use wxEventType coherently with the docs

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

diff --git a/include/wx/control.h b/include/wx/control.h
index 24338b06b5dddc42ee2f220c32aa879b14bbd772..a7c6496e72975c87c7049e0f08559db8be8aa6e7 100644 (file)
--- a/include/wx/control.h
+++ b/include/wx/control.h
@@ -5,8 +5,8 @@
 // Modified by:
 // Created:     26.07.99
 // RCS-ID:      $Id$
-// Copyright:   (c) wxWindows team
-// Licence:     wxWindows license
+// Copyright:   (c) wxWidgets team
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_CONTROL_H_BASE_
@@ -16,23 +16,23 @@
 // headers
 // ----------------------------------------------------------------------------
 
-#ifdef __GNUG__
-    #pragma interface "controlbase.h"
-#endif
+#include "wx/defs.h"
 
 #if wxUSE_CONTROLS
 
 #include "wx/window.h"      // base class
 
-WXDLLEXPORT_DATA(extern const wxChar*) wxControlNameStr;
+extern WXDLLIMPEXP_DATA_CORE(const char) wxControlNameStr[];
 
 // ----------------------------------------------------------------------------
 // wxControl is the base class for all controls
 // ----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxControlBase : public wxWindow
+class WXDLLIMPEXP_CORE wxControlBase : public wxWindow
 {
 public:
+    wxControlBase() { }
+
     virtual ~wxControlBase();
 
     // Create() function adds the validator parameter
@@ -43,14 +43,63 @@ public:
                 const wxValidator& validator = wxDefaultValidator,
                 const wxString& name = wxControlNameStr);
 
+    // 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);
+
+    // 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);
+
+
+    // 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
+    virtual bool ShouldInheritColours() const { return true; }
+
+
+    // WARNING: this doesn't work for all controls nor all platforms!
+    //
     // simulates the event of given type (i.e. wxButton::Command() is just as
     // if the button was clicked)
     virtual void Command(wxCommandEvent &event);
 
-    // get the control alignment (left/right/centre, top/bottom/centre)
-    int GetAlignment() const { return m_windowStyle & wxALIGN_MASK; }
+    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,
@@ -61,11 +110,13 @@ protected:
                        const wxValidator& validator,
                        const wxString& name);
 
-    // inherit colour and font settings from the parent window
-    void InheritAttributes();
-
     // initialize the common fields of wxCommandEvent
     void InitCommandEvent(wxCommandEvent& event) const;
+
+    // this field contains the label in wx format, i.e. with '&' mnemonics
+    wxString m_labelOrig;
+
+    DECLARE_NO_COPY_CLASS(wxControlBase)
 };
 
 // ----------------------------------------------------------------------------
@@ -74,18 +125,22 @@ 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__)
     #include "wx/motif/control.h"
-#elif defined(__WXGTK__)
+#elif defined(__WXGTK20__)
     #include "wx/gtk/control.h"
+#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__)
     #include "wx/os2/control.h"
-#elif defined(__WXSTUBS__)
-    #include "wx/stubs/control.h"
 #endif
 
 #endif // wxUSE_CONTROLS