aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/src/others/irrlicht-1.8.1/doc/html/classirr_1_1gui_1_1_i_g_u_i_button.html
diff options
context:
space:
mode:
Diffstat (limited to 'src/others/irrlicht-1.8.1/doc/html/classirr_1_1gui_1_1_i_g_u_i_button.html')
-rw-r--r--src/others/irrlicht-1.8.1/doc/html/classirr_1_1gui_1_1_i_g_u_i_button.html669
1 files changed, 669 insertions, 0 deletions
diff --git a/src/others/irrlicht-1.8.1/doc/html/classirr_1_1gui_1_1_i_g_u_i_button.html b/src/others/irrlicht-1.8.1/doc/html/classirr_1_1gui_1_1_i_g_u_i_button.html
new file mode 100644
index 0000000..81476c8
--- /dev/null
+++ b/src/others/irrlicht-1.8.1/doc/html/classirr_1_1gui_1_1_i_g_u_i_button.html
@@ -0,0 +1,669 @@
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>Irrlicht 3D Engine: irr::gui::IGUIButton Class Reference</title>
6
7<link href="tabs.css" rel="stylesheet" type="text/css"/>
8<link href="doxygen.css" rel="stylesheet" type="text/css" />
9<link href="navtree.css" rel="stylesheet" type="text/css"/>
10<script type="text/javascript" src="jquery.js"></script>
11<script type="text/javascript" src="resize.js"></script>
12<script type="text/javascript" src="navtree.js"></script>
13<script type="text/javascript">
14 $(document).ready(initResizable);
15</script>
16<link href="search/search.css" rel="stylesheet" type="text/css"/>
17<script type="text/javascript" src="search/search.js"></script>
18<script type="text/javascript">
19 $(document).ready(function() { searchBox.OnSelectItem(0); });
20</script>
21
22</head>
23<body>
24<div id="top"><!-- do not remove this div! -->
25
26
27<div id="titlearea">
28<table cellspacing="0" cellpadding="0">
29 <tbody>
30 <tr style="height: 56px;">
31
32 <td id="projectlogo"><img alt="Logo" src="irrlichtlogo.png"/></td>
33
34
35 <td style="padding-left: 0.5em;">
36 <div id="projectname">Irrlicht 3D Engine
37
38 </div>
39
40 </td>
41
42
43
44
45 <td> <div id="MSearchBox" class="MSearchBoxInactive">
46 <span class="left">
47 <img id="MSearchSelect" src="search/mag_sel.png"
48 onmouseover="return searchBox.OnSearchSelectShow()"
49 onmouseout="return searchBox.OnSearchSelectHide()"
50 alt=""/>
51 <input type="text" id="MSearchField" value="Search" accesskey="S"
52 onfocus="searchBox.OnSearchFieldFocus(true)"
53 onblur="searchBox.OnSearchFieldFocus(false)"
54 onkeyup="searchBox.OnSearchFieldChange(event)"/>
55 </span><span class="right">
56 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
57 </span>
58 </div>
59</td>
60
61
62 </tr>
63 </tbody>
64</table>
65</div>
66
67<!-- Generated by Doxygen 1.7.5.1 -->
68<script type="text/javascript">
69var searchBox = new SearchBox("searchBox", "search",false,'Search');
70</script>
71<script type="text/javascript" src="dynsections.js"></script>
72</div>
73<div id="side-nav" class="ui-resizable side-nav-resizable">
74 <div id="nav-tree">
75 <div id="nav-tree-contents">
76 </div>
77 </div>
78 <div id="splitbar" style="-moz-user-select:none;"
79 class="ui-resizable-handle">
80 </div>
81</div>
82<script type="text/javascript">
83 initNavTree('classirr_1_1gui_1_1_i_g_u_i_button.html','');
84</script>
85<div id="doc-content">
86<div class="header">
87 <div class="summary">
88<a href="#pub-methods">Public Member Functions</a> </div>
89 <div class="headertitle">
90<div class="title">irr::gui::IGUIButton Class Reference</div> </div>
91</div>
92<div class="contents">
93<!-- doxytag: class="irr::gui::IGUIButton" --><!-- doxytag: inherits="irr::gui::IGUIElement" -->
94<p>GUI Button interface.
95 <a href="classirr_1_1gui_1_1_i_g_u_i_button.html#details">More...</a></p>
96
97<p><code>#include &lt;<a class="el" href="_i_g_u_i_button_8h_source.html">IGUIButton.h</a>&gt;</code></p>
98<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
99 <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for irr::gui::IGUIButton:</div>
100<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
101</div>
102<div id="dynsection-0-content" class="dyncontent" style="display:none;">
103 <div class="center">
104 <img src="classirr_1_1gui_1_1_i_g_u_i_button.png" usemap="#irr::gui::IGUIButton_map" alt=""/>
105 <map id="irr::gui::IGUIButton_map" name="irr::gui::IGUIButton_map">
106<area href="classirr_1_1gui_1_1_i_g_u_i_element.html" title="Base class of all GUI elements." alt="irr::gui::IGUIElement" shape="rect" coords="105,112,305,136"/>
107<area href="classirr_1_1io_1_1_i_attribute_exchanging_object.html" title="An object which is able to serialize and deserialize its attributes into an attributes object..." alt="irr::io::IAttributeExchangingObject" shape="rect" coords="0,56,200,80"/>
108<area href="classirr_1_1_i_event_receiver.html" title="Interface of an object which can receive events." alt="irr::IEventReceiver" shape="rect" coords="210,56,410,80"/>
109<area href="classirr_1_1_i_reference_counted.html" title="Base class of most objects of the Irrlicht Engine." alt="irr::IReferenceCounted" shape="rect" coords="0,0,200,24"/>
110</map>
111 </div></div>
112
113<p><a href="classirr_1_1gui_1_1_i_g_u_i_button-members.html">List of all members.</a></p>
114<h2><a name="pub-methods"></a>
115Public Member Functions</h2>
116<ul>
117<li><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_button.html#a9ce8f3172c2c82269c2cf6a650ccaaa8">IGUIButton</a> (<a class="el" href="classirr_1_1gui_1_1_i_g_u_i_environment.html">IGUIEnvironment</a> *environment, <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_element.html">IGUIElement</a> *parent, <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> id, <a class="el" href="classirr_1_1core_1_1rect.html">core::rect</a>&lt; <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> &gt; rectangle)
118<dl class="el"><dd class="mdescRight">constructor <a href="#a9ce8f3172c2c82269c2cf6a650ccaaa8"></a><br/></dl><li>virtual <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_font.html">IGUIFont</a> * <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_button.html#a1caa9253c284c3e3366733bf7805d762">getActiveFont</a> () const =0
119<dl class="el"><dd class="mdescRight">Get the font which is used right now for drawing. <a href="#a1caa9253c284c3e3366733bf7805d762"></a><br/></dl><li>virtual <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_font.html">IGUIFont</a> * <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_button.html#adbc27c7589bf22d2a7fa676401358578">getOverrideFont</a> (void) const =0
120<dl class="el"><dd class="mdescRight">Gets the override font (if any) <a href="#adbc27c7589bf22d2a7fa676401358578"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_button.html#af4cb47805f2a296506b8a0b4cb65fddf">isAlphaChannelUsed</a> () const =0
121<dl class="el"><dd class="mdescRight">Returns if the alpha channel should be used for drawing background images on the button. <a href="#af4cb47805f2a296506b8a0b4cb65fddf"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_button.html#af2e1cee431cc5f90cede3820719625f1">isDrawingBorder</a> () const =0
122<dl class="el"><dd class="mdescRight">Returns if the border and button face are being drawn using the skin. <a href="#af2e1cee431cc5f90cede3820719625f1"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_button.html#a2621bd10a5eb91fa14037feb9378c252">isPressed</a> () const =0
123<dl class="el"><dd class="mdescRight">Returns if the button is currently pressed. <a href="#a2621bd10a5eb91fa14037feb9378c252"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_button.html#abb12a92ba70d1fe738655d04ef73734f">isPushButton</a> () const =0
124<dl class="el"><dd class="mdescRight">Returns whether the button is a push button. <a href="#abb12a92ba70d1fe738655d04ef73734f"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_button.html#af2660457dae6def0b34d4748e96c653a">isScalingImage</a> () const =0
125<dl class="el"><dd class="mdescRight">Checks whether the button scales the used images. <a href="#af2660457dae6def0b34d4748e96c653a"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_button.html#aa6e68e5335f67472bde80b530b6d31fd">setDrawBorder</a> (bool border=true)=0
126<dl class="el"><dd class="mdescRight">Sets if the button should use the skin to draw its border and button face (default is true) <a href="#aa6e68e5335f67472bde80b530b6d31fd"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_button.html#af233578beb34ba115b0197731e34a3f1">setImage</a> (<a class="el" href="classirr_1_1video_1_1_i_texture.html">video::ITexture</a> *image=0)=0
127<dl class="el"><dd class="mdescRight">Sets an image which should be displayed on the button when it is in normal state. <a href="#af233578beb34ba115b0197731e34a3f1"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_button.html#a205490ec6b4978afe9d3f6a4aed92b50">setImage</a> (<a class="el" href="classirr_1_1video_1_1_i_texture.html">video::ITexture</a> *image, const <a class="el" href="classirr_1_1core_1_1rect.html">core::rect</a>&lt; <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> &gt; &amp;pos)=0
128<dl class="el"><dd class="mdescRight">Sets a background image for the button when it is in normal state. <a href="#a205490ec6b4978afe9d3f6a4aed92b50"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_button.html#a992775637ba91f5267c4c04d5889fc6d">setIsPushButton</a> (bool isPushButton=true)=0
129<dl class="el"><dd class="mdescRight">Sets if the button should behave like a push button. <a href="#a992775637ba91f5267c4c04d5889fc6d"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_button.html#ab63c3536bd2eb92e9ebec8ea3a381ec1">setOverrideFont</a> (<a class="el" href="classirr_1_1gui_1_1_i_g_u_i_font.html">IGUIFont</a> *font=0)=0
130<dl class="el"><dd class="mdescRight">Sets another skin independent font. <a href="#ab63c3536bd2eb92e9ebec8ea3a381ec1"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_button.html#a2508fb292fab222bcebdeae0f9874348">setPressed</a> (bool pressed=true)=0
131<dl class="el"><dd class="mdescRight">Sets the pressed state of the button if this is a pushbutton. <a href="#a2508fb292fab222bcebdeae0f9874348"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_button.html#a10389917530aa2f4a3008330c0695aad">setPressedImage</a> (<a class="el" href="classirr_1_1video_1_1_i_texture.html">video::ITexture</a> *image=0)=0
132<dl class="el"><dd class="mdescRight">Sets a background image for the button when it is in pressed state. <a href="#a10389917530aa2f4a3008330c0695aad"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_button.html#a08019647ec3e08984d795b3c564d457e">setPressedImage</a> (<a class="el" href="classirr_1_1video_1_1_i_texture.html">video::ITexture</a> *image, const <a class="el" href="classirr_1_1core_1_1rect.html">core::rect</a>&lt; <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> &gt; &amp;pos)=0
133<dl class="el"><dd class="mdescRight">Sets an image which should be displayed on the button when it is in pressed state. <a href="#a08019647ec3e08984d795b3c564d457e"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_button.html#ae0767cb927c7974e19eaa3e5ca52bf1f">setScaleImage</a> (bool scaleImage=true)=0
134<dl class="el"><dd class="mdescRight">Sets if the button should scale the button images to fit. <a href="#ae0767cb927c7974e19eaa3e5ca52bf1f"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_button.html#a26c5f05e922b0fc1b5790a001fd04b78">setSprite</a> (<a class="el" href="namespaceirr_1_1gui.html#a2520445dec46e00684645ef8053aebb5">EGUI_BUTTON_STATE</a> state, <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> index, <a class="el" href="classirr_1_1video_1_1_s_color.html">video::SColor</a> color=<a class="el" href="classirr_1_1video_1_1_s_color.html">video::SColor</a>(255, 255, 255, 255), bool loop=false)=0
135<dl class="el"><dd class="mdescRight">Sets the animated sprite for a specific button state. <a href="#a26c5f05e922b0fc1b5790a001fd04b78"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_button.html#a0570cc64a1445866a0c8123c0209c83d">setSpriteBank</a> (<a class="el" href="classirr_1_1gui_1_1_i_g_u_i_sprite_bank.html">IGUISpriteBank</a> *bank=0)=0
136<dl class="el"><dd class="mdescRight">Sets the sprite bank used by the button. <a href="#a0570cc64a1445866a0c8123c0209c83d"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_button.html#a3d7727e7807e8b71dae6f81a44737e8a">setUseAlphaChannel</a> (bool useAlphaChannel=true)=0
137<dl class="el"><dd class="mdescRight">Sets if the alpha channel should be used for drawing background images on the button (default is false) <a href="#a3d7727e7807e8b71dae6f81a44737e8a"></a><br/></dl></ul>
138<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
139<div class="textblock"><p>GUI Button interface. </p>
140<dl class="user"><dt><b>This element can create the following events of type EGUI_EVENT_TYPE:</b></dt><dd><ul>
141<li>EGET_BUTTON_CLICKED </li>
142</ul>
143</dd></dl>
144
145<p>Definition at line <a class="el" href="_i_g_u_i_button_8h_source.html#l00058">58</a> of file <a class="el" href="_i_g_u_i_button_8h_source.html">IGUIButton.h</a>.</p>
146</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
147<a class="anchor" id="a9ce8f3172c2c82269c2cf6a650ccaaa8"></a><!-- doxytag: member="irr::gui::IGUIButton::IGUIButton" ref="a9ce8f3172c2c82269c2cf6a650ccaaa8" args="(IGUIEnvironment *environment, IGUIElement *parent, s32 id, core::rect&lt; s32 &gt; rectangle)" -->
148<div class="memitem">
149<div class="memproto">
150 <table class="memname">
151 <tr>
152 <td class="memname">irr::gui::IGUIButton::IGUIButton </td>
153 <td>(</td>
154 <td class="paramtype"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_environment.html">IGUIEnvironment</a> *&#160;</td>
155 <td class="paramname"><em>environment</em>, </td>
156 </tr>
157 <tr>
158 <td class="paramkey"></td>
159 <td></td>
160 <td class="paramtype"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_element.html">IGUIElement</a> *&#160;</td>
161 <td class="paramname"><em>parent</em>, </td>
162 </tr>
163 <tr>
164 <td class="paramkey"></td>
165 <td></td>
166 <td class="paramtype"><a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a>&#160;</td>
167 <td class="paramname"><em>id</em>, </td>
168 </tr>
169 <tr>
170 <td class="paramkey"></td>
171 <td></td>
172 <td class="paramtype"><a class="el" href="classirr_1_1core_1_1rect.html">core::rect</a>&lt; <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> &gt;&#160;</td>
173 <td class="paramname"><em>rectangle</em>&#160;</td>
174 </tr>
175 <tr>
176 <td></td>
177 <td>)</td>
178 <td></td><td><code> [inline]</code></td>
179 </tr>
180 </table>
181</div>
182<div class="memdoc">
183
184<p>constructor </p>
185
186<p>Definition at line <a class="el" href="_i_g_u_i_button_8h_source.html#l00063">63</a> of file <a class="el" href="_i_g_u_i_button_8h_source.html">IGUIButton.h</a>.</p>
187
188</div>
189</div>
190<hr/><h2>Member Function Documentation</h2>
191<a class="anchor" id="a1caa9253c284c3e3366733bf7805d762"></a><!-- doxytag: member="irr::gui::IGUIButton::getActiveFont" ref="a1caa9253c284c3e3366733bf7805d762" args="() const =0" -->
192<div class="memitem">
193<div class="memproto">
194 <table class="memname">
195 <tr>
196 <td class="memname">virtual <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_font.html">IGUIFont</a>* irr::gui::IGUIButton::getActiveFont </td>
197 <td>(</td>
198 <td class="paramname"></td><td>)</td>
199 <td> const<code> [pure virtual]</code></td>
200 </tr>
201 </table>
202</div>
203<div class="memdoc">
204
205<p>Get the font which is used right now for drawing. </p>
206<p>Currently this is the override font when one is set and the font of the active skin otherwise </p>
207
208</div>
209</div>
210<a class="anchor" id="adbc27c7589bf22d2a7fa676401358578"></a><!-- doxytag: member="irr::gui::IGUIButton::getOverrideFont" ref="adbc27c7589bf22d2a7fa676401358578" args="(void) const =0" -->
211<div class="memitem">
212<div class="memproto">
213 <table class="memname">
214 <tr>
215 <td class="memname">virtual <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_font.html">IGUIFont</a>* irr::gui::IGUIButton::getOverrideFont </td>
216 <td>(</td>
217 <td class="paramtype">void&#160;</td>
218 <td class="paramname"></td><td>)</td>
219 <td> const<code> [pure virtual]</code></td>
220 </tr>
221 </table>
222</div>
223<div class="memdoc">
224
225<p>Gets the override font (if any) </p>
226<dl class="return"><dt><b>Returns:</b></dt><dd>The override font (may be 0) </dd></dl>
227
228</div>
229</div>
230<a class="anchor" id="af4cb47805f2a296506b8a0b4cb65fddf"></a><!-- doxytag: member="irr::gui::IGUIButton::isAlphaChannelUsed" ref="af4cb47805f2a296506b8a0b4cb65fddf" args="() const =0" -->
231<div class="memitem">
232<div class="memproto">
233 <table class="memname">
234 <tr>
235 <td class="memname">virtual bool irr::gui::IGUIButton::isAlphaChannelUsed </td>
236 <td>(</td>
237 <td class="paramname"></td><td>)</td>
238 <td> const<code> [pure virtual]</code></td>
239 </tr>
240 </table>
241</div>
242<div class="memdoc">
243
244<p>Returns if the alpha channel should be used for drawing background images on the button. </p>
245
246</div>
247</div>
248<a class="anchor" id="af2e1cee431cc5f90cede3820719625f1"></a><!-- doxytag: member="irr::gui::IGUIButton::isDrawingBorder" ref="af2e1cee431cc5f90cede3820719625f1" args="() const =0" -->
249<div class="memitem">
250<div class="memproto">
251 <table class="memname">
252 <tr>
253 <td class="memname">virtual bool irr::gui::IGUIButton::isDrawingBorder </td>
254 <td>(</td>
255 <td class="paramname"></td><td>)</td>
256 <td> const<code> [pure virtual]</code></td>
257 </tr>
258 </table>
259</div>
260<div class="memdoc">
261
262<p>Returns if the border and button face are being drawn using the skin. </p>
263
264</div>
265</div>
266<a class="anchor" id="a2621bd10a5eb91fa14037feb9378c252"></a><!-- doxytag: member="irr::gui::IGUIButton::isPressed" ref="a2621bd10a5eb91fa14037feb9378c252" args="() const =0" -->
267<div class="memitem">
268<div class="memproto">
269 <table class="memname">
270 <tr>
271 <td class="memname">virtual bool irr::gui::IGUIButton::isPressed </td>
272 <td>(</td>
273 <td class="paramname"></td><td>)</td>
274 <td> const<code> [pure virtual]</code></td>
275 </tr>
276 </table>
277</div>
278<div class="memdoc">
279
280<p>Returns if the button is currently pressed. </p>
281
282</div>
283</div>
284<a class="anchor" id="abb12a92ba70d1fe738655d04ef73734f"></a><!-- doxytag: member="irr::gui::IGUIButton::isPushButton" ref="abb12a92ba70d1fe738655d04ef73734f" args="() const =0" -->
285<div class="memitem">
286<div class="memproto">
287 <table class="memname">
288 <tr>
289 <td class="memname">virtual bool irr::gui::IGUIButton::isPushButton </td>
290 <td>(</td>
291 <td class="paramname"></td><td>)</td>
292 <td> const<code> [pure virtual]</code></td>
293 </tr>
294 </table>
295</div>
296<div class="memdoc">
297
298<p>Returns whether the button is a push button. </p>
299
300</div>
301</div>
302<a class="anchor" id="af2660457dae6def0b34d4748e96c653a"></a><!-- doxytag: member="irr::gui::IGUIButton::isScalingImage" ref="af2660457dae6def0b34d4748e96c653a" args="() const =0" -->
303<div class="memitem">
304<div class="memproto">
305 <table class="memname">
306 <tr>
307 <td class="memname">virtual bool irr::gui::IGUIButton::isScalingImage </td>
308 <td>(</td>
309 <td class="paramname"></td><td>)</td>
310 <td> const<code> [pure virtual]</code></td>
311 </tr>
312 </table>
313</div>
314<div class="memdoc">
315
316<p>Checks whether the button scales the used images. </p>
317
318</div>
319</div>
320<a class="anchor" id="aa6e68e5335f67472bde80b530b6d31fd"></a><!-- doxytag: member="irr::gui::IGUIButton::setDrawBorder" ref="aa6e68e5335f67472bde80b530b6d31fd" args="(bool border=true)=0" -->
321<div class="memitem">
322<div class="memproto">
323 <table class="memname">
324 <tr>
325 <td class="memname">virtual void irr::gui::IGUIButton::setDrawBorder </td>
326 <td>(</td>
327 <td class="paramtype">bool&#160;</td>
328 <td class="paramname"><em>border</em> = <code>true</code></td><td>)</td>
329 <td><code> [pure virtual]</code></td>
330 </tr>
331 </table>
332</div>
333<div class="memdoc">
334
335<p>Sets if the button should use the skin to draw its border and button face (default is true) </p>
336
337</div>
338</div>
339<a class="anchor" id="af233578beb34ba115b0197731e34a3f1"></a><!-- doxytag: member="irr::gui::IGUIButton::setImage" ref="af233578beb34ba115b0197731e34a3f1" args="(video::ITexture *image=0)=0" -->
340<div class="memitem">
341<div class="memproto">
342 <table class="memname">
343 <tr>
344 <td class="memname">virtual void irr::gui::IGUIButton::setImage </td>
345 <td>(</td>
346 <td class="paramtype"><a class="el" href="classirr_1_1video_1_1_i_texture.html">video::ITexture</a> *&#160;</td>
347 <td class="paramname"><em>image</em> = <code>0</code></td><td>)</td>
348 <td><code> [pure virtual]</code></td>
349 </tr>
350 </table>
351</div>
352<div class="memdoc">
353
354<p>Sets an image which should be displayed on the button when it is in normal state. </p>
355<dl><dt><b>Parameters:</b></dt><dd>
356 <table class="params">
357 <tr><td class="paramname">image,:</td><td>Image to be displayed </td></tr>
358 </table>
359 </dd>
360</dl>
361
362</div>
363</div>
364<a class="anchor" id="a205490ec6b4978afe9d3f6a4aed92b50"></a><!-- doxytag: member="irr::gui::IGUIButton::setImage" ref="a205490ec6b4978afe9d3f6a4aed92b50" args="(video::ITexture *image, const core::rect&lt; s32 &gt; &amp;pos)=0" -->
365<div class="memitem">
366<div class="memproto">
367 <table class="memname">
368 <tr>
369 <td class="memname">virtual void irr::gui::IGUIButton::setImage </td>
370 <td>(</td>
371 <td class="paramtype"><a class="el" href="classirr_1_1video_1_1_i_texture.html">video::ITexture</a> *&#160;</td>
372 <td class="paramname"><em>image</em>, </td>
373 </tr>
374 <tr>
375 <td class="paramkey"></td>
376 <td></td>
377 <td class="paramtype">const <a class="el" href="classirr_1_1core_1_1rect.html">core::rect</a>&lt; <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> &gt; &amp;&#160;</td>
378 <td class="paramname"><em>pos</em>&#160;</td>
379 </tr>
380 <tr>
381 <td></td>
382 <td>)</td>
383 <td></td><td><code> [pure virtual]</code></td>
384 </tr>
385 </table>
386</div>
387<div class="memdoc">
388
389<p>Sets a background image for the button when it is in normal state. </p>
390<dl><dt><b>Parameters:</b></dt><dd>
391 <table class="params">
392 <tr><td class="paramname">image,:</td><td>Texture containing the image to be displayed </td></tr>
393 <tr><td class="paramname">pos,:</td><td>Position in the texture, where the image is located </td></tr>
394 </table>
395 </dd>
396</dl>
397
398</div>
399</div>
400<a class="anchor" id="a992775637ba91f5267c4c04d5889fc6d"></a><!-- doxytag: member="irr::gui::IGUIButton::setIsPushButton" ref="a992775637ba91f5267c4c04d5889fc6d" args="(bool isPushButton=true)=0" -->
401<div class="memitem">
402<div class="memproto">
403 <table class="memname">
404 <tr>
405 <td class="memname">virtual void irr::gui::IGUIButton::setIsPushButton </td>
406 <td>(</td>
407 <td class="paramtype">bool&#160;</td>
408 <td class="paramname"><em>isPushButton</em> = <code>true</code></td><td>)</td>
409 <td><code> [pure virtual]</code></td>
410 </tr>
411 </table>
412</div>
413<div class="memdoc">
414
415<p>Sets if the button should behave like a push button. </p>
416<p>Which means it can be in two states: Normal or Pressed. With a click on the button, the user can change the state of the button. </p>
417
418</div>
419</div>
420<a class="anchor" id="ab63c3536bd2eb92e9ebec8ea3a381ec1"></a><!-- doxytag: member="irr::gui::IGUIButton::setOverrideFont" ref="ab63c3536bd2eb92e9ebec8ea3a381ec1" args="(IGUIFont *font=0)=0" -->
421<div class="memitem">
422<div class="memproto">
423 <table class="memname">
424 <tr>
425 <td class="memname">virtual void irr::gui::IGUIButton::setOverrideFont </td>
426 <td>(</td>
427 <td class="paramtype"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_font.html">IGUIFont</a> *&#160;</td>
428 <td class="paramname"><em>font</em> = <code>0</code></td><td>)</td>
429 <td><code> [pure virtual]</code></td>
430 </tr>
431 </table>
432</div>
433<div class="memdoc">
434
435<p>Sets another skin independent font. </p>
436<p>If this is set to zero, the button uses the font of the skin. </p>
437<dl><dt><b>Parameters:</b></dt><dd>
438 <table class="params">
439 <tr><td class="paramname">font,:</td><td>New font to set. </td></tr>
440 </table>
441 </dd>
442</dl>
443
444</div>
445</div>
446<a class="anchor" id="a2508fb292fab222bcebdeae0f9874348"></a><!-- doxytag: member="irr::gui::IGUIButton::setPressed" ref="a2508fb292fab222bcebdeae0f9874348" args="(bool pressed=true)=0" -->
447<div class="memitem">
448<div class="memproto">
449 <table class="memname">
450 <tr>
451 <td class="memname">virtual void irr::gui::IGUIButton::setPressed </td>
452 <td>(</td>
453 <td class="paramtype">bool&#160;</td>
454 <td class="paramname"><em>pressed</em> = <code>true</code></td><td>)</td>
455 <td><code> [pure virtual]</code></td>
456 </tr>
457 </table>
458</div>
459<div class="memdoc">
460
461<p>Sets the pressed state of the button if this is a pushbutton. </p>
462
463</div>
464</div>
465<a class="anchor" id="a10389917530aa2f4a3008330c0695aad"></a><!-- doxytag: member="irr::gui::IGUIButton::setPressedImage" ref="a10389917530aa2f4a3008330c0695aad" args="(video::ITexture *image=0)=0" -->
466<div class="memitem">
467<div class="memproto">
468 <table class="memname">
469 <tr>
470 <td class="memname">virtual void irr::gui::IGUIButton::setPressedImage </td>
471 <td>(</td>
472 <td class="paramtype"><a class="el" href="classirr_1_1video_1_1_i_texture.html">video::ITexture</a> *&#160;</td>
473 <td class="paramname"><em>image</em> = <code>0</code></td><td>)</td>
474 <td><code> [pure virtual]</code></td>
475 </tr>
476 </table>
477</div>
478<div class="memdoc">
479
480<p>Sets a background image for the button when it is in pressed state. </p>
481<p>If no images is specified for the pressed state via <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_button.html#a10389917530aa2f4a3008330c0695aad" title="Sets a background image for the button when it is in pressed state.">setPressedImage()</a>, this image is also drawn in pressed state. </p>
482<dl><dt><b>Parameters:</b></dt><dd>
483 <table class="params">
484 <tr><td class="paramname">image,:</td><td>Image to be displayed </td></tr>
485 </table>
486 </dd>
487</dl>
488
489</div>
490</div>
491<a class="anchor" id="a08019647ec3e08984d795b3c564d457e"></a><!-- doxytag: member="irr::gui::IGUIButton::setPressedImage" ref="a08019647ec3e08984d795b3c564d457e" args="(video::ITexture *image, const core::rect&lt; s32 &gt; &amp;pos)=0" -->
492<div class="memitem">
493<div class="memproto">
494 <table class="memname">
495 <tr>
496 <td class="memname">virtual void irr::gui::IGUIButton::setPressedImage </td>
497 <td>(</td>
498 <td class="paramtype"><a class="el" href="classirr_1_1video_1_1_i_texture.html">video::ITexture</a> *&#160;</td>
499 <td class="paramname"><em>image</em>, </td>
500 </tr>
501 <tr>
502 <td class="paramkey"></td>
503 <td></td>
504 <td class="paramtype">const <a class="el" href="classirr_1_1core_1_1rect.html">core::rect</a>&lt; <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> &gt; &amp;&#160;</td>
505 <td class="paramname"><em>pos</em>&#160;</td>
506 </tr>
507 <tr>
508 <td></td>
509 <td>)</td>
510 <td></td><td><code> [pure virtual]</code></td>
511 </tr>
512 </table>
513</div>
514<div class="memdoc">
515
516<p>Sets an image which should be displayed on the button when it is in pressed state. </p>
517<dl><dt><b>Parameters:</b></dt><dd>
518 <table class="params">
519 <tr><td class="paramname">image,:</td><td>Texture containing the image to be displayed </td></tr>
520 <tr><td class="paramname">pos,:</td><td>Position in the texture, where the image is located </td></tr>
521 </table>
522 </dd>
523</dl>
524
525</div>
526</div>
527<a class="anchor" id="ae0767cb927c7974e19eaa3e5ca52bf1f"></a><!-- doxytag: member="irr::gui::IGUIButton::setScaleImage" ref="ae0767cb927c7974e19eaa3e5ca52bf1f" args="(bool scaleImage=true)=0" -->
528<div class="memitem">
529<div class="memproto">
530 <table class="memname">
531 <tr>
532 <td class="memname">virtual void irr::gui::IGUIButton::setScaleImage </td>
533 <td>(</td>
534 <td class="paramtype">bool&#160;</td>
535 <td class="paramname"><em>scaleImage</em> = <code>true</code></td><td>)</td>
536 <td><code> [pure virtual]</code></td>
537 </tr>
538 </table>
539</div>
540<div class="memdoc">
541
542<p>Sets if the button should scale the button images to fit. </p>
543
544</div>
545</div>
546<a class="anchor" id="a26c5f05e922b0fc1b5790a001fd04b78"></a><!-- doxytag: member="irr::gui::IGUIButton::setSprite" ref="a26c5f05e922b0fc1b5790a001fd04b78" args="(EGUI_BUTTON_STATE state, s32 index, video::SColor color=video::SColor(255, 255, 255, 255), bool loop=false)=0" -->
547<div class="memitem">
548<div class="memproto">
549 <table class="memname">
550 <tr>
551 <td class="memname">virtual void irr::gui::IGUIButton::setSprite </td>
552 <td>(</td>
553 <td class="paramtype"><a class="el" href="namespaceirr_1_1gui.html#a2520445dec46e00684645ef8053aebb5">EGUI_BUTTON_STATE</a>&#160;</td>
554 <td class="paramname"><em>state</em>, </td>
555 </tr>
556 <tr>
557 <td class="paramkey"></td>
558 <td></td>
559 <td class="paramtype"><a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a>&#160;</td>
560 <td class="paramname"><em>index</em>, </td>
561 </tr>
562 <tr>
563 <td class="paramkey"></td>
564 <td></td>
565 <td class="paramtype"><a class="el" href="classirr_1_1video_1_1_s_color.html">video::SColor</a>&#160;</td>
566 <td class="paramname"><em>color</em> = <code><a class="el" href="classirr_1_1video_1_1_s_color.html">video::SColor</a>(255,&#160;255,&#160;255,&#160;255)</code>, </td>
567 </tr>
568 <tr>
569 <td class="paramkey"></td>
570 <td></td>
571 <td class="paramtype">bool&#160;</td>
572 <td class="paramname"><em>loop</em> = <code>false</code>&#160;</td>
573 </tr>
574 <tr>
575 <td></td>
576 <td>)</td>
577 <td></td><td><code> [pure virtual]</code></td>
578 </tr>
579 </table>
580</div>
581<div class="memdoc">
582
583<p>Sets the animated sprite for a specific button state. </p>
584<dl><dt><b>Parameters:</b></dt><dd>
585 <table class="params">
586 <tr><td class="paramname">index,:</td><td>Number of the sprite within the sprite bank, use -1 for no sprite </td></tr>
587 <tr><td class="paramname">state,:</td><td>State of the button to set the sprite for </td></tr>
588 <tr><td class="paramname">index,:</td><td>The sprite number from the current sprite bank </td></tr>
589 <tr><td class="paramname">color,:</td><td>The color of the sprite </td></tr>
590 <tr><td class="paramname">loop,:</td><td>True if the animation should loop, false if not </td></tr>
591 </table>
592 </dd>
593</dl>
594
595</div>
596</div>
597<a class="anchor" id="a0570cc64a1445866a0c8123c0209c83d"></a><!-- doxytag: member="irr::gui::IGUIButton::setSpriteBank" ref="a0570cc64a1445866a0c8123c0209c83d" args="(IGUISpriteBank *bank=0)=0" -->
598<div class="memitem">
599<div class="memproto">
600 <table class="memname">
601 <tr>
602 <td class="memname">virtual void irr::gui::IGUIButton::setSpriteBank </td>
603 <td>(</td>
604 <td class="paramtype"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_sprite_bank.html">IGUISpriteBank</a> *&#160;</td>
605 <td class="paramname"><em>bank</em> = <code>0</code></td><td>)</td>
606 <td><code> [pure virtual]</code></td>
607 </tr>
608 </table>
609</div>
610<div class="memdoc">
611
612<p>Sets the sprite bank used by the button. </p>
613
614</div>
615</div>
616<a class="anchor" id="a3d7727e7807e8b71dae6f81a44737e8a"></a><!-- doxytag: member="irr::gui::IGUIButton::setUseAlphaChannel" ref="a3d7727e7807e8b71dae6f81a44737e8a" args="(bool useAlphaChannel=true)=0" -->
617<div class="memitem">
618<div class="memproto">
619 <table class="memname">
620 <tr>
621 <td class="memname">virtual void irr::gui::IGUIButton::setUseAlphaChannel </td>
622 <td>(</td>
623 <td class="paramtype">bool&#160;</td>
624 <td class="paramname"><em>useAlphaChannel</em> = <code>true</code></td><td>)</td>
625 <td><code> [pure virtual]</code></td>
626 </tr>
627 </table>
628</div>
629<div class="memdoc">
630
631<p>Sets if the alpha channel should be used for drawing background images on the button (default is false) </p>
632
633</div>
634</div>
635<hr/>The documentation for this class was generated from the following file:<ul>
636<li><a class="el" href="_i_g_u_i_button_8h_source.html">IGUIButton.h</a></li>
637</ul>
638</div>
639</div>
640 <div id="nav-path" class="navpath">
641 <ul>
642 <li class="navelem"><a class="el" href="namespaceirr.html">irr</a> </li>
643 <li class="navelem"><a class="el" href="namespaceirr_1_1gui.html">gui</a> </li>
644 <li class="navelem"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_button.html">IGUIButton</a> </li>
645<!-- window showing the filter options -->
646<div id="MSearchSelectWindow"
647 onmouseover="return searchBox.OnSearchSelectShow()"
648 onmouseout="return searchBox.OnSearchSelectHide()"
649 onkeydown="return searchBox.OnSearchSelectKey(event)">
650<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>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Defines</a></div>
651
652<!-- iframe showing the search results (closed by default) -->
653<div id="MSearchResultsWindow">
654<iframe src="javascript:void(0)" frameborder="0"
655 name="MSearchResults" id="MSearchResults">
656</iframe>
657</div>
658
659
660 <li class="footer">
661<a href="http://irrlicht.sourceforge.net" target="_blank">Irrlicht
662Engine</a> Documentation &copy; 2003-2012 by Nikolaus Gebhardt. Generated on Sun Nov 17 2013 20:18:43 for Irrlicht 3D Engine by
663<a href="http://www.doxygen.org/index.html" target="_blank">Doxygen</a> 1.7.5.1 </li>
664 </ul>
665 </div>
666
667
668</body>
669</html>
generated by cgit v1.1 at 2024-05-16 09:42:38 +0000