File: classCEGUI_1_1GroupBox.html

package info (click to toggle)
cegui-mk2 0.7.6-2
  • links: PTS
  • area: main
  • in suites: wheezy
  • size: 105,384 kB
  • sloc: cpp: 142,729; ansic: 27,984; sh: 11,010; makefile: 2,275; python: 916; xml: 17
file content (212 lines) | stat: -rw-r--r-- 16,140 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Crazy Eddies GUI System: CEGUI::GroupBox Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript">
function hasClass(ele,cls) {
  return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));
}

function addClass(ele,cls) {
  if (!this.hasClass(ele,cls)) ele.className += " "+cls;
}

function removeClass(ele,cls) {
  if (hasClass(ele,cls)) {
    var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');
    ele.className=ele.className.replace(reg,' ');
  }
}

function toggleVisibility(linkObj) {
 var base = linkObj.getAttribute('id');
 var summary = document.getElementById(base + '-summary');
 var content = document.getElementById(base + '-content');
 var trigger = document.getElementById(base + '-trigger');
 if ( hasClass(linkObj,'closed') ) {
   summary.style.display = 'none';
   content.style.display = 'block';
   trigger.src = 'open.png';
   removeClass(linkObj,'closed');
   addClass(linkObj,'opened');
 } else if ( hasClass(linkObj,'opened') ) {
   summary.style.display = 'block';
   content.style.display = 'none';
   trigger.src = 'closed.png';
   removeClass(linkObj,'opened');
   addClass(linkObj,'closed');
 }
 return false;
}
</script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">Crazy Eddies GUI System&#160;<span id="projectnumber">0.7.6</span></div>
  </td>
 </tr>
 </tbody>
</table>
</div>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="namespaceCEGUI.html">CEGUI</a>      </li>
      <li class="navelem"><a class="el" href="classCEGUI_1_1GroupBox.html">GroupBox</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="#pro-methods">Protected Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">CEGUI::GroupBox Class Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::GroupBox" --><!-- doxytag: inherits="CEGUI::Window" -->
<p>Base class for standard <a class="el" href="classCEGUI_1_1GroupBox.html" title="Base class for standard GroupBox widget.">GroupBox</a> widget.  
 <a href="classCEGUI_1_1GroupBox.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png"/> Inheritance diagram for CEGUI::GroupBox:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classCEGUI_1_1GroupBox__inherit__graph.gif" border="0" usemap="#CEGUI_1_1GroupBox_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1GroupBox_inherit__map" id="CEGUI_1_1GroupBox_inherit__map">
