X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/bce49490f66910767d8a3dd7ea5ebafc5f40005b..9c805dec6caf3c98a3797898cffe795b5b56e606:/include/wx/stattext.h diff --git a/include/wx/stattext.h b/include/wx/stattext.h index 1aef30c9a4..a7124c440d 100644 --- a/include/wx/stattext.h +++ b/include/wx/stattext.h @@ -1,5 +1,5 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: stattext.h +// Name: wx/stattext.h // Purpose: wxStaticText base header // Author: Julian Smart // Modified by: @@ -22,13 +22,11 @@ * wxStaticText flags */ #define wxST_NO_AUTORESIZE 0x0001 -#define wxST_MARKUP 0x0002 - +// free 0x0002 bit #define wxST_ELLIPSIZE_START 0x0004 #define wxST_ELLIPSIZE_MIDDLE 0x0008 #define wxST_ELLIPSIZE_END 0x0010 - extern WXDLLIMPEXP_DATA_CORE(const char) wxStaticTextNameStr[]; class WXDLLIMPEXP_CORE wxStaticTextBase : public wxControl @@ -41,7 +39,7 @@ public: // This function will modify the value returned by GetLabel()! void Wrap(int width); - // overriden base virtuals + // overridden base virtuals virtual bool AcceptsFocus() const { return false; } virtual bool HasTransparentBackground() { return true; } @@ -52,33 +50,17 @@ public: HasFlag(wxST_ELLIPSIZE_END); } - // get the string without mnemonic characters ('&') and without markup - // (if wxST_MARKUP is being used) - virtual wxString GetLabelText() const; - - // public utilities (symmetric to those in wxControl about mnemonics): - - // get the string without mnemonic characters ('&') and without markup - static wxString GetLabelText(const wxString& label); - - // removes the markup accepted by wxStaticText when wxST_MARKUP is used, - // and then returns the cleaned string - static wxString RemoveMarkup(const wxString& str); - - // escapes the alls special symbols (<>"'&) present inside the given string - // using the corresponding entities (< > " ' &) - static wxString EscapeMarkup(const wxString& str); - - protected: // functions required for wxST_ELLIPSIZE_* support // choose the default border for this window virtual wxBorder GetDefaultBorder() const { return wxBORDER_NONE; } - // just calls RemoveMarkup & Ellipsize on the original label. - virtual wxString GetEllipsizedLabelWithoutMarkup() const; + // Calls Ellipsize() on the real label if necessary. Unlike GetLabelText(), + // keeps the mnemonics instead of removing them. + virtual wxString GetEllipsizedLabel() const; - // replaces parts of the string with ellipsis if needed + // Replaces parts of the string with ellipsis according to the ellipsize + // style. Shouldn't be called if we don't have any. wxString Ellipsize(const wxString& label) const; // to be called when updating the size of the static text: @@ -87,17 +69,18 @@ protected: // functions required for wxST_ELLIPSIZE_* support // These functions are platform-specific and must be overridden in ports // which do not natively support ellipsization and they must be implemented - // in a way so that the m_label member of wxControl is not touched: + // in a way so that the m_labelOrig member of wxControl is not touched: // returns the real label currently displayed inside the control. virtual wxString DoGetLabel() const { return wxEmptyString; } // sets the real label currently displayed inside the control, - // _without_ invalidating the size. The text passed is always markup-free. + // _without_ invalidating the size. The text passed is always markup-free + // but may contain the mnemonic characters. virtual void DoSetLabel(const wxString& WXUNUSED(str)) { } private: - DECLARE_NO_COPY_CLASS(wxStaticTextBase) + wxDECLARE_NO_COPY_CLASS(wxStaticTextBase); }; // see wx/generic/stattextg.h for the explanation