X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/11e3af6e7eed3c4717608ba2095a688b1fea60e0..7344108e8a129a3f9b4df5ab0f98a1713db03b89:/interface/wx/stattext.h
diff --git a/interface/wx/stattext.h b/interface/wx/stattext.h
index 21d1affe1b..08fddf0b15 100644
--- a/interface/wx/stattext.h
+++ b/interface/wx/stattext.h
@@ -3,38 +3,46 @@
// Purpose: interface of wxStaticText
// Author: wxWidgets team
// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
+#define wxST_NO_AUTORESIZE 0x0001
+#define wxST_ELLIPSIZE_START 0x0004
+#define wxST_ELLIPSIZE_MIDDLE 0x0008
+#define wxST_ELLIPSIZE_END 0x0010
+
/**
@class wxStaticText
A static text control displays one or more lines of read-only text.
+ wxStaticText 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 wxControl::SetLabelMarkup().
@beginStyleTable
@style{wxALIGN_LEFT}
- Align the text to the left
+ Align the text to the left.
@style{wxALIGN_RIGHT}
- Align the text to the right
+ Align the text to the right.
@style{wxALIGN_CENTRE}
- Center the text (horizontally)
+ Center the text (horizontally).
@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
+ 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)
+ especially useful with controls which also have the @c wxALIGN_RIGHT or
+ the @c wxALIGN_CENTRE style because otherwise they won't make sense any
+ longer after a call to SetLabel()).
@style{wxST_ELLIPSIZE_START}
- If the text width exceeds the control width, replace the beginning
- of the text with an ellipsis
+ If the labeltext width exceeds the control width, replace the beginning
+ of the label with an ellipsis; uses wxControl::Ellipsize.
@style{wxST_ELLIPSIZE_MIDDLE}
- Same as above, but replace the text in the middle of the control
- with an ellipsis
+ If the label text width exceeds the control width, replace the middle
+ of the label with an ellipsis; uses wxControl::Ellipsize.
@style{wxST_ELLIPSIZE_END}
- Same as above, but replace the end of the text with an ellipsis
- @style{wxST_MARKUP}
- Support markup in the label; see SetLabel for more information
+ If the label text width exceeds the control width, replace the end
+ of the label with an ellipsis; uses wxControl::Ellipsize.
@endStyleTable
@library{wxcore}
@@ -87,121 +95,10 @@ public:
const wxString& name = wxStaticTextNameStr);
/**
- Returns the contents of the control.
-
- 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.
- */
- wxString GetLabel() const;
-
- /**
- 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.
- */
- 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
- (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.
- Also note that you need to escape the following special characters:
-
-
-
- @b Special character |
- @b Escape as |
-
-
- @c & |
- @c & or as && |
-
-
- @c ' |
- @c ' |
-
-
- @c " |
- @c " |
-
-
- @c < |
- @c < |
-
-
- @c > |
- @c > |
-
-
-
- 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.
+ Returns @true if the window styles for this control contains one of the
+ @c wxST_ELLIPSIZE_START, @c wxST_ELLIPSIZE_MIDDLE or @c wxST_ELLIPSIZE_END styles.
*/
- virtual void SetLabel(const wxString& label);
+ bool IsEllipsized() const;
/**
This functions wraps the controls label so that each of its lines becomes at