fix the signature of the documented functions and document some (relatively) new...

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

diff --git a/include/wx/control.h b/include/wx/control.h
index c5b425e7e8da9132a284fac6c375b209d24e84d8..08e9aeceea97d08a872f936af53896283f70c995 100644 (file)
--- a/include/wx/control.h
+++ b/include/wx/control.h
@@ -22,7 +22,7 @@
 
 #include "wx/window.h"      // base class
 
-extern WXDLLEXPORT_DATA(const wxChar) wxControlNameStr[];
+extern WXDLLEXPORT_DATA(const char) wxControlNameStr[];
 
 // ----------------------------------------------------------------------------
 // wxControl is the base class for all controls
@@ -46,6 +46,33 @@ 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;
+
+        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;
+    }
+
+    // static utilities:
+
+    // get the string without mnemonic characters ('&')
+    static wxString GetLabelText(const wxString& label);
+
+    // removes the mnemonics characters
+    static wxString RemoveMnemonics(const wxString& str);
+
 
     // controls by default inherit the colours of their parents, if a
     // particular control class doesn't want to do it, it can override
@@ -59,24 +86,15 @@ 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);
 
-    // Reserved for future use
-    virtual void ReservedControlFunc1() {}
-    virtual void ReservedControlFunc2() {}
-    virtual void ReservedControlFunc3() {}
-    virtual void ReservedControlFunc4() {}
-    virtual void ReservedControlFunc5() {}
-    virtual void ReservedControlFunc6() {}
-    virtual void ReservedControlFunc7() {}
-    virtual void ReservedControlFunc8() {}
-    virtual void ReservedControlFunc9() {}
-
 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,
@@ -90,16 +108,8 @@ protected:
     // initialize the common fields of wxCommandEvent
     void InitCommandEvent(wxCommandEvent& event) const;
 
-    // set the initial window size if none is given (i.e. at least one of the
-    // components of the size passed to ctor/Create() is -1)
-    //
-    // normally just calls SetBestSize() but can be overridden not to do it for
-    // the controls which have to do some additional initialization (e.g. add
-    // strings to list box) before their best size can be accurately calculated
-    virtual void SetInitialBestSize(const wxSize& size)
-    {
-        SetBestSize(size);
-    }
+    // this field contains the label in wx format, i.e. with '&' mnemonics
+    wxString m_labelOrig;
 
     DECLARE_NO_COPY_CLASS(wxControlBase)
 };