Added caption parameter to wxGetFontFromUser and wxGetColourFromUser.

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

diff --git a/include/wx/control.h b/include/wx/control.h
index 5b932502823275e82625ff38c4199fa91aac6597..cc394434e3018ad5edfe5dd6b10eaa0f7a36414e 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,12 +16,14 @@
 // headers
 // ----------------------------------------------------------------------------
 
-#ifdef __GNUG__
-    #pragma interface "controlbase.h"
-#endif
+#include "wx/defs.h"
+
+#if wxUSE_CONTROLS
 
 #include "wx/window.h"      // base class
 
+extern WXDLLEXPORT_DATA(const wxChar*) wxControlNameStr;
+
 // ----------------------------------------------------------------------------
 // wxControl is the base class for all controls
 // ----------------------------------------------------------------------------
@@ -29,50 +31,99 @@
 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);
 
+    virtual void SetLabel( const wxString &label );
+    virtual bool SetFont(const wxFont& font);
+
+    // 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:
-    // creates the controls (invokes wxWindowBase::CreateBase) and adds it to
-    // the list of parents children
+    // 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,
-#if wxUSE_VALIDATORS
-#  if defined(__VISAGECPP__)
-                       const wxValidator* validator,
-#  else
                        const wxValidator& validator,
-#  endif
-#endif
                        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;
+
+    // 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);
+    }
+
+    DECLARE_NO_COPY_CLASS(wxControlBase)
 };
 
 // ----------------------------------------------------------------------------
 // include platform-dependent wxControl declarations
 // ----------------------------------------------------------------------------
 
-#if defined(__WXMSW__)
+#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__)
     #include "wx/gtk/control.h"
-#elif defined(__WXQT__)
-    #include "wx/qt/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"
-#elif defined(__WXSTUBS__)
-    #include "wx/stubs/control.h"
 #endif
 
+#endif // wxUSE_CONTROLS
+
 #endif
     // _WX_CONTROL_H_BASE_