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

Last change on this file since 34 was 34, checked in by Sanahuja Guillaume, 4 years ago

doc

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