← Back to branch summary

~ubuntu-branches/debian/wheezy/cegui-mk2/wheezy

« back to all changes in this revision

Viewing changes to docs/classCEGUI_1_1ScrolledContainerProperties_1_1ContentArea.html

  • Committer: Package Import Robot
  • Author(s): Muammar El Khatib
  • Date: 2011-10-13 12:43:12 UTC
  • mfrom: (10.1.5 experimental)
  • Revision ID: package-import@ubuntu.com-20111013124312-qch0o3fayloxgxu3
Tags: 0.7.5-7
http://bugs.debian.org/645109
Moved to unstable. (Closes: #645109)

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/classCEGUI_1_1ScrolledContainerProperties_1_1ContentArea.html
 
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
<title>Crazy Eddies GUI System: CEGUI::ScrolledContainerProperties::ContentArea Class Reference</title>
 
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
 
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
 
8
</head>
 
9
<body>
 
10
<!-- Generated by Doxygen 1.7.2 -->
 
11
<script type="text/javascript">
 
12
function hasClass(ele,cls) {
 
13
  return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));
 
14
}
 
15
 
 
16
function addClass(ele,cls) {
 
17
  if (!this.hasClass(ele,cls)) ele.className += " "+cls;
 
18
}
 
19
 
 
20
function removeClass(ele,cls) {
 
21
  if (hasClass(ele,cls)) {
 
22
    var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');
 
23
    ele.className=ele.className.replace(reg,' ');
 
24
  }
 
25
}
 
26
 
 
27
function toggleVisibility(linkObj) {
 
28
 var base = linkObj.getAttribute('id');
 
29
 var summary = document.getElementById(base + '-summary');
 
30
 var content = document.getElementById(base + '-content');
 
31
 var trigger = document.getElementById(base + '-trigger');
 
32
 if ( hasClass(linkObj,'closed') ) {
 
33
   summary.style.display = 'none';
 
34
   content.style.display = 'block';
 
35
   trigger.src = 'open.png';
 
36
   removeClass(linkObj,'closed');
 
37
   addClass(linkObj,'opened');
 
38
 } else if ( hasClass(linkObj,'opened') ) {
 
39
   summary.style.display = 'block';
 
40
   content.style.display = 'none';
 
41
   trigger.src = 'closed.png';
 
42
   removeClass(linkObj,'opened');
 
43
   addClass(linkObj,'closed');
 
44
 }
 
45
 return false;
 
46
}
 
47
</script>
 
48
<div class="navigation" id="top">
 
49
  <div class="tabs">
 
50
    <ul class="tablist">
 
51
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
 
52
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
 
53
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
 
54
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
 
55
      <li><a href="files.html"><span>Files</span></a></li>
 
56
    </ul>
 
57
  </div>
 
58
  <div class="tabs2">
 
59
    <ul class="tablist">
 
60
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
 
61
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
 
62
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
 
63
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
 
64
    </ul>
 
65
  </div>
 
66
  <div class="navpath">
 
67
    <ul>
 
68
      <li><a class="el" href="namespaceCEGUI.html">CEGUI</a>      </li>
 
69
      <li><a class="el" href="namespaceCEGUI_1_1ScrolledContainerProperties.html">ScrolledContainerProperties</a>      </li>
 
70
      <li><a class="el" href="classCEGUI_1_1ScrolledContainerProperties_1_1ContentArea.html">ContentArea</a>      </li>
 
71
    </ul>
 
72
  </div>
 
73
</div>
 
74
<div class="header">
 
75
  <div class="summary">
 
76
<a href="#pub-methods">Public Member Functions</a>  </div>
 
77
  <div class="headertitle">
 
78
<h1>CEGUI::ScrolledContainerProperties::ContentArea Class Reference</h1>  </div>
 
79
</div>
 
80
<div class="contents">
 
81
<!-- doxytag: class="CEGUI::ScrolledContainerProperties::ContentArea" --><!-- doxytag: inherits="CEGUI::Property" -->
 
82
<p><a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> to access the current content pane area rectangle (as window relative pixels).  
 
83
<a href="#_details">More...</a></p>
 
84
<!-- startSectionHeader --><div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
 
85
  <img id="dynsection-0-trigger" src="closed.png"/> Inheritance diagram for CEGUI::ScrolledContainerProperties::ContentArea:<!-- endSectionHeader --></div>
 
86
<!-- startSectionSummary --><div id="dynsection-0-summary" class="dynsummary" style="display:block;">
 
87
<!-- endSectionSummary --></div>
 
