X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4cc4bfafe5a31cb96f35b3ec9b19fa2b0b3a4eef..7c0d297a1f761de31d3a4ac924fa2080b5bbaf41:/interface/stattext.h diff --git a/interface/stattext.h b/interface/stattext.h index 7c2da1dc22..dda0b92030 100644 --- a/interface/stattext.h +++ b/interface/stattext.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: stattext.h -// Purpose: documentation for wxStaticText class +// Purpose: interface of wxStaticText // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -13,28 +13,28 @@ A static text control displays one or more lines of read-only text. @beginStyleTable - @style{wxALIGN_LEFT}: + @style{wxALIGN_LEFT} Align the text to the left - @style{wxALIGN_RIGHT}: + @style{wxALIGN_RIGHT} Align the text to the right - @style{wxALIGN_CENTRE}: + @style{wxALIGN_CENTRE} Center the text (horizontally) - @style{wxST_NO_AUTORESIZE}: + @style{wxST_NO_AUTORESIZE} By default, the control will adjust its size to exactly fit to the size of the text when SetLabel is called. If this style flag is given, the control will not change its size (this style is especially useful with controls which also have wxALIGN_RIGHT or CENTER style because otherwise they won't make sense any longer after a call to SetLabel) - @style{wxST_ELLIPSIZE_START}: + @style{wxST_ELLIPSIZE_START} If the text width exceeds the control width, replace the beginning of the text with an ellipsis - @style{wxST_ELLIPSIZE_MIDDLE}: + @style{wxST_ELLIPSIZE_MIDDLE} Same as above, but replace the text in the middle of the control with an ellipsis - @style{wxST_ELLIPSIZE_END}: + @style{wxST_ELLIPSIZE_END} Same as above, but replace the end of the text with an ellipsis - @style{wxST_MARKUP}: + @style{wxST_MARKUP} Support markup in the label; see SetLabel for more information @endStyleTable @@ -42,8 +42,7 @@ @category{ctrl} @appearance{statictext.png} - @seealso - wxStaticBitmap, wxStaticBox + @see wxStaticBitmap, wxStaticBox */ class wxStaticText : public wxControl { @@ -51,7 +50,7 @@ public: //@{ /** Constructor, creating and showing a text control. - + @param parent Parent window. Should not be @NULL. @param id @@ -66,7 +65,7 @@ public: Window style. See wxStaticText. @param name Window name. - + @see Create() */ wxStaticText(); @@ -95,7 +94,7 @@ public: Use GetLabelText() if only the label text is needed. */ - wxString GetLabel(); + wxString GetLabel() const; //@{ /** @@ -107,7 +106,7 @@ public: characters (if any) and without the markup. */ wxString GetLabelText(); - static wxString GetLabelText(const wxString& label); + const static wxString GetLabelText(const wxString& label); //@} /** @@ -117,81 +116,81 @@ public: 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. - + 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. 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 mnemonics; see wxControl::SetLabel. - + Example: - + @param label The new label to set. It may contain newline characters and the markup tags described above. @@ -203,7 +202,9 @@ public: 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. - This function is new since wxWidgets version 2.6.2 + + @wxsince{2.6.2} */ void Wrap(int width); }; +