Use wxWebKitCtrlNameStr to adhere to the convention used by other wx classes.

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

diff --git a/include/wx/control.h b/include/wx/control.h
index 560a476e05d3ea0d49164c9a5ffedacbe1c14886..8f1a1767c140da61fad3ed57e3af44738bba6a51 100644 (file)
--- a/include/wx/control.h
+++ b/include/wx/control.h
@@ -22,13 +22,38 @@
 
 #include "wx/window.h"      // base class
 
-extern WXDLLEXPORT_DATA(const wxChar) wxControlNameStr[];
+extern WXDLLIMPEXP_DATA_CORE(const char) wxControlNameStr[];
+
+
+// ----------------------------------------------------------------------------
+// Ellipsize() constants
+// ----------------------------------------------------------------------------
+
+enum wxEllipsizeFlags
+{
+    wxELLIPSIZE_FLAGS_NONE = 0,
+    wxELLIPSIZE_FLAGS_PROCESS_MNEMONICS = 1,
+    wxELLIPSIZE_FLAGS_EXPAND_TABS = 2,
+
+    wxELLIPSIZE_FLAGS_DEFAULT = wxELLIPSIZE_FLAGS_PROCESS_MNEMONICS |
+                                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
+};
 
 // ----------------------------------------------------------------------------
 // wxControl is the base class for all controls
 // ----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxControlBase : public wxWindow
+class WXDLLIMPEXP_CORE wxControlBase : public wxWindow
 {
 public:
     wxControlBase() { }
@@ -46,12 +71,30 @@ public:
     // get the control alignment (left/right/centre, top/bottom/centre)
     int GetAlignment() const { return m_windowStyle & wxALIGN_MASK; }
 
-    // get the string without mnemonic characters ('&')
-    static wxString GetLabelText(const wxString& label);
+    virtual void SetLabel(const wxString& label)
+    {
+        m_labelOrig = label;
+
+        InvalidateBestSize();
+
+        wxWindow::SetLabel(label);
+    }
+
+    virtual wxString GetLabel() const
+    {
+        // return the original string, as it was passed to SetLabel()
+        // (i.e. with wx-style mnemonics)
+        return m_labelOrig;
+    }
 
     // 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
     // ShouldInheritColours() to return false
@@ -64,13 +107,46 @@ public:
     // if the button was clicked)
     virtual void Command(wxCommandEvent &event);
 
-    virtual void SetLabel( const wxString &label );
     virtual bool SetFont(const wxFont& font);
 
     // 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_FLAGS_DEFAULT);
+
+    // 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);
+
+    // this is a helper for the derived class GetClassDefaultAttributes()
+    // implementation: it returns the right colours for the classes which
+    // contain something else (e.g. wxListBox, wxTextCtrl, ...) instead of
+    // being simple controls (such as wxButton, wxCheckBox, ...)
+    static wxVisualAttributes
+        GetCompositeControlsDefaultAttributes(wxWindowVariant variant);
+
 protected:
+    // choose the default border for this window
+    virtual wxBorder GetDefaultBorder() const;
+
     // creates the control (calls wxWindowBase::CreateBase inside) and adds it
     // to the list of parents children
     bool CreateControl(wxWindowBase *parent,
@@ -84,7 +160,15 @@ protected:
     // initialize the common fields of wxCommandEvent
     void InitCommandEvent(wxCommandEvent& event) const;
 
-    DECLARE_NO_COPY_CLASS(wxControlBase)
+    // 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;
+
+    wxDECLARE_NO_COPY_CLASS(wxControlBase);
 };
 
 // ----------------------------------------------------------------------------
@@ -104,7 +188,7 @@ protected:
 #elif defined(__WXGTK__)
     #include "wx/gtk1/control.h"
 #elif defined(__WXMAC__)
-    #include "wx/mac/control.h"
+    #include "wx/osx/control.h"
 #elif defined(__WXCOCOA__)
     #include "wx/cocoa/control.h"
 #elif defined(__WXPM__)