Change SetStringSelection to return bool like in other classes and ports

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

diff --git a/include/wx/control.h b/include/wx/control.h
index bb5003ae2059f197d43a321464c384a2799a4563..62ea97b1b357308d88982341a5e606e5d4bbcf3e 100644 (file)
--- a/include/wx/control.h
+++ b/include/wx/control.h
@@ -1,13 +1,106 @@
-#ifndef __CONTROLH_BASE__
-#define __CONTROLH_BASE__
-
-#if defined(__WINDOWS__)
-#include "wx/msw/control.h"
-#elif defined(__MOTIF__)
-#include "wx/xt/control.h"
-#elif defined(__GTK__)
-#include "wx/gtk/control.h"
+/////////////////////////////////////////////////////////////////////////////
+// Name:        wx/control.h
+// Purpose:     wxControl common interface
+// Author:      Vadim Zeitlin
+// Modified by:
+// Created:     26.07.99
+// RCS-ID:      $Id$
+// Copyright:   (c) wxWindows team
+// Licence:     wxWindows licence
+/////////////////////////////////////////////////////////////////////////////
+
+#ifndef _WX_CONTROL_H_BASE_
+#define _WX_CONTROL_H_BASE_
+
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------
+
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
+    #pragma interface "controlbase.h"
 #endif
 
+#include "wx/defs.h"
+
+#if wxUSE_CONTROLS
+
+#include "wx/window.h"      // base class
+
+WXDLLEXPORT_DATA(extern const wxChar*) wxControlNameStr;
+
+// ----------------------------------------------------------------------------
+// wxControl is the base class for all controls
+// ----------------------------------------------------------------------------
+
+class WXDLLEXPORT 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; }
+
+
+    // 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);
+
+protected:
+    // 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;
+
+    DECLARE_NO_COPY_CLASS(wxControlBase)
+};
+
+// ----------------------------------------------------------------------------
+// include platform-dependent wxControl declarations
+// ----------------------------------------------------------------------------
+
+#if defined(__WXUNIVERSAL__)
+    #include "wx/univ/control.h"
+#elif defined(__WXMSW__)
+    #include "wx/msw/control.h"
+#elif defined(__WXMOTIF__)
+    #include "wx/motif/control.h"
+#elif defined(__WXGTK__)
+    #include "wx/gtk/control.h"
+#elif defined(__WXMAC__)
+    #include "wx/mac/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_