keep {Left,Middle,Right}Down() methods of wxMouseState which were present in 2.9...

[wxWidgets.git] / include / wx / control.h

diff --git a/include/wx/control.h b/include/wx/control.h
index 2bf0c472ad1641e23aafe0e2e44d6af336a62ad9..5427a2d4aaabe2134675a1af07128be4f52b9996 100644 (file)
--- a/include/wx/control.h
+++ b/include/wx/control.h
@@ -24,6 +24,19 @@
 
 extern WXDLLIMPEXP_DATA_CORE(const char) wxControlNameStr[];
 
+
+// ----------------------------------------------------------------------------
+// Ellipsize() constants
+// ----------------------------------------------------------------------------
+
+enum wxEllipsizeFlags
+{
+    wxELLIPSIZE_PROCESS_MNEMONICS = 1,
+    wxELLIPSIZE_EXPAND_TAB = 2,
+
+    wxELLIPSIZE_DEFAULT_FLAGS = wxELLIPSIZE_PROCESS_MNEMONICS|wxELLIPSIZE_EXPAND_TAB
+};
+
 enum wxEllipsizeMode
 {
     wxELLIPSIZE_START,
@@ -53,9 +66,6 @@ public:
     // get the control alignment (left/right/centre, top/bottom/centre)
     int GetAlignment() const { return m_windowStyle & wxALIGN_MASK; }
 
-    // get just the text of the label, without mnemonic characters ('&')
-    wxString GetLabelText() const { return GetLabelText(GetLabel()); }
-
     virtual void SetLabel(const wxString& label)
     {
         m_labelOrig = label;
@@ -72,23 +82,13 @@ public:
         return m_labelOrig;
     }
 
-    // static utilities:
-
-    // replaces parts of the string with ellipsis if needed
-    static wxString Ellipsize(const wxString& label, const wxDC& dc,
-                              wxEllipsizeMode mode, int maxWidth);
-
-    // get the string without mnemonic characters ('&')
-    static wxString GetLabelText(const wxString& label);
-
-    // removes the mnemonics characters
-    static wxString RemoveMnemonics(const wxString& str);
-
-    // 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,
-                              wxString *labelOnly = NULL);
+    // get just the text of the label, without mnemonic characters ('&')
+    wxString GetLabelText() const { return GetLabelText(GetLabel()); }
 
+    void SetLabelText(const wxString& text)
+    {
+        SetLabel(EscapeMnemonics(text));
+    }
 
     // controls by default inherit the colours of their parents, if a
     // particular control class doesn't want to do it, it can override
@@ -107,6 +107,30 @@ public:
     // wxControl-specific processing after processing the update event
     virtual void DoUpdateWindowUI(wxUpdateUIEvent& event);
 
+
+
+    // 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_DEFAULT_FLAGS);
+
+    // get the string without mnemonic characters ('&')
+    static wxString GetLabelText(const wxString& label);
+
+    // removes the mnemonics characters
+    static wxString RemoveMnemonics(const wxString& str);
+
+    // escapes (by doubling them) the mnemonics
+    static wxString EscapeMnemonics(const wxString& str);
+
+    // 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,
+                              wxString *labelOnly = NULL);
+
 protected:
     // choose the default border for this window
     virtual wxBorder GetDefaultBorder() const;
@@ -124,10 +148,15 @@ protected:
     // 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);
+
     // this field contains the label in wx format, i.e. with '&' mnemonics
     wxString m_labelOrig;
 
-    DECLARE_NO_COPY_CLASS(wxControlBase)
+    wxDECLARE_NO_COPY_CLASS(wxControlBase);
 };
 
 // ----------------------------------------------------------------------------