include/wx/msw/control.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        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 #ifdef __GNUG__
  16     #pragma interface "control.h"
  17 #endif
  18
  19 #include "wx/dynarray.h"
  20
  21 // General item class
  22 class WXDLLEXPORT wxControl : public wxControlBase
  23 {
  24 public:
  25    wxControl();
  26    wxControl(wxWindow *parent, wxWindowID id,
  27              const wxPoint& pos = wxDefaultPosition,
  28              const wxSize& size = wxDefaultSize, long style = 0,
  29              const wxValidator& validator = wxDefaultValidator,
  30              const wxString& name = wxControlNameStr)
  31     {
  32         Create(parent, id, pos, size, style, validator, name);
  33     }
  34
  35     bool Create(wxWindow *parent, wxWindowID id,
  36             const wxPoint& pos = wxDefaultPosition,
  37             const wxSize& size = wxDefaultSize, long style = 0,
  38             const wxValidator& validator = wxDefaultValidator,
  39             const wxString& name = wxControlNameStr);
  40
  41     virtual ~wxControl();
  42
  43     // Simulates an event
  44     virtual void Command(wxCommandEvent& event) { ProcessCommand(event); }
  45
  46     // implementation from now on
  47     // --------------------------
  48
  49     // Calls the callback and appropriate event handlers
  50     bool ProcessCommand(wxCommandEvent& event);
  51
  52     // MSW-specific
  53 #ifdef __WIN95__
  54     virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
  55 #endif // Win95
  56
  57     // For ownerdraw items
  58     virtual bool MSWOnDraw(WXDRAWITEMSTRUCT *WXUNUSED(item)) { return FALSE; };
  59     virtual bool MSWOnMeasure(WXMEASUREITEMSTRUCT *WXUNUSED(item)) { return FALSE; };
  60
  61     wxArrayLong GetSubcontrols() { return m_subControls; }
  62
  63     void OnEraseBackground(wxEraseEvent& event);
  64
  65     virtual WXHBRUSH OnCtlColor(WXHDC pDC, WXHWND pWnd, WXUINT nCtlColor,
  66             WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
  67
  68 #if WXWIN_COMPATIBILITY
  69     virtual void SetButtonColour(const wxColour& WXUNUSED(col)) { }
  70     wxColour* GetButtonColour() const { return NULL; }
  71
  72     virtual void SetLabelFont(const wxFont& font);
  73     virtual void SetButtonFont(const wxFont& font);
  74     wxFont& GetLabelFont() const;
  75     wxFont& GetButtonFont() const;
  76 #endif // WXWIN_COMPATIBILITY
  77
  78 protected:
  79     // choose the default border for this window
  80     virtual wxBorder GetDefaultBorder() const;
  81
  82     virtual wxSize DoGetBestSize() 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 wxWindows 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     // for controls like radiobuttons which are really composite this array
 118     // holds the ids (not HWNDs!) of the sub controls
 119     wxArrayLong m_subControls;
 120
 121 private:
 122     DECLARE_ABSTRACT_CLASS(wxControl)
 123     DECLARE_EVENT_TABLE()
 124 };
 125
 126
 127 #if WXWIN_COMPATIBILITY
 128     inline wxFont& wxControl::GetLabelFont() const { return (wxFont &)GetFont(); }
 129     inline wxFont& wxControl::GetButtonFont() const { return (wxFont &)GetFont(); }
 130     inline void wxControl::SetLabelFont(const wxFont& font) { SetFont(font); }
 131     inline void wxControl::SetButtonFont(const wxFont& font) { SetFont(font); }
 132 #endif // WXWIN_COMPATIBILITY
 133
 134 #endif
 135     // _WX_CONTROL_H_