X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/1d065710d3cf39e519f05fd02760006b9a929c38..7bd30a12ade503fd135c686ecc98a6f6d5fecbeb:/include/wx/control.h?ds=sidebyside diff --git a/include/wx/control.h b/include/wx/control.h index 696cf8124b..b597937ef2 100644 --- a/include/wx/control.h +++ b/include/wx/control.h @@ -94,6 +94,29 @@ public: // get just the text of the label, without mnemonic characters ('&') virtual wxString GetLabelText() const { return GetLabelText(GetLabel()); } + +#if wxUSE_MARKUP + // Set the label with markup (and mnemonics). Markup is a simple subset of + // HTML with tags such as , and . By default it is not + // supported i.e. all the markup is simply stripped and SetLabel() is + // called but some controls in some ports do support this already and in + // the future most of them should. + // + // Notice that, being HTML-like, markup also supports XML entities so '<' + // should be encoded as "<" and so on, a bare '<' in the input will + // likely result in an error. As an exception, a bare '&' is allowed and + // indicates that the next character is a mnemonic. To insert a literal '&' + // in the control you need to use "&" in the input string. + // + // Returns true if the label was set, even if the markup in it was ignored. + // False is only returned if we failed to parse the label. + bool SetLabelMarkup(const wxString& markup) + { + return DoSetLabelMarkup(markup); + } +#endif // wxUSE_MARKUP + + // controls by default inherit the colours of their parents, if a // particular control class doesn't want to do it, it can override // ShouldInheritColours() to return false @@ -162,6 +185,14 @@ protected: const wxValidator& validator, const wxString& name); +#if wxUSE_MARKUP + // This function may be overridden in the derived classes to implement + // support for labels with markup. The base class version simply strips the + // markup and calls SetLabel() with the remaining text. + virtual bool DoSetLabelMarkup(const wxString& markup); +#endif // wxUSE_MARKUP + + // initialize the common fields of wxCommandEvent void InitCommandEvent(wxCommandEvent& event) const; @@ -170,6 +201,13 @@ protected: wxEllipsizeMode mode, int maxWidth, int replacementWidth); +#if wxUSE_MARKUP + // Remove markup from the given string, returns empty string on error i.e. + // if markup was syntactically invalid. + static wxString RemoveMarkup(const wxString& markup); +#endif // wxUSE_MARKUP + + // this field contains the label in wx format, i.e. with '&' mnemonics, // as it was passed to the last SetLabel() call wxString m_labelOrig;