source: flair-dev/trunk/doc/Flair/classflair_1_1gui_1_1_box.html

Last change on this file was 100, checked in by Sanahuja Guillaume, 6 years ago

doc

File size: 37.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.9.1"/>
7<title>Flair: flair::gui::Box 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_box.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="#pro-methods">Protected Member Functions</a> &#124;
113<a href="classflair_1_1gui_1_1_box-members.html">List of all members</a> </div>
114 <div class="headertitle">
115<div class="title">flair::gui::Box Class Reference</div> </div>
116</div><!--header-->
117<div class="contents">
118
119<p>Abstract class to display a box on the ground station.
120 <a href="classflair_1_1gui_1_1_box.html#details">More...</a></p>
121
122<p><code>#include &lt;<a class="el" href="_box_8h_source.html">Box.h</a>&gt;</code></p>
123<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
124 <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for flair::gui::Box:</div>
125<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
126</div>
127<div id="dynsection-0-content" class="dyncontent" style="display:none;">
128 <div class="center">
129 <img src="classflair_1_1gui_1_1_box.png" usemap="#flair::gui::Box_map" alt=""/>
130 <map id="flair::gui::Box_map" name="flair::gui::Box_map">
131<area href="classflair_1_1gui_1_1_widget.html" title="Abstract class for all Framework&#39;s widget classes. " alt="flair::gui::Widget" shape="rect" coords="346,56,509,80"/>
132<area href="classflair_1_1core_1_1_object.html" title="Base class for all Framework&#39;s classes. " alt="flair::core::Object" shape="rect" coords="346,0,509,24"/>
133<area href="classflair_1_1gui_1_1_check_box.html" title="Class displaying a QCheckBox on the ground station. " alt="flair::gui::CheckBox" shape="rect" coords="0,168,163,192"/>
134<area href="classflair_1_1gui_1_1_combo_box.html" title="Class displaying a QComboBox on the ground station. " alt="flair::gui::ComboBox" shape="rect" coords="173,168,336,192"/>
135<area href="classflair_1_1gui_1_1_double_spin_box.html" title="Class displaying a QDoubleSpinBox on the ground station. " alt="flair::gui::DoubleSpinBox" shape="rect" coords="346,168,509,192"/>
136<area href="classflair_1_1gui_1_1_spin_box.html" title="Class displaying a QSpinBox on the ground station. " alt="flair::gui::SpinBox" shape="rect" coords="519,168,682,192"/>
137<area href="classflair_1_1gui_1_1_vector3_d_spin_box.html" title="Class displaying 3 QDoubleSpinBox for x,y,z on the ground station. " alt="flair::gui::Vector3DSpinBox" shape="rect" coords="692,168,855,192"/>
138</map>
139 </div></div>
140<table class="memberdecls">
141<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
142Public Member Functions</h2></td></tr>
143<tr class="memitem:a2f126878bf430425982c367e709ea438"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1gui_1_1_box.html#a2f126878bf430425982c367e709ea438">Box</a> (const <a class="el" href="classflair_1_1gui_1_1_layout_position.html">LayoutPosition</a> *position, std::string name, std::string type)</td></tr>
144<tr class="memdesc:a2f126878bf430425982c367e709ea438"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="#a2f126878bf430425982c367e709ea438">More...</a><br /></td></tr>
145<tr class="separator:a2f126878bf430425982c367e709ea438"><td class="memSeparator" colspan="2">&#160;</td></tr>
146<tr class="memitem:adfd9a664f5096bbe85cdebf021f542ea"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1gui_1_1_box.html#adfd9a664f5096bbe85cdebf021f542ea">~Box</a> ()</td></tr>
147<tr class="memdesc:adfd9a664f5096bbe85cdebf021f542ea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <a href="#adfd9a664f5096bbe85cdebf021f542ea">More...</a><br /></td></tr>
148<tr class="separator:adfd9a664f5096bbe85cdebf021f542ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
149<tr class="memitem:a54608ff0fdac6b8e05c8ece4fd3f8375"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1gui_1_1_box.html#a54608ff0fdac6b8e05c8ece4fd3f8375">ValueChanged</a> (void)</td></tr>
150<tr class="memdesc:a54608ff0fdac6b8e05c8ece4fd3f8375"><td class="mdescLeft">&#160;</td><td class="mdescRight">Has the value changed since last call? <a href="#a54608ff0fdac6b8e05c8ece4fd3f8375">More...</a><br /></td></tr>
151<tr class="separator:a54608ff0fdac6b8e05c8ece4fd3f8375"><td class="memSeparator" colspan="2">&#160;</td></tr>
152<tr class="inherit_header pub_methods_classflair_1_1gui_1_1_widget"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classflair_1_1gui_1_1_widget')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classflair_1_1gui_1_1_widget.html">flair::gui::Widget</a></td></tr>
153<tr class="memitem:a7b867cc6c603cbc5e5a2f39f083a9494 inherit pub_methods_classflair_1_1gui_1_1_widget"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1gui_1_1_widget.html#a7b867cc6c603cbc5e5a2f39f083a9494">Widget</a> (const <a class="el" href="classflair_1_1gui_1_1_widget.html">Widget</a> *parent, std::string name, std::string type)</td></tr>
154<tr class="memdesc:a7b867cc6c603cbc5e5a2f39f083a9494 inherit pub_methods_classflair_1_1gui_1_1_widget"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="#a7b867cc6c603cbc5e5a2f39f083a9494">More...</a><br /></td></tr>
155<tr class="separator:a7b867cc6c603cbc5e5a2f39f083a9494 inherit pub_methods_classflair_1_1gui_1_1_widget"><td class="memSeparator" colspan="2">&#160;</td></tr>
156<tr class="memitem:a81110928e09e909dc1cc90971de4e8a9 inherit pub_methods_classflair_1_1gui_1_1_widget"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1gui_1_1_widget.html#a81110928e09e909dc1cc90971de4e8a9">~Widget</a> ()</td></tr>
157<tr class="memdesc:a81110928e09e909dc1cc90971de4e8a9 inherit pub_methods_classflair_1_1gui_1_1_widget"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <a href="#a81110928e09e909dc1cc90971de4e8a9">More...</a><br /></td></tr>
158<tr class="separator:a81110928e09e909dc1cc90971de4e8a9 inherit pub_methods_classflair_1_1gui_1_1_widget"><td class="memSeparator" colspan="2">&#160;</td></tr>
159<tr class="memitem:a814a933622114ad9c8f5d49014262d89 inherit pub_methods_classflair_1_1gui_1_1_widget"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1gui_1_1_widget.html#a814a933622114ad9c8f5d49014262d89">setEnabled</a> (bool status)</td></tr>
160<tr class="memdesc:a814a933622114ad9c8f5d49014262d89 inherit pub_methods_classflair_1_1gui_1_1_widget"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set enabled. <a href="#a814a933622114ad9c8f5d49014262d89">More...</a><br /></td></tr>
161<tr class="separator:a814a933622114ad9c8f5d49014262d89 inherit pub_methods_classflair_1_1gui_1_1_widget"><td class="memSeparator" colspan="2">&#160;</td></tr>
162<tr class="memitem:a299877c38b297ada04542e4dfc5a2f4f inherit pub_methods_classflair_1_1gui_1_1_widget"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1gui_1_1_widget.html#a299877c38b297ada04542e4dfc5a2f4f">isEnabled</a> (void) const </td></tr>
163<tr class="memdesc:a299877c38b297ada04542e4dfc5a2f4f inherit pub_methods_classflair_1_1gui_1_1_widget"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is enabled? <a href="#a299877c38b297ada04542e4dfc5a2f4f">More...</a><br /></td></tr>
164<tr class="separator:a299877c38b297ada04542e4dfc5a2f4f inherit pub_methods_classflair_1_1gui_1_1_widget"><td class="memSeparator" colspan="2">&#160;</td></tr>
165<tr class="inherit_header pub_methods_classflair_1_1core_1_1_object"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classflair_1_1core_1_1_object')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classflair_1_1core_1_1_object.html">flair::core::Object</a></td></tr>
166<tr class="memitem:aec92383fd5bf68d9df10414862b7e95c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#aec92383fd5bf68d9df10414862b7e95c">Object</a> (const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> *parent=NULL, std::string name=&quot;&quot;, std::string type=&quot;&quot;)</td></tr>
167<tr class="memdesc:aec92383fd5bf68d9df10414862b7e95c inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="#aec92383fd5bf68d9df10414862b7e95c">More...</a><br /></td></tr>
168<tr class="separator:aec92383fd5bf68d9df10414862b7e95c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
169<tr class="memitem:aa2bde0e6677bbef705c96c93cb06ad09 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#aa2bde0e6677bbef705c96c93cb06ad09">~Object</a> ()</td></tr>
170<tr class="memdesc:aa2bde0e6677bbef705c96c93cb06ad09 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <a href="#aa2bde0e6677bbef705c96c93cb06ad09">More...</a><br /></td></tr>
171<tr class="separator:aa2bde0e6677bbef705c96c93cb06ad09 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
172<tr class="memitem:a9b0344dff7e1c05424d9152c8274523a inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a9b0344dff7e1c05424d9152c8274523a">ObjectName</a> (void) const </td></tr>
173<tr class="memdesc:a9b0344dff7e1c05424d9152c8274523a inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Name. <a href="#a9b0344dff7e1c05424d9152c8274523a">More...</a><br /></td></tr>
174<tr class="separator:a9b0344dff7e1c05424d9152c8274523a inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
175<tr class="memitem:a609a250ec037fbcaf8957c8f1dcbfc53 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a609a250ec037fbcaf8957c8f1dcbfc53">ObjectType</a> (void) const </td></tr>
176<tr class="memdesc:a609a250ec037fbcaf8957c8f1dcbfc53 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type. <a href="#a609a250ec037fbcaf8957c8f1dcbfc53">More...</a><br /></td></tr>
177<tr class="separator:a609a250ec037fbcaf8957c8f1dcbfc53 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
178<tr class="memitem:a360c112cc3017a5152ebf6e84d2efa70 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a360c112cc3017a5152ebf6e84d2efa70">Parent</a> (void) const </td></tr>
179<tr class="memdesc:a360c112cc3017a5152ebf6e84d2efa70 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parent. <a href="#a360c112cc3017a5152ebf6e84d2efa70">More...</a><br /></td></tr>
180<tr class="separator:a360c112cc3017a5152ebf6e84d2efa70 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
181<tr class="memitem:ae22db4d723ec2d50b3ba48f26a6a770c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">std::vector&lt; const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> * &gt; *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#ae22db4d723ec2d50b3ba48f26a6a770c">TypeChilds</a> (void) const </td></tr>
182<tr class="memdesc:ae22db4d723ec2d50b3ba48f26a6a770c inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Childs of the same type. <a href="#ae22db4d723ec2d50b3ba48f26a6a770c">More...</a><br /></td></tr>
183<tr class="separator:ae22db4d723ec2d50b3ba48f26a6a770c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
184<tr class="memitem:a344f81cd35805a9501098bf727ac1a10 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">std::vector&lt; const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> * &gt; *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a344f81cd35805a9501098bf727ac1a10">Childs</a> (void) const </td></tr>
185<tr class="memdesc:a344f81cd35805a9501098bf727ac1a10 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Childs. <a href="#a344f81cd35805a9501098bf727ac1a10">More...</a><br /></td></tr>
186<tr class="separator:a344f81cd35805a9501098bf727ac1a10 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
187<tr class="memitem:af001feba14fc053aa778e61080a0b4cf inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#af001feba14fc053aa778e61080a0b4cf">Information</a> (const char *function, int line, const char *format,...) const </td></tr>
188<tr class="memdesc:af001feba14fc053aa778e61080a0b4cf inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formatted information. <a href="#af001feba14fc053aa778e61080a0b4cf">More...</a><br /></td></tr>
189<tr class="separator:af001feba14fc053aa778e61080a0b4cf inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
190<tr class="memitem:a168b18451b2ee6126e1e81d452005ff6 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a168b18451b2ee6126e1e81d452005ff6">Warning</a> (const char *function, const char *format,...) const </td></tr>
191<tr class="memdesc:a168b18451b2ee6126e1e81d452005ff6 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formatted warning. <a href="#a168b18451b2ee6126e1e81d452005ff6">More...</a><br /></td></tr>
192<tr class="separator:a168b18451b2ee6126e1e81d452005ff6 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
193<tr class="memitem:a3ca9694d29ec2b0491739879685df5ca inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a3ca9694d29ec2b0491739879685df5ca">Error</a> (const char *function, const char *format,...) const </td></tr>
194<tr class="memdesc:a3ca9694d29ec2b0491739879685df5ca inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formatted error. <a href="#a3ca9694d29ec2b0491739879685df5ca">More...</a><br /></td></tr>
195<tr class="separator:a3ca9694d29ec2b0491739879685df5ca inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
196<tr class="memitem:a36cdd7f556e78b1bddd1d1fe4264bb85 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a36cdd7f556e78b1bddd1d1fe4264bb85">ErrorOccured</a> (bool recursive=true) const </td></tr>
197<tr class="memdesc:a36cdd7f556e78b1bddd1d1fe4264bb85 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Has an errror occured? <a href="#a36cdd7f556e78b1bddd1d1fe4264bb85">More...</a><br /></td></tr>
198<tr class="separator:a36cdd7f556e78b1bddd1d1fe4264bb85 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
199</table><table class="memberdecls">
200<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
201Protected Member Functions</h2></td></tr>
202<tr class="memitem:a97997d50ef96b359564c2d6b94db1edc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1gui_1_1_box.html#a97997d50ef96b359564c2d6b94db1edc">SetValueChanged</a> (void)</td></tr>
203<tr class="memdesc:a97997d50ef96b359564c2d6b94db1edc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the value changed flag. <a href="#a97997d50ef96b359564c2d6b94db1edc">More...</a><br /></td></tr>
204<tr class="separator:a97997d50ef96b359564c2d6b94db1edc"><td class="memSeparator" colspan="2">&#160;</td></tr>
205<tr class="memitem:a72d33c20718419d566e198840318e22f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1gui_1_1_box.html#a72d33c20718419d566e198840318e22f">GetMutex</a> (void) const </td></tr>
206<tr class="memdesc:a72d33c20718419d566e198840318e22f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get Mutex. <a href="#a72d33c20718419d566e198840318e22f">More...</a><br /></td></tr>
207<tr class="separator:a72d33c20718419d566e198840318e22f"><td class="memSeparator" colspan="2">&#160;</td></tr>
208<tr class="memitem:a3d1e4e81c7c59a051368a346a104c988"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1gui_1_1_box.html#a3d1e4e81c7c59a051368a346a104c988">ReleaseMutex</a> (void) const </td></tr>
209<tr class="memdesc:a3d1e4e81c7c59a051368a346a104c988"><td class="mdescLeft">&#160;</td><td class="mdescRight">Release Mutex. <a href="#a3d1e4e81c7c59a051368a346a104c988">More...</a><br /></td></tr>
210<tr class="separator:a3d1e4e81c7c59a051368a346a104c988"><td class="memSeparator" colspan="2">&#160;</td></tr>
211<tr class="inherit_header pro_methods_classflair_1_1gui_1_1_widget"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classflair_1_1gui_1_1_widget')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classflair_1_1gui_1_1_widget.html">flair::gui::Widget</a></td></tr>
212<tr class="memitem:a0e81847db5a84b2e7e26545c9b1b704f inherit pro_methods_classflair_1_1gui_1_1_widget"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
213<tr class="memitem:a0e81847db5a84b2e7e26545c9b1b704f inherit pro_methods_classflair_1_1gui_1_1_widget"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classflair_1_1gui_1_1_widget.html#a0e81847db5a84b2e7e26545c9b1b704f">SetPersistentXmlProp</a> (std::string prop, T value)</td></tr>
214<tr class="memdesc:a0e81847db5a84b2e7e26545c9b1b704f inherit pro_methods_classflair_1_1gui_1_1_widget"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a persistent xml property. <a href="#a0e81847db5a84b2e7e26545c9b1b704f">More...</a><br /></td></tr>
215<tr class="separator:a0e81847db5a84b2e7e26545c9b1b704f inherit pro_methods_classflair_1_1gui_1_1_widget"><td class="memSeparator" colspan="2">&#160;</td></tr>
216<tr class="memitem:a6404c7f474be994ec4e72a97e45dfffa inherit pro_methods_classflair_1_1gui_1_1_widget"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
217<tr class="memitem:a6404c7f474be994ec4e72a97e45dfffa inherit pro_methods_classflair_1_1gui_1_1_widget"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classflair_1_1gui_1_1_widget.html#a6404c7f474be994ec4e72a97e45dfffa">GetPersistentXmlProp</a> (std::string prop, T &amp;value)</td></tr>
218<tr class="memdesc:a6404c7f474be994ec4e72a97e45dfffa inherit pro_methods_classflair_1_1gui_1_1_widget"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a persistent xml property. <a href="#a6404c7f474be994ec4e72a97e45dfffa">More...</a><br /></td></tr>
219<tr class="separator:a6404c7f474be994ec4e72a97e45dfffa inherit pro_methods_classflair_1_1gui_1_1_widget"><td class="memSeparator" colspan="2">&#160;</td></tr>
220<tr class="memitem:abe5ab96255919238138527c92fbeb6d8 inherit pro_methods_classflair_1_1gui_1_1_widget"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
221<tr class="memitem:abe5ab96255919238138527c92fbeb6d8 inherit pro_methods_classflair_1_1gui_1_1_widget"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classflair_1_1gui_1_1_widget.html#abe5ab96255919238138527c92fbeb6d8">SetVolatileXmlProp</a> (std::string prop, T value, xmlNodePtr node=NULL)</td></tr>
222<tr class="memdesc:abe5ab96255919238138527c92fbeb6d8 inherit pro_methods_classflair_1_1gui_1_1_widget"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a volatile xml property. <a href="#abe5ab96255919238138527c92fbeb6d8">More...</a><br /></td></tr>
223<tr class="separator:abe5ab96255919238138527c92fbeb6d8 inherit pro_methods_classflair_1_1gui_1_1_widget"><td class="memSeparator" colspan="2">&#160;</td></tr>
224<tr class="memitem:ac80f72906580f269b5881c1ef0b35afb inherit pro_methods_classflair_1_1gui_1_1_widget"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1gui_1_1_widget.html#ac80f72906580f269b5881c1ef0b35afb">SendXml</a> (void)</td></tr>
225<tr class="memdesc:ac80f72906580f269b5881c1ef0b35afb inherit pro_methods_classflair_1_1gui_1_1_widget"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send xml. <a href="#ac80f72906580f269b5881c1ef0b35afb">More...</a><br /></td></tr>
226<tr class="separator:ac80f72906580f269b5881c1ef0b35afb inherit pro_methods_classflair_1_1gui_1_1_widget"><td class="memSeparator" colspan="2">&#160;</td></tr>
227<tr class="memitem:a92d4e0613146c9b348b388f3f75cca9e inherit pro_methods_classflair_1_1gui_1_1_widget"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1gui_1_1_widget.html#a92d4e0613146c9b348b388f3f75cca9e">XmlEvent</a> (void)</td></tr>
228<tr class="memdesc:a92d4e0613146c9b348b388f3f75cca9e inherit pro_methods_classflair_1_1gui_1_1_widget"><td class="mdescLeft">&#160;</td><td class="mdescRight">Xml event. <a href="#a92d4e0613146c9b348b388f3f75cca9e">More...</a><br /></td></tr>
229<tr class="separator:a92d4e0613146c9b348b388f3f75cca9e inherit pro_methods_classflair_1_1gui_1_1_widget"><td class="memSeparator" colspan="2">&#160;</td></tr>
230<tr class="memitem:a9ba37bd7fad0f4a97175d922b93b5434 inherit pro_methods_classflair_1_1gui_1_1_widget"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1gui_1_1_widget.html#a9ba37bd7fad0f4a97175d922b93b5434">UnsetPersistentXmlProp</a> (std::string prop)</td></tr>
231<tr class="memdesc:a9ba37bd7fad0f4a97175d922b93b5434 inherit pro_methods_classflair_1_1gui_1_1_widget"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unset a persistent xml property. <a href="#a9ba37bd7fad0f4a97175d922b93b5434">More...</a><br /></td></tr>
232<tr class="separator:a9ba37bd7fad0f4a97175d922b93b5434 inherit pro_methods_classflair_1_1gui_1_1_widget"><td class="memSeparator" colspan="2">&#160;</td></tr>
233</table><table class="memberdecls">
234<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
235Additional Inherited Members</h2></td></tr>
236<tr class="inherit_header pub_types_classflair_1_1core_1_1_object"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classflair_1_1core_1_1_object')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="classflair_1_1core_1_1_object.html">flair::core::Object</a></td></tr>
237<tr class="memitem:aed5fccda511f97487040fed29f4efc97 inherit pub_types_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aed5fccda511f97487040fed29f4efc97"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>color_t</b> { <b>Auto</b> = 0,
238<b>Red</b> = 31,
239<b>Green</b> = 32,
240<b>Orange</b> = 33
241 }</td></tr>
242<tr class="separator:aed5fccda511f97487040fed29f4efc97 inherit pub_types_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
243</table>
244<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
245<div class="textblock"><p>Abstract class to display a box on the ground station. </p>
246<p>This is an abstract class to display boxes (like <a class="el" href="classflair_1_1gui_1_1_check_box.html" title="Class displaying a QCheckBox on the ground station. ">CheckBox</a>, <a class="el" href="classflair_1_1gui_1_1_spin_box.html" title="Class displaying a QSpinBox on the ground station. ">SpinBox</a>, etc). <br />
247 To access reimplemented box's value, use <a class="el" href="classflair_1_1gui_1_1_box.html#a72d33c20718419d566e198840318e22f" title="Get Mutex. ">Box::GetMutex</a> and <a class="el" href="classflair_1_1gui_1_1_box.html#a3d1e4e81c7c59a051368a346a104c988" title="Release Mutex. ">Box::ReleaseMutex</a>. <br />
248 Note that this mutex is in reality the one from 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>. To minimize memory footprint, each <a class="el" href="classflair_1_1gui_1_1_box.html" title="Abstract class to display a box on the ground station. ">Box</a> does not have its own Mutex. </p>
249</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
250<a class="anchor" id="a2f126878bf430425982c367e709ea438"></a>
251<div class="memitem">
252<div class="memproto">
253 <table class="memname">
254 <tr>
255 <td class="memname">flair::gui::Box::Box </td>
256 <td>(</td>
257 <td class="paramtype">const <a class="el" href="classflair_1_1gui_1_1_layout_position.html">LayoutPosition</a> *&#160;</td>
258 <td class="paramname"><em>position</em>, </td>
259 </tr>
260 <tr>
261 <td class="paramkey"></td>
262 <td></td>
263 <td class="paramtype">std::string&#160;</td>
264 <td class="paramname"><em>name</em>, </td>
265 </tr>
266 <tr>
267 <td class="paramkey"></td>
268 <td></td>
269 <td class="paramtype">std::string&#160;</td>
270 <td class="paramname"><em>type</em>&#160;</td>
271 </tr>
272 <tr>
273 <td></td>
274 <td>)</td>
275 <td></td><td></td>
276 </tr>
277 </table>
278</div><div class="memdoc">
279
280<p>Constructor. </p>
281<p>Construct a <a class="el" href="classflair_1_1gui_1_1_box.html" title="Abstract class to display a box on the ground station. ">Box</a>. <br />
282 Type must agree with predifined (hard coded) types in ground station code. <br />
283 The <a class="el" href="classflair_1_1gui_1_1_box.html" title="Abstract class to display a box on the ground station. ">Box</a> will automatically be child of position-&gt;getLayout() <a class="el" href="classflair_1_1gui_1_1_layout.html" title="Abstract class to display a layout on the ground station. ">Layout</a>. After calling this method, position will be deleted as it is no longer usefull.</p>
284<dl class="params"><dt>Parameters</dt><dd>
285 <table class="params">
286 <tr><td class="paramname">position</td><td>position </td></tr>
287 <tr><td class="paramname">name</td><td>name </td></tr>
288 <tr><td class="paramname">type</td><td>type </td></tr>
289 </table>
290 </dd>
291</dl>
292
293</div>
294</div>
295<a class="anchor" id="adfd9a664f5096bbe85cdebf021f542ea"></a>
296<div class="memitem">
297<div class="memproto">
298 <table class="memname">
299 <tr>
300 <td class="memname">flair::gui::Box::~Box </td>
301 <td>(</td>
302 <td class="paramname"></td><td>)</td>
303 <td></td>
304 </tr>
305 </table>
306</div><div class="memdoc">
307
308<p>Destructor. </p>
309
310</div>
311</div>
312<h2 class="groupheader">Member Function Documentation</h2>
313<a class="anchor" id="a54608ff0fdac6b8e05c8ece4fd3f8375"></a>
314<div class="memitem">
315<div class="memproto">
316 <table class="memname">
317 <tr>
318 <td class="memname">bool flair::gui::Box::ValueChanged </td>
319 <td>(</td>
320 <td class="paramtype">void&#160;</td>
321 <td class="paramname"></td><td>)</td>
322 <td></td>
323 </tr>
324 </table>
325</div><div class="memdoc">
326
327<p>Has the value changed since last call? </p>
328<p>This method returns the value of an internal flag which is set through <a class="el" href="classflair_1_1gui_1_1_box.html#a97997d50ef96b359564c2d6b94db1edc" title="Set the value changed flag. ">SetValueChanged()</a>. <br />
329After calling this method, the internal flag is set to false.</p>
330<dl class="section return"><dt>Returns</dt><dd>true is valued has changed since last call </dd></dl>
331
332</div>
333</div>
334<a class="anchor" id="a97997d50ef96b359564c2d6b94db1edc"></a>
335<div class="memitem">
336<div class="memproto">
337<table class="mlabels">
338 <tr>
339 <td class="mlabels-left">
340 <table class="memname">
341 <tr>
342 <td class="memname">void flair::gui::Box::SetValueChanged </td>
343 <td>(</td>
344 <td class="paramtype">void&#160;</td>
345 <td class="paramname"></td><td>)</td>
346 <td></td>
347 </tr>
348 </table>
349 </td>
350 <td class="mlabels-right">
351<span class="mlabels"><span class="mlabel">protected</span></span> </td>
352 </tr>
353</table>
354</div><div class="memdoc">
355
356<p>Set the value changed flag. </p>
357<p>The reimplemented class must call this method when <a class="el" href="classflair_1_1gui_1_1_box.html" title="Abstract class to display a box on the ground station. ">Box</a>'s value is changed. <br />
358 This method must be called with Mutex locked. Indeed, as reimplemented class also has to lock the Mutex to change the <a class="el" href="classflair_1_1gui_1_1_box.html" title="Abstract class to display a box on the ground station. ">Box</a> value, this mecanism avoid two successives lock and unlock. </p>
359
360</div>
361</div>
362<a class="anchor" id="a72d33c20718419d566e198840318e22f"></a>
363<div class="memitem">
364<div class="memproto">
365<table class="mlabels">
366 <tr>
367 <td class="mlabels-left">
368 <table class="memname">
369 <tr>
370 <td class="memname">void flair::gui::Box::GetMutex </td>
371 <td>(</td>
372 <td class="paramtype">void&#160;</td>
373 <td class="paramname"></td><td>)</td>
374 <td> const</td>
375 </tr>
376 </table>
377 </td>
378 <td class="mlabels-right">
379<span class="mlabels"><span class="mlabel">protected</span></span> </td>
380 </tr>
381</table>
382</div><div class="memdoc">
383
384<p>Get Mutex. </p>
385<p>This method must be called before changing <a class="el" href="classflair_1_1gui_1_1_box.html" title="Abstract class to display a box on the ground station. ">Box</a>'s value or calling <a class="el" href="classflair_1_1gui_1_1_box.html#a97997d50ef96b359564c2d6b94db1edc" title="Set the value changed flag. ">SetValueChanged()</a>. </p>
386
387</div>
388</div>
389<a class="anchor" id="a3d1e4e81c7c59a051368a346a104c988"></a>
390<div class="memitem">
391<div class="memproto">
392<table class="mlabels">
393 <tr>
394 <td class="mlabels-left">
395 <table class="memname">
396 <tr>
397 <td class="memname">void flair::gui::Box::ReleaseMutex </td>
398 <td>(</td>
399 <td class="paramtype">void&#160;</td>
400 <td class="paramname"></td><td>)</td>
401 <td> const</td>
402 </tr>
403 </table>
404 </td>
405 <td class="mlabels-right">
406<span class="mlabels"><span class="mlabel">protected</span></span> </td>
407 </tr>
408</table>
409</div><div class="memdoc">
410
411<p>Release Mutex. </p>
412<p>This method must be called after changing <a class="el" href="classflair_1_1gui_1_1_box.html" title="Abstract class to display a box on the ground station. ">Box</a>'s value or calling <a class="el" href="classflair_1_1gui_1_1_box.html#a97997d50ef96b359564c2d6b94db1edc" title="Set the value changed flag. ">SetValueChanged()</a>. </p>
413
414</div>
415</div>
416</div><!-- contents -->
417</div><!-- doc-content -->
418<!-- start footer part -->
419<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
420 <ul>
421 <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_box.html">Box</a></li>
422 <li class="footer">Generated on Thu Jan 31 2019 12:34:23 for Flair by
423 <a href="http://www.doxygen.org/index.html">
424 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
425 </ul>
426</div>
427</body>
428</html>
Note: See TracBrowser for help on using the repository browser.