aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/src/others/irrlicht-1.8.1/doc/html/classirr_1_1gui_1_1_i_g_u_i_edit_box.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_edit_box.html')
-rw-r--r--src/others/irrlicht-1.8.1/doc/html/classirr_1_1gui_1_1_i_g_u_i_edit_box.html711
1 files changed, 711 insertions, 0 deletions
diff --git a/src/others/irrlicht-1.8.1/doc/html/classirr_1_1gui_1_1_i_g_u_i_edit_box.html b/src/others/irrlicht-1.8.1/doc/html/classirr_1_1gui_1_1_i_g_u_i_edit_box.html
new file mode 100644
index 0000000..11f4280
--- /dev/null
+++ b/src/others/irrlicht-1.8.1/doc/html/classirr_1_1gui_1_1_i_g_u_i_edit_box.html
@@ -0,0 +1,711 @@
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::IGUIEditBox 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_edit_box.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::IGUIEditBox Class Reference</div> </div>
91</div>
92<div class="contents">
93<!-- doxytag: class="irr::gui::IGUIEditBox" --><!-- doxytag: inherits="irr::gui::IGUIElement" -->
94<p>Single line edit box for editing simple text.
95 <a href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#details">More...</a></p>
96
97<p><code>#include &lt;<a class="el" href="_i_g_u_i_edit_box_8h_source.html">IGUIEditBox.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::IGUIEditBox:</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_edit_box.png" usemap="#irr::gui::IGUIEditBox_map" alt=""/>
105 <map id="irr::gui::IGUIEditBox_map" name="irr::gui::IGUIEditBox_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_edit_box-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_edit_box.html#a454f49d8d569bf61b45a31871cc6d301">IGUIEditBox</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="#a454f49d8d569bf61b45a31871cc6d301"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#a121ab76cb2b69bbc4238921095917346">enableOverrideColor</a> (bool enable)=0
119<dl class="el"><dd class="mdescRight">Sets if the text should use the override color or the color in the gui skin. <a href="#a121ab76cb2b69bbc4238921095917346"></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_edit_box.html#a50542fa7f03a48458fac258a0949d987">getActiveFont</a> () const =0
120<dl class="el"><dd class="mdescRight">Get the font which is used right now for drawing. <a href="#a50542fa7f03a48458fac258a0949d987"></a><br/></dl><li>virtual <a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#ad402bf1211f1a41bf230cc587060648e">getMax</a> () const =0
121<dl class="el"><dd class="mdescRight">Returns maximum amount of characters, previously set by <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#a5253ed6b422e129356e56f8e2a610be5" title="Sets the maximum amount of characters which may be entered in the box.">setMax()</a>;. <a href="#ad402bf1211f1a41bf230cc587060648e"></a><br/></dl><li>virtual <a class="el" href="classirr_1_1video_1_1_s_color.html">video::SColor</a> <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#a2390e7376b017d8f1e2e724be88fbcc3">getOverrideColor</a> () const =0
122<dl class="el"><dd class="mdescRight">Gets the override color. <a href="#a2390e7376b017d8f1e2e724be88fbcc3"></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_edit_box.html#a4c5e6749a5ac390d6a10303babd845b8">getOverrideFont</a> () const =0
123<dl class="el"><dd class="mdescRight">Gets the override font (if any) <a href="#a4c5e6749a5ac390d6a10303babd845b8"></a><br/></dl><li>virtual <a class="el" href="namespaceirr_1_1core.html#ad2e562e3219072e2f7fc7c2bba0ef0cb">core::dimension2du</a> <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#ac993c4647168460c68d56527ba213b9c">getTextDimension</a> ()=0
124<dl class="el"><dd class="mdescRight">Gets the size area of the text in the edit box. <a href="#ac993c4647168460c68d56527ba213b9c"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#a4ccf066d1198f3548c7d04622067917f">isAutoScrollEnabled</a> () const =0
125<dl class="el"><dd class="mdescRight">Checks to see if automatic scrolling is enabled. <a href="#a4ccf066d1198f3548c7d04622067917f"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#a0be3338bc094fc93c9f0e4ed842835d6">isMultiLineEnabled</a> () const =0
126<dl class="el"><dd class="mdescRight">Checks if multi line editing is enabled. <a href="#a0be3338bc094fc93c9f0e4ed842835d6"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#ae62dac299d0101be9d78ed3db9a2d314">isOverrideColorEnabled</a> (void) const =0
127<dl class="el"><dd class="mdescRight">Checks if an override color is enabled. <a href="#ae62dac299d0101be9d78ed3db9a2d314"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#a94b093df77af7cf3e3f9853d68d2c8f2">isPasswordBox</a> () const =0
128<dl class="el"><dd class="mdescRight">Returns true if the edit box is currently a password box. <a href="#a94b093df77af7cf3e3f9853d68d2c8f2"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#ad0fd4782c052341744ea9d1f61f80e01">isWordWrapEnabled</a> () const =0
129<dl class="el"><dd class="mdescRight">Checks if word wrap is enabled. <a href="#ad0fd4782c052341744ea9d1f61f80e01"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#ad0a9db6da9d0594bb3b5b85a673b3e4d">setAutoScroll</a> (bool enable)=0
130<dl class="el"><dd class="mdescRight">Enables or disables automatic scrolling with cursor position. <a href="#ad0a9db6da9d0594bb3b5b85a673b3e4d"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#a06b1913867b10018e891969d319f376f">setDrawBackground</a> (bool draw)=0
131<dl class="el"><dd class="mdescRight">Sets whether to draw the background. <a href="#a06b1913867b10018e891969d319f376f"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#a37094bd4bc6b82a184bd1d7864f7ea18">setDrawBorder</a> (bool border)=0
132<dl class="el"><dd class="mdescRight">Turns the border on or off. <a href="#a37094bd4bc6b82a184bd1d7864f7ea18"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#a5253ed6b422e129356e56f8e2a610be5">setMax</a> (<a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> max)=0
133<dl class="el"><dd class="mdescRight">Sets the maximum amount of characters which may be entered in the box. <a href="#a5253ed6b422e129356e56f8e2a610be5"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#a0f68dc7ddc74d8103ba3ba4d445dbf9a">setMultiLine</a> (bool enable)=0
134<dl class="el"><dd class="mdescRight">Enables or disables newlines. <a href="#a0f68dc7ddc74d8103ba3ba4d445dbf9a"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#aa134d2a36c52abcb4881da0267031c47">setOverrideColor</a> (<a class="el" href="classirr_1_1video_1_1_s_color.html">video::SColor</a> color)=0
135<dl class="el"><dd class="mdescRight">Sets another color for the text. <a href="#aa134d2a36c52abcb4881da0267031c47"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#a7608fe327ec860712ec87b5e1dc4aec9">setOverrideFont</a> (<a class="el" href="classirr_1_1gui_1_1_i_g_u_i_font.html">IGUIFont</a> *font=0)=0
136<dl class="el"><dd class="mdescRight">Sets another skin independent font. <a href="#a7608fe327ec860712ec87b5e1dc4aec9"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#a59a0cf8090eb165fdbade6144bc19807">setPasswordBox</a> (bool passwordBox, wchar_t passwordChar=L'*')=0
137<dl class="el"><dd class="mdescRight">Sets whether the edit box is a password box. Setting this to true will. <a href="#a59a0cf8090eb165fdbade6144bc19807"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#ab1e2379940983f4ff874f5143f6d7244">setTextAlignment</a> (<a class="el" href="namespaceirr_1_1gui.html#a19eb5fb40e67f108cb16aba922ddaa2d">EGUI_ALIGNMENT</a> horizontal, <a class="el" href="namespaceirr_1_1gui.html#a19eb5fb40e67f108cb16aba922ddaa2d">EGUI_ALIGNMENT</a> vertical)=0
138<dl class="el"><dd class="mdescRight">Sets text justification mode. <a href="#ab1e2379940983f4ff874f5143f6d7244"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#aa020a985b38d293794b73e6e12dafd7c">setWordWrap</a> (bool enable)=0
139<dl class="el"><dd class="mdescRight">Enables or disables word wrap. <a href="#aa020a985b38d293794b73e6e12dafd7c"></a><br/></dl></ul>
140<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
141<div class="textblock"><p>Single line edit box for editing simple text. </p>
142<dl class="user"><dt><b>This element can create the following events of type EGUI_EVENT_TYPE:</b></dt><dd><ul>
143<li>EGET_EDITBOX_ENTER </li>
144<li>EGET_EDITBOX_CHANGED </li>
145<li>EGET_EDITBOX_MARKING_CHANGED </li>
146</ul>
147</dd></dl>
148
149<p>Definition at line <a class="el" href="_i_g_u_i_edit_box_8h_source.html#l00023">23</a> of file <a class="el" href="_i_g_u_i_edit_box_8h_source.html">IGUIEditBox.h</a>.</p>
150</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
151<a class="anchor" id="a454f49d8d569bf61b45a31871cc6d301"></a><!-- doxytag: member="irr::gui::IGUIEditBox::IGUIEditBox" ref="a454f49d8d569bf61b45a31871cc6d301" args="(IGUIEnvironment *environment, IGUIElement *parent, s32 id, core::rect&lt; s32 &gt; rectangle)" -->
152<div class="memitem">
153<div class="memproto">
154 <table class="memname">
155 <tr>
156 <td class="memname">irr::gui::IGUIEditBox::IGUIEditBox </td>
157 <td>(</td>
158 <td class="paramtype"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_environment.html">IGUIEnvironment</a> *&#160;</td>
159 <td class="paramname"><em>environment</em>, </td>
160 </tr>
161 <tr>
162 <td class="paramkey"></td>
163 <td></td>
164 <td class="paramtype"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_element.html">IGUIElement</a> *&#160;</td>
165 <td class="paramname"><em>parent</em>, </td>
166 </tr>
167 <tr>
168 <td class="paramkey"></td>
169 <td></td>
170 <td class="paramtype"><a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a>&#160;</td>
171 <td class="paramname"><em>id</em>, </td>
172 </tr>
173 <tr>
174 <td class="paramkey"></td>
175 <td></td>
176 <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>
177 <td class="paramname"><em>rectangle</em>&#160;</td>
178 </tr>
179 <tr>
180 <td></td>
181 <td>)</td>
182 <td></td><td><code> [inline]</code></td>
183 </tr>
184 </table>
185</div>
186<div class="memdoc">
187
188<p>constructor </p>
189
190<p>Definition at line <a class="el" href="_i_g_u_i_edit_box_8h_source.html#l00028">28</a> of file <a class="el" href="_i_g_u_i_edit_box_8h_source.html">IGUIEditBox.h</a>.</p>
191
192</div>
193</div>
194<hr/><h2>Member Function Documentation</h2>
195<a class="anchor" id="a121ab76cb2b69bbc4238921095917346"></a><!-- doxytag: member="irr::gui::IGUIEditBox::enableOverrideColor" ref="a121ab76cb2b69bbc4238921095917346" args="(bool enable)=0" -->
196<div class="memitem">
197<div class="memproto">
198 <table class="memname">
199 <tr>
200 <td class="memname">virtual void irr::gui::IGUIEditBox::enableOverrideColor </td>
201 <td>(</td>
202 <td class="paramtype">bool&#160;</td>
203 <td class="paramname"><em>enable</em></td><td>)</td>
204 <td><code> [pure virtual]</code></td>
205 </tr>
206 </table>
207</div>
208<div class="memdoc">
209
210<p>Sets if the text should use the override color or the color in the gui skin. </p>
211<dl><dt><b>Parameters:</b></dt><dd>
212 <table class="params">
213 <tr><td class="paramname">enable,:</td><td>If set to true, the override color, which can be set with <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#aa134d2a36c52abcb4881da0267031c47" title="Sets another color for the text.">IGUIEditBox::setOverrideColor</a> is used, otherwise the EGDC_BUTTON_TEXT color of the skin. </td></tr>
214 </table>
215 </dd>
216</dl>
217
218</div>
219</div>
220<a class="anchor" id="a50542fa7f03a48458fac258a0949d987"></a><!-- doxytag: member="irr::gui::IGUIEditBox::getActiveFont" ref="a50542fa7f03a48458fac258a0949d987" args="() const =0" -->
221<div class="memitem">
222<div class="memproto">
223 <table class="memname">
224 <tr>
225 <td class="memname">virtual <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_font.html">IGUIFont</a>* irr::gui::IGUIEditBox::getActiveFont </td>
226 <td>(</td>
227 <td class="paramname"></td><td>)</td>
228 <td> const<code> [pure virtual]</code></td>
229 </tr>
230 </table>
231</div>
232<div class="memdoc">
233
234<p>Get the font which is used right now for drawing. </p>
235<p>Currently this is the override font when one is set and the font of the active skin otherwise </p>
236
237</div>
238</div>
239<a class="anchor" id="ad402bf1211f1a41bf230cc587060648e"></a><!-- doxytag: member="irr::gui::IGUIEditBox::getMax" ref="ad402bf1211f1a41bf230cc587060648e" args="() const =0" -->
240<div class="memitem">
241<div class="memproto">
242 <table class="memname">
243 <tr>
244 <td class="memname">virtual <a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> irr::gui::IGUIEditBox::getMax </td>
245 <td>(</td>
246 <td class="paramname"></td><td>)</td>
247 <td> const<code> [pure virtual]</code></td>
248 </tr>
249 </table>
250</div>
251<div class="memdoc">
252
253<p>Returns maximum amount of characters, previously set by <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#a5253ed6b422e129356e56f8e2a610be5" title="Sets the maximum amount of characters which may be entered in the box.">setMax()</a>;. </p>
254
255</div>
256</div>
257<a class="anchor" id="a2390e7376b017d8f1e2e724be88fbcc3"></a><!-- doxytag: member="irr::gui::IGUIEditBox::getOverrideColor" ref="a2390e7376b017d8f1e2e724be88fbcc3" args="() const =0" -->
258<div class="memitem">
259<div class="memproto">
260 <table class="memname">
261 <tr>
262 <td class="memname">virtual <a class="el" href="classirr_1_1video_1_1_s_color.html">video::SColor</a> irr::gui::IGUIEditBox::getOverrideColor </td>
263 <td>(</td>
264 <td class="paramname"></td><td>)</td>
265 <td> const<code> [pure virtual]</code></td>
266 </tr>
267 </table>
268</div>
269<div class="memdoc">
270
271<p>Gets the override color. </p>
272
273</div>
274</div>
275<a class="anchor" id="a4c5e6749a5ac390d6a10303babd845b8"></a><!-- doxytag: member="irr::gui::IGUIEditBox::getOverrideFont" ref="a4c5e6749a5ac390d6a10303babd845b8" args="() const =0" -->
276<div class="memitem">
277<div class="memproto">
278 <table class="memname">
279 <tr>
280 <td class="memname">virtual <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_font.html">IGUIFont</a>* irr::gui::IGUIEditBox::getOverrideFont </td>
281 <td>(</td>
282 <td class="paramname"></td><td>)</td>
283 <td> const<code> [pure virtual]</code></td>
284 </tr>
285 </table>
286</div>
287<div class="memdoc">
288
289<p>Gets the override font (if any) </p>
290<dl class="return"><dt><b>Returns:</b></dt><dd>The override font (may be 0) </dd></dl>
291
292</div>
293</div>
294<a class="anchor" id="ac993c4647168460c68d56527ba213b9c"></a><!-- doxytag: member="irr::gui::IGUIEditBox::getTextDimension" ref="ac993c4647168460c68d56527ba213b9c" args="()=0" -->
295<div class="memitem">
296<div class="memproto">
297 <table class="memname">
298 <tr>
299 <td class="memname">virtual <a class="el" href="namespaceirr_1_1core.html#ad2e562e3219072e2f7fc7c2bba0ef0cb">core::dimension2du</a> irr::gui::IGUIEditBox::getTextDimension </td>
300 <td>(</td>
301 <td class="paramname"></td><td>)</td>
302 <td><code> [pure virtual]</code></td>
303 </tr>
304 </table>
305</div>
306<div class="memdoc">
307
308<p>Gets the size area of the text in the edit box. </p>
309<dl class="return"><dt><b>Returns:</b></dt><dd>The size in pixels of the text </dd></dl>
310
311</div>
312</div>
313<a class="anchor" id="a4ccf066d1198f3548c7d04622067917f"></a><!-- doxytag: member="irr::gui::IGUIEditBox::isAutoScrollEnabled" ref="a4ccf066d1198f3548c7d04622067917f" args="() const =0" -->
314<div class="memitem">
315<div class="memproto">
316 <table class="memname">
317 <tr>
318 <td class="memname">virtual bool irr::gui::IGUIEditBox::isAutoScrollEnabled </td>
319 <td>(</td>
320 <td class="paramname"></td><td>)</td>
321 <td> const<code> [pure virtual]</code></td>
322 </tr>
323 </table>
324</div>
325<div class="memdoc">
326
327<p>Checks to see if automatic scrolling is enabled. </p>
328<dl class="return"><dt><b>Returns:</b></dt><dd>true if automatic scrolling is enabled, false if not </dd></dl>
329
330</div>
331</div>
332<a class="anchor" id="a0be3338bc094fc93c9f0e4ed842835d6"></a><!-- doxytag: member="irr::gui::IGUIEditBox::isMultiLineEnabled" ref="a0be3338bc094fc93c9f0e4ed842835d6" args="() const =0" -->
333<div class="memitem">
334<div class="memproto">
335 <table class="memname">
336 <tr>
337 <td class="memname">virtual bool irr::gui::IGUIEditBox::isMultiLineEnabled </td>
338 <td>(</td>
339 <td class="paramname"></td><td>)</td>
340 <td> const<code> [pure virtual]</code></td>
341 </tr>
342 </table>
343</div>
344<div class="memdoc">
345
346<p>Checks if multi line editing is enabled. </p>
347<dl class="return"><dt><b>Returns:</b></dt><dd>true if multi-line is enabled, false otherwise </dd></dl>
348
349</div>
350</div>
351<a class="anchor" id="ae62dac299d0101be9d78ed3db9a2d314"></a><!-- doxytag: member="irr::gui::IGUIEditBox::isOverrideColorEnabled" ref="ae62dac299d0101be9d78ed3db9a2d314" args="(void) const =0" -->
352<div class="memitem">
353<div class="memproto">
354 <table class="memname">
355 <tr>
356 <td class="memname">virtual bool irr::gui::IGUIEditBox::isOverrideColorEnabled </td>
357 <td>(</td>
358 <td class="paramtype">void&#160;</td>
359 <td class="paramname"></td><td>)</td>
360 <td> const<code> [pure virtual]</code></td>
361 </tr>
362 </table>
363</div>
364<div class="memdoc">
365
366<p>Checks if an override color is enabled. </p>
367<dl class="return"><dt><b>Returns:</b></dt><dd>true if the override color is enabled, false otherwise </dd></dl>
368
369</div>
370</div>
371<a class="anchor" id="a94b093df77af7cf3e3f9853d68d2c8f2"></a><!-- doxytag: member="irr::gui::IGUIEditBox::isPasswordBox" ref="a94b093df77af7cf3e3f9853d68d2c8f2" args="() const =0" -->
372<div class="memitem">
373<div class="memproto">
374 <table class="memname">
375 <tr>
376 <td class="memname">virtual bool irr::gui::IGUIEditBox::isPasswordBox </td>
377 <td>(</td>
378 <td class="paramname"></td><td>)</td>
379 <td> const<code> [pure virtual]</code></td>
380 </tr>
381 </table>
382</div>
383<div class="memdoc">
384
385<p>Returns true if the edit box is currently a password box. </p>
386
387</div>
388</div>
389<a class="anchor" id="ad0fd4782c052341744ea9d1f61f80e01"></a><!-- doxytag: member="irr::gui::IGUIEditBox::isWordWrapEnabled" ref="ad0fd4782c052341744ea9d1f61f80e01" args="() const =0" -->
390<div class="memitem">
391<div class="memproto">
392 <table class="memname">
393 <tr>
394 <td class="memname">virtual bool irr::gui::IGUIEditBox::isWordWrapEnabled </td>
395 <td>(</td>
396 <td class="paramname"></td><td>)</td>
397 <td> const<code> [pure virtual]</code></td>
398 </tr>
399 </table>
400</div>
401<div class="memdoc">
402
403<p>Checks if word wrap is enabled. </p>
404<dl class="return"><dt><b>Returns:</b></dt><dd>true if word wrap is enabled, false otherwise </dd></dl>
405
406</div>
407</div>
408<a class="anchor" id="ad0a9db6da9d0594bb3b5b85a673b3e4d"></a><!-- doxytag: member="irr::gui::IGUIEditBox::setAutoScroll" ref="ad0a9db6da9d0594bb3b5b85a673b3e4d" args="(bool enable)=0" -->
409<div class="memitem">
410<div class="memproto">
411 <table class="memname">
412 <tr>
413 <td class="memname">virtual void irr::gui::IGUIEditBox::setAutoScroll </td>
414 <td>(</td>
415 <td class="paramtype">bool&#160;</td>
416 <td class="paramname"><em>enable</em></td><td>)</td>
417 <td><code> [pure virtual]</code></td>
418 </tr>
419 </table>
420</div>
421<div class="memdoc">
422
423<p>Enables or disables automatic scrolling with cursor position. </p>
424<dl><dt><b>Parameters:</b></dt><dd>
425 <table class="params">
426 <tr><td class="paramname">enable,:</td><td>If set to true, the text will move around with the cursor position </td></tr>
427 </table>
428 </dd>
429</dl>
430
431</div>
432</div>
433<a class="anchor" id="a06b1913867b10018e891969d319f376f"></a><!-- doxytag: member="irr::gui::IGUIEditBox::setDrawBackground" ref="a06b1913867b10018e891969d319f376f" args="(bool draw)=0" -->
434<div class="memitem">
435<div class="memproto">
436 <table class="memname">
437 <tr>
438 <td class="memname">virtual void irr::gui::IGUIEditBox::setDrawBackground </td>
439 <td>(</td>
440 <td class="paramtype">bool&#160;</td>
441 <td class="paramname"><em>draw</em></td><td>)</td>
442 <td><code> [pure virtual]</code></td>
443 </tr>
444 </table>
445</div>
446<div class="memdoc">
447
448<p>Sets whether to draw the background. </p>
449
450</div>
451</div>
452<a class="anchor" id="a37094bd4bc6b82a184bd1d7864f7ea18"></a><!-- doxytag: member="irr::gui::IGUIEditBox::setDrawBorder" ref="a37094bd4bc6b82a184bd1d7864f7ea18" args="(bool border)=0" -->
453<div class="memitem">
454<div class="memproto">
455 <table class="memname">
456 <tr>
457 <td class="memname">virtual void irr::gui::IGUIEditBox::setDrawBorder </td>
458 <td>(</td>
459 <td class="paramtype">bool&#160;</td>
460 <td class="paramname"><em>border</em></td><td>)</td>
461 <td><code> [pure virtual]</code></td>
462 </tr>
463 </table>
464</div>
465<div class="memdoc">
466
467<p>Turns the border on or off. </p>
468<dl><dt><b>Parameters:</b></dt><dd>
469 <table class="params">
470 <tr><td class="paramname">border,:</td><td>true if you want the border to be drawn, false if not </td></tr>
471 </table>
472 </dd>
473</dl>
474
475</div>
476</div>
477<a class="anchor" id="a5253ed6b422e129356e56f8e2a610be5"></a><!-- doxytag: member="irr::gui::IGUIEditBox::setMax" ref="a5253ed6b422e129356e56f8e2a610be5" args="(u32 max)=0" -->
478<div class="memitem">
479<div class="memproto">
480 <table class="memname">
481 <tr>
482 <td class="memname">virtual void irr::gui::IGUIEditBox::setMax </td>
483 <td>(</td>
484 <td class="paramtype"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a>&#160;</td>
485 <td class="paramname"><em>max</em></td><td>)</td>
486 <td><code> [pure virtual]</code></td>
487 </tr>
488 </table>
489</div>
490<div class="memdoc">
491
492<p>Sets the maximum amount of characters which may be entered in the box. </p>
493<dl><dt><b>Parameters:</b></dt><dd>
494 <table class="params">
495 <tr><td class="paramname">max,:</td><td>Maximum amount of characters. If 0, the character amount is infinity. </td></tr>
496 </table>
497 </dd>
498</dl>
499
500</div>
501</div>
502<a class="anchor" id="a0f68dc7ddc74d8103ba3ba4d445dbf9a"></a><!-- doxytag: member="irr::gui::IGUIEditBox::setMultiLine" ref="a0f68dc7ddc74d8103ba3ba4d445dbf9a" args="(bool enable)=0" -->
503<div class="memitem">
504<div class="memproto">
505 <table class="memname">
506 <tr>
507 <td class="memname">virtual void irr::gui::IGUIEditBox::setMultiLine </td>
508 <td>(</td>
509 <td class="paramtype">bool&#160;</td>
510 <td class="paramname"><em>enable</em></td><td>)</td>
511 <td><code> [pure virtual]</code></td>
512 </tr>
513 </table>
514</div>
515<div class="memdoc">
516
517<p>Enables or disables newlines. </p>
518<dl><dt><b>Parameters:</b></dt><dd>
519 <table class="params">
520 <tr><td class="paramname">enable,:</td><td>If set to true, the EGET_EDITBOX_ENTER event will not be fired, instead a newline character will be inserted. </td></tr>
521 </table>
522 </dd>
523</dl>
524
525</div>
526</div>
527<a class="anchor" id="aa134d2a36c52abcb4881da0267031c47"></a><!-- doxytag: member="irr::gui::IGUIEditBox::setOverrideColor" ref="aa134d2a36c52abcb4881da0267031c47" args="(video::SColor color)=0" -->
528<div class="memitem">
529<div class="memproto">
530 <table class="memname">
531 <tr>
532 <td class="memname">virtual void irr::gui::IGUIEditBox::setOverrideColor </td>
533 <td>(</td>
534 <td class="paramtype"><a class="el" href="classirr_1_1video_1_1_s_color.html">video::SColor</a>&#160;</td>
535 <td class="paramname"><em>color</em></td><td>)</td>
536 <td><code> [pure virtual]</code></td>
537 </tr>
538 </table>
539</div>
540<div class="memdoc">
541
542<p>Sets another color for the text. </p>
543<p>If set, the edit box does not use the EGDC_BUTTON_TEXT color defined in the skin, but the set color instead. You don't need to call IGUIEditBox::enableOverrrideColor(true) after this, this is done by this function. If you set a color, and you want the text displayed with the color of the skin again, call IGUIEditBox::enableOverrideColor(false); </p>
544<dl><dt><b>Parameters:</b></dt><dd>
545 <table class="params">
546 <tr><td class="paramname">color,:</td><td>New color of the text. </td></tr>
547 </table>
548 </dd>
549</dl>
550
551</div>
552</div>
553<a class="anchor" id="a7608fe327ec860712ec87b5e1dc4aec9"></a><!-- doxytag: member="irr::gui::IGUIEditBox::setOverrideFont" ref="a7608fe327ec860712ec87b5e1dc4aec9" args="(IGUIFont *font=0)=0" -->
554<div class="memitem">
555<div class="memproto">
556 <table class="memname">
557 <tr>
558 <td class="memname">virtual void irr::gui::IGUIEditBox::setOverrideFont </td>
559 <td>(</td>
560 <td class="paramtype"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_font.html">IGUIFont</a> *&#160;</td>
561 <td class="paramname"><em>font</em> = <code>0</code></td><td>)</td>
562 <td><code> [pure virtual]</code></td>
563 </tr>
564 </table>
565</div>
566<div class="memdoc">
567
568<p>Sets another skin independent font. </p>
569<p>If this is set to zero, the button uses the font of the skin. </p>
570<dl><dt><b>Parameters:</b></dt><dd>
571 <table class="params">
572 <tr><td class="paramname">font,:</td><td>New font to set. </td></tr>
573 </table>
574 </dd>
575</dl>
576
577</div>
578</div>
579<a class="anchor" id="a59a0cf8090eb165fdbade6144bc19807"></a><!-- doxytag: member="irr::gui::IGUIEditBox::setPasswordBox" ref="a59a0cf8090eb165fdbade6144bc19807" args="(bool passwordBox, wchar_t passwordChar=L'*')=0" -->
580<div class="memitem">
581<div class="memproto">
582 <table class="memname">
583 <tr>
584 <td class="memname">virtual void irr::gui::IGUIEditBox::setPasswordBox </td>
585 <td>(</td>
586 <td class="paramtype">bool&#160;</td>
587 <td class="paramname"><em>passwordBox</em>, </td>
588 </tr>
589 <tr>
590 <td class="paramkey"></td>
591 <td></td>
592 <td class="paramtype">wchar_t&#160;</td>
593 <td class="paramname"><em>passwordChar</em> = <code>L'*'</code>&#160;</td>
594 </tr>
595 <tr>
596 <td></td>
597 <td>)</td>
598 <td></td><td><code> [pure virtual]</code></td>
599 </tr>
600 </table>
601</div>
602<div class="memdoc">
603
604<p>Sets whether the edit box is a password box. Setting this to true will. </p>
605<p>disable MultiLine, WordWrap and the ability to copy with ctrl+c or ctrl+x </p>
606<dl><dt><b>Parameters:</b></dt><dd>
607 <table class="params">
608 <tr><td class="paramname">passwordBox,:</td><td>true to enable password, false to disable </td></tr>
609 <tr><td class="paramname">passwordChar,:</td><td>the character that is displayed instead of letters </td></tr>
610 </table>
611 </dd>
612</dl>
613
614</div>
615</div>
616<a class="anchor" id="ab1e2379940983f4ff874f5143f6d7244"></a><!-- doxytag: member="irr::gui::IGUIEditBox::setTextAlignment" ref="ab1e2379940983f4ff874f5143f6d7244" args="(EGUI_ALIGNMENT horizontal, EGUI_ALIGNMENT vertical)=0" -->
617<div class="memitem">
618<div class="memproto">
619 <table class="memname">
620 <tr>
621 <td class="memname">virtual void irr::gui::IGUIEditBox::setTextAlignment </td>
622 <td>(</td>
623 <td class="paramtype"><a class="el" href="namespaceirr_1_1gui.html#a19eb5fb40e67f108cb16aba922ddaa2d">EGUI_ALIGNMENT</a>&#160;</td>
624 <td class="paramname"><em>horizontal</em>, </td>
625 </tr>
626 <tr>
627 <td class="paramkey"></td>
628 <td></td>
629 <td class="paramtype"><a class="el" href="namespaceirr_1_1gui.html#a19eb5fb40e67f108cb16aba922ddaa2d">EGUI_ALIGNMENT</a>&#160;</td>
630 <td class="paramname"><em>vertical</em>&#160;</td>
631 </tr>
632 <tr>
633 <td></td>
634 <td>)</td>
635 <td></td><td><code> [pure virtual]</code></td>
636 </tr>
637 </table>
638</div>
639<div class="memdoc">
640
641<p>Sets text justification mode. </p>
642<dl><dt><b>Parameters:</b></dt><dd>
643 <table class="params">
644 <tr><td class="paramname">horizontal,:</td><td>EGUIA_UPPERLEFT for left justified (default), EGUIA_LOWERRIGHT for right justified, or EGUIA_CENTER for centered text. </td></tr>
645 <tr><td class="paramname">vertical,:</td><td>EGUIA_UPPERLEFT to align with top edge, EGUIA_LOWERRIGHT for bottom edge, or EGUIA_CENTER for centered text (default). </td></tr>
646 </table>
647 </dd>
648</dl>
649
650</div>
651</div>
652<a class="anchor" id="aa020a985b38d293794b73e6e12dafd7c"></a><!-- doxytag: member="irr::gui::IGUIEditBox::setWordWrap" ref="aa020a985b38d293794b73e6e12dafd7c" args="(bool enable)=0" -->
653<div class="memitem">
654<div class="memproto">
655 <table class="memname">
656 <tr>
657 <td class="memname">virtual void irr::gui::IGUIEditBox::setWordWrap </td>
658 <td>(</td>
659 <td class="paramtype">bool&#160;</td>
660 <td class="paramname"><em>enable</em></td><td>)</td>
661 <td><code> [pure virtual]</code></td>
662 </tr>
663 </table>
664</div>
665<div class="memdoc">
666
667<p>Enables or disables word wrap. </p>
668<dl><dt><b>Parameters:</b></dt><dd>
669 <table class="params">
670 <tr><td class="paramname">enable,:</td><td>If set to true, words going over one line are broken to the next line. </td></tr>
671 </table>
672 </dd>
673</dl>
674
675</div>
676</div>
677<hr/>The documentation for this class was generated from the following file:<ul>
678<li><a class="el" href="_i_g_u_i_edit_box_8h_source.html">IGUIEditBox.h</a></li>
679</ul>
680</div>
681</div>
682 <div id="nav-path" class="navpath">
683 <ul>
684 <li class="navelem"><a class="el" href="namespaceirr.html">irr</a> </li>
685 <li class="navelem"><a class="el" href="namespaceirr_1_1gui.html">gui</a> </li>
686 <li class="navelem"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html">IGUIEditBox</a> </li>
687<!-- window showing the filter options -->
688<div id="MSearchSelectWindow"
689 onmouseover="return searchBox.OnSearchSelectShow()"
690 onmouseout="return searchBox.OnSearchSelectHide()"
691 onkeydown="return searchBox.OnSearchSelectKey(event)">
692<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>
693
694<!-- iframe showing the search results (closed by default) -->
695<div id="MSearchResultsWindow">
696<iframe src="javascript:void(0)" frameborder="0"
697 name="MSearchResults" id="MSearchResults">
698</iframe>
699</div>
700
701
702 <li class="footer">
703<a href="http://irrlicht.sourceforge.net" target="_blank">Irrlicht
704Engine</a> Documentation &copy; 2003-2012 by Nikolaus Gebhardt. Generated on Sun Nov 17 2013 20:18:43 for Irrlicht 3D Engine by
705<a href="http://www.doxygen.org/index.html" target="_blank">Doxygen</a> 1.7.5.1 </li>
706 </ul>
707 </div>
708
709
710</body>
711</html>
generated by cgit v1.1 at 2024-05-15 19:27:57 +0000