use wx-style header and commets; fix indentation to be 4 spaces; move Doxygen comment...

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

diff --git a/include/wx/control.h b/include/wx/control.h
index aed113f80304f5032dd4e4d1c3bbe4ecca845022..08e9aeceea97d08a872f936af53896283f70c995 100644 (file)
--- a/include/wx/control.h
+++ b/include/wx/control.h
@@ -22,7 +22,7 @@
 
 #include "wx/window.h"      // base class
 
 
 #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
 
 // ----------------------------------------------------------------------------
 // wxControl is the base class for all controls


@@ -46,11 +46,33 @@ public:
     // get the control alignment (left/right/centre, top/bottom/centre)
     int GetAlignment() const { return m_windowStyle & wxALIGN_MASK; }
 
     // 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);
 
     // get the string without mnemonic characters ('&')
     static wxString GetLabelText(const wxString& label);
 

-    // get just the text of the label, without mnemonic characters ('&')
-    wxString GetLabelText() const { return GetLabelText(GetLabel()); }
+    // 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
 
     // controls by default inherit the colours of their parents, if a
     // particular control class doesn't want to do it, it can override


@@ -64,13 +86,15 @@ public:
     // if the button was clicked)
     virtual void Command(wxCommandEvent &event);
 
     // 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);
 
 protected:
     virtual bool SetFont(const wxFont& font);
 
     // wxControl-specific processing after processing the update event
     virtual void DoUpdateWindowUI(wxUpdateUIEvent& event);
 
 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,
     // creates the control (calls wxWindowBase::CreateBase inside) and adds it
     // to the list of parents children
     bool CreateControl(wxWindowBase *parent,


@@ -84,16 +108,8 @@ protected:
     // initialize the common fields of wxCommandEvent
     void InitCommandEvent(wxCommandEvent& event) const;
 
     // 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)
 };
 
     DECLARE_NO_COPY_CLASS(wxControlBase)
 };