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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
|
<!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::FalagardScrollablePane 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 <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 Page</span></a></li>
<li><a href="pages.html"><span>Related 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 List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class 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_1FalagardScrollablePane.html">FalagardScrollablePane</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-attribs">Static Public Attributes</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">CEGUI::FalagardScrollablePane Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::FalagardScrollablePane" --><!-- doxytag: inherits="CEGUI::ScrollablePaneWindowRenderer" -->
<p><a class="el" href="classCEGUI_1_1ScrollablePane.html" title="Base class for the ScrollablePane widget.">ScrollablePane</a> class for the FalagardBase module.
<a href="classCEGUI_1_1FalagardScrollablePane.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::FalagardScrollablePane:</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_1FalagardScrollablePane__inherit__graph.gif" border="0" usemap="#CEGUI_1_1FalagardScrollablePane_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1FalagardScrollablePane_inherit__map" id="CEGUI_1_1FalagardScrollablePane_inherit__map">
<area shape="rect" id="node2" href="classCEGUI_1_1ScrollablePaneWindowRenderer.html" title="Base class for ScrollablePane window renderer objects." alt="" coords="5,83,264,112"/><area shape="rect" id="node4" href="classCEGUI_1_1WindowRenderer.html" title="Base-class for the assignable WindowRenderer object." alt="" coords="48,5,221,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::FalagardScrollablePane:</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_1FalagardScrollablePane__coll__graph.gif" border="0" usemap="#CEGUI_1_1FalagardScrollablePane_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1FalagardScrollablePane_coll__map" id="CEGUI_1_1FalagardScrollablePane_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1ScrollablePaneWindowRenderer.html" title="Base class for ScrollablePane window renderer objects." alt="" coords="5,197,264,227"/><area shape="rect" id="node4" href="classCEGUI_1_1WindowRenderer.html" title="Base-class for the assignable WindowRenderer object." alt="" coords="48,117,221,147"/><area shape="rect" id="node6" href="classCEGUI_1_1String.html" title="String class used within the GUI system." alt="" coords="81,5,188,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1FalagardScrollablePane-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardScrollablePane.html#abec1f4c8ed525315210078704bb14959">FalagardScrollablePane</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &type)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">type name for this widget. <a href="#abec1f4c8ed525315210078704bb14959"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardScrollablePane.html#a9832724cc48dbd9bd3ea7cc89232efc3">render</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Populate render cache. <a href="#a9832724cc48dbd9bd3ea7cc89232efc3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1Rect.html">Rect</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardScrollablePane.html#aa749a6158a85faf4586907386a6735e1">getViewableArea</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a <a class="el" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a> that described the pane's viewable area, relative to this <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>, in pixels. <a href="#aa749a6158a85faf4586907386a6735e1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8cd24ac45476be82866aa3ab78f15a1c"></a><!-- doxytag: member="CEGUI::FalagardScrollablePane::getUnclippedInnerRect" ref="a8cd24ac45476be82866aa3ab78f15a1c" args="() const " -->
<a class="el" href="classCEGUI_1_1Rect.html">Rect</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardScrollablePane.html#a8cd24ac45476be82866aa3ab78f15a1c">getUnclippedInnerRect</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get unclipped inner rectangle that our window should return from its member function with the same name. <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="ab49706ae83e80d35c5d8b68615956f0f"></a><!-- doxytag: member="CEGUI::FalagardScrollablePane::TypeName" ref="ab49706ae83e80d35c5d8b68615956f0f" args="[]" -->
static const utf8 </td><td class="memItemRight" valign="bottom"><b>TypeName</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="a0dda90a4e2e3432588a55c435594b88d"></a><!-- doxytag: member="CEGUI::FalagardScrollablePane::onLookNFeelAssigned" ref="a0dda90a4e2e3432588a55c435594b88d" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardScrollablePane.html#a0dda90a4e2e3432588a55c435594b88d">onLookNFeelAssigned</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Handler called when a Look'N'Feel is assigned to our window. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0df38c36201aa3b478bc62f0f3e24a36"></a><!-- doxytag: member="CEGUI::FalagardScrollablePane::onLookNFeelUnassigned" ref="a0df38c36201aa3b478bc62f0f3e24a36" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardScrollablePane.html#a0df38c36201aa3b478bc62f0f3e24a36">onLookNFeelUnassigned</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Handler called when a Look'N'Feel is removed/unassigned from our window. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa3b13a47b517e3e8f3fd0e0c0b835de3"></a><!-- doxytag: member="CEGUI::FalagardScrollablePane::d_widgetLookAssigned" ref="aa3b13a47b517e3e8f3fd0e0c0b835de3" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardScrollablePane.html#aa3b13a47b517e3e8f3fd0e0c0b835de3">d_widgetLookAssigned</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">flag whether target window has looknfeel assigned yet. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classCEGUI_1_1ScrollablePane.html" title="Base class for the ScrollablePane widget.">ScrollablePane</a> class for the FalagardBase module. </p>
<p>This class requires LookNFeel to be assigned. The LookNFeel should provide the following:</p>
<p>States:</p>
<ul>
<li>Enabled</li>
<li>Disabled</li>
</ul>
<p>Named Areas:</p>
<ul>
<li>ViewableArea - area where content will be drawn when no scrollbars are visible.</li>
<li>ViewableAreaHScroll - area where content will be drawn when the horizontal scrollbar is visible.</li>
<li>ViewableAreaVScroll - area where content will be drawn when the vertical scrollbar is visible.</li>
<li>ViewableAreaHVScroll - area where content will be drawn when both scrollbars are visible.</li>
</ul>
<p>Child Widgets: <a class="el" href="classCEGUI_1_1Scrollbar.html" title="Base scroll bar class.">Scrollbar</a> based widget with name suffix "__auto_vscrollbar__" <a class="el" href="classCEGUI_1_1Scrollbar.html" title="Base scroll bar class.">Scrollbar</a> based widget with name suffix "__auto_hscrollbar__" </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="abec1f4c8ed525315210078704bb14959"></a><!-- doxytag: member="CEGUI::FalagardScrollablePane::FalagardScrollablePane" ref="abec1f4c8ed525315210078704bb14959" args="(const String &type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CEGUI::FalagardScrollablePane::FalagardScrollablePane </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>type</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>type name for this widget. </p>
<p>Constructor </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aa749a6158a85faf4586907386a6735e1"></a><!-- doxytag: member="CEGUI::FalagardScrollablePane::getViewableArea" ref="aa749a6158a85faf4586907386a6735e1" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1Rect.html">Rect</a> CEGUI::FalagardScrollablePane::getViewableArea </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a <a class="el" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a> that described the pane's viewable area, relative to this <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>, in pixels. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a> object describing the ScrollablePane's viewable area. </dd></dl>
<p>Implements <a class="el" href="classCEGUI_1_1ScrollablePaneWindowRenderer.html#a0d24c717a17f6ebdcace09af19100728">CEGUI::ScrollablePaneWindowRenderer</a>.</p>
</div>
</div>
<a class="anchor" id="a9832724cc48dbd9bd3ea7cc89232efc3"></a><!-- doxytag: member="CEGUI::FalagardScrollablePane::render" ref="a9832724cc48dbd9bd3ea7cc89232efc3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::FalagardScrollablePane::render </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Populate render cache. </p>
<p>This method must be implemented by all window renderers and should perform the rendering operations needed for this widget. Normally using the Falagard API... </p>
<p>Implements <a class="el" href="classCEGUI_1_1WindowRenderer.html#aafeb7dd00fe1e81f640fac257946ee66">CEGUI::WindowRenderer</a>.</p>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:42 for Crazy Eddies GUI System by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
|
