]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/msw/control.h
fix the incoherence pointed out by ifacecheck between wx docs, that documents usage...
[wxWidgets.git] / include / wx / msw / control.h
index f6ab16ee18a5a0b172702c9a70e5984e0f273e6c..20d9c73d5b233702400b5c3198da706bbab8f558 100644 (file)
 /////////////////////////////////////////////////////////////////////////////
-// Name:        control.h
+// Name:        wx/msw/control.h
 // Purpose:     wxControl class
 // Author:      Julian Smart
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart
-// Licence:    wxWindows licence
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_CONTROL_H_
 #define _WX_CONTROL_H_
 
-#ifdef __GNUG__
-#pragma interface "control.h"
-#endif
-
-#include "wx/window.h"
-#include "wx/list.h"
-#include "wx/validate.h"
+#include "wx/dynarray.h"
 
 // General item class
-class WXDLLEXPORT wxControl: public wxWindow
+class WXDLLIMPEXP_CORE wxControl : public wxControlBase
 {
-  DECLARE_ABSTRACT_CLASS(wxControl)
 public:
-   wxControl(void);
-   ~wxControl(void);
-
-   virtual void Command(wxCommandEvent& WXUNUSED(event)) {};        // Simulates an event
-   virtual void ProcessCommand(wxCommandEvent& event); // Calls the callback and
-                                                                 // appropriate event handlers
-   virtual void SetClientSize(int width, int height);
-   virtual void SetLabel(const wxString& label);
-   virtual wxString GetLabel(void) const ;
-
-#if WXWIN_COMPATIBILITY
-   inline virtual void SetButtonColour(const wxColour& WXUNUSED(col)) { }
-   inline wxColour*GetButtonColour(void) const { return NULL; }
-
-   inline virtual void SetLabelFont(const wxFont& font);
-   inline virtual void SetButtonFont(const wxFont& font);
-   inline wxFont  *GetLabelFont(void) const ;
-   inline wxFont  *GetButtonFont(void) const ;
-#endif
-
-   // Places item in centre of panel - so can't be used BEFORE panel->Fit()
-   void Centre(int direction = wxHORIZONTAL);
-   inline void Callback(const wxFunction function);           // Adds callback
-
-   // MSW-specific
-   
-   // Window procedure
-   virtual long MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
-   virtual void MSWOnMouseMove(int x, int y, WXUINT flags);
-   virtual bool MSWNotify(WXWPARAM wParam, WXLPARAM lParam, WXLPARAM *result);
-
-   void OnEraseBackground(wxEraseEvent& event);
-
-   // For ownerdraw items
-   virtual bool MSWOnDraw(WXDRAWITEMSTRUCT *WXUNUSED(item)) { return FALSE; };
-   virtual bool MSWOnMeasure(WXMEASUREITEMSTRUCT *WXUNUSED(item)) { return FALSE; };
-
-   inline wxFunction GetCallback(void) { return m_callback; }
-   inline wxList& GetSubcontrols(void) { return m_subControls; }
-protected:
-   wxFunction       m_callback;     // Callback associated with the window
-   // MSW implementation
-   wxList           m_subControls; // For controls like radiobuttons which are really composite
+    wxControl() { }
 
-DECLARE_EVENT_TABLE()
-};
+    wxControl(wxWindow *parent, wxWindowID id,
+              const wxPoint& pos = wxDefaultPosition,
+              const wxSize& size = wxDefaultSize, long style = 0,
+              const wxValidator& validator = wxDefaultValidator,
+              const wxString& name = wxControlNameStr)
+    {
+        Create(parent, id, pos, size, style, validator, name);
+    }
+
+    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);
+
+    virtual ~wxControl();
+
+    // Simulates an event
+    virtual void Command(wxCommandEvent& event) { ProcessCommand(event); }
+
+
+    // implementation from now on
+    // --------------------------
+
+    virtual wxVisualAttributes GetDefaultAttributes() const
+    {
+        return GetClassDefaultAttributes(GetWindowVariant());
+    }
 
-inline void wxControl::Callback(const wxFunction function) { m_callback = function; };           // Adds callback
+    static wxVisualAttributes
+    GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
 
