]>
git.saurik.com Git - wxWidgets.git/blob - interface/stattext.h
1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: interface of wxStaticText
4 // Author: wxWidgets team
6 // Licence: wxWindows license
7 /////////////////////////////////////////////////////////////////////////////
13 A static text control displays one or more lines of read-only text.
17 Align the text to the left
19 Align the text to the right
20 @style{wxALIGN_CENTRE}
21 Center the text (horizontally)
22 @style{wxST_NO_AUTORESIZE}
23 By default, the control will adjust its size to exactly fit to the
24 size of the text when SetLabel is called. If this style flag is
25 given, the control will not change its size (this style is
26 especially useful with controls which also have wxALIGN_RIGHT or
27 CENTER style because otherwise they won't make sense any longer
28 after a call to SetLabel)
29 @style{wxST_ELLIPSIZE_START}
30 If the text width exceeds the control width, replace the beginning
31 of the text with an ellipsis
32 @style{wxST_ELLIPSIZE_MIDDLE}
33 Same as above, but replace the text in the middle of the control
35 @style{wxST_ELLIPSIZE_END}
36 Same as above, but replace the end of the text with an ellipsis
38 Support markup in the label; see SetLabel for more information
43 @appearance{statictext.png}
45 @see wxStaticBitmap, wxStaticBox
47 class wxStaticText
: public wxControl
52 Constructor, creating and showing a text control.
55 Parent window. Should not be @NULL.
57 Control identifier. A value of -1 denotes a default value.
65 Window style. See wxStaticText.
72 wxStaticText(wxWindow
* parent
, wxWindowID id
,
73 const wxString
& label
,
74 const wxPoint
& pos
= wxDefaultPosition
,
75 const wxSize
& size
= wxDefaultSize
,
77 const wxString
& name
= "staticText");
81 Creation function, for two-step construction. For details see wxStaticText().
83 bool Create(wxWindow
* parent
, wxWindowID id
,
84 const wxString
& label
,
85 const wxPoint
& pos
= wxDefaultPosition
,
86 const wxSize
& size
= wxDefaultSize
,
88 const wxString
& name
= "staticText");
91 Returns the contents of the control.
92 Note that the returned string contains both the mnemonics (@c characters),
93 if any, and markup tags, if any.
94 Use GetLabelText() if only the
97 wxString
GetLabel() const;
101 The first form returns the control's label without the mnemonics characters (if
103 and without the markup (if the control has @c wxST_MARKUP style).
104 The second (static) version returns the given @a label string without the
106 characters (if any) and without the markup.
108 wxString
GetLabelText();
109 const static wxString
GetLabelText(const wxString
& label
);
113 Sets the static text label and updates the controls size to exactly fit the
114 label unless the control has wxST_NO_AUTORESIZE flag.
115 This function allows to set decorated static label text on platforms which
116 support it (currently only GTK+ 2). For the other platforms, the markup is
118 The supported tags are:
158 generic formatter tag; see Pango Markup for more information.
160 Note that the string must be well-formed (e.g. all tags must be correctly
162 otherwise it can be not shown correctly or at all.
163 Also note that you need to escape the following special characters:
189 The non-escaped ampersand @c characters are interpreted as
190 mnemonics; see wxControl::SetLabel.
195 The new label to set. It may contain newline characters and the markup tags
198 virtual void SetLabel(const wxString
& label
);
201 This functions wraps the controls label so that each of its lines becomes at
202 most @a width pixels wide if possible (the lines are broken at words
203 boundaries so it might not be the case if words are too long). If @e width
204 is negative, no wrapping is done.
208 void Wrap(int width
);