source: flair-dev/trunk/doc/Flair/classflair_1_1gui_1_1_layout_position.html @ 14

Last change on this file since 14 was 14, checked in by Sanahuja Guillaume, 5 years ago

doc

File size: 14.2 KB
Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6<meta name="generator" content="Doxygen 1.8.7"/>
7<title>Flair: flair::gui::LayoutPosition Class Reference</title>
8<link href="tabs.css" rel="stylesheet" type="text/css"/>
9<script type="text/javascript" src="jquery.js"></script>
10<script type="text/javascript" src="dynsections.js"></script>
11<link href="navtree.css" rel="stylesheet" type="text/css"/>
12<script type="text/javascript" src="resize.js"></script>
13<script type="text/javascript" src="navtree.js"></script>
14<script type="text/javascript">
15  $(document).ready(initResizable);
16  $(window).load(resizeHeight);
17</script>
18<link href="search/search.css" rel="stylesheet" type="text/css"/>
19<script type="text/javascript" src="search/search.js"></script>
20<script type="text/javascript">
21  $(document).ready(function() { searchBox.OnSelectItem(0); });
22</script>
23<link href="doxygen.css" rel="stylesheet" type="text/css" />
24</head>
25<body>
26<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
27<div id="titlearea">
28<table cellspacing="0" cellpadding="0">
29 <tbody>
30 <tr style="height: 56px;">
31  <td id="projectlogo"><img alt="Logo" src="logo_hds.png"/></td>
32  <td style="padding-left: 0.5em;">
33   <div id="projectname">Flair
34   </div>
35   <div id="projectbrief">Framework Libre Air</div>
36  </td>
37 </tr>
38 </tbody>
39</table>
40</div>
41<!-- end header part -->
42<!-- Generated by Doxygen 1.8.7 -->
43<script type="text/javascript">
44var searchBox = new SearchBox("searchBox", "search",false,'Search');
45</script>
46  <div id="navrow1" class="tabs">
47    <ul class="tablist">
48      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
49      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
50      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
51      <li><a href="files.html"><span>Files</span></a></li>
52      <li>
53        <div id="MSearchBox" class="MSearchBoxInactive">
54        <span class="left">
55          <img id="MSearchSelect" src="search/mag_sel.png"
56               onmouseover="return searchBox.OnSearchSelectShow()"
57               onmouseout="return searchBox.OnSearchSelectHide()"
58               alt=""/>
59          <input type="text" id="MSearchField" value="Search" accesskey="S"
60               onfocus="searchBox.OnSearchFieldFocus(true)" 
61               onblur="searchBox.OnSearchFieldFocus(false)" 
62               onkeyup="searchBox.OnSearchFieldChange(event)"/>
63          </span><span class="right">
64            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
65          </span>
66        </div>
67      </li>
68    </ul>
69  </div>
70  <div id="navrow2" class="tabs2">
71    <ul class="tablist">
72      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
73      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
74      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
75      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
76    </ul>
77  </div>
78</div><!-- top -->
79<div id="side-nav" class="ui-resizable side-nav-resizable">
80  <div id="nav-tree">
81    <div id="nav-tree-contents">
82      <div id="nav-sync" class="sync"></div>
83    </div>
84  </div>
85  <div id="splitbar" style="-moz-user-select:none;" 
86       class="ui-resizable-handle">
87  </div>
88</div>
89<script type="text/javascript">
90$(document).ready(function(){initNavTree('classflair_1_1gui_1_1_layout_position.html','');});
91</script>
92<div id="doc-content">
93<!-- window showing the filter options -->
94<div id="MSearchSelectWindow"
95     onmouseover="return searchBox.OnSearchSelectShow()"
96     onmouseout="return searchBox.OnSearchSelectHide()"
97     onkeydown="return searchBox.OnSearchSelectKey(event)">
98<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Properties</a></div>
99
100<!-- iframe showing the search results (closed by default) -->
101<div id="MSearchResultsWindow">
102<iframe src="javascript:void(0)" frameborder="0" 
103        name="MSearchResults" id="MSearchResults">
104</iframe>
105</div>
106
107<div class="header">
108  <div class="summary">
109<a href="#pub-methods">Public Member Functions</a> &#124;
110<a href="classflair_1_1gui_1_1_layout_position-members.html">List of all members</a>  </div>
111  <div class="headertitle">
112<div class="title">flair::gui::LayoutPosition Class Reference</div>  </div>
113</div><!--header-->
114<div class="contents">
115
116<p>Class to define a position in a layout on the ground station. 
117 <a href="classflair_1_1gui_1_1_layout_position.html#details">More...</a></p>
118
119<p><code>#include &lt;<a class="el" href="_layout_position_8h_source.html">LayoutPosition.h</a>&gt;</code></p>
120<table class="memberdecls">
121<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
122Public Member Functions</h2></td></tr>
123<tr class="memitem:ac47a69e6867c7a39e9cb91d4adc7ca7c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1gui_1_1_layout_position.html#ac47a69e6867c7a39e9cb91d4adc7ca7c">LayoutPosition</a> (const <a class="el" href="classflair_1_1gui_1_1_layout.html">Layout</a> *layout, int16_t row, int16_t col)</td></tr>
124<tr class="memdesc:ac47a69e6867c7a39e9cb91d4adc7ca7c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#ac47a69e6867c7a39e9cb91d4adc7ca7c">More...</a><br /></td></tr>
125<tr class="separator:ac47a69e6867c7a39e9cb91d4adc7ca7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
126<tr class="memitem:abfff9b4fd6670430e8bd94440370ee49"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1gui_1_1_layout_position.html#abfff9b4fd6670430e8bd94440370ee49">~LayoutPosition</a> ()</td></tr>
127<tr class="memdesc:abfff9b4fd6670430e8bd94440370ee49"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#abfff9b4fd6670430e8bd94440370ee49">More...</a><br /></td></tr>
128<tr class="separator:abfff9b4fd6670430e8bd94440370ee49"><td class="memSeparator" colspan="2">&#160;</td></tr>
129<tr class="memitem:a766d122d2b123cf6b146daf527058df4"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classflair_1_1gui_1_1_layout.html">Layout</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1gui_1_1_layout_position.html#a766d122d2b123cf6b146daf527058df4">getLayout</a> (void) const </td></tr>
130<tr class="memdesc:a766d122d2b123cf6b146daf527058df4"><td class="mdescLeft">&#160;</td><td class="mdescRight">get <a class="el" href="classflair_1_1gui_1_1_layout.html" title="Abstract class to display a layout on the ground station. ">Layout</a>  <a href="#a766d122d2b123cf6b146daf527058df4">More...</a><br /></td></tr>
131<tr class="separator:a766d122d2b123cf6b146daf527058df4"><td class="memSeparator" colspan="2">&#160;</td></tr>
132<tr class="memitem:a1fca2149b3c709f3f2172e8fea66b02d"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1gui_1_1_layout_position.html#a1fca2149b3c709f3f2172e8fea66b02d">Row</a> (void) const </td></tr>
133<tr class="memdesc:a1fca2149b3c709f3f2172e8fea66b02d"><td class="mdescLeft">&#160;</td><td class="mdescRight">get row  <a href="#a1fca2149b3c709f3f2172e8fea66b02d">More...</a><br /></td></tr>
134<tr class="separator:a1fca2149b3c709f3f2172e8fea66b02d"><td class="memSeparator" colspan="2">&#160;</td></tr>
135<tr class="memitem:a7f321233c0ec13034db703b71d612520"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1gui_1_1_layout_position.html#a7f321233c0ec13034db703b71d612520">Col</a> (void) const </td></tr>
136<tr class="memdesc:a7f321233c0ec13034db703b71d612520"><td class="mdescLeft">&#160;</td><td class="mdescRight">get col  <a href="#a7f321233c0ec13034db703b71d612520">More...</a><br /></td></tr>
137<tr class="separator:a7f321233c0ec13034db703b71d612520"><td class="memSeparator" colspan="2">&#160;</td></tr>
138</table>
139<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
140<div class="textblock"><p>Class to define a position in a layout on the ground station. </p>
141</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
142<a class="anchor" id="ac47a69e6867c7a39e9cb91d4adc7ca7c"></a>
143<div class="memitem">
144<div class="memproto">
145      <table class="memname">
146        <tr>
147          <td class="memname">flair::gui::LayoutPosition::LayoutPosition </td>
148          <td>(</td>
149          <td class="paramtype">const <a class="el" href="classflair_1_1gui_1_1_layout.html">Layout</a> *&#160;</td>
150          <td class="paramname"><em>layout</em>, </td>
151        </tr>
152        <tr>
153          <td class="paramkey"></td>
154          <td></td>
155          <td class="paramtype">int16_t&#160;</td>
156          <td class="paramname"><em>row</em>, </td>
157        </tr>
158        <tr>
159          <td class="paramkey"></td>
160          <td></td>
161          <td class="paramtype">int16_t&#160;</td>
162          <td class="paramname"><em>col</em>&#160;</td>
163        </tr>
164        <tr>
165          <td></td>
166          <td>)</td>
167          <td></td><td></td>
168        </tr>
169      </table>
170</div><div class="memdoc">
171
172<p>Constructor. </p>
173<p>Construct a <a class="el" href="classflair_1_1gui_1_1_layout_position.html" title="Class to define a position in a layout on the ground station. ">LayoutPosition</a>, in given <a class="el" href="classflair_1_1gui_1_1_layout.html" title="Abstract class to display a layout on the ground station. ">Layout</a> at given place.</p>
174<dl class="params"><dt>Parameters</dt><dd>
175  <table class="params">
176    <tr><td class="paramname">layout</td><td>layout </td></tr>
177    <tr><td class="paramname">row</td><td>row position </td></tr>
178    <tr><td class="paramname">col</td><td>col position </td></tr>
179  </table>
180  </dd>
181</dl>
182
183</div>
184</div>
185<a class="anchor" id="abfff9b4fd6670430e8bd94440370ee49"></a>
186<div class="memitem">
187<div class="memproto">
188      <table class="memname">
189        <tr>
190          <td class="memname">flair::gui::LayoutPosition::~LayoutPosition </td>
191          <td>(</td>
192          <td class="paramname"></td><td>)</td>
193          <td></td>
194        </tr>
195      </table>
196</div><div class="memdoc">
197
198<p>Destructor. </p>
199
200</div>
201</div>
202<h2 class="groupheader">Member Function Documentation</h2>
203<a class="anchor" id="a766d122d2b123cf6b146daf527058df4"></a>
204<div class="memitem">
205<div class="memproto">
206      <table class="memname">
207        <tr>
208          <td class="memname">const <a class="el" href="classflair_1_1gui_1_1_layout.html">Layout</a>* flair::gui::LayoutPosition::getLayout </td>
209          <td>(</td>
210          <td class="paramtype">void&#160;</td>
211          <td class="paramname"></td><td>)</td>
212          <td> const</td>
213        </tr>
214      </table>
215</div><div class="memdoc">
216
217<p>get <a class="el" href="classflair_1_1gui_1_1_layout.html" title="Abstract class to display a layout on the ground station. ">Layout</a> </p>
218<dl class="section return"><dt>Returns</dt><dd>the parent <a class="el" href="classflair_1_1gui_1_1_layout.html" title="Abstract class to display a layout on the ground station. ">Layout</a> </dd></dl>
219
220</div>
221</div>
222<a class="anchor" id="a1fca2149b3c709f3f2172e8fea66b02d"></a>
223<div class="memitem">
224<div class="memproto">
225      <table class="memname">
226        <tr>
227          <td class="memname">int16_t flair::gui::LayoutPosition::Row </td>
228          <td>(</td>
229          <td class="paramtype">void&#160;</td>
230          <td class="paramname"></td><td>)</td>
231          <td> const</td>
232        </tr>
233      </table>
234</div><div class="memdoc">
235
236<p>get row </p>
237<dl class="section return"><dt>Returns</dt><dd>row position </dd></dl>
238
239</div>
240</div>
241<a class="anchor" id="a7f321233c0ec13034db703b71d612520"></a>
242<div class="memitem">
243<div class="memproto">
244      <table class="memname">
245        <tr>
246          <td class="memname">int16_t flair::gui::LayoutPosition::Col </td>
247          <td>(</td>
248          <td class="paramtype">void&#160;</td>
249          <td class="paramname"></td><td>)</td>
250          <td> const</td>
251        </tr>
252      </table>
253</div><div class="memdoc">
254
255<p>get col </p>
256<dl class="section return"><dt>Returns</dt><dd>col position </dd></dl>
257
258</div>
259</div>
260</div><!-- contents -->
261</div><!-- doc-content -->
262<!-- start footer part -->
263<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
264  <ul>
265    <li class="navelem"><a class="el" href="namespaceflair.html">flair</a></li><li class="navelem"><a class="el" href="namespaceflair_1_1gui.html">gui</a></li><li class="navelem"><a class="el" href="classflair_1_1gui_1_1_layout_position.html">LayoutPosition</a></li>
266    <li class="footer">Generated on Mon Apr 18 2016 17:27:09 for Flair by
267    <a href="http://www.doxygen.org/index.html">
268    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </li>
269  </ul>
270</div>
271</body>
272</html>
Note: See TracBrowser for help on using the repository browser.