<area shape="rect" id="node2" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv..." alt="" coords="16,83,136,112"/><area shape="rect" id="node4" href="classCEGUI_1_1PropertySet.html" title="Class that contains a collection of Property objects." alt="" coords="5,5,147,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-1-trigger" src="closed.png"/> Collaboration diagram for CEGUI::GroupBox:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classCEGUI_1_1GroupBox__coll__graph.gif" border="0" usemap="#CEGUI_1_1GroupBox_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1GroupBox_coll__map" id="CEGUI_1_1GroupBox_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv..." alt="" coords="29,287,149,316"/><area shape="rect" id="node4" href="classCEGUI_1_1PropertySet.html" title="Class that contains a collection of Property objects." alt="" coords="5,5,147,35"/><area shape="rect" id="node6" href="classCEGUI_1_1String.html" title="String class used within the GUI system." alt="" coords="221,5,328,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classCEGUI_1_1GroupBox-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a29e2dbf600a0c9d6b447753ce05bf8a2"></a><!-- doxytag: member="CEGUI::GroupBox::GroupBox" ref="a29e2dbf600a0c9d6b447753ce05bf8a2" args="(const String &amp;type, const String &amp;name)" -->
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1GroupBox.html#a29e2dbf600a0c9d6b447753ce05bf8a2">GroupBox</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;type, const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;name)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor for <a class="el" href="classCEGUI_1_1GroupBox.html" title="Base class for standard GroupBox widget.">GroupBox</a> class. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a72246e69255fa5350a4c2513e73fd041"></a><!-- doxytag: member="CEGUI::GroupBox::~GroupBox" ref="a72246e69255fa5350a4c2513e73fd041" args="()" -->
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1GroupBox.html#a72246e69255fa5350a4c2513e73fd041">~GroupBox</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor for <a class="el" href="classCEGUI_1_1GroupBox.html" title="Base class for standard GroupBox widget.">GroupBox</a> class. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a25a2a3eb8d68c4ebf80c75fefbfe26ec"></a><!-- doxytag: member="CEGUI::GroupBox::drawAroundWidget" ref="a25a2a3eb8d68c4ebf80c75fefbfe26ec" args="(const CEGUI::Window *wnd)" -->
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1GroupBox.html#a25a2a3eb8d68c4ebf80c75fefbfe26ec">drawAroundWidget</a> (const <a class="el" href="classCEGUI_1_1Window.html">CEGUI::Window</a> *wnd)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Draws the <a class="el" href="classCEGUI_1_1GroupBox.html" title="Base class for standard GroupBox widget.">GroupBox</a> around a widget. The size and position of the <a class="el" href="classCEGUI_1_1GroupBox.html" title="Base class for standard GroupBox widget.">GroupBox</a> are overriden. Once the window that is drawn around resizes, you'll have to call the function again. FIXME. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3d820d9565bb38f8605baa4b5d7511bf"></a><!-- doxytag: member="CEGUI::GroupBox::drawAroundWidget" ref="a3d820d9565bb38f8605baa4b5d7511bf" args="(const String &amp;name)" -->
bool&#160;</td><td class="memItemRight" valign="bottom"><b>drawAroundWidget</b> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;name)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1GroupBox.html#ad48484d4bd137e8c6dd39535a4a34bc0">testClassName_impl</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;class_name) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return whether this window was inherited from the given class name at some point in the inheritance hierarchy.  <a href="#ad48484d4bd137e8c6dd39535a4a34bc0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1Window.html">Window</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1GroupBox.html#aa465ea72adcf5b34cce0cc01e296d3f9">getContentPane</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the content pane held by this <a class="el" href="classCEGUI_1_1GroupBox.html" title="Base class for standard GroupBox widget.">GroupBox</a>.  <a href="#aa465ea72adcf5b34cce0cc01e296d3f9"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae3e72174c0fd3361bb7bfc97d3efd32e"></a><!-- doxytag: member="CEGUI::GroupBox::EventNamespace" ref="ae3e72174c0fd3361bb7bfc97d3efd32e" args="" -->
static const <a class="el" href="classCEGUI_1_1String.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1GroupBox.html#ae3e72174c0fd3361bb7bfc97d3efd32e">EventNamespace</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Namespace for global events. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab2951971efebf75d7d1b1bdece6c973f"></a><!-- doxytag: member="CEGUI::GroupBox::WidgetTypeName" ref="ab2951971efebf75d7d1b1bdece6c973f" args="" -->
static const <a class="el" href="classCEGUI_1_1String.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><b>WidgetTypeName</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab8a39fa76992200bb722e2074ea72511"></a><!-- doxytag: member="CEGUI::GroupBox::ContentPaneNameSuffix" ref="ab8a39fa76992200bb722e2074ea72511" args="" -->
static const <a class="el" href="classCEGUI_1_1String.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><b>ContentPaneNameSuffix</b></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae84b3c5a5677f489ab5617a9553e3625"></a><!-- doxytag: member="CEGUI::GroupBox::initialiseComponents" ref="ae84b3c5a5677f489ab5617a9553e3625" args="()" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1GroupBox.html#ae84b3c5a5677f489ab5617a9553e3625">initialiseComponents</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the components necessary. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad2aa14d31bf1cee61e7e045985b51c3b"></a><!-- doxytag: member="CEGUI::GroupBox::addChild_impl" ref="ad2aa14d31bf1cee61e7e045985b51c3b" args="(Window *wnd)" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1GroupBox.html#ad2aa14d31bf1cee61e7e045985b51c3b">addChild_impl</a> (<a class="el" href="classCEGUI_1_1Window.html">Window</a> *wnd)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Add given window to child list at an appropriate position. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa0e70889bbcb0f343ae8d714b250c29f"></a><!-- doxytag: member="CEGUI::GroupBox::removeChild_impl" ref="aa0e70889bbcb0f343ae8d714b250c29f" args="(Window *wnd)" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1GroupBox.html#aa0e70889bbcb0f343ae8d714b250c29f">removeChild_impl</a> (<a class="el" href="classCEGUI_1_1Window.html">Window</a> *wnd)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove our child again when necessary. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Base class for standard <a class="el" href="classCEGUI_1_1GroupBox.html" title="Base class for standard GroupBox widget.">GroupBox</a> widget. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aa465ea72adcf5b34cce0cc01e296d3f9"></a><!-- doxytag: member="CEGUI::GroupBox::getContentPane" ref="aa465ea72adcf5b34cce0cc01e296d3f9" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classCEGUI_1_1Window.html">Window</a>* CEGUI::GroupBox::getContentPane </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns the content pane held by this <a class="el" href="classCEGUI_1_1GroupBox.html" title="Base class for standard GroupBox widget.">GroupBox</a>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to a <a class="el" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv...">Window</a> instance. </dd></dl>

</div>
</div>
<a class="anchor" id="ad48484d4bd137e8c6dd39535a4a34bc0"></a><!-- doxytag: member="CEGUI::GroupBox::testClassName_impl" ref="ad48484d4bd137e8c6dd39535a4a34bc0" args="(const String &amp;class_name) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool CEGUI::GroupBox::testClassName_impl </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;&#160;</td>
          <td class="paramname"><em>class_name</em></td><td>)</td>
          <td> const<code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Return whether this window was inherited from the given class name at some point in the inheritance hierarchy. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">class_name</td><td>The class name that is to be checked.</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if this window was inherited from <em>class_name</em>. false if not. </dd></dl>

<p>Reimplemented from <a class="el" href="classCEGUI_1_1Window.html#a2b58cf00b4790c9cb08acfc18d5d3b0b">CEGUI::Window</a>.</p>

<p>References <a class="el" href="classCEGUI_1_1Window.html#a2b58cf00b4790c9cb08acfc18d5d3b0b">CEGUI::Window::testClassName_impl()</a>.</p>

</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:41 for Crazy Eddies GUI System by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>