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 e6a4b8fed2d5796edc931f127939c7d6788bad23..a7c6496e72975c87c7049e0f08559db8be8aa6e7 100644 (file)
--- a/include/wx/control.h
+++ b/include/wx/control.h
@@ -1,15 +1,149 @@
-#ifndef __CONTROLH_BASE__
-#define __CONTROLH_BASE__
+/////////////////////////////////////////////////////////////////////////////
+// Name:        wx/control.h
+// Purpose:     wxControl common interface
+// Author:      Vadim Zeitlin
+// Modified by:
+// Created:     26.07.99
+// RCS-ID:      $Id$
+// Copyright:   (c) wxWidgets team
+// Licence:     wxWindows licence
+/////////////////////////////////////////////////////////////////////////////
 
-#if defined(__WXMSW__)
-#include "wx/msw/control.h"
+#ifndef _WX_CONTROL_H_BASE_
+#define _WX_CONTROL_H_BASE_
+
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------
+
+#include "wx/defs.h"
+
+#if wxUSE_CONTROLS
+
+#include "wx/window.h"      // base class
+
+extern WXDLLIMPEXP_DATA_CORE(const char) wxControlNameStr[];
+
+// ----------------------------------------------------------------------------
+// wxControl is the base class for all controls
+// ----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_CORE wxControlBase : public wxWindow
+{
+public:
+    wxControlBase() { }
+
+    virtual ~wxControlBase();
+
+    // Create() function adds the validator parameter
+    bool Create(wxWindow *parent, wxWindowID id,
+                const wxPoint& pos = wxDefaultPosition,
+                const wxSize& size = wxDefaultSize,
+                long style = 0,
+                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);
+
+    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,
+                       wxWindowID id,
+                       const wxPoint& pos,
+                       const wxSize& size,
+                       long style,
+                       const wxValidator& validator,
+                       const wxString& name);
+
+    // 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)
+};
+
+// ----------------------------------------------------------------------------
+// include platform-dependent wxControl declarations
+// ----------------------------------------------------------------------------
+
+#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/xt/control.h"
+    #include "wx/motif/control.h"
+#elif defined(__WXGTK20__)
+    #include "wx/gtk/control.h"
 #elif defined(__WXGTK__)
-#include "wx/gtk/control.h"
-#elif defined(__WXQT__)
-#include "wx/qt/control.h"
+    #include "wx/gtk1/control.h"
+#elif defined(__WXMAC__)
+    #include "wx/osx/control.h"
+#elif defined(__WXCOCOA__)
+    #include "wx/cocoa/control.h"
+#elif defined(__WXPM__)
+    #include "wx/os2/control.h"
 #endif
 
+#endif // wxUSE_CONTROLS
+
 #endif
-    // __CONTROLH_BASE__
+    // _WX_CONTROL_H_BASE_