aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/src/others/irrlicht-1.8.1/doc/html/classirr_1_1gui_1_1_i_g_u_i_static_text.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_static_text.html')
-rw-r--r--src/others/irrlicht-1.8.1/doc/html/classirr_1_1gui_1_1_i_g_u_i_static_text.html691
1 files changed, 691 insertions, 0 deletions
diff --git a/src/others/irrlicht-1.8.1/doc/html/classirr_1_1gui_1_1_i_g_u_i_static_text.html b/src/others/irrlicht-1.8.1/doc/html/classirr_1_1gui_1_1_i_g_u_i_static_text.html
new file mode 100644
index 0000000..801d5dc
--- /dev/null
+++ b/src/others/irrlicht-1.8.1/doc/html/classirr_1_1gui_1_1_i_g_u_i_static_text.html
@@ -0,0 +1,691 @@
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::IGUIStaticText 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_static_text.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::IGUIStaticText Class Reference</div> </div>
91</div>
92<div class="contents">
93<!-- doxytag: class="irr::gui::IGUIStaticText" --><!-- doxytag: inherits="irr::gui::IGUIElement" -->
94<p>Multi or single line text label.
95 <a href="classirr_1_1gui_1_1_i_g_u_i_static_text.html#details">More...</a></p>
96
97<p><code>#include &lt;<a class="el" href="_i_g_u_i_static_text_8h_source.html">IGUIStaticText.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::IGUIStaticText:</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_static_text.png" usemap="#irr::gui::IGUIStaticText_map" alt=""/>
105 <map id="irr::gui::IGUIStaticText_map" name="irr::gui::IGUIStaticText_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_static_text-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_static_text.html#a80f93a4419ad85a0f9aadfbdd26aa87d">IGUIStaticText</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="#a80f93a4419ad85a0f9aadfbdd26aa87d"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_static_text.html#ae1f432263d4c638b0441f8b993f301bc">enableOverrideColor</a> (bool enable)=0
119<dl class="el"><dd class="mdescRight">Sets if the static text should use the overide color or the color in the gui skin. <a href="#ae1f432263d4c638b0441f8b993f301bc"></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_static_text.html#aef001eb5d0e13b5b6d1efead606605c2">getActiveFont</a> () const =0
120<dl class="el"><dd class="mdescRight">Get the font which is used right now for drawing. <a href="#aef001eb5d0e13b5b6d1efead606605c2"></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_static_text.html#a7149fff0b2c4159503f114807e0b0a83">getBackgroundColor</a> () const =0
121<dl class="el"><dd class="mdescRight">Gets the background color. <a href="#a7149fff0b2c4159503f114807e0b0a83"></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_static_text.html#a9c4c43f262efd02a113da79bedb973e1">getOverrideColor</a> (void) const =0
122<dl class="el"><dd class="mdescRight">Gets the override color. <a href="#a9c4c43f262efd02a113da79bedb973e1"></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_static_text.html#a581f18f3ffe650246125988b3b7dc44e">getOverrideFont</a> (void) const =0
123<dl class="el"><dd class="mdescRight">Gets the override font (if any) <a href="#a581f18f3ffe650246125988b3b7dc44e"></a><br/></dl><li>virtual <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_static_text.html#a88e90c238601f17e1f0b0d79c7dc1004">getTextHeight</a> () const =0
124<dl class="el"><dd class="mdescRight">Returns the height of the text in pixels when it is drawn. <a href="#a88e90c238601f17e1f0b0d79c7dc1004"></a><br/></dl><li>virtual <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_static_text.html#adcfbe869b6c0ab409bbde51d4cba7e5d">getTextWidth</a> (void) const =0
125<dl class="el"><dd class="mdescRight">Returns the width of the current text, in the current font. <a href="#adcfbe869b6c0ab409bbde51d4cba7e5d"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_static_text.html#ab6da7f10a72d023729d12c85e2926aec">isDrawBackgroundEnabled</a> () const =0
126<dl class="el"><dd class="mdescRight">Checks if background drawing is enabled. <a href="#ab6da7f10a72d023729d12c85e2926aec"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_static_text.html#a52478a36f77cfbc62e1f57a486e0a083">isDrawBorderEnabled</a> () const =0
127<dl class="el"><dd class="mdescRight">Checks if border drawing is enabled. <a href="#a52478a36f77cfbc62e1f57a486e0a083"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_static_text.html#a67b17803b8ad73e8d687b23ad38db37e">isOverrideColorEnabled</a> (void) const =0
128<dl class="el"><dd class="mdescRight">Checks if an override color is enabled. <a href="#a67b17803b8ad73e8d687b23ad38db37e"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_static_text.html#a750a43d48f16d0e89aa28a0175a06ff6">isRightToLeft</a> () const =0
129<dl class="el"><dd class="mdescRight">Checks whether the text in this element should be interpreted as right-to-left. <a href="#a750a43d48f16d0e89aa28a0175a06ff6"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_static_text.html#a90823f5df79cfd4e2e3a20f38bc3b65a">isTextRestrainedInside</a> () const =0
130<dl class="el"><dd class="mdescRight">Checks if the text in this label should be clipped if it goes outside bounds. <a href="#a90823f5df79cfd4e2e3a20f38bc3b65a"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_static_text.html#a42d7fbdb196414a1d95146b53e6a3528">isWordWrapEnabled</a> (void) const =0
131<dl class="el"><dd class="mdescRight">Checks if word wrap is enabled. <a href="#a42d7fbdb196414a1d95146b53e6a3528"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_static_text.html#afe9b39a38851b8d4056a35e3d62996d6">setBackgroundColor</a> (<a class="el" href="classirr_1_1video_1_1_s_color.html">video::SColor</a> color)=0
132<dl class="el"><dd class="mdescRight">Sets another color for the background. <a href="#afe9b39a38851b8d4056a35e3d62996d6"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_static_text.html#aed8ab71280b2c1787c62565d199c0c34">setDrawBackground</a> (bool draw)=0
133<dl class="el"><dd class="mdescRight">Sets whether to draw the background. <a href="#aed8ab71280b2c1787c62565d199c0c34"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_static_text.html#a48e8662debdf36b4eb3319a5fee937c6">setDrawBorder</a> (bool draw)=0
134<dl class="el"><dd class="mdescRight">Sets whether to draw the border. <a href="#a48e8662debdf36b4eb3319a5fee937c6"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_static_text.html#aadc1f0e10e4b298944e6dcfd49e54009">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="#aadc1f0e10e4b298944e6dcfd49e54009"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_static_text.html#ae3f65780d10979eb323ee7310cff7396">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="#ae3f65780d10979eb323ee7310cff7396"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_static_text.html#a43cee247cf34faa30851f4e8c10b2367">setRightToLeft</a> (bool rtl)=0
137<dl class="el"><dd class="mdescRight">Set whether the string should be interpreted as right-to-left (RTL) text. <a href="#a43cee247cf34faa30851f4e8c10b2367"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_static_text.html#ad8635f1247971277543cfff6e1fa9277">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="#ad8635f1247971277543cfff6e1fa9277"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_static_text.html#aaec565b5b45581470d4e524c2efac1b6">setTextRestrainedInside</a> (bool restrainedInside)=0
139<dl class="el"><dd class="mdescRight">Set whether the text in this label should be clipped if it goes outside bounds. <a href="#aaec565b5b45581470d4e524c2efac1b6"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_static_text.html#a2a47bc2f85ced3efc1d007c5bd61f906">setWordWrap</a> (bool enable)=0
140<dl class="el"><dd class="mdescRight">Enables or disables word wrap for using the static text as multiline text control. <a href="#a2a47bc2f85ced3efc1d007c5bd61f906"></a><br/></dl></ul>
141<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
142<div class="textblock"><p>Multi or single line text label. </p>
143
144<p>Definition at line <a class="el" href="_i_g_u_i_static_text_8h_source.html#l00018">18</a> of file <a class="el" href="_i_g_u_i_static_text_8h_source.html">IGUIStaticText.h</a>.</p>
145</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
146<a class="anchor" id="a80f93a4419ad85a0f9aadfbdd26aa87d"></a><!-- doxytag: member="irr::gui::IGUIStaticText::IGUIStaticText" ref="a80f93a4419ad85a0f9aadfbdd26aa87d" args="(IGUIEnvironment *environment, IGUIElement *parent, s32 id, core::rect&lt; s32 &gt; rectangle)" -->
147<div class="memitem">
148<div class="memproto">
149 <table class="memname">
150 <tr>
151 <td class="memname">irr::gui::IGUIStaticText::IGUIStaticText </td>
152 <td>(</td>
153 <td class="paramtype"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_environment.html">IGUIEnvironment</a> *&#160;</td>
154 <td class="paramname"><em>environment</em>, </td>
155 </tr>
156 <tr>
157 <td class="paramkey"></td>
158 <td></td>
159 <td class="paramtype"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_element.html">IGUIElement</a> *&#160;</td>
160 <td class="paramname"><em>parent</em>, </td>
161 </tr>
162 <tr>
163 <td class="paramkey"></td>
164 <td></td>
165 <td class="paramtype"><a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a>&#160;</td>
166 <td class="paramname"><em>id</em>, </td>
167 </tr>
168 <tr>
169 <td class="paramkey"></td>
170 <td></td>
171 <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>
172 <td class="paramname"><em>rectangle</em>&#160;</td>
173 </tr>
174 <tr>
175 <td></td>
176 <td>)</td>
177 <td></td><td><code> [inline]</code></td>
178 </tr>
179 </table>
180</div>
181<div class="memdoc">
182
183<p>constructor </p>
184
185<p>Definition at line <a class="el" href="_i_g_u_i_static_text_8h_source.html#l00023">23</a> of file <a class="el" href="_i_g_u_i_static_text_8h_source.html">IGUIStaticText.h</a>.</p>
186
187</div>
188</div>
189<hr/><h2>Member Function Documentation</h2>
190<a class="anchor" id="ae1f432263d4c638b0441f8b993f301bc"></a><!-- doxytag: member="irr::gui::IGUIStaticText::enableOverrideColor" ref="ae1f432263d4c638b0441f8b993f301bc" args="(bool enable)=0" -->
191<div class="memitem">
192<div class="memproto">
193 <table class="memname">
194 <tr>
195 <td class="memname">virtual void irr::gui::IGUIStaticText::enableOverrideColor </td>
196 <td>(</td>
197 <td class="paramtype">bool&#160;</td>
198 <td class="paramname"><em>enable</em></td><td>)</td>
199 <td><code> [pure virtual]</code></td>
200 </tr>
201 </table>
202</div>
203<div class="memdoc">
204
205<p>Sets if the static text should use the overide color or the color in the gui skin. </p>
206<dl><dt><b>Parameters:</b></dt><dd>
207 <table class="params">
208 <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_static_text.html#aadc1f0e10e4b298944e6dcfd49e54009" title="Sets another color for the text.">IGUIStaticText::setOverrideColor</a> is used, otherwise the EGDC_BUTTON_TEXT color of the skin. </td></tr>
209 </table>
210 </dd>
211</dl>
212
213</div>
214</div>
215<a class="anchor" id="aef001eb5d0e13b5b6d1efead606605c2"></a><!-- doxytag: member="irr::gui::IGUIStaticText::getActiveFont" ref="aef001eb5d0e13b5b6d1efead606605c2" args="() const =0" -->
216<div class="memitem">
217<div class="memproto">
218 <table class="memname">
219 <tr>
220 <td class="memname">virtual <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_font.html">IGUIFont</a>* irr::gui::IGUIStaticText::getActiveFont </td>
221 <td>(</td>
222 <td class="paramname"></td><td>)</td>
223 <td> const<code> [pure virtual]</code></td>
224 </tr>
225 </table>
226</div>
227<div class="memdoc">
228
229<p>Get the font which is used right now for drawing. </p>
230<p>Currently this is the override font when one is set and the font of the active skin otherwise </p>
231
232</div>
233</div>
234<a class="anchor" id="a7149fff0b2c4159503f114807e0b0a83"></a><!-- doxytag: member="irr::gui::IGUIStaticText::getBackgroundColor" ref="a7149fff0b2c4159503f114807e0b0a83" args="() const =0" -->
235<div class="memitem">
236<div class="memproto">
237 <table class="memname">
238 <tr>
239 <td class="memname">virtual <a class="el" href="classirr_1_1video_1_1_s_color.html">video::SColor</a> irr::gui::IGUIStaticText::getBackgroundColor </td>
240 <td>(</td>
241 <td class="paramname"></td><td>)</td>
242 <td> const<code> [pure virtual]</code></td>
243 </tr>
244 </table>
245</div>
246<div class="memdoc">
247
248<p>Gets the background color. </p>
249<dl class="return"><dt><b>Returns:</b></dt><dd>: The background color </dd></dl>
250
251</div>
252</div>
253<a class="anchor" id="a9c4c43f262efd02a113da79bedb973e1"></a><!-- doxytag: member="irr::gui::IGUIStaticText::getOverrideColor" ref="a9c4c43f262efd02a113da79bedb973e1" args="(void) const =0" -->
254<div class="memitem">
255<div class="memproto">
256 <table class="memname">
257 <tr>
258 <td class="memname">virtual <a class="el" href="classirr_1_1video_1_1_s_color.html">video::SColor</a> irr::gui::IGUIStaticText::getOverrideColor </td>
259 <td>(</td>
260 <td class="paramtype">void&#160;</td>
261 <td class="paramname"></td><td>)</td>
262 <td> const<code> [pure virtual]</code></td>
263 </tr>
264 </table>
265</div>
266<div class="memdoc">
267
268<p>Gets the override color. </p>
269<dl class="return"><dt><b>Returns:</b></dt><dd>: The override color </dd></dl>
270
271</div>
272</div>
273<a class="anchor" id="a581f18f3ffe650246125988b3b7dc44e"></a><!-- doxytag: member="irr::gui::IGUIStaticText::getOverrideFont" ref="a581f18f3ffe650246125988b3b7dc44e" args="(void) const =0" -->
274<div class="memitem">
275<div class="memproto">
276 <table class="memname">
277 <tr>
278 <td class="memname">virtual <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_font.html">IGUIFont</a>* irr::gui::IGUIStaticText::getOverrideFont </td>
279 <td>(</td>
280 <td class="paramtype">void&#160;</td>
281 <td class="paramname"></td><td>)</td>
282 <td> const<code> [pure virtual]</code></td>
283 </tr>
284 </table>
285</div>
286<div class="memdoc">
287
288<p>Gets the override font (if any) </p>
289<dl class="return"><dt><b>Returns:</b></dt><dd>The override font (may be 0) </dd></dl>
290
291</div>
292</div>
293<a class="anchor" id="a88e90c238601f17e1f0b0d79c7dc1004"></a><!-- doxytag: member="irr::gui::IGUIStaticText::getTextHeight" ref="a88e90c238601f17e1f0b0d79c7dc1004" args="() const =0" -->
294<div class="memitem">
295<div class="memproto">
296 <table class="memname">
297 <tr>
298 <td class="memname">virtual <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> irr::gui::IGUIStaticText::getTextHeight </td>
299 <td>(</td>
300 <td class="paramname"></td><td>)</td>
301 <td> const<code> [pure virtual]</code></td>
302 </tr>
303 </table>
304</div>
305<div class="memdoc">
306
307<p>Returns the height of the text in pixels when it is drawn. </p>
308<p>This is useful for adjusting the layout of gui elements based on the height of the multiline text in this element. </p>
309<dl class="return"><dt><b>Returns:</b></dt><dd>Height of text in pixels. </dd></dl>
310
311</div>
312</div>
313<a class="anchor" id="adcfbe869b6c0ab409bbde51d4cba7e5d"></a><!-- doxytag: member="irr::gui::IGUIStaticText::getTextWidth" ref="adcfbe869b6c0ab409bbde51d4cba7e5d" args="(void) const =0" -->
314<div class="memitem">
315<div class="memproto">
316 <table class="memname">
317 <tr>
318 <td class="memname">virtual <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> irr::gui::IGUIStaticText::getTextWidth </td>
319 <td>(</td>
320 <td class="paramtype">void&#160;</td>
321 <td class="paramname"></td><td>)</td>
322 <td> const<code> [pure virtual]</code></td>
323 </tr>
324 </table>
325</div>
326<div class="memdoc">
327
328<p>Returns the width of the current text, in the current font. </p>
329<p>If the text is broken, this returns the width of the widest line </p>
330<dl class="return"><dt><b>Returns:</b></dt><dd>The width of the text, or the widest broken line. </dd></dl>
331
332</div>
333</div>
334<a class="anchor" id="ab6da7f10a72d023729d12c85e2926aec"></a><!-- doxytag: member="irr::gui::IGUIStaticText::isDrawBackgroundEnabled" ref="ab6da7f10a72d023729d12c85e2926aec" args="() const =0" -->
335<div class="memitem">
336<div class="memproto">
337 <table class="memname">
338 <tr>
339 <td class="memname">virtual bool irr::gui::IGUIStaticText::isDrawBackgroundEnabled </td>
340 <td>(</td>
341 <td class="paramname"></td><td>)</td>
342 <td> const<code> [pure virtual]</code></td>
343 </tr>
344 </table>
345</div>
346<div class="memdoc">
347
348<p>Checks if background drawing is enabled. </p>
349<dl class="return"><dt><b>Returns:</b></dt><dd>true if background drawing is enabled, false otherwise </dd></dl>
350
351</div>
352</div>
353<a class="anchor" id="a52478a36f77cfbc62e1f57a486e0a083"></a><!-- doxytag: member="irr::gui::IGUIStaticText::isDrawBorderEnabled" ref="a52478a36f77cfbc62e1f57a486e0a083" args="() const =0" -->
354<div class="memitem">
355<div class="memproto">
356 <table class="memname">
357 <tr>
358 <td class="memname">virtual bool irr::gui::IGUIStaticText::isDrawBorderEnabled </td>
359 <td>(</td>
360 <td class="paramname"></td><td>)</td>
361 <td> const<code> [pure virtual]</code></td>
362 </tr>
363 </table>
364</div>
365<div class="memdoc">
366
367<p>Checks if border drawing is enabled. </p>
368<dl class="return"><dt><b>Returns:</b></dt><dd>true if border drawing is enabled, false otherwise </dd></dl>
369
370</div>
371</div>
372<a class="anchor" id="a67b17803b8ad73e8d687b23ad38db37e"></a><!-- doxytag: member="irr::gui::IGUIStaticText::isOverrideColorEnabled" ref="a67b17803b8ad73e8d687b23ad38db37e" args="(void) const =0" -->
373<div class="memitem">
374<div class="memproto">
375 <table class="memname">
376 <tr>
377 <td class="memname">virtual bool irr::gui::IGUIStaticText::isOverrideColorEnabled </td>
378 <td>(</td>
379 <td class="paramtype">void&#160;</td>
380 <td class="paramname"></td><td>)</td>
381 <td> const<code> [pure virtual]</code></td>
382 </tr>
383 </table>
384</div>
385<div class="memdoc">
386
387<p>Checks if an override color is enabled. </p>
388<dl class="return"><dt><b>Returns:</b></dt><dd>true if the override color is enabled, false otherwise </dd></dl>
389
390</div>
391</div>
392<a class="anchor" id="a750a43d48f16d0e89aa28a0175a06ff6"></a><!-- doxytag: member="irr::gui::IGUIStaticText::isRightToLeft" ref="a750a43d48f16d0e89aa28a0175a06ff6" args="() const =0" -->
393<div class="memitem">
394<div class="memproto">
395 <table class="memname">
396 <tr>
397 <td class="memname">virtual bool irr::gui::IGUIStaticText::isRightToLeft </td>
398 <td>(</td>
399 <td class="paramname"></td><td>)</td>
400 <td> const<code> [pure virtual]</code></td>
401 </tr>
402 </table>
403</div>
404<div class="memdoc">
405
406<p>Checks whether the text in this element should be interpreted as right-to-left. </p>
407
408</div>
409</div>
410<a class="anchor" id="a90823f5df79cfd4e2e3a20f38bc3b65a"></a><!-- doxytag: member="irr::gui::IGUIStaticText::isTextRestrainedInside" ref="a90823f5df79cfd4e2e3a20f38bc3b65a" args="() const =0" -->
411<div class="memitem">
412<div class="memproto">
413 <table class="memname">
414 <tr>
415 <td class="memname">virtual bool irr::gui::IGUIStaticText::isTextRestrainedInside </td>
416 <td>(</td>
417 <td class="paramname"></td><td>)</td>
418 <td> const<code> [pure virtual]</code></td>
419 </tr>
420 </table>
421</div>
422<div class="memdoc">
423
424<p>Checks if the text in this label should be clipped if it goes outside bounds. </p>
425
426</div>
427</div>
428<a class="anchor" id="a42d7fbdb196414a1d95146b53e6a3528"></a><!-- doxytag: member="irr::gui::IGUIStaticText::isWordWrapEnabled" ref="a42d7fbdb196414a1d95146b53e6a3528" args="(void) const =0" -->
429<div class="memitem">
430<div class="memproto">
431 <table class="memname">
432 <tr>
433 <td class="memname">virtual bool irr::gui::IGUIStaticText::isWordWrapEnabled </td>
434 <td>(</td>
435 <td class="paramtype">void&#160;</td>
436 <td class="paramname"></td><td>)</td>
437 <td> const<code> [pure virtual]</code></td>
438 </tr>
439 </table>
440</div>
441<div class="memdoc">
442
443<p>Checks if word wrap is enabled. </p>
444<dl class="return"><dt><b>Returns:</b></dt><dd>true if word wrap is enabled, false otherwise </dd></dl>
445
446</div>
447</div>
448<a class="anchor" id="afe9b39a38851b8d4056a35e3d62996d6"></a><!-- doxytag: member="irr::gui::IGUIStaticText::setBackgroundColor" ref="afe9b39a38851b8d4056a35e3d62996d6" args="(video::SColor color)=0" -->
449<div class="memitem">
450<div class="memproto">
451 <table class="memname">
452 <tr>
453 <td class="memname">virtual void irr::gui::IGUIStaticText::setBackgroundColor </td>
454 <td>(</td>
455 <td class="paramtype"><a class="el" href="classirr_1_1video_1_1_s_color.html">video::SColor</a>&#160;</td>
456 <td class="paramname"><em>color</em></td><td>)</td>
457 <td><code> [pure virtual]</code></td>
458 </tr>
459 </table>
460</div>
461<div class="memdoc">
462
463<p>Sets another color for the background. </p>
464
465</div>
466</div>
467<a class="anchor" id="aed8ab71280b2c1787c62565d199c0c34"></a><!-- doxytag: member="irr::gui::IGUIStaticText::setDrawBackground" ref="aed8ab71280b2c1787c62565d199c0c34" args="(bool draw)=0" -->
468<div class="memitem">
469<div class="memproto">
470 <table class="memname">
471 <tr>
472 <td class="memname">virtual void irr::gui::IGUIStaticText::setDrawBackground </td>
473 <td>(</td>
474 <td class="paramtype">bool&#160;</td>
475 <td class="paramname"><em>draw</em></td><td>)</td>
476 <td><code> [pure virtual]</code></td>
477 </tr>
478 </table>
479</div>
480<div class="memdoc">
481
482<p>Sets whether to draw the background. </p>
483
484</div>
485</div>
486<a class="anchor" id="a48e8662debdf36b4eb3319a5fee937c6"></a><!-- doxytag: member="irr::gui::IGUIStaticText::setDrawBorder" ref="a48e8662debdf36b4eb3319a5fee937c6" args="(bool draw)=0" -->
487<div class="memitem">
488<div class="memproto">
489 <table class="memname">
490 <tr>
491 <td class="memname">virtual void irr::gui::IGUIStaticText::setDrawBorder </td>
492 <td>(</td>
493 <td class="paramtype">bool&#160;</td>
494 <td class="paramname"><em>draw</em></td><td>)</td>
495 <td><code> [pure virtual]</code></td>
496 </tr>
497 </table>
498</div>
499<div class="memdoc">
500
501<p>Sets whether to draw the border. </p>
502
503</div>
504</div>
505<a class="anchor" id="aadc1f0e10e4b298944e6dcfd49e54009"></a><!-- doxytag: member="irr::gui::IGUIStaticText::setOverrideColor" ref="aadc1f0e10e4b298944e6dcfd49e54009" args="(video::SColor color)=0" -->
506<div class="memitem">
507<div class="memproto">
508 <table class="memname">
509 <tr>
510 <td class="memname">virtual void irr::gui::IGUIStaticText::setOverrideColor </td>
511 <td>(</td>
512 <td class="paramtype"><a class="el" href="classirr_1_1video_1_1_s_color.html">video::SColor</a>&#160;</td>
513 <td class="paramname"><em>color</em></td><td>)</td>
514 <td><code> [pure virtual]</code></td>
515 </tr>
516 </table>
517</div>
518<div class="memdoc">
519
520<p>Sets another color for the text. </p>
521<p>If set, the static text does not use the EGDC_BUTTON_TEXT color defined in the skin, but the set color instead. You don't need to call IGUIStaticText::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 IGUIStaticText::enableOverrideColor(false); </p>
522<dl><dt><b>Parameters:</b></dt><dd>
523 <table class="params">
524 <tr><td class="paramname">color,:</td><td>New color of the text. </td></tr>
525 </table>
526 </dd>
527</dl>
528
529</div>
530</div>
531<a class="anchor" id="ae3f65780d10979eb323ee7310cff7396"></a><!-- doxytag: member="irr::gui::IGUIStaticText::setOverrideFont" ref="ae3f65780d10979eb323ee7310cff7396" args="(IGUIFont *font=0)=0" -->
532<div class="memitem">
533<div class="memproto">
534 <table class="memname">
535 <tr>
536 <td class="memname">virtual void irr::gui::IGUIStaticText::setOverrideFont </td>
537 <td>(</td>
538 <td class="paramtype"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_font.html">IGUIFont</a> *&#160;</td>
539 <td class="paramname"><em>font</em> = <code>0</code></td><td>)</td>
540 <td><code> [pure virtual]</code></td>
541 </tr>
542 </table>
543</div>
544<div class="memdoc">
545
546<p>Sets another skin independent font. </p>
547<p>If this is set to zero, the button uses the font of the skin. </p>
548<dl><dt><b>Parameters:</b></dt><dd>
549 <table class="params">
550 <tr><td class="paramname">font,:</td><td>New font to set. </td></tr>
551 </table>
552 </dd>
553</dl>
554
555</div>
556</div>
557<a class="anchor" id="a43cee247cf34faa30851f4e8c10b2367"></a><!-- doxytag: member="irr::gui::IGUIStaticText::setRightToLeft" ref="a43cee247cf34faa30851f4e8c10b2367" args="(bool rtl)=0" -->
558<div class="memitem">
559<div class="memproto">
560 <table class="memname">
561 <tr>
562 <td class="memname">virtual void irr::gui::IGUIStaticText::setRightToLeft </td>
563 <td>(</td>
564 <td class="paramtype">bool&#160;</td>
565 <td class="paramname"><em>rtl</em></td><td>)</td>
566 <td><code> [pure virtual]</code></td>
567 </tr>
568 </table>
569</div>
570<div class="memdoc">
571
572<p>Set whether the string should be interpreted as right-to-left (RTL) text. </p>
573<dl class="note"><dt><b>Note:</b></dt><dd>This component does not implement the Unicode bidi standard, the text of the component should be already RTL if you call this. The main difference when RTL is enabled is that the linebreaks for multiline elements are performed starting from the end. </dd></dl>
574
575</div>
576</div>
577<a class="anchor" id="ad8635f1247971277543cfff6e1fa9277"></a><!-- doxytag: member="irr::gui::IGUIStaticText::setTextAlignment" ref="ad8635f1247971277543cfff6e1fa9277" args="(EGUI_ALIGNMENT horizontal, EGUI_ALIGNMENT vertical)=0" -->
578<div class="memitem">
579<div class="memproto">
580 <table class="memname">
581 <tr>
582 <td class="memname">virtual void irr::gui::IGUIStaticText::setTextAlignment </td>
583 <td>(</td>
584 <td class="paramtype"><a class="el" href="namespaceirr_1_1gui.html#a19eb5fb40e67f108cb16aba922ddaa2d">EGUI_ALIGNMENT</a>&#160;</td>
585 <td class="paramname"><em>horizontal</em>, </td>
586 </tr>
587 <tr>
588 <td class="paramkey"></td>
589 <td></td>
590 <td class="paramtype"><a class="el" href="namespaceirr_1_1gui.html#a19eb5fb40e67f108cb16aba922ddaa2d">EGUI_ALIGNMENT</a>&#160;</td>
591 <td class="paramname"><em>vertical</em>&#160;</td>
592 </tr>
593 <tr>
594 <td></td>
595 <td>)</td>
596 <td></td><td><code> [pure virtual]</code></td>
597 </tr>
598 </table>
599</div>
600<div class="memdoc">
601
602<p>Sets text justification mode. </p>
603<dl><dt><b>Parameters:</b></dt><dd>
604 <table class="params">
605 <tr><td class="paramname">horizontal,:</td><td>EGUIA_UPPERLEFT for left justified (default), EGUIA_LOWEERRIGHT for right justified, or EGUIA_CENTER for centered text. </td></tr>
606 <tr><td class="paramname">vertical,:</td><td>EGUIA_UPPERLEFT to align with top edge, EGUIA_LOWEERRIGHT for bottom edge, or EGUIA_CENTER for centered text (default). </td></tr>
607 </table>
608 </dd>
609</dl>
610
611</div>
612</div>
613<a class="anchor" id="aaec565b5b45581470d4e524c2efac1b6"></a><!-- doxytag: member="irr::gui::IGUIStaticText::setTextRestrainedInside" ref="aaec565b5b45581470d4e524c2efac1b6" args="(bool restrainedInside)=0" -->
614<div class="memitem">
615<div class="memproto">
616 <table class="memname">
617 <tr>
618 <td class="memname">virtual void irr::gui::IGUIStaticText::setTextRestrainedInside </td>
619 <td>(</td>
620 <td class="paramtype">bool&#160;</td>
621 <td class="paramname"><em>restrainedInside</em></td><td>)</td>
622 <td><code> [pure virtual]</code></td>
623 </tr>
624 </table>
625</div>
626<div class="memdoc">
627
628<p>Set whether the text in this label should be clipped if it goes outside bounds. </p>
629
630</div>
631</div>
632<a class="anchor" id="a2a47bc2f85ced3efc1d007c5bd61f906"></a><!-- doxytag: member="irr::gui::IGUIStaticText::setWordWrap" ref="a2a47bc2f85ced3efc1d007c5bd61f906" args="(bool enable)=0" -->
633<div class="memitem">
634<div class="memproto">
635 <table class="memname">
636 <tr>
637 <td class="memname">virtual void irr::gui::IGUIStaticText::setWordWrap </td>
638 <td>(</td>
639 <td class="paramtype">bool&#160;</td>
640 <td class="paramname"><em>enable</em></td><td>)</td>
641 <td><code> [pure virtual]</code></td>
642 </tr>
643 </table>
644</div>
645<div class="memdoc">
646
647<p>Enables or disables word wrap for using the static text as multiline text control. </p>
648<dl><dt><b>Parameters:</b></dt><dd>
649 <table class="params">
650 <tr><td class="paramname">enable,:</td><td>If set to true, words going over one line are broken on to the next line. </td></tr>
651 </table>
652 </dd>
653</dl>
654
655</div>
656</div>
657<hr/>The documentation for this class was generated from the following file:<ul>
658<li><a class="el" href="_i_g_u_i_static_text_8h_source.html">IGUIStaticText.h</a></li>
659</ul>
660</div>
661</div>
662 <div id="nav-path" class="navpath">
663 <ul>
664 <li class="navelem"><a class="el" href="namespaceirr.html">irr</a> </li>
665 <li class="navelem"><a class="el" href="namespaceirr_1_1gui.html">gui</a> </li>
666 <li class="navelem"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_static_text.html">IGUIStaticText</a> </li>
667<!-- window showing the filter options -->
668<div id="MSearchSelectWindow"
669 onmouseover="return searchBox.OnSearchSelectShow()"
670 onmouseout="return searchBox.OnSearchSelectHide()"
671 onkeydown="return searchBox.OnSearchSelectKey(event)">
672<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>
673
674<!-- iframe showing the search results (closed by default) -->
675<div id="MSearchResultsWindow">
676<iframe src="javascript:void(0)" frameborder="0"
677 name="MSearchResults" id="MSearchResults">
678</iframe>
679</div>
680
681
682 <li class="footer">
683<a href="http://irrlicht.sourceforge.net" target="_blank">Irrlicht
684Engine</a> Documentation &copy; 2003-2012 by Nikolaus Gebhardt. Generated on Sun Nov 17 2013 20:18:44 for Irrlicht 3D Engine by
685<a href="http://www.doxygen.org/index.html" target="_blank">Doxygen</a> 1.7.5.1 </li>
686 </ul>
687 </div>
688
689
690</body>
691</html>
generated by cgit v1.1 at 2024-06-27 09:33:17 +0000