/usr/include/wx-3.0/wx/wxPython/i_files/_renderer.i is in python-wxgtk3.0-dev 3.0.2.0+dfsg-7.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 | /////////////////////////////////////////////////////////////////////////////
// Name: _renderer.i
// Purpose: SWIG interface for wxRendererNative
//
// Author: Robin Dunn
//
// Created: 9-June-2005
// RCS-ID: $Id$
// Copyright: (c) 2005 by Total Control Software
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
// Not a %module
//---------------------------------------------------------------------------
%newgroup
%{
#include "wx/renderer.h"
%}
// control state flags used in wxRenderer and wxColourScheme
enum
{
wxCONTROL_DISABLED = 0x00000001, // control is disabled
wxCONTROL_FOCUSED = 0x00000002, // currently has keyboard focus
wxCONTROL_PRESSED = 0x00000004, // (button) is pressed
wxCONTROL_SPECIAL = 0x00000008, // control-specific bit:
wxCONTROL_ISDEFAULT = wxCONTROL_SPECIAL, // only for the buttons
wxCONTROL_ISSUBMENU = wxCONTROL_SPECIAL, // only for the menu items
wxCONTROL_EXPANDED = wxCONTROL_SPECIAL, // only for the tree items
wxCONTROL_SIZEGRIP = wxCONTROL_SPECIAL, // only for the status bar panes
wxCONTROL_FLAT = wxCONTROL_SPECIAL, // checkboxes only: flat border
wxCONTROL_CURRENT = 0x00000010, // mouse is currently over the control
wxCONTROL_SELECTED = 0x00000020, // selected item in e.g. listbox
wxCONTROL_CHECKED = 0x00000040, // (check/radio button) is checked
wxCONTROL_CHECKABLE = 0x00000080, // (menu) item can be checked
wxCONTROL_UNDETERMINED = wxCONTROL_CHECKABLE, // (check) undetermined state
wxCONTROL_FLAGS_MASK = 0x000000ff,
// this is a pseudo flag not used directly by wxRenderer but rather by some
// controls internally
wxCONTROL_DIRTY = 0x80000000
};
enum wxTitleBarButton
{
wxTITLEBAR_BUTTON_CLOSE = 0x01000000,
wxTITLEBAR_BUTTON_MAXIMIZE = 0x02000000,
wxTITLEBAR_BUTTON_ICONIZE = 0x04000000,
wxTITLEBAR_BUTTON_RESTORE = 0x08000000,
wxTITLEBAR_BUTTON_HELP = 0x10000000
};
DocStr(wxSplitterRenderParams,
"This is just a simple struct used as a return value of
`wx.RendererNative.GetSplitterParams` and contains some platform
specific metrics about splitters.
* widthSash: the width of the splitter sash.
* border: the width of the border of the splitter window.
* isHotSensitive: ``True`` if the splitter changes its
appearance when the mouse is over it.
", "");
struct wxSplitterRenderParams
{
wxSplitterRenderParams(wxCoord widthSash_, wxCoord border_, bool isSens_);
~wxSplitterRenderParams();
// the width of the splitter sash
const wxCoord widthSash;
// the width of the border of the splitter window
const wxCoord border;
// true if the splitter changes its appearance when the mouse is over it
const bool isHotSensitive;
};
DocStr(wxHeaderButtonParams,
"Extra (optional) parameters for `wx.RendererNative.DrawHeaderButton`", "");
struct wxHeaderButtonParams
{
wxHeaderButtonParams();
~wxHeaderButtonParams();
// So wxColour_helper will be used when assigning to the colour items in the struct
%typemap(in) wxColour* (wxColour temp) {
$1 = &temp;
if ( ! wxColour_helper($input, &$1)) SWIG_fail;
}
wxColour m_arrowColour;
wxColour m_selectionColour;
wxString m_labelText;
wxFont m_labelFont;
wxColour m_labelColour;
wxBitmap m_labelBitmap;
int m_labelAlignment;
};
enum wxHeaderSortIconType {
wxHDR_SORT_ICON_NONE, // Header button has no sort arrow
wxHDR_SORT_ICON_UP, // Header button an an up sort arrow icon
wxHDR_SORT_ICON_DOWN // Header button an a down sort arrow icon
};
DocStr(wxRendererVersion,
"This simple struct represents the `wx.RendererNative` interface
version and is only used as the return value of
`wx.RendererNative.GetVersion`.", "");
struct wxRendererVersion
{
wxRendererVersion(int version_, int age_);
~wxRendererVersion();
enum
{
Current_Version,
Current_Age
};
// check if the given version is compatible with the current one
static bool IsCompatible(const wxRendererVersion& ver);
const int version;
const int age;
};
//---------------------------------------------------------------------------
DocStr(wxRendererNative,
"One of the design principles of wxWidgets is to use the native
widgets on every platform in order to be as close as possible to
the native look and feel on every platform. However there are
still cases when some generic widgets are needed for various
reasons, but it can sometimes take a lot of messy work to make
them conform to the native LnF.
The wx.RendererNative class is a collection of functions that have
platform-specific implementations for drawing certain parts of
genereic controls in ways that are as close to the native look as
possible.
Note that each drawing function restores the `wx.DC` attributes if it
changes them, so it is safe to assume that the same pen, brush and
colours that were active before the call to this function are still in
effect after it.
", "");
class wxRendererNative
{
public:
DocDeclStr(
virtual int , DrawHeaderButton(wxWindow *win,
wxDC& dc,
const wxRect& rect,
int flags = 0,
wxHeaderSortIconType sortArrow = wxHDR_SORT_ICON_NONE,
wxHeaderButtonParams* params=NULL),
"Draw a header control button (such as what is used by `wx.ListCtrl` in report
mode.) The optimal size of the label (text and icons) is returned.", "");
DocDeclStr(
virtual int , DrawHeaderButtonContents(wxWindow *win,
wxDC& dc,
const wxRect& rect,
int flags = 0,
wxHeaderSortIconType sortArrow = wxHDR_SORT_ICON_NONE,
wxHeaderButtonParams* params=NULL),
"Draw the contents of a header control button, (label, sort
arrows, etc.) Normally this is only called by `DrawHeaderButton`.", "");
DocDeclStr(
virtual int , GetHeaderButtonHeight(wxWindow *win),
"Returns the default height of a header button, either a fixed platform
height if available, or a generic height based on the window's font.", "");
// Returns the margin on left and right sides of header button's label
virtual int GetHeaderButtonMargin(wxWindow *win);
DocDeclStr(
virtual void , DrawTreeItemButton(wxWindow *win,
wxDC& dc,
const wxRect& rect,
int flags = 0),
"Draw the expanded/collapsed icon for a tree control item.", "");
DocDeclStr(
virtual void , DrawSplitterBorder(wxWindow *win,
wxDC& dc,
const wxRect& rect,
int flags = 0),
"Draw the border for a sash window: this border must be such that the
sash drawn by `DrawSplitterSash` blends into it well.", "");
DocDeclStr(
virtual void , DrawSplitterSash(wxWindow *win,
wxDC& dc,
const wxSize& size,
wxCoord position,
wxOrientation orient,
int flags = 0),
"Draw a sash. The orient parameter defines whether the sash should be
vertical or horizontal and how the position should be interpreted.", "");
DocDeclStr(
virtual void , DrawComboBoxDropButton(wxWindow *win,
wxDC& dc,
const wxRect& rect,
int flags = 0),
"Draw a button like the one used by `wx.ComboBox` to show a drop down
window. The usual appearance is a downwards pointing arrow.
The ``flags`` parameter may have the ``wx.CONTROL_PRESSED`` or
``wx.CONTROL_CURRENT`` bits set.", "");
DocDeclStr(
virtual void , DrawDropArrow(wxWindow *win,
wxDC& dc,
const wxRect& rect,
int flags = 0),
"Draw a drop down arrow that is suitable for use outside a combo
box. Arrow will have a transparent background.
``rect`` is not entirely filled by the arrow. Instead, you should use
bounding rectangle of a drop down button which arrow matches the size
you need. ``flags`` may have the ``wx.CONTROL_PRESSED`` or
``wx.CONTROL_CURRENT`` bit set.", "");
DocDeclStr(
virtual void , DrawCheckBox(wxWindow *win,
wxDC& dc,
const wxRect& rect,
int flags = 0),
"Draw a check button. Flags may use wx.CONTROL_CHECKED,
wx.CONTROL_UNDETERMINED and wx.CONTROL_CURRENT.", "");
DocDeclStr(
wxSize , GetCheckBoxSize(wxWindow *win),
"", "");
DocDeclStr(
virtual void , DrawPushButton(wxWindow *win,
wxDC& dc,
const wxRect& rect,
int flags = 0),
"Draw a blank button. Flags may be wx.CONTROL_PRESSED, wx.CONTROL_CURRENT and
wx.CONTROL_ISDEFAULT", "");
DocDeclStr(
virtual void , DrawItemSelectionRect(wxWindow *win,
wxDC& dc,
const wxRect& rect,
int flags = 0),
"Draw rectangle indicating that an item in e.g. a list control has been
selected or focused
The flags parameter may be:
==================== ============================================
wx.CONTROL_SELECTED item is selected, e.g. draw background
wx.CONTROL_CURRENT item is the current item, e.g. dotted border
wx.CONTROL_FOCUSED the whole control has focus, e.g. blue
background vs. grey otherwise
==================== ============================================
", "");
DocDeclStr(
virtual void , DrawFocusRect(wxWindow* win, wxDC& dc, const wxRect& rect, int flags = 0),
"Draw the focus rectangle around the label contained in the given rect.
Only wxCONTROL_SELECTED makes sense in flags here", "");
DocDeclStr(
virtual wxSplitterRenderParams , GetSplitterParams(const wxWindow *win),
"Get the splitter parameters, see `wx.SplitterRenderParams`.", "");
DocDeclStr(
void, DrawChoice(wxWindow* win, wxDC& dc,
const wxRect& rect, int flags=0),
"Draw a native wxChoice", "");
DocDeclStr(
void, DrawComboBox(wxWindow* win, wxDC& dc,
const wxRect& rect, int flags=0),
"Draw a native wxComboBox", "");
DocDeclStr(
void, DrawTextCtrl(wxWindow* win, wxDC& dc,
const wxRect& rect, int flags=0),
"Draw a native wxTextCtrl", "");
DocDeclStr(
void, DrawRadioBitmap(wxWindow* win, wxDC& dc,
const wxRect& rect, int flags=0),
"Draw a native wxRadioButton (just the button image, not the text)", "");
%pythoncode {
DrawRadioButton = wx.deprecated(DrawRadioBitmap,
'DrawRadioButton is deprecated, use `DrawRadioBitmap` instead.')
}
DocStr(DrawTitleBarBitmap,
"Draw one of the standard title bar buttons.
This is currently implemented only for MSW and OS X (for the close
button only) because there is no way to render standard title bar
buttons under the other platforms, the best can be done is to use
normal (only) images which wxArtProvider provides for wxART_HELP and
wxART_CLOSE (but not any other title bar buttons)", "");
#ifdef __WXGTK__
%extend {
void DrawTitleBarBitmap(wxWindow *win,
wxDC& dc,
const wxRect& rect,
wxTitleBarButton button,
int flags = 0)
{
wxPyRaiseNotImplemented();
}
}
#else
void DrawTitleBarBitmap(wxWindow *win,
wxDC& dc,
const wxRect& rect,
wxTitleBarButton button,
int flags = 0);
#endif
MustHaveApp(Get);
DocDeclStr(
static wxRendererNative& , Get(),
"Return the currently used renderer", "");
MustHaveApp(GetGeneric);
DocDeclStr(
static wxRendererNative& , GetGeneric(),
"Return the generic implementation of the renderer. Under some
platforms, this is the default renderer implementation, others have
platform-specific default renderer which can be retrieved by calling
`wx.RendererNative.GetDefault`.", "");
MustHaveApp(GetDefault);
DocDeclStr(
static wxRendererNative& , GetDefault(),
"Return the default (native) implementation for this platform -- this
is also the one used by default but this may be changed by calling
`wx.RendererNative.Set` in which case the return value of this method
may be different from the return value of `wx.RendererNative.Get`.", "");
// // load the renderer from the specified DLL, the returned pointer must be
// // deleted by caller if not NULL when it is not used any more
// static wxRendererNative *Load(const wxString& name);
MustHaveApp(Set);
DocDeclStr(
static wxRendererNative *, Set(wxRendererNative *renderer),
"Set the renderer to use, passing None reverts to using the default
renderer. Returns the previous renderer used with Set or None.", "");
DocDeclStr(
virtual wxRendererVersion , GetVersion() const,
"Returns the version of the renderer. Will be used for ensuring
compatibility of dynamically loaded renderers.", "");
%property(SplitterParams, GetSplitterParams, doc="See `GetSplitterParams`");
%property(Version, GetVersion, doc="See `GetVersion`");
};
//---------------------------------------------------------------------------
//---------------------------------------------------------------------------
|