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

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

doc
File size: 38.0 KB
Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6<meta name="generator" content="Doxygen 1.8.7"/>
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="navtree.js"></script>
14<script type="text/javascript">
15 $(document).ready(initResizable);
16 $(window).load(resizeHeight);
17</script>
18<link href="search/search.css" rel="stylesheet" type="text/css"/>
19<script type="text/javascript" src="search/search.js"></script>
20<script type="text/javascript">
21 $(document).ready(function() { searchBox.OnSelectItem(0); });
22</script>
23<link href="doxygen.css" rel="stylesheet" type="text/css" />
24</head>
25<body>
26<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
27<div id="titlearea">
28<table cellspacing="0" cellpadding="0">
29 <tbody>
30 <tr style="height: 56px;">
31 <td id="projectlogo"><img alt="Logo" src="logo_hds.png"/></td>
32 <td style="padding-left: 0.5em;">
33 <div id="projectname">Flair
34 </div>
35 <div id="projectbrief">Framework Libre Air</div>
36 </td>
37 </tr>
38 </tbody>
39</table>
40</div>
41<!-- end header part -->
42<!-- Generated by Doxygen 1.8.7 -->
43<script type="text/javascript">
44var searchBox = new SearchBox("searchBox", "search",false,'Search');
45</script>
46 <div id="navrow1" class="tabs">
47 <ul class="tablist">
48 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
49 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
50 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
51 <li><a href="files.html"><span>Files</span></a></li>
52 <li>
53 <div id="MSearchBox" class="MSearchBoxInactive">
54 <span class="left">
55 <img id="MSearchSelect" src="search/mag_sel.png"
56 onmouseover="return searchBox.OnSearchSelectShow()"
57 onmouseout="return searchBox.OnSearchSelectHide()"
58 alt=""/>
59 <input type="text" id="MSearchField" value="Search" accesskey="S"
60 onfocus="searchBox.OnSearchFieldFocus(true)"
61 onblur="searchBox.OnSearchFieldFocus(false)"
62 onkeyup="searchBox.OnSearchFieldChange(event)"/>
63 </span><span class="right">
64 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
65 </span>
66 </div>
67 </li>
68 </ul>
69 </div>
70 <div id="navrow2" class="tabs2">
71 <ul class="tablist">
72 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
73 <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
74 <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
75 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
76 </ul>
77 </div>
78</div><!-- top -->
79<div id="side-nav" class="ui-resizable side-nav-resizable">
80 <div id="nav-tree">
81 <div id="nav-tree-contents">
82 <div id="nav-sync" class="sync"></div>
83 </div>
84 </div>
85 <div id="splitbar" style="-moz-user-select:none;"
86 class="ui-resizable-handle">
87 </div>
88</div>
89<script type="text/javascript">
90$(document).ready(function(){initNavTree('classflair_1_1gui_1_1_widget.html','');});
91</script>
92<div id="doc-content">
93<!-- window showing the filter options -->
94<div id="MSearchSelectWindow"
95 onmouseover="return searchBox.OnSearchSelectShow()"
96 onmouseout="return searchBox.OnSearchSelectHide()"
97 onkeydown="return searchBox.OnSearchSelectKey(event)">
98<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Properties</a></div>
99
100<!-- iframe showing the search results (closed by default) -->
101<div id="MSearchResultsWindow">
102<iframe src="javascript:void(0)" frameborder="0"
103 name="MSearchResults" id="MSearchResults">
104</iframe>
105</div>
106
107<div class="header">
108 <div class="summary">
109<a href="#pub-methods">Public Member Functions</a> &#124;
110<a href="#pro-methods">Protected Member Functions</a> &#124;
111<a href="classflair_1_1gui_1_1_widget-members.html">List of all members</a> </div>
112 <div class="headertitle">
113<div class="title">flair::gui::Widget Class Reference</div> </div>
114</div><!--header-->
115<div class="contents">
116
117<p>Abstract class for all Framework's widget classes.
118 <a href="classflair_1_1gui_1_1_widget.html#details">More...</a></p>
119
120<p><code>#include &lt;<a class="el" href="_widget_8h_source.html">Widget.h</a>&gt;</code></p>
121<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
122 <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for flair::gui::Widget:</div>
123<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
124</div>
125<div id="dynsection-0-content" class="dyncontent" style="display:none;">
126 <div class="center">
127 <img src="classflair_1_1gui_1_1_widget.png" usemap="#flair::gui::Widget_map" alt=""/>
128 <map id="flair::gui::Widget_map" name="flair::gui::Widget_map">
129<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"/>
130<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"/>
131<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"/>
132<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"/>
133<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"/>
134<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"/>
135<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"/>
136<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"/>
137<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"/>
138<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"/>
139<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"/>
140<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"/>
141<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"/>
142<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"/>
143<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"/>
144<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"/>
145<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"/>
146<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"/>
147<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"/>
148<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"/>
149</map>
150 </div></div>
151<table class="memberdecls">
152<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
153Public Member Functions</h2></td></tr>
154<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>
155<tr class="memdesc:a7b867cc6c603cbc5e5a2f39f083a9494"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="#a7b867cc6c603cbc5e5a2f39f083a9494">More...</a><br /></td></tr>
156<tr class="separator:a7b867cc6c603cbc5e5a2f39f083a9494"><td class="memSeparator" colspan="2">&#160;</td></tr>
157<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>
158<tr class="memdesc:a81110928e09e909dc1cc90971de4e8a9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <a href="#a81110928e09e909dc1cc90971de4e8a9">More...</a><br /></td></tr>
159<tr class="separator:a81110928e09e909dc1cc90971de4e8a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
160<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>
161<tr class="memdesc:a814a933622114ad9c8f5d49014262d89"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set enabled. <a href="#a814a933622114ad9c8f5d49014262d89">More...</a><br /></td></tr>
162<tr class="separator:a814a933622114ad9c8f5d49014262d89"><td class="memSeparator" colspan="2">&#160;</td></tr>
163<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>
164<tr class="memdesc:a299877c38b297ada04542e4dfc5a2f4f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is enabled? <a href="#a299877c38b297ada04542e4dfc5a2f4f">More...</a><br /></td></tr>
165<tr class="separator:a299877c38b297ada04542e4dfc5a2f4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
166<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>
167<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>
168<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>
169<tr class="separator:aec92383fd5bf68d9df10414862b7e95c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
170<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>
171<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>
172<tr class="separator:aa2bde0e6677bbef705c96c93cb06ad09 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
173<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>
174<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>
175<tr class="separator:a9b0344dff7e1c05424d9152c8274523a inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
176<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>
177<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>
178<tr class="separator:a609a250ec037fbcaf8957c8f1dcbfc53 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
179<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>
180<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>
181<tr class="separator:a360c112cc3017a5152ebf6e84d2efa70 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
182<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>
183<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>
184<tr class="separator:ae22db4d723ec2d50b3ba48f26a6a770c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
185<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>
186<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>
187<tr class="separator:a344f81cd35805a9501098bf727ac1a10 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
188<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>
189<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>
190<tr class="separator:af001feba14fc053aa778e61080a0b4cf inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
191<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>
192<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>
193<tr class="separator:a168b18451b2ee6126e1e81d452005ff6 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
194<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>
195<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>
196<tr class="separator:a3ca9694d29ec2b0491739879685df5ca inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
197<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>
198<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>
199<tr class="separator:a36cdd7f556e78b1bddd1d1fe4264bb85 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
200</table><table class="memberdecls">
201<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
202Protected Member Functions</h2></td></tr>
203<tr class="memitem:a0e81847db5a84b2e7e26545c9b1b704f"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
204<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>
205<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>
206<tr class="separator:a0e81847db5a84b2e7e26545c9b1b704f"><td class="memSeparator" colspan="2">&#160;</td></tr>
207<tr class="memitem:a6404c7f474be994ec4e72a97e45dfffa"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
208<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>
209<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>
210<tr class="separator:a6404c7f474be994ec4e72a97e45dfffa"><td class="memSeparator" colspan="2">&#160;</td></tr>
211<tr class="memitem:abe5ab96255919238138527c92fbeb6d8"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
212<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>
213<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>
214<tr class="separator:abe5ab96255919238138527c92fbeb6d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
215<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>
216<tr class="memdesc:ac80f72906580f269b5881c1ef0b35afb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send xml. <a href="#ac80f72906580f269b5881c1ef0b35afb">More...</a><br /></td></tr>
217<tr class="separator:ac80f72906580f269b5881c1ef0b35afb"><td class="memSeparator" colspan="2">&#160;</td></tr>
218<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>
219<tr class="memdesc:a92d4e0613146c9b348b388f3f75cca9e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Xml event. <a href="#a92d4e0613146c9b348b388f3f75cca9e">More...</a><br /></td></tr>
220<tr class="separator:a92d4e0613146c9b348b388f3f75cca9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
221</table><table class="memberdecls">
222<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
223Additional Inherited Members</h2></td></tr>
224<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>
225<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,
226<b>Red</b> = 31,
227<b>Green</b> = 32,
228<b>Orange</b> = 33
229 }</td></tr>
230<tr class="separator:aed5fccda511f97487040fed29f4efc97 inherit pub_types_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
231</table>
232<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
233<div class="textblock"><p>Abstract class for all Framework's widget classes. </p>
234<p>A widget is an object to display on the ground station. <br />
235 Communication with ground station is done through xml files; properties of theses files are modified through appropriate method. <br />
236 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>
237</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
238<a class="anchor" id="a7b867cc6c603cbc5e5a2f39f083a9494"></a>
239<div class="memitem">
240<div class="memproto">
241 <table class="memname">
242 <tr>
243 <td class="memname">flair::gui::Widget::Widget </td>
244 <td>(</td>
245 <td class="paramtype">const <a class="el" href="classflair_1_1gui_1_1_widget.html">Widget</a> *&#160;</td>
246 <td class="paramname"><em>parent</em>, </td>
247 </tr>
248 <tr>
249 <td class="paramkey"></td>
250 <td></td>
251 <td class="paramtype">std::string&#160;</td>
252 <td class="paramname"><em>name</em>, </td>
253 </tr>
254 <tr>
255 <td class="paramkey"></td>
256 <td></td>
257 <td class="paramtype">std::string&#160;</td>
258 <td class="paramname"><em>type</em>&#160;</td>
259 </tr>
260 <tr>
261 <td></td>
262 <td>)</td>
263 <td></td><td></td>
264 </tr>
265 </table>
266</div><div class="memdoc">
267
268<p>Constructor. </p>
269<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 />
270 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 />
271 Type must agree with predifined (hard coded) types in ground station code.</p>
272<dl class="params"><dt>Parameters</dt><dd>
273 <table class="params">
274 <tr><td class="paramname">parent</td><td>parent </td></tr>
275 <tr><td class="paramname">name</td><td>name </td></tr>
276 <tr><td class="paramname">type</td><td>type </td></tr>
277 </table>
278 </dd>
279</dl>
280
281</div>
282</div>
283<a class="anchor" id="a81110928e09e909dc1cc90971de4e8a9"></a>
284<div class="memitem">
285<div class="memproto">
286<table class="mlabels">
287 <tr>
288 <td class="mlabels-left">
289 <table class="memname">
290 <tr>
291 <td class="memname">virtual flair::gui::Widget::~Widget </td>
292 <td>(</td>
293 <td class="paramname"></td><td>)</td>
294 <td></td>
295 </tr>
296 </table>
297 </td>
298 <td class="mlabels-right">
299<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
300 </tr>
301</table>
302</div><div class="memdoc">
303
304<p>Destructor. </p>
305
306</div>
307</div>
308<h2 class="groupheader">Member Function Documentation</h2>
309<a class="anchor" id="a814a933622114ad9c8f5d49014262d89"></a>
310<div class="memitem">
311<div class="memproto">
312 <table class="memname">
313 <tr>
314 <td class="memname">void flair::gui::Widget::setEnabled </td>
315 <td>(</td>
316 <td class="paramtype">bool&#160;</td>
317 <td class="paramname"><em>status</em></td><td>)</td>
318 <td></td>
319 </tr>
320 </table>
321</div><div class="memdoc">
322
323<p>Set enabled. </p>
324<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 />
325A disabled widget is greyed out on the ground station and in unmodifiable.</p>
326<dl class="params"><dt>Parameters</dt><dd>
327 <table class="params">
328 <tr><td class="paramname">status</td><td></td></tr>
329 </table>
330 </dd>
331</dl>
332
333</div>
334</div>
335<a class="anchor" id="a299877c38b297ada04542e4dfc5a2f4f"></a>
336<div class="memitem">
337<div class="memproto">
338 <table class="memname">
339 <tr>
340 <td class="memname">bool flair::gui::Widget::isEnabled </td>
341 <td>(</td>
342 <td class="paramtype">void&#160;</td>
343 <td class="paramname"></td><td>)</td>
344 <td> const</td>
345 </tr>
346 </table>
347</div><div class="memdoc">
348
349<p>Is enabled? </p>
350<dl class="section return"><dt>Returns</dt><dd>true if widget is enabled </dd></dl>
351
352</div>
353</div>
354<a class="anchor" id="a0e81847db5a84b2e7e26545c9b1b704f"></a>
355<div class="memitem">
356<div class="memproto">
357<div class="memtemplate">
358template&lt;typename T &gt; </div>
359<table class="mlabels">
360 <tr>
361 <td class="mlabels-left">
362 <table class="memname">
363 <tr>
364 <td class="memname">void flair::gui::Widget::SetPersistentXmlProp </td>
365 <td>(</td>
366 <td class="paramtype">std::string&#160;</td>
367 <td class="paramname"><em>prop</em>, </td>
368 </tr>
369 <tr>
370 <td class="paramkey"></td>
371 <td></td>
372 <td class="paramtype">T&#160;</td>
373 <td class="paramname"><em>value</em>&#160;</td>
374 </tr>
375 <tr>
376 <td></td>
377 <td>)</td>
378 <td></td><td></td>
379 </tr>
380 </table>
381 </td>
382 <td class="mlabels-right">
383<span class="mlabels"><span class="mlabel">protected</span></span> </td>
384 </tr>
385</table>
386</div><div class="memdoc">
387
388<p>Set a persistent xml property. </p>
389<p>The property will be saved in the configuration xml and also used to configure the ground station.</p>
390<dl class="params"><dt>Parameters</dt><dd>
391 <table class="params">
392 <tr><td class="paramname">prop</td><td>property to set and save </td></tr>
393 <tr><td class="paramname">value</td><td>value to set and save </td></tr>
394 </table>
395 </dd>
396</dl>
397
398</div>
399</div>
400<a class="anchor" id="a6404c7f474be994ec4e72a97e45dfffa"></a>
401<div class="memitem">
402<div class="memproto">
403<div class="memtemplate">
404template&lt;typename T &gt; </div>
405<table class="mlabels">
406 <tr>
407 <td class="mlabels-left">
408 <table class="memname">
409 <tr>
410 <td class="memname">bool flair::gui::Widget::GetPersistentXmlProp </td>
411 <td>(</td>
412 <td class="paramtype">std::string&#160;</td>
413 <td class="paramname"><em>prop</em>, </td>
414 </tr>
415 <tr>
416 <td class="paramkey"></td>
417 <td></td>
418 <td class="paramtype">T &amp;&#160;</td>
419 <td class="paramname"><em>value</em>&#160;</td>
420 </tr>
421 <tr>
422 <td></td>
423 <td>)</td>
424 <td></td><td></td>
425 </tr>
426 </table>
427 </td>
428 <td class="mlabels-right">
429<span class="mlabels"><span class="mlabel">protected</span></span> </td>
430 </tr>
431</table>
432</div><div class="memdoc">
433
434<p>Get a persistent xml property. </p>
435<p>Get the property from the xml file. If no corresponding property is found in the xml, value remains unchanged. <br />
436 Thus value can be initialized with a default value before calling this method.</p>
437<dl class="params"><dt>Parameters</dt><dd>
438 <table class="params">
439 <tr><td class="paramname">prop</td><td>property to get </td></tr>
440 <tr><td class="paramname">value</td><td>value to store the result </td></tr>
441 </table>
442 </dd>
443</dl>
444<dl class="section return"><dt>Returns</dt><dd>true if value was changed </dd></dl>
445
446</div>
447</div>
448<a class="anchor" id="abe5ab96255919238138527c92fbeb6d8"></a>
449<div class="memitem">
450<div class="memproto">
451<div class="memtemplate">
452template&lt;typename T &gt; </div>
453<table class="mlabels">
454 <tr>
455 <td class="mlabels-left">
456 <table class="memname">
457 <tr>
458 <td class="memname">void flair::gui::Widget::SetVolatileXmlProp </td>
459 <td>(</td>
460 <td class="paramtype">std::string&#160;</td>
461 <td class="paramname"><em>prop</em>, </td>
462 </tr>
463 <tr>
464 <td class="paramkey"></td>
465 <td></td>
466 <td class="paramtype">T&#160;</td>
467 <td class="paramname"><em>value</em>, </td>
468 </tr>
469 <tr>
470 <td class="paramkey"></td>
471 <td></td>
472 <td class="paramtype">xmlNodePtr&#160;</td>
473 <td class="paramname"><em>node</em> = <code>NULL</code>&#160;</td>
474 </tr>
475 <tr>
476 <td></td>
477 <td>)</td>
478 <td></td><td></td>
479 </tr>
480 </table>
481 </td>
482 <td class="mlabels-right">
483<span class="mlabels"><span class="mlabel">protected</span></span> </td>
484 </tr>
485</table>
486</div><div class="memdoc">
487
488<p>Set a volatile xml property. </p>
489<p>This property should be used to configure the ground station (one time init). <br />
490 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>
491<dl class="params"><dt>Parameters</dt><dd>
492 <table class="params">
493 <tr><td class="paramname">prop</td><td>property to set </td></tr>
494 <tr><td class="paramname">value</td><td>value to set </td></tr>
495 <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>
496 </table>
497 </dd>
498</dl>
499
500</div>
501</div>
502<a class="anchor" id="ac80f72906580f269b5881c1ef0b35afb"></a>
503<div class="memitem">
504<div class="memproto">
505<table class="mlabels">
506 <tr>
507 <td class="mlabels-left">
508 <table class="memname">
509 <tr>
510 <td class="memname">void flair::gui::Widget::SendXml </td>
511 <td>(</td>
512 <td class="paramtype">void&#160;</td>
513 <td class="paramname"></td><td>)</td>
514 <td></td>
515 </tr>
516 </table>
517 </td>
518 <td class="mlabels-right">
519<span class="mlabels"><span class="mlabel">protected</span></span> </td>
520 </tr>
521</table>
522</div><div class="memdoc">
523
524<p>Send xml. </p>
525<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 />
526 New changes will be taken into account by ground station. <br />
527 All volatile properties will be erased after calling ths method, as they should not be used anymore. </p>
528
529</div>
530</div>
531<a class="anchor" id="a92d4e0613146c9b348b388f3f75cca9e"></a>
532<div class="memitem">
533<div class="memproto">
534<table class="mlabels">
535 <tr>
536 <td class="mlabels-left">
537 <table class="memname">
538 <tr>
539 <td class="memname">virtual void flair::gui::Widget::XmlEvent </td>
540 <td>(</td>
541 <td class="paramtype">void&#160;</td>
542 <td class="paramname"></td><td>)</td>
543 <td></td>
544 </tr>
545 </table>
546 </td>
547 <td class="mlabels-right">
548<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
549 </tr>
550</table>
551</div><div class="memdoc">
552
553<p>Xml event. </p>
554<p>This method must be reimplemented to handle a xml event. <br />
555It is automatically called when something changed from ground station. <br />
556</p>
557
558</div>
559</div>
560</div><!-- contents -->
561</div><!-- doc-content -->
562<!-- start footer part -->
563<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
564 <ul>
565 <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>
566 <li class="footer">Generated on Mon Apr 18 2016 17:27:09 for Flair by
567 <a href="http://www.doxygen.org/index.html">
568 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </li>
569 </ul>
570</div>
571</body>
572</html>
Note: See TracBrowser for help on using the repository browser.