wxPython/src/_renderer.i

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        _renderer.i
   3 // Purpose:     SWIG interface for wxRendererNative
   4 //
   5 // Author:      Robin Dunn
   6 //
   7 // Created:     9-June-2005
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) 2005 by Total Control Software
  10 // Licence:     wxWindows license
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13 // Not a %module
  14
  15 //---------------------------------------------------------------------------
  16 %newgroup
  17
  18 %{
  19 #include "wx/renderer.h"
  20 %}
  21
  22
  23 // control state flags used in wxRenderer and wxColourScheme
  24 enum
  25 {
  26     wxCONTROL_DISABLED   = 0x00000001,  // control is disabled
  27     wxCONTROL_FOCUSED    = 0x00000002,  // currently has keyboard focus
  28     wxCONTROL_PRESSED    = 0x00000004,  // (button) is pressed
  29     wxCONTROL_ISDEFAULT  = 0x00000008,  // only applies to the buttons
  30     wxCONTROL_ISSUBMENU  = wxCONTROL_ISDEFAULT, // only for menu items
  31     wxCONTROL_EXPANDED   = wxCONTROL_ISDEFAULT, // only for the tree items
  32     wxCONTROL_CURRENT    = 0x00000010,  // mouse is currently over the control
  33     wxCONTROL_SELECTED   = 0x00000020,  // selected item in e.g. listbox
  34     wxCONTROL_CHECKED    = 0x00000040,  // (check/radio button) is checked
  35     wxCONTROL_CHECKABLE  = 0x00000080,  // (menu) item can be checked
  36     wxCONTROL_UNDETERMINED = wxCONTROL_CHECKABLE, // (check) undetermined state
  37
  38     wxCONTROL_FLAGS_MASK = 0x000000ff,
  39
  40     // this is a pseudo flag not used directly by wxRenderer but rather by some
  41     // controls internally
  42     wxCONTROL_DIRTY      = 0x80000000
  43 };
  44
  45
  46
  47 DocStr(wxSplitterRenderParams,
  48 "This is just a simple struct used as a return value of
  49 `wx.RendererNative.GetSplitterParams` and contains some platform
  50 specific metrics about splitters.
  51
  52     * widthSash: the width of the splitter sash.
  53     * border: the width of the border of the splitter window.
  54     * isHotSensitive: ``True`` if the splitter changes its
  55       appearance when the mouse is over it.
  56
  57 ", "");
  58
  59 struct wxSplitterRenderParams
  60 {
  61     wxSplitterRenderParams(wxCoord widthSash_, wxCoord border_, bool isSens_);
  62     ~wxSplitterRenderParams();
  63
  64     // the width of the splitter sash
  65     const wxCoord widthSash;
  66
  67     // the width of the border of the splitter window
  68     const wxCoord border;
  69
  70     // true if the splitter changes its appearance when the mouse is over it
  71     const bool isHotSensitive;
  72 };
  73
  74
  75
  76
  77 DocStr(wxRendererVersion,
  78 "This simple struct represents the `wx.RendererNative` interface
  79 version and is only used as the return value of
  80 `wx.RendererNative.GetVersion`.", "");
  81
  82 struct wxRendererVersion
  83 {
  84     wxRendererVersion(int version_, int age_);
  85     ~wxRendererVersion();
  86
  87     enum
  88     {
  89         Current_Version,
  90         Current_Age
  91     };
  92
  93
  94     // check if the given version is compatible with the current one
  95     static bool IsCompatible(const wxRendererVersion& ver);
  96
  97     const int version;
  98     const int age;
  99 };
 100
 101 //---------------------------------------------------------------------------
 102
 103
 104 DocStr(wxRendererNative,
 105 "One of the design principles of wxWidgets is to use the native widgets
 106 on every platform in order to be as close to the native look and feel
 107 on every platform.  However there are still cases when some generic
 108 widgets are needed for various reasons, but it can sometimes take a
 109 lot of messy work to make them conform to the native LnF.
 110
 111 The wx.RendererNative class is a collection of functions that have
 112 platform-specific implementations for drawing certain parts of
 113 genereic controls in ways that are as close to the native look as
 114 possible.
 115 ", "");
 116
 117 class wxRendererNative
 118 {
 119 public:
 120
 121
 122     DocDeclStr(
 123         virtual void , DrawHeaderButton(wxWindow *win,
 124                                         wxDC& dc,
 125                                         const wxRect& rect,
 126                                         int flags = 0),
 127         "Draw the header control button (such as what is used by `wx.ListCtrl`
 128 in report mode.)", "");
 129
 130
 131
 132     DocDeclStr(
 133         virtual void , DrawTreeItemButton(wxWindow *win,
 134                                           wxDC& dc,
 135                                           const wxRect& rect,
 136                                           int flags = 0),
 137         "Draw the expanded/collapsed icon for a tree control item.", "");
 138
 139
 140     DocDeclStr(
 141         virtual void , DrawSplitterBorder(wxWindow *win,
 142                                           wxDC& dc,
 143                                           const wxRect& rect,
 144                                           int flags = 0),
 145         "Draw the border for a sash window: this border must be such that the
 146 sash drawn by `DrawSplitterSash` blends into it well.", "");
 147
 148
 149     DocDeclStr(
 150         virtual void , DrawSplitterSash(wxWindow *win,
 151                                         wxDC& dc,
 152                                         const wxSize& size,
 153                                         wxCoord position,
 154                                         wxOrientation orient,
 155                                         int flags = 0),
 156         "Draw a sash. The orient parameter defines whether the sash should be
 157 vertical or horizontal and how the position should be interpreted.", "");
 158
 159
 160     DocDeclStr(
 161         virtual void , DrawComboBoxDropButton(wxWindow *win,
 162                                               wxDC& dc,
 163                                               const wxRect& rect,
 164                                               int flags = 0),
 165         "Draw a button like the one used by `wx.ComboBox` to show a drop down
 166 window. The usual appearance is a downwards pointing arrow.
 167
 168 The ``flags`` parameter may have the ``wx.CONTROL_PRESSED`` or
 169 ``wx.CONTROL_CURRENT`` bits set.", "");
 170
 171
 172     DocDeclStr(
 173         virtual void , DrawDropArrow(wxWindow *win,
 174                                      wxDC& dc,
 175                                      const wxRect& rect,
 176                                      int flags = 0),
 177         "Draw a drop down arrow that is suitable for use outside a combo
 178 box. Arrow will have a transparent background.
 179
 180 ``rect`` is not entirely filled by the arrow. Instead, you should use
 181 bounding rectangle of a drop down button which arrow matches the size
 182 you need. ``flags`` may have the ``wx.CONTROL_PRESSED`` or
 183 ``wx.CONTROL_CURRENT`` bit set.", "");
 184
 185
 186
 187     DocDeclStr(
 188         virtual wxSplitterRenderParams , GetSplitterParams(const wxWindow *win),
 189         "Get the splitter parameters, see `wx.SplitterRenderParams`.", "");
 190
 191
 192
 193
 194     DocDeclStr(
 195         static wxRendererNative& , Get(),
 196         "Return the currently used renderer", "");
 197
 198
 199     DocDeclStr(
 200         static wxRendererNative& , GetGeneric(),
 201         "Return the generic implementation of the renderer. Under some
 202 platforms, this is the default renderer implementation, others have
 203 platform-specific default renderer which can be retrieved by calling
 204 `GetDefault`.", "");
 205
 206
 207     DocDeclStr(
 208         static wxRendererNative& , GetDefault(),
 209         "Return the default (native) implementation for this platform -- this
 210 is also the one used by default but this may be changed by calling `Set`
 211 in which case the return value of this method may be different from
 212 the return value of `Get`.", "");
 213
 214
 215
 216
 217 //     // load the renderer from the specified DLL, the returned pointer must be
 218 //     // deleted by caller if not NULL when it is not used any more
 219 //     static wxRendererNative *Load(const wxString& name);
 220
 221
 222     DocDeclStr(
 223         static wxRendererNative *, Set(wxRendererNative *renderer),
 224         "Set the renderer to use, passing None reverts to using the default
 225 renderer.  Returns the previous renderer used with Set or None.", "");
 226
 227
 228
 229     DocDeclStr(
 230         virtual wxRendererVersion , GetVersion() const,
 231         "Returns the version of the renderer.  Will be used for ensuring
 232 compatibility of dynamically loaded renderers.", "");
 233
 234 };
 235
 236
 237 //---------------------------------------------------------------------------