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     // geometry functions
 174     // ------------------
 175
 176     // get the splitter parameters: the x field of the returned point is the
 177     // sash width and the y field is the border width
 178     virtual wxSplitterRenderParams GetSplitterParams(const wxWindow *win) = 0;
 179
 180
 181     // pseudo constructors
 182     // -------------------
 183
 184     // return the currently used renderer
 185     static wxRendererNative& Get();
 186
 187     // return the generic implementation of the renderer
 188     static wxRendererNative& GetGeneric();
 189
 190     // return the default (native) implementation for this platform
 191     static wxRendererNative& GetDefault();
 192
 193
 194     // changing the global renderer
 195     // ----------------------------
 196
 197 #if wxUSE_DYNLIB_CLASS
 198     // load the renderer from the specified DLL, the returned pointer must be
 199     // deleted by caller if not NULL when it is not used any more
 200     static wxRendererNative *Load(const wxString& name);
 201 #endif // wxUSE_DYNLIB_CLASS
 202
 203     // set the renderer to use, passing NULL reverts to using the default
 204     // renderer
 205     //
 206     // return the previous renderer used with Set() or NULL if none
 207     static wxRendererNative *Set(wxRendererNative *renderer);
 208
 209
 210     // miscellaneous stuff
 211     // -------------------
 212
 213     // this function is used for version checking: Load() refuses to load any
 214     // DLLs implementing an older or incompatible version; it should be
 215     // implemented simply by returning wxRendererVersion::Current_XXX values
 216     virtual wxRendererVersion GetVersion() const = 0;
 217
 218     // virtual dtor for any base class
 219     virtual ~wxRendererNative();
 220 };
 221
 222 // ----------------------------------------------------------------------------
 223 // wxDelegateRendererNative: allows reuse of renderers code
 224 // ----------------------------------------------------------------------------
 225
 226 class WXDLLEXPORT wxDelegateRendererNative : public wxRendererNative
 227 {
 228 public:
 229     wxDelegateRendererNative()
 230         : m_rendererNative(GetGeneric()) { }
 231
 232     wxDelegateRendererNative(wxRendererNative& rendererNative)
 233         : m_rendererNative(rendererNative) { }
 234
 235
 236     virtual void DrawHeaderButton(wxWindow *win,
 237                                   wxDC& dc,
 238                                   const wxRect& rect,
 239                                   int flags = 0)
 240         { m_rendererNative.DrawHeaderButton(win, dc, rect, flags); }
 241
 242     virtual void DrawTreeItemButton(wxWindow *win,
 243                                     wxDC& dc,
 244                                     const wxRect& rect,
 245                                     int flags = 0)
 246         { m_rendererNative.DrawTreeItemButton(win, dc, rect, flags); }
 247
 248     virtual void DrawSplitterBorder(wxWindow *win,
 249                                     wxDC& dc,
 250                                     const wxRect& rect,
 251                                     int flags = 0)
 252         { m_rendererNative.DrawSplitterBorder(win, dc, rect, flags); }
 253
 254     virtual void DrawSplitterSash(wxWindow *win,
 255                                   wxDC& dc,
 256                                   const wxSize& size,
 257                                   wxCoord position,
 258                                   wxOrientation orient,
 259                                   int flags = 0)
 260         { m_rendererNative.DrawSplitterSash(win, dc, size,
 261                                             position, orient, flags); }
 262
 263     virtual void DrawComboBoxDropButton(wxWindow *win,
 264                                         wxDC& dc,
 265                                         const wxRect& rect,
 266                                         int flags = 0)
 267         { m_rendererNative.DrawComboBoxDropButton(win, dc, rect, flags); }
 268
 269     virtual void DrawDropArrow(wxWindow *win,
 270                                wxDC& dc,
 271                                const wxRect& rect,
 272                                int flags = 0)
 273         { m_rendererNative.DrawDropArrow(win, dc, rect, flags); }
 274
 275     virtual wxSplitterRenderParams GetSplitterParams(const wxWindow *win)
 276         { return m_rendererNative.GetSplitterParams(win); }
 277
 278     virtual wxRendererVersion GetVersion() const
 279         { return m_rendererNative.GetVersion(); }
 280
 281 protected:
 282     wxRendererNative& m_rendererNative;
 283
 284     DECLARE_NO_COPY_CLASS(wxDelegateRendererNative)
 285 };
 286
 287 // ----------------------------------------------------------------------------
 288 // inline functions implementation
 289 // ----------------------------------------------------------------------------
 290
 291 #ifndef wxHAS_NATIVE_RENDERER
 292
 293 // default native renderer is the generic one then
 294 /* static */ inline
 295 wxRendererNative& wxRendererNative::GetDefault()
 296 {
 297     return GetGeneric();
 298 }
 299
 300 #endif // !wxHAS_NATIVE_RENDERER
 301
 302 #endif // _WX_RENDERER_H_
 303