File: classCEGUI_1_1FalagardSystemButton.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 (163 lines) | stat: -rw-r--r-- 9,358 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
<!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::FalagardSystemButton 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_1FalagardSystemButton.html">FalagardSystemButton</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>  </div>
  <div class="headertitle">
<div class="title">CEGUI::FalagardSystemButton Class Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::FalagardSystemButton" --><!-- doxytag: inherits="CEGUI::FalagardButton" -->
<p>SystemButton class for the FalagardBase module. This class should be used for 'system' buttons on a <a class="el" href="classCEGUI_1_1FrameWindow.html" title="Abstract base class for a movable, sizable, window with a title-bar and a frame.">FrameWindow</a>, such as the close button.  
 <a href="classCEGUI_1_1FalagardSystemButton.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::FalagardSystemButton:</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_1FalagardSystemButton__inherit__graph.gif" border="0" usemap="#CEGUI_1_1FalagardSystemButton_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1FalagardSystemButton_inherit__map" id="CEGUI_1_1FalagardSystemButton_inherit__map">
<area shape="rect" id="node2" href="classCEGUI_1_1FalagardButton.html" title="Button class for the FalagardBase module." alt="" coords="28,83,188,112"/><area shape="rect" id="node4" href="classCEGUI_1_1WindowRenderer.html" title="Base&#45;class for the assignable WindowRenderer object." alt="" coords="21,5,195,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::FalagardSystemButton:</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_1FalagardSystemButton__coll__graph.gif" border="0" usemap="#CEGUI_1_1FalagardSystemButton_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1FalagardSystemButton_coll__map" id="CEGUI_1_1FalagardSystemButton_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1FalagardButton.html" title="Button class for the FalagardBase module." alt="" coords="28,197,188,227"/><area shape="rect" id="node4" href="classCEGUI_1_1WindowRenderer.html" title="Base&#45;class for the assignable WindowRenderer object." alt="" coords="21,117,195,147"/><area shape="rect" id="node6" href="classCEGUI_1_1String.html" title="String class used within the GUI system." alt="" coords="55,5,161,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classCEGUI_1_1FalagardSystemButton-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">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardSystemButton.html#aa6f95e1216e45443372f53f6030ea892">FalagardSystemButton</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;type)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">type name for this widget.  <a href="#aa6f95e1216e45443372f53f6030ea892"></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="ada9bfa8d7bfa6ab08fffa9c24e62b909"></a><!-- doxytag: member="CEGUI::FalagardSystemButton::TypeName" ref="ada9bfa8d7bfa6ab08fffa9c24e62b909" args="[]" -->
static const utf8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardSystemButton.html#ada9bfa8d7bfa6ab08fffa9c24e62b909">TypeName</a> []</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">type name for this widget. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>SystemButton class for the FalagardBase module. This class should be used for 'system' buttons on a <a class="el" href="classCEGUI_1_1FrameWindow.html" title="Abstract base class for a movable, sizable, window with a title-bar and a frame.">FrameWindow</a>, such as the close button. </p>
<p>This class requires LookNFeel to be assigned. The LookNFeel should provide the following:</p>
<p>States (missing states will default to 'Normal'):</p>
<ul>
<li>Normal - Rendering for when the button is neither pushed or has the mouse hovering over it.</li>
<li>Hover - Rendering for then the button has the mouse hovering over it.</li>
<li>Pushed - Rendering for when the button is pushed and mouse is over it.</li>
<li>PushedOff - Rendering for when the button is pushed and mouse is not over it.</li>
<li>Disabled - Rendering for when the button is disabled. </li>
</ul>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="aa6f95e1216e45443372f53f6030ea892"></a><!-- doxytag: member="CEGUI::FalagardSystemButton::FalagardSystemButton" ref="aa6f95e1216e45443372f53f6030ea892" args="(const String &amp;type)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CEGUI::FalagardSystemButton::FalagardSystemButton </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;&#160;</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>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:42 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>