include/wx/msw/control.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/msw/control.h
   3 // Purpose:     wxControl class
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_CONTROL_H_
  13 #define _WX_CONTROL_H_
  14
  15 #include "wx/dynarray.h"
  16
  17 // General item class
  18 class WXDLLEXPORT wxControl : public wxControlBase
  19 {
  20 public:
  21     wxControl() { }
  22
  23     wxControl(wxWindow *parent, wxWindowID id,
  24               const wxPoint& pos = wxDefaultPosition,
  25               const wxSize& size = wxDefaultSize, long style = 0,
  26               const wxValidator& validator = wxDefaultValidator,
  27               const wxString& name = wxControlNameStr)
  28     {
  29         Create(parent, id, pos, size, style, validator, name);
  30     }
  31
  32     bool Create(wxWindow *parent, wxWindowID id,
  33             const wxPoint& pos = wxDefaultPosition,
  34             const wxSize& size = wxDefaultSize, long style = 0,
  35             const wxValidator& validator = wxDefaultValidator,
  36             const wxString& name = wxControlNameStr);
  37
  38     virtual ~wxControl();
  39
  40     // Simulates an event
  41     virtual void Command(wxCommandEvent& event) { ProcessCommand(event); }
  42
  43
  44     // implementation from now on
  45     // --------------------------
  46
  47     virtual wxVisualAttributes GetDefaultAttributes() const
  48     {
  49         return GetClassDefaultAttributes(GetWindowVariant());
  50     }
  51
  52     static wxVisualAttributes
  53     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
  54
  55     // Calls the callback and appropriate event handlers
  56     bool ProcessCommand(wxCommandEvent& event);
  57
  58     // MSW-specific
  59     virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
  60
  61     // For ownerdraw items
  62     virtual bool MSWOnDraw(WXDRAWITEMSTRUCT *WXUNUSED(item)) { return false; };
  63     virtual bool MSWOnMeasure(WXMEASUREITEMSTRUCT *WXUNUSED(item)) { return false; };
  64
  65     const wxArrayLong& GetSubcontrols() const { return m_subControls; }
  66
  67     // default handling of WM_CTLCOLORxxx: this is public so that wxWindow
  68     // could call it
  69     virtual WXHBRUSH MSWControlColor(WXHDC pDC, WXHWND hWnd);
  70
  71 protected:
  72     // choose the default border for this window
  73     virtual wxBorder GetDefaultBorder() const;
  74
  75     // return default best size (doesn't really make any sense, override this)
  76     virtual wxSize DoGetBestSize() const;
  77
  78     // This is a helper for all wxControls made with UPDOWN native control.
  79     // In wxMSW it was only wxSpinCtrl derived from wxSpinButton but in
  80     // WinCE of Smartphones this happens also for native wxTextCtrl,
  81     // wxChoice and others.
  82     virtual wxSize GetBestSpinnerSize(const bool is_vertical) const;
  83
  84     // create the control of the given Windows class: this is typically called
  85     // from Create() method of the derived class passing its label, pos and
  86     // size parameter (style parameter is not needed because m_windowStyle is
  87     // supposed to had been already set and so is used instead when this
  88     // function is called)
  89     bool MSWCreateControl(const wxChar *classname,
  90                           const wxString& label,
  91                           const wxPoint& pos,
  92                           const wxSize& size);
  93
  94     // NB: the method below is deprecated now, with MSWGetStyle() the method
  95     //     above should be used instead! Once all the controls are updated to
  96     //     implement MSWGetStyle() this version will disappear.
  97     //
  98     // create the control of the given class with the given style (combination
  99     // of WS_XXX flags, i.e. Windows style, not wxWidgets one), returns
 100     // false if creation failed
 101     //
 102     // All parameters except classname and style are optional, if the
 103     // size/position are not given, they should be set later with SetSize()
 104     // and, label (the title of the window), of course, is left empty. The
 105     // extended style is determined from the style and the app 3D settings
 106     // automatically if it's not specified explicitly.
 107     bool MSWCreateControl(const wxChar *classname,
 108                           WXDWORD style,
 109                           const wxPoint& pos = wxDefaultPosition,
 110                           const wxSize& size = wxDefaultSize,
 111                           const wxString& label = wxEmptyString,
 112                           WXDWORD exstyle = (WXDWORD)-1);
 113
 114     // default style for the control include WS_TABSTOP if it AcceptsFocus()
 115     virtual WXDWORD MSWGetStyle(long style, WXDWORD *exstyle) const;
 116
 117     // call this from the derived class MSWControlColor() if you want to show
 118     // the control greyed out (and opaque)
 119     WXHBRUSH MSWControlColorDisabled(WXHDC pDC);
 120
 121     // common part of the 3 functions above: pass wxNullColour to use the
 122     // appropriate background colour (meaning ours or our parents) or a fixed
 123     // one
 124     virtual WXHBRUSH DoMSWControlColor(WXHDC pDC, wxColour colBg, WXHWND hWnd);
 125
 126     // this is a helper for the derived class GetClassDefaultAttributes()
 127     // implementation: it returns the right colours for the classes which
 128     // contain something else (e.g. wxListBox, wxTextCtrl, ...) instead of
 129     // being simple controls (such as wxButton, wxCheckBox, ...)
 130     static wxVisualAttributes
 131         GetCompositeControlsDefaultAttributes(wxWindowVariant variant);
 132
 133     // for controls like radiobuttons which are really composite this array
 134     // holds the ids (not HWNDs!) of the sub controls
 135     wxArrayLong m_subControls;
 136
 137 private:
 138     DECLARE_DYNAMIC_CLASS_NO_COPY(wxControl)
 139 };
 140
 141 #endif // _WX_CONTROL_H_