@library{wxcore}
@category{ctrl}
- <!-- @appearance{statictext.png} -->
+ @appearance{statictext.png}
@see wxStaticBitmap, wxStaticBox
*/
Default constructor.
*/
wxStaticText();
-
+
/**
Constructor, creating and showing a text control.
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0,
- const wxString& name = "staticText");
+ const wxString& name = wxStaticTextNameStr);
/**
Creation function, for two-step construction. For details see wxStaticText().
*/
- bool Create(wxWindow* parent, wxWindowID id,
- const wxString& label,
+ bool Create(wxWindow* parent, wxWindowID id, const wxString& label,
const wxPoint& pos = wxDefaultPosition,
- const wxSize& size = wxDefaultSize,
- long style = 0,
- const wxString& name = "staticText");
+ const wxSize& size = wxDefaultSize, long style = 0,
+ const wxString& name = wxStaticTextNameStr);
/**
Returns the contents of the control.
- Note that the returned string contains both the mnemonics (@c characters),
+
+ Note that the returned string contains both the mnemonics (@& characters),
if any, and markup tags, if any.
- Use GetLabelText() if only the
- label text is needed.
+ Use GetLabelText() if only the label text is needed.
*/
wxString GetLabel() const;
- //@{
/**
- The first form returns the control's label without the mnemonics characters (if
- any)
- and without the markup (if the control has @c wxST_MARKUP style).
- The second (static) version returns the given @a label string without the
- mnemonics
- characters (if any) and without the markup.
+ This method returns the control's label without the mnemonics characters
+ (if any) and without the markup (if the control has @c wxST_MARKUP style).
+ */
+ wxString GetLabelText() const;
+
+ /**
+ This overload returns the given @a label string without the
+ mnemonics characters (if any) and without the markup.
*/
- wxString GetLabelText();
- const static wxString GetLabelText(const wxString& label);
- //@}
+ static wxString GetLabelText(const wxString& label);
/**
Sets the static text label and updates the controls size to exactly fit the
label unless the control has wxST_NO_AUTORESIZE flag.
+
This function allows to set decorated static label text on platforms which
support it (currently only GTK+ 2). For the other platforms, the markup is
ignored.
- The supported tags are:
-
- b
-
- bold text
-
- big
-
- bigger text
-
- i
-
- italic text
-
- s
-
- strike-through text
-
- sub
-
- subscript text
-
- sup
-
- superscript text
-
- small
- smaller text
-
- tt
-
- monospaced text
-
- u
-
- underlined text
-
- span
-
- generic formatter tag; see Pango Markup for more information.
+ The supported tags are:
+ <TABLE>
+ <TR>
+ <TD><b></TD>
+ <TD>bold text</TD>
+ </TR>
+ <TR>
+ <TD><big></TD>
+ <TD>bigger text</TD>
+ </TR>
+ <TR>
+ <TD><i></TD>
+ <TD>italic text</TD>
+ </TR>
+ <TR>
+ <TD><s></TD>
+ <TD>strike-through text</TD>
+ </TR>
+ <TR>
+ <TD><sub></TD>
+ <TD>subscript text</TD>
+ </TR>
+ <TR>
+ <TD><sup></TD>
+ <TD>superscript text</TD>
+ </TR>
+ <TR>
+ <TD><small></TD>
+ <TD>smaller text</TD>
+ </TR>
+ <TR>
+ <TD><tt></TD>
+ <TD>monospaced text</TD>
+ </TR>
+ <TR>
+ <TD><u></TD>
+ <TD>underlined text</TD>
+ </TR>
+ <TR>
+ <TD><span></TD>
+ <TD>generic formatter tag; see Pango Markup
+ (http://library.gnome.org/devel/pango/unstable/PangoMarkupFormat.html)
+ for more information.</TD>
+ </TR>
+ </TABLE>
Note that the string must be well-formed (e.g. all tags must be correctly
- closed)
- otherwise it can be not shown correctly or at all.
+ closed) otherwise it can be not shown correctly or at all.
Also note that you need to escape the following special characters:
- @b Special character
-
- @b Escape as
-
- @c
-
- @c amp; or as @c
-
- @c '
-
- @c apos;
-
- @c "
-
- @c quot;
-
- @c
-
- @c lt;
-
- @c
-
- @c gt;
-
- The non-escaped ampersand @c characters are interpreted as
+ <TABLE>
+ <TR>
+ <TD>@b Special character</TD>
+ <TD>@b Escape as</TD>
+ </TR>
+ <TR>
+ <TD>@c &</TD>
+ <TD>@c &amp; or as &&</TD>
+ </TR>
+ <TR>
+ <TD>@c '</TD>
+ <TD>@c &apos;</TD>
+ </TR>
+ <TR>
+ <TD>@c "</TD>
+ <TD>@c &quot;</TD>
+ </TR>
+ <TR>
+ <TD>@c <</TD>
+ <TD>@c &lt;</TD>
+ </TR>
+ <TR>
+ <TD>@c ></TD>
+ <TD>@c &gt;</TD>
+ </TR>
+ </TABLE>
+
+ The non-escaped ampersand @c & characters are interpreted as
mnemonics; see wxControl::SetLabel.
Example:
@param label
- The new label to set. It may contain newline characters and the markup tags
- described above.
+ The new label to set.
+ It may contain newline characters and the markup tags described above.
*/
virtual void SetLabel(const wxString& label);
/**
This functions wraps the controls label so that each of its lines becomes at
most @a width pixels wide if possible (the lines are broken at words
- boundaries so it might not be the case if words are too long). If @e width
- is negative, no wrapping is done. Note that this width is not
+ boundaries so it might not be the case if words are too long).
+
+ If @a width 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.
projects / wxWidgets.git / blobdiff