X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/12f5e1e78fe906050ff2fee9529476db332633f0..6362d82b3ed82aa6795e4ad03160820f94c9e4d4:/interface/wx/stattext.h diff --git a/interface/wx/stattext.h b/interface/wx/stattext.h index 88c8d955ad..21d1affe1b 100644 --- a/interface/wx/stattext.h +++ b/interface/wx/stattext.h @@ -39,7 +39,7 @@ @library{wxcore} @category{ctrl} - + @appearance{statictext.png} @see wxStaticBitmap, wxStaticBox */ @@ -50,7 +50,7 @@ public: Default constructor. */ wxStaticText(); - + /** Constructor, creating and showing a text control. @@ -76,133 +76,139 @@ public: 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: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
<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 + (http://library.gnome.org/devel/pango/unstable/PangoMarkupFormat.html) + for more information.
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 + + + + + + + + + + + + + + + + + + + + + + + + + +
@b Special character@b Escape as
@c &@c &amp; or as &&
@c '@c &apos;
@c "@c &quot;
@c <@c &lt;
@c >@c &gt;
+ + 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.