1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Wt: Wt::WTextArea Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceWt.html">Wt</a>::<a class="el" href="classWt_1_1WTextArea.html">WTextArea</a>
</div>
</div>
<div class="contents">
<h1>Wt::WTextArea Class Reference</h1><!-- doxytag: class="Wt::WTextArea" --><!-- doxytag: inherits="Wt::WFormWidget" -->A widget that provides a multi-line edit.
<a href="#_details">More...</a>
<p>
<code>#include <Wt/WTextArea></code>
<p>
<div class="dynheader">
Inheritance diagram for Wt::WTextArea:</div>
<div class="dynsection">
<p><center><img src="classWt_1_1WTextArea__inherit__graph.png" border="0" usemap="#Wt_1_1WTextArea__inherit__map" alt="Inheritance graph"></center>
<map name="Wt_1_1WTextArea__inherit__map">
<area shape="rect" href="classWt_1_1WTextEdit.html" title="A rich-text XHTML editor." alt="" coords="24,453,128,480"><area shape="rect" href="classWt_1_1WFormWidget.html" title="An abstract widget that corresponds to an HTML form element." alt="" coords="12,304,140,331"><area shape="rect" href="classWt_1_1WInteractWidget.html" title="An abstract widget that can receive user-interface interaction." alt="" coords="5,229,147,256"><area shape="rect" href="classWt_1_1WWebWidget.html" title="A base class for widgets with an HTML counterpart." alt="" coords="15,155,137,181"><area shape="rect" href="classWt_1_1WWidget.html" title="The abstract base class for a user-interface component." alt="" coords="28,80,124,107"><area shape="rect" href="classWt_1_1WObject.html" title="A base class for objects that participate in the signal/slot system." alt="" coords="28,5,124,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classWt_1_1WTextArea-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d083421ca4fe15da882440d506cab05b"></a><!-- doxytag: member="Wt::WTextArea::WTextArea" ref="d083421ca4fe15da882440d506cab05b" args="(WContainerWidget *parent=0)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTextArea.html#d083421ca4fe15da882440d506cab05b">WTextArea</a> (<a class="el" href="classWt_1_1WContainerWidget.html">WContainerWidget</a> *parent=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a text area with empty content and optional parent. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8c2aa87526952d2645cec139f4ad26bb"></a><!-- doxytag: member="Wt::WTextArea::WTextArea" ref="8c2aa87526952d2645cec139f4ad26bb" args="(const WString &content, WContainerWidget *parent=0)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTextArea.html#8c2aa87526952d2645cec139f4ad26bb">WTextArea</a> (const <a class="el" href="classWt_1_1WString.html">WString</a> &content, <a class="el" href="classWt_1_1WContainerWidget.html">WContainerWidget</a> *parent=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a text area with given content and optional parent. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTextArea.html#f429ed3a2b6011c97b4f9ea7f910e079">setColumns</a> (int cols)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the number of columns. <a href="#f429ed3a2b6011c97b4f9ea7f910e079"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTextArea.html#de46b47350f427f45c9b53ac7e41c5b2">setRows</a> (int rows)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the number of rows. <a href="#de46b47350f427f45c9b53ac7e41c5b2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTextArea.html#fa438b99f8ebf858e3202c262b29a3ae">columns</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of columns. <a href="#fa438b99f8ebf858e3202c262b29a3ae"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTextArea.html#be1a4daf466365557cfd3fbbe8bc9dd7">rows</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of rows. <a href="#be1a4daf466365557cfd3fbbe8bc9dd7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d8b89ce30df2b02894c53b6ed71fe4a6"></a><!-- doxytag: member="Wt::WTextArea::text" ref="d8b89ce30df2b02894c53b6ed71fe4a6" args="() const " -->
const <a class="el" href="classWt_1_1WString.html">WString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTextArea.html#d8b89ce30df2b02894c53b6ed71fe4a6">text</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the current content. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTextArea.html#1f05060c037d13c2c6c26f51f1fb9640">setText</a> (const <a class="el" href="classWt_1_1WString.html">WString</a> &text)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the content of the text area. <a href="#1f05060c037d13c2c6c26f51f1fb9640"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="480530c1847f32f8b94101881484287b"></a><!-- doxytag: member="Wt::WTextArea::validate" ref="480530c1847f32f8b94101881484287b" args="()" -->
<a class="el" href="classWt_1_1WValidator.html#638a1feefca259ea2f806a8add2d18a3">WValidator::State</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTextArea.html#480530c1847f32f8b94101881484287b">validate</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Validates the field. <br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTextArea.html#83a327ce1d6408a99991cd6b5ddc74e4">boxPadding</a> (<a class="el" href="namespaceWt.html#2a8d45559e16a0185bf61bfad0a67912">Orientation</a> orientation) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the widget's built-in padding. <a href="#83a327ce1d6408a99991cd6b5ddc74e4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTextArea.html#3379006d7dbe832b617303b72924019c">boxBorder</a> (<a class="el" href="namespaceWt.html#2a8d45559e16a0185bf61bfad0a67912">Orientation</a> orientation) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the widget's built-in border width. <a href="#3379006d7dbe832b617303b72924019c"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A widget that provides a multi-line edit.
<p>
To act upon text changes, connect a slot to the <a class="el" href="classWt_1_1WFormWidget.html#5216ba1594b5dc525cc47cad593c7ba8" title="Signal emitted when the value was changed.">changed()</a> signal. This signal is emitted when the user changed the content, and subsequently removes the focus from the line edit.<p>
To act upon editing, connect a slot to the <a class="el" href="classWt_1_1WInteractWidget.html#7602bfbe38090d4acca674afc02f15c8" title="Event signal emitted when a keyboard key is released.">keyWentUp()</a> signal.<p>
At all times, the current content may be accessed with the <a class="el" href="classWt_1_1WTextArea.html#d8b89ce30df2b02894c53b6ed71fe4a6" title="Returns the current content.">text()</a> method.<p>
Usage example: <div class="fragment"><pre class="fragment"> <a class="code" href="classWt_1_1WContainerWidget.html" title="A widget that holds and manages child widgets.">Wt::WContainerWidget</a> *w = <span class="keyword">new</span> <a class="code" href="classWt_1_1WContainerWidget.html" title="A widget that holds and manages child widgets.">Wt::WContainerWidget</a>();
<a class="code" href="classWt_1_1WLabel.html" title="A label for a form field.">Wt::WLabel</a> *label = <span class="keyword">new</span> <a class="code" href="classWt_1_1WLabel.html" title="A label for a form field.">Wt::WLabel</a>(<span class="stringliteral">"Comments:"</span>, w);
<a class="code" href="classWt_1_1WTextArea.html" title="A widget that provides a multi-line edit.">Wt::WTextArea</a> *edit = <span class="keyword">new</span> <a class="code" href="classWt_1_1WTextArea.html" title="A widget that provides a multi-line edit.">Wt::WTextArea</a>(<span class="stringliteral">""</span>, w);
label-><a class="code" href="classWt_1_1WLabel.html#f468c613eab7d184c68fd6ae20978de5" title="Sets the buddy of this label.">setBuddy</a>(edit);
</pre></div><p>
WTextArea is an <a class="el" href="classWt_1_1WWidget.html#c78e3af143883334c82031790c87416e">inline </a> widget.<p>
<h3>CSS</h3>
<p>
The widget corresponds to an HTML <code><textarea></code> tag can be styled using inline or external CSS as appropriate. The emptyText style can be configured via .Wt-edit-emptyText.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WLineEdit.html" title="A widget that provides a single line edit.">WLineEdit</a> </dd></dl>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="f429ed3a2b6011c97b4f9ea7f910e079"></a><!-- doxytag: member="Wt::WTextArea::setColumns" ref="f429ed3a2b6011c97b4f9ea7f910e079" args="(int cols)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WTextArea::setColumns </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>cols</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the number of columns.
<p>
The default value is 20.
</div>
</div><p>
<a class="anchor" name="de46b47350f427f45c9b53ac7e41c5b2"></a><!-- doxytag: member="Wt::WTextArea::setRows" ref="de46b47350f427f45c9b53ac7e41c5b2" args="(int rows)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WTextArea::setRows </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>rows</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the number of rows.
<p>
The default value is 5.
</div>
</div><p>
<a class="anchor" name="fa438b99f8ebf858e3202c262b29a3ae"></a><!-- doxytag: member="Wt::WTextArea::columns" ref="fa438b99f8ebf858e3202c262b29a3ae" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Wt::WTextArea::columns </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the number of columns.
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WTextArea.html#f429ed3a2b6011c97b4f9ea7f910e079" title="Sets the number of columns.">setColumns()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="be1a4daf466365557cfd3fbbe8bc9dd7"></a><!-- doxytag: member="Wt::WTextArea::rows" ref="be1a4daf466365557cfd3fbbe8bc9dd7" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Wt::WTextArea::rows </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the number of rows.
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WTextArea.html#de46b47350f427f45c9b53ac7e41c5b2" title="Sets the number of rows.">setRows()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="1f05060c037d13c2c6c26f51f1fb9640"></a><!-- doxytag: member="Wt::WTextArea::setText" ref="1f05060c037d13c2c6c26f51f1fb9640" args="(const WString &text)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WTextArea::setText </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1WString.html">WString</a> & </td>
<td class="paramname"> <em>text</em> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the content of the text area.
<p>
The default text is "".
<p>Reimplemented in <a class="el" href="classWt_1_1WTextEdit.html#8023b2dbe675a22f30a563704d9ae475">Wt::WTextEdit</a>.</p>
</div>
</div><p>
<a class="anchor" name="83a327ce1d6408a99991cd6b5ddc74e4"></a><!-- doxytag: member="Wt::WTextArea::boxPadding" ref="83a327ce1d6408a99991cd6b5ddc74e4" args="(Orientation orientation) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Wt::WTextArea::boxPadding </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceWt.html#2a8d45559e16a0185bf61bfad0a67912">Orientation</a> </td>
<td class="paramname"> <em>orientation</em> </td>
<td> ) </td>
<td> const<code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the widget's built-in padding.
<p>
This is used by the layout managers to correct for a built-in padding which interferes with setting a widget's width (or height) to 100%.<p>
A layout manager needs to set the width to 100% only for form widgets (<a class="el" href="classWt_1_1WTextArea.html" title="A widget that provides a multi-line edit.">WTextArea</a>, <a class="el" href="classWt_1_1WLineEdit.html" title="A widget that provides a single line edit.">WLineEdit</a>, <a class="el" href="classWt_1_1WComboBox.html" title="A widget that provides a drop-down combo-box control.">WComboBox</a>, etc...). Therefore, only for those widgets this needs to return the padding (the default implementation returns 0).<p>
For form widgets, the padding depends on the specific browser/platform combination, unless an explicit padding is set for the widget.<p>
When setting an explicit padding for the widget using a style class, you will want to reimplement this method to return this padding in case you want to set the widget inside a layout manager.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WTextArea.html#3379006d7dbe832b617303b72924019c" title="Returns the widget's built-in border width.">boxBorder()</a> </dd></dl>
<p>Reimplemented from <a class="el" href="classWt_1_1WWidget.html#b4cfd6bd5bea1a6182731ec79a78792c">Wt::WWidget</a>.</p>
<p>Reimplemented in <a class="el" href="classWt_1_1WTextEdit.html#b268ab5bfd2edda2bf64dad5cd068abe">Wt::WTextEdit</a>.</p>
</div>
</div><p>
<a class="anchor" name="3379006d7dbe832b617303b72924019c"></a><!-- doxytag: member="Wt::WTextArea::boxBorder" ref="3379006d7dbe832b617303b72924019c" args="(Orientation orientation) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Wt::WTextArea::boxBorder </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceWt.html#2a8d45559e16a0185bf61bfad0a67912">Orientation</a> </td>
<td class="paramname"> <em>orientation</em> </td>
<td> ) </td>
<td> const<code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the widget's built-in border width.
<p>
This is used by the layout managers to correct for a built-in border which interferes with setting a widget's width (or height) to 100%.<p>
A layout manager needs to set the width to 100% only for form widgets (<a class="el" href="classWt_1_1WTextArea.html" title="A widget that provides a multi-line edit.">WTextArea</a>, <a class="el" href="classWt_1_1WLineEdit.html" title="A widget that provides a single line edit.">WLineEdit</a>, <a class="el" href="classWt_1_1WComboBox.html" title="A widget that provides a drop-down combo-box control.">WComboBox</a>, etc...). Therefore, only for those widgets this needs to return the border width (the default implementation returns 0).<p>
For form widgets, the border width depends on the specific browser/platform combination, unless an explicit border is set for the widget.<p>
When setting an explicit border for the widget using a style class, you will want to reimplement this method to return this border width, in case you want to set the widget inside a layout manager.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WTextArea.html#83a327ce1d6408a99991cd6b5ddc74e4" title="Returns the widget's built-in padding.">boxPadding()</a> </dd></dl>
<p>Reimplemented from <a class="el" href="classWt_1_1WWidget.html#6bd6a9d01afbc4f96c4ec7dd48db9126">Wt::WWidget</a>.</p>
<p>Reimplemented in <a class="el" href="classWt_1_1WTextEdit.html#c946e268b85e49d1155c656f354f00cb">Wt::WTextEdit</a>.</p>
</div>
</div><p>
</div>
<hr size="1"><address style="align: right;"><small>
Generated on Fri Mar 26 17:12:07 2010 for <a href="http://www.webtoolkit.eu/wt/">Wt</a> by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6</small></address>
</body>
</html>
|
