include/wx/renderer.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/renderer.h
   3 // Purpose:     wxRendererNative class declaration
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     20.07.2003
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 2003 Vadim Zeitlin <vadim@wxwidgets.org>
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 /*
  13    Renderers are used in wxWidgets for two similar but different things:
  14     (a) wxUniversal uses them to draw everything, i.e. all the control
  15     (b) all the native ports use them to draw generic controls only
  16
  17    wxUniversal needs more functionality than what is included in the base class
  18    as it needs to draw stuff like scrollbars which are never going to be
  19    generic. So we put the bare minimum needed by the native ports here and the
  20    full wxRenderer class is declared in wx/univ/renderer.h and is only used by
  21    wxUniveral (although note that native ports can load wxRenderer objects from
  22    theme DLLs and use them as wxRendererNative ones, of course).
  23  */
  24
  25 #ifndef _WX_RENDERER_H_
  26 #define _WX_RENDERER_H_
  27
  28 class WXDLLEXPORT wxDC;
  29 class WXDLLEXPORT wxWindow;
  30
  31 #include "wx/gdicmn.h" // for wxPoint
  32
  33 // some platforms have their own renderers, others use the generic one
  34 #if defined(__WXMSW__) || defined(__WXMAC__) || defined(__WXGTK__)
  35     #define wxHAS_NATIVE_RENDERER
  36 #else
  37     #undef wxHAS_NATIVE_RENDERER
  38 #endif
  39
  40 // ----------------------------------------------------------------------------
  41 // constants
  42 // ----------------------------------------------------------------------------
  43
  44 // control state flags used in wxRenderer and wxColourScheme
  45 enum
  46 {
  47     wxCONTROL_DISABLED   = 0x00000001,  // control is disabled
  48     wxCONTROL_FOCUSED    = 0x00000002,  // currently has keyboard focus
  49     wxCONTROL_PRESSED    = 0x00000004,  // (button) is pressed
  50     wxCONTROL_ISDEFAULT  = 0x00000008,  // only applies to the buttons
  51     wxCONTROL_ISSUBMENU  = wxCONTROL_ISDEFAULT, // only for menu items
  52     wxCONTROL_EXPANDED   = wxCONTROL_ISDEFAULT, // only for the tree items
  53     wxCONTROL_CURRENT    = 0x00000010,  // mouse is currently over the control
  54     wxCONTROL_SELECTED   = 0x00000020,  // selected item in e.g. listbox
  55     wxCONTROL_CHECKED    = 0x00000040,  // (check/radio button) is checked
  56     wxCONTROL_CHECKABLE  = 0x00000080,  // (menu) item can be checked
  57     wxCONTROL_UNDETERMINED = wxCONTROL_CHECKABLE, // (check) undetermined state
  58
  59     wxCONTROL_FLAGS_MASK = 0x000000ff,
  60
  61     // this is a pseudo flag not used directly by wxRenderer but rather by some
  62     // controls internally
  63     wxCONTROL_DIRTY      = 0x80000000
  64 };
  65
  66 // ----------------------------------------------------------------------------
  67 // helper structs
  68 // ----------------------------------------------------------------------------
  69
  70 // wxSplitterWindow parameters
  71 struct WXDLLEXPORT wxSplitterRenderParams
  72 {
  73     // the only way to initialize this struct is by using this ctor
  74     wxSplitterRenderParams(wxCoord widthSash_, wxCoord border_, bool isSens_)
  75         : widthSash(widthSash_), border(border_), isHotSensitive(isSens_)
  76         {
  77         }
  78
  79     // the width of the splitter sash
  80     const wxCoord widthSash;
  81
  82     // the width of the border of the splitter window
  83     const wxCoord border;
  84
  85     // true if the splitter changes its appearance when the mouse is over it
  86     const bool isHotSensitive;
  87 };
  88
  89 // wxRendererNative interface version
  90 struct WXDLLEXPORT wxRendererVersion
  91 {
  92     wxRendererVersion(int version_, int age_) : version(version_), age(age_) { }
  93
  94     // default copy ctor, assignment operator and dtor are ok
  95
  96     // the current version and age of wxRendererNative interface: different
  97     // versions are incompatible (in both ways) while the ages inside the same
  98     // version are upwards compatible, i.e. the version of the renderer must
  99     // match the version of the main program exactly while the age may be
 100     // highergreater or equal to it
 101     //
 102     // NB: don't forget to increment age after adding any new virtual function!
 103     enum
 104     {
 105         Current_Version = 1,
 106         Current_Age = 5
 107     };
 108
 109
 110     // check if the given version is compatible with the current one
 111     static bool IsCompatible(const wxRendererVersion& ver)
 112     {
 113         return ver.version == Current_Version && ver.age >= Current_Age;
 114     }
 115
 116     const int version;
 117     const int age;
 118 };
 119
 120 // ----------------------------------------------------------------------------
 121 // wxRendererNative: abstracts drawing methods needed by the native controls
 122 // ----------------------------------------------------------------------------
 123
 124 class WXDLLEXPORT wxRendererNative
 125 {
 126 public:
 127     // drawing functions
 128     // -----------------
 129
 130     // draw the header control button (used by wxListCtrl)
 131     virtual void DrawHeaderButton(wxWindow *win,
 132                                   wxDC& dc,
 133                                   const wxRect& rect,
 134                                   int flags = 0) = 0;
 135
 136     // draw the expanded/collapsed icon for a tree control item
 137     virtual void DrawTreeItemButton(wxWindow *win,
 138                                     wxDC& dc,
 139                                     const wxRect& rect,
 140                                     int flags = 0) = 0;
 141
 142     // draw the border for sash window: this border must be such that the sash
 143     // drawn by DrawSash() blends into it well
 144     virtual void DrawSplitterBorder(wxWindow *win,
 145                                     wxDC& dc,
 146                                     const wxRect& rect,
 147                                     int flags = 0) = 0;
 148
 149     // draw a (vertical) sash
 150     virtual void DrawSplitterSash(wxWindow *win,
 151                                   wxDC& dc,
 152                                   const wxSize& size,
 153                                   wxCoord position,
 154                                   wxOrientation orient,
 155                                   int flags = 0) = 0;
 156
 157     // draw a combobox dropdown button
 158     //
 159     // flags may use wxCONTROL_PRESSED and wxCONTROL_CURRENT
 160     virtual void DrawComboBoxDropButton(wxWindow *win,
 161                                         wxDC& dc,
 162                                         const wxRect& rect,
 163                                         int flags = 0) = 0;
 164
 165     // draw a dropdown arrow
 166     //
 167     // flags may use wxCONTROL_PRESSED and wxCONTROL_CURRENT
 168     virtual void DrawDropArrow(wxWindow *win,
 169                                wxDC& dc,
 170                                const wxRect& rect,
 171                                int flags = 0) = 0;
 172
 173
 174     // draw check button
 175     //
 176     // flags may use wxCONTROL_CHECKED, wxCONTROL_UNDETERMINED and wxCONTROL_CURRENT
 177     virtual void DrawCheckButton(wxWindow *win,
 178                                  wxDC& dc,
 179                                  const wxRect& rect,
 180                                  int flags = 0) = 0;
 181
 182     // geometry functions
 183     // ------------------
 184
 185     // get the splitter parameters: the x field of the returned point is the
 186     // sash width and the y field is the border width
 187     virtual wxSplitterRenderParams GetSplitterParams(const wxWindow *win) = 0;
 188
 189
 190     // pseudo constructors
 191     // -------------------
 192
 193     // return the currently used renderer
 194     static wxRendererNative& Get();
 195
 196     // return the generic implementation of the renderer
 197     static wxRendererNative& GetGeneric();
 198
 199     // return the default (native) implementation for this platform
 200     static wxRendererNative& GetDefault();
 201
 202
 203     // changing the global renderer
 204     // ----------------------------
 205
 206 #if wxUSE_DYNLIB_CLASS
 207     // load the renderer from the specified DLL, the returned pointer must be
 208     // deleted by caller if not NULL when it is not used any more
 209     static wxRendererNative *Load(const wxString& name);
 210 #endif // wxUSE_DYNLIB_CLASS
 211
 212     // set the renderer to use, passing NULL reverts to using the default
 213     // renderer
 214     //
 215     // return the previous renderer used with Set() or NULL if none
 216     static wxRendererNative *Set(wxRendererNative *renderer);
 217
 218
 219     // miscellaneous stuff
 220     // -------------------
 221
 222     // this function is used for version checking: Load() refuses to load any
 223     // DLLs implementing an older or incompatible version; it should be
 224     // implemented simply by returning wxRendererVersion::Current_XXX values
 225     virtual wxRendererVersion GetVersion() const = 0;
 226
 227     // virtual dtor for any base class
 228     virtual ~wxRendererNative();
 229 };
 230
 231 // ----------------------------------------------------------------------------
 232 // wxDelegateRendererNative: allows reuse of renderers code
 233 // ----------------------------------------------------------------------------
 234
 235 class WXDLLEXPORT wxDelegateRendererNative : public wxRendererNative
 236 {
 237 public:
 238     wxDelegateRendererNative()
 239         : m_rendererNative(GetGeneric()) { }
 240
 241     wxDelegateRendererNative(wxRendererNative& rendererNative)
 242         : m_rendererNative(rendererNative) { }
 243
 244
 245     virtual void DrawHeaderButton(wxWindow *win,
 246                                   wxDC& dc,
 247                                   const wxRect& rect,
 248                                   int flags = 0)
 249         { m_rendererNative.DrawHeaderButton(win, dc, rect, flags); }
 250
 251     virtual void DrawTreeItemButton(wxWindow *win,
 252                                     wxDC& dc,
 253                                     const wxRect& rect,
 254                                     int flags = 0)
 255         { m_rendererNative.DrawTreeItemButton(win, dc, rect, flags); }
 256
 257     virtual void DrawSplitterBorder(wxWindow *win,
 258                                     wxDC& dc,
 259                                     const wxRect& rect,
 260                                     int flags = 0)
 261         { m_rendererNative.DrawSplitterBorder(win, dc, rect, flags); }
 262
 263     virtual void DrawSplitterSash(wxWindow *win,
 264                                   wxDC& dc,
 265                                   const wxSize& size,
 266                                   wxCoord position,
 267                                   wxOrientation orient,
 268                                   int flags = 0)
 269         { m_rendererNative.DrawSplitterSash(win, dc, size,
 270                                             position, orient, flags); }
 271
 272     virtual void DrawComboBoxDropButton(wxWindow *win,
 273                                         wxDC& dc,
 274                                         const wxRect& rect,
 275                                         int flags = 0)
 276         { m_rendererNative.DrawComboBoxDropButton(win, dc, rect, flags); }
 277
 278     virtual void DrawDropArrow(wxWindow *win,
 279                                wxDC& dc,
 280                                const wxRect& rect,
 281                                int flags = 0)
 282         { m_rendererNative.DrawDropArrow(win, dc, rect, flags); }
 283
 284     virtual void DrawCheckButton(wxWindow *win,
 285                                  wxDC& dc,
 286                                  const wxRect& rect,
 287                                  int flags = 0 )
 288         { m_rendererNative.DrawCheckButton( win, dc, rect, flags ); }
 289
 290     virtual wxSplitterRenderParams GetSplitterParams(const wxWindow *win)
 291         { return m_rendererNative.GetSplitterParams(win); }
 292
 293     virtual wxRendererVersion GetVersion() const
 294         { return m_rendererNative.GetVersion(); }
 295
 296 protected:
 297     wxRendererNative& m_rendererNative;
 298
 299     DECLARE_NO_COPY_CLASS(wxDelegateRendererNative)
 300 };
 301
 302 // ----------------------------------------------------------------------------
 303 // inline functions implementation
 304 // ----------------------------------------------------------------------------
 305
 306 #ifndef wxHAS_NATIVE_RENDERER
 307
 308 // default native renderer is the generic one then
 309 /* static */ inline
 310 wxRendererNative& wxRendererNative::GetDefault()
 311 {
 312     return GetGeneric();
 313 }
 314
 315 #endif // !wxHAS_NATIVE_RENDERER
 316
 317 #endif // _WX_RENDERER_H_
 318