88
<!-- startSectionContent --><div id="dynsection-0-content" class="dyncontent" style="display:none;">
 
89
<div class="center"><img src="classCEGUI_1_1ScrolledContainerProperties_1_1ContentArea__inherit__graph.gif" border="0" usemap="#CEGUI_1_1ScrolledContainerProperties_1_1ContentArea_inherit__map" alt="Inheritance graph"/></div>
 
90
<map name="CEGUI_1_1ScrolledContainerProperties_1_1ContentArea_inherit__map" id="CEGUI_1_1ScrolledContainerProperties_1_1ContentArea_inherit__map">
 
91
<area shape="rect" id="node2" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name." alt="" coords="112,5,235,35"/></map>
 
92
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center><!-- endSectionContent --></div>
 
93
<!-- startSectionHeader --><div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
 
94
  <img id="dynsection-1-trigger" src="closed.png"/> Collaboration diagram for CEGUI::ScrolledContainerProperties::ContentArea:<!-- endSectionHeader --></div>
 
95
<!-- startSectionSummary --><div id="dynsection-1-summary" class="dynsummary" style="display:block;">
 
96
<!-- endSectionSummary --></div>
 
97
<!-- startSectionContent --><div id="dynsection-1-content" class="dyncontent" style="display:none;">
 
98
<div class="center"><img src="classCEGUI_1_1ScrolledContainerProperties_1_1ContentArea__coll__graph.gif" border="0" usemap="#CEGUI_1_1ScrolledContainerProperties_1_1ContentArea_coll__map" alt="Collaboration graph"/></div>
 
99
<map name="CEGUI_1_1ScrolledContainerProperties_1_1ContentArea_coll__map" id="CEGUI_1_1ScrolledContainerProperties_1_1ContentArea_coll__map">
 
100
<area shape="rect" id="node2" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name." alt="" coords="112,136,235,165"/><area shape="rect" id="node4" href="classCEGUI_1_1String.html" title="String class used within the GUI system." alt="" coords="120,5,227,35"/></map>
 
101
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center><!-- endSectionContent --></div>
 
102
 
 
103
<p><a href="classCEGUI_1_1ScrolledContainerProperties_1_1ContentArea-members.html">List of all members.</a></p>
 
104
<table class="memberdecls">
 
105
<tr><td colspan="2"><h2><a name="pub-methods"></a>
 
106
Public Member Functions</h2></td></tr>
 
107
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1String.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ScrolledContainerProperties_1_1ContentArea.html#ad0152e0c261204f59f7fcc9f6a78d29e">get</a> (const <a class="el" href="classCEGUI_1_1PropertyReceiver.html">PropertyReceiver</a> *receiver) const </td></tr>
 
108
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the current value of the <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> as a <a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>.  <a href="#ad0152e0c261204f59f7fcc9f6a78d29e"></a><br/></td></tr>
 
109
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ScrolledContainerProperties_1_1ContentArea.html#a60ef4a61ff02f2527af54e3f3a5f3778">set</a> (<a class="el" href="classCEGUI_1_1PropertyReceiver.html">PropertyReceiver</a> *receiver, const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;value)</td></tr>
 
110
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the value of the property.  <a href="#a60ef4a61ff02f2527af54e3f3a5f3778"></a><br/></td></tr>
 
111
</table>
 
112
<hr/><a name="_details"></a><h2>Detailed Description</h2>
 
113
<p><a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> to access the current content pane area rectangle (as window relative pixels). </p>
 
114
<dl class="user"><dt><b>Usage:</b></dt><dd><ul>
 
115
<li>Name: <a class="el" href="classCEGUI_1_1ScrolledContainerProperties_1_1ContentArea.html" title="Property to access the current content pane area rectangle (as window relative pixels).">ContentArea</a></li>
 
116
<li>Format: "l:[float] t:[float] r:[float] b:[float]".</li>
 
117
</ul>
 
118
</dd></dl>
 
119
<dl class="user"><dt><b>Where:</b></dt><dd><ul>
 
120
<li>l:[float] specifies the position of the left edge of the area as a floating point number.</li>
 
121
<li>t:[float] specifies the position of the top edge of the area as a floating point number.</li>
 
122
<li>r:[float] specifies the position of the right edge of the area as a floating point number.</li>
 
123
<li>b:[float] specifies the position of the bottom edge of the area as a floating point number. </li>
 
124
</ul>
 
125
</dd></dl>
 
126
<hr/><h2>Member Function Documentation</h2>
 
127
<a class="anchor" id="ad0152e0c261204f59f7fcc9f6a78d29e"></a><!-- doxytag: member="CEGUI::ScrolledContainerProperties::ContentArea::get" ref="ad0152e0c261204f59f7fcc9f6a78d29e" args="(const PropertyReceiver *receiver) const " -->
 
128
<div class="memitem">
 
129
<div class="memproto">
 
130
      <table class="memname">
 
131
        <tr>
 
132
          <td class="memname"><a class="el" href="classCEGUI_1_1String.html">String</a> CEGUI::ScrolledContainerProperties::ContentArea::get </td>
 
133
          <td>(</td>
 
134
          <td class="paramtype">const <a class="el" href="classCEGUI_1_1PropertyReceiver.html">PropertyReceiver</a> *&#160;</td>
 
135
          <td class="paramname"> <em>receiver</em>&#160;)</td>
 
136
          <td> const<code> [virtual]</code></td>
 
137
        </tr>
 
138
      </table>
 
139
</div>
 
140
<div class="memdoc">
 
141
 
 
142
<p>Return the current value of the <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> as a <a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>. </p>
 
143
<dl><dt><b>Parameters:</b></dt><dd>
 
144
  <table class="params">
 
145
    <tr><td class="paramname">receiver</td><td>Pointer to the target object.</td></tr>
 
146
  </table>
 
147
  </dd>
 
148
</dl>
 
149
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object containing a textual representation of the current value of the <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> </dd></dl>
 
150
 
 
151
<p>Implements <a class="el" href="classCEGUI_1_1Property.html#a47b2146f07d6a725075d06dc62396ab1">CEGUI::Property</a>.</p>
 
152
 
 
153
</div>
 
154
</div>
 
155
<a class="anchor" id="a60ef4a61ff02f2527af54e3f3a5f3778"></a><!-- doxytag: member="CEGUI::ScrolledContainerProperties::ContentArea::set" ref="a60ef4a61ff02f2527af54e3f3a5f3778" args="(PropertyReceiver *receiver, const String &amp;value)" -->
 
156
<div class="memitem">
 
157
<div class="memproto">
 
158
      <table class="memname">
 
159
        <tr>
 
160
          <td class="memname">void CEGUI::ScrolledContainerProperties::ContentArea::set </td>
 
161
          <td>(</td>
 
162
          <td class="paramtype"><a class="el" href="classCEGUI_1_1PropertyReceiver.html">PropertyReceiver</a> *&#160;</td>
 
163
          <td class="paramname"> <em>receiver</em>, </td>
 
164
        </tr>
 
165
        <tr>
 
166
          <td class="paramkey"></td>
 
167
          <td></td>
 
168
          <td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;&#160;</td>
 
169
          <td class="paramname"> <em>value</em>&#160;</td>
 
170
        </tr>
 
171
        <tr>
 
172
          <td></td>
 
173
          <td>)</td>
 
174
          <td></td><td><code> [virtual]</code></td>
 
175
        </tr>
 
176
      </table>
 
177
</div>
 
178
<div class="memdoc">
 
179
 
 
180
<p>Sets the value of the property. </p>
 
181
<dl><dt><b>Parameters:</b></dt><dd>
 
182
  <table class="params">
 
183
    <tr><td class="paramname">receiver</td><td>Pointer to the target object.</td></tr>
 
184
    <tr><td class="paramname">value</td><td>A <a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object that contains a textual representation of the new value to assign to the <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a>.</td></tr>
 
185
  </table>
 
186
  </dd>
 
187
</dl>
 
188
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing.</dd></dl>
 
189
<dl><dt><b>Exceptions:</b></dt><dd>
 
190
  <table class="exception">
 
191
    <tr><td class="paramname"><a class="el" href="classCEGUI_1_1InvalidRequestException.html" title="Exception class used when some impossible request was made of the system.">InvalidRequestException</a></td><td>Thrown when the <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> was unable to interpret the content of <em>value</em>. </td></tr>
 
192
  </table>
 
193
  </dd>
 
194
</dl>
 
195
 
 
196
<p>Implements <a class="el" href="classCEGUI_1_1Property.html#a66405360c2f98359dbb90f9700fc8251">CEGUI::Property</a>.</p>
 
197
 
 
198
</div>
 
199
</div>
 
200
</div>
 
201
<hr class="footer"/><address class="footer"><small>Generated on Fri Nov 19 2010 12:01:23 for Crazy Eddies GUI System by&#160;
 
202
<a href="http://www.doxygen.org/index.html">
 
203
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address>
 
204
</body>
 
205
</html>