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
|
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE erlref SYSTEM "erlref.dtd">
<!-- THIS FILE IS GENERATED DO NOT EDIT -->
<erlref>
<header>
<copyright>
<year>2020</year>
<holder>Ericsson AB. All Rights Reserved.</holder></copyright>
<legalnotice>
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
</legalnotice>
<title>wxStaticText</title>
</header>
<module>wxStaticText</module>
<modulesummary>Functions for wxStaticText class</modulesummary>
<description><p>A static text control displays one or more lines of read-only text. <seeerl marker="wxStaticText"><c>wxStaticText</c></seeerl> supports the three classic text alignments, label ellipsization i.e. replacing parts of the text with the ellipsis ("...") if the label doesn't fit into the provided space and also formatting markup with <c>wxControl::SetLabelMarkup()</c> (not implemented in wx).
</p><p>Styles</p><p>This class supports the following styles:
</p><p>See: <seeerl marker="wxStaticBitmap"><c>wxStaticBitmap</c></seeerl>, <seeerl marker="wxStaticBox"><c>wxStaticBox</c></seeerl>
</p>
<p>This class is derived (and can use functions) from:
<seeerl marker="wxControl"><c>wxControl</c></seeerl> <seeerl marker="wxWindow"><c>wxWindow</c></seeerl> <seeerl marker="wxEvtHandler"><c>wxEvtHandler</c></seeerl></p>
<p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_static_text.html">wxStaticText</url></p>
</description>
<datatypes><datatype><name name="wxStaticText"/></datatype></datatypes>
<funcs>
<func>
<name name="new" arity="0" clause_i="1" since=""/>
<fsummary>Default constructor. </fsummary>
<desc><p>Default constructor.
</p></desc>
</func>
<func>
<name name="new" arity="3" clause_i="1" since=""/>
<fsummary>See: <c>new/4</c></fsummary>
</func>
<func>
<name name="new" arity="4" clause_i="1" since=""/>
<fsummary>Constructor, creating and showing a text control. </fsummary>
<desc><p>Constructor, creating and showing a text control.
</p><p>See: <seemfa marker="#create/5"><c>create/5</c></seemfa>
</p></desc>
</func>
<func>
<name name="create" arity="4" clause_i="1" since=""/>
<fsummary>See: <c>create/5</c></fsummary>
</func>
<func>
<name name="create" arity="5" clause_i="1" since=""/>
<fsummary>Creation function, for two-step construction. </fsummary>
<desc><p>Creation function, for two-step construction.
</p><p>For details see <seemfa marker="#new/4"><c>new/4</c></seemfa>.
</p></desc>
</func>
<func>
<name name="getLabel" arity="1" clause_i="1" since=""/>
<fsummary>Returns the control's label, as it was passed to <c>wxControl:setLabel/2</c>. </fsummary>
<desc><p>Returns the control's label, as it was passed to <seemfa marker="wxControl#setLabel/2"><c>wxControl:setLabel/2</c></seemfa>.
</p><p>Note that the returned string may contains mnemonics ("&" characters) if they were passed to the <seemfa marker="wxControl#setLabel/2"><c>wxControl:setLabel/2</c></seemfa> function; use <c>GetLabelText()</c> (not implemented in wx) if they are undesired.
</p><p>Also note that the returned string is always the string which was passed to <seemfa marker="wxControl#setLabel/2"><c>wxControl:setLabel/2</c></seemfa> but may be different from the string passed to <c>SetLabelText()</c> (not implemented in wx) (since this last one escapes mnemonic characters).
</p></desc>
</func>
<func>
<name name="setLabel" arity="2" clause_i="1" since=""/>
<fsummary>Change the label shown in the control. </fsummary>
<desc><p>Change the label shown in the control.
</p><p>Notice that since wxWidgets 3.1.1 this function is guaranteed not to do anything if the label didn't really change, so there is no benefit to checking if the new label is different from the current one in the application code.
</p><p>See: <seemfa marker="wxControl#setLabel/2"><c>wxControl:setLabel/2</c></seemfa>
</p></desc>
</func>
<func>
<name name="wrap" arity="2" clause_i="1" since=""/>
<fsummary>This functions wraps the controls label so that each of its lines becomes at most <c>width</c> pixels wide if possible (the lines are broken at words boundaries so it might not be the case if words are too long). </fsummary>
<desc><p>This functions wraps the controls label so that each of its lines becomes at most <c>width</c> pixels wide if possible (the lines are broken at words boundaries so it might not be the case if words are too long).
</p><p>If <c>width</c> is negative, no wrapping is done. Note that this width is not necessarily the total width of the control, since a few pixels for the border (depending on the controls border style) may be added.
</p><p>Since: 2.6.2
</p></desc>
</func>
<func>
<name name="destroy" arity="1" clause_i="1" since=""/>
<fsummary>Destructor</fsummary>
<desc><p>Destroys the object.</p></desc>
</func>
</funcs>
</erlref>
|
