source: flair-dev/trunk/doc/Flair/classflair_1_1gui_1_1_widget.html @ 25

Last change on this file since 25 was 25, checked in by Bayard Gildas, 4 years ago

Plop

File size: 36.8 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::Widget 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_widget.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_widget-members.html">List of all members</a>  </div>
114  <div class="headertitle">
115<div class="title">flair::gui::Widget Class Reference</div>  </div>
116</div><!--header-->
117<div class="contents">
118
119<p>Abstract class for all Framework's widget classes. 
120 <a href="classflair_1_1gui_1_1_widget.html#details">More...</a></p>
121
122<p><code>#include &lt;<a class="el" href="_widget_8h_source.html">Widget.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::Widget:</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_widget.png" usemap="#flair::gui::Widget_map" alt=""/>
130  <map id="flair::gui::Widget_map" name="flair::gui::Widget_map">
131<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="519,0,682,24"/>
132<area href="classflair_1_1gui_1_1_box.html" title="Abstract class to display a box on the ground station. " alt="flair::gui::Box" shape="rect" coords="0,112,163,136"/>
133<area href="classflair_1_1gui_1_1_label.html" title="Class displaying a QLabel on the ground station. " alt="flair::gui::Label" shape="rect" coords="173,112,336,136"/>
134<area href="classflair_1_1gui_1_1_layout.html" title="Abstract class to display a layout on the ground station. " alt="flair::gui::Layout" shape="rect" coords="346,112,509,136"/>
135<area href="classflair_1_1gui_1_1_push_button.html" title="Class displaying a QPushButton on the ground station. " alt="flair::gui::PushButton" shape="rect" coords="519,112,682,136"/>
136<area href="classflair_1_1gui_1_1_send_data.html" title="Abstract class for sending datas to ground station. " alt="flair::gui::SendData" shape="rect" coords="692,112,855,136"/>
137<area href="classflair_1_1gui_1_1_tab_widget.html" title="Class displaying a QTabWidget on the ground station. " alt="flair::gui::TabWidget" shape="rect" coords="865,112,1028,136"/>
138<area href="classflair_1_1gui_1_1_text_edit.html" title="Class displaying a QTextEdit on the ground station. " alt="flair::gui::TextEdit" shape="rect" coords="1038,112,1201,136"/>
139<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="173,168,336,192"/>
140<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,224,336,248"/>
141<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="173,280,336,304"/>
142<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="173,336,336,360"/>
143<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="173,392,336,416"/>
144<area href="classflair_1_1gui_1_1_grid_layout.html" title="Class displaying a QGridLayout on the ground station. " alt="flair::gui::GridLayout" shape="rect" coords="519,168,682,192"/>
145<area href="classflair_1_1gui_1_1_group_box.html" title="Class displaying a QGroupBox on the ground station. " alt="flair::gui::GroupBox" shape="rect" coords="519,224,682,248"/>
146<area href="classflair_1_1gui_1_1_tab.html" title="Class displaying a QTab on the ground station. " alt="flair::gui::Tab" shape="rect" coords="519,280,682,304"/>
147<area href="classflair_1_1gui_1_1_data_plot.html" title="Abstract class to display plots on ground station. " alt="flair::gui::DataPlot" shape="rect" coords="865,168,1028,192"/>
148<area href="classflair_1_1gui_1_1_map.html" title="Class displaying a GPS map on the ground station. " alt="flair::gui::Map" shape="rect" coords="865,224,1028,248"/>
149<area href="classflair_1_1gui_1_1_picture.html" title="Class displaying a Picture on the ground station. " alt="flair::gui::Picture" shape="rect" coords="865,280,1028,304"/>
150<area href="classflair_1_1gui_1_1_range_finder_plot.html" title="Class displaying a 2D plot on the ground station for laser range finder like Hokuyo. " alt="flair::gui::RangeFinderPlot" shape="rect" coords="865,336,1028,360"/>
151</map>
152 </div></div>
153<table class="memberdecls">
154<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
155Public Member Functions</h2></td></tr>
156<tr class="memitem:a7b867cc6c603cbc5e5a2f39f083a9494"><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>
157<tr class="memdesc:a7b867cc6c603cbc5e5a2f39f083a9494"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a7b867cc6c603cbc5e5a2f39f083a9494">More...</a><br /></td></tr>
158<tr class="separator:a7b867cc6c603cbc5e5a2f39f083a9494"><td class="memSeparator" colspan="2">&#160;</td></tr>
159<tr class="memitem:a81110928e09e909dc1cc90971de4e8a9"><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>
160<tr class="memdesc:a81110928e09e909dc1cc90971de4e8a9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#a81110928e09e909dc1cc90971de4e8a9">More...</a><br /></td></tr>
161<tr class="separator:a81110928e09e909dc1cc90971de4e8a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
162<tr class="memitem:a814a933622114ad9c8f5d49014262d89"><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>
163<tr class="memdesc:a814a933622114ad9c8f5d49014262d89"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set enabled.  <a href="#a814a933622114ad9c8f5d49014262d89">More...</a><br /></td></tr>
164<tr class="separator:a814a933622114ad9c8f5d49014262d89"><td class="memSeparator" colspan="2">&#160;</td></tr>
165<tr class="memitem:a299877c38b297ada04542e4dfc5a2f4f"><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>
166<tr class="memdesc:a299877c38b297ada04542e4dfc5a2f4f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is enabled?  <a href="#a299877c38b297ada04542e4dfc5a2f4f">More...</a><br /></td></tr>
167<tr class="separator:a299877c38b297ada04542e4dfc5a2f4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
168<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>
169<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>
170<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>
171<tr class="separator:aec92383fd5bf68d9df10414862b7e95c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
172<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>
173<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>
174<tr class="separator:aa2bde0e6677bbef705c96c93cb06ad09 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
175<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>
176<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>
177<tr class="separator:a9b0344dff7e1c05424d9152c8274523a inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
178<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>
179<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>
180<tr class="separator:a609a250ec037fbcaf8957c8f1dcbfc53 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
181<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>
182<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>
183<tr class="separator:a360c112cc3017a5152ebf6e84d2efa70 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
184<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>
185<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>
186<tr class="separator:ae22db4d723ec2d50b3ba48f26a6a770c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
187<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>
188<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>
189<tr class="separator:a344f81cd35805a9501098bf727ac1a10 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
190<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>
191<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>
192<tr class="separator:af001feba14fc053aa778e61080a0b4cf inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
193<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>
194<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>
195<tr class="separator:a168b18451b2ee6126e1e81d452005ff6 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
196<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>
197<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>
198<tr class="separator:a3ca9694d29ec2b0491739879685df5ca inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
199<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>
200<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>
201<tr class="separator:a36cdd7f556e78b1bddd1d1fe4264bb85 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
202</table><table class="memberdecls">
203<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
204Protected Member Functions</h2></td></tr>
205<tr class="memitem:a0e81847db5a84b2e7e26545c9b1b704f"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
206<tr class="memitem:a0e81847db5a84b2e7e26545c9b1b704f"><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>
207<tr class="memdesc:a0e81847db5a84b2e7e26545c9b1b704f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a persistent xml property.  <a href="#a0e81847db5a84b2e7e26545c9b1b704f">More...</a><br /></td></tr>
208<tr class="separator:a0e81847db5a84b2e7e26545c9b1b704f"><td class="memSeparator" colspan="2">&#160;</td></tr>
209<tr class="memitem:a6404c7f474be994ec4e72a97e45dfffa"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
210<tr class="memitem:a6404c7f474be994ec4e72a97e45dfffa"><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>
211<tr class="memdesc:a6404c7f474be994ec4e72a97e45dfffa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a persistent xml property.  <a href="#a6404c7f474be994ec4e72a97e45dfffa">More...</a><br /></td></tr>
212<tr class="separator:a6404c7f474be994ec4e72a97e45dfffa"><td class="memSeparator" colspan="2">&#160;</td></tr>
213<tr class="memitem:abe5ab96255919238138527c92fbeb6d8"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
214<tr class="memitem:abe5ab96255919238138527c92fbeb6d8"><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>
215<tr class="memdesc:abe5ab96255919238138527c92fbeb6d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a volatile xml property.  <a href="#abe5ab96255919238138527c92fbeb6d8">More...</a><br /></td></tr>
216<tr class="separator:abe5ab96255919238138527c92fbeb6d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
217<tr class="memitem:ac80f72906580f269b5881c1ef0b35afb"><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>
218<tr class="memdesc:ac80f72906580f269b5881c1ef0b35afb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send xml.  <a href="#ac80f72906580f269b5881c1ef0b35afb">More...</a><br /></td></tr>
219<tr class="separator:ac80f72906580f269b5881c1ef0b35afb"><td class="memSeparator" colspan="2">&#160;</td></tr>
220<tr class="memitem:a92d4e0613146c9b348b388f3f75cca9e"><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>
221<tr class="memdesc:a92d4e0613146c9b348b388f3f75cca9e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Xml event.  <a href="#a92d4e0613146c9b348b388f3f75cca9e">More...</a><br /></td></tr>
222<tr class="separator:a92d4e0613146c9b348b388f3f75cca9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
223</table><table class="memberdecls">
224<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
225Additional Inherited Members</h2></td></tr>
226<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>
227<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,
228<b>Red</b> = 31,
229<b>Green</b> = 32,
230<b>Orange</b> = 33
231 }</td></tr>
232<tr class="separator:aed5fccda511f97487040fed29f4efc97 inherit pub_types_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
233</table>
234<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
235<div class="textblock"><p>Abstract class for all Framework's widget classes. </p>
236<p>A widget is an object to display on the ground station. <br />
237 Communication with ground station is done through xml files; properties of theses files are modified through appropriate method. <br />
238 A xml file is used for default values of the <a class="el" href="classflair_1_1gui_1_1_widget.html" title="Abstract class for all Framework&#39;s widget classes. ">Widget</a>, if it has been specified in the constructor of the FrameworkManager. </p>
239</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
240<a class="anchor" id="a7b867cc6c603cbc5e5a2f39f083a9494"></a>
241<div class="memitem">
242<div class="memproto">
243      <table class="memname">
244        <tr>
245          <td class="memname">flair::gui::Widget::Widget </td>
246          <td>(</td>
247          <td class="paramtype">const <a class="el" href="classflair_1_1gui_1_1_widget.html">Widget</a> *&#160;</td>
248          <td class="paramname"><em>parent</em>, </td>
249        </tr>
250        <tr>
251          <td class="paramkey"></td>
252          <td></td>
253          <td class="paramtype">std::string&#160;</td>
254          <td class="paramname"><em>name</em>, </td>
255        </tr>
256        <tr>
257          <td class="paramkey"></td>
258          <td></td>
259          <td class="paramtype">std::string&#160;</td>
260          <td class="paramname"><em>type</em>&#160;</td>
261        </tr>
262        <tr>
263          <td></td>
264          <td>)</td>
265          <td></td><td></td>
266        </tr>
267      </table>
268</div><div class="memdoc">
269
270<p>Constructor. </p>
271<p>Construct a <a class="el" href="classflair_1_1gui_1_1_widget.html" title="Abstract class for all Framework&#39;s widget classes. ">Widget</a>, the xml file specified to the FrameworkManager's constructor is sued for default values. <br />
272 Two <a class="el" href="classflair_1_1gui_1_1_widget.html" title="Abstract class for all Framework&#39;s widget classes. ">Widget</a> with same parent must have different names. If a brother <a class="el" href="classflair_1_1gui_1_1_widget.html" title="Abstract class for all Framework&#39;s widget classes. ">Widget</a> already has the same name, the name of the new one will be automatically changed. <br />
273 Type must agree with predifined (hard coded) types in ground station code.</p>
274<dl class="params"><dt>Parameters</dt><dd>
275  <table class="params">
276    <tr><td class="paramname">parent</td><td>parent </td></tr>
277    <tr><td class="paramname">name</td><td>name </td></tr>
278    <tr><td class="paramname">type</td><td>type </td></tr>
279  </table>
280  </dd>
281</dl>
282
283</div>
284</div>
285<a class="anchor" id="a81110928e09e909dc1cc90971de4e8a9"></a>
286<div class="memitem">
287<div class="memproto">
288<table class="mlabels">
289  <tr>
290  <td class="mlabels-left">
291      <table class="memname">
292        <tr>
293          <td class="memname">virtual flair::gui::Widget::~Widget </td>
294          <td>(</td>
295          <td class="paramname"></td><td>)</td>
296          <td></td>
297        </tr>
298      </table>
299  </td>
300  <td class="mlabels-right">
301<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
302  </tr>
303</table>
304</div><div class="memdoc">
305
306<p>Destructor. </p>
307
308</div>
309</div>
310<h2 class="groupheader">Member Function Documentation</h2>
311<a class="anchor" id="a814a933622114ad9c8f5d49014262d89"></a>
312<div class="memitem">
313<div class="memproto">
314      <table class="memname">
315        <tr>
316          <td class="memname">void flair::gui::Widget::setEnabled </td>
317          <td>(</td>
318          <td class="paramtype">bool&#160;</td>
319          <td class="paramname"><em>status</em></td><td>)</td>
320          <td></td>
321        </tr>
322      </table>
323</div><div class="memdoc">
324
325<p>Set enabled. </p>
326<p>Enable or disable the <a class="el" href="classflair_1_1gui_1_1_widget.html" title="Abstract class for all Framework&#39;s widget classes. ">Widget</a> on the ground station. <br />
327A disabled widget is greyed out on the ground station and in unmodifiable.</p>
328<dl class="params"><dt>Parameters</dt><dd>
329  <table class="params">
330    <tr><td class="paramname">status</td><td></td></tr>
331  </table>
332  </dd>
333</dl>
334
335</div>
336</div>
337<a class="anchor" id="a299877c38b297ada04542e4dfc5a2f4f"></a>
338<div class="memitem">
339<div class="memproto">
340      <table class="memname">
341        <tr>
342          <td class="memname">bool flair::gui::Widget::isEnabled </td>
343          <td>(</td>
344          <td class="paramtype">void&#160;</td>
345          <td class="paramname"></td><td>)</td>
346          <td> const</td>
347        </tr>
348      </table>
349</div><div class="memdoc">
350
351<p>Is enabled? </p>
352<dl class="section return"><dt>Returns</dt><dd>true if widget is enabled </dd></dl>
353
354</div>
355</div>
356<a class="anchor" id="a0e81847db5a84b2e7e26545c9b1b704f"></a>
357<div class="memitem">
358<div class="memproto">
359<div class="memtemplate">
360template&lt;typename T &gt; </div>
361<table class="mlabels">
362  <tr>
363  <td class="mlabels-left">
364      <table class="memname">
365        <tr>
366          <td class="memname">void flair::gui::Widget::SetPersistentXmlProp </td>
367          <td>(</td>
368          <td class="paramtype">std::string&#160;</td>
369          <td class="paramname"><em>prop</em>, </td>
370        </tr>
371        <tr>
372          <td class="paramkey"></td>
373          <td></td>
374          <td class="paramtype">T&#160;</td>
375          <td class="paramname"><em>value</em>&#160;</td>
376        </tr>
377        <tr>
378          <td></td>
379          <td>)</td>
380          <td></td><td></td>
381        </tr>
382      </table>
383  </td>
384  <td class="mlabels-right">
385<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
386  </tr>
387</table>
388</div><div class="memdoc">
389
390<p>Set a persistent xml property. </p>
391<p>The property will be saved in the configuration xml and also used to configure the ground station.</p>
392<dl class="params"><dt>Parameters</dt><dd>
393  <table class="params">
394    <tr><td class="paramname">prop</td><td>property to set and save </td></tr>
395    <tr><td class="paramname">value</td><td>value to set and save </td></tr>
396  </table>
397  </dd>
398</dl>
399
400</div>
401</div>
402<a class="anchor" id="a6404c7f474be994ec4e72a97e45dfffa"></a>
403<div class="memitem">
404<div class="memproto">
405<div class="memtemplate">
406template&lt;typename T &gt; </div>
407<table class="mlabels">
408  <tr>
409  <td class="mlabels-left">
410      <table class="memname">
411        <tr>
412          <td class="memname">bool flair::gui::Widget::GetPersistentXmlProp </td>
413          <td>(</td>
414          <td class="paramtype">std::string&#160;</td>
415          <td class="paramname"><em>prop</em>, </td>
416        </tr>
417        <tr>
418          <td class="paramkey"></td>
419          <td></td>
420          <td class="paramtype">T &amp;&#160;</td>
421          <td class="paramname"><em>value</em>&#160;</td>
422        </tr>
423        <tr>
424          <td></td>
425          <td>)</td>
426          <td></td><td></td>
427        </tr>
428      </table>
429  </td>
430  <td class="mlabels-right">
431<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
432  </tr>
433</table>
434</div><div class="memdoc">
435
436<p>Get a persistent xml property. </p>
437<p>Get the property from the xml file. If no corresponding property is found in the xml, value remains unchanged. <br />
438 Thus value can be initialized with a default value before calling this method.</p>
439<dl class="params"><dt>Parameters</dt><dd>
440  <table class="params">
441    <tr><td class="paramname">prop</td><td>property to get </td></tr>
442    <tr><td class="paramname">value</td><td>value to store the result </td></tr>
443  </table>
444  </dd>
445</dl>
446<dl class="section return"><dt>Returns</dt><dd>true if value was changed </dd></dl>
447
448</div>
449</div>
450<a class="anchor" id="abe5ab96255919238138527c92fbeb6d8"></a>
451<div class="memitem">
452<div class="memproto">
453<div class="memtemplate">
454template&lt;typename T &gt; </div>
455<table class="mlabels">
456  <tr>
457  <td class="mlabels-left">
458      <table class="memname">
459        <tr>
460          <td class="memname">void flair::gui::Widget::SetVolatileXmlProp </td>
461          <td>(</td>
462          <td class="paramtype">std::string&#160;</td>
463          <td class="paramname"><em>prop</em>, </td>
464        </tr>
465        <tr>
466          <td class="paramkey"></td>
467          <td></td>
468          <td class="paramtype">T&#160;</td>
469          <td class="paramname"><em>value</em>, </td>
470        </tr>
471        <tr>
472          <td class="paramkey"></td>
473          <td></td>
474          <td class="paramtype">xmlNodePtr&#160;</td>
475          <td class="paramname"><em>node</em> = <code>NULL</code>&#160;</td>
476        </tr>
477        <tr>
478          <td></td>
479          <td>)</td>
480          <td></td><td></td>
481        </tr>
482      </table>
483  </td>
484  <td class="mlabels-right">
485<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
486  </tr>
487</table>
488</div><div class="memdoc">
489
490<p>Set a volatile xml property. </p>
491<p>This property should be used to configure the ground station (one time init). <br />
492 The property will be destroyed after calling <a class="el" href="classflair_1_1gui_1_1_widget.html#ac80f72906580f269b5881c1ef0b35afb" title="Send xml. ">SendXml()</a> as it should no be used anymore.</p>
493<dl class="params"><dt>Parameters</dt><dd>
494  <table class="params">
495    <tr><td class="paramname">prop</td><td>property to set </td></tr>
496    <tr><td class="paramname">value</td><td>value to set </td></tr>
497    <tr><td class="paramname">node</td><td>if sepcified, node to set; otherwise use the node of the <a class="el" href="classflair_1_1gui_1_1_widget.html" title="Abstract class for all Framework&#39;s widget classes. ">Widget</a> </td></tr>
498  </table>
499  </dd>
500</dl>
501
502</div>
503</div>
504<a class="anchor" id="ac80f72906580f269b5881c1ef0b35afb"></a>
505<div class="memitem">
506<div class="memproto">
507<table class="mlabels">
508  <tr>
509  <td class="mlabels-left">
510      <table class="memname">
511        <tr>
512          <td class="memname">void flair::gui::Widget::SendXml </td>
513          <td>(</td>
514          <td class="paramtype">void&#160;</td>
515          <td class="paramname"></td><td>)</td>
516          <td></td>
517        </tr>
518      </table>
519  </td>
520  <td class="mlabels-right">
521<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
522  </tr>
523</table>
524</div><div class="memdoc">
525
526<p>Send xml. </p>
527<p>Send <a class="el" href="classflair_1_1gui_1_1_widget.html" title="Abstract class for all Framework&#39;s widget classes. ">Widget</a>'s xml to ground station. <br />
528 New changes will be taken into account by ground station. <br />
529 All volatile properties will be erased after calling ths method, as they should not be used anymore. </p>
530
531</div>
532</div>
533<a class="anchor" id="a92d4e0613146c9b348b388f3f75cca9e"></a>
534<div class="memitem">
535<div class="memproto">
536<table class="mlabels">
537  <tr>
538  <td class="mlabels-left">
539      <table class="memname">
540        <tr>
541          <td class="memname">virtual void flair::gui::Widget::XmlEvent </td>
542          <td>(</td>
543          <td class="paramtype">void&#160;</td>
544          <td class="paramname"></td><td>)</td>
545          <td></td>
546        </tr>
547      </table>
548  </td>
549  <td class="mlabels-right">
550<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>
551  </tr>
552</table>
553</div><div class="memdoc">
554
555<p>Xml event. </p>
556<p>This method must be reimplemented to handle a xml event. <br />
557It is automatically called when something changed from ground station. <br />
558</p>
559
560</div>
561</div>
562</div><!-- contents -->
563</div><!-- doc-content -->
564<!-- start footer part -->
565<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
566  <ul>
567    <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_widget.html">Widget</a></li>
568    <li class="footer">Generated on Wed Jun 22 2016 15:34:01 for Flair by
569    <a href="http://www.doxygen.org/index.html">
570    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
571  </ul>
572</div>
573</body>
574</html>
Note: See TracBrowser for help on using the repository browser.