X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/355ce7adea8043d72e02cd00aa7f475f3b3be92d..a4301b8f14d21b7d28fc4f6a247b740d945ca6dc:/include/wx/control.h?ds=sidebyside diff --git a/include/wx/control.h b/include/wx/control.h index f947f0f203..6bd5ed190b 100644 --- a/include/wx/control.h +++ b/include/wx/control.h @@ -39,8 +39,11 @@ enum wxEllipsizeFlags wxELLIPSIZE_FLAGS_EXPAND_TABS }; +// NB: Don't change the order of these values, they're the same as in +// PangoEllipsizeMode enum. enum wxEllipsizeMode { + wxELLIPSIZE_NONE, wxELLIPSIZE_START, wxELLIPSIZE_MIDDLE, wxELLIPSIZE_END @@ -68,6 +71,7 @@ public: // get the control alignment (left/right/centre, top/bottom/centre) int GetAlignment() const { return m_windowStyle & wxALIGN_MASK; } + // set label with mnemonics virtual void SetLabel(const wxString& label) { m_labelOrig = label; @@ -77,20 +81,41 @@ public: wxWindow::SetLabel(label); } - virtual wxString GetLabel() const + // return the original string, as it was passed to SetLabel() + // (i.e. with wx-style mnemonics) + virtual wxString GetLabel() const { return m_labelOrig; } + + // set label text (mnemonics will be escaped) + virtual void SetLabelText(const wxString& text) { - // return the original string, as it was passed to SetLabel() - // (i.e. with wx-style mnemonics) - return m_labelOrig; + SetLabel(EscapeMnemonics(text)); } // get just the text of the label, without mnemonic characters ('&') - wxString GetLabelText() const { return GetLabelText(GetLabel()); } + virtual wxString GetLabelText() const { return GetLabelText(GetLabel()); } + - void SetLabelText(const wxString& text) +#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) { - SetLabel(EscapeMnemonics(text)); + 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 @@ -109,25 +134,35 @@ public: // wxControl-specific processing after processing the update event virtual void DoUpdateWindowUI(wxUpdateUIEvent& event); + wxSize GetSizeFromTextSize(int xlen, int ylen = -1) const + { return DoGetSizeFromTextSize(xlen, ylen); } + wxSize GetSizeFromTextSize(const wxSize& tsize) const + { return DoGetSizeFromTextSize(tsize.x, tsize.y); } - // static utilities - // ---------------- - - // replaces parts of the (multiline) string with ellipsis if needed - static wxString Ellipsize(const wxString& label, const wxDC& dc, - wxEllipsizeMode mode, int maxWidth, - int flags = wxELLIPSIZE_FLAGS_DEFAULT); + // static utilities for mnemonics char (&) handling + // ------------------------------------------------ - // get the string without mnemonic characters ('&') + // returns the given string without mnemonic characters ('&') static wxString GetLabelText(const wxString& label); - // removes the mnemonics characters + // returns the given string without mnemonic characters ('&') + // this function is identic to GetLabelText() and is provided for clarity + // and for symmetry with the wxStaticText::RemoveMarkup() function. static wxString RemoveMnemonics(const wxString& str); // escapes (by doubling them) the mnemonics static wxString EscapeMnemonics(const wxString& str); + + // miscellaneous static utilities + // ------------------------------ + + // replaces parts of the given (multiline) string with an ellipsis if needed + static wxString Ellipsize(const wxString& label, const wxDC& dc, + wxEllipsizeMode mode, int maxWidth, + int flags = wxELLIPSIZE_FLAGS_DEFAULT); + // return the accel index in the string or -1 if none and puts the modified // string into second parameter if non NULL static int FindAccelIndex(const wxString& label, @@ -154,15 +189,33 @@ 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 + + // override this to return the total control's size from a string size + virtual wxSize DoGetSizeFromTextSize(int xlen, int ylen = -1) const; + // initialize the common fields of wxCommandEvent void InitCommandEvent(wxCommandEvent& event) const; // Ellipsize() helper: static wxString DoEllipsizeSingleLine(const wxString& label, const wxDC& dc, wxEllipsizeMode mode, int maxWidth, - int replacementWidth, int marginWidth); + 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 + // this field contains the label in wx format, i.e. with '&' mnemonics, + // as it was passed to the last SetLabel() call wxString m_labelOrig; wxDECLARE_NO_COPY_CLASS(wxControlBase); @@ -174,8 +227,6 @@ protected: #if defined(__WXUNIVERSAL__) #include "wx/univ/control.h" -#elif defined(__WXPALMOS__) - #include "wx/palmos/control.h" #elif defined(__WXMSW__) #include "wx/msw/control.h" #elif defined(__WXMOTIF__)