-#if WXWIN_COMPATIBILITY
-inline wxFont  *wxControl::GetLabelFont(void) const         { return GetFont() ; }
-inline wxFont  *wxControl::GetButtonFont(void) const        { return GetFont() ; }
-inline void wxControl::SetLabelFont(const wxFont& font) { SetFont(font); }
-inline void wxControl::SetButtonFont(const wxFont& font) { SetFont(font); }
-#endif
+    // Calls the callback and appropriate event handlers
+    bool ProcessCommand(wxCommandEvent& event);
+
+    // MSW-specific
+    virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
+
+    // For ownerdraw items
+    virtual bool MSWOnDraw(WXDRAWITEMSTRUCT *WXUNUSED(item)) { return false; }
+    virtual bool MSWOnMeasure(WXMEASUREITEMSTRUCT *WXUNUSED(item)) { return false; }
+
+    const wxArrayLong& GetSubcontrols() const { return m_subControls; }
+
+    // default handling of WM_CTLCOLORxxx: this is public so that wxWindow
+    // could call it
+    virtual WXHBRUSH MSWControlColor(WXHDC pDC, WXHWND hWnd);
+
+    // default style for the control include WS_TABSTOP if it AcceptsFocus()
+    virtual WXDWORD MSWGetStyle(long style, WXDWORD *exstyle) const;
+
+protected:
+    // choose the default border for this window
+    virtual wxBorder GetDefaultBorder() const;
+
+    // return default best size (doesn't really make any sense, override this)
+    virtual wxSize DoGetBestSize() const;
+
+    // This is a helper for all wxControls made with UPDOWN native control.
+    // In wxMSW it was only wxSpinCtrl derived from wxSpinButton but in
+    // WinCE of Smartphones this happens also for native wxTextCtrl,
+    // wxChoice and others.
+    virtual wxSize GetBestSpinnerSize(const bool is_vertical) const;
+
+    // create the control of the given Windows class: this is typically called
+    // from Create() method of the derived class passing its label, pos and
+    // size parameter (style parameter is not needed because m_windowStyle is
+    // supposed to had been already set and so is used instead when this
+    // function is called)
+    bool MSWCreateControl(const wxChar *classname,
+                          const wxString& label,
+                          const wxPoint& pos,
+                          const wxSize& size);
+
+    // NB: the method below is deprecated now, with MSWGetStyle() the method
+    //     above should be used instead! Once all the controls are updated to
+    //     implement MSWGetStyle() this version will disappear.
+    //
+    // create the control of the given class with the given style (combination
+    // of WS_XXX flags, i.e. Windows style, not wxWidgets one), returns
+    // false if creation failed
+    //
+    // All parameters except classname and style are optional, if the
+    // size/position are not given, they should be set later with SetSize()
+    // and, label (the title of the window), of course, is left empty. The
+    // extended style is determined from the style and the app 3D settings
+    // automatically if it's not specified explicitly.
+    bool MSWCreateControl(const wxChar *classname,
+                          WXDWORD style,
+                          const wxPoint& pos = wxDefaultPosition,
+                          const wxSize& size = wxDefaultSize,
+                          const wxString& label = wxEmptyString,
+                          WXDWORD exstyle = (WXDWORD)-1);
+
+    // call this from the derived class MSWControlColor() if you want to show
+    // the control greyed out (and opaque)
+    WXHBRUSH MSWControlColorDisabled(WXHDC pDC);
+
+    // common part of the 3 functions above: pass wxNullColour to use the
+    // appropriate background colour (meaning ours or our parents) or a fixed
+    // one
+    virtual WXHBRUSH DoMSWControlColor(WXHDC pDC, wxColour colBg, WXHWND hWnd);
+
+    // this is a helper for the derived class GetClassDefaultAttributes()
+    // implementation: it returns the right colours for the classes which
+    // contain something else (e.g. wxListBox, wxTextCtrl, ...) instead of
+    // being simple controls (such as wxButton, wxCheckBox, ...)
+    static wxVisualAttributes
+        GetCompositeControlsDefaultAttributes(wxWindowVariant variant);
+
+    // for controls like radiobuttons which are really composite this array
+    // holds the ids (not HWNDs!) of the sub controls
+    wxArrayLong m_subControls;
+
+private:
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxControl)
+};
 
-#endif
-    // _WX_CONTROL_H_
+#endif // _WX_CONTROL_H_