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

Last change on this file since 33 was 33, checked in by Sanahuja Guillaume, 8 years ago

m
File size: 38.3 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<tr class="memitem:a9ba37bd7fad0f4a97175d922b93b5434"><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>
224<tr class="memdesc:a9ba37bd7fad0f4a97175d922b93b5434"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unset a persistent xml property. <a href="#a9ba37bd7fad0f4a97175d922b93b5434">More...</a><br /></td></tr>
225<tr class="separator:a9ba37bd7fad0f4a97175d922b93b5434"><td class="memSeparator" colspan="2">&#160;</td></tr>
226</table><table class="memberdecls">
227<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
228Additional Inherited Members</h2></td></tr>
229<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>
230<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,
231<b>Red</b> = 31,
232<b>Green</b> = 32,
233<b>Orange</b> = 33
234 }</td></tr>
235<tr class="separator:aed5fccda511f97487040fed29f4efc97 inherit pub_types_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
236</table>
237<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
238<div class="textblock"><p>Abstract class for all Framework's widget classes. </p>
239<p>A widget is an object to display on the ground station. <br />
240 Communication with ground station is done through xml files; properties of theses files are modified through appropriate method. <br />
241 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>
242</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
243<a class="anchor" id="a7b867cc6c603cbc5e5a2f39f083a9494"></a>
244<div class="memitem">
245<div class="memproto">
246 <table class="memname">
247 <tr>
248 <td class="memname">flair::gui::Widget::Widget </td>
249 <td>(</td>
250 <td class="paramtype">const <a class="el" href="classflair_1_1gui_1_1_widget.html">Widget</a> *&#160;</td>
251 <td class="paramname"><em>parent</em>, </td>
252 </tr>
253 <tr>
254 <td class="paramkey"></td>
255 <td></td>
256 <td class="paramtype">std::string&#160;</td>
257 <td class="paramname"><em>name</em>, </td>
258 </tr>
259 <tr>
260 <td class="paramkey"></td>
261 <td></td>
262 <td class="paramtype">std::string&#160;</td>
263 <td class="paramname"><em>type</em>&#160;</td>
264 </tr>
265 <tr>
266 <td></td>
267 <td>)</td>
268 <td></td><td></td>
269 </tr>
270 </table>
271</div><div class="memdoc">
272
273<p>Constructor. </p>
274<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 />
275 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 />
276 Type must agree with predifined (hard coded) types in ground station code.</p>
277<dl class="params"><dt>Parameters</dt><dd>
278 <table class="params">
279 <tr><td class="paramname">parent</td><td>parent </td></tr>
280 <tr><td class="paramname">name</td><td>name </td></tr>
281 <tr><td class="paramname">type</td><td>type </td></tr>
282 </table>
283 </dd>
284</dl>
285
286</div>
287</div>
288<a class="anchor" id="a81110928e09e909dc1cc90971de4e8a9"></a>
289<div class="memitem">
290<div class="memproto">
291<table class="mlabels">
292 <tr>
293 <td class="mlabels-left">
294 <table class="memname">
295 <tr>
296 <td class="memname">virtual flair::gui::Widget::~Widget </td>
297 <td>(</td>
298 <td class="paramname"></td><td>)</td>
299 <td></td>
300 </tr>
301 </table>
302 </td>
303 <td class="mlabels-right">
304<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
305 </tr>
306</table>
307</div><div class="memdoc">
308
309<p>Destructor. </p>
310
311</div>
312</div>
313<h2 class="groupheader">Member Function Documentation</h2>
314<a class="anchor" id="a814a933622114ad9c8f5d49014262d89"></a>
315<div class="memitem">
316<div class="memproto">
317 <table class="memname">
318 <tr>
319 <td class="memname">void flair::gui::Widget::setEnabled </td>
320 <td>(</td>
321 <td class="paramtype">bool&#160;</td>
322 <td class="paramname"><em>status</em></td><td>)</td>
323 <td></td>
324 </tr>
325 </table>
326</div><div class="memdoc">
327
328<p>Set enabled. </p>
329<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 />
330A disabled widget is greyed out on the ground station and in unmodifiable.</p>
331<dl class="params"><dt>Parameters</dt><dd>
332 <table class="params">
333 <tr><td class="paramname">status</td><td></td></tr>
334 </table>
335 </dd>
336</dl>
337
338</div>
339</div>
340<a class="anchor" id="a299877c38b297ada04542e4dfc5a2f4f"></a>
341<div class="memitem">
342<div class="memproto">
343 <table class="memname">
344 <tr>
345 <td class="memname">bool flair::gui::Widget::isEnabled </td>
346 <td>(</td>
347 <td class="paramtype">void&#160;</td>
348 <td class="paramname"></td><td>)</td>
349 <td> const</td>
350 </tr>
351 </table>
352</div><div class="memdoc">
353
354<p>Is enabled? </p>
355<dl class="section return"><dt>Returns</dt><dd>true if widget is enabled </dd></dl>
356
357</div>
358</div>
359<a class="anchor" id="a0e81847db5a84b2e7e26545c9b1b704f"></a>
360<div class="memitem">
361<div class="memproto">
362<div class="memtemplate">
363template&lt;typename T &gt; </div>
364<table class="mlabels">
365 <tr>
366 <td class="mlabels-left">
367 <table class="memname">
368 <tr>
369 <td class="memname">void flair::gui::Widget::SetPersistentXmlProp </td>
370 <td>(</td>
371 <td class="paramtype">std::string&#160;</td>
372 <td class="paramname"><em>prop</em>, </td>
373 </tr>
374 <tr>
375 <td class="paramkey"></td>
376 <td></td>
377 <td class="paramtype">T&#160;</td>
378 <td class="paramname"><em>value</em>&#160;</td>
379 </tr>
380 <tr>
381 <td></td>
382 <td>)</td>
383 <td></td><td></td>
384 </tr>
385 </table>
386 </td>
387 <td class="mlabels-right">
388<span class="mlabels"><span class="mlabel">protected</span></span> </td>
389 </tr>
390</table>
391</div><div class="memdoc">
392
393<p>Set a persistent xml property. </p>
394<p>The property will be saved in the configuration xml and also used to configure the ground station.</p>
395<dl class="params"><dt>Parameters</dt><dd>
396 <table class="params">
397 <tr><td class="paramname">prop</td><td>property to set and save </td></tr>
398 <tr><td class="paramname">value</td><td>value to set and save </td></tr>
399 </table>
400 </dd>
401</dl>
402
403</div>
404</div>
405<a class="anchor" id="a6404c7f474be994ec4e72a97e45dfffa"></a>
406<div class="memitem">
407<div class="memproto">
408<div class="memtemplate">
409template&lt;typename T &gt; </div>
410<table class="mlabels">
411 <tr>
412 <td class="mlabels-left">
413 <table class="memname">
414 <tr>
415 <td class="memname">bool flair::gui::Widget::GetPersistentXmlProp </td>
416 <td>(</td>
417 <td class="paramtype">std::string&#160;</td>
418 <td class="paramname"><em>prop</em>, </td>
419 </tr>
420 <tr>
421 <td class="paramkey"></td>
422 <td></td>
423 <td class="paramtype">T &amp;&#160;</td>
424 <td class="paramname"><em>value</em>&#160;</td>
425 </tr>
426 <tr>
427 <td></td>
428 <td>)</td>
429 <td></td><td></td>
430 </tr>
431 </table>
432 </td>
433 <td class="mlabels-right">
434<span class="mlabels"><span class="mlabel">protected</span></span> </td>
435 </tr>
436</table>
437</div><div class="memdoc">
438
439<p>Get a persistent xml property. </p>
440<p>Get the property from the xml file. If no corresponding property is found in the xml, value remains unchanged. <br />
441 Thus value can be initialized with a default value before calling this method.</p>
442<dl class="params"><dt>Parameters</dt><dd>
443 <table class="params">
444 <tr><td class="paramname">prop</td><td>property to get </td></tr>
445 <tr><td class="paramname">value</td><td>value to store the result </td></tr>
446 </table>
447 </dd>
448</dl>
449<dl class="section return"><dt>Returns</dt><dd>true if value was changed </dd></dl>
450
451</div>
452</div>
453<a class="anchor" id="abe5ab96255919238138527c92fbeb6d8"></a>
454<div class="memitem">
455<div class="memproto">
456<div class="memtemplate">
457template&lt;typename T &gt; </div>
458<table class="mlabels">
459 <tr>
460 <td class="mlabels-left">
461 <table class="memname">
462 <tr>
463 <td class="memname">void flair::gui::Widget::SetVolatileXmlProp </td>
464 <td>(</td>
465 <td class="paramtype">std::string&#160;</td>
466 <td class="paramname"><em>prop</em>, </td>
467 </tr>
468 <tr>
469 <td class="paramkey"></td>
470 <td></td>
471 <td class="paramtype">T&#160;</td>
472 <td class="paramname"><em>value</em>, </td>
473 </tr>
474 <tr>
475 <td class="paramkey"></td>
476 <td></td>
477 <td class="paramtype">xmlNodePtr&#160;</td>
478 <td class="paramname"><em>node</em> = <code>NULL</code>&#160;</td>
479 </tr>
480 <tr>
481 <td></td>
482 <td>)</td>
483 <td></td><td></td>
484 </tr>
485 </table>
486 </td>
487 <td class="mlabels-right">
488<span class="mlabels"><span class="mlabel">protected</span></span> </td>
489 </tr>
490</table>
491</div><div class="memdoc">
492
493<p>Set a volatile xml property. </p>
494<p>This property should be used to configure the ground station (one time init). <br />
495 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>
496<dl class="params"><dt>Parameters</dt><dd>
497 <table class="params">
498 <tr><td class="paramname">prop</td><td>property to set </td></tr>
499 <tr><td class="paramname">value</td><td>value to set </td></tr>
500 <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>
501 </table>
502 </dd>
503</dl>
504
505</div>
506</div>
507<a class="anchor" id="ac80f72906580f269b5881c1ef0b35afb"></a>
508<div class="memitem">
509<div class="memproto">
510<table class="mlabels">
511 <tr>
512 <td class="mlabels-left">
513 <table class="memname">
514 <tr>
515 <td class="memname">void flair::gui::Widget::SendXml </td>
516 <td>(</td>
517 <td class="paramtype">void&#160;</td>
518 <td class="paramname"></td><td>)</td>
519 <td></td>
520 </tr>
521 </table>
522 </td>
523 <td class="mlabels-right">
524<span class="mlabels"><span class="mlabel">protected</span></span> </td>
525 </tr>
526</table>
527</div><div class="memdoc">
528
529<p>Send xml. </p>
530<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 />
531 New changes will be taken into account by ground station. <br />
532 All volatile properties will be erased after calling ths method, as they should not be used anymore. </p>
533
534</div>
535</div>
536<a class="anchor" id="a92d4e0613146c9b348b388f3f75cca9e"></a>
537<div class="memitem">
538<div class="memproto">
539<table class="mlabels">
540 <tr>
541 <td class="mlabels-left">
542 <table class="memname">
543 <tr>
544 <td class="memname">virtual void flair::gui::Widget::XmlEvent </td>
545 <td>(</td>
546 <td class="paramtype">void&#160;</td>
547 <td class="paramname"></td><td>)</td>
548 <td></td>
549 </tr>
550 </table>
551 </td>
552 <td class="mlabels-right">
553<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
554 </tr>
555</table>
556</div><div class="memdoc">
557
558<p>Xml event. </p>
559<p>This method must be reimplemented to handle a xml event. <br />
560It is automatically called when something changed from ground station. <br />
561</p>
562
563</div>
564</div>
565<a class="anchor" id="a9ba37bd7fad0f4a97175d922b93b5434"></a>
566<div class="memitem">
567<div class="memproto">
568<table class="mlabels">
569 <tr>
570 <td class="mlabels-left">
571 <table class="memname">
572 <tr>
573 <td class="memname">void flair::gui::Widget::UnsetPersistentXmlProp </td>
574 <td>(</td>
575 <td class="paramtype">std::string&#160;</td>
576 <td class="paramname"><em>prop</em></td><td>)</td>
577 <td></td>
578 </tr>
579 </table>
580 </td>
581 <td class="mlabels-right">
582<span class="mlabels"><span class="mlabel">protected</span></span> </td>
583 </tr>
584</table>
585</div><div class="memdoc">
586
587<p>Unset a persistent xml property. </p>
588<p>Unset an existent property, so it won't be saved.</p>
589<dl class="params"><dt>Parameters</dt><dd>
590 <table class="params">
591 <tr><td class="paramname">prop</td><td>property to set </td></tr>
592 </table>
593 </dd>
594</dl>
595
596</div>
597</div>
598</div><!-- contents -->
599</div><!-- doc-content -->
600<!-- start footer part -->
601<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
602 <ul>
603 <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>
604 <li class="footer">Generated on Mon Aug 29 2016 15:26:02 for Flair by
605 <a href="http://www.doxygen.org/index.html">
606 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
607 </ul>
608</div>
609</body>
610</html>
Note: See TracBrowser for help on using the repository browser.