wxPython/src/msw/_core.py

   1 # This file was created automatically by SWIG 1.3.29.
   2 # Don't modify this file, modify the SWIG interface instead.
   3
   4 import _core_
   5 import new
   6 new_instancemethod = new.instancemethod
   7 def _swig_setattr_nondynamic(self,class_type,name,value,static=1):
   8     if (name == "thisown"): return self.this.own(value)
   9     if (name == "this"):
  10         if type(value).__name__ == 'PySwigObject':
  11             self.__dict__[name] = value
  12             return
  13     method = class_type.__swig_setmethods__.get(name,None)
  14     if method: return method(self,value)
  15     if (not static) or hasattr(self,name):
  16         self.__dict__[name] = value
  17     else:
  18         raise AttributeError("You cannot add attributes to %s" % self)
  19
  20 def _swig_setattr(self,class_type,name,value):
  21     return _swig_setattr_nondynamic(self,class_type,name,value,0)
  22
  23 def _swig_getattr(self,class_type,name):
  24     if (name == "thisown"): return self.this.own()
  25     method = class_type.__swig_getmethods__.get(name,None)
  26     if method: return method(self)
  27     raise AttributeError,name
  28
  29 def _swig_repr(self):
  30     try: strthis = "proxy of " + self.this.__repr__()
  31     except: strthis = ""
  32     return "<%s.%s; %s >" % (self.__class__.__module__, self.__class__.__name__, strthis,)
  33
  34 import types
  35 try:
  36     _object = types.ObjectType
  37     _newclass = 1
  38 except AttributeError:
  39     class _object : pass
  40     _newclass = 0
  41 del types
  42
  43
  44 def _swig_setattr_nondynamic_method(set):
  45     def set_attr(self,name,value):
  46         if (name == "thisown"): return self.this.own(value)
  47         if hasattr(self,name) or (name == "this"):
  48             set(self,name,value)
  49         else:
  50             raise AttributeError("You cannot add attributes to %s" % self)
  51     return set_attr
  52
  53
  54 #// Give a reference to the dictionary of this module to the C++ extension
  55 #// code.
  56 _core_._wxPySetDictionary(vars())
  57
  58 #// A little trick to make 'wx' be a reference to this module so wx.Names can
  59 #// be used here.
  60 import sys as _sys
  61 wx = _sys.modules[__name__]
  62
  63
  64 #----------------------------------------------------------------------------
  65
  66 def _deprecated(callable, msg=None):
  67     """
  68     Create a wrapper function that will raise a DeprecationWarning
  69     before calling the callable.
  70     """
  71     if msg is None:
  72         msg = "%s is deprecated" % callable
  73     def deprecatedWrapper(*args, **kwargs):
  74         import warnings
  75         warnings.warn(msg, DeprecationWarning, stacklevel=2)
  76         return callable(*args, **kwargs)
  77     deprecatedWrapper.__doc__ = msg
  78     return deprecatedWrapper
  79
  80
  81 #----------------------------------------------------------------------------
  82
  83 NOT_FOUND = _core_.NOT_FOUND
  84 VSCROLL = _core_.VSCROLL
  85 HSCROLL = _core_.HSCROLL
  86 CAPTION = _core_.CAPTION
  87 DOUBLE_BORDER = _core_.DOUBLE_BORDER
  88 SUNKEN_BORDER = _core_.SUNKEN_BORDER
  89 RAISED_BORDER = _core_.RAISED_BORDER
  90 BORDER = _core_.BORDER
  91 SIMPLE_BORDER = _core_.SIMPLE_BORDER
  92 STATIC_BORDER = _core_.STATIC_BORDER
  93 TRANSPARENT_WINDOW = _core_.TRANSPARENT_WINDOW
  94 NO_BORDER = _core_.NO_BORDER
  95 DEFAULT_CONTROL_BORDER = _core_.DEFAULT_CONTROL_BORDER
  96 DEFAULT_STATUSBAR_STYLE = _core_.DEFAULT_STATUSBAR_STYLE
  97 TAB_TRAVERSAL = _core_.TAB_TRAVERSAL
  98 WANTS_CHARS = _core_.WANTS_CHARS
  99 POPUP_WINDOW = _core_.POPUP_WINDOW
 100 CENTER_FRAME = _core_.CENTER_FRAME
 101 CENTRE_ON_SCREEN = _core_.CENTRE_ON_SCREEN
 102 CENTER_ON_SCREEN = _core_.CENTER_ON_SCREEN
 103 CLIP_CHILDREN = _core_.CLIP_CHILDREN
 104 CLIP_SIBLINGS = _core_.CLIP_SIBLINGS
 105 WINDOW_STYLE_MASK = _core_.WINDOW_STYLE_MASK
 106 ALWAYS_SHOW_SB = _core_.ALWAYS_SHOW_SB
 107 RETAINED = _core_.RETAINED
 108 BACKINGSTORE = _core_.BACKINGSTORE
 109 COLOURED = _core_.COLOURED
 110 FIXED_LENGTH = _core_.FIXED_LENGTH
 111 LB_NEEDED_SB = _core_.LB_NEEDED_SB
 112 LB_ALWAYS_SB = _core_.LB_ALWAYS_SB
 113 LB_SORT = _core_.LB_SORT
 114 LB_SINGLE = _core_.LB_SINGLE
 115 LB_MULTIPLE = _core_.LB_MULTIPLE
 116 LB_EXTENDED = _core_.LB_EXTENDED
 117 LB_OWNERDRAW = _core_.LB_OWNERDRAW
 118 LB_HSCROLL = _core_.LB_HSCROLL
 119 PROCESS_ENTER = _core_.PROCESS_ENTER
 120 PASSWORD = _core_.PASSWORD
 121 CB_SIMPLE = _core_.CB_SIMPLE
 122 CB_DROPDOWN = _core_.CB_DROPDOWN
 123 CB_SORT = _core_.CB_SORT
 124 CB_READONLY = _core_.CB_READONLY
 125 RA_HORIZONTAL = _core_.RA_HORIZONTAL
 126 RA_VERTICAL = _core_.RA_VERTICAL
 127 RA_SPECIFY_ROWS = _core_.RA_SPECIFY_ROWS
 128 RA_SPECIFY_COLS = _core_.RA_SPECIFY_COLS
 129 RA_USE_CHECKBOX = _core_.RA_USE_CHECKBOX
 130 RB_GROUP = _core_.RB_GROUP
 131 RB_SINGLE = _core_.RB_SINGLE
 132 SB_HORIZONTAL = _core_.SB_HORIZONTAL
 133 SB_VERTICAL = _core_.SB_VERTICAL
 134 RB_USE_CHECKBOX = _core_.RB_USE_CHECKBOX
 135 ST_SIZEGRIP = _core_.ST_SIZEGRIP
 136 ST_NO_AUTORESIZE = _core_.ST_NO_AUTORESIZE
 137 ST_DOTS_MIDDLE = _core_.ST_DOTS_MIDDLE
 138 ST_DOTS_END = _core_.ST_DOTS_END
 139 FLOOD_SURFACE = _core_.FLOOD_SURFACE
 140 FLOOD_BORDER = _core_.FLOOD_BORDER
 141 ODDEVEN_RULE = _core_.ODDEVEN_RULE
 142 WINDING_RULE = _core_.WINDING_RULE
 143 TOOL_TOP = _core_.TOOL_TOP
 144 TOOL_BOTTOM = _core_.TOOL_BOTTOM
 145 TOOL_LEFT = _core_.TOOL_LEFT
 146 TOOL_RIGHT = _core_.TOOL_RIGHT
 147 OK = _core_.OK
 148 YES_NO = _core_.YES_NO
 149 CANCEL = _core_.CANCEL
 150 YES = _core_.YES
 151 NO = _core_.NO
 152 NO_DEFAULT = _core_.NO_DEFAULT
 153 YES_DEFAULT = _core_.YES_DEFAULT
 154 ICON_EXCLAMATION = _core_.ICON_EXCLAMATION
 155 ICON_HAND = _core_.ICON_HAND
 156 ICON_QUESTION = _core_.ICON_QUESTION
 157 ICON_INFORMATION = _core_.ICON_INFORMATION
 158 ICON_STOP = _core_.ICON_STOP
 159 ICON_ASTERISK = _core_.ICON_ASTERISK
 160 ICON_MASK = _core_.ICON_MASK
 161 ICON_WARNING = _core_.ICON_WARNING
 162 ICON_ERROR = _core_.ICON_ERROR
 163 FORWARD = _core_.FORWARD
 164 BACKWARD = _core_.BACKWARD
 165 RESET = _core_.RESET
 166 HELP = _core_.HELP
 167 MORE = _core_.MORE
 168 SETUP = _core_.SETUP
 169 SIZE_AUTO_WIDTH = _core_.SIZE_AUTO_WIDTH
 170 SIZE_AUTO_HEIGHT = _core_.SIZE_AUTO_HEIGHT
 171 SIZE_AUTO = _core_.SIZE_AUTO
 172 SIZE_USE_EXISTING = _core_.SIZE_USE_EXISTING
 173 SIZE_ALLOW_MINUS_ONE = _core_.SIZE_ALLOW_MINUS_ONE
 174 SIZE_FORCE = _core_.SIZE_FORCE
 175 PORTRAIT = _core_.PORTRAIT
 176 LANDSCAPE = _core_.LANDSCAPE
 177 PRINT_QUALITY_HIGH = _core_.PRINT_QUALITY_HIGH
 178 PRINT_QUALITY_MEDIUM = _core_.PRINT_QUALITY_MEDIUM
 179 PRINT_QUALITY_LOW = _core_.PRINT_QUALITY_LOW
 180 PRINT_QUALITY_DRAFT = _core_.PRINT_QUALITY_DRAFT
 181 ID_ANY = _core_.ID_ANY
 182 ID_SEPARATOR = _core_.ID_SEPARATOR
 183 ID_NONE = _core_.ID_NONE
 184 ID_LOWEST = _core_.ID_LOWEST
 185 ID_OPEN = _core_.ID_OPEN
 186 ID_CLOSE = _core_.ID_CLOSE
 187 ID_NEW = _core_.ID_NEW
 188 ID_SAVE = _core_.ID_SAVE
 189 ID_SAVEAS = _core_.ID_SAVEAS
 190 ID_REVERT = _core_.ID_REVERT
 191 ID_EXIT = _core_.ID_EXIT
 192 ID_UNDO = _core_.ID_UNDO
 193 ID_REDO = _core_.ID_REDO
 194 ID_HELP = _core_.ID_HELP
 195 ID_PRINT = _core_.ID_PRINT
 196 ID_PRINT_SETUP = _core_.ID_PRINT_SETUP
 197 ID_PREVIEW = _core_.ID_PREVIEW
 198 ID_ABOUT = _core_.ID_ABOUT
 199 ID_HELP_CONTENTS = _core_.ID_HELP_CONTENTS
 200 ID_HELP_COMMANDS = _core_.ID_HELP_COMMANDS
 201 ID_HELP_PROCEDURES = _core_.ID_HELP_PROCEDURES
 202 ID_HELP_CONTEXT = _core_.ID_HELP_CONTEXT
 203 ID_HELP_INDEX = _core_.ID_HELP_INDEX
 204 ID_HELP_SEARCH = _core_.ID_HELP_SEARCH
 205 ID_CLOSE_ALL = _core_.ID_CLOSE_ALL
 206 ID_PREFERENCES = _core_.ID_PREFERENCES
 207 ID_CUT = _core_.ID_CUT
 208 ID_COPY = _core_.ID_COPY
 209 ID_PASTE = _core_.ID_PASTE
 210 ID_CLEAR = _core_.ID_CLEAR
 211 ID_FIND = _core_.ID_FIND
 212 ID_DUPLICATE = _core_.ID_DUPLICATE
 213 ID_SELECTALL = _core_.ID_SELECTALL
 214 ID_DELETE = _core_.ID_DELETE
 215 ID_REPLACE = _core_.ID_REPLACE
 216 ID_REPLACE_ALL = _core_.ID_REPLACE_ALL
 217 ID_PROPERTIES = _core_.ID_PROPERTIES
 218 ID_VIEW_DETAILS = _core_.ID_VIEW_DETAILS
 219 ID_VIEW_LARGEICONS = _core_.ID_VIEW_LARGEICONS
 220 ID_VIEW_SMALLICONS = _core_.ID_VIEW_SMALLICONS
 221 ID_VIEW_LIST = _core_.ID_VIEW_LIST
 222 ID_VIEW_SORTDATE = _core_.ID_VIEW_SORTDATE
 223 ID_VIEW_SORTNAME = _core_.ID_VIEW_SORTNAME
 224 ID_VIEW_SORTSIZE = _core_.ID_VIEW_SORTSIZE
 225 ID_VIEW_SORTTYPE = _core_.ID_VIEW_SORTTYPE
 226 ID_FILE1 = _core_.ID_FILE1
 227 ID_FILE2 = _core_.ID_FILE2
 228 ID_FILE3 = _core_.ID_FILE3
 229 ID_FILE4 = _core_.ID_FILE4
 230 ID_FILE5 = _core_.ID_FILE5
 231 ID_FILE6 = _core_.ID_FILE6
 232 ID_FILE7 = _core_.ID_FILE7
 233 ID_FILE8 = _core_.ID_FILE8
 234 ID_FILE9 = _core_.ID_FILE9
 235 ID_OK = _core_.ID_OK
 236 ID_CANCEL = _core_.ID_CANCEL
 237 ID_APPLY = _core_.ID_APPLY
 238 ID_YES = _core_.ID_YES
 239 ID_NO = _core_.ID_NO
 240 ID_STATIC = _core_.ID_STATIC
 241 ID_FORWARD = _core_.ID_FORWARD
 242 ID_BACKWARD = _core_.ID_BACKWARD
 243 ID_DEFAULT = _core_.ID_DEFAULT
 244 ID_MORE = _core_.ID_MORE
 245 ID_SETUP = _core_.ID_SETUP
 246 ID_RESET = _core_.ID_RESET
 247 ID_CONTEXT_HELP = _core_.ID_CONTEXT_HELP
 248 ID_YESTOALL = _core_.ID_YESTOALL
 249 ID_NOTOALL = _core_.ID_NOTOALL
 250 ID_ABORT = _core_.ID_ABORT
 251 ID_RETRY = _core_.ID_RETRY
 252 ID_IGNORE = _core_.ID_IGNORE
 253 ID_ADD = _core_.ID_ADD
 254 ID_REMOVE = _core_.ID_REMOVE
 255 ID_UP = _core_.ID_UP
 256 ID_DOWN = _core_.ID_DOWN
 257 ID_HOME = _core_.ID_HOME
 258 ID_REFRESH = _core_.ID_REFRESH
 259 ID_STOP = _core_.ID_STOP
 260 ID_INDEX = _core_.ID_INDEX
 261 ID_BOLD = _core_.ID_BOLD
 262 ID_ITALIC = _core_.ID_ITALIC
 263 ID_JUSTIFY_CENTER = _core_.ID_JUSTIFY_CENTER
 264 ID_JUSTIFY_FILL = _core_.ID_JUSTIFY_FILL
 265 ID_JUSTIFY_RIGHT = _core_.ID_JUSTIFY_RIGHT
 266 ID_JUSTIFY_LEFT = _core_.ID_JUSTIFY_LEFT
 267 ID_UNDERLINE = _core_.ID_UNDERLINE
 268 ID_INDENT = _core_.ID_INDENT
 269 ID_UNINDENT = _core_.ID_UNINDENT
 270 ID_ZOOM_100 = _core_.ID_ZOOM_100
 271 ID_ZOOM_FIT = _core_.ID_ZOOM_FIT
 272 ID_ZOOM_IN = _core_.ID_ZOOM_IN
 273 ID_ZOOM_OUT = _core_.ID_ZOOM_OUT
 274 ID_UNDELETE = _core_.ID_UNDELETE
 275 ID_REVERT_TO_SAVED = _core_.ID_REVERT_TO_SAVED
 276 ID_HIGHEST = _core_.ID_HIGHEST
 277 ACCEL_ALT = _core_.ACCEL_ALT
 278 ACCEL_CTRL = _core_.ACCEL_CTRL
 279 ACCEL_SHIFT = _core_.ACCEL_SHIFT
 280 ACCEL_NORMAL = _core_.ACCEL_NORMAL
 281 PD_AUTO_HIDE = _core_.PD_AUTO_HIDE
 282 PD_APP_MODAL = _core_.PD_APP_MODAL
 283 PD_CAN_ABORT = _core_.PD_CAN_ABORT
 284 PD_ELAPSED_TIME = _core_.PD_ELAPSED_TIME
 285 PD_ESTIMATED_TIME = _core_.PD_ESTIMATED_TIME
 286 PD_REMAINING_TIME = _core_.PD_REMAINING_TIME
 287 PD_SMOOTH = _core_.PD_SMOOTH
 288 PD_CAN_SKIP = _core_.PD_CAN_SKIP
 289 MENU_TEAROFF = _core_.MENU_TEAROFF
 290 MB_DOCKABLE = _core_.MB_DOCKABLE
 291 NO_FULL_REPAINT_ON_RESIZE = _core_.NO_FULL_REPAINT_ON_RESIZE
 292 FULL_REPAINT_ON_RESIZE = _core_.FULL_REPAINT_ON_RESIZE
 293 LI_HORIZONTAL = _core_.LI_HORIZONTAL
 294 LI_VERTICAL = _core_.LI_VERTICAL
 295 WS_EX_VALIDATE_RECURSIVELY = _core_.WS_EX_VALIDATE_RECURSIVELY
 296 WS_EX_BLOCK_EVENTS = _core_.WS_EX_BLOCK_EVENTS
 297 WS_EX_TRANSIENT = _core_.WS_EX_TRANSIENT
 298 WS_EX_THEMED_BACKGROUND = _core_.WS_EX_THEMED_BACKGROUND
 299 WS_EX_PROCESS_IDLE = _core_.WS_EX_PROCESS_IDLE
 300 WS_EX_PROCESS_UI_UPDATES = _core_.WS_EX_PROCESS_UI_UPDATES
 301 MM_TEXT = _core_.MM_TEXT
 302 MM_LOMETRIC = _core_.MM_LOMETRIC
 303 MM_HIMETRIC = _core_.MM_HIMETRIC
 304 MM_LOENGLISH = _core_.MM_LOENGLISH
 305 MM_HIENGLISH = _core_.MM_HIENGLISH
 306 MM_TWIPS = _core_.MM_TWIPS
 307 MM_ISOTROPIC = _core_.MM_ISOTROPIC
 308 MM_ANISOTROPIC = _core_.MM_ANISOTROPIC
 309 MM_POINTS = _core_.MM_POINTS
 310 MM_METRIC = _core_.MM_METRIC
 311 CENTRE = _core_.CENTRE
 312 CENTER = _core_.CENTER
 313 HORIZONTAL = _core_.HORIZONTAL
 314 VERTICAL = _core_.VERTICAL
 315 BOTH = _core_.BOTH
 316 LEFT = _core_.LEFT
 317 RIGHT = _core_.RIGHT
 318 UP = _core_.UP
 319 DOWN = _core_.DOWN
 320 TOP = _core_.TOP
 321 BOTTOM = _core_.BOTTOM
 322 NORTH = _core_.NORTH
 323 SOUTH = _core_.SOUTH
 324 WEST = _core_.WEST
 325 EAST = _core_.EAST
 326 ALL = _core_.ALL
 327 ALIGN_NOT = _core_.ALIGN_NOT
 328 ALIGN_CENTER_HORIZONTAL = _core_.ALIGN_CENTER_HORIZONTAL
 329 ALIGN_CENTRE_HORIZONTAL = _core_.ALIGN_CENTRE_HORIZONTAL
 330 ALIGN_LEFT = _core_.ALIGN_LEFT
 331 ALIGN_TOP = _core_.ALIGN_TOP
 332 ALIGN_RIGHT = _core_.ALIGN_RIGHT
 333 ALIGN_BOTTOM = _core_.ALIGN_BOTTOM
 334 ALIGN_CENTER_VERTICAL = _core_.ALIGN_CENTER_VERTICAL
 335 ALIGN_CENTRE_VERTICAL = _core_.ALIGN_CENTRE_VERTICAL
 336 ALIGN_CENTER = _core_.ALIGN_CENTER
 337 ALIGN_CENTRE = _core_.ALIGN_CENTRE
 338 ALIGN_MASK = _core_.ALIGN_MASK
 339 STRETCH_NOT = _core_.STRETCH_NOT
 340 SHRINK = _core_.SHRINK
 341 GROW = _core_.GROW
 342 EXPAND = _core_.EXPAND
 343 SHAPED = _core_.SHAPED
 344 FIXED_MINSIZE = _core_.FIXED_MINSIZE
 345 TILE = _core_.TILE
 346 ADJUST_MINSIZE = _core_.ADJUST_MINSIZE
 347 BORDER_DEFAULT = _core_.BORDER_DEFAULT
 348 BORDER_NONE = _core_.BORDER_NONE
 349 BORDER_STATIC = _core_.BORDER_STATIC
 350 BORDER_SIMPLE = _core_.BORDER_SIMPLE
 351 BORDER_RAISED = _core_.BORDER_RAISED
 352 BORDER_SUNKEN = _core_.BORDER_SUNKEN
 353 BORDER_DOUBLE = _core_.BORDER_DOUBLE
 354 BORDER_MASK = _core_.BORDER_MASK
 355 BG_STYLE_SYSTEM = _core_.BG_STYLE_SYSTEM
 356 BG_STYLE_COLOUR = _core_.BG_STYLE_COLOUR
 357 BG_STYLE_CUSTOM = _core_.BG_STYLE_CUSTOM
 358 DEFAULT = _core_.DEFAULT
 359 DECORATIVE = _core_.DECORATIVE
 360 ROMAN = _core_.ROMAN
 361 SCRIPT = _core_.SCRIPT
 362 SWISS = _core_.SWISS
 363 MODERN = _core_.MODERN
 364 TELETYPE = _core_.TELETYPE
 365 VARIABLE = _core_.VARIABLE
 366 FIXED = _core_.FIXED
 367 NORMAL = _core_.NORMAL
 368 LIGHT = _core_.LIGHT
 369 BOLD = _core_.BOLD
 370 ITALIC = _core_.ITALIC
 371 SLANT = _core_.SLANT
 372 SOLID = _core_.SOLID
 373 DOT = _core_.DOT
 374 LONG_DASH = _core_.LONG_DASH
 375 SHORT_DASH = _core_.SHORT_DASH
 376 DOT_DASH = _core_.DOT_DASH
 377 USER_DASH = _core_.USER_DASH
 378 TRANSPARENT = _core_.TRANSPARENT
 379 STIPPLE = _core_.STIPPLE
 380 STIPPLE_MASK = _core_.STIPPLE_MASK
 381 STIPPLE_MASK_OPAQUE = _core_.STIPPLE_MASK_OPAQUE
 382 BDIAGONAL_HATCH = _core_.BDIAGONAL_HATCH
 383 CROSSDIAG_HATCH = _core_.CROSSDIAG_HATCH
 384 FDIAGONAL_HATCH = _core_.FDIAGONAL_HATCH
 385 CROSS_HATCH = _core_.CROSS_HATCH
 386 HORIZONTAL_HATCH = _core_.HORIZONTAL_HATCH
 387 VERTICAL_HATCH = _core_.VERTICAL_HATCH
 388 JOIN_BEVEL = _core_.JOIN_BEVEL
 389 JOIN_MITER = _core_.JOIN_MITER
 390 JOIN_ROUND = _core_.JOIN_ROUND
 391 CAP_ROUND = _core_.CAP_ROUND
 392 CAP_PROJECTING = _core_.CAP_PROJECTING
 393 CAP_BUTT = _core_.CAP_BUTT
 394 CLEAR = _core_.CLEAR
 395 XOR = _core_.XOR
 396 INVERT = _core_.INVERT
 397 OR_REVERSE = _core_.OR_REVERSE
 398 AND_REVERSE = _core_.AND_REVERSE
 399 COPY = _core_.COPY
 400 AND = _core_.AND
 401 AND_INVERT = _core_.AND_INVERT
 402 NO_OP = _core_.NO_OP
 403 NOR = _core_.NOR
 404 EQUIV = _core_.EQUIV
 405 SRC_INVERT = _core_.SRC_INVERT
 406 OR_INVERT = _core_.OR_INVERT
 407 NAND = _core_.NAND
 408 OR = _core_.OR
 409 SET = _core_.SET
 410 WXK_BACK = _core_.WXK_BACK
 411 WXK_TAB = _core_.WXK_TAB
 412 WXK_RETURN = _core_.WXK_RETURN
 413 WXK_ESCAPE = _core_.WXK_ESCAPE
 414 WXK_SPACE = _core_.WXK_SPACE
 415 WXK_DELETE = _core_.WXK_DELETE
 416 WXK_START = _core_.WXK_START
 417 WXK_LBUTTON = _core_.WXK_LBUTTON
 418 WXK_RBUTTON = _core_.WXK_RBUTTON
 419 WXK_CANCEL = _core_.WXK_CANCEL
 420 WXK_MBUTTON = _core_.WXK_MBUTTON
 421 WXK_CLEAR = _core_.WXK_CLEAR
 422 WXK_SHIFT = _core_.WXK_SHIFT
 423 WXK_ALT = _core_.WXK_ALT
 424 WXK_CONTROL = _core_.WXK_CONTROL
 425 WXK_MENU = _core_.WXK_MENU
 426 WXK_PAUSE = _core_.WXK_PAUSE
 427 WXK_CAPITAL = _core_.WXK_CAPITAL
 428 WXK_PRIOR = _core_.WXK_PRIOR
 429 WXK_NEXT = _core_.WXK_NEXT
 430 WXK_END = _core_.WXK_END
 431 WXK_HOME = _core_.WXK_HOME
 432 WXK_LEFT = _core_.WXK_LEFT
 433 WXK_UP = _core_.WXK_UP
 434 WXK_RIGHT = _core_.WXK_RIGHT
 435 WXK_DOWN = _core_.WXK_DOWN
 436 WXK_SELECT = _core_.WXK_SELECT
 437 WXK_PRINT = _core_.WXK_PRINT
 438 WXK_EXECUTE = _core_.WXK_EXECUTE
 439 WXK_SNAPSHOT = _core_.WXK_SNAPSHOT
 440 WXK_INSERT = _core_.WXK_INSERT
 441 WXK_HELP = _core_.WXK_HELP
 442 WXK_NUMPAD0 = _core_.WXK_NUMPAD0
 443 WXK_NUMPAD1 = _core_.WXK_NUMPAD1
 444 WXK_NUMPAD2 = _core_.WXK_NUMPAD2
 445 WXK_NUMPAD3 = _core_.WXK_NUMPAD3
 446 WXK_NUMPAD4 = _core_.WXK_NUMPAD4
 447 WXK_NUMPAD5 = _core_.WXK_NUMPAD5
 448 WXK_NUMPAD6 = _core_.WXK_NUMPAD6
 449 WXK_NUMPAD7 = _core_.WXK_NUMPAD7
 450 WXK_NUMPAD8 = _core_.WXK_NUMPAD8
 451 WXK_NUMPAD9 = _core_.WXK_NUMPAD9
 452 WXK_MULTIPLY = _core_.WXK_MULTIPLY
 453 WXK_ADD = _core_.WXK_ADD
 454 WXK_SEPARATOR = _core_.WXK_SEPARATOR
 455 WXK_SUBTRACT = _core_.WXK_SUBTRACT
 456 WXK_DECIMAL = _core_.WXK_DECIMAL
 457 WXK_DIVIDE = _core_.WXK_DIVIDE
 458 WXK_F1 = _core_.WXK_F1
 459 WXK_F2 = _core_.WXK_F2
 460 WXK_F3 = _core_.WXK_F3
 461 WXK_F4 = _core_.WXK_F4
 462 WXK_F5 = _core_.WXK_F5
 463 WXK_F6 = _core_.WXK_F6
 464 WXK_F7 = _core_.WXK_F7
 465 WXK_F8 = _core_.WXK_F8
 466 WXK_F9 = _core_.WXK_F9
 467 WXK_F10 = _core_.WXK_F10
 468 WXK_F11 = _core_.WXK_F11
 469 WXK_F12 = _core_.WXK_F12
 470 WXK_F13 = _core_.WXK_F13
 471 WXK_F14 = _core_.WXK_F14
 472 WXK_F15 = _core_.WXK_F15
 473 WXK_F16 = _core_.WXK_F16
 474 WXK_F17 = _core_.WXK_F17
 475 WXK_F18 = _core_.WXK_F18
 476 WXK_F19 = _core_.WXK_F19
 477 WXK_F20 = _core_.WXK_F20
 478 WXK_F21 = _core_.WXK_F21
 479 WXK_F22 = _core_.WXK_F22
 480 WXK_F23 = _core_.WXK_F23
 481 WXK_F24 = _core_.WXK_F24
 482 WXK_NUMLOCK = _core_.WXK_NUMLOCK
 483 WXK_SCROLL = _core_.WXK_SCROLL
 484 WXK_PAGEUP = _core_.WXK_PAGEUP
 485 WXK_PAGEDOWN = _core_.WXK_PAGEDOWN
 486 WXK_NUMPAD_SPACE = _core_.WXK_NUMPAD_SPACE
 487 WXK_NUMPAD_TAB = _core_.WXK_NUMPAD_TAB
 488 WXK_NUMPAD_ENTER = _core_.WXK_NUMPAD_ENTER
 489 WXK_NUMPAD_F1 = _core_.WXK_NUMPAD_F1
 490 WXK_NUMPAD_F2 = _core_.WXK_NUMPAD_F2
 491 WXK_NUMPAD_F3 = _core_.WXK_NUMPAD_F3
 492 WXK_NUMPAD_F4 = _core_.WXK_NUMPAD_F4
 493 WXK_NUMPAD_HOME = _core_.WXK_NUMPAD_HOME
 494 WXK_NUMPAD_LEFT = _core_.WXK_NUMPAD_LEFT
 495 WXK_NUMPAD_UP = _core_.WXK_NUMPAD_UP
 496 WXK_NUMPAD_RIGHT = _core_.WXK_NUMPAD_RIGHT
 497 WXK_NUMPAD_DOWN = _core_.WXK_NUMPAD_DOWN
 498 WXK_NUMPAD_PRIOR = _core_.WXK_NUMPAD_PRIOR
 499 WXK_NUMPAD_PAGEUP = _core_.WXK_NUMPAD_PAGEUP
 500 WXK_NUMPAD_NEXT = _core_.WXK_NUMPAD_NEXT
 501 WXK_NUMPAD_PAGEDOWN = _core_.WXK_NUMPAD_PAGEDOWN
 502 WXK_NUMPAD_END = _core_.WXK_NUMPAD_END
 503 WXK_NUMPAD_BEGIN = _core_.WXK_NUMPAD_BEGIN
 504 WXK_NUMPAD_INSERT = _core_.WXK_NUMPAD_INSERT
 505 WXK_NUMPAD_DELETE = _core_.WXK_NUMPAD_DELETE
 506 WXK_NUMPAD_EQUAL = _core_.WXK_NUMPAD_EQUAL
 507 WXK_NUMPAD_MULTIPLY = _core_.WXK_NUMPAD_MULTIPLY
 508 WXK_NUMPAD_ADD = _core_.WXK_NUMPAD_ADD
 509 WXK_NUMPAD_SEPARATOR = _core_.WXK_NUMPAD_SEPARATOR
 510 WXK_NUMPAD_SUBTRACT = _core_.WXK_NUMPAD_SUBTRACT
 511 WXK_NUMPAD_DECIMAL = _core_.WXK_NUMPAD_DECIMAL
 512 WXK_NUMPAD_DIVIDE = _core_.WXK_NUMPAD_DIVIDE
 513 WXK_WINDOWS_LEFT = _core_.WXK_WINDOWS_LEFT
 514 WXK_WINDOWS_RIGHT = _core_.WXK_WINDOWS_RIGHT
 515 WXK_WINDOWS_MENU = _core_.WXK_WINDOWS_MENU
 516 WXK_COMMAND = _core_.WXK_COMMAND
 517 WXK_SPECIAL1 = _core_.WXK_SPECIAL1
 518 WXK_SPECIAL2 = _core_.WXK_SPECIAL2
 519 WXK_SPECIAL3 = _core_.WXK_SPECIAL3
 520 WXK_SPECIAL4 = _core_.WXK_SPECIAL4
 521 WXK_SPECIAL5 = _core_.WXK_SPECIAL5
 522 WXK_SPECIAL6 = _core_.WXK_SPECIAL6
 523 WXK_SPECIAL7 = _core_.WXK_SPECIAL7
 524 WXK_SPECIAL8 = _core_.WXK_SPECIAL8
 525 WXK_SPECIAL9 = _core_.WXK_SPECIAL9
 526 WXK_SPECIAL10 = _core_.WXK_SPECIAL10
 527 WXK_SPECIAL11 = _core_.WXK_SPECIAL11
 528 WXK_SPECIAL12 = _core_.WXK_SPECIAL12
 529 WXK_SPECIAL13 = _core_.WXK_SPECIAL13
 530 WXK_SPECIAL14 = _core_.WXK_SPECIAL14
 531 WXK_SPECIAL15 = _core_.WXK_SPECIAL15
 532 WXK_SPECIAL16 = _core_.WXK_SPECIAL16
 533 WXK_SPECIAL17 = _core_.WXK_SPECIAL17
 534 WXK_SPECIAL18 = _core_.WXK_SPECIAL18
 535 WXK_SPECIAL19 = _core_.WXK_SPECIAL19
 536 WXK_SPECIAL20 = _core_.WXK_SPECIAL20
 537 PAPER_NONE = _core_.PAPER_NONE
 538 PAPER_LETTER = _core_.PAPER_LETTER
 539 PAPER_LEGAL = _core_.PAPER_LEGAL
 540 PAPER_A4 = _core_.PAPER_A4
 541 PAPER_CSHEET = _core_.PAPER_CSHEET
 542 PAPER_DSHEET = _core_.PAPER_DSHEET
 543 PAPER_ESHEET = _core_.PAPER_ESHEET
 544 PAPER_LETTERSMALL = _core_.PAPER_LETTERSMALL
 545 PAPER_TABLOID = _core_.PAPER_TABLOID
 546 PAPER_LEDGER = _core_.PAPER_LEDGER
 547 PAPER_STATEMENT = _core_.PAPER_STATEMENT
 548 PAPER_EXECUTIVE = _core_.PAPER_EXECUTIVE
 549 PAPER_A3 = _core_.PAPER_A3
 550 PAPER_A4SMALL = _core_.PAPER_A4SMALL
 551 PAPER_A5 = _core_.PAPER_A5
 552 PAPER_B4 = _core_.PAPER_B4
 553 PAPER_B5 = _core_.PAPER_B5
 554 PAPER_FOLIO = _core_.PAPER_FOLIO
 555 PAPER_QUARTO = _core_.PAPER_QUARTO
 556 PAPER_10X14 = _core_.PAPER_10X14
 557 PAPER_11X17 = _core_.PAPER_11X17
 558 PAPER_NOTE = _core_.PAPER_NOTE
 559 PAPER_ENV_9 = _core_.PAPER_ENV_9
 560 PAPER_ENV_10 = _core_.PAPER_ENV_10
 561 PAPER_ENV_11 = _core_.PAPER_ENV_11
 562 PAPER_ENV_12 = _core_.PAPER_ENV_12
 563 PAPER_ENV_14 = _core_.PAPER_ENV_14
 564 PAPER_ENV_DL = _core_.PAPER_ENV_DL
 565 PAPER_ENV_C5 = _core_.PAPER_ENV_C5
 566 PAPER_ENV_C3 = _core_.PAPER_ENV_C3
 567 PAPER_ENV_C4 = _core_.PAPER_ENV_C4
 568 PAPER_ENV_C6 = _core_.PAPER_ENV_C6
 569 PAPER_ENV_C65 = _core_.PAPER_ENV_C65
 570 PAPER_ENV_B4 = _core_.PAPER_ENV_B4
 571 PAPER_ENV_B5 = _core_.PAPER_ENV_B5
 572 PAPER_ENV_B6 = _core_.PAPER_ENV_B6
 573 PAPER_ENV_ITALY = _core_.PAPER_ENV_ITALY
 574 PAPER_ENV_MONARCH = _core_.PAPER_ENV_MONARCH
 575 PAPER_ENV_PERSONAL = _core_.PAPER_ENV_PERSONAL
 576 PAPER_FANFOLD_US = _core_.PAPER_FANFOLD_US
 577 PAPER_FANFOLD_STD_GERMAN = _core_.PAPER_FANFOLD_STD_GERMAN
 578 PAPER_FANFOLD_LGL_GERMAN = _core_.PAPER_FANFOLD_LGL_GERMAN
 579 PAPER_ISO_B4 = _core_.PAPER_ISO_B4
 580 PAPER_JAPANESE_POSTCARD = _core_.PAPER_JAPANESE_POSTCARD
 581 PAPER_9X11 = _core_.PAPER_9X11
 582 PAPER_10X11 = _core_.PAPER_10X11
 583 PAPER_15X11 = _core_.PAPER_15X11
 584 PAPER_ENV_INVITE = _core_.PAPER_ENV_INVITE
 585 PAPER_LETTER_EXTRA = _core_.PAPER_LETTER_EXTRA
 586 PAPER_LEGAL_EXTRA = _core_.PAPER_LEGAL_EXTRA
 587 PAPER_TABLOID_EXTRA = _core_.PAPER_TABLOID_EXTRA
 588 PAPER_A4_EXTRA = _core_.PAPER_A4_EXTRA
 589 PAPER_LETTER_TRANSVERSE = _core_.PAPER_LETTER_TRANSVERSE
 590 PAPER_A4_TRANSVERSE = _core_.PAPER_A4_TRANSVERSE
 591 PAPER_LETTER_EXTRA_TRANSVERSE = _core_.PAPER_LETTER_EXTRA_TRANSVERSE
 592 PAPER_A_PLUS = _core_.PAPER_A_PLUS
 593 PAPER_B_PLUS = _core_.PAPER_B_PLUS
 594 PAPER_LETTER_PLUS = _core_.PAPER_LETTER_PLUS
 595 PAPER_A4_PLUS = _core_.PAPER_A4_PLUS
 596 PAPER_A5_TRANSVERSE = _core_.PAPER_A5_TRANSVERSE
 597 PAPER_B5_TRANSVERSE = _core_.PAPER_B5_TRANSVERSE
 598 PAPER_A3_EXTRA = _core_.PAPER_A3_EXTRA
 599 PAPER_A5_EXTRA = _core_.PAPER_A5_EXTRA
 600 PAPER_B5_EXTRA = _core_.PAPER_B5_EXTRA
 601 PAPER_A2 = _core_.PAPER_A2
 602 PAPER_A3_TRANSVERSE = _core_.PAPER_A3_TRANSVERSE
 603 PAPER_A3_EXTRA_TRANSVERSE = _core_.PAPER_A3_EXTRA_TRANSVERSE
 604 PAPER_DBL_JAPANESE_POSTCARD = _core_.PAPER_DBL_JAPANESE_POSTCARD
 605 PAPER_A6 = _core_.PAPER_A6
 606 PAPER_JENV_KAKU2 = _core_.PAPER_JENV_KAKU2
 607 PAPER_JENV_KAKU3 = _core_.PAPER_JENV_KAKU3
 608 PAPER_JENV_CHOU3 = _core_.PAPER_JENV_CHOU3
 609 PAPER_JENV_CHOU4 = _core_.PAPER_JENV_CHOU4
 610 PAPER_LETTER_ROTATED = _core_.PAPER_LETTER_ROTATED
 611 PAPER_A3_ROTATED = _core_.PAPER_A3_ROTATED
 612 PAPER_A4_ROTATED = _core_.PAPER_A4_ROTATED
 613 PAPER_A5_ROTATED = _core_.PAPER_A5_ROTATED
 614 PAPER_B4_JIS_ROTATED = _core_.PAPER_B4_JIS_ROTATED
 615 PAPER_B5_JIS_ROTATED = _core_.PAPER_B5_JIS_ROTATED
 616 PAPER_JAPANESE_POSTCARD_ROTATED = _core_.PAPER_JAPANESE_POSTCARD_ROTATED
 617 PAPER_DBL_JAPANESE_POSTCARD_ROTATED = _core_.PAPER_DBL_JAPANESE_POSTCARD_ROTATED
 618 PAPER_A6_ROTATED = _core_.PAPER_A6_ROTATED
 619 PAPER_JENV_KAKU2_ROTATED = _core_.PAPER_JENV_KAKU2_ROTATED
 620 PAPER_JENV_KAKU3_ROTATED = _core_.PAPER_JENV_KAKU3_ROTATED
 621 PAPER_JENV_CHOU3_ROTATED = _core_.PAPER_JENV_CHOU3_ROTATED
 622 PAPER_JENV_CHOU4_ROTATED = _core_.PAPER_JENV_CHOU4_ROTATED
 623 PAPER_B6_JIS = _core_.PAPER_B6_JIS
 624 PAPER_B6_JIS_ROTATED = _core_.PAPER_B6_JIS_ROTATED
 625 PAPER_12X11 = _core_.PAPER_12X11
 626 PAPER_JENV_YOU4 = _core_.PAPER_JENV_YOU4
 627 PAPER_JENV_YOU4_ROTATED = _core_.PAPER_JENV_YOU4_ROTATED
 628 PAPER_P16K = _core_.PAPER_P16K
 629 PAPER_P32K = _core_.PAPER_P32K
 630 PAPER_P32KBIG = _core_.PAPER_P32KBIG
 631 PAPER_PENV_1 = _core_.PAPER_PENV_1
 632 PAPER_PENV_2 = _core_.PAPER_PENV_2
 633 PAPER_PENV_3 = _core_.PAPER_PENV_3
 634 PAPER_PENV_4 = _core_.PAPER_PENV_4
 635 PAPER_PENV_5 = _core_.PAPER_PENV_5
 636 PAPER_PENV_6 = _core_.PAPER_PENV_6
 637 PAPER_PENV_7 = _core_.PAPER_PENV_7
 638 PAPER_PENV_8 = _core_.PAPER_PENV_8
 639 PAPER_PENV_9 = _core_.PAPER_PENV_9
 640 PAPER_PENV_10 = _core_.PAPER_PENV_10
 641 PAPER_P16K_ROTATED = _core_.PAPER_P16K_ROTATED
 642 PAPER_P32K_ROTATED = _core_.PAPER_P32K_ROTATED
 643 PAPER_P32KBIG_ROTATED = _core_.PAPER_P32KBIG_ROTATED
 644 PAPER_PENV_1_ROTATED = _core_.PAPER_PENV_1_ROTATED
 645 PAPER_PENV_2_ROTATED = _core_.PAPER_PENV_2_ROTATED
 646 PAPER_PENV_3_ROTATED = _core_.PAPER_PENV_3_ROTATED
 647 PAPER_PENV_4_ROTATED = _core_.PAPER_PENV_4_ROTATED
 648 PAPER_PENV_5_ROTATED = _core_.PAPER_PENV_5_ROTATED
 649 PAPER_PENV_6_ROTATED = _core_.PAPER_PENV_6_ROTATED
 650 PAPER_PENV_7_ROTATED = _core_.PAPER_PENV_7_ROTATED
 651 PAPER_PENV_8_ROTATED = _core_.PAPER_PENV_8_ROTATED
 652 PAPER_PENV_9_ROTATED = _core_.PAPER_PENV_9_ROTATED
 653 PAPER_PENV_10_ROTATED = _core_.PAPER_PENV_10_ROTATED
 654 DUPLEX_SIMPLEX = _core_.DUPLEX_SIMPLEX
 655 DUPLEX_HORIZONTAL = _core_.DUPLEX_HORIZONTAL
 656 DUPLEX_VERTICAL = _core_.DUPLEX_VERTICAL
 657 ITEM_SEPARATOR = _core_.ITEM_SEPARATOR
 658 ITEM_NORMAL = _core_.ITEM_NORMAL
 659 ITEM_CHECK = _core_.ITEM_CHECK
 660 ITEM_RADIO = _core_.ITEM_RADIO
 661 ITEM_MAX = _core_.ITEM_MAX
 662 HT_NOWHERE = _core_.HT_NOWHERE
 663 HT_SCROLLBAR_FIRST = _core_.HT_SCROLLBAR_FIRST
 664 HT_SCROLLBAR_ARROW_LINE_1 = _core_.HT_SCROLLBAR_ARROW_LINE_1
 665 HT_SCROLLBAR_ARROW_LINE_2 = _core_.HT_SCROLLBAR_ARROW_LINE_2
 666 HT_SCROLLBAR_ARROW_PAGE_1 = _core_.HT_SCROLLBAR_ARROW_PAGE_1
 667 HT_SCROLLBAR_ARROW_PAGE_2 = _core_.HT_SCROLLBAR_ARROW_PAGE_2
 668 HT_SCROLLBAR_THUMB = _core_.HT_SCROLLBAR_THUMB
 669 HT_SCROLLBAR_BAR_1 = _core_.HT_SCROLLBAR_BAR_1
 670 HT_SCROLLBAR_BAR_2 = _core_.HT_SCROLLBAR_BAR_2
 671 HT_SCROLLBAR_LAST = _core_.HT_SCROLLBAR_LAST
 672 HT_WINDOW_OUTSIDE = _core_.HT_WINDOW_OUTSIDE
 673 HT_WINDOW_INSIDE = _core_.HT_WINDOW_INSIDE
 674 HT_WINDOW_VERT_SCROLLBAR = _core_.HT_WINDOW_VERT_SCROLLBAR
 675 HT_WINDOW_HORZ_SCROLLBAR = _core_.HT_WINDOW_HORZ_SCROLLBAR
 676 HT_WINDOW_CORNER = _core_.HT_WINDOW_CORNER
 677 HT_MAX = _core_.HT_MAX
 678 MOD_NONE = _core_.MOD_NONE
 679 MOD_ALT = _core_.MOD_ALT
 680 MOD_CONTROL = _core_.MOD_CONTROL
 681 MOD_ALTGR = _core_.MOD_ALTGR
 682 MOD_SHIFT = _core_.MOD_SHIFT
 683 MOD_META = _core_.MOD_META
 684 MOD_WIN = _core_.MOD_WIN
 685 MOD_CMD = _core_.MOD_CMD
 686 MOD_ALL = _core_.MOD_ALL
 687 UPDATE_UI_NONE = _core_.UPDATE_UI_NONE
 688 UPDATE_UI_RECURSE = _core_.UPDATE_UI_RECURSE
 689 UPDATE_UI_FROMIDLE = _core_.UPDATE_UI_FROMIDLE
 690 #---------------------------------------------------------------------------
 691
 692 class Object(object):
 693     """
 694     The base class for most wx objects, although in wxPython not
 695     much functionality is needed nor exposed.
 696     """
 697     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
 698     def __init__(self): raise AttributeError, "No constructor defined"
 699     __repr__ = _swig_repr
 700     def GetClassName(*args, **kwargs):
 701         """
 702         GetClassName(self) -> String
 703
 704         Returns the class name of the C++ class using wxRTTI.
 705         """
 706         return _core_.Object_GetClassName(*args, **kwargs)
 707
 708     def Destroy(*args, **kwargs):
 709         """
 710         Destroy(self)
 711
 712         Deletes the C++ object this Python object is a proxy for.
 713         """
 714         val = _core_.Object_Destroy(*args, **kwargs)
 715         args[0].thisown = 0
 716         return val
 717
 718 _core_.Object_swigregister(Object)
 719 _wxPySetDictionary = _core_._wxPySetDictionary
 720 cvar = _core_.cvar
 721 EmptyString = cvar.EmptyString
 722
 723 #---------------------------------------------------------------------------
 724
 725 BITMAP_TYPE_INVALID = _core_.BITMAP_TYPE_INVALID
 726 BITMAP_TYPE_BMP = _core_.BITMAP_TYPE_BMP
 727 BITMAP_TYPE_ICO = _core_.BITMAP_TYPE_ICO
 728 BITMAP_TYPE_CUR = _core_.BITMAP_TYPE_CUR
 729 BITMAP_TYPE_XBM = _core_.BITMAP_TYPE_XBM
 730 BITMAP_TYPE_XBM_DATA = _core_.BITMAP_TYPE_XBM_DATA
 731 BITMAP_TYPE_XPM = _core_.BITMAP_TYPE_XPM
 732 BITMAP_TYPE_XPM_DATA = _core_.BITMAP_TYPE_XPM_DATA
 733 BITMAP_TYPE_TIF = _core_.BITMAP_TYPE_TIF
 734 BITMAP_TYPE_GIF = _core_.BITMAP_TYPE_GIF
 735 BITMAP_TYPE_PNG = _core_.BITMAP_TYPE_PNG
 736 BITMAP_TYPE_JPEG = _core_.BITMAP_TYPE_JPEG
 737 BITMAP_TYPE_PNM = _core_.BITMAP_TYPE_PNM
 738 BITMAP_TYPE_PCX = _core_.BITMAP_TYPE_PCX
 739 BITMAP_TYPE_PICT = _core_.BITMAP_TYPE_PICT
 740 BITMAP_TYPE_ICON = _core_.BITMAP_TYPE_ICON
 741 BITMAP_TYPE_ANI = _core_.BITMAP_TYPE_ANI
 742 BITMAP_TYPE_IFF = _core_.BITMAP_TYPE_IFF
 743 BITMAP_TYPE_MACCURSOR = _core_.BITMAP_TYPE_MACCURSOR
 744 BITMAP_TYPE_ANY = _core_.BITMAP_TYPE_ANY
 745 CURSOR_NONE = _core_.CURSOR_NONE
 746 CURSOR_ARROW = _core_.CURSOR_ARROW
 747 CURSOR_RIGHT_ARROW = _core_.CURSOR_RIGHT_ARROW
 748 CURSOR_BULLSEYE = _core_.CURSOR_BULLSEYE
 749 CURSOR_CHAR = _core_.CURSOR_CHAR
 750 CURSOR_CROSS = _core_.CURSOR_CROSS
 751 CURSOR_HAND = _core_.CURSOR_HAND
 752 CURSOR_IBEAM = _core_.CURSOR_IBEAM
 753 CURSOR_LEFT_BUTTON = _core_.CURSOR_LEFT_BUTTON
 754 CURSOR_MAGNIFIER = _core_.CURSOR_MAGNIFIER
 755 CURSOR_MIDDLE_BUTTON = _core_.CURSOR_MIDDLE_BUTTON
 756 CURSOR_NO_ENTRY = _core_.CURSOR_NO_ENTRY
 757 CURSOR_PAINT_BRUSH = _core_.CURSOR_PAINT_BRUSH
 758 CURSOR_PENCIL = _core_.CURSOR_PENCIL
 759 CURSOR_POINT_LEFT = _core_.CURSOR_POINT_LEFT
 760 CURSOR_POINT_RIGHT = _core_.CURSOR_POINT_RIGHT
 761 CURSOR_QUESTION_ARROW = _core_.CURSOR_QUESTION_ARROW
 762 CURSOR_RIGHT_BUTTON = _core_.CURSOR_RIGHT_BUTTON
 763 CURSOR_SIZENESW = _core_.CURSOR_SIZENESW
 764 CURSOR_SIZENS = _core_.CURSOR_SIZENS
 765 CURSOR_SIZENWSE = _core_.CURSOR_SIZENWSE
 766 CURSOR_SIZEWE = _core_.CURSOR_SIZEWE
 767 CURSOR_SIZING = _core_.CURSOR_SIZING
 768 CURSOR_SPRAYCAN = _core_.CURSOR_SPRAYCAN
 769 CURSOR_WAIT = _core_.CURSOR_WAIT
 770 CURSOR_WATCH = _core_.CURSOR_WATCH
 771 CURSOR_BLANK = _core_.CURSOR_BLANK
 772 CURSOR_DEFAULT = _core_.CURSOR_DEFAULT
 773 CURSOR_COPY_ARROW = _core_.CURSOR_COPY_ARROW
 774 CURSOR_ARROWWAIT = _core_.CURSOR_ARROWWAIT
 775 CURSOR_MAX = _core_.CURSOR_MAX
 776 #---------------------------------------------------------------------------
 777
 778 class Size(object):
 779     """
 780     wx.Size is a useful data structure used to represent the size of
 781     something.  It simply contains integer width and height
 782     properties.  In most places in wxPython where a wx.Size is
 783     expected a (width, height) tuple can be used instead.
 784     """
 785     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
 786     __repr__ = _swig_repr
 787     width = property(_core_.Size_width_get, _core_.Size_width_set)
 788     height = property(_core_.Size_height_get, _core_.Size_height_set)
 789     x = width; y = height
 790     def __init__(self, *args, **kwargs):
 791         """
 792         __init__(self, int w=0, int h=0) -> Size
 793
 794         Creates a size object.
 795         """
 796         _core_.Size_swiginit(self,_core_.new_Size(*args, **kwargs))
 797     __swig_destroy__ = _core_.delete_Size
 798     __del__ = lambda self : None;
 799     def __eq__(*args, **kwargs):
 800         """
 801         __eq__(self, PyObject other) -> bool
 802
 803         Test for equality of wx.Size objects.
 804         """
 805         return _core_.Size___eq__(*args, **kwargs)
 806
 807     def __ne__(*args, **kwargs):
 808         """
 809         __ne__(self, PyObject other) -> bool
 810
 811         Test for inequality of wx.Size objects.
 812         """
 813         return _core_.Size___ne__(*args, **kwargs)
 814
 815     def __add__(*args, **kwargs):
 816         """
 817         __add__(self, Size sz) -> Size
 818
 819         Add sz's proprties to this and return the result.
 820         """
 821         return _core_.Size___add__(*args, **kwargs)
 822
 823     def __sub__(*args, **kwargs):
 824         """
 825         __sub__(self, Size sz) -> Size
 826
 827         Subtract sz's properties from this and return the result.
 828         """
 829         return _core_.Size___sub__(*args, **kwargs)
 830
 831     def IncTo(*args, **kwargs):
 832         """
 833         IncTo(self, Size sz)
 834
 835         Increments this object so that both of its dimensions are not less
 836         than the corresponding dimensions of the size.
 837         """
 838         return _core_.Size_IncTo(*args, **kwargs)
 839
 840     def DecTo(*args, **kwargs):
 841         """
 842         DecTo(self, Size sz)
 843
 844         Decrements this object so that both of its dimensions are not greater
 845         than the corresponding dimensions of the size.
 846         """
 847         return _core_.Size_DecTo(*args, **kwargs)
 848
 849     def Scale(*args, **kwargs):
 850         """
 851         Scale(self, float xscale, float yscale)
 852
 853         Scales the dimensions of this object by the given factors.
 854         """
 855         return _core_.Size_Scale(*args, **kwargs)
 856
 857     def Set(*args, **kwargs):
 858         """
 859         Set(self, int w, int h)
 860
 861         Set both width and height.
 862         """
 863         return _core_.Size_Set(*args, **kwargs)
 864
 865     def SetWidth(*args, **kwargs):
 866         """SetWidth(self, int w)"""
 867         return _core_.Size_SetWidth(*args, **kwargs)
 868
 869     def SetHeight(*args, **kwargs):
 870         """SetHeight(self, int h)"""
 871         return _core_.Size_SetHeight(*args, **kwargs)
 872
 873     def GetWidth(*args, **kwargs):
 874         """GetWidth(self) -> int"""
 875         return _core_.Size_GetWidth(*args, **kwargs)
 876
 877     def GetHeight(*args, **kwargs):
 878         """GetHeight(self) -> int"""
 879         return _core_.Size_GetHeight(*args, **kwargs)
 880
 881     def IsFullySpecified(*args, **kwargs):
 882         """
 883         IsFullySpecified(self) -> bool
 884
 885         Returns True if both components of the size are non-default values.
 886         """
 887         return _core_.Size_IsFullySpecified(*args, **kwargs)
 888
 889     def SetDefaults(*args, **kwargs):
 890         """
 891         SetDefaults(self, Size size)
 892
 893         Combine this size with the other one replacing the default components
 894         of this object (i.e. equal to -1) with those of the other.
 895         """
 896         return _core_.Size_SetDefaults(*args, **kwargs)
 897
 898     def Get(*args, **kwargs):
 899         """
 900         Get() -> (width,height)
 901
 902         Returns the width and height properties as a tuple.
 903         """
 904         return _core_.Size_Get(*args, **kwargs)
 905
 906     asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
 907     def __str__(self):                   return str(self.Get())
 908     def __repr__(self):                  return 'wx.Size'+str(self.Get())
 909     def __len__(self):                   return len(self.Get())
 910     def __getitem__(self, index):        return self.Get()[index]
 911     def __setitem__(self, index, val):
 912         if index == 0: self.width = val
 913         elif index == 1: self.height = val
 914         else: raise IndexError
 915     def __nonzero__(self):               return self.Get() != (0,0)
 916     __safe_for_unpickling__ = True
 917     def __reduce__(self):                return (wx.Size, self.Get())
 918
 919 _core_.Size_swigregister(Size)
 920
 921 #---------------------------------------------------------------------------
 922
 923 class RealPoint(object):
 924     """
 925     A data structure for representing a point or position with floating
 926     point x and y properties.  In wxPython most places that expect a
 927     wx.RealPoint can also accept a (x,y) tuple.
 928     """
 929     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
 930     __repr__ = _swig_repr
 931     x = property(_core_.RealPoint_x_get, _core_.RealPoint_x_set)
 932     y = property(_core_.RealPoint_y_get, _core_.RealPoint_y_set)
 933     def __init__(self, *args, **kwargs):
 934         """
 935         __init__(self, double x=0.0, double y=0.0) -> RealPoint
 936
 937         Create a wx.RealPoint object
 938         """
 939         _core_.RealPoint_swiginit(self,_core_.new_RealPoint(*args, **kwargs))
 940     __swig_destroy__ = _core_.delete_RealPoint
 941     __del__ = lambda self : None;
 942     def __eq__(*args, **kwargs):
 943         """
 944         __eq__(self, PyObject other) -> bool
 945
 946         Test for equality of wx.RealPoint objects.
 947         """
 948         return _core_.RealPoint___eq__(*args, **kwargs)
 949
 950     def __ne__(*args, **kwargs):
 951         """
 952         __ne__(self, PyObject other) -> bool
 953
 954         Test for inequality of wx.RealPoint objects.
 955         """
 956         return _core_.RealPoint___ne__(*args, **kwargs)
 957
 958     def __add__(*args, **kwargs):
 959         """
 960         __add__(self, RealPoint pt) -> RealPoint
 961
 962         Add pt's proprties to this and return the result.
 963         """
 964         return _core_.RealPoint___add__(*args, **kwargs)
 965
 966     def __sub__(*args, **kwargs):
 967         """
 968         __sub__(self, RealPoint pt) -> RealPoint
 969
 970         Subtract pt's proprties from this and return the result
 971         """
 972         return _core_.RealPoint___sub__(*args, **kwargs)
 973
 974     def Set(*args, **kwargs):
 975         """
 976         Set(self, double x, double y)
 977
 978         Set both the x and y properties
 979         """
 980         return _core_.RealPoint_Set(*args, **kwargs)
 981
 982     def Get(*args, **kwargs):
 983         """
 984         Get() -> (x,y)
 985
 986         Return the x and y properties as a tuple.
 987         """
 988         return _core_.RealPoint_Get(*args, **kwargs)
 989
 990     asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
 991     def __str__(self):                   return str(self.Get())
 992     def __repr__(self):                  return 'wx.RealPoint'+str(self.Get())
 993     def __len__(self):                   return len(self.Get())
 994     def __getitem__(self, index):        return self.Get()[index]
 995     def __setitem__(self, index, val):
 996         if index == 0: self.x = val
 997         elif index == 1: self.y = val
 998         else: raise IndexError
 999     def __nonzero__(self):               return self.Get() != (0.0, 0.0)
1000     __safe_for_unpickling__ = True
1001     def __reduce__(self):                return (wx.RealPoint, self.Get())
1002
1003 _core_.RealPoint_swigregister(RealPoint)
1004
1005 #---------------------------------------------------------------------------
1006
1007 class Point(object):
1008     """
1009     A data structure for representing a point or position with integer x
1010     and y properties.  Most places in wxPython that expect a wx.Point can
1011     also accept a (x,y) tuple.
1012     """
1013     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1014     __repr__ = _swig_repr
1015     x = property(_core_.Point_x_get, _core_.Point_x_set)
1016     y = property(_core_.Point_y_get, _core_.Point_y_set)
1017     def __init__(self, *args, **kwargs):
1018         """
1019         __init__(self, int x=0, int y=0) -> Point
1020
1021         Create a wx.Point object
1022         """
1023         _core_.Point_swiginit(self,_core_.new_Point(*args, **kwargs))
1024     __swig_destroy__ = _core_.delete_Point
1025     __del__ = lambda self : None;
1026     def __eq__(*args, **kwargs):
1027         """
1028         __eq__(self, PyObject other) -> bool
1029
1030         Test for equality of wx.Point objects.
1031         """
1032         return _core_.Point___eq__(*args, **kwargs)
1033
1034     def __ne__(*args, **kwargs):
1035         """
1036         __ne__(self, PyObject other) -> bool
1037
1038         Test for inequality of wx.Point objects.
1039         """
1040         return _core_.Point___ne__(*args, **kwargs)
1041
1042     def __add__(*args, **kwargs):
1043         """
1044         __add__(self, Point pt) -> Point
1045
1046         Add pt's proprties to this and return the result.
1047         """
1048         return _core_.Point___add__(*args, **kwargs)
1049
1050     def __sub__(*args, **kwargs):
1051         """
1052         __sub__(self, Point pt) -> Point
1053
1054         Subtract pt's proprties from this and return the result
1055         """
1056         return _core_.Point___sub__(*args, **kwargs)
1057
1058     def __iadd__(*args, **kwargs):
1059         """
1060         __iadd__(self, Point pt) -> Point
1061
1062         Add pt to this object.
1063         """
1064         return _core_.Point___iadd__(*args, **kwargs)
1065
1066     def __isub__(*args, **kwargs):
1067         """
1068         __isub__(self, Point pt) -> Point
1069
1070         Subtract pt from this object.
1071         """
1072         return _core_.Point___isub__(*args, **kwargs)
1073
1074     def Set(*args, **kwargs):
1075         """
1076         Set(self, long x, long y)
1077
1078         Set both the x and y properties
1079         """
1080         return _core_.Point_Set(*args, **kwargs)
1081
1082     def Get(*args, **kwargs):
1083         """
1084         Get() -> (x,y)
1085
1086         Return the x and y properties as a tuple.
1087         """
1088         return _core_.Point_Get(*args, **kwargs)
1089
1090     asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
1091     def __str__(self):                   return str(self.Get())
1092     def __repr__(self):                  return 'wx.Point'+str(self.Get())
1093     def __len__(self):                   return len(self.Get())
1094     def __getitem__(self, index):        return self.Get()[index]
1095     def __setitem__(self, index, val):
1096         if index == 0: self.x = val
1097         elif index == 1: self.y = val
1098         else: raise IndexError
1099     def __nonzero__(self):               return self.Get() != (0,0)
1100     __safe_for_unpickling__ = True
1101     def __reduce__(self):                return (wx.Point, self.Get())
1102
1103 _core_.Point_swigregister(Point)
1104
1105 #---------------------------------------------------------------------------
1106
1107 class Rect(object):
1108     """
1109     A class for representing and manipulating rectangles.  It has x, y,
1110     width and height properties.  In wxPython most palces that expect a
1111     wx.Rect can also accept a (x,y,width,height) tuple.
1112     """
1113     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1114     __repr__ = _swig_repr
1115     def __init__(self, *args, **kwargs):
1116         """
1117         __init__(self, int x=0, int y=0, int width=0, int height=0) -> Rect
1118
1119         Create a new Rect object.
1120         """
1121         _core_.Rect_swiginit(self,_core_.new_Rect(*args, **kwargs))
1122     __swig_destroy__ = _core_.delete_Rect
1123     __del__ = lambda self : None;
1124     def GetX(*args, **kwargs):
1125         """GetX(self) -> int"""
1126         return _core_.Rect_GetX(*args, **kwargs)
1127
1128     def SetX(*args, **kwargs):
1129         """SetX(self, int x)"""
1130         return _core_.Rect_SetX(*args, **kwargs)
1131
1132     def GetY(*args, **kwargs):
1133         """GetY(self) -> int"""
1134         return _core_.Rect_GetY(*args, **kwargs)
1135
1136     def SetY(*args, **kwargs):
1137         """SetY(self, int y)"""
1138         return _core_.Rect_SetY(*args, **kwargs)
1139
1140     def GetWidth(*args, **kwargs):
1141         """GetWidth(self) -> int"""
1142         return _core_.Rect_GetWidth(*args, **kwargs)
1143
1144     def SetWidth(*args, **kwargs):
1145         """SetWidth(self, int w)"""
1146         return _core_.Rect_SetWidth(*args, **kwargs)
1147
1148     def GetHeight(*args, **kwargs):
1149         """GetHeight(self) -> int"""
1150         return _core_.Rect_GetHeight(*args, **kwargs)
1151
1152     def SetHeight(*args, **kwargs):
1153         """SetHeight(self, int h)"""
1154         return _core_.Rect_SetHeight(*args, **kwargs)
1155
1156     def GetPosition(*args, **kwargs):
1157         """GetPosition(self) -> Point"""
1158         return _core_.Rect_GetPosition(*args, **kwargs)
1159
1160     def SetPosition(*args, **kwargs):
1161         """SetPosition(self, Point p)"""
1162         return _core_.Rect_SetPosition(*args, **kwargs)
1163
1164     def GetSize(*args, **kwargs):
1165         """GetSize(self) -> Size"""
1166         return _core_.Rect_GetSize(*args, **kwargs)
1167
1168     def SetSize(*args, **kwargs):
1169         """SetSize(self, Size s)"""
1170         return _core_.Rect_SetSize(*args, **kwargs)
1171
1172     def IsEmpty(*args, **kwargs):
1173         """IsEmpty(self) -> bool"""
1174         return _core_.Rect_IsEmpty(*args, **kwargs)
1175
1176     def GetTopLeft(*args, **kwargs):
1177         """GetTopLeft(self) -> Point"""
1178         return _core_.Rect_GetTopLeft(*args, **kwargs)
1179
1180     def SetTopLeft(*args, **kwargs):
1181         """SetTopLeft(self, Point p)"""
1182         return _core_.Rect_SetTopLeft(*args, **kwargs)
1183
1184     def GetBottomRight(*args, **kwargs):
1185         """GetBottomRight(self) -> Point"""
1186         return _core_.Rect_GetBottomRight(*args, **kwargs)
1187
1188     def SetBottomRight(*args, **kwargs):
1189         """SetBottomRight(self, Point p)"""
1190         return _core_.Rect_SetBottomRight(*args, **kwargs)
1191
1192     def GetLeft(*args, **kwargs):
1193         """GetLeft(self) -> int"""
1194         return _core_.Rect_GetLeft(*args, **kwargs)
1195
1196     def GetTop(*args, **kwargs):
1197         """GetTop(self) -> int"""
1198         return _core_.Rect_GetTop(*args, **kwargs)
1199
1200     def GetBottom(*args, **kwargs):
1201         """GetBottom(self) -> int"""
1202         return _core_.Rect_GetBottom(*args, **kwargs)
1203
1204     def GetRight(*args, **kwargs):
1205         """GetRight(self) -> int"""
1206         return _core_.Rect_GetRight(*args, **kwargs)
1207
1208     def SetLeft(*args, **kwargs):
1209         """SetLeft(self, int left)"""
1210         return _core_.Rect_SetLeft(*args, **kwargs)
1211
1212     def SetRight(*args, **kwargs):
1213         """SetRight(self, int right)"""
1214         return _core_.Rect_SetRight(*args, **kwargs)
1215
1216     def SetTop(*args, **kwargs):
1217         """SetTop(self, int top)"""
1218         return _core_.Rect_SetTop(*args, **kwargs)
1219
1220     def SetBottom(*args, **kwargs):
1221         """SetBottom(self, int bottom)"""
1222         return _core_.Rect_SetBottom(*args, **kwargs)
1223
1224     position = property(GetPosition, SetPosition)
1225     size = property(GetSize, SetSize)
1226     left = property(GetLeft, SetLeft)
1227     right = property(GetRight, SetRight)
1228     top = property(GetTop, SetTop)
1229     bottom = property(GetBottom, SetBottom)
1230
1231     def Inflate(*args, **kwargs):
1232         """
1233         Inflate(self, int dx, int dy) -> Rect
1234
1235         Increases the size of the rectangle.
1236
1237         The left border is moved farther left and the right border is moved
1238         farther right by ``dx``. The upper border is moved farther up and the
1239         bottom border is moved farther down by ``dy``. (Note the the width and
1240         height of the rectangle thus change by ``2*dx`` and ``2*dy``,
1241         respectively.) If one or both of ``dx`` and ``dy`` are negative, the
1242         opposite happens: the rectangle size decreases in the respective
1243         direction.
1244
1245         The change is made to the rectangle inplace, if instead you need a
1246         copy that is inflated, preserving the original then make the copy
1247         first::
1248
1249             copy = wx.Rect(*original)
1250             copy.Inflate(10,15)
1251
1252
1253         """
1254         return _core_.Rect_Inflate(*args, **kwargs)
1255
1256     def Deflate(*args, **kwargs):
1257         """
1258         Deflate(self, int dx, int dy) -> Rect
1259
1260         Decrease the rectangle size. This method is the opposite of `Inflate`
1261         in that Deflate(a,b) is equivalent to Inflate(-a,-b).  Please refer to
1262         `Inflate` for a full description.
1263         """
1264         return _core_.Rect_Deflate(*args, **kwargs)
1265
1266     def OffsetXY(*args, **kwargs):
1267         """
1268         OffsetXY(self, int dx, int dy)
1269
1270         Moves the rectangle by the specified offset. If dx is positive, the
1271         rectangle is moved to the right, if dy is positive, it is moved to the
1272         bottom, otherwise it is moved to the left or top respectively.
1273         """
1274         return _core_.Rect_OffsetXY(*args, **kwargs)
1275
1276     def Offset(*args, **kwargs):
1277         """
1278         Offset(self, Point pt)
1279
1280         Same as `OffsetXY` but uses dx,dy from Point
1281         """
1282         return _core_.Rect_Offset(*args, **kwargs)
1283
1284     def Intersect(*args, **kwargs):
1285         """
1286         Intersect(self, Rect rect) -> Rect
1287
1288         Returns the intersectsion of this rectangle and rect.
1289         """
1290         return _core_.Rect_Intersect(*args, **kwargs)
1291
1292     def Union(*args, **kwargs):
1293         """
1294         Union(self, Rect rect) -> Rect
1295
1296         Returns the union of this rectangle and rect.
1297         """
1298         return _core_.Rect_Union(*args, **kwargs)
1299
1300     def __add__(*args, **kwargs):
1301         """
1302         __add__(self, Rect rect) -> Rect
1303
1304         Add the properties of rect to this rectangle and return the result.
1305         """
1306         return _core_.Rect___add__(*args, **kwargs)
1307
1308     def __iadd__(*args, **kwargs):
1309         """
1310         __iadd__(self, Rect rect) -> Rect
1311
1312         Add the properties of rect to this rectangle, updating this rectangle.
1313         """
1314         return _core_.Rect___iadd__(*args, **kwargs)
1315
1316     def __eq__(*args, **kwargs):
1317         """
1318         __eq__(self, PyObject other) -> bool
1319
1320         Test for equality of wx.Rect objects.
1321         """
1322         return _core_.Rect___eq__(*args, **kwargs)
1323
1324     def __ne__(*args, **kwargs):
1325         """
1326         __ne__(self, PyObject other) -> bool
1327
1328         Test for inequality of wx.Rect objects.
1329         """
1330         return _core_.Rect___ne__(*args, **kwargs)
1331
1332     def InsideXY(*args, **kwargs):
1333         """
1334         InsideXY(self, int x, int y) -> bool
1335
1336         Return True if the point is (not strcitly) inside the rect.
1337         """
1338         return _core_.Rect_InsideXY(*args, **kwargs)
1339
1340     def Inside(*args, **kwargs):
1341         """
1342         Inside(self, Point pt) -> bool
1343
1344         Return True if the point is (not strcitly) inside the rect.
1345         """
1346         return _core_.Rect_Inside(*args, **kwargs)
1347
1348     def Intersects(*args, **kwargs):
1349         """
1350         Intersects(self, Rect rect) -> bool
1351
1352         Returns True if the rectangles have a non empty intersection.
1353         """
1354         return _core_.Rect_Intersects(*args, **kwargs)
1355
1356     def CenterIn(*args, **kwargs):
1357         """
1358         CenterIn(self, Rect r, int dir=BOTH) -> Rect
1359
1360         Center this rectangle within the one passed to the method, which is
1361         usually, but not necessarily, the larger one.
1362         """
1363         return _core_.Rect_CenterIn(*args, **kwargs)
1364
1365     CentreIn = CenterIn
1366     x = property(_core_.Rect_x_get, _core_.Rect_x_set)
1367     y = property(_core_.Rect_y_get, _core_.Rect_y_set)
1368     width = property(_core_.Rect_width_get, _core_.Rect_width_set)
1369     height = property(_core_.Rect_height_get, _core_.Rect_height_set)
1370     def Set(*args, **kwargs):
1371         """
1372         Set(self, int x=0, int y=0, int width=0, int height=0)
1373
1374         Set all rectangle properties.
1375         """
1376         return _core_.Rect_Set(*args, **kwargs)
1377
1378     def Get(*args, **kwargs):
1379         """
1380         Get() -> (x,y,width,height)
1381
1382         Return the rectangle properties as a tuple.
1383         """
1384         return _core_.Rect_Get(*args, **kwargs)
1385
1386     asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
1387     def __str__(self):                   return str(self.Get())
1388     def __repr__(self):                  return 'wx.Rect'+str(self.Get())
1389     def __len__(self):                   return len(self.Get())
1390     def __getitem__(self, index):        return self.Get()[index]
1391     def __setitem__(self, index, val):
1392         if index == 0: self.x = val
1393         elif index == 1: self.y = val
1394         elif index == 2: self.width = val
1395         elif index == 3: self.height = val
1396         else: raise IndexError
1397     def __nonzero__(self):               return self.Get() != (0,0,0,0)
1398     __safe_for_unpickling__ = True
1399     def __reduce__(self):                return (wx.Rect, self.Get())
1400
1401 _core_.Rect_swigregister(Rect)
1402
1403 def RectPP(*args, **kwargs):
1404     """
1405     RectPP(Point topLeft, Point bottomRight) -> Rect
1406
1407     Create a new Rect object from Points representing two corners.
1408     """
1409     val = _core_.new_RectPP(*args, **kwargs)
1410     return val
1411
1412 def RectPS(*args, **kwargs):
1413     """
1414     RectPS(Point pos, Size size) -> Rect
1415
1416     Create a new Rect from a position and size.
1417     """
1418     val = _core_.new_RectPS(*args, **kwargs)
1419     return val
1420
1421 def RectS(*args, **kwargs):
1422     """
1423     RectS(Size size) -> Rect
1424
1425     Create a new Rect from a size only.
1426     """
1427     val = _core_.new_RectS(*args, **kwargs)
1428     return val
1429
1430
1431 def IntersectRect(*args, **kwargs):
1432   """
1433     IntersectRect(Rect r1, Rect r2) -> Rect
1434
1435     Calculate and return the intersection of r1 and r2.
1436     """
1437   return _core_.IntersectRect(*args, **kwargs)
1438 #---------------------------------------------------------------------------
1439
1440 class Point2D(object):
1441     """
1442     wx.Point2Ds represent a point or a vector in a 2d coordinate system
1443     with floating point values.
1444     """
1445     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1446     __repr__ = _swig_repr
1447     def __init__(self, *args, **kwargs):
1448         """
1449         __init__(self, double x=0.0, double y=0.0) -> Point2D
1450
1451         Create a w.Point2D object.
1452         """
1453         _core_.Point2D_swiginit(self,_core_.new_Point2D(*args, **kwargs))
1454     def GetFloor(*args, **kwargs):
1455         """
1456         GetFloor() -> (x,y)
1457
1458         Convert to integer
1459         """
1460         return _core_.Point2D_GetFloor(*args, **kwargs)
1461
1462     def GetRounded(*args, **kwargs):
1463         """
1464         GetRounded() -> (x,y)
1465
1466         Convert to integer
1467         """
1468         return _core_.Point2D_GetRounded(*args, **kwargs)
1469
1470     def GetVectorLength(*args, **kwargs):
1471         """GetVectorLength(self) -> double"""
1472         return _core_.Point2D_GetVectorLength(*args, **kwargs)
1473
1474     def GetVectorAngle(*args, **kwargs):
1475         """GetVectorAngle(self) -> double"""
1476         return _core_.Point2D_GetVectorAngle(*args, **kwargs)
1477
1478     def SetVectorLength(*args, **kwargs):
1479         """SetVectorLength(self, double length)"""
1480         return _core_.Point2D_SetVectorLength(*args, **kwargs)
1481
1482     def SetVectorAngle(*args, **kwargs):
1483         """SetVectorAngle(self, double degrees)"""
1484         return _core_.Point2D_SetVectorAngle(*args, **kwargs)
1485
1486     def SetPolarCoordinates(self, angle, length):
1487         self.SetVectorLength(length)
1488         self.SetVectorAngle(angle)
1489     def Normalize(self):
1490         self.SetVectorLength(1.0)
1491
1492     def GetDistance(*args, **kwargs):
1493         """GetDistance(self, Point2D pt) -> double"""
1494         return _core_.Point2D_GetDistance(*args, **kwargs)
1495
1496     def GetDistanceSquare(*args, **kwargs):
1497         """GetDistanceSquare(self, Point2D pt) -> double"""
1498         return _core_.Point2D_GetDistanceSquare(*args, **kwargs)
1499
1500     def GetDotProduct(*args, **kwargs):
1501         """GetDotProduct(self, Point2D vec) -> double"""
1502         return _core_.Point2D_GetDotProduct(*args, **kwargs)
1503
1504     def GetCrossProduct(*args, **kwargs):
1505         """GetCrossProduct(self, Point2D vec) -> double"""
1506         return _core_.Point2D_GetCrossProduct(*args, **kwargs)
1507
1508     def __neg__(*args, **kwargs):
1509         """
1510         __neg__(self) -> Point2D
1511
1512         the reflection of this point
1513         """
1514         return _core_.Point2D___neg__(*args, **kwargs)
1515
1516     def __iadd__(*args, **kwargs):
1517         """__iadd__(self, Point2D pt) -> Point2D"""
1518         return _core_.Point2D___iadd__(*args, **kwargs)
1519
1520     def __isub__(*args, **kwargs):
1521         """__isub__(self, Point2D pt) -> Point2D"""
1522         return _core_.Point2D___isub__(*args, **kwargs)
1523
1524     def __imul__(*args, **kwargs):
1525         """__imul__(self, Point2D pt) -> Point2D"""
1526         return _core_.Point2D___imul__(*args, **kwargs)
1527
1528     def __idiv__(*args, **kwargs):
1529         """__idiv__(self, Point2D pt) -> Point2D"""
1530         return _core_.Point2D___idiv__(*args, **kwargs)
1531
1532     def __eq__(*args, **kwargs):
1533         """
1534         __eq__(self, PyObject other) -> bool
1535
1536         Test for equality of wx.Point2D objects.
1537         """
1538         return _core_.Point2D___eq__(*args, **kwargs)
1539
1540     def __ne__(*args, **kwargs):
1541         """
1542         __ne__(self, PyObject other) -> bool
1543
1544         Test for inequality of wx.Point2D objects.
1545         """
1546         return _core_.Point2D___ne__(*args, **kwargs)
1547
1548     x = property(_core_.Point2D_x_get, _core_.Point2D_x_set)
1549     y = property(_core_.Point2D_y_get, _core_.Point2D_y_set)
1550     def Set(*args, **kwargs):
1551         """Set(self, double x=0, double y=0)"""
1552         return _core_.Point2D_Set(*args, **kwargs)
1553
1554     def Get(*args, **kwargs):
1555         """
1556         Get() -> (x,y)
1557
1558         Return x and y properties as a tuple.
1559         """
1560         return _core_.Point2D_Get(*args, **kwargs)
1561
1562     asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
1563     def __str__(self):                   return str(self.Get())
1564     def __repr__(self):                  return 'wx.Point2D'+str(self.Get())
1565     def __len__(self):                   return len(self.Get())
1566     def __getitem__(self, index):        return self.Get()[index]
1567     def __setitem__(self, index, val):
1568         if index == 0: self.x = val
1569         elif index == 1: self.y = val
1570         else: raise IndexError
1571     def __nonzero__(self):               return self.Get() != (0.0, 0.0)
1572     __safe_for_unpickling__ = True
1573     def __reduce__(self):                return (wx.Point2D, self.Get())
1574
1575 _core_.Point2D_swigregister(Point2D)
1576
1577 def Point2DCopy(*args, **kwargs):
1578     """
1579     Point2DCopy(Point2D pt) -> Point2D
1580
1581     Create a w.Point2D object.
1582     """
1583     val = _core_.new_Point2DCopy(*args, **kwargs)
1584     return val
1585
1586 def Point2DFromPoint(*args, **kwargs):
1587     """
1588     Point2DFromPoint(Point pt) -> Point2D
1589
1590     Create a w.Point2D object.
1591     """
1592     val = _core_.new_Point2DFromPoint(*args, **kwargs)
1593     return val
1594
1595 #---------------------------------------------------------------------------
1596
1597 FromStart = _core_.FromStart
1598 FromCurrent = _core_.FromCurrent
1599 FromEnd = _core_.FromEnd
1600 class InputStream(object):
1601     """Proxy of C++ InputStream class"""
1602     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1603     __repr__ = _swig_repr
1604     def __init__(self, *args, **kwargs):
1605         """__init__(self, PyObject p) -> InputStream"""
1606         _core_.InputStream_swiginit(self,_core_.new_InputStream(*args, **kwargs))
1607     __swig_destroy__ = _core_.delete_InputStream
1608     __del__ = lambda self : None;
1609     def close(*args, **kwargs):
1610         """close(self)"""
1611         return _core_.InputStream_close(*args, **kwargs)
1612
1613     def flush(*args, **kwargs):
1614         """flush(self)"""
1615         return _core_.InputStream_flush(*args, **kwargs)
1616
1617     def eof(*args, **kwargs):
1618         """eof(self) -> bool"""
1619         return _core_.InputStream_eof(*args, **kwargs)
1620
1621     def read(*args, **kwargs):
1622         """read(self, int size=-1) -> PyObject"""
1623         return _core_.InputStream_read(*args, **kwargs)
1624
1625     def readline(*args, **kwargs):
1626         """readline(self, int size=-1) -> PyObject"""
1627         return _core_.InputStream_readline(*args, **kwargs)
1628
1629     def readlines(*args, **kwargs):
1630         """readlines(self, int sizehint=-1) -> PyObject"""
1631         return _core_.InputStream_readlines(*args, **kwargs)
1632
1633     def seek(*args, **kwargs):
1634         """seek(self, int offset, int whence=0)"""
1635         return _core_.InputStream_seek(*args, **kwargs)
1636
1637     def tell(*args, **kwargs):
1638         """tell(self) -> int"""
1639         return _core_.InputStream_tell(*args, **kwargs)
1640
1641     def Peek(*args, **kwargs):
1642         """Peek(self) -> char"""
1643         return _core_.InputStream_Peek(*args, **kwargs)
1644
1645     def GetC(*args, **kwargs):
1646         """GetC(self) -> char"""
1647         return _core_.InputStream_GetC(*args, **kwargs)
1648
1649     def LastRead(*args, **kwargs):
1650         """LastRead(self) -> size_t"""
1651         return _core_.InputStream_LastRead(*args, **kwargs)
1652
1653     def CanRead(*args, **kwargs):
1654         """CanRead(self) -> bool"""
1655         return _core_.InputStream_CanRead(*args, **kwargs)
1656
1657     def Eof(*args, **kwargs):
1658         """Eof(self) -> bool"""
1659         return _core_.InputStream_Eof(*args, **kwargs)
1660
1661     def Ungetch(*args, **kwargs):
1662         """Ungetch(self, char c) -> bool"""
1663         return _core_.InputStream_Ungetch(*args, **kwargs)
1664
1665     def SeekI(*args, **kwargs):
1666         """SeekI(self, long pos, int mode=FromStart) -> long"""
1667         return _core_.InputStream_SeekI(*args, **kwargs)
1668
1669     def TellI(*args, **kwargs):
1670         """TellI(self) -> long"""
1671         return _core_.InputStream_TellI(*args, **kwargs)
1672
1673 _core_.InputStream_swigregister(InputStream)
1674 DefaultPosition = cvar.DefaultPosition
1675 DefaultSize = cvar.DefaultSize
1676
1677 class OutputStream(object):
1678     """Proxy of C++ OutputStream class"""
1679     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1680     def __init__(self): raise AttributeError, "No constructor defined"
1681     __repr__ = _swig_repr
1682     def write(*args, **kwargs):
1683         """write(self, PyObject obj)"""
1684         return _core_.OutputStream_write(*args, **kwargs)
1685
1686     def LastWrite(*args, **kwargs):
1687         """LastWrite(self) -> size_t"""
1688         return _core_.OutputStream_LastWrite(*args, **kwargs)
1689
1690 _core_.OutputStream_swigregister(OutputStream)
1691
1692 #---------------------------------------------------------------------------
1693
1694 class FSFile(Object):
1695     """Proxy of C++ FSFile class"""
1696     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1697     __repr__ = _swig_repr
1698     def __init__(self, *args, **kwargs):
1699         """
1700         __init__(self, InputStream stream, String loc, String mimetype, String anchor,
1701             DateTime modif) -> FSFile
1702         """
1703         _core_.FSFile_swiginit(self,_core_.new_FSFile(*args, **kwargs))
1704     __swig_destroy__ = _core_.delete_FSFile
1705     __del__ = lambda self : None;
1706     def GetStream(*args, **kwargs):
1707         """GetStream(self) -> InputStream"""
1708         return _core_.FSFile_GetStream(*args, **kwargs)
1709
1710     def GetMimeType(*args, **kwargs):
1711         """GetMimeType(self) -> String"""
1712         return _core_.FSFile_GetMimeType(*args, **kwargs)
1713
1714     def GetLocation(*args, **kwargs):
1715         """GetLocation(self) -> String"""
1716         return _core_.FSFile_GetLocation(*args, **kwargs)
1717
1718     def GetAnchor(*args, **kwargs):
1719         """GetAnchor(self) -> String"""
1720         return _core_.FSFile_GetAnchor(*args, **kwargs)
1721
1722     def GetModificationTime(*args, **kwargs):
1723         """GetModificationTime(self) -> DateTime"""
1724         return _core_.FSFile_GetModificationTime(*args, **kwargs)
1725
1726 _core_.FSFile_swigregister(FSFile)
1727
1728 class CPPFileSystemHandler(object):
1729     """Proxy of C++ CPPFileSystemHandler class"""
1730     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1731     def __init__(self): raise AttributeError, "No constructor defined"
1732     __repr__ = _swig_repr
1733     __swig_destroy__ = _core_.delete_CPPFileSystemHandler
1734     __del__ = lambda self : None;
1735 _core_.CPPFileSystemHandler_swigregister(CPPFileSystemHandler)
1736
1737 class FileSystemHandler(CPPFileSystemHandler):
1738     """Proxy of C++ FileSystemHandler class"""
1739     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1740     __repr__ = _swig_repr
1741     def __init__(self, *args, **kwargs):
1742         """__init__(self) -> FileSystemHandler"""
1743         _core_.FileSystemHandler_swiginit(self,_core_.new_FileSystemHandler(*args, **kwargs))
1744         self._setCallbackInfo(self, FileSystemHandler)
1745
1746     def _setCallbackInfo(*args, **kwargs):
1747         """_setCallbackInfo(self, PyObject self, PyObject _class)"""
1748         return _core_.FileSystemHandler__setCallbackInfo(*args, **kwargs)
1749
1750     def CanOpen(*args, **kwargs):
1751         """CanOpen(self, String location) -> bool"""
1752         return _core_.FileSystemHandler_CanOpen(*args, **kwargs)
1753
1754     def OpenFile(*args, **kwargs):
1755         """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1756         return _core_.FileSystemHandler_OpenFile(*args, **kwargs)
1757
1758     def FindFirst(*args, **kwargs):
1759         """FindFirst(self, String spec, int flags=0) -> String"""
1760         return _core_.FileSystemHandler_FindFirst(*args, **kwargs)
1761
1762     def FindNext(*args, **kwargs):
1763         """FindNext(self) -> String"""
1764         return _core_.FileSystemHandler_FindNext(*args, **kwargs)
1765
1766     def GetProtocol(*args, **kwargs):
1767         """GetProtocol(self, String location) -> String"""
1768         return _core_.FileSystemHandler_GetProtocol(*args, **kwargs)
1769
1770     def GetLeftLocation(*args, **kwargs):
1771         """GetLeftLocation(self, String location) -> String"""
1772         return _core_.FileSystemHandler_GetLeftLocation(*args, **kwargs)
1773
1774     def GetAnchor(*args, **kwargs):
1775         """GetAnchor(self, String location) -> String"""
1776         return _core_.FileSystemHandler_GetAnchor(*args, **kwargs)
1777
1778     def GetRightLocation(*args, **kwargs):
1779         """GetRightLocation(self, String location) -> String"""
1780         return _core_.FileSystemHandler_GetRightLocation(*args, **kwargs)
1781
1782     def GetMimeTypeFromExt(*args, **kwargs):
1783         """GetMimeTypeFromExt(self, String location) -> String"""
1784         return _core_.FileSystemHandler_GetMimeTypeFromExt(*args, **kwargs)
1785
1786 _core_.FileSystemHandler_swigregister(FileSystemHandler)
1787
1788 class FileSystem(Object):
1789     """Proxy of C++ FileSystem class"""
1790     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1791     __repr__ = _swig_repr
1792     def __init__(self, *args, **kwargs):
1793         """__init__(self) -> FileSystem"""
1794         _core_.FileSystem_swiginit(self,_core_.new_FileSystem(*args, **kwargs))
1795     __swig_destroy__ = _core_.delete_FileSystem
1796     __del__ = lambda self : None;
1797     def ChangePathTo(*args, **kwargs):
1798         """ChangePathTo(self, String location, bool is_dir=False)"""
1799         return _core_.FileSystem_ChangePathTo(*args, **kwargs)
1800
1801     def GetPath(*args, **kwargs):
1802         """GetPath(self) -> String"""
1803         return _core_.FileSystem_GetPath(*args, **kwargs)
1804
1805     def OpenFile(*args, **kwargs):
1806         """OpenFile(self, String location) -> FSFile"""
1807         return _core_.FileSystem_OpenFile(*args, **kwargs)
1808
1809     def FindFirst(*args, **kwargs):
1810         """FindFirst(self, String spec, int flags=0) -> String"""
1811         return _core_.FileSystem_FindFirst(*args, **kwargs)
1812
1813     def FindNext(*args, **kwargs):
1814         """FindNext(self) -> String"""
1815         return _core_.FileSystem_FindNext(*args, **kwargs)
1816
1817     def AddHandler(*args, **kwargs):
1818         """AddHandler(CPPFileSystemHandler handler)"""
1819         return _core_.FileSystem_AddHandler(*args, **kwargs)
1820
1821     AddHandler = staticmethod(AddHandler)
1822     def CleanUpHandlers(*args, **kwargs):
1823         """CleanUpHandlers()"""
1824         return _core_.FileSystem_CleanUpHandlers(*args, **kwargs)
1825
1826     CleanUpHandlers = staticmethod(CleanUpHandlers)
1827     def FileNameToURL(*args, **kwargs):
1828         """FileNameToURL(String filename) -> String"""
1829         return _core_.FileSystem_FileNameToURL(*args, **kwargs)
1830
1831     FileNameToURL = staticmethod(FileNameToURL)
1832     def URLToFileName(*args, **kwargs):
1833         """URLToFileName(String url) -> String"""
1834         return _core_.FileSystem_URLToFileName(*args, **kwargs)
1835
1836     URLToFileName = staticmethod(URLToFileName)
1837 _core_.FileSystem_swigregister(FileSystem)
1838
1839 def FileSystem_AddHandler(*args, **kwargs):
1840   """FileSystem_AddHandler(CPPFileSystemHandler handler)"""
1841   return _core_.FileSystem_AddHandler(*args, **kwargs)
1842
1843 def FileSystem_CleanUpHandlers(*args):
1844   """FileSystem_CleanUpHandlers()"""
1845   return _core_.FileSystem_CleanUpHandlers(*args)
1846
1847 def FileSystem_FileNameToURL(*args, **kwargs):
1848   """FileSystem_FileNameToURL(String filename) -> String"""
1849   return _core_.FileSystem_FileNameToURL(*args, **kwargs)
1850
1851 def FileSystem_URLToFileName(*args, **kwargs):
1852   """FileSystem_URLToFileName(String url) -> String"""
1853   return _core_.FileSystem_URLToFileName(*args, **kwargs)
1854
1855 class InternetFSHandler(CPPFileSystemHandler):
1856     """Proxy of C++ InternetFSHandler class"""
1857     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1858     __repr__ = _swig_repr
1859     def __init__(self, *args, **kwargs):
1860         """__init__(self) -> InternetFSHandler"""
1861         _core_.InternetFSHandler_swiginit(self,_core_.new_InternetFSHandler(*args, **kwargs))
1862     def CanOpen(*args, **kwargs):
1863         """CanOpen(self, String location) -> bool"""
1864         return _core_.InternetFSHandler_CanOpen(*args, **kwargs)
1865
1866     def OpenFile(*args, **kwargs):
1867         """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1868         return _core_.InternetFSHandler_OpenFile(*args, **kwargs)
1869
1870 _core_.InternetFSHandler_swigregister(InternetFSHandler)
1871
1872 class ZipFSHandler(CPPFileSystemHandler):
1873     """Proxy of C++ ZipFSHandler class"""
1874     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1875     __repr__ = _swig_repr
1876     def __init__(self, *args, **kwargs):
1877         """__init__(self) -> ZipFSHandler"""
1878         _core_.ZipFSHandler_swiginit(self,_core_.new_ZipFSHandler(*args, **kwargs))
1879     def CanOpen(*args, **kwargs):
1880         """CanOpen(self, String location) -> bool"""
1881         return _core_.ZipFSHandler_CanOpen(*args, **kwargs)
1882
1883     def OpenFile(*args, **kwargs):
1884         """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1885         return _core_.ZipFSHandler_OpenFile(*args, **kwargs)
1886
1887     def FindFirst(*args, **kwargs):
1888         """FindFirst(self, String spec, int flags=0) -> String"""
1889         return _core_.ZipFSHandler_FindFirst(*args, **kwargs)
1890
1891     def FindNext(*args, **kwargs):
1892         """FindNext(self) -> String"""
1893         return _core_.ZipFSHandler_FindNext(*args, **kwargs)
1894
1895 _core_.ZipFSHandler_swigregister(ZipFSHandler)
1896
1897
1898 def __wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs):
1899   """__wxMemoryFSHandler_AddFile_wxImage(String filename, Image image, long type)"""
1900   return _core_.__wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs)
1901
1902 def __wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs):
1903   """__wxMemoryFSHandler_AddFile_wxBitmap(String filename, Bitmap bitmap, long type)"""
1904   return _core_.__wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs)
1905
1906 def __wxMemoryFSHandler_AddFile_Data(*args, **kwargs):
1907   """__wxMemoryFSHandler_AddFile_Data(String filename, PyObject data)"""
1908   return _core_.__wxMemoryFSHandler_AddFile_Data(*args, **kwargs)
1909 def MemoryFSHandler_AddFile(filename, dataItem, imgType=-1):
1910     """
1911     Add 'file' to the memory filesystem.  The dataItem parameter can
1912     either be a `wx.Bitmap`, `wx.Image` or a string that can contain
1913     arbitrary data.  If a bitmap or image is used then the imgType
1914     parameter should specify what kind of image file it should be
1915     written as, wx.BITMAP_TYPE_PNG, etc.
1916     """
1917     if isinstance(dataItem, wx.Image):
1918         __wxMemoryFSHandler_AddFile_wxImage(filename, dataItem, imgType)
1919     elif isinstance(dataItem, wx.Bitmap):
1920         __wxMemoryFSHandler_AddFile_wxBitmap(filename, dataItem, imgType)
1921     elif type(dataItem) == str:
1922         __wxMemoryFSHandler_AddFile_Data(filename, dataItem)
1923     else:
1924         raise TypeError, 'wx.Image, wx.Bitmap or string expected'
1925
1926 class MemoryFSHandler(CPPFileSystemHandler):
1927     """Proxy of C++ MemoryFSHandler class"""
1928     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1929     __repr__ = _swig_repr
1930     def __init__(self, *args, **kwargs):
1931         """__init__(self) -> MemoryFSHandler"""
1932         _core_.MemoryFSHandler_swiginit(self,_core_.new_MemoryFSHandler(*args, **kwargs))
1933     def RemoveFile(*args, **kwargs):
1934         """RemoveFile(String filename)"""
1935         return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
1936
1937     RemoveFile = staticmethod(RemoveFile)
1938     AddFile = staticmethod(MemoryFSHandler_AddFile)
1939     def CanOpen(*args, **kwargs):
1940         """CanOpen(self, String location) -> bool"""
1941         return _core_.MemoryFSHandler_CanOpen(*args, **kwargs)
1942
1943     def OpenFile(*args, **kwargs):
1944         """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1945         return _core_.MemoryFSHandler_OpenFile(*args, **kwargs)
1946
1947     def FindFirst(*args, **kwargs):
1948         """FindFirst(self, String spec, int flags=0) -> String"""
1949         return _core_.MemoryFSHandler_FindFirst(*args, **kwargs)
1950
1951     def FindNext(*args, **kwargs):
1952         """FindNext(self) -> String"""
1953         return _core_.MemoryFSHandler_FindNext(*args, **kwargs)
1954
1955 _core_.MemoryFSHandler_swigregister(MemoryFSHandler)
1956
1957 def MemoryFSHandler_RemoveFile(*args, **kwargs):
1958   """MemoryFSHandler_RemoveFile(String filename)"""
1959   return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
1960
1961 IMAGE_ALPHA_TRANSPARENT = _core_.IMAGE_ALPHA_TRANSPARENT
1962 IMAGE_ALPHA_THRESHOLD = _core_.IMAGE_ALPHA_THRESHOLD
1963 IMAGE_ALPHA_OPAQUE = _core_.IMAGE_ALPHA_OPAQUE
1964 #---------------------------------------------------------------------------
1965
1966 class ImageHandler(Object):
1967     """
1968     This is the base class for implementing image file loading/saving, and
1969     image creation from data. It is used within `wx.Image` and is not
1970     normally seen by the application.
1971     """
1972     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1973     def __init__(self): raise AttributeError, "No constructor defined"
1974     __repr__ = _swig_repr
1975     def GetName(*args, **kwargs):
1976         """GetName(self) -> String"""
1977         return _core_.ImageHandler_GetName(*args, **kwargs)
1978
1979     def GetExtension(*args, **kwargs):
1980         """GetExtension(self) -> String"""
1981         return _core_.ImageHandler_GetExtension(*args, **kwargs)
1982
1983     def GetType(*args, **kwargs):
1984         """GetType(self) -> long"""
1985         return _core_.ImageHandler_GetType(*args, **kwargs)
1986
1987     def GetMimeType(*args, **kwargs):
1988         """GetMimeType(self) -> String"""
1989         return _core_.ImageHandler_GetMimeType(*args, **kwargs)
1990
1991     def CanRead(*args, **kwargs):
1992         """CanRead(self, String name) -> bool"""
1993         return _core_.ImageHandler_CanRead(*args, **kwargs)
1994
1995     def CanReadStream(*args, **kwargs):
1996         """CanReadStream(self, InputStream stream) -> bool"""
1997         return _core_.ImageHandler_CanReadStream(*args, **kwargs)
1998
1999     def SetName(*args, **kwargs):
2000         """SetName(self, String name)"""
2001         return _core_.ImageHandler_SetName(*args, **kwargs)
2002
2003     def SetExtension(*args, **kwargs):
2004         """SetExtension(self, String extension)"""
2005         return _core_.ImageHandler_SetExtension(*args, **kwargs)
2006
2007     def SetType(*args, **kwargs):
2008         """SetType(self, long type)"""
2009         return _core_.ImageHandler_SetType(*args, **kwargs)
2010
2011     def SetMimeType(*args, **kwargs):
2012         """SetMimeType(self, String mimetype)"""
2013         return _core_.ImageHandler_SetMimeType(*args, **kwargs)
2014
2015 _core_.ImageHandler_swigregister(ImageHandler)
2016
2017 class PyImageHandler(ImageHandler):
2018     """
2019     This is the base class for implementing image file loading/saving, and
2020     image creation from data, all written in Python.  To create a custom
2021     image handler derive a new class from wx.PyImageHandler and provide
2022     the following methods::
2023
2024         def DoCanRead(self, stream) --> bool
2025             '''Check if this handler can read the image on the stream'''
2026
2027         def LoadFile(self, image, stream, verbose, index) --> bool
2028             '''Load image data from the stream and load it into image.'''
2029
2030         def SaveFile(self, image, stream, verbose) --> bool
2031             '''Save the iamge data in image to the stream using
2032                this handler's image file format.'''
2033
2034         def GetImageCount(self, stream) --> int
2035             '''If this image format can hold more than one image,
2036                how many does the image on the stream have?'''
2037
2038     To activate your handler create an instance of it and pass it to
2039     `wx.Image_AddHandler`.  Be sure to call `SetName`, `SetType`, and
2040     `SetExtension` from your constructor.
2041
2042     """
2043     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2044     __repr__ = _swig_repr
2045     def __init__(self, *args, **kwargs):
2046         """
2047         __init__(self) -> PyImageHandler
2048
2049         This is the base class for implementing image file loading/saving, and
2050         image creation from data, all written in Python.  To create a custom
2051         image handler derive a new class from wx.PyImageHandler and provide
2052         the following methods::
2053
2054             def DoCanRead(self, stream) --> bool
2055                 '''Check if this handler can read the image on the stream'''
2056
2057             def LoadFile(self, image, stream, verbose, index) --> bool
2058                 '''Load image data from the stream and load it into image.'''
2059
2060             def SaveFile(self, image, stream, verbose) --> bool
2061                 '''Save the iamge data in image to the stream using
2062                    this handler's image file format.'''
2063
2064             def GetImageCount(self, stream) --> int
2065                 '''If this image format can hold more than one image,
2066                    how many does the image on the stream have?'''
2067
2068         To activate your handler create an instance of it and pass it to
2069         `wx.Image_AddHandler`.  Be sure to call `SetName`, `SetType`, and
2070         `SetExtension` from your constructor.
2071
2072         """
2073         _core_.PyImageHandler_swiginit(self,_core_.new_PyImageHandler(*args, **kwargs))
2074         self._SetSelf(self)
2075
2076     def _SetSelf(*args, **kwargs):
2077         """_SetSelf(self, PyObject self)"""
2078         return _core_.PyImageHandler__SetSelf(*args, **kwargs)
2079
2080 _core_.PyImageHandler_swigregister(PyImageHandler)
2081
2082 class ImageHistogram(object):
2083     """Proxy of C++ ImageHistogram class"""
2084     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2085     __repr__ = _swig_repr
2086     def __init__(self, *args, **kwargs):
2087         """__init__(self) -> ImageHistogram"""
2088         _core_.ImageHistogram_swiginit(self,_core_.new_ImageHistogram(*args, **kwargs))
2089     def MakeKey(*args, **kwargs):
2090         """
2091         MakeKey(byte r, byte g, byte b) -> unsigned long
2092
2093         Get the key in the histogram for the given RGB values
2094         """
2095         return _core_.ImageHistogram_MakeKey(*args, **kwargs)
2096
2097     MakeKey = staticmethod(MakeKey)
2098     def FindFirstUnusedColour(*args, **kwargs):
2099         """
2100         FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2101
2102         Find first colour that is not used in the image and has higher RGB
2103         values than startR, startG, startB.  Returns a tuple consisting of a
2104         success flag and rgb values.
2105         """
2106         return _core_.ImageHistogram_FindFirstUnusedColour(*args, **kwargs)
2107
2108     def GetCount(*args, **kwargs):
2109         """
2110         GetCount(self, unsigned long key) -> unsigned long
2111
2112         Returns the pixel count for the given key.  Use `MakeKey` to create a
2113         key value from a RGB tripple.
2114         """
2115         return _core_.ImageHistogram_GetCount(*args, **kwargs)
2116
2117     def GetCountRGB(*args, **kwargs):
2118         """
2119         GetCountRGB(self, byte r, byte g, byte b) -> unsigned long
2120
2121         Returns the pixel count for the given RGB values.
2122         """
2123         return _core_.ImageHistogram_GetCountRGB(*args, **kwargs)
2124
2125     def GetCountColour(*args, **kwargs):
2126         """
2127         GetCountColour(self, Colour colour) -> unsigned long
2128
2129         Returns the pixel count for the given `wx.Colour` value.
2130         """
2131         return _core_.ImageHistogram_GetCountColour(*args, **kwargs)
2132
2133 _core_.ImageHistogram_swigregister(ImageHistogram)
2134
2135 def ImageHistogram_MakeKey(*args, **kwargs):
2136   """
2137     ImageHistogram_MakeKey(byte r, byte g, byte b) -> unsigned long
2138
2139     Get the key in the histogram for the given RGB values
2140     """
2141   return _core_.ImageHistogram_MakeKey(*args, **kwargs)
2142
2143 class Image_RGBValue(object):
2144     """
2145     An object that contains values for red, green and blue which represent
2146     the value of a color. It is used by `wx.Image.HSVtoRGB` and
2147     `wx.Image.RGBtoHSV`, which converts between HSV color space and RGB
2148     color space.
2149     """
2150     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2151     __repr__ = _swig_repr
2152     def __init__(self, *args, **kwargs):
2153         """
2154         __init__(self, byte r=0, byte g=0, byte b=0) -> Image_RGBValue
2155
2156         Constructor.
2157         """
2158         _core_.Image_RGBValue_swiginit(self,_core_.new_Image_RGBValue(*args, **kwargs))
2159     red = property(_core_.Image_RGBValue_red_get, _core_.Image_RGBValue_red_set)
2160     green = property(_core_.Image_RGBValue_green_get, _core_.Image_RGBValue_green_set)
2161     blue = property(_core_.Image_RGBValue_blue_get, _core_.Image_RGBValue_blue_set)
2162 _core_.Image_RGBValue_swigregister(Image_RGBValue)
2163
2164 class Image_HSVValue(object):
2165     """
2166     An object that contains values for hue, saturation and value which
2167     represent the value of a color.  It is used by `wx.Image.HSVtoRGB` and
2168     `wx.Image.RGBtoHSV`, which +converts between HSV color space and RGB
2169     color space.
2170     """
2171     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2172     __repr__ = _swig_repr
2173     def __init__(self, *args, **kwargs):
2174         """
2175         __init__(self, double h=0.0, double s=0.0, double v=0.0) -> Image_HSVValue
2176
2177         Constructor.
2178         """
2179         _core_.Image_HSVValue_swiginit(self,_core_.new_Image_HSVValue(*args, **kwargs))
2180     hue = property(_core_.Image_HSVValue_hue_get, _core_.Image_HSVValue_hue_set)
2181     saturation = property(_core_.Image_HSVValue_saturation_get, _core_.Image_HSVValue_saturation_set)
2182     value = property(_core_.Image_HSVValue_value_get, _core_.Image_HSVValue_value_set)
2183 _core_.Image_HSVValue_swigregister(Image_HSVValue)
2184
2185 class Image(Object):
2186     """
2187     A platform-independent image class.  An image can be created from
2188     data, or using `wx.Bitmap.ConvertToImage`, or loaded from a file in a
2189     variety of formats.  Functions are available to set and get image
2190     bits, so it can be used for basic image manipulation.
2191
2192     A wx.Image cannot be drawn directly to a `wx.DC`.  Instead, a
2193     platform-specific `wx.Bitmap` object must be created from it using the
2194     `wx.BitmapFromImage` constructor. This bitmap can then be drawn in a
2195     device context, using `wx.DC.DrawBitmap`.
2196
2197     One colour value of the image may be used as a mask colour which will
2198     lead to the automatic creation of a `wx.Mask` object associated to the
2199     bitmap object.
2200
2201     wx.Image supports alpha channel data, that is in addition to a byte
2202     for the red, green and blue colour components for each pixel it also
2203     stores a byte representing the pixel opacity. An alpha value of 0
2204     corresponds to a transparent pixel (null opacity) while a value of 255
2205     means that the pixel is 100% opaque.
2206
2207     Unlike RGB data, not all images have an alpha channel and before using
2208     `GetAlpha` you should check if this image contains an alpha channel
2209     with `HasAlpha`. Note that currently only images loaded from PNG files
2210     with transparency information will have an alpha channel.
2211     """
2212     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2213     __repr__ = _swig_repr
2214     def __init__(self, *args, **kwargs):
2215         """
2216         __init__(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
2217
2218         Loads an image from a file.
2219         """
2220         _core_.Image_swiginit(self,_core_.new_Image(*args, **kwargs))
2221     __swig_destroy__ = _core_.delete_Image
2222     __del__ = lambda self : None;
2223     def Create(*args, **kwargs):
2224         """
2225         Create(self, int width, int height, bool clear=True)
2226
2227         Creates a fresh image.  If clear is ``True``, the new image will be
2228         initialized to black. Otherwise, the image data will be uninitialized.
2229         """
2230         return _core_.Image_Create(*args, **kwargs)
2231
2232     def Destroy(*args, **kwargs):
2233         """
2234         Destroy(self)
2235
2236         Destroys the image data.
2237         """
2238         val = _core_.Image_Destroy(*args, **kwargs)
2239         args[0].thisown = 0
2240         return val
2241
2242     def Scale(*args, **kwargs):
2243         """
2244         Scale(self, int width, int height) -> Image
2245
2246         Returns a scaled version of the image. This is also useful for scaling
2247         bitmaps in general as the only other way to scale bitmaps is to blit a
2248         `wx.MemoryDC` into another `wx.MemoryDC`.
2249         """
2250         return _core_.Image_Scale(*args, **kwargs)
2251
2252     def ShrinkBy(*args, **kwargs):
2253         """
2254         ShrinkBy(self, int xFactor, int yFactor) -> Image
2255
2256         Return a version of the image scaled smaller by the given factors.
2257         """
2258         return _core_.Image_ShrinkBy(*args, **kwargs)
2259
2260     def Rescale(*args, **kwargs):
2261         """
2262         Rescale(self, int width, int height) -> Image
2263
2264         Changes the size of the image in-place by scaling it: after a call to
2265         this function, the image will have the given width and height.
2266
2267         Returns the (modified) image itself.
2268         """
2269         return _core_.Image_Rescale(*args, **kwargs)
2270
2271     def Resize(*args, **kwargs):
2272         """
2273         Resize(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
2274
2275         Changes the size of the image in-place without scaling it, by adding
2276         either a border with the given colour or cropping as necessary. The
2277         image is pasted into a new image with the given size and background
2278         colour at the position pos relative to the upper left of the new
2279         image. If red = green = blue = -1 then use either the current mask
2280         colour if set or find, use, and set a suitable mask colour for any
2281         newly exposed areas.
2282
2283         Returns the (modified) image itself.
2284         """
2285         return _core_.Image_Resize(*args, **kwargs)
2286
2287     def SetRGB(*args, **kwargs):
2288         """
2289         SetRGB(self, int x, int y, byte r, byte g, byte b)
2290
2291         Sets the pixel at the given coordinate. This routine performs
2292         bounds-checks for the coordinate so it can be considered a safe way to
2293         manipulate the data, but in some cases this might be too slow so that
2294         the data will have to be set directly. In that case you will have to
2295         get access to the image data using the `GetData` method.
2296         """
2297         return _core_.Image_SetRGB(*args, **kwargs)
2298
2299     def SetRGBRect(*args, **kwargs):
2300         """
2301         SetRGBRect(self, Rect rect, byte r, byte g, byte b)
2302
2303         Sets the colour of the pixels within the given rectangle. This routine
2304         performs bounds-checks for the rectangle so it can be considered a
2305         safe way to manipulate the data.
2306         """
2307         return _core_.Image_SetRGBRect(*args, **kwargs)
2308
2309     def GetRed(*args, **kwargs):
2310         """
2311         GetRed(self, int x, int y) -> byte
2312
2313         Returns the red intensity at the given coordinate.
2314         """
2315         return _core_.Image_GetRed(*args, **kwargs)
2316
2317     def GetGreen(*args, **kwargs):
2318         """
2319         GetGreen(self, int x, int y) -> byte
2320
2321         Returns the green intensity at the given coordinate.
2322         """
2323         return _core_.Image_GetGreen(*args, **kwargs)
2324
2325     def GetBlue(*args, **kwargs):
2326         """
2327         GetBlue(self, int x, int y) -> byte
2328
2329         Returns the blue intensity at the given coordinate.
2330         """
2331         return _core_.Image_GetBlue(*args, **kwargs)
2332
2333     def SetAlpha(*args, **kwargs):
2334         """
2335         SetAlpha(self, int x, int y, byte alpha)
2336
2337         Sets the alpha value for the given pixel. This function should only be
2338         called if the image has alpha channel data, use `HasAlpha` to check
2339         for this.
2340         """
2341         return _core_.Image_SetAlpha(*args, **kwargs)
2342
2343     def GetAlpha(*args, **kwargs):
2344         """
2345         GetAlpha(self, int x, int y) -> byte
2346
2347         Returns the alpha value for the given pixel. This function may only be
2348         called for the images with alpha channel, use `HasAlpha` to check for
2349         this.
2350
2351         The returned value is the *opacity* of the image, i.e. the value of 0
2352         corresponds to the fully transparent pixels while the value of 255 to
2353         the fully opaque pixels.
2354         """
2355         return _core_.Image_GetAlpha(*args, **kwargs)
2356
2357     def HasAlpha(*args, **kwargs):
2358         """
2359         HasAlpha(self) -> bool
2360
2361         Returns true if this image has alpha channel, false otherwise.
2362         """
2363         return _core_.Image_HasAlpha(*args, **kwargs)
2364
2365     def InitAlpha(*args, **kwargs):
2366         """
2367         InitAlpha(self)
2368
2369         Initializes the image alpha channel data. It is an error to call it if
2370         the image already has alpha data. If it doesn't, alpha data will be by
2371         default initialized to all pixels being fully opaque. But if the image
2372         has a a mask colour, all mask pixels will be completely transparent.
2373         """
2374         return _core_.Image_InitAlpha(*args, **kwargs)
2375
2376     def IsTransparent(*args, **kwargs):
2377         """
2378         IsTransparent(self, int x, int y, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
2379
2380         Returns ``True`` if this pixel is masked or has an alpha value less
2381         than the spcified threshold.
2382         """
2383         return _core_.Image_IsTransparent(*args, **kwargs)
2384
2385     def FindFirstUnusedColour(*args, **kwargs):
2386         """
2387         FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2388
2389         Find first colour that is not used in the image and has higher RGB
2390         values than startR, startG, startB.  Returns a tuple consisting of a
2391         success flag and rgb values.
2392         """
2393         return _core_.Image_FindFirstUnusedColour(*args, **kwargs)
2394
2395     def ConvertAlphaToMask(*args, **kwargs):
2396         """
2397         ConvertAlphaToMask(self, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
2398
2399         If the image has alpha channel, this method converts it to mask. All
2400         pixels with alpha value less than ``threshold`` are replaced with the
2401         mask colour and the alpha channel is removed. The mask colour is
2402         chosen automatically using `FindFirstUnusedColour`.
2403
2404         If the image image doesn't have alpha channel, ConvertAlphaToMask does
2405         nothing.
2406         """
2407         return _core_.Image_ConvertAlphaToMask(*args, **kwargs)
2408
2409     def ConvertColourToAlpha(*args, **kwargs):
2410         """
2411         ConvertColourToAlpha(self, byte r, byte g, byte b) -> bool
2412
2413         This method converts an image where the original alpha information is
2414         only available as a shades of a colour (actually shades of grey)
2415         typically when you draw anti-aliased text into a bitmap. The DC
2416         drawing routines draw grey values on the black background although
2417         they actually mean to draw white with differnt alpha values.  This
2418         method reverses it, assuming a black (!) background and white text.
2419         The method will then fill up the whole image with the colour given.
2420         """
2421         return _core_.Image_ConvertColourToAlpha(*args, **kwargs)
2422
2423     def SetMaskFromImage(*args, **kwargs):
2424         """
2425         SetMaskFromImage(self, Image mask, byte mr, byte mg, byte mb) -> bool
2426
2427         Sets the image's mask so that the pixels that have RGB value of
2428         ``(mr,mg,mb)`` in ``mask`` will be masked in this image. This is done
2429         by first finding an unused colour in the image, setting this colour as
2430         the mask colour and then using this colour to draw all pixels in the
2431         image who corresponding pixel in mask has given RGB value.
2432
2433         Returns ``False`` if ``mask`` does not have same dimensions as the
2434         image or if there is no unused colour left. Returns ``True`` if the
2435         mask was successfully applied.
2436
2437         Note that this method involves computing the histogram, which is
2438         computationally intensive operation.
2439         """
2440         return _core_.Image_SetMaskFromImage(*args, **kwargs)
2441
2442     def CanRead(*args, **kwargs):
2443         """
2444         CanRead(String filename) -> bool
2445
2446         Returns True if the image handlers can read this file.
2447         """
2448         return _core_.Image_CanRead(*args, **kwargs)
2449
2450     CanRead = staticmethod(CanRead)
2451     def GetImageCount(*args, **kwargs):
2452         """
2453         GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
2454
2455         If the image file contains more than one image and the image handler
2456         is capable of retrieving these individually, this function will return
2457         the number of available images.
2458         """
2459         return _core_.Image_GetImageCount(*args, **kwargs)
2460
2461     GetImageCount = staticmethod(GetImageCount)
2462     def LoadFile(*args, **kwargs):
2463         """
2464         LoadFile(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2465
2466         Loads an image from a file. If no handler type is provided, the
2467         library will try to autodetect the format.
2468         """
2469         return _core_.Image_LoadFile(*args, **kwargs)
2470
2471     def LoadMimeFile(*args, **kwargs):
2472         """
2473         LoadMimeFile(self, String name, String mimetype, int index=-1) -> bool
2474
2475         Loads an image from a file, specifying the image type with a MIME type
2476         string.
2477         """
2478         return _core_.Image_LoadMimeFile(*args, **kwargs)
2479
2480     def SaveFile(*args, **kwargs):
2481         """
2482         SaveFile(self, String name, int type) -> bool
2483
2484         Saves an image in the named file.
2485         """
2486         return _core_.Image_SaveFile(*args, **kwargs)
2487
2488     def SaveMimeFile(*args, **kwargs):
2489         """
2490         SaveMimeFile(self, String name, String mimetype) -> bool
2491
2492         Saves an image in the named file.
2493         """
2494         return _core_.Image_SaveMimeFile(*args, **kwargs)
2495
2496     def CanReadStream(*args, **kwargs):
2497         """
2498         CanReadStream(InputStream stream) -> bool
2499
2500         Returns True if the image handlers can read an image file from the
2501         data currently on the input stream, or a readable Python file-like
2502         object.
2503         """
2504         return _core_.Image_CanReadStream(*args, **kwargs)
2505
2506     CanReadStream = staticmethod(CanReadStream)
2507     def LoadStream(*args, **kwargs):
2508         """
2509         LoadStream(self, InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2510
2511         Loads an image from an input stream or a readable Python file-like
2512         object. If no handler type is provided, the library will try to
2513         autodetect the format.
2514         """
2515         return _core_.Image_LoadStream(*args, **kwargs)
2516
2517     def LoadMimeStream(*args, **kwargs):
2518         """
2519         LoadMimeStream(self, InputStream stream, String mimetype, int index=-1) -> bool
2520
2521         Loads an image from an input stream or a readable Python file-like
2522         object, using a MIME type string to specify the image file format.
2523         """
2524         return _core_.Image_LoadMimeStream(*args, **kwargs)
2525
2526     def Ok(*args, **kwargs):
2527         """
2528         Ok(self) -> bool
2529
2530         Returns true if image data is present.
2531         """
2532         return _core_.Image_Ok(*args, **kwargs)
2533
2534     def GetWidth(*args, **kwargs):
2535         """
2536         GetWidth(self) -> int
2537
2538         Gets the width of the image in pixels.
2539         """
2540         return _core_.Image_GetWidth(*args, **kwargs)
2541
2542     def GetHeight(*args, **kwargs):
2543         """
2544         GetHeight(self) -> int
2545
2546         Gets the height of the image in pixels.
2547         """
2548         return _core_.Image_GetHeight(*args, **kwargs)
2549
2550     def GetSize(*args, **kwargs):
2551         """
2552         GetSize(self) -> Size
2553
2554         Returns the size of the image in pixels.
2555         """
2556         return _core_.Image_GetSize(*args, **kwargs)
2557
2558     def GetSubImage(*args, **kwargs):
2559         """
2560         GetSubImage(self, Rect rect) -> Image
2561
2562         Returns a sub image of the current one as long as the rect belongs
2563         entirely to the image.
2564         """
2565         return _core_.Image_GetSubImage(*args, **kwargs)
2566
2567     def Size(*args, **kwargs):
2568         """
2569         Size(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
2570
2571         Returns a resized version of this image without scaling it by adding
2572         either a border with the given colour or cropping as necessary. The
2573         image is pasted into a new image with the given size and background
2574         colour at the position ``pos`` relative to the upper left of the new
2575         image. If red = green = blue = -1 then use either the current mask
2576         colour if set or find, use, and set a suitable mask colour for any
2577         newly exposed areas.
2578         """
2579         return _core_.Image_Size(*args, **kwargs)
2580
2581     def Copy(*args, **kwargs):
2582         """
2583         Copy(self) -> Image
2584
2585         Returns an identical copy of the image.
2586         """
2587         return _core_.Image_Copy(*args, **kwargs)
2588
2589     def Paste(*args, **kwargs):
2590         """
2591         Paste(self, Image image, int x, int y)
2592
2593         Pastes ``image`` into this instance and takes care of the mask colour
2594         and any out of bounds problems.
2595         """
2596         return _core_.Image_Paste(*args, **kwargs)
2597
2598     def GetData(*args, **kwargs):
2599         """
2600         GetData(self) -> PyObject
2601
2602         Returns a string containing a copy of the RGB bytes of the image.
2603         """
2604         return _core_.Image_GetData(*args, **kwargs)
2605
2606     def SetData(*args, **kwargs):
2607         """
2608         SetData(self, buffer data)
2609
2610         Resets the Image's RGB data from a buffer of RGB bytes.  Accepts
2611         either a string or a buffer object holding the data and the length of
2612         the data must be width*height*3.
2613         """
2614         return _core_.Image_SetData(*args, **kwargs)
2615
2616     def GetDataBuffer(*args, **kwargs):
2617         """
2618         GetDataBuffer(self) -> PyObject
2619
2620         Returns a writable Python buffer object that is pointing at the RGB
2621         image data buffer inside the wx.Image. You need to ensure that you do
2622         not use this buffer object after the image has been destroyed.
2623         """
2624         return _core_.Image_GetDataBuffer(*args, **kwargs)
2625
2626     def SetDataBuffer(*args, **kwargs):
2627         """
2628         SetDataBuffer(self, buffer data)
2629
2630         Sets the internal image data pointer to point at a Python buffer
2631         object.  This can save making an extra copy of the data but you must
2632         ensure that the buffer object lives longer than the wx.Image does.
2633         """
2634         return _core_.Image_SetDataBuffer(*args, **kwargs)
2635
2636     def GetAlphaData(*args, **kwargs):
2637         """
2638         GetAlphaData(self) -> PyObject
2639
2640         Returns a string containing a copy of the alpha bytes of the image.
2641         """
2642         return _core_.Image_GetAlphaData(*args, **kwargs)
2643
2644     def SetAlphaData(*args, **kwargs):
2645         """
2646         SetAlphaData(self, buffer alpha)
2647
2648         Resets the Image's alpha data from a buffer of bytes.  Accepts either
2649         a string or a buffer object holding the data and the length of the
2650         data must be width*height.
2651         """
2652         return _core_.Image_SetAlphaData(*args, **kwargs)
2653
2654     def GetAlphaBuffer(*args, **kwargs):
2655         """GetAlphaBuffer(self) -> PyObject"""
2656         return _core_.Image_GetAlphaBuffer(*args, **kwargs)
2657
2658     def SetAlphaBuffer(*args, **kwargs):
2659         """SetAlphaBuffer(self, buffer alpha)"""
2660         return _core_.Image_SetAlphaBuffer(*args, **kwargs)
2661
2662     def SetMaskColour(*args, **kwargs):
2663         """
2664         SetMaskColour(self, byte r, byte g, byte b)
2665
2666         Sets the mask colour for this image (and tells the image to use the
2667         mask).
2668         """
2669         return _core_.Image_SetMaskColour(*args, **kwargs)
2670
2671     def GetOrFindMaskColour(*args, **kwargs):
2672         """
2673         GetOrFindMaskColour() -> (r,g,b)
2674
2675         Get the current mask colour or find a suitable colour.
2676         """
2677         return _core_.Image_GetOrFindMaskColour(*args, **kwargs)
2678
2679     def GetMaskRed(*args, **kwargs):
2680         """
2681         GetMaskRed(self) -> byte
2682
2683         Gets the red component of the mask colour.
2684         """
2685         return _core_.Image_GetMaskRed(*args, **kwargs)
2686
2687     def GetMaskGreen(*args, **kwargs):
2688         """
2689         GetMaskGreen(self) -> byte
2690
2691         Gets the green component of the mask colour.
2692         """
2693         return _core_.Image_GetMaskGreen(*args, **kwargs)
2694
2695     def GetMaskBlue(*args, **kwargs):
2696         """
2697         GetMaskBlue(self) -> byte
2698
2699         Gets the blue component of the mask colour.
2700         """
2701         return _core_.Image_GetMaskBlue(*args, **kwargs)
2702
2703     def SetMask(*args, **kwargs):
2704         """
2705         SetMask(self, bool mask=True)
2706
2707         Specifies whether there is a mask or not. The area of the mask is
2708         determined by the current mask colour.
2709         """
2710         return _core_.Image_SetMask(*args, **kwargs)
2711
2712     def HasMask(*args, **kwargs):
2713         """
2714         HasMask(self) -> bool
2715
2716         Returns ``True`` if there is a mask active, ``False`` otherwise.
2717         """
2718         return _core_.Image_HasMask(*args, **kwargs)
2719
2720     def Rotate(*args, **kwargs):
2721         """
2722         Rotate(self, double angle, Point centre_of_rotation, bool interpolating=True,
2723             Point offset_after_rotation=None) -> Image
2724
2725         Rotates the image about the given point, by ``angle`` radians. Passing
2726         ``True`` to ``interpolating`` results in better image quality, but is
2727         slower. If the image has a mask, then the mask colour is used for the
2728         uncovered pixels in the rotated image background. Otherwise, black
2729         will be used as the fill colour.
2730
2731         Returns the rotated image, leaving this image intact.
2732         """
2733         return _core_.Image_Rotate(*args, **kwargs)
2734
2735     def Rotate90(*args, **kwargs):
2736         """
2737         Rotate90(self, bool clockwise=True) -> Image
2738
2739         Returns a copy of the image rotated 90 degrees in the direction
2740         indicated by ``clockwise``.
2741         """
2742         return _core_.Image_Rotate90(*args, **kwargs)
2743
2744     def Mirror(*args, **kwargs):
2745         """
2746         Mirror(self, bool horizontally=True) -> Image
2747
2748         Returns a mirrored copy of the image. The parameter ``horizontally``
2749         indicates the orientation.
2750         """
2751         return _core_.Image_Mirror(*args, **kwargs)
2752
2753     def Replace(*args, **kwargs):
2754         """
2755         Replace(self, byte r1, byte g1, byte b1, byte r2, byte g2, byte b2)
2756
2757         Replaces the colour specified by ``(r1,g1,b1)`` by the colour
2758         ``(r2,g2,b2)``.
2759         """
2760         return _core_.Image_Replace(*args, **kwargs)
2761
2762     def ConvertToGreyscale(*args, **kwargs):
2763         """
2764         ConvertToGreyscale(self, double lr=0.299, double lg=0.587, double lb=0.114) -> Image
2765
2766         Convert to greyscale image. Uses the luminance component (Y) of the
2767         image.  The luma value (YUV) is calculated using (R * lr) + (G * lg) + (B * lb),
2768         defaults to ITU-T BT.601
2769         """
2770         return _core_.Image_ConvertToGreyscale(*args, **kwargs)
2771
2772     def ConvertToMono(*args, **kwargs):
2773         """
2774         ConvertToMono(self, byte r, byte g, byte b) -> Image
2775
2776         Returns monochromatic version of the image. The returned image has
2777         white colour where the original has ``(r,g,b)`` colour and black
2778         colour everywhere else.
2779         """
2780         return _core_.Image_ConvertToMono(*args, **kwargs)
2781
2782     def SetOption(*args, **kwargs):
2783         """
2784         SetOption(self, String name, String value)
2785
2786         Sets an image handler defined option.  For example, when saving as a
2787         JPEG file, the option ``wx.IMAGE_OPTION_QUALITY`` is used, which is a
2788         number between 0 and 100 (0 is terrible, 100 is very good).
2789         """
2790         return _core_.Image_SetOption(*args, **kwargs)
2791
2792     def SetOptionInt(*args, **kwargs):
2793         """
2794         SetOptionInt(self, String name, int value)
2795
2796         Sets an image option as an integer.
2797         """
2798         return _core_.Image_SetOptionInt(*args, **kwargs)
2799
2800     def GetOption(*args, **kwargs):
2801         """
2802         GetOption(self, String name) -> String
2803
2804         Gets the value of an image handler option.
2805         """
2806         return _core_.Image_GetOption(*args, **kwargs)
2807
2808     def GetOptionInt(*args, **kwargs):
2809         """
2810         GetOptionInt(self, String name) -> int
2811
2812         Gets the value of an image handler option as an integer.  If the given
2813         option is not present, the function returns 0.
2814         """
2815         return _core_.Image_GetOptionInt(*args, **kwargs)
2816
2817     def HasOption(*args, **kwargs):
2818         """
2819         HasOption(self, String name) -> bool
2820
2821         Returns true if the given option is present.
2822         """
2823         return _core_.Image_HasOption(*args, **kwargs)
2824
2825     def CountColours(*args, **kwargs):
2826         """CountColours(self, unsigned long stopafter=(unsigned long) -1) -> unsigned long"""
2827         return _core_.Image_CountColours(*args, **kwargs)
2828
2829     def ComputeHistogram(*args, **kwargs):
2830         """ComputeHistogram(self, ImageHistogram h) -> unsigned long"""
2831         return _core_.Image_ComputeHistogram(*args, **kwargs)
2832
2833     def AddHandler(*args, **kwargs):
2834         """AddHandler(ImageHandler handler)"""
2835         return _core_.Image_AddHandler(*args, **kwargs)
2836
2837     AddHandler = staticmethod(AddHandler)
2838     def InsertHandler(*args, **kwargs):
2839         """InsertHandler(ImageHandler handler)"""
2840         return _core_.Image_InsertHandler(*args, **kwargs)
2841
2842     InsertHandler = staticmethod(InsertHandler)
2843     def RemoveHandler(*args, **kwargs):
2844         """RemoveHandler(String name) -> bool"""
2845         return _core_.Image_RemoveHandler(*args, **kwargs)
2846
2847     RemoveHandler = staticmethod(RemoveHandler)
2848     def GetHandlers(*args, **kwargs):
2849         """GetHandlers() -> PyObject"""
2850         return _core_.Image_GetHandlers(*args, **kwargs)
2851
2852     GetHandlers = staticmethod(GetHandlers)
2853     def GetImageExtWildcard(*args, **kwargs):
2854         """
2855         GetImageExtWildcard() -> String
2856
2857         Iterates all registered wxImageHandler objects, and returns a string
2858         containing file extension masks suitable for passing to file open/save
2859         dialog boxes.
2860         """
2861         return _core_.Image_GetImageExtWildcard(*args, **kwargs)
2862
2863     GetImageExtWildcard = staticmethod(GetImageExtWildcard)
2864     def ConvertToBitmap(*args, **kwargs):
2865         """ConvertToBitmap(self, int depth=-1) -> Bitmap"""
2866         return _core_.Image_ConvertToBitmap(*args, **kwargs)
2867
2868     def ConvertToMonoBitmap(*args, **kwargs):
2869         """ConvertToMonoBitmap(self, byte red, byte green, byte blue) -> Bitmap"""
2870         return _core_.Image_ConvertToMonoBitmap(*args, **kwargs)
2871
2872     def RotateHue(*args, **kwargs):
2873         """
2874         RotateHue(self, double angle)
2875
2876         Rotates the hue of each pixel of the image. Hue is a double in the
2877         range -1.0..1.0 where -1.0 is -360 degrees and 1.0 is 360 degrees
2878         """
2879         return _core_.Image_RotateHue(*args, **kwargs)
2880
2881     def RGBtoHSV(*args, **kwargs):
2882         """
2883         RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
2884
2885         Converts a color in RGB color space to HSV color space.
2886         """
2887         return _core_.Image_RGBtoHSV(*args, **kwargs)
2888
2889     RGBtoHSV = staticmethod(RGBtoHSV)
2890     def HSVtoRGB(*args, **kwargs):
2891         """
2892         HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
2893
2894         Converts a color in HSV color space to RGB color space.
2895         """
2896         return _core_.Image_HSVtoRGB(*args, **kwargs)
2897
2898     HSVtoRGB = staticmethod(HSVtoRGB)
2899     def __nonzero__(self): return self.Ok()
2900 _core_.Image_swigregister(Image)
2901
2902 def ImageFromMime(*args, **kwargs):
2903     """
2904     ImageFromMime(String name, String mimetype, int index=-1) -> Image
2905
2906     Loads an image from a file, using a MIME type string (such as
2907     'image/jpeg') to specify image type.
2908     """
2909     val = _core_.new_ImageFromMime(*args, **kwargs)
2910     return val
2911
2912 def ImageFromStream(*args, **kwargs):
2913     """
2914     ImageFromStream(InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
2915
2916     Loads an image from an input stream, or any readable Python file-like
2917     object.
2918     """
2919     val = _core_.new_ImageFromStream(*args, **kwargs)
2920     return val
2921
2922 def ImageFromStreamMime(*args, **kwargs):
2923     """
2924     ImageFromStreamMime(InputStream stream, String mimetype, int index=-1) -> Image
2925
2926     Loads an image from an input stream, or any readable Python file-like
2927     object, specifying the image format with a MIME type string.
2928     """
2929     val = _core_.new_ImageFromStreamMime(*args, **kwargs)
2930     return val
2931
2932 def EmptyImage(*args, **kwargs):
2933     """
2934     EmptyImage(int width=0, int height=0, bool clear=True) -> Image
2935
2936     Construct an empty image of a given size, optionally setting all
2937     pixels to black.
2938     """
2939     val = _core_.new_EmptyImage(*args, **kwargs)
2940     return val
2941
2942 def ImageFromBitmap(*args, **kwargs):
2943     """
2944     ImageFromBitmap(Bitmap bitmap) -> Image
2945
2946     Construct an Image from a `wx.Bitmap`.
2947     """
2948     val = _core_.new_ImageFromBitmap(*args, **kwargs)
2949     return val
2950
2951 def ImageFromData(*args, **kwargs):
2952     """
2953     ImageFromData(int width, int height, buffer data) -> Image
2954
2955     Construct an Image from a buffer of RGB bytes.  Accepts either a
2956     string or a buffer object holding the data and the length of the data
2957     must be width*height*3.
2958     """
2959     val = _core_.new_ImageFromData(*args, **kwargs)
2960     return val
2961
2962 def ImageFromDataWithAlpha(*args, **kwargs):
2963     """
2964     ImageFromDataWithAlpha(int width, int height, buffer data, buffer alpha) -> Image
2965
2966     Construct an Image from a buffer of RGB bytes with an Alpha channel.
2967     Accepts either a string or a buffer object holding the data and the
2968     length of the data must be width*height*3 bytes, and the length of the
2969     alpha data must be width*height bytes.
2970     """
2971     val = _core_.new_ImageFromDataWithAlpha(*args, **kwargs)
2972     return val
2973
2974 def Image_CanRead(*args, **kwargs):
2975   """
2976     Image_CanRead(String filename) -> bool
2977
2978     Returns True if the image handlers can read this file.
2979     """
2980   return _core_.Image_CanRead(*args, **kwargs)
2981
2982 def Image_GetImageCount(*args, **kwargs):
2983   """
2984     Image_GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
2985
2986     If the image file contains more than one image and the image handler
2987     is capable of retrieving these individually, this function will return
2988     the number of available images.
2989     """
2990   return _core_.Image_GetImageCount(*args, **kwargs)
2991
2992 def Image_CanReadStream(*args, **kwargs):
2993   """
2994     Image_CanReadStream(InputStream stream) -> bool
2995
2996     Returns True if the image handlers can read an image file from the
2997     data currently on the input stream, or a readable Python file-like
2998     object.
2999     """
3000   return _core_.Image_CanReadStream(*args, **kwargs)
3001
3002 def Image_AddHandler(*args, **kwargs):
3003   """Image_AddHandler(ImageHandler handler)"""
3004   return _core_.Image_AddHandler(*args, **kwargs)
3005
3006 def Image_InsertHandler(*args, **kwargs):
3007   """Image_InsertHandler(ImageHandler handler)"""
3008   return _core_.Image_InsertHandler(*args, **kwargs)
3009
3010 def Image_RemoveHandler(*args, **kwargs):
3011   """Image_RemoveHandler(String name) -> bool"""
3012   return _core_.Image_RemoveHandler(*args, **kwargs)
3013
3014 def Image_GetHandlers(*args):
3015   """Image_GetHandlers() -> PyObject"""
3016   return _core_.Image_GetHandlers(*args)
3017
3018 def Image_GetImageExtWildcard(*args):
3019   """
3020     Image_GetImageExtWildcard() -> String
3021
3022     Iterates all registered wxImageHandler objects, and returns a string
3023     containing file extension masks suitable for passing to file open/save
3024     dialog boxes.
3025     """
3026   return _core_.Image_GetImageExtWildcard(*args)
3027
3028 def Image_RGBtoHSV(*args, **kwargs):
3029   """
3030     Image_RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
3031
3032     Converts a color in RGB color space to HSV color space.
3033     """
3034   return _core_.Image_RGBtoHSV(*args, **kwargs)
3035
3036 def Image_HSVtoRGB(*args, **kwargs):
3037   """
3038     Image_HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
3039
3040     Converts a color in HSV color space to RGB color space.
3041     """
3042   return _core_.Image_HSVtoRGB(*args, **kwargs)
3043
3044 def InitAllImageHandlers():
3045     """
3046     The former functionality of InitAllImageHanders is now done internal to
3047     the _core_ extension module and so this function has become a simple NOP.
3048     """
3049     pass
3050
3051 IMAGE_RESOLUTION_INCHES = _core_.IMAGE_RESOLUTION_INCHES
3052 IMAGE_RESOLUTION_CM = _core_.IMAGE_RESOLUTION_CM
3053 PNG_TYPE_COLOUR = _core_.PNG_TYPE_COLOUR
3054 PNG_TYPE_GREY = _core_.PNG_TYPE_GREY
3055 PNG_TYPE_GREY_RED = _core_.PNG_TYPE_GREY_RED
3056 BMP_24BPP = _core_.BMP_24BPP
3057 BMP_8BPP = _core_.BMP_8BPP
3058 BMP_8BPP_GREY = _core_.BMP_8BPP_GREY
3059 BMP_8BPP_GRAY = _core_.BMP_8BPP_GRAY
3060 BMP_8BPP_RED = _core_.BMP_8BPP_RED
3061 BMP_8BPP_PALETTE = _core_.BMP_8BPP_PALETTE
3062 BMP_4BPP = _core_.BMP_4BPP
3063 BMP_1BPP = _core_.BMP_1BPP
3064 BMP_1BPP_BW = _core_.BMP_1BPP_BW
3065 class BMPHandler(ImageHandler):
3066     """A `wx.ImageHandler` for \*.bmp bitmap files."""
3067     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3068     __repr__ = _swig_repr
3069     def __init__(self, *args, **kwargs):
3070         """
3071         __init__(self) -> BMPHandler
3072
3073         A `wx.ImageHandler` for \*.bmp bitmap files.
3074         """
3075         _core_.BMPHandler_swiginit(self,_core_.new_BMPHandler(*args, **kwargs))
3076 _core_.BMPHandler_swigregister(BMPHandler)
3077 NullImage = cvar.NullImage
3078 IMAGE_OPTION_FILENAME = cvar.IMAGE_OPTION_FILENAME
3079 IMAGE_OPTION_BMP_FORMAT = cvar.IMAGE_OPTION_BMP_FORMAT
3080 IMAGE_OPTION_CUR_HOTSPOT_X = cvar.IMAGE_OPTION_CUR_HOTSPOT_X
3081 IMAGE_OPTION_CUR_HOTSPOT_Y = cvar.IMAGE_OPTION_CUR_HOTSPOT_Y
3082 IMAGE_OPTION_RESOLUTION = cvar.IMAGE_OPTION_RESOLUTION
3083 IMAGE_OPTION_RESOLUTIONX = cvar.IMAGE_OPTION_RESOLUTIONX
3084 IMAGE_OPTION_RESOLUTIONY = cvar.IMAGE_OPTION_RESOLUTIONY
3085 IMAGE_OPTION_RESOLUTIONUNIT = cvar.IMAGE_OPTION_RESOLUTIONUNIT
3086 IMAGE_OPTION_QUALITY = cvar.IMAGE_OPTION_QUALITY
3087 IMAGE_OPTION_BITSPERSAMPLE = cvar.IMAGE_OPTION_BITSPERSAMPLE
3088 IMAGE_OPTION_SAMPLESPERPIXEL = cvar.IMAGE_OPTION_SAMPLESPERPIXEL
3089 IMAGE_OPTION_COMPRESSION = cvar.IMAGE_OPTION_COMPRESSION
3090 IMAGE_OPTION_IMAGEDESCRIPTOR = cvar.IMAGE_OPTION_IMAGEDESCRIPTOR
3091 IMAGE_OPTION_PNG_FORMAT = cvar.IMAGE_OPTION_PNG_FORMAT
3092 IMAGE_OPTION_PNG_BITDEPTH = cvar.IMAGE_OPTION_PNG_BITDEPTH
3093
3094 class ICOHandler(BMPHandler):
3095     """A `wx.ImageHandler` for \*.ico icon files."""
3096     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3097     __repr__ = _swig_repr
3098     def __init__(self, *args, **kwargs):
3099         """
3100         __init__(self) -> ICOHandler
3101
3102         A `wx.ImageHandler` for \*.ico icon files.
3103         """
3104         _core_.ICOHandler_swiginit(self,_core_.new_ICOHandler(*args, **kwargs))
3105 _core_.ICOHandler_swigregister(ICOHandler)
3106
3107 class CURHandler(ICOHandler):
3108     """A `wx.ImageHandler` for \*.cur cursor files."""
3109     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3110     __repr__ = _swig_repr
3111     def __init__(self, *args, **kwargs):
3112         """
3113         __init__(self) -> CURHandler
3114
3115         A `wx.ImageHandler` for \*.cur cursor files.
3116         """
3117         _core_.CURHandler_swiginit(self,_core_.new_CURHandler(*args, **kwargs))
3118 _core_.CURHandler_swigregister(CURHandler)
3119
3120 class ANIHandler(CURHandler):
3121     """A `wx.ImageHandler` for \*.ani animated cursor files."""
3122     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3123     __repr__ = _swig_repr
3124     def __init__(self, *args, **kwargs):
3125         """
3126         __init__(self) -> ANIHandler
3127
3128         A `wx.ImageHandler` for \*.ani animated cursor files.
3129         """
3130         _core_.ANIHandler_swiginit(self,_core_.new_ANIHandler(*args, **kwargs))
3131 _core_.ANIHandler_swigregister(ANIHandler)
3132
3133 class PNGHandler(ImageHandler):
3134     """A `wx.ImageHandler` for PNG image files."""
3135     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3136     __repr__ = _swig_repr
3137     def __init__(self, *args, **kwargs):
3138         """
3139         __init__(self) -> PNGHandler
3140
3141         A `wx.ImageHandler` for PNG image files.
3142         """
3143         _core_.PNGHandler_swiginit(self,_core_.new_PNGHandler(*args, **kwargs))
3144 _core_.PNGHandler_swigregister(PNGHandler)
3145
3146 class GIFHandler(ImageHandler):
3147     """A `wx.ImageHandler` for GIF image files."""
3148     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3149     __repr__ = _swig_repr
3150     def __init__(self, *args, **kwargs):
3151         """
3152         __init__(self) -> GIFHandler
3153
3154         A `wx.ImageHandler` for GIF image files.
3155         """
3156         _core_.GIFHandler_swiginit(self,_core_.new_GIFHandler(*args, **kwargs))
3157 _core_.GIFHandler_swigregister(GIFHandler)
3158
3159 class PCXHandler(ImageHandler):
3160     """A `wx.ImageHandler` for PCX imager files."""
3161     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3162     __repr__ = _swig_repr
3163     def __init__(self, *args, **kwargs):
3164         """
3165         __init__(self) -> PCXHandler
3166
3167         A `wx.ImageHandler` for PCX imager files.
3168         """
3169         _core_.PCXHandler_swiginit(self,_core_.new_PCXHandler(*args, **kwargs))
3170 _core_.PCXHandler_swigregister(PCXHandler)
3171
3172 class JPEGHandler(ImageHandler):
3173     """A `wx.ImageHandler` for JPEG/JPG image files."""
3174     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3175     __repr__ = _swig_repr
3176     def __init__(self, *args, **kwargs):
3177         """
3178         __init__(self) -> JPEGHandler
3179
3180         A `wx.ImageHandler` for JPEG/JPG image files.
3181         """
3182         _core_.JPEGHandler_swiginit(self,_core_.new_JPEGHandler(*args, **kwargs))
3183 _core_.JPEGHandler_swigregister(JPEGHandler)
3184
3185 class PNMHandler(ImageHandler):
3186     """A `wx.ImageHandler` for PNM image files."""
3187     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3188     __repr__ = _swig_repr
3189     def __init__(self, *args, **kwargs):
3190         """
3191         __init__(self) -> PNMHandler
3192
3193         A `wx.ImageHandler` for PNM image files.
3194         """
3195         _core_.PNMHandler_swiginit(self,_core_.new_PNMHandler(*args, **kwargs))
3196 _core_.PNMHandler_swigregister(PNMHandler)
3197
3198 class XPMHandler(ImageHandler):
3199     """A `wx.ImageHandler` for XPM image."""
3200     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3201     __repr__ = _swig_repr
3202     def __init__(self, *args, **kwargs):
3203         """
3204         __init__(self) -> XPMHandler
3205
3206         A `wx.ImageHandler` for XPM image.
3207         """
3208         _core_.XPMHandler_swiginit(self,_core_.new_XPMHandler(*args, **kwargs))
3209 _core_.XPMHandler_swigregister(XPMHandler)
3210
3211 class TIFFHandler(ImageHandler):
3212     """A `wx.ImageHandler` for TIFF image files."""
3213     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3214     __repr__ = _swig_repr
3215     def __init__(self, *args, **kwargs):
3216         """
3217         __init__(self) -> TIFFHandler
3218
3219         A `wx.ImageHandler` for TIFF image files.
3220         """
3221         _core_.TIFFHandler_swiginit(self,_core_.new_TIFFHandler(*args, **kwargs))
3222 _core_.TIFFHandler_swigregister(TIFFHandler)
3223
3224 QUANTIZE_INCLUDE_WINDOWS_COLOURS = _core_.QUANTIZE_INCLUDE_WINDOWS_COLOURS
3225 QUANTIZE_FILL_DESTINATION_IMAGE = _core_.QUANTIZE_FILL_DESTINATION_IMAGE
3226 class Quantize(object):
3227     """Performs quantization, or colour reduction, on a wxImage."""
3228     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3229     def __init__(self): raise AttributeError, "No constructor defined"
3230     __repr__ = _swig_repr
3231     def Quantize(*args, **kwargs):
3232         """
3233         Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
3234
3235         Reduce the colours in the source image and put the result into the
3236         destination image, setting the palette in the destination if
3237         needed. Both images may be the same, to overwrite the source image.
3238         """
3239         return _core_.Quantize_Quantize(*args, **kwargs)
3240
3241     Quantize = staticmethod(Quantize)
3242 _core_.Quantize_swigregister(Quantize)
3243
3244 def Quantize_Quantize(*args, **kwargs):
3245   """
3246     Quantize_Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
3247
3248     Reduce the colours in the source image and put the result into the
3249     destination image, setting the palette in the destination if
3250     needed. Both images may be the same, to overwrite the source image.
3251     """
3252   return _core_.Quantize_Quantize(*args, **kwargs)
3253
3254 #---------------------------------------------------------------------------
3255
3256 class EvtHandler(Object):
3257     """Proxy of C++ EvtHandler class"""
3258     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3259     __repr__ = _swig_repr
3260     def __init__(self, *args, **kwargs):
3261         """__init__(self) -> EvtHandler"""
3262         _core_.EvtHandler_swiginit(self,_core_.new_EvtHandler(*args, **kwargs))
3263     def GetNextHandler(*args, **kwargs):
3264         """GetNextHandler(self) -> EvtHandler"""
3265         return _core_.EvtHandler_GetNextHandler(*args, **kwargs)
3266
3267     def GetPreviousHandler(*args, **kwargs):
3268         """GetPreviousHandler(self) -> EvtHandler"""
3269         return _core_.EvtHandler_GetPreviousHandler(*args, **kwargs)
3270
3271     def SetNextHandler(*args, **kwargs):
3272         """SetNextHandler(self, EvtHandler handler)"""
3273         return _core_.EvtHandler_SetNextHandler(*args, **kwargs)
3274
3275     def SetPreviousHandler(*args, **kwargs):
3276         """SetPreviousHandler(self, EvtHandler handler)"""
3277         return _core_.EvtHandler_SetPreviousHandler(*args, **kwargs)
3278
3279     def GetEvtHandlerEnabled(*args, **kwargs):
3280         """GetEvtHandlerEnabled(self) -> bool"""
3281         return _core_.EvtHandler_GetEvtHandlerEnabled(*args, **kwargs)
3282
3283     def SetEvtHandlerEnabled(*args, **kwargs):
3284         """SetEvtHandlerEnabled(self, bool enabled)"""
3285         return _core_.EvtHandler_SetEvtHandlerEnabled(*args, **kwargs)
3286
3287     def ProcessEvent(*args, **kwargs):
3288         """ProcessEvent(self, Event event) -> bool"""
3289         return _core_.EvtHandler_ProcessEvent(*args, **kwargs)
3290
3291     def AddPendingEvent(*args, **kwargs):
3292         """AddPendingEvent(self, Event event)"""
3293         return _core_.EvtHandler_AddPendingEvent(*args, **kwargs)
3294
3295     def ProcessPendingEvents(*args, **kwargs):
3296         """ProcessPendingEvents(self)"""
3297         return _core_.EvtHandler_ProcessPendingEvents(*args, **kwargs)
3298
3299     def Connect(*args, **kwargs):
3300         """Connect(self, int id, int lastId, int eventType, PyObject func)"""
3301         return _core_.EvtHandler_Connect(*args, **kwargs)
3302
3303     def Disconnect(*args, **kwargs):
3304         """Disconnect(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL) -> bool"""
3305         return _core_.EvtHandler_Disconnect(*args, **kwargs)
3306
3307     def _setOORInfo(*args, **kwargs):
3308         """_setOORInfo(self, PyObject _self, bool incref=True)"""
3309         val = _core_.EvtHandler__setOORInfo(*args, **kwargs)
3310         args[0].thisown = 0
3311         return val
3312
3313     def Bind(self, event, handler, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
3314         """
3315         Bind an event to an event handler.
3316
3317         :param event: One of the EVT_* objects that specifies the
3318                       type of event to bind,
3319
3320         :param handler: A callable object to be invoked when the
3321                       event is delivered to self.  Pass None to
3322                       disconnect an event handler.
3323
3324         :param source: Sometimes the event originates from a
3325                       different window than self, but you still
3326                       want to catch it in self.  (For example, a
3327                       button event delivered to a frame.)  By
3328                       passing the source of the event, the event
3329                       handling system is able to differentiate
3330                       between the same event type from different
3331                       controls.
3332
3333         :param id: Used to spcify the event source by ID instead
3334                    of instance.
3335
3336         :param id2: Used when it is desirable to bind a handler
3337                       to a range of IDs, such as with EVT_MENU_RANGE.
3338         """
3339         if source is not None:
3340             id  = source.GetId()
3341         event.Bind(self, id, id2, handler)
3342
3343     def Unbind(self, event, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
3344         """
3345         Disconencts the event handler binding for event from self.
3346         Returns True if successful.
3347         """
3348         if source is not None:
3349             id  = source.GetId()
3350         return event.Unbind(self, id, id2)
3351
3352 _core_.EvtHandler_swigregister(EvtHandler)
3353
3354 #---------------------------------------------------------------------------
3355
3356 class PyEventBinder(object):
3357     """
3358     Instances of this class are used to bind specific events to event
3359     handlers.
3360     """
3361     def __init__(self, evtType, expectedIDs=0):
3362         if expectedIDs not in [0, 1, 2]:
3363             raise ValueError, "Invalid number of expectedIDs"
3364         self.expectedIDs = expectedIDs
3365
3366         if type(evtType) == list or type(evtType) == tuple:
3367             self.evtType = evtType
3368         else:
3369             self.evtType = [evtType]
3370
3371
3372     def Bind(self, target, id1, id2, function):
3373         """Bind this set of event types to target."""
3374         for et in self.evtType:
3375             target.Connect(id1, id2, et, function)
3376
3377
3378     def Unbind(self, target, id1, id2):
3379         """Remove an event binding."""
3380         success = 0
3381         for et in self.evtType:
3382             success += target.Disconnect(id1, id2, et)
3383         return success != 0
3384
3385
3386     def __call__(self, *args):
3387         """
3388         For backwards compatibility with the old EVT_* functions.
3389         Should be called with either (window, func), (window, ID,
3390         func) or (window, ID1, ID2, func) parameters depending on the
3391         type of the event.
3392         """
3393         assert len(args) == 2 + self.expectedIDs
3394         id1 = wx.ID_ANY
3395         id2 = wx.ID_ANY
3396         target = args[0]
3397         if self.expectedIDs == 0:
3398             func = args[1]
3399         elif self.expectedIDs == 1:
3400             id1 = args[1]
3401             func = args[2]
3402         elif self.expectedIDs == 2:
3403             id1 = args[1]
3404             id2 = args[2]
3405             func = args[3]
3406         else:
3407             raise ValueError, "Unexpected number of IDs"
3408
3409         self.Bind(target, id1, id2, func)
3410
3411
3412 # These two are square pegs that don't fit the PyEventBinder hole...
3413 def EVT_COMMAND(win, id, cmd, func):
3414     win.Connect(id, -1, cmd, func)
3415 def EVT_COMMAND_RANGE(win, id1, id2, cmd, func):
3416     win.Connect(id1, id2, cmd, func)
3417
3418
3419 #---------------------------------------------------------------------------
3420
3421 #---------------------------------------------------------------------------
3422
3423 EVENT_PROPAGATE_NONE = _core_.EVENT_PROPAGATE_NONE
3424 EVENT_PROPAGATE_MAX = _core_.EVENT_PROPAGATE_MAX
3425
3426 def NewEventType(*args):
3427   """NewEventType() -> EventType"""
3428   return _core_.NewEventType(*args)
3429 wxEVT_NULL = _core_.wxEVT_NULL
3430 wxEVT_FIRST = _core_.wxEVT_FIRST
3431 wxEVT_USER_FIRST = _core_.wxEVT_USER_FIRST
3432 wxEVT_COMMAND_BUTTON_CLICKED = _core_.wxEVT_COMMAND_BUTTON_CLICKED
3433 wxEVT_COMMAND_CHECKBOX_CLICKED = _core_.wxEVT_COMMAND_CHECKBOX_CLICKED
3434 wxEVT_COMMAND_CHOICE_SELECTED = _core_.wxEVT_COMMAND_CHOICE_SELECTED
3435 wxEVT_COMMAND_LISTBOX_SELECTED = _core_.wxEVT_COMMAND_LISTBOX_SELECTED
3436 wxEVT_COMMAND_LISTBOX_DOUBLECLICKED = _core_.wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
3437 wxEVT_COMMAND_CHECKLISTBOX_TOGGLED = _core_.wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
3438 wxEVT_COMMAND_MENU_SELECTED = _core_.wxEVT_COMMAND_MENU_SELECTED
3439 wxEVT_COMMAND_TOOL_CLICKED = _core_.wxEVT_COMMAND_TOOL_CLICKED
3440 wxEVT_COMMAND_SLIDER_UPDATED = _core_.wxEVT_COMMAND_SLIDER_UPDATED
3441 wxEVT_COMMAND_RADIOBOX_SELECTED = _core_.wxEVT_COMMAND_RADIOBOX_SELECTED
3442 wxEVT_COMMAND_RADIOBUTTON_SELECTED = _core_.wxEVT_COMMAND_RADIOBUTTON_SELECTED
3443 wxEVT_COMMAND_SCROLLBAR_UPDATED = _core_.wxEVT_COMMAND_SCROLLBAR_UPDATED
3444 wxEVT_COMMAND_VLBOX_SELECTED = _core_.wxEVT_COMMAND_VLBOX_SELECTED
3445 wxEVT_COMMAND_COMBOBOX_SELECTED = _core_.wxEVT_COMMAND_COMBOBOX_SELECTED
3446 wxEVT_COMMAND_TOOL_RCLICKED = _core_.wxEVT_COMMAND_TOOL_RCLICKED
3447 wxEVT_COMMAND_TOOL_ENTER = _core_.wxEVT_COMMAND_TOOL_ENTER
3448 wxEVT_LEFT_DOWN = _core_.wxEVT_LEFT_DOWN
3449 wxEVT_LEFT_UP = _core_.wxEVT_LEFT_UP
3450 wxEVT_MIDDLE_DOWN = _core_.wxEVT_MIDDLE_DOWN
3451 wxEVT_MIDDLE_UP = _core_.wxEVT_MIDDLE_UP
3452 wxEVT_RIGHT_DOWN = _core_.wxEVT_RIGHT_DOWN
3453 wxEVT_RIGHT_UP = _core_.wxEVT_RIGHT_UP
3454 wxEVT_MOTION = _core_.wxEVT_MOTION
3455 wxEVT_ENTER_WINDOW = _core_.wxEVT_ENTER_WINDOW
3456 wxEVT_LEAVE_WINDOW = _core_.wxEVT_LEAVE_WINDOW
3457 wxEVT_LEFT_DCLICK = _core_.wxEVT_LEFT_DCLICK
3458 wxEVT_MIDDLE_DCLICK = _core_.wxEVT_MIDDLE_DCLICK
3459 wxEVT_RIGHT_DCLICK = _core_.wxEVT_RIGHT_DCLICK
3460 wxEVT_SET_FOCUS = _core_.wxEVT_SET_FOCUS
3461 wxEVT_KILL_FOCUS = _core_.wxEVT_KILL_FOCUS
3462 wxEVT_CHILD_FOCUS = _core_.wxEVT_CHILD_FOCUS
3463 wxEVT_MOUSEWHEEL = _core_.wxEVT_MOUSEWHEEL
3464 wxEVT_NC_LEFT_DOWN = _core_.wxEVT_NC_LEFT_DOWN
3465 wxEVT_NC_LEFT_UP = _core_.wxEVT_NC_LEFT_UP
3466 wxEVT_NC_MIDDLE_DOWN = _core_.wxEVT_NC_MIDDLE_DOWN
3467 wxEVT_NC_MIDDLE_UP = _core_.wxEVT_NC_MIDDLE_UP
3468 wxEVT_NC_RIGHT_DOWN = _core_.wxEVT_NC_RIGHT_DOWN
3469 wxEVT_NC_RIGHT_UP = _core_.wxEVT_NC_RIGHT_UP
3470 wxEVT_NC_MOTION = _core_.wxEVT_NC_MOTION
3471 wxEVT_NC_ENTER_WINDOW = _core_.wxEVT_NC_ENTER_WINDOW
3472 wxEVT_NC_LEAVE_WINDOW = _core_.wxEVT_NC_LEAVE_WINDOW
3473 wxEVT_NC_LEFT_DCLICK = _core_.wxEVT_NC_LEFT_DCLICK
3474 wxEVT_NC_MIDDLE_DCLICK = _core_.wxEVT_NC_MIDDLE_DCLICK
3475 wxEVT_NC_RIGHT_DCLICK = _core_.wxEVT_NC_RIGHT_DCLICK
3476 wxEVT_CHAR = _core_.wxEVT_CHAR
3477 wxEVT_CHAR_HOOK = _core_.wxEVT_CHAR_HOOK
3478 wxEVT_NAVIGATION_KEY = _core_.wxEVT_NAVIGATION_KEY
3479 wxEVT_KEY_DOWN = _core_.wxEVT_KEY_DOWN
3480 wxEVT_KEY_UP = _core_.wxEVT_KEY_UP
3481 wxEVT_HOTKEY = _core_.wxEVT_HOTKEY
3482 wxEVT_SET_CURSOR = _core_.wxEVT_SET_CURSOR
3483 wxEVT_SCROLL_TOP = _core_.wxEVT_SCROLL_TOP
3484 wxEVT_SCROLL_BOTTOM = _core_.wxEVT_SCROLL_BOTTOM
3485 wxEVT_SCROLL_LINEUP = _core_.wxEVT_SCROLL_LINEUP
3486 wxEVT_SCROLL_LINEDOWN = _core_.wxEVT_SCROLL_LINEDOWN
3487 wxEVT_SCROLL_PAGEUP = _core_.wxEVT_SCROLL_PAGEUP
3488 wxEVT_SCROLL_PAGEDOWN = _core_.wxEVT_SCROLL_PAGEDOWN
3489 wxEVT_SCROLL_THUMBTRACK = _core_.wxEVT_SCROLL_THUMBTRACK
3490 wxEVT_SCROLL_THUMBRELEASE = _core_.wxEVT_SCROLL_THUMBRELEASE
3491 wxEVT_SCROLL_CHANGED = _core_.wxEVT_SCROLL_CHANGED
3492 wxEVT_SCROLL_ENDSCROLL = wxEVT_SCROLL_CHANGED
3493 wxEVT_SCROLLWIN_TOP = _core_.wxEVT_SCROLLWIN_TOP
3494 wxEVT_SCROLLWIN_BOTTOM = _core_.wxEVT_SCROLLWIN_BOTTOM
3495 wxEVT_SCROLLWIN_LINEUP = _core_.wxEVT_SCROLLWIN_LINEUP
3496 wxEVT_SCROLLWIN_LINEDOWN = _core_.wxEVT_SCROLLWIN_LINEDOWN
3497 wxEVT_SCROLLWIN_PAGEUP = _core_.wxEVT_SCROLLWIN_PAGEUP
3498 wxEVT_SCROLLWIN_PAGEDOWN = _core_.wxEVT_SCROLLWIN_PAGEDOWN
3499 wxEVT_SCROLLWIN_THUMBTRACK = _core_.wxEVT_SCROLLWIN_THUMBTRACK
3500 wxEVT_SCROLLWIN_THUMBRELEASE = _core_.wxEVT_SCROLLWIN_THUMBRELEASE
3501 wxEVT_SIZE = _core_.wxEVT_SIZE
3502 wxEVT_MOVE = _core_.wxEVT_MOVE
3503 wxEVT_CLOSE_WINDOW = _core_.wxEVT_CLOSE_WINDOW
3504 wxEVT_END_SESSION = _core_.wxEVT_END_SESSION
3505 wxEVT_QUERY_END_SESSION = _core_.wxEVT_QUERY_END_SESSION
3506 wxEVT_ACTIVATE_APP = _core_.wxEVT_ACTIVATE_APP
3507 wxEVT_ACTIVATE = _core_.wxEVT_ACTIVATE
3508 wxEVT_CREATE = _core_.wxEVT_CREATE
3509 wxEVT_DESTROY = _core_.wxEVT_DESTROY
3510 wxEVT_SHOW = _core_.wxEVT_SHOW
3511 wxEVT_ICONIZE = _core_.wxEVT_ICONIZE
3512 wxEVT_MAXIMIZE = _core_.wxEVT_MAXIMIZE
3513 wxEVT_MOUSE_CAPTURE_CHANGED = _core_.wxEVT_MOUSE_CAPTURE_CHANGED
3514 wxEVT_MOUSE_CAPTURE_LOST = _core_.wxEVT_MOUSE_CAPTURE_LOST
3515 wxEVT_PAINT = _core_.wxEVT_PAINT
3516 wxEVT_ERASE_BACKGROUND = _core_.wxEVT_ERASE_BACKGROUND
3517 wxEVT_NC_PAINT = _core_.wxEVT_NC_PAINT
3518 wxEVT_PAINT_ICON = _core_.wxEVT_PAINT_ICON
3519 wxEVT_MENU_OPEN = _core_.wxEVT_MENU_OPEN
3520 wxEVT_MENU_CLOSE = _core_.wxEVT_MENU_CLOSE
3521 wxEVT_MENU_HIGHLIGHT = _core_.wxEVT_MENU_HIGHLIGHT
3522 wxEVT_CONTEXT_MENU = _core_.wxEVT_CONTEXT_MENU
3523 wxEVT_SYS_COLOUR_CHANGED = _core_.wxEVT_SYS_COLOUR_CHANGED
3524 wxEVT_DISPLAY_CHANGED = _core_.wxEVT_DISPLAY_CHANGED
3525 wxEVT_SETTING_CHANGED = _core_.wxEVT_SETTING_CHANGED
3526 wxEVT_QUERY_NEW_PALETTE = _core_.wxEVT_QUERY_NEW_PALETTE
3527 wxEVT_PALETTE_CHANGED = _core_.wxEVT_PALETTE_CHANGED
3528 wxEVT_DROP_FILES = _core_.wxEVT_DROP_FILES
3529 wxEVT_DRAW_ITEM = _core_.wxEVT_DRAW_ITEM
3530 wxEVT_MEASURE_ITEM = _core_.wxEVT_MEASURE_ITEM
3531 wxEVT_COMPARE_ITEM = _core_.wxEVT_COMPARE_ITEM
3532 wxEVT_INIT_DIALOG = _core_.wxEVT_INIT_DIALOG
3533 wxEVT_IDLE = _core_.wxEVT_IDLE
3534 wxEVT_UPDATE_UI = _core_.wxEVT_UPDATE_UI
3535 wxEVT_SIZING = _core_.wxEVT_SIZING
3536 wxEVT_MOVING = _core_.wxEVT_MOVING
3537 wxEVT_HIBERNATE = _core_.wxEVT_HIBERNATE
3538 wxEVT_COMMAND_TEXT_COPY = _core_.wxEVT_COMMAND_TEXT_COPY
3539 wxEVT_COMMAND_TEXT_CUT = _core_.wxEVT_COMMAND_TEXT_CUT
3540 wxEVT_COMMAND_TEXT_PASTE = _core_.wxEVT_COMMAND_TEXT_PASTE
3541 wxEVT_COMMAND_LEFT_CLICK = _core_.wxEVT_COMMAND_LEFT_CLICK
3542 wxEVT_COMMAND_LEFT_DCLICK = _core_.wxEVT_COMMAND_LEFT_DCLICK
3543 wxEVT_COMMAND_RIGHT_CLICK = _core_.wxEVT_COMMAND_RIGHT_CLICK
3544 wxEVT_COMMAND_RIGHT_DCLICK = _core_.wxEVT_COMMAND_RIGHT_DCLICK
3545 wxEVT_COMMAND_SET_FOCUS = _core_.wxEVT_COMMAND_SET_FOCUS
3546 wxEVT_COMMAND_KILL_FOCUS = _core_.wxEVT_COMMAND_KILL_FOCUS
3547 wxEVT_COMMAND_ENTER = _core_.wxEVT_COMMAND_ENTER
3548 #
3549 # Create some event binders
3550 EVT_SIZE = wx.PyEventBinder( wxEVT_SIZE )
3551 EVT_SIZING = wx.PyEventBinder( wxEVT_SIZING )
3552 EVT_MOVE = wx.PyEventBinder( wxEVT_MOVE )
3553 EVT_MOVING = wx.PyEventBinder( wxEVT_MOVING )
3554 EVT_CLOSE = wx.PyEventBinder( wxEVT_CLOSE_WINDOW )
3555 EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
3556 EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
3557 EVT_PAINT = wx.PyEventBinder( wxEVT_PAINT )
3558 EVT_NC_PAINT = wx.PyEventBinder( wxEVT_NC_PAINT )
3559 EVT_ERASE_BACKGROUND = wx.PyEventBinder( wxEVT_ERASE_BACKGROUND )
3560 EVT_CHAR = wx.PyEventBinder( wxEVT_CHAR )
3561 EVT_KEY_DOWN = wx.PyEventBinder( wxEVT_KEY_DOWN )
3562 EVT_KEY_UP = wx.PyEventBinder( wxEVT_KEY_UP )
3563 EVT_HOTKEY = wx.PyEventBinder( wxEVT_HOTKEY, 1)
3564 EVT_CHAR_HOOK = wx.PyEventBinder( wxEVT_CHAR_HOOK )
3565 EVT_MENU_OPEN = wx.PyEventBinder( wxEVT_MENU_OPEN )
3566 EVT_MENU_CLOSE = wx.PyEventBinder( wxEVT_MENU_CLOSE )
3567 EVT_MENU_HIGHLIGHT = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT, 1)
3568 EVT_MENU_HIGHLIGHT_ALL = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT )
3569 EVT_SET_FOCUS = wx.PyEventBinder( wxEVT_SET_FOCUS )
3570 EVT_KILL_FOCUS = wx.PyEventBinder( wxEVT_KILL_FOCUS )
3571 EVT_CHILD_FOCUS = wx.PyEventBinder( wxEVT_CHILD_FOCUS )
3572 EVT_ACTIVATE = wx.PyEventBinder( wxEVT_ACTIVATE )
3573 EVT_ACTIVATE_APP = wx.PyEventBinder( wxEVT_ACTIVATE_APP )
3574 EVT_HIBERNATE = wx.PyEventBinder( wxEVT_HIBERNATE )
3575 EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
3576 EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
3577 EVT_DROP_FILES = wx.PyEventBinder( wxEVT_DROP_FILES )
3578 EVT_INIT_DIALOG = wx.PyEventBinder( wxEVT_INIT_DIALOG )
3579 EVT_SYS_COLOUR_CHANGED = wx.PyEventBinder( wxEVT_SYS_COLOUR_CHANGED )
3580 EVT_DISPLAY_CHANGED = wx.PyEventBinder( wxEVT_DISPLAY_CHANGED )
3581 EVT_SHOW = wx.PyEventBinder( wxEVT_SHOW )
3582 EVT_MAXIMIZE = wx.PyEventBinder( wxEVT_MAXIMIZE )
3583 EVT_ICONIZE = wx.PyEventBinder( wxEVT_ICONIZE )
3584 EVT_NAVIGATION_KEY = wx.PyEventBinder( wxEVT_NAVIGATION_KEY )
3585 EVT_PALETTE_CHANGED = wx.PyEventBinder( wxEVT_PALETTE_CHANGED )
3586 EVT_QUERY_NEW_PALETTE = wx.PyEventBinder( wxEVT_QUERY_NEW_PALETTE )
3587 EVT_WINDOW_CREATE = wx.PyEventBinder( wxEVT_CREATE )
3588 EVT_WINDOW_DESTROY = wx.PyEventBinder( wxEVT_DESTROY )
3589 EVT_SET_CURSOR = wx.PyEventBinder( wxEVT_SET_CURSOR )
3590 EVT_MOUSE_CAPTURE_CHANGED = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_CHANGED )
3591 EVT_MOUSE_CAPTURE_LOST = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_LOST )
3592
3593 EVT_LEFT_DOWN = wx.PyEventBinder( wxEVT_LEFT_DOWN )
3594 EVT_LEFT_UP = wx.PyEventBinder( wxEVT_LEFT_UP )
3595 EVT_MIDDLE_DOWN = wx.PyEventBinder( wxEVT_MIDDLE_DOWN )
3596 EVT_MIDDLE_UP = wx.PyEventBinder( wxEVT_MIDDLE_UP )
3597 EVT_RIGHT_DOWN = wx.PyEventBinder( wxEVT_RIGHT_DOWN )
3598 EVT_RIGHT_UP = wx.PyEventBinder( wxEVT_RIGHT_UP )
3599 EVT_MOTION = wx.PyEventBinder( wxEVT_MOTION )
3600 EVT_LEFT_DCLICK = wx.PyEventBinder( wxEVT_LEFT_DCLICK )
3601 EVT_MIDDLE_DCLICK = wx.PyEventBinder( wxEVT_MIDDLE_DCLICK )
3602 EVT_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_RIGHT_DCLICK )
3603 EVT_LEAVE_WINDOW = wx.PyEventBinder( wxEVT_LEAVE_WINDOW )
3604 EVT_ENTER_WINDOW = wx.PyEventBinder( wxEVT_ENTER_WINDOW )
3605 EVT_MOUSEWHEEL = wx.PyEventBinder( wxEVT_MOUSEWHEEL )
3606
3607 EVT_MOUSE_EVENTS = wx.PyEventBinder([ wxEVT_LEFT_DOWN,
3608                                      wxEVT_LEFT_UP,
3609                                      wxEVT_MIDDLE_DOWN,
3610                                      wxEVT_MIDDLE_UP,
3611                                      wxEVT_RIGHT_DOWN,
3612                                      wxEVT_RIGHT_UP,
3613                                      wxEVT_MOTION,
3614                                      wxEVT_LEFT_DCLICK,
3615                                      wxEVT_MIDDLE_DCLICK,
3616                                      wxEVT_RIGHT_DCLICK,
3617                                      wxEVT_ENTER_WINDOW,
3618                                      wxEVT_LEAVE_WINDOW,
3619                                      wxEVT_MOUSEWHEEL
3620                                      ])
3621
3622
3623 # Scrolling from wxWindow (sent to wxScrolledWindow)
3624 EVT_SCROLLWIN = wx.PyEventBinder([ wxEVT_SCROLLWIN_TOP,
3625                                   wxEVT_SCROLLWIN_BOTTOM,
3626                                   wxEVT_SCROLLWIN_LINEUP,
3627                                   wxEVT_SCROLLWIN_LINEDOWN,
3628                                   wxEVT_SCROLLWIN_PAGEUP,
3629                                   wxEVT_SCROLLWIN_PAGEDOWN,
3630                                   wxEVT_SCROLLWIN_THUMBTRACK,
3631                                   wxEVT_SCROLLWIN_THUMBRELEASE,
3632                                   ])
3633
3634 EVT_SCROLLWIN_TOP = wx.PyEventBinder( wxEVT_SCROLLWIN_TOP )
3635 EVT_SCROLLWIN_BOTTOM = wx.PyEventBinder( wxEVT_SCROLLWIN_BOTTOM )
3636 EVT_SCROLLWIN_LINEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEUP )
3637 EVT_SCROLLWIN_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEDOWN )
3638 EVT_SCROLLWIN_PAGEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEUP )
3639 EVT_SCROLLWIN_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEDOWN )
3640 EVT_SCROLLWIN_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBTRACK )
3641 EVT_SCROLLWIN_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBRELEASE )
3642
3643 # Scrolling from wx.Slider and wx.ScrollBar
3644 EVT_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
3645                                wxEVT_SCROLL_BOTTOM,
3646                                wxEVT_SCROLL_LINEUP,
3647                                wxEVT_SCROLL_LINEDOWN,
3648                                wxEVT_SCROLL_PAGEUP,
3649                                wxEVT_SCROLL_PAGEDOWN,
3650                                wxEVT_SCROLL_THUMBTRACK,
3651                                wxEVT_SCROLL_THUMBRELEASE,
3652                                wxEVT_SCROLL_CHANGED,
3653                                ])
3654
3655 EVT_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP )
3656 EVT_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM )
3657 EVT_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP )
3658 EVT_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN )
3659 EVT_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP )
3660 EVT_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN )
3661 EVT_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK )
3662 EVT_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE )
3663 EVT_SCROLL_CHANGED = wx.PyEventBinder( wxEVT_SCROLL_CHANGED )
3664 EVT_SCROLL_ENDSCROLL = EVT_SCROLL_CHANGED
3665
3666 # Scrolling from wx.Slider and wx.ScrollBar, with an id
3667 EVT_COMMAND_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
3668                                        wxEVT_SCROLL_BOTTOM,
3669                                        wxEVT_SCROLL_LINEUP,
3670                                        wxEVT_SCROLL_LINEDOWN,
3671                                        wxEVT_SCROLL_PAGEUP,
3672                                        wxEVT_SCROLL_PAGEDOWN,
3673                                        wxEVT_SCROLL_THUMBTRACK,
3674                                        wxEVT_SCROLL_THUMBRELEASE,
3675                                        wxEVT_SCROLL_CHANGED,
3676                                        ], 1)
3677
3678 EVT_COMMAND_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP, 1)
3679 EVT_COMMAND_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM, 1)
3680 EVT_COMMAND_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP, 1)
3681 EVT_COMMAND_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN, 1)
3682 EVT_COMMAND_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP, 1)
3683 EVT_COMMAND_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN, 1)
3684 EVT_COMMAND_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK, 1)
3685 EVT_COMMAND_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE, 1)
3686 EVT_COMMAND_SCROLL_CHANGED = wx.PyEventBinder( wxEVT_SCROLL_CHANGED, 1)
3687 EVT_COMMAND_SCROLL_ENDSCROLL = EVT_COMMAND_SCROLL_CHANGED
3688
3689 EVT_BUTTON = wx.PyEventBinder( wxEVT_COMMAND_BUTTON_CLICKED, 1)
3690 EVT_CHECKBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKBOX_CLICKED, 1)
3691 EVT_CHOICE = wx.PyEventBinder( wxEVT_COMMAND_CHOICE_SELECTED, 1)
3692 EVT_LISTBOX = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_SELECTED, 1)
3693 EVT_LISTBOX_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, 1)
3694 EVT_MENU = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 1)
3695 EVT_MENU_RANGE = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 2)
3696 EVT_SLIDER = wx.PyEventBinder( wxEVT_COMMAND_SLIDER_UPDATED, 1)
3697 EVT_RADIOBOX = wx.PyEventBinder( wxEVT_COMMAND_RADIOBOX_SELECTED, 1)
3698 EVT_RADIOBUTTON = wx.PyEventBinder( wxEVT_COMMAND_RADIOBUTTON_SELECTED, 1)
3699
3700 EVT_SCROLLBAR = wx.PyEventBinder( wxEVT_COMMAND_SCROLLBAR_UPDATED, 1)
3701 EVT_VLBOX = wx.PyEventBinder( wxEVT_COMMAND_VLBOX_SELECTED, 1)
3702 EVT_COMBOBOX = wx.PyEventBinder( wxEVT_COMMAND_COMBOBOX_SELECTED, 1)
3703 EVT_TOOL = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 1)
3704 EVT_TOOL_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 2)
3705 EVT_TOOL_RCLICKED = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 1)
3706 EVT_TOOL_RCLICKED_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 2)
3707 EVT_TOOL_ENTER = wx.PyEventBinder( wxEVT_COMMAND_TOOL_ENTER, 1)
3708 EVT_CHECKLISTBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, 1)
3709
3710
3711 EVT_COMMAND_LEFT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_CLICK, 1)
3712 EVT_COMMAND_LEFT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_DCLICK, 1)
3713 EVT_COMMAND_RIGHT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_CLICK, 1)
3714 EVT_COMMAND_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_DCLICK, 1)
3715 EVT_COMMAND_SET_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_SET_FOCUS, 1)
3716 EVT_COMMAND_KILL_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_KILL_FOCUS, 1)
3717 EVT_COMMAND_ENTER = wx.PyEventBinder( wxEVT_COMMAND_ENTER, 1)
3718
3719 EVT_IDLE = wx.PyEventBinder( wxEVT_IDLE )
3720
3721 EVT_UPDATE_UI = wx.PyEventBinder( wxEVT_UPDATE_UI, 1)
3722 EVT_UPDATE_UI_RANGE = wx.PyEventBinder( wxEVT_UPDATE_UI, 2)
3723
3724 EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU )
3725
3726 EVT_TEXT_CUT   =  wx.PyEventBinder( wxEVT_COMMAND_TEXT_CUT )
3727 EVT_TEXT_COPY  =  wx.PyEventBinder( wxEVT_COMMAND_TEXT_COPY )
3728 EVT_TEXT_PASTE =  wx.PyEventBinder( wxEVT_COMMAND_TEXT_PASTE )
3729
3730
3731 #---------------------------------------------------------------------------
3732
3733 class Event(Object):
3734     """
3735     An event is a structure holding information about an event passed to a
3736     callback or member function. wx.Event is an abstract base class for
3737     other event classes
3738     """
3739     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3740     def __init__(self): raise AttributeError, "No constructor defined"
3741     __repr__ = _swig_repr
3742     __swig_destroy__ = _core_.delete_Event
3743     __del__ = lambda self : None;
3744     def SetEventType(*args, **kwargs):
3745         """
3746         SetEventType(self, EventType typ)
3747
3748         Sets the specific type of the event.
3749         """
3750         return _core_.Event_SetEventType(*args, **kwargs)
3751
3752     def GetEventType(*args, **kwargs):
3753         """
3754         GetEventType(self) -> EventType
3755
3756         Returns the identifier of the given event type, such as
3757         ``wxEVT_COMMAND_BUTTON_CLICKED``.
3758         """
3759         return _core_.Event_GetEventType(*args, **kwargs)
3760
3761     def GetEventObject(*args, **kwargs):
3762         """
3763         GetEventObject(self) -> Object
3764
3765         Returns the object (usually a window) associated with the event, if
3766         any.
3767         """
3768         return _core_.Event_GetEventObject(*args, **kwargs)
3769
3770     def SetEventObject(*args, **kwargs):
3771         """
3772         SetEventObject(self, Object obj)
3773
3774         Sets the originating object, or in other words, obj is normally the
3775         object that is sending the event.
3776         """
3777         return _core_.Event_SetEventObject(*args, **kwargs)
3778
3779     def GetTimestamp(*args, **kwargs):
3780         """GetTimestamp(self) -> long"""
3781         return _core_.Event_GetTimestamp(*args, **kwargs)
3782
3783     def SetTimestamp(*args, **kwargs):
3784         """SetTimestamp(self, long ts=0)"""
3785         return _core_.Event_SetTimestamp(*args, **kwargs)
3786
3787     def GetId(*args, **kwargs):
3788         """
3789         GetId(self) -> int
3790
3791         Returns the identifier associated with this event, such as a button
3792         command id.
3793         """
3794         return _core_.Event_GetId(*args, **kwargs)
3795
3796     def SetId(*args, **kwargs):
3797         """
3798         SetId(self, int Id)
3799
3800         Set's the ID for the event.  This is usually the ID of the window that
3801         is sending the event, but it can also be a command id from a menu
3802         item, etc.
3803         """
3804         return _core_.Event_SetId(*args, **kwargs)
3805
3806     def IsCommandEvent(*args, **kwargs):
3807         """
3808         IsCommandEvent(self) -> bool
3809
3810         Returns true if the event is or is derived from `wx.CommandEvent` else
3811         it returns false. Note: Exists only for optimization purposes.
3812         """
3813         return _core_.Event_IsCommandEvent(*args, **kwargs)
3814
3815     def Skip(*args, **kwargs):
3816         """
3817         Skip(self, bool skip=True)
3818
3819         Called by an event handler, it controls whether additional event
3820         handlers bound to this event will be called after the current event
3821         handler returns.  Skip(false) (the default setting) will prevent
3822         additional event handlers from being called and control will be
3823         returned to the sender of the event immediately after the current
3824         handler has finished.  Skip(True) will cause the event processing
3825         system to continue searching for a handler function for this event.
3826
3827         """
3828         return _core_.Event_Skip(*args, **kwargs)
3829
3830     def GetSkipped(*args, **kwargs):
3831         """
3832         GetSkipped(self) -> bool
3833
3834         Returns true if the event handler should be skipped, false otherwise.
3835         :see: `Skip`
3836         """
3837         return _core_.Event_GetSkipped(*args, **kwargs)
3838
3839     def ShouldPropagate(*args, **kwargs):
3840         """
3841         ShouldPropagate(self) -> bool
3842
3843         Test if this event should be propagated to the parent window or not,
3844         i.e. if the propagation level is currently greater than 0.
3845         """
3846         return _core_.Event_ShouldPropagate(*args, **kwargs)
3847
3848     def StopPropagation(*args, **kwargs):
3849         """
3850         StopPropagation(self) -> int
3851
3852         Stop the event from propagating to its parent window.  Returns the old
3853         propagation level value which may be later passed to
3854         `ResumePropagation` to allow propagating the event again.
3855         """
3856         return _core_.Event_StopPropagation(*args, **kwargs)
3857
3858     def ResumePropagation(*args, **kwargs):
3859         """
3860         ResumePropagation(self, int propagationLevel)
3861
3862         Resume the event propagation by restoring the propagation level.  (For
3863         example, you can use the value returned by an earlier call to
3864         `StopPropagation`.)
3865
3866         """
3867         return _core_.Event_ResumePropagation(*args, **kwargs)
3868
3869     def Clone(*args, **kwargs):
3870         """Clone(self) -> Event"""
3871         return _core_.Event_Clone(*args, **kwargs)
3872
3873 _core_.Event_swigregister(Event)
3874
3875 #---------------------------------------------------------------------------
3876
3877 class PropagationDisabler(object):
3878     """
3879     Helper class to temporarily change an event not to propagate.  Simply
3880     create an instance of this class and then whe it is destroyed the
3881     propogation of the event will be restored.
3882     """
3883     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3884     __repr__ = _swig_repr
3885     def __init__(self, *args, **kwargs):
3886         """
3887         __init__(self, Event event) -> PropagationDisabler
3888
3889         Helper class to temporarily change an event not to propagate.  Simply
3890         create an instance of this class and then whe it is destroyed the
3891         propogation of the event will be restored.
3892         """
3893         _core_.PropagationDisabler_swiginit(self,_core_.new_PropagationDisabler(*args, **kwargs))
3894     __swig_destroy__ = _core_.delete_PropagationDisabler
3895     __del__ = lambda self : None;
3896 _core_.PropagationDisabler_swigregister(PropagationDisabler)
3897
3898 class PropagateOnce(object):
3899     """
3900     A helper class that will temporarily lower propagation level of an
3901     event.  Simply create an instance of this class and then whe it is
3902     destroyed the propogation of the event will be restored.
3903     """
3904     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3905     __repr__ = _swig_repr
3906     def __init__(self, *args, **kwargs):
3907         """
3908         __init__(self, Event event) -> PropagateOnce
3909
3910         A helper class that will temporarily lower propagation level of an
3911         event.  Simply create an instance of this class and then whe it is
3912         destroyed the propogation of the event will be restored.
3913         """
3914         _core_.PropagateOnce_swiginit(self,_core_.new_PropagateOnce(*args, **kwargs))
3915     __swig_destroy__ = _core_.delete_PropagateOnce
3916     __del__ = lambda self : None;
3917 _core_.PropagateOnce_swigregister(PropagateOnce)
3918
3919 #---------------------------------------------------------------------------
3920
3921 class CommandEvent(Event):
3922     """
3923     This event class contains information about command events, which
3924     originate from a variety of simple controls, as well as menus and
3925     toolbars.
3926     """
3927     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3928     __repr__ = _swig_repr
3929     def __init__(self, *args, **kwargs):
3930         """
3931         __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent
3932
3933         This event class contains information about command events, which
3934         originate from a variety of simple controls, as well as menus and
3935         toolbars.
3936         """
3937         _core_.CommandEvent_swiginit(self,_core_.new_CommandEvent(*args, **kwargs))
3938     def GetSelection(*args, **kwargs):
3939         """
3940         GetSelection(self) -> int
3941
3942         Returns item index for a listbox or choice selection event (not valid
3943         for a deselection).
3944         """
3945         return _core_.CommandEvent_GetSelection(*args, **kwargs)
3946
3947     def SetString(*args, **kwargs):
3948         """SetString(self, String s)"""
3949         return _core_.CommandEvent_SetString(*args, **kwargs)
3950
3951     def GetString(*args, **kwargs):
3952         """
3953         GetString(self) -> String
3954
3955         Returns item string for a listbox or choice selection event (not valid
3956         for a deselection).
3957         """
3958         return _core_.CommandEvent_GetString(*args, **kwargs)
3959
3960     def IsChecked(*args, **kwargs):
3961         """
3962         IsChecked(self) -> bool
3963
3964         This method can be used with checkbox and menu events: for the
3965         checkboxes, the method returns true for a selection event and false
3966         for a deselection one. For the menu events, this method indicates if
3967         the menu item just has become checked or unchecked (and thus only
3968         makes sense for checkable menu items).
3969         """
3970         return _core_.CommandEvent_IsChecked(*args, **kwargs)
3971
3972     Checked = IsChecked
3973     def IsSelection(*args, **kwargs):
3974         """
3975         IsSelection(self) -> bool
3976
3977         For a listbox or similar event, returns true if it is a selection,
3978         false if it is a deselection.
3979         """
3980         return _core_.CommandEvent_IsSelection(*args, **kwargs)
3981
3982     def SetExtraLong(*args, **kwargs):
3983         """SetExtraLong(self, long extraLong)"""
3984         return _core_.CommandEvent_SetExtraLong(*args, **kwargs)
3985
3986     def GetExtraLong(*args, **kwargs):
3987         """
3988         GetExtraLong(self) -> long
3989
3990         Returns extra information dependant on the event objects type. If the
3991         event comes from a listbox selection, it is a boolean determining
3992         whether the event was a selection (true) or a deselection (false). A
3993         listbox deselection only occurs for multiple-selection boxes, and in
3994         this case the index and string values are indeterminate and the
3995         listbox must be examined by the application.
3996         """
3997         return _core_.CommandEvent_GetExtraLong(*args, **kwargs)
3998
3999     def SetInt(*args, **kwargs):
4000         """SetInt(self, int i)"""
4001         return _core_.CommandEvent_SetInt(*args, **kwargs)
4002
4003     def GetInt(*args, **kwargs):
4004         """
4005         GetInt(self) -> int
4006
4007         Returns the integer identifier corresponding to a listbox, choice or
4008         radiobox selection (only if the event was a selection, not a
4009         deselection), or a boolean value representing the value of a checkbox.
4010         """
4011         return _core_.CommandEvent_GetInt(*args, **kwargs)
4012
4013     def GetClientData(*args, **kwargs):
4014         """
4015         GetClientData(self) -> PyObject
4016
4017         Returns the client data object for a listbox or choice selection event, (if any.)
4018         """
4019         return _core_.CommandEvent_GetClientData(*args, **kwargs)
4020
4021     def SetClientData(*args, **kwargs):
4022         """
4023         SetClientData(self, PyObject clientData)
4024
4025         Associate the given client data with the item at position n.
4026         """
4027         return _core_.CommandEvent_SetClientData(*args, **kwargs)
4028
4029     GetClientObject = GetClientData
4030     SetClientObject = SetClientData
4031
4032     def Clone(*args, **kwargs):
4033         """Clone(self) -> Event"""
4034         return _core_.CommandEvent_Clone(*args, **kwargs)
4035
4036 _core_.CommandEvent_swigregister(CommandEvent)
4037
4038 #---------------------------------------------------------------------------
4039
4040 class NotifyEvent(CommandEvent):
4041     """
4042     An instance of this class (or one of its derived classes) is sent from
4043     a control when the control's state is being changed and the control
4044     allows that change to be prevented from happening.  The event handler
4045     can call `Veto` or `Allow` to tell the control what to do.
4046     """
4047     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4048     __repr__ = _swig_repr
4049     def __init__(self, *args, **kwargs):
4050         """
4051         __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent
4052
4053         An instance of this class (or one of its derived classes) is sent from
4054         a control when the control's state is being changed and the control
4055         allows that change to be prevented from happening.  The event handler
4056         can call `Veto` or `Allow` to tell the control what to do.
4057         """
4058         _core_.NotifyEvent_swiginit(self,_core_.new_NotifyEvent(*args, **kwargs))
4059     def Veto(*args, **kwargs):
4060         """
4061         Veto(self)
4062
4063         Prevents the change announced by this event from happening.
4064
4065         It is in general a good idea to notify the user about the reasons for
4066         vetoing the change because otherwise the applications behaviour (which
4067         just refuses to do what the user wants) might be quite surprising.
4068         """
4069         return _core_.NotifyEvent_Veto(*args, **kwargs)
4070
4071     def Allow(*args, **kwargs):
4072         """
4073         Allow(self)
4074
4075         This is the opposite of `Veto`: it explicitly allows the event to be
4076         processed. For most events it is not necessary to call this method as
4077         the events are allowed anyhow but some are forbidden by default (this
4078         will be mentioned in the corresponding event description).
4079         """
4080         return _core_.NotifyEvent_Allow(*args, **kwargs)
4081
4082     def IsAllowed(*args, **kwargs):
4083         """
4084         IsAllowed(self) -> bool
4085
4086         Returns true if the change is allowed (`Veto` hasn't been called) or
4087         false otherwise (if it was).
4088         """
4089         return _core_.NotifyEvent_IsAllowed(*args, **kwargs)
4090
4091 _core_.NotifyEvent_swigregister(NotifyEvent)
4092
4093 #---------------------------------------------------------------------------
4094
4095 class ScrollEvent(CommandEvent):
4096     """
4097     A scroll event holds information about events sent from stand-alone
4098     scrollbars and sliders. Note that scrolled windows do not send
4099     instnaces of this event class, but send the `wx.ScrollWinEvent`
4100     instead.
4101     """
4102     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4103     __repr__ = _swig_repr
4104     def __init__(self, *args, **kwargs):
4105         """
4106         __init__(self, EventType commandType=wxEVT_NULL, int winid=0, int pos=0,
4107             int orient=0) -> ScrollEvent
4108         """
4109         _core_.ScrollEvent_swiginit(self,_core_.new_ScrollEvent(*args, **kwargs))
4110     def GetOrientation(*args, **kwargs):
4111         """
4112         GetOrientation(self) -> int
4113
4114         Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4115         the scrollbar.
4116         """
4117         return _core_.ScrollEvent_GetOrientation(*args, **kwargs)
4118
4119     def GetPosition(*args, **kwargs):
4120         """
4121         GetPosition(self) -> int
4122
4123         Returns the position of the scrollbar.
4124         """
4125         return _core_.ScrollEvent_GetPosition(*args, **kwargs)
4126
4127     def SetOrientation(*args, **kwargs):
4128         """SetOrientation(self, int orient)"""
4129         return _core_.ScrollEvent_SetOrientation(*args, **kwargs)
4130
4131     def SetPosition(*args, **kwargs):
4132         """SetPosition(self, int pos)"""
4133         return _core_.ScrollEvent_SetPosition(*args, **kwargs)
4134
4135 _core_.ScrollEvent_swigregister(ScrollEvent)
4136
4137 #---------------------------------------------------------------------------
4138
4139 class ScrollWinEvent(Event):
4140     """
4141     A wx.ScrollWinEvent holds information about scrolling and is sent from
4142     scrolling windows.
4143     """
4144     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4145     __repr__ = _swig_repr
4146     def __init__(self, *args, **kwargs):
4147         """
4148         __init__(self, EventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent
4149
4150         A wx.ScrollWinEvent holds information about scrolling and is sent from
4151         scrolling windows.
4152         """
4153         _core_.ScrollWinEvent_swiginit(self,_core_.new_ScrollWinEvent(*args, **kwargs))
4154     def GetOrientation(*args, **kwargs):
4155         """
4156         GetOrientation(self) -> int
4157
4158         Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4159         the scrollbar.
4160         """
4161         return _core_.ScrollWinEvent_GetOrientation(*args, **kwargs)
4162
4163     def GetPosition(*args, **kwargs):
4164         """
4165         GetPosition(self) -> int
4166
4167         Returns the position of the scrollbar for the thumb track and release
4168         events. Note that this field can't be used for the other events, you
4169         need to query the window itself for the current position in that case.
4170         """
4171         return _core_.ScrollWinEvent_GetPosition(*args, **kwargs)
4172
4173     def SetOrientation(*args, **kwargs):
4174         """SetOrientation(self, int orient)"""
4175         return _core_.ScrollWinEvent_SetOrientation(*args, **kwargs)
4176
4177     def SetPosition(*args, **kwargs):
4178         """SetPosition(self, int pos)"""
4179         return _core_.ScrollWinEvent_SetPosition(*args, **kwargs)
4180
4181 _core_.ScrollWinEvent_swigregister(ScrollWinEvent)
4182
4183 #---------------------------------------------------------------------------
4184
4185 MOUSE_BTN_ANY = _core_.MOUSE_BTN_ANY
4186 MOUSE_BTN_NONE = _core_.MOUSE_BTN_NONE
4187 MOUSE_BTN_LEFT = _core_.MOUSE_BTN_LEFT
4188 MOUSE_BTN_MIDDLE = _core_.MOUSE_BTN_MIDDLE
4189 MOUSE_BTN_RIGHT = _core_.MOUSE_BTN_RIGHT
4190 class MouseEvent(Event):
4191     """
4192     This event class contains information about the events generated by
4193     the mouse: they include mouse buttons press and release events and
4194     mouse move events.
4195
4196     All mouse events involving the buttons use ``wx.MOUSE_BTN_LEFT`` for
4197     the left mouse button, ``wx.MOUSE_BTN_MIDDLE`` for the middle one and
4198     ``wx.MOUSE_BTN_RIGHT`` for the right one. Note that not all mice have
4199     a middle button so a portable application should avoid relying on the
4200     events from it.
4201
4202     Note the difference between methods like `LeftDown` and `LeftIsDown`:
4203     the former returns true when the event corresponds to the left mouse
4204     button click while the latter returns true if the left mouse button is
4205     currently being pressed. For example, when the user is dragging the
4206     mouse you can use `LeftIsDown` to test whether the left mouse button
4207     is (still) depressed. Also, by convention, if `LeftDown` returns true,
4208     `LeftIsDown` will also return true in wxWidgets whatever the
4209     underlying GUI behaviour is (which is platform-dependent). The same
4210     applies, of course, to other mouse buttons as well.
4211     """
4212     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4213     __repr__ = _swig_repr
4214     def __init__(self, *args, **kwargs):
4215         """
4216         __init__(self, EventType mouseType=wxEVT_NULL) -> MouseEvent
4217
4218         Constructs a wx.MouseEvent.  Valid event types are:
4219
4220             * wxEVT_ENTER_WINDOW
4221             * wxEVT_LEAVE_WINDOW
4222             * wxEVT_LEFT_DOWN
4223             * wxEVT_LEFT_UP
4224             * wxEVT_LEFT_DCLICK
4225             * wxEVT_MIDDLE_DOWN
4226             * wxEVT_MIDDLE_UP
4227             * wxEVT_MIDDLE_DCLICK
4228             * wxEVT_RIGHT_DOWN
4229             * wxEVT_RIGHT_UP
4230             * wxEVT_RIGHT_DCLICK
4231             * wxEVT_MOTION
4232             * wxEVT_MOUSEWHEEL
4233         """
4234         _core_.MouseEvent_swiginit(self,_core_.new_MouseEvent(*args, **kwargs))
4235     def IsButton(*args, **kwargs):
4236         """
4237         IsButton(self) -> bool
4238
4239         Returns true if the event was a mouse button event (not necessarily a
4240         button down event - that may be tested using `ButtonDown`).
4241         """
4242         return _core_.MouseEvent_IsButton(*args, **kwargs)
4243
4244     def ButtonDown(*args, **kwargs):
4245         """
4246         ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool
4247
4248         If the argument is omitted, this returns true if the event was any
4249         mouse button down event. Otherwise the argument specifies which
4250         button-down event shold be checked for (see `Button` for the possible
4251         values).
4252         """
4253         return _core_.MouseEvent_ButtonDown(*args, **kwargs)
4254
4255     def ButtonDClick(*args, **kwargs):
4256         """
4257         ButtonDClick(self, int but=MOUSE_BTN_ANY) -> bool
4258
4259         If the argument is omitted, this returns true if the event was any
4260         mouse double click event. Otherwise the argument specifies which
4261         double click event to check for (see `Button` for the possible
4262         values).
4263         """
4264         return _core_.MouseEvent_ButtonDClick(*args, **kwargs)
4265
4266     def ButtonUp(*args, **kwargs):
4267         """
4268         ButtonUp(self, int but=MOUSE_BTN_ANY) -> bool
4269
4270         If the argument is omitted, this returns true if the event was any
4271         mouse button up event. Otherwise the argument specifies which button
4272         up event to check for (see `Button` for the possible values).
4273         """
4274         return _core_.MouseEvent_ButtonUp(*args, **kwargs)
4275
4276     def Button(*args, **kwargs):
4277         """
4278         Button(self, int button) -> bool
4279
4280         Returns true if the identified mouse button is changing state. Valid
4281         values of button are:
4282
4283              ====================      =====================================
4284              wx.MOUSE_BTN_LEFT         check if left button was pressed
4285              wx.MOUSE_BTN_MIDDLE       check if middle button was pressed
4286              wx.MOUSE_BTN_RIGHT        check if right button was pressed
4287              wx.MOUSE_BTN_ANY          check if any button was pressed
4288              ====================      =====================================
4289
4290         """
4291         return _core_.MouseEvent_Button(*args, **kwargs)
4292
4293     def ButtonIsDown(*args, **kwargs):
4294         """ButtonIsDown(self, int but) -> bool"""
4295         return _core_.MouseEvent_ButtonIsDown(*args, **kwargs)
4296
4297     def GetButton(*args, **kwargs):
4298         """
4299         GetButton(self) -> int
4300
4301         Returns the mouse button which generated this event or
4302         wx.MOUSE_BTN_NONE if no button is involved (for mouse move, enter or
4303         leave event, for example). Otherwise wx.MOUSE_BTN_LEFT is returned for
4304         the left button down, up and double click events, wx.MOUSE_BTN_MIDDLE
4305         and wx.MOUSE_BTN_RIGHT for the same events for the middle and the
4306         right buttons respectively.
4307         """
4308         return _core_.MouseEvent_GetButton(*args, **kwargs)
4309
4310     def ControlDown(*args, **kwargs):
4311         """
4312         ControlDown(self) -> bool
4313
4314         Returns true if the control key was down at the time of the event.
4315         """
4316         return _core_.MouseEvent_ControlDown(*args, **kwargs)
4317
4318     def MetaDown(*args, **kwargs):
4319         """
4320         MetaDown(self) -> bool
4321
4322         Returns true if the Meta key was down at the time of the event.
4323         """
4324         return _core_.MouseEvent_MetaDown(*args, **kwargs)
4325
4326     def AltDown(*args, **kwargs):
4327         """
4328         AltDown(self) -> bool
4329
4330         Returns true if the Alt key was down at the time of the event.
4331         """
4332         return _core_.MouseEvent_AltDown(*args, **kwargs)
4333
4334     def ShiftDown(*args, **kwargs):
4335         """
4336         ShiftDown(self) -> bool
4337
4338         Returns true if the Shift key was down at the time of the event.
4339         """
4340         return _core_.MouseEvent_ShiftDown(*args, **kwargs)
4341
4342     def CmdDown(*args, **kwargs):
4343         """
4344         CmdDown(self) -> bool
4345
4346         "Cmd" is a pseudo key which is the same as Control for PC and Unix
4347         platforms but the special "Apple" (a.k.a as "Command") key on
4348         Macs. It often makes sense to use it instead of, say, `ControlDown`
4349         because Cmd key is used for the same thing under Mac as Ctrl
4350         elsewhere. The Ctrl key still exists, it's just not used for this
4351         purpose. So for non-Mac platforms this is the same as `ControlDown`
4352         and Macs this is the same as `MetaDown`.
4353         """
4354         return _core_.MouseEvent_CmdDown(*args, **kwargs)
4355
4356     def LeftDown(*args, **kwargs):
4357         """
4358         LeftDown(self) -> bool
4359
4360         Returns true if the left mouse button state changed to down.
4361         """
4362         return _core_.MouseEvent_LeftDown(*args, **kwargs)
4363
4364     def MiddleDown(*args, **kwargs):
4365         """
4366         MiddleDown(self) -> bool
4367
4368         Returns true if the middle mouse button state changed to down.
4369         """
4370         return _core_.MouseEvent_MiddleDown(*args, **kwargs)
4371
4372     def RightDown(*args, **kwargs):
4373         """
4374         RightDown(self) -> bool
4375
4376         Returns true if the right mouse button state changed to down.
4377         """
4378         return _core_.MouseEvent_RightDown(*args, **kwargs)
4379
4380     def LeftUp(*args, **kwargs):
4381         """
4382         LeftUp(self) -> bool
4383
4384         Returns true if the left mouse button state changed to up.
4385         """
4386         return _core_.MouseEvent_LeftUp(*args, **kwargs)
4387
4388     def MiddleUp(*args, **kwargs):
4389         """
4390         MiddleUp(self) -> bool
4391
4392         Returns true if the middle mouse button state changed to up.
4393         """
4394         return _core_.MouseEvent_MiddleUp(*args, **kwargs)
4395
4396     def RightUp(*args, **kwargs):
4397         """
4398         RightUp(self) -> bool
4399
4400         Returns true if the right mouse button state changed to up.
4401         """
4402         return _core_.MouseEvent_RightUp(*args, **kwargs)
4403
4404     def LeftDClick(*args, **kwargs):
4405         """
4406         LeftDClick(self) -> bool
4407
4408         Returns true if the event was a left button double click.
4409         """
4410         return _core_.MouseEvent_LeftDClick(*args, **kwargs)
4411
4412     def MiddleDClick(*args, **kwargs):
4413         """
4414         MiddleDClick(self) -> bool
4415
4416         Returns true if the event was a middle button double click.
4417         """
4418         return _core_.MouseEvent_MiddleDClick(*args, **kwargs)
4419
4420     def RightDClick(*args, **kwargs):
4421         """
4422         RightDClick(self) -> bool
4423
4424         Returns true if the event was a right button double click.
4425         """
4426         return _core_.MouseEvent_RightDClick(*args, **kwargs)
4427
4428     def LeftIsDown(*args, **kwargs):
4429         """
4430         LeftIsDown(self) -> bool
4431
4432         Returns true if the left mouse button is currently down, independent
4433         of the current event type.
4434
4435         Please notice that it is not the same as LeftDown which returns true
4436         if the left mouse button was just pressed. Rather, it describes the
4437         state of the mouse button before the event happened.
4438
4439         This event is usually used in the mouse event handlers which process
4440         "move mouse" messages to determine whether the user is (still)
4441         dragging the mouse.
4442         """
4443         return _core_.MouseEvent_LeftIsDown(*args, **kwargs)
4444
4445     def MiddleIsDown(*args, **kwargs):
4446         """
4447         MiddleIsDown(self) -> bool
4448
4449         Returns true if the middle mouse button is currently down, independent
4450         of the current event type.
4451         """
4452         return _core_.MouseEvent_MiddleIsDown(*args, **kwargs)
4453
4454     def RightIsDown(*args, **kwargs):
4455         """
4456         RightIsDown(self) -> bool
4457
4458         Returns true if the right mouse button is currently down, independent
4459         of the current event type.
4460         """
4461         return _core_.MouseEvent_RightIsDown(*args, **kwargs)
4462
4463     def Dragging(*args, **kwargs):
4464         """
4465         Dragging(self) -> bool
4466
4467         Returns true if this was a dragging event (motion while a button is
4468         depressed).
4469         """
4470         return _core_.MouseEvent_Dragging(*args, **kwargs)
4471
4472     def Moving(*args, **kwargs):
4473         """
4474         Moving(self) -> bool
4475
4476         Returns true if this was a motion event and no mouse buttons were
4477         pressed. If any mouse button is held pressed, then this method returns
4478         false and Dragging returns true.
4479         """
4480         return _core_.MouseEvent_Moving(*args, **kwargs)
4481
4482     def Entering(*args, **kwargs):
4483         """
4484         Entering(self) -> bool
4485
4486         Returns true if the mouse was entering the window.
4487         """
4488         return _core_.MouseEvent_Entering(*args, **kwargs)
4489
4490     def Leaving(*args, **kwargs):
4491         """
4492         Leaving(self) -> bool
4493
4494         Returns true if the mouse was leaving the window.
4495         """
4496         return _core_.MouseEvent_Leaving(*args, **kwargs)
4497
4498     def GetPosition(*args, **kwargs):
4499         """
4500         GetPosition(self) -> Point
4501
4502         Returns the pixel position of the mouse in window coordinates when the
4503         event happened.
4504         """
4505         return _core_.MouseEvent_GetPosition(*args, **kwargs)
4506
4507     def GetPositionTuple(*args, **kwargs):
4508         """
4509         GetPositionTuple() -> (x,y)
4510
4511         Returns the pixel position of the mouse in window coordinates when the
4512         event happened.
4513         """
4514         return _core_.MouseEvent_GetPositionTuple(*args, **kwargs)
4515
4516     def GetLogicalPosition(*args, **kwargs):
4517         """
4518         GetLogicalPosition(self, DC dc) -> Point
4519
4520         Returns the logical mouse position in pixels (i.e. translated
4521         according to the translation set for the DC, which usually indicates
4522         that the window has been scrolled).
4523         """
4524         return _core_.MouseEvent_GetLogicalPosition(*args, **kwargs)
4525
4526     def GetX(*args, **kwargs):
4527         """
4528         GetX(self) -> int
4529
4530         Returns X coordinate of the physical mouse event position.
4531         """
4532         return _core_.MouseEvent_GetX(*args, **kwargs)
4533
4534     def GetY(*args, **kwargs):
4535         """
4536         GetY(self) -> int
4537
4538         Returns Y coordinate of the physical mouse event position.
4539         """
4540         return _core_.MouseEvent_GetY(*args, **kwargs)
4541
4542     def GetWheelRotation(*args, **kwargs):
4543         """
4544         GetWheelRotation(self) -> int
4545
4546         Get wheel rotation, positive or negative indicates direction of
4547         rotation. Current devices all send an event when rotation is equal to
4548         +/-WheelDelta, but this allows for finer resolution devices to be
4549         created in the future. Because of this you shouldn't assume that one
4550         event is equal to 1 line or whatever, but you should be able to either
4551         do partial line scrolling or wait until +/-WheelDelta rotation values
4552         have been accumulated before scrolling.
4553         """
4554         return _core_.MouseEvent_GetWheelRotation(*args, **kwargs)
4555
4556     def GetWheelDelta(*args, **kwargs):
4557         """
4558         GetWheelDelta(self) -> int
4559
4560         Get wheel delta, normally 120. This is the threshold for action to be
4561         taken, and one such action (for example, scrolling one increment)
4562         should occur for each delta.
4563         """
4564         return _core_.MouseEvent_GetWheelDelta(*args, **kwargs)
4565
4566     def GetLinesPerAction(*args, **kwargs):
4567         """
4568         GetLinesPerAction(self) -> int
4569
4570         Returns the configured number of lines (or whatever) to be scrolled
4571         per wheel action. Defaults to three.
4572         """
4573         return _core_.MouseEvent_GetLinesPerAction(*args, **kwargs)
4574
4575     def IsPageScroll(*args, **kwargs):
4576         """
4577         IsPageScroll(self) -> bool
4578
4579         Returns true if the system has been setup to do page scrolling with
4580         the mouse wheel instead of line scrolling.
4581         """
4582         return _core_.MouseEvent_IsPageScroll(*args, **kwargs)
4583
4584     m_x = property(_core_.MouseEvent_m_x_get, _core_.MouseEvent_m_x_set)
4585     m_y = property(_core_.MouseEvent_m_y_get, _core_.MouseEvent_m_y_set)
4586     m_leftDown = property(_core_.MouseEvent_m_leftDown_get, _core_.MouseEvent_m_leftDown_set)
4587     m_middleDown = property(_core_.MouseEvent_m_middleDown_get, _core_.MouseEvent_m_middleDown_set)
4588     m_rightDown = property(_core_.MouseEvent_m_rightDown_get, _core_.MouseEvent_m_rightDown_set)
4589     m_controlDown = property(_core_.MouseEvent_m_controlDown_get, _core_.MouseEvent_m_controlDown_set)
4590     m_shiftDown = property(_core_.MouseEvent_m_shiftDown_get, _core_.MouseEvent_m_shiftDown_set)
4591     m_altDown = property(_core_.MouseEvent_m_altDown_get, _core_.MouseEvent_m_altDown_set)
4592     m_metaDown = property(_core_.MouseEvent_m_metaDown_get, _core_.MouseEvent_m_metaDown_set)
4593     m_wheelRotation = property(_core_.MouseEvent_m_wheelRotation_get, _core_.MouseEvent_m_wheelRotation_set)
4594     m_wheelDelta = property(_core_.MouseEvent_m_wheelDelta_get, _core_.MouseEvent_m_wheelDelta_set)
4595     m_linesPerAction = property(_core_.MouseEvent_m_linesPerAction_get, _core_.MouseEvent_m_linesPerAction_set)
4596 _core_.MouseEvent_swigregister(MouseEvent)
4597
4598 #---------------------------------------------------------------------------
4599
4600 class SetCursorEvent(Event):
4601     """
4602     A SetCursorEvent is generated when the mouse cursor is about to be set
4603     as a result of mouse motion. This event gives the application the
4604     chance to perform specific mouse cursor processing based on the
4605     current position of the mouse within the window. Use the `SetCursor`
4606     method to specify the cursor you want to be displayed.
4607     """
4608     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4609     __repr__ = _swig_repr
4610     def __init__(self, *args, **kwargs):
4611         """
4612         __init__(self, int x=0, int y=0) -> SetCursorEvent
4613
4614         Construct a new `wx.SetCursorEvent`.
4615         """
4616         _core_.SetCursorEvent_swiginit(self,_core_.new_SetCursorEvent(*args, **kwargs))
4617     def GetX(*args, **kwargs):
4618         """
4619         GetX(self) -> int
4620
4621         Returns the X coordinate of the mouse in client coordinates.
4622         """
4623         return _core_.SetCursorEvent_GetX(*args, **kwargs)
4624
4625     def GetY(*args, **kwargs):
4626         """
4627         GetY(self) -> int
4628
4629         Returns the Y coordinate of the mouse in client coordinates.
4630         """
4631         return _core_.SetCursorEvent_GetY(*args, **kwargs)
4632
4633     def SetCursor(*args, **kwargs):
4634         """
4635         SetCursor(self, Cursor cursor)
4636
4637         Sets the cursor associated with this event.
4638         """
4639         return _core_.SetCursorEvent_SetCursor(*args, **kwargs)
4640
4641     def GetCursor(*args, **kwargs):
4642         """
4643         GetCursor(self) -> Cursor
4644
4645         Returns a reference to the cursor specified by this event.
4646         """
4647         return _core_.SetCursorEvent_GetCursor(*args, **kwargs)
4648
4649     def HasCursor(*args, **kwargs):
4650         """
4651         HasCursor(self) -> bool
4652
4653         Returns true if the cursor specified by this event is a valid cursor.
4654         """
4655         return _core_.SetCursorEvent_HasCursor(*args, **kwargs)
4656
4657 _core_.SetCursorEvent_swigregister(SetCursorEvent)
4658
4659 #---------------------------------------------------------------------------
4660
4661 class KeyEvent(Event):
4662     """
4663     This event class contains information about keypress and character
4664     events.  These events are only sent to the widget that currently has
4665     the keyboard focus.
4666
4667     Notice that there are three different kinds of keyboard events in
4668     wxWidgets: key down and up events and char events. The difference
4669     between the first two is clear - the first corresponds to a key press
4670     and the second to a key release - otherwise they are identical. Just
4671     note that if the key is maintained in a pressed state you will
4672     typically get a lot of (automatically generated) down events but only
4673     one up so it is wrong to assume that there is one up event
4674     corresponding to each down one.
4675
4676     Both key events provide untranslated key codes while the char event
4677     carries the translated one. The untranslated code for alphanumeric
4678     keys is always an upper case value. For the other keys it is one of
4679     WXK_XXX values from the keycodes table. The translated key is, in
4680     general, the character the user expects to appear as the result of the
4681     key combination when typing the text into a text entry zone, for
4682     example.
4683
4684     A few examples to clarify this (all assume that CAPS LOCK is unpressed
4685     and the standard US keyboard): when the 'A' key is pressed, the key
4686     down event key code is equal to ASCII A == 65. But the char event key
4687     code is ASCII a == 97. On the other hand, if you press both SHIFT and
4688     'A' keys simultaneously , the key code in key down event will still be
4689     just 'A' while the char event key code parameter will now be 'A' as
4690     well.
4691
4692     Although in this simple case it is clear that the correct key code
4693     could be found in the key down event handler by checking the value
4694     returned by `ShiftDown`, in general you should use EVT_CHAR for this
4695     as for non alphanumeric keys or non-US keyboard layouts the
4696     translation is keyboard-layout dependent and can only be done properly
4697     by the system itself.
4698
4699     Another kind of translation is done when the control key is pressed:
4700     for example, for CTRL-A key press the key down event still carries the
4701     same key code 'A' as usual but the char event will have key code of 1,
4702     the ASCII value of this key combination.
4703
4704     You may discover how the other keys on your system behave
4705     interactively by running the KeyEvents sample in the wxPython demo and
4706     pressing some keys while the blue box at the top has the keyboard
4707     focus.
4708
4709     **Note**: If a key down event is caught and the event handler does not
4710     call event.Skip() then the coresponding char event will not
4711     happen. This is by design and enables the programs that handle both
4712     types of events to be a bit simpler.
4713
4714     **Note for Windows programmers**: The key and char events in wxWidgets
4715     are similar to but slightly different from Windows WM_KEYDOWN and
4716     WM_CHAR events. In particular, Alt-x combination will generate a char
4717     event in wxWidgets (unless it is used as an accelerator).
4718
4719     **Tip**: be sure to call event.Skip() for events that you don't
4720     process in key event function, otherwise menu shortcuts may cease to
4721     work under Windows.
4722
4723     """
4724     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4725     __repr__ = _swig_repr
4726     def __init__(self, *args, **kwargs):
4727         """
4728         __init__(self, EventType eventType=wxEVT_NULL) -> KeyEvent
4729
4730         Construct a new `wx.KeyEvent`.  Valid event types are:
4731             *
4732         """
4733         _core_.KeyEvent_swiginit(self,_core_.new_KeyEvent(*args, **kwargs))
4734     def GetModifiers(*args, **kwargs):
4735         """
4736         GetModifiers(self) -> int
4737
4738         Returns a bitmask of the current modifier settings.  Can be used to
4739         check if the key event has exactly the given modifiers without having
4740         to explicitly check that the other modifiers are not down.  For
4741         example::
4742
4743             if event.GetModifers() == wx.MOD_CONTROL:
4744                 DoSomething()
4745
4746         """
4747         return _core_.KeyEvent_GetModifiers(*args, **kwargs)
4748
4749     def ControlDown(*args, **kwargs):
4750         """
4751         ControlDown(self) -> bool
4752
4753         Returns ``True`` if the Control key was down at the time of the event.
4754         """
4755         return _core_.KeyEvent_ControlDown(*args, **kwargs)
4756
4757     def MetaDown(*args, **kwargs):
4758         """
4759         MetaDown(self) -> bool
4760
4761         Returns ``True`` if the Meta key was down at the time of the event.
4762         """
4763         return _core_.KeyEvent_MetaDown(*args, **kwargs)
4764
4765     def AltDown(*args, **kwargs):
4766         """
4767         AltDown(self) -> bool
4768
4769         Returns ``True`` if the Alt key was down at the time of the event.
4770         """
4771         return _core_.KeyEvent_AltDown(*args, **kwargs)
4772
4773     def ShiftDown(*args, **kwargs):
4774         """
4775         ShiftDown(self) -> bool
4776
4777         Returns ``True`` if the Shift key was down at the time of the event.
4778         """
4779         return _core_.KeyEvent_ShiftDown(*args, **kwargs)
4780
4781     def CmdDown(*args, **kwargs):
4782         """
4783         CmdDown(self) -> bool
4784
4785         "Cmd" is a pseudo key which is the same as Control for PC and Unix
4786         platforms but the special "Apple" (a.k.a as "Command") key on
4787         Macs. It makes often sense to use it instead of, say, `ControlDown`
4788         because Cmd key is used for the same thing under Mac as Ctrl
4789         elsewhere. The Ctrl still exists, it's just not used for this
4790         purpose. So for non-Mac platforms this is the same as `ControlDown`
4791         and Macs this is the same as `MetaDown`.
4792         """
4793         return _core_.KeyEvent_CmdDown(*args, **kwargs)
4794
4795     def HasModifiers(*args, **kwargs):
4796         """
4797         HasModifiers(self) -> bool
4798
4799         Returns true if either CTRL or ALT keys was down at the time of the
4800         key event. Note that this function does not take into account neither
4801         SHIFT nor META key states (the reason for ignoring the latter is that
4802         it is common for NUMLOCK key to be configured as META under X but the
4803         key presses even while NUMLOCK is on should be still processed
4804         normally).
4805         """
4806         return _core_.KeyEvent_HasModifiers(*args, **kwargs)
4807
4808     def GetKeyCode(*args, **kwargs):
4809         """
4810         GetKeyCode(self) -> int
4811
4812         Returns the virtual key code. ASCII events return normal ASCII values,
4813         while non-ASCII events return values such as WXK_LEFT for the left
4814         cursor key. See `wx.KeyEvent` for a full list of the virtual key
4815         codes.
4816
4817         Note that in Unicode build, the returned value is meaningful only if
4818         the user entered a character that can be represented in current
4819         locale's default charset. You can obtain the corresponding Unicode
4820         character using `GetUnicodeKey`.
4821         """
4822         return _core_.KeyEvent_GetKeyCode(*args, **kwargs)
4823
4824     KeyCode = GetKeyCode
4825     def GetUnicodeKey(*args, **kwargs):
4826         """
4827         GetUnicodeKey(self) -> int
4828
4829         Returns the Unicode character corresponding to this key event.  This
4830         function is only meaningfule in a Unicode build of wxPython.
4831         """
4832         return _core_.KeyEvent_GetUnicodeKey(*args, **kwargs)
4833
4834     GetUniChar = GetUnicodeKey
4835     def SetUnicodeKey(*args, **kwargs):
4836         """
4837         SetUnicodeKey(self, int uniChar)
4838
4839         Set the Unicode value of the key event, but only if this is a Unicode
4840         build of wxPython.
4841         """
4842         return _core_.KeyEvent_SetUnicodeKey(*args, **kwargs)
4843
4844     def GetRawKeyCode(*args, **kwargs):
4845         """
4846         GetRawKeyCode(self) -> unsigned int
4847
4848         Returns the raw key code for this event. This is a platform-dependent
4849         scan code which should only be used in advanced
4850         applications. Currently the raw key codes are not supported by all
4851         ports.
4852         """
4853         return _core_.KeyEvent_GetRawKeyCode(*args, **kwargs)
4854
4855     def GetRawKeyFlags(*args, **kwargs):
4856         """
4857         GetRawKeyFlags(self) -> unsigned int
4858
4859         Returns the low level key flags for this event. The flags are
4860         platform-dependent and should only be used in advanced applications.
4861         Currently the raw key flags are not supported by all ports.
4862         """
4863         return _core_.KeyEvent_GetRawKeyFlags(*args, **kwargs)
4864
4865     def GetPosition(*args, **kwargs):
4866         """
4867         GetPosition(self) -> Point
4868
4869         Find the position of the event, if applicable.
4870         """
4871         return _core_.KeyEvent_GetPosition(*args, **kwargs)
4872
4873     def GetPositionTuple(*args, **kwargs):
4874         """
4875         GetPositionTuple() -> (x,y)
4876
4877         Find the position of the event, if applicable.
4878         """
4879         return _core_.KeyEvent_GetPositionTuple(*args, **kwargs)
4880
4881     def GetX(*args, **kwargs):
4882         """
4883         GetX(self) -> int
4884
4885         Returns the X position (in client coordinates) of the event, if
4886         applicable.
4887         """
4888         return _core_.KeyEvent_GetX(*args, **kwargs)
4889
4890     def GetY(*args, **kwargs):
4891         """
4892         GetY(self) -> int
4893
4894         Returns the Y position (in client coordinates) of the event, if
4895         applicable.
4896         """
4897         return _core_.KeyEvent_GetY(*args, **kwargs)
4898
4899     m_x = property(_core_.KeyEvent_m_x_get, _core_.KeyEvent_m_x_set)
4900     m_y = property(_core_.KeyEvent_m_y_get, _core_.KeyEvent_m_y_set)
4901     m_keyCode = property(_core_.KeyEvent_m_keyCode_get, _core_.KeyEvent_m_keyCode_set)
4902     m_controlDown = property(_core_.KeyEvent_m_controlDown_get, _core_.KeyEvent_m_controlDown_set)
4903     m_shiftDown = property(_core_.KeyEvent_m_shiftDown_get, _core_.KeyEvent_m_shiftDown_set)
4904     m_altDown = property(_core_.KeyEvent_m_altDown_get, _core_.KeyEvent_m_altDown_set)
4905     m_metaDown = property(_core_.KeyEvent_m_metaDown_get, _core_.KeyEvent_m_metaDown_set)
4906     m_scanCode = property(_core_.KeyEvent_m_scanCode_get, _core_.KeyEvent_m_scanCode_set)
4907     m_rawCode = property(_core_.KeyEvent_m_rawCode_get, _core_.KeyEvent_m_rawCode_set)
4908     m_rawFlags = property(_core_.KeyEvent_m_rawFlags_get, _core_.KeyEvent_m_rawFlags_set)
4909 _core_.KeyEvent_swigregister(KeyEvent)
4910
4911 #---------------------------------------------------------------------------
4912
4913 class SizeEvent(Event):
4914     """
4915     A size event holds information about size change events.  The EVT_SIZE
4916     handler function will be called when the window it is bound to has
4917     been resized.
4918
4919     Note that the size passed is of the whole window: call
4920     `wx.Window.GetClientSize` for the area which may be used by the
4921     application.
4922
4923     When a window is resized, usually only a small part of the window is
4924     damaged and and that area is all that is in the update region for the
4925     next paint event. However, if your drawing depends on the size of the
4926     window, you may need to clear the DC explicitly and repaint the whole
4927     window. In which case, you may need to call `wx.Window.Refresh` to
4928     invalidate the entire window.
4929
4930     """
4931     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4932     __repr__ = _swig_repr
4933     def __init__(self, *args, **kwargs):
4934         """
4935         __init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent
4936
4937         Construct a new ``wx.SizeEvent``.
4938         """
4939         _core_.SizeEvent_swiginit(self,_core_.new_SizeEvent(*args, **kwargs))
4940     def GetSize(*args, **kwargs):
4941         """
4942         GetSize(self) -> Size
4943
4944         Returns the entire size of the window generating the size change
4945         event.
4946         """
4947         return _core_.SizeEvent_GetSize(*args, **kwargs)
4948
4949     def GetRect(*args, **kwargs):
4950         """GetRect(self) -> Rect"""
4951         return _core_.SizeEvent_GetRect(*args, **kwargs)
4952
4953     def SetRect(*args, **kwargs):
4954         """SetRect(self, Rect rect)"""
4955         return _core_.SizeEvent_SetRect(*args, **kwargs)
4956
4957     def SetSize(*args, **kwargs):
4958         """SetSize(self, Size size)"""
4959         return _core_.SizeEvent_SetSize(*args, **kwargs)
4960
4961     m_size = property(_core_.SizeEvent_m_size_get, _core_.SizeEvent_m_size_set)
4962     m_rect = property(_core_.SizeEvent_m_rect_get, _core_.SizeEvent_m_rect_set)
4963 _core_.SizeEvent_swigregister(SizeEvent)
4964
4965 #---------------------------------------------------------------------------
4966
4967 class MoveEvent(Event):
4968     """
4969     This event object is sent for EVT_MOVE event bindings when a window is
4970     moved to a new position.
4971     """
4972     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4973     __repr__ = _swig_repr
4974     def __init__(self, *args, **kwargs):
4975         """
4976         __init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent
4977
4978         Constructor.
4979         """
4980         _core_.MoveEvent_swiginit(self,_core_.new_MoveEvent(*args, **kwargs))
4981     def GetPosition(*args, **kwargs):
4982         """
4983         GetPosition(self) -> Point
4984
4985         Returns the position of the window generating the move change event.
4986         """
4987         return _core_.MoveEvent_GetPosition(*args, **kwargs)
4988
4989     def GetRect(*args, **kwargs):
4990         """GetRect(self) -> Rect"""
4991         return _core_.MoveEvent_GetRect(*args, **kwargs)
4992
4993     def SetRect(*args, **kwargs):
4994         """SetRect(self, Rect rect)"""
4995         return _core_.MoveEvent_SetRect(*args, **kwargs)
4996
4997     def SetPosition(*args, **kwargs):
4998         """SetPosition(self, Point pos)"""
4999         return _core_.MoveEvent_SetPosition(*args, **kwargs)
5000
5001     m_pos =  property(GetPosition, SetPosition)
5002     m_rect = property(GetRect, SetRect)
5003
5004 _core_.MoveEvent_swigregister(MoveEvent)
5005
5006 #---------------------------------------------------------------------------
5007
5008 class PaintEvent(Event):
5009     """
5010     A paint event is sent when a window's contents needs to be repainted.
5011     Note that in an EVT_PAINT handler the application must *always* create
5012     a `wx.PaintDC` object, even if you do not use it.  Otherwise MS
5013     Windows assumes that the window has not been painted yet and will send
5014     the event again, causing endless refreshes.
5015
5016     You can optimize painting by retrieving the rectangles that have been
5017     damaged using `wx.Window.GetUpdateRegion` and/or `wx.RegionIterator`,
5018     and only repainting these rectangles. The rectangles are in terms of
5019     the client area, and are unscrolled, so you will need to do some
5020     calculations using the current view position to obtain logical,
5021     scrolled units.
5022
5023     """
5024     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5025     __repr__ = _swig_repr
5026     def __init__(self, *args, **kwargs):
5027         """__init__(self, int Id=0) -> PaintEvent"""
5028         _core_.PaintEvent_swiginit(self,_core_.new_PaintEvent(*args, **kwargs))
5029 _core_.PaintEvent_swigregister(PaintEvent)
5030
5031 class NcPaintEvent(Event):
5032     """Proxy of C++ NcPaintEvent class"""
5033     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5034     __repr__ = _swig_repr
5035     def __init__(self, *args, **kwargs):
5036         """__init__(self, int winid=0) -> NcPaintEvent"""
5037         _core_.NcPaintEvent_swiginit(self,_core_.new_NcPaintEvent(*args, **kwargs))
5038 _core_.NcPaintEvent_swigregister(NcPaintEvent)
5039
5040 #---------------------------------------------------------------------------
5041
5042 class EraseEvent(Event):
5043     """
5044     An erase event is sent whenever the background of a window needs to be
5045     repainted.  To intercept this event use the EVT_ERASE_BACKGROUND event
5046     binder.  On some platforms, such as GTK+, this event is simulated
5047     (simply generated just before the paint event) and may cause flicker.
5048
5049     To paint a custom background use the `GetDC` method and use the returned
5050     device context if it is not ``None``, otherwise create a temporary
5051     `wx.ClientDC` and draw on that.
5052
5053     """
5054     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5055     __repr__ = _swig_repr
5056     def __init__(self, *args, **kwargs):
5057         """
5058         __init__(self, int Id=0, DC dc=None) -> EraseEvent
5059
5060         Constructor
5061         """
5062         _core_.EraseEvent_swiginit(self,_core_.new_EraseEvent(*args, **kwargs))
5063     def GetDC(*args, **kwargs):
5064         """
5065         GetDC(self) -> DC
5066
5067         Returns the device context the event handler should draw upon.  If
5068         ``None`` is returned then create a temporary `wx.ClientDC` and use
5069         that instead.
5070         """
5071         return _core_.EraseEvent_GetDC(*args, **kwargs)
5072
5073 _core_.EraseEvent_swigregister(EraseEvent)
5074
5075 #---------------------------------------------------------------------------
5076
5077 class FocusEvent(Event):
5078     """
5079     A focus event is sent when a window's focus changes. The window losing
5080     focus receives an EVT_KILL_FOCUS event while the window gaining it
5081     gets an EVT_SET_FOCUS event.
5082
5083     Notice that the set focus event happens both when the user gives focus
5084     to the window (whether using the mouse or keyboard) and when it is
5085     done from the program itself using `wx.Window.SetFocus`.
5086
5087     """
5088     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5089     __repr__ = _swig_repr
5090     def __init__(self, *args, **kwargs):
5091         """
5092         __init__(self, EventType type=wxEVT_NULL, int winid=0) -> FocusEvent
5093
5094         Constructor
5095         """
5096         _core_.FocusEvent_swiginit(self,_core_.new_FocusEvent(*args, **kwargs))
5097     def GetWindow(*args, **kwargs):
5098         """
5099         GetWindow(self) -> Window
5100
5101         Returns the other window associated with this event, that is the
5102         window which had the focus before for the EVT_SET_FOCUS event and the
5103         window which is going to receive focus for the wxEVT_KILL_FOCUS event.
5104
5105         Warning: the window returned may be None!
5106         """
5107         return _core_.FocusEvent_GetWindow(*args, **kwargs)
5108
5109     def SetWindow(*args, **kwargs):
5110         """SetWindow(self, Window win)"""
5111         return _core_.FocusEvent_SetWindow(*args, **kwargs)
5112
5113 _core_.FocusEvent_swigregister(FocusEvent)
5114
5115 #---------------------------------------------------------------------------
5116
5117 class ChildFocusEvent(CommandEvent):
5118     """
5119     wx.ChildFocusEvent notifies the parent that a child has received the
5120     focus.  Unlike `wx.FocusEvent` it is propagated up the window
5121     heirarchy.
5122     """
5123     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5124     __repr__ = _swig_repr
5125     def __init__(self, *args, **kwargs):
5126         """
5127         __init__(self, Window win=None) -> ChildFocusEvent
5128
5129         Constructor
5130         """
5131         _core_.ChildFocusEvent_swiginit(self,_core_.new_ChildFocusEvent(*args, **kwargs))
5132     def GetWindow(*args, **kwargs):
5133         """
5134         GetWindow(self) -> Window
5135
5136         The window which has just received the focus.
5137         """
5138         return _core_.ChildFocusEvent_GetWindow(*args, **kwargs)
5139
5140 _core_.ChildFocusEvent_swigregister(ChildFocusEvent)
5141
5142 #---------------------------------------------------------------------------
5143
5144 class ActivateEvent(Event):
5145     """
5146     An activate event is sent when a top-level window or the entire
5147     application is being activated or deactivated.
5148
5149     A top-level window (a dialog or frame) receives an activate event when
5150     is being activated or deactivated. This is indicated visually by the
5151     title bar changing colour, and a subwindow gaining the keyboard focus.
5152     An application is activated or deactivated when one of its frames
5153     becomes activated, or a frame becomes inactivate resulting in all
5154     application frames being inactive.
5155
5156     Please note that usually you should call event.Skip() in your handlers
5157     for these events so the default handlers will still be called, as not
5158     doing so can result in strange effects.
5159
5160     """
5161     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5162     __repr__ = _swig_repr
5163     def __init__(self, *args, **kwargs):
5164         """
5165         __init__(self, EventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent
5166
5167         Constructor
5168         """
5169         _core_.ActivateEvent_swiginit(self,_core_.new_ActivateEvent(*args, **kwargs))
5170     def GetActive(*args, **kwargs):
5171         """
5172         GetActive(self) -> bool
5173
5174         Returns true if the application or window is being activated, false
5175         otherwise.
5176         """
5177         return _core_.ActivateEvent_GetActive(*args, **kwargs)
5178
5179 _core_.ActivateEvent_swigregister(ActivateEvent)
5180
5181 #---------------------------------------------------------------------------
5182
5183 class InitDialogEvent(Event):
5184     """
5185     A wx.InitDialogEvent is sent as a dialog is being initialised, or for
5186     any window when `wx.Window.InitDialog` is called.  Handlers for this
5187     event can transfer data to the window, or anything else that should be
5188     done before the user begins editing the form. The default handler
5189     calls `wx.Window.TransferDataToWindow`.
5190     """
5191     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5192     __repr__ = _swig_repr
5193     def __init__(self, *args, **kwargs):
5194         """
5195         __init__(self, int Id=0) -> InitDialogEvent
5196
5197         Constructor
5198         """
5199         _core_.InitDialogEvent_swiginit(self,_core_.new_InitDialogEvent(*args, **kwargs))
5200 _core_.InitDialogEvent_swigregister(InitDialogEvent)
5201
5202 #---------------------------------------------------------------------------
5203
5204 class MenuEvent(Event):
5205     """
5206     This class is used for a variety of menu-related events.  Note that
5207     these do not include menu command events, which are handled by sending
5208     `wx.CommandEvent` objects.
5209
5210     The default handler for wx.EVT_MENU_HIGHLIGHT displays menu item help
5211     text in the first field of the status bar.
5212     """
5213     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5214     __repr__ = _swig_repr
5215     def __init__(self, *args, **kwargs):
5216         """
5217         __init__(self, EventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent
5218
5219         Constructor
5220         """
5221         _core_.MenuEvent_swiginit(self,_core_.new_MenuEvent(*args, **kwargs))
5222     def GetMenuId(*args, **kwargs):
5223         """
5224         GetMenuId(self) -> int
5225
5226         Returns the menu identifier associated with the event. This method
5227         should be only used with the HIGHLIGHT events.
5228         """
5229         return _core_.MenuEvent_GetMenuId(*args, **kwargs)
5230
5231     def IsPopup(*args, **kwargs):
5232         """
5233         IsPopup(self) -> bool
5234
5235         Returns ``True`` if the menu which is being opened or closed is a
5236         popup menu, ``False`` if it is a normal one.  This method should only
5237         be used with the OPEN and CLOSE events.
5238         """
5239         return _core_.MenuEvent_IsPopup(*args, **kwargs)
5240
5241     def GetMenu(*args, **kwargs):
5242         """
5243         GetMenu(self) -> Menu
5244
5245         Returns the menu which is being opened or closed. This method should
5246         only be used with the OPEN and CLOSE events.
5247         """
5248         return _core_.MenuEvent_GetMenu(*args, **kwargs)
5249
5250 _core_.MenuEvent_swigregister(MenuEvent)
5251
5252 #---------------------------------------------------------------------------
5253
5254 class CloseEvent(Event):
5255     """
5256     This event class contains information about window and session close
5257     events.
5258
5259     The handler function for EVT_CLOSE is called when the user has tried
5260     to close a a frame or dialog box using the window manager controls or
5261     the system menu. It can also be invoked by the application itself
5262     programmatically, for example by calling the `wx.Window.Close`
5263     function.
5264
5265     You should check whether the application is forcing the deletion of
5266     the window using `CanVeto`. If it returns ``False``, you must destroy
5267     the window using `wx.Window.Destroy`. If the return value is ``True``,
5268     it is up to you whether you respond by destroying the window or not.
5269     For example you may wish to display a message dialog prompting to save
5270     files or to cancel the close.
5271
5272     If you don't destroy the window, you should call `Veto` to let the
5273     calling code know that you did not destroy the window. This allows the
5274     `wx.Window.Close` function to return ``True`` or ``False`` depending
5275     on whether the close instruction was honored or not.
5276     """
5277     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5278     __repr__ = _swig_repr
5279     def __init__(self, *args, **kwargs):
5280         """
5281         __init__(self, EventType type=wxEVT_NULL, int winid=0) -> CloseEvent
5282
5283         Constructor.
5284         """
5285         _core_.CloseEvent_swiginit(self,_core_.new_CloseEvent(*args, **kwargs))
5286     def SetLoggingOff(*args, **kwargs):
5287         """
5288         SetLoggingOff(self, bool logOff)
5289
5290         Sets the 'logging off' flag.
5291         """
5292         return _core_.CloseEvent_SetLoggingOff(*args, **kwargs)
5293
5294     def GetLoggingOff(*args, **kwargs):
5295         """
5296         GetLoggingOff(self) -> bool
5297
5298         Returns ``True`` if the user is logging off or ``False`` if the
5299         system is shutting down. This method can only be called for end
5300         session and query end session events, it doesn't make sense for close
5301         window event.
5302         """
5303         return _core_.CloseEvent_GetLoggingOff(*args, **kwargs)
5304
5305     def Veto(*args, **kwargs):
5306         """
5307         Veto(self, bool veto=True)
5308
5309         Call this from your event handler to veto a system shutdown or to
5310         signal to the calling application that a window close did not happen.
5311
5312         You can only veto a shutdown or close if `CanVeto` returns true.
5313         """
5314         return _core_.CloseEvent_Veto(*args, **kwargs)
5315
5316     def GetVeto(*args, **kwargs):
5317         """GetVeto(self) -> bool"""
5318         return _core_.CloseEvent_GetVeto(*args, **kwargs)
5319
5320     def SetCanVeto(*args, **kwargs):
5321         """
5322         SetCanVeto(self, bool canVeto)
5323
5324         Sets the 'can veto' flag.
5325         """
5326         return _core_.CloseEvent_SetCanVeto(*args, **kwargs)
5327
5328     def CanVeto(*args, **kwargs):
5329         """
5330         CanVeto(self) -> bool
5331
5332         Returns true if you can veto a system shutdown or a window close
5333         event. Vetoing a window close event is not possible if the calling
5334         code wishes to force the application to exit, and so this function
5335         must be called to check this.
5336         """
5337         return _core_.CloseEvent_CanVeto(*args, **kwargs)
5338
5339 _core_.CloseEvent_swigregister(CloseEvent)
5340
5341 #---------------------------------------------------------------------------
5342
5343 class ShowEvent(Event):
5344     """An EVT_SHOW event is sent when a window is shown or hidden."""
5345     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5346     __repr__ = _swig_repr
5347     def __init__(self, *args, **kwargs):
5348         """
5349         __init__(self, int winid=0, bool show=False) -> ShowEvent
5350
5351         An EVT_SHOW event is sent when a window is shown or hidden.
5352         """
5353         _core_.ShowEvent_swiginit(self,_core_.new_ShowEvent(*args, **kwargs))
5354     def SetShow(*args, **kwargs):
5355         """SetShow(self, bool show)"""
5356         return _core_.ShowEvent_SetShow(*args, **kwargs)
5357
5358     def GetShow(*args, **kwargs):
5359         """GetShow(self) -> bool"""
5360         return _core_.ShowEvent_GetShow(*args, **kwargs)
5361
5362 _core_.ShowEvent_swigregister(ShowEvent)
5363
5364 #---------------------------------------------------------------------------
5365
5366 class IconizeEvent(Event):
5367     """
5368     An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5369     restored.
5370     """
5371     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5372     __repr__ = _swig_repr
5373     def __init__(self, *args, **kwargs):
5374         """
5375         __init__(self, int id=0, bool iconized=True) -> IconizeEvent
5376
5377         An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5378         restored.
5379         """
5380         _core_.IconizeEvent_swiginit(self,_core_.new_IconizeEvent(*args, **kwargs))
5381     def Iconized(*args, **kwargs):
5382         """
5383         Iconized(self) -> bool
5384
5385         Returns ``True`` if the frame has been iconized, ``False`` if it has
5386         been restored.
5387         """
5388         return _core_.IconizeEvent_Iconized(*args, **kwargs)
5389
5390 _core_.IconizeEvent_swigregister(IconizeEvent)
5391
5392 #---------------------------------------------------------------------------
5393
5394 class MaximizeEvent(Event):
5395     """An EVT_MAXIMIZE event is sent when a frame is maximized or restored."""
5396     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5397     __repr__ = _swig_repr
5398     def __init__(self, *args, **kwargs):
5399         """
5400         __init__(self, int id=0) -> MaximizeEvent
5401
5402         An EVT_MAXIMIZE event is sent when a frame is maximized or restored.
5403         """
5404         _core_.MaximizeEvent_swiginit(self,_core_.new_MaximizeEvent(*args, **kwargs))
5405 _core_.MaximizeEvent_swigregister(MaximizeEvent)
5406
5407 #---------------------------------------------------------------------------
5408
5409 class DropFilesEvent(Event):
5410     """
5411     This class is used for drop files events, that is, when files have
5412     been dropped onto the window. This functionality is only available
5413     under Windows. The window must have previously been enabled for
5414     dropping by calling `wx.Window.DragAcceptFiles`.
5415
5416     Important note: this is a separate implementation to the more general
5417     drag and drop implementation using `wx.FileDropTarget`, and etc. This
5418     implementation uses the older, Windows message-based approach of
5419     dropping files.
5420
5421     Use wx.EVT_DROP_FILES to bind an event handler to receive file drop
5422     events.
5423
5424     """
5425     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5426     def __init__(self): raise AttributeError, "No constructor defined"
5427     __repr__ = _swig_repr
5428     def GetPosition(*args, **kwargs):
5429         """
5430         GetPosition(self) -> Point
5431
5432         Returns the position at which the files were dropped.
5433         """
5434         return _core_.DropFilesEvent_GetPosition(*args, **kwargs)
5435
5436     def GetNumberOfFiles(*args, **kwargs):
5437         """
5438         GetNumberOfFiles(self) -> int
5439
5440         Returns the number of files dropped.
5441         """
5442         return _core_.DropFilesEvent_GetNumberOfFiles(*args, **kwargs)
5443
5444     def GetFiles(*args, **kwargs):
5445         """
5446         GetFiles(self) -> PyObject
5447
5448         Returns a list of the filenames that were dropped.
5449         """
5450         return _core_.DropFilesEvent_GetFiles(*args, **kwargs)
5451
5452 _core_.DropFilesEvent_swigregister(DropFilesEvent)
5453
5454 #---------------------------------------------------------------------------
5455
5456 UPDATE_UI_PROCESS_ALL = _core_.UPDATE_UI_PROCESS_ALL
5457 UPDATE_UI_PROCESS_SPECIFIED = _core_.UPDATE_UI_PROCESS_SPECIFIED
5458 class UpdateUIEvent(CommandEvent):
5459     """
5460     This class is used for EVT_UPDATE_UI pseudo-events which are sent by
5461     wxWidgets to give an application the chance to update various user
5462     interface elements.
5463
5464     Without update UI events, an application has to work hard to
5465     check/uncheck, enable/disable, and set the text for elements such as
5466     menu items and toolbar buttons. The code for doing this has to be
5467     mixed up with the code that is invoked when an action is invoked for a
5468     menu item or button.
5469
5470     With update UI events, you define an event handler to look at the
5471     state of the application and change UI elements accordingly. wxWidgets
5472     will call your handler functions in idle time, so you don't have to
5473     worry where to call this code. In addition to being a clearer and more
5474     declarative method, it also means you don't have to worry whether
5475     you're updating a toolbar or menubar identifier. The same handler can
5476     update a menu item and toolbar button, if the ID values are the same.
5477
5478     Instead of directly manipulating the menu or button, you call
5479     functions in the event object, such as `Check`. wxWidgets will
5480     determine whether such a call has been made, and which UI element to
5481     update.
5482
5483     These events will work for popup menus as well as menubars. Just
5484     before a menu is popped up, `wx.Menu.UpdateUI` is called to process
5485     any UI events for the window that owns the menu.
5486
5487     If you find that the overhead of UI update processing is affecting
5488     your application, you can do one or both of the following:
5489
5490        1. Call `wx.UpdateUIEvent.SetMode` with a value of
5491           wx.UPDATE_UI_PROCESS_SPECIFIED, and set the extra style
5492           wx.WS_EX_PROCESS_UPDATE_EVENTS for every window that should
5493           receive update events. No other windows will receive update
5494           events.
5495
5496        2. Call `wx.UpdateUIEvent.SetUpdateInterval` with a millisecond
5497           value to set the delay between updates. You may need to call
5498           `wx.Window.UpdateWindowUI` at critical points, for example when
5499           a dialog is about to be shown, in case the user sees a slight
5500           delay before windows are updated.
5501
5502     Note that although events are sent in idle time, defining a EVT_IDLE
5503     handler for a window does not affect this because the events are sent
5504     from an internal idle handler.
5505
5506     wxWidgets tries to optimize update events on some platforms. On
5507     Windows and GTK+, events for menubar items are only sent when the menu
5508     is about to be shown, and not in idle time.
5509
5510     """
5511     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5512     __repr__ = _swig_repr
5513     def __init__(self, *args, **kwargs):
5514         """
5515         __init__(self, int commandId=0) -> UpdateUIEvent
5516
5517         Constructor
5518         """
5519         _core_.UpdateUIEvent_swiginit(self,_core_.new_UpdateUIEvent(*args, **kwargs))
5520     def GetChecked(*args, **kwargs):
5521         """
5522         GetChecked(self) -> bool
5523
5524         Returns ``True`` if the UI element should be checked.
5525         """
5526         return _core_.UpdateUIEvent_GetChecked(*args, **kwargs)
5527
5528     def GetEnabled(*args, **kwargs):
5529         """
5530         GetEnabled(self) -> bool
5531
5532         Returns ``True`` if the UI element should be enabled.
5533         """
5534         return _core_.UpdateUIEvent_GetEnabled(*args, **kwargs)
5535
5536     def GetShown(*args, **kwargs):
5537         """
5538         GetShown(self) -> bool
5539
5540         Returns ``True`` if the UI element should be shown.
5541         """
5542         return _core_.UpdateUIEvent_GetShown(*args, **kwargs)
5543
5544     def GetText(*args, **kwargs):
5545         """
5546         GetText(self) -> String
5547
5548         Returns the text that should be set for the UI element.
5549         """
5550         return _core_.UpdateUIEvent_GetText(*args, **kwargs)
5551
5552     def GetSetText(*args, **kwargs):
5553         """
5554         GetSetText(self) -> bool
5555
5556         Returns ``True`` if the application has called `SetText`. For
5557         wxWidgets internal use only.
5558         """
5559         return _core_.UpdateUIEvent_GetSetText(*args, **kwargs)
5560
5561     def GetSetChecked(*args, **kwargs):
5562         """
5563         GetSetChecked(self) -> bool
5564
5565         Returns ``True`` if the application has called `Check`. For wxWidgets
5566         internal use only.
5567         """
5568         return _core_.UpdateUIEvent_GetSetChecked(*args, **kwargs)
5569
5570     def GetSetEnabled(*args, **kwargs):
5571         """
5572         GetSetEnabled(self) -> bool
5573
5574         Returns ``True`` if the application has called `Enable`. For wxWidgets
5575         internal use only.
5576         """
5577         return _core_.UpdateUIEvent_GetSetEnabled(*args, **kwargs)
5578
5579     def GetSetShown(*args, **kwargs):
5580         """
5581         GetSetShown(self) -> bool
5582
5583         Returns ``True`` if the application has called `Show`. For wxWidgets
5584         internal use only.
5585         """
5586         return _core_.UpdateUIEvent_GetSetShown(*args, **kwargs)
5587
5588     def Check(*args, **kwargs):
5589         """
5590         Check(self, bool check)
5591
5592         Check or uncheck the UI element.
5593         """
5594         return _core_.UpdateUIEvent_Check(*args, **kwargs)
5595
5596     def Enable(*args, **kwargs):
5597         """
5598         Enable(self, bool enable)
5599
5600         Enable or disable the UI element.
5601         """
5602         return _core_.UpdateUIEvent_Enable(*args, **kwargs)
5603
5604     def Show(*args, **kwargs):
5605         """
5606         Show(self, bool show)
5607
5608         Show or hide the UI element.
5609         """
5610         return _core_.UpdateUIEvent_Show(*args, **kwargs)
5611
5612     def SetText(*args, **kwargs):
5613         """
5614         SetText(self, String text)
5615
5616         Sets the text for this UI element.
5617         """
5618         return _core_.UpdateUIEvent_SetText(*args, **kwargs)
5619
5620     def SetUpdateInterval(*args, **kwargs):
5621         """
5622         SetUpdateInterval(long updateInterval)
5623
5624         Sets the interval between updates in milliseconds. Set to -1 to
5625         disable updates, or to 0 to update as frequently as possible. The
5626         default is 0.
5627
5628         Use this to reduce the overhead of UI update events if your
5629         application has a lot of windows. If you set the value to -1 or
5630         greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
5631         at appropriate points in your application, such as when a dialog is
5632         about to be shown.
5633         """
5634         return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
5635
5636     SetUpdateInterval = staticmethod(SetUpdateInterval)
5637     def GetUpdateInterval(*args, **kwargs):
5638         """
5639         GetUpdateInterval() -> long
5640
5641         Returns the current interval between updates in milliseconds. -1
5642         disables updates, 0 updates as frequently as possible.
5643         """
5644         return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs)
5645
5646     GetUpdateInterval = staticmethod(GetUpdateInterval)
5647     def CanUpdate(*args, **kwargs):
5648         """
5649         CanUpdate(Window win) -> bool
5650
5651         Returns ``True`` if it is appropriate to update (send UI update events
5652         to) this window.
5653
5654         This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
5655         the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
5656         events were last sent in idle time, and the update interval, to
5657         determine whether events should be sent to this window now. By default
5658         this will always return true because the update mode is initially
5659         wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
5660         events will be sent as often as possible. You can reduce the frequency
5661         that events are sent by changing the mode and/or setting an update
5662         interval.
5663
5664         """
5665         return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
5666
5667     CanUpdate = staticmethod(CanUpdate)
5668     def ResetUpdateTime(*args, **kwargs):
5669         """
5670         ResetUpdateTime()
5671
5672         Used internally to reset the last-updated time to the current time. It
5673         is assumed that update events are normally sent in idle time, so this
5674         is called at the end of idle processing.
5675         """
5676         return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs)
5677
5678     ResetUpdateTime = staticmethod(ResetUpdateTime)
5679     def SetMode(*args, **kwargs):
5680         """
5681         SetMode(int mode)
5682
5683         Specify how wxWidgets will send update events: to all windows, or only
5684         to those which specify that they will process the events.
5685
5686         The mode may be one of the following values:
5687
5688             =============================   ==========================================
5689             wxUPDATE_UI_PROCESS_ALL         Send UI update events to all windows.  This
5690                                             is the default setting.
5691             wxUPDATE_UI_PROCESS_SPECIFIED   Send UI update events only to windows that
5692                                             have the wx.WS_EX_PROCESS_UI_UPDATES extra
5693                                             style set.
5694             =============================   ==========================================
5695
5696         """
5697         return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
5698
5699     SetMode = staticmethod(SetMode)
5700     def GetMode(*args, **kwargs):
5701         """
5702         GetMode() -> int
5703
5704         Returns a value specifying how wxWidgets will send update events: to
5705         all windows, or only to those which specify that they will process the
5706         events.
5707         """
5708         return _core_.UpdateUIEvent_GetMode(*args, **kwargs)
5709
5710     GetMode = staticmethod(GetMode)
5711 _core_.UpdateUIEvent_swigregister(UpdateUIEvent)
5712
5713 def UpdateUIEvent_SetUpdateInterval(*args, **kwargs):
5714   """
5715     UpdateUIEvent_SetUpdateInterval(long updateInterval)
5716
5717     Sets the interval between updates in milliseconds. Set to -1 to
5718     disable updates, or to 0 to update as frequently as possible. The
5719     default is 0.
5720
5721     Use this to reduce the overhead of UI update events if your
5722     application has a lot of windows. If you set the value to -1 or
5723     greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
5724     at appropriate points in your application, such as when a dialog is
5725     about to be shown.
5726     """
5727   return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
5728
5729 def UpdateUIEvent_GetUpdateInterval(*args):
5730   """
5731     UpdateUIEvent_GetUpdateInterval() -> long
5732
5733     Returns the current interval between updates in milliseconds. -1
5734     disables updates, 0 updates as frequently as possible.
5735     """
5736   return _core_.UpdateUIEvent_GetUpdateInterval(*args)
5737
5738 def UpdateUIEvent_CanUpdate(*args, **kwargs):
5739   """
5740     UpdateUIEvent_CanUpdate(Window win) -> bool
5741
5742     Returns ``True`` if it is appropriate to update (send UI update events
5743     to) this window.
5744
5745     This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
5746     the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
5747     events were last sent in idle time, and the update interval, to
5748     determine whether events should be sent to this window now. By default
5749     this will always return true because the update mode is initially
5750     wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
5751     events will be sent as often as possible. You can reduce the frequency
5752     that events are sent by changing the mode and/or setting an update
5753     interval.
5754
5755     """
5756   return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
5757
5758 def UpdateUIEvent_ResetUpdateTime(*args):
5759   """
5760     UpdateUIEvent_ResetUpdateTime()
5761
5762     Used internally to reset the last-updated time to the current time. It
5763     is assumed that update events are normally sent in idle time, so this
5764     is called at the end of idle processing.
5765     """
5766   return _core_.UpdateUIEvent_ResetUpdateTime(*args)
5767
5768 def UpdateUIEvent_SetMode(*args, **kwargs):
5769   """
5770     UpdateUIEvent_SetMode(int mode)
5771
5772     Specify how wxWidgets will send update events: to all windows, or only
5773     to those which specify that they will process the events.
5774
5775     The mode may be one of the following values:
5776
5777         =============================   ==========================================
5778         wxUPDATE_UI_PROCESS_ALL         Send UI update events to all windows.  This
5779                                         is the default setting.
5780         wxUPDATE_UI_PROCESS_SPECIFIED   Send UI update events only to windows that
5781                                         have the wx.WS_EX_PROCESS_UI_UPDATES extra
5782                                         style set.
5783         =============================   ==========================================
5784
5785     """
5786   return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
5787
5788 def UpdateUIEvent_GetMode(*args):
5789   """
5790     UpdateUIEvent_GetMode() -> int
5791
5792     Returns a value specifying how wxWidgets will send update events: to
5793     all windows, or only to those which specify that they will process the
5794     events.
5795     """
5796   return _core_.UpdateUIEvent_GetMode(*args)
5797
5798 #---------------------------------------------------------------------------
5799
5800 class SysColourChangedEvent(Event):
5801     """
5802     This class is used for EVT_SYS_COLOUR_CHANGED, which are generated
5803     when the user changes the colour settings using the control
5804     panel. This is only applicable under Windows.
5805
5806     The default event handler for this event propagates the event to child
5807     windows, since Windows only sends the events to top-level windows. If
5808     intercepting this event for a top-level window, remember to call
5809     `Skip` so the the base class handler will still be executed, or to
5810     pass the event on to the window's children explicitly.
5811
5812     """
5813     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5814     __repr__ = _swig_repr
5815     def __init__(self, *args, **kwargs):
5816         """
5817         __init__(self) -> SysColourChangedEvent
5818
5819         Constructor
5820         """
5821         _core_.SysColourChangedEvent_swiginit(self,_core_.new_SysColourChangedEvent(*args, **kwargs))
5822 _core_.SysColourChangedEvent_swigregister(SysColourChangedEvent)
5823
5824 #---------------------------------------------------------------------------
5825
5826 class MouseCaptureChangedEvent(Event):
5827     """
5828     An mouse capture changed event (EVT_MOUSE_CAPTURE_CHANGED) is sent to
5829     a window that loses its mouse capture. This is called even if
5830     `wx.Window.ReleaseMouse` was called by the application code. Handling
5831     this event allows an application to cater for unexpected capture
5832     releases which might otherwise confuse mouse handling code.
5833
5834     This event is implemented under Windows only.
5835     """
5836     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5837     __repr__ = _swig_repr
5838     def __init__(self, *args, **kwargs):
5839         """
5840         __init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent
5841
5842         Constructor
5843         """
5844         _core_.MouseCaptureChangedEvent_swiginit(self,_core_.new_MouseCaptureChangedEvent(*args, **kwargs))
5845     def GetCapturedWindow(*args, **kwargs):
5846         """
5847         GetCapturedWindow(self) -> Window
5848
5849         Returns the window that gained the capture, or ``None`` if it was a
5850         non-wxWidgets window.
5851         """
5852         return _core_.MouseCaptureChangedEvent_GetCapturedWindow(*args, **kwargs)
5853
5854 _core_.MouseCaptureChangedEvent_swigregister(MouseCaptureChangedEvent)
5855
5856 #---------------------------------------------------------------------------
5857
5858 class MouseCaptureLostEvent(Event):
5859     """
5860     A mouse capture lost event is sent to a window that obtained mouse
5861     capture, which was subsequently loss due to "external" event, for
5862     example when a dialog box is shown or if another application captures
5863     the mouse.
5864
5865     If this happens, this event is sent to all windows that are on the
5866     capture stack (i.e. a window that called `wx.Window.CaptureMouse`, but
5867     didn't call `wx.Window.ReleaseMouse` yet). The event is *not* sent
5868     if the capture changes because of a call to CaptureMouse or
5869     ReleaseMouse.
5870
5871     This event is currently emitted under Windows only.
5872
5873     """
5874     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5875     __repr__ = _swig_repr
5876     def __init__(self, *args, **kwargs):
5877         """
5878         __init__(self, int winid=0) -> MouseCaptureLostEvent
5879
5880         A mouse capture lost event is sent to a window that obtained mouse
5881         capture, which was subsequently loss due to "external" event, for
5882         example when a dialog box is shown or if another application captures
5883         the mouse.
5884
5885         If this happens, this event is sent to all windows that are on the
5886         capture stack (i.e. a window that called `wx.Window.CaptureMouse`, but
5887         didn't call `wx.Window.ReleaseMouse` yet). The event is *not* sent
5888         if the capture changes because of a call to CaptureMouse or
5889         ReleaseMouse.
5890
5891         This event is currently emitted under Windows only.
5892
5893         """
5894         _core_.MouseCaptureLostEvent_swiginit(self,_core_.new_MouseCaptureLostEvent(*args, **kwargs))
5895 _core_.MouseCaptureLostEvent_swigregister(MouseCaptureLostEvent)
5896
5897 #---------------------------------------------------------------------------
5898
5899 class DisplayChangedEvent(Event):
5900     """
5901     An EVT_DISPLAY_CHANGED event is sent to all windows when the display
5902     resolution has changed.
5903
5904     This event is implemented under Windows only.
5905     """
5906     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5907     __repr__ = _swig_repr
5908     def __init__(self, *args, **kwargs):
5909         """__init__(self) -> DisplayChangedEvent"""
5910         _core_.DisplayChangedEvent_swiginit(self,_core_.new_DisplayChangedEvent(*args, **kwargs))
5911 _core_.DisplayChangedEvent_swigregister(DisplayChangedEvent)
5912
5913 #---------------------------------------------------------------------------
5914
5915 class PaletteChangedEvent(Event):
5916     """
5917     An EVT_PALETTE_CHANGED event is sent when the system palette has
5918     changed, thereby giving each window a chance to redo their own to
5919     match.
5920
5921     This event is implemented under Windows only.
5922     """
5923     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5924     __repr__ = _swig_repr
5925     def __init__(self, *args, **kwargs):
5926         """
5927         __init__(self, int id=0) -> PaletteChangedEvent
5928
5929         An EVT_PALETTE_CHANGED event is sent when the system palette has
5930         changed, thereby giving each window a chance to redo their own to
5931         match.
5932
5933         This event is implemented under Windows only.
5934         """
5935         _core_.PaletteChangedEvent_swiginit(self,_core_.new_PaletteChangedEvent(*args, **kwargs))
5936     def SetChangedWindow(*args, **kwargs):
5937         """SetChangedWindow(self, Window win)"""
5938         return _core_.PaletteChangedEvent_SetChangedWindow(*args, **kwargs)
5939
5940     def GetChangedWindow(*args, **kwargs):
5941         """GetChangedWindow(self) -> Window"""
5942         return _core_.PaletteChangedEvent_GetChangedWindow(*args, **kwargs)
5943
5944 _core_.PaletteChangedEvent_swigregister(PaletteChangedEvent)
5945
5946 #---------------------------------------------------------------------------
5947
5948 class QueryNewPaletteEvent(Event):
5949     """
5950     An EVT_QUERY_NEW_PALETE event indicates the window is getting keyboard
5951     focus and should re-do its palette.
5952
5953     This event is implemented under Windows only.
5954     """
5955     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5956     __repr__ = _swig_repr
5957     def __init__(self, *args, **kwargs):
5958         """
5959         __init__(self, int winid=0) -> QueryNewPaletteEvent
5960
5961         Constructor.
5962         """
5963         _core_.QueryNewPaletteEvent_swiginit(self,_core_.new_QueryNewPaletteEvent(*args, **kwargs))
5964     def SetPaletteRealized(*args, **kwargs):
5965         """
5966         SetPaletteRealized(self, bool realized)
5967
5968         App should set this if it changes the palette.
5969         """
5970         return _core_.QueryNewPaletteEvent_SetPaletteRealized(*args, **kwargs)
5971
5972     def GetPaletteRealized(*args, **kwargs):
5973         """GetPaletteRealized(self) -> bool"""
5974         return _core_.QueryNewPaletteEvent_GetPaletteRealized(*args, **kwargs)
5975
5976 _core_.QueryNewPaletteEvent_swigregister(QueryNewPaletteEvent)
5977
5978 #---------------------------------------------------------------------------
5979
5980 class NavigationKeyEvent(Event):
5981     """
5982     EVT_NAVIGATION_KEY events are used to control moving the focus between
5983     widgets, otherwise known as tab-traversal.  You woudl normally not
5984     catch navigation events in applications as there are already
5985     appropriate handlers in `wx.Dialog` and `wx.Panel`, but you may find
5986     it useful to send navigation events in certain situations to change
5987     the focus in certain ways, although it's probably easier to just call
5988     `wx.Window.Navigate`.
5989     """
5990     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5991     __repr__ = _swig_repr
5992     def __init__(self, *args, **kwargs):
5993         """__init__(self) -> NavigationKeyEvent"""
5994         _core_.NavigationKeyEvent_swiginit(self,_core_.new_NavigationKeyEvent(*args, **kwargs))
5995     def GetDirection(*args, **kwargs):
5996         """
5997         GetDirection(self) -> bool
5998
5999         Returns ``True`` if the direction is forward, ``False`` otherwise.
6000         """
6001         return _core_.NavigationKeyEvent_GetDirection(*args, **kwargs)
6002
6003     def SetDirection(*args, **kwargs):
6004         """
6005         SetDirection(self, bool forward)
6006
6007         Specify the direction that the navigation should take.  Usually the
6008         difference between using Tab and Shift-Tab.
6009         """
6010         return _core_.NavigationKeyEvent_SetDirection(*args, **kwargs)
6011
6012     def IsWindowChange(*args, **kwargs):
6013         """
6014         IsWindowChange(self) -> bool
6015
6016         Returns ``True`` if window change is allowed.
6017         """
6018         return _core_.NavigationKeyEvent_IsWindowChange(*args, **kwargs)
6019
6020     def SetWindowChange(*args, **kwargs):
6021         """
6022         SetWindowChange(self, bool ischange)
6023
6024         Specify if the navigation should be able to change parent windows.
6025         For example, changing notebook pages, etc. This is usually implemented
6026         by using Control-Tab.
6027         """
6028         return _core_.NavigationKeyEvent_SetWindowChange(*args, **kwargs)
6029
6030     def IsFromTab(*args, **kwargs):
6031         """
6032         IsFromTab(self) -> bool
6033
6034         Returns ``True`` if the navigation event is originated from the Tab
6035         key.
6036         """
6037         return _core_.NavigationKeyEvent_IsFromTab(*args, **kwargs)
6038
6039     def SetFromTab(*args, **kwargs):
6040         """
6041         SetFromTab(self, bool bIs)
6042
6043         Set to true under MSW if the event was generated using the tab key.
6044         This is required for proper navogation over radio buttons.
6045         """
6046         return _core_.NavigationKeyEvent_SetFromTab(*args, **kwargs)
6047
6048     def SetFlags(*args, **kwargs):
6049         """
6050         SetFlags(self, long flags)
6051
6052         Set the navigation flags to a combination of the following:
6053
6054             * wx.NavigationKeyEvent.IsBackward
6055             * wx.NavigationKeyEvent.IsForward
6056             * wx.NavigationKeyEvent.WinChange
6057             * wx.NavigationKeyEvent.FromTab
6058
6059         """
6060         return _core_.NavigationKeyEvent_SetFlags(*args, **kwargs)
6061
6062     def GetCurrentFocus(*args, **kwargs):
6063         """
6064         GetCurrentFocus(self) -> Window
6065
6066         Returns the child window which currenty has the focus.  May be
6067         ``None``.
6068         """
6069         return _core_.NavigationKeyEvent_GetCurrentFocus(*args, **kwargs)
6070
6071     def SetCurrentFocus(*args, **kwargs):
6072         """
6073         SetCurrentFocus(self, Window win)
6074
6075         Set the window that has the focus.
6076         """
6077         return _core_.NavigationKeyEvent_SetCurrentFocus(*args, **kwargs)
6078
6079     IsBackward = _core_.NavigationKeyEvent_IsBackward
6080     IsForward = _core_.NavigationKeyEvent_IsForward
6081     WinChange = _core_.NavigationKeyEvent_WinChange
6082     FromTab = _core_.NavigationKeyEvent_FromTab
6083 _core_.NavigationKeyEvent_swigregister(NavigationKeyEvent)
6084
6085 #---------------------------------------------------------------------------
6086
6087 class WindowCreateEvent(CommandEvent):
6088     """
6089     The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6090     underlying GUI object) exists.
6091     """
6092     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6093     __repr__ = _swig_repr
6094     def __init__(self, *args, **kwargs):
6095         """
6096         __init__(self, Window win=None) -> WindowCreateEvent
6097
6098         The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6099         underlying GUI object) exists.
6100         """
6101         _core_.WindowCreateEvent_swiginit(self,_core_.new_WindowCreateEvent(*args, **kwargs))
6102     def GetWindow(*args, **kwargs):
6103         """
6104         GetWindow(self) -> Window
6105
6106         Returns the window that this event refers to.
6107         """
6108         return _core_.WindowCreateEvent_GetWindow(*args, **kwargs)
6109
6110 _core_.WindowCreateEvent_swigregister(WindowCreateEvent)
6111
6112 class WindowDestroyEvent(CommandEvent):
6113     """
6114     The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6115     when the GUI window is destroyed.
6116
6117     When a class derived from `wx.Window` is destroyed its destructor will
6118     have already run by the time this event is sent. Therefore this event
6119     will not usually be received at all by the window itself.  Since it is
6120     received after the destructor has run, an object should not try to
6121     handle its own wx.WindowDestroyEvent, but it can be used to get
6122     notification of the destruction of another window.
6123     """
6124     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6125     __repr__ = _swig_repr
6126     def __init__(self, *args, **kwargs):
6127         """
6128         __init__(self, Window win=None) -> WindowDestroyEvent
6129
6130         The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6131         when the GUI window is destroyed.
6132
6133         When a class derived from `wx.Window` is destroyed its destructor will
6134         have already run by the time this event is sent. Therefore this event
6135         will not usually be received at all by the window itself.  Since it is
6136         received after the destructor has run, an object should not try to
6137         handle its own wx.WindowDestroyEvent, but it can be used to get
6138         notification of the destruction of another window.
6139         """
6140         _core_.WindowDestroyEvent_swiginit(self,_core_.new_WindowDestroyEvent(*args, **kwargs))
6141     def GetWindow(*args, **kwargs):
6142         """
6143         GetWindow(self) -> Window
6144
6145         Returns the window that this event refers to.
6146         """
6147         return _core_.WindowDestroyEvent_GetWindow(*args, **kwargs)
6148
6149 _core_.WindowDestroyEvent_swigregister(WindowDestroyEvent)
6150
6151 #---------------------------------------------------------------------------
6152
6153 class ContextMenuEvent(CommandEvent):
6154     """
6155     This class is used for context menu events (EVT_CONTECT_MENU,) sent to
6156     give the application a chance to show a context (popup) menu.
6157     """
6158     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6159     __repr__ = _swig_repr
6160     def __init__(self, *args, **kwargs):
6161         """
6162         __init__(self, EventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent
6163
6164         Constructor.
6165         """
6166         _core_.ContextMenuEvent_swiginit(self,_core_.new_ContextMenuEvent(*args, **kwargs))
6167     def GetPosition(*args, **kwargs):
6168         """
6169         GetPosition(self) -> Point
6170
6171         Returns the position (in screen coordinants) at which the menu should
6172         be shown.
6173         """
6174         return _core_.ContextMenuEvent_GetPosition(*args, **kwargs)
6175
6176     def SetPosition(*args, **kwargs):
6177         """
6178         SetPosition(self, Point pos)
6179
6180         Sets the position at which the menu should be shown.
6181         """
6182         return _core_.ContextMenuEvent_SetPosition(*args, **kwargs)
6183
6184 _core_.ContextMenuEvent_swigregister(ContextMenuEvent)
6185
6186 #---------------------------------------------------------------------------
6187
6188 IDLE_PROCESS_ALL = _core_.IDLE_PROCESS_ALL
6189 IDLE_PROCESS_SPECIFIED = _core_.IDLE_PROCESS_SPECIFIED
6190 class IdleEvent(Event):
6191     """
6192     This class is used for EVT_IDLE events, which are generated and sent
6193     when the application *becomes* idle.  In other words, the when the
6194     event queue becomes empty then idle events are sent to all windows (by
6195     default) and as long as none of them call `RequestMore` then there are
6196     no more idle events until after the system event queue has some normal
6197     events and then becomes empty again.
6198
6199     By default, idle events are sent to all windows. If this is causing a
6200     significant overhead in your application, you can call
6201     `wx.IdleEvent.SetMode` with the value wx.IDLE_PROCESS_SPECIFIED, and
6202     set the wx.WS_EX_PROCESS_IDLE extra window style for every window
6203     which should receive idle events.  Then idle events will only be sent
6204     to those windows and not to any others.
6205     """
6206     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6207     __repr__ = _swig_repr
6208     def __init__(self, *args, **kwargs):
6209         """
6210         __init__(self) -> IdleEvent
6211
6212         Constructor
6213         """
6214         _core_.IdleEvent_swiginit(self,_core_.new_IdleEvent(*args, **kwargs))
6215     def RequestMore(*args, **kwargs):
6216         """
6217         RequestMore(self, bool needMore=True)
6218
6219         Tells wxWidgets that more processing is required. This function can be
6220         called by an EVT_IDLE handler for a window to indicate that the
6221         application should forward the EVT_IDLE event once more to the
6222         application windows. If no window calls this function during its
6223         EVT_IDLE handler, then the application will remain in a passive event
6224         loop until a new event is posted to the application by the windowing
6225         system.
6226         """
6227         return _core_.IdleEvent_RequestMore(*args, **kwargs)
6228
6229     def MoreRequested(*args, **kwargs):
6230         """
6231         MoreRequested(self) -> bool
6232
6233         Returns ``True`` if the OnIdle function processing this event
6234         requested more processing time.
6235         """
6236         return _core_.IdleEvent_MoreRequested(*args, **kwargs)
6237
6238     def SetMode(*args, **kwargs):
6239         """
6240         SetMode(int mode)
6241
6242         Static method for specifying how wxWidgets will send idle events: to
6243         all windows, or only to those which specify that they will process the
6244         events.
6245
6246         The mode can be one of the following values:
6247
6248             =========================   ========================================
6249             wx.IDLE_PROCESS_ALL         Send idle events to all windows
6250             wx.IDLE_PROCESS_SPECIFIED   Send idle events only to windows that have
6251                                         the wx.WS_EX_PROCESS_IDLE extra style
6252                                         flag set.
6253             =========================   ========================================
6254
6255         """
6256         return _core_.IdleEvent_SetMode(*args, **kwargs)
6257
6258     SetMode = staticmethod(SetMode)
6259     def GetMode(*args, **kwargs):
6260         """
6261         GetMode() -> int
6262
6263         Static method returning a value specifying how wxWidgets will send
6264         idle events: to all windows, or only to those which specify that they
6265         will process the events.
6266         """
6267         return _core_.IdleEvent_GetMode(*args, **kwargs)
6268
6269     GetMode = staticmethod(GetMode)
6270     def CanSend(*args, **kwargs):
6271         """
6272         CanSend(Window win) -> bool
6273
6274         Returns ``True`` if it is appropriate to send idle events to this
6275         window.
6276
6277         This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6278         the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6279         events should be sent to this window now. By default this will always
6280         return ``True`` because the update mode is initially
6281         wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6282         to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6283         """
6284         return _core_.IdleEvent_CanSend(*args, **kwargs)
6285
6286     CanSend = staticmethod(CanSend)
6287 _core_.IdleEvent_swigregister(IdleEvent)
6288
6289 def IdleEvent_SetMode(*args, **kwargs):
6290   """
6291     IdleEvent_SetMode(int mode)
6292
6293     Static method for specifying how wxWidgets will send idle events: to
6294     all windows, or only to those which specify that they will process the
6295     events.
6296
6297     The mode can be one of the following values:
6298
6299         =========================   ========================================
6300         wx.IDLE_PROCESS_ALL         Send idle events to all windows
6301         wx.IDLE_PROCESS_SPECIFIED   Send idle events only to windows that have
6302                                     the wx.WS_EX_PROCESS_IDLE extra style
6303                                     flag set.
6304         =========================   ========================================
6305
6306     """
6307   return _core_.IdleEvent_SetMode(*args, **kwargs)
6308
6309 def IdleEvent_GetMode(*args):
6310   """
6311     IdleEvent_GetMode() -> int
6312
6313     Static method returning a value specifying how wxWidgets will send
6314     idle events: to all windows, or only to those which specify that they
6315     will process the events.
6316     """
6317   return _core_.IdleEvent_GetMode(*args)
6318
6319 def IdleEvent_CanSend(*args, **kwargs):
6320   """
6321     IdleEvent_CanSend(Window win) -> bool
6322
6323     Returns ``True`` if it is appropriate to send idle events to this
6324     window.
6325
6326     This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6327     the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6328     events should be sent to this window now. By default this will always
6329     return ``True`` because the update mode is initially
6330     wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6331     to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6332     """
6333   return _core_.IdleEvent_CanSend(*args, **kwargs)
6334
6335 #---------------------------------------------------------------------------
6336
6337 class ClipboardTextEvent(CommandEvent):
6338     """
6339     A Clipboard Text event is sent when a window intercepts a text
6340     copy/cut/paste message, i.e. the user has cut/copied/pasted data
6341     from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a
6342     popup menu command, etc.  NOTE : under windows these events are *NOT*
6343     generated automatically for a Rich Edit text control.
6344     """
6345     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6346     __repr__ = _swig_repr
6347     def __init__(self, *args, **kwargs):
6348         """
6349         __init__(self, EventType type=wxEVT_NULL, int winid=0) -> ClipboardTextEvent
6350
6351         A Clipboard Text event is sent when a window intercepts a text
6352         copy/cut/paste message, i.e. the user has cut/copied/pasted data
6353         from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a
6354         popup menu command, etc.  NOTE : under windows these events are *NOT*
6355         generated automatically for a Rich Edit text control.
6356         """
6357         _core_.ClipboardTextEvent_swiginit(self,_core_.new_ClipboardTextEvent(*args, **kwargs))
6358 _core_.ClipboardTextEvent_swigregister(ClipboardTextEvent)
6359
6360 #---------------------------------------------------------------------------
6361
6362 class PyEvent(Event):
6363     """
6364     wx.PyEvent can be used as a base class for implementing custom event
6365     types in Python.  You should derived from this class instead of
6366     `wx.Event` because this class is Python-aware and is able to transport
6367     its Python bits safely through the wxWidgets event system and have
6368     them still be there when the event handler is invoked.
6369
6370     :see: `wx.PyCommandEvent`
6371
6372     """
6373     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6374     __repr__ = _swig_repr
6375     def __init__(self, *args, **kwargs):
6376         """__init__(self, int winid=0, EventType eventType=wxEVT_NULL) -> PyEvent"""
6377         _core_.PyEvent_swiginit(self,_core_.new_PyEvent(*args, **kwargs))
6378         self._SetSelf(self)
6379
6380     __swig_destroy__ = _core_.delete_PyEvent
6381     __del__ = lambda self : None;
6382     def _SetSelf(*args, **kwargs):
6383         """_SetSelf(self, PyObject self)"""
6384         return _core_.PyEvent__SetSelf(*args, **kwargs)
6385
6386     def _GetSelf(*args, **kwargs):
6387         """_GetSelf(self) -> PyObject"""
6388         return _core_.PyEvent__GetSelf(*args, **kwargs)
6389
6390 _core_.PyEvent_swigregister(PyEvent)
6391
6392 class PyCommandEvent(CommandEvent):
6393     """
6394     wx.PyCommandEvent can be used as a base class for implementing custom
6395     event types in Python, where the event shoudl travel up to parent
6396     windows looking for a handler.  You should derived from this class
6397     instead of `wx.CommandEvent` because this class is Python-aware and is
6398     able to transport its Python bits safely through the wxWidgets event
6399     system and have them still be there when the event handler is invoked.
6400
6401     :see: `wx.PyEvent`
6402
6403     """
6404     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6405     __repr__ = _swig_repr
6406     def __init__(self, *args, **kwargs):
6407         """__init__(self, EventType eventType=wxEVT_NULL, int id=0) -> PyCommandEvent"""
6408         _core_.PyCommandEvent_swiginit(self,_core_.new_PyCommandEvent(*args, **kwargs))
6409         self._SetSelf(self)
6410
6411     __swig_destroy__ = _core_.delete_PyCommandEvent
6412     __del__ = lambda self : None;
6413     def _SetSelf(*args, **kwargs):
6414         """_SetSelf(self, PyObject self)"""
6415         return _core_.PyCommandEvent__SetSelf(*args, **kwargs)
6416
6417     def _GetSelf(*args, **kwargs):
6418         """_GetSelf(self) -> PyObject"""
6419         return _core_.PyCommandEvent__GetSelf(*args, **kwargs)
6420
6421 _core_.PyCommandEvent_swigregister(PyCommandEvent)
6422
6423 class DateEvent(CommandEvent):
6424     """
6425     This event class holds information about a date change event and is
6426     used together with `wx.DatePickerCtrl`. It also serves as a base class
6427     for `wx.calendar.CalendarEvent`.  Bind these event types with
6428     EVT_DATE_CHANGED.
6429     """
6430     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6431     __repr__ = _swig_repr
6432     def __init__(self, *args, **kwargs):
6433         """__init__(self, Window win, DateTime dt, EventType type) -> DateEvent"""
6434         _core_.DateEvent_swiginit(self,_core_.new_DateEvent(*args, **kwargs))
6435     def GetDate(*args, **kwargs):
6436         """
6437         GetDate(self) -> DateTime
6438
6439         Returns the date.
6440         """
6441         return _core_.DateEvent_GetDate(*args, **kwargs)
6442
6443     def SetDate(*args, **kwargs):
6444         """
6445         SetDate(self, DateTime date)
6446
6447         Sets the date carried by the event, normally only used by the library
6448         internally.
6449         """
6450         return _core_.DateEvent_SetDate(*args, **kwargs)
6451
6452 _core_.DateEvent_swigregister(DateEvent)
6453
6454 wxEVT_DATE_CHANGED = _core_.wxEVT_DATE_CHANGED
6455 EVT_DATE_CHANGED = wx.PyEventBinder( wxEVT_DATE_CHANGED, 1 )
6456
6457 #---------------------------------------------------------------------------
6458
6459 PYAPP_ASSERT_SUPPRESS = _core_.PYAPP_ASSERT_SUPPRESS
6460 PYAPP_ASSERT_EXCEPTION = _core_.PYAPP_ASSERT_EXCEPTION
6461 PYAPP_ASSERT_DIALOG = _core_.PYAPP_ASSERT_DIALOG
6462 PYAPP_ASSERT_LOG = _core_.PYAPP_ASSERT_LOG
6463 PRINT_WINDOWS = _core_.PRINT_WINDOWS
6464 PRINT_POSTSCRIPT = _core_.PRINT_POSTSCRIPT
6465 class PyApp(EvtHandler):
6466     """
6467     The ``wx.PyApp`` class is an *implementation detail*, please use the
6468     `wx.App` class (or some other derived class) instead.
6469     """
6470     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6471     __repr__ = _swig_repr
6472     def __init__(self, *args, **kwargs):
6473         """
6474         __init__(self) -> PyApp
6475
6476         Create a new application object, starting the bootstrap process.
6477         """
6478         _core_.PyApp_swiginit(self,_core_.new_PyApp(*args, **kwargs))
6479         self._setCallbackInfo(self, PyApp, False)
6480         self._setOORInfo(self, False)
6481
6482     __swig_destroy__ = _core_.delete_PyApp
6483     __del__ = lambda self : None;
6484     def _setCallbackInfo(*args, **kwargs):
6485         """_setCallbackInfo(self, PyObject self, PyObject _class, bool incref)"""
6486         return _core_.PyApp__setCallbackInfo(*args, **kwargs)
6487
6488     def GetAppName(*args, **kwargs):
6489         """
6490         GetAppName(self) -> String
6491
6492         Get the application name.
6493         """
6494         return _core_.PyApp_GetAppName(*args, **kwargs)
6495
6496     def SetAppName(*args, **kwargs):
6497         """
6498         SetAppName(self, String name)
6499
6500         Set the application name. This value may be used automatically by
6501         `wx.Config` and such.
6502         """
6503         return _core_.PyApp_SetAppName(*args, **kwargs)
6504
6505     def GetClassName(*args, **kwargs):
6506         """
6507         GetClassName(self) -> String
6508
6509         Get the application's class name.
6510         """
6511         return _core_.PyApp_GetClassName(*args, **kwargs)
6512
6513     def SetClassName(*args, **kwargs):
6514         """
6515         SetClassName(self, String name)
6516
6517         Set the application's class name. This value may be used for
6518         X-resources if applicable for the platform
6519         """
6520         return _core_.PyApp_SetClassName(*args, **kwargs)
6521
6522     def GetVendorName(*args, **kwargs):
6523         """
6524         GetVendorName(self) -> String
6525
6526         Get the application's vendor name.
6527         """
6528         return _core_.PyApp_GetVendorName(*args, **kwargs)
6529
6530     def SetVendorName(*args, **kwargs):
6531         """
6532         SetVendorName(self, String name)
6533
6534         Set the application's vendor name. This value may be used
6535         automatically by `wx.Config` and such.
6536         """
6537         return _core_.PyApp_SetVendorName(*args, **kwargs)
6538
6539     def GetTraits(*args, **kwargs):
6540         """
6541         GetTraits(self) -> wxAppTraits
6542
6543         Return (and create if necessary) the app traits object to which we
6544         delegate for everything which either should be configurable by the
6545         user (then he can change the default behaviour simply by overriding
6546         CreateTraits() and returning his own traits object) or which is
6547         GUI/console dependent as then wx.AppTraits allows us to abstract the
6548         differences behind the common facade.
6549
6550         :todo: Add support for overriding CreateAppTraits in wxPython.
6551         """
6552         return _core_.PyApp_GetTraits(*args, **kwargs)
6553
6554     def ProcessPendingEvents(*args, **kwargs):
6555         """
6556         ProcessPendingEvents(self)
6557
6558         Process all events in the Pending Events list -- it is necessary to
6559         call this function to process posted events. This normally happens
6560         during each event loop iteration.
6561         """
6562         return _core_.PyApp_ProcessPendingEvents(*args, **kwargs)
6563
6564     def Yield(*args, **kwargs):
6565         """
6566         Yield(self, bool onlyIfNeeded=False) -> bool
6567
6568         Process all currently pending events right now, instead of waiting
6569         until return to the event loop.  It is an error to call ``Yield``
6570         recursively unless the value of ``onlyIfNeeded`` is True.
6571
6572         :warning: This function is dangerous as it can lead to unexpected
6573               reentrancies (i.e. when called from an event handler it may
6574               result in calling the same event handler again), use with
6575               extreme care or, better, don't use at all!
6576
6577         :see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield`
6578
6579         """
6580         return _core_.PyApp_Yield(*args, **kwargs)
6581
6582     def WakeUpIdle(*args, **kwargs):
6583         """
6584         WakeUpIdle(self)
6585
6586         Make sure that idle events are sent again.
6587         :see: `wx.WakeUpIdle`
6588         """
6589         return _core_.PyApp_WakeUpIdle(*args, **kwargs)
6590
6591     def IsMainLoopRunning(*args, **kwargs):
6592         """
6593         IsMainLoopRunning() -> bool
6594
6595         Returns True if we're running the main loop, i.e. if the events can
6596         currently be dispatched.
6597         """
6598         return _core_.PyApp_IsMainLoopRunning(*args, **kwargs)
6599
6600     IsMainLoopRunning = staticmethod(IsMainLoopRunning)
6601     def MainLoop(*args, **kwargs):
6602         """
6603         MainLoop(self) -> int
6604
6605         Execute the main GUI loop, the function doesn't normally return until
6606         all top level windows have been closed and destroyed.
6607         """
6608         return _core_.PyApp_MainLoop(*args, **kwargs)
6609
6610     def Exit(*args, **kwargs):
6611         """
6612         Exit(self)
6613
6614         Exit the main loop thus terminating the application.
6615         :see: `wx.Exit`
6616         """
6617         return _core_.PyApp_Exit(*args, **kwargs)
6618
6619     def ExitMainLoop(*args, **kwargs):
6620         """
6621         ExitMainLoop(self)
6622
6623         Exit the main GUI loop during the next iteration of the main
6624         loop, (i.e. it does not stop the program immediately!)
6625         """
6626         return _core_.PyApp_ExitMainLoop(*args, **kwargs)
6627
6628     def Pending(*args, **kwargs):
6629         """
6630         Pending(self) -> bool
6631
6632         Returns True if there are unprocessed events in the event queue.
6633         """
6634         return _core_.PyApp_Pending(*args, **kwargs)
6635
6636     def Dispatch(*args, **kwargs):
6637         """
6638         Dispatch(self) -> bool
6639
6640         Process the first event in the event queue (blocks until an event
6641         appears if there are none currently)
6642         """
6643         return _core_.PyApp_Dispatch(*args, **kwargs)
6644
6645     def ProcessIdle(*args, **kwargs):
6646         """
6647         ProcessIdle(self) -> bool
6648
6649         Called from the MainLoop when the application becomes idle (there are
6650         no pending events) and sends a `wx.IdleEvent` to all interested
6651         parties.  Returns True if more idle events are needed, False if not.
6652         """
6653         return _core_.PyApp_ProcessIdle(*args, **kwargs)
6654
6655     def SendIdleEvents(*args, **kwargs):
6656         """
6657         SendIdleEvents(self, Window win, IdleEvent event) -> bool
6658
6659         Send idle event to window and all subwindows.  Returns True if more
6660         idle time is requested.
6661         """
6662         return _core_.PyApp_SendIdleEvents(*args, **kwargs)
6663
6664     def IsActive(*args, **kwargs):
6665         """
6666         IsActive(self) -> bool
6667
6668         Return True if our app has focus.
6669         """
6670         return _core_.PyApp_IsActive(*args, **kwargs)
6671
6672     def SetTopWindow(*args, **kwargs):
6673         """
6674         SetTopWindow(self, Window win)
6675
6676         Set the *main* top level window
6677         """
6678         return _core_.PyApp_SetTopWindow(*args, **kwargs)
6679
6680     def GetTopWindow(*args, **kwargs):
6681         """
6682         GetTopWindow(self) -> Window
6683
6684         Return the *main* top level window (if it hadn't been set previously
6685         with SetTopWindow(), will return just some top level window and, if
6686         there not any, will return None)
6687         """
6688         return _core_.PyApp_GetTopWindow(*args, **kwargs)
6689
6690     def SetExitOnFrameDelete(*args, **kwargs):
6691         """
6692         SetExitOnFrameDelete(self, bool flag)
6693
6694         Control the exit behaviour: by default, the program will exit the main
6695         loop (and so, usually, terminate) when the last top-level program
6696         window is deleted.  Beware that if you disable this behaviour (with
6697         SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop()
6698         explicitly from somewhere.
6699         """
6700         return _core_.PyApp_SetExitOnFrameDelete(*args, **kwargs)
6701
6702     def GetExitOnFrameDelete(*args, **kwargs):
6703         """
6704         GetExitOnFrameDelete(self) -> bool
6705
6706         Get the current exit behaviour setting.
6707         """
6708         return _core_.PyApp_GetExitOnFrameDelete(*args, **kwargs)
6709
6710     def SetUseBestVisual(*args, **kwargs):
6711         """
6712         SetUseBestVisual(self, bool flag)
6713
6714         Set whether the app should try to use the best available visual on
6715         systems where more than one is available, (Sun, SGI, XFree86 4, etc.)
6716         """
6717         return _core_.PyApp_SetUseBestVisual(*args, **kwargs)
6718
6719     def GetUseBestVisual(*args, **kwargs):
6720         """
6721         GetUseBestVisual(self) -> bool
6722
6723         Get current UseBestVisual setting.
6724         """
6725         return _core_.PyApp_GetUseBestVisual(*args, **kwargs)
6726
6727     def SetPrintMode(*args, **kwargs):
6728         """SetPrintMode(self, int mode)"""
6729         return _core_.PyApp_SetPrintMode(*args, **kwargs)
6730
6731     def GetPrintMode(*args, **kwargs):
6732         """GetPrintMode(self) -> int"""
6733         return _core_.PyApp_GetPrintMode(*args, **kwargs)
6734
6735     def SetAssertMode(*args, **kwargs):
6736         """
6737         SetAssertMode(self, int mode)
6738
6739         Set the OnAssert behaviour for debug and hybrid builds.
6740         """
6741         return _core_.PyApp_SetAssertMode(*args, **kwargs)
6742
6743     def GetAssertMode(*args, **kwargs):
6744         """
6745         GetAssertMode(self) -> int
6746
6747         Get the current OnAssert behaviour setting.
6748         """
6749         return _core_.PyApp_GetAssertMode(*args, **kwargs)
6750
6751     def GetMacSupportPCMenuShortcuts(*args, **kwargs):
6752         """GetMacSupportPCMenuShortcuts() -> bool"""
6753         return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs)
6754
6755     GetMacSupportPCMenuShortcuts = staticmethod(GetMacSupportPCMenuShortcuts)
6756     def GetMacAboutMenuItemId(*args, **kwargs):
6757         """GetMacAboutMenuItemId() -> long"""
6758         return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs)
6759
6760     GetMacAboutMenuItemId = staticmethod(GetMacAboutMenuItemId)
6761     def GetMacPreferencesMenuItemId(*args, **kwargs):
6762         """GetMacPreferencesMenuItemId() -> long"""
6763         return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs)
6764
6765     GetMacPreferencesMenuItemId = staticmethod(GetMacPreferencesMenuItemId)
6766     def GetMacExitMenuItemId(*args, **kwargs):
6767         """GetMacExitMenuItemId() -> long"""
6768         return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs)
6769
6770     GetMacExitMenuItemId = staticmethod(GetMacExitMenuItemId)
6771     def GetMacHelpMenuTitleName(*args, **kwargs):
6772         """GetMacHelpMenuTitleName() -> String"""
6773         return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs)
6774
6775     GetMacHelpMenuTitleName = staticmethod(GetMacHelpMenuTitleName)
6776     def SetMacSupportPCMenuShortcuts(*args, **kwargs):
6777         """SetMacSupportPCMenuShortcuts(bool val)"""
6778         return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
6779
6780     SetMacSupportPCMenuShortcuts = staticmethod(SetMacSupportPCMenuShortcuts)
6781     def SetMacAboutMenuItemId(*args, **kwargs):
6782         """SetMacAboutMenuItemId(long val)"""
6783         return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
6784
6785     SetMacAboutMenuItemId = staticmethod(SetMacAboutMenuItemId)
6786     def SetMacPreferencesMenuItemId(*args, **kwargs):
6787         """SetMacPreferencesMenuItemId(long val)"""
6788         return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
6789
6790     SetMacPreferencesMenuItemId = staticmethod(SetMacPreferencesMenuItemId)
6791     def SetMacExitMenuItemId(*args, **kwargs):
6792         """SetMacExitMenuItemId(long val)"""
6793         return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
6794
6795     SetMacExitMenuItemId = staticmethod(SetMacExitMenuItemId)
6796     def SetMacHelpMenuTitleName(*args, **kwargs):
6797         """SetMacHelpMenuTitleName(String val)"""
6798         return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
6799
6800     SetMacHelpMenuTitleName = staticmethod(SetMacHelpMenuTitleName)
6801     def _BootstrapApp(*args, **kwargs):
6802         """
6803         _BootstrapApp(self)
6804
6805         For internal use only
6806         """
6807         return _core_.PyApp__BootstrapApp(*args, **kwargs)
6808
6809     def GetComCtl32Version(*args, **kwargs):
6810         """
6811         GetComCtl32Version() -> int
6812
6813         Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
6814         it wasn't found at all.  Raises an exception on non-Windows platforms.
6815         """
6816         return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
6817
6818     GetComCtl32Version = staticmethod(GetComCtl32Version)
6819 _core_.PyApp_swigregister(PyApp)
6820
6821 def PyApp_IsMainLoopRunning(*args):
6822   """
6823     PyApp_IsMainLoopRunning() -> bool
6824
6825     Returns True if we're running the main loop, i.e. if the events can
6826     currently be dispatched.
6827     """
6828   return _core_.PyApp_IsMainLoopRunning(*args)
6829
6830 def PyApp_GetMacSupportPCMenuShortcuts(*args):
6831   """PyApp_GetMacSupportPCMenuShortcuts() -> bool"""
6832   return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args)
6833
6834 def PyApp_GetMacAboutMenuItemId(*args):
6835   """PyApp_GetMacAboutMenuItemId() -> long"""
6836   return _core_.PyApp_GetMacAboutMenuItemId(*args)
6837
6838 def PyApp_GetMacPreferencesMenuItemId(*args):
6839   """PyApp_GetMacPreferencesMenuItemId() -> long"""
6840   return _core_.PyApp_GetMacPreferencesMenuItemId(*args)
6841
6842 def PyApp_GetMacExitMenuItemId(*args):
6843   """PyApp_GetMacExitMenuItemId() -> long"""
6844   return _core_.PyApp_GetMacExitMenuItemId(*args)
6845
6846 def PyApp_GetMacHelpMenuTitleName(*args):
6847   """PyApp_GetMacHelpMenuTitleName() -> String"""
6848   return _core_.PyApp_GetMacHelpMenuTitleName(*args)
6849
6850 def PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs):
6851   """PyApp_SetMacSupportPCMenuShortcuts(bool val)"""
6852   return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
6853
6854 def PyApp_SetMacAboutMenuItemId(*args, **kwargs):
6855   """PyApp_SetMacAboutMenuItemId(long val)"""
6856   return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
6857
6858 def PyApp_SetMacPreferencesMenuItemId(*args, **kwargs):
6859   """PyApp_SetMacPreferencesMenuItemId(long val)"""
6860   return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
6861
6862 def PyApp_SetMacExitMenuItemId(*args, **kwargs):
6863   """PyApp_SetMacExitMenuItemId(long val)"""
6864   return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
6865
6866 def PyApp_SetMacHelpMenuTitleName(*args, **kwargs):
6867   """PyApp_SetMacHelpMenuTitleName(String val)"""
6868   return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
6869
6870 def PyApp_GetComCtl32Version(*args):
6871   """
6872     PyApp_GetComCtl32Version() -> int
6873
6874     Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
6875     it wasn't found at all.  Raises an exception on non-Windows platforms.
6876     """
6877   return _core_.PyApp_GetComCtl32Version(*args)
6878
6879 #---------------------------------------------------------------------------
6880
6881
6882 def Exit(*args):
6883   """
6884     Exit()
6885
6886     Force an exit of the application.  Convenience for wx.GetApp().Exit()
6887     """
6888   return _core_.Exit(*args)
6889
6890 def Yield(*args):
6891   """
6892     Yield() -> bool
6893
6894     Yield to other apps/messages.  Convenience for wx.GetApp().Yield()
6895     """
6896   return _core_.Yield(*args)
6897
6898 def YieldIfNeeded(*args):
6899   """
6900     YieldIfNeeded() -> bool
6901
6902     Yield to other apps/messages.  Convenience for wx.GetApp().Yield(True)
6903     """
6904   return _core_.YieldIfNeeded(*args)
6905
6906 def SafeYield(*args, **kwargs):
6907   """
6908     SafeYield(Window win=None, bool onlyIfNeeded=False) -> bool
6909
6910     This function is similar to `wx.Yield`, except that it disables the
6911     user input to all program windows before calling `wx.Yield` and
6912     re-enables it again afterwards. If ``win`` is not None, this window
6913     will remain enabled, allowing the implementation of some limited user
6914     interaction.
6915
6916     :Returns: the result of the call to `wx.Yield`.
6917     """
6918   return _core_.SafeYield(*args, **kwargs)
6919
6920 def WakeUpIdle(*args):
6921   """
6922     WakeUpIdle()
6923
6924     Cause the message queue to become empty again, so idle events will be
6925     sent.
6926     """
6927   return _core_.WakeUpIdle(*args)
6928
6929 def PostEvent(*args, **kwargs):
6930   """
6931     PostEvent(EvtHandler dest, Event event)
6932
6933     Send an event to a window or other wx.EvtHandler to be processed
6934     later.
6935     """
6936   return _core_.PostEvent(*args, **kwargs)
6937
6938 def App_CleanUp(*args):
6939   """
6940     App_CleanUp()
6941
6942     For internal use only, it is used to cleanup after wxWidgets when
6943     Python shuts down.
6944     """
6945   return _core_.App_CleanUp(*args)
6946
6947 def GetApp(*args):
6948   """
6949     GetApp() -> PyApp
6950
6951     Return a reference to the current wx.App object.
6952     """
6953   return _core_.GetApp(*args)
6954
6955 def SetDefaultPyEncoding(*args, **kwargs):
6956   """
6957     SetDefaultPyEncoding(string encoding)
6958
6959     Sets the encoding that wxPython will use when it needs to convert a
6960     Python string or unicode object to or from a wxString.
6961
6962     The default encoding is the value of ``locale.getdefaultlocale()[1]``
6963     but please be aware that the default encoding within the same locale
6964     may be slightly different on different platforms.  For example, please
6965     see http://www.alanwood.net/demos/charsetdiffs.html for differences
6966     between the common latin/roman encodings.
6967     """
6968   return _core_.SetDefaultPyEncoding(*args, **kwargs)
6969
6970 def GetDefaultPyEncoding(*args):
6971   """
6972     GetDefaultPyEncoding() -> string
6973
6974     Gets the current encoding that wxPython will use when it needs to
6975     convert a Python string or unicode object to or from a wxString.
6976     """
6977   return _core_.GetDefaultPyEncoding(*args)
6978 #----------------------------------------------------------------------
6979
6980 class PyOnDemandOutputWindow:
6981     """
6982     A class that can be used for redirecting Python's stdout and
6983     stderr streams.  It will do nothing until something is wrriten to
6984     the stream at which point it will create a Frame with a text area
6985     and write the text there.
6986     """
6987     def __init__(self, title = "wxPython: stdout/stderr"):
6988         self.frame  = None
6989         self.title  = title
6990         self.pos    = wx.DefaultPosition
6991         self.size   = (450, 300)
6992         self.parent = None
6993
6994     def SetParent(self, parent):
6995         """Set the window to be used as the popup Frame's parent."""
6996         self.parent = parent
6997
6998
6999     def CreateOutputWindow(self, st):
7000         self.frame = wx.Frame(self.parent, -1, self.title, self.pos, self.size,
7001                               style=wx.DEFAULT_FRAME_STYLE)
7002         self.text  = wx.TextCtrl(self.frame, -1, "",
7003                                  style=wx.TE_MULTILINE|wx.TE_READONLY)
7004         self.text.AppendText(st)
7005         self.frame.Show(True)
7006         self.frame.Bind(wx.EVT_CLOSE, self.OnCloseWindow)
7007
7008
7009     def OnCloseWindow(self, event):
7010         if self.frame is not None:
7011             self.frame.Destroy()
7012         self.frame = None
7013         self.text  = None
7014
7015
7016     # These methods provide the file-like output behaviour.
7017     def write(self, text):
7018         """
7019         Create the output window if needed and write the string to it.
7020         If not called in the context of the gui thread then uses
7021         CallAfter to do the work there.
7022         """
7023         if self.frame is None:
7024             if not wx.Thread_IsMain():
7025                 wx.CallAfter(self.CreateOutputWindow, text)
7026             else:
7027                 self.CreateOutputWindow(text)
7028         else:
7029             if not wx.Thread_IsMain():
7030                 wx.CallAfter(self.text.AppendText, text)
7031             else:
7032                 self.text.AppendText(text)
7033
7034
7035     def close(self):
7036         if self.frame is not None:
7037             wx.CallAfter(self.frame.Close)
7038
7039
7040     def flush(self):
7041         pass
7042
7043
7044
7045 #----------------------------------------------------------------------
7046
7047 _defRedirect = (wx.Platform == '__WXMSW__' or wx.Platform == '__WXMAC__')
7048
7049 class App(wx.PyApp):
7050     """
7051     The ``wx.App`` class represents the application and is used to:
7052
7053       * bootstrap the wxPython system and initialize the underlying
7054         gui toolkit
7055       * set and get application-wide properties
7056       * implement the windowing system main message or event loop,
7057         and to dispatch events to window instances
7058       * etc.
7059
7060     Every application must have a ``wx.App`` instance, and all
7061     creation of UI objects should be delayed until after the
7062     ``wx.App`` object has been created in order to ensure that the gui
7063     platform and wxWidgets have been fully initialized.
7064
7065     Normally you would derive from this class and implement an
7066     ``OnInit`` method that creates a frame and then calls
7067     ``self.SetTopWindow(frame)``.
7068
7069     :see: `wx.PySimpleApp` for a simpler app class that can be used
7070            directly.
7071     """
7072
7073     outputWindowClass = PyOnDemandOutputWindow
7074
7075     def __init__(self, redirect=_defRedirect, filename=None,
7076                  useBestVisual=False, clearSigInt=True):
7077         """
7078         Construct a ``wx.App`` object.
7079
7080         :param redirect: Should ``sys.stdout`` and ``sys.stderr`` be
7081             redirected?  Defaults to True on Windows and Mac, False
7082             otherwise.  If `filename` is None then output will be
7083             redirected to a window that pops up as needed.  (You can
7084             control what kind of window is created for the output by
7085             resetting the class variable ``outputWindowClass`` to a
7086             class of your choosing.)
7087
7088         :param filename: The name of a file to redirect output to, if
7089             redirect is True.
7090
7091         :param useBestVisual: Should the app try to use the best
7092             available visual provided by the system (only relevant on
7093             systems that have more than one visual.)  This parameter
7094             must be used instead of calling `SetUseBestVisual` later
7095             on because it must be set before the underlying GUI
7096             toolkit is initialized.
7097
7098         :param clearSigInt: Should SIGINT be cleared?  This allows the
7099             app to terminate upon a Ctrl-C in the console like other
7100             GUI apps will.
7101
7102         :note: You should override OnInit to do applicaition
7103             initialization to ensure that the system, toolkit and
7104             wxWidgets are fully initialized.
7105         """
7106         wx.PyApp.__init__(self)
7107
7108         if wx.Platform == "__WXMAC__":
7109             try:
7110                 import MacOS
7111                 if not MacOS.WMAvailable():
7112                     print """\
7113 This program needs access to the screen. Please run with 'pythonw',
7114 not 'python', and only when you are logged in on the main display of
7115 your Mac."""
7116                     _sys.exit(1)
7117             except SystemExit:
7118                 raise
7119             except:
7120                 pass
7121
7122         # This has to be done before OnInit
7123         self.SetUseBestVisual(useBestVisual)
7124
7125         # Set the default handler for SIGINT.  This fixes a problem
7126         # where if Ctrl-C is pressed in the console that started this
7127         # app then it will not appear to do anything, (not even send
7128         # KeyboardInterrupt???)  but will later segfault on exit.  By
7129         # setting the default handler then the app will exit, as
7130         # expected (depending on platform.)
7131         if clearSigInt:
7132             try:
7133                 import signal
7134                 signal.signal(signal.SIGINT, signal.SIG_DFL)
7135             except:
7136                 pass
7137
7138         # Save and redirect the stdio to a window?
7139         self.stdioWin = None
7140         self.saveStdio = (_sys.stdout, _sys.stderr)
7141         if redirect:
7142             self.RedirectStdio(filename)
7143
7144         # Use Python's install prefix as the default
7145         wx.StandardPaths.Get().SetInstallPrefix(_sys.prefix)
7146
7147         # This finishes the initialization of wxWindows and then calls
7148         # the OnInit that should be present in the derived class
7149         self._BootstrapApp()
7150
7151
7152     def OnPreInit(self):
7153         """
7154         Things that must be done after _BootstrapApp has done its
7155         thing, but would be nice if they were already done by the time
7156         that OnInit is called.
7157         """
7158         wx.StockGDI._initStockObjects()
7159
7160
7161     def __del__(self, destroy=wx.PyApp.__del__):
7162         self.RestoreStdio()  # Just in case the MainLoop was overridden
7163         destroy(self)
7164
7165     def Destroy(self):
7166         wx.PyApp.Destroy(self)
7167         self.thisown = 0
7168
7169     def SetTopWindow(self, frame):
7170         """Set the \"main\" top level window"""
7171         if self.stdioWin:
7172             self.stdioWin.SetParent(frame)
7173         wx.PyApp.SetTopWindow(self, frame)
7174
7175
7176     def MainLoop(self):
7177         """Execute the main GUI event loop"""
7178         wx.PyApp.MainLoop(self)
7179         self.RestoreStdio()
7180
7181
7182     def RedirectStdio(self, filename=None):
7183         """Redirect sys.stdout and sys.stderr to a file or a popup window."""
7184         if filename:
7185             _sys.stdout = _sys.stderr = open(filename, 'a')
7186         else:
7187             self.stdioWin = self.outputWindowClass()
7188             _sys.stdout = _sys.stderr = self.stdioWin
7189
7190
7191     def RestoreStdio(self):
7192         try:
7193             _sys.stdout, _sys.stderr = self.saveStdio
7194         except:
7195             pass
7196
7197
7198     def SetOutputWindowAttributes(self, title=None, pos=None, size=None):
7199         """
7200         Set the title, position and/or size of the output window if
7201         the stdio has been redirected.  This should be called before
7202         any output would cause the output window to be created.
7203         """
7204         if self.stdioWin:
7205             if title is not None:
7206                 self.stdioWin.title = title
7207             if pos is not None:
7208                 self.stdioWin.pos = pos
7209             if size is not None:
7210                 self.stdioWin.size = size
7211
7212
7213
7214
7215 # change from wx.PyApp_XX to wx.App_XX
7216 App_GetMacSupportPCMenuShortcuts = _core_.PyApp_GetMacSupportPCMenuShortcuts
7217 App_GetMacAboutMenuItemId        = _core_.PyApp_GetMacAboutMenuItemId
7218 App_GetMacPreferencesMenuItemId  = _core_.PyApp_GetMacPreferencesMenuItemId
7219 App_GetMacExitMenuItemId         = _core_.PyApp_GetMacExitMenuItemId
7220 App_GetMacHelpMenuTitleName      = _core_.PyApp_GetMacHelpMenuTitleName
7221 App_SetMacSupportPCMenuShortcuts = _core_.PyApp_SetMacSupportPCMenuShortcuts
7222 App_SetMacAboutMenuItemId        = _core_.PyApp_SetMacAboutMenuItemId
7223 App_SetMacPreferencesMenuItemId  = _core_.PyApp_SetMacPreferencesMenuItemId
7224 App_SetMacExitMenuItemId         = _core_.PyApp_SetMacExitMenuItemId
7225 App_SetMacHelpMenuTitleName      = _core_.PyApp_SetMacHelpMenuTitleName
7226 App_GetComCtl32Version           = _core_.PyApp_GetComCtl32Version
7227
7228 #----------------------------------------------------------------------------
7229
7230 class PySimpleApp(wx.App):
7231     """
7232     A simple application class.  You can just create one of these and
7233     then then make your top level windows later, and not have to worry
7234     about OnInit.  For example::
7235
7236         app = wx.PySimpleApp()
7237         frame = wx.Frame(None, title='Hello World')
7238         frame.Show()
7239         app.MainLoop()
7240
7241     :see: `wx.App`
7242     """
7243
7244     def __init__(self, redirect=False, filename=None,
7245                  useBestVisual=False, clearSigInt=True):
7246         """
7247         :see: `wx.App.__init__`
7248         """
7249         wx.App.__init__(self, redirect, filename, useBestVisual, clearSigInt)
7250
7251     def OnInit(self):
7252         return True
7253
7254
7255
7256 # Is anybody using this one?
7257 class PyWidgetTester(wx.App):
7258     def __init__(self, size = (250, 100)):
7259         self.size = size
7260         wx.App.__init__(self, 0)
7261
7262     def OnInit(self):
7263         self.frame = wx.Frame(None, -1, "Widget Tester", pos=(0,0), size=self.size)
7264         self.SetTopWindow(self.frame)
7265         return True
7266
7267     def SetWidget(self, widgetClass, *args, **kwargs):
7268         w = widgetClass(self.frame, *args, **kwargs)
7269         self.frame.Show(True)
7270
7271 #----------------------------------------------------------------------------
7272 # DO NOT hold any other references to this object.  This is how we
7273 # know when to cleanup system resources that wxWidgets is holding.  When
7274 # the sys module is unloaded, the refcount on sys.__wxPythonCleanup
7275 # goes to zero and it calls the wx.App_CleanUp function.
7276
7277 class __wxPyCleanup:
7278     def __init__(self):
7279         self.cleanup = _core_.App_CleanUp
7280     def __del__(self):
7281         self.cleanup()
7282
7283 _sys.__wxPythonCleanup = __wxPyCleanup()
7284
7285 ## # another possible solution, but it gets called too early...
7286 ## import atexit
7287 ## atexit.register(_core_.wxApp_CleanUp)
7288
7289
7290 #----------------------------------------------------------------------------
7291
7292 #---------------------------------------------------------------------------
7293
7294 class EventLoop(object):
7295     """Proxy of C++ EventLoop class"""
7296     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7297     __repr__ = _swig_repr
7298     def __init__(self, *args, **kwargs):
7299         """__init__(self) -> EventLoop"""
7300         _core_.EventLoop_swiginit(self,_core_.new_EventLoop(*args, **kwargs))
7301     __swig_destroy__ = _core_.delete_EventLoop
7302     __del__ = lambda self : None;
7303     def Run(*args, **kwargs):
7304         """Run(self) -> int"""
7305         return _core_.EventLoop_Run(*args, **kwargs)
7306
7307     def Exit(*args, **kwargs):
7308         """Exit(self, int rc=0)"""
7309         return _core_.EventLoop_Exit(*args, **kwargs)
7310
7311     def Pending(*args, **kwargs):
7312         """Pending(self) -> bool"""
7313         return _core_.EventLoop_Pending(*args, **kwargs)
7314
7315     def Dispatch(*args, **kwargs):
7316         """Dispatch(self) -> bool"""
7317         return _core_.EventLoop_Dispatch(*args, **kwargs)
7318
7319     def IsRunning(*args, **kwargs):
7320         """IsRunning(self) -> bool"""
7321         return _core_.EventLoop_IsRunning(*args, **kwargs)
7322
7323     def GetActive(*args, **kwargs):
7324         """GetActive() -> EventLoop"""
7325         return _core_.EventLoop_GetActive(*args, **kwargs)
7326
7327     GetActive = staticmethod(GetActive)
7328     def SetActive(*args, **kwargs):
7329         """SetActive(EventLoop loop)"""
7330         return _core_.EventLoop_SetActive(*args, **kwargs)
7331
7332     SetActive = staticmethod(SetActive)
7333 _core_.EventLoop_swigregister(EventLoop)
7334
7335 def EventLoop_GetActive(*args):
7336   """EventLoop_GetActive() -> EventLoop"""
7337   return _core_.EventLoop_GetActive(*args)
7338
7339 def EventLoop_SetActive(*args, **kwargs):
7340   """EventLoop_SetActive(EventLoop loop)"""
7341   return _core_.EventLoop_SetActive(*args, **kwargs)
7342
7343 class EventLoopActivator(object):
7344     """Proxy of C++ EventLoopActivator class"""
7345     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7346     __repr__ = _swig_repr
7347     def __init__(self, *args, **kwargs):
7348         """__init__(self, EventLoop evtLoop) -> EventLoopActivator"""
7349         _core_.EventLoopActivator_swiginit(self,_core_.new_EventLoopActivator(*args, **kwargs))
7350     __swig_destroy__ = _core_.delete_EventLoopActivator
7351     __del__ = lambda self : None;
7352 _core_.EventLoopActivator_swigregister(EventLoopActivator)
7353
7354 #---------------------------------------------------------------------------
7355
7356 class AcceleratorEntry(object):
7357     """
7358     A class used to define items in an `wx.AcceleratorTable`.  wxPython
7359     programs can choose to use wx.AcceleratorEntry objects, but using a
7360     list of 3-tuple of integers (flags, keyCode, cmdID) usually works just
7361     as well.  See `__init__` for  of the tuple values.
7362
7363     :see: `wx.AcceleratorTable`
7364     """
7365     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7366     __repr__ = _swig_repr
7367     def __init__(self, *args, **kwargs):
7368         """
7369         __init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry
7370
7371         Construct a wx.AcceleratorEntry.
7372         """
7373         _core_.AcceleratorEntry_swiginit(self,_core_.new_AcceleratorEntry(*args, **kwargs))
7374     __swig_destroy__ = _core_.delete_AcceleratorEntry
7375     __del__ = lambda self : None;
7376     def Set(*args, **kwargs):
7377         """
7378         Set(self, int flags, int keyCode, int cmd)
7379
7380         (Re)set the attributes of a wx.AcceleratorEntry.
7381         :see `__init__`
7382         """
7383         return _core_.AcceleratorEntry_Set(*args, **kwargs)
7384
7385     def GetFlags(*args, **kwargs):
7386         """
7387         GetFlags(self) -> int
7388
7389         Get the AcceleratorEntry's flags.
7390         """
7391         return _core_.AcceleratorEntry_GetFlags(*args, **kwargs)
7392
7393     def GetKeyCode(*args, **kwargs):
7394         """
7395         GetKeyCode(self) -> int
7396
7397         Get the AcceleratorEntry's keycode.
7398         """
7399         return _core_.AcceleratorEntry_GetKeyCode(*args, **kwargs)
7400
7401     def GetCommand(*args, **kwargs):
7402         """
7403         GetCommand(self) -> int
7404
7405         Get the AcceleratorEntry's command ID.
7406         """
7407         return _core_.AcceleratorEntry_GetCommand(*args, **kwargs)
7408
7409 _core_.AcceleratorEntry_swigregister(AcceleratorEntry)
7410
7411 class AcceleratorTable(Object):
7412     """
7413     An accelerator table allows the application to specify a table of
7414     keyboard shortcuts for menus or other commands. On Windows, menu or
7415     button commands are supported; on GTK, only menu commands are
7416     supported.
7417     """
7418     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7419     __repr__ = _swig_repr
7420     def __init__(self, *args, **kwargs):
7421         """
7422         __init__(entries) -> AcceleratorTable
7423
7424         Construct an AcceleratorTable from a list of `wx.AcceleratorEntry`
7425         items or or of 3-tuples (flags, keyCode, cmdID)
7426
7427         :see: `wx.AcceleratorEntry`
7428         """
7429         _core_.AcceleratorTable_swiginit(self,_core_.new_AcceleratorTable(*args, **kwargs))
7430     __swig_destroy__ = _core_.delete_AcceleratorTable
7431     __del__ = lambda self : None;
7432     def Ok(*args, **kwargs):
7433         """Ok(self) -> bool"""
7434         return _core_.AcceleratorTable_Ok(*args, **kwargs)
7435
7436 _core_.AcceleratorTable_swigregister(AcceleratorTable)
7437
7438
7439 def GetAccelFromString(*args, **kwargs):
7440   """GetAccelFromString(String label) -> AcceleratorEntry"""
7441   return _core_.GetAccelFromString(*args, **kwargs)
7442 #---------------------------------------------------------------------------
7443
7444 class VisualAttributes(object):
7445     """struct containing all the visual attributes of a control"""
7446     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7447     __repr__ = _swig_repr
7448     def __init__(self, *args, **kwargs):
7449         """
7450         __init__(self) -> VisualAttributes
7451
7452         struct containing all the visual attributes of a control
7453         """
7454         _core_.VisualAttributes_swiginit(self,_core_.new_VisualAttributes(*args, **kwargs))
7455     __swig_destroy__ = _core_.delete_VisualAttributes
7456     __del__ = lambda self : None;
7457     font = property(_core_.VisualAttributes_font_get, _core_.VisualAttributes_font_set)
7458     colFg = property(_core_.VisualAttributes_colFg_get, _core_.VisualAttributes_colFg_set)
7459     colBg = property(_core_.VisualAttributes_colBg_get, _core_.VisualAttributes_colBg_set)
7460 _core_.VisualAttributes_swigregister(VisualAttributes)
7461 NullAcceleratorTable = cvar.NullAcceleratorTable
7462 PanelNameStr = cvar.PanelNameStr
7463
7464 WINDOW_VARIANT_NORMAL = _core_.WINDOW_VARIANT_NORMAL
7465 WINDOW_VARIANT_SMALL = _core_.WINDOW_VARIANT_SMALL
7466 WINDOW_VARIANT_MINI = _core_.WINDOW_VARIANT_MINI
7467 WINDOW_VARIANT_LARGE = _core_.WINDOW_VARIANT_LARGE
7468 WINDOW_VARIANT_MAX = _core_.WINDOW_VARIANT_MAX
7469 class Window(EvtHandler):
7470     """
7471     wx.Window is the base class for all windows and represents any visible
7472     object on the screen. All controls, top level windows and so on are
7473     wx.Windows. Sizers and device contexts are not however, as they don't
7474     appear on screen themselves.
7475
7476     """
7477     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7478     __repr__ = _swig_repr
7479     def __init__(self, *args, **kwargs):
7480         """
7481         __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
7482             Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window
7483
7484         Construct and show a generic Window.
7485         """
7486         _core_.Window_swiginit(self,_core_.new_Window(*args, **kwargs))
7487         self._setOORInfo(self)
7488
7489     def Create(*args, **kwargs):
7490         """
7491         Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
7492             Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool
7493
7494         Create the GUI part of the Window for 2-phase creation mode.
7495         """
7496         return _core_.Window_Create(*args, **kwargs)
7497
7498     def Close(*args, **kwargs):
7499         """
7500         Close(self, bool force=False) -> bool
7501
7502         This function simply generates a EVT_CLOSE event whose handler usually
7503         tries to close the window. It doesn't close the window itself,
7504         however.  If force is False (the default) then the window's close
7505         handler will be allowed to veto the destruction of the window.
7506         """
7507         return _core_.Window_Close(*args, **kwargs)
7508
7509     def Destroy(*args, **kwargs):
7510         """
7511         Destroy(self) -> bool
7512
7513         Destroys the window safely.  Frames and dialogs are not destroyed
7514         immediately when this function is called -- they are added to a list
7515         of windows to be deleted on idle time, when all the window's events
7516         have been processed. This prevents problems with events being sent to
7517         non-existent windows.
7518
7519         Returns True if the window has either been successfully deleted, or it
7520         has been added to the list of windows pending real deletion.
7521         """
7522         val = _core_.Window_Destroy(*args, **kwargs)
7523         args[0].thisown = 0
7524         return val
7525
7526     def DestroyChildren(*args, **kwargs):
7527         """
7528         DestroyChildren(self) -> bool
7529
7530         Destroys all children of a window. Called automatically by the
7531         destructor.
7532         """
7533         return _core_.Window_DestroyChildren(*args, **kwargs)
7534
7535     def IsBeingDeleted(*args, **kwargs):
7536         """
7537         IsBeingDeleted(self) -> bool
7538
7539         Is the window in the process of being deleted?
7540         """
7541         return _core_.Window_IsBeingDeleted(*args, **kwargs)
7542
7543     def SetLabel(*args, **kwargs):
7544         """
7545         SetLabel(self, String label)
7546
7547         Set the text which the window shows in its label if applicable.
7548         """
7549         return _core_.Window_SetLabel(*args, **kwargs)
7550
7551     def GetLabel(*args, **kwargs):
7552         """
7553         GetLabel(self) -> String
7554
7555         Generic way of getting a label from any window, for identification
7556         purposes.  The interpretation of this function differs from class to
7557         class. For frames and dialogs, the value returned is the title. For
7558         buttons or static text controls, it is the button text. This function
7559         can be useful for meta-programs such as testing tools or special-needs
7560         access programs)which need to identify windows by name.
7561         """
7562         return _core_.Window_GetLabel(*args, **kwargs)
7563
7564     def SetName(*args, **kwargs):
7565         """
7566         SetName(self, String name)
7567
7568         Sets the window's name.  The window name is used for ressource setting
7569         in X, it is not the same as the window title/label
7570         """
7571         return _core_.Window_SetName(*args, **kwargs)
7572
7573     def GetName(*args, **kwargs):
7574         """
7575         GetName(self) -> String
7576
7577         Returns the windows name.  This name is not guaranteed to be unique;
7578         it is up to the programmer to supply an appropriate name in the window
7579         constructor or via wx.Window.SetName.
7580         """
7581         return _core_.Window_GetName(*args, **kwargs)
7582
7583     def SetWindowVariant(*args, **kwargs):
7584         """
7585         SetWindowVariant(self, int variant)
7586
7587         Sets the variant of the window/font size to use for this window, if
7588         the platform supports variants, for example, wxMac.
7589         """
7590         return _core_.Window_SetWindowVariant(*args, **kwargs)
7591
7592     def GetWindowVariant(*args, **kwargs):
7593         """GetWindowVariant(self) -> int"""
7594         return _core_.Window_GetWindowVariant(*args, **kwargs)
7595
7596     def SetId(*args, **kwargs):
7597         """
7598         SetId(self, int winid)
7599
7600         Sets the identifier of the window.  Each window has an integer
7601         identifier. If the application has not provided one, an identifier
7602         will be generated. Normally, the identifier should be provided on
7603         creation and should not be modified subsequently.
7604         """
7605         return _core_.Window_SetId(*args, **kwargs)
7606
7607     def GetId(*args, **kwargs):
7608         """
7609         GetId(self) -> int
7610
7611         Returns the identifier of the window.  Each window has an integer
7612         identifier. If the application has not provided one (or the default Id
7613         -1 is used) then an unique identifier with a negative value will be
7614         generated.
7615         """
7616         return _core_.Window_GetId(*args, **kwargs)
7617
7618     def NewControlId(*args, **kwargs):
7619         """
7620         NewControlId() -> int
7621
7622         Generate a control id for the controls which were not given one.
7623         """
7624         return _core_.Window_NewControlId(*args, **kwargs)
7625
7626     NewControlId = staticmethod(NewControlId)
7627     def NextControlId(*args, **kwargs):
7628         """
7629         NextControlId(int winid) -> int
7630
7631         Get the id of the control following the one with the given
7632         autogenerated) id
7633         """
7634         return _core_.Window_NextControlId(*args, **kwargs)
7635
7636     NextControlId = staticmethod(NextControlId)
7637     def PrevControlId(*args, **kwargs):
7638         """
7639         PrevControlId(int winid) -> int
7640
7641         Get the id of the control preceding the one with the given
7642         autogenerated) id
7643         """
7644         return _core_.Window_PrevControlId(*args, **kwargs)
7645
7646     PrevControlId = staticmethod(PrevControlId)
7647     def SetSize(*args, **kwargs):
7648         """
7649         SetSize(self, Size size)
7650
7651         Sets the size of the window in pixels.
7652         """
7653         return _core_.Window_SetSize(*args, **kwargs)
7654
7655     def SetDimensions(*args, **kwargs):
7656         """
7657         SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
7658
7659         Sets the position and size of the window in pixels.  The sizeFlags
7660         parameter indicates the interpretation of the other params if they are
7661         equal to -1.
7662
7663             ========================  ======================================
7664             wx.SIZE_AUTO              A -1 indicates that a class-specific
7665                                       default should be used.
7666             wx.SIZE_USE_EXISTING      Axisting dimensions should be used if
7667                                       -1 values are supplied.
7668             wxSIZE_ALLOW_MINUS_ONE    Allow dimensions of -1 and less to be
7669                                       interpreted as real dimensions, not
7670                                       default values.
7671             ========================  ======================================
7672
7673         """
7674         return _core_.Window_SetDimensions(*args, **kwargs)
7675
7676     def SetRect(*args, **kwargs):
7677         """
7678         SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
7679
7680         Sets the position and size of the window in pixels using a wx.Rect.
7681         """
7682         return _core_.Window_SetRect(*args, **kwargs)
7683
7684     def SetSizeWH(*args, **kwargs):
7685         """
7686         SetSizeWH(self, int width, int height)
7687
7688         Sets the size of the window in pixels.
7689         """
7690         return _core_.Window_SetSizeWH(*args, **kwargs)
7691
7692     def Move(*args, **kwargs):
7693         """
7694         Move(self, Point pt, int flags=SIZE_USE_EXISTING)
7695
7696         Moves the window to the given position.
7697         """
7698         return _core_.Window_Move(*args, **kwargs)
7699
7700     SetPosition = Move
7701     def MoveXY(*args, **kwargs):
7702         """
7703         MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
7704
7705         Moves the window to the given position.
7706         """
7707         return _core_.Window_MoveXY(*args, **kwargs)
7708
7709     def SetBestFittingSize(*args, **kwargs):
7710         """
7711         SetBestFittingSize(self, Size size=DefaultSize)
7712
7713         A 'Smart' SetSize that will fill in default size components with the
7714         window's *best size* values.  Also set's the minsize for use with sizers.
7715         """
7716         return _core_.Window_SetBestFittingSize(*args, **kwargs)
7717
7718     def Raise(*args, **kwargs):
7719         """
7720         Raise(self)
7721
7722         Raises the window to the top of the window hierarchy.  In current
7723         version of wxWidgets this works both for manage and child windows.
7724         """
7725         return _core_.Window_Raise(*args, **kwargs)
7726
7727     def Lower(*args, **kwargs):
7728         """
7729         Lower(self)
7730
7731         Lowers the window to the bottom of the window hierarchy.  In current
7732         version of wxWidgets this works both for manage and child windows.
7733         """
7734         return _core_.Window_Lower(*args, **kwargs)
7735
7736     def SetClientSize(*args, **kwargs):
7737         """
7738         SetClientSize(self, Size size)
7739
7740         This sets the size of the window client area in pixels. Using this
7741         function to size a window tends to be more device-independent than
7742         wx.Window.SetSize, since the application need not worry about what
7743         dimensions the border or title bar have when trying to fit the window
7744         around panel items, for example.
7745         """
7746         return _core_.Window_SetClientSize(*args, **kwargs)
7747
7748     def SetClientSizeWH(*args, **kwargs):
7749         """
7750         SetClientSizeWH(self, int width, int height)
7751
7752         This sets the size of the window client area in pixels. Using this
7753         function to size a window tends to be more device-independent than
7754         wx.Window.SetSize, since the application need not worry about what
7755         dimensions the border or title bar have when trying to fit the window
7756         around panel items, for example.
7757         """
7758         return _core_.Window_SetClientSizeWH(*args, **kwargs)
7759
7760     def SetClientRect(*args, **kwargs):
7761         """
7762         SetClientRect(self, Rect rect)
7763
7764         This sets the size of the window client area in pixels. Using this
7765         function to size a window tends to be more device-independent than
7766         wx.Window.SetSize, since the application need not worry about what
7767         dimensions the border or title bar have when trying to fit the window
7768         around panel items, for example.
7769         """
7770         return _core_.Window_SetClientRect(*args, **kwargs)
7771
7772     def GetPosition(*args, **kwargs):
7773         """
7774         GetPosition(self) -> Point
7775
7776         Get the window's position.  Notice that the position is in client
7777         coordinates for child windows and screen coordinates for the top level
7778         ones, use `GetScreenPosition` if you need screen coordinates for all
7779         kinds of windows.
7780         """
7781         return _core_.Window_GetPosition(*args, **kwargs)
7782
7783     def GetPositionTuple(*args, **kwargs):
7784         """
7785         GetPositionTuple() -> (x,y)
7786
7787         Get the window's position.  Notice that the position is in client
7788         coordinates for child windows and screen coordinates for the top level
7789         ones, use `GetScreenPosition` if you need screen coordinates for all
7790         kinds of windows.
7791         """
7792         return _core_.Window_GetPositionTuple(*args, **kwargs)
7793
7794     def GetScreenPosition(*args, **kwargs):
7795         """
7796         GetScreenPosition(self) -> Point
7797
7798         Get the position of the window in screen coordinantes.
7799         """
7800         return _core_.Window_GetScreenPosition(*args, **kwargs)
7801
7802     def GetScreenPositionTuple(*args, **kwargs):
7803         """
7804         GetScreenPositionTuple() -> (x,y)
7805
7806         Get the position of the window in screen coordinantes.
7807         """
7808         return _core_.Window_GetScreenPositionTuple(*args, **kwargs)
7809
7810     def GetScreenRect(*args, **kwargs):
7811         """
7812         GetScreenRect(self) -> Rect
7813
7814         Returns the size and position of the window in screen coordinantes as
7815         a `wx.Rect` object.
7816         """
7817         return _core_.Window_GetScreenRect(*args, **kwargs)
7818
7819     def GetSize(*args, **kwargs):
7820         """
7821         GetSize(self) -> Size
7822
7823         Get the window size.
7824         """
7825         return _core_.Window_GetSize(*args, **kwargs)
7826
7827     def GetSizeTuple(*args, **kwargs):
7828         """
7829         GetSizeTuple() -> (width, height)
7830
7831         Get the window size.
7832         """
7833         return _core_.Window_GetSizeTuple(*args, **kwargs)
7834
7835     def GetRect(*args, **kwargs):
7836         """
7837         GetRect(self) -> Rect
7838
7839         Returns the size and position of the window as a `wx.Rect` object.
7840         """
7841         return _core_.Window_GetRect(*args, **kwargs)
7842
7843     def GetClientSize(*args, **kwargs):
7844         """
7845         GetClientSize(self) -> Size
7846
7847         This gets the size of the window's 'client area' in pixels. The client
7848         area is the area which may be drawn on by the programmer, excluding
7849         title bar, border, scrollbars, etc.
7850         """
7851         return _core_.Window_GetClientSize(*args, **kwargs)
7852
7853     def GetClientSizeTuple(*args, **kwargs):
7854         """
7855         GetClientSizeTuple() -> (width, height)
7856
7857         This gets the size of the window's 'client area' in pixels. The client
7858         area is the area which may be drawn on by the programmer, excluding
7859         title bar, border, scrollbars, etc.
7860         """
7861         return _core_.Window_GetClientSizeTuple(*args, **kwargs)
7862
7863     def GetClientAreaOrigin(*args, **kwargs):
7864         """
7865         GetClientAreaOrigin(self) -> Point
7866
7867         Get the origin of the client area of the window relative to the
7868         window's top left corner (the client area may be shifted because of
7869         the borders, scrollbars, other decorations...)
7870         """
7871         return _core_.Window_GetClientAreaOrigin(*args, **kwargs)
7872
7873     def GetClientRect(*args, **kwargs):
7874         """
7875         GetClientRect(self) -> Rect
7876
7877         Get the client area position and size as a `wx.Rect` object.
7878         """
7879         return _core_.Window_GetClientRect(*args, **kwargs)
7880
7881     def GetBestSize(*args, **kwargs):
7882         """
7883         GetBestSize(self) -> Size
7884
7885         This function returns the best acceptable minimal size for the
7886         window, if applicable. For example, for a static text control, it will
7887         be the minimal size such that the control label is not truncated. For
7888         windows containing subwindows (suzh aswx.Panel), the size returned by
7889         this function will be the same as the size the window would have had
7890         after calling Fit.
7891         """
7892         return _core_.Window_GetBestSize(*args, **kwargs)
7893
7894     def GetBestSizeTuple(*args, **kwargs):
7895         """
7896         GetBestSizeTuple() -> (width, height)
7897
7898         This function returns the best acceptable minimal size for the
7899         window, if applicable. For example, for a static text control, it will
7900         be the minimal size such that the control label is not truncated. For
7901         windows containing subwindows (suzh aswx.Panel), the size returned by
7902         this function will be the same as the size the window would have had
7903         after calling Fit.
7904         """
7905         return _core_.Window_GetBestSizeTuple(*args, **kwargs)
7906
7907     def InvalidateBestSize(*args, **kwargs):
7908         """
7909         InvalidateBestSize(self)
7910
7911         Reset the cached best size value so it will be recalculated the next
7912         time it is needed.
7913         """
7914         return _core_.Window_InvalidateBestSize(*args, **kwargs)
7915
7916     def CacheBestSize(*args, **kwargs):
7917         """
7918         CacheBestSize(self, Size size)
7919
7920         Cache the best size so it doesn't need to be calculated again, (at least until
7921         some properties of the window change.)
7922         """
7923         return _core_.Window_CacheBestSize(*args, **kwargs)
7924
7925     def GetBestFittingSize(*args, **kwargs):
7926         """
7927         GetBestFittingSize(self) -> Size
7928
7929         This function will merge the window's best size into the window's
7930         minimum size, giving priority to the min size components, and returns
7931         the results.
7932
7933         """
7934         return _core_.Window_GetBestFittingSize(*args, **kwargs)
7935
7936     def GetAdjustedBestSize(*args, **kwargs):
7937         """
7938         GetAdjustedBestSize(self) -> Size
7939
7940         This method is similar to GetBestSize, except in one
7941         thing. GetBestSize should return the minimum untruncated size of the
7942         window, while this method will return the largest of BestSize and any
7943         user specified minimum size. ie. it is the minimum size the window
7944         should currently be drawn at, not the minimal size it can possibly
7945         tolerate.
7946         """
7947         return _core_.Window_GetAdjustedBestSize(*args, **kwargs)
7948
7949     def Center(*args, **kwargs):
7950         """
7951         Center(self, int direction=BOTH)
7952
7953         Centers the window.  The parameter specifies the direction for
7954         cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
7955         also include wx.CENTER_ON_SCREEN flag if you want to center the window
7956         on the entire screen and not on its parent window.  If it is a
7957         top-level window and has no parent then it will always be centered
7958         relative to the screen.
7959         """
7960         return _core_.Window_Center(*args, **kwargs)
7961
7962     Centre = Center
7963     def CenterOnParent(*args, **kwargs):
7964         """
7965         CenterOnParent(self, int dir=BOTH)
7966
7967         Center with respect to the the parent window
7968         """
7969         return _core_.Window_CenterOnParent(*args, **kwargs)
7970
7971     CentreOnParent = CenterOnParent
7972     def Fit(*args, **kwargs):
7973         """
7974         Fit(self)
7975
7976         Sizes the window so that it fits around its subwindows. This function
7977         won't do anything if there are no subwindows and will only really work
7978         correctly if sizers are used for the subwindows layout. Also, if the
7979         window has exactly one subwindow it is better (faster and the result
7980         is more precise as Fit adds some margin to account for fuzziness of
7981         its calculations) to call window.SetClientSize(child.GetSize())
7982         instead of calling Fit.
7983         """
7984         return _core_.Window_Fit(*args, **kwargs)
7985
7986     def FitInside(*args, **kwargs):
7987         """
7988         FitInside(self)
7989
7990         Similar to Fit, but sizes the interior (virtual) size of a
7991         window. Mainly useful with scrolled windows to reset scrollbars after
7992         sizing changes that do not trigger a size event, and/or scrolled
7993         windows without an interior sizer. This function similarly won't do
7994         anything if there are no subwindows.
7995         """
7996         return _core_.Window_FitInside(*args, **kwargs)
7997
7998     def SetSizeHints(*args, **kwargs):
7999         """
8000         SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1,
8001             int incH=-1)
8002
8003         Allows specification of minimum and maximum window sizes, and window
8004         size increments. If a pair of values is not set (or set to -1), the
8005         default values will be used.  If this function is called, the user
8006         will not be able to size the window outside the given bounds (if it is
8007         a top-level window.)  Sizers will also inspect the minimum window size
8008         and will use that value if set when calculating layout.
8009
8010         The resizing increments are only significant under Motif or Xt.
8011         """
8012         return _core_.Window_SetSizeHints(*args, **kwargs)
8013
8014     def SetSizeHintsSz(*args, **kwargs):
8015         """
8016         SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
8017
8018         Allows specification of minimum and maximum window sizes, and window
8019         size increments. If a pair of values is not set (or set to -1), the
8020         default values will be used.  If this function is called, the user
8021         will not be able to size the window outside the given bounds (if it is
8022         a top-level window.)  Sizers will also inspect the minimum window size
8023         and will use that value if set when calculating layout.
8024
8025         The resizing increments are only significant under Motif or Xt.
8026         """
8027         return _core_.Window_SetSizeHintsSz(*args, **kwargs)
8028
8029     def SetVirtualSizeHints(*args, **kwargs):
8030         """
8031         SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
8032
8033         Allows specification of minimum and maximum virtual window sizes. If a
8034         pair of values is not set (or set to -1), the default values will be
8035         used.  If this function is called, the user will not be able to size
8036         the virtual area of the window outside the given bounds.
8037         """
8038         return _core_.Window_SetVirtualSizeHints(*args, **kwargs)
8039
8040     def SetVirtualSizeHintsSz(*args, **kwargs):
8041         """
8042         SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)
8043
8044         Allows specification of minimum and maximum virtual window sizes. If a
8045         pair of values is not set (or set to -1), the default values will be
8046         used.  If this function is called, the user will not be able to size
8047         the virtual area of the window outside the given bounds.
8048         """
8049         return _core_.Window_SetVirtualSizeHintsSz(*args, **kwargs)
8050
8051     def GetMaxSize(*args, **kwargs):
8052         """GetMaxSize(self) -> Size"""
8053         return _core_.Window_GetMaxSize(*args, **kwargs)
8054
8055     def GetMinSize(*args, **kwargs):
8056         """GetMinSize(self) -> Size"""
8057         return _core_.Window_GetMinSize(*args, **kwargs)
8058
8059     def SetMinSize(*args, **kwargs):
8060         """
8061         SetMinSize(self, Size minSize)
8062
8063         A more convenient method than `SetSizeHints` for setting just the
8064         min size.
8065         """
8066         return _core_.Window_SetMinSize(*args, **kwargs)
8067
8068     def SetMaxSize(*args, **kwargs):
8069         """
8070         SetMaxSize(self, Size maxSize)
8071
8072         A more convenient method than `SetSizeHints` for setting just the
8073         max size.
8074         """
8075         return _core_.Window_SetMaxSize(*args, **kwargs)
8076
8077     def GetMinWidth(*args, **kwargs):
8078         """GetMinWidth(self) -> int"""
8079         return _core_.Window_GetMinWidth(*args, **kwargs)
8080
8081     def GetMinHeight(*args, **kwargs):
8082         """GetMinHeight(self) -> int"""
8083         return _core_.Window_GetMinHeight(*args, **kwargs)
8084
8085     def GetMaxWidth(*args, **kwargs):
8086         """GetMaxWidth(self) -> int"""
8087         return _core_.Window_GetMaxWidth(*args, **kwargs)
8088
8089     def GetMaxHeight(*args, **kwargs):
8090         """GetMaxHeight(self) -> int"""
8091         return _core_.Window_GetMaxHeight(*args, **kwargs)
8092
8093     def SetVirtualSize(*args, **kwargs):
8094         """
8095         SetVirtualSize(self, Size size)
8096
8097         Set the the virtual size of a window in pixels.  For most windows this
8098         is just the client area of the window, but for some like scrolled
8099         windows it is more or less independent of the screen window size.
8100         """
8101         return _core_.Window_SetVirtualSize(*args, **kwargs)
8102
8103     def SetVirtualSizeWH(*args, **kwargs):
8104         """
8105         SetVirtualSizeWH(self, int w, int h)
8106
8107         Set the the virtual size of a window in pixels.  For most windows this
8108         is just the client area of the window, but for some like scrolled
8109         windows it is more or less independent of the screen window size.
8110         """
8111         return _core_.Window_SetVirtualSizeWH(*args, **kwargs)
8112
8113     def GetVirtualSize(*args, **kwargs):
8114         """
8115         GetVirtualSize(self) -> Size
8116
8117         Get the the virtual size of the window in pixels.  For most windows
8118         this is just the client area of the window, but for some like scrolled
8119         windows it is more or less independent of the screen window size.
8120         """
8121         return _core_.Window_GetVirtualSize(*args, **kwargs)
8122
8123     def GetVirtualSizeTuple(*args, **kwargs):
8124         """
8125         GetVirtualSizeTuple() -> (width, height)
8126
8127         Get the the virtual size of the window in pixels.  For most windows
8128         this is just the client area of the window, but for some like scrolled
8129         windows it is more or less independent of the screen window size.
8130         """
8131         return _core_.Window_GetVirtualSizeTuple(*args, **kwargs)
8132
8133     def GetBestVirtualSize(*args, **kwargs):
8134         """
8135         GetBestVirtualSize(self) -> Size
8136
8137         Return the largest of ClientSize and BestSize (as determined by a
8138         sizer, interior children, or other means)
8139         """
8140         return _core_.Window_GetBestVirtualSize(*args, **kwargs)
8141
8142     def Show(*args, **kwargs):
8143         """
8144         Show(self, bool show=True) -> bool
8145
8146         Shows or hides the window. You may need to call Raise for a top level
8147         window if you want to bring it to top, although this is not needed if
8148         Show is called immediately after the frame creation.  Returns True if
8149         the window has been shown or hidden or False if nothing was done
8150         because it already was in the requested state.
8151         """
8152         return _core_.Window_Show(*args, **kwargs)
8153
8154     def Hide(*args, **kwargs):
8155         """
8156         Hide(self) -> bool
8157
8158         Equivalent to calling Show(False).
8159         """
8160         return _core_.Window_Hide(*args, **kwargs)
8161
8162     def Enable(*args, **kwargs):
8163         """
8164         Enable(self, bool enable=True) -> bool
8165
8166         Enable or disable the window for user input. Note that when a parent
8167         window is disabled, all of its children are disabled as well and they
8168         are reenabled again when the parent is.  Returns true if the window
8169         has been enabled or disabled, false if nothing was done, i.e. if the
8170         window had already been in the specified state.
8171         """
8172         return _core_.Window_Enable(*args, **kwargs)
8173
8174     def Disable(*args, **kwargs):
8175         """
8176         Disable(self) -> bool
8177
8178         Disables the window, same as Enable(false).
8179         """
8180         return _core_.Window_Disable(*args, **kwargs)
8181
8182     def IsShown(*args, **kwargs):
8183         """
8184         IsShown(self) -> bool
8185
8186         Returns true if the window is shown, false if it has been hidden.
8187         """
8188         return _core_.Window_IsShown(*args, **kwargs)
8189
8190     def IsEnabled(*args, **kwargs):
8191         """
8192         IsEnabled(self) -> bool
8193
8194         Returns true if the window is enabled for input, false otherwise.
8195         """
8196         return _core_.Window_IsEnabled(*args, **kwargs)
8197
8198     def SetWindowStyleFlag(*args, **kwargs):
8199         """
8200         SetWindowStyleFlag(self, long style)
8201
8202         Sets the style of the window. Please note that some styles cannot be
8203         changed after the window creation and that Refresh() might need to be
8204         called after changing the others for the change to take place
8205         immediately.
8206         """
8207         return _core_.Window_SetWindowStyleFlag(*args, **kwargs)
8208
8209     def GetWindowStyleFlag(*args, **kwargs):
8210         """
8211         GetWindowStyleFlag(self) -> long
8212
8213         Gets the window style that was passed to the constructor or Create
8214         method.
8215         """
8216         return _core_.Window_GetWindowStyleFlag(*args, **kwargs)
8217
8218     SetWindowStyle = SetWindowStyleFlag; GetWindowStyle = GetWindowStyleFlag
8219     def HasFlag(*args, **kwargs):
8220         """
8221         HasFlag(self, int flag) -> bool
8222
8223         Test if the given style is set for this window.
8224         """
8225         return _core_.Window_HasFlag(*args, **kwargs)
8226
8227     def IsRetained(*args, **kwargs):
8228         """
8229         IsRetained(self) -> bool
8230
8231         Returns true if the window is retained, false otherwise.  Retained
8232         windows are only available on X platforms.
8233         """
8234         return _core_.Window_IsRetained(*args, **kwargs)
8235
8236     def SetExtraStyle(*args, **kwargs):
8237         """
8238         SetExtraStyle(self, long exStyle)
8239
8240         Sets the extra style bits for the window.  Extra styles are the less
8241         often used style bits which can't be set with the constructor or with
8242         SetWindowStyleFlag()
8243         """
8244         return _core_.Window_SetExtraStyle(*args, **kwargs)
8245
8246     def GetExtraStyle(*args, **kwargs):
8247         """
8248         GetExtraStyle(self) -> long
8249
8250         Returns the extra style bits for the window.
8251         """
8252         return _core_.Window_GetExtraStyle(*args, **kwargs)
8253
8254     def MakeModal(*args, **kwargs):
8255         """
8256         MakeModal(self, bool modal=True)
8257
8258         Disables all other windows in the application so that the user can
8259         only interact with this window.  Passing False will reverse this
8260         effect.
8261         """
8262         return _core_.Window_MakeModal(*args, **kwargs)
8263
8264     def SetThemeEnabled(*args, **kwargs):
8265         """
8266         SetThemeEnabled(self, bool enableTheme)
8267
8268         This function tells a window if it should use the system's "theme"
8269          code to draw the windows' background instead if its own background
8270          drawing code. This will only have an effect on platforms that support
8271          the notion of themes in user defined windows. One such platform is
8272          GTK+ where windows can have (very colourful) backgrounds defined by a
8273          user's selected theme.
8274
8275         Dialogs, notebook pages and the status bar have this flag set to true
8276         by default so that the default look and feel is simulated best.
8277         """
8278         return _core_.Window_SetThemeEnabled(*args, **kwargs)
8279
8280     def GetThemeEnabled(*args, **kwargs):
8281         """
8282         GetThemeEnabled(self) -> bool
8283
8284         Return the themeEnabled flag.
8285         """
8286         return _core_.Window_GetThemeEnabled(*args, **kwargs)
8287
8288     def SetFocus(*args, **kwargs):
8289         """
8290         SetFocus(self)
8291
8292         Set's the focus to this window, allowing it to receive keyboard input.
8293         """
8294         return _core_.Window_SetFocus(*args, **kwargs)
8295
8296     def SetFocusFromKbd(*args, **kwargs):
8297         """
8298         SetFocusFromKbd(self)
8299
8300         Set focus to this window as the result of a keyboard action.  Normally
8301         only called internally.
8302         """
8303         return _core_.Window_SetFocusFromKbd(*args, **kwargs)
8304
8305     def FindFocus(*args, **kwargs):
8306         """
8307         FindFocus() -> Window
8308
8309         Returns the window or control that currently has the keyboard focus,
8310         or None.
8311         """
8312         return _core_.Window_FindFocus(*args, **kwargs)
8313
8314     FindFocus = staticmethod(FindFocus)
8315     def AcceptsFocus(*args, **kwargs):
8316         """
8317         AcceptsFocus(self) -> bool
8318
8319         Can this window have focus?
8320         """
8321         return _core_.Window_AcceptsFocus(*args, **kwargs)
8322
8323     def AcceptsFocusFromKeyboard(*args, **kwargs):
8324         """
8325         AcceptsFocusFromKeyboard(self) -> bool
8326
8327         Can this window be given focus by keyboard navigation? if not, the
8328         only way to give it focus (provided it accepts it at all) is to click
8329         it.
8330         """
8331         return _core_.Window_AcceptsFocusFromKeyboard(*args, **kwargs)
8332
8333     def Navigate(*args, **kwargs):
8334         """
8335         Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
8336
8337         Does keyboard navigation from this window to another, by sending a
8338         `wx.NavigationKeyEvent`.
8339         """
8340         return _core_.Window_Navigate(*args, **kwargs)
8341
8342     def MoveAfterInTabOrder(*args, **kwargs):
8343         """
8344         MoveAfterInTabOrder(self, Window win)
8345
8346         Moves this window in the tab navigation order after the specified
8347         sibling window.  This means that when the user presses the TAB key on
8348         that other window, the focus switches to this window.
8349
8350         The default tab order is the same as creation order.  This function
8351         and `MoveBeforeInTabOrder` allow to change it after creating all the
8352         windows.
8353
8354         """
8355         return _core_.Window_MoveAfterInTabOrder(*args, **kwargs)
8356
8357     def MoveBeforeInTabOrder(*args, **kwargs):
8358         """
8359         MoveBeforeInTabOrder(self, Window win)
8360
8361         Same as `MoveAfterInTabOrder` except that it inserts this window just
8362         before win instead of putting it right after it.
8363         """
8364         return _core_.Window_MoveBeforeInTabOrder(*args, **kwargs)
8365
8366     def GetChildren(*args, **kwargs):
8367         """
8368         GetChildren(self) -> PyObject
8369
8370         Returns a list of the window's children.  NOTE: Currently this is a
8371         copy of the child window list maintained by the window, so the return
8372         value of this function is only valid as long as the window's children
8373         do not change.
8374         """
8375         return _core_.Window_GetChildren(*args, **kwargs)
8376
8377     def GetParent(*args, **kwargs):
8378         """
8379         GetParent(self) -> Window
8380
8381         Returns the parent window of this window, or None if there isn't one.
8382         """
8383         return _core_.Window_GetParent(*args, **kwargs)
8384
8385     def GetGrandParent(*args, **kwargs):
8386         """
8387         GetGrandParent(self) -> Window
8388
8389         Returns the parent of the parent of this window, or None if there
8390         isn't one.
8391         """
8392         return _core_.Window_GetGrandParent(*args, **kwargs)
8393
8394     def IsTopLevel(*args, **kwargs):
8395         """
8396         IsTopLevel(self) -> bool
8397
8398         Returns true if the given window is a top-level one. Currently all
8399         frames and dialogs are always considered to be top-level windows (even
8400         if they have a parent window).
8401         """
8402         return _core_.Window_IsTopLevel(*args, **kwargs)
8403
8404     def Reparent(*args, **kwargs):
8405         """
8406         Reparent(self, Window newParent) -> bool
8407
8408         Reparents the window, i.e the window will be removed from its current
8409         parent window (e.g. a non-standard toolbar in a wxFrame) and then
8410         re-inserted into another. Available on Windows and GTK.  Returns True
8411         if the parent was changed, False otherwise (error or newParent ==
8412         oldParent)
8413         """
8414         return _core_.Window_Reparent(*args, **kwargs)
8415
8416     def AddChild(*args, **kwargs):
8417         """
8418         AddChild(self, Window child)
8419
8420         Adds a child window. This is called automatically by window creation
8421         functions so should not be required by the application programmer.
8422         """
8423         return _core_.Window_AddChild(*args, **kwargs)
8424
8425     def RemoveChild(*args, **kwargs):
8426         """
8427         RemoveChild(self, Window child)
8428
8429         Removes a child window. This is called automatically by window
8430         deletion functions so should not be required by the application
8431         programmer.
8432         """
8433         return _core_.Window_RemoveChild(*args, **kwargs)
8434
8435     def SetDoubleBuffered(*args, **kwargs):
8436         """
8437         SetDoubleBuffered(self, bool on)
8438
8439         Currently wxGTK2 only.
8440         """
8441         return _core_.Window_SetDoubleBuffered(*args, **kwargs)
8442
8443     def FindWindowById(*args, **kwargs):
8444         """
8445         FindWindowById(self, long winid) -> Window
8446
8447         Find a chld of this window by window ID
8448         """
8449         return _core_.Window_FindWindowById(*args, **kwargs)
8450
8451     def FindWindowByName(*args, **kwargs):
8452         """
8453         FindWindowByName(self, String name) -> Window
8454
8455         Find a child of this window by name
8456         """
8457         return _core_.Window_FindWindowByName(*args, **kwargs)
8458
8459     def GetEventHandler(*args, **kwargs):
8460         """
8461         GetEventHandler(self) -> EvtHandler
8462
8463         Returns the event handler for this window. By default, the window is
8464         its own event handler.
8465         """
8466         return _core_.Window_GetEventHandler(*args, **kwargs)
8467
8468     def SetEventHandler(*args, **kwargs):
8469         """
8470         SetEventHandler(self, EvtHandler handler)
8471
8472         Sets the event handler for this window.  An event handler is an object
8473         that is capable of processing the events sent to a window. By default,
8474         the window is its own event handler, but an application may wish to
8475         substitute another, for example to allow central implementation of
8476         event-handling for a variety of different window classes.
8477
8478         It is usually better to use `wx.Window.PushEventHandler` since this sets
8479         up a chain of event handlers, where an event not handled by one event
8480         handler is handed to the next one in the chain.
8481         """
8482         return _core_.Window_SetEventHandler(*args, **kwargs)
8483
8484     def PushEventHandler(*args, **kwargs):
8485         """
8486         PushEventHandler(self, EvtHandler handler)
8487
8488         Pushes this event handler onto the event handler stack for the window.
8489         An event handler is an object that is capable of processing the events
8490         sent to a window. By default, the window is its own event handler, but
8491         an application may wish to substitute another, for example to allow
8492         central implementation of event-handling for a variety of different
8493         window classes.
8494
8495         wx.Window.PushEventHandler allows an application to set up a chain of
8496         event handlers, where an event not handled by one event handler is
8497         handed to the next one in the chain. Use `wx.Window.PopEventHandler` to
8498         remove the event handler.
8499         """
8500         return _core_.Window_PushEventHandler(*args, **kwargs)
8501
8502     def PopEventHandler(*args, **kwargs):
8503         """
8504         PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
8505
8506         Removes and returns the top-most event handler on the event handler
8507         stack.  If deleteHandler is True then the wx.EvtHandler object will be
8508         destroyed after it is popped.
8509         """
8510         return _core_.Window_PopEventHandler(*args, **kwargs)
8511
8512     def RemoveEventHandler(*args, **kwargs):
8513         """
8514         RemoveEventHandler(self, EvtHandler handler) -> bool
8515
8516         Find the given handler in the event handler chain and remove (but not
8517         delete) it from the event handler chain, return True if it was found
8518         and False otherwise (this also results in an assert failure so this
8519         function should only be called when the handler is supposed to be
8520         there.)
8521         """
8522         return _core_.Window_RemoveEventHandler(*args, **kwargs)
8523
8524     def SetValidator(*args, **kwargs):
8525         """
8526         SetValidator(self, Validator validator)
8527
8528         Deletes the current validator (if any) and sets the window validator,
8529         having called wx.Validator.Clone to create a new validator of this
8530         type.
8531         """
8532         return _core_.Window_SetValidator(*args, **kwargs)
8533
8534     def GetValidator(*args, **kwargs):
8535         """
8536         GetValidator(self) -> Validator
8537
8538         Returns a pointer to the current validator for the window, or None if
8539         there is none.
8540         """
8541         return _core_.Window_GetValidator(*args, **kwargs)
8542
8543     def Validate(*args, **kwargs):
8544         """
8545         Validate(self) -> bool
8546
8547         Validates the current values of the child controls using their
8548         validators.  If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
8549         style flag set, the method will also call Validate() of all child
8550         windows.  Returns false if any of the validations failed.
8551         """
8552         return _core_.Window_Validate(*args, **kwargs)
8553
8554     def TransferDataToWindow(*args, **kwargs):
8555         """
8556         TransferDataToWindow(self) -> bool
8557
8558         Transfers values to child controls from data areas specified by their
8559         validators.  If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
8560         style flag set, the method will also call TransferDataToWindow() of
8561         all child windows.
8562         """
8563         return _core_.Window_TransferDataToWindow(*args, **kwargs)
8564
8565     def TransferDataFromWindow(*args, **kwargs):
8566         """
8567         TransferDataFromWindow(self) -> bool
8568
8569         Transfers values from child controls to data areas specified by their
8570         validators. Returns false if a transfer failed.  If the window has
8571         wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
8572         also call TransferDataFromWindow() of all child windows.
8573         """
8574         return _core_.Window_TransferDataFromWindow(*args, **kwargs)
8575
8576     def InitDialog(*args, **kwargs):
8577         """
8578         InitDialog(self)
8579
8580         Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
8581         to the dialog via validators.
8582         """
8583         return _core_.Window_InitDialog(*args, **kwargs)
8584
8585     def SetAcceleratorTable(*args, **kwargs):
8586         """
8587         SetAcceleratorTable(self, AcceleratorTable accel)
8588
8589         Sets the accelerator table for this window.
8590         """
8591         return _core_.Window_SetAcceleratorTable(*args, **kwargs)
8592
8593     def GetAcceleratorTable(*args, **kwargs):
8594         """
8595         GetAcceleratorTable(self) -> AcceleratorTable
8596
8597         Gets the accelerator table for this window.
8598         """
8599         return _core_.Window_GetAcceleratorTable(*args, **kwargs)
8600
8601     def RegisterHotKey(*args, **kwargs):
8602         """
8603         RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
8604
8605         Registers a system wide hotkey. Every time the user presses the hotkey
8606         registered here, this window will receive a hotkey event. It will
8607         receive the event even if the application is in the background and
8608         does not have the input focus because the user is working with some
8609         other application.  To bind an event handler function to this hotkey
8610         use EVT_HOTKEY with an id equal to hotkeyId.  Returns True if the
8611         hotkey was registered successfully.
8612         """
8613         return _core_.Window_RegisterHotKey(*args, **kwargs)
8614
8615     def UnregisterHotKey(*args, **kwargs):
8616         """
8617         UnregisterHotKey(self, int hotkeyId) -> bool
8618
8619         Unregisters a system wide hotkey.
8620         """
8621         return _core_.Window_UnregisterHotKey(*args, **kwargs)
8622
8623     def ConvertDialogPointToPixels(*args, **kwargs):
8624         """
8625         ConvertDialogPointToPixels(self, Point pt) -> Point
8626
8627         Converts a point or size from dialog units to pixels.  Dialog units
8628         are used for maintaining a dialog's proportions even if the font
8629         changes. For the x dimension, the dialog units are multiplied by the
8630         average character width and then divided by 4. For the y dimension,
8631         the dialog units are multiplied by the average character height and
8632         then divided by 8.
8633         """
8634         return _core_.Window_ConvertDialogPointToPixels(*args, **kwargs)
8635
8636     def ConvertDialogSizeToPixels(*args, **kwargs):
8637         """
8638         ConvertDialogSizeToPixels(self, Size sz) -> Size
8639
8640         Converts a point or size from dialog units to pixels.  Dialog units
8641         are used for maintaining a dialog's proportions even if the font
8642         changes. For the x dimension, the dialog units are multiplied by the
8643         average character width and then divided by 4. For the y dimension,
8644         the dialog units are multiplied by the average character height and
8645         then divided by 8.
8646         """
8647         return _core_.Window_ConvertDialogSizeToPixels(*args, **kwargs)
8648
8649     def DLG_PNT(*args, **kwargs):
8650         """
8651         DLG_PNT(self, Point pt) -> Point
8652
8653         Converts a point or size from dialog units to pixels.  Dialog units
8654         are used for maintaining a dialog's proportions even if the font
8655         changes. For the x dimension, the dialog units are multiplied by the
8656         average character width and then divided by 4. For the y dimension,
8657         the dialog units are multiplied by the average character height and
8658         then divided by 8.
8659         """
8660         return _core_.Window_DLG_PNT(*args, **kwargs)
8661
8662     def DLG_SZE(*args, **kwargs):
8663         """
8664         DLG_SZE(self, Size sz) -> Size
8665
8666         Converts a point or size from dialog units to pixels.  Dialog units
8667         are used for maintaining a dialog's proportions even if the font
8668         changes. For the x dimension, the dialog units are multiplied by the
8669         average character width and then divided by 4. For the y dimension,
8670         the dialog units are multiplied by the average character height and
8671         then divided by 8.
8672         """
8673         return _core_.Window_DLG_SZE(*args, **kwargs)
8674
8675     def ConvertPixelPointToDialog(*args, **kwargs):
8676         """ConvertPixelPointToDialog(self, Point pt) -> Point"""
8677         return _core_.Window_ConvertPixelPointToDialog(*args, **kwargs)
8678
8679     def ConvertPixelSizeToDialog(*args, **kwargs):
8680         """ConvertPixelSizeToDialog(self, Size sz) -> Size"""
8681         return _core_.Window_ConvertPixelSizeToDialog(*args, **kwargs)
8682
8683     def WarpPointer(*args, **kwargs):
8684         """
8685         WarpPointer(self, int x, int y)
8686
8687         Moves the pointer to the given position on the window.
8688
8689         NOTE: This function is not supported under Mac because Apple Human
8690         Interface Guidelines forbid moving the mouse cursor programmatically.
8691         """
8692         return _core_.Window_WarpPointer(*args, **kwargs)
8693
8694     def CaptureMouse(*args, **kwargs):
8695         """
8696         CaptureMouse(self)
8697
8698         Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
8699         release the capture.
8700
8701         Note that wxWindows maintains the stack of windows having captured the
8702         mouse and when the mouse is released the capture returns to the window
8703         which had had captured it previously and it is only really released if
8704         there were no previous window. In particular, this means that you must
8705         release the mouse as many times as you capture it, unless the window
8706         receives the `wx.MouseCaptureLostEvent` event.
8707
8708         Any application which captures the mouse in the beginning of some
8709         operation *must* handle `wx.MouseCaptureLostEvent` and cancel this
8710         operation when it receives the event. The event handler must not
8711         recapture mouse.
8712         """
8713         return _core_.Window_CaptureMouse(*args, **kwargs)
8714
8715     def ReleaseMouse(*args, **kwargs):
8716         """
8717         ReleaseMouse(self)
8718
8719         Releases mouse input captured with wx.Window.CaptureMouse.
8720         """
8721         return _core_.Window_ReleaseMouse(*args, **kwargs)
8722
8723     def GetCapture(*args, **kwargs):
8724         """
8725         GetCapture() -> Window
8726
8727         Returns the window which currently captures the mouse or None
8728         """
8729         return _core_.Window_GetCapture(*args, **kwargs)
8730
8731     GetCapture = staticmethod(GetCapture)
8732     def HasCapture(*args, **kwargs):
8733         """
8734         HasCapture(self) -> bool
8735
8736         Returns true if this window has the current mouse capture.
8737         """
8738         return _core_.Window_HasCapture(*args, **kwargs)
8739
8740     def Refresh(*args, **kwargs):
8741         """
8742         Refresh(self, bool eraseBackground=True, Rect rect=None)
8743
8744         Mark the specified rectangle (or the whole window) as "dirty" so it
8745         will be repainted.  Causes an EVT_PAINT event to be generated and sent
8746         to the window.
8747         """
8748         return _core_.Window_Refresh(*args, **kwargs)
8749
8750     def RefreshRect(*args, **kwargs):
8751         """
8752         RefreshRect(self, Rect rect, bool eraseBackground=True)
8753
8754         Redraws the contents of the given rectangle: the area inside it will
8755         be repainted.  This is the same as Refresh but has a nicer syntax.
8756         """
8757         return _core_.Window_RefreshRect(*args, **kwargs)
8758
8759     def Update(*args, **kwargs):
8760         """
8761         Update(self)
8762
8763         Calling this method immediately repaints the invalidated area of the
8764         window instead of waiting for the EVT_PAINT event to happen, (normally
8765         this would usually only happen when the flow of control returns to the
8766         event loop.)  Notice that this function doesn't refresh the window and
8767         does nothing if the window has been already repainted.  Use Refresh
8768         first if you want to immediately redraw the window (or some portion of
8769         it) unconditionally.
8770         """
8771         return _core_.Window_Update(*args, **kwargs)
8772
8773     def ClearBackground(*args, **kwargs):
8774         """
8775         ClearBackground(self)
8776
8777         Clears the window by filling it with the current background
8778         colour. Does not cause an erase background event to be generated.
8779         """
8780         return _core_.Window_ClearBackground(*args, **kwargs)
8781
8782     def Freeze(*args, **kwargs):
8783         """
8784         Freeze(self)
8785
8786         Freezes the window or, in other words, prevents any updates from
8787         taking place on screen, the window is not redrawn at all. Thaw must be
8788         called to reenable window redrawing.  Calls to Freeze/Thaw may be
8789         nested, with the actual Thaw being delayed until all the nesting has
8790         been undone.
8791
8792         This method is useful for visual appearance optimization (for example,
8793         it is a good idea to use it before inserting large amount of text into
8794         a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
8795         for all controls so it is mostly just a hint to wxWindows and not a
8796         mandatory directive.
8797         """
8798         return _core_.Window_Freeze(*args, **kwargs)
8799
8800     def Thaw(*args, **kwargs):
8801         """
8802         Thaw(self)
8803
8804         Reenables window updating after a previous call to Freeze.  Calls to
8805         Freeze/Thaw may be nested, so Thaw must be called the same number of
8806         times that Freeze was before the window will be updated.
8807         """
8808         return _core_.Window_Thaw(*args, **kwargs)
8809
8810     def PrepareDC(*args, **kwargs):
8811         """
8812         PrepareDC(self, DC dc)
8813
8814         Call this function to prepare the device context for drawing a
8815         scrolled image. It sets the device origin according to the current
8816         scroll position.
8817         """
8818         return _core_.Window_PrepareDC(*args, **kwargs)
8819
8820     def GetUpdateRegion(*args, **kwargs):
8821         """
8822         GetUpdateRegion(self) -> Region
8823
8824         Returns the region specifying which parts of the window have been
8825         damaged. Should only be called within an EVT_PAINT handler.
8826         """
8827         return _core_.Window_GetUpdateRegion(*args, **kwargs)
8828
8829     def GetUpdateClientRect(*args, **kwargs):
8830         """
8831         GetUpdateClientRect(self) -> Rect
8832
8833         Get the update rectangle region bounding box in client coords.
8834         """
8835         return _core_.Window_GetUpdateClientRect(*args, **kwargs)
8836
8837     def IsExposed(*args, **kwargs):
8838         """
8839         IsExposed(self, int x, int y, int w=1, int h=1) -> bool
8840
8841         Returns true if the given point or rectangle area has been exposed
8842         since the last repaint. Call this in an paint event handler to
8843         optimize redrawing by only redrawing those areas, which have been
8844         exposed.
8845         """
8846         return _core_.Window_IsExposed(*args, **kwargs)
8847
8848     def IsExposedPoint(*args, **kwargs):
8849         """
8850         IsExposedPoint(self, Point pt) -> bool
8851
8852         Returns true if the given point or rectangle area has been exposed
8853         since the last repaint. Call this in an paint event handler to
8854         optimize redrawing by only redrawing those areas, which have been
8855         exposed.
8856         """
8857         return _core_.Window_IsExposedPoint(*args, **kwargs)
8858
8859     def IsExposedRect(*args, **kwargs):
8860         """
8861         IsExposedRect(self, Rect rect) -> bool
8862
8863         Returns true if the given point or rectangle area has been exposed
8864         since the last repaint. Call this in an paint event handler to
8865         optimize redrawing by only redrawing those areas, which have been
8866         exposed.
8867         """
8868         return _core_.Window_IsExposedRect(*args, **kwargs)
8869
8870     def GetDefaultAttributes(*args, **kwargs):
8871         """
8872         GetDefaultAttributes(self) -> VisualAttributes
8873
8874         Get the default attributes for an instance of this class.  This is
8875         useful if you want to use the same font or colour in your own control
8876         as in a standard control -- which is a much better idea than hard
8877         coding specific colours or fonts which might look completely out of
8878         place on the user's system, especially if it uses themes.
8879         """
8880         return _core_.Window_GetDefaultAttributes(*args, **kwargs)
8881
8882     def GetClassDefaultAttributes(*args, **kwargs):
8883         """
8884         GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
8885
8886         Get the default attributes for this class.  This is useful if you want
8887         to use the same font or colour in your own control as in a standard
8888         control -- which is a much better idea than hard coding specific
8889         colours or fonts which might look completely out of place on the
8890         user's system, especially if it uses themes.
8891
8892         The variant parameter is only relevant under Mac currently and is
8893         ignore under other platforms. Under Mac, it will change the size of
8894         the returned font. See `wx.Window.SetWindowVariant` for more about
8895         this.
8896         """
8897         return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
8898
8899     GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
8900     def SetBackgroundColour(*args, **kwargs):
8901         """
8902         SetBackgroundColour(self, Colour colour) -> bool
8903
8904         Sets the background colour of the window.  Returns True if the colour
8905         was changed.  The background colour is usually painted by the default
8906         EVT_ERASE_BACKGROUND event handler function under Windows and
8907         automatically under GTK.  Using `wx.NullColour` will reset the window
8908         to the default background colour.
8909
8910         Note that setting the background colour may not cause an immediate
8911         refresh, so you may wish to call `ClearBackground` or `Refresh` after
8912         calling this function.
8913
8914         Using this function will disable attempts to use themes for this
8915         window, if the system supports them.  Use with care since usually the
8916         themes represent the appearance chosen by the user to be used for all
8917         applications on the system.
8918         """
8919         return _core_.Window_SetBackgroundColour(*args, **kwargs)
8920
8921     def SetOwnBackgroundColour(*args, **kwargs):
8922         """SetOwnBackgroundColour(self, Colour colour)"""
8923         return _core_.Window_SetOwnBackgroundColour(*args, **kwargs)
8924
8925     def SetForegroundColour(*args, **kwargs):
8926         """
8927         SetForegroundColour(self, Colour colour) -> bool
8928
8929         Sets the foreground colour of the window.  Returns True is the colour
8930         was changed.  The interpretation of foreground colour is dependent on
8931         the window class; it may be the text colour or other colour, or it may
8932         not be used at all.
8933         """
8934         return _core_.Window_SetForegroundColour(*args, **kwargs)
8935
8936     def SetOwnForegroundColour(*args, **kwargs):
8937         """SetOwnForegroundColour(self, Colour colour)"""
8938         return _core_.Window_SetOwnForegroundColour(*args, **kwargs)
8939
8940     def GetBackgroundColour(*args, **kwargs):
8941         """
8942         GetBackgroundColour(self) -> Colour
8943
8944         Returns the background colour of the window.
8945         """
8946         return _core_.Window_GetBackgroundColour(*args, **kwargs)
8947
8948     def GetForegroundColour(*args, **kwargs):
8949         """
8950         GetForegroundColour(self) -> Colour
8951
8952         Returns the foreground colour of the window.  The interpretation of
8953         foreground colour is dependent on the window class; it may be the text
8954         colour or other colour, or it may not be used at all.
8955         """
8956         return _core_.Window_GetForegroundColour(*args, **kwargs)
8957
8958     def InheritsBackgroundColour(*args, **kwargs):
8959         """InheritsBackgroundColour(self) -> bool"""
8960         return _core_.Window_InheritsBackgroundColour(*args, **kwargs)
8961
8962     def UseBgCol(*args, **kwargs):
8963         """UseBgCol(self) -> bool"""
8964         return _core_.Window_UseBgCol(*args, **kwargs)
8965
8966     def SetBackgroundStyle(*args, **kwargs):
8967         """
8968         SetBackgroundStyle(self, int style) -> bool
8969
8970         Returns the background style of the window. The background style
8971         indicates how the background of the window is drawn.
8972
8973             ======================  ========================================
8974             wx.BG_STYLE_SYSTEM      The background colour or pattern should
8975                                     be determined by the system
8976             wx.BG_STYLE_COLOUR      The background should be a solid colour
8977             wx.BG_STYLE_CUSTOM      The background will be implemented by the
8978                                     application.
8979             ======================  ========================================
8980
8981         On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
8982         a custom background, such as a tiled bitmap. Currently the style has
8983         no effect on other platforms.
8984
8985         :see: `GetBackgroundStyle`, `SetBackgroundColour`
8986         """
8987         return _core_.Window_SetBackgroundStyle(*args, **kwargs)
8988
8989     def GetBackgroundStyle(*args, **kwargs):
8990         """
8991         GetBackgroundStyle(self) -> int
8992
8993         Returns the background style of the window.
8994
8995         :see: `SetBackgroundStyle`
8996         """
8997         return _core_.Window_GetBackgroundStyle(*args, **kwargs)
8998
8999     def HasTransparentBackground(*args, **kwargs):
9000         """
9001         HasTransparentBackground(self) -> bool
9002
9003         Returns True if this window's background is transparent (as, for
9004         example, for `wx.StaticText`) and should show the parent window's
9005         background.
9006
9007         This method is mostly used internally by the library itself and you
9008         normally shouldn't have to call it. You may, however, have to override
9009         it in your custom control classes to ensure that background is painted
9010         correctly.
9011         """
9012         return _core_.Window_HasTransparentBackground(*args, **kwargs)
9013
9014     def SetCursor(*args, **kwargs):
9015         """
9016         SetCursor(self, Cursor cursor) -> bool
9017
9018         Sets the window's cursor. Notice that the window cursor also sets it
9019         for the children of the window implicitly.
9020
9021         The cursor may be wx.NullCursor in which case the window cursor will
9022         be reset back to default.
9023         """
9024         return _core_.Window_SetCursor(*args, **kwargs)
9025
9026     def GetCursor(*args, **kwargs):
9027         """
9028         GetCursor(self) -> Cursor
9029
9030         Return the cursor associated with this window.
9031         """
9032         return _core_.Window_GetCursor(*args, **kwargs)
9033
9034     def SetFont(*args, **kwargs):
9035         """
9036         SetFont(self, Font font) -> bool
9037
9038         Sets the font for this window.
9039         """
9040         return _core_.Window_SetFont(*args, **kwargs)
9041
9042     def SetOwnFont(*args, **kwargs):
9043         """SetOwnFont(self, Font font)"""
9044         return _core_.Window_SetOwnFont(*args, **kwargs)
9045
9046     def GetFont(*args, **kwargs):
9047         """
9048         GetFont(self) -> Font
9049
9050         Returns the default font used for this window.
9051         """
9052         return _core_.Window_GetFont(*args, **kwargs)
9053
9054     def SetCaret(*args, **kwargs):
9055         """
9056         SetCaret(self, Caret caret)
9057
9058         Sets the caret associated with the window.
9059         """
9060         return _core_.Window_SetCaret(*args, **kwargs)
9061
9062     def GetCaret(*args, **kwargs):
9063         """
9064         GetCaret(self) -> Caret
9065
9066         Returns the caret associated with the window.
9067         """
9068         return _core_.Window_GetCaret(*args, **kwargs)
9069
9070     def GetCharHeight(*args, **kwargs):
9071         """
9072         GetCharHeight(self) -> int
9073
9074         Get the (average) character size for the current font.
9075         """
9076         return _core_.Window_GetCharHeight(*args, **kwargs)
9077
9078     def GetCharWidth(*args, **kwargs):
9079         """
9080         GetCharWidth(self) -> int
9081
9082         Get the (average) character size for the current font.
9083         """
9084         return _core_.Window_GetCharWidth(*args, **kwargs)
9085
9086     def GetTextExtent(*args, **kwargs):
9087         """
9088         GetTextExtent(String string) -> (width, height)
9089
9090         Get the width and height of the text using the current font.
9091         """
9092         return _core_.Window_GetTextExtent(*args, **kwargs)
9093
9094     def GetFullTextExtent(*args, **kwargs):
9095         """
9096         GetFullTextExtent(String string, Font font=None) ->
9097            (width, height, descent, externalLeading)
9098
9099         Get the width, height, decent and leading of the text using the
9100         current or specified font.
9101         """
9102         return _core_.Window_GetFullTextExtent(*args, **kwargs)
9103
9104     def ClientToScreenXY(*args, **kwargs):
9105         """
9106         ClientToScreenXY(int x, int y) -> (x,y)
9107
9108         Converts to screen coordinates from coordinates relative to this window.
9109         """
9110         return _core_.Window_ClientToScreenXY(*args, **kwargs)
9111
9112     def ScreenToClientXY(*args, **kwargs):
9113         """
9114         ScreenToClientXY(int x, int y) -> (x,y)
9115
9116         Converts from screen to client window coordinates.
9117         """
9118         return _core_.Window_ScreenToClientXY(*args, **kwargs)
9119
9120     def ClientToScreen(*args, **kwargs):
9121         """
9122         ClientToScreen(self, Point pt) -> Point
9123
9124         Converts to screen coordinates from coordinates relative to this window.
9125         """
9126         return _core_.Window_ClientToScreen(*args, **kwargs)
9127
9128     def ScreenToClient(*args, **kwargs):
9129         """
9130         ScreenToClient(self, Point pt) -> Point
9131
9132         Converts from screen to client window coordinates.
9133         """
9134         return _core_.Window_ScreenToClient(*args, **kwargs)
9135
9136     def HitTestXY(*args, **kwargs):
9137         """
9138         HitTestXY(self, int x, int y) -> int
9139
9140         Test where the given (in client coords) point lies
9141         """
9142         return _core_.Window_HitTestXY(*args, **kwargs)
9143
9144     def HitTest(*args, **kwargs):
9145         """
9146         HitTest(self, Point pt) -> int
9147
9148         Test where the given (in client coords) point lies
9149         """
9150         return _core_.Window_HitTest(*args, **kwargs)
9151
9152     def GetBorder(*args):
9153         """
9154         GetBorder(self, long flags) -> int
9155         GetBorder(self) -> int
9156
9157         Get border for the flags of this window
9158         """
9159         return _core_.Window_GetBorder(*args)
9160
9161     def UpdateWindowUI(*args, **kwargs):
9162         """
9163         UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
9164
9165         This function sends EVT_UPDATE_UI events to the window. The particular
9166         implementation depends on the window; for example a wx.ToolBar will
9167         send an update UI event for each toolbar button, and a wx.Frame will
9168         send an update UI event for each menubar menu item. You can call this
9169         function from your application to ensure that your UI is up-to-date at
9170         a particular point in time (as far as your EVT_UPDATE_UI handlers are
9171         concerned). This may be necessary if you have called
9172         `wx.UpdateUIEvent.SetMode` or `wx.UpdateUIEvent.SetUpdateInterval` to
9173         limit the overhead that wxWindows incurs by sending update UI events
9174         in idle time.
9175         """
9176         return _core_.Window_UpdateWindowUI(*args, **kwargs)
9177
9178     def PopupMenuXY(*args, **kwargs):
9179         """
9180         PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
9181
9182         Pops up the given menu at the specified coordinates, relative to this window,
9183         and returns control when the user has dismissed the menu. If a menu item is
9184         selected, the corresponding menu event is generated and will be processed as
9185         usual.  If the default position is given then the current position of the
9186         mouse cursor will be used.
9187         """
9188         return _core_.Window_PopupMenuXY(*args, **kwargs)
9189
9190     def PopupMenu(*args, **kwargs):
9191         """
9192         PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
9193
9194         Pops up the given menu at the specified coordinates, relative to this window,
9195         and returns control when the user has dismissed the menu. If a menu item is
9196         selected, the corresponding menu event is generated and will be processed as
9197         usual.  If the default position is given then the current position of the
9198         mouse cursor will be used.
9199         """
9200         return _core_.Window_PopupMenu(*args, **kwargs)
9201
9202     def HasMultiplePages(*args, **kwargs):
9203         """HasMultiplePages(self) -> bool"""
9204         return _core_.Window_HasMultiplePages(*args, **kwargs)
9205
9206     def GetHandle(*args, **kwargs):
9207         """
9208         GetHandle(self) -> long
9209
9210         Returns the platform-specific handle (as a long integer) of the
9211         physical window.  Currently on wxMac it returns the handle of the
9212         toplevel parent of the window.
9213         """
9214         return _core_.Window_GetHandle(*args, **kwargs)
9215
9216     def AssociateHandle(*args, **kwargs):
9217         """
9218         AssociateHandle(self, long handle)
9219
9220         Associate the window with a new native handle
9221         """
9222         return _core_.Window_AssociateHandle(*args, **kwargs)
9223
9224     def DissociateHandle(*args, **kwargs):
9225         """
9226         DissociateHandle(self)
9227
9228         Dissociate the current native handle from the window
9229         """
9230         return _core_.Window_DissociateHandle(*args, **kwargs)
9231
9232     def OnPaint(*args, **kwargs):
9233         """OnPaint(self, PaintEvent event)"""
9234         return _core_.Window_OnPaint(*args, **kwargs)
9235
9236     def HasScrollbar(*args, **kwargs):
9237         """
9238         HasScrollbar(self, int orient) -> bool
9239
9240         Does the window have the scrollbar for this orientation?
9241         """
9242         return _core_.Window_HasScrollbar(*args, **kwargs)
9243
9244     def SetScrollbar(*args, **kwargs):
9245         """
9246         SetScrollbar(self, int orientation, int position, int thumbSize, int range,
9247             bool refresh=True)
9248
9249         Sets the scrollbar properties of a built-in scrollbar.
9250         """
9251         return _core_.Window_SetScrollbar(*args, **kwargs)
9252
9253     def SetScrollPos(*args, **kwargs):
9254         """
9255         SetScrollPos(self, int orientation, int pos, bool refresh=True)
9256
9257         Sets the position of one of the built-in scrollbars.
9258         """
9259         return _core_.Window_SetScrollPos(*args, **kwargs)
9260
9261     def GetScrollPos(*args, **kwargs):
9262         """
9263         GetScrollPos(self, int orientation) -> int
9264
9265         Returns the built-in scrollbar position.
9266         """
9267         return _core_.Window_GetScrollPos(*args, **kwargs)
9268
9269     def GetScrollThumb(*args, **kwargs):
9270         """
9271         GetScrollThumb(self, int orientation) -> int
9272
9273         Returns the built-in scrollbar thumb size.
9274         """
9275         return _core_.Window_GetScrollThumb(*args, **kwargs)
9276
9277     def GetScrollRange(*args, **kwargs):
9278         """
9279         GetScrollRange(self, int orientation) -> int
9280
9281         Returns the built-in scrollbar range.
9282         """
9283         return _core_.Window_GetScrollRange(*args, **kwargs)
9284
9285     def ScrollWindow(*args, **kwargs):
9286         """
9287         ScrollWindow(self, int dx, int dy, Rect rect=None)
9288
9289         Physically scrolls the pixels in the window and move child windows
9290         accordingly.  Use this function to optimise your scrolling
9291         implementations, to minimise the area that must be redrawn. Note that
9292         it is rarely required to call this function from a user program.
9293         """
9294         return _core_.Window_ScrollWindow(*args, **kwargs)
9295
9296     def ScrollLines(*args, **kwargs):
9297         """
9298         ScrollLines(self, int lines) -> bool
9299
9300         If the platform and window class supports it, scrolls the window by
9301         the given number of lines down, if lines is positive, or up if lines
9302         is negative.  Returns True if the window was scrolled, False if it was
9303         already on top/bottom and nothing was done.
9304         """
9305         return _core_.Window_ScrollLines(*args, **kwargs)
9306
9307     def ScrollPages(*args, **kwargs):
9308         """
9309         ScrollPages(self, int pages) -> bool
9310
9311         If the platform and window class supports it, scrolls the window by
9312         the given number of pages down, if pages is positive, or up if pages
9313         is negative.  Returns True if the window was scrolled, False if it was
9314         already on top/bottom and nothing was done.
9315         """
9316         return _core_.Window_ScrollPages(*args, **kwargs)
9317
9318     def LineUp(*args, **kwargs):
9319         """
9320         LineUp(self) -> bool
9321
9322         This is just a wrapper for ScrollLines(-1).
9323         """
9324         return _core_.Window_LineUp(*args, **kwargs)
9325
9326     def LineDown(*args, **kwargs):
9327         """
9328         LineDown(self) -> bool
9329
9330         This is just a wrapper for ScrollLines(1).
9331         """
9332         return _core_.Window_LineDown(*args, **kwargs)
9333
9334     def PageUp(*args, **kwargs):
9335         """
9336         PageUp(self) -> bool
9337
9338         This is just a wrapper for ScrollPages(-1).
9339         """
9340         return _core_.Window_PageUp(*args, **kwargs)
9341
9342     def PageDown(*args, **kwargs):
9343         """
9344         PageDown(self) -> bool
9345
9346         This is just a wrapper for ScrollPages(1).
9347         """
9348         return _core_.Window_PageDown(*args, **kwargs)
9349
9350     def SetHelpText(*args, **kwargs):
9351         """
9352         SetHelpText(self, String text)
9353
9354         Sets the help text to be used as context-sensitive help for this
9355         window.  Note that the text is actually stored by the current
9356         `wx.HelpProvider` implementation, and not in the window object itself.
9357         """
9358         return _core_.Window_SetHelpText(*args, **kwargs)
9359
9360     def SetHelpTextForId(*args, **kwargs):
9361         """
9362         SetHelpTextForId(self, String text)
9363
9364         Associate this help text with all windows with the same id as this
9365         one.
9366         """
9367         return _core_.Window_SetHelpTextForId(*args, **kwargs)
9368
9369     def GetHelpTextAtPoint(*args, **kwargs):
9370         """
9371         GetHelpTextAtPoint(self, Point pt, wxHelpEvent::Origin origin) -> String
9372
9373         Get the help string associated with the given position in this window.
9374
9375         Notice that pt may be invalid if event origin is keyboard or unknown
9376         and this method should return the global window help text then
9377
9378         """
9379         return _core_.Window_GetHelpTextAtPoint(*args, **kwargs)
9380
9381     def GetHelpText(*args, **kwargs):
9382         """
9383         GetHelpText(self) -> String
9384
9385         Gets the help text to be used as context-sensitive help for this
9386         window.  Note that the text is actually stored by the current
9387         `wx.HelpProvider` implementation, and not in the window object itself.
9388         """
9389         return _core_.Window_GetHelpText(*args, **kwargs)
9390
9391     def SetToolTipString(*args, **kwargs):
9392         """
9393         SetToolTipString(self, String tip)
9394
9395         Attach a tooltip to the window.
9396         """
9397         return _core_.Window_SetToolTipString(*args, **kwargs)
9398
9399     def SetToolTip(*args, **kwargs):
9400         """
9401         SetToolTip(self, ToolTip tip)
9402
9403         Attach a tooltip to the window.
9404         """
9405         return _core_.Window_SetToolTip(*args, **kwargs)
9406
9407     def GetToolTip(*args, **kwargs):
9408         """
9409         GetToolTip(self) -> ToolTip
9410
9411         get the associated tooltip or None if none
9412         """
9413         return _core_.Window_GetToolTip(*args, **kwargs)
9414
9415     def SetDropTarget(*args, **kwargs):
9416         """
9417         SetDropTarget(self, DropTarget dropTarget)
9418
9419         Associates a drop target with this window.  If the window already has
9420         a drop target, it is deleted.
9421         """
9422         return _core_.Window_SetDropTarget(*args, **kwargs)
9423
9424     def GetDropTarget(*args, **kwargs):
9425         """
9426         GetDropTarget(self) -> DropTarget
9427
9428         Returns the associated drop target, which may be None.
9429         """
9430         return _core_.Window_GetDropTarget(*args, **kwargs)
9431
9432     def DragAcceptFiles(*args, **kwargs):
9433         """
9434         DragAcceptFiles(self, bool accept)
9435
9436         Enables or disables eligibility for drop file events, EVT_DROP_FILES.
9437         Only functional on Windows.
9438         """
9439         return _core_.Window_DragAcceptFiles(*args, **kwargs)
9440
9441     def SetConstraints(*args, **kwargs):
9442         """
9443         SetConstraints(self, LayoutConstraints constraints)
9444
9445         Sets the window to have the given layout constraints. If an existing
9446         layout constraints object is already owned by the window, it will be
9447         deleted.  Pass None to disassociate and delete the window's current
9448         constraints.
9449
9450         You must call SetAutoLayout to tell a window to use the constraints
9451         automatically in its default EVT_SIZE handler; otherwise, you must
9452         handle EVT_SIZE yourself and call Layout() explicitly. When setting
9453         both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
9454         effect.
9455         """
9456         return _core_.Window_SetConstraints(*args, **kwargs)
9457
9458     def GetConstraints(*args, **kwargs):
9459         """
9460         GetConstraints(self) -> LayoutConstraints
9461
9462         Returns a pointer to the window's layout constraints, or None if there
9463         are none.
9464         """
9465         return _core_.Window_GetConstraints(*args, **kwargs)
9466
9467     def SetAutoLayout(*args, **kwargs):
9468         """
9469         SetAutoLayout(self, bool autoLayout)
9470
9471         Determines whether the Layout function will be called automatically
9472         when the window is resized.  lease note that this only happens for the
9473         windows usually used to contain children, namely `wx.Panel` and
9474         `wx.TopLevelWindow` (and the classes deriving from them).
9475
9476         This method is called implicitly by `SetSizer` but if you use
9477         `SetConstraints` you should call it manually or otherwise the window
9478         layout won't be correctly updated when its size changes.
9479         """
9480         return _core_.Window_SetAutoLayout(*args, **kwargs)
9481
9482     def GetAutoLayout(*args, **kwargs):
9483         """
9484         GetAutoLayout(self) -> bool
9485
9486         Returns the current autoLayout setting
9487         """
9488         return _core_.Window_GetAutoLayout(*args, **kwargs)
9489
9490     def Layout(*args, **kwargs):
9491         """
9492         Layout(self) -> bool
9493
9494         Invokes the constraint-based layout algorithm or the sizer-based
9495         algorithm for this window.  See SetAutoLayout: when auto layout is on,
9496         this function gets called automatically by the default EVT_SIZE
9497         handler when the window is resized.
9498         """
9499         return _core_.Window_Layout(*args, **kwargs)
9500
9501     def SetSizer(*args, **kwargs):
9502         """
9503         SetSizer(self, Sizer sizer, bool deleteOld=True)
9504
9505         Sets the window to have the given layout sizer. The window will then
9506         own the object, and will take care of its deletion. If an existing
9507         layout sizer object is already owned by the window, it will be deleted
9508         if the deleteOld parameter is true. Note that this function will also
9509         call SetAutoLayout implicitly with a True parameter if the sizer is
9510         non-None, and False otherwise.
9511         """
9512         return _core_.Window_SetSizer(*args, **kwargs)
9513
9514     def SetSizerAndFit(*args, **kwargs):
9515         """
9516         SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
9517
9518         The same as SetSizer, except it also sets the size hints for the
9519         window based on the sizer's minimum size.
9520         """
9521         return _core_.Window_SetSizerAndFit(*args, **kwargs)
9522
9523     def GetSizer(*args, **kwargs):
9524         """
9525         GetSizer(self) -> Sizer
9526
9527         Return the sizer associated with the window by a previous call to
9528         SetSizer or None if there isn't one.
9529         """
9530         return _core_.Window_GetSizer(*args, **kwargs)
9531
9532     def SetContainingSizer(*args, **kwargs):
9533         """
9534         SetContainingSizer(self, Sizer sizer)
9535
9536         This normally does not need to be called by application code. It is
9537         called internally when a window is added to a sizer, and is used so
9538         the window can remove itself from the sizer when it is destroyed.
9539         """
9540         return _core_.Window_SetContainingSizer(*args, **kwargs)
9541
9542     def GetContainingSizer(*args, **kwargs):
9543         """
9544         GetContainingSizer(self) -> Sizer
9545
9546         Return the sizer that this window is a member of, if any, otherwise None.
9547         """
9548         return _core_.Window_GetContainingSizer(*args, **kwargs)
9549
9550     def InheritAttributes(*args, **kwargs):
9551         """
9552         InheritAttributes(self)
9553
9554         This function is (or should be, in case of custom controls) called
9555         during window creation to intelligently set up the window visual
9556         attributes, that is the font and the foreground and background
9557         colours.
9558
9559         By 'intelligently' the following is meant: by default, all windows use
9560         their own default attributes. However if some of the parent's
9561         attributes are explicitly changed (that is, using SetFont and not
9562         SetOwnFont) and if the corresponding attribute hadn't been
9563         explicitly set for this window itself, then this window takes the same
9564         value as used by the parent. In addition, if the window overrides
9565         ShouldInheritColours to return false, the colours will not be changed
9566         no matter what and only the font might.
9567
9568         This rather complicated logic is necessary in order to accommodate the
9569         different usage scenarios. The most common one is when all default
9570         attributes are used and in this case, nothing should be inherited as
9571         in modern GUIs different controls use different fonts (and colours)
9572         than their siblings so they can't inherit the same value from the
9573         parent. However it was also deemed desirable to allow to simply change
9574         the attributes of all children at once by just changing the font or
9575         colour of their common parent, hence in this case we do inherit the
9576         parents attributes.
9577
9578         """
9579         return _core_.Window_InheritAttributes(*args, **kwargs)
9580
9581     def ShouldInheritColours(*args, **kwargs):
9582         """
9583         ShouldInheritColours(self) -> bool
9584
9585         Return true from here to allow the colours of this window to be
9586         changed by InheritAttributes, returning false forbids inheriting them
9587         from the parent window.
9588
9589         The base class version returns false, but this method is overridden in
9590         wxControl where it returns true.
9591         """
9592         return _core_.Window_ShouldInheritColours(*args, **kwargs)
9593
9594     def PostCreate(self, pre):
9595         """
9596         Phase 3 of the 2-phase create <wink!>
9597         Call this method after precreating the window with the 2-phase create method.
9598         """
9599         self.this = pre.this
9600         self.thisown = pre.thisown
9601         pre.thisown = 0
9602         if hasattr(self, '_setOORInfo'):
9603             self._setOORInfo(self)
9604         if hasattr(self, '_setCallbackInfo'):
9605             self._setCallbackInfo(self, self.__class__)
9606
9607     def SendSizeEvent(self):
9608         self.GetEventHandler().ProcessEvent(wx.SizeEvent((-1,-1)))
9609
9610 _core_.Window_swigregister(Window)
9611
9612 def PreWindow(*args, **kwargs):
9613     """
9614     PreWindow() -> Window
9615
9616     Precreate a Window for 2-phase creation.
9617     """
9618     val = _core_.new_PreWindow(*args, **kwargs)
9619     return val
9620
9621 def Window_NewControlId(*args):
9622   """
9623     Window_NewControlId() -> int
9624
9625     Generate a control id for the controls which were not given one.
9626     """
9627   return _core_.Window_NewControlId(*args)
9628
9629 def Window_NextControlId(*args, **kwargs):
9630   """
9631     Window_NextControlId(int winid) -> int
9632
9633     Get the id of the control following the one with the given
9634     autogenerated) id
9635     """
9636   return _core_.Window_NextControlId(*args, **kwargs)
9637
9638 def Window_PrevControlId(*args, **kwargs):
9639   """
9640     Window_PrevControlId(int winid) -> int
9641
9642     Get the id of the control preceding the one with the given
9643     autogenerated) id
9644     """
9645   return _core_.Window_PrevControlId(*args, **kwargs)
9646
9647 def Window_FindFocus(*args):
9648   """
9649     Window_FindFocus() -> Window
9650
9651     Returns the window or control that currently has the keyboard focus,
9652     or None.
9653     """
9654   return _core_.Window_FindFocus(*args)
9655
9656 def Window_GetCapture(*args):
9657   """
9658     Window_GetCapture() -> Window
9659
9660     Returns the window which currently captures the mouse or None
9661     """
9662   return _core_.Window_GetCapture(*args)
9663
9664 def Window_GetClassDefaultAttributes(*args, **kwargs):
9665   """
9666     Window_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
9667
9668     Get the default attributes for this class.  This is useful if you want
9669     to use the same font or colour in your own control as in a standard
9670     control -- which is a much better idea than hard coding specific
9671     colours or fonts which might look completely out of place on the
9672     user's system, especially if it uses themes.
9673
9674     The variant parameter is only relevant under Mac currently and is
9675     ignore under other platforms. Under Mac, it will change the size of
9676     the returned font. See `wx.Window.SetWindowVariant` for more about
9677     this.
9678     """
9679   return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
9680
9681 def DLG_PNT(win, point_or_x, y=None):
9682     """
9683     Convenience function for converting a Point or (x,y) in
9684     dialog units to pixel units.
9685     """
9686     if y is None:
9687         return win.ConvertDialogPointToPixels(point_or_x)
9688     else:
9689         return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y))
9690
9691 def DLG_SZE(win, size_width, height=None):
9692     """
9693     Convenience function for converting a Size or (w,h) in
9694     dialog units to pixel units.
9695     """
9696     if height is None:
9697         return win.ConvertDialogSizeToPixels(size_width)
9698     else:
9699         return win.ConvertDialogSizeToPixels(wx.Size(size_width, height))
9700
9701
9702 def FindWindowById(*args, **kwargs):
9703   """
9704     FindWindowById(long id, Window parent=None) -> Window
9705
9706     Find the first window in the application with the given id. If parent
9707     is None, the search will start from all top-level frames and dialog
9708     boxes; if non-None, the search will be limited to the given window
9709     hierarchy. The search is recursive in both cases.
9710     """
9711   return _core_.FindWindowById(*args, **kwargs)
9712
9713 def FindWindowByName(*args, **kwargs):
9714   """
9715     FindWindowByName(String name, Window parent=None) -> Window
9716
9717     Find a window by its name (as given in a window constructor or Create
9718     function call). If parent is None, the search will start from all
9719     top-level frames and dialog boxes; if non-None, the search will be
9720     limited to the given window hierarchy. The search is recursive in both
9721     cases.
9722
9723     If no window with such name is found, wx.FindWindowByLabel is called.
9724     """
9725   return _core_.FindWindowByName(*args, **kwargs)
9726
9727 def FindWindowByLabel(*args, **kwargs):
9728   """
9729     FindWindowByLabel(String label, Window parent=None) -> Window
9730
9731     Find a window by its label. Depending on the type of window, the label
9732     may be a window title or panel item label. If parent is None, the
9733     search will start from all top-level frames and dialog boxes; if
9734     non-None, the search will be limited to the given window
9735     hierarchy. The search is recursive in both cases.
9736     """
9737   return _core_.FindWindowByLabel(*args, **kwargs)
9738
9739 def Window_FromHWND(*args, **kwargs):
9740   """Window_FromHWND(Window parent, unsigned long _hWnd) -> Window"""
9741   return _core_.Window_FromHWND(*args, **kwargs)
9742
9743 def GetTopLevelWindows(*args):
9744   """
9745     GetTopLevelWindows() -> PyObject
9746
9747     Returns a list of the the application's top-level windows, (frames,
9748     dialogs, etc.)  NOTE: Currently this is a copy of the list maintained
9749     by wxWidgets, and so it is only valid as long as no top-level windows
9750     are closed or new top-level windows are created.
9751
9752     """
9753   return _core_.GetTopLevelWindows(*args)
9754 #---------------------------------------------------------------------------
9755
9756 class Validator(EvtHandler):
9757     """Proxy of C++ Validator class"""
9758     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
9759     __repr__ = _swig_repr
9760     def __init__(self, *args, **kwargs):
9761         """__init__(self) -> Validator"""
9762         _core_.Validator_swiginit(self,_core_.new_Validator(*args, **kwargs))
9763         self._setOORInfo(self)
9764
9765     def Clone(*args, **kwargs):
9766         """Clone(self) -> Validator"""
9767         return _core_.Validator_Clone(*args, **kwargs)
9768
9769     def Validate(*args, **kwargs):
9770         """Validate(self, Window parent) -> bool"""
9771         return _core_.Validator_Validate(*args, **kwargs)
9772
9773     def TransferToWindow(*args, **kwargs):
9774         """TransferToWindow(self) -> bool"""
9775         return _core_.Validator_TransferToWindow(*args, **kwargs)
9776
9777     def TransferFromWindow(*args, **kwargs):
9778         """TransferFromWindow(self) -> bool"""
9779         return _core_.Validator_TransferFromWindow(*args, **kwargs)
9780
9781     def GetWindow(*args, **kwargs):
9782         """GetWindow(self) -> Window"""
9783         return _core_.Validator_GetWindow(*args, **kwargs)
9784
9785     def SetWindow(*args, **kwargs):
9786         """SetWindow(self, Window window)"""
9787         return _core_.Validator_SetWindow(*args, **kwargs)
9788
9789     def IsSilent(*args, **kwargs):
9790         """IsSilent() -> bool"""
9791         return _core_.Validator_IsSilent(*args, **kwargs)
9792
9793     IsSilent = staticmethod(IsSilent)
9794     def SetBellOnError(*args, **kwargs):
9795         """SetBellOnError(int doIt=True)"""
9796         return _core_.Validator_SetBellOnError(*args, **kwargs)
9797
9798     SetBellOnError = staticmethod(SetBellOnError)
9799 _core_.Validator_swigregister(Validator)
9800
9801 def Validator_IsSilent(*args):
9802   """Validator_IsSilent() -> bool"""
9803   return _core_.Validator_IsSilent(*args)
9804
9805 def Validator_SetBellOnError(*args, **kwargs):
9806   """Validator_SetBellOnError(int doIt=True)"""
9807   return _core_.Validator_SetBellOnError(*args, **kwargs)
9808
9809 class PyValidator(Validator):
9810     """Proxy of C++ PyValidator class"""
9811     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
9812     __repr__ = _swig_repr
9813     def __init__(self, *args, **kwargs):
9814         """__init__(self) -> PyValidator"""
9815         _core_.PyValidator_swiginit(self,_core_.new_PyValidator(*args, **kwargs))
9816
9817         self._setCallbackInfo(self, PyValidator, 1)
9818         self._setOORInfo(self)
9819
9820     def _setCallbackInfo(*args, **kwargs):
9821         """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=True)"""
9822         return _core_.PyValidator__setCallbackInfo(*args, **kwargs)
9823
9824 _core_.PyValidator_swigregister(PyValidator)
9825
9826 #---------------------------------------------------------------------------
9827
9828 class Menu(EvtHandler):
9829     """Proxy of C++ Menu class"""
9830     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
9831     __repr__ = _swig_repr
9832     def __init__(self, *args, **kwargs):
9833         """__init__(self, String title=EmptyString, long style=0) -> Menu"""
9834         _core_.Menu_swiginit(self,_core_.new_Menu(*args, **kwargs))
9835         self._setOORInfo(self)
9836
9837     def Append(*args, **kwargs):
9838         """Append(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem"""
9839         return _core_.Menu_Append(*args, **kwargs)
9840
9841     def AppendSeparator(*args, **kwargs):
9842         """AppendSeparator(self) -> MenuItem"""
9843         return _core_.Menu_AppendSeparator(*args, **kwargs)
9844
9845     def AppendCheckItem(*args, **kwargs):
9846         """AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
9847         return _core_.Menu_AppendCheckItem(*args, **kwargs)
9848
9849     def AppendRadioItem(*args, **kwargs):
9850         """AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
9851         return _core_.Menu_AppendRadioItem(*args, **kwargs)
9852
9853     def AppendMenu(*args, **kwargs):
9854         """AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
9855         return _core_.Menu_AppendMenu(*args, **kwargs)
9856
9857     def AppendSubMenu(*args, **kwargs):
9858         """AppendSubMenu(self, Menu submenu, String text, String help=EmptyString) -> MenuItem"""
9859         return _core_.Menu_AppendSubMenu(*args, **kwargs)
9860
9861     def AppendItem(*args, **kwargs):
9862         """AppendItem(self, MenuItem item) -> MenuItem"""
9863         return _core_.Menu_AppendItem(*args, **kwargs)
9864
9865     def InsertItem(*args, **kwargs):
9866         """InsertItem(self, size_t pos, MenuItem item) -> MenuItem"""
9867         return _core_.Menu_InsertItem(*args, **kwargs)
9868
9869     def PrependItem(*args, **kwargs):
9870         """PrependItem(self, MenuItem item) -> MenuItem"""
9871         return _core_.Menu_PrependItem(*args, **kwargs)
9872
9873     def Break(*args, **kwargs):
9874         """Break(self)"""
9875         return _core_.Menu_Break(*args, **kwargs)
9876
9877     def Insert(*args, **kwargs):
9878         """
9879         Insert(self, size_t pos, int id, String text, String help=EmptyString,
9880             int kind=ITEM_NORMAL) -> MenuItem
9881         """
9882         return _core_.Menu_Insert(*args, **kwargs)
9883
9884     def InsertSeparator(*args, **kwargs):
9885         """InsertSeparator(self, size_t pos) -> MenuItem"""
9886         return _core_.Menu_InsertSeparator(*args, **kwargs)
9887
9888     def InsertCheckItem(*args, **kwargs):
9889         """InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
9890         return _core_.Menu_InsertCheckItem(*args, **kwargs)
9891
9892     def InsertRadioItem(*args, **kwargs):
9893         """InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
9894         return _core_.Menu_InsertRadioItem(*args, **kwargs)
9895
9896     def InsertMenu(*args, **kwargs):
9897         """InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
9898         return _core_.Menu_InsertMenu(*args, **kwargs)
9899
9900     def Prepend(*args, **kwargs):
9901         """Prepend(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem"""
9902         return _core_.Menu_Prepend(*args, **kwargs)
9903
9904     def PrependSeparator(*args, **kwargs):
9905         """PrependSeparator(self) -> MenuItem"""
9906         return _core_.Menu_PrependSeparator(*args, **kwargs)
9907
9908     def PrependCheckItem(*args, **kwargs):
9909         """PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
9910         return _core_.Menu_PrependCheckItem(*args, **kwargs)
9911
9912     def PrependRadioItem(*args, **kwargs):
9913         """PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
9914         return _core_.Menu_PrependRadioItem(*args, **kwargs)
9915
9916     def PrependMenu(*args, **kwargs):
9917         """PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
9918         return _core_.Menu_PrependMenu(*args, **kwargs)
9919
9920     def Remove(*args, **kwargs):
9921         """Remove(self, int id) -> MenuItem"""
9922         return _core_.Menu_Remove(*args, **kwargs)
9923
9924     def RemoveItem(*args, **kwargs):
9925         """RemoveItem(self, MenuItem item) -> MenuItem"""
9926         return _core_.Menu_RemoveItem(*args, **kwargs)
9927
9928     def Delete(*args, **kwargs):
9929         """Delete(self, int id) -> bool"""
9930         return _core_.Menu_Delete(*args, **kwargs)
9931
9932     def DeleteItem(*args, **kwargs):
9933         """DeleteItem(self, MenuItem item) -> bool"""
9934         return _core_.Menu_DeleteItem(*args, **kwargs)
9935
9936     def Destroy(*args, **kwargs):
9937         """
9938         Destroy(self)
9939
9940         Deletes the C++ object this Python object is a proxy for.
9941         """
9942         val = _core_.Menu_Destroy(*args, **kwargs)
9943         args[0].thisown = 0
9944         return val
9945
9946     def DestroyId(*args, **kwargs):
9947         """
9948         DestroyId(self, int id) -> bool
9949
9950         Deletes the C++ object this Python object is a proxy for.
9951         """
9952         val = _core_.Menu_DestroyId(*args, **kwargs)
9953         args[0].thisown = 0
9954         return val
9955
9956     def DestroyItem(*args, **kwargs):
9957         """
9958         DestroyItem(self, MenuItem item) -> bool
9959
9960         Deletes the C++ object this Python object is a proxy for.
9961         """
9962         val = _core_.Menu_DestroyItem(*args, **kwargs)
9963         args[0].thisown = 0
9964         return val
9965
9966     def GetMenuItemCount(*args, **kwargs):
9967         """GetMenuItemCount(self) -> size_t"""
9968         return _core_.Menu_GetMenuItemCount(*args, **kwargs)
9969
9970     def GetMenuItems(*args, **kwargs):
9971         """GetMenuItems(self) -> PyObject"""
9972         return _core_.Menu_GetMenuItems(*args, **kwargs)
9973
9974     def FindItem(*args, **kwargs):
9975         """FindItem(self, String item) -> int"""
9976         return _core_.Menu_FindItem(*args, **kwargs)
9977
9978     def FindItemById(*args, **kwargs):
9979         """FindItemById(self, int id) -> MenuItem"""
9980         return _core_.Menu_FindItemById(*args, **kwargs)
9981
9982     def FindItemByPosition(*args, **kwargs):
9983         """FindItemByPosition(self, size_t position) -> MenuItem"""
9984         return _core_.Menu_FindItemByPosition(*args, **kwargs)
9985
9986     def Enable(*args, **kwargs):
9987         """Enable(self, int id, bool enable)"""
9988         return _core_.Menu_Enable(*args, **kwargs)
9989
9990     def IsEnabled(*args, **kwargs):
9991         """IsEnabled(self, int id) -> bool"""
9992         return _core_.Menu_IsEnabled(*args, **kwargs)
9993
9994     def Check(*args, **kwargs):
9995         """Check(self, int id, bool check)"""
9996         return _core_.Menu_Check(*args, **kwargs)
9997
9998     def IsChecked(*args, **kwargs):
9999         """IsChecked(self, int id) -> bool"""
10000         return _core_.Menu_IsChecked(*args, **kwargs)
10001
10002     def SetLabel(*args, **kwargs):
10003         """SetLabel(self, int id, String label)"""
10004         return _core_.Menu_SetLabel(*args, **kwargs)
10005
10006     def GetLabel(*args, **kwargs):
10007         """GetLabel(self, int id) -> String"""
10008         return _core_.Menu_GetLabel(*args, **kwargs)
10009
10010     def SetHelpString(*args, **kwargs):
10011         """SetHelpString(self, int id, String helpString)"""
10012         return _core_.Menu_SetHelpString(*args, **kwargs)
10013
10014     def GetHelpString(*args, **kwargs):
10015         """GetHelpString(self, int id) -> String"""
10016         return _core_.Menu_GetHelpString(*args, **kwargs)
10017
10018     def SetTitle(*args, **kwargs):
10019         """SetTitle(self, String title)"""
10020         return _core_.Menu_SetTitle(*args, **kwargs)
10021
10022     def GetTitle(*args, **kwargs):
10023         """GetTitle(self) -> String"""
10024         return _core_.Menu_GetTitle(*args, **kwargs)
10025
10026     def SetEventHandler(*args, **kwargs):
10027         """SetEventHandler(self, EvtHandler handler)"""
10028         return _core_.Menu_SetEventHandler(*args, **kwargs)
10029
10030     def GetEventHandler(*args, **kwargs):
10031         """GetEventHandler(self) -> EvtHandler"""
10032         return _core_.Menu_GetEventHandler(*args, **kwargs)
10033
10034     def SetInvokingWindow(*args, **kwargs):
10035         """SetInvokingWindow(self, Window win)"""
10036         return _core_.Menu_SetInvokingWindow(*args, **kwargs)
10037
10038     def GetInvokingWindow(*args, **kwargs):
10039         """GetInvokingWindow(self) -> Window"""
10040         return _core_.Menu_GetInvokingWindow(*args, **kwargs)
10041
10042     def GetStyle(*args, **kwargs):
10043         """GetStyle(self) -> long"""
10044         return _core_.Menu_GetStyle(*args, **kwargs)
10045
10046     def UpdateUI(*args, **kwargs):
10047         """UpdateUI(self, EvtHandler source=None)"""
10048         return _core_.Menu_UpdateUI(*args, **kwargs)
10049
10050     def GetMenuBar(*args, **kwargs):
10051         """GetMenuBar(self) -> MenuBar"""
10052         return _core_.Menu_GetMenuBar(*args, **kwargs)
10053
10054     def Attach(*args, **kwargs):
10055         """Attach(self, wxMenuBarBase menubar)"""
10056         return _core_.Menu_Attach(*args, **kwargs)
10057
10058     def Detach(*args, **kwargs):
10059         """Detach(self)"""
10060         return _core_.Menu_Detach(*args, **kwargs)
10061
10062     def IsAttached(*args, **kwargs):
10063         """IsAttached(self) -> bool"""
10064         return _core_.Menu_IsAttached(*args, **kwargs)
10065
10066     def SetParent(*args, **kwargs):
10067         """SetParent(self, Menu parent)"""
10068         return _core_.Menu_SetParent(*args, **kwargs)
10069
10070     def GetParent(*args, **kwargs):
10071         """GetParent(self) -> Menu"""
10072         return _core_.Menu_GetParent(*args, **kwargs)
10073
10074 _core_.Menu_swigregister(Menu)
10075 DefaultValidator = cvar.DefaultValidator
10076
10077 #---------------------------------------------------------------------------
10078
10079 class MenuBar(Window):
10080     """Proxy of C++ MenuBar class"""
10081     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10082     __repr__ = _swig_repr
10083     def __init__(self, *args, **kwargs):
10084         """__init__(self, long style=0) -> MenuBar"""
10085         _core_.MenuBar_swiginit(self,_core_.new_MenuBar(*args, **kwargs))
10086         self._setOORInfo(self)
10087
10088     def Append(*args, **kwargs):
10089         """Append(self, Menu menu, String title) -> bool"""
10090         return _core_.MenuBar_Append(*args, **kwargs)
10091
10092     def Insert(*args, **kwargs):
10093         """Insert(self, size_t pos, Menu menu, String title) -> bool"""
10094         return _core_.MenuBar_Insert(*args, **kwargs)
10095
10096     def GetMenuCount(*args, **kwargs):
10097         """GetMenuCount(self) -> size_t"""
10098         return _core_.MenuBar_GetMenuCount(*args, **kwargs)
10099
10100     def GetMenu(*args, **kwargs):
10101         """GetMenu(self, size_t pos) -> Menu"""
10102         return _core_.MenuBar_GetMenu(*args, **kwargs)
10103
10104     def Replace(*args, **kwargs):
10105         """Replace(self, size_t pos, Menu menu, String title) -> Menu"""
10106         return _core_.MenuBar_Replace(*args, **kwargs)
10107
10108     def Remove(*args, **kwargs):
10109         """Remove(self, size_t pos) -> Menu"""
10110         return _core_.MenuBar_Remove(*args, **kwargs)
10111
10112     def EnableTop(*args, **kwargs):
10113         """EnableTop(self, size_t pos, bool enable)"""
10114         return _core_.MenuBar_EnableTop(*args, **kwargs)
10115
10116     def IsEnabledTop(*args, **kwargs):
10117         """IsEnabledTop(self, size_t pos) -> bool"""
10118         return _core_.MenuBar_IsEnabledTop(*args, **kwargs)
10119
10120     def SetLabelTop(*args, **kwargs):
10121         """SetLabelTop(self, size_t pos, String label)"""
10122         return _core_.MenuBar_SetLabelTop(*args, **kwargs)
10123
10124     def GetLabelTop(*args, **kwargs):
10125         """GetLabelTop(self, size_t pos) -> String"""
10126         return _core_.MenuBar_GetLabelTop(*args, **kwargs)
10127
10128     def FindMenuItem(*args, **kwargs):
10129         """FindMenuItem(self, String menu, String item) -> int"""
10130         return _core_.MenuBar_FindMenuItem(*args, **kwargs)
10131
10132     def FindItemById(*args, **kwargs):
10133         """FindItemById(self, int id) -> MenuItem"""
10134         return _core_.MenuBar_FindItemById(*args, **kwargs)
10135
10136     def FindMenu(*args, **kwargs):
10137         """FindMenu(self, String title) -> int"""
10138         return _core_.MenuBar_FindMenu(*args, **kwargs)
10139
10140     def Enable(*args, **kwargs):
10141         """Enable(self, int id, bool enable)"""
10142         return _core_.MenuBar_Enable(*args, **kwargs)
10143
10144     def Check(*args, **kwargs):
10145         """Check(self, int id, bool check)"""
10146         return _core_.MenuBar_Check(*args, **kwargs)
10147
10148     def IsChecked(*args, **kwargs):
10149         """IsChecked(self, int id) -> bool"""
10150         return _core_.MenuBar_IsChecked(*args, **kwargs)
10151
10152     def IsEnabled(*args, **kwargs):
10153         """IsEnabled(self, int id) -> bool"""
10154         return _core_.MenuBar_IsEnabled(*args, **kwargs)
10155
10156     def SetLabel(*args, **kwargs):
10157         """SetLabel(self, int id, String label)"""
10158         return _core_.MenuBar_SetLabel(*args, **kwargs)
10159
10160     def GetLabel(*args, **kwargs):
10161         """GetLabel(self, int id) -> String"""
10162         return _core_.MenuBar_GetLabel(*args, **kwargs)
10163
10164     def SetHelpString(*args, **kwargs):
10165         """SetHelpString(self, int id, String helpString)"""
10166         return _core_.MenuBar_SetHelpString(*args, **kwargs)
10167
10168     def GetHelpString(*args, **kwargs):
10169         """GetHelpString(self, int id) -> String"""
10170         return _core_.MenuBar_GetHelpString(*args, **kwargs)
10171
10172     def GetFrame(*args, **kwargs):
10173         """GetFrame(self) -> wxFrame"""
10174         return _core_.MenuBar_GetFrame(*args, **kwargs)
10175
10176     def IsAttached(*args, **kwargs):
10177         """IsAttached(self) -> bool"""
10178         return _core_.MenuBar_IsAttached(*args, **kwargs)
10179
10180     def Attach(*args, **kwargs):
10181         """Attach(self, wxFrame frame)"""
10182         return _core_.MenuBar_Attach(*args, **kwargs)
10183
10184     def Detach(*args, **kwargs):
10185         """Detach(self)"""
10186         return _core_.MenuBar_Detach(*args, **kwargs)
10187
10188     def UpdateMenus(*args, **kwargs):
10189         """UpdateMenus(self)"""
10190         return _core_.MenuBar_UpdateMenus(*args, **kwargs)
10191
10192     def SetAutoWindowMenu(*args, **kwargs):
10193         """SetAutoWindowMenu(bool enable)"""
10194         return _core_.MenuBar_SetAutoWindowMenu(*args, **kwargs)
10195
10196     SetAutoWindowMenu = staticmethod(SetAutoWindowMenu)
10197     def GetAutoWindowMenu(*args, **kwargs):
10198         """GetAutoWindowMenu() -> bool"""
10199         return _core_.MenuBar_GetAutoWindowMenu(*args, **kwargs)
10200
10201     GetAutoWindowMenu = staticmethod(GetAutoWindowMenu)
10202 _core_.MenuBar_swigregister(MenuBar)
10203
10204 def MenuBar_SetAutoWindowMenu(*args, **kwargs):
10205   """MenuBar_SetAutoWindowMenu(bool enable)"""
10206   return _core_.MenuBar_SetAutoWindowMenu(*args, **kwargs)
10207
10208 def MenuBar_GetAutoWindowMenu(*args):
10209   """MenuBar_GetAutoWindowMenu() -> bool"""
10210   return _core_.MenuBar_GetAutoWindowMenu(*args)
10211
10212 #---------------------------------------------------------------------------
10213
10214 class MenuItem(Object):
10215     """Proxy of C++ MenuItem class"""
10216     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10217     __repr__ = _swig_repr
10218     def __init__(self, *args, **kwargs):
10219         """
10220         __init__(self, Menu parentMenu=None, int id=ID_ANY, String text=EmptyString,
10221             String help=EmptyString, int kind=ITEM_NORMAL,
10222             Menu subMenu=None) -> MenuItem
10223         """
10224         _core_.MenuItem_swiginit(self,_core_.new_MenuItem(*args, **kwargs))
10225     __swig_destroy__ = _core_.delete_MenuItem
10226     __del__ = lambda self : None;
10227     def GetMenu(*args, **kwargs):
10228         """GetMenu(self) -> Menu"""
10229         return _core_.MenuItem_GetMenu(*args, **kwargs)
10230
10231     def SetMenu(*args, **kwargs):
10232         """SetMenu(self, Menu menu)"""
10233         return _core_.MenuItem_SetMenu(*args, **kwargs)
10234
10235     def SetId(*args, **kwargs):
10236         """SetId(self, int id)"""
10237         return _core_.MenuItem_SetId(*args, **kwargs)
10238
10239     def GetId(*args, **kwargs):
10240         """GetId(self) -> int"""
10241         return _core_.MenuItem_GetId(*args, **kwargs)
10242
10243     def IsSeparator(*args, **kwargs):
10244         """IsSeparator(self) -> bool"""
10245         return _core_.MenuItem_IsSeparator(*args, **kwargs)
10246
10247     def SetText(*args, **kwargs):
10248         """SetText(self, String str)"""
10249         return _core_.MenuItem_SetText(*args, **kwargs)
10250
10251     def GetLabel(*args, **kwargs):
10252         """GetLabel(self) -> String"""
10253         return _core_.MenuItem_GetLabel(*args, **kwargs)
10254
10255     def GetText(*args, **kwargs):
10256         """GetText(self) -> String"""
10257         return _core_.MenuItem_GetText(*args, **kwargs)
10258
10259     def GetLabelFromText(*args, **kwargs):
10260         """GetLabelFromText(String text) -> String"""
10261         return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
10262
10263     GetLabelFromText = staticmethod(GetLabelFromText)
10264     def GetKind(*args, **kwargs):
10265         """GetKind(self) -> int"""
10266         return _core_.MenuItem_GetKind(*args, **kwargs)
10267
10268     def SetKind(*args, **kwargs):
10269         """SetKind(self, int kind)"""
10270         return _core_.MenuItem_SetKind(*args, **kwargs)
10271
10272     def SetCheckable(*args, **kwargs):
10273         """SetCheckable(self, bool checkable)"""
10274         return _core_.MenuItem_SetCheckable(*args, **kwargs)
10275
10276     def IsCheckable(*args, **kwargs):
10277         """IsCheckable(self) -> bool"""
10278         return _core_.MenuItem_IsCheckable(*args, **kwargs)
10279
10280     def IsSubMenu(*args, **kwargs):
10281         """IsSubMenu(self) -> bool"""
10282         return _core_.MenuItem_IsSubMenu(*args, **kwargs)
10283
10284     def SetSubMenu(*args, **kwargs):
10285         """SetSubMenu(self, Menu menu)"""
10286         return _core_.MenuItem_SetSubMenu(*args, **kwargs)
10287
10288     def GetSubMenu(*args, **kwargs):
10289         """GetSubMenu(self) -> Menu"""
10290         return _core_.MenuItem_GetSubMenu(*args, **kwargs)
10291
10292     def Enable(*args, **kwargs):
10293         """Enable(self, bool enable=True)"""
10294         return _core_.MenuItem_Enable(*args, **kwargs)
10295
10296     def IsEnabled(*args, **kwargs):
10297         """IsEnabled(self) -> bool"""
10298         return _core_.MenuItem_IsEnabled(*args, **kwargs)
10299
10300     def Check(*args, **kwargs):
10301         """Check(self, bool check=True)"""
10302         return _core_.MenuItem_Check(*args, **kwargs)
10303
10304     def IsChecked(*args, **kwargs):
10305         """IsChecked(self) -> bool"""
10306         return _core_.MenuItem_IsChecked(*args, **kwargs)
10307
10308     def Toggle(*args, **kwargs):
10309         """Toggle(self)"""
10310         return _core_.MenuItem_Toggle(*args, **kwargs)
10311
10312     def SetHelp(*args, **kwargs):
10313         """SetHelp(self, String str)"""
10314         return _core_.MenuItem_SetHelp(*args, **kwargs)
10315
10316     def GetHelp(*args, **kwargs):
10317         """GetHelp(self) -> String"""
10318         return _core_.MenuItem_GetHelp(*args, **kwargs)
10319
10320     def GetAccel(*args, **kwargs):
10321         """GetAccel(self) -> AcceleratorEntry"""
10322         return _core_.MenuItem_GetAccel(*args, **kwargs)
10323
10324     def SetAccel(*args, **kwargs):
10325         """SetAccel(self, AcceleratorEntry accel)"""
10326         return _core_.MenuItem_SetAccel(*args, **kwargs)
10327
10328     def SetBitmap(*args, **kwargs):
10329         """SetBitmap(self, Bitmap bitmap)"""
10330         return _core_.MenuItem_SetBitmap(*args, **kwargs)
10331
10332     def GetBitmap(*args, **kwargs):
10333         """GetBitmap(self) -> Bitmap"""
10334         return _core_.MenuItem_GetBitmap(*args, **kwargs)
10335
10336     def SetFont(*args, **kwargs):
10337         """SetFont(self, Font font)"""
10338         return _core_.MenuItem_SetFont(*args, **kwargs)
10339
10340     def GetFont(*args, **kwargs):
10341         """GetFont(self) -> Font"""
10342         return _core_.MenuItem_GetFont(*args, **kwargs)
10343
10344     def SetTextColour(*args, **kwargs):
10345         """SetTextColour(self, Colour colText)"""
10346         return _core_.MenuItem_SetTextColour(*args, **kwargs)
10347
10348     def GetTextColour(*args, **kwargs):
10349         """GetTextColour(self) -> Colour"""
10350         return _core_.MenuItem_GetTextColour(*args, **kwargs)
10351
10352     def SetBackgroundColour(*args, **kwargs):
10353         """SetBackgroundColour(self, Colour colBack)"""
10354         return _core_.MenuItem_SetBackgroundColour(*args, **kwargs)
10355
10356     def GetBackgroundColour(*args, **kwargs):
10357         """GetBackgroundColour(self) -> Colour"""
10358         return _core_.MenuItem_GetBackgroundColour(*args, **kwargs)
10359
10360     def SetBitmaps(*args, **kwargs):
10361         """SetBitmaps(self, Bitmap bmpChecked, Bitmap bmpUnchecked=wxNullBitmap)"""
10362         return _core_.MenuItem_SetBitmaps(*args, **kwargs)
10363
10364     def SetDisabledBitmap(*args, **kwargs):
10365         """SetDisabledBitmap(self, Bitmap bmpDisabled)"""
10366         return _core_.MenuItem_SetDisabledBitmap(*args, **kwargs)
10367
10368     def GetDisabledBitmap(*args, **kwargs):
10369         """GetDisabledBitmap(self) -> Bitmap"""
10370         return _core_.MenuItem_GetDisabledBitmap(*args, **kwargs)
10371
10372     def SetMarginWidth(*args, **kwargs):
10373         """SetMarginWidth(self, int nWidth)"""
10374         return _core_.MenuItem_SetMarginWidth(*args, **kwargs)
10375
10376     def GetMarginWidth(*args, **kwargs):
10377         """GetMarginWidth(self) -> int"""
10378         return _core_.MenuItem_GetMarginWidth(*args, **kwargs)
10379
10380     def GetDefaultMarginWidth(*args, **kwargs):
10381         """GetDefaultMarginWidth() -> int"""
10382         return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
10383
10384     GetDefaultMarginWidth = staticmethod(GetDefaultMarginWidth)
10385     def IsOwnerDrawn(*args, **kwargs):
10386         """IsOwnerDrawn(self) -> bool"""
10387         return _core_.MenuItem_IsOwnerDrawn(*args, **kwargs)
10388
10389     def SetOwnerDrawn(*args, **kwargs):
10390         """SetOwnerDrawn(self, bool ownerDrawn=True)"""
10391         return _core_.MenuItem_SetOwnerDrawn(*args, **kwargs)
10392
10393     def ResetOwnerDrawn(*args, **kwargs):
10394         """ResetOwnerDrawn(self)"""
10395         return _core_.MenuItem_ResetOwnerDrawn(*args, **kwargs)
10396
10397 _core_.MenuItem_swigregister(MenuItem)
10398
10399 def MenuItem_GetLabelFromText(*args, **kwargs):
10400   """MenuItem_GetLabelFromText(String text) -> String"""
10401   return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
10402
10403 def MenuItem_GetDefaultMarginWidth(*args):
10404   """MenuItem_GetDefaultMarginWidth() -> int"""
10405   return _core_.MenuItem_GetDefaultMarginWidth(*args)
10406
10407 #---------------------------------------------------------------------------
10408
10409 class Control(Window):
10410     """
10411     This is the base class for a control or 'widget'.
10412
10413     A control is generally a small window which processes user input
10414     and/or displays one or more item of data.
10415     """
10416     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10417     __repr__ = _swig_repr
10418     def __init__(self, *args, **kwargs):
10419         """
10420         __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
10421             Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
10422             String name=ControlNameStr) -> Control
10423
10424         Create a Control.  Normally you should only call this from a subclass'
10425         __init__ as a plain old wx.Control is not very useful.
10426         """
10427         _core_.Control_swiginit(self,_core_.new_Control(*args, **kwargs))
10428         self._setOORInfo(self)
10429
10430     def Create(*args, **kwargs):
10431         """
10432         Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
10433             Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
10434             String name=ControlNameStr) -> bool
10435
10436         Do the 2nd phase and create the GUI control.
10437         """
10438         return _core_.Control_Create(*args, **kwargs)
10439
10440     def GetAlignment(*args, **kwargs):
10441         """
10442         GetAlignment(self) -> int
10443
10444         Get the control alignment (left/right/centre, top/bottom/centre)
10445         """
10446         return _core_.Control_GetAlignment(*args, **kwargs)
10447
10448     def GetLabelText(*args, **kwargs):
10449         """
10450         GetLabelText(self) -> String
10451
10452         Get just the text of the label, without mnemonic characters ('&')
10453         """
10454         return _core_.Control_GetLabelText(*args, **kwargs)
10455
10456     def Command(*args, **kwargs):
10457         """
10458         Command(self, CommandEvent event)
10459
10460         Simulates the effect of the user issuing a command to the item.
10461
10462         :see: `wx.CommandEvent`
10463
10464         """
10465         return _core_.Control_Command(*args, **kwargs)
10466
10467     def GetLabel(*args, **kwargs):
10468         """
10469         GetLabel(self) -> String
10470
10471         Return a control's text.
10472         """
10473         return _core_.Control_GetLabel(*args, **kwargs)
10474
10475     def GetClassDefaultAttributes(*args, **kwargs):
10476         """
10477         GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
10478
10479         Get the default attributes for this class.  This is useful if you want
10480         to use the same font or colour in your own control as in a standard
10481         control -- which is a much better idea than hard coding specific
10482         colours or fonts which might look completely out of place on the
10483         user's system, especially if it uses themes.
10484
10485         The variant parameter is only relevant under Mac currently and is
10486         ignore under other platforms. Under Mac, it will change the size of
10487         the returned font. See `wx.Window.SetWindowVariant` for more about
10488         this.
10489         """
10490         return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
10491
10492     GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
10493 _core_.Control_swigregister(Control)
10494 ControlNameStr = cvar.ControlNameStr
10495
10496 def PreControl(*args, **kwargs):
10497     """
10498     PreControl() -> Control
10499
10500     Precreate a Control control for 2-phase creation
10501     """
10502     val = _core_.new_PreControl(*args, **kwargs)
10503     return val
10504
10505 def Control_GetClassDefaultAttributes(*args, **kwargs):
10506   """
10507     Control_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
10508
10509     Get the default attributes for this class.  This is useful if you want
10510     to use the same font or colour in your own control as in a standard
10511     control -- which is a much better idea than hard coding specific
10512     colours or fonts which might look completely out of place on the
10513     user's system, especially if it uses themes.
10514
10515     The variant parameter is only relevant under Mac currently and is
10516     ignore under other platforms. Under Mac, it will change the size of
10517     the returned font. See `wx.Window.SetWindowVariant` for more about
10518     this.
10519     """
10520   return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
10521
10522 #---------------------------------------------------------------------------
10523
10524 class ItemContainer(object):
10525     """
10526     The wx.ItemContainer class defines an interface which is implemented
10527     by all controls which have string subitems, each of which may be
10528     selected, such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well
10529     as `wx.ComboBox` which implements an extended interface deriving from
10530     this one.
10531
10532     It defines the methods for accessing the control's items and although
10533     each of the derived classes implements them differently, they still
10534     all conform to the same interface.
10535
10536     The items in a wx.ItemContainer have (non empty) string labels and,
10537     optionally, client data associated with them.
10538
10539     """
10540     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10541     def __init__(self): raise AttributeError, "No constructor defined"
10542     __repr__ = _swig_repr
10543     def Append(*args, **kwargs):
10544         """
10545         Append(self, String item, PyObject clientData=None) -> int
10546
10547         Adds the item to the control, associating the given data with the item
10548         if not None.  The return value is the index of the newly added item
10549         which may be different from the last one if the control is sorted (e.g.
10550         has wx.LB_SORT or wx.CB_SORT style).
10551         """
10552         return _core_.ItemContainer_Append(*args, **kwargs)
10553
10554     def AppendItems(*args, **kwargs):
10555         """
10556         AppendItems(self, List strings)
10557
10558         Apend several items at once to the control.  Notice that calling this
10559         method may be much faster than appending the items one by one if you
10560         need to add a lot of items.
10561         """
10562         return _core_.ItemContainer_AppendItems(*args, **kwargs)
10563
10564     def Insert(*args, **kwargs):
10565         """
10566         Insert(self, String item, unsigned int pos, PyObject clientData=None) -> int
10567
10568         Insert an item into the control before the item at the ``pos`` index,
10569         optionally associating some data object with the item.
10570         """
10571         return _core_.ItemContainer_Insert(*args, **kwargs)
10572
10573     def Clear(*args, **kwargs):
10574         """
10575         Clear(self)
10576
10577         Removes all items from the control.
10578         """
10579         return _core_.ItemContainer_Clear(*args, **kwargs)
10580
10581     def Delete(*args, **kwargs):
10582         """
10583         Delete(self, unsigned int n)
10584
10585         Deletes the item at the zero-based index 'n' from the control. Note
10586         that it is an error (signalled by a `wx.PyAssertionError` exception if
10587         enabled) to remove an item with the index negative or greater or equal
10588         than the number of items in the control.
10589         """
10590         return _core_.ItemContainer_Delete(*args, **kwargs)
10591
10592     def GetClientData(*args, **kwargs):
10593         """
10594         GetClientData(self, unsigned int n) -> PyObject
10595
10596         Returns the client data associated with the given item, (if any.)
10597         """
10598         return _core_.ItemContainer_GetClientData(*args, **kwargs)
10599
10600     def SetClientData(*args, **kwargs):
10601         """
10602         SetClientData(self, unsigned int n, PyObject clientData)
10603
10604         Associate the given client data with the item at position n.
10605         """
10606         return _core_.ItemContainer_SetClientData(*args, **kwargs)
10607
10608     def GetCount(*args, **kwargs):
10609         """
10610         GetCount(self) -> unsigned int
10611
10612         Returns the number of items in the control.
10613         """
10614         return _core_.ItemContainer_GetCount(*args, **kwargs)
10615
10616     def IsEmpty(*args, **kwargs):
10617         """
10618         IsEmpty(self) -> bool
10619
10620         Returns True if the control is empty or False if it has some items.
10621         """
10622         return _core_.ItemContainer_IsEmpty(*args, **kwargs)
10623
10624     def GetString(*args, **kwargs):
10625         """
10626         GetString(self, unsigned int n) -> String
10627
10628         Returns the label of the item with the given index.
10629         """
10630         return _core_.ItemContainer_GetString(*args, **kwargs)
10631
10632     def GetStrings(*args, **kwargs):
10633         """GetStrings(self) -> wxArrayString"""
10634         return _core_.ItemContainer_GetStrings(*args, **kwargs)
10635
10636     def SetString(*args, **kwargs):
10637         """
10638         SetString(self, unsigned int n, String s)
10639
10640         Sets the label for the given item.
10641         """
10642         return _core_.ItemContainer_SetString(*args, **kwargs)
10643
10644     def FindString(*args, **kwargs):
10645         """
10646         FindString(self, String s) -> int
10647
10648         Finds an item whose label matches the given string.  Returns the
10649         zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not
10650         found.
10651         """
10652         return _core_.ItemContainer_FindString(*args, **kwargs)
10653
10654     def SetSelection(*args, **kwargs):
10655         """
10656         SetSelection(self, int n)
10657
10658         Sets the item at index 'n' to be the selected item.
10659         """
10660         return _core_.ItemContainer_SetSelection(*args, **kwargs)
10661
10662     def GetSelection(*args, **kwargs):
10663         """
10664         GetSelection(self) -> int
10665
10666         Returns the index of the selected item or ``wx.NOT_FOUND`` if no item
10667         is selected.
10668         """
10669         return _core_.ItemContainer_GetSelection(*args, **kwargs)
10670
10671     def SetStringSelection(*args, **kwargs):
10672         """SetStringSelection(self, String s) -> bool"""
10673         return _core_.ItemContainer_SetStringSelection(*args, **kwargs)
10674
10675     def GetStringSelection(*args, **kwargs):
10676         """
10677         GetStringSelection(self) -> String
10678
10679         Returns the label of the selected item or an empty string if no item
10680         is selected.
10681         """
10682         return _core_.ItemContainer_GetStringSelection(*args, **kwargs)
10683
10684     def Select(*args, **kwargs):
10685         """
10686         Select(self, int n)
10687
10688         This is the same as `SetSelection` and exists only because it is
10689         slightly more natural for controls which support multiple selection.
10690         """
10691         return _core_.ItemContainer_Select(*args, **kwargs)
10692
10693 _core_.ItemContainer_swigregister(ItemContainer)
10694
10695 #---------------------------------------------------------------------------
10696
10697 class ControlWithItems(Control,ItemContainer):
10698     """
10699     wx.ControlWithItems combines the ``wx.ItemContainer`` class with the
10700     wx.Control class, and is used for the base class of various controls
10701     that have items.
10702     """
10703     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10704     def __init__(self): raise AttributeError, "No constructor defined"
10705     __repr__ = _swig_repr
10706 _core_.ControlWithItems_swigregister(ControlWithItems)
10707
10708 #---------------------------------------------------------------------------
10709
10710 class SizerItem(Object):
10711     """
10712     The wx.SizerItem class is used to track the position, size and other
10713     attributes of each item managed by a `wx.Sizer`. It is not usually
10714     necessary to use this class because the sizer elements can also be
10715     identified by their positions or window or sizer references but
10716     sometimes it may be more convenient to use wx.SizerItem directly.
10717     Also, custom classes derived from `wx.PySizer` will probably need to
10718     use the collection of wx.SizerItems held by wx.Sizer when calculating
10719     layout.
10720
10721     :see: `wx.Sizer`, `wx.GBSizerItem`
10722     """
10723     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10724     __repr__ = _swig_repr
10725     def __init__(self, *args, **kwargs):
10726         """
10727         __init__(self) -> SizerItem
10728
10729         Constructs an empty wx.SizerItem.  Either a window, sizer or spacer
10730         size will need to be set before this item can be used in a Sizer.
10731
10732         You will probably never need to create a wx.SizerItem directly as they
10733         are created automatically when the sizer's Add, Insert or Prepend
10734         methods are called.
10735
10736         :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer`
10737         """
10738         _core_.SizerItem_swiginit(self,_core_.new_SizerItem(*args, **kwargs))
10739     __swig_destroy__ = _core_.delete_SizerItem
10740     __del__ = lambda self : None;
10741     def DeleteWindows(*args, **kwargs):
10742         """
10743         DeleteWindows(self)
10744
10745         Destroy the window or the windows in a subsizer, depending on the type
10746         of item.
10747         """
10748         return _core_.SizerItem_DeleteWindows(*args, **kwargs)
10749
10750     def DetachSizer(*args, **kwargs):
10751         """
10752         DetachSizer(self)
10753
10754         Enable deleting the SizerItem without destroying the contained sizer.
10755         """
10756         return _core_.SizerItem_DetachSizer(*args, **kwargs)
10757
10758     def GetSize(*args, **kwargs):
10759         """
10760         GetSize(self) -> Size
10761
10762         Get the current size of the item, as set in the last Layout.
10763         """
10764         return _core_.SizerItem_GetSize(*args, **kwargs)
10765
10766     def CalcMin(*args, **kwargs):
10767         """
10768         CalcMin(self) -> Size
10769
10770         Calculates the minimum desired size for the item, including any space
10771         needed by borders.
10772         """
10773         return _core_.SizerItem_CalcMin(*args, **kwargs)
10774
10775     def SetDimension(*args, **kwargs):
10776         """
10777         SetDimension(self, Point pos, Size size)
10778
10779         Set the position and size of the space allocated for this item by the
10780         sizer, and adjust the position and size of the item (window or
10781         subsizer) to be within that space taking alignment and borders into
10782         account.
10783         """
10784         return _core_.SizerItem_SetDimension(*args, **kwargs)
10785
10786     def GetMinSize(*args, **kwargs):
10787         """
10788         GetMinSize(self) -> Size
10789
10790         Get the minimum size needed for the item.
10791         """
10792         return _core_.SizerItem_GetMinSize(*args, **kwargs)
10793
10794     def GetMinSizeWithBorder(*args, **kwargs):
10795         """
10796         GetMinSizeWithBorder(self) -> Size
10797
10798         Get the minimum size needed for the item with space for the borders
10799         added, if needed.
10800         """
10801         return _core_.SizerItem_GetMinSizeWithBorder(*args, **kwargs)
10802
10803     def SetInitSize(*args, **kwargs):
10804         """SetInitSize(self, int x, int y)"""
10805         return _core_.SizerItem_SetInitSize(*args, **kwargs)
10806
10807     def SetRatioWH(*args, **kwargs):
10808         """
10809         SetRatioWH(self, int width, int height)
10810
10811         Set the ratio item attribute.
10812         """
10813         return _core_.SizerItem_SetRatioWH(*args, **kwargs)
10814
10815     def SetRatioSize(*args, **kwargs):
10816         """
10817         SetRatioSize(self, Size size)
10818
10819         Set the ratio item attribute.
10820         """
10821         return _core_.SizerItem_SetRatioSize(*args, **kwargs)
10822
10823     def SetRatio(*args, **kwargs):
10824         """
10825         SetRatio(self, float ratio)
10826
10827         Set the ratio item attribute.
10828         """
10829         return _core_.SizerItem_SetRatio(*args, **kwargs)
10830
10831     def GetRatio(*args, **kwargs):
10832         """
10833         GetRatio(self) -> float
10834
10835         Set the ratio item attribute.
10836         """
10837         return _core_.SizerItem_GetRatio(*args, **kwargs)
10838
10839     def GetRect(*args, **kwargs):
10840         """
10841         GetRect(self) -> Rect
10842
10843         Returns the rectangle that the sizer item should occupy
10844         """
10845         return _core_.SizerItem_GetRect(*args, **kwargs)
10846
10847     def IsWindow(*args, **kwargs):
10848         """
10849         IsWindow(self) -> bool
10850
10851         Is this sizer item a window?
10852         """
10853         return _core_.SizerItem_IsWindow(*args, **kwargs)
10854
10855     def IsSizer(*args, **kwargs):
10856         """
10857         IsSizer(self) -> bool
10858
10859         Is this sizer item a subsizer?
10860         """
10861         return _core_.SizerItem_IsSizer(*args, **kwargs)
10862
10863     def IsSpacer(*args, **kwargs):
10864         """
10865         IsSpacer(self) -> bool
10866
10867         Is this sizer item a spacer?
10868         """
10869         return _core_.SizerItem_IsSpacer(*args, **kwargs)
10870
10871     def SetProportion(*args, **kwargs):
10872         """
10873         SetProportion(self, int proportion)
10874
10875         Set the proportion value for this item.
10876         """
10877         return _core_.SizerItem_SetProportion(*args, **kwargs)
10878
10879     def GetProportion(*args, **kwargs):
10880         """
10881         GetProportion(self) -> int
10882
10883         Get the proportion value for this item.
10884         """
10885         return _core_.SizerItem_GetProportion(*args, **kwargs)
10886
10887     SetOption = wx._deprecated(SetProportion, "Please use `SetProportion` instead.")
10888     GetOption = wx._deprecated(GetProportion, "Please use `GetProportion` instead.")
10889     def SetFlag(*args, **kwargs):
10890         """
10891         SetFlag(self, int flag)
10892
10893         Set the flag value for this item.
10894         """
10895         return _core_.SizerItem_SetFlag(*args, **kwargs)
10896
10897     def GetFlag(*args, **kwargs):
10898         """
10899         GetFlag(self) -> int
10900
10901         Get the flag value for this item.
10902         """
10903         return _core_.SizerItem_GetFlag(*args, **kwargs)
10904
10905     def SetBorder(*args, **kwargs):
10906         """
10907         SetBorder(self, int border)
10908
10909         Set the border value for this item.
10910         """
10911         return _core_.SizerItem_SetBorder(*args, **kwargs)
10912
10913     def GetBorder(*args, **kwargs):
10914         """
10915         GetBorder(self) -> int
10916
10917         Get the border value for this item.
10918         """
10919         return _core_.SizerItem_GetBorder(*args, **kwargs)
10920
10921     def GetWindow(*args, **kwargs):
10922         """
10923         GetWindow(self) -> Window
10924
10925         Get the window (if any) that is managed by this sizer item.
10926         """
10927         return _core_.SizerItem_GetWindow(*args, **kwargs)
10928
10929     def SetWindow(*args, **kwargs):
10930         """
10931         SetWindow(self, Window window)
10932
10933         Set the window to be managed by this sizer item.
10934         """
10935         return _core_.SizerItem_SetWindow(*args, **kwargs)
10936
10937     def GetSizer(*args, **kwargs):
10938         """
10939         GetSizer(self) -> Sizer
10940
10941         Get the subsizer (if any) that is managed by this sizer item.
10942         """
10943         return _core_.SizerItem_GetSizer(*args, **kwargs)
10944
10945     def SetSizer(*args, **kwargs):
10946         """
10947         SetSizer(self, Sizer sizer)
10948
10949         Set the subsizer to be managed by this sizer item.
10950         """
10951         return _core_.SizerItem_SetSizer(*args, **kwargs)
10952
10953     def GetSpacer(*args, **kwargs):
10954         """
10955         GetSpacer(self) -> Size
10956
10957         Get the size of the spacer managed by this sizer item.
10958         """
10959         return _core_.SizerItem_GetSpacer(*args, **kwargs)
10960
10961     def SetSpacer(*args, **kwargs):
10962         """
10963         SetSpacer(self, Size size)
10964
10965         Set the size of the spacer to be managed by this sizer item.
10966         """
10967         return _core_.SizerItem_SetSpacer(*args, **kwargs)
10968
10969     def Show(*args, **kwargs):
10970         """
10971         Show(self, bool show)
10972
10973         Set the show item attribute, which sizers use to determine if the item
10974         is to be made part of the layout or not. If the item is tracking a
10975         window then it is shown or hidden as needed.
10976         """
10977         return _core_.SizerItem_Show(*args, **kwargs)
10978
10979     def IsShown(*args, **kwargs):
10980         """
10981         IsShown(self) -> bool
10982
10983         Is the item to be shown in the layout?
10984         """
10985         return _core_.SizerItem_IsShown(*args, **kwargs)
10986
10987     def GetPosition(*args, **kwargs):
10988         """
10989         GetPosition(self) -> Point
10990
10991         Returns the current position of the item, as set in the last Layout.
10992         """
10993         return _core_.SizerItem_GetPosition(*args, **kwargs)
10994
10995     def GetUserData(*args, **kwargs):
10996         """
10997         GetUserData(self) -> PyObject
10998
10999         Returns the userData associated with this sizer item, or None if there
11000         isn't any.
11001         """
11002         return _core_.SizerItem_GetUserData(*args, **kwargs)
11003
11004     def SetUserData(*args, **kwargs):
11005         """
11006         SetUserData(self, PyObject userData)
11007
11008         Associate a Python object with this sizer item.
11009         """
11010         return _core_.SizerItem_SetUserData(*args, **kwargs)
11011
11012 _core_.SizerItem_swigregister(SizerItem)
11013
11014 def SizerItemWindow(*args, **kwargs):
11015     """
11016     SizerItemWindow(Window window, int proportion, int flag, int border,
11017         PyObject userData=None) -> SizerItem
11018
11019     Constructs a `wx.SizerItem` for tracking a window.
11020     """
11021     val = _core_.new_SizerItemWindow(*args, **kwargs)
11022     return val
11023
11024 def SizerItemSpacer(*args, **kwargs):
11025     """
11026     SizerItemSpacer(int width, int height, int proportion, int flag, int border,
11027         PyObject userData=None) -> SizerItem
11028
11029     Constructs a `wx.SizerItem` for tracking a spacer.
11030     """
11031     val = _core_.new_SizerItemSpacer(*args, **kwargs)
11032     return val
11033
11034 def SizerItemSizer(*args, **kwargs):
11035     """
11036     SizerItemSizer(Sizer sizer, int proportion, int flag, int border,
11037         PyObject userData=None) -> SizerItem
11038
11039     Constructs a `wx.SizerItem` for tracking a subsizer
11040     """
11041     val = _core_.new_SizerItemSizer(*args, **kwargs)
11042     return val
11043
11044 class Sizer(Object):
11045     """
11046     wx.Sizer is the abstract base class used for laying out subwindows in
11047     a window.  You cannot use wx.Sizer directly; instead, you will have to
11048     use one of the sizer classes derived from it such as `wx.BoxSizer`,
11049     `wx.StaticBoxSizer`, `wx.GridSizer`, `wx.FlexGridSizer` and
11050     `wx.GridBagSizer`.
11051
11052     The concept implemented by sizers in wxWidgets is closely related to
11053     layout tools in other GUI toolkits, such as Java's AWT, the GTK
11054     toolkit or the Qt toolkit. It is based upon the idea of the individual
11055     subwindows reporting their minimal required size and their ability to
11056     get stretched if the size of the parent window has changed. This will
11057     most often mean that the programmer does not set the original size of
11058     a dialog in the beginning, rather the dialog will assigned a sizer and
11059     this sizer will be queried about the recommended size. The sizer in
11060     turn will query its children, which can be normal windows or contorls,
11061     empty space or other sizers, so that a hierarchy of sizers can be
11062     constructed. Note that wxSizer does not derive from wxWindow and thus
11063     do not interfere with tab ordering and requires very little resources
11064     compared to a real window on screen.
11065
11066     What makes sizers so well fitted for use in wxWidgets is the fact that
11067     every control reports its own minimal size and the algorithm can
11068     handle differences in font sizes or different window (dialog item)
11069     sizes on different platforms without problems. If for example the
11070     standard font as well as the overall design of Mac widgets requires
11071     more space than on Windows, then the initial size of a dialog using a
11072     sizer will automatically be bigger on Mac than on Windows.
11073     """
11074     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11075     def __init__(self): raise AttributeError, "No constructor defined"
11076     __repr__ = _swig_repr
11077     __swig_destroy__ = _core_.delete_Sizer
11078     __del__ = lambda self : None;
11079     def _setOORInfo(*args, **kwargs):
11080         """_setOORInfo(self, PyObject _self)"""
11081         return _core_.Sizer__setOORInfo(*args, **kwargs)
11082
11083     def Add(*args, **kwargs):
11084         """
11085         Add(self, item, int proportion=0, int flag=0, int border=0,
11086             PyObject userData=None) -> wx.SizerItem
11087
11088         Appends a child item to the sizer.
11089         """
11090         return _core_.Sizer_Add(*args, **kwargs)
11091
11092     def Insert(*args, **kwargs):
11093         """
11094         Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
11095             PyObject userData=None) -> wx.SizerItem
11096
11097         Inserts a new item into the list of items managed by this sizer before
11098         the item at index *before*.  See `Add` for a description of the parameters.
11099         """
11100         return _core_.Sizer_Insert(*args, **kwargs)
11101
11102     def Prepend(*args, **kwargs):
11103         """
11104         Prepend(self, item, int proportion=0, int flag=0, int border=0,
11105             PyObject userData=None) -> wx.SizerItem
11106
11107         Adds a new item to the begining of the list of sizer items managed by
11108         this sizer.  See `Add` for a description of the parameters.
11109         """
11110         return _core_.Sizer_Prepend(*args, **kwargs)
11111
11112     def Remove(*args, **kwargs):
11113         """
11114         Remove(self, item) -> bool
11115
11116         Removes an item from the sizer and destroys it.  This method does not
11117         cause any layout or resizing to take place, call `Layout` to update
11118         the layout on screen after removing a child from the sizer.  The
11119         *item* parameter can be either a window, a sizer, or the zero-based
11120         index of an item to remove.  Returns True if the child item was found
11121         and removed.
11122         """
11123         return _core_.Sizer_Remove(*args, **kwargs)
11124
11125     def Detach(*args, **kwargs):
11126         """
11127         Detach(self, item) -> bool
11128
11129         Detaches an item from the sizer without destroying it.  This method
11130         does not cause any layout or resizing to take place, call `Layout` to
11131         do so.  The *item* parameter can be either a window, a sizer, or the
11132         zero-based index of the item to be detached.  Returns True if the child item
11133         was found and detached.
11134         """
11135         return _core_.Sizer_Detach(*args, **kwargs)
11136
11137     def GetItem(*args, **kwargs):
11138         """
11139         GetItem(self, item) -> wx.SizerItem
11140
11141         Returns the `wx.SizerItem` which holds the *item* given.  The *item*
11142         parameter can be either a window, a sizer, or the zero-based index of
11143         the item to be found.
11144         """
11145         return _core_.Sizer_GetItem(*args, **kwargs)
11146
11147     def _SetItemMinSize(*args, **kwargs):
11148         """_SetItemMinSize(self, PyObject item, Size size)"""
11149         return _core_.Sizer__SetItemMinSize(*args, **kwargs)
11150
11151     def SetItemMinSize(self, item, *args):
11152         """
11153         SetItemMinSize(self, item, Size size)
11154
11155         Sets the minimum size that will be allocated for an item in the sizer.
11156         The *item* parameter can be either a window, a sizer, or the
11157         zero-based index of the item.  If a window or sizer is given then it
11158         will be searched for recursivly in subsizers if neccessary.
11159         """
11160         if len(args) == 2:
11161             # for backward compatibility accept separate width,height args too
11162             return self._SetItemMinSize(item, args)
11163         else:
11164             return self._SetItemMinSize(item, args[0])
11165
11166     def AddItem(*args, **kwargs):
11167         """
11168         AddItem(self, SizerItem item)
11169
11170         Adds a `wx.SizerItem` to the sizer.
11171         """
11172         return _core_.Sizer_AddItem(*args, **kwargs)
11173
11174     def InsertItem(*args, **kwargs):
11175         """
11176         InsertItem(self, int index, SizerItem item)
11177
11178         Inserts a `wx.SizerItem` to the sizer at the position given by *index*.
11179         """
11180         return _core_.Sizer_InsertItem(*args, **kwargs)
11181
11182     def PrependItem(*args, **kwargs):
11183         """
11184         PrependItem(self, SizerItem item)
11185
11186         Prepends a `wx.SizerItem` to the sizer.
11187         """
11188         return _core_.Sizer_PrependItem(*args, **kwargs)
11189
11190     def AddMany(self, items):
11191         """
11192         AddMany is a convenience method for adding several items
11193         to a sizer at one time.  Simply pass it a list of tuples,
11194         where each tuple consists of the parameters that you
11195         would normally pass to the `Add` method.
11196         """
11197         for item in items:
11198             if type(item) != type(()) or (len(item) == 2 and type(item[0]) == type(1)):
11199                 item = (item, )
11200             self.Add(*item)
11201
11202     # for backwards compatibility only, please do not use in new code
11203     def AddWindow(self, *args, **kw):
11204         """Compatibility alias for `Add`."""
11205         return self.Add(*args, **kw)
11206     def AddSizer(self, *args, **kw):
11207         """Compatibility alias for `Add`."""
11208         return self.Add(*args, **kw)
11209     def AddSpacer(self, *args, **kw):
11210         """Compatibility alias for `Add`."""
11211         return self.Add(*args, **kw)
11212
11213     def PrependWindow(self, *args, **kw):
11214         """Compatibility alias for `Prepend`."""
11215         return self.Prepend(*args, **kw)
11216     def PrependSizer(self, *args, **kw):
11217         """Compatibility alias for `Prepend`."""
11218         return self.Prepend(*args, **kw)
11219     def PrependSpacer(self, *args, **kw):
11220         """Compatibility alias for `Prepend`."""
11221         return self.Prepend(*args, **kw)
11222
11223     def InsertWindow(self, *args, **kw):
11224         """Compatibility alias for `Insert`."""
11225         return self.Insert(*args, **kw)
11226     def InsertSizer(self, *args, **kw):
11227         """Compatibility alias for `Insert`."""
11228         return self.Insert(*args, **kw)
11229     def InsertSpacer(self, *args, **kw):
11230         """Compatibility alias for `Insert`."""
11231         return self.Insert(*args, **kw)
11232
11233     def RemoveWindow(self, *args, **kw):
11234         """Compatibility alias for `Remove`."""
11235         return self.Remove(*args, **kw)
11236     def RemoveSizer(self, *args, **kw):
11237         """Compatibility alias for `Remove`."""
11238         return self.Remove(*args, **kw)
11239     def RemovePos(self, *args, **kw):
11240         """Compatibility alias for `Remove`."""
11241         return self.Remove(*args, **kw)
11242
11243
11244     def SetDimension(*args, **kwargs):
11245         """
11246         SetDimension(self, int x, int y, int width, int height)
11247
11248         Call this to force the sizer to take the given dimension and thus
11249         force the items owned by the sizer to resize themselves according to
11250         the rules defined by the parameter in the `Add`, `Insert` or `Prepend`
11251         methods.
11252         """
11253         return _core_.Sizer_SetDimension(*args, **kwargs)
11254
11255     def SetMinSize(*args, **kwargs):
11256         """
11257         SetMinSize(self, Size size)
11258
11259         Call this to give the sizer a minimal size. Normally, the sizer will
11260         calculate its minimal size based purely on how much space its children
11261         need. After calling this method `GetMinSize` will return either the
11262         minimal size as requested by its children or the minimal size set
11263         here, depending on which is bigger.
11264         """
11265         return _core_.Sizer_SetMinSize(*args, **kwargs)
11266
11267     def GetSize(*args, **kwargs):
11268         """
11269         GetSize(self) -> Size
11270
11271         Returns the current size of the space managed by the sizer.
11272         """
11273         return _core_.Sizer_GetSize(*args, **kwargs)
11274
11275     def GetPosition(*args, **kwargs):
11276         """
11277         GetPosition(self) -> Point
11278
11279         Returns the current position of the sizer's managed space.
11280         """
11281         return _core_.Sizer_GetPosition(*args, **kwargs)
11282
11283     def GetMinSize(*args, **kwargs):
11284         """
11285         GetMinSize(self) -> Size
11286
11287         Returns the minimal size of the sizer. This is either the combined
11288         minimal size of all the children and their borders or the minimal size
11289         set by SetMinSize, depending on which is bigger.
11290         """
11291         return _core_.Sizer_GetMinSize(*args, **kwargs)
11292
11293     def GetSizeTuple(self):
11294         return self.GetSize().Get()
11295     def GetPositionTuple(self):
11296         return self.GetPosition().Get()
11297     def GetMinSizeTuple(self):
11298         return self.GetMinSize().Get()
11299
11300     def RecalcSizes(*args, **kwargs):
11301         """
11302         RecalcSizes(self)
11303
11304         Using the sizes calculated by `CalcMin` reposition and resize all the
11305         items managed by this sizer.  You should not need to call this directly as
11306         it is called by `Layout`.
11307         """
11308         return _core_.Sizer_RecalcSizes(*args, **kwargs)
11309
11310     def CalcMin(*args, **kwargs):
11311         """
11312         CalcMin(self) -> Size
11313
11314         This method is where the sizer will do the actual calculation of its
11315         children's minimal sizes.  You should not need to call this directly as
11316         it is called by `Layout`.
11317         """
11318         return _core_.Sizer_CalcMin(*args, **kwargs)
11319
11320     def Layout(*args, **kwargs):
11321         """
11322         Layout(self)
11323
11324         This method will force the recalculation and layout of the items
11325         controlled by the sizer using the current space allocated to the
11326         sizer.  Normally this is called automatically from the owning window's
11327         EVT_SIZE handler, but it is also useful to call it from user code when
11328         one of the items in a sizer change size, or items are added or
11329         removed.
11330         """
11331         return _core_.Sizer_Layout(*args, **kwargs)
11332
11333     def Fit(*args, **kwargs):
11334         """
11335         Fit(self, Window window) -> Size
11336
11337         Tell the sizer to resize the *window* to match the sizer's minimal
11338         size. This is commonly done in the constructor of the window itself in
11339         order to set its initial size to match the needs of the children as
11340         determined by the sizer.  Returns the new size.
11341
11342         For a top level window this is the total window size, not the client size.
11343         """
11344         return _core_.Sizer_Fit(*args, **kwargs)
11345
11346     def FitInside(*args, **kwargs):
11347         """
11348         FitInside(self, Window window)
11349
11350         Tell the sizer to resize the *virtual size* of the *window* to match the
11351         sizer's minimal size. This will not alter the on screen size of the
11352         window, but may cause the addition/removal/alteration of scrollbars
11353         required to view the virtual area in windows which manage it.
11354
11355         :see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints`
11356
11357         """
11358         return _core_.Sizer_FitInside(*args, **kwargs)
11359
11360     def SetSizeHints(*args, **kwargs):
11361         """
11362         SetSizeHints(self, Window window)
11363
11364         Tell the sizer to set (and `Fit`) the minimal size of the *window* to
11365         match the sizer's minimal size. This is commonly done in the
11366         constructor of the window itself if the window is resizable (as are
11367         many dialogs under Unix and frames on probably all platforms) in order
11368         to prevent the window from being sized smaller than the minimal size
11369         required by the sizer.
11370         """
11371         return _core_.Sizer_SetSizeHints(*args, **kwargs)
11372
11373     def SetVirtualSizeHints(*args, **kwargs):
11374         """
11375         SetVirtualSizeHints(self, Window window)
11376
11377         Tell the sizer to set the minimal size of the window virtual area to
11378         match the sizer's minimal size. For windows with managed scrollbars
11379         this will set them appropriately.
11380
11381         :see: `wx.ScrolledWindow.SetScrollbars`
11382
11383         """
11384         return _core_.Sizer_SetVirtualSizeHints(*args, **kwargs)
11385
11386     def Clear(*args, **kwargs):
11387         """
11388         Clear(self, bool deleteWindows=False)
11389
11390         Clear all items from the sizer, optionally destroying the window items
11391         as well.
11392         """
11393         return _core_.Sizer_Clear(*args, **kwargs)
11394
11395     def DeleteWindows(*args, **kwargs):
11396         """
11397         DeleteWindows(self)
11398
11399         Destroy all windows managed by the sizer.
11400         """
11401         return _core_.Sizer_DeleteWindows(*args, **kwargs)
11402
11403     def GetChildren(*args, **kwargs):
11404         """
11405         GetChildren(self) -> list
11406
11407         Returns a list of all the `wx.SizerItem` objects managed by the sizer.
11408         """
11409         return _core_.Sizer_GetChildren(*args, **kwargs)
11410
11411     def Show(*args, **kwargs):
11412         """
11413         Show(self, item, bool show=True, bool recursive=false) -> bool
11414
11415         Shows or hides an item managed by the sizer.  To make a sizer item
11416         disappear or reappear, use Show followed by `Layout`.  The *item*
11417         parameter can be either a window, a sizer, or the zero-based index of
11418         the item.  Use the recursive parameter to show or hide an item in a
11419         subsizer.  Returns True if the item was found.
11420         """
11421         return _core_.Sizer_Show(*args, **kwargs)
11422
11423     def IsShown(*args, **kwargs):
11424         """
11425         IsShown(self, item)
11426
11427         Determines if the item is currently shown. To make a sizer
11428         item disappear or reappear, use Show followed by `Layout`.  The *item*
11429         parameter can be either a window, a sizer, or the zero-based index of
11430         the item.
11431         """
11432         return _core_.Sizer_IsShown(*args, **kwargs)
11433
11434     def Hide(self, item, recursive=False):
11435         """
11436         A convenience method for `Show` (item, False, recursive).
11437         """
11438         return self.Show(item, False, recursive)
11439
11440     def ShowItems(*args, **kwargs):
11441         """
11442         ShowItems(self, bool show)
11443
11444         Recursively call `wx.SizerItem.Show` on all sizer items.
11445         """
11446         return _core_.Sizer_ShowItems(*args, **kwargs)
11447
11448 _core_.Sizer_swigregister(Sizer)
11449
11450 class PySizer(Sizer):
11451     """
11452     wx.PySizer is a special version of `wx.Sizer` that has been
11453     instrumented to allow the C++ virtual methods to be overloaded in
11454     Python derived classes.  You would derive from this class if you are
11455     wanting to implement a custom sizer in Python code.  Simply implement
11456     `CalcMin` and `RecalcSizes` in the derived class and you're all set.
11457     For example::
11458
11459         class MySizer(wx.PySizer):
11460              def __init__(self):
11461                  wx.PySizer.__init__(self)
11462
11463              def CalcMin(self):
11464                  for item in self.GetChildren():
11465                       # calculate the total minimum width and height needed
11466                       # by all items in the sizer according to this sizer's
11467                       # layout algorithm.
11468                       ...
11469                  return wx.Size(width, height)
11470
11471               def RecalcSizes(self):
11472                   # find the space allotted to this sizer
11473                   pos = self.GetPosition()
11474                   size = self.GetSize()
11475                   for item in self.GetChildren():
11476                       # Recalculate (if necessary) the position and size of
11477                       # each item and then call item.SetDimension to do the
11478                       # actual positioning and sizing of the items within the
11479                       # space alloted to this sizer.
11480                       ...
11481                       item.SetDimension(itemPos, itemSize)
11482
11483
11484     When `Layout` is called it first calls `CalcMin` followed by
11485     `RecalcSizes` so you can optimize a bit by saving the results of
11486     `CalcMin` and reusing them in `RecalcSizes`.
11487
11488     :see: `wx.SizerItem`, `wx.Sizer.GetChildren`
11489
11490
11491     """
11492     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11493     __repr__ = _swig_repr
11494     def __init__(self, *args, **kwargs):
11495         """
11496         __init__(self) -> PySizer
11497
11498         Creates a wx.PySizer.  Must be called from the __init__ in the derived
11499         class.
11500         """
11501         _core_.PySizer_swiginit(self,_core_.new_PySizer(*args, **kwargs))
11502         self._setCallbackInfo(self, PySizer);self._setOORInfo(self)
11503
11504     def _setCallbackInfo(*args, **kwargs):
11505         """_setCallbackInfo(self, PyObject self, PyObject _class)"""
11506         return _core_.PySizer__setCallbackInfo(*args, **kwargs)
11507
11508 _core_.PySizer_swigregister(PySizer)
11509
11510 #---------------------------------------------------------------------------
11511
11512 class BoxSizer(Sizer):
11513     """
11514     The basic idea behind a box sizer is that windows will most often be
11515     laid out in rather simple basic geometry, typically in a row or a
11516     column or nested hierarchies of either.  A wx.BoxSizer will lay out
11517     its items in a simple row or column, depending on the orientation
11518     parameter passed to the constructor.
11519     """
11520     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11521     __repr__ = _swig_repr
11522     def __init__(self, *args, **kwargs):
11523         """
11524         __init__(self, int orient=HORIZONTAL) -> BoxSizer
11525
11526         Constructor for a wx.BoxSizer. *orient* may be one of ``wx.VERTICAL``
11527         or ``wx.HORIZONTAL`` for creating either a column sizer or a row
11528         sizer.
11529         """
11530         _core_.BoxSizer_swiginit(self,_core_.new_BoxSizer(*args, **kwargs))
11531         self._setOORInfo(self)
11532
11533     def GetOrientation(*args, **kwargs):
11534         """
11535         GetOrientation(self) -> int
11536
11537         Returns the current orientation of the sizer.
11538         """
11539         return _core_.BoxSizer_GetOrientation(*args, **kwargs)
11540
11541     def SetOrientation(*args, **kwargs):
11542         """
11543         SetOrientation(self, int orient)
11544
11545         Resets the orientation of the sizer.
11546         """
11547         return _core_.BoxSizer_SetOrientation(*args, **kwargs)
11548
11549 _core_.BoxSizer_swigregister(BoxSizer)
11550
11551 #---------------------------------------------------------------------------
11552
11553 class StaticBoxSizer(BoxSizer):
11554     """
11555     wx.StaticBoxSizer derives from and functions identically to the
11556     `wx.BoxSizer` and adds a `wx.StaticBox` around the items that the sizer
11557     manages.  Note that this static box must be created separately and
11558     passed to the sizer constructor.
11559     """
11560     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11561     __repr__ = _swig_repr
11562     def __init__(self, *args, **kwargs):
11563         """
11564         __init__(self, StaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer
11565
11566         Constructor. It takes an associated static box and the orientation
11567         *orient* as parameters - orient can be either of ``wx.VERTICAL`` or
11568         ``wx.HORIZONTAL``.
11569         """
11570         _core_.StaticBoxSizer_swiginit(self,_core_.new_StaticBoxSizer(*args, **kwargs))
11571         self._setOORInfo(self)
11572
11573     def GetStaticBox(*args, **kwargs):
11574         """
11575         GetStaticBox(self) -> StaticBox
11576
11577         Returns the static box associated with this sizer.
11578         """
11579         return _core_.StaticBoxSizer_GetStaticBox(*args, **kwargs)
11580
11581 _core_.StaticBoxSizer_swigregister(StaticBoxSizer)
11582
11583 #---------------------------------------------------------------------------
11584
11585 class GridSizer(Sizer):
11586     """
11587     A grid sizer is a sizer which lays out its children in a
11588     two-dimensional table with all cells having the same size.  In other
11589     words, the width of each cell within the grid is the width of the
11590     widest item added to the sizer and the height of each grid cell is the
11591     height of the tallest item.  An optional vertical and/or horizontal
11592     gap between items can also be specified (in pixels.)
11593
11594     Items are placed in the cells of the grid in the order they are added,
11595     in row-major order.  In other words, the first row is filled first,
11596     then the second, and so on until all items have been added. (If
11597     neccessary, additional rows will be added as items are added.)  If you
11598     need to have greater control over the cells that items are placed in
11599     then use the `wx.GridBagSizer`.
11600
11601     """
11602     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11603     __repr__ = _swig_repr
11604     def __init__(self, *args, **kwargs):
11605         """
11606         __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer
11607
11608         Constructor for a wx.GridSizer. *rows* and *cols* determine the number
11609         of columns and rows in the sizer - if either of the parameters is
11610         zero, it will be calculated to from the total number of children in
11611         the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
11612         define extra space between all children.
11613         """
11614         _core_.GridSizer_swiginit(self,_core_.new_GridSizer(*args, **kwargs))
11615         self._setOORInfo(self)
11616
11617     def SetCols(*args, **kwargs):
11618         """
11619         SetCols(self, int cols)
11620
11621         Sets the number of columns in the sizer.
11622         """
11623         return _core_.GridSizer_SetCols(*args, **kwargs)
11624
11625     def SetRows(*args, **kwargs):
11626         """
11627         SetRows(self, int rows)
11628
11629         Sets the number of rows in the sizer.
11630         """
11631         return _core_.GridSizer_SetRows(*args, **kwargs)
11632
11633     def SetVGap(*args, **kwargs):
11634         """
11635         SetVGap(self, int gap)
11636
11637         Sets the vertical gap (in pixels) between the cells in the sizer.
11638         """
11639         return _core_.GridSizer_SetVGap(*args, **kwargs)
11640
11641     def SetHGap(*args, **kwargs):
11642         """
11643         SetHGap(self, int gap)
11644
11645         Sets the horizontal gap (in pixels) between cells in the sizer
11646         """
11647         return _core_.GridSizer_SetHGap(*args, **kwargs)
11648
11649     def GetCols(*args, **kwargs):
11650         """
11651         GetCols(self) -> int
11652
11653         Returns the number of columns in the sizer.
11654         """
11655         return _core_.GridSizer_GetCols(*args, **kwargs)
11656
11657     def GetRows(*args, **kwargs):
11658         """
11659         GetRows(self) -> int
11660
11661         Returns the number of rows in the sizer.
11662         """
11663         return _core_.GridSizer_GetRows(*args, **kwargs)
11664
11665     def GetVGap(*args, **kwargs):
11666         """
11667         GetVGap(self) -> int
11668
11669         Returns the vertical gap (in pixels) between the cells in the sizer.
11670         """
11671         return _core_.GridSizer_GetVGap(*args, **kwargs)
11672
11673     def GetHGap(*args, **kwargs):
11674         """
11675         GetHGap(self) -> int
11676
11677         Returns the horizontal gap (in pixels) between cells in the sizer.
11678         """
11679         return _core_.GridSizer_GetHGap(*args, **kwargs)
11680
11681     def CalcRowsCols(self):
11682         """
11683         CalcRowsCols() -> (rows, cols)
11684
11685         Calculates how many rows and columns will be in the sizer based
11686         on the current number of items and also the rows, cols specified
11687         in the constructor.
11688         """
11689         nitems = len(self.GetChildren())
11690         rows = self.GetRows()
11691         cols = self.GetCols()
11692         assert rows != 0 or cols != 0, "Grid sizer must have either rows or columns fixed"
11693         if cols != 0:
11694             rows = (nitems + cols - 1) / cols
11695         elif rows != 0:
11696             cols = (nitems + rows - 1) / rows
11697         return (rows, cols)
11698
11699 _core_.GridSizer_swigregister(GridSizer)
11700
11701 #---------------------------------------------------------------------------
11702
11703 FLEX_GROWMODE_NONE = _core_.FLEX_GROWMODE_NONE
11704 FLEX_GROWMODE_SPECIFIED = _core_.FLEX_GROWMODE_SPECIFIED
11705 FLEX_GROWMODE_ALL = _core_.FLEX_GROWMODE_ALL
11706 class FlexGridSizer(GridSizer):
11707     """
11708     A flex grid sizer is a sizer which lays out its children in a
11709     two-dimensional table with all table cells in one row having the same
11710     height and all cells in one column having the same width, but all
11711     rows or all columns are not necessarily the same height or width as in
11712     the `wx.GridSizer`.
11713
11714     wx.FlexGridSizer can also size items equally in one direction but
11715     unequally ("flexibly") in the other. If the sizer is only flexible
11716     in one direction (this can be changed using `SetFlexibleDirection`), it
11717     needs to be decided how the sizer should grow in the other ("non
11718     flexible") direction in order to fill the available space. The
11719     `SetNonFlexibleGrowMode` method serves this purpose.
11720
11721
11722     """
11723     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11724     __repr__ = _swig_repr
11725     def __init__(self, *args, **kwargs):
11726         """
11727         __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer
11728
11729         Constructor for a wx.FlexGridSizer. *rows* and *cols* determine the
11730         number of columns and rows in the sizer - if either of the parameters
11731         is zero, it will be calculated to from the total number of children in
11732         the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
11733         define extra space between all children.
11734         """
11735         _core_.FlexGridSizer_swiginit(self,_core_.new_FlexGridSizer(*args, **kwargs))
11736         self._setOORInfo(self)
11737
11738     def AddGrowableRow(*args, **kwargs):
11739         """
11740         AddGrowableRow(self, size_t idx, int proportion=0)
11741
11742         Specifies that row *idx* (starting from zero) should be grown if there
11743         is extra space available to the sizer.
11744
11745         The *proportion* parameter has the same meaning as the stretch factor
11746         for the box sizers except that if all proportions are 0, then all
11747         columns are resized equally (instead of not being resized at all).
11748         """
11749         return _core_.FlexGridSizer_AddGrowableRow(*args, **kwargs)
11750
11751     def RemoveGrowableRow(*args, **kwargs):
11752         """
11753         RemoveGrowableRow(self, size_t idx)
11754
11755         Specifies that row *idx* is no longer growable.
11756         """
11757         return _core_.FlexGridSizer_RemoveGrowableRow(*args, **kwargs)
11758
11759     def AddGrowableCol(*args, **kwargs):
11760         """
11761         AddGrowableCol(self, size_t idx, int proportion=0)
11762
11763         Specifies that column *idx* (starting from zero) should be grown if
11764         there is extra space available to the sizer.
11765
11766         The *proportion* parameter has the same meaning as the stretch factor
11767         for the box sizers except that if all proportions are 0, then all
11768         columns are resized equally (instead of not being resized at all).
11769         """
11770         return _core_.FlexGridSizer_AddGrowableCol(*args, **kwargs)
11771
11772     def RemoveGrowableCol(*args, **kwargs):
11773         """
11774         RemoveGrowableCol(self, size_t idx)
11775
11776         Specifies that column *idx* is no longer growable.
11777         """
11778         return _core_.FlexGridSizer_RemoveGrowableCol(*args, **kwargs)
11779
11780     def SetFlexibleDirection(*args, **kwargs):
11781         """
11782         SetFlexibleDirection(self, int direction)
11783
11784         Specifies whether the sizer should flexibly resize its columns, rows,
11785         or both. Argument *direction* can be one of the following values.  Any
11786         other value is ignored.
11787
11788             ==============    =======================================
11789             wx.VERTICAL       Rows are flexibly sized.
11790             wx.HORIZONTAL     Columns are flexibly sized.
11791             wx.BOTH           Both rows and columns are flexibly sized
11792                               (this is the default value).
11793             ==============    =======================================
11794
11795         Note that this method does not trigger relayout.
11796
11797         """
11798         return _core_.FlexGridSizer_SetFlexibleDirection(*args, **kwargs)
11799
11800     def GetFlexibleDirection(*args, **kwargs):
11801         """
11802         GetFlexibleDirection(self) -> int
11803
11804         Returns a value that specifies whether the sizer
11805         flexibly resizes its columns, rows, or both (default).
11806
11807         :see: `SetFlexibleDirection`
11808         """
11809         return _core_.FlexGridSizer_GetFlexibleDirection(*args, **kwargs)
11810
11811     def SetNonFlexibleGrowMode(*args, **kwargs):
11812         """
11813         SetNonFlexibleGrowMode(self, int mode)
11814
11815         Specifies how the sizer should grow in the non-flexible direction if
11816         there is one (so `SetFlexibleDirection` must have been called
11817         previously). Argument *mode* can be one of the following values:
11818
11819             ==========================  =================================================
11820             wx.FLEX_GROWMODE_NONE       Sizer doesn't grow in the non flexible direction.
11821             wx.FLEX_GROWMODE_SPECIFIED  Sizer honors growable columns/rows set with
11822                                         `AddGrowableCol` and `AddGrowableRow`. In this
11823                                         case equal sizing applies to minimum sizes of
11824                                         columns or rows (this is the default value).
11825             wx.FLEX_GROWMODE_ALL        Sizer equally stretches all columns or rows in
11826                                         the non flexible direction, whether they are
11827                                         growable or not in the flexbile direction.
11828             ==========================  =================================================
11829
11830         Note that this method does not trigger relayout.
11831
11832
11833         """
11834         return _core_.FlexGridSizer_SetNonFlexibleGrowMode(*args, **kwargs)
11835
11836     def GetNonFlexibleGrowMode(*args, **kwargs):
11837         """
11838         GetNonFlexibleGrowMode(self) -> int
11839
11840         Returns the value that specifies how the sizer grows in the
11841         non-flexible direction if there is one.
11842
11843         :see: `SetNonFlexibleGrowMode`
11844         """
11845         return _core_.FlexGridSizer_GetNonFlexibleGrowMode(*args, **kwargs)
11846
11847     def GetRowHeights(*args, **kwargs):
11848         """
11849         GetRowHeights(self) -> list
11850
11851         Returns a list of integers representing the heights of each of the
11852         rows in the sizer.
11853         """
11854         return _core_.FlexGridSizer_GetRowHeights(*args, **kwargs)
11855
11856     def GetColWidths(*args, **kwargs):
11857         """
11858         GetColWidths(self) -> list
11859
11860         Returns a list of integers representing the widths of each of the
11861         columns in the sizer.
11862         """
11863         return _core_.FlexGridSizer_GetColWidths(*args, **kwargs)
11864
11865 _core_.FlexGridSizer_swigregister(FlexGridSizer)
11866
11867 class StdDialogButtonSizer(BoxSizer):
11868     """
11869     A special sizer that knows how to order and position standard buttons
11870     in order to conform to the current platform's standards.  You simply
11871     need to add each `wx.Button` to the sizer, and be sure to create the
11872     buttons using the standard ID's.  Then call `Realize` and the sizer
11873     will take care of the rest.
11874
11875     """
11876     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11877     __repr__ = _swig_repr
11878     def __init__(self, *args, **kwargs):
11879         """__init__(self) -> StdDialogButtonSizer"""
11880         _core_.StdDialogButtonSizer_swiginit(self,_core_.new_StdDialogButtonSizer(*args, **kwargs))
11881     def AddButton(*args, **kwargs):
11882         """
11883         AddButton(self, wxButton button)
11884
11885         Use this to add the buttons to this sizer.  Do not use the `Add`
11886         method in the base class.
11887         """
11888         return _core_.StdDialogButtonSizer_AddButton(*args, **kwargs)
11889
11890     def Realize(*args, **kwargs):
11891         """
11892         Realize(self)
11893
11894         This funciton needs to be called after all the buttons have been added
11895         to the sizer.  It will reorder them and position them in a platform
11896         specifc manner.
11897         """
11898         return _core_.StdDialogButtonSizer_Realize(*args, **kwargs)
11899
11900     def SetAffirmativeButton(*args, **kwargs):
11901         """SetAffirmativeButton(self, wxButton button)"""
11902         return _core_.StdDialogButtonSizer_SetAffirmativeButton(*args, **kwargs)
11903
11904     def SetNegativeButton(*args, **kwargs):
11905         """SetNegativeButton(self, wxButton button)"""
11906         return _core_.StdDialogButtonSizer_SetNegativeButton(*args, **kwargs)
11907
11908     def SetCancelButton(*args, **kwargs):
11909         """SetCancelButton(self, wxButton button)"""
11910         return _core_.StdDialogButtonSizer_SetCancelButton(*args, **kwargs)
11911
11912     def GetAffirmativeButton(*args, **kwargs):
11913         """GetAffirmativeButton(self) -> wxButton"""
11914         return _core_.StdDialogButtonSizer_GetAffirmativeButton(*args, **kwargs)
11915
11916     def GetApplyButton(*args, **kwargs):
11917         """GetApplyButton(self) -> wxButton"""
11918         return _core_.StdDialogButtonSizer_GetApplyButton(*args, **kwargs)
11919
11920     def GetNegativeButton(*args, **kwargs):
11921         """GetNegativeButton(self) -> wxButton"""
11922         return _core_.StdDialogButtonSizer_GetNegativeButton(*args, **kwargs)
11923
11924     def GetCancelButton(*args, **kwargs):
11925         """GetCancelButton(self) -> wxButton"""
11926         return _core_.StdDialogButtonSizer_GetCancelButton(*args, **kwargs)
11927
11928     def GetHelpButton(*args, **kwargs):
11929         """GetHelpButton(self) -> wxButton"""
11930         return _core_.StdDialogButtonSizer_GetHelpButton(*args, **kwargs)
11931
11932 _core_.StdDialogButtonSizer_swigregister(StdDialogButtonSizer)
11933
11934 #---------------------------------------------------------------------------
11935
11936 class GBPosition(object):
11937     """
11938     This class represents the position of an item in a virtual grid of
11939     rows and columns managed by a `wx.GridBagSizer`.  wxPython has
11940     typemaps that will automatically convert from a 2-element sequence of
11941     integers to a wx.GBPosition, so you can use the more pythonic
11942     representation of the position nearly transparently in Python code.
11943     """
11944     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11945     __repr__ = _swig_repr
11946     def __init__(self, *args, **kwargs):
11947         """
11948         __init__(self, int row=0, int col=0) -> GBPosition
11949
11950         This class represents the position of an item in a virtual grid of
11951         rows and columns managed by a `wx.GridBagSizer`.  wxPython has
11952         typemaps that will automatically convert from a 2-element sequence of
11953         integers to a wx.GBPosition, so you can use the more pythonic
11954         representation of the position nearly transparently in Python code.
11955         """
11956         _core_.GBPosition_swiginit(self,_core_.new_GBPosition(*args, **kwargs))
11957     __swig_destroy__ = _core_.delete_GBPosition
11958     __del__ = lambda self : None;
11959     def GetRow(*args, **kwargs):
11960         """GetRow(self) -> int"""
11961         return _core_.GBPosition_GetRow(*args, **kwargs)
11962
11963     def GetCol(*args, **kwargs):
11964         """GetCol(self) -> int"""
11965         return _core_.GBPosition_GetCol(*args, **kwargs)
11966
11967     def SetRow(*args, **kwargs):
11968         """SetRow(self, int row)"""
11969         return _core_.GBPosition_SetRow(*args, **kwargs)
11970
11971     def SetCol(*args, **kwargs):
11972         """SetCol(self, int col)"""
11973         return _core_.GBPosition_SetCol(*args, **kwargs)
11974
11975     def __eq__(*args, **kwargs):
11976         """
11977         __eq__(self, PyObject other) -> bool
11978
11979         Compare GBPosition for equality.
11980         """
11981         return _core_.GBPosition___eq__(*args, **kwargs)
11982
11983     def __ne__(*args, **kwargs):
11984         """
11985         __ne__(self, PyObject other) -> bool
11986
11987         Compare GBPosition for inequality.
11988         """
11989         return _core_.GBPosition___ne__(*args, **kwargs)
11990
11991     def Set(*args, **kwargs):
11992         """Set(self, int row=0, int col=0)"""
11993         return _core_.GBPosition_Set(*args, **kwargs)
11994
11995     def Get(*args, **kwargs):
11996         """Get(self) -> PyObject"""
11997         return _core_.GBPosition_Get(*args, **kwargs)
11998
11999     asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
12000     def __str__(self):                   return str(self.Get())
12001     def __repr__(self):                  return 'wx.GBPosition'+str(self.Get())
12002     def __len__(self):                   return len(self.Get())
12003     def __getitem__(self, index):        return self.Get()[index]
12004     def __setitem__(self, index, val):
12005         if index == 0: self.SetRow(val)
12006         elif index == 1: self.SetCol(val)
12007         else: raise IndexError
12008     def __nonzero__(self):               return self.Get() != (0,0)
12009     __safe_for_unpickling__ = True
12010     def __reduce__(self):                return (wx.GBPosition, self.Get())
12011
12012     row = property(GetRow, SetRow)
12013     col = property(GetCol, SetCol)
12014
12015 _core_.GBPosition_swigregister(GBPosition)
12016
12017 class GBSpan(object):
12018     """
12019     This class is used to hold the row and column spanning attributes of
12020     items in a `wx.GridBagSizer`.  wxPython has typemaps that will
12021     automatically convert from a 2-element sequence of integers to a
12022     wx.GBSpan, so you can use the more pythonic representation of the span
12023     nearly transparently in Python code.
12024
12025     """
12026     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12027     __repr__ = _swig_repr
12028     def __init__(self, *args, **kwargs):
12029         """
12030         __init__(self, int rowspan=1, int colspan=1) -> GBSpan
12031
12032         Construct a new wxGBSpan, optionally setting the rowspan and
12033         colspan. The default is (1,1). (Meaning that the item occupies one
12034         cell in each direction.
12035         """
12036         _core_.GBSpan_swiginit(self,_core_.new_GBSpan(*args, **kwargs))
12037     __swig_destroy__ = _core_.delete_GBSpan
12038     __del__ = lambda self : None;
12039     def GetRowspan(*args, **kwargs):
12040         """GetRowspan(self) -> int"""
12041         return _core_.GBSpan_GetRowspan(*args, **kwargs)
12042
12043     def GetColspan(*args, **kwargs):
12044         """GetColspan(self) -> int"""
12045         return _core_.GBSpan_GetColspan(*args, **kwargs)
12046
12047     def SetRowspan(*args, **kwargs):
12048         """SetRowspan(self, int rowspan)"""
12049         return _core_.GBSpan_SetRowspan(*args, **kwargs)
12050
12051     def SetColspan(*args, **kwargs):
12052         """SetColspan(self, int colspan)"""
12053         return _core_.GBSpan_SetColspan(*args, **kwargs)
12054
12055     def __eq__(*args, **kwargs):
12056         """
12057         __eq__(self, PyObject other) -> bool
12058
12059         Compare wxGBSpan for equality.
12060         """
12061         return _core_.GBSpan___eq__(*args, **kwargs)
12062
12063     def __ne__(*args, **kwargs):
12064         """
12065         __ne__(self, PyObject other) -> bool
12066
12067         Compare GBSpan for inequality.
12068         """
12069         return _core_.GBSpan___ne__(*args, **kwargs)
12070
12071     def Set(*args, **kwargs):
12072         """Set(self, int rowspan=1, int colspan=1)"""
12073         return _core_.GBSpan_Set(*args, **kwargs)
12074
12075     def Get(*args, **kwargs):
12076         """Get(self) -> PyObject"""
12077         return _core_.GBSpan_Get(*args, **kwargs)
12078
12079     asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
12080     def __str__(self):                   return str(self.Get())
12081     def __repr__(self):                  return 'wx.GBSpan'+str(self.Get())
12082     def __len__(self):                   return len(self.Get())
12083     def __getitem__(self, index):        return self.Get()[index]
12084     def __setitem__(self, index, val):
12085         if index == 0: self.SetRowspan(val)
12086         elif index == 1: self.SetColspan(val)
12087         else: raise IndexError
12088     def __nonzero__(self):               return self.Get() != (0,0)
12089     __safe_for_unpickling__ = True
12090     def __reduce__(self):                return (wx.GBSpan, self.Get())
12091
12092     rowspan = property(GetRowspan, SetRowspan)
12093     colspan = property(GetColspan, SetColspan)
12094
12095 _core_.GBSpan_swigregister(GBSpan)
12096
12097 class GBSizerItem(SizerItem):
12098     """
12099     The wx.GBSizerItem class is used to track the additional data about
12100     items in a `wx.GridBagSizer` such as the item's position in the grid
12101     and how many rows or columns it spans.
12102
12103     """
12104     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12105     __repr__ = _swig_repr
12106     def __init__(self, *args, **kwargs):
12107         """
12108         __init__(self) -> GBSizerItem
12109
12110         Constructs an empty wx.GBSizerItem.  Either a window, sizer or spacer
12111         size will need to be set, as well as a position and span before this
12112         item can be used in a Sizer.
12113
12114         You will probably never need to create a wx.GBSizerItem directly as they
12115         are created automatically when the sizer's Add method is called.
12116         """
12117         _core_.GBSizerItem_swiginit(self,_core_.new_GBSizerItem(*args, **kwargs))
12118     __swig_destroy__ = _core_.delete_GBSizerItem
12119     __del__ = lambda self : None;
12120     def GetPos(*args, **kwargs):
12121         """
12122         GetPos(self) -> GBPosition
12123
12124         Get the grid position of the item
12125         """
12126         return _core_.GBSizerItem_GetPos(*args, **kwargs)
12127
12128     def GetPosTuple(self): return self.GetPos().Get()
12129     def GetSpan(*args, **kwargs):
12130         """
12131         GetSpan(self) -> GBSpan
12132
12133         Get the row and column spanning of the item
12134         """
12135         return _core_.GBSizerItem_GetSpan(*args, **kwargs)
12136
12137     def GetSpanTuple(self): return self.GetSpan().Get()
12138     def SetPos(*args, **kwargs):
12139         """
12140         SetPos(self, GBPosition pos) -> bool
12141
12142         If the item is already a member of a sizer then first ensure that
12143         there is no other item that would intersect with this one at the new
12144         position, then set the new position.  Returns True if the change is
12145         successful and after the next Layout() the item will be moved.
12146         """
12147         return _core_.GBSizerItem_SetPos(*args, **kwargs)
12148
12149     def SetSpan(*args, **kwargs):
12150         """
12151         SetSpan(self, GBSpan span) -> bool
12152
12153         If the item is already a member of a sizer then first ensure that
12154         there is no other item that would intersect with this one with its new
12155         spanning size, then set the new spanning.  Returns True if the change
12156         is successful and after the next Layout() the item will be resized.
12157
12158         """
12159         return _core_.GBSizerItem_SetSpan(*args, **kwargs)
12160
12161     def Intersects(*args, **kwargs):
12162         """
12163         Intersects(self, GBSizerItem other) -> bool
12164
12165         Returns True if this item and the other item instersect.
12166         """
12167         return _core_.GBSizerItem_Intersects(*args, **kwargs)
12168
12169     def IntersectsPos(*args, **kwargs):
12170         """
12171         IntersectsPos(self, GBPosition pos, GBSpan span) -> bool
12172
12173         Returns True if the given pos/span would intersect with this item.
12174         """
12175         return _core_.GBSizerItem_IntersectsPos(*args, **kwargs)
12176
12177     def GetEndPos(*args, **kwargs):
12178         """
12179         GetEndPos(self) -> GBPosition
12180
12181         Get the row and column of the endpoint of this item.
12182         """
12183         return _core_.GBSizerItem_GetEndPos(*args, **kwargs)
12184
12185     def GetGBSizer(*args, **kwargs):
12186         """
12187         GetGBSizer(self) -> GridBagSizer
12188
12189         Get the sizer this item is a member of.
12190         """
12191         return _core_.GBSizerItem_GetGBSizer(*args, **kwargs)
12192
12193     def SetGBSizer(*args, **kwargs):
12194         """
12195         SetGBSizer(self, GridBagSizer sizer)
12196
12197         Set the sizer this item is a member of.
12198         """
12199         return _core_.GBSizerItem_SetGBSizer(*args, **kwargs)
12200
12201 _core_.GBSizerItem_swigregister(GBSizerItem)
12202 DefaultSpan = cvar.DefaultSpan
12203
12204 def GBSizerItemWindow(*args, **kwargs):
12205     """
12206     GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag,
12207         int border, PyObject userData=None) -> GBSizerItem
12208
12209     Construct a `wx.GBSizerItem` for a window.
12210     """
12211     val = _core_.new_GBSizerItemWindow(*args, **kwargs)
12212     return val
12213
12214 def GBSizerItemSizer(*args, **kwargs):
12215     """
12216     GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag,
12217         int border, PyObject userData=None) -> GBSizerItem
12218
12219     Construct a `wx.GBSizerItem` for a sizer
12220     """
12221     val = _core_.new_GBSizerItemSizer(*args, **kwargs)
12222     return val
12223
12224 def GBSizerItemSpacer(*args, **kwargs):
12225     """
12226     GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span,
12227         int flag, int border, PyObject userData=None) -> GBSizerItem
12228
12229     Construct a `wx.GBSizerItem` for a spacer.
12230     """
12231     val = _core_.new_GBSizerItemSpacer(*args, **kwargs)
12232     return val
12233
12234 class GridBagSizer(FlexGridSizer):
12235     """
12236     A `wx.Sizer` that can lay out items in a virtual grid like a
12237     `wx.FlexGridSizer` but in this case explicit positioning of the items
12238     is allowed using `wx.GBPosition`, and items can optionally span more
12239     than one row and/or column using `wx.GBSpan`.  The total size of the
12240     virtual grid is determined by the largest row and column that items are
12241     positioned at, adjusted for spanning.
12242
12243     """
12244     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12245     __repr__ = _swig_repr
12246     def __init__(self, *args, **kwargs):
12247         """
12248         __init__(self, int vgap=0, int hgap=0) -> GridBagSizer
12249
12250         Constructor, with optional parameters to specify the gap between the
12251         rows and columns.
12252         """
12253         _core_.GridBagSizer_swiginit(self,_core_.new_GridBagSizer(*args, **kwargs))
12254         self._setOORInfo(self)
12255
12256     def Add(*args, **kwargs):
12257         """
12258         Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=0,
12259         int border=0, userData=None) -> wx.GBSizerItem
12260
12261         Adds an item to the sizer at the grid cell *pos*, optionally spanning
12262         more than one row or column as specified with *span*.  The remaining
12263         args behave similarly to `wx.Sizer.Add`.
12264
12265         Returns True if the item was successfully placed at the given cell
12266         position, False if something was already there.
12267
12268         """
12269         return _core_.GridBagSizer_Add(*args, **kwargs)
12270
12271     def AddItem(*args, **kwargs):
12272         """
12273         Add(self, GBSizerItem item) -> wx.GBSizerItem
12274
12275         Add an item to the sizer using a `wx.GBSizerItem`.  Returns True if
12276         the item was successfully placed at its given cell position, False if
12277         something was already there.
12278         """
12279         return _core_.GridBagSizer_AddItem(*args, **kwargs)
12280
12281     def GetCellSize(*args, **kwargs):
12282         """
12283         GetCellSize(self, int row, int col) -> Size
12284
12285         Get the size of the specified cell, including hgap and
12286         vgap.  Only valid after a Layout.
12287         """
12288         return _core_.GridBagSizer_GetCellSize(*args, **kwargs)
12289
12290     def GetEmptyCellSize(*args, **kwargs):
12291         """
12292         GetEmptyCellSize(self) -> Size
12293
12294         Get the size used for cells in the grid with no item.
12295         """
12296         return _core_.GridBagSizer_GetEmptyCellSize(*args, **kwargs)
12297
12298     def SetEmptyCellSize(*args, **kwargs):
12299         """
12300         SetEmptyCellSize(self, Size sz)
12301
12302         Set the size used for cells in the grid with no item.
12303         """
12304         return _core_.GridBagSizer_SetEmptyCellSize(*args, **kwargs)
12305
12306     def GetItemPosition(*args):
12307         """
12308         GetItemPosition(self, item) -> GBPosition
12309
12310         Get the grid position of the specified *item* where *item* is either a
12311         window or subsizer that is a member of this sizer, or a zero-based
12312         index of an item.
12313         """
12314         return _core_.GridBagSizer_GetItemPosition(*args)
12315
12316     def SetItemPosition(*args):
12317         """
12318         SetItemPosition(self, item, GBPosition pos) -> bool
12319
12320         Set the grid position of the specified *item* where *item* is either a
12321         window or subsizer that is a member of this sizer, or a zero-based
12322         index of an item.  Returns True on success.  If the move is not
12323         allowed (because an item is already there) then False is returned.
12324
12325         """
12326         return _core_.GridBagSizer_SetItemPosition(*args)
12327
12328     def GetItemSpan(*args):
12329         """
12330         GetItemSpan(self, item) -> GBSpan
12331
12332         Get the row/col spanning of the specified *item* where *item* is
12333         either a window or subsizer that is a member of this sizer, or a
12334         zero-based index of an item.
12335         """
12336         return _core_.GridBagSizer_GetItemSpan(*args)
12337
12338     def SetItemSpan(*args):
12339         """
12340         SetItemSpan(self, item, GBSpan span) -> bool
12341
12342         Set the row/col spanning of the specified *item* where *item* is
12343         either a window or subsizer that is a member of this sizer, or a
12344         zero-based index of an item.  Returns True on success.  If the move is
12345         not allowed (because an item is already there) then False is returned.
12346         """
12347         return _core_.GridBagSizer_SetItemSpan(*args)
12348
12349     def FindItem(*args):
12350         """
12351         FindItem(self, item) -> GBSizerItem
12352
12353         Find the sizer item for the given window or subsizer, returns None if
12354         not found. (non-recursive)
12355         """
12356         return _core_.GridBagSizer_FindItem(*args)
12357
12358     def FindItemAtPosition(*args, **kwargs):
12359         """
12360         FindItemAtPosition(self, GBPosition pos) -> GBSizerItem
12361
12362         Return the sizer item for the given grid cell, or None if there is no
12363         item at that position. (non-recursive)
12364         """
12365         return _core_.GridBagSizer_FindItemAtPosition(*args, **kwargs)
12366
12367     def FindItemAtPoint(*args, **kwargs):
12368         """
12369         FindItemAtPoint(self, Point pt) -> GBSizerItem
12370
12371         Return the sizer item located at the point given in *pt*, or None if
12372         there is no item at that point. The (x,y) coordinates in pt correspond
12373         to the client coordinates of the window using the sizer for
12374         layout. (non-recursive)
12375         """
12376         return _core_.GridBagSizer_FindItemAtPoint(*args, **kwargs)
12377
12378     def CheckForIntersection(*args, **kwargs):
12379         """
12380         CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool
12381
12382         Look at all items and see if any intersect (or would overlap) the
12383         given *item*.  Returns True if so, False if there would be no overlap.
12384         If an *excludeItem* is given then it will not be checked for
12385         intersection, for example it may be the item we are checking the
12386         position of.
12387
12388         """
12389         return _core_.GridBagSizer_CheckForIntersection(*args, **kwargs)
12390
12391     def CheckForIntersectionPos(*args, **kwargs):
12392         """
12393         CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool
12394
12395         Look at all items and see if any intersect (or would overlap) the
12396         given position and span.  Returns True if so, False if there would be
12397         no overlap.  If an *excludeItem* is given then it will not be checked
12398         for intersection, for example it may be the item we are checking the
12399         position of.
12400         """
12401         return _core_.GridBagSizer_CheckForIntersectionPos(*args, **kwargs)
12402
12403 _core_.GridBagSizer_swigregister(GridBagSizer)
12404
12405 #---------------------------------------------------------------------------
12406
12407 Left = _core_.Left
12408 Top = _core_.Top
12409 Right = _core_.Right
12410 Bottom = _core_.Bottom
12411 Width = _core_.Width
12412 Height = _core_.Height
12413 Centre = _core_.Centre
12414 Center = _core_.Center
12415 CentreX = _core_.CentreX
12416 CentreY = _core_.CentreY
12417 Unconstrained = _core_.Unconstrained
12418 AsIs = _core_.AsIs
12419 PercentOf = _core_.PercentOf
12420 Above = _core_.Above
12421 Below = _core_.Below
12422 LeftOf = _core_.LeftOf
12423 RightOf = _core_.RightOf
12424 SameAs = _core_.SameAs
12425 Absolute = _core_.Absolute
12426 class IndividualLayoutConstraint(Object):
12427     """
12428     Objects of this class are stored in the `wx.LayoutConstraints` class as
12429     one of eight possible constraints that a window can be involved in.
12430     You will never need to create an instance of
12431     wx.IndividualLayoutConstraint, rather you should create a
12432     `wx.LayoutConstraints` instance and use the individual contstraints
12433     that it contains.
12434     """
12435     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12436     def __init__(self): raise AttributeError, "No constructor defined"
12437     __repr__ = _swig_repr
12438     def Set(*args, **kwargs):
12439         """
12440         Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN)
12441
12442         Sets the properties of the constraint. Normally called by one of the
12443         convenience functions such as Above, RightOf, SameAs.
12444         """
12445         return _core_.IndividualLayoutConstraint_Set(*args, **kwargs)
12446
12447     def LeftOf(*args, **kwargs):
12448         """
12449         LeftOf(self, Window sibling, int marg=0)
12450
12451         Constrains this edge to be to the left of the given window, with an
12452         optional margin. Implicitly, this is relative to the left edge of the
12453         other window.
12454         """
12455         return _core_.IndividualLayoutConstraint_LeftOf(*args, **kwargs)
12456
12457     def RightOf(*args, **kwargs):
12458         """
12459         RightOf(self, Window sibling, int marg=0)
12460
12461         Constrains this edge to be to the right of the given window, with an
12462         optional margin. Implicitly, this is relative to the right edge of the
12463         other window.
12464         """
12465         return _core_.IndividualLayoutConstraint_RightOf(*args, **kwargs)
12466
12467     def Above(*args, **kwargs):
12468         """
12469         Above(self, Window sibling, int marg=0)
12470
12471         Constrains this edge to be above the given window, with an optional
12472         margin. Implicitly, this is relative to the top edge of the other
12473         window.
12474         """
12475         return _core_.IndividualLayoutConstraint_Above(*args, **kwargs)
12476
12477     def Below(*args, **kwargs):
12478         """
12479         Below(self, Window sibling, int marg=0)
12480
12481         Constrains this edge to be below the given window, with an optional
12482         margin. Implicitly, this is relative to the bottom edge of the other
12483         window.
12484         """
12485         return _core_.IndividualLayoutConstraint_Below(*args, **kwargs)
12486
12487     def SameAs(*args, **kwargs):
12488         """
12489         SameAs(self, Window otherW, int edge, int marg=0)
12490
12491         Constrains this edge or dimension to be to the same as the edge of the
12492         given window, with an optional margin.
12493         """
12494         return _core_.IndividualLayoutConstraint_SameAs(*args, **kwargs)
12495
12496     def PercentOf(*args, **kwargs):
12497         """
12498         PercentOf(self, Window otherW, int wh, int per)
12499
12500         Constrains this edge or dimension to be to a percentage of the given
12501         window, with an optional margin.
12502         """
12503         return _core_.IndividualLayoutConstraint_PercentOf(*args, **kwargs)
12504
12505     def Absolute(*args, **kwargs):
12506         """
12507         Absolute(self, int val)
12508
12509         Constrains this edge or dimension to be the given absolute value.
12510         """
12511         return _core_.IndividualLayoutConstraint_Absolute(*args, **kwargs)
12512
12513     def Unconstrained(*args, **kwargs):
12514         """
12515         Unconstrained(self)
12516
12517         Sets this edge or dimension to be unconstrained, that is, dependent on
12518         other edges and dimensions from which this value can be deduced.
12519         """
12520         return _core_.IndividualLayoutConstraint_Unconstrained(*args, **kwargs)
12521
12522     def AsIs(*args, **kwargs):
12523         """
12524         AsIs(self)
12525
12526         Sets this edge or constraint to be whatever the window's value is at
12527         the moment. If either of the width and height constraints are *as is*,
12528         the window will not be resized, but moved instead. This is important
12529         when considering panel items which are intended to have a default
12530         size, such as a button, which may take its size from the size of the
12531         button label.
12532         """
12533         return _core_.IndividualLayoutConstraint_AsIs(*args, **kwargs)
12534
12535     def GetOtherWindow(*args, **kwargs):
12536         """GetOtherWindow(self) -> Window"""
12537         return _core_.IndividualLayoutConstraint_GetOtherWindow(*args, **kwargs)
12538
12539     def GetMyEdge(*args, **kwargs):
12540         """GetMyEdge(self) -> int"""
12541         return _core_.IndividualLayoutConstraint_GetMyEdge(*args, **kwargs)
12542
12543     def SetEdge(*args, **kwargs):
12544         """SetEdge(self, int which)"""
12545         return _core_.IndividualLayoutConstraint_SetEdge(*args, **kwargs)
12546
12547     def SetValue(*args, **kwargs):
12548         """SetValue(self, int v)"""
12549         return _core_.IndividualLayoutConstraint_SetValue(*args, **kwargs)
12550
12551     def GetMargin(*args, **kwargs):
12552         """GetMargin(self) -> int"""
12553         return _core_.IndividualLayoutConstraint_GetMargin(*args, **kwargs)
12554
12555     def SetMargin(*args, **kwargs):
12556         """SetMargin(self, int m)"""
12557         return _core_.IndividualLayoutConstraint_SetMargin(*args, **kwargs)
12558
12559     def GetValue(*args, **kwargs):
12560         """GetValue(self) -> int"""
12561         return _core_.IndividualLayoutConstraint_GetValue(*args, **kwargs)
12562
12563     def GetPercent(*args, **kwargs):
12564         """GetPercent(self) -> int"""
12565         return _core_.IndividualLayoutConstraint_GetPercent(*args, **kwargs)
12566
12567     def GetOtherEdge(*args, **kwargs):
12568         """GetOtherEdge(self) -> int"""
12569         return _core_.IndividualLayoutConstraint_GetOtherEdge(*args, **kwargs)
12570
12571     def GetDone(*args, **kwargs):
12572         """GetDone(self) -> bool"""
12573         return _core_.IndividualLayoutConstraint_GetDone(*args, **kwargs)
12574
12575     def SetDone(*args, **kwargs):
12576         """SetDone(self, bool d)"""
12577         return _core_.IndividualLayoutConstraint_SetDone(*args, **kwargs)
12578
12579     def GetRelationship(*args, **kwargs):
12580         """GetRelationship(self) -> int"""
12581         return _core_.IndividualLayoutConstraint_GetRelationship(*args, **kwargs)
12582
12583     def SetRelationship(*args, **kwargs):
12584         """SetRelationship(self, int r)"""
12585         return _core_.IndividualLayoutConstraint_SetRelationship(*args, **kwargs)
12586
12587     def ResetIfWin(*args, **kwargs):
12588         """
12589         ResetIfWin(self, Window otherW) -> bool
12590
12591         Reset constraint if it mentions otherWin
12592         """
12593         return _core_.IndividualLayoutConstraint_ResetIfWin(*args, **kwargs)
12594
12595     def SatisfyConstraint(*args, **kwargs):
12596         """
12597         SatisfyConstraint(self, LayoutConstraints constraints, Window win) -> bool
12598
12599         Try to satisfy constraint
12600         """
12601         return _core_.IndividualLayoutConstraint_SatisfyConstraint(*args, **kwargs)
12602
12603     def GetEdge(*args, **kwargs):
12604         """
12605         GetEdge(self, int which, Window thisWin, Window other) -> int
12606
12607         Get the value of this edge or dimension, or if this
12608         is not determinable, -1.
12609         """
12610         return _core_.IndividualLayoutConstraint_GetEdge(*args, **kwargs)
12611
12612 _core_.IndividualLayoutConstraint_swigregister(IndividualLayoutConstraint)
12613
12614 class LayoutConstraints(Object):
12615     """
12616     **Note:** constraints are now deprecated and you should use sizers
12617     instead.
12618
12619     Objects of this class can be associated with a window to define its
12620     layout constraints, with respect to siblings or its parent.
12621
12622     The class consists of the following eight constraints of class
12623     wx.IndividualLayoutConstraint, some or all of which should be accessed
12624     directly to set the appropriate constraints.
12625
12626         * left: represents the left hand edge of the window
12627         * right: represents the right hand edge of the window
12628         * top: represents the top edge of the window
12629         * bottom: represents the bottom edge of the window
12630         * width: represents the width of the window
12631         * height: represents the height of the window
12632         * centreX: represents the horizontal centre point of the window
12633         * centreY: represents the vertical centre point of the window
12634
12635     Most constraints are initially set to have the relationship
12636     wxUnconstrained, which means that their values should be calculated by
12637     looking at known constraints. The exceptions are width and height,
12638     which are set to wxAsIs to ensure that if the user does not specify a
12639     constraint, the existing width and height will be used, to be
12640     compatible with panel items which often have take a default size. If
12641     the constraint is ``wx.AsIs``, the dimension will not be changed.
12642
12643     :see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints`
12644
12645     """
12646     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12647     __repr__ = _swig_repr
12648     left = property(_core_.LayoutConstraints_left_get)
12649     top = property(_core_.LayoutConstraints_top_get)
12650     right = property(_core_.LayoutConstraints_right_get)
12651     bottom = property(_core_.LayoutConstraints_bottom_get)
12652     width = property(_core_.LayoutConstraints_width_get)
12653     height = property(_core_.LayoutConstraints_height_get)
12654     centreX = property(_core_.LayoutConstraints_centreX_get)
12655     centreY = property(_core_.LayoutConstraints_centreY_get)
12656     def __init__(self, *args, **kwargs):
12657         """__init__(self) -> LayoutConstraints"""
12658         _core_.LayoutConstraints_swiginit(self,_core_.new_LayoutConstraints(*args, **kwargs))
12659     __swig_destroy__ = _core_.delete_LayoutConstraints
12660     __del__ = lambda self : None;
12661     def SatisfyConstraints(*args, **kwargs):
12662         """SatisfyConstraints(Window win) -> (areSatisfied, noChanges)"""
12663         return _core_.LayoutConstraints_SatisfyConstraints(*args, **kwargs)
12664
12665     def AreSatisfied(*args, **kwargs):
12666         """AreSatisfied(self) -> bool"""
12667         return _core_.LayoutConstraints_AreSatisfied(*args, **kwargs)
12668
12669 _core_.LayoutConstraints_swigregister(LayoutConstraints)
12670
12671 #----------------------------------------------------------------------------
12672
12673 # Use Python's bool constants if available, make some if not
12674 try:
12675     True
12676 except NameError:
12677     __builtins__.True = 1==1
12678     __builtins__.False = 1==0
12679     def bool(value): return not not value
12680     __builtins__.bool = bool
12681
12682
12683
12684 # workarounds for bad wxRTTI names
12685 __wxPyPtrTypeMap['wxGauge95']    = 'wxGauge'
12686 __wxPyPtrTypeMap['wxSlider95']   = 'wxSlider'
12687 __wxPyPtrTypeMap['wxStatusBar95']   = 'wxStatusBar'
12688
12689
12690 #----------------------------------------------------------------------------
12691 # Load version numbers from __version__...  Ensure that major and minor
12692 # versions are the same for both wxPython and wxWidgets.
12693
12694 from __version__ import *
12695 __version__ = VERSION_STRING
12696
12697 assert MAJOR_VERSION == _core_.MAJOR_VERSION, "wxPython/wxWidgets version mismatch"
12698 assert MINOR_VERSION == _core_.MINOR_VERSION, "wxPython/wxWidgets version mismatch"
12699 if RELEASE_VERSION != _core_.RELEASE_VERSION:
12700     import warnings
12701     warnings.warn("wxPython/wxWidgets release number mismatch")
12702
12703 #----------------------------------------------------------------------------
12704
12705 # Set wxPython's default string<-->unicode conversion encoding from
12706 # the locale, but only if Python's default hasn't been changed.  (We
12707 # assume that if the user has customized it already then that is the
12708 # encoding we need to use as well.)
12709 #
12710 # The encoding selected here is used when string or unicode objects
12711 # need to be converted in order to pass them to wxWidgets.  Please be
12712 # aware that the default encoding within the same locale may be
12713 # slightly different on different platforms.  For example, please see
12714 # http://www.alanwood.net/demos/charsetdiffs.html for differences
12715 # between the common latin/roman encodings.
12716
12717 default = _sys.getdefaultencoding()
12718 if default == 'ascii':
12719     import locale
12720     import codecs
12721     try:
12722         default = locale.getdefaultlocale()[1]
12723         codecs.lookup(default)
12724     except (ValueError, LookupError, TypeError):
12725         default = _sys.getdefaultencoding()
12726     del locale
12727     del codecs
12728 if default:
12729     wx.SetDefaultPyEncoding(default)
12730 del default
12731
12732 #----------------------------------------------------------------------------
12733
12734 class PyDeadObjectError(AttributeError):
12735     pass
12736
12737 class _wxPyDeadObject(object):
12738     """
12739     Instances of wx objects that are OOR capable will have their __class__
12740     changed to this class when the C++ object is deleted.  This should help
12741     prevent crashes due to referencing a bogus C++ pointer.
12742     """
12743     reprStr = "wxPython wrapper for DELETED %s object! (The C++ object no longer exists.)"
12744     attrStr = "The C++ part of the %s object has been deleted, attribute access no longer allowed."
12745
12746     def __repr__(self):
12747         if not hasattr(self, "_name"):
12748             self._name = "[unknown]"
12749         return self.reprStr % self._name
12750
12751     def __getattr__(self, *args):
12752         if not hasattr(self, "_name"):
12753             self._name = "[unknown]"
12754         raise PyDeadObjectError(self.attrStr % self._name)
12755
12756     def __nonzero__(self):
12757         return 0
12758
12759
12760
12761 class PyUnbornObjectError(AttributeError):
12762     pass
12763
12764 class _wxPyUnbornObject(object):
12765     """
12766     Some stock objects are created when the wx._core module is
12767     imported, but their C++ instance is not created until the wx.App
12768     object is created and initialized.  These object instances will
12769     temporarily have their __class__ changed to this class so an
12770     exception will be raised if they are used before the C++ instance
12771     is ready.
12772     """
12773
12774     reprStr = "wxPython wrapper for UNBORN object! (The C++ object is not initialized yet.)"
12775     attrStr = "The C++ part of this object has not been initialized, attribute access not allowed."
12776
12777     def __repr__(self):
12778         #if not hasattr(self, "_name"):
12779         #    self._name = "[unknown]"
12780         return self.reprStr #% self._name
12781
12782     def __getattr__(self, *args):
12783         #if not hasattr(self, "_name"):
12784         #    self._name = "[unknown]"
12785         raise PyUnbornObjectError(self.attrStr) # % self._name )
12786
12787     def __nonzero__(self):
12788         return 0
12789
12790
12791 #----------------------------------------------------------------------------
12792
12793 def CallAfter(callable, *args, **kw):
12794     """
12795     Call the specified function after the current and pending event
12796     handlers have been completed.  This is also good for making GUI
12797     method calls from non-GUI threads.  Any extra positional or
12798     keyword args are passed on to the callable when it is called.
12799
12800     :see: `wx.FutureCall`
12801     """
12802     app = wx.GetApp()
12803     assert app is not None, 'No wx.App created yet'
12804
12805     if not hasattr(app, "_CallAfterId"):
12806         app._CallAfterId = wx.NewEventType()
12807         app.Connect(-1, -1, app._CallAfterId,
12808                     lambda event: event.callable(*event.args, **event.kw) )
12809     evt = wx.PyEvent()
12810     evt.SetEventType(app._CallAfterId)
12811     evt.callable = callable
12812     evt.args = args
12813     evt.kw = kw
12814     wx.PostEvent(app, evt)
12815
12816 #----------------------------------------------------------------------------
12817
12818
12819 class FutureCall:
12820     """
12821     A convenience class for `wx.Timer`, that calls the given callable
12822     object once after the given amount of milliseconds, passing any
12823     positional or keyword args.  The return value of the callable is
12824     availbale after it has been run with the `GetResult` method.
12825
12826     If you don't need to get the return value or restart the timer
12827     then there is no need to hold a reference to this object.  It will
12828     hold a reference to itself while the timer is running (the timer
12829     has a reference to self.Notify) but the cycle will be broken when
12830     the timer completes, automatically cleaning up the wx.FutureCall
12831     object.
12832
12833     :see: `wx.CallAfter`
12834     """
12835     def __init__(self, millis, callable, *args, **kwargs):
12836         self.millis = millis
12837         self.callable = callable
12838         self.SetArgs(*args, **kwargs)
12839         self.runCount = 0
12840         self.running = False
12841         self.hasRun = False
12842         self.result = None
12843         self.timer = None
12844         self.Start()
12845
12846     def __del__(self):
12847         self.Stop()
12848
12849
12850     def Start(self, millis=None, *args, **kwargs):
12851         """
12852         (Re)start the timer
12853         """
12854         self.hasRun = False
12855         if millis is not None:
12856             self.millis = millis
12857         if args or kwargs:
12858             self.SetArgs(*args, **kwargs)
12859         self.Stop()
12860         self.timer = wx.PyTimer(self.Notify)
12861         self.timer.Start(self.millis, wx.TIMER_ONE_SHOT)
12862         self.running = True
12863     Restart = Start
12864
12865
12866     def Stop(self):
12867         """
12868         Stop and destroy the timer.
12869         """
12870         if self.timer is not None:
12871             self.timer.Stop()
12872             self.timer = None
12873
12874
12875     def GetInterval(self):
12876         if self.timer is not None:
12877             return self.timer.GetInterval()
12878         else:
12879             return 0
12880
12881
12882     def IsRunning(self):
12883         return self.timer is not None and self.timer.IsRunning()
12884
12885
12886     def SetArgs(self, *args, **kwargs):
12887         """
12888         (Re)set the args passed to the callable object.  This is
12889         useful in conjunction with Restart if you want to schedule a
12890         new call to the same callable object but with different
12891         parameters.
12892         """
12893         self.args = args
12894         self.kwargs = kwargs
12895
12896
12897     def HasRun(self):
12898         return self.hasRun
12899
12900     def GetResult(self):
12901         return self.result
12902
12903     def Notify(self):
12904         """
12905         The timer has expired so call the callable.
12906         """
12907         if self.callable and getattr(self.callable, 'im_self', True):
12908             self.runCount += 1
12909             self.running = False
12910             self.result = self.callable(*self.args, **self.kwargs)
12911         self.hasRun = True
12912         if not self.running:
12913             # if it wasn't restarted, then cleanup
12914             wx.CallAfter(self.Stop)
12915
12916
12917
12918 #----------------------------------------------------------------------------
12919 # Control which items in this module should be documented by epydoc.
12920 # We allow only classes and functions, which will help reduce the size
12921 # of the docs by filtering out the zillions of constants, EVT objects,
12922 # and etc that don't make much sense by themselves, but are instead
12923 # documented (or will be) as part of the classes/functions/methods
12924 # where they should be used.
12925
12926 class __DocFilter:
12927     """
12928     A filter for epydoc that only allows non-Ptr classes and
12929     functions, in order to reduce the clutter in the API docs.
12930     """
12931     def __init__(self, globals):
12932         self._globals = globals
12933
12934     def __call__(self, name):
12935         import types
12936         obj = self._globals.get(name, None)
12937
12938         # only document classes and function
12939         if type(obj) not in [type, types.ClassType, types.FunctionType, types.BuiltinFunctionType]:
12940             return False
12941
12942         # skip other things that are private or will be documented as part of somethign else
12943         if name.startswith('_') or name.startswith('EVT') or name.endswith('_swigregister')  or name.endswith('Ptr') :
12944             return False
12945
12946         # skip functions that are duplicates of static functions in a class
12947         if name.find('_') != -1:
12948             cls = self._globals.get(name.split('_')[0], None)
12949             methname = name.split('_')[1]
12950             if hasattr(cls, methname) and type(getattr(cls, methname)) is types.FunctionType:
12951                 return False
12952
12953         return True
12954
12955 #----------------------------------------------------------------------------
12956 #----------------------------------------------------------------------------
12957
12958 # Import other modules in this package that should show up in the
12959 # "core" wx namespace
12960 from _gdi import *
12961 from _windows import *
12962 from _controls import *
12963 from _misc import *
12964
12965 #----------------------------------------------------------------------------
12966 #----------------------------------------------------------------------------
12967
12968
12969