wxPython/src/gtk/_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_PAGE_SETUP = _core_.ID_PAGE_SETUP
 198 ID_PREVIEW = _core_.ID_PREVIEW
 199 ID_ABOUT = _core_.ID_ABOUT
 200 ID_HELP_CONTENTS = _core_.ID_HELP_CONTENTS
 201 ID_HELP_COMMANDS = _core_.ID_HELP_COMMANDS
 202 ID_HELP_PROCEDURES = _core_.ID_HELP_PROCEDURES
 203 ID_HELP_CONTEXT = _core_.ID_HELP_CONTEXT
 204 ID_HELP_INDEX = _core_.ID_HELP_INDEX
 205 ID_HELP_SEARCH = _core_.ID_HELP_SEARCH
 206 ID_CLOSE_ALL = _core_.ID_CLOSE_ALL
 207 ID_PREFERENCES = _core_.ID_PREFERENCES
 208 ID_EDIT = _core_.ID_EDIT
 209 ID_CUT = _core_.ID_CUT
 210 ID_COPY = _core_.ID_COPY
 211 ID_PASTE = _core_.ID_PASTE
 212 ID_CLEAR = _core_.ID_CLEAR
 213 ID_FIND = _core_.ID_FIND
 214 ID_DUPLICATE = _core_.ID_DUPLICATE
 215 ID_SELECTALL = _core_.ID_SELECTALL
 216 ID_DELETE = _core_.ID_DELETE
 217 ID_REPLACE = _core_.ID_REPLACE
 218 ID_REPLACE_ALL = _core_.ID_REPLACE_ALL
 219 ID_PROPERTIES = _core_.ID_PROPERTIES
 220 ID_VIEW_DETAILS = _core_.ID_VIEW_DETAILS
 221 ID_VIEW_LARGEICONS = _core_.ID_VIEW_LARGEICONS
 222 ID_VIEW_SMALLICONS = _core_.ID_VIEW_SMALLICONS
 223 ID_VIEW_LIST = _core_.ID_VIEW_LIST
 224 ID_VIEW_SORTDATE = _core_.ID_VIEW_SORTDATE
 225 ID_VIEW_SORTNAME = _core_.ID_VIEW_SORTNAME
 226 ID_VIEW_SORTSIZE = _core_.ID_VIEW_SORTSIZE
 227 ID_VIEW_SORTTYPE = _core_.ID_VIEW_SORTTYPE
 228 ID_FILE = _core_.ID_FILE
 229 ID_FILE1 = _core_.ID_FILE1
 230 ID_FILE2 = _core_.ID_FILE2
 231 ID_FILE3 = _core_.ID_FILE3
 232 ID_FILE4 = _core_.ID_FILE4
 233 ID_FILE5 = _core_.ID_FILE5
 234 ID_FILE6 = _core_.ID_FILE6
 235 ID_FILE7 = _core_.ID_FILE7
 236 ID_FILE8 = _core_.ID_FILE8
 237 ID_FILE9 = _core_.ID_FILE9
 238 ID_OK = _core_.ID_OK
 239 ID_CANCEL = _core_.ID_CANCEL
 240 ID_APPLY = _core_.ID_APPLY
 241 ID_YES = _core_.ID_YES
 242 ID_NO = _core_.ID_NO
 243 ID_STATIC = _core_.ID_STATIC
 244 ID_FORWARD = _core_.ID_FORWARD
 245 ID_BACKWARD = _core_.ID_BACKWARD
 246 ID_DEFAULT = _core_.ID_DEFAULT
 247 ID_MORE = _core_.ID_MORE
 248 ID_SETUP = _core_.ID_SETUP
 249 ID_RESET = _core_.ID_RESET
 250 ID_CONTEXT_HELP = _core_.ID_CONTEXT_HELP
 251 ID_YESTOALL = _core_.ID_YESTOALL
 252 ID_NOTOALL = _core_.ID_NOTOALL
 253 ID_ABORT = _core_.ID_ABORT
 254 ID_RETRY = _core_.ID_RETRY
 255 ID_IGNORE = _core_.ID_IGNORE
 256 ID_ADD = _core_.ID_ADD
 257 ID_REMOVE = _core_.ID_REMOVE
 258 ID_UP = _core_.ID_UP
 259 ID_DOWN = _core_.ID_DOWN
 260 ID_HOME = _core_.ID_HOME
 261 ID_REFRESH = _core_.ID_REFRESH
 262 ID_STOP = _core_.ID_STOP
 263 ID_INDEX = _core_.ID_INDEX
 264 ID_BOLD = _core_.ID_BOLD
 265 ID_ITALIC = _core_.ID_ITALIC
 266 ID_JUSTIFY_CENTER = _core_.ID_JUSTIFY_CENTER
 267 ID_JUSTIFY_FILL = _core_.ID_JUSTIFY_FILL
 268 ID_JUSTIFY_RIGHT = _core_.ID_JUSTIFY_RIGHT
 269 ID_JUSTIFY_LEFT = _core_.ID_JUSTIFY_LEFT
 270 ID_UNDERLINE = _core_.ID_UNDERLINE
 271 ID_INDENT = _core_.ID_INDENT
 272 ID_UNINDENT = _core_.ID_UNINDENT
 273 ID_ZOOM_100 = _core_.ID_ZOOM_100
 274 ID_ZOOM_FIT = _core_.ID_ZOOM_FIT
 275 ID_ZOOM_IN = _core_.ID_ZOOM_IN
 276 ID_ZOOM_OUT = _core_.ID_ZOOM_OUT
 277 ID_UNDELETE = _core_.ID_UNDELETE
 278 ID_REVERT_TO_SAVED = _core_.ID_REVERT_TO_SAVED
 279 ID_HIGHEST = _core_.ID_HIGHEST
 280 MENU_TEAROFF = _core_.MENU_TEAROFF
 281 MB_DOCKABLE = _core_.MB_DOCKABLE
 282 NO_FULL_REPAINT_ON_RESIZE = _core_.NO_FULL_REPAINT_ON_RESIZE
 283 FULL_REPAINT_ON_RESIZE = _core_.FULL_REPAINT_ON_RESIZE
 284 LI_HORIZONTAL = _core_.LI_HORIZONTAL
 285 LI_VERTICAL = _core_.LI_VERTICAL
 286 WS_EX_VALIDATE_RECURSIVELY = _core_.WS_EX_VALIDATE_RECURSIVELY
 287 WS_EX_BLOCK_EVENTS = _core_.WS_EX_BLOCK_EVENTS
 288 WS_EX_TRANSIENT = _core_.WS_EX_TRANSIENT
 289 WS_EX_THEMED_BACKGROUND = _core_.WS_EX_THEMED_BACKGROUND
 290 WS_EX_PROCESS_IDLE = _core_.WS_EX_PROCESS_IDLE
 291 WS_EX_PROCESS_UI_UPDATES = _core_.WS_EX_PROCESS_UI_UPDATES
 292 MM_TEXT = _core_.MM_TEXT
 293 MM_LOMETRIC = _core_.MM_LOMETRIC
 294 MM_HIMETRIC = _core_.MM_HIMETRIC
 295 MM_LOENGLISH = _core_.MM_LOENGLISH
 296 MM_HIENGLISH = _core_.MM_HIENGLISH
 297 MM_TWIPS = _core_.MM_TWIPS
 298 MM_ISOTROPIC = _core_.MM_ISOTROPIC
 299 MM_ANISOTROPIC = _core_.MM_ANISOTROPIC
 300 MM_POINTS = _core_.MM_POINTS
 301 MM_METRIC = _core_.MM_METRIC
 302 CENTRE = _core_.CENTRE
 303 CENTER = _core_.CENTER
 304 HORIZONTAL = _core_.HORIZONTAL
 305 VERTICAL = _core_.VERTICAL
 306 BOTH = _core_.BOTH
 307 LEFT = _core_.LEFT
 308 RIGHT = _core_.RIGHT
 309 UP = _core_.UP
 310 DOWN = _core_.DOWN
 311 TOP = _core_.TOP
 312 BOTTOM = _core_.BOTTOM
 313 NORTH = _core_.NORTH
 314 SOUTH = _core_.SOUTH
 315 WEST = _core_.WEST
 316 EAST = _core_.EAST
 317 ALL = _core_.ALL
 318 ALIGN_NOT = _core_.ALIGN_NOT
 319 ALIGN_CENTER_HORIZONTAL = _core_.ALIGN_CENTER_HORIZONTAL
 320 ALIGN_CENTRE_HORIZONTAL = _core_.ALIGN_CENTRE_HORIZONTAL
 321 ALIGN_LEFT = _core_.ALIGN_LEFT
 322 ALIGN_TOP = _core_.ALIGN_TOP
 323 ALIGN_RIGHT = _core_.ALIGN_RIGHT
 324 ALIGN_BOTTOM = _core_.ALIGN_BOTTOM
 325 ALIGN_CENTER_VERTICAL = _core_.ALIGN_CENTER_VERTICAL
 326 ALIGN_CENTRE_VERTICAL = _core_.ALIGN_CENTRE_VERTICAL
 327 ALIGN_CENTER = _core_.ALIGN_CENTER
 328 ALIGN_CENTRE = _core_.ALIGN_CENTRE
 329 ALIGN_MASK = _core_.ALIGN_MASK
 330 STRETCH_NOT = _core_.STRETCH_NOT
 331 SHRINK = _core_.SHRINK
 332 GROW = _core_.GROW
 333 EXPAND = _core_.EXPAND
 334 SHAPED = _core_.SHAPED
 335 FIXED_MINSIZE = _core_.FIXED_MINSIZE
 336 TILE = _core_.TILE
 337 ADJUST_MINSIZE = _core_.ADJUST_MINSIZE
 338 BORDER_DEFAULT = _core_.BORDER_DEFAULT
 339 BORDER_NONE = _core_.BORDER_NONE
 340 BORDER_STATIC = _core_.BORDER_STATIC
 341 BORDER_SIMPLE = _core_.BORDER_SIMPLE
 342 BORDER_RAISED = _core_.BORDER_RAISED
 343 BORDER_SUNKEN = _core_.BORDER_SUNKEN
 344 BORDER_DOUBLE = _core_.BORDER_DOUBLE
 345 BORDER_MASK = _core_.BORDER_MASK
 346 BG_STYLE_SYSTEM = _core_.BG_STYLE_SYSTEM
 347 BG_STYLE_COLOUR = _core_.BG_STYLE_COLOUR
 348 BG_STYLE_CUSTOM = _core_.BG_STYLE_CUSTOM
 349 DEFAULT = _core_.DEFAULT
 350 DECORATIVE = _core_.DECORATIVE
 351 ROMAN = _core_.ROMAN
 352 SCRIPT = _core_.SCRIPT
 353 SWISS = _core_.SWISS
 354 MODERN = _core_.MODERN
 355 TELETYPE = _core_.TELETYPE
 356 VARIABLE = _core_.VARIABLE
 357 FIXED = _core_.FIXED
 358 NORMAL = _core_.NORMAL
 359 LIGHT = _core_.LIGHT
 360 BOLD = _core_.BOLD
 361 ITALIC = _core_.ITALIC
 362 SLANT = _core_.SLANT
 363 SOLID = _core_.SOLID
 364 DOT = _core_.DOT
 365 LONG_DASH = _core_.LONG_DASH
 366 SHORT_DASH = _core_.SHORT_DASH
 367 DOT_DASH = _core_.DOT_DASH
 368 USER_DASH = _core_.USER_DASH
 369 TRANSPARENT = _core_.TRANSPARENT
 370 STIPPLE = _core_.STIPPLE
 371 STIPPLE_MASK = _core_.STIPPLE_MASK
 372 STIPPLE_MASK_OPAQUE = _core_.STIPPLE_MASK_OPAQUE
 373 BDIAGONAL_HATCH = _core_.BDIAGONAL_HATCH
 374 CROSSDIAG_HATCH = _core_.CROSSDIAG_HATCH
 375 FDIAGONAL_HATCH = _core_.FDIAGONAL_HATCH
 376 CROSS_HATCH = _core_.CROSS_HATCH
 377 HORIZONTAL_HATCH = _core_.HORIZONTAL_HATCH
 378 VERTICAL_HATCH = _core_.VERTICAL_HATCH
 379 JOIN_BEVEL = _core_.JOIN_BEVEL
 380 JOIN_MITER = _core_.JOIN_MITER
 381 JOIN_ROUND = _core_.JOIN_ROUND
 382 CAP_ROUND = _core_.CAP_ROUND
 383 CAP_PROJECTING = _core_.CAP_PROJECTING
 384 CAP_BUTT = _core_.CAP_BUTT
 385 CLEAR = _core_.CLEAR
 386 XOR = _core_.XOR
 387 INVERT = _core_.INVERT
 388 OR_REVERSE = _core_.OR_REVERSE
 389 AND_REVERSE = _core_.AND_REVERSE
 390 COPY = _core_.COPY
 391 AND = _core_.AND
 392 AND_INVERT = _core_.AND_INVERT
 393 NO_OP = _core_.NO_OP
 394 NOR = _core_.NOR
 395 EQUIV = _core_.EQUIV
 396 SRC_INVERT = _core_.SRC_INVERT
 397 OR_INVERT = _core_.OR_INVERT
 398 NAND = _core_.NAND
 399 OR = _core_.OR
 400 SET = _core_.SET
 401 WXK_BACK = _core_.WXK_BACK
 402 WXK_TAB = _core_.WXK_TAB
 403 WXK_RETURN = _core_.WXK_RETURN
 404 WXK_ESCAPE = _core_.WXK_ESCAPE
 405 WXK_SPACE = _core_.WXK_SPACE
 406 WXK_DELETE = _core_.WXK_DELETE
 407 WXK_START = _core_.WXK_START
 408 WXK_LBUTTON = _core_.WXK_LBUTTON
 409 WXK_RBUTTON = _core_.WXK_RBUTTON
 410 WXK_CANCEL = _core_.WXK_CANCEL
 411 WXK_MBUTTON = _core_.WXK_MBUTTON
 412 WXK_CLEAR = _core_.WXK_CLEAR
 413 WXK_SHIFT = _core_.WXK_SHIFT
 414 WXK_ALT = _core_.WXK_ALT
 415 WXK_CONTROL = _core_.WXK_CONTROL
 416 WXK_MENU = _core_.WXK_MENU
 417 WXK_PAUSE = _core_.WXK_PAUSE
 418 WXK_CAPITAL = _core_.WXK_CAPITAL
 419 WXK_PRIOR = _core_.WXK_PRIOR
 420 WXK_NEXT = _core_.WXK_NEXT
 421 WXK_END = _core_.WXK_END
 422 WXK_HOME = _core_.WXK_HOME
 423 WXK_LEFT = _core_.WXK_LEFT
 424 WXK_UP = _core_.WXK_UP
 425 WXK_RIGHT = _core_.WXK_RIGHT
 426 WXK_DOWN = _core_.WXK_DOWN
 427 WXK_SELECT = _core_.WXK_SELECT
 428 WXK_PRINT = _core_.WXK_PRINT
 429 WXK_EXECUTE = _core_.WXK_EXECUTE
 430 WXK_SNAPSHOT = _core_.WXK_SNAPSHOT
 431 WXK_INSERT = _core_.WXK_INSERT
 432 WXK_HELP = _core_.WXK_HELP
 433 WXK_NUMPAD0 = _core_.WXK_NUMPAD0
 434 WXK_NUMPAD1 = _core_.WXK_NUMPAD1
 435 WXK_NUMPAD2 = _core_.WXK_NUMPAD2
 436 WXK_NUMPAD3 = _core_.WXK_NUMPAD3
 437 WXK_NUMPAD4 = _core_.WXK_NUMPAD4
 438 WXK_NUMPAD5 = _core_.WXK_NUMPAD5
 439 WXK_NUMPAD6 = _core_.WXK_NUMPAD6
 440 WXK_NUMPAD7 = _core_.WXK_NUMPAD7
 441 WXK_NUMPAD8 = _core_.WXK_NUMPAD8
 442 WXK_NUMPAD9 = _core_.WXK_NUMPAD9
 443 WXK_MULTIPLY = _core_.WXK_MULTIPLY
 444 WXK_ADD = _core_.WXK_ADD
 445 WXK_SEPARATOR = _core_.WXK_SEPARATOR
 446 WXK_SUBTRACT = _core_.WXK_SUBTRACT
 447 WXK_DECIMAL = _core_.WXK_DECIMAL
 448 WXK_DIVIDE = _core_.WXK_DIVIDE
 449 WXK_F1 = _core_.WXK_F1
 450 WXK_F2 = _core_.WXK_F2
 451 WXK_F3 = _core_.WXK_F3
 452 WXK_F4 = _core_.WXK_F4
 453 WXK_F5 = _core_.WXK_F5
 454 WXK_F6 = _core_.WXK_F6
 455 WXK_F7 = _core_.WXK_F7
 456 WXK_F8 = _core_.WXK_F8
 457 WXK_F9 = _core_.WXK_F9
 458 WXK_F10 = _core_.WXK_F10
 459 WXK_F11 = _core_.WXK_F11
 460 WXK_F12 = _core_.WXK_F12
 461 WXK_F13 = _core_.WXK_F13
 462 WXK_F14 = _core_.WXK_F14
 463 WXK_F15 = _core_.WXK_F15
 464 WXK_F16 = _core_.WXK_F16
 465 WXK_F17 = _core_.WXK_F17
 466 WXK_F18 = _core_.WXK_F18
 467 WXK_F19 = _core_.WXK_F19
 468 WXK_F20 = _core_.WXK_F20
 469 WXK_F21 = _core_.WXK_F21
 470 WXK_F22 = _core_.WXK_F22
 471 WXK_F23 = _core_.WXK_F23
 472 WXK_F24 = _core_.WXK_F24
 473 WXK_NUMLOCK = _core_.WXK_NUMLOCK
 474 WXK_SCROLL = _core_.WXK_SCROLL
 475 WXK_PAGEUP = _core_.WXK_PAGEUP
 476 WXK_PAGEDOWN = _core_.WXK_PAGEDOWN
 477 WXK_NUMPAD_SPACE = _core_.WXK_NUMPAD_SPACE
 478 WXK_NUMPAD_TAB = _core_.WXK_NUMPAD_TAB
 479 WXK_NUMPAD_ENTER = _core_.WXK_NUMPAD_ENTER
 480 WXK_NUMPAD_F1 = _core_.WXK_NUMPAD_F1
 481 WXK_NUMPAD_F2 = _core_.WXK_NUMPAD_F2
 482 WXK_NUMPAD_F3 = _core_.WXK_NUMPAD_F3
 483 WXK_NUMPAD_F4 = _core_.WXK_NUMPAD_F4
 484 WXK_NUMPAD_HOME = _core_.WXK_NUMPAD_HOME
 485 WXK_NUMPAD_LEFT = _core_.WXK_NUMPAD_LEFT
 486 WXK_NUMPAD_UP = _core_.WXK_NUMPAD_UP
 487 WXK_NUMPAD_RIGHT = _core_.WXK_NUMPAD_RIGHT
 488 WXK_NUMPAD_DOWN = _core_.WXK_NUMPAD_DOWN
 489 WXK_NUMPAD_PRIOR = _core_.WXK_NUMPAD_PRIOR
 490 WXK_NUMPAD_PAGEUP = _core_.WXK_NUMPAD_PAGEUP
 491 WXK_NUMPAD_NEXT = _core_.WXK_NUMPAD_NEXT
 492 WXK_NUMPAD_PAGEDOWN = _core_.WXK_NUMPAD_PAGEDOWN
 493 WXK_NUMPAD_END = _core_.WXK_NUMPAD_END
 494 WXK_NUMPAD_BEGIN = _core_.WXK_NUMPAD_BEGIN
 495 WXK_NUMPAD_INSERT = _core_.WXK_NUMPAD_INSERT
 496 WXK_NUMPAD_DELETE = _core_.WXK_NUMPAD_DELETE
 497 WXK_NUMPAD_EQUAL = _core_.WXK_NUMPAD_EQUAL
 498 WXK_NUMPAD_MULTIPLY = _core_.WXK_NUMPAD_MULTIPLY
 499 WXK_NUMPAD_ADD = _core_.WXK_NUMPAD_ADD
 500 WXK_NUMPAD_SEPARATOR = _core_.WXK_NUMPAD_SEPARATOR
 501 WXK_NUMPAD_SUBTRACT = _core_.WXK_NUMPAD_SUBTRACT
 502 WXK_NUMPAD_DECIMAL = _core_.WXK_NUMPAD_DECIMAL
 503 WXK_NUMPAD_DIVIDE = _core_.WXK_NUMPAD_DIVIDE
 504 WXK_WINDOWS_LEFT = _core_.WXK_WINDOWS_LEFT
 505 WXK_WINDOWS_RIGHT = _core_.WXK_WINDOWS_RIGHT
 506 WXK_WINDOWS_MENU = _core_.WXK_WINDOWS_MENU
 507 WXK_COMMAND = _core_.WXK_COMMAND
 508 WXK_SPECIAL1 = _core_.WXK_SPECIAL1
 509 WXK_SPECIAL2 = _core_.WXK_SPECIAL2
 510 WXK_SPECIAL3 = _core_.WXK_SPECIAL3
 511 WXK_SPECIAL4 = _core_.WXK_SPECIAL4
 512 WXK_SPECIAL5 = _core_.WXK_SPECIAL5
 513 WXK_SPECIAL6 = _core_.WXK_SPECIAL6
 514 WXK_SPECIAL7 = _core_.WXK_SPECIAL7
 515 WXK_SPECIAL8 = _core_.WXK_SPECIAL8
 516 WXK_SPECIAL9 = _core_.WXK_SPECIAL9
 517 WXK_SPECIAL10 = _core_.WXK_SPECIAL10
 518 WXK_SPECIAL11 = _core_.WXK_SPECIAL11
 519 WXK_SPECIAL12 = _core_.WXK_SPECIAL12
 520 WXK_SPECIAL13 = _core_.WXK_SPECIAL13
 521 WXK_SPECIAL14 = _core_.WXK_SPECIAL14
 522 WXK_SPECIAL15 = _core_.WXK_SPECIAL15
 523 WXK_SPECIAL16 = _core_.WXK_SPECIAL16
 524 WXK_SPECIAL17 = _core_.WXK_SPECIAL17
 525 WXK_SPECIAL18 = _core_.WXK_SPECIAL18
 526 WXK_SPECIAL19 = _core_.WXK_SPECIAL19
 527 WXK_SPECIAL20 = _core_.WXK_SPECIAL20
 528 PAPER_NONE = _core_.PAPER_NONE
 529 PAPER_LETTER = _core_.PAPER_LETTER
 530 PAPER_LEGAL = _core_.PAPER_LEGAL
 531 PAPER_A4 = _core_.PAPER_A4
 532 PAPER_CSHEET = _core_.PAPER_CSHEET
 533 PAPER_DSHEET = _core_.PAPER_DSHEET
 534 PAPER_ESHEET = _core_.PAPER_ESHEET
 535 PAPER_LETTERSMALL = _core_.PAPER_LETTERSMALL
 536 PAPER_TABLOID = _core_.PAPER_TABLOID
 537 PAPER_LEDGER = _core_.PAPER_LEDGER
 538 PAPER_STATEMENT = _core_.PAPER_STATEMENT
 539 PAPER_EXECUTIVE = _core_.PAPER_EXECUTIVE
 540 PAPER_A3 = _core_.PAPER_A3
 541 PAPER_A4SMALL = _core_.PAPER_A4SMALL
 542 PAPER_A5 = _core_.PAPER_A5
 543 PAPER_B4 = _core_.PAPER_B4
 544 PAPER_B5 = _core_.PAPER_B5
 545 PAPER_FOLIO = _core_.PAPER_FOLIO
 546 PAPER_QUARTO = _core_.PAPER_QUARTO
 547 PAPER_10X14 = _core_.PAPER_10X14
 548 PAPER_11X17 = _core_.PAPER_11X17
 549 PAPER_NOTE = _core_.PAPER_NOTE
 550 PAPER_ENV_9 = _core_.PAPER_ENV_9
 551 PAPER_ENV_10 = _core_.PAPER_ENV_10
 552 PAPER_ENV_11 = _core_.PAPER_ENV_11
 553 PAPER_ENV_12 = _core_.PAPER_ENV_12
 554 PAPER_ENV_14 = _core_.PAPER_ENV_14
 555 PAPER_ENV_DL = _core_.PAPER_ENV_DL
 556 PAPER_ENV_C5 = _core_.PAPER_ENV_C5
 557 PAPER_ENV_C3 = _core_.PAPER_ENV_C3
 558 PAPER_ENV_C4 = _core_.PAPER_ENV_C4
 559 PAPER_ENV_C6 = _core_.PAPER_ENV_C6
 560 PAPER_ENV_C65 = _core_.PAPER_ENV_C65
 561 PAPER_ENV_B4 = _core_.PAPER_ENV_B4
 562 PAPER_ENV_B5 = _core_.PAPER_ENV_B5
 563 PAPER_ENV_B6 = _core_.PAPER_ENV_B6
 564 PAPER_ENV_ITALY = _core_.PAPER_ENV_ITALY
 565 PAPER_ENV_MONARCH = _core_.PAPER_ENV_MONARCH
 566 PAPER_ENV_PERSONAL = _core_.PAPER_ENV_PERSONAL
 567 PAPER_FANFOLD_US = _core_.PAPER_FANFOLD_US
 568 PAPER_FANFOLD_STD_GERMAN = _core_.PAPER_FANFOLD_STD_GERMAN
 569 PAPER_FANFOLD_LGL_GERMAN = _core_.PAPER_FANFOLD_LGL_GERMAN
 570 PAPER_ISO_B4 = _core_.PAPER_ISO_B4
 571 PAPER_JAPANESE_POSTCARD = _core_.PAPER_JAPANESE_POSTCARD
 572 PAPER_9X11 = _core_.PAPER_9X11
 573 PAPER_10X11 = _core_.PAPER_10X11
 574 PAPER_15X11 = _core_.PAPER_15X11
 575 PAPER_ENV_INVITE = _core_.PAPER_ENV_INVITE
 576 PAPER_LETTER_EXTRA = _core_.PAPER_LETTER_EXTRA
 577 PAPER_LEGAL_EXTRA = _core_.PAPER_LEGAL_EXTRA
 578 PAPER_TABLOID_EXTRA = _core_.PAPER_TABLOID_EXTRA
 579 PAPER_A4_EXTRA = _core_.PAPER_A4_EXTRA
 580 PAPER_LETTER_TRANSVERSE = _core_.PAPER_LETTER_TRANSVERSE
 581 PAPER_A4_TRANSVERSE = _core_.PAPER_A4_TRANSVERSE
 582 PAPER_LETTER_EXTRA_TRANSVERSE = _core_.PAPER_LETTER_EXTRA_TRANSVERSE
 583 PAPER_A_PLUS = _core_.PAPER_A_PLUS
 584 PAPER_B_PLUS = _core_.PAPER_B_PLUS
 585 PAPER_LETTER_PLUS = _core_.PAPER_LETTER_PLUS
 586 PAPER_A4_PLUS = _core_.PAPER_A4_PLUS
 587 PAPER_A5_TRANSVERSE = _core_.PAPER_A5_TRANSVERSE
 588 PAPER_B5_TRANSVERSE = _core_.PAPER_B5_TRANSVERSE
 589 PAPER_A3_EXTRA = _core_.PAPER_A3_EXTRA
 590 PAPER_A5_EXTRA = _core_.PAPER_A5_EXTRA
 591 PAPER_B5_EXTRA = _core_.PAPER_B5_EXTRA
 592 PAPER_A2 = _core_.PAPER_A2
 593 PAPER_A3_TRANSVERSE = _core_.PAPER_A3_TRANSVERSE
 594 PAPER_A3_EXTRA_TRANSVERSE = _core_.PAPER_A3_EXTRA_TRANSVERSE
 595 PAPER_DBL_JAPANESE_POSTCARD = _core_.PAPER_DBL_JAPANESE_POSTCARD
 596 PAPER_A6 = _core_.PAPER_A6
 597 PAPER_JENV_KAKU2 = _core_.PAPER_JENV_KAKU2
 598 PAPER_JENV_KAKU3 = _core_.PAPER_JENV_KAKU3
 599 PAPER_JENV_CHOU3 = _core_.PAPER_JENV_CHOU3
 600 PAPER_JENV_CHOU4 = _core_.PAPER_JENV_CHOU4
 601 PAPER_LETTER_ROTATED = _core_.PAPER_LETTER_ROTATED
 602 PAPER_A3_ROTATED = _core_.PAPER_A3_ROTATED
 603 PAPER_A4_ROTATED = _core_.PAPER_A4_ROTATED
 604 PAPER_A5_ROTATED = _core_.PAPER_A5_ROTATED
 605 PAPER_B4_JIS_ROTATED = _core_.PAPER_B4_JIS_ROTATED
 606 PAPER_B5_JIS_ROTATED = _core_.PAPER_B5_JIS_ROTATED
 607 PAPER_JAPANESE_POSTCARD_ROTATED = _core_.PAPER_JAPANESE_POSTCARD_ROTATED
 608 PAPER_DBL_JAPANESE_POSTCARD_ROTATED = _core_.PAPER_DBL_JAPANESE_POSTCARD_ROTATED
 609 PAPER_A6_ROTATED = _core_.PAPER_A6_ROTATED
 610 PAPER_JENV_KAKU2_ROTATED = _core_.PAPER_JENV_KAKU2_ROTATED
 611 PAPER_JENV_KAKU3_ROTATED = _core_.PAPER_JENV_KAKU3_ROTATED
 612 PAPER_JENV_CHOU3_ROTATED = _core_.PAPER_JENV_CHOU3_ROTATED
 613 PAPER_JENV_CHOU4_ROTATED = _core_.PAPER_JENV_CHOU4_ROTATED
 614 PAPER_B6_JIS = _core_.PAPER_B6_JIS
 615 PAPER_B6_JIS_ROTATED = _core_.PAPER_B6_JIS_ROTATED
 616 PAPER_12X11 = _core_.PAPER_12X11
 617 PAPER_JENV_YOU4 = _core_.PAPER_JENV_YOU4
 618 PAPER_JENV_YOU4_ROTATED = _core_.PAPER_JENV_YOU4_ROTATED
 619 PAPER_P16K = _core_.PAPER_P16K
 620 PAPER_P32K = _core_.PAPER_P32K
 621 PAPER_P32KBIG = _core_.PAPER_P32KBIG
 622 PAPER_PENV_1 = _core_.PAPER_PENV_1
 623 PAPER_PENV_2 = _core_.PAPER_PENV_2
 624 PAPER_PENV_3 = _core_.PAPER_PENV_3
 625 PAPER_PENV_4 = _core_.PAPER_PENV_4
 626 PAPER_PENV_5 = _core_.PAPER_PENV_5
 627 PAPER_PENV_6 = _core_.PAPER_PENV_6
 628 PAPER_PENV_7 = _core_.PAPER_PENV_7
 629 PAPER_PENV_8 = _core_.PAPER_PENV_8
 630 PAPER_PENV_9 = _core_.PAPER_PENV_9
 631 PAPER_PENV_10 = _core_.PAPER_PENV_10
 632 PAPER_P16K_ROTATED = _core_.PAPER_P16K_ROTATED
 633 PAPER_P32K_ROTATED = _core_.PAPER_P32K_ROTATED
 634 PAPER_P32KBIG_ROTATED = _core_.PAPER_P32KBIG_ROTATED
 635 PAPER_PENV_1_ROTATED = _core_.PAPER_PENV_1_ROTATED
 636 PAPER_PENV_2_ROTATED = _core_.PAPER_PENV_2_ROTATED
 637 PAPER_PENV_3_ROTATED = _core_.PAPER_PENV_3_ROTATED
 638 PAPER_PENV_4_ROTATED = _core_.PAPER_PENV_4_ROTATED
 639 PAPER_PENV_5_ROTATED = _core_.PAPER_PENV_5_ROTATED
 640 PAPER_PENV_6_ROTATED = _core_.PAPER_PENV_6_ROTATED
 641 PAPER_PENV_7_ROTATED = _core_.PAPER_PENV_7_ROTATED
 642 PAPER_PENV_8_ROTATED = _core_.PAPER_PENV_8_ROTATED
 643 PAPER_PENV_9_ROTATED = _core_.PAPER_PENV_9_ROTATED
 644 PAPER_PENV_10_ROTATED = _core_.PAPER_PENV_10_ROTATED
 645 DUPLEX_SIMPLEX = _core_.DUPLEX_SIMPLEX
 646 DUPLEX_HORIZONTAL = _core_.DUPLEX_HORIZONTAL
 647 DUPLEX_VERTICAL = _core_.DUPLEX_VERTICAL
 648 ITEM_SEPARATOR = _core_.ITEM_SEPARATOR
 649 ITEM_NORMAL = _core_.ITEM_NORMAL
 650 ITEM_CHECK = _core_.ITEM_CHECK
 651 ITEM_RADIO = _core_.ITEM_RADIO
 652 ITEM_MAX = _core_.ITEM_MAX
 653 HT_NOWHERE = _core_.HT_NOWHERE
 654 HT_SCROLLBAR_FIRST = _core_.HT_SCROLLBAR_FIRST
 655 HT_SCROLLBAR_ARROW_LINE_1 = _core_.HT_SCROLLBAR_ARROW_LINE_1
 656 HT_SCROLLBAR_ARROW_LINE_2 = _core_.HT_SCROLLBAR_ARROW_LINE_2
 657 HT_SCROLLBAR_ARROW_PAGE_1 = _core_.HT_SCROLLBAR_ARROW_PAGE_1
 658 HT_SCROLLBAR_ARROW_PAGE_2 = _core_.HT_SCROLLBAR_ARROW_PAGE_2
 659 HT_SCROLLBAR_THUMB = _core_.HT_SCROLLBAR_THUMB
 660 HT_SCROLLBAR_BAR_1 = _core_.HT_SCROLLBAR_BAR_1
 661 HT_SCROLLBAR_BAR_2 = _core_.HT_SCROLLBAR_BAR_2
 662 HT_SCROLLBAR_LAST = _core_.HT_SCROLLBAR_LAST
 663 HT_WINDOW_OUTSIDE = _core_.HT_WINDOW_OUTSIDE
 664 HT_WINDOW_INSIDE = _core_.HT_WINDOW_INSIDE
 665 HT_WINDOW_VERT_SCROLLBAR = _core_.HT_WINDOW_VERT_SCROLLBAR
 666 HT_WINDOW_HORZ_SCROLLBAR = _core_.HT_WINDOW_HORZ_SCROLLBAR
 667 HT_WINDOW_CORNER = _core_.HT_WINDOW_CORNER
 668 HT_MAX = _core_.HT_MAX
 669 MOD_NONE = _core_.MOD_NONE
 670 MOD_ALT = _core_.MOD_ALT
 671 MOD_CONTROL = _core_.MOD_CONTROL
 672 MOD_ALTGR = _core_.MOD_ALTGR
 673 MOD_SHIFT = _core_.MOD_SHIFT
 674 MOD_META = _core_.MOD_META
 675 MOD_WIN = _core_.MOD_WIN
 676 MOD_CMD = _core_.MOD_CMD
 677 MOD_ALL = _core_.MOD_ALL
 678 UPDATE_UI_NONE = _core_.UPDATE_UI_NONE
 679 UPDATE_UI_RECURSE = _core_.UPDATE_UI_RECURSE
 680 UPDATE_UI_FROMIDLE = _core_.UPDATE_UI_FROMIDLE
 681 Layout_Default = _core_.Layout_Default
 682 Layout_LeftToRight = _core_.Layout_LeftToRight
 683 Layout_RightToLeft = _core_.Layout_RightToLeft
 684 #---------------------------------------------------------------------------
 685
 686 class Object(object):
 687     """
 688     The base class for most wx objects, although in wxPython not
 689     much functionality is needed nor exposed.
 690     """
 691     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
 692     def __init__(self): raise AttributeError, "No constructor defined"
 693     __repr__ = _swig_repr
 694     def GetClassName(*args, **kwargs):
 695         """
 696         GetClassName(self) -> String
 697
 698         Returns the class name of the C++ class using wxRTTI.
 699         """
 700         return _core_.Object_GetClassName(*args, **kwargs)
 701
 702     def Destroy(*args, **kwargs):
 703         """
 704         Destroy(self)
 705
 706         Deletes the C++ object this Python object is a proxy for.
 707         """
 708         args[0].this.own(False)
 709         return _core_.Object_Destroy(*args, **kwargs)
 710
 711     def IsSameAs(*args, **kwargs):
 712         """
 713         IsSameAs(self, Object p) -> bool
 714
 715         For wx.Objects that use C++ reference counting internally, this method
 716         can be used to determine if two objects are referencing the same data
 717         object.
 718         """
 719         return _core_.Object_IsSameAs(*args, **kwargs)
 720
 721     ClassName = property(GetClassName,doc="See `GetClassName`")
 722 _core_.Object_swigregister(Object)
 723 _wxPySetDictionary = _core_._wxPySetDictionary
 724 cvar = _core_.cvar
 725 EmptyString = cvar.EmptyString
 726
 727 #---------------------------------------------------------------------------
 728
 729 BITMAP_TYPE_INVALID = _core_.BITMAP_TYPE_INVALID
 730 BITMAP_TYPE_BMP = _core_.BITMAP_TYPE_BMP
 731 BITMAP_TYPE_ICO = _core_.BITMAP_TYPE_ICO
 732 BITMAP_TYPE_CUR = _core_.BITMAP_TYPE_CUR
 733 BITMAP_TYPE_XBM = _core_.BITMAP_TYPE_XBM
 734 BITMAP_TYPE_XBM_DATA = _core_.BITMAP_TYPE_XBM_DATA
 735 BITMAP_TYPE_XPM = _core_.BITMAP_TYPE_XPM
 736 BITMAP_TYPE_XPM_DATA = _core_.BITMAP_TYPE_XPM_DATA
 737 BITMAP_TYPE_TIF = _core_.BITMAP_TYPE_TIF
 738 BITMAP_TYPE_GIF = _core_.BITMAP_TYPE_GIF
 739 BITMAP_TYPE_PNG = _core_.BITMAP_TYPE_PNG
 740 BITMAP_TYPE_JPEG = _core_.BITMAP_TYPE_JPEG
 741 BITMAP_TYPE_PNM = _core_.BITMAP_TYPE_PNM
 742 BITMAP_TYPE_PCX = _core_.BITMAP_TYPE_PCX
 743 BITMAP_TYPE_PICT = _core_.BITMAP_TYPE_PICT
 744 BITMAP_TYPE_ICON = _core_.BITMAP_TYPE_ICON
 745 BITMAP_TYPE_ANI = _core_.BITMAP_TYPE_ANI
 746 BITMAP_TYPE_IFF = _core_.BITMAP_TYPE_IFF
 747 BITMAP_TYPE_TGA = _core_.BITMAP_TYPE_TGA
 748 BITMAP_TYPE_MACCURSOR = _core_.BITMAP_TYPE_MACCURSOR
 749 BITMAP_TYPE_ANY = _core_.BITMAP_TYPE_ANY
 750 CURSOR_NONE = _core_.CURSOR_NONE
 751 CURSOR_ARROW = _core_.CURSOR_ARROW
 752 CURSOR_RIGHT_ARROW = _core_.CURSOR_RIGHT_ARROW
 753 CURSOR_BULLSEYE = _core_.CURSOR_BULLSEYE
 754 CURSOR_CHAR = _core_.CURSOR_CHAR
 755 CURSOR_CROSS = _core_.CURSOR_CROSS
 756 CURSOR_HAND = _core_.CURSOR_HAND
 757 CURSOR_IBEAM = _core_.CURSOR_IBEAM
 758 CURSOR_LEFT_BUTTON = _core_.CURSOR_LEFT_BUTTON
 759 CURSOR_MAGNIFIER = _core_.CURSOR_MAGNIFIER
 760 CURSOR_MIDDLE_BUTTON = _core_.CURSOR_MIDDLE_BUTTON
 761 CURSOR_NO_ENTRY = _core_.CURSOR_NO_ENTRY
 762 CURSOR_PAINT_BRUSH = _core_.CURSOR_PAINT_BRUSH
 763 CURSOR_PENCIL = _core_.CURSOR_PENCIL
 764 CURSOR_POINT_LEFT = _core_.CURSOR_POINT_LEFT
 765 CURSOR_POINT_RIGHT = _core_.CURSOR_POINT_RIGHT
 766 CURSOR_QUESTION_ARROW = _core_.CURSOR_QUESTION_ARROW
 767 CURSOR_RIGHT_BUTTON = _core_.CURSOR_RIGHT_BUTTON
 768 CURSOR_SIZENESW = _core_.CURSOR_SIZENESW
 769 CURSOR_SIZENS = _core_.CURSOR_SIZENS
 770 CURSOR_SIZENWSE = _core_.CURSOR_SIZENWSE
 771 CURSOR_SIZEWE = _core_.CURSOR_SIZEWE
 772 CURSOR_SIZING = _core_.CURSOR_SIZING
 773 CURSOR_SPRAYCAN = _core_.CURSOR_SPRAYCAN
 774 CURSOR_WAIT = _core_.CURSOR_WAIT
 775 CURSOR_WATCH = _core_.CURSOR_WATCH
 776 CURSOR_BLANK = _core_.CURSOR_BLANK
 777 CURSOR_DEFAULT = _core_.CURSOR_DEFAULT
 778 CURSOR_COPY_ARROW = _core_.CURSOR_COPY_ARROW
 779 CURSOR_ARROWWAIT = _core_.CURSOR_ARROWWAIT
 780 CURSOR_MAX = _core_.CURSOR_MAX
 781 #---------------------------------------------------------------------------
 782
 783 class Size(object):
 784     """
 785     wx.Size is a useful data structure used to represent the size of
 786     something.  It simply contains integer width and height
 787     properties.  In most places in wxPython where a wx.Size is
 788     expected a (width, height) tuple can be used instead.
 789     """
 790     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
 791     __repr__ = _swig_repr
 792     width = property(_core_.Size_width_get, _core_.Size_width_set)
 793     height = property(_core_.Size_height_get, _core_.Size_height_set)
 794     x = width; y = height
 795     def __init__(self, *args, **kwargs):
 796         """
 797         __init__(self, int w=0, int h=0) -> Size
 798
 799         Creates a size object.
 800         """
 801         _core_.Size_swiginit(self,_core_.new_Size(*args, **kwargs))
 802     __swig_destroy__ = _core_.delete_Size
 803     __del__ = lambda self : None;
 804     def __eq__(*args, **kwargs):
 805         """
 806         __eq__(self, PyObject other) -> bool
 807
 808         Test for equality of wx.Size objects.
 809         """
 810         return _core_.Size___eq__(*args, **kwargs)
 811
 812     def __ne__(*args, **kwargs):
 813         """
 814         __ne__(self, PyObject other) -> bool
 815
 816         Test for inequality of wx.Size objects.
 817         """
 818         return _core_.Size___ne__(*args, **kwargs)
 819
 820     def __add__(*args, **kwargs):
 821         """
 822         __add__(self, Size sz) -> Size
 823
 824         Add sz's proprties to this and return the result.
 825         """
 826         return _core_.Size___add__(*args, **kwargs)
 827
 828     def __sub__(*args, **kwargs):
 829         """
 830         __sub__(self, Size sz) -> Size
 831
 832         Subtract sz's properties from this and return the result.
 833         """
 834         return _core_.Size___sub__(*args, **kwargs)
 835
 836     def IncTo(*args, **kwargs):
 837         """
 838         IncTo(self, Size sz)
 839
 840         Increments this object so that both of its dimensions are not less
 841         than the corresponding dimensions of the size.
 842         """
 843         return _core_.Size_IncTo(*args, **kwargs)
 844
 845     def DecTo(*args, **kwargs):
 846         """
 847         DecTo(self, Size sz)
 848
 849         Decrements this object so that both of its dimensions are not greater
 850         than the corresponding dimensions of the size.
 851         """
 852         return _core_.Size_DecTo(*args, **kwargs)
 853
 854     def IncBy(*args, **kwargs):
 855         """IncBy(self, int dx, int dy)"""
 856         return _core_.Size_IncBy(*args, **kwargs)
 857
 858     def DecBy(*args, **kwargs):
 859         """DecBy(self, int dx, int dy)"""
 860         return _core_.Size_DecBy(*args, **kwargs)
 861
 862     def Scale(*args, **kwargs):
 863         """
 864         Scale(self, float xscale, float yscale)
 865
 866         Scales the dimensions of this object by the given factors.
 867         """
 868         return _core_.Size_Scale(*args, **kwargs)
 869
 870     def Set(*args, **kwargs):
 871         """
 872         Set(self, int w, int h)
 873
 874         Set both width and height.
 875         """
 876         return _core_.Size_Set(*args, **kwargs)
 877
 878     def SetWidth(*args, **kwargs):
 879         """SetWidth(self, int w)"""
 880         return _core_.Size_SetWidth(*args, **kwargs)
 881
 882     def SetHeight(*args, **kwargs):
 883         """SetHeight(self, int h)"""
 884         return _core_.Size_SetHeight(*args, **kwargs)
 885
 886     def GetWidth(*args, **kwargs):
 887         """GetWidth(self) -> int"""
 888         return _core_.Size_GetWidth(*args, **kwargs)
 889
 890     def GetHeight(*args, **kwargs):
 891         """GetHeight(self) -> int"""
 892         return _core_.Size_GetHeight(*args, **kwargs)
 893
 894     def IsFullySpecified(*args, **kwargs):
 895         """
 896         IsFullySpecified(self) -> bool
 897
 898         Returns True if both components of the size are non-default values.
 899         """
 900         return _core_.Size_IsFullySpecified(*args, **kwargs)
 901
 902     def SetDefaults(*args, **kwargs):
 903         """
 904         SetDefaults(self, Size size)
 905
 906         Combine this size with the other one replacing the default components
 907         of this object (i.e. equal to -1) with those of the other.
 908         """
 909         return _core_.Size_SetDefaults(*args, **kwargs)
 910
 911     def Get(*args, **kwargs):
 912         """
 913         Get() -> (width,height)
 914
 915         Returns the width and height properties as a tuple.
 916         """
 917         return _core_.Size_Get(*args, **kwargs)
 918
 919     asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
 920     def __str__(self):                   return str(self.Get())
 921     def __repr__(self):                  return 'wx.Size'+str(self.Get())
 922     def __len__(self):                   return len(self.Get())
 923     def __getitem__(self, index):        return self.Get()[index]
 924     def __setitem__(self, index, val):
 925         if index == 0: self.width = val
 926         elif index == 1: self.height = val
 927         else: raise IndexError
 928     def __nonzero__(self):               return self.Get() != (0,0)
 929     __safe_for_unpickling__ = True
 930     def __reduce__(self):                return (wx.Size, self.Get())
 931
 932 _core_.Size_swigregister(Size)
 933
 934 #---------------------------------------------------------------------------
 935
 936 class RealPoint(object):
 937     """
 938     A data structure for representing a point or position with floating
 939     point x and y properties.  In wxPython most places that expect a
 940     wx.RealPoint can also accept a (x,y) tuple.
 941     """
 942     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
 943     __repr__ = _swig_repr
 944     x = property(_core_.RealPoint_x_get, _core_.RealPoint_x_set)
 945     y = property(_core_.RealPoint_y_get, _core_.RealPoint_y_set)
 946     def __init__(self, *args, **kwargs):
 947         """
 948         __init__(self, double x=0.0, double y=0.0) -> RealPoint
 949
 950         Create a wx.RealPoint object
 951         """
 952         _core_.RealPoint_swiginit(self,_core_.new_RealPoint(*args, **kwargs))
 953     __swig_destroy__ = _core_.delete_RealPoint
 954     __del__ = lambda self : None;
 955     def __eq__(*args, **kwargs):
 956         """
 957         __eq__(self, PyObject other) -> bool
 958
 959         Test for equality of wx.RealPoint objects.
 960         """
 961         return _core_.RealPoint___eq__(*args, **kwargs)
 962
 963     def __ne__(*args, **kwargs):
 964         """
 965         __ne__(self, PyObject other) -> bool
 966
 967         Test for inequality of wx.RealPoint objects.
 968         """
 969         return _core_.RealPoint___ne__(*args, **kwargs)
 970
 971     def __add__(*args, **kwargs):
 972         """
 973         __add__(self, RealPoint pt) -> RealPoint
 974
 975         Add pt's proprties to this and return the result.
 976         """
 977         return _core_.RealPoint___add__(*args, **kwargs)
 978
 979     def __sub__(*args, **kwargs):
 980         """
 981         __sub__(self, RealPoint pt) -> RealPoint
 982
 983         Subtract pt's proprties from this and return the result
 984         """
 985         return _core_.RealPoint___sub__(*args, **kwargs)
 986
 987     def Set(*args, **kwargs):
 988         """
 989         Set(self, double x, double y)
 990
 991         Set both the x and y properties
 992         """
 993         return _core_.RealPoint_Set(*args, **kwargs)
 994
 995     def Get(*args, **kwargs):
 996         """
 997         Get() -> (x,y)
 998
 999         Return the x and y properties as a tuple.
1000         """
1001         return _core_.RealPoint_Get(*args, **kwargs)
1002
1003     asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
1004     def __str__(self):                   return str(self.Get())
1005     def __repr__(self):                  return 'wx.RealPoint'+str(self.Get())
1006     def __len__(self):                   return len(self.Get())
1007     def __getitem__(self, index):        return self.Get()[index]
1008     def __setitem__(self, index, val):
1009         if index == 0: self.x = val
1010         elif index == 1: self.y = val
1011         else: raise IndexError
1012     def __nonzero__(self):               return self.Get() != (0.0, 0.0)
1013     __safe_for_unpickling__ = True
1014     def __reduce__(self):                return (wx.RealPoint, self.Get())
1015
1016 _core_.RealPoint_swigregister(RealPoint)
1017
1018 #---------------------------------------------------------------------------
1019
1020 class Point(object):
1021     """
1022     A data structure for representing a point or position with integer x
1023     and y properties.  Most places in wxPython that expect a wx.Point can
1024     also accept a (x,y) tuple.
1025     """
1026     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1027     __repr__ = _swig_repr
1028     x = property(_core_.Point_x_get, _core_.Point_x_set)
1029     y = property(_core_.Point_y_get, _core_.Point_y_set)
1030     def __init__(self, *args, **kwargs):
1031         """
1032         __init__(self, int x=0, int y=0) -> Point
1033
1034         Create a wx.Point object
1035         """
1036         _core_.Point_swiginit(self,_core_.new_Point(*args, **kwargs))
1037     __swig_destroy__ = _core_.delete_Point
1038     __del__ = lambda self : None;
1039     def __eq__(*args, **kwargs):
1040         """
1041         __eq__(self, PyObject other) -> bool
1042
1043         Test for equality of wx.Point objects.
1044         """
1045         return _core_.Point___eq__(*args, **kwargs)
1046
1047     def __ne__(*args, **kwargs):
1048         """
1049         __ne__(self, PyObject other) -> bool
1050
1051         Test for inequality of wx.Point objects.
1052         """
1053         return _core_.Point___ne__(*args, **kwargs)
1054
1055     def __add__(*args, **kwargs):
1056         """
1057         __add__(self, Point pt) -> Point
1058
1059         Add pt's proprties to this and return the result.
1060         """
1061         return _core_.Point___add__(*args, **kwargs)
1062
1063     def __sub__(*args, **kwargs):
1064         """
1065         __sub__(self, Point pt) -> Point
1066
1067         Subtract pt's proprties from this and return the result
1068         """
1069         return _core_.Point___sub__(*args, **kwargs)
1070
1071     def __iadd__(*args, **kwargs):
1072         """
1073         __iadd__(self, Point pt) -> Point
1074
1075         Add pt to this object.
1076         """
1077         return _core_.Point___iadd__(*args, **kwargs)
1078
1079     def __isub__(*args, **kwargs):
1080         """
1081         __isub__(self, Point pt) -> Point
1082
1083         Subtract pt from this object.
1084         """
1085         return _core_.Point___isub__(*args, **kwargs)
1086
1087     def Set(*args, **kwargs):
1088         """
1089         Set(self, long x, long y)
1090
1091         Set both the x and y properties
1092         """
1093         return _core_.Point_Set(*args, **kwargs)
1094
1095     def Get(*args, **kwargs):
1096         """
1097         Get() -> (x,y)
1098
1099         Return the x and y properties as a tuple.
1100         """
1101         return _core_.Point_Get(*args, **kwargs)
1102
1103     asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
1104     def __str__(self):                   return str(self.Get())
1105     def __repr__(self):                  return 'wx.Point'+str(self.Get())
1106     def __len__(self):                   return len(self.Get())
1107     def __getitem__(self, index):        return self.Get()[index]
1108     def __setitem__(self, index, val):
1109         if index == 0: self.x = val
1110         elif index == 1: self.y = val
1111         else: raise IndexError
1112     def __nonzero__(self):               return self.Get() != (0,0)
1113     __safe_for_unpickling__ = True
1114     def __reduce__(self):                return (wx.Point, self.Get())
1115
1116 _core_.Point_swigregister(Point)
1117
1118 #---------------------------------------------------------------------------
1119
1120 class Rect(object):
1121     """
1122     A class for representing and manipulating rectangles.  It has x, y,
1123     width and height properties.  In wxPython most palces that expect a
1124     wx.Rect can also accept a (x,y,width,height) tuple.
1125     """
1126     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1127     __repr__ = _swig_repr
1128     def __init__(self, *args, **kwargs):
1129         """
1130         __init__(self, int x=0, int y=0, int width=0, int height=0) -> Rect
1131
1132         Create a new Rect object.
1133         """
1134         _core_.Rect_swiginit(self,_core_.new_Rect(*args, **kwargs))
1135     __swig_destroy__ = _core_.delete_Rect
1136     __del__ = lambda self : None;
1137     def GetX(*args, **kwargs):
1138         """GetX(self) -> int"""
1139         return _core_.Rect_GetX(*args, **kwargs)
1140
1141     def SetX(*args, **kwargs):
1142         """SetX(self, int x)"""
1143         return _core_.Rect_SetX(*args, **kwargs)
1144
1145     def GetY(*args, **kwargs):
1146         """GetY(self) -> int"""
1147         return _core_.Rect_GetY(*args, **kwargs)
1148
1149     def SetY(*args, **kwargs):
1150         """SetY(self, int y)"""
1151         return _core_.Rect_SetY(*args, **kwargs)
1152
1153     def GetWidth(*args, **kwargs):
1154         """GetWidth(self) -> int"""
1155         return _core_.Rect_GetWidth(*args, **kwargs)
1156
1157     def SetWidth(*args, **kwargs):
1158         """SetWidth(self, int w)"""
1159         return _core_.Rect_SetWidth(*args, **kwargs)
1160
1161     def GetHeight(*args, **kwargs):
1162         """GetHeight(self) -> int"""
1163         return _core_.Rect_GetHeight(*args, **kwargs)
1164
1165     def SetHeight(*args, **kwargs):
1166         """SetHeight(self, int h)"""
1167         return _core_.Rect_SetHeight(*args, **kwargs)
1168
1169     def GetPosition(*args, **kwargs):
1170         """GetPosition(self) -> Point"""
1171         return _core_.Rect_GetPosition(*args, **kwargs)
1172
1173     def SetPosition(*args, **kwargs):
1174         """SetPosition(self, Point p)"""
1175         return _core_.Rect_SetPosition(*args, **kwargs)
1176
1177     def GetSize(*args, **kwargs):
1178         """GetSize(self) -> Size"""
1179         return _core_.Rect_GetSize(*args, **kwargs)
1180
1181     def SetSize(*args, **kwargs):
1182         """SetSize(self, Size s)"""
1183         return _core_.Rect_SetSize(*args, **kwargs)
1184
1185     def IsEmpty(*args, **kwargs):
1186         """IsEmpty(self) -> bool"""
1187         return _core_.Rect_IsEmpty(*args, **kwargs)
1188
1189     def GetTopLeft(*args, **kwargs):
1190         """GetTopLeft(self) -> Point"""
1191         return _core_.Rect_GetTopLeft(*args, **kwargs)
1192
1193     def SetTopLeft(*args, **kwargs):
1194         """SetTopLeft(self, Point p)"""
1195         return _core_.Rect_SetTopLeft(*args, **kwargs)
1196
1197     def GetBottomRight(*args, **kwargs):
1198         """GetBottomRight(self) -> Point"""
1199         return _core_.Rect_GetBottomRight(*args, **kwargs)
1200
1201     def SetBottomRight(*args, **kwargs):
1202         """SetBottomRight(self, Point p)"""
1203         return _core_.Rect_SetBottomRight(*args, **kwargs)
1204
1205     def GetTopRight(*args, **kwargs):
1206         """GetTopRight(self) -> Point"""
1207         return _core_.Rect_GetTopRight(*args, **kwargs)
1208
1209     def SetTopRight(*args, **kwargs):
1210         """SetTopRight(self, Point p)"""
1211         return _core_.Rect_SetTopRight(*args, **kwargs)
1212
1213     def GetBottomLeft(*args, **kwargs):
1214         """GetBottomLeft(self) -> Point"""
1215         return _core_.Rect_GetBottomLeft(*args, **kwargs)
1216
1217     def SetBottomLeft(*args, **kwargs):
1218         """SetBottomLeft(self, Point p)"""
1219         return _core_.Rect_SetBottomLeft(*args, **kwargs)
1220
1221     def GetLeft(*args, **kwargs):
1222         """GetLeft(self) -> int"""
1223         return _core_.Rect_GetLeft(*args, **kwargs)
1224
1225     def GetTop(*args, **kwargs):
1226         """GetTop(self) -> int"""
1227         return _core_.Rect_GetTop(*args, **kwargs)
1228
1229     def GetBottom(*args, **kwargs):
1230         """GetBottom(self) -> int"""
1231         return _core_.Rect_GetBottom(*args, **kwargs)
1232
1233     def GetRight(*args, **kwargs):
1234         """GetRight(self) -> int"""
1235         return _core_.Rect_GetRight(*args, **kwargs)
1236
1237     def SetLeft(*args, **kwargs):
1238         """SetLeft(self, int left)"""
1239         return _core_.Rect_SetLeft(*args, **kwargs)
1240
1241     def SetRight(*args, **kwargs):
1242         """SetRight(self, int right)"""
1243         return _core_.Rect_SetRight(*args, **kwargs)
1244
1245     def SetTop(*args, **kwargs):
1246         """SetTop(self, int top)"""
1247         return _core_.Rect_SetTop(*args, **kwargs)
1248
1249     def SetBottom(*args, **kwargs):
1250         """SetBottom(self, int bottom)"""
1251         return _core_.Rect_SetBottom(*args, **kwargs)
1252
1253     position = property(GetPosition, SetPosition)
1254     size = property(GetSize, SetSize)
1255     left = property(GetLeft, SetLeft)
1256     right = property(GetRight, SetRight)
1257     top = property(GetTop, SetTop)
1258     bottom = property(GetBottom, SetBottom)
1259
1260     def Inflate(*args, **kwargs):
1261         """
1262         Inflate(self, int dx, int dy) -> Rect
1263
1264         Increases the size of the rectangle.
1265
1266         The left border is moved farther left and the right border is moved
1267         farther right by ``dx``. The upper border is moved farther up and the
1268         bottom border is moved farther down by ``dy``. (Note the the width and
1269         height of the rectangle thus change by ``2*dx`` and ``2*dy``,
1270         respectively.) If one or both of ``dx`` and ``dy`` are negative, the
1271         opposite happens: the rectangle size decreases in the respective
1272         direction.
1273
1274         The change is made to the rectangle inplace, if instead you need a
1275         copy that is inflated, preserving the original then make the copy
1276         first::
1277
1278             copy = wx.Rect(*original)
1279             copy.Inflate(10,15)
1280
1281
1282         """
1283         return _core_.Rect_Inflate(*args, **kwargs)
1284
1285     def Deflate(*args, **kwargs):
1286         """
1287         Deflate(self, int dx, int dy) -> Rect
1288
1289         Decrease the rectangle size. This method is the opposite of `Inflate`
1290         in that Deflate(a,b) is equivalent to Inflate(-a,-b).  Please refer to
1291         `Inflate` for a full description.
1292         """
1293         return _core_.Rect_Deflate(*args, **kwargs)
1294
1295     def OffsetXY(*args, **kwargs):
1296         """
1297         OffsetXY(self, int dx, int dy)
1298
1299         Moves the rectangle by the specified offset. If dx is positive, the
1300         rectangle is moved to the right, if dy is positive, it is moved to the
1301         bottom, otherwise it is moved to the left or top respectively.
1302         """
1303         return _core_.Rect_OffsetXY(*args, **kwargs)
1304
1305     def Offset(*args, **kwargs):
1306         """
1307         Offset(self, Point pt)
1308
1309         Same as `OffsetXY` but uses dx,dy from Point
1310         """
1311         return _core_.Rect_Offset(*args, **kwargs)
1312
1313     def Intersect(*args, **kwargs):
1314         """
1315         Intersect(self, Rect rect) -> Rect
1316
1317         Returns the intersectsion of this rectangle and rect.
1318         """
1319         return _core_.Rect_Intersect(*args, **kwargs)
1320
1321     def Union(*args, **kwargs):
1322         """
1323         Union(self, Rect rect) -> Rect
1324
1325         Returns the union of this rectangle and rect.
1326         """
1327         return _core_.Rect_Union(*args, **kwargs)
1328
1329     def __add__(*args, **kwargs):
1330         """
1331         __add__(self, Rect rect) -> Rect
1332
1333         Add the properties of rect to this rectangle and return the result.
1334         """
1335         return _core_.Rect___add__(*args, **kwargs)
1336
1337     def __iadd__(*args, **kwargs):
1338         """
1339         __iadd__(self, Rect rect) -> Rect
1340
1341         Add the properties of rect to this rectangle, updating this rectangle.
1342         """
1343         return _core_.Rect___iadd__(*args, **kwargs)
1344
1345     def __eq__(*args, **kwargs):
1346         """
1347         __eq__(self, PyObject other) -> bool
1348
1349         Test for equality of wx.Rect objects.
1350         """
1351         return _core_.Rect___eq__(*args, **kwargs)
1352
1353     def __ne__(*args, **kwargs):
1354         """
1355         __ne__(self, PyObject other) -> bool
1356
1357         Test for inequality of wx.Rect objects.
1358         """
1359         return _core_.Rect___ne__(*args, **kwargs)
1360
1361     def ContainsXY(*args, **kwargs):
1362         """
1363         ContainsXY(self, int x, int y) -> bool
1364
1365         Return True if the point is inside the rect.
1366         """
1367         return _core_.Rect_ContainsXY(*args, **kwargs)
1368
1369     def Contains(*args, **kwargs):
1370         """
1371         Contains(self, Point pt) -> bool
1372
1373         Return True if the point is inside the rect.
1374         """
1375         return _core_.Rect_Contains(*args, **kwargs)
1376
1377     def ContainsRect(*args, **kwargs):
1378         """
1379         ContainsRect(self, Rect rect) -> bool
1380
1381         Returns ``True`` if the given rectangle is completely inside this
1382         rectangle or touches its boundary.
1383         """
1384         return _core_.Rect_ContainsRect(*args, **kwargs)
1385
1386     #Inside = wx._deprecated(Contains, "Use `Contains` instead.")
1387     #InsideXY = wx._deprecated(ContainsXY, "Use `ContainsXY` instead.")
1388     #InsideRect = wx._deprecated(ContainsRect, "Use `ContainsRect` instead.")
1389     Inside = Contains
1390     InsideXY = ContainsXY
1391     InsideRect = ContainsRect
1392
1393     def Intersects(*args, **kwargs):
1394         """
1395         Intersects(self, Rect rect) -> bool
1396
1397         Returns True if the rectangles have a non empty intersection.
1398         """
1399         return _core_.Rect_Intersects(*args, **kwargs)
1400
1401     def CenterIn(*args, **kwargs):
1402         """
1403         CenterIn(self, Rect r, int dir=BOTH) -> Rect
1404
1405         Center this rectangle within the one passed to the method, which is
1406         usually, but not necessarily, the larger one.
1407         """
1408         return _core_.Rect_CenterIn(*args, **kwargs)
1409
1410     CentreIn = CenterIn
1411     x = property(_core_.Rect_x_get, _core_.Rect_x_set)
1412     y = property(_core_.Rect_y_get, _core_.Rect_y_set)
1413     width = property(_core_.Rect_width_get, _core_.Rect_width_set)
1414     height = property(_core_.Rect_height_get, _core_.Rect_height_set)
1415     def Set(*args, **kwargs):
1416         """
1417         Set(self, int x=0, int y=0, int width=0, int height=0)
1418
1419         Set all rectangle properties.
1420         """
1421         return _core_.Rect_Set(*args, **kwargs)
1422
1423     def Get(*args, **kwargs):
1424         """
1425         Get() -> (x,y,width,height)
1426
1427         Return the rectangle properties as a tuple.
1428         """
1429         return _core_.Rect_Get(*args, **kwargs)
1430
1431     asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
1432     def __str__(self):                   return str(self.Get())
1433     def __repr__(self):                  return 'wx.Rect'+str(self.Get())
1434     def __len__(self):                   return len(self.Get())
1435     def __getitem__(self, index):        return self.Get()[index]
1436     def __setitem__(self, index, val):
1437         if index == 0: self.x = val
1438         elif index == 1: self.y = val
1439         elif index == 2: self.width = val
1440         elif index == 3: self.height = val
1441         else: raise IndexError
1442     def __nonzero__(self):               return self.Get() != (0,0,0,0)
1443     __safe_for_unpickling__ = True
1444     def __reduce__(self):                return (wx.Rect, self.Get())
1445
1446     Bottom = property(GetBottom,SetBottom,doc="See `GetBottom` and `SetBottom`")
1447     BottomRight = property(GetBottomRight,SetBottomRight,doc="See `GetBottomRight` and `SetBottomRight`")
1448     BottomLeft = property(GetBottomLeft,SetBottomLeft,doc="See `GetBottomLeft` and `SetBottomLeft`")
1449     Height = property(GetHeight,SetHeight,doc="See `GetHeight` and `SetHeight`")
1450     Left = property(GetLeft,SetLeft,doc="See `GetLeft` and `SetLeft`")
1451     Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
1452     Right = property(GetRight,SetRight,doc="See `GetRight` and `SetRight`")
1453     Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`")
1454     Top = property(GetTop,SetTop,doc="See `GetTop` and `SetTop`")
1455     TopLeft = property(GetTopLeft,SetTopLeft,doc="See `GetTopLeft` and `SetTopLeft`")
1456     TopRight = property(GetTopRight,SetTopRight,doc="See `GetTopRight` and `SetTopRight`")
1457     Width = property(GetWidth,SetWidth,doc="See `GetWidth` and `SetWidth`")
1458     X = property(GetX,SetX,doc="See `GetX` and `SetX`")
1459     Y = property(GetY,SetY,doc="See `GetY` and `SetY`")
1460     Empty = property(IsEmpty,doc="See `IsEmpty`")
1461 _core_.Rect_swigregister(Rect)
1462
1463 def RectPP(*args, **kwargs):
1464     """
1465     RectPP(Point topLeft, Point bottomRight) -> Rect
1466
1467     Create a new Rect object from Points representing two corners.
1468     """
1469     val = _core_.new_RectPP(*args, **kwargs)
1470     return val
1471
1472 def RectPS(*args, **kwargs):
1473     """
1474     RectPS(Point pos, Size size) -> Rect
1475
1476     Create a new Rect from a position and size.
1477     """
1478     val = _core_.new_RectPS(*args, **kwargs)
1479     return val
1480
1481 def RectS(*args, **kwargs):
1482     """
1483     RectS(Size size) -> Rect
1484
1485     Create a new Rect from a size only.
1486     """
1487     val = _core_.new_RectS(*args, **kwargs)
1488     return val
1489
1490
1491 def IntersectRect(*args, **kwargs):
1492   """
1493     IntersectRect(Rect r1, Rect r2) -> Rect
1494
1495     Calculate and return the intersection of r1 and r2.
1496     """
1497   return _core_.IntersectRect(*args, **kwargs)
1498 #---------------------------------------------------------------------------
1499
1500 class Point2D(object):
1501     """
1502     wx.Point2Ds represent a point or a vector in a 2d coordinate system
1503     with floating point values.
1504     """
1505     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1506     __repr__ = _swig_repr
1507     def __init__(self, *args, **kwargs):
1508         """
1509         __init__(self, double x=0.0, double y=0.0) -> Point2D
1510
1511         Create a w.Point2D object.
1512         """
1513         _core_.Point2D_swiginit(self,_core_.new_Point2D(*args, **kwargs))
1514     __swig_destroy__ = _core_.delete_Point2D
1515     __del__ = lambda self : None;
1516     def GetFloor(*args, **kwargs):
1517         """
1518         GetFloor() -> (x,y)
1519
1520         Convert to integer
1521         """
1522         return _core_.Point2D_GetFloor(*args, **kwargs)
1523
1524     def GetRounded(*args, **kwargs):
1525         """
1526         GetRounded() -> (x,y)
1527
1528         Convert to integer
1529         """
1530         return _core_.Point2D_GetRounded(*args, **kwargs)
1531
1532     def GetVectorLength(*args, **kwargs):
1533         """GetVectorLength(self) -> double"""
1534         return _core_.Point2D_GetVectorLength(*args, **kwargs)
1535
1536     def GetVectorAngle(*args, **kwargs):
1537         """GetVectorAngle(self) -> double"""
1538         return _core_.Point2D_GetVectorAngle(*args, **kwargs)
1539
1540     def SetVectorLength(*args, **kwargs):
1541         """SetVectorLength(self, double length)"""
1542         return _core_.Point2D_SetVectorLength(*args, **kwargs)
1543
1544     def SetVectorAngle(*args, **kwargs):
1545         """SetVectorAngle(self, double degrees)"""
1546         return _core_.Point2D_SetVectorAngle(*args, **kwargs)
1547
1548     def SetPolarCoordinates(self, angle, length):
1549         self.SetVectorLength(length)
1550         self.SetVectorAngle(angle)
1551     def Normalize(self):
1552         self.SetVectorLength(1.0)
1553
1554     def GetDistance(*args, **kwargs):
1555         """GetDistance(self, Point2D pt) -> double"""
1556         return _core_.Point2D_GetDistance(*args, **kwargs)
1557
1558     def GetDistanceSquare(*args, **kwargs):
1559         """GetDistanceSquare(self, Point2D pt) -> double"""
1560         return _core_.Point2D_GetDistanceSquare(*args, **kwargs)
1561
1562     def GetDotProduct(*args, **kwargs):
1563         """GetDotProduct(self, Point2D vec) -> double"""
1564         return _core_.Point2D_GetDotProduct(*args, **kwargs)
1565
1566     def GetCrossProduct(*args, **kwargs):
1567         """GetCrossProduct(self, Point2D vec) -> double"""
1568         return _core_.Point2D_GetCrossProduct(*args, **kwargs)
1569
1570     def __neg__(*args, **kwargs):
1571         """
1572         __neg__(self) -> Point2D
1573
1574         the reflection of this point
1575         """
1576         return _core_.Point2D___neg__(*args, **kwargs)
1577
1578     def __iadd__(*args, **kwargs):
1579         """__iadd__(self, Point2D pt) -> Point2D"""
1580         return _core_.Point2D___iadd__(*args, **kwargs)
1581
1582     def __isub__(*args, **kwargs):
1583         """__isub__(self, Point2D pt) -> Point2D"""
1584         return _core_.Point2D___isub__(*args, **kwargs)
1585
1586     def __imul__(*args, **kwargs):
1587         """__imul__(self, Point2D pt) -> Point2D"""
1588         return _core_.Point2D___imul__(*args, **kwargs)
1589
1590     def __idiv__(*args, **kwargs):
1591         """__idiv__(self, Point2D pt) -> Point2D"""
1592         return _core_.Point2D___idiv__(*args, **kwargs)
1593
1594     def __eq__(*args, **kwargs):
1595         """
1596         __eq__(self, PyObject other) -> bool
1597
1598         Test for equality of wx.Point2D objects.
1599         """
1600         return _core_.Point2D___eq__(*args, **kwargs)
1601
1602     def __ne__(*args, **kwargs):
1603         """
1604         __ne__(self, PyObject other) -> bool
1605
1606         Test for inequality of wx.Point2D objects.
1607         """
1608         return _core_.Point2D___ne__(*args, **kwargs)
1609
1610     x = property(_core_.Point2D_x_get, _core_.Point2D_x_set)
1611     y = property(_core_.Point2D_y_get, _core_.Point2D_y_set)
1612     def Set(*args, **kwargs):
1613         """Set(self, double x=0, double y=0)"""
1614         return _core_.Point2D_Set(*args, **kwargs)
1615
1616     def Get(*args, **kwargs):
1617         """
1618         Get() -> (x,y)
1619
1620         Return x and y properties as a tuple.
1621         """
1622         return _core_.Point2D_Get(*args, **kwargs)
1623
1624     asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
1625     def __str__(self):                   return str(self.Get())
1626     def __repr__(self):                  return 'wx.Point2D'+str(self.Get())
1627     def __len__(self):                   return len(self.Get())
1628     def __getitem__(self, index):        return self.Get()[index]
1629     def __setitem__(self, index, val):
1630         if index == 0: self.x = val
1631         elif index == 1: self.y = val
1632         else: raise IndexError
1633     def __nonzero__(self):               return self.Get() != (0.0, 0.0)
1634     __safe_for_unpickling__ = True
1635     def __reduce__(self):                return (wx.Point2D, self.Get())
1636
1637     Floor = property(GetFloor,doc="See `GetFloor`")
1638     Rounded = property(GetRounded,doc="See `GetRounded`")
1639     VectorAngle = property(GetVectorAngle,SetVectorAngle,doc="See `GetVectorAngle` and `SetVectorAngle`")
1640     VectorLength = property(GetVectorLength,SetVectorLength,doc="See `GetVectorLength` and `SetVectorLength`")
1641 _core_.Point2D_swigregister(Point2D)
1642
1643 def Point2DCopy(*args, **kwargs):
1644     """
1645     Point2DCopy(Point2D pt) -> Point2D
1646
1647     Create a w.Point2D object.
1648     """
1649     val = _core_.new_Point2DCopy(*args, **kwargs)
1650     return val
1651
1652 def Point2DFromPoint(*args, **kwargs):
1653     """
1654     Point2DFromPoint(Point pt) -> Point2D
1655
1656     Create a w.Point2D object.
1657     """
1658     val = _core_.new_Point2DFromPoint(*args, **kwargs)
1659     return val
1660
1661 #---------------------------------------------------------------------------
1662
1663 Inside = _core_.Inside
1664 OutLeft = _core_.OutLeft
1665 OutRight = _core_.OutRight
1666 OutTop = _core_.OutTop
1667 OutBottom = _core_.OutBottom
1668 class Rect2D(object):
1669     """
1670     wx.Rect2D is a rectangle, with position and size, in a 2D coordinate system
1671     with floating point component values.
1672     """
1673     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1674     __repr__ = _swig_repr
1675     def __init__(self, *args, **kwargs):
1676         """
1677         __init__(self, wxDouble x=0.0, wxDouble y=0.0, wxDouble w=0.0, wxDouble h=0.0) -> Rect2D
1678
1679         wx.Rect2D is a rectangle, with position and size, in a 2D coordinate system
1680         with floating point component values.
1681         """
1682         _core_.Rect2D_swiginit(self,_core_.new_Rect2D(*args, **kwargs))
1683     __swig_destroy__ = _core_.delete_Rect2D
1684     __del__ = lambda self : None;
1685     def GetPosition(*args, **kwargs):
1686         """GetPosition(self) -> Point2D"""
1687         return _core_.Rect2D_GetPosition(*args, **kwargs)
1688
1689     def GetSize(*args, **kwargs):
1690         """GetSize(self) -> Size"""
1691         return _core_.Rect2D_GetSize(*args, **kwargs)
1692
1693     def GetLeft(*args, **kwargs):
1694         """GetLeft(self) -> wxDouble"""
1695         return _core_.Rect2D_GetLeft(*args, **kwargs)
1696
1697     def SetLeft(*args, **kwargs):
1698         """SetLeft(self, wxDouble n)"""
1699         return _core_.Rect2D_SetLeft(*args, **kwargs)
1700
1701     def MoveLeftTo(*args, **kwargs):
1702         """MoveLeftTo(self, wxDouble n)"""
1703         return _core_.Rect2D_MoveLeftTo(*args, **kwargs)
1704
1705     def GetTop(*args, **kwargs):
1706         """GetTop(self) -> wxDouble"""
1707         return _core_.Rect2D_GetTop(*args, **kwargs)
1708
1709     def SetTop(*args, **kwargs):
1710         """SetTop(self, wxDouble n)"""
1711         return _core_.Rect2D_SetTop(*args, **kwargs)
1712
1713     def MoveTopTo(*args, **kwargs):
1714         """MoveTopTo(self, wxDouble n)"""
1715         return _core_.Rect2D_MoveTopTo(*args, **kwargs)
1716
1717     def GetBottom(*args, **kwargs):
1718         """GetBottom(self) -> wxDouble"""
1719         return _core_.Rect2D_GetBottom(*args, **kwargs)
1720
1721     def SetBottom(*args, **kwargs):
1722         """SetBottom(self, wxDouble n)"""
1723         return _core_.Rect2D_SetBottom(*args, **kwargs)
1724
1725     def MoveBottomTo(*args, **kwargs):
1726         """MoveBottomTo(self, wxDouble n)"""
1727         return _core_.Rect2D_MoveBottomTo(*args, **kwargs)
1728
1729     def GetRight(*args, **kwargs):
1730         """GetRight(self) -> wxDouble"""
1731         return _core_.Rect2D_GetRight(*args, **kwargs)
1732
1733     def SetRight(*args, **kwargs):
1734         """SetRight(self, wxDouble n)"""
1735         return _core_.Rect2D_SetRight(*args, **kwargs)
1736
1737     def MoveRightTo(*args, **kwargs):
1738         """MoveRightTo(self, wxDouble n)"""
1739         return _core_.Rect2D_MoveRightTo(*args, **kwargs)
1740
1741     def GetLeftTop(*args, **kwargs):
1742         """GetLeftTop(self) -> Point2D"""
1743         return _core_.Rect2D_GetLeftTop(*args, **kwargs)
1744
1745     def SetLeftTop(*args, **kwargs):
1746         """SetLeftTop(self, Point2D pt)"""
1747         return _core_.Rect2D_SetLeftTop(*args, **kwargs)
1748
1749     def MoveLeftTopTo(*args, **kwargs):
1750         """MoveLeftTopTo(self, Point2D pt)"""
1751         return _core_.Rect2D_MoveLeftTopTo(*args, **kwargs)
1752
1753     def GetLeftBottom(*args, **kwargs):
1754         """GetLeftBottom(self) -> Point2D"""
1755         return _core_.Rect2D_GetLeftBottom(*args, **kwargs)
1756
1757     def SetLeftBottom(*args, **kwargs):
1758         """SetLeftBottom(self, Point2D pt)"""
1759         return _core_.Rect2D_SetLeftBottom(*args, **kwargs)
1760
1761     def MoveLeftBottomTo(*args, **kwargs):
1762         """MoveLeftBottomTo(self, Point2D pt)"""
1763         return _core_.Rect2D_MoveLeftBottomTo(*args, **kwargs)
1764
1765     def GetRightTop(*args, **kwargs):
1766         """GetRightTop(self) -> Point2D"""
1767         return _core_.Rect2D_GetRightTop(*args, **kwargs)
1768
1769     def SetRightTop(*args, **kwargs):
1770         """SetRightTop(self, Point2D pt)"""
1771         return _core_.Rect2D_SetRightTop(*args, **kwargs)
1772
1773     def MoveRightTopTo(*args, **kwargs):
1774         """MoveRightTopTo(self, Point2D pt)"""
1775         return _core_.Rect2D_MoveRightTopTo(*args, **kwargs)
1776
1777     def GetRightBottom(*args, **kwargs):
1778         """GetRightBottom(self) -> Point2D"""
1779         return _core_.Rect2D_GetRightBottom(*args, **kwargs)
1780
1781     def SetRightBottom(*args, **kwargs):
1782         """SetRightBottom(self, Point2D pt)"""
1783         return _core_.Rect2D_SetRightBottom(*args, **kwargs)
1784
1785     def MoveRightBottomTo(*args, **kwargs):
1786         """MoveRightBottomTo(self, Point2D pt)"""
1787         return _core_.Rect2D_MoveRightBottomTo(*args, **kwargs)
1788
1789     def GetCentre(*args, **kwargs):
1790         """GetCentre(self) -> Point2D"""
1791         return _core_.Rect2D_GetCentre(*args, **kwargs)
1792
1793     def SetCentre(*args, **kwargs):
1794         """SetCentre(self, Point2D pt)"""
1795         return _core_.Rect2D_SetCentre(*args, **kwargs)
1796
1797     def MoveCentreTo(*args, **kwargs):
1798         """MoveCentreTo(self, Point2D pt)"""
1799         return _core_.Rect2D_MoveCentreTo(*args, **kwargs)
1800
1801     def GetOutcode(*args, **kwargs):
1802         """GetOutcode(self, Point2D pt) -> int"""
1803         return _core_.Rect2D_GetOutcode(*args, **kwargs)
1804
1805     def Contains(*args, **kwargs):
1806         """Contains(self, Point2D pt) -> bool"""
1807         return _core_.Rect2D_Contains(*args, **kwargs)
1808
1809     def ContainsRect(*args, **kwargs):
1810         """ContainsRect(self, Rect2D rect) -> bool"""
1811         return _core_.Rect2D_ContainsRect(*args, **kwargs)
1812
1813     def IsEmpty(*args, **kwargs):
1814         """IsEmpty(self) -> bool"""
1815         return _core_.Rect2D_IsEmpty(*args, **kwargs)
1816
1817     def HaveEqualSize(*args, **kwargs):
1818         """HaveEqualSize(self, Rect2D rect) -> bool"""
1819         return _core_.Rect2D_HaveEqualSize(*args, **kwargs)
1820
1821     def Inset(*args):
1822         """
1823         Inset(self, wxDouble x, wxDouble y)
1824         Inset(self, wxDouble left, wxDouble top, wxDouble right, wxDouble bottom)
1825         """
1826         return _core_.Rect2D_Inset(*args)
1827
1828     def Offset(*args, **kwargs):
1829         """Offset(self, Point2D pt)"""
1830         return _core_.Rect2D_Offset(*args, **kwargs)
1831
1832     def ConstrainTo(*args, **kwargs):
1833         """ConstrainTo(self, Rect2D rect)"""
1834         return _core_.Rect2D_ConstrainTo(*args, **kwargs)
1835
1836     def Interpolate(*args, **kwargs):
1837         """Interpolate(self, int widthfactor, int heightfactor) -> Point2D"""
1838         return _core_.Rect2D_Interpolate(*args, **kwargs)
1839
1840     def Intersect(*args, **kwargs):
1841         """Intersect(self, Rect2D otherRect)"""
1842         return _core_.Rect2D_Intersect(*args, **kwargs)
1843
1844     def CreateIntersection(*args, **kwargs):
1845         """CreateIntersection(self, Rect2D otherRect) -> Rect2D"""
1846         return _core_.Rect2D_CreateIntersection(*args, **kwargs)
1847
1848     def Intersects(*args, **kwargs):
1849         """Intersects(self, Rect2D rect) -> bool"""
1850         return _core_.Rect2D_Intersects(*args, **kwargs)
1851
1852     def Union(*args, **kwargs):
1853         """Union(self, Rect2D otherRect)"""
1854         return _core_.Rect2D_Union(*args, **kwargs)
1855
1856     def CreateUnion(*args, **kwargs):
1857         """CreateUnion(self, Rect2D otherRect) -> Rect2D"""
1858         return _core_.Rect2D_CreateUnion(*args, **kwargs)
1859
1860     def Scale(*args):
1861         """
1862         Scale(self, wxDouble f)
1863         Scale(self, int num, int denum)
1864         """
1865         return _core_.Rect2D_Scale(*args)
1866
1867     def __eq__(*args, **kwargs):
1868         """
1869         __eq__(self, PyObject other) -> bool
1870
1871         Test for equality of wx.Rect2D objects.
1872         """
1873         return _core_.Rect2D___eq__(*args, **kwargs)
1874
1875     def __ne__(*args, **kwargs):
1876         """
1877         __ne__(self, PyObject other) -> bool
1878
1879         Test for inequality of wx.Rect2D objects.
1880         """
1881         return _core_.Rect2D___ne__(*args, **kwargs)
1882
1883     x = property(_core_.Rect2D_x_get, _core_.Rect2D_x_set)
1884     y = property(_core_.Rect2D_y_get, _core_.Rect2D_y_set)
1885     width = property(_core_.Rect2D_width_get, _core_.Rect2D_width_set)
1886     height = property(_core_.Rect2D_height_get, _core_.Rect2D_height_set)
1887     def Set(*args, **kwargs):
1888         """Set(self, wxDouble x=0, wxDouble y=0, wxDouble width=0, wxDouble height=0)"""
1889         return _core_.Rect2D_Set(*args, **kwargs)
1890
1891     def Get(*args, **kwargs):
1892         """
1893         Get() -> (x,y, width, height)
1894
1895         Return x, y, width and height y properties as a tuple.
1896         """
1897         return _core_.Rect2D_Get(*args, **kwargs)
1898
1899     def __str__(self):                   return str(self.Get())
1900     def __repr__(self):                  return 'wx.Rect2D'+str(self.Get())
1901     def __len__(self):                   return len(self.Get())
1902     def __getitem__(self, index):        return self.Get()[index]
1903     def __setitem__(self, index, val):
1904         if index == 0: self.x = val
1905         elif index == 1: self.y = val
1906         elif index == 2: self.width = val
1907         elif index == 3: self.height = val
1908         else: raise IndexError
1909     def __nonzero__(self):               return self.Get() != (0.0, 0.0, 0.0, 0.0)
1910     __safe_for_unpickling__ = True
1911     def __reduce__(self):                return (wx.Rect2D, self.Get())
1912
1913 _core_.Rect2D_swigregister(Rect2D)
1914
1915 #---------------------------------------------------------------------------
1916
1917 FromStart = _core_.FromStart
1918 FromCurrent = _core_.FromCurrent
1919 FromEnd = _core_.FromEnd
1920 class InputStream(object):
1921     """Proxy of C++ InputStream class"""
1922     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1923     __repr__ = _swig_repr
1924     def __init__(self, *args, **kwargs):
1925         """__init__(self, PyObject p) -> InputStream"""
1926         _core_.InputStream_swiginit(self,_core_.new_InputStream(*args, **kwargs))
1927     __swig_destroy__ = _core_.delete_InputStream
1928     __del__ = lambda self : None;
1929     def close(*args, **kwargs):
1930         """close(self)"""
1931         return _core_.InputStream_close(*args, **kwargs)
1932
1933     def flush(*args, **kwargs):
1934         """flush(self)"""
1935         return _core_.InputStream_flush(*args, **kwargs)
1936
1937     def eof(*args, **kwargs):
1938         """eof(self) -> bool"""
1939         return _core_.InputStream_eof(*args, **kwargs)
1940
1941     def read(*args, **kwargs):
1942         """read(self, int size=-1) -> PyObject"""
1943         return _core_.InputStream_read(*args, **kwargs)
1944
1945     def readline(*args, **kwargs):
1946         """readline(self, int size=-1) -> PyObject"""
1947         return _core_.InputStream_readline(*args, **kwargs)
1948
1949     def readlines(*args, **kwargs):
1950         """readlines(self, int sizehint=-1) -> PyObject"""
1951         return _core_.InputStream_readlines(*args, **kwargs)
1952
1953     def seek(*args, **kwargs):
1954         """seek(self, int offset, int whence=0)"""
1955         return _core_.InputStream_seek(*args, **kwargs)
1956
1957     def tell(*args, **kwargs):
1958         """tell(self) -> int"""
1959         return _core_.InputStream_tell(*args, **kwargs)
1960
1961     def Peek(*args, **kwargs):
1962         """Peek(self) -> char"""
1963         return _core_.InputStream_Peek(*args, **kwargs)
1964
1965     def GetC(*args, **kwargs):
1966         """GetC(self) -> char"""
1967         return _core_.InputStream_GetC(*args, **kwargs)
1968
1969     def LastRead(*args, **kwargs):
1970         """LastRead(self) -> size_t"""
1971         return _core_.InputStream_LastRead(*args, **kwargs)
1972
1973     def CanRead(*args, **kwargs):
1974         """CanRead(self) -> bool"""
1975         return _core_.InputStream_CanRead(*args, **kwargs)
1976
1977     def Eof(*args, **kwargs):
1978         """Eof(self) -> bool"""
1979         return _core_.InputStream_Eof(*args, **kwargs)
1980
1981     def Ungetch(*args, **kwargs):
1982         """Ungetch(self, char c) -> bool"""
1983         return _core_.InputStream_Ungetch(*args, **kwargs)
1984
1985     def SeekI(*args, **kwargs):
1986         """SeekI(self, long pos, int mode=FromStart) -> long"""
1987         return _core_.InputStream_SeekI(*args, **kwargs)
1988
1989     def TellI(*args, **kwargs):
1990         """TellI(self) -> long"""
1991         return _core_.InputStream_TellI(*args, **kwargs)
1992
1993 _core_.InputStream_swigregister(InputStream)
1994 DefaultPosition = cvar.DefaultPosition
1995 DefaultSize = cvar.DefaultSize
1996
1997 class OutputStream(object):
1998     """Proxy of C++ OutputStream class"""
1999     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2000     def __init__(self): raise AttributeError, "No constructor defined"
2001     __repr__ = _swig_repr
2002     def write(*args, **kwargs):
2003         """write(self, PyObject obj)"""
2004         return _core_.OutputStream_write(*args, **kwargs)
2005
2006     def LastWrite(*args, **kwargs):
2007         """LastWrite(self) -> size_t"""
2008         return _core_.OutputStream_LastWrite(*args, **kwargs)
2009
2010 _core_.OutputStream_swigregister(OutputStream)
2011
2012 #---------------------------------------------------------------------------
2013
2014 class FSFile(Object):
2015     """Proxy of C++ FSFile class"""
2016     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2017     __repr__ = _swig_repr
2018     def __init__(self, *args, **kwargs):
2019         """
2020         __init__(self, InputStream stream, String loc, String mimetype, String anchor,
2021             DateTime modif) -> FSFile
2022         """
2023         _core_.FSFile_swiginit(self,_core_.new_FSFile(*args, **kwargs))
2024     __swig_destroy__ = _core_.delete_FSFile
2025     __del__ = lambda self : None;
2026     def GetStream(*args, **kwargs):
2027         """GetStream(self) -> InputStream"""
2028         return _core_.FSFile_GetStream(*args, **kwargs)
2029
2030     def DetachStream(*args, **kwargs):
2031         """DetachStream(self)"""
2032         return _core_.FSFile_DetachStream(*args, **kwargs)
2033
2034     def GetMimeType(*args, **kwargs):
2035         """GetMimeType(self) -> String"""
2036         return _core_.FSFile_GetMimeType(*args, **kwargs)
2037
2038     def GetLocation(*args, **kwargs):
2039         """GetLocation(self) -> String"""
2040         return _core_.FSFile_GetLocation(*args, **kwargs)
2041
2042     def GetAnchor(*args, **kwargs):
2043         """GetAnchor(self) -> String"""
2044         return _core_.FSFile_GetAnchor(*args, **kwargs)
2045
2046     def GetModificationTime(*args, **kwargs):
2047         """GetModificationTime(self) -> DateTime"""
2048         return _core_.FSFile_GetModificationTime(*args, **kwargs)
2049
2050     Anchor = property(GetAnchor,doc="See `GetAnchor`")
2051     Location = property(GetLocation,doc="See `GetLocation`")
2052     MimeType = property(GetMimeType,doc="See `GetMimeType`")
2053     ModificationTime = property(GetModificationTime,doc="See `GetModificationTime`")
2054     Stream = property(GetStream,doc="See `GetStream`")
2055 _core_.FSFile_swigregister(FSFile)
2056
2057 class CPPFileSystemHandler(object):
2058     """Proxy of C++ CPPFileSystemHandler class"""
2059     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2060     def __init__(self): raise AttributeError, "No constructor defined"
2061     __repr__ = _swig_repr
2062     __swig_destroy__ = _core_.delete_CPPFileSystemHandler
2063     __del__ = lambda self : None;
2064 _core_.CPPFileSystemHandler_swigregister(CPPFileSystemHandler)
2065
2066 class FileSystemHandler(CPPFileSystemHandler):
2067     """Proxy of C++ FileSystemHandler class"""
2068     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2069     __repr__ = _swig_repr
2070     def __init__(self, *args, **kwargs):
2071         """__init__(self) -> FileSystemHandler"""
2072         _core_.FileSystemHandler_swiginit(self,_core_.new_FileSystemHandler(*args, **kwargs))
2073         FileSystemHandler._setCallbackInfo(self, self, FileSystemHandler)
2074
2075     def _setCallbackInfo(*args, **kwargs):
2076         """_setCallbackInfo(self, PyObject self, PyObject _class)"""
2077         return _core_.FileSystemHandler__setCallbackInfo(*args, **kwargs)
2078
2079     def CanOpen(*args, **kwargs):
2080         """CanOpen(self, String location) -> bool"""
2081         return _core_.FileSystemHandler_CanOpen(*args, **kwargs)
2082
2083     def OpenFile(*args, **kwargs):
2084         """OpenFile(self, FileSystem fs, String location) -> FSFile"""
2085         return _core_.FileSystemHandler_OpenFile(*args, **kwargs)
2086
2087     def FindFirst(*args, **kwargs):
2088         """FindFirst(self, String spec, int flags=0) -> String"""
2089         return _core_.FileSystemHandler_FindFirst(*args, **kwargs)
2090
2091     def FindNext(*args, **kwargs):
2092         """FindNext(self) -> String"""
2093         return _core_.FileSystemHandler_FindNext(*args, **kwargs)
2094
2095     def GetProtocol(*args, **kwargs):
2096         """GetProtocol(self, String location) -> String"""
2097         return _core_.FileSystemHandler_GetProtocol(*args, **kwargs)
2098
2099     def GetLeftLocation(*args, **kwargs):
2100         """GetLeftLocation(self, String location) -> String"""
2101         return _core_.FileSystemHandler_GetLeftLocation(*args, **kwargs)
2102
2103     def GetAnchor(*args, **kwargs):
2104         """GetAnchor(self, String location) -> String"""
2105         return _core_.FileSystemHandler_GetAnchor(*args, **kwargs)
2106
2107     def GetRightLocation(*args, **kwargs):
2108         """GetRightLocation(self, String location) -> String"""
2109         return _core_.FileSystemHandler_GetRightLocation(*args, **kwargs)
2110
2111     def GetMimeTypeFromExt(*args, **kwargs):
2112         """GetMimeTypeFromExt(self, String location) -> String"""
2113         return _core_.FileSystemHandler_GetMimeTypeFromExt(*args, **kwargs)
2114
2115     Anchor = property(GetAnchor,doc="See `GetAnchor`")
2116     LeftLocation = property(GetLeftLocation,doc="See `GetLeftLocation`")
2117     MimeTypeFromExt = property(GetMimeTypeFromExt,doc="See `GetMimeTypeFromExt`")
2118     Protocol = property(GetProtocol,doc="See `GetProtocol`")
2119     RightLocation = property(GetRightLocation,doc="See `GetRightLocation`")
2120 _core_.FileSystemHandler_swigregister(FileSystemHandler)
2121
2122 class FileSystem(Object):
2123     """Proxy of C++ FileSystem class"""
2124     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2125     __repr__ = _swig_repr
2126     def __init__(self, *args, **kwargs):
2127         """__init__(self) -> FileSystem"""
2128         _core_.FileSystem_swiginit(self,_core_.new_FileSystem(*args, **kwargs))
2129     __swig_destroy__ = _core_.delete_FileSystem
2130     __del__ = lambda self : None;
2131     def ChangePathTo(*args, **kwargs):
2132         """ChangePathTo(self, String location, bool is_dir=False)"""
2133         return _core_.FileSystem_ChangePathTo(*args, **kwargs)
2134
2135     def GetPath(*args, **kwargs):
2136         """GetPath(self) -> String"""
2137         return _core_.FileSystem_GetPath(*args, **kwargs)
2138
2139     def OpenFile(*args, **kwargs):
2140         """OpenFile(self, String location) -> FSFile"""
2141         return _core_.FileSystem_OpenFile(*args, **kwargs)
2142
2143     def FindFirst(*args, **kwargs):
2144         """FindFirst(self, String spec, int flags=0) -> String"""
2145         return _core_.FileSystem_FindFirst(*args, **kwargs)
2146
2147     def FindNext(*args, **kwargs):
2148         """FindNext(self) -> String"""
2149         return _core_.FileSystem_FindNext(*args, **kwargs)
2150
2151     def AddHandler(*args, **kwargs):
2152         """AddHandler(CPPFileSystemHandler handler)"""
2153         return _core_.FileSystem_AddHandler(*args, **kwargs)
2154
2155     AddHandler = staticmethod(AddHandler)
2156     def RemoveHandler(*args, **kwargs):
2157         """RemoveHandler(CPPFileSystemHandler handler) -> CPPFileSystemHandler"""
2158         return _core_.FileSystem_RemoveHandler(*args, **kwargs)
2159
2160     RemoveHandler = staticmethod(RemoveHandler)
2161     def CleanUpHandlers(*args, **kwargs):
2162         """CleanUpHandlers()"""
2163         return _core_.FileSystem_CleanUpHandlers(*args, **kwargs)
2164
2165     CleanUpHandlers = staticmethod(CleanUpHandlers)
2166     def FileNameToURL(*args, **kwargs):
2167         """FileNameToURL(String filename) -> String"""
2168         return _core_.FileSystem_FileNameToURL(*args, **kwargs)
2169
2170     FileNameToURL = staticmethod(FileNameToURL)
2171     def URLToFileName(*args, **kwargs):
2172         """URLToFileName(String url) -> String"""
2173         return _core_.FileSystem_URLToFileName(*args, **kwargs)
2174
2175     URLToFileName = staticmethod(URLToFileName)
2176     Path = property(GetPath,doc="See `GetPath`")
2177 _core_.FileSystem_swigregister(FileSystem)
2178
2179 def FileSystem_AddHandler(*args, **kwargs):
2180   """FileSystem_AddHandler(CPPFileSystemHandler handler)"""
2181   return _core_.FileSystem_AddHandler(*args, **kwargs)
2182
2183 def FileSystem_RemoveHandler(*args, **kwargs):
2184   """FileSystem_RemoveHandler(CPPFileSystemHandler handler) -> CPPFileSystemHandler"""
2185   return _core_.FileSystem_RemoveHandler(*args, **kwargs)
2186
2187 def FileSystem_CleanUpHandlers(*args):
2188   """FileSystem_CleanUpHandlers()"""
2189   return _core_.FileSystem_CleanUpHandlers(*args)
2190
2191 def FileSystem_FileNameToURL(*args, **kwargs):
2192   """FileSystem_FileNameToURL(String filename) -> String"""
2193   return _core_.FileSystem_FileNameToURL(*args, **kwargs)
2194
2195 def FileSystem_URLToFileName(*args, **kwargs):
2196   """FileSystem_URLToFileName(String url) -> String"""
2197   return _core_.FileSystem_URLToFileName(*args, **kwargs)
2198
2199 class InternetFSHandler(CPPFileSystemHandler):
2200     """Proxy of C++ InternetFSHandler class"""
2201     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2202     __repr__ = _swig_repr
2203     def __init__(self, *args, **kwargs):
2204         """__init__(self) -> InternetFSHandler"""
2205         _core_.InternetFSHandler_swiginit(self,_core_.new_InternetFSHandler(*args, **kwargs))
2206     def CanOpen(*args, **kwargs):
2207         """CanOpen(self, String location) -> bool"""
2208         return _core_.InternetFSHandler_CanOpen(*args, **kwargs)
2209
2210     def OpenFile(*args, **kwargs):
2211         """OpenFile(self, FileSystem fs, String location) -> FSFile"""
2212         return _core_.InternetFSHandler_OpenFile(*args, **kwargs)
2213
2214 _core_.InternetFSHandler_swigregister(InternetFSHandler)
2215
2216 class ZipFSHandler(CPPFileSystemHandler):
2217     """Proxy of C++ ZipFSHandler class"""
2218     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2219     __repr__ = _swig_repr
2220     def __init__(self, *args, **kwargs):
2221         """__init__(self) -> ZipFSHandler"""
2222         _core_.ZipFSHandler_swiginit(self,_core_.new_ZipFSHandler(*args, **kwargs))
2223     def CanOpen(*args, **kwargs):
2224         """CanOpen(self, String location) -> bool"""
2225         return _core_.ZipFSHandler_CanOpen(*args, **kwargs)
2226
2227     def OpenFile(*args, **kwargs):
2228         """OpenFile(self, FileSystem fs, String location) -> FSFile"""
2229         return _core_.ZipFSHandler_OpenFile(*args, **kwargs)
2230
2231     def FindFirst(*args, **kwargs):
2232         """FindFirst(self, String spec, int flags=0) -> String"""
2233         return _core_.ZipFSHandler_FindFirst(*args, **kwargs)
2234
2235     def FindNext(*args, **kwargs):
2236         """FindNext(self) -> String"""
2237         return _core_.ZipFSHandler_FindNext(*args, **kwargs)
2238
2239 _core_.ZipFSHandler_swigregister(ZipFSHandler)
2240
2241
2242 def __wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs):
2243   """__wxMemoryFSHandler_AddFile_wxImage(String filename, Image image, long type)"""
2244   return _core_.__wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs)
2245
2246 def __wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs):
2247   """__wxMemoryFSHandler_AddFile_wxBitmap(String filename, Bitmap bitmap, long type)"""
2248   return _core_.__wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs)
2249
2250 def __wxMemoryFSHandler_AddFile_Data(*args, **kwargs):
2251   """__wxMemoryFSHandler_AddFile_Data(String filename, PyObject data)"""
2252   return _core_.__wxMemoryFSHandler_AddFile_Data(*args, **kwargs)
2253 def MemoryFSHandler_AddFile(filename, dataItem, imgType=-1):
2254     """
2255     Add 'file' to the memory filesystem.  The dataItem parameter can
2256     either be a `wx.Bitmap`, `wx.Image` or a string that can contain
2257     arbitrary data.  If a bitmap or image is used then the imgType
2258     parameter should specify what kind of image file it should be
2259     written as, wx.BITMAP_TYPE_PNG, etc.
2260     """
2261     if isinstance(dataItem, wx.Image):
2262         __wxMemoryFSHandler_AddFile_wxImage(filename, dataItem, imgType)
2263     elif isinstance(dataItem, wx.Bitmap):
2264         __wxMemoryFSHandler_AddFile_wxBitmap(filename, dataItem, imgType)
2265     elif type(dataItem) == str:
2266         __wxMemoryFSHandler_AddFile_Data(filename, dataItem)
2267     else:
2268         raise TypeError, 'wx.Image, wx.Bitmap or string expected'
2269
2270 class MemoryFSHandler(CPPFileSystemHandler):
2271     """Proxy of C++ MemoryFSHandler class"""
2272     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2273     __repr__ = _swig_repr
2274     def __init__(self, *args, **kwargs):
2275         """__init__(self) -> MemoryFSHandler"""
2276         _core_.MemoryFSHandler_swiginit(self,_core_.new_MemoryFSHandler(*args, **kwargs))
2277     def RemoveFile(*args, **kwargs):
2278         """RemoveFile(String filename)"""
2279         return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
2280
2281     RemoveFile = staticmethod(RemoveFile)
2282     AddFile = staticmethod(MemoryFSHandler_AddFile)
2283     def CanOpen(*args, **kwargs):
2284         """CanOpen(self, String location) -> bool"""
2285         return _core_.MemoryFSHandler_CanOpen(*args, **kwargs)
2286
2287     def OpenFile(*args, **kwargs):
2288         """OpenFile(self, FileSystem fs, String location) -> FSFile"""
2289         return _core_.MemoryFSHandler_OpenFile(*args, **kwargs)
2290
2291     def FindFirst(*args, **kwargs):
2292         """FindFirst(self, String spec, int flags=0) -> String"""
2293         return _core_.MemoryFSHandler_FindFirst(*args, **kwargs)
2294
2295     def FindNext(*args, **kwargs):
2296         """FindNext(self) -> String"""
2297         return _core_.MemoryFSHandler_FindNext(*args, **kwargs)
2298
2299 _core_.MemoryFSHandler_swigregister(MemoryFSHandler)
2300
2301 def MemoryFSHandler_RemoveFile(*args, **kwargs):
2302   """MemoryFSHandler_RemoveFile(String filename)"""
2303   return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
2304
2305 IMAGE_ALPHA_TRANSPARENT = _core_.IMAGE_ALPHA_TRANSPARENT
2306 IMAGE_ALPHA_THRESHOLD = _core_.IMAGE_ALPHA_THRESHOLD
2307 IMAGE_ALPHA_OPAQUE = _core_.IMAGE_ALPHA_OPAQUE
2308 IMAGE_QUALITY_NORMAL = _core_.IMAGE_QUALITY_NORMAL
2309 IMAGE_QUALITY_HIGH = _core_.IMAGE_QUALITY_HIGH
2310 #---------------------------------------------------------------------------
2311
2312 class ImageHandler(Object):
2313     """
2314     This is the base class for implementing image file loading/saving, and
2315     image creation from data. It is used within `wx.Image` and is not
2316     normally seen by the application.
2317     """
2318     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2319     def __init__(self): raise AttributeError, "No constructor defined"
2320     __repr__ = _swig_repr
2321     def GetName(*args, **kwargs):
2322         """GetName(self) -> String"""
2323         return _core_.ImageHandler_GetName(*args, **kwargs)
2324
2325     def GetExtension(*args, **kwargs):
2326         """GetExtension(self) -> String"""
2327         return _core_.ImageHandler_GetExtension(*args, **kwargs)
2328
2329     def GetType(*args, **kwargs):
2330         """GetType(self) -> long"""
2331         return _core_.ImageHandler_GetType(*args, **kwargs)
2332
2333     def GetMimeType(*args, **kwargs):
2334         """GetMimeType(self) -> String"""
2335         return _core_.ImageHandler_GetMimeType(*args, **kwargs)
2336
2337     def CanRead(*args, **kwargs):
2338         """CanRead(self, String name) -> bool"""
2339         return _core_.ImageHandler_CanRead(*args, **kwargs)
2340
2341     def CanReadStream(*args, **kwargs):
2342         """CanReadStream(self, InputStream stream) -> bool"""
2343         return _core_.ImageHandler_CanReadStream(*args, **kwargs)
2344
2345     def SetName(*args, **kwargs):
2346         """SetName(self, String name)"""
2347         return _core_.ImageHandler_SetName(*args, **kwargs)
2348
2349     def SetExtension(*args, **kwargs):
2350         """SetExtension(self, String extension)"""
2351         return _core_.ImageHandler_SetExtension(*args, **kwargs)
2352
2353     def SetType(*args, **kwargs):
2354         """SetType(self, long type)"""
2355         return _core_.ImageHandler_SetType(*args, **kwargs)
2356
2357     def SetMimeType(*args, **kwargs):
2358         """SetMimeType(self, String mimetype)"""
2359         return _core_.ImageHandler_SetMimeType(*args, **kwargs)
2360
2361     Extension = property(GetExtension,SetExtension,doc="See `GetExtension` and `SetExtension`")
2362     MimeType = property(GetMimeType,SetMimeType,doc="See `GetMimeType` and `SetMimeType`")
2363     Name = property(GetName,SetName,doc="See `GetName` and `SetName`")
2364     Type = property(GetType,SetType,doc="See `GetType` and `SetType`")
2365 _core_.ImageHandler_swigregister(ImageHandler)
2366
2367 class PyImageHandler(ImageHandler):
2368     """
2369     This is the base class for implementing image file loading/saving, and
2370     image creation from data, all written in Python.  To create a custom
2371     image handler derive a new class from wx.PyImageHandler and provide
2372     the following methods::
2373
2374         def DoCanRead(self, stream) --> bool
2375             '''Check if this handler can read the image on the stream'''
2376
2377         def LoadFile(self, image, stream, verbose, index) --> bool
2378             '''Load image data from the stream and load it into image.'''
2379
2380         def SaveFile(self, image, stream, verbose) --> bool
2381             '''Save the iamge data in image to the stream using
2382                this handler's image file format.'''
2383
2384         def GetImageCount(self, stream) --> int
2385             '''If this image format can hold more than one image,
2386                how many does the image on the stream have?'''
2387
2388     To activate your handler create an instance of it and pass it to
2389     `wx.Image_AddHandler`.  Be sure to call `SetName`, `SetType`, and
2390     `SetExtension` from your constructor.
2391
2392     """
2393     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2394     __repr__ = _swig_repr
2395     def __init__(self, *args, **kwargs):
2396         """
2397         __init__(self) -> PyImageHandler
2398
2399         This is the base class for implementing image file loading/saving, and
2400         image creation from data, all written in Python.  To create a custom
2401         image handler derive a new class from wx.PyImageHandler and provide
2402         the following methods::
2403
2404             def DoCanRead(self, stream) --> bool
2405                 '''Check if this handler can read the image on the stream'''
2406
2407             def LoadFile(self, image, stream, verbose, index) --> bool
2408                 '''Load image data from the stream and load it into image.'''
2409
2410             def SaveFile(self, image, stream, verbose) --> bool
2411                 '''Save the iamge data in image to the stream using
2412                    this handler's image file format.'''
2413
2414             def GetImageCount(self, stream) --> int
2415                 '''If this image format can hold more than one image,
2416                    how many does the image on the stream have?'''
2417
2418         To activate your handler create an instance of it and pass it to
2419         `wx.Image_AddHandler`.  Be sure to call `SetName`, `SetType`, and
2420         `SetExtension` from your constructor.
2421
2422         """
2423         _core_.PyImageHandler_swiginit(self,_core_.new_PyImageHandler(*args, **kwargs))
2424         self._SetSelf(self)
2425
2426     def _SetSelf(*args, **kwargs):
2427         """_SetSelf(self, PyObject self)"""
2428         return _core_.PyImageHandler__SetSelf(*args, **kwargs)
2429
2430 _core_.PyImageHandler_swigregister(PyImageHandler)
2431
2432 class ImageHistogram(object):
2433     """Proxy of C++ ImageHistogram class"""
2434     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2435     __repr__ = _swig_repr
2436     def __init__(self, *args, **kwargs):
2437         """__init__(self) -> ImageHistogram"""
2438         _core_.ImageHistogram_swiginit(self,_core_.new_ImageHistogram(*args, **kwargs))
2439     def MakeKey(*args, **kwargs):
2440         """
2441         MakeKey(byte r, byte g, byte b) -> unsigned long
2442
2443         Get the key in the histogram for the given RGB values
2444         """
2445         return _core_.ImageHistogram_MakeKey(*args, **kwargs)
2446
2447     MakeKey = staticmethod(MakeKey)
2448     def FindFirstUnusedColour(*args, **kwargs):
2449         """
2450         FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2451
2452         Find first colour that is not used in the image and has higher RGB
2453         values than startR, startG, startB.  Returns a tuple consisting of a
2454         success flag and rgb values.
2455         """
2456         return _core_.ImageHistogram_FindFirstUnusedColour(*args, **kwargs)
2457
2458     def GetCount(*args, **kwargs):
2459         """
2460         GetCount(self, unsigned long key) -> unsigned long
2461
2462         Returns the pixel count for the given key.  Use `MakeKey` to create a
2463         key value from a RGB tripple.
2464         """
2465         return _core_.ImageHistogram_GetCount(*args, **kwargs)
2466
2467     def GetCountRGB(*args, **kwargs):
2468         """
2469         GetCountRGB(self, byte r, byte g, byte b) -> unsigned long
2470
2471         Returns the pixel count for the given RGB values.
2472         """
2473         return _core_.ImageHistogram_GetCountRGB(*args, **kwargs)
2474
2475     def GetCountColour(*args, **kwargs):
2476         """
2477         GetCountColour(self, Colour colour) -> unsigned long
2478
2479         Returns the pixel count for the given `wx.Colour` value.
2480         """
2481         return _core_.ImageHistogram_GetCountColour(*args, **kwargs)
2482
2483 _core_.ImageHistogram_swigregister(ImageHistogram)
2484
2485 def ImageHistogram_MakeKey(*args, **kwargs):
2486   """
2487     ImageHistogram_MakeKey(byte r, byte g, byte b) -> unsigned long
2488
2489     Get the key in the histogram for the given RGB values
2490     """
2491   return _core_.ImageHistogram_MakeKey(*args, **kwargs)
2492
2493 class Image_RGBValue(object):
2494     """
2495     An object that contains values for red, green and blue which represent
2496     the value of a color. It is used by `wx.Image.HSVtoRGB` and
2497     `wx.Image.RGBtoHSV`, which converts between HSV color space and RGB
2498     color space.
2499     """
2500     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2501     __repr__ = _swig_repr
2502     def __init__(self, *args, **kwargs):
2503         """
2504         __init__(self, byte r=0, byte g=0, byte b=0) -> Image_RGBValue
2505
2506         Constructor.
2507         """
2508         _core_.Image_RGBValue_swiginit(self,_core_.new_Image_RGBValue(*args, **kwargs))
2509     red = property(_core_.Image_RGBValue_red_get, _core_.Image_RGBValue_red_set)
2510     green = property(_core_.Image_RGBValue_green_get, _core_.Image_RGBValue_green_set)
2511     blue = property(_core_.Image_RGBValue_blue_get, _core_.Image_RGBValue_blue_set)
2512 _core_.Image_RGBValue_swigregister(Image_RGBValue)
2513
2514 class Image_HSVValue(object):
2515     """
2516     An object that contains values for hue, saturation and value which
2517     represent the value of a color.  It is used by `wx.Image.HSVtoRGB` and
2518     `wx.Image.RGBtoHSV`, which +converts between HSV color space and RGB
2519     color space.
2520     """
2521     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2522     __repr__ = _swig_repr
2523     def __init__(self, *args, **kwargs):
2524         """
2525         __init__(self, double h=0.0, double s=0.0, double v=0.0) -> Image_HSVValue
2526
2527         Constructor.
2528         """
2529         _core_.Image_HSVValue_swiginit(self,_core_.new_Image_HSVValue(*args, **kwargs))
2530     hue = property(_core_.Image_HSVValue_hue_get, _core_.Image_HSVValue_hue_set)
2531     saturation = property(_core_.Image_HSVValue_saturation_get, _core_.Image_HSVValue_saturation_set)
2532     value = property(_core_.Image_HSVValue_value_get, _core_.Image_HSVValue_value_set)
2533 _core_.Image_HSVValue_swigregister(Image_HSVValue)
2534
2535 class Image(Object):
2536     """
2537     A platform-independent image class.  An image can be created from
2538     data, or using `wx.Bitmap.ConvertToImage`, or loaded from a file in a
2539     variety of formats.  Functions are available to set and get image
2540     bits, so it can be used for basic image manipulation.
2541
2542     A wx.Image cannot be drawn directly to a `wx.DC`.  Instead, a
2543     platform-specific `wx.Bitmap` object must be created from it using the
2544     `wx.BitmapFromImage` constructor. This bitmap can then be drawn in a
2545     device context, using `wx.DC.DrawBitmap`.
2546
2547     One colour value of the image may be used as a mask colour which will
2548     lead to the automatic creation of a `wx.Mask` object associated to the
2549     bitmap object.
2550
2551     wx.Image supports alpha channel data, that is in addition to a byte
2552     for the red, green and blue colour components for each pixel it also
2553     stores a byte representing the pixel opacity. An alpha value of 0
2554     corresponds to a transparent pixel (null opacity) while a value of 255
2555     means that the pixel is 100% opaque.
2556
2557     Unlike RGB data, not all images have an alpha channel and before using
2558     `GetAlpha` you should check if this image contains an alpha channel
2559     with `HasAlpha`. Note that currently only images loaded from PNG files
2560     with transparency information will have an alpha channel.
2561     """
2562     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2563     __repr__ = _swig_repr
2564     def __init__(self, *args, **kwargs):
2565         """
2566         __init__(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
2567
2568         Loads an image from a file.
2569         """
2570         _core_.Image_swiginit(self,_core_.new_Image(*args, **kwargs))
2571     __swig_destroy__ = _core_.delete_Image
2572     __del__ = lambda self : None;
2573     def Create(*args, **kwargs):
2574         """
2575         Create(self, int width, int height, bool clear=True)
2576
2577         Creates a fresh image.  If clear is ``True``, the new image will be
2578         initialized to black. Otherwise, the image data will be uninitialized.
2579         """
2580         return _core_.Image_Create(*args, **kwargs)
2581
2582     def Destroy(*args, **kwargs):
2583         """
2584         Destroy(self)
2585
2586         Destroys the image data.
2587         """
2588         args[0].this.own(False)
2589         return _core_.Image_Destroy(*args, **kwargs)
2590
2591     def Scale(*args, **kwargs):
2592         """
2593         Scale(self, int width, int height, int quality=IMAGE_QUALITY_NORMAL) -> Image
2594
2595         Returns a scaled version of the image. This is also useful for scaling
2596         bitmaps in general as the only other way to scale bitmaps is to blit a
2597         `wx.MemoryDC` into another `wx.MemoryDC`.  The ``quality`` parameter
2598         specifies what method to use for resampling the image.  It can be
2599         either wx.IMAGE_QUALITY_NORMAL, which uses the normal default scaling
2600         method of pixel replication, or wx.IMAGE_QUALITY_HIGH which uses
2601         bicubic and box averaging resampling methods for upsampling and
2602         downsampling respectively.
2603         """
2604         return _core_.Image_Scale(*args, **kwargs)
2605
2606     def ResampleBox(*args, **kwargs):
2607         """ResampleBox(self, int width, int height) -> Image"""
2608         return _core_.Image_ResampleBox(*args, **kwargs)
2609
2610     def ResampleBicubic(*args, **kwargs):
2611         """ResampleBicubic(self, int width, int height) -> Image"""
2612         return _core_.Image_ResampleBicubic(*args, **kwargs)
2613
2614     def Blur(*args, **kwargs):
2615         """
2616         Blur(self, int radius) -> Image
2617
2618         Blurs the image in both horizontal and vertical directions by the
2619         specified pixel ``radius``. This should not be used when using a
2620         single mask colour for transparency.
2621         """
2622         return _core_.Image_Blur(*args, **kwargs)
2623
2624     def BlurHorizontal(*args, **kwargs):
2625         """
2626         BlurHorizontal(self, int radius) -> Image
2627
2628         Blurs the image in the horizontal direction only. This should not be
2629         used when using a single mask colour for transparency.
2630
2631         """
2632         return _core_.Image_BlurHorizontal(*args, **kwargs)
2633
2634     def BlurVertical(*args, **kwargs):
2635         """
2636         BlurVertical(self, int radius) -> Image
2637
2638         Blurs the image in the vertical direction only. This should not be
2639         used when using a single mask colour for transparency.
2640         """
2641         return _core_.Image_BlurVertical(*args, **kwargs)
2642
2643     def ShrinkBy(*args, **kwargs):
2644         """
2645         ShrinkBy(self, int xFactor, int yFactor) -> Image
2646
2647         Return a version of the image scaled smaller by the given factors.
2648         """
2649         return _core_.Image_ShrinkBy(*args, **kwargs)
2650
2651     def Rescale(*args, **kwargs):
2652         """
2653         Rescale(self, int width, int height, int quality=IMAGE_QUALITY_NORMAL) -> Image
2654
2655         Changes the size of the image in-place by scaling it: after a call to
2656         this function, the image will have the given width and height.
2657
2658         Returns the (modified) image itself.
2659         """
2660         return _core_.Image_Rescale(*args, **kwargs)
2661
2662     def Resize(*args, **kwargs):
2663         """
2664         Resize(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
2665
2666         Changes the size of the image in-place without scaling it, by adding
2667         either a border with the given colour or cropping as necessary. The
2668         image is pasted into a new image with the given size and background
2669         colour at the position pos relative to the upper left of the new
2670         image. If red = green = blue = -1 then use either the current mask
2671         colour if set or find, use, and set a suitable mask colour for any
2672         newly exposed areas.
2673
2674         Returns the (modified) image itself.
2675         """
2676         return _core_.Image_Resize(*args, **kwargs)
2677
2678     def SetRGB(*args, **kwargs):
2679         """
2680         SetRGB(self, int x, int y, byte r, byte g, byte b)
2681
2682         Sets the pixel at the given coordinate. This routine performs
2683         bounds-checks for the coordinate so it can be considered a safe way to
2684         manipulate the data, but in some cases this might be too slow so that
2685         the data will have to be set directly. In that case you will have to
2686         get access to the image data using the `GetData` method.
2687         """
2688         return _core_.Image_SetRGB(*args, **kwargs)
2689
2690     def SetRGBRect(*args, **kwargs):
2691         """
2692         SetRGBRect(self, Rect rect, byte r, byte g, byte b)
2693
2694         Sets the colour of the pixels within the given rectangle. This routine
2695         performs bounds-checks for the rectangle so it can be considered a
2696         safe way to manipulate the data.
2697         """
2698         return _core_.Image_SetRGBRect(*args, **kwargs)
2699
2700     def GetRed(*args, **kwargs):
2701         """
2702         GetRed(self, int x, int y) -> byte
2703
2704         Returns the red intensity at the given coordinate.
2705         """
2706         return _core_.Image_GetRed(*args, **kwargs)
2707
2708     def GetGreen(*args, **kwargs):
2709         """
2710         GetGreen(self, int x, int y) -> byte
2711
2712         Returns the green intensity at the given coordinate.
2713         """
2714         return _core_.Image_GetGreen(*args, **kwargs)
2715
2716     def GetBlue(*args, **kwargs):
2717         """
2718         GetBlue(self, int x, int y) -> byte
2719
2720         Returns the blue intensity at the given coordinate.
2721         """
2722         return _core_.Image_GetBlue(*args, **kwargs)
2723
2724     def SetAlpha(*args, **kwargs):
2725         """
2726         SetAlpha(self, int x, int y, byte alpha)
2727
2728         Sets the alpha value for the given pixel. This function should only be
2729         called if the image has alpha channel data, use `HasAlpha` to check
2730         for this.
2731         """
2732         return _core_.Image_SetAlpha(*args, **kwargs)
2733
2734     def GetAlpha(*args, **kwargs):
2735         """
2736         GetAlpha(self, int x, int y) -> byte
2737
2738         Returns the alpha value for the given pixel. This function may only be
2739         called for the images with alpha channel, use `HasAlpha` to check for
2740         this.
2741
2742         The returned value is the *opacity* of the image, i.e. the value of 0
2743         corresponds to the fully transparent pixels while the value of 255 to
2744         the fully opaque pixels.
2745         """
2746         return _core_.Image_GetAlpha(*args, **kwargs)
2747
2748     def HasAlpha(*args, **kwargs):
2749         """
2750         HasAlpha(self) -> bool
2751
2752         Returns true if this image has alpha channel, false otherwise.
2753         """
2754         return _core_.Image_HasAlpha(*args, **kwargs)
2755
2756     def InitAlpha(*args, **kwargs):
2757         """
2758         InitAlpha(self)
2759
2760         Initializes the image alpha channel data. It is an error to call it if
2761         the image already has alpha data. If it doesn't, alpha data will be by
2762         default initialized to all pixels being fully opaque. But if the image
2763         has a a mask colour, all mask pixels will be completely transparent.
2764         """
2765         return _core_.Image_InitAlpha(*args, **kwargs)
2766
2767     def IsTransparent(*args, **kwargs):
2768         """
2769         IsTransparent(self, int x, int y, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
2770
2771         Returns ``True`` if this pixel is masked or has an alpha value less
2772         than the spcified threshold.
2773         """
2774         return _core_.Image_IsTransparent(*args, **kwargs)
2775
2776     def FindFirstUnusedColour(*args, **kwargs):
2777         """
2778         FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2779
2780         Find first colour that is not used in the image and has higher RGB
2781         values than startR, startG, startB.  Returns a tuple consisting of a
2782         success flag and rgb values.
2783         """
2784         return _core_.Image_FindFirstUnusedColour(*args, **kwargs)
2785
2786     def ConvertAlphaToMask(*args, **kwargs):
2787         """
2788         ConvertAlphaToMask(self, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
2789
2790         If the image has alpha channel, this method converts it to mask. All
2791         pixels with alpha value less than ``threshold`` are replaced with the
2792         mask colour and the alpha channel is removed. The mask colour is
2793         chosen automatically using `FindFirstUnusedColour`.
2794
2795         If the image image doesn't have alpha channel, ConvertAlphaToMask does
2796         nothing.
2797         """
2798         return _core_.Image_ConvertAlphaToMask(*args, **kwargs)
2799
2800     def ConvertColourToAlpha(*args, **kwargs):
2801         """
2802         ConvertColourToAlpha(self, byte r, byte g, byte b) -> bool
2803
2804         This method converts an image where the original alpha information is
2805         only available as a shades of a colour (actually shades of grey)
2806         typically when you draw anti-aliased text into a bitmap. The DC
2807         drawing routines draw grey values on the black background although
2808         they actually mean to draw white with differnt alpha values.  This
2809         method reverses it, assuming a black (!) background and white text.
2810         The method will then fill up the whole image with the colour given.
2811         """
2812         return _core_.Image_ConvertColourToAlpha(*args, **kwargs)
2813
2814     def SetMaskFromImage(*args, **kwargs):
2815         """
2816         SetMaskFromImage(self, Image mask, byte mr, byte mg, byte mb) -> bool
2817
2818         Sets the image's mask so that the pixels that have RGB value of
2819         ``(mr,mg,mb)`` in ``mask`` will be masked in this image. This is done
2820         by first finding an unused colour in the image, setting this colour as
2821         the mask colour and then using this colour to draw all pixels in the
2822         image who corresponding pixel in mask has given RGB value.
2823
2824         Returns ``False`` if ``mask`` does not have same dimensions as the
2825         image or if there is no unused colour left. Returns ``True`` if the
2826         mask was successfully applied.
2827
2828         Note that this method involves computing the histogram, which is
2829         computationally intensive operation.
2830         """
2831         return _core_.Image_SetMaskFromImage(*args, **kwargs)
2832
2833     def CanRead(*args, **kwargs):
2834         """
2835         CanRead(String filename) -> bool
2836
2837         Returns True if the image handlers can read this file.
2838         """
2839         return _core_.Image_CanRead(*args, **kwargs)
2840
2841     CanRead = staticmethod(CanRead)
2842     def GetImageCount(*args, **kwargs):
2843         """
2844         GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
2845
2846         If the image file contains more than one image and the image handler
2847         is capable of retrieving these individually, this function will return
2848         the number of available images.
2849         """
2850         return _core_.Image_GetImageCount(*args, **kwargs)
2851
2852     GetImageCount = staticmethod(GetImageCount)
2853     def LoadFile(*args, **kwargs):
2854         """
2855         LoadFile(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2856
2857         Loads an image from a file. If no handler type is provided, the
2858         library will try to autodetect the format.
2859         """
2860         return _core_.Image_LoadFile(*args, **kwargs)
2861
2862     def LoadMimeFile(*args, **kwargs):
2863         """
2864         LoadMimeFile(self, String name, String mimetype, int index=-1) -> bool
2865
2866         Loads an image from a file, specifying the image type with a MIME type
2867         string.
2868         """
2869         return _core_.Image_LoadMimeFile(*args, **kwargs)
2870
2871     def SaveFile(*args, **kwargs):
2872         """
2873         SaveFile(self, String name, int type) -> bool
2874
2875         Saves an image in the named file.
2876         """
2877         return _core_.Image_SaveFile(*args, **kwargs)
2878
2879     def SaveMimeFile(*args, **kwargs):
2880         """
2881         SaveMimeFile(self, String name, String mimetype) -> bool
2882
2883         Saves an image in the named file.
2884         """
2885         return _core_.Image_SaveMimeFile(*args, **kwargs)
2886
2887     def CanReadStream(*args, **kwargs):
2888         """
2889         CanReadStream(InputStream stream) -> bool
2890
2891         Returns True if the image handlers can read an image file from the
2892         data currently on the input stream, or a readable Python file-like
2893         object.
2894         """
2895         return _core_.Image_CanReadStream(*args, **kwargs)
2896
2897     CanReadStream = staticmethod(CanReadStream)
2898     def LoadStream(*args, **kwargs):
2899         """
2900         LoadStream(self, InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2901
2902         Loads an image from an input stream or a readable Python file-like
2903         object. If no handler type is provided, the library will try to
2904         autodetect the format.
2905         """
2906         return _core_.Image_LoadStream(*args, **kwargs)
2907
2908     def LoadMimeStream(*args, **kwargs):
2909         """
2910         LoadMimeStream(self, InputStream stream, String mimetype, int index=-1) -> bool
2911
2912         Loads an image from an input stream or a readable Python file-like
2913         object, using a MIME type string to specify the image file format.
2914         """
2915         return _core_.Image_LoadMimeStream(*args, **kwargs)
2916
2917     def IsOk(*args, **kwargs):
2918         """
2919         IsOk(self) -> bool
2920
2921         Returns true if image data is present.
2922         """
2923         return _core_.Image_IsOk(*args, **kwargs)
2924
2925     Ok = IsOk
2926     def GetWidth(*args, **kwargs):
2927         """
2928         GetWidth(self) -> int
2929
2930         Gets the width of the image in pixels.
2931         """
2932         return _core_.Image_GetWidth(*args, **kwargs)
2933
2934     def GetHeight(*args, **kwargs):
2935         """
2936         GetHeight(self) -> int
2937
2938         Gets the height of the image in pixels.
2939         """
2940         return _core_.Image_GetHeight(*args, **kwargs)
2941
2942     def GetSize(*args, **kwargs):
2943         """
2944         GetSize(self) -> Size
2945
2946         Returns the size of the image in pixels.
2947         """
2948         return _core_.Image_GetSize(*args, **kwargs)
2949
2950     def GetSubImage(*args, **kwargs):
2951         """
2952         GetSubImage(self, Rect rect) -> Image
2953
2954         Returns a sub image of the current one as long as the rect belongs
2955         entirely to the image.
2956         """
2957         return _core_.Image_GetSubImage(*args, **kwargs)
2958
2959     def Size(*args, **kwargs):
2960         """
2961         Size(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
2962
2963         Returns a resized version of this image without scaling it by adding
2964         either a border with the given colour or cropping as necessary. The
2965         image is pasted into a new image with the given size and background
2966         colour at the position ``pos`` relative to the upper left of the new
2967         image. If red = green = blue = -1 then use either the current mask
2968         colour if set or find, use, and set a suitable mask colour for any
2969         newly exposed areas.
2970         """
2971         return _core_.Image_Size(*args, **kwargs)
2972
2973     def Copy(*args, **kwargs):
2974         """
2975         Copy(self) -> Image
2976
2977         Returns an identical copy of the image.
2978         """
2979         return _core_.Image_Copy(*args, **kwargs)
2980
2981     def Paste(*args, **kwargs):
2982         """
2983         Paste(self, Image image, int x, int y)
2984
2985         Pastes ``image`` into this instance and takes care of the mask colour
2986         and any out of bounds problems.
2987         """
2988         return _core_.Image_Paste(*args, **kwargs)
2989
2990     def GetData(*args, **kwargs):
2991         """
2992         GetData(self) -> PyObject
2993
2994         Returns a string containing a copy of the RGB bytes of the image.
2995         """
2996         return _core_.Image_GetData(*args, **kwargs)
2997
2998     def SetData(*args, **kwargs):
2999         """
3000         SetData(self, buffer data)
3001
3002         Resets the Image's RGB data from a buffer of RGB bytes.  Accepts
3003         either a string or a buffer object holding the data and the length of
3004         the data must be width*height*3.
3005         """
3006         return _core_.Image_SetData(*args, **kwargs)
3007
3008     def GetDataBuffer(*args, **kwargs):
3009         """
3010         GetDataBuffer(self) -> PyObject
3011
3012         Returns a writable Python buffer object that is pointing at the RGB
3013         image data buffer inside the wx.Image. You need to ensure that you do
3014         not use this buffer object after the image has been destroyed.
3015         """
3016         return _core_.Image_GetDataBuffer(*args, **kwargs)
3017
3018     def SetDataBuffer(*args, **kwargs):
3019         """
3020         SetDataBuffer(self, buffer data)
3021
3022         Sets the internal image data pointer to point at a Python buffer
3023         object.  This can save making an extra copy of the data but you must
3024         ensure that the buffer object lives longer than the wx.Image does.
3025         """
3026         return _core_.Image_SetDataBuffer(*args, **kwargs)
3027
3028     def GetAlphaData(*args, **kwargs):
3029         """
3030         GetAlphaData(self) -> PyObject
3031
3032         Returns a string containing a copy of the alpha bytes of the image.
3033         """
3034         return _core_.Image_GetAlphaData(*args, **kwargs)
3035
3036     def SetAlphaData(*args, **kwargs):
3037         """
3038         SetAlphaData(self, buffer alpha)
3039
3040         Resets the Image's alpha data from a buffer of bytes.  Accepts either
3041         a string or a buffer object holding the data and the length of the
3042         data must be width*height.
3043         """
3044         return _core_.Image_SetAlphaData(*args, **kwargs)
3045
3046     def GetAlphaBuffer(*args, **kwargs):
3047         """
3048         GetAlphaBuffer(self) -> PyObject
3049
3050         Returns a writable Python buffer object that is pointing at the Alpha
3051         data buffer inside the wx.Image. You need to ensure that you do not
3052         use this buffer object after the image has been destroyed.
3053         """
3054         return _core_.Image_GetAlphaBuffer(*args, **kwargs)
3055
3056     def SetAlphaBuffer(*args, **kwargs):
3057         """
3058         SetAlphaBuffer(self, buffer alpha)
3059
3060         Sets the internal image alpha pointer to point at a Python buffer
3061         object.  This can save making an extra copy of the data but you must
3062         ensure that the buffer object lives as long as the wx.Image does.
3063         """
3064         return _core_.Image_SetAlphaBuffer(*args, **kwargs)
3065
3066     def SetMaskColour(*args, **kwargs):
3067         """
3068         SetMaskColour(self, byte r, byte g, byte b)
3069
3070         Sets the mask colour for this image (and tells the image to use the
3071         mask).
3072         """
3073         return _core_.Image_SetMaskColour(*args, **kwargs)
3074
3075     def GetOrFindMaskColour(*args, **kwargs):
3076         """
3077         GetOrFindMaskColour() -> (r,g,b)
3078
3079         Get the current mask colour or find a suitable colour.
3080         """
3081         return _core_.Image_GetOrFindMaskColour(*args, **kwargs)
3082
3083     def GetMaskRed(*args, **kwargs):
3084         """
3085         GetMaskRed(self) -> byte
3086
3087         Gets the red component of the mask colour.
3088         """
3089         return _core_.Image_GetMaskRed(*args, **kwargs)
3090
3091     def GetMaskGreen(*args, **kwargs):
3092         """
3093         GetMaskGreen(self) -> byte
3094
3095         Gets the green component of the mask colour.
3096         """
3097         return _core_.Image_GetMaskGreen(*args, **kwargs)
3098
3099     def GetMaskBlue(*args, **kwargs):
3100         """
3101         GetMaskBlue(self) -> byte
3102
3103         Gets the blue component of the mask colour.
3104         """
3105         return _core_.Image_GetMaskBlue(*args, **kwargs)
3106
3107     def SetMask(*args, **kwargs):
3108         """
3109         SetMask(self, bool mask=True)
3110
3111         Specifies whether there is a mask or not. The area of the mask is
3112         determined by the current mask colour.
3113         """
3114         return _core_.Image_SetMask(*args, **kwargs)
3115
3116     def HasMask(*args, **kwargs):
3117         """
3118         HasMask(self) -> bool
3119
3120         Returns ``True`` if there is a mask active, ``False`` otherwise.
3121         """
3122         return _core_.Image_HasMask(*args, **kwargs)
3123
3124     def Rotate(*args, **kwargs):
3125         """
3126         Rotate(self, double angle, Point centre_of_rotation, bool interpolating=True,
3127             Point offset_after_rotation=None) -> Image
3128
3129         Rotates the image about the given point, by ``angle`` radians. Passing
3130         ``True`` to ``interpolating`` results in better image quality, but is
3131         slower. If the image has a mask, then the mask colour is used for the
3132         uncovered pixels in the rotated image background. Otherwise, black
3133         will be used as the fill colour.
3134
3135         Returns the rotated image, leaving this image intact.
3136         """
3137         return _core_.Image_Rotate(*args, **kwargs)
3138
3139     def Rotate90(*args, **kwargs):
3140         """
3141         Rotate90(self, bool clockwise=True) -> Image
3142
3143         Returns a copy of the image rotated 90 degrees in the direction
3144         indicated by ``clockwise``.
3145         """
3146         return _core_.Image_Rotate90(*args, **kwargs)
3147
3148     def Mirror(*args, **kwargs):
3149         """
3150         Mirror(self, bool horizontally=True) -> Image
3151
3152         Returns a mirrored copy of the image. The parameter ``horizontally``
3153         indicates the orientation.
3154         """
3155         return _core_.Image_Mirror(*args, **kwargs)
3156
3157     def Replace(*args, **kwargs):
3158         """
3159         Replace(self, byte r1, byte g1, byte b1, byte r2, byte g2, byte b2)
3160
3161         Replaces the colour specified by ``(r1,g1,b1)`` by the colour
3162         ``(r2,g2,b2)``.
3163         """
3164         return _core_.Image_Replace(*args, **kwargs)
3165
3166     def ConvertToGreyscale(*args, **kwargs):
3167         """
3168         ConvertToGreyscale(self, double lr=0.299, double lg=0.587, double lb=0.114) -> Image
3169
3170         Convert to greyscale image. Uses the luminance component (Y) of the
3171         image.  The luma value (YUV) is calculated using (R * lr) + (G * lg) + (B * lb),
3172         defaults to ITU-T BT.601
3173         """
3174         return _core_.Image_ConvertToGreyscale(*args, **kwargs)
3175
3176     def ConvertToMono(*args, **kwargs):
3177         """
3178         ConvertToMono(self, byte r, byte g, byte b) -> Image
3179
3180         Returns monochromatic version of the image. The returned image has
3181         white colour where the original has ``(r,g,b)`` colour and black
3182         colour everywhere else.
3183         """
3184         return _core_.Image_ConvertToMono(*args, **kwargs)
3185
3186     def SetOption(*args, **kwargs):
3187         """
3188         SetOption(self, String name, String value)
3189
3190         Sets an image handler defined option.  For example, when saving as a
3191         JPEG file, the option ``wx.IMAGE_OPTION_QUALITY`` is used, which is a
3192         number between 0 and 100 (0 is terrible, 100 is very good).
3193         """
3194         return _core_.Image_SetOption(*args, **kwargs)
3195
3196     def SetOptionInt(*args, **kwargs):
3197         """
3198         SetOptionInt(self, String name, int value)
3199
3200         Sets an image option as an integer.
3201         """
3202         return _core_.Image_SetOptionInt(*args, **kwargs)
3203
3204     def GetOption(*args, **kwargs):
3205         """
3206         GetOption(self, String name) -> String
3207
3208         Gets the value of an image handler option.
3209         """
3210         return _core_.Image_GetOption(*args, **kwargs)
3211
3212     def GetOptionInt(*args, **kwargs):
3213         """
3214         GetOptionInt(self, String name) -> int
3215
3216         Gets the value of an image handler option as an integer.  If the given
3217         option is not present, the function returns 0.
3218         """
3219         return _core_.Image_GetOptionInt(*args, **kwargs)
3220
3221     def HasOption(*args, **kwargs):
3222         """
3223         HasOption(self, String name) -> bool
3224
3225         Returns true if the given option is present.
3226         """
3227         return _core_.Image_HasOption(*args, **kwargs)
3228
3229     def CountColours(*args, **kwargs):
3230         """CountColours(self, unsigned long stopafter=(unsigned long) -1) -> unsigned long"""
3231         return _core_.Image_CountColours(*args, **kwargs)
3232
3233     def ComputeHistogram(*args, **kwargs):
3234         """ComputeHistogram(self, ImageHistogram h) -> unsigned long"""
3235         return _core_.Image_ComputeHistogram(*args, **kwargs)
3236
3237     def AddHandler(*args, **kwargs):
3238         """AddHandler(ImageHandler handler)"""
3239         return _core_.Image_AddHandler(*args, **kwargs)
3240
3241     AddHandler = staticmethod(AddHandler)
3242     def InsertHandler(*args, **kwargs):
3243         """InsertHandler(ImageHandler handler)"""
3244         return _core_.Image_InsertHandler(*args, **kwargs)
3245
3246     InsertHandler = staticmethod(InsertHandler)
3247     def RemoveHandler(*args, **kwargs):
3248         """RemoveHandler(String name) -> bool"""
3249         return _core_.Image_RemoveHandler(*args, **kwargs)
3250
3251     RemoveHandler = staticmethod(RemoveHandler)
3252     def GetHandlers(*args, **kwargs):
3253         """GetHandlers() -> PyObject"""
3254         return _core_.Image_GetHandlers(*args, **kwargs)
3255
3256     GetHandlers = staticmethod(GetHandlers)
3257     def GetImageExtWildcard(*args, **kwargs):
3258         """
3259         GetImageExtWildcard() -> String
3260
3261         Iterates all registered wxImageHandler objects, and returns a string
3262         containing file extension masks suitable for passing to file open/save
3263         dialog boxes.
3264         """
3265         return _core_.Image_GetImageExtWildcard(*args, **kwargs)
3266
3267     GetImageExtWildcard = staticmethod(GetImageExtWildcard)
3268     def ConvertToBitmap(*args, **kwargs):
3269         """ConvertToBitmap(self, int depth=-1) -> Bitmap"""
3270         return _core_.Image_ConvertToBitmap(*args, **kwargs)
3271
3272     def ConvertToMonoBitmap(*args, **kwargs):
3273         """ConvertToMonoBitmap(self, byte red, byte green, byte blue) -> Bitmap"""
3274         return _core_.Image_ConvertToMonoBitmap(*args, **kwargs)
3275
3276     def RotateHue(*args, **kwargs):
3277         """
3278         RotateHue(self, double angle)
3279
3280         Rotates the hue of each pixel of the image. Hue is a double in the
3281         range -1.0..1.0 where -1.0 is -360 degrees and 1.0 is 360 degrees
3282         """
3283         return _core_.Image_RotateHue(*args, **kwargs)
3284
3285     def RGBtoHSV(*args, **kwargs):
3286         """
3287         RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
3288
3289         Converts a color in RGB color space to HSV color space.
3290         """
3291         return _core_.Image_RGBtoHSV(*args, **kwargs)
3292
3293     RGBtoHSV = staticmethod(RGBtoHSV)
3294     def HSVtoRGB(*args, **kwargs):
3295         """
3296         HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
3297
3298         Converts a color in HSV color space to RGB color space.
3299         """
3300         return _core_.Image_HSVtoRGB(*args, **kwargs)
3301
3302     HSVtoRGB = staticmethod(HSVtoRGB)
3303     def __nonzero__(self): return self.IsOk()
3304     AlphaBuffer = property(GetAlphaBuffer,SetAlphaBuffer,doc="See `GetAlphaBuffer` and `SetAlphaBuffer`")
3305     AlphaData = property(GetAlphaData,SetAlphaData,doc="See `GetAlphaData` and `SetAlphaData`")
3306     Data = property(GetData,SetData,doc="See `GetData` and `SetData`")
3307     DataBuffer = property(GetDataBuffer,SetDataBuffer,doc="See `GetDataBuffer` and `SetDataBuffer`")
3308     Height = property(GetHeight,doc="See `GetHeight`")
3309     MaskBlue = property(GetMaskBlue,doc="See `GetMaskBlue`")
3310     MaskGreen = property(GetMaskGreen,doc="See `GetMaskGreen`")
3311     MaskRed = property(GetMaskRed,doc="See `GetMaskRed`")
3312     Width = property(GetWidth,doc="See `GetWidth`")
3313 _core_.Image_swigregister(Image)
3314
3315 def ImageFromMime(*args, **kwargs):
3316     """
3317     ImageFromMime(String name, String mimetype, int index=-1) -> Image
3318
3319     Loads an image from a file, using a MIME type string (such as
3320     'image/jpeg') to specify image type.
3321     """
3322     val = _core_.new_ImageFromMime(*args, **kwargs)
3323     return val
3324
3325 def ImageFromStream(*args, **kwargs):
3326     """
3327     ImageFromStream(InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
3328
3329     Loads an image from an input stream, or any readable Python file-like
3330     object.
3331     """
3332     val = _core_.new_ImageFromStream(*args, **kwargs)
3333     return val
3334
3335 def ImageFromStreamMime(*args, **kwargs):
3336     """
3337     ImageFromStreamMime(InputStream stream, String mimetype, int index=-1) -> Image
3338
3339     Loads an image from an input stream, or any readable Python file-like
3340     object, specifying the image format with a MIME type string.
3341     """
3342     val = _core_.new_ImageFromStreamMime(*args, **kwargs)
3343     return val
3344
3345 def EmptyImage(*args, **kwargs):
3346     """
3347     EmptyImage(int width=0, int height=0, bool clear=True) -> Image
3348
3349     Construct an empty image of a given size, optionally setting all
3350     pixels to black.
3351     """
3352     val = _core_.new_EmptyImage(*args, **kwargs)
3353     return val
3354
3355 def ImageFromBitmap(*args, **kwargs):
3356     """
3357     ImageFromBitmap(Bitmap bitmap) -> Image
3358
3359     Construct an Image from a `wx.Bitmap`.
3360     """
3361     val = _core_.new_ImageFromBitmap(*args, **kwargs)
3362     return val
3363
3364 def ImageFromData(*args, **kwargs):
3365     """
3366     ImageFromData(int width, int height, buffer data) -> Image
3367
3368     Construct an Image from a buffer of RGB bytes.  Accepts either a
3369     string or a buffer object holding the data and the length of the data
3370     must be width*height*3.
3371     """
3372     val = _core_.new_ImageFromData(*args, **kwargs)
3373     return val
3374
3375 def ImageFromDataWithAlpha(*args, **kwargs):
3376     """
3377     ImageFromDataWithAlpha(int width, int height, buffer data, buffer alpha) -> Image
3378
3379     Construct an Image from a buffer of RGB bytes with an Alpha channel.
3380     Accepts either a string or a buffer object holding the data and the
3381     length of the data must be width*height*3 bytes, and the length of the
3382     alpha data must be width*height bytes.
3383     """
3384     val = _core_.new_ImageFromDataWithAlpha(*args, **kwargs)
3385     return val
3386
3387 def Image_CanRead(*args, **kwargs):
3388   """
3389     Image_CanRead(String filename) -> bool
3390
3391     Returns True if the image handlers can read this file.
3392     """
3393   return _core_.Image_CanRead(*args, **kwargs)
3394
3395 def Image_GetImageCount(*args, **kwargs):
3396   """
3397     Image_GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
3398
3399     If the image file contains more than one image and the image handler
3400     is capable of retrieving these individually, this function will return
3401     the number of available images.
3402     """
3403   return _core_.Image_GetImageCount(*args, **kwargs)
3404
3405 def Image_CanReadStream(*args, **kwargs):
3406   """
3407     Image_CanReadStream(InputStream stream) -> bool
3408
3409     Returns True if the image handlers can read an image file from the
3410     data currently on the input stream, or a readable Python file-like
3411     object.
3412     """
3413   return _core_.Image_CanReadStream(*args, **kwargs)
3414
3415 def Image_AddHandler(*args, **kwargs):
3416   """Image_AddHandler(ImageHandler handler)"""
3417   return _core_.Image_AddHandler(*args, **kwargs)
3418
3419 def Image_InsertHandler(*args, **kwargs):
3420   """Image_InsertHandler(ImageHandler handler)"""
3421   return _core_.Image_InsertHandler(*args, **kwargs)
3422
3423 def Image_RemoveHandler(*args, **kwargs):
3424   """Image_RemoveHandler(String name) -> bool"""
3425   return _core_.Image_RemoveHandler(*args, **kwargs)
3426
3427 def Image_GetHandlers(*args):
3428   """Image_GetHandlers() -> PyObject"""
3429   return _core_.Image_GetHandlers(*args)
3430
3431 def Image_GetImageExtWildcard(*args):
3432   """
3433     Image_GetImageExtWildcard() -> String
3434
3435     Iterates all registered wxImageHandler objects, and returns a string
3436     containing file extension masks suitable for passing to file open/save
3437     dialog boxes.
3438     """
3439   return _core_.Image_GetImageExtWildcard(*args)
3440
3441 def Image_RGBtoHSV(*args, **kwargs):
3442   """
3443     Image_RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
3444
3445     Converts a color in RGB color space to HSV color space.
3446     """
3447   return _core_.Image_RGBtoHSV(*args, **kwargs)
3448
3449 def Image_HSVtoRGB(*args, **kwargs):
3450   """
3451     Image_HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
3452
3453     Converts a color in HSV color space to RGB color space.
3454     """
3455   return _core_.Image_HSVtoRGB(*args, **kwargs)
3456
3457
3458 def _ImageFromBuffer(*args, **kwargs):
3459   """_ImageFromBuffer(int width, int height, buffer data, buffer alpha=None) -> Image"""
3460   return _core_._ImageFromBuffer(*args, **kwargs)
3461 def ImageFromBuffer(width, height, dataBuffer, alphaBuffer=None):
3462     """
3463     Creates a `wx.Image` from the data in dataBuffer.  The dataBuffer
3464     parameter must be a Python object that implements the buffer interface,
3465     such as a string, array, etc.  The dataBuffer object is expected to
3466     contain a series of RGB bytes and be width*height*3 bytes long.  A buffer
3467     object can optionally be supplied for the image's alpha channel data, and
3468     it is expected to be width*height bytes long.
3469
3470     The wx.Image will be created with its data and alpha pointers initialized
3471     to the memory address pointed to by the buffer objects, thus saving the
3472     time needed to copy the image data from the buffer object to the wx.Image.
3473     While this has advantages, it also has the shoot-yourself-in-the-foot
3474     risks associated with sharing a C pointer between two objects.
3475
3476     To help alleviate the risk a reference to the data and alpha buffer
3477     objects are kept with the wx.Image, so that they won't get deleted until
3478     after the wx.Image is deleted.  However please be aware that it is not
3479     guaranteed that an object won't move its memory buffer to a new location
3480     when it needs to resize its contents.  If that happens then the wx.Image
3481     will end up referring to an invalid memory location and could cause the
3482     application to crash.  Therefore care should be taken to not manipulate
3483     the objects used for the data and alpha buffers in a way that would cause
3484     them to change size.
3485     """
3486     image = _core_._ImageFromBuffer(width, height, dataBuffer, alphaBuffer)
3487     image._buffer = dataBuffer
3488     image._alpha = alphaBuffer
3489     return image
3490
3491 def InitAllImageHandlers():
3492     """
3493     The former functionality of InitAllImageHanders is now done internal to
3494     the _core_ extension module and so this function has become a simple NOP.
3495     """
3496     pass
3497
3498 IMAGE_RESOLUTION_INCHES = _core_.IMAGE_RESOLUTION_INCHES
3499 IMAGE_RESOLUTION_CM = _core_.IMAGE_RESOLUTION_CM
3500 PNG_TYPE_COLOUR = _core_.PNG_TYPE_COLOUR
3501 PNG_TYPE_GREY = _core_.PNG_TYPE_GREY
3502 PNG_TYPE_GREY_RED = _core_.PNG_TYPE_GREY_RED
3503 BMP_24BPP = _core_.BMP_24BPP
3504 BMP_8BPP = _core_.BMP_8BPP
3505 BMP_8BPP_GREY = _core_.BMP_8BPP_GREY
3506 BMP_8BPP_GRAY = _core_.BMP_8BPP_GRAY
3507 BMP_8BPP_RED = _core_.BMP_8BPP_RED
3508 BMP_8BPP_PALETTE = _core_.BMP_8BPP_PALETTE
3509 BMP_4BPP = _core_.BMP_4BPP
3510 BMP_1BPP = _core_.BMP_1BPP
3511 BMP_1BPP_BW = _core_.BMP_1BPP_BW
3512 class BMPHandler(ImageHandler):
3513     """A `wx.ImageHandler` for \*.bmp bitmap files."""
3514     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3515     __repr__ = _swig_repr
3516     def __init__(self, *args, **kwargs):
3517         """
3518         __init__(self) -> BMPHandler
3519
3520         A `wx.ImageHandler` for \*.bmp bitmap files.
3521         """
3522         _core_.BMPHandler_swiginit(self,_core_.new_BMPHandler(*args, **kwargs))
3523 _core_.BMPHandler_swigregister(BMPHandler)
3524 NullImage = cvar.NullImage
3525 IMAGE_OPTION_FILENAME = cvar.IMAGE_OPTION_FILENAME
3526 IMAGE_OPTION_BMP_FORMAT = cvar.IMAGE_OPTION_BMP_FORMAT
3527 IMAGE_OPTION_CUR_HOTSPOT_X = cvar.IMAGE_OPTION_CUR_HOTSPOT_X
3528 IMAGE_OPTION_CUR_HOTSPOT_Y = cvar.IMAGE_OPTION_CUR_HOTSPOT_Y
3529 IMAGE_OPTION_RESOLUTION = cvar.IMAGE_OPTION_RESOLUTION
3530 IMAGE_OPTION_RESOLUTIONX = cvar.IMAGE_OPTION_RESOLUTIONX
3531 IMAGE_OPTION_RESOLUTIONY = cvar.IMAGE_OPTION_RESOLUTIONY
3532 IMAGE_OPTION_RESOLUTIONUNIT = cvar.IMAGE_OPTION_RESOLUTIONUNIT
3533 IMAGE_OPTION_QUALITY = cvar.IMAGE_OPTION_QUALITY
3534 IMAGE_OPTION_BITSPERSAMPLE = cvar.IMAGE_OPTION_BITSPERSAMPLE
3535 IMAGE_OPTION_SAMPLESPERPIXEL = cvar.IMAGE_OPTION_SAMPLESPERPIXEL
3536 IMAGE_OPTION_COMPRESSION = cvar.IMAGE_OPTION_COMPRESSION
3537 IMAGE_OPTION_IMAGEDESCRIPTOR = cvar.IMAGE_OPTION_IMAGEDESCRIPTOR
3538 IMAGE_OPTION_PNG_FORMAT = cvar.IMAGE_OPTION_PNG_FORMAT
3539 IMAGE_OPTION_PNG_BITDEPTH = cvar.IMAGE_OPTION_PNG_BITDEPTH
3540
3541 class ICOHandler(BMPHandler):
3542     """A `wx.ImageHandler` for \*.ico icon files."""
3543     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3544     __repr__ = _swig_repr
3545     def __init__(self, *args, **kwargs):
3546         """
3547         __init__(self) -> ICOHandler
3548
3549         A `wx.ImageHandler` for \*.ico icon files.
3550         """
3551         _core_.ICOHandler_swiginit(self,_core_.new_ICOHandler(*args, **kwargs))
3552 _core_.ICOHandler_swigregister(ICOHandler)
3553
3554 class CURHandler(ICOHandler):
3555     """A `wx.ImageHandler` for \*.cur cursor files."""
3556     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3557     __repr__ = _swig_repr
3558     def __init__(self, *args, **kwargs):
3559         """
3560         __init__(self) -> CURHandler
3561
3562         A `wx.ImageHandler` for \*.cur cursor files.
3563         """
3564         _core_.CURHandler_swiginit(self,_core_.new_CURHandler(*args, **kwargs))
3565 _core_.CURHandler_swigregister(CURHandler)
3566
3567 class ANIHandler(CURHandler):
3568     """A `wx.ImageHandler` for \*.ani animated cursor files."""
3569     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3570     __repr__ = _swig_repr
3571     def __init__(self, *args, **kwargs):
3572         """
3573         __init__(self) -> ANIHandler
3574
3575         A `wx.ImageHandler` for \*.ani animated cursor files.
3576         """
3577         _core_.ANIHandler_swiginit(self,_core_.new_ANIHandler(*args, **kwargs))
3578 _core_.ANIHandler_swigregister(ANIHandler)
3579
3580 class PNGHandler(ImageHandler):
3581     """A `wx.ImageHandler` for PNG image files."""
3582     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3583     __repr__ = _swig_repr
3584     def __init__(self, *args, **kwargs):
3585         """
3586         __init__(self) -> PNGHandler
3587
3588         A `wx.ImageHandler` for PNG image files.
3589         """
3590         _core_.PNGHandler_swiginit(self,_core_.new_PNGHandler(*args, **kwargs))
3591 _core_.PNGHandler_swigregister(PNGHandler)
3592
3593 class GIFHandler(ImageHandler):
3594     """A `wx.ImageHandler` for GIF image files."""
3595     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3596     __repr__ = _swig_repr
3597     def __init__(self, *args, **kwargs):
3598         """
3599         __init__(self) -> GIFHandler
3600
3601         A `wx.ImageHandler` for GIF image files.
3602         """
3603         _core_.GIFHandler_swiginit(self,_core_.new_GIFHandler(*args, **kwargs))
3604 _core_.GIFHandler_swigregister(GIFHandler)
3605
3606 class PCXHandler(ImageHandler):
3607     """A `wx.ImageHandler` for PCX imager files."""
3608     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3609     __repr__ = _swig_repr
3610     def __init__(self, *args, **kwargs):
3611         """
3612         __init__(self) -> PCXHandler
3613
3614         A `wx.ImageHandler` for PCX imager files.
3615         """
3616         _core_.PCXHandler_swiginit(self,_core_.new_PCXHandler(*args, **kwargs))
3617 _core_.PCXHandler_swigregister(PCXHandler)
3618
3619 class JPEGHandler(ImageHandler):
3620     """A `wx.ImageHandler` for JPEG/JPG image files."""
3621     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3622     __repr__ = _swig_repr
3623     def __init__(self, *args, **kwargs):
3624         """
3625         __init__(self) -> JPEGHandler
3626
3627         A `wx.ImageHandler` for JPEG/JPG image files.
3628         """
3629         _core_.JPEGHandler_swiginit(self,_core_.new_JPEGHandler(*args, **kwargs))
3630 _core_.JPEGHandler_swigregister(JPEGHandler)
3631
3632 class PNMHandler(ImageHandler):
3633     """A `wx.ImageHandler` for PNM image files."""
3634     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3635     __repr__ = _swig_repr
3636     def __init__(self, *args, **kwargs):
3637         """
3638         __init__(self) -> PNMHandler
3639
3640         A `wx.ImageHandler` for PNM image files.
3641         """
3642         _core_.PNMHandler_swiginit(self,_core_.new_PNMHandler(*args, **kwargs))
3643 _core_.PNMHandler_swigregister(PNMHandler)
3644
3645 class XPMHandler(ImageHandler):
3646     """A `wx.ImageHandler` for XPM image."""
3647     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3648     __repr__ = _swig_repr
3649     def __init__(self, *args, **kwargs):
3650         """
3651         __init__(self) -> XPMHandler
3652
3653         A `wx.ImageHandler` for XPM image.
3654         """
3655         _core_.XPMHandler_swiginit(self,_core_.new_XPMHandler(*args, **kwargs))
3656 _core_.XPMHandler_swigregister(XPMHandler)
3657
3658 class TIFFHandler(ImageHandler):
3659     """A `wx.ImageHandler` for TIFF image files."""
3660     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3661     __repr__ = _swig_repr
3662     def __init__(self, *args, **kwargs):
3663         """
3664         __init__(self) -> TIFFHandler
3665
3666         A `wx.ImageHandler` for TIFF image files.
3667         """
3668         _core_.TIFFHandler_swiginit(self,_core_.new_TIFFHandler(*args, **kwargs))
3669 _core_.TIFFHandler_swigregister(TIFFHandler)
3670
3671 class TGAHandler(ImageHandler):
3672     """A `wx.ImageHandler` for TGA image files."""
3673     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3674     __repr__ = _swig_repr
3675     def __init__(self, *args, **kwargs):
3676         """
3677         __init__(self) -> TGAHandler
3678
3679         A `wx.ImageHandler` for TGA image files.
3680         """
3681         _core_.TGAHandler_swiginit(self,_core_.new_TGAHandler(*args, **kwargs))
3682 _core_.TGAHandler_swigregister(TGAHandler)
3683
3684 QUANTIZE_INCLUDE_WINDOWS_COLOURS = _core_.QUANTIZE_INCLUDE_WINDOWS_COLOURS
3685 QUANTIZE_FILL_DESTINATION_IMAGE = _core_.QUANTIZE_FILL_DESTINATION_IMAGE
3686 class Quantize(object):
3687     """Performs quantization, or colour reduction, on a wxImage."""
3688     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3689     def __init__(self): raise AttributeError, "No constructor defined"
3690     __repr__ = _swig_repr
3691     def Quantize(*args, **kwargs):
3692         """
3693         Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
3694
3695         Reduce the colours in the source image and put the result into the
3696         destination image, setting the palette in the destination if
3697         needed. Both images may be the same, to overwrite the source image.
3698         """
3699         return _core_.Quantize_Quantize(*args, **kwargs)
3700
3701     Quantize = staticmethod(Quantize)
3702 _core_.Quantize_swigregister(Quantize)
3703
3704 def Quantize_Quantize(*args, **kwargs):
3705   """
3706     Quantize_Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
3707
3708     Reduce the colours in the source image and put the result into the
3709     destination image, setting the palette in the destination if
3710     needed. Both images may be the same, to overwrite the source image.
3711     """
3712   return _core_.Quantize_Quantize(*args, **kwargs)
3713
3714 #---------------------------------------------------------------------------
3715
3716 class EvtHandler(Object):
3717     """Proxy of C++ EvtHandler class"""
3718     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3719     __repr__ = _swig_repr
3720     def __init__(self, *args, **kwargs):
3721         """__init__(self) -> EvtHandler"""
3722         _core_.EvtHandler_swiginit(self,_core_.new_EvtHandler(*args, **kwargs))
3723         self._setOORInfo(self)
3724
3725     def GetNextHandler(*args, **kwargs):
3726         """GetNextHandler(self) -> EvtHandler"""
3727         return _core_.EvtHandler_GetNextHandler(*args, **kwargs)
3728
3729     def GetPreviousHandler(*args, **kwargs):
3730         """GetPreviousHandler(self) -> EvtHandler"""
3731         return _core_.EvtHandler_GetPreviousHandler(*args, **kwargs)
3732
3733     def SetNextHandler(*args, **kwargs):
3734         """SetNextHandler(self, EvtHandler handler)"""
3735         return _core_.EvtHandler_SetNextHandler(*args, **kwargs)
3736
3737     def SetPreviousHandler(*args, **kwargs):
3738         """SetPreviousHandler(self, EvtHandler handler)"""
3739         return _core_.EvtHandler_SetPreviousHandler(*args, **kwargs)
3740
3741     def GetEvtHandlerEnabled(*args, **kwargs):
3742         """GetEvtHandlerEnabled(self) -> bool"""
3743         return _core_.EvtHandler_GetEvtHandlerEnabled(*args, **kwargs)
3744
3745     def SetEvtHandlerEnabled(*args, **kwargs):
3746         """SetEvtHandlerEnabled(self, bool enabled)"""
3747         return _core_.EvtHandler_SetEvtHandlerEnabled(*args, **kwargs)
3748
3749     def ProcessEvent(*args, **kwargs):
3750         """ProcessEvent(self, Event event) -> bool"""
3751         return _core_.EvtHandler_ProcessEvent(*args, **kwargs)
3752
3753     def AddPendingEvent(*args, **kwargs):
3754         """AddPendingEvent(self, Event event)"""
3755         return _core_.EvtHandler_AddPendingEvent(*args, **kwargs)
3756
3757     def ProcessPendingEvents(*args, **kwargs):
3758         """ProcessPendingEvents(self)"""
3759         return _core_.EvtHandler_ProcessPendingEvents(*args, **kwargs)
3760
3761     def Connect(*args, **kwargs):
3762         """Connect(self, int id, int lastId, int eventType, PyObject func)"""
3763         return _core_.EvtHandler_Connect(*args, **kwargs)
3764
3765     def Disconnect(*args, **kwargs):
3766         """Disconnect(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL) -> bool"""
3767         return _core_.EvtHandler_Disconnect(*args, **kwargs)
3768
3769     def _setOORInfo(*args, **kwargs):
3770         """_setOORInfo(self, PyObject _self, bool incref=True)"""
3771         val = _core_.EvtHandler__setOORInfo(*args, **kwargs)
3772         args[0].this.own(False)
3773         return val
3774
3775     def Bind(self, event, handler, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
3776         """
3777         Bind an event to an event handler.
3778
3779         :param event: One of the EVT_* objects that specifies the
3780                       type of event to bind,
3781
3782         :param handler: A callable object to be invoked when the
3783                       event is delivered to self.  Pass None to
3784                       disconnect an event handler.
3785
3786         :param source: Sometimes the event originates from a
3787                       different window than self, but you still
3788                       want to catch it in self.  (For example, a
3789                       button event delivered to a frame.)  By
3790                       passing the source of the event, the event
3791                       handling system is able to differentiate
3792                       between the same event type from different
3793                       controls.
3794
3795         :param id: Used to spcify the event source by ID instead
3796                    of instance.
3797
3798         :param id2: Used when it is desirable to bind a handler
3799                       to a range of IDs, such as with EVT_MENU_RANGE.
3800         """
3801         if source is not None:
3802             id  = source.GetId()
3803         event.Bind(self, id, id2, handler)
3804
3805     def Unbind(self, event, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
3806         """
3807         Disconencts the event handler binding for event from self.
3808         Returns True if successful.
3809         """
3810         if source is not None:
3811             id  = source.GetId()
3812         return event.Unbind(self, id, id2)
3813
3814     EvtHandlerEnabled = property(GetEvtHandlerEnabled,SetEvtHandlerEnabled,doc="See `GetEvtHandlerEnabled` and `SetEvtHandlerEnabled`")
3815     NextHandler = property(GetNextHandler,SetNextHandler,doc="See `GetNextHandler` and `SetNextHandler`")
3816     PreviousHandler = property(GetPreviousHandler,SetPreviousHandler,doc="See `GetPreviousHandler` and `SetPreviousHandler`")
3817 _core_.EvtHandler_swigregister(EvtHandler)
3818
3819 #---------------------------------------------------------------------------
3820
3821 class PyEventBinder(object):
3822     """
3823     Instances of this class are used to bind specific events to event
3824     handlers.
3825     """
3826     def __init__(self, evtType, expectedIDs=0):
3827         if expectedIDs not in [0, 1, 2]:
3828             raise ValueError, "Invalid number of expectedIDs"
3829         self.expectedIDs = expectedIDs
3830
3831         if type(evtType) == list or type(evtType) == tuple:
3832             self.evtType = evtType
3833         else:
3834             self.evtType = [evtType]
3835
3836
3837     def Bind(self, target, id1, id2, function):
3838         """Bind this set of event types to target."""
3839         for et in self.evtType:
3840             target.Connect(id1, id2, et, function)
3841
3842
3843     def Unbind(self, target, id1, id2):
3844         """Remove an event binding."""
3845         success = 0
3846         for et in self.evtType:
3847             success += target.Disconnect(id1, id2, et)
3848         return success != 0
3849
3850     def _getEvtType(self):
3851         """
3852         Make it easy to get to the default wxEventType typeID for this
3853         event binder.
3854         """
3855         return self.evtType[0]
3856
3857     typeId = property(_getEvtType)
3858
3859
3860     def __call__(self, *args):
3861         """
3862         For backwards compatibility with the old EVT_* functions.
3863         Should be called with either (window, func), (window, ID,
3864         func) or (window, ID1, ID2, func) parameters depending on the
3865         type of the event.
3866         """
3867         assert len(args) == 2 + self.expectedIDs
3868         id1 = wx.ID_ANY
3869         id2 = wx.ID_ANY
3870         target = args[0]
3871         if self.expectedIDs == 0:
3872             func = args[1]
3873         elif self.expectedIDs == 1:
3874             id1 = args[1]
3875             func = args[2]
3876         elif self.expectedIDs == 2:
3877             id1 = args[1]
3878             id2 = args[2]
3879             func = args[3]
3880         else:
3881             raise ValueError, "Unexpected number of IDs"
3882
3883         self.Bind(target, id1, id2, func)
3884
3885
3886 # These two are square pegs that don't fit the PyEventBinder hole...
3887 def EVT_COMMAND(win, id, cmd, func):
3888     win.Connect(id, -1, cmd, func)
3889 def EVT_COMMAND_RANGE(win, id1, id2, cmd, func):
3890     win.Connect(id1, id2, cmd, func)
3891
3892
3893 #---------------------------------------------------------------------------
3894
3895 #---------------------------------------------------------------------------
3896
3897 EVENT_PROPAGATE_NONE = _core_.EVENT_PROPAGATE_NONE
3898 EVENT_PROPAGATE_MAX = _core_.EVENT_PROPAGATE_MAX
3899
3900 def NewEventType(*args):
3901   """NewEventType() -> EventType"""
3902   return _core_.NewEventType(*args)
3903 wxEVT_ANY = _core_.wxEVT_ANY
3904 wxEVT_NULL = _core_.wxEVT_NULL
3905 wxEVT_FIRST = _core_.wxEVT_FIRST
3906 wxEVT_USER_FIRST = _core_.wxEVT_USER_FIRST
3907 wxEVT_COMMAND_BUTTON_CLICKED = _core_.wxEVT_COMMAND_BUTTON_CLICKED
3908 wxEVT_COMMAND_CHECKBOX_CLICKED = _core_.wxEVT_COMMAND_CHECKBOX_CLICKED
3909 wxEVT_COMMAND_CHOICE_SELECTED = _core_.wxEVT_COMMAND_CHOICE_SELECTED
3910 wxEVT_COMMAND_LISTBOX_SELECTED = _core_.wxEVT_COMMAND_LISTBOX_SELECTED
3911 wxEVT_COMMAND_LISTBOX_DOUBLECLICKED = _core_.wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
3912 wxEVT_COMMAND_CHECKLISTBOX_TOGGLED = _core_.wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
3913 wxEVT_COMMAND_MENU_SELECTED = _core_.wxEVT_COMMAND_MENU_SELECTED
3914 wxEVT_COMMAND_TOOL_CLICKED = _core_.wxEVT_COMMAND_TOOL_CLICKED
3915 wxEVT_COMMAND_SLIDER_UPDATED = _core_.wxEVT_COMMAND_SLIDER_UPDATED
3916 wxEVT_COMMAND_RADIOBOX_SELECTED = _core_.wxEVT_COMMAND_RADIOBOX_SELECTED
3917 wxEVT_COMMAND_RADIOBUTTON_SELECTED = _core_.wxEVT_COMMAND_RADIOBUTTON_SELECTED
3918 wxEVT_COMMAND_SCROLLBAR_UPDATED = _core_.wxEVT_COMMAND_SCROLLBAR_UPDATED
3919 wxEVT_COMMAND_VLBOX_SELECTED = _core_.wxEVT_COMMAND_VLBOX_SELECTED
3920 wxEVT_COMMAND_COMBOBOX_SELECTED = _core_.wxEVT_COMMAND_COMBOBOX_SELECTED
3921 wxEVT_COMMAND_TOOL_RCLICKED = _core_.wxEVT_COMMAND_TOOL_RCLICKED
3922 wxEVT_COMMAND_TOOL_ENTER = _core_.wxEVT_COMMAND_TOOL_ENTER
3923 wxEVT_LEFT_DOWN = _core_.wxEVT_LEFT_DOWN
3924 wxEVT_LEFT_UP = _core_.wxEVT_LEFT_UP
3925 wxEVT_MIDDLE_DOWN = _core_.wxEVT_MIDDLE_DOWN
3926 wxEVT_MIDDLE_UP = _core_.wxEVT_MIDDLE_UP
3927 wxEVT_RIGHT_DOWN = _core_.wxEVT_RIGHT_DOWN
3928 wxEVT_RIGHT_UP = _core_.wxEVT_RIGHT_UP
3929 wxEVT_MOTION = _core_.wxEVT_MOTION
3930 wxEVT_ENTER_WINDOW = _core_.wxEVT_ENTER_WINDOW
3931 wxEVT_LEAVE_WINDOW = _core_.wxEVT_LEAVE_WINDOW
3932 wxEVT_LEFT_DCLICK = _core_.wxEVT_LEFT_DCLICK
3933 wxEVT_MIDDLE_DCLICK = _core_.wxEVT_MIDDLE_DCLICK
3934 wxEVT_RIGHT_DCLICK = _core_.wxEVT_RIGHT_DCLICK
3935 wxEVT_SET_FOCUS = _core_.wxEVT_SET_FOCUS
3936 wxEVT_KILL_FOCUS = _core_.wxEVT_KILL_FOCUS
3937 wxEVT_CHILD_FOCUS = _core_.wxEVT_CHILD_FOCUS
3938 wxEVT_MOUSEWHEEL = _core_.wxEVT_MOUSEWHEEL
3939 wxEVT_NC_LEFT_DOWN = _core_.wxEVT_NC_LEFT_DOWN
3940 wxEVT_NC_LEFT_UP = _core_.wxEVT_NC_LEFT_UP
3941 wxEVT_NC_MIDDLE_DOWN = _core_.wxEVT_NC_MIDDLE_DOWN
3942 wxEVT_NC_MIDDLE_UP = _core_.wxEVT_NC_MIDDLE_UP
3943 wxEVT_NC_RIGHT_DOWN = _core_.wxEVT_NC_RIGHT_DOWN
3944 wxEVT_NC_RIGHT_UP = _core_.wxEVT_NC_RIGHT_UP
3945 wxEVT_NC_MOTION = _core_.wxEVT_NC_MOTION
3946 wxEVT_NC_ENTER_WINDOW = _core_.wxEVT_NC_ENTER_WINDOW
3947 wxEVT_NC_LEAVE_WINDOW = _core_.wxEVT_NC_LEAVE_WINDOW
3948 wxEVT_NC_LEFT_DCLICK = _core_.wxEVT_NC_LEFT_DCLICK
3949 wxEVT_NC_MIDDLE_DCLICK = _core_.wxEVT_NC_MIDDLE_DCLICK
3950 wxEVT_NC_RIGHT_DCLICK = _core_.wxEVT_NC_RIGHT_DCLICK
3951 wxEVT_CHAR = _core_.wxEVT_CHAR
3952 wxEVT_CHAR_HOOK = _core_.wxEVT_CHAR_HOOK
3953 wxEVT_NAVIGATION_KEY = _core_.wxEVT_NAVIGATION_KEY
3954 wxEVT_KEY_DOWN = _core_.wxEVT_KEY_DOWN
3955 wxEVT_KEY_UP = _core_.wxEVT_KEY_UP
3956 wxEVT_HOTKEY = _core_.wxEVT_HOTKEY
3957 wxEVT_SET_CURSOR = _core_.wxEVT_SET_CURSOR
3958 wxEVT_SCROLL_TOP = _core_.wxEVT_SCROLL_TOP
3959 wxEVT_SCROLL_BOTTOM = _core_.wxEVT_SCROLL_BOTTOM
3960 wxEVT_SCROLL_LINEUP = _core_.wxEVT_SCROLL_LINEUP
3961 wxEVT_SCROLL_LINEDOWN = _core_.wxEVT_SCROLL_LINEDOWN
3962 wxEVT_SCROLL_PAGEUP = _core_.wxEVT_SCROLL_PAGEUP
3963 wxEVT_SCROLL_PAGEDOWN = _core_.wxEVT_SCROLL_PAGEDOWN
3964 wxEVT_SCROLL_THUMBTRACK = _core_.wxEVT_SCROLL_THUMBTRACK
3965 wxEVT_SCROLL_THUMBRELEASE = _core_.wxEVT_SCROLL_THUMBRELEASE
3966 wxEVT_SCROLL_CHANGED = _core_.wxEVT_SCROLL_CHANGED
3967 wxEVT_SCROLL_ENDSCROLL = wxEVT_SCROLL_CHANGED
3968 wxEVT_SCROLLWIN_TOP = _core_.wxEVT_SCROLLWIN_TOP
3969 wxEVT_SCROLLWIN_BOTTOM = _core_.wxEVT_SCROLLWIN_BOTTOM
3970 wxEVT_SCROLLWIN_LINEUP = _core_.wxEVT_SCROLLWIN_LINEUP
3971 wxEVT_SCROLLWIN_LINEDOWN = _core_.wxEVT_SCROLLWIN_LINEDOWN
3972 wxEVT_SCROLLWIN_PAGEUP = _core_.wxEVT_SCROLLWIN_PAGEUP
3973 wxEVT_SCROLLWIN_PAGEDOWN = _core_.wxEVT_SCROLLWIN_PAGEDOWN
3974 wxEVT_SCROLLWIN_THUMBTRACK = _core_.wxEVT_SCROLLWIN_THUMBTRACK
3975 wxEVT_SCROLLWIN_THUMBRELEASE = _core_.wxEVT_SCROLLWIN_THUMBRELEASE
3976 wxEVT_SIZE = _core_.wxEVT_SIZE
3977 wxEVT_MOVE = _core_.wxEVT_MOVE
3978 wxEVT_CLOSE_WINDOW = _core_.wxEVT_CLOSE_WINDOW
3979 wxEVT_END_SESSION = _core_.wxEVT_END_SESSION
3980 wxEVT_QUERY_END_SESSION = _core_.wxEVT_QUERY_END_SESSION
3981 wxEVT_ACTIVATE_APP = _core_.wxEVT_ACTIVATE_APP
3982 wxEVT_ACTIVATE = _core_.wxEVT_ACTIVATE
3983 wxEVT_CREATE = _core_.wxEVT_CREATE
3984 wxEVT_DESTROY = _core_.wxEVT_DESTROY
3985 wxEVT_SHOW = _core_.wxEVT_SHOW
3986 wxEVT_ICONIZE = _core_.wxEVT_ICONIZE
3987 wxEVT_MAXIMIZE = _core_.wxEVT_MAXIMIZE
3988 wxEVT_MOUSE_CAPTURE_CHANGED = _core_.wxEVT_MOUSE_CAPTURE_CHANGED
3989 wxEVT_MOUSE_CAPTURE_LOST = _core_.wxEVT_MOUSE_CAPTURE_LOST
3990 wxEVT_PAINT = _core_.wxEVT_PAINT
3991 wxEVT_ERASE_BACKGROUND = _core_.wxEVT_ERASE_BACKGROUND
3992 wxEVT_NC_PAINT = _core_.wxEVT_NC_PAINT
3993 wxEVT_PAINT_ICON = _core_.wxEVT_PAINT_ICON
3994 wxEVT_MENU_OPEN = _core_.wxEVT_MENU_OPEN
3995 wxEVT_MENU_CLOSE = _core_.wxEVT_MENU_CLOSE
3996 wxEVT_MENU_HIGHLIGHT = _core_.wxEVT_MENU_HIGHLIGHT
3997 wxEVT_CONTEXT_MENU = _core_.wxEVT_CONTEXT_MENU
3998 wxEVT_SYS_COLOUR_CHANGED = _core_.wxEVT_SYS_COLOUR_CHANGED
3999 wxEVT_DISPLAY_CHANGED = _core_.wxEVT_DISPLAY_CHANGED
4000 wxEVT_SETTING_CHANGED = _core_.wxEVT_SETTING_CHANGED
4001 wxEVT_QUERY_NEW_PALETTE = _core_.wxEVT_QUERY_NEW_PALETTE
4002 wxEVT_PALETTE_CHANGED = _core_.wxEVT_PALETTE_CHANGED
4003 wxEVT_DROP_FILES = _core_.wxEVT_DROP_FILES
4004 wxEVT_DRAW_ITEM = _core_.wxEVT_DRAW_ITEM
4005 wxEVT_MEASURE_ITEM = _core_.wxEVT_MEASURE_ITEM
4006 wxEVT_COMPARE_ITEM = _core_.wxEVT_COMPARE_ITEM
4007 wxEVT_INIT_DIALOG = _core_.wxEVT_INIT_DIALOG
4008 wxEVT_IDLE = _core_.wxEVT_IDLE
4009 wxEVT_UPDATE_UI = _core_.wxEVT_UPDATE_UI
4010 wxEVT_SIZING = _core_.wxEVT_SIZING
4011 wxEVT_MOVING = _core_.wxEVT_MOVING
4012 wxEVT_HIBERNATE = _core_.wxEVT_HIBERNATE
4013 wxEVT_COMMAND_TEXT_COPY = _core_.wxEVT_COMMAND_TEXT_COPY
4014 wxEVT_COMMAND_TEXT_CUT = _core_.wxEVT_COMMAND_TEXT_CUT
4015 wxEVT_COMMAND_TEXT_PASTE = _core_.wxEVT_COMMAND_TEXT_PASTE
4016 wxEVT_COMMAND_LEFT_CLICK = _core_.wxEVT_COMMAND_LEFT_CLICK
4017 wxEVT_COMMAND_LEFT_DCLICK = _core_.wxEVT_COMMAND_LEFT_DCLICK
4018 wxEVT_COMMAND_RIGHT_CLICK = _core_.wxEVT_COMMAND_RIGHT_CLICK
4019 wxEVT_COMMAND_RIGHT_DCLICK = _core_.wxEVT_COMMAND_RIGHT_DCLICK
4020 wxEVT_COMMAND_SET_FOCUS = _core_.wxEVT_COMMAND_SET_FOCUS
4021 wxEVT_COMMAND_KILL_FOCUS = _core_.wxEVT_COMMAND_KILL_FOCUS
4022 wxEVT_COMMAND_ENTER = _core_.wxEVT_COMMAND_ENTER
4023 #
4024 # Create some event binders
4025 EVT_SIZE = wx.PyEventBinder( wxEVT_SIZE )
4026 EVT_SIZING = wx.PyEventBinder( wxEVT_SIZING )
4027 EVT_MOVE = wx.PyEventBinder( wxEVT_MOVE )
4028 EVT_MOVING = wx.PyEventBinder( wxEVT_MOVING )
4029 EVT_CLOSE = wx.PyEventBinder( wxEVT_CLOSE_WINDOW )
4030 EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
4031 EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
4032 EVT_PAINT = wx.PyEventBinder( wxEVT_PAINT )
4033 EVT_NC_PAINT = wx.PyEventBinder( wxEVT_NC_PAINT )
4034 EVT_ERASE_BACKGROUND = wx.PyEventBinder( wxEVT_ERASE_BACKGROUND )
4035 EVT_CHAR = wx.PyEventBinder( wxEVT_CHAR )
4036 EVT_KEY_DOWN = wx.PyEventBinder( wxEVT_KEY_DOWN )
4037 EVT_KEY_UP = wx.PyEventBinder( wxEVT_KEY_UP )
4038 EVT_HOTKEY = wx.PyEventBinder( wxEVT_HOTKEY, 1)
4039 EVT_CHAR_HOOK = wx.PyEventBinder( wxEVT_CHAR_HOOK )
4040 EVT_MENU_OPEN = wx.PyEventBinder( wxEVT_MENU_OPEN )
4041 EVT_MENU_CLOSE = wx.PyEventBinder( wxEVT_MENU_CLOSE )
4042 EVT_MENU_HIGHLIGHT = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT, 1)
4043 EVT_MENU_HIGHLIGHT_ALL = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT )
4044 EVT_SET_FOCUS = wx.PyEventBinder( wxEVT_SET_FOCUS )
4045 EVT_KILL_FOCUS = wx.PyEventBinder( wxEVT_KILL_FOCUS )
4046 EVT_CHILD_FOCUS = wx.PyEventBinder( wxEVT_CHILD_FOCUS )
4047 EVT_ACTIVATE = wx.PyEventBinder( wxEVT_ACTIVATE )
4048 EVT_ACTIVATE_APP = wx.PyEventBinder( wxEVT_ACTIVATE_APP )
4049 EVT_HIBERNATE = wx.PyEventBinder( wxEVT_HIBERNATE )
4050 EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
4051 EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
4052 EVT_DROP_FILES = wx.PyEventBinder( wxEVT_DROP_FILES )
4053 EVT_INIT_DIALOG = wx.PyEventBinder( wxEVT_INIT_DIALOG )
4054 EVT_SYS_COLOUR_CHANGED = wx.PyEventBinder( wxEVT_SYS_COLOUR_CHANGED )
4055 EVT_DISPLAY_CHANGED = wx.PyEventBinder( wxEVT_DISPLAY_CHANGED )
4056 EVT_SHOW = wx.PyEventBinder( wxEVT_SHOW )
4057 EVT_MAXIMIZE = wx.PyEventBinder( wxEVT_MAXIMIZE )
4058 EVT_ICONIZE = wx.PyEventBinder( wxEVT_ICONIZE )
4059 EVT_NAVIGATION_KEY = wx.PyEventBinder( wxEVT_NAVIGATION_KEY )
4060 EVT_PALETTE_CHANGED = wx.PyEventBinder( wxEVT_PALETTE_CHANGED )
4061 EVT_QUERY_NEW_PALETTE = wx.PyEventBinder( wxEVT_QUERY_NEW_PALETTE )
4062 EVT_WINDOW_CREATE = wx.PyEventBinder( wxEVT_CREATE )
4063 EVT_WINDOW_DESTROY = wx.PyEventBinder( wxEVT_DESTROY )
4064 EVT_SET_CURSOR = wx.PyEventBinder( wxEVT_SET_CURSOR )
4065 EVT_MOUSE_CAPTURE_CHANGED = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_CHANGED )
4066 EVT_MOUSE_CAPTURE_LOST = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_LOST )
4067
4068 EVT_LEFT_DOWN = wx.PyEventBinder( wxEVT_LEFT_DOWN )
4069 EVT_LEFT_UP = wx.PyEventBinder( wxEVT_LEFT_UP )
4070 EVT_MIDDLE_DOWN = wx.PyEventBinder( wxEVT_MIDDLE_DOWN )
4071 EVT_MIDDLE_UP = wx.PyEventBinder( wxEVT_MIDDLE_UP )
4072 EVT_RIGHT_DOWN = wx.PyEventBinder( wxEVT_RIGHT_DOWN )
4073 EVT_RIGHT_UP = wx.PyEventBinder( wxEVT_RIGHT_UP )
4074 EVT_MOTION = wx.PyEventBinder( wxEVT_MOTION )
4075 EVT_LEFT_DCLICK = wx.PyEventBinder( wxEVT_LEFT_DCLICK )
4076 EVT_MIDDLE_DCLICK = wx.PyEventBinder( wxEVT_MIDDLE_DCLICK )
4077 EVT_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_RIGHT_DCLICK )
4078 EVT_LEAVE_WINDOW = wx.PyEventBinder( wxEVT_LEAVE_WINDOW )
4079 EVT_ENTER_WINDOW = wx.PyEventBinder( wxEVT_ENTER_WINDOW )
4080 EVT_MOUSEWHEEL = wx.PyEventBinder( wxEVT_MOUSEWHEEL )
4081
4082 EVT_MOUSE_EVENTS = wx.PyEventBinder([ wxEVT_LEFT_DOWN,
4083                                      wxEVT_LEFT_UP,
4084                                      wxEVT_MIDDLE_DOWN,
4085                                      wxEVT_MIDDLE_UP,
4086                                      wxEVT_RIGHT_DOWN,
4087                                      wxEVT_RIGHT_UP,
4088                                      wxEVT_MOTION,
4089                                      wxEVT_LEFT_DCLICK,
4090                                      wxEVT_MIDDLE_DCLICK,
4091                                      wxEVT_RIGHT_DCLICK,
4092                                      wxEVT_ENTER_WINDOW,
4093                                      wxEVT_LEAVE_WINDOW,
4094                                      wxEVT_MOUSEWHEEL
4095                                      ])
4096
4097
4098 # Scrolling from wxWindow (sent to wxScrolledWindow)
4099 EVT_SCROLLWIN = wx.PyEventBinder([ wxEVT_SCROLLWIN_TOP,
4100                                   wxEVT_SCROLLWIN_BOTTOM,
4101                                   wxEVT_SCROLLWIN_LINEUP,
4102                                   wxEVT_SCROLLWIN_LINEDOWN,
4103                                   wxEVT_SCROLLWIN_PAGEUP,
4104                                   wxEVT_SCROLLWIN_PAGEDOWN,
4105                                   wxEVT_SCROLLWIN_THUMBTRACK,
4106                                   wxEVT_SCROLLWIN_THUMBRELEASE,
4107                                   ])
4108
4109 EVT_SCROLLWIN_TOP = wx.PyEventBinder( wxEVT_SCROLLWIN_TOP )
4110 EVT_SCROLLWIN_BOTTOM = wx.PyEventBinder( wxEVT_SCROLLWIN_BOTTOM )
4111 EVT_SCROLLWIN_LINEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEUP )
4112 EVT_SCROLLWIN_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEDOWN )
4113 EVT_SCROLLWIN_PAGEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEUP )
4114 EVT_SCROLLWIN_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEDOWN )
4115 EVT_SCROLLWIN_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBTRACK )
4116 EVT_SCROLLWIN_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBRELEASE )
4117
4118 # Scrolling from wx.Slider and wx.ScrollBar
4119 EVT_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
4120                                wxEVT_SCROLL_BOTTOM,
4121                                wxEVT_SCROLL_LINEUP,
4122                                wxEVT_SCROLL_LINEDOWN,
4123                                wxEVT_SCROLL_PAGEUP,
4124                                wxEVT_SCROLL_PAGEDOWN,
4125                                wxEVT_SCROLL_THUMBTRACK,
4126                                wxEVT_SCROLL_THUMBRELEASE,
4127                                wxEVT_SCROLL_CHANGED,
4128                                ])
4129
4130 EVT_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP )
4131 EVT_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM )
4132 EVT_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP )
4133 EVT_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN )
4134 EVT_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP )
4135 EVT_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN )
4136 EVT_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK )
4137 EVT_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE )
4138 EVT_SCROLL_CHANGED = wx.PyEventBinder( wxEVT_SCROLL_CHANGED )
4139 EVT_SCROLL_ENDSCROLL = EVT_SCROLL_CHANGED
4140
4141 # Scrolling from wx.Slider and wx.ScrollBar, with an id
4142 EVT_COMMAND_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
4143                                        wxEVT_SCROLL_BOTTOM,
4144                                        wxEVT_SCROLL_LINEUP,
4145                                        wxEVT_SCROLL_LINEDOWN,
4146                                        wxEVT_SCROLL_PAGEUP,
4147                                        wxEVT_SCROLL_PAGEDOWN,
4148                                        wxEVT_SCROLL_THUMBTRACK,
4149                                        wxEVT_SCROLL_THUMBRELEASE,
4150                                        wxEVT_SCROLL_CHANGED,
4151                                        ], 1)
4152
4153 EVT_COMMAND_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP, 1)
4154 EVT_COMMAND_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM, 1)
4155 EVT_COMMAND_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP, 1)
4156 EVT_COMMAND_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN, 1)
4157 EVT_COMMAND_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP, 1)
4158 EVT_COMMAND_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN, 1)
4159 EVT_COMMAND_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK, 1)
4160 EVT_COMMAND_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE, 1)
4161 EVT_COMMAND_SCROLL_CHANGED = wx.PyEventBinder( wxEVT_SCROLL_CHANGED, 1)
4162 EVT_COMMAND_SCROLL_ENDSCROLL = EVT_COMMAND_SCROLL_CHANGED
4163
4164 EVT_BUTTON = wx.PyEventBinder( wxEVT_COMMAND_BUTTON_CLICKED, 1)
4165 EVT_CHECKBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKBOX_CLICKED, 1)
4166 EVT_CHOICE = wx.PyEventBinder( wxEVT_COMMAND_CHOICE_SELECTED, 1)
4167 EVT_LISTBOX = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_SELECTED, 1)
4168 EVT_LISTBOX_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, 1)
4169 EVT_MENU = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 1)
4170 EVT_MENU_RANGE = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 2)
4171 EVT_SLIDER = wx.PyEventBinder( wxEVT_COMMAND_SLIDER_UPDATED, 1)
4172 EVT_RADIOBOX = wx.PyEventBinder( wxEVT_COMMAND_RADIOBOX_SELECTED, 1)
4173 EVT_RADIOBUTTON = wx.PyEventBinder( wxEVT_COMMAND_RADIOBUTTON_SELECTED, 1)
4174
4175 EVT_SCROLLBAR = wx.PyEventBinder( wxEVT_COMMAND_SCROLLBAR_UPDATED, 1)
4176 EVT_VLBOX = wx.PyEventBinder( wxEVT_COMMAND_VLBOX_SELECTED, 1)
4177 EVT_COMBOBOX = wx.PyEventBinder( wxEVT_COMMAND_COMBOBOX_SELECTED, 1)
4178 EVT_TOOL = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 1)
4179 EVT_TOOL_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 2)
4180 EVT_TOOL_RCLICKED = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 1)
4181 EVT_TOOL_RCLICKED_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 2)
4182 EVT_TOOL_ENTER = wx.PyEventBinder( wxEVT_COMMAND_TOOL_ENTER, 1)
4183 EVT_CHECKLISTBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, 1)
4184
4185
4186 EVT_COMMAND_LEFT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_CLICK, 1)
4187 EVT_COMMAND_LEFT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_DCLICK, 1)
4188 EVT_COMMAND_RIGHT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_CLICK, 1)
4189 EVT_COMMAND_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_DCLICK, 1)
4190 EVT_COMMAND_SET_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_SET_FOCUS, 1)
4191 EVT_COMMAND_KILL_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_KILL_FOCUS, 1)
4192 EVT_COMMAND_ENTER = wx.PyEventBinder( wxEVT_COMMAND_ENTER, 1)
4193
4194 EVT_IDLE = wx.PyEventBinder( wxEVT_IDLE )
4195
4196 EVT_UPDATE_UI = wx.PyEventBinder( wxEVT_UPDATE_UI, 1)
4197 EVT_UPDATE_UI_RANGE = wx.PyEventBinder( wxEVT_UPDATE_UI, 2)
4198
4199 EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU )
4200
4201 EVT_TEXT_CUT   =  wx.PyEventBinder( wxEVT_COMMAND_TEXT_CUT )
4202 EVT_TEXT_COPY  =  wx.PyEventBinder( wxEVT_COMMAND_TEXT_COPY )
4203 EVT_TEXT_PASTE =  wx.PyEventBinder( wxEVT_COMMAND_TEXT_PASTE )
4204
4205
4206 #---------------------------------------------------------------------------
4207
4208 class Event(Object):
4209     """
4210     An event is a structure holding information about an event passed to a
4211     callback or member function. wx.Event is an abstract base class for
4212     other event classes
4213     """
4214     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4215     def __init__(self): raise AttributeError, "No constructor defined"
4216     __repr__ = _swig_repr
4217     __swig_destroy__ = _core_.delete_Event
4218     __del__ = lambda self : None;
4219     def SetEventType(*args, **kwargs):
4220         """
4221         SetEventType(self, EventType typ)
4222
4223         Sets the specific type of the event.
4224         """
4225         return _core_.Event_SetEventType(*args, **kwargs)
4226
4227     def GetEventType(*args, **kwargs):
4228         """
4229         GetEventType(self) -> EventType
4230
4231         Returns the identifier of the given event type, such as
4232         ``wxEVT_COMMAND_BUTTON_CLICKED``.
4233         """
4234         return _core_.Event_GetEventType(*args, **kwargs)
4235
4236     def GetEventObject(*args, **kwargs):
4237         """
4238         GetEventObject(self) -> Object
4239
4240         Returns the object (usually a window) associated with the event, if
4241         any.
4242         """
4243         return _core_.Event_GetEventObject(*args, **kwargs)
4244
4245     def SetEventObject(*args, **kwargs):
4246         """
4247         SetEventObject(self, Object obj)
4248
4249         Sets the originating object, or in other words, obj is normally the
4250         object that is sending the event.
4251         """
4252         return _core_.Event_SetEventObject(*args, **kwargs)
4253
4254     def GetTimestamp(*args, **kwargs):
4255         """GetTimestamp(self) -> long"""
4256         return _core_.Event_GetTimestamp(*args, **kwargs)
4257
4258     def SetTimestamp(*args, **kwargs):
4259         """SetTimestamp(self, long ts=0)"""
4260         return _core_.Event_SetTimestamp(*args, **kwargs)
4261
4262     def GetId(*args, **kwargs):
4263         """
4264         GetId(self) -> int
4265
4266         Returns the identifier associated with this event, such as a button
4267         command id.
4268         """
4269         return _core_.Event_GetId(*args, **kwargs)
4270
4271     def SetId(*args, **kwargs):
4272         """
4273         SetId(self, int Id)
4274
4275         Set's the ID for the event.  This is usually the ID of the window that
4276         is sending the event, but it can also be a command id from a menu
4277         item, etc.
4278         """
4279         return _core_.Event_SetId(*args, **kwargs)
4280
4281     def IsCommandEvent(*args, **kwargs):
4282         """
4283         IsCommandEvent(self) -> bool
4284
4285         Returns true if the event is or is derived from `wx.CommandEvent` else
4286         it returns false. Note: Exists only for optimization purposes.
4287         """
4288         return _core_.Event_IsCommandEvent(*args, **kwargs)
4289
4290     def Skip(*args, **kwargs):
4291         """
4292         Skip(self, bool skip=True)
4293
4294         This method can be used inside an event handler to control whether
4295         further event handlers bound to this event will be called after the
4296         current one returns. Without Skip() (or equivalently if Skip(False) is
4297         used), the event will not be processed any more. If Skip(True) is
4298         called, the event processing system continues searching for a further
4299         handler function for this event, even though it has been processed
4300         already in the current handler.
4301         """
4302         return _core_.Event_Skip(*args, **kwargs)
4303
4304     def GetSkipped(*args, **kwargs):
4305         """
4306         GetSkipped(self) -> bool
4307
4308         Returns true if the event handler should be skipped, false otherwise.
4309         :see: `Skip`
4310         """
4311         return _core_.Event_GetSkipped(*args, **kwargs)
4312
4313     def ShouldPropagate(*args, **kwargs):
4314         """
4315         ShouldPropagate(self) -> bool
4316
4317         Test if this event should be propagated to the parent window or not,
4318         i.e. if the propagation level is currently greater than 0.
4319         """
4320         return _core_.Event_ShouldPropagate(*args, **kwargs)
4321
4322     def StopPropagation(*args, **kwargs):
4323         """
4324         StopPropagation(self) -> int
4325
4326         Stop the event from propagating to its parent window.  Returns the old
4327         propagation level value which may be later passed to
4328         `ResumePropagation` to allow propagating the event again.
4329         """
4330         return _core_.Event_StopPropagation(*args, **kwargs)
4331
4332     def ResumePropagation(*args, **kwargs):
4333         """
4334         ResumePropagation(self, int propagationLevel)
4335
4336         Resume the event propagation by restoring the propagation level.  (For
4337         example, you can use the value returned by an earlier call to
4338         `StopPropagation`.)
4339
4340         """
4341         return _core_.Event_ResumePropagation(*args, **kwargs)
4342
4343     def Clone(*args, **kwargs):
4344         """Clone(self) -> Event"""
4345         return _core_.Event_Clone(*args, **kwargs)
4346
4347     EventObject = property(GetEventObject,SetEventObject,doc="See `GetEventObject` and `SetEventObject`")
4348     EventType = property(GetEventType,SetEventType,doc="See `GetEventType` and `SetEventType`")
4349     Id = property(GetId,SetId,doc="See `GetId` and `SetId`")
4350     Skipped = property(GetSkipped,doc="See `GetSkipped`")
4351     Timestamp = property(GetTimestamp,SetTimestamp,doc="See `GetTimestamp` and `SetTimestamp`")
4352 _core_.Event_swigregister(Event)
4353
4354 #---------------------------------------------------------------------------
4355
4356 class PropagationDisabler(object):
4357     """
4358     Helper class to temporarily change an event not to propagate.  Simply
4359     create an instance of this class and then whe it is destroyed the
4360     propogation of the event will be restored.
4361     """
4362     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4363     __repr__ = _swig_repr
4364     def __init__(self, *args, **kwargs):
4365         """
4366         __init__(self, Event event) -> PropagationDisabler
4367
4368         Helper class to temporarily change an event not to propagate.  Simply
4369         create an instance of this class and then whe it is destroyed the
4370         propogation of the event will be restored.
4371         """
4372         _core_.PropagationDisabler_swiginit(self,_core_.new_PropagationDisabler(*args, **kwargs))
4373     __swig_destroy__ = _core_.delete_PropagationDisabler
4374     __del__ = lambda self : None;
4375 _core_.PropagationDisabler_swigregister(PropagationDisabler)
4376
4377 class PropagateOnce(object):
4378     """
4379     A helper class that will temporarily lower propagation level of an
4380     event.  Simply create an instance of this class and then whe it is
4381     destroyed the propogation of the event will be restored.
4382     """
4383     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4384     __repr__ = _swig_repr
4385     def __init__(self, *args, **kwargs):
4386         """
4387         __init__(self, Event event) -> PropagateOnce
4388
4389         A helper class that will temporarily lower propagation level of an
4390         event.  Simply create an instance of this class and then whe it is
4391         destroyed the propogation of the event will be restored.
4392         """
4393         _core_.PropagateOnce_swiginit(self,_core_.new_PropagateOnce(*args, **kwargs))
4394     __swig_destroy__ = _core_.delete_PropagateOnce
4395     __del__ = lambda self : None;
4396 _core_.PropagateOnce_swigregister(PropagateOnce)
4397
4398 #---------------------------------------------------------------------------
4399
4400 class CommandEvent(Event):
4401     """
4402     This event class contains information about command events, which
4403     originate from a variety of simple controls, as well as menus and
4404     toolbars.
4405     """
4406     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4407     __repr__ = _swig_repr
4408     def __init__(self, *args, **kwargs):
4409         """
4410         __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent
4411
4412         This event class contains information about command events, which
4413         originate from a variety of simple controls, as well as menus and
4414         toolbars.
4415         """
4416         _core_.CommandEvent_swiginit(self,_core_.new_CommandEvent(*args, **kwargs))
4417     def GetSelection(*args, **kwargs):
4418         """
4419         GetSelection(self) -> int
4420
4421         Returns item index for a listbox or choice selection event (not valid
4422         for a deselection).
4423         """
4424         return _core_.CommandEvent_GetSelection(*args, **kwargs)
4425
4426     def SetString(*args, **kwargs):
4427         """SetString(self, String s)"""
4428         return _core_.CommandEvent_SetString(*args, **kwargs)
4429
4430     def GetString(*args, **kwargs):
4431         """
4432         GetString(self) -> String
4433
4434         Returns item string for a listbox or choice selection event (not valid
4435         for a deselection).
4436         """
4437         return _core_.CommandEvent_GetString(*args, **kwargs)
4438
4439     def IsChecked(*args, **kwargs):
4440         """
4441         IsChecked(self) -> bool
4442
4443         This method can be used with checkbox and menu events: for the
4444         checkboxes, the method returns true for a selection event and false
4445         for a deselection one. For the menu events, this method indicates if
4446         the menu item just has become checked or unchecked (and thus only
4447         makes sense for checkable menu items).
4448         """
4449         return _core_.CommandEvent_IsChecked(*args, **kwargs)
4450
4451     Checked = IsChecked
4452     def IsSelection(*args, **kwargs):
4453         """
4454         IsSelection(self) -> bool
4455
4456         For a listbox or similar event, returns true if it is a selection,
4457         false if it is a deselection.
4458         """
4459         return _core_.CommandEvent_IsSelection(*args, **kwargs)
4460
4461     def SetExtraLong(*args, **kwargs):
4462         """SetExtraLong(self, long extraLong)"""
4463         return _core_.CommandEvent_SetExtraLong(*args, **kwargs)
4464
4465     def GetExtraLong(*args, **kwargs):
4466         """
4467         GetExtraLong(self) -> long
4468
4469         Returns extra information dependant on the event objects type. If the
4470         event comes from a listbox selection, it is a boolean determining
4471         whether the event was a selection (true) or a deselection (false). A
4472         listbox deselection only occurs for multiple-selection boxes, and in
4473         this case the index and string values are indeterminate and the
4474         listbox must be examined by the application.
4475         """
4476         return _core_.CommandEvent_GetExtraLong(*args, **kwargs)
4477
4478     def SetInt(*args, **kwargs):
4479         """SetInt(self, int i)"""
4480         return _core_.CommandEvent_SetInt(*args, **kwargs)
4481
4482     def GetInt(*args, **kwargs):
4483         """
4484         GetInt(self) -> int
4485
4486         Returns the integer identifier corresponding to a listbox, choice or
4487         radiobox selection (only if the event was a selection, not a
4488         deselection), or a boolean value representing the value of a checkbox.
4489         """
4490         return _core_.CommandEvent_GetInt(*args, **kwargs)
4491
4492     def GetClientData(*args, **kwargs):
4493         """
4494         GetClientData(self) -> PyObject
4495
4496         Returns the client data object for a listbox or choice selection event, (if any.)
4497         """
4498         return _core_.CommandEvent_GetClientData(*args, **kwargs)
4499
4500     def SetClientData(*args, **kwargs):
4501         """
4502         SetClientData(self, PyObject clientData)
4503
4504         Associate the given client data with the item at position n.
4505         """
4506         return _core_.CommandEvent_SetClientData(*args, **kwargs)
4507
4508     GetClientObject = GetClientData
4509     SetClientObject = SetClientData
4510
4511     def Clone(*args, **kwargs):
4512         """Clone(self) -> Event"""
4513         return _core_.CommandEvent_Clone(*args, **kwargs)
4514
4515     ClientData = property(GetClientData,SetClientData,doc="See `GetClientData` and `SetClientData`")
4516     ClientObject = property(GetClientObject,SetClientObject,doc="See `GetClientObject` and `SetClientObject`")
4517     ExtraLong = property(GetExtraLong,SetExtraLong,doc="See `GetExtraLong` and `SetExtraLong`")
4518     Int = property(GetInt,SetInt,doc="See `GetInt` and `SetInt`")
4519     Selection = property(GetSelection,doc="See `GetSelection`")
4520     String = property(GetString,SetString,doc="See `GetString` and `SetString`")
4521 _core_.CommandEvent_swigregister(CommandEvent)
4522
4523 #---------------------------------------------------------------------------
4524
4525 class NotifyEvent(CommandEvent):
4526     """
4527     An instance of this class (or one of its derived classes) is sent from
4528     a control when the control's state is being changed and the control
4529     allows that change to be prevented from happening.  The event handler
4530     can call `Veto` or `Allow` to tell the control what to do.
4531     """
4532     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4533     __repr__ = _swig_repr
4534     def __init__(self, *args, **kwargs):
4535         """
4536         __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent
4537
4538         An instance of this class (or one of its derived classes) is sent from
4539         a control when the control's state is being changed and the control
4540         allows that change to be prevented from happening.  The event handler
4541         can call `Veto` or `Allow` to tell the control what to do.
4542         """
4543         _core_.NotifyEvent_swiginit(self,_core_.new_NotifyEvent(*args, **kwargs))
4544     def Veto(*args, **kwargs):
4545         """
4546         Veto(self)
4547
4548         Prevents the change announced by this event from happening.
4549
4550         It is in general a good idea to notify the user about the reasons for
4551         vetoing the change because otherwise the applications behaviour (which
4552         just refuses to do what the user wants) might be quite surprising.
4553         """
4554         return _core_.NotifyEvent_Veto(*args, **kwargs)
4555
4556     def Allow(*args, **kwargs):
4557         """
4558         Allow(self)
4559
4560         This is the opposite of `Veto`: it explicitly allows the event to be
4561         processed. For most events it is not necessary to call this method as
4562         the events are allowed anyhow but some are forbidden by default (this
4563         will be mentioned in the corresponding event description).
4564         """
4565         return _core_.NotifyEvent_Allow(*args, **kwargs)
4566
4567     def IsAllowed(*args, **kwargs):
4568         """
4569         IsAllowed(self) -> bool
4570
4571         Returns true if the change is allowed (`Veto` hasn't been called) or
4572         false otherwise (if it was).
4573         """
4574         return _core_.NotifyEvent_IsAllowed(*args, **kwargs)
4575
4576 _core_.NotifyEvent_swigregister(NotifyEvent)
4577
4578 #---------------------------------------------------------------------------
4579
4580 class ScrollEvent(CommandEvent):
4581     """
4582     A scroll event holds information about events sent from stand-alone
4583     scrollbars and sliders. Note that scrolled windows do not send
4584     instnaces of this event class, but send the `wx.ScrollWinEvent`
4585     instead.
4586     """
4587     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4588     __repr__ = _swig_repr
4589     def __init__(self, *args, **kwargs):
4590         """
4591         __init__(self, EventType commandType=wxEVT_NULL, int winid=0, int pos=0,
4592             int orient=0) -> ScrollEvent
4593         """
4594         _core_.ScrollEvent_swiginit(self,_core_.new_ScrollEvent(*args, **kwargs))
4595     def GetOrientation(*args, **kwargs):
4596         """
4597         GetOrientation(self) -> int
4598
4599         Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4600         the scrollbar.
4601         """
4602         return _core_.ScrollEvent_GetOrientation(*args, **kwargs)
4603
4604     def GetPosition(*args, **kwargs):
4605         """
4606         GetPosition(self) -> int
4607
4608         Returns the position of the scrollbar.
4609         """
4610         return _core_.ScrollEvent_GetPosition(*args, **kwargs)
4611
4612     def SetOrientation(*args, **kwargs):
4613         """SetOrientation(self, int orient)"""
4614         return _core_.ScrollEvent_SetOrientation(*args, **kwargs)
4615
4616     def SetPosition(*args, **kwargs):
4617         """SetPosition(self, int pos)"""
4618         return _core_.ScrollEvent_SetPosition(*args, **kwargs)
4619
4620     Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`")
4621     Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
4622 _core_.ScrollEvent_swigregister(ScrollEvent)
4623
4624 #---------------------------------------------------------------------------
4625
4626 class ScrollWinEvent(Event):
4627     """
4628     A wx.ScrollWinEvent holds information about scrolling and is sent from
4629     scrolling windows.
4630     """
4631     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4632     __repr__ = _swig_repr
4633     def __init__(self, *args, **kwargs):
4634         """
4635         __init__(self, EventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent
4636
4637         A wx.ScrollWinEvent holds information about scrolling and is sent from
4638         scrolling windows.
4639         """
4640         _core_.ScrollWinEvent_swiginit(self,_core_.new_ScrollWinEvent(*args, **kwargs))
4641     def GetOrientation(*args, **kwargs):
4642         """
4643         GetOrientation(self) -> int
4644
4645         Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4646         the scrollbar.
4647         """
4648         return _core_.ScrollWinEvent_GetOrientation(*args, **kwargs)
4649
4650     def GetPosition(*args, **kwargs):
4651         """
4652         GetPosition(self) -> int
4653
4654         Returns the position of the scrollbar for the thumb track and release
4655         events. Note that this field can't be used for the other events, you
4656         need to query the window itself for the current position in that case.
4657         """
4658         return _core_.ScrollWinEvent_GetPosition(*args, **kwargs)
4659
4660     def SetOrientation(*args, **kwargs):
4661         """SetOrientation(self, int orient)"""
4662         return _core_.ScrollWinEvent_SetOrientation(*args, **kwargs)
4663
4664     def SetPosition(*args, **kwargs):
4665         """SetPosition(self, int pos)"""
4666         return _core_.ScrollWinEvent_SetPosition(*args, **kwargs)
4667
4668     Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`")
4669     Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
4670 _core_.ScrollWinEvent_swigregister(ScrollWinEvent)
4671
4672 #---------------------------------------------------------------------------
4673
4674 MOUSE_BTN_ANY = _core_.MOUSE_BTN_ANY
4675 MOUSE_BTN_NONE = _core_.MOUSE_BTN_NONE
4676 MOUSE_BTN_LEFT = _core_.MOUSE_BTN_LEFT
4677 MOUSE_BTN_MIDDLE = _core_.MOUSE_BTN_MIDDLE
4678 MOUSE_BTN_RIGHT = _core_.MOUSE_BTN_RIGHT
4679 class MouseEvent(Event):
4680     """
4681     This event class contains information about the events generated by
4682     the mouse: they include mouse buttons press and release events and
4683     mouse move events.
4684
4685     All mouse events involving the buttons use ``wx.MOUSE_BTN_LEFT`` for
4686     the left mouse button, ``wx.MOUSE_BTN_MIDDLE`` for the middle one and
4687     ``wx.MOUSE_BTN_RIGHT`` for the right one. Note that not all mice have
4688     a middle button so a portable application should avoid relying on the
4689     events from it.
4690
4691     Note the difference between methods like `LeftDown` and `LeftIsDown`:
4692     the former returns true when the event corresponds to the left mouse
4693     button click while the latter returns true if the left mouse button is
4694     currently being pressed. For example, when the user is dragging the
4695     mouse you can use `LeftIsDown` to test whether the left mouse button
4696     is (still) depressed. Also, by convention, if `LeftDown` returns true,
4697     `LeftIsDown` will also return true in wxWidgets whatever the
4698     underlying GUI behaviour is (which is platform-dependent). The same
4699     applies, of course, to other mouse buttons as well.
4700     """
4701     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4702     __repr__ = _swig_repr
4703     def __init__(self, *args, **kwargs):
4704         """
4705         __init__(self, EventType mouseType=wxEVT_NULL) -> MouseEvent
4706
4707         Constructs a wx.MouseEvent.  Valid event types are:
4708
4709             * wxEVT_ENTER_WINDOW
4710             * wxEVT_LEAVE_WINDOW
4711             * wxEVT_LEFT_DOWN
4712             * wxEVT_LEFT_UP
4713             * wxEVT_LEFT_DCLICK
4714             * wxEVT_MIDDLE_DOWN
4715             * wxEVT_MIDDLE_UP
4716             * wxEVT_MIDDLE_DCLICK
4717             * wxEVT_RIGHT_DOWN
4718             * wxEVT_RIGHT_UP
4719             * wxEVT_RIGHT_DCLICK
4720             * wxEVT_MOTION
4721             * wxEVT_MOUSEWHEEL
4722         """
4723         _core_.MouseEvent_swiginit(self,_core_.new_MouseEvent(*args, **kwargs))
4724     def IsButton(*args, **kwargs):
4725         """
4726         IsButton(self) -> bool
4727
4728         Returns true if the event was a mouse button event (not necessarily a
4729         button down event - that may be tested using `ButtonDown`).
4730         """
4731         return _core_.MouseEvent_IsButton(*args, **kwargs)
4732
4733     def ButtonDown(*args, **kwargs):
4734         """
4735         ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool
4736
4737         If the argument is omitted, this returns true if the event was any
4738         mouse button down event. Otherwise the argument specifies which
4739         button-down event shold be checked for (see `Button` for the possible
4740         values).
4741         """
4742         return _core_.MouseEvent_ButtonDown(*args, **kwargs)
4743
4744     def ButtonDClick(*args, **kwargs):
4745         """
4746         ButtonDClick(self, int but=MOUSE_BTN_ANY) -> bool
4747
4748         If the argument is omitted, this returns true if the event was any
4749         mouse double click event. Otherwise the argument specifies which
4750         double click event to check for (see `Button` for the possible
4751         values).
4752         """
4753         return _core_.MouseEvent_ButtonDClick(*args, **kwargs)
4754
4755     def ButtonUp(*args, **kwargs):
4756         """
4757         ButtonUp(self, int but=MOUSE_BTN_ANY) -> bool
4758
4759         If the argument is omitted, this returns true if the event was any
4760         mouse button up event. Otherwise the argument specifies which button
4761         up event to check for (see `Button` for the possible values).
4762         """
4763         return _core_.MouseEvent_ButtonUp(*args, **kwargs)
4764
4765     def Button(*args, **kwargs):
4766         """
4767         Button(self, int button) -> bool
4768
4769         Returns true if the identified mouse button is changing state. Valid
4770         values of button are:
4771
4772              ====================      =====================================
4773              wx.MOUSE_BTN_LEFT         check if left button was pressed
4774              wx.MOUSE_BTN_MIDDLE       check if middle button was pressed
4775              wx.MOUSE_BTN_RIGHT        check if right button was pressed
4776              wx.MOUSE_BTN_ANY          check if any button was pressed
4777              ====================      =====================================
4778
4779         """
4780         return _core_.MouseEvent_Button(*args, **kwargs)
4781
4782     def ButtonIsDown(*args, **kwargs):
4783         """ButtonIsDown(self, int but) -> bool"""
4784         return _core_.MouseEvent_ButtonIsDown(*args, **kwargs)
4785
4786     def GetButton(*args, **kwargs):
4787         """
4788         GetButton(self) -> int
4789
4790         Returns the mouse button which generated this event or
4791         wx.MOUSE_BTN_NONE if no button is involved (for mouse move, enter or
4792         leave event, for example). Otherwise wx.MOUSE_BTN_LEFT is returned for
4793         the left button down, up and double click events, wx.MOUSE_BTN_MIDDLE
4794         and wx.MOUSE_BTN_RIGHT for the same events for the middle and the
4795         right buttons respectively.
4796         """
4797         return _core_.MouseEvent_GetButton(*args, **kwargs)
4798
4799     def ControlDown(*args, **kwargs):
4800         """
4801         ControlDown(self) -> bool
4802
4803         Returns true if the control key was down at the time of the event.
4804         """
4805         return _core_.MouseEvent_ControlDown(*args, **kwargs)
4806
4807     def MetaDown(*args, **kwargs):
4808         """
4809         MetaDown(self) -> bool
4810
4811         Returns true if the Meta key was down at the time of the event.
4812         """
4813         return _core_.MouseEvent_MetaDown(*args, **kwargs)
4814
4815     def AltDown(*args, **kwargs):
4816         """
4817         AltDown(self) -> bool
4818
4819         Returns true if the Alt key was down at the time of the event.
4820         """
4821         return _core_.MouseEvent_AltDown(*args, **kwargs)
4822
4823     def ShiftDown(*args, **kwargs):
4824         """
4825         ShiftDown(self) -> bool
4826
4827         Returns true if the Shift key was down at the time of the event.
4828         """
4829         return _core_.MouseEvent_ShiftDown(*args, **kwargs)
4830
4831     def CmdDown(*args, **kwargs):
4832         """
4833         CmdDown(self) -> bool
4834
4835         "Cmd" is a pseudo key which is the same as Control for PC and Unix
4836         platforms but the special "Apple" (a.k.a as "Command") key on
4837         Macs. It often makes sense to use it instead of, say, `ControlDown`
4838         because Cmd key is used for the same thing under Mac as Ctrl
4839         elsewhere. The Ctrl key still exists, it's just not used for this
4840         purpose. So for non-Mac platforms this is the same as `ControlDown`
4841         and Macs this is the same as `MetaDown`.
4842         """
4843         return _core_.MouseEvent_CmdDown(*args, **kwargs)
4844
4845     def LeftDown(*args, **kwargs):
4846         """
4847         LeftDown(self) -> bool
4848
4849         Returns true if the left mouse button state changed to down.
4850         """
4851         return _core_.MouseEvent_LeftDown(*args, **kwargs)
4852
4853     def MiddleDown(*args, **kwargs):
4854         """
4855         MiddleDown(self) -> bool
4856
4857         Returns true if the middle mouse button state changed to down.
4858         """
4859         return _core_.MouseEvent_MiddleDown(*args, **kwargs)
4860
4861     def RightDown(*args, **kwargs):
4862         """
4863         RightDown(self) -> bool
4864
4865         Returns true if the right mouse button state changed to down.
4866         """
4867         return _core_.MouseEvent_RightDown(*args, **kwargs)
4868
4869     def LeftUp(*args, **kwargs):
4870         """
4871         LeftUp(self) -> bool
4872
4873         Returns true if the left mouse button state changed to up.
4874         """
4875         return _core_.MouseEvent_LeftUp(*args, **kwargs)
4876
4877     def MiddleUp(*args, **kwargs):
4878         """
4879         MiddleUp(self) -> bool
4880
4881         Returns true if the middle mouse button state changed to up.
4882         """
4883         return _core_.MouseEvent_MiddleUp(*args, **kwargs)
4884
4885     def RightUp(*args, **kwargs):
4886         """
4887         RightUp(self) -> bool
4888
4889         Returns true if the right mouse button state changed to up.
4890         """
4891         return _core_.MouseEvent_RightUp(*args, **kwargs)
4892
4893     def LeftDClick(*args, **kwargs):
4894         """
4895         LeftDClick(self) -> bool
4896
4897         Returns true if the event was a left button double click.
4898         """
4899         return _core_.MouseEvent_LeftDClick(*args, **kwargs)
4900
4901     def MiddleDClick(*args, **kwargs):
4902         """
4903         MiddleDClick(self) -> bool
4904
4905         Returns true if the event was a middle button double click.
4906         """
4907         return _core_.MouseEvent_MiddleDClick(*args, **kwargs)
4908
4909     def RightDClick(*args, **kwargs):
4910         """
4911         RightDClick(self) -> bool
4912
4913         Returns true if the event was a right button double click.
4914         """
4915         return _core_.MouseEvent_RightDClick(*args, **kwargs)
4916
4917     def LeftIsDown(*args, **kwargs):
4918         """
4919         LeftIsDown(self) -> bool
4920
4921         Returns true if the left mouse button is currently down, independent
4922         of the current event type.
4923
4924         Please notice that it is not the same as LeftDown which returns true
4925         if the left mouse button was just pressed. Rather, it describes the
4926         state of the mouse button before the event happened.
4927
4928         This event is usually used in the mouse event handlers which process
4929         "move mouse" messages to determine whether the user is (still)
4930         dragging the mouse.
4931         """
4932         return _core_.MouseEvent_LeftIsDown(*args, **kwargs)
4933
4934     def MiddleIsDown(*args, **kwargs):
4935         """
4936         MiddleIsDown(self) -> bool
4937
4938         Returns true if the middle mouse button is currently down, independent
4939         of the current event type.
4940         """
4941         return _core_.MouseEvent_MiddleIsDown(*args, **kwargs)
4942
4943     def RightIsDown(*args, **kwargs):
4944         """
4945         RightIsDown(self) -> bool
4946
4947         Returns true if the right mouse button is currently down, independent
4948         of the current event type.
4949         """
4950         return _core_.MouseEvent_RightIsDown(*args, **kwargs)
4951
4952     def Dragging(*args, **kwargs):
4953         """
4954         Dragging(self) -> bool
4955
4956         Returns true if this was a dragging event (motion while a button is
4957         depressed).
4958         """
4959         return _core_.MouseEvent_Dragging(*args, **kwargs)
4960
4961     def Moving(*args, **kwargs):
4962         """
4963         Moving(self) -> bool
4964
4965         Returns true if this was a motion event and no mouse buttons were
4966         pressed. If any mouse button is held pressed, then this method returns
4967         false and Dragging returns true.
4968         """
4969         return _core_.MouseEvent_Moving(*args, **kwargs)
4970
4971     def Entering(*args, **kwargs):
4972         """
4973         Entering(self) -> bool
4974
4975         Returns true if the mouse was entering the window.
4976         """
4977         return _core_.MouseEvent_Entering(*args, **kwargs)
4978
4979     def Leaving(*args, **kwargs):
4980         """
4981         Leaving(self) -> bool
4982
4983         Returns true if the mouse was leaving the window.
4984         """
4985         return _core_.MouseEvent_Leaving(*args, **kwargs)
4986
4987     def GetPosition(*args, **kwargs):
4988         """
4989         GetPosition(self) -> Point
4990
4991         Returns the pixel position of the mouse in window coordinates when the
4992         event happened.
4993         """
4994         return _core_.MouseEvent_GetPosition(*args, **kwargs)
4995
4996     def GetPositionTuple(*args, **kwargs):
4997         """
4998         GetPositionTuple() -> (x,y)
4999
5000         Returns the pixel position of the mouse in window coordinates when the
5001         event happened.
5002         """
5003         return _core_.MouseEvent_GetPositionTuple(*args, **kwargs)
5004
5005     def GetLogicalPosition(*args, **kwargs):
5006         """
5007         GetLogicalPosition(self, DC dc) -> Point
5008
5009         Returns the logical mouse position in pixels (i.e. translated
5010         according to the translation set for the DC, which usually indicates
5011         that the window has been scrolled).
5012         """
5013         return _core_.MouseEvent_GetLogicalPosition(*args, **kwargs)
5014
5015     def GetX(*args, **kwargs):
5016         """
5017         GetX(self) -> int
5018
5019         Returns X coordinate of the physical mouse event position.
5020         """
5021         return _core_.MouseEvent_GetX(*args, **kwargs)
5022
5023     def GetY(*args, **kwargs):
5024         """
5025         GetY(self) -> int
5026
5027         Returns Y coordinate of the physical mouse event position.
5028         """
5029         return _core_.MouseEvent_GetY(*args, **kwargs)
5030
5031     def GetWheelRotation(*args, **kwargs):
5032         """
5033         GetWheelRotation(self) -> int
5034
5035         Get wheel rotation, positive or negative indicates direction of
5036         rotation. Current devices all send an event when rotation is equal to
5037         +/-WheelDelta, but this allows for finer resolution devices to be
5038         created in the future. Because of this you shouldn't assume that one
5039         event is equal to 1 line or whatever, but you should be able to either
5040         do partial line scrolling or wait until +/-WheelDelta rotation values
5041         have been accumulated before scrolling.
5042         """
5043         return _core_.MouseEvent_GetWheelRotation(*args, **kwargs)
5044
5045     def GetWheelDelta(*args, **kwargs):
5046         """
5047         GetWheelDelta(self) -> int
5048
5049         Get wheel delta, normally 120. This is the threshold for action to be
5050         taken, and one such action (for example, scrolling one increment)
5051         should occur for each delta.
5052         """
5053         return _core_.MouseEvent_GetWheelDelta(*args, **kwargs)
5054
5055     def GetWheelAxis(*args, **kwargs):
5056         """
5057         GetWheelAxis(self) -> int
5058
5059         Gets the axis the wheel operation concerns, 0 being the y axis as on
5060         most mouse wheels, 1 is the x axis for things like MightyMouse scrolls
5061         or horizontal trackpad scrolling.
5062         """
5063         return _core_.MouseEvent_GetWheelAxis(*args, **kwargs)
5064
5065     def GetLinesPerAction(*args, **kwargs):
5066         """
5067         GetLinesPerAction(self) -> int
5068
5069         Returns the configured number of lines (or whatever) to be scrolled
5070         per wheel action. Defaults to three.
5071         """
5072         return _core_.MouseEvent_GetLinesPerAction(*args, **kwargs)
5073
5074     def IsPageScroll(*args, **kwargs):
5075         """
5076         IsPageScroll(self) -> bool
5077
5078         Returns true if the system has been setup to do page scrolling with
5079         the mouse wheel instead of line scrolling.
5080         """
5081         return _core_.MouseEvent_IsPageScroll(*args, **kwargs)
5082
5083     m_x = property(_core_.MouseEvent_m_x_get, _core_.MouseEvent_m_x_set)
5084     m_y = property(_core_.MouseEvent_m_y_get, _core_.MouseEvent_m_y_set)
5085     m_leftDown = property(_core_.MouseEvent_m_leftDown_get, _core_.MouseEvent_m_leftDown_set)
5086     m_middleDown = property(_core_.MouseEvent_m_middleDown_get, _core_.MouseEvent_m_middleDown_set)
5087     m_rightDown = property(_core_.MouseEvent_m_rightDown_get, _core_.MouseEvent_m_rightDown_set)
5088     m_controlDown = property(_core_.MouseEvent_m_controlDown_get, _core_.MouseEvent_m_controlDown_set)
5089     m_shiftDown = property(_core_.MouseEvent_m_shiftDown_get, _core_.MouseEvent_m_shiftDown_set)
5090     m_altDown = property(_core_.MouseEvent_m_altDown_get, _core_.MouseEvent_m_altDown_set)
5091     m_metaDown = property(_core_.MouseEvent_m_metaDown_get, _core_.MouseEvent_m_metaDown_set)
5092     m_wheelRotation = property(_core_.MouseEvent_m_wheelRotation_get, _core_.MouseEvent_m_wheelRotation_set)
5093     m_wheelDelta = property(_core_.MouseEvent_m_wheelDelta_get, _core_.MouseEvent_m_wheelDelta_set)
5094     m_linesPerAction = property(_core_.MouseEvent_m_linesPerAction_get, _core_.MouseEvent_m_linesPerAction_set)
5095     Button = property(GetButton,doc="See `GetButton`")
5096     LinesPerAction = property(GetLinesPerAction,doc="See `GetLinesPerAction`")
5097     LogicalPosition = property(GetLogicalPosition,doc="See `GetLogicalPosition`")
5098     Position = property(GetPosition,doc="See `GetPosition`")
5099     WheelDelta = property(GetWheelDelta,doc="See `GetWheelDelta`")
5100     WheelRotation = property(GetWheelRotation,doc="See `GetWheelRotation`")
5101     X = property(GetX,doc="See `GetX`")
5102     Y = property(GetY,doc="See `GetY`")
5103 _core_.MouseEvent_swigregister(MouseEvent)
5104
5105 #---------------------------------------------------------------------------
5106
5107 class SetCursorEvent(Event):
5108     """
5109     A SetCursorEvent is generated when the mouse cursor is about to be set
5110     as a result of mouse motion. This event gives the application the
5111     chance to perform specific mouse cursor processing based on the
5112     current position of the mouse within the window. Use the `SetCursor`
5113     method to specify the cursor you want to be displayed.
5114     """
5115     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5116     __repr__ = _swig_repr
5117     def __init__(self, *args, **kwargs):
5118         """
5119         __init__(self, int x=0, int y=0) -> SetCursorEvent
5120
5121         Construct a new `wx.SetCursorEvent`.
5122         """
5123         _core_.SetCursorEvent_swiginit(self,_core_.new_SetCursorEvent(*args, **kwargs))
5124     def GetX(*args, **kwargs):
5125         """
5126         GetX(self) -> int
5127
5128         Returns the X coordinate of the mouse in client coordinates.
5129         """
5130         return _core_.SetCursorEvent_GetX(*args, **kwargs)
5131
5132     def GetY(*args, **kwargs):
5133         """
5134         GetY(self) -> int
5135
5136         Returns the Y coordinate of the mouse in client coordinates.
5137         """
5138         return _core_.SetCursorEvent_GetY(*args, **kwargs)
5139
5140     def SetCursor(*args, **kwargs):
5141         """
5142         SetCursor(self, Cursor cursor)
5143
5144         Sets the cursor associated with this event.
5145         """
5146         return _core_.SetCursorEvent_SetCursor(*args, **kwargs)
5147
5148     def GetCursor(*args, **kwargs):
5149         """
5150         GetCursor(self) -> Cursor
5151
5152         Returns a reference to the cursor specified by this event.
5153         """
5154         return _core_.SetCursorEvent_GetCursor(*args, **kwargs)
5155
5156     def HasCursor(*args, **kwargs):
5157         """
5158         HasCursor(self) -> bool
5159
5160         Returns true if the cursor specified by this event is a valid cursor.
5161         """
5162         return _core_.SetCursorEvent_HasCursor(*args, **kwargs)
5163
5164     Cursor = property(GetCursor,SetCursor,doc="See `GetCursor` and `SetCursor`")
5165     X = property(GetX,doc="See `GetX`")
5166     Y = property(GetY,doc="See `GetY`")
5167 _core_.SetCursorEvent_swigregister(SetCursorEvent)
5168
5169 #---------------------------------------------------------------------------
5170
5171 class KeyEvent(Event):
5172     """
5173     This event class contains information about keypress and character
5174     events.  These events are only sent to the widget that currently has
5175     the keyboard focus.
5176
5177     Notice that there are three different kinds of keyboard events in
5178     wxWidgets: key down and up events and char events. The difference
5179     between the first two is clear - the first corresponds to a key press
5180     and the second to a key release - otherwise they are identical. Just
5181     note that if the key is maintained in a pressed state you will
5182     typically get a lot of (automatically generated) down events but only
5183     one up so it is wrong to assume that there is one up event
5184     corresponding to each down one.
5185
5186     Both key events provide untranslated key codes while the char event
5187     carries the translated one. The untranslated code for alphanumeric
5188     keys is always an upper case value. For the other keys it is one of
5189     WXK_XXX values from the keycodes table. The translated key is, in
5190     general, the character the user expects to appear as the result of the
5191     key combination when typing the text into a text entry zone, for
5192     example.
5193
5194     A few examples to clarify this (all assume that CAPS LOCK is unpressed
5195     and the standard US keyboard): when the 'A' key is pressed, the key
5196     down event key code is equal to ASCII A == 65. But the char event key
5197     code is ASCII a == 97. On the other hand, if you press both SHIFT and
5198     'A' keys simultaneously , the key code in key down event will still be
5199     just 'A' while the char event key code parameter will now be 'A' as
5200     well.
5201
5202     Although in this simple case it is clear that the correct key code
5203     could be found in the key down event handler by checking the value
5204     returned by `ShiftDown`, in general you should use EVT_CHAR for this
5205     as for non alphanumeric keys or non-US keyboard layouts the
5206     translation is keyboard-layout dependent and can only be done properly
5207     by the system itself.
5208
5209     Another kind of translation is done when the control key is pressed:
5210     for example, for CTRL-A key press the key down event still carries the
5211     same key code 'A' as usual but the char event will have key code of 1,
5212     the ASCII value of this key combination.
5213
5214     You may discover how the other keys on your system behave
5215     interactively by running the KeyEvents sample in the wxPython demo and
5216     pressing some keys while the blue box at the top has the keyboard
5217     focus.
5218
5219     **Note**: If a key down event is caught and the event handler does not
5220     call event.Skip() then the coresponding char event will not
5221     happen. This is by design and enables the programs that handle both
5222     types of events to be a bit simpler.
5223
5224     **Note for Windows programmers**: The key and char events in wxWidgets
5225     are similar to but slightly different from Windows WM_KEYDOWN and
5226     WM_CHAR events. In particular, Alt-x combination will generate a char
5227     event in wxWidgets (unless it is used as an accelerator).
5228
5229     **Tip**: be sure to call event.Skip() for events that you don't
5230     process in key event function, otherwise menu shortcuts may cease to
5231     work under Windows.
5232
5233     """
5234     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5235     __repr__ = _swig_repr
5236     def __init__(self, *args, **kwargs):
5237         """
5238         __init__(self, EventType eventType=wxEVT_NULL) -> KeyEvent
5239
5240         Construct a new `wx.KeyEvent`.  Valid event types are:
5241             *
5242         """
5243         _core_.KeyEvent_swiginit(self,_core_.new_KeyEvent(*args, **kwargs))
5244     def GetModifiers(*args, **kwargs):
5245         """
5246         GetModifiers(self) -> int
5247
5248         Returns a bitmask of the current modifier settings.  Can be used to
5249         check if the key event has exactly the given modifiers without having
5250         to explicitly check that the other modifiers are not down.  For
5251         example::
5252
5253             if event.GetModifers() == wx.MOD_CONTROL:
5254                 DoSomething()
5255
5256         """
5257         return _core_.KeyEvent_GetModifiers(*args, **kwargs)
5258
5259     def ControlDown(*args, **kwargs):
5260         """
5261         ControlDown(self) -> bool
5262
5263         Returns ``True`` if the Control key was down at the time of the event.
5264         """
5265         return _core_.KeyEvent_ControlDown(*args, **kwargs)
5266
5267     def MetaDown(*args, **kwargs):
5268         """
5269         MetaDown(self) -> bool
5270
5271         Returns ``True`` if the Meta key was down at the time of the event.
5272         """
5273         return _core_.KeyEvent_MetaDown(*args, **kwargs)
5274
5275     def AltDown(*args, **kwargs):
5276         """
5277         AltDown(self) -> bool
5278
5279         Returns ``True`` if the Alt key was down at the time of the event.
5280         """
5281         return _core_.KeyEvent_AltDown(*args, **kwargs)
5282
5283     def ShiftDown(*args, **kwargs):
5284         """
5285         ShiftDown(self) -> bool
5286
5287         Returns ``True`` if the Shift key was down at the time of the event.
5288         """
5289         return _core_.KeyEvent_ShiftDown(*args, **kwargs)
5290
5291     def CmdDown(*args, **kwargs):
5292         """
5293         CmdDown(self) -> bool
5294
5295         "Cmd" is a pseudo key which is the same as Control for PC and Unix
5296         platforms but the special "Apple" (a.k.a as "Command") key on
5297         Macs. It makes often sense to use it instead of, say, `ControlDown`
5298         because Cmd key is used for the same thing under Mac as Ctrl
5299         elsewhere. The Ctrl still exists, it's just not used for this
5300         purpose. So for non-Mac platforms this is the same as `ControlDown`
5301         and Macs this is the same as `MetaDown`.
5302         """
5303         return _core_.KeyEvent_CmdDown(*args, **kwargs)
5304
5305     def HasModifiers(*args, **kwargs):
5306         """
5307         HasModifiers(self) -> bool
5308
5309         Returns true if either CTRL or ALT keys was down at the time of the
5310         key event. Note that this function does not take into account neither
5311         SHIFT nor META key states (the reason for ignoring the latter is that
5312         it is common for NUMLOCK key to be configured as META under X but the
5313         key presses even while NUMLOCK is on should be still processed
5314         normally).
5315         """
5316         return _core_.KeyEvent_HasModifiers(*args, **kwargs)
5317
5318     def GetKeyCode(*args, **kwargs):
5319         """
5320         GetKeyCode(self) -> int
5321
5322         Returns the virtual key code. ASCII events return normal ASCII values,
5323         while non-ASCII events return values such as WXK_LEFT for the left
5324         cursor key. See `wx.KeyEvent` for a full list of the virtual key
5325         codes.
5326
5327         Note that in Unicode build, the returned value is meaningful only if
5328         the user entered a character that can be represented in current
5329         locale's default charset. You can obtain the corresponding Unicode
5330         character using `GetUnicodeKey`.
5331         """
5332         return _core_.KeyEvent_GetKeyCode(*args, **kwargs)
5333
5334     def GetUnicodeKey(*args, **kwargs):
5335         """
5336         GetUnicodeKey(self) -> int
5337
5338         Returns the Unicode character corresponding to this key event.  This
5339         function is only meaningfule in a Unicode build of wxPython.
5340         """
5341         return _core_.KeyEvent_GetUnicodeKey(*args, **kwargs)
5342
5343     GetUniChar = GetUnicodeKey
5344     def SetUnicodeKey(*args, **kwargs):
5345         """
5346         SetUnicodeKey(self, int uniChar)
5347
5348         Set the Unicode value of the key event, but only if this is a Unicode
5349         build of wxPython.
5350         """
5351         return _core_.KeyEvent_SetUnicodeKey(*args, **kwargs)
5352
5353     def GetRawKeyCode(*args, **kwargs):
5354         """
5355         GetRawKeyCode(self) -> unsigned int
5356
5357         Returns the raw key code for this event. This is a platform-dependent
5358         scan code which should only be used in advanced
5359         applications. Currently the raw key codes are not supported by all
5360         ports.
5361         """
5362         return _core_.KeyEvent_GetRawKeyCode(*args, **kwargs)
5363
5364     def GetRawKeyFlags(*args, **kwargs):
5365         """
5366         GetRawKeyFlags(self) -> unsigned int
5367
5368         Returns the low level key flags for this event. The flags are
5369         platform-dependent and should only be used in advanced applications.
5370         Currently the raw key flags are not supported by all ports.
5371         """
5372         return _core_.KeyEvent_GetRawKeyFlags(*args, **kwargs)
5373
5374     def GetPosition(*args, **kwargs):
5375         """
5376         GetPosition(self) -> Point
5377
5378         Find the position of the event, if applicable.
5379         """
5380         return _core_.KeyEvent_GetPosition(*args, **kwargs)
5381
5382     def GetPositionTuple(*args, **kwargs):
5383         """
5384         GetPositionTuple() -> (x,y)
5385
5386         Find the position of the event, if applicable.
5387         """
5388         return _core_.KeyEvent_GetPositionTuple(*args, **kwargs)
5389
5390     def GetX(*args, **kwargs):
5391         """
5392         GetX(self) -> int
5393
5394         Returns the X position (in client coordinates) of the event, if
5395         applicable.
5396         """
5397         return _core_.KeyEvent_GetX(*args, **kwargs)
5398
5399     def GetY(*args, **kwargs):
5400         """
5401         GetY(self) -> int
5402
5403         Returns the Y position (in client coordinates) of the event, if
5404         applicable.
5405         """
5406         return _core_.KeyEvent_GetY(*args, **kwargs)
5407
5408     m_x = property(_core_.KeyEvent_m_x_get, _core_.KeyEvent_m_x_set)
5409     m_y = property(_core_.KeyEvent_m_y_get, _core_.KeyEvent_m_y_set)
5410     m_keyCode = property(_core_.KeyEvent_m_keyCode_get, _core_.KeyEvent_m_keyCode_set)
5411     m_controlDown = property(_core_.KeyEvent_m_controlDown_get, _core_.KeyEvent_m_controlDown_set)
5412     m_shiftDown = property(_core_.KeyEvent_m_shiftDown_get, _core_.KeyEvent_m_shiftDown_set)
5413     m_altDown = property(_core_.KeyEvent_m_altDown_get, _core_.KeyEvent_m_altDown_set)
5414     m_metaDown = property(_core_.KeyEvent_m_metaDown_get, _core_.KeyEvent_m_metaDown_set)
5415     m_scanCode = property(_core_.KeyEvent_m_scanCode_get, _core_.KeyEvent_m_scanCode_set)
5416     m_rawCode = property(_core_.KeyEvent_m_rawCode_get, _core_.KeyEvent_m_rawCode_set)
5417     m_rawFlags = property(_core_.KeyEvent_m_rawFlags_get, _core_.KeyEvent_m_rawFlags_set)
5418     KeyCode = property(GetKeyCode,doc="See `GetKeyCode`")
5419     Modifiers = property(GetModifiers,doc="See `GetModifiers`")
5420     Position = property(GetPosition,doc="See `GetPosition`")
5421     RawKeyCode = property(GetRawKeyCode,doc="See `GetRawKeyCode`")
5422     RawKeyFlags = property(GetRawKeyFlags,doc="See `GetRawKeyFlags`")
5423     UnicodeKey = property(GetUnicodeKey,SetUnicodeKey,doc="See `GetUnicodeKey` and `SetUnicodeKey`")
5424     X = property(GetX,doc="See `GetX`")
5425     Y = property(GetY,doc="See `GetY`")
5426 _core_.KeyEvent_swigregister(KeyEvent)
5427
5428 #---------------------------------------------------------------------------
5429
5430 class SizeEvent(Event):
5431     """
5432     A size event holds information about size change events.  The EVT_SIZE
5433     handler function will be called when the window it is bound to has
5434     been resized.
5435
5436     Note that the size passed is of the whole window: call
5437     `wx.Window.GetClientSize` for the area which may be used by the
5438     application.
5439
5440     When a window is resized, usually only a small part of the window is
5441     damaged and and that area is all that is in the update region for the
5442     next paint event. However, if your drawing depends on the size of the
5443     window, you may need to clear the DC explicitly and repaint the whole
5444     window. In which case, you may need to call `wx.Window.Refresh` to
5445     invalidate the entire window.
5446
5447     """
5448     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5449     __repr__ = _swig_repr
5450     def __init__(self, *args, **kwargs):
5451         """
5452         __init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent
5453
5454         Construct a new ``wx.SizeEvent``.
5455         """
5456         _core_.SizeEvent_swiginit(self,_core_.new_SizeEvent(*args, **kwargs))
5457     def GetSize(*args, **kwargs):
5458         """
5459         GetSize(self) -> Size
5460
5461         Returns the entire size of the window generating the size change
5462         event.
5463         """
5464         return _core_.SizeEvent_GetSize(*args, **kwargs)
5465
5466     def GetRect(*args, **kwargs):
5467         """GetRect(self) -> Rect"""
5468         return _core_.SizeEvent_GetRect(*args, **kwargs)
5469
5470     def SetRect(*args, **kwargs):
5471         """SetRect(self, Rect rect)"""
5472         return _core_.SizeEvent_SetRect(*args, **kwargs)
5473
5474     def SetSize(*args, **kwargs):
5475         """SetSize(self, Size size)"""
5476         return _core_.SizeEvent_SetSize(*args, **kwargs)
5477
5478     m_size = property(_core_.SizeEvent_m_size_get, _core_.SizeEvent_m_size_set)
5479     m_rect = property(_core_.SizeEvent_m_rect_get, _core_.SizeEvent_m_rect_set)
5480     Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`")
5481     Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`")
5482 _core_.SizeEvent_swigregister(SizeEvent)
5483
5484 #---------------------------------------------------------------------------
5485
5486 class MoveEvent(Event):
5487     """
5488     This event object is sent for EVT_MOVE event bindings when a window is
5489     moved to a new position.
5490     """
5491     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5492     __repr__ = _swig_repr
5493     def __init__(self, *args, **kwargs):
5494         """
5495         __init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent
5496
5497         Constructor.
5498         """
5499         _core_.MoveEvent_swiginit(self,_core_.new_MoveEvent(*args, **kwargs))
5500     def GetPosition(*args, **kwargs):
5501         """
5502         GetPosition(self) -> Point
5503
5504         Returns the position of the window generating the move change event.
5505         """
5506         return _core_.MoveEvent_GetPosition(*args, **kwargs)
5507
5508     def GetRect(*args, **kwargs):
5509         """GetRect(self) -> Rect"""
5510         return _core_.MoveEvent_GetRect(*args, **kwargs)
5511
5512     def SetRect(*args, **kwargs):
5513         """SetRect(self, Rect rect)"""
5514         return _core_.MoveEvent_SetRect(*args, **kwargs)
5515
5516     def SetPosition(*args, **kwargs):
5517         """SetPosition(self, Point pos)"""
5518         return _core_.MoveEvent_SetPosition(*args, **kwargs)
5519
5520     m_pos =  property(GetPosition, SetPosition)
5521     m_rect = property(GetRect, SetRect)
5522
5523     Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
5524     Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`")
5525 _core_.MoveEvent_swigregister(MoveEvent)
5526
5527 #---------------------------------------------------------------------------
5528
5529 class PaintEvent(Event):
5530     """
5531     A paint event is sent when a window's contents needs to be repainted.
5532     Note that in an EVT_PAINT handler the application must *always* create
5533     a `wx.PaintDC` object, even if you do not use it.  Otherwise MS
5534     Windows assumes that the window has not been painted yet and will send
5535     the event again, causing endless refreshes.
5536
5537     You can optimize painting by retrieving the rectangles that have been
5538     damaged using `wx.Window.GetUpdateRegion` and/or `wx.RegionIterator`,
5539     and only repainting these rectangles. The rectangles are in terms of
5540     the client area, and are unscrolled, so you will need to do some
5541     calculations using the current view position to obtain logical,
5542     scrolled units.
5543
5544     """
5545     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5546     __repr__ = _swig_repr
5547     def __init__(self, *args, **kwargs):
5548         """__init__(self, int Id=0) -> PaintEvent"""
5549         _core_.PaintEvent_swiginit(self,_core_.new_PaintEvent(*args, **kwargs))
5550 _core_.PaintEvent_swigregister(PaintEvent)
5551
5552 class NcPaintEvent(Event):
5553     """Proxy of C++ NcPaintEvent class"""
5554     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5555     __repr__ = _swig_repr
5556     def __init__(self, *args, **kwargs):
5557         """__init__(self, int winid=0) -> NcPaintEvent"""
5558         _core_.NcPaintEvent_swiginit(self,_core_.new_NcPaintEvent(*args, **kwargs))
5559 _core_.NcPaintEvent_swigregister(NcPaintEvent)
5560
5561 #---------------------------------------------------------------------------
5562
5563 class EraseEvent(Event):
5564     """
5565     An erase event is sent whenever the background of a window needs to be
5566     repainted.  To intercept this event use the EVT_ERASE_BACKGROUND event
5567     binder.  On some platforms, such as GTK+, this event is simulated
5568     (simply generated just before the paint event) and may cause flicker.
5569
5570     To paint a custom background use the `GetDC` method and use the returned
5571     device context if it is not ``None``, otherwise create a temporary
5572     `wx.ClientDC` and draw on that.
5573
5574     """
5575     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5576     __repr__ = _swig_repr
5577     def __init__(self, *args, **kwargs):
5578         """
5579         __init__(self, int Id=0, DC dc=None) -> EraseEvent
5580
5581         Constructor
5582         """
5583         _core_.EraseEvent_swiginit(self,_core_.new_EraseEvent(*args, **kwargs))
5584     def GetDC(*args, **kwargs):
5585         """
5586         GetDC(self) -> DC
5587
5588         Returns the device context the event handler should draw upon.  If
5589         ``None`` is returned then create a temporary `wx.ClientDC` and use
5590         that instead.
5591         """
5592         return _core_.EraseEvent_GetDC(*args, **kwargs)
5593
5594     DC = property(GetDC,doc="See `GetDC`")
5595 _core_.EraseEvent_swigregister(EraseEvent)
5596
5597 #---------------------------------------------------------------------------
5598
5599 class FocusEvent(Event):
5600     """
5601     A focus event is sent when a window's focus changes. The window losing
5602     focus receives an EVT_KILL_FOCUS event while the window gaining it
5603     gets an EVT_SET_FOCUS event.
5604
5605     Notice that the set focus event happens both when the user gives focus
5606     to the window (whether using the mouse or keyboard) and when it is
5607     done from the program itself using `wx.Window.SetFocus`.
5608
5609     """
5610     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5611     __repr__ = _swig_repr
5612     def __init__(self, *args, **kwargs):
5613         """
5614         __init__(self, EventType type=wxEVT_NULL, int winid=0) -> FocusEvent
5615
5616         Constructor
5617         """
5618         _core_.FocusEvent_swiginit(self,_core_.new_FocusEvent(*args, **kwargs))
5619     def GetWindow(*args, **kwargs):
5620         """
5621         GetWindow(self) -> Window
5622
5623         Returns the other window associated with this event, that is the
5624         window which had the focus before for the EVT_SET_FOCUS event and the
5625         window which is going to receive focus for the wxEVT_KILL_FOCUS event.
5626
5627         Warning: the window returned may be None!
5628         """
5629         return _core_.FocusEvent_GetWindow(*args, **kwargs)
5630
5631     def SetWindow(*args, **kwargs):
5632         """SetWindow(self, Window win)"""
5633         return _core_.FocusEvent_SetWindow(*args, **kwargs)
5634
5635     Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`")
5636 _core_.FocusEvent_swigregister(FocusEvent)
5637
5638 #---------------------------------------------------------------------------
5639
5640 class ChildFocusEvent(CommandEvent):
5641     """
5642     A child focus event is sent to a (parent-)window when one of its child
5643     windows gains focus, so that the window could restore the focus back
5644     to its corresponding child if it loses it now and regains later.
5645
5646     Notice that child window is the direct child of the window receiving
5647     the event, and so may not be the actual widget recieving focus if it
5648     is further down the containment heirarchy.  Use `wx.Window.FindFocus`
5649     to get the widget that is actually receiving focus.
5650     """
5651     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5652     __repr__ = _swig_repr
5653     def __init__(self, *args, **kwargs):
5654         """
5655         __init__(self, Window win=None) -> ChildFocusEvent
5656
5657         Constructor
5658         """
5659         _core_.ChildFocusEvent_swiginit(self,_core_.new_ChildFocusEvent(*args, **kwargs))
5660     def GetWindow(*args, **kwargs):
5661         """
5662         GetWindow(self) -> Window
5663
5664         The window, or (grand)parent of the window which has just received the
5665         focus.
5666         """
5667         return _core_.ChildFocusEvent_GetWindow(*args, **kwargs)
5668
5669     Window = property(GetWindow,doc="See `GetWindow`")
5670 _core_.ChildFocusEvent_swigregister(ChildFocusEvent)
5671
5672 #---------------------------------------------------------------------------
5673
5674 class ActivateEvent(Event):
5675     """
5676     An activate event is sent when a top-level window or the entire
5677     application is being activated or deactivated.
5678
5679     A top-level window (a dialog or frame) receives an activate event when
5680     is being activated or deactivated. This is indicated visually by the
5681     title bar changing colour, and a subwindow gaining the keyboard focus.
5682     An application is activated or deactivated when one of its frames
5683     becomes activated, or a frame becomes inactivate resulting in all
5684     application frames being inactive.
5685
5686     Please note that usually you should call event.Skip() in your handlers
5687     for these events so the default handlers will still be called, as not
5688     doing so can result in strange effects.
5689
5690     """
5691     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5692     __repr__ = _swig_repr
5693     def __init__(self, *args, **kwargs):
5694         """
5695         __init__(self, EventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent
5696
5697         Constructor
5698         """
5699         _core_.ActivateEvent_swiginit(self,_core_.new_ActivateEvent(*args, **kwargs))
5700     def GetActive(*args, **kwargs):
5701         """
5702         GetActive(self) -> bool
5703
5704         Returns true if the application or window is being activated, false
5705         otherwise.
5706         """
5707         return _core_.ActivateEvent_GetActive(*args, **kwargs)
5708
5709     Active = property(GetActive,doc="See `GetActive`")
5710 _core_.ActivateEvent_swigregister(ActivateEvent)
5711
5712 #---------------------------------------------------------------------------
5713
5714 class InitDialogEvent(Event):
5715     """
5716     A wx.InitDialogEvent is sent as a dialog is being initialised, or for
5717     any window when `wx.Window.InitDialog` is called.  Handlers for this
5718     event can transfer data to the window, or anything else that should be
5719     done before the user begins editing the form. The default handler
5720     calls `wx.Window.TransferDataToWindow`.
5721     """
5722     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5723     __repr__ = _swig_repr
5724     def __init__(self, *args, **kwargs):
5725         """
5726         __init__(self, int Id=0) -> InitDialogEvent
5727
5728         Constructor
5729         """
5730         _core_.InitDialogEvent_swiginit(self,_core_.new_InitDialogEvent(*args, **kwargs))
5731 _core_.InitDialogEvent_swigregister(InitDialogEvent)
5732
5733 #---------------------------------------------------------------------------
5734
5735 class MenuEvent(Event):
5736     """
5737     This class is used for a variety of menu-related events.  Note that
5738     these do not include menu command events, which are handled by sending
5739     `wx.CommandEvent` objects.
5740
5741     The default handler for wx.EVT_MENU_HIGHLIGHT displays menu item help
5742     text in the first field of the status bar.
5743     """
5744     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5745     __repr__ = _swig_repr
5746     def __init__(self, *args, **kwargs):
5747         """
5748         __init__(self, EventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent
5749
5750         Constructor
5751         """
5752         _core_.MenuEvent_swiginit(self,_core_.new_MenuEvent(*args, **kwargs))
5753     def GetMenuId(*args, **kwargs):
5754         """
5755         GetMenuId(self) -> int
5756
5757         Returns the menu identifier associated with the event. This method
5758         should be only used with the HIGHLIGHT events.
5759         """
5760         return _core_.MenuEvent_GetMenuId(*args, **kwargs)
5761
5762     def IsPopup(*args, **kwargs):
5763         """
5764         IsPopup(self) -> bool
5765
5766         Returns ``True`` if the menu which is being opened or closed is a
5767         popup menu, ``False`` if it is a normal one.  This method should only
5768         be used with the OPEN and CLOSE events.
5769         """
5770         return _core_.MenuEvent_IsPopup(*args, **kwargs)
5771
5772     def GetMenu(*args, **kwargs):
5773         """
5774         GetMenu(self) -> Menu
5775
5776         Returns the menu which is being opened or closed. This method should
5777         only be used with the OPEN and CLOSE events.
5778         """
5779         return _core_.MenuEvent_GetMenu(*args, **kwargs)
5780
5781     Menu = property(GetMenu,doc="See `GetMenu`")
5782     MenuId = property(GetMenuId,doc="See `GetMenuId`")
5783 _core_.MenuEvent_swigregister(MenuEvent)
5784
5785 #---------------------------------------------------------------------------
5786
5787 class CloseEvent(Event):
5788     """
5789     This event class contains information about window and session close
5790     events.
5791
5792     The handler function for EVT_CLOSE is called when the user has tried
5793     to close a a frame or dialog box using the window manager controls or
5794     the system menu. It can also be invoked by the application itself
5795     programmatically, for example by calling the `wx.Window.Close`
5796     function.
5797
5798     You should check whether the application is forcing the deletion of
5799     the window using `CanVeto`. If it returns ``False``, you must destroy
5800     the window using `wx.Window.Destroy`. If the return value is ``True``,
5801     it is up to you whether you respond by destroying the window or not.
5802     For example you may wish to display a message dialog prompting to save
5803     files or to cancel the close.
5804
5805     If you don't destroy the window, you should call `Veto` to let the
5806     calling code know that you did not destroy the window. This allows the
5807     `wx.Window.Close` function to return ``True`` or ``False`` depending
5808     on whether the close instruction was honored or not.
5809     """
5810     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5811     __repr__ = _swig_repr
5812     def __init__(self, *args, **kwargs):
5813         """
5814         __init__(self, EventType type=wxEVT_NULL, int winid=0) -> CloseEvent
5815
5816         Constructor.
5817         """
5818         _core_.CloseEvent_swiginit(self,_core_.new_CloseEvent(*args, **kwargs))
5819     def SetLoggingOff(*args, **kwargs):
5820         """
5821         SetLoggingOff(self, bool logOff)
5822
5823         Sets the 'logging off' flag.
5824         """
5825         return _core_.CloseEvent_SetLoggingOff(*args, **kwargs)
5826
5827     def GetLoggingOff(*args, **kwargs):
5828         """
5829         GetLoggingOff(self) -> bool
5830
5831         Returns ``True`` if the user is logging off or ``False`` if the
5832         system is shutting down. This method can only be called for end
5833         session and query end session events, it doesn't make sense for close
5834         window event.
5835         """
5836         return _core_.CloseEvent_GetLoggingOff(*args, **kwargs)
5837
5838     def Veto(*args, **kwargs):
5839         """
5840         Veto(self, bool veto=True)
5841
5842         Call this from your event handler to veto a system shutdown or to
5843         signal to the calling application that a window close did not happen.
5844
5845         You can only veto a shutdown or close if `CanVeto` returns true.
5846         """
5847         return _core_.CloseEvent_Veto(*args, **kwargs)
5848
5849     def GetVeto(*args, **kwargs):
5850         """GetVeto(self) -> bool"""
5851         return _core_.CloseEvent_GetVeto(*args, **kwargs)
5852
5853     def SetCanVeto(*args, **kwargs):
5854         """
5855         SetCanVeto(self, bool canVeto)
5856
5857         Sets the 'can veto' flag.
5858         """
5859         return _core_.CloseEvent_SetCanVeto(*args, **kwargs)
5860
5861     def CanVeto(*args, **kwargs):
5862         """
5863         CanVeto(self) -> bool
5864
5865         Returns true if you can veto a system shutdown or a window close
5866         event. Vetoing a window close event is not possible if the calling
5867         code wishes to force the application to exit, and so this function
5868         must be called to check this.
5869         """
5870         return _core_.CloseEvent_CanVeto(*args, **kwargs)
5871
5872     LoggingOff = property(GetLoggingOff,SetLoggingOff,doc="See `GetLoggingOff` and `SetLoggingOff`")
5873 _core_.CloseEvent_swigregister(CloseEvent)
5874
5875 #---------------------------------------------------------------------------
5876
5877 class ShowEvent(Event):
5878     """An EVT_SHOW event is sent when a window is shown or hidden."""
5879     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5880     __repr__ = _swig_repr
5881     def __init__(self, *args, **kwargs):
5882         """
5883         __init__(self, int winid=0, bool show=False) -> ShowEvent
5884
5885         An EVT_SHOW event is sent when a window is shown or hidden.
5886         """
5887         _core_.ShowEvent_swiginit(self,_core_.new_ShowEvent(*args, **kwargs))
5888     def SetShow(*args, **kwargs):
5889         """SetShow(self, bool show)"""
5890         return _core_.ShowEvent_SetShow(*args, **kwargs)
5891
5892     def GetShow(*args, **kwargs):
5893         """GetShow(self) -> bool"""
5894         return _core_.ShowEvent_GetShow(*args, **kwargs)
5895
5896     Show = property(GetShow,SetShow,doc="See `GetShow` and `SetShow`")
5897 _core_.ShowEvent_swigregister(ShowEvent)
5898
5899 #---------------------------------------------------------------------------
5900
5901 class IconizeEvent(Event):
5902     """
5903     An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5904     restored.
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         """
5910         __init__(self, int id=0, bool iconized=True) -> IconizeEvent
5911
5912         An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5913         restored.
5914         """
5915         _core_.IconizeEvent_swiginit(self,_core_.new_IconizeEvent(*args, **kwargs))
5916     def Iconized(*args, **kwargs):
5917         """
5918         Iconized(self) -> bool
5919
5920         Returns ``True`` if the frame has been iconized, ``False`` if it has
5921         been restored.
5922         """
5923         return _core_.IconizeEvent_Iconized(*args, **kwargs)
5924
5925 _core_.IconizeEvent_swigregister(IconizeEvent)
5926
5927 #---------------------------------------------------------------------------
5928
5929 class MaximizeEvent(Event):
5930     """An EVT_MAXIMIZE event is sent when a frame is maximized or restored."""
5931     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5932     __repr__ = _swig_repr
5933     def __init__(self, *args, **kwargs):
5934         """
5935         __init__(self, int id=0) -> MaximizeEvent
5936
5937         An EVT_MAXIMIZE event is sent when a frame is maximized or restored.
5938         """
5939         _core_.MaximizeEvent_swiginit(self,_core_.new_MaximizeEvent(*args, **kwargs))
5940 _core_.MaximizeEvent_swigregister(MaximizeEvent)
5941
5942 #---------------------------------------------------------------------------
5943
5944 class DropFilesEvent(Event):
5945     """
5946     This class is used for drop files events, that is, when files have
5947     been dropped onto the window. This functionality is only available
5948     under Windows. The window must have previously been enabled for
5949     dropping by calling `wx.Window.DragAcceptFiles`.
5950
5951     Important note: this is a separate implementation to the more general
5952     drag and drop implementation using `wx.FileDropTarget`, and etc. This
5953     implementation uses the older, Windows message-based approach of
5954     dropping files.
5955
5956     Use wx.EVT_DROP_FILES to bind an event handler to receive file drop
5957     events.
5958
5959     """
5960     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5961     def __init__(self): raise AttributeError, "No constructor defined"
5962     __repr__ = _swig_repr
5963     def GetPosition(*args, **kwargs):
5964         """
5965         GetPosition(self) -> Point
5966
5967         Returns the position at which the files were dropped.
5968         """
5969         return _core_.DropFilesEvent_GetPosition(*args, **kwargs)
5970
5971     def GetNumberOfFiles(*args, **kwargs):
5972         """
5973         GetNumberOfFiles(self) -> int
5974
5975         Returns the number of files dropped.
5976         """
5977         return _core_.DropFilesEvent_GetNumberOfFiles(*args, **kwargs)
5978
5979     def GetFiles(*args, **kwargs):
5980         """
5981         GetFiles(self) -> PyObject
5982
5983         Returns a list of the filenames that were dropped.
5984         """
5985         return _core_.DropFilesEvent_GetFiles(*args, **kwargs)
5986
5987     Files = property(GetFiles,doc="See `GetFiles`")
5988     NumberOfFiles = property(GetNumberOfFiles,doc="See `GetNumberOfFiles`")
5989     Position = property(GetPosition,doc="See `GetPosition`")
5990 _core_.DropFilesEvent_swigregister(DropFilesEvent)
5991
5992 #---------------------------------------------------------------------------
5993
5994 UPDATE_UI_PROCESS_ALL = _core_.UPDATE_UI_PROCESS_ALL
5995 UPDATE_UI_PROCESS_SPECIFIED = _core_.UPDATE_UI_PROCESS_SPECIFIED
5996 class UpdateUIEvent(CommandEvent):
5997     """
5998     This class is used for EVT_UPDATE_UI pseudo-events which are sent by
5999     wxWidgets to give an application the chance to update various user
6000     interface elements.
6001
6002     Without update UI events, an application has to work hard to
6003     check/uncheck, enable/disable, and set the text for elements such as
6004     menu items and toolbar buttons. The code for doing this has to be
6005     mixed up with the code that is invoked when an action is invoked for a
6006     menu item or button.
6007
6008     With update UI events, you define an event handler to look at the
6009     state of the application and change UI elements accordingly. wxWidgets
6010     will call your handler functions in idle time, so you don't have to
6011     worry where to call this code. In addition to being a clearer and more
6012     declarative method, it also means you don't have to worry whether
6013     you're updating a toolbar or menubar identifier. The same handler can
6014     update a menu item and toolbar button, if the ID values are the same.
6015
6016     Instead of directly manipulating the menu or button, you call
6017     functions in the event object, such as `Check`. wxWidgets will
6018     determine whether such a call has been made, and which UI element to
6019     update.
6020
6021     These events will work for popup menus as well as menubars. Just
6022     before a menu is popped up, `wx.Menu.UpdateUI` is called to process
6023     any UI events for the window that owns the menu.
6024
6025     If you find that the overhead of UI update processing is affecting
6026     your application, you can do one or both of the following:
6027
6028        1. Call `wx.UpdateUIEvent.SetMode` with a value of
6029           wx.UPDATE_UI_PROCESS_SPECIFIED, and set the extra style
6030           wx.WS_EX_PROCESS_UPDATE_EVENTS for every window that should
6031           receive update events. No other windows will receive update
6032           events.
6033
6034        2. Call `wx.UpdateUIEvent.SetUpdateInterval` with a millisecond
6035           value to set the delay between updates. You may need to call
6036           `wx.Window.UpdateWindowUI` at critical points, for example when
6037           a dialog is about to be shown, in case the user sees a slight
6038           delay before windows are updated.
6039
6040     Note that although events are sent in idle time, defining a EVT_IDLE
6041     handler for a window does not affect this because the events are sent
6042     from an internal idle handler.
6043
6044     wxWidgets tries to optimize update events on some platforms. On
6045     Windows and GTK+, events for menubar items are only sent when the menu
6046     is about to be shown, and not in idle time.
6047
6048     """
6049     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6050     __repr__ = _swig_repr
6051     def __init__(self, *args, **kwargs):
6052         """
6053         __init__(self, int commandId=0) -> UpdateUIEvent
6054
6055         Constructor
6056         """
6057         _core_.UpdateUIEvent_swiginit(self,_core_.new_UpdateUIEvent(*args, **kwargs))
6058     def GetChecked(*args, **kwargs):
6059         """
6060         GetChecked(self) -> bool
6061
6062         Returns ``True`` if the UI element should be checked.
6063         """
6064         return _core_.UpdateUIEvent_GetChecked(*args, **kwargs)
6065
6066     def GetEnabled(*args, **kwargs):
6067         """
6068         GetEnabled(self) -> bool
6069
6070         Returns ``True`` if the UI element should be enabled.
6071         """
6072         return _core_.UpdateUIEvent_GetEnabled(*args, **kwargs)
6073
6074     def GetShown(*args, **kwargs):
6075         """
6076         GetShown(self) -> bool
6077
6078         Returns ``True`` if the UI element should be shown.
6079         """
6080         return _core_.UpdateUIEvent_GetShown(*args, **kwargs)
6081
6082     def GetText(*args, **kwargs):
6083         """
6084         GetText(self) -> String
6085
6086         Returns the text that should be set for the UI element.
6087         """
6088         return _core_.UpdateUIEvent_GetText(*args, **kwargs)
6089
6090     def GetSetText(*args, **kwargs):
6091         """
6092         GetSetText(self) -> bool
6093
6094         Returns ``True`` if the application has called `SetText`. For
6095         wxWidgets internal use only.
6096         """
6097         return _core_.UpdateUIEvent_GetSetText(*args, **kwargs)
6098
6099     def GetSetChecked(*args, **kwargs):
6100         """
6101         GetSetChecked(self) -> bool
6102
6103         Returns ``True`` if the application has called `Check`. For wxWidgets
6104         internal use only.
6105         """
6106         return _core_.UpdateUIEvent_GetSetChecked(*args, **kwargs)
6107
6108     def GetSetEnabled(*args, **kwargs):
6109         """
6110         GetSetEnabled(self) -> bool
6111
6112         Returns ``True`` if the application has called `Enable`. For wxWidgets
6113         internal use only.
6114         """
6115         return _core_.UpdateUIEvent_GetSetEnabled(*args, **kwargs)
6116
6117     def GetSetShown(*args, **kwargs):
6118         """
6119         GetSetShown(self) -> bool
6120
6121         Returns ``True`` if the application has called `Show`. For wxWidgets
6122         internal use only.
6123         """
6124         return _core_.UpdateUIEvent_GetSetShown(*args, **kwargs)
6125
6126     def Check(*args, **kwargs):
6127         """
6128         Check(self, bool check)
6129
6130         Check or uncheck the UI element.
6131         """
6132         return _core_.UpdateUIEvent_Check(*args, **kwargs)
6133
6134     def Enable(*args, **kwargs):
6135         """
6136         Enable(self, bool enable)
6137
6138         Enable or disable the UI element.
6139         """
6140         return _core_.UpdateUIEvent_Enable(*args, **kwargs)
6141
6142     def Show(*args, **kwargs):
6143         """
6144         Show(self, bool show)
6145
6146         Show or hide the UI element.
6147         """
6148         return _core_.UpdateUIEvent_Show(*args, **kwargs)
6149
6150     def SetText(*args, **kwargs):
6151         """
6152         SetText(self, String text)
6153
6154         Sets the text for this UI element.
6155         """
6156         return _core_.UpdateUIEvent_SetText(*args, **kwargs)
6157
6158     def SetUpdateInterval(*args, **kwargs):
6159         """
6160         SetUpdateInterval(long updateInterval)
6161
6162         Sets the interval between updates in milliseconds. Set to -1 to
6163         disable updates, or to 0 to update as frequently as possible. The
6164         default is 0.
6165
6166         Use this to reduce the overhead of UI update events if your
6167         application has a lot of windows. If you set the value to -1 or
6168         greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
6169         at appropriate points in your application, such as when a dialog is
6170         about to be shown.
6171         """
6172         return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
6173
6174     SetUpdateInterval = staticmethod(SetUpdateInterval)
6175     def GetUpdateInterval(*args, **kwargs):
6176         """
6177         GetUpdateInterval() -> long
6178
6179         Returns the current interval between updates in milliseconds. -1
6180         disables updates, 0 updates as frequently as possible.
6181         """
6182         return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs)
6183
6184     GetUpdateInterval = staticmethod(GetUpdateInterval)
6185     def CanUpdate(*args, **kwargs):
6186         """
6187         CanUpdate(Window win) -> bool
6188
6189         Returns ``True`` if it is appropriate to update (send UI update events
6190         to) this window.
6191
6192         This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
6193         the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
6194         events were last sent in idle time, and the update interval, to
6195         determine whether events should be sent to this window now. By default
6196         this will always return true because the update mode is initially
6197         wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
6198         events will be sent as often as possible. You can reduce the frequency
6199         that events are sent by changing the mode and/or setting an update
6200         interval.
6201
6202         """
6203         return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
6204
6205     CanUpdate = staticmethod(CanUpdate)
6206     def ResetUpdateTime(*args, **kwargs):
6207         """
6208         ResetUpdateTime()
6209
6210         Used internally to reset the last-updated time to the current time. It
6211         is assumed that update events are normally sent in idle time, so this
6212         is called at the end of idle processing.
6213         """
6214         return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs)
6215
6216     ResetUpdateTime = staticmethod(ResetUpdateTime)
6217     def SetMode(*args, **kwargs):
6218         """
6219         SetMode(int mode)
6220
6221         Specify how wxWidgets will send update events: to all windows, or only
6222         to those which specify that they will process the events.
6223
6224         The mode may be one of the following values:
6225
6226             =============================   ==========================================
6227             wxUPDATE_UI_PROCESS_ALL         Send UI update events to all windows.  This
6228                                             is the default setting.
6229             wxUPDATE_UI_PROCESS_SPECIFIED   Send UI update events only to windows that
6230                                             have the wx.WS_EX_PROCESS_UI_UPDATES extra
6231                                             style set.
6232             =============================   ==========================================
6233
6234         """
6235         return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
6236
6237     SetMode = staticmethod(SetMode)
6238     def GetMode(*args, **kwargs):
6239         """
6240         GetMode() -> int
6241
6242         Returns a value specifying how wxWidgets will send update events: to
6243         all windows, or only to those which specify that they will process the
6244         events.
6245         """
6246         return _core_.UpdateUIEvent_GetMode(*args, **kwargs)
6247
6248     GetMode = staticmethod(GetMode)
6249     Checked = property(GetChecked,Check,doc="See `GetChecked`")
6250     Enabled = property(GetEnabled,Enable,doc="See `GetEnabled`")
6251     Shown = property(GetShown,Show,doc="See `GetShown`")
6252     Text = property(GetText,SetText,doc="See `GetText` and `SetText`")
6253 _core_.UpdateUIEvent_swigregister(UpdateUIEvent)
6254
6255 def UpdateUIEvent_SetUpdateInterval(*args, **kwargs):
6256   """
6257     UpdateUIEvent_SetUpdateInterval(long updateInterval)
6258
6259     Sets the interval between updates in milliseconds. Set to -1 to
6260     disable updates, or to 0 to update as frequently as possible. The
6261     default is 0.
6262
6263     Use this to reduce the overhead of UI update events if your
6264     application has a lot of windows. If you set the value to -1 or
6265     greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
6266     at appropriate points in your application, such as when a dialog is
6267     about to be shown.
6268     """
6269   return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
6270
6271 def UpdateUIEvent_GetUpdateInterval(*args):
6272   """
6273     UpdateUIEvent_GetUpdateInterval() -> long
6274
6275     Returns the current interval between updates in milliseconds. -1
6276     disables updates, 0 updates as frequently as possible.
6277     """
6278   return _core_.UpdateUIEvent_GetUpdateInterval(*args)
6279
6280 def UpdateUIEvent_CanUpdate(*args, **kwargs):
6281   """
6282     UpdateUIEvent_CanUpdate(Window win) -> bool
6283
6284     Returns ``True`` if it is appropriate to update (send UI update events
6285     to) this window.
6286
6287     This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
6288     the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
6289     events were last sent in idle time, and the update interval, to
6290     determine whether events should be sent to this window now. By default
6291     this will always return true because the update mode is initially
6292     wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
6293     events will be sent as often as possible. You can reduce the frequency
6294     that events are sent by changing the mode and/or setting an update
6295     interval.
6296
6297     """
6298   return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
6299
6300 def UpdateUIEvent_ResetUpdateTime(*args):
6301   """
6302     UpdateUIEvent_ResetUpdateTime()
6303
6304     Used internally to reset the last-updated time to the current time. It
6305     is assumed that update events are normally sent in idle time, so this
6306     is called at the end of idle processing.
6307     """
6308   return _core_.UpdateUIEvent_ResetUpdateTime(*args)
6309
6310 def UpdateUIEvent_SetMode(*args, **kwargs):
6311   """
6312     UpdateUIEvent_SetMode(int mode)
6313
6314     Specify how wxWidgets will send update events: to all windows, or only
6315     to those which specify that they will process the events.
6316
6317     The mode may be one of the following values:
6318
6319         =============================   ==========================================
6320         wxUPDATE_UI_PROCESS_ALL         Send UI update events to all windows.  This
6321                                         is the default setting.
6322         wxUPDATE_UI_PROCESS_SPECIFIED   Send UI update events only to windows that
6323                                         have the wx.WS_EX_PROCESS_UI_UPDATES extra
6324                                         style set.
6325         =============================   ==========================================
6326
6327     """
6328   return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
6329
6330 def UpdateUIEvent_GetMode(*args):
6331   """
6332     UpdateUIEvent_GetMode() -> int
6333
6334     Returns a value specifying how wxWidgets will send update events: to
6335     all windows, or only to those which specify that they will process the
6336     events.
6337     """
6338   return _core_.UpdateUIEvent_GetMode(*args)
6339
6340 #---------------------------------------------------------------------------
6341
6342 class SysColourChangedEvent(Event):
6343     """
6344     This class is used for EVT_SYS_COLOUR_CHANGED, which are generated
6345     when the user changes the colour settings using the control
6346     panel. This is only applicable under Windows.
6347
6348     The default event handler for this event propagates the event to child
6349     windows, since Windows only sends the events to top-level windows. If
6350     intercepting this event for a top-level window, remember to call
6351     `Skip` so the the base class handler will still be executed, or to
6352     pass the event on to the window's children explicitly.
6353
6354     """
6355     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6356     __repr__ = _swig_repr
6357     def __init__(self, *args, **kwargs):
6358         """
6359         __init__(self) -> SysColourChangedEvent
6360
6361         Constructor
6362         """
6363         _core_.SysColourChangedEvent_swiginit(self,_core_.new_SysColourChangedEvent(*args, **kwargs))
6364 _core_.SysColourChangedEvent_swigregister(SysColourChangedEvent)
6365
6366 #---------------------------------------------------------------------------
6367
6368 class MouseCaptureChangedEvent(Event):
6369     """
6370     An mouse capture changed event (EVT_MOUSE_CAPTURE_CHANGED) is sent to
6371     a window that loses its mouse capture. This is called even if
6372     `wx.Window.ReleaseMouse` was called by the application code. Handling
6373     this event allows an application to cater for unexpected capture
6374     releases which might otherwise confuse mouse handling code.
6375
6376     This event is implemented under Windows only.
6377     """
6378     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6379     __repr__ = _swig_repr
6380     def __init__(self, *args, **kwargs):
6381         """
6382         __init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent
6383
6384         Constructor
6385         """
6386         _core_.MouseCaptureChangedEvent_swiginit(self,_core_.new_MouseCaptureChangedEvent(*args, **kwargs))
6387     def GetCapturedWindow(*args, **kwargs):
6388         """
6389         GetCapturedWindow(self) -> Window
6390
6391         Returns the window that gained the capture, or ``None`` if it was a
6392         non-wxWidgets window.
6393         """
6394         return _core_.MouseCaptureChangedEvent_GetCapturedWindow(*args, **kwargs)
6395
6396     CapturedWindow = property(GetCapturedWindow,doc="See `GetCapturedWindow`")
6397 _core_.MouseCaptureChangedEvent_swigregister(MouseCaptureChangedEvent)
6398
6399 #---------------------------------------------------------------------------
6400
6401 class MouseCaptureLostEvent(Event):
6402     """
6403     A mouse capture lost event is sent to a window that obtained mouse
6404     capture, which was subsequently loss due to "external" event, for
6405     example when a dialog box is shown or if another application captures
6406     the mouse.
6407
6408     If this happens, this event is sent to all windows that are on the
6409     capture stack (i.e. a window that called `wx.Window.CaptureMouse`, but
6410     didn't call `wx.Window.ReleaseMouse` yet). The event is *not* sent
6411     if the capture changes because of a call to CaptureMouse or
6412     ReleaseMouse.
6413
6414     This event is currently emitted under Windows only.
6415
6416     """
6417     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6418     __repr__ = _swig_repr
6419     def __init__(self, *args, **kwargs):
6420         """
6421         __init__(self, int winid=0) -> MouseCaptureLostEvent
6422
6423         A mouse capture lost event is sent to a window that obtained mouse
6424         capture, which was subsequently loss due to "external" event, for
6425         example when a dialog box is shown or if another application captures
6426         the mouse.
6427
6428         If this happens, this event is sent to all windows that are on the
6429         capture stack (i.e. a window that called `wx.Window.CaptureMouse`, but
6430         didn't call `wx.Window.ReleaseMouse` yet). The event is *not* sent
6431         if the capture changes because of a call to CaptureMouse or
6432         ReleaseMouse.
6433
6434         This event is currently emitted under Windows only.
6435
6436         """
6437         _core_.MouseCaptureLostEvent_swiginit(self,_core_.new_MouseCaptureLostEvent(*args, **kwargs))
6438 _core_.MouseCaptureLostEvent_swigregister(MouseCaptureLostEvent)
6439
6440 #---------------------------------------------------------------------------
6441
6442 class DisplayChangedEvent(Event):
6443     """
6444     An EVT_DISPLAY_CHANGED event is sent to all windows when the display
6445     resolution has changed.
6446
6447     This event is implemented under Windows only.
6448     """
6449     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6450     __repr__ = _swig_repr
6451     def __init__(self, *args, **kwargs):
6452         """__init__(self) -> DisplayChangedEvent"""
6453         _core_.DisplayChangedEvent_swiginit(self,_core_.new_DisplayChangedEvent(*args, **kwargs))
6454 _core_.DisplayChangedEvent_swigregister(DisplayChangedEvent)
6455
6456 #---------------------------------------------------------------------------
6457
6458 class PaletteChangedEvent(Event):
6459     """
6460     An EVT_PALETTE_CHANGED event is sent when the system palette has
6461     changed, thereby giving each window a chance to redo their own to
6462     match.
6463
6464     This event is implemented under Windows only.
6465     """
6466     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6467     __repr__ = _swig_repr
6468     def __init__(self, *args, **kwargs):
6469         """
6470         __init__(self, int id=0) -> PaletteChangedEvent
6471
6472         An EVT_PALETTE_CHANGED event is sent when the system palette has
6473         changed, thereby giving each window a chance to redo their own to
6474         match.
6475
6476         This event is implemented under Windows only.
6477         """
6478         _core_.PaletteChangedEvent_swiginit(self,_core_.new_PaletteChangedEvent(*args, **kwargs))
6479     def SetChangedWindow(*args, **kwargs):
6480         """SetChangedWindow(self, Window win)"""
6481         return _core_.PaletteChangedEvent_SetChangedWindow(*args, **kwargs)
6482
6483     def GetChangedWindow(*args, **kwargs):
6484         """GetChangedWindow(self) -> Window"""
6485         return _core_.PaletteChangedEvent_GetChangedWindow(*args, **kwargs)
6486
6487     ChangedWindow = property(GetChangedWindow,SetChangedWindow,doc="See `GetChangedWindow` and `SetChangedWindow`")
6488 _core_.PaletteChangedEvent_swigregister(PaletteChangedEvent)
6489
6490 #---------------------------------------------------------------------------
6491
6492 class QueryNewPaletteEvent(Event):
6493     """
6494     An EVT_QUERY_NEW_PALETE event indicates the window is getting keyboard
6495     focus and should re-do its palette.
6496
6497     This event is implemented under Windows only.
6498     """
6499     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6500     __repr__ = _swig_repr
6501     def __init__(self, *args, **kwargs):
6502         """
6503         __init__(self, int winid=0) -> QueryNewPaletteEvent
6504
6505         Constructor.
6506         """
6507         _core_.QueryNewPaletteEvent_swiginit(self,_core_.new_QueryNewPaletteEvent(*args, **kwargs))
6508     def SetPaletteRealized(*args, **kwargs):
6509         """
6510         SetPaletteRealized(self, bool realized)
6511
6512         App should set this if it changes the palette.
6513         """
6514         return _core_.QueryNewPaletteEvent_SetPaletteRealized(*args, **kwargs)
6515
6516     def GetPaletteRealized(*args, **kwargs):
6517         """GetPaletteRealized(self) -> bool"""
6518         return _core_.QueryNewPaletteEvent_GetPaletteRealized(*args, **kwargs)
6519
6520     PaletteRealized = property(GetPaletteRealized,SetPaletteRealized,doc="See `GetPaletteRealized` and `SetPaletteRealized`")
6521 _core_.QueryNewPaletteEvent_swigregister(QueryNewPaletteEvent)
6522
6523 #---------------------------------------------------------------------------
6524
6525 class NavigationKeyEvent(Event):
6526     """
6527     EVT_NAVIGATION_KEY events are used to control moving the focus between
6528     widgets, otherwise known as tab-traversal.  You woudl normally not
6529     catch navigation events in applications as there are already
6530     appropriate handlers in `wx.Dialog` and `wx.Panel`, but you may find
6531     it useful to send navigation events in certain situations to change
6532     the focus in certain ways, although it's probably easier to just call
6533     `wx.Window.Navigate`.
6534     """
6535     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6536     __repr__ = _swig_repr
6537     def __init__(self, *args, **kwargs):
6538         """__init__(self) -> NavigationKeyEvent"""
6539         _core_.NavigationKeyEvent_swiginit(self,_core_.new_NavigationKeyEvent(*args, **kwargs))
6540     def GetDirection(*args, **kwargs):
6541         """
6542         GetDirection(self) -> bool
6543
6544         Returns ``True`` if the direction is forward, ``False`` otherwise.
6545         """
6546         return _core_.NavigationKeyEvent_GetDirection(*args, **kwargs)
6547
6548     def SetDirection(*args, **kwargs):
6549         """
6550         SetDirection(self, bool forward)
6551
6552         Specify the direction that the navigation should take.  Usually the
6553         difference between using Tab and Shift-Tab.
6554         """
6555         return _core_.NavigationKeyEvent_SetDirection(*args, **kwargs)
6556
6557     def IsWindowChange(*args, **kwargs):
6558         """
6559         IsWindowChange(self) -> bool
6560
6561         Returns ``True`` if window change is allowed.
6562         """
6563         return _core_.NavigationKeyEvent_IsWindowChange(*args, **kwargs)
6564
6565     def SetWindowChange(*args, **kwargs):
6566         """
6567         SetWindowChange(self, bool ischange)
6568
6569         Specify if the navigation should be able to change parent windows.
6570         For example, changing notebook pages, etc. This is usually implemented
6571         by using Control-Tab.
6572         """
6573         return _core_.NavigationKeyEvent_SetWindowChange(*args, **kwargs)
6574
6575     def IsFromTab(*args, **kwargs):
6576         """
6577         IsFromTab(self) -> bool
6578
6579         Returns ``True`` if the navigation event is originated from the Tab
6580         key.
6581         """
6582         return _core_.NavigationKeyEvent_IsFromTab(*args, **kwargs)
6583
6584     def SetFromTab(*args, **kwargs):
6585         """
6586         SetFromTab(self, bool bIs)
6587
6588         Set to true under MSW if the event was generated using the tab key.
6589         This is required for proper navogation over radio buttons.
6590         """
6591         return _core_.NavigationKeyEvent_SetFromTab(*args, **kwargs)
6592
6593     def SetFlags(*args, **kwargs):
6594         """
6595         SetFlags(self, long flags)
6596
6597         Set the navigation flags to a combination of the following:
6598
6599             * wx.NavigationKeyEvent.IsBackward
6600             * wx.NavigationKeyEvent.IsForward
6601             * wx.NavigationKeyEvent.WinChange
6602             * wx.NavigationKeyEvent.FromTab
6603
6604         """
6605         return _core_.NavigationKeyEvent_SetFlags(*args, **kwargs)
6606
6607     def GetCurrentFocus(*args, **kwargs):
6608         """
6609         GetCurrentFocus(self) -> Window
6610
6611         Returns the child window which currenty has the focus.  May be
6612         ``None``.
6613         """
6614         return _core_.NavigationKeyEvent_GetCurrentFocus(*args, **kwargs)
6615
6616     def SetCurrentFocus(*args, **kwargs):
6617         """
6618         SetCurrentFocus(self, Window win)
6619
6620         Set the window that has the focus.
6621         """
6622         return _core_.NavigationKeyEvent_SetCurrentFocus(*args, **kwargs)
6623
6624     IsBackward = _core_.NavigationKeyEvent_IsBackward
6625     IsForward = _core_.NavigationKeyEvent_IsForward
6626     WinChange = _core_.NavigationKeyEvent_WinChange
6627     FromTab = _core_.NavigationKeyEvent_FromTab
6628     CurrentFocus = property(GetCurrentFocus,SetCurrentFocus,doc="See `GetCurrentFocus` and `SetCurrentFocus`")
6629     Direction = property(GetDirection,SetDirection,doc="See `GetDirection` and `SetDirection`")
6630 _core_.NavigationKeyEvent_swigregister(NavigationKeyEvent)
6631
6632 #---------------------------------------------------------------------------
6633
6634 class WindowCreateEvent(CommandEvent):
6635     """
6636     The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6637     underlying GUI object) exists.
6638     """
6639     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6640     __repr__ = _swig_repr
6641     def __init__(self, *args, **kwargs):
6642         """
6643         __init__(self, Window win=None) -> WindowCreateEvent
6644
6645         The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6646         underlying GUI object) exists.
6647         """
6648         _core_.WindowCreateEvent_swiginit(self,_core_.new_WindowCreateEvent(*args, **kwargs))
6649     def GetWindow(*args, **kwargs):
6650         """
6651         GetWindow(self) -> Window
6652
6653         Returns the window that this event refers to.
6654         """
6655         return _core_.WindowCreateEvent_GetWindow(*args, **kwargs)
6656
6657     Window = property(GetWindow,doc="See `GetWindow`")
6658 _core_.WindowCreateEvent_swigregister(WindowCreateEvent)
6659
6660 class WindowDestroyEvent(CommandEvent):
6661     """
6662     The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6663     when the GUI window is destroyed.
6664
6665     When a class derived from `wx.Window` is destroyed its destructor will
6666     have already run by the time this event is sent. Therefore this event
6667     will not usually be received at all by the window itself.  Since it is
6668     received after the destructor has run, an object should not try to
6669     handle its own wx.WindowDestroyEvent, but it can be used to get
6670     notification of the destruction of another window.
6671     """
6672     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6673     __repr__ = _swig_repr
6674     def __init__(self, *args, **kwargs):
6675         """
6676         __init__(self, Window win=None) -> WindowDestroyEvent
6677
6678         The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6679         when the GUI window is destroyed.
6680
6681         When a class derived from `wx.Window` is destroyed its destructor will
6682         have already run by the time this event is sent. Therefore this event
6683         will not usually be received at all by the window itself.  Since it is
6684         received after the destructor has run, an object should not try to
6685         handle its own wx.WindowDestroyEvent, but it can be used to get
6686         notification of the destruction of another window.
6687         """
6688         _core_.WindowDestroyEvent_swiginit(self,_core_.new_WindowDestroyEvent(*args, **kwargs))
6689     def GetWindow(*args, **kwargs):
6690         """
6691         GetWindow(self) -> Window
6692
6693         Returns the window that this event refers to.
6694         """
6695         return _core_.WindowDestroyEvent_GetWindow(*args, **kwargs)
6696
6697     Window = property(GetWindow,doc="See `GetWindow`")
6698 _core_.WindowDestroyEvent_swigregister(WindowDestroyEvent)
6699
6700 #---------------------------------------------------------------------------
6701
6702 class ContextMenuEvent(CommandEvent):
6703     """
6704     This class is used for context menu events (EVT_CONTECT_MENU,) sent to
6705     give the application a chance to show a context (popup) menu.
6706     """
6707     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6708     __repr__ = _swig_repr
6709     def __init__(self, *args, **kwargs):
6710         """
6711         __init__(self, EventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent
6712
6713         Constructor.
6714         """
6715         _core_.ContextMenuEvent_swiginit(self,_core_.new_ContextMenuEvent(*args, **kwargs))
6716     def GetPosition(*args, **kwargs):
6717         """
6718         GetPosition(self) -> Point
6719
6720         Returns the position (in screen coordinants) at which the menu should
6721         be shown.
6722         """
6723         return _core_.ContextMenuEvent_GetPosition(*args, **kwargs)
6724
6725     def SetPosition(*args, **kwargs):
6726         """
6727         SetPosition(self, Point pos)
6728
6729         Sets the position at which the menu should be shown.
6730         """
6731         return _core_.ContextMenuEvent_SetPosition(*args, **kwargs)
6732
6733     Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
6734 _core_.ContextMenuEvent_swigregister(ContextMenuEvent)
6735
6736 #---------------------------------------------------------------------------
6737
6738 IDLE_PROCESS_ALL = _core_.IDLE_PROCESS_ALL
6739 IDLE_PROCESS_SPECIFIED = _core_.IDLE_PROCESS_SPECIFIED
6740 class IdleEvent(Event):
6741     """
6742     This class is used for EVT_IDLE events, which are generated and sent
6743     when the application *becomes* idle.  In other words, the when the
6744     event queue becomes empty then idle events are sent to all windows (by
6745     default) and as long as none of them call `RequestMore` then there are
6746     no more idle events until after the system event queue has some normal
6747     events and then becomes empty again.
6748
6749     By default, idle events are sent to all windows. If this is causing a
6750     significant overhead in your application, you can call
6751     `wx.IdleEvent.SetMode` with the value wx.IDLE_PROCESS_SPECIFIED, and
6752     set the wx.WS_EX_PROCESS_IDLE extra window style for every window
6753     which should receive idle events.  Then idle events will only be sent
6754     to those windows and not to any others.
6755     """
6756     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6757     __repr__ = _swig_repr
6758     def __init__(self, *args, **kwargs):
6759         """
6760         __init__(self) -> IdleEvent
6761
6762         Constructor
6763         """
6764         _core_.IdleEvent_swiginit(self,_core_.new_IdleEvent(*args, **kwargs))
6765     def RequestMore(*args, **kwargs):
6766         """
6767         RequestMore(self, bool needMore=True)
6768
6769         Tells wxWidgets that more processing is required. This function can be
6770         called by an EVT_IDLE handler for a window to indicate that the
6771         application should forward the EVT_IDLE event once more to the
6772         application windows. If no window calls this function during its
6773         EVT_IDLE handler, then the application will remain in a passive event
6774         loop until a new event is posted to the application by the windowing
6775         system.
6776         """
6777         return _core_.IdleEvent_RequestMore(*args, **kwargs)
6778
6779     def MoreRequested(*args, **kwargs):
6780         """
6781         MoreRequested(self) -> bool
6782
6783         Returns ``True`` if the OnIdle function processing this event
6784         requested more processing time.
6785         """
6786         return _core_.IdleEvent_MoreRequested(*args, **kwargs)
6787
6788     def SetMode(*args, **kwargs):
6789         """
6790         SetMode(int mode)
6791
6792         Static method for specifying how wxWidgets will send idle events: to
6793         all windows, or only to those which specify that they will process the
6794         events.
6795
6796         The mode can be one of the following values:
6797
6798             =========================   ========================================
6799             wx.IDLE_PROCESS_ALL         Send idle events to all windows
6800             wx.IDLE_PROCESS_SPECIFIED   Send idle events only to windows that have
6801                                         the wx.WS_EX_PROCESS_IDLE extra style
6802                                         flag set.
6803             =========================   ========================================
6804
6805         """
6806         return _core_.IdleEvent_SetMode(*args, **kwargs)
6807
6808     SetMode = staticmethod(SetMode)
6809     def GetMode(*args, **kwargs):
6810         """
6811         GetMode() -> int
6812
6813         Static method returning a value specifying how wxWidgets will send
6814         idle events: to all windows, or only to those which specify that they
6815         will process the events.
6816         """
6817         return _core_.IdleEvent_GetMode(*args, **kwargs)
6818
6819     GetMode = staticmethod(GetMode)
6820     def CanSend(*args, **kwargs):
6821         """
6822         CanSend(Window win) -> bool
6823
6824         Returns ``True`` if it is appropriate to send idle events to this
6825         window.
6826
6827         This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6828         the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6829         events should be sent to this window now. By default this will always
6830         return ``True`` because the update mode is initially
6831         wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6832         to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6833         """
6834         return _core_.IdleEvent_CanSend(*args, **kwargs)
6835
6836     CanSend = staticmethod(CanSend)
6837 _core_.IdleEvent_swigregister(IdleEvent)
6838
6839 def IdleEvent_SetMode(*args, **kwargs):
6840   """
6841     IdleEvent_SetMode(int mode)
6842
6843     Static method for specifying how wxWidgets will send idle events: to
6844     all windows, or only to those which specify that they will process the
6845     events.
6846
6847     The mode can be one of the following values:
6848
6849         =========================   ========================================
6850         wx.IDLE_PROCESS_ALL         Send idle events to all windows
6851         wx.IDLE_PROCESS_SPECIFIED   Send idle events only to windows that have
6852                                     the wx.WS_EX_PROCESS_IDLE extra style
6853                                     flag set.
6854         =========================   ========================================
6855
6856     """
6857   return _core_.IdleEvent_SetMode(*args, **kwargs)
6858
6859 def IdleEvent_GetMode(*args):
6860   """
6861     IdleEvent_GetMode() -> int
6862
6863     Static method returning a value specifying how wxWidgets will send
6864     idle events: to all windows, or only to those which specify that they
6865     will process the events.
6866     """
6867   return _core_.IdleEvent_GetMode(*args)
6868
6869 def IdleEvent_CanSend(*args, **kwargs):
6870   """
6871     IdleEvent_CanSend(Window win) -> bool
6872
6873     Returns ``True`` if it is appropriate to send idle events to this
6874     window.
6875
6876     This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6877     the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6878     events should be sent to this window now. By default this will always
6879     return ``True`` because the update mode is initially
6880     wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6881     to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6882     """
6883   return _core_.IdleEvent_CanSend(*args, **kwargs)
6884
6885 #---------------------------------------------------------------------------
6886
6887 class ClipboardTextEvent(CommandEvent):
6888     """
6889     A Clipboard Text event is sent when a window intercepts a text
6890     copy/cut/paste message, i.e. the user has cut/copied/pasted data
6891     from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a
6892     popup menu command, etc.  NOTE : under windows these events are *NOT*
6893     generated automatically for a Rich Edit text control.
6894     """
6895     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6896     __repr__ = _swig_repr
6897     def __init__(self, *args, **kwargs):
6898         """
6899         __init__(self, EventType type=wxEVT_NULL, int winid=0) -> ClipboardTextEvent
6900
6901         A Clipboard Text event is sent when a window intercepts a text
6902         copy/cut/paste message, i.e. the user has cut/copied/pasted data
6903         from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a
6904         popup menu command, etc.  NOTE : under windows these events are *NOT*
6905         generated automatically for a Rich Edit text control.
6906         """
6907         _core_.ClipboardTextEvent_swiginit(self,_core_.new_ClipboardTextEvent(*args, **kwargs))
6908 _core_.ClipboardTextEvent_swigregister(ClipboardTextEvent)
6909
6910 #---------------------------------------------------------------------------
6911
6912 class PyEvent(Event):
6913     """
6914     wx.PyEvent can be used as a base class for implementing custom event
6915     types in Python.  You should derived from this class instead of
6916     `wx.Event` because this class is Python-aware and is able to transport
6917     its Python bits safely through the wxWidgets event system and have
6918     them still be there when the event handler is invoked.
6919
6920     :see: `wx.PyCommandEvent`
6921
6922     """
6923     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6924     __repr__ = _swig_repr
6925     def __init__(self, *args, **kwargs):
6926         """__init__(self, int winid=0, EventType eventType=wxEVT_NULL) -> PyEvent"""
6927         _core_.PyEvent_swiginit(self,_core_.new_PyEvent(*args, **kwargs))
6928         self._SetSelf(self)
6929
6930     __swig_destroy__ = _core_.delete_PyEvent
6931     __del__ = lambda self : None;
6932     def _SetSelf(*args, **kwargs):
6933         """_SetSelf(self, PyObject self)"""
6934         return _core_.PyEvent__SetSelf(*args, **kwargs)
6935
6936     def _GetSelf(*args, **kwargs):
6937         """_GetSelf(self) -> PyObject"""
6938         return _core_.PyEvent__GetSelf(*args, **kwargs)
6939
6940 _core_.PyEvent_swigregister(PyEvent)
6941
6942 class PyCommandEvent(CommandEvent):
6943     """
6944     wx.PyCommandEvent can be used as a base class for implementing custom
6945     event types in Python, where the event shoudl travel up to parent
6946     windows looking for a handler.  You should derived from this class
6947     instead of `wx.CommandEvent` because this class is Python-aware and is
6948     able to transport its Python bits safely through the wxWidgets event
6949     system and have them still be there when the event handler is invoked.
6950
6951     :see: `wx.PyEvent`
6952
6953     """
6954     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6955     __repr__ = _swig_repr
6956     def __init__(self, *args, **kwargs):
6957         """__init__(self, EventType eventType=wxEVT_NULL, int id=0) -> PyCommandEvent"""
6958         _core_.PyCommandEvent_swiginit(self,_core_.new_PyCommandEvent(*args, **kwargs))
6959         self._SetSelf(self)
6960
6961     __swig_destroy__ = _core_.delete_PyCommandEvent
6962     __del__ = lambda self : None;
6963     def _SetSelf(*args, **kwargs):
6964         """_SetSelf(self, PyObject self)"""
6965         return _core_.PyCommandEvent__SetSelf(*args, **kwargs)
6966
6967     def _GetSelf(*args, **kwargs):
6968         """_GetSelf(self) -> PyObject"""
6969         return _core_.PyCommandEvent__GetSelf(*args, **kwargs)
6970
6971 _core_.PyCommandEvent_swigregister(PyCommandEvent)
6972
6973 class DateEvent(CommandEvent):
6974     """
6975     This event class holds information about a date change event and is
6976     used together with `wx.DatePickerCtrl`. It also serves as a base class
6977     for `wx.calendar.CalendarEvent`.  Bind these event types with
6978     EVT_DATE_CHANGED.
6979     """
6980     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6981     __repr__ = _swig_repr
6982     def __init__(self, *args, **kwargs):
6983         """__init__(self, Window win, DateTime dt, EventType type) -> DateEvent"""
6984         _core_.DateEvent_swiginit(self,_core_.new_DateEvent(*args, **kwargs))
6985     def GetDate(*args, **kwargs):
6986         """
6987         GetDate(self) -> DateTime
6988
6989         Returns the date.
6990         """
6991         return _core_.DateEvent_GetDate(*args, **kwargs)
6992
6993     def SetDate(*args, **kwargs):
6994         """
6995         SetDate(self, DateTime date)
6996
6997         Sets the date carried by the event, normally only used by the library
6998         internally.
6999         """
7000         return _core_.DateEvent_SetDate(*args, **kwargs)
7001
7002     Date = property(GetDate,SetDate,doc="See `GetDate` and `SetDate`")
7003 _core_.DateEvent_swigregister(DateEvent)
7004
7005 wxEVT_DATE_CHANGED = _core_.wxEVT_DATE_CHANGED
7006 EVT_DATE_CHANGED = wx.PyEventBinder( wxEVT_DATE_CHANGED, 1 )
7007
7008 class EventBlocker(EvtHandler):
7009     """Helper class to temporarily disable event handling for a window."""
7010     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7011     __repr__ = _swig_repr
7012     def __init__(self, *args, **kwargs):
7013         """
7014         __init__(self, Window win, EventType type=wxEVT_ANY) -> EventBlocker
7015
7016         Helper class to temporarily disable event handling for a window.
7017         """
7018         _core_.EventBlocker_swiginit(self,_core_.new_EventBlocker(*args, **kwargs))
7019     __swig_destroy__ = _core_.delete_EventBlocker
7020     __del__ = lambda self : None;
7021     def Block(*args, **kwargs):
7022         """Block(self, EventType type)"""
7023         return _core_.EventBlocker_Block(*args, **kwargs)
7024
7025 _core_.EventBlocker_swigregister(EventBlocker)
7026
7027 #---------------------------------------------------------------------------
7028
7029 PYAPP_ASSERT_SUPPRESS = _core_.PYAPP_ASSERT_SUPPRESS
7030 PYAPP_ASSERT_EXCEPTION = _core_.PYAPP_ASSERT_EXCEPTION
7031 PYAPP_ASSERT_DIALOG = _core_.PYAPP_ASSERT_DIALOG
7032 PYAPP_ASSERT_LOG = _core_.PYAPP_ASSERT_LOG
7033 PRINT_WINDOWS = _core_.PRINT_WINDOWS
7034 PRINT_POSTSCRIPT = _core_.PRINT_POSTSCRIPT
7035 class PyApp(EvtHandler):
7036     """
7037     The ``wx.PyApp`` class is an *implementation detail*, please use the
7038     `wx.App` class (or some other derived class) instead.
7039     """
7040     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7041     __repr__ = _swig_repr
7042     def __init__(self, *args, **kwargs):
7043         """
7044         __init__(self) -> PyApp
7045
7046         Create a new application object, starting the bootstrap process.
7047         """
7048         _core_.PyApp_swiginit(self,_core_.new_PyApp(*args, **kwargs))
7049         self._setOORInfo(self, False);PyApp._setCallbackInfo(self, self, PyApp)
7050
7051     __swig_destroy__ = _core_.delete_PyApp
7052     __del__ = lambda self : None;
7053     def _setCallbackInfo(*args, **kwargs):
7054         """_setCallbackInfo(self, PyObject self, PyObject _class, bool incref=False)"""
7055         return _core_.PyApp__setCallbackInfo(*args, **kwargs)
7056
7057     def GetAppName(*args, **kwargs):
7058         """
7059         GetAppName(self) -> String
7060
7061         Get the application name.
7062         """
7063         return _core_.PyApp_GetAppName(*args, **kwargs)
7064
7065     def SetAppName(*args, **kwargs):
7066         """
7067         SetAppName(self, String name)
7068
7069         Set the application name. This value may be used automatically by
7070         `wx.Config` and such.
7071         """
7072         return _core_.PyApp_SetAppName(*args, **kwargs)
7073
7074     def GetClassName(*args, **kwargs):
7075         """
7076         GetClassName(self) -> String
7077
7078         Get the application's class name.
7079         """
7080         return _core_.PyApp_GetClassName(*args, **kwargs)
7081
7082     def SetClassName(*args, **kwargs):
7083         """
7084         SetClassName(self, String name)
7085
7086         Set the application's class name. This value may be used for
7087         X-resources if applicable for the platform
7088         """
7089         return _core_.PyApp_SetClassName(*args, **kwargs)
7090
7091     def GetVendorName(*args, **kwargs):
7092         """
7093         GetVendorName(self) -> String
7094
7095         Get the application's vendor name.
7096         """
7097         return _core_.PyApp_GetVendorName(*args, **kwargs)
7098
7099     def SetVendorName(*args, **kwargs):
7100         """
7101         SetVendorName(self, String name)
7102
7103         Set the application's vendor name. This value may be used
7104         automatically by `wx.Config` and such.
7105         """
7106         return _core_.PyApp_SetVendorName(*args, **kwargs)
7107
7108     def GetTraits(*args, **kwargs):
7109         """
7110         GetTraits(self) -> wxAppTraits
7111
7112         Return (and create if necessary) the app traits object to which we
7113         delegate for everything which either should be configurable by the
7114         user (then he can change the default behaviour simply by overriding
7115         CreateTraits() and returning his own traits object) or which is
7116         GUI/console dependent as then wx.AppTraits allows us to abstract the
7117         differences behind the common facade.
7118
7119         :todo: Add support for overriding CreateAppTraits in wxPython.
7120         """
7121         return _core_.PyApp_GetTraits(*args, **kwargs)
7122
7123     def ProcessPendingEvents(*args, **kwargs):
7124         """
7125         ProcessPendingEvents(self)
7126
7127         Process all events in the Pending Events list -- it is necessary to
7128         call this function to process posted events. This normally happens
7129         during each event loop iteration.
7130         """
7131         return _core_.PyApp_ProcessPendingEvents(*args, **kwargs)
7132
7133     def Yield(*args, **kwargs):
7134         """
7135         Yield(self, bool onlyIfNeeded=False) -> bool
7136
7137         Process all currently pending events right now, instead of waiting
7138         until return to the event loop.  It is an error to call ``Yield``
7139         recursively unless the value of ``onlyIfNeeded`` is True.
7140
7141         :warning: This function is dangerous as it can lead to unexpected
7142               reentrancies (i.e. when called from an event handler it may
7143               result in calling the same event handler again), use with
7144               extreme care or, better, don't use at all!
7145
7146         :see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield`
7147
7148         """
7149         return _core_.PyApp_Yield(*args, **kwargs)
7150
7151     def WakeUpIdle(*args, **kwargs):
7152         """
7153         WakeUpIdle(self)
7154
7155         Make sure that idle events are sent again.
7156         :see: `wx.WakeUpIdle`
7157         """
7158         return _core_.PyApp_WakeUpIdle(*args, **kwargs)
7159
7160     def IsMainLoopRunning(*args, **kwargs):
7161         """
7162         IsMainLoopRunning() -> bool
7163
7164         Returns True if we're running the main loop, i.e. if the events can
7165         currently be dispatched.
7166         """
7167         return _core_.PyApp_IsMainLoopRunning(*args, **kwargs)
7168
7169     IsMainLoopRunning = staticmethod(IsMainLoopRunning)
7170     def MainLoop(*args, **kwargs):
7171         """
7172         MainLoop(self) -> int
7173
7174         Execute the main GUI loop, the function doesn't normally return until
7175         all top level windows have been closed and destroyed.
7176         """
7177         return _core_.PyApp_MainLoop(*args, **kwargs)
7178
7179     def Exit(*args, **kwargs):
7180         """
7181         Exit(self)
7182
7183         Exit the main loop thus terminating the application.
7184         :see: `wx.Exit`
7185         """
7186         return _core_.PyApp_Exit(*args, **kwargs)
7187
7188     def GetLayoutDirection(*args, **kwargs):
7189         """
7190         GetLayoutDirection(self) -> int
7191
7192         Return the layout direction for the current locale.
7193         """
7194         return _core_.PyApp_GetLayoutDirection(*args, **kwargs)
7195
7196     def ExitMainLoop(*args, **kwargs):
7197         """
7198         ExitMainLoop(self)
7199
7200         Exit the main GUI loop during the next iteration of the main
7201         loop, (i.e. it does not stop the program immediately!)
7202         """
7203         return _core_.PyApp_ExitMainLoop(*args, **kwargs)
7204
7205     def Pending(*args, **kwargs):
7206         """
7207         Pending(self) -> bool
7208
7209         Returns True if there are unprocessed events in the event queue.
7210         """
7211         return _core_.PyApp_Pending(*args, **kwargs)
7212
7213     def Dispatch(*args, **kwargs):
7214         """
7215         Dispatch(self) -> bool
7216
7217         Process the first event in the event queue (blocks until an event
7218         appears if there are none currently)
7219         """
7220         return _core_.PyApp_Dispatch(*args, **kwargs)
7221
7222     def ProcessIdle(*args, **kwargs):
7223         """
7224         ProcessIdle(self) -> bool
7225
7226         Called from the MainLoop when the application becomes idle (there are
7227         no pending events) and sends a `wx.IdleEvent` to all interested
7228         parties.  Returns True if more idle events are needed, False if not.
7229         """
7230         return _core_.PyApp_ProcessIdle(*args, **kwargs)
7231
7232     def SendIdleEvents(*args, **kwargs):
7233         """
7234         SendIdleEvents(self, Window win, IdleEvent event) -> bool
7235
7236         Send idle event to window and all subwindows.  Returns True if more
7237         idle time is requested.
7238         """
7239         return _core_.PyApp_SendIdleEvents(*args, **kwargs)
7240
7241     def IsActive(*args, **kwargs):
7242         """
7243         IsActive(self) -> bool
7244
7245         Return True if our app has focus.
7246         """
7247         return _core_.PyApp_IsActive(*args, **kwargs)
7248
7249     def SetTopWindow(*args, **kwargs):
7250         """
7251         SetTopWindow(self, Window win)
7252
7253         Set the *main* top level window
7254         """
7255         return _core_.PyApp_SetTopWindow(*args, **kwargs)
7256
7257     def GetTopWindow(*args, **kwargs):
7258         """
7259         GetTopWindow(self) -> Window
7260
7261         Return the *main* top level window (if it hadn't been set previously
7262         with SetTopWindow(), will return just some top level window and, if
7263         there not any, will return None)
7264         """
7265         return _core_.PyApp_GetTopWindow(*args, **kwargs)
7266
7267     def SetExitOnFrameDelete(*args, **kwargs):
7268         """
7269         SetExitOnFrameDelete(self, bool flag)
7270
7271         Control the exit behaviour: by default, the program will exit the main
7272         loop (and so, usually, terminate) when the last top-level program
7273         window is deleted.  Beware that if you disable this behaviour (with
7274         SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop()
7275         explicitly from somewhere.
7276         """
7277         return _core_.PyApp_SetExitOnFrameDelete(*args, **kwargs)
7278
7279     def GetExitOnFrameDelete(*args, **kwargs):
7280         """
7281         GetExitOnFrameDelete(self) -> bool
7282
7283         Get the current exit behaviour setting.
7284         """
7285         return _core_.PyApp_GetExitOnFrameDelete(*args, **kwargs)
7286
7287     def SetUseBestVisual(*args, **kwargs):
7288         """
7289         SetUseBestVisual(self, bool flag, bool forceTrueColour=False)
7290
7291         Set whether the app should try to use the best available visual on
7292         systems where more than one is available, (Sun, SGI, XFree86 4, etc.)
7293         """
7294         return _core_.PyApp_SetUseBestVisual(*args, **kwargs)
7295
7296     def GetUseBestVisual(*args, **kwargs):
7297         """
7298         GetUseBestVisual(self) -> bool
7299
7300         Get current UseBestVisual setting.
7301         """
7302         return _core_.PyApp_GetUseBestVisual(*args, **kwargs)
7303
7304     def SetPrintMode(*args, **kwargs):
7305         """SetPrintMode(self, int mode)"""
7306         return _core_.PyApp_SetPrintMode(*args, **kwargs)
7307
7308     def GetPrintMode(*args, **kwargs):
7309         """GetPrintMode(self) -> int"""
7310         return _core_.PyApp_GetPrintMode(*args, **kwargs)
7311
7312     def SetAssertMode(*args, **kwargs):
7313         """
7314         SetAssertMode(self, int mode)
7315
7316         Set the OnAssert behaviour for debug and hybrid builds.
7317         """
7318         return _core_.PyApp_SetAssertMode(*args, **kwargs)
7319
7320     def GetAssertMode(*args, **kwargs):
7321         """
7322         GetAssertMode(self) -> int
7323
7324         Get the current OnAssert behaviour setting.
7325         """
7326         return _core_.PyApp_GetAssertMode(*args, **kwargs)
7327
7328     def GetMacSupportPCMenuShortcuts(*args, **kwargs):
7329         """GetMacSupportPCMenuShortcuts() -> bool"""
7330         return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs)
7331
7332     GetMacSupportPCMenuShortcuts = staticmethod(GetMacSupportPCMenuShortcuts)
7333     def GetMacAboutMenuItemId(*args, **kwargs):
7334         """GetMacAboutMenuItemId() -> long"""
7335         return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs)
7336
7337     GetMacAboutMenuItemId = staticmethod(GetMacAboutMenuItemId)
7338     def GetMacPreferencesMenuItemId(*args, **kwargs):
7339         """GetMacPreferencesMenuItemId() -> long"""
7340         return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs)
7341
7342     GetMacPreferencesMenuItemId = staticmethod(GetMacPreferencesMenuItemId)
7343     def GetMacExitMenuItemId(*args, **kwargs):
7344         """GetMacExitMenuItemId() -> long"""
7345         return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs)
7346
7347     GetMacExitMenuItemId = staticmethod(GetMacExitMenuItemId)
7348     def GetMacHelpMenuTitleName(*args, **kwargs):
7349         """GetMacHelpMenuTitleName() -> String"""
7350         return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs)
7351
7352     GetMacHelpMenuTitleName = staticmethod(GetMacHelpMenuTitleName)
7353     def SetMacSupportPCMenuShortcuts(*args, **kwargs):
7354         """SetMacSupportPCMenuShortcuts(bool val)"""
7355         return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
7356
7357     SetMacSupportPCMenuShortcuts = staticmethod(SetMacSupportPCMenuShortcuts)
7358     def SetMacAboutMenuItemId(*args, **kwargs):
7359         """SetMacAboutMenuItemId(long val)"""
7360         return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
7361
7362     SetMacAboutMenuItemId = staticmethod(SetMacAboutMenuItemId)
7363     def SetMacPreferencesMenuItemId(*args, **kwargs):
7364         """SetMacPreferencesMenuItemId(long val)"""
7365         return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
7366
7367     SetMacPreferencesMenuItemId = staticmethod(SetMacPreferencesMenuItemId)
7368     def SetMacExitMenuItemId(*args, **kwargs):
7369         """SetMacExitMenuItemId(long val)"""
7370         return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
7371
7372     SetMacExitMenuItemId = staticmethod(SetMacExitMenuItemId)
7373     def SetMacHelpMenuTitleName(*args, **kwargs):
7374         """SetMacHelpMenuTitleName(String val)"""
7375         return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
7376
7377     SetMacHelpMenuTitleName = staticmethod(SetMacHelpMenuTitleName)
7378     def _BootstrapApp(*args, **kwargs):
7379         """
7380         _BootstrapApp(self)
7381
7382         For internal use only
7383         """
7384         return _core_.PyApp__BootstrapApp(*args, **kwargs)
7385
7386     def GetComCtl32Version(*args, **kwargs):
7387         """
7388         GetComCtl32Version() -> int
7389
7390         Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
7391         it wasn't found at all.  Raises an exception on non-Windows platforms.
7392         """
7393         return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
7394
7395     GetComCtl32Version = staticmethod(GetComCtl32Version)
7396     def IsDisplayAvailable(*args, **kwargs):
7397         """
7398         IsDisplayAvailable() -> bool
7399
7400         Tests if it is possible to create a GUI in the current environment.
7401         This will mean different things on the different platforms.
7402
7403            * On X Windows systems this function will return ``False`` if it is
7404              not able to open a connection to the X display, which can happen
7405              if $DISPLAY is not set, or is not set correctly.
7406
7407            * On Mac OS X a ``False`` return value will mean that wx is not
7408              able to access the window manager, which can happen if logged in
7409              remotely or if running from the normal version of python instead
7410              of the framework version, (i.e., pythonw.)
7411
7412            * On MS Windows...
7413
7414         """
7415         return _core_.PyApp_IsDisplayAvailable(*args, **kwargs)
7416
7417     IsDisplayAvailable = staticmethod(IsDisplayAvailable)
7418     AppName = property(GetAppName,SetAppName,doc="See `GetAppName` and `SetAppName`")
7419     AssertMode = property(GetAssertMode,SetAssertMode,doc="See `GetAssertMode` and `SetAssertMode`")
7420     ClassName = property(GetClassName,SetClassName,doc="See `GetClassName` and `SetClassName`")
7421     ExitOnFrameDelete = property(GetExitOnFrameDelete,SetExitOnFrameDelete,doc="See `GetExitOnFrameDelete` and `SetExitOnFrameDelete`")
7422     LayoutDirection = property(GetLayoutDirection,doc="See `GetLayoutDirection`")
7423     PrintMode = property(GetPrintMode,SetPrintMode,doc="See `GetPrintMode` and `SetPrintMode`")
7424     TopWindow = property(GetTopWindow,SetTopWindow,doc="See `GetTopWindow` and `SetTopWindow`")
7425     Traits = property(GetTraits,doc="See `GetTraits`")
7426     UseBestVisual = property(GetUseBestVisual,SetUseBestVisual,doc="See `GetUseBestVisual` and `SetUseBestVisual`")
7427     VendorName = property(GetVendorName,SetVendorName,doc="See `GetVendorName` and `SetVendorName`")
7428     Active = property(IsActive)
7429 _core_.PyApp_swigregister(PyApp)
7430
7431 def PyApp_IsMainLoopRunning(*args):
7432   """
7433     PyApp_IsMainLoopRunning() -> bool
7434
7435     Returns True if we're running the main loop, i.e. if the events can
7436     currently be dispatched.
7437     """
7438   return _core_.PyApp_IsMainLoopRunning(*args)
7439
7440 def PyApp_GetMacSupportPCMenuShortcuts(*args):
7441   """PyApp_GetMacSupportPCMenuShortcuts() -> bool"""
7442   return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args)
7443
7444 def PyApp_GetMacAboutMenuItemId(*args):
7445   """PyApp_GetMacAboutMenuItemId() -> long"""
7446   return _core_.PyApp_GetMacAboutMenuItemId(*args)
7447
7448 def PyApp_GetMacPreferencesMenuItemId(*args):
7449   """PyApp_GetMacPreferencesMenuItemId() -> long"""
7450   return _core_.PyApp_GetMacPreferencesMenuItemId(*args)
7451
7452 def PyApp_GetMacExitMenuItemId(*args):
7453   """PyApp_GetMacExitMenuItemId() -> long"""
7454   return _core_.PyApp_GetMacExitMenuItemId(*args)
7455
7456 def PyApp_GetMacHelpMenuTitleName(*args):
7457   """PyApp_GetMacHelpMenuTitleName() -> String"""
7458   return _core_.PyApp_GetMacHelpMenuTitleName(*args)
7459
7460 def PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs):
7461   """PyApp_SetMacSupportPCMenuShortcuts(bool val)"""
7462   return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
7463
7464 def PyApp_SetMacAboutMenuItemId(*args, **kwargs):
7465   """PyApp_SetMacAboutMenuItemId(long val)"""
7466   return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
7467
7468 def PyApp_SetMacPreferencesMenuItemId(*args, **kwargs):
7469   """PyApp_SetMacPreferencesMenuItemId(long val)"""
7470   return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
7471
7472 def PyApp_SetMacExitMenuItemId(*args, **kwargs):
7473   """PyApp_SetMacExitMenuItemId(long val)"""
7474   return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
7475
7476 def PyApp_SetMacHelpMenuTitleName(*args, **kwargs):
7477   """PyApp_SetMacHelpMenuTitleName(String val)"""
7478   return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
7479
7480 def PyApp_GetComCtl32Version(*args):
7481   """
7482     PyApp_GetComCtl32Version() -> int
7483
7484     Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
7485     it wasn't found at all.  Raises an exception on non-Windows platforms.
7486     """
7487   return _core_.PyApp_GetComCtl32Version(*args)
7488
7489 def PyApp_IsDisplayAvailable(*args):
7490   """
7491     PyApp_IsDisplayAvailable() -> bool
7492
7493     Tests if it is possible to create a GUI in the current environment.
7494     This will mean different things on the different platforms.
7495
7496        * On X Windows systems this function will return ``False`` if it is
7497          not able to open a connection to the X display, which can happen
7498          if $DISPLAY is not set, or is not set correctly.
7499
7500        * On Mac OS X a ``False`` return value will mean that wx is not
7501          able to access the window manager, which can happen if logged in
7502          remotely or if running from the normal version of python instead
7503          of the framework version, (i.e., pythonw.)
7504
7505        * On MS Windows...
7506
7507     """
7508   return _core_.PyApp_IsDisplayAvailable(*args)
7509
7510 #---------------------------------------------------------------------------
7511
7512
7513 def Exit(*args):
7514   """
7515     Exit()
7516
7517     Force an exit of the application.  Convenience for wx.GetApp().Exit()
7518     """
7519   return _core_.Exit(*args)
7520
7521 def Yield(*args):
7522   """
7523     Yield() -> bool
7524
7525     Yield to other apps/messages.  Convenience for wx.GetApp().Yield()
7526     """
7527   return _core_.Yield(*args)
7528
7529 def YieldIfNeeded(*args):
7530   """
7531     YieldIfNeeded() -> bool
7532
7533     Yield to other apps/messages.  Convenience for wx.GetApp().Yield(True)
7534     """
7535   return _core_.YieldIfNeeded(*args)
7536
7537 def SafeYield(*args, **kwargs):
7538   """
7539     SafeYield(Window win=None, bool onlyIfNeeded=False) -> bool
7540
7541     This function is similar to `wx.Yield`, except that it disables the
7542     user input to all program windows before calling `wx.Yield` and
7543     re-enables it again afterwards. If ``win`` is not None, this window
7544     will remain enabled, allowing the implementation of some limited user
7545     interaction.
7546
7547     :Returns: the result of the call to `wx.Yield`.
7548     """
7549   return _core_.SafeYield(*args, **kwargs)
7550
7551 def WakeUpIdle(*args):
7552   """
7553     WakeUpIdle()
7554
7555     Cause the message queue to become empty again, so idle events will be
7556     sent.
7557     """
7558   return _core_.WakeUpIdle(*args)
7559
7560 def PostEvent(*args, **kwargs):
7561   """
7562     PostEvent(EvtHandler dest, Event event)
7563
7564     Send an event to a window or other wx.EvtHandler to be processed
7565     later.
7566     """
7567   return _core_.PostEvent(*args, **kwargs)
7568
7569 def App_CleanUp(*args):
7570   """
7571     App_CleanUp()
7572
7573     For internal use only, it is used to cleanup after wxWidgets when
7574     Python shuts down.
7575     """
7576   return _core_.App_CleanUp(*args)
7577
7578 def GetApp(*args):
7579   """
7580     GetApp() -> PyApp
7581
7582     Return a reference to the current wx.App object.
7583     """
7584   return _core_.GetApp(*args)
7585
7586 def SetDefaultPyEncoding(*args, **kwargs):
7587   """
7588     SetDefaultPyEncoding(string encoding)
7589
7590     Sets the encoding that wxPython will use when it needs to convert a
7591     Python string or unicode object to or from a wxString.
7592
7593     The default encoding is the value of ``locale.getdefaultlocale()[1]``
7594     but please be aware that the default encoding within the same locale
7595     may be slightly different on different platforms.  For example, please
7596     see http://www.alanwood.net/demos/charsetdiffs.html for differences
7597     between the common latin/roman encodings.
7598     """
7599   return _core_.SetDefaultPyEncoding(*args, **kwargs)
7600
7601 def GetDefaultPyEncoding(*args):
7602   """
7603     GetDefaultPyEncoding() -> string
7604
7605     Gets the current encoding that wxPython will use when it needs to
7606     convert a Python string or unicode object to or from a wxString.
7607     """
7608   return _core_.GetDefaultPyEncoding(*args)
7609 #----------------------------------------------------------------------
7610
7611 class PyOnDemandOutputWindow:
7612     """
7613     A class that can be used for redirecting Python's stdout and
7614     stderr streams.  It will do nothing until something is wrriten to
7615     the stream at which point it will create a Frame with a text area
7616     and write the text there.
7617     """
7618     def __init__(self, title = "wxPython: stdout/stderr"):
7619         self.frame  = None
7620         self.title  = title
7621         self.pos    = wx.DefaultPosition
7622         self.size   = (450, 300)
7623         self.parent = None
7624
7625     def SetParent(self, parent):
7626         """Set the window to be used as the popup Frame's parent."""
7627         self.parent = parent
7628
7629
7630     def CreateOutputWindow(self, st):
7631         self.frame = wx.Frame(self.parent, -1, self.title, self.pos, self.size,
7632                               style=wx.DEFAULT_FRAME_STYLE)
7633         self.text  = wx.TextCtrl(self.frame, -1, "",
7634                                  style=wx.TE_MULTILINE|wx.TE_READONLY)
7635         self.text.AppendText(st)
7636         self.frame.Show(True)
7637         self.frame.Bind(wx.EVT_CLOSE, self.OnCloseWindow)
7638
7639
7640     def OnCloseWindow(self, event):
7641         if self.frame is not None:
7642             self.frame.Destroy()
7643         self.frame = None
7644         self.text  = None
7645
7646
7647     # These methods provide the file-like output behaviour.
7648     def write(self, text):
7649         """
7650         Create the output window if needed and write the string to it.
7651         If not called in the context of the gui thread then uses
7652         CallAfter to do the work there.
7653         """
7654         if self.frame is None:
7655             if not wx.Thread_IsMain():
7656                 wx.CallAfter(self.CreateOutputWindow, text)
7657             else:
7658                 self.CreateOutputWindow(text)
7659         else:
7660             if not wx.Thread_IsMain():
7661                 wx.CallAfter(self.text.AppendText, text)
7662             else:
7663                 self.text.AppendText(text)
7664
7665
7666     def close(self):
7667         if self.frame is not None:
7668             wx.CallAfter(self.frame.Close)
7669
7670
7671     def flush(self):
7672         pass
7673
7674
7675
7676 #----------------------------------------------------------------------
7677
7678 _defRedirect = (wx.Platform == '__WXMSW__' or wx.Platform == '__WXMAC__')
7679
7680 class App(wx.PyApp):
7681     """
7682     The ``wx.App`` class represents the application and is used to:
7683
7684       * bootstrap the wxPython system and initialize the underlying
7685         gui toolkit
7686       * set and get application-wide properties
7687       * implement the windowing system main message or event loop,
7688         and to dispatch events to window instances
7689       * etc.
7690
7691     Every application must have a ``wx.App`` instance, and all
7692     creation of UI objects should be delayed until after the
7693     ``wx.App`` object has been created in order to ensure that the gui
7694     platform and wxWidgets have been fully initialized.
7695
7696     Normally you would derive from this class and implement an
7697     ``OnInit`` method that creates a frame and then calls
7698     ``self.SetTopWindow(frame)``.
7699
7700     :see: `wx.PySimpleApp` for a simpler app class that can be used
7701            directly.
7702     """
7703
7704     outputWindowClass = PyOnDemandOutputWindow
7705
7706     def __init__(self, redirect=_defRedirect, filename=None,
7707                  useBestVisual=False, clearSigInt=True):
7708         """
7709         Construct a ``wx.App`` object.
7710
7711         :param redirect: Should ``sys.stdout`` and ``sys.stderr`` be
7712             redirected?  Defaults to True on Windows and Mac, False
7713             otherwise.  If `filename` is None then output will be
7714             redirected to a window that pops up as needed.  (You can
7715             control what kind of window is created for the output by
7716             resetting the class variable ``outputWindowClass`` to a
7717             class of your choosing.)
7718
7719         :param filename: The name of a file to redirect output to, if
7720             redirect is True.
7721
7722         :param useBestVisual: Should the app try to use the best
7723             available visual provided by the system (only relevant on
7724             systems that have more than one visual.)  This parameter
7725             must be used instead of calling `SetUseBestVisual` later
7726             on because it must be set before the underlying GUI
7727             toolkit is initialized.
7728
7729         :param clearSigInt: Should SIGINT be cleared?  This allows the
7730             app to terminate upon a Ctrl-C in the console like other
7731             GUI apps will.
7732
7733         :note: You should override OnInit to do applicaition
7734             initialization to ensure that the system, toolkit and
7735             wxWidgets are fully initialized.
7736         """
7737
7738         wx.PyApp.__init__(self)
7739
7740         # make sure we can create a GUI
7741         if not self.IsDisplayAvailable():
7742
7743             if wx.Platform == "__WXMAC__":
7744                 msg = """This program needs access to the screen.
7745 Please run with 'pythonw', not 'python', and only when you are logged
7746 in on the main display of your Mac."""
7747
7748             elif wx.Platform == "__WXGTK__":
7749                 msg ="Unable to access the X Display, is $DISPLAY set properly?"
7750
7751             else:
7752                 msg = "Unable to create GUI"
7753                 # TODO: more description is needed for wxMSW...
7754
7755             raise SystemExit(msg)
7756
7757         # This has to be done before OnInit
7758         self.SetUseBestVisual(useBestVisual)
7759
7760         # Set the default handler for SIGINT.  This fixes a problem
7761         # where if Ctrl-C is pressed in the console that started this
7762         # app then it will not appear to do anything, (not even send
7763         # KeyboardInterrupt???)  but will later segfault on exit.  By
7764         # setting the default handler then the app will exit, as
7765         # expected (depending on platform.)
7766         if clearSigInt:
7767             try:
7768                 import signal
7769                 signal.signal(signal.SIGINT, signal.SIG_DFL)
7770             except:
7771                 pass
7772
7773         # Save and redirect the stdio to a window?
7774         self.stdioWin = None
7775         self.saveStdio = (_sys.stdout, _sys.stderr)
7776         if redirect:
7777             self.RedirectStdio(filename)
7778
7779         # Use Python's install prefix as the default
7780         wx.StandardPaths.Get().SetInstallPrefix(_sys.prefix)
7781
7782         # Until the new native control for wxMac is up to par, still use the generic one.
7783         wx.SystemOptions.SetOptionInt("mac.listctrl.always_use_generic", 1)
7784
7785         # This finishes the initialization of wxWindows and then calls
7786         # the OnInit that should be present in the derived class
7787         self._BootstrapApp()
7788
7789
7790     def OnPreInit(self):
7791         """
7792         Things that must be done after _BootstrapApp has done its
7793         thing, but would be nice if they were already done by the time
7794         that OnInit is called.
7795         """
7796         wx.StockGDI._initStockObjects()
7797
7798
7799     def __del__(self, destroy=wx.PyApp.__del__):
7800         self.RestoreStdio()  # Just in case the MainLoop was overridden
7801         destroy(self)
7802
7803     def Destroy(self):
7804         self.this.own(False)
7805         wx.PyApp.Destroy(self)
7806
7807     def SetTopWindow(self, frame):
7808         """Set the \"main\" top level window"""
7809         if self.stdioWin:
7810             self.stdioWin.SetParent(frame)
7811         wx.PyApp.SetTopWindow(self, frame)
7812
7813
7814     def MainLoop(self):
7815         """Execute the main GUI event loop"""
7816         wx.PyApp.MainLoop(self)
7817         self.RestoreStdio()
7818
7819
7820     def RedirectStdio(self, filename=None):
7821         """Redirect sys.stdout and sys.stderr to a file or a popup window."""
7822         if filename:
7823             _sys.stdout = _sys.stderr = open(filename, 'a')
7824         else:
7825             self.stdioWin = self.outputWindowClass()
7826             _sys.stdout = _sys.stderr = self.stdioWin
7827
7828
7829     def RestoreStdio(self):
7830         try:
7831             _sys.stdout, _sys.stderr = self.saveStdio
7832         except:
7833             pass
7834
7835
7836     def SetOutputWindowAttributes(self, title=None, pos=None, size=None):
7837         """
7838         Set the title, position and/or size of the output window if
7839         the stdio has been redirected.  This should be called before
7840         any output would cause the output window to be created.
7841         """
7842         if self.stdioWin:
7843             if title is not None:
7844                 self.stdioWin.title = title
7845             if pos is not None:
7846                 self.stdioWin.pos = pos
7847             if size is not None:
7848                 self.stdioWin.size = size
7849
7850
7851
7852
7853 # change from wx.PyApp_XX to wx.App_XX
7854 App_GetMacSupportPCMenuShortcuts = _core_.PyApp_GetMacSupportPCMenuShortcuts
7855 App_GetMacAboutMenuItemId        = _core_.PyApp_GetMacAboutMenuItemId
7856 App_GetMacPreferencesMenuItemId  = _core_.PyApp_GetMacPreferencesMenuItemId
7857 App_GetMacExitMenuItemId         = _core_.PyApp_GetMacExitMenuItemId
7858 App_GetMacHelpMenuTitleName      = _core_.PyApp_GetMacHelpMenuTitleName
7859 App_SetMacSupportPCMenuShortcuts = _core_.PyApp_SetMacSupportPCMenuShortcuts
7860 App_SetMacAboutMenuItemId        = _core_.PyApp_SetMacAboutMenuItemId
7861 App_SetMacPreferencesMenuItemId  = _core_.PyApp_SetMacPreferencesMenuItemId
7862 App_SetMacExitMenuItemId         = _core_.PyApp_SetMacExitMenuItemId
7863 App_SetMacHelpMenuTitleName      = _core_.PyApp_SetMacHelpMenuTitleName
7864 App_GetComCtl32Version           = _core_.PyApp_GetComCtl32Version
7865
7866 #----------------------------------------------------------------------------
7867
7868 class PySimpleApp(wx.App):
7869     """
7870     A simple application class.  You can just create one of these and
7871     then then make your top level windows later, and not have to worry
7872     about OnInit.  For example::
7873
7874         app = wx.PySimpleApp()
7875         frame = wx.Frame(None, title='Hello World')
7876         frame.Show()
7877         app.MainLoop()
7878
7879     :see: `wx.App`
7880     """
7881
7882     def __init__(self, redirect=False, filename=None,
7883                  useBestVisual=False, clearSigInt=True):
7884         """
7885         :see: `wx.App.__init__`
7886         """
7887         wx.App.__init__(self, redirect, filename, useBestVisual, clearSigInt)
7888
7889     def OnInit(self):
7890         return True
7891
7892
7893
7894 # Is anybody using this one?
7895 class PyWidgetTester(wx.App):
7896     def __init__(self, size = (250, 100)):
7897         self.size = size
7898         wx.App.__init__(self, 0)
7899
7900     def OnInit(self):
7901         self.frame = wx.Frame(None, -1, "Widget Tester", pos=(0,0), size=self.size)
7902         self.SetTopWindow(self.frame)
7903         return True
7904
7905     def SetWidget(self, widgetClass, *args, **kwargs):
7906         w = widgetClass(self.frame, *args, **kwargs)
7907         self.frame.Show(True)
7908
7909 #----------------------------------------------------------------------------
7910 # DO NOT hold any other references to this object.  This is how we
7911 # know when to cleanup system resources that wxWidgets is holding.  When
7912 # the sys module is unloaded, the refcount on sys.__wxPythonCleanup
7913 # goes to zero and it calls the wx.App_CleanUp function.
7914
7915 class __wxPyCleanup:
7916     def __init__(self):
7917         self.cleanup = _core_.App_CleanUp
7918     def __del__(self):
7919         self.cleanup()
7920
7921 _sys.__wxPythonCleanup = __wxPyCleanup()
7922
7923 ## # another possible solution, but it gets called too early...
7924 ## import atexit
7925 ## atexit.register(_core_.wxApp_CleanUp)
7926
7927
7928 #----------------------------------------------------------------------------
7929
7930 #---------------------------------------------------------------------------
7931
7932 class EventLoop(object):
7933     """Proxy of C++ EventLoop class"""
7934     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7935     __repr__ = _swig_repr
7936     def __init__(self, *args, **kwargs):
7937         """__init__(self) -> EventLoop"""
7938         _core_.EventLoop_swiginit(self,_core_.new_EventLoop(*args, **kwargs))
7939     __swig_destroy__ = _core_.delete_EventLoop
7940     __del__ = lambda self : None;
7941     def Run(*args, **kwargs):
7942         """Run(self) -> int"""
7943         return _core_.EventLoop_Run(*args, **kwargs)
7944
7945     def Exit(*args, **kwargs):
7946         """Exit(self, int rc=0)"""
7947         return _core_.EventLoop_Exit(*args, **kwargs)
7948
7949     def Pending(*args, **kwargs):
7950         """Pending(self) -> bool"""
7951         return _core_.EventLoop_Pending(*args, **kwargs)
7952
7953     def Dispatch(*args, **kwargs):
7954         """Dispatch(self) -> bool"""
7955         return _core_.EventLoop_Dispatch(*args, **kwargs)
7956
7957     def IsRunning(*args, **kwargs):
7958         """IsRunning(self) -> bool"""
7959         return _core_.EventLoop_IsRunning(*args, **kwargs)
7960
7961     def GetActive(*args, **kwargs):
7962         """GetActive() -> EventLoop"""
7963         return _core_.EventLoop_GetActive(*args, **kwargs)
7964
7965     GetActive = staticmethod(GetActive)
7966     def SetActive(*args, **kwargs):
7967         """SetActive(EventLoop loop)"""
7968         return _core_.EventLoop_SetActive(*args, **kwargs)
7969
7970     SetActive = staticmethod(SetActive)
7971 _core_.EventLoop_swigregister(EventLoop)
7972
7973 def EventLoop_GetActive(*args):
7974   """EventLoop_GetActive() -> EventLoop"""
7975   return _core_.EventLoop_GetActive(*args)
7976
7977 def EventLoop_SetActive(*args, **kwargs):
7978   """EventLoop_SetActive(EventLoop loop)"""
7979   return _core_.EventLoop_SetActive(*args, **kwargs)
7980
7981 class EventLoopActivator(object):
7982     """Proxy of C++ EventLoopActivator class"""
7983     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7984     __repr__ = _swig_repr
7985     def __init__(self, *args, **kwargs):
7986         """__init__(self, EventLoop evtLoop) -> EventLoopActivator"""
7987         _core_.EventLoopActivator_swiginit(self,_core_.new_EventLoopActivator(*args, **kwargs))
7988     __swig_destroy__ = _core_.delete_EventLoopActivator
7989     __del__ = lambda self : None;
7990 _core_.EventLoopActivator_swigregister(EventLoopActivator)
7991
7992 #---------------------------------------------------------------------------
7993
7994 ACCEL_ALT = _core_.ACCEL_ALT
7995 ACCEL_CTRL = _core_.ACCEL_CTRL
7996 ACCEL_SHIFT = _core_.ACCEL_SHIFT
7997 ACCEL_NORMAL = _core_.ACCEL_NORMAL
7998 ACCEL_CMD = _core_.ACCEL_CMD
7999 class AcceleratorEntry(object):
8000     """
8001     A class used to define items in an `wx.AcceleratorTable`.  wxPython
8002     programs can choose to use wx.AcceleratorEntry objects, but using a
8003     list of 3-tuple of integers (flags, keyCode, cmdID) usually works just
8004     as well.  See `__init__` for  of the tuple values.
8005
8006     :see: `wx.AcceleratorTable`
8007     """
8008     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
8009     __repr__ = _swig_repr
8010     def __init__(self, *args, **kwargs):
8011         """
8012         __init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry
8013
8014         Construct a wx.AcceleratorEntry.
8015         """
8016         _core_.AcceleratorEntry_swiginit(self,_core_.new_AcceleratorEntry(*args, **kwargs))
8017     __swig_destroy__ = _core_.delete_AcceleratorEntry
8018     __del__ = lambda self : None;
8019     def Set(*args, **kwargs):
8020         """
8021         Set(self, int flags, int keyCode, int cmd)
8022
8023         (Re)set the attributes of a wx.AcceleratorEntry.
8024         :see `__init__`
8025         """
8026         return _core_.AcceleratorEntry_Set(*args, **kwargs)
8027
8028     def Create(*args, **kwargs):
8029         """
8030         Create(String str) -> AcceleratorEntry
8031
8032         Create accelerator corresponding to the specified string, or None if
8033         it coulnd't be parsed.
8034         """
8035         return _core_.AcceleratorEntry_Create(*args, **kwargs)
8036
8037     Create = staticmethod(Create)
8038     def GetFlags(*args, **kwargs):
8039         """
8040         GetFlags(self) -> int
8041
8042         Get the AcceleratorEntry's flags.
8043         """
8044         return _core_.AcceleratorEntry_GetFlags(*args, **kwargs)
8045
8046     def GetKeyCode(*args, **kwargs):
8047         """
8048         GetKeyCode(self) -> int
8049
8050         Get the AcceleratorEntry's keycode.
8051         """
8052         return _core_.AcceleratorEntry_GetKeyCode(*args, **kwargs)
8053
8054     def GetCommand(*args, **kwargs):
8055         """
8056         GetCommand(self) -> int
8057
8058         Get the AcceleratorEntry's command ID.
8059         """
8060         return _core_.AcceleratorEntry_GetCommand(*args, **kwargs)
8061
8062     def IsOk(*args, **kwargs):
8063         """IsOk(self) -> bool"""
8064         return _core_.AcceleratorEntry_IsOk(*args, **kwargs)
8065
8066     def ToString(*args, **kwargs):
8067         """
8068         ToString(self) -> String
8069
8070         Returns a string representation for the this accelerator.  The string
8071         is formatted using the <flags>-<keycode> format where <flags> maybe a
8072         hyphen-separed list of "shift|alt|ctrl"
8073
8074         """
8075         return _core_.AcceleratorEntry_ToString(*args, **kwargs)
8076
8077     def FromString(*args, **kwargs):
8078         """
8079         FromString(self, String str) -> bool
8080
8081         Returns true if the given string correctly initialized this object.
8082         """
8083         return _core_.AcceleratorEntry_FromString(*args, **kwargs)
8084
8085     Command = property(GetCommand,doc="See `GetCommand`")
8086     Flags = property(GetFlags,doc="See `GetFlags`")
8087     KeyCode = property(GetKeyCode,doc="See `GetKeyCode`")
8088 _core_.AcceleratorEntry_swigregister(AcceleratorEntry)
8089
8090 def AcceleratorEntry_Create(*args, **kwargs):
8091   """
8092     AcceleratorEntry_Create(String str) -> AcceleratorEntry
8093
8094     Create accelerator corresponding to the specified string, or None if
8095     it coulnd't be parsed.
8096     """
8097   return _core_.AcceleratorEntry_Create(*args, **kwargs)
8098
8099 class AcceleratorTable(Object):
8100     """
8101     An accelerator table allows the application to specify a table of
8102     keyboard shortcuts for menus or other commands. On Windows, menu or
8103     button commands are supported; on GTK, only menu commands are
8104     supported.
8105     """
8106     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
8107     __repr__ = _swig_repr
8108     def __init__(self, *args, **kwargs):
8109         """
8110         __init__(entries) -> AcceleratorTable
8111
8112         Construct an AcceleratorTable from a list of `wx.AcceleratorEntry`
8113         items or or of 3-tuples (flags, keyCode, cmdID)
8114
8115         :see: `wx.AcceleratorEntry`
8116         """
8117         _core_.AcceleratorTable_swiginit(self,_core_.new_AcceleratorTable(*args, **kwargs))
8118     __swig_destroy__ = _core_.delete_AcceleratorTable
8119     __del__ = lambda self : None;
8120     def IsOk(*args, **kwargs):
8121         """IsOk(self) -> bool"""
8122         return _core_.AcceleratorTable_IsOk(*args, **kwargs)
8123
8124     Ok = IsOk
8125 _core_.AcceleratorTable_swigregister(AcceleratorTable)
8126
8127
8128 def GetAccelFromString(*args, **kwargs):
8129   """GetAccelFromString(String label) -> AcceleratorEntry"""
8130   return _core_.GetAccelFromString(*args, **kwargs)
8131 #---------------------------------------------------------------------------
8132
8133 class VisualAttributes(object):
8134     """struct containing all the visual attributes of a control"""
8135     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
8136     __repr__ = _swig_repr
8137     def __init__(self, *args, **kwargs):
8138         """
8139         __init__(self) -> VisualAttributes
8140
8141         struct containing all the visual attributes of a control
8142         """
8143         _core_.VisualAttributes_swiginit(self,_core_.new_VisualAttributes(*args, **kwargs))
8144     __swig_destroy__ = _core_.delete_VisualAttributes
8145     __del__ = lambda self : None;
8146     font = property(_core_.VisualAttributes_font_get, _core_.VisualAttributes_font_set)
8147     colFg = property(_core_.VisualAttributes_colFg_get, _core_.VisualAttributes_colFg_set)
8148     colBg = property(_core_.VisualAttributes_colBg_get, _core_.VisualAttributes_colBg_set)
8149 _core_.VisualAttributes_swigregister(VisualAttributes)
8150 NullAcceleratorTable = cvar.NullAcceleratorTable
8151 PanelNameStr = cvar.PanelNameStr
8152
8153 WINDOW_VARIANT_NORMAL = _core_.WINDOW_VARIANT_NORMAL
8154 WINDOW_VARIANT_SMALL = _core_.WINDOW_VARIANT_SMALL
8155 WINDOW_VARIANT_MINI = _core_.WINDOW_VARIANT_MINI
8156 WINDOW_VARIANT_LARGE = _core_.WINDOW_VARIANT_LARGE
8157 WINDOW_VARIANT_MAX = _core_.WINDOW_VARIANT_MAX
8158 class Window(EvtHandler):
8159     """
8160     wx.Window is the base class for all windows and represents any visible
8161     object on the screen. All controls, top level windows and so on are
8162     wx.Windows. Sizers and device contexts are not however, as they don't
8163     appear on screen themselves.
8164
8165     """
8166     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
8167     __repr__ = _swig_repr
8168     def __init__(self, *args, **kwargs):
8169         """
8170         __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
8171             Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window
8172
8173         Construct and show a generic Window.
8174         """
8175         _core_.Window_swiginit(self,_core_.new_Window(*args, **kwargs))
8176         self._setOORInfo(self)
8177
8178     def Create(*args, **kwargs):
8179         """
8180         Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
8181             Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool
8182
8183         Create the GUI part of the Window for 2-phase creation mode.
8184         """
8185         return _core_.Window_Create(*args, **kwargs)
8186
8187     def Close(*args, **kwargs):
8188         """
8189         Close(self, bool force=False) -> bool
8190
8191         This function simply generates a EVT_CLOSE event whose handler usually
8192         tries to close the window. It doesn't close the window itself,
8193         however.  If force is False (the default) then the window's close
8194         handler will be allowed to veto the destruction of the window.
8195         """
8196         return _core_.Window_Close(*args, **kwargs)
8197
8198     def Destroy(*args, **kwargs):
8199         """
8200         Destroy(self) -> bool
8201
8202         Destroys the window safely.  Frames and dialogs are not destroyed
8203         immediately when this function is called -- they are added to a list
8204         of windows to be deleted on idle time, when all the window's events
8205         have been processed. This prevents problems with events being sent to
8206         non-existent windows.
8207
8208         Returns True if the window has either been successfully deleted, or it
8209         has been added to the list of windows pending real deletion.
8210         """
8211         args[0].this.own(False)
8212         return _core_.Window_Destroy(*args, **kwargs)
8213
8214     def DestroyChildren(*args, **kwargs):
8215         """
8216         DestroyChildren(self) -> bool
8217
8218         Destroys all children of a window. Called automatically by the
8219         destructor.
8220         """
8221         return _core_.Window_DestroyChildren(*args, **kwargs)
8222
8223     def IsBeingDeleted(*args, **kwargs):
8224         """
8225         IsBeingDeleted(self) -> bool
8226
8227         Is the window in the process of being deleted?
8228         """
8229         return _core_.Window_IsBeingDeleted(*args, **kwargs)
8230
8231     def SetLabel(*args, **kwargs):
8232         """
8233         SetLabel(self, String label)
8234
8235         Set the text which the window shows in its label if applicable.
8236         """
8237         return _core_.Window_SetLabel(*args, **kwargs)
8238
8239     def GetLabel(*args, **kwargs):
8240         """
8241         GetLabel(self) -> String
8242
8243         Generic way of getting a label from any window, for identification
8244         purposes.  The interpretation of this function differs from class to
8245         class. For frames and dialogs, the value returned is the title. For
8246         buttons or static text controls, it is the button text. This function
8247         can be useful for meta-programs such as testing tools or special-needs
8248         access programs)which need to identify windows by name.
8249         """
8250         return _core_.Window_GetLabel(*args, **kwargs)
8251
8252     def SetName(*args, **kwargs):
8253         """
8254         SetName(self, String name)
8255
8256         Sets the window's name.  The window name is used for ressource setting
8257         in X, it is not the same as the window title/label
8258         """
8259         return _core_.Window_SetName(*args, **kwargs)
8260
8261     def GetName(*args, **kwargs):
8262         """
8263         GetName(self) -> String
8264
8265         Returns the windows name.  This name is not guaranteed to be unique;
8266         it is up to the programmer to supply an appropriate name in the window
8267         constructor or via wx.Window.SetName.
8268         """
8269         return _core_.Window_GetName(*args, **kwargs)
8270
8271     def SetWindowVariant(*args, **kwargs):
8272         """
8273         SetWindowVariant(self, int variant)
8274
8275         Sets the variant of the window/font size to use for this window, if
8276         the platform supports variants, for example, wxMac.
8277         """
8278         return _core_.Window_SetWindowVariant(*args, **kwargs)
8279
8280     def GetWindowVariant(*args, **kwargs):
8281         """GetWindowVariant(self) -> int"""
8282         return _core_.Window_GetWindowVariant(*args, **kwargs)
8283
8284     def SetId(*args, **kwargs):
8285         """
8286         SetId(self, int winid)
8287
8288         Sets the identifier of the window.  Each window has an integer
8289         identifier. If the application has not provided one, an identifier
8290         will be generated. Normally, the identifier should be provided on
8291         creation and should not be modified subsequently.
8292         """
8293         return _core_.Window_SetId(*args, **kwargs)
8294
8295     def GetId(*args, **kwargs):
8296         """
8297         GetId(self) -> int
8298
8299         Returns the identifier of the window.  Each window has an integer
8300         identifier. If the application has not provided one (or the default Id
8301         -1 is used) then an unique identifier with a negative value will be
8302         generated.
8303         """
8304         return _core_.Window_GetId(*args, **kwargs)
8305
8306     def NewControlId(*args, **kwargs):
8307         """
8308         NewControlId() -> int
8309
8310         Generate a control id for the controls which were not given one.
8311         """
8312         return _core_.Window_NewControlId(*args, **kwargs)
8313
8314     NewControlId = staticmethod(NewControlId)
8315     def NextControlId(*args, **kwargs):
8316         """
8317         NextControlId(int winid) -> int
8318
8319         Get the id of the control following the one with the given
8320         autogenerated) id
8321         """
8322         return _core_.Window_NextControlId(*args, **kwargs)
8323
8324     NextControlId = staticmethod(NextControlId)
8325     def PrevControlId(*args, **kwargs):
8326         """
8327         PrevControlId(int winid) -> int
8328
8329         Get the id of the control preceding the one with the given
8330         autogenerated) id
8331         """
8332         return _core_.Window_PrevControlId(*args, **kwargs)
8333
8334     PrevControlId = staticmethod(PrevControlId)
8335     def GetLayoutDirection(*args, **kwargs):
8336         """
8337         GetLayoutDirection(self) -> int
8338
8339         Get the layout direction (LTR or RTL) for this window.  Returns
8340         ``wx.Layout_Default`` if layout direction is not supported.
8341         """
8342         return _core_.Window_GetLayoutDirection(*args, **kwargs)
8343
8344     def SetLayoutDirection(*args, **kwargs):
8345         """
8346         SetLayoutDirection(self, int dir)
8347
8348         Set the layout direction (LTR or RTL) for this window.
8349         """
8350         return _core_.Window_SetLayoutDirection(*args, **kwargs)
8351
8352     def AdjustForLayoutDirection(*args, **kwargs):
8353         """
8354         AdjustForLayoutDirection(self, int x, int width, int widthTotal) -> int
8355
8356         Mirror coordinates for RTL layout if this window uses it and if the
8357         mirroring is not done automatically like Win32.
8358         """
8359         return _core_.Window_AdjustForLayoutDirection(*args, **kwargs)
8360
8361     def SetSize(*args, **kwargs):
8362         """
8363         SetSize(self, Size size)
8364
8365         Sets the size of the window in pixels.
8366         """
8367         return _core_.Window_SetSize(*args, **kwargs)
8368
8369     def SetDimensions(*args, **kwargs):
8370         """
8371         SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
8372
8373         Sets the position and size of the window in pixels.  The sizeFlags
8374         parameter indicates the interpretation of the other params if they are
8375         equal to -1.
8376
8377             ========================  ======================================
8378             wx.SIZE_AUTO              A -1 indicates that a class-specific
8379                                       default should be used.
8380             wx.SIZE_USE_EXISTING      Axisting dimensions should be used if
8381                                       -1 values are supplied.
8382             wxSIZE_ALLOW_MINUS_ONE    Allow dimensions of -1 and less to be
8383                                       interpreted as real dimensions, not
8384                                       default values.
8385             ========================  ======================================
8386
8387         """
8388         return _core_.Window_SetDimensions(*args, **kwargs)
8389
8390     def SetRect(*args, **kwargs):
8391         """
8392         SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
8393
8394         Sets the position and size of the window in pixels using a wx.Rect.
8395         """
8396         return _core_.Window_SetRect(*args, **kwargs)
8397
8398     def SetSizeWH(*args, **kwargs):
8399         """
8400         SetSizeWH(self, int width, int height)
8401
8402         Sets the size of the window in pixels.
8403         """
8404         return _core_.Window_SetSizeWH(*args, **kwargs)
8405
8406     def Move(*args, **kwargs):
8407         """
8408         Move(self, Point pt, int flags=SIZE_USE_EXISTING)
8409
8410         Moves the window to the given position.
8411         """
8412         return _core_.Window_Move(*args, **kwargs)
8413
8414     SetPosition = Move
8415     def MoveXY(*args, **kwargs):
8416         """
8417         MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
8418
8419         Moves the window to the given position.
8420         """
8421         return _core_.Window_MoveXY(*args, **kwargs)
8422
8423     def SetInitialSize(*args, **kwargs):
8424         """
8425         SetInitialSize(self, Size size=DefaultSize)
8426
8427         A 'Smart' SetSize that will fill in default size components with the
8428         window's *best size* values.  Also set's the minsize for use with sizers.
8429         """
8430         return _core_.Window_SetInitialSize(*args, **kwargs)
8431
8432     SetBestFittingSize = wx._deprecated(SetInitialSize, 'Use `SetInitialSize`')
8433     def Raise(*args, **kwargs):
8434         """
8435         Raise(self)
8436
8437         Raises the window to the top of the window hierarchy.  In current
8438         version of wxWidgets this works both for managed and child windows.
8439         """
8440         return _core_.Window_Raise(*args, **kwargs)
8441
8442     def Lower(*args, **kwargs):
8443         """
8444         Lower(self)
8445
8446         Lowers the window to the bottom of the window hierarchy.  In current
8447         version of wxWidgets this works both for managed and child windows.
8448         """
8449         return _core_.Window_Lower(*args, **kwargs)
8450
8451     def SetClientSize(*args, **kwargs):
8452         """
8453         SetClientSize(self, Size size)
8454
8455         This sets the size of the window client area in pixels. Using this
8456         function to size a window tends to be more device-independent than
8457         wx.Window.SetSize, since the application need not worry about what
8458         dimensions the border or title bar have when trying to fit the window
8459         around panel items, for example.
8460         """
8461         return _core_.Window_SetClientSize(*args, **kwargs)
8462
8463     def SetClientSizeWH(*args, **kwargs):
8464         """
8465         SetClientSizeWH(self, int width, int height)
8466
8467         This sets the size of the window client area in pixels. Using this
8468         function to size a window tends to be more device-independent than
8469         wx.Window.SetSize, since the application need not worry about what
8470         dimensions the border or title bar have when trying to fit the window
8471         around panel items, for example.
8472         """
8473         return _core_.Window_SetClientSizeWH(*args, **kwargs)
8474
8475     def SetClientRect(*args, **kwargs):
8476         """
8477         SetClientRect(self, Rect rect)
8478
8479         This sets the size of the window client area in pixels. Using this
8480         function to size a window tends to be more device-independent than
8481         wx.Window.SetSize, since the application need not worry about what
8482         dimensions the border or title bar have when trying to fit the window
8483         around panel items, for example.
8484         """
8485         return _core_.Window_SetClientRect(*args, **kwargs)
8486
8487     def GetPosition(*args, **kwargs):
8488         """
8489         GetPosition(self) -> Point
8490
8491         Get the window's position.  Notice that the position is in client
8492         coordinates for child windows and screen coordinates for the top level
8493         ones, use `GetScreenPosition` if you need screen coordinates for all
8494         kinds of windows.
8495         """
8496         return _core_.Window_GetPosition(*args, **kwargs)
8497
8498     def GetPositionTuple(*args, **kwargs):
8499         """
8500         GetPositionTuple() -> (x,y)
8501
8502         Get the window's position.  Notice that the position is in client
8503         coordinates for child windows and screen coordinates for the top level
8504         ones, use `GetScreenPosition` if you need screen coordinates for all
8505         kinds of windows.
8506         """
8507         return _core_.Window_GetPositionTuple(*args, **kwargs)
8508
8509     def GetScreenPosition(*args, **kwargs):
8510         """
8511         GetScreenPosition(self) -> Point
8512
8513         Get the position of the window in screen coordinantes.
8514         """
8515         return _core_.Window_GetScreenPosition(*args, **kwargs)
8516
8517     def GetScreenPositionTuple(*args, **kwargs):
8518         """
8519         GetScreenPositionTuple() -> (x,y)
8520
8521         Get the position of the window in screen coordinantes.
8522         """
8523         return _core_.Window_GetScreenPositionTuple(*args, **kwargs)
8524
8525     def GetScreenRect(*args, **kwargs):
8526         """
8527         GetScreenRect(self) -> Rect
8528
8529         Returns the size and position of the window in screen coordinantes as
8530         a `wx.Rect` object.
8531         """
8532         return _core_.Window_GetScreenRect(*args, **kwargs)
8533
8534     def GetSize(*args, **kwargs):
8535         """
8536         GetSize(self) -> Size
8537
8538         Get the window size.
8539         """
8540         return _core_.Window_GetSize(*args, **kwargs)
8541
8542     def GetSizeTuple(*args, **kwargs):
8543         """
8544         GetSizeTuple() -> (width, height)
8545
8546         Get the window size.
8547         """
8548         return _core_.Window_GetSizeTuple(*args, **kwargs)
8549
8550     def GetRect(*args, **kwargs):
8551         """
8552         GetRect(self) -> Rect
8553
8554         Returns the size and position of the window as a `wx.Rect` object.
8555         """
8556         return _core_.Window_GetRect(*args, **kwargs)
8557
8558     def GetClientSize(*args, **kwargs):
8559         """
8560         GetClientSize(self) -> Size
8561
8562         This gets the size of the window's 'client area' in pixels. The client
8563         area is the area which may be drawn on by the programmer, excluding
8564         title bar, border, scrollbars, etc.
8565         """
8566         return _core_.Window_GetClientSize(*args, **kwargs)
8567
8568     def GetClientSizeTuple(*args, **kwargs):
8569         """
8570         GetClientSizeTuple() -> (width, height)
8571
8572         This gets the size of the window's 'client area' in pixels. The client
8573         area is the area which may be drawn on by the programmer, excluding
8574         title bar, border, scrollbars, etc.
8575         """
8576         return _core_.Window_GetClientSizeTuple(*args, **kwargs)
8577
8578     def GetClientAreaOrigin(*args, **kwargs):
8579         """
8580         GetClientAreaOrigin(self) -> Point
8581
8582         Get the origin of the client area of the window relative to the
8583         window's top left corner (the client area may be shifted because of
8584         the borders, scrollbars, other decorations...)
8585         """
8586         return _core_.Window_GetClientAreaOrigin(*args, **kwargs)
8587
8588     def GetClientRect(*args, **kwargs):
8589         """
8590         GetClientRect(self) -> Rect
8591
8592         Get the client area position and size as a `wx.Rect` object.
8593         """
8594         return _core_.Window_GetClientRect(*args, **kwargs)
8595
8596     def GetBestSize(*args, **kwargs):
8597         """
8598         GetBestSize(self) -> Size
8599
8600         This function returns the best acceptable minimal size for the
8601         window, if applicable. For example, for a static text control, it will
8602         be the minimal size such that the control label is not truncated. For
8603         windows containing subwindows (suzh aswx.Panel), the size returned by
8604         this function will be the same as the size the window would have had
8605         after calling Fit.
8606         """
8607         return _core_.Window_GetBestSize(*args, **kwargs)
8608
8609     def GetBestSizeTuple(*args, **kwargs):
8610         """
8611         GetBestSizeTuple() -> (width, height)
8612
8613         This function returns the best acceptable minimal size for the
8614         window, if applicable. For example, for a static text control, it will
8615         be the minimal size such that the control label is not truncated. For
8616         windows containing subwindows (suzh aswx.Panel), the size returned by
8617         this function will be the same as the size the window would have had
8618         after calling Fit.
8619         """
8620         return _core_.Window_GetBestSizeTuple(*args, **kwargs)
8621
8622     def InvalidateBestSize(*args, **kwargs):
8623         """
8624         InvalidateBestSize(self)
8625
8626         Reset the cached best size value so it will be recalculated the next
8627         time it is needed.
8628         """
8629         return _core_.Window_InvalidateBestSize(*args, **kwargs)
8630
8631     def CacheBestSize(*args, **kwargs):
8632         """
8633         CacheBestSize(self, Size size)
8634
8635         Cache the best size so it doesn't need to be calculated again, (at least until
8636         some properties of the window change.)
8637         """
8638         return _core_.Window_CacheBestSize(*args, **kwargs)
8639
8640     def GetEffectiveMinSize(*args, **kwargs):
8641         """
8642         GetEffectiveMinSize(self) -> Size
8643
8644         This function will merge the window's best size into the window's
8645         minimum size, giving priority to the min size components, and returns
8646         the results.
8647
8648         """
8649         return _core_.Window_GetEffectiveMinSize(*args, **kwargs)
8650
8651     GetBestFittingSize = wx._deprecated(GetEffectiveMinSize, 'Use `GetEffectiveMinSize` instead.')
8652     def GetAdjustedBestSize(self):
8653         s = self.GetBestSize()
8654         return wx.Size(max(s.width,  self.GetMinWidth()),
8655                        max(s.height, self.GetMinHeight()))
8656     GetAdjustedBestSize = wx._deprecated(GetAdjustedBestSize, 'Use `GetEffectiveMinSize` instead.')
8657
8658     def Center(*args, **kwargs):
8659         """
8660         Center(self, int direction=BOTH)
8661
8662         Centers the window.  The parameter specifies the direction for
8663         cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
8664         also include wx.CENTER_ON_SCREEN flag if you want to center the window
8665         on the entire screen and not on its parent window.  If it is a
8666         top-level window and has no parent then it will always be centered
8667         relative to the screen.
8668         """
8669         return _core_.Window_Center(*args, **kwargs)
8670
8671     Centre = Center
8672     def CenterOnParent(*args, **kwargs):
8673         """
8674         CenterOnParent(self, int dir=BOTH)
8675
8676         Center with respect to the the parent window
8677         """
8678         return _core_.Window_CenterOnParent(*args, **kwargs)
8679
8680     CentreOnParent = CenterOnParent
8681     def Fit(*args, **kwargs):
8682         """
8683         Fit(self)
8684
8685         Sizes the window so that it fits around its subwindows. This function
8686         won't do anything if there are no subwindows and will only really work
8687         correctly if sizers are used for the subwindows layout. Also, if the
8688         window has exactly one subwindow it is better (faster and the result
8689         is more precise as Fit adds some margin to account for fuzziness of
8690         its calculations) to call window.SetClientSize(child.GetSize())
8691         instead of calling Fit.
8692         """
8693         return _core_.Window_Fit(*args, **kwargs)
8694
8695     def FitInside(*args, **kwargs):
8696         """
8697         FitInside(self)
8698
8699         Similar to Fit, but sizes the interior (virtual) size of a
8700         window. Mainly useful with scrolled windows to reset scrollbars after
8701         sizing changes that do not trigger a size event, and/or scrolled
8702         windows without an interior sizer. This function similarly won't do
8703         anything if there are no subwindows.
8704         """
8705         return _core_.Window_FitInside(*args, **kwargs)
8706
8707     def SetSizeHints(*args, **kwargs):
8708         """
8709         SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1,
8710             int incH=-1)
8711
8712         Allows specification of minimum and maximum window sizes, and window
8713         size increments. If a pair of values is not set (or set to -1), the
8714         default values will be used.  If this function is called, the user
8715         will not be able to size the window outside the given bounds (if it is
8716         a top-level window.)  Sizers will also inspect the minimum window size
8717         and will use that value if set when calculating layout.
8718
8719         The resizing increments are only significant under Motif or Xt.
8720         """
8721         return _core_.Window_SetSizeHints(*args, **kwargs)
8722
8723     def SetSizeHintsSz(*args, **kwargs):
8724         """
8725         SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
8726
8727         Allows specification of minimum and maximum window sizes, and window
8728         size increments. If a pair of values is not set (or set to -1), the
8729         default values will be used.  If this function is called, the user
8730         will not be able to size the window outside the given bounds (if it is
8731         a top-level window.)  Sizers will also inspect the minimum window size
8732         and will use that value if set when calculating layout.
8733
8734         The resizing increments are only significant under Motif or Xt.
8735         """
8736         return _core_.Window_SetSizeHintsSz(*args, **kwargs)
8737
8738     def SetVirtualSizeHints(*args, **kwargs):
8739         """
8740         SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
8741
8742         Allows specification of minimum and maximum virtual window sizes. If a
8743         pair of values is not set (or set to -1), the default values will be
8744         used.  If this function is called, the user will not be able to size
8745         the virtual area of the window outside the given bounds.
8746         """
8747         return _core_.Window_SetVirtualSizeHints(*args, **kwargs)
8748
8749     def SetVirtualSizeHintsSz(*args, **kwargs):
8750         """
8751         SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)
8752
8753         Allows specification of minimum and maximum virtual window sizes. If a
8754         pair of values is not set (or set to -1), the default values will be
8755         used.  If this function is called, the user will not be able to size
8756         the virtual area of the window outside the given bounds.
8757         """
8758         return _core_.Window_SetVirtualSizeHintsSz(*args, **kwargs)
8759
8760     def GetMaxSize(*args, **kwargs):
8761         """GetMaxSize(self) -> Size"""
8762         return _core_.Window_GetMaxSize(*args, **kwargs)
8763
8764     def GetMinSize(*args, **kwargs):
8765         """GetMinSize(self) -> Size"""
8766         return _core_.Window_GetMinSize(*args, **kwargs)
8767
8768     def SetMinSize(*args, **kwargs):
8769         """
8770         SetMinSize(self, Size minSize)
8771
8772         A more convenient method than `SetSizeHints` for setting just the
8773         min size.
8774         """
8775         return _core_.Window_SetMinSize(*args, **kwargs)
8776
8777     def SetMaxSize(*args, **kwargs):
8778         """
8779         SetMaxSize(self, Size maxSize)
8780
8781         A more convenient method than `SetSizeHints` for setting just the
8782         max size.
8783         """
8784         return _core_.Window_SetMaxSize(*args, **kwargs)
8785
8786     def GetMinWidth(*args, **kwargs):
8787         """GetMinWidth(self) -> int"""
8788         return _core_.Window_GetMinWidth(*args, **kwargs)
8789
8790     def GetMinHeight(*args, **kwargs):
8791         """GetMinHeight(self) -> int"""
8792         return _core_.Window_GetMinHeight(*args, **kwargs)
8793
8794     def GetMaxWidth(*args, **kwargs):
8795         """GetMaxWidth(self) -> int"""
8796         return _core_.Window_GetMaxWidth(*args, **kwargs)
8797
8798     def GetMaxHeight(*args, **kwargs):
8799         """GetMaxHeight(self) -> int"""
8800         return _core_.Window_GetMaxHeight(*args, **kwargs)
8801
8802     def SetVirtualSize(*args, **kwargs):
8803         """
8804         SetVirtualSize(self, Size size)
8805
8806         Set the the virtual size of a window in pixels.  For most windows this
8807         is just the client area of the window, but for some like scrolled
8808         windows it is more or less independent of the screen window size.
8809         """
8810         return _core_.Window_SetVirtualSize(*args, **kwargs)
8811
8812     def SetVirtualSizeWH(*args, **kwargs):
8813         """
8814         SetVirtualSizeWH(self, int w, int h)
8815
8816         Set the the virtual size of a window in pixels.  For most windows this
8817         is just the client area of the window, but for some like scrolled
8818         windows it is more or less independent of the screen window size.
8819         """
8820         return _core_.Window_SetVirtualSizeWH(*args, **kwargs)
8821
8822     def GetVirtualSize(*args, **kwargs):
8823         """
8824         GetVirtualSize(self) -> Size
8825
8826         Get the the virtual size of the window in pixels.  For most windows
8827         this is just the client area of the window, but for some like scrolled
8828         windows it is more or less independent of the screen window size.
8829         """
8830         return _core_.Window_GetVirtualSize(*args, **kwargs)
8831
8832     def GetVirtualSizeTuple(*args, **kwargs):
8833         """
8834         GetVirtualSizeTuple() -> (width, height)
8835
8836         Get the the virtual size of the window in pixels.  For most windows
8837         this is just the client area of the window, but for some like scrolled
8838         windows it is more or less independent of the screen window size.
8839         """
8840         return _core_.Window_GetVirtualSizeTuple(*args, **kwargs)
8841
8842     def GetWindowBorderSize(*args, **kwargs):
8843         """
8844         GetWindowBorderSize(self) -> Size
8845
8846         Return the size of the left/right and top/bottom borders.
8847         """
8848         return _core_.Window_GetWindowBorderSize(*args, **kwargs)
8849
8850     def GetBestVirtualSize(*args, **kwargs):
8851         """
8852         GetBestVirtualSize(self) -> Size
8853
8854         Return the largest of ClientSize and BestSize (as determined by a
8855         sizer, interior children, or other means)
8856         """
8857         return _core_.Window_GetBestVirtualSize(*args, **kwargs)
8858
8859     def Show(*args, **kwargs):
8860         """
8861         Show(self, bool show=True) -> bool
8862
8863         Shows or hides the window. You may need to call Raise for a top level
8864         window if you want to bring it to top, although this is not needed if
8865         Show is called immediately after the frame creation.  Returns True if
8866         the window has been shown or hidden or False if nothing was done
8867         because it already was in the requested state.
8868         """
8869         return _core_.Window_Show(*args, **kwargs)
8870
8871     def Hide(*args, **kwargs):
8872         """
8873         Hide(self) -> bool
8874
8875         Equivalent to calling Show(False).
8876         """
8877         return _core_.Window_Hide(*args, **kwargs)
8878
8879     def Enable(*args, **kwargs):
8880         """
8881         Enable(self, bool enable=True) -> bool
8882
8883         Enable or disable the window for user input. Note that when a parent
8884         window is disabled, all of its children are disabled as well and they
8885         are reenabled again when the parent is.  Returns true if the window
8886         has been enabled or disabled, false if nothing was done, i.e. if the
8887         window had already been in the specified state.
8888         """
8889         return _core_.Window_Enable(*args, **kwargs)
8890
8891     def Disable(*args, **kwargs):
8892         """
8893         Disable(self) -> bool
8894
8895         Disables the window, same as Enable(false).
8896         """
8897         return _core_.Window_Disable(*args, **kwargs)
8898
8899     def IsShown(*args, **kwargs):
8900         """
8901         IsShown(self) -> bool
8902
8903         Returns true if the window is shown, false if it has been hidden.
8904         """
8905         return _core_.Window_IsShown(*args, **kwargs)
8906
8907     def IsEnabled(*args, **kwargs):
8908         """
8909         IsEnabled(self) -> bool
8910
8911         Returns true if the window is enabled for input, false otherwise.
8912         """
8913         return _core_.Window_IsEnabled(*args, **kwargs)
8914
8915     def IsShownOnScreen(*args, **kwargs):
8916         """
8917         IsShownOnScreen(self) -> bool
8918
8919         Returns ``True`` if the window is physically visible on the screen,
8920         i.e. it is shown and all its parents up to the toplevel window are
8921         shown as well.
8922         """
8923         return _core_.Window_IsShownOnScreen(*args, **kwargs)
8924
8925     def SetWindowStyleFlag(*args, **kwargs):
8926         """
8927         SetWindowStyleFlag(self, long style)
8928
8929         Sets the style of the window. Please note that some styles cannot be
8930         changed after the window creation and that Refresh() might need to be
8931         called after changing the others for the change to take place
8932         immediately.
8933         """
8934         return _core_.Window_SetWindowStyleFlag(*args, **kwargs)
8935
8936     def GetWindowStyleFlag(*args, **kwargs):
8937         """
8938         GetWindowStyleFlag(self) -> long
8939
8940         Gets the window style that was passed to the constructor or Create
8941         method.
8942         """
8943         return _core_.Window_GetWindowStyleFlag(*args, **kwargs)
8944
8945     SetWindowStyle = SetWindowStyleFlag; GetWindowStyle = GetWindowStyleFlag
8946     def HasFlag(*args, **kwargs):
8947         """
8948         HasFlag(self, int flag) -> bool
8949
8950         Test if the given style is set for this window.
8951         """
8952         return _core_.Window_HasFlag(*args, **kwargs)
8953
8954     def IsRetained(*args, **kwargs):
8955         """
8956         IsRetained(self) -> bool
8957
8958         Returns true if the window is retained, false otherwise.  Retained
8959         windows are only available on X platforms.
8960         """
8961         return _core_.Window_IsRetained(*args, **kwargs)
8962
8963     def ToggleWindowStyle(*args, **kwargs):
8964         """
8965         ToggleWindowStyle(self, int flag) -> bool
8966
8967         Turn the flag on if it had been turned off before and vice versa,
8968         returns True if the flag is turned on by this function call.
8969         """
8970         return _core_.Window_ToggleWindowStyle(*args, **kwargs)
8971
8972     def SetExtraStyle(*args, **kwargs):
8973         """
8974         SetExtraStyle(self, long exStyle)
8975
8976         Sets the extra style bits for the window.  Extra styles are the less
8977         often used style bits which can't be set with the constructor or with
8978         SetWindowStyleFlag()
8979         """
8980         return _core_.Window_SetExtraStyle(*args, **kwargs)
8981
8982     def GetExtraStyle(*args, **kwargs):
8983         """
8984         GetExtraStyle(self) -> long
8985
8986         Returns the extra style bits for the window.
8987         """
8988         return _core_.Window_GetExtraStyle(*args, **kwargs)
8989
8990     def MakeModal(*args, **kwargs):
8991         """
8992         MakeModal(self, bool modal=True)
8993
8994         Disables all other windows in the application so that the user can
8995         only interact with this window.  Passing False will reverse this
8996         effect.
8997         """
8998         return _core_.Window_MakeModal(*args, **kwargs)
8999
9000     def SetThemeEnabled(*args, **kwargs):
9001         """
9002         SetThemeEnabled(self, bool enableTheme)
9003
9004         This function tells a window if it should use the system's "theme"
9005          code to draw the windows' background instead if its own background
9006          drawing code. This will only have an effect on platforms that support
9007          the notion of themes in user defined windows. One such platform is
9008          GTK+ where windows can have (very colourful) backgrounds defined by a
9009          user's selected theme.
9010
9011         Dialogs, notebook pages and the status bar have this flag set to true
9012         by default so that the default look and feel is simulated best.
9013         """
9014         return _core_.Window_SetThemeEnabled(*args, **kwargs)
9015
9016     def GetThemeEnabled(*args, **kwargs):
9017         """
9018         GetThemeEnabled(self) -> bool
9019
9020         Return the themeEnabled flag.
9021         """
9022         return _core_.Window_GetThemeEnabled(*args, **kwargs)
9023
9024     def SetFocus(*args, **kwargs):
9025         """
9026         SetFocus(self)
9027
9028         Set's the focus to this window, allowing it to receive keyboard input.
9029         """
9030         return _core_.Window_SetFocus(*args, **kwargs)
9031
9032     def SetFocusFromKbd(*args, **kwargs):
9033         """
9034         SetFocusFromKbd(self)
9035
9036         Set focus to this window as the result of a keyboard action.  Normally
9037         only called internally.
9038         """
9039         return _core_.Window_SetFocusFromKbd(*args, **kwargs)
9040
9041     def FindFocus(*args, **kwargs):
9042         """
9043         FindFocus() -> Window
9044
9045         Returns the window or control that currently has the keyboard focus,
9046         or None.
9047         """
9048         return _core_.Window_FindFocus(*args, **kwargs)
9049
9050     FindFocus = staticmethod(FindFocus)
9051     def AcceptsFocus(*args, **kwargs):
9052         """
9053         AcceptsFocus(self) -> bool
9054
9055         Can this window have focus?
9056         """
9057         return _core_.Window_AcceptsFocus(*args, **kwargs)
9058
9059     def AcceptsFocusFromKeyboard(*args, **kwargs):
9060         """
9061         AcceptsFocusFromKeyboard(self) -> bool
9062
9063         Can this window be given focus by keyboard navigation? if not, the
9064         only way to give it focus (provided it accepts it at all) is to click
9065         it.
9066         """
9067         return _core_.Window_AcceptsFocusFromKeyboard(*args, **kwargs)
9068
9069     def Navigate(*args, **kwargs):
9070         """
9071         Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
9072
9073         Does keyboard navigation from this window to another, by sending a
9074         `wx.NavigationKeyEvent`.
9075         """
9076         return _core_.Window_Navigate(*args, **kwargs)
9077
9078     def MoveAfterInTabOrder(*args, **kwargs):
9079         """
9080         MoveAfterInTabOrder(self, Window win)
9081
9082         Moves this window in the tab navigation order after the specified
9083         sibling window.  This means that when the user presses the TAB key on
9084         that other window, the focus switches to this window.
9085
9086         The default tab order is the same as creation order.  This function
9087         and `MoveBeforeInTabOrder` allow to change it after creating all the
9088         windows.
9089
9090         """
9091         return _core_.Window_MoveAfterInTabOrder(*args, **kwargs)
9092
9093     def MoveBeforeInTabOrder(*args, **kwargs):
9094         """
9095         MoveBeforeInTabOrder(self, Window win)
9096
9097         Same as `MoveAfterInTabOrder` except that it inserts this window just
9098         before win instead of putting it right after it.
9099         """
9100         return _core_.Window_MoveBeforeInTabOrder(*args, **kwargs)
9101
9102     def GetChildren(*args, **kwargs):
9103         """
9104         GetChildren(self) -> PyObject
9105
9106         Returns a list of the window's children.  NOTE: Currently this is a
9107         copy of the child window list maintained by the window, so the return
9108         value of this function is only valid as long as the window's children
9109         do not change.
9110         """
9111         return _core_.Window_GetChildren(*args, **kwargs)
9112
9113     def GetParent(*args, **kwargs):
9114         """
9115         GetParent(self) -> Window
9116
9117         Returns the parent window of this window, or None if there isn't one.
9118         """
9119         return _core_.Window_GetParent(*args, **kwargs)
9120
9121     def GetGrandParent(*args, **kwargs):
9122         """
9123         GetGrandParent(self) -> Window
9124
9125         Returns the parent of the parent of this window, or None if there
9126         isn't one.
9127         """
9128         return _core_.Window_GetGrandParent(*args, **kwargs)
9129
9130     def IsTopLevel(*args, **kwargs):
9131         """
9132         IsTopLevel(self) -> bool
9133
9134         Returns true if the given window is a top-level one. Currently all
9135         frames and dialogs are always considered to be top-level windows (even
9136         if they have a parent window).
9137         """
9138         return _core_.Window_IsTopLevel(*args, **kwargs)
9139
9140     def Reparent(*args, **kwargs):
9141         """
9142         Reparent(self, Window newParent) -> bool
9143
9144         Reparents the window, i.e the window will be removed from its current
9145         parent window (e.g. a non-standard toolbar in a wxFrame) and then
9146         re-inserted into another. Available on Windows and GTK.  Returns True
9147         if the parent was changed, False otherwise (error or newParent ==
9148         oldParent)
9149         """
9150         return _core_.Window_Reparent(*args, **kwargs)
9151
9152     def AddChild(*args, **kwargs):
9153         """
9154         AddChild(self, Window child)
9155
9156         Adds a child window. This is called automatically by window creation
9157         functions so should not be required by the application programmer.
9158         """
9159         return _core_.Window_AddChild(*args, **kwargs)
9160
9161     def RemoveChild(*args, **kwargs):
9162         """
9163         RemoveChild(self, Window child)
9164
9165         Removes a child window. This is called automatically by window
9166         deletion functions so should not be required by the application
9167         programmer.
9168         """
9169         return _core_.Window_RemoveChild(*args, **kwargs)
9170
9171     def SetDoubleBuffered(*args, **kwargs):
9172         """
9173         SetDoubleBuffered(self, bool on)
9174
9175         Currently wxGTK2 only.
9176         """
9177         return _core_.Window_SetDoubleBuffered(*args, **kwargs)
9178
9179     def FindWindowById(*args, **kwargs):
9180         """
9181         FindWindowById(self, long winid) -> Window
9182
9183         Find a chld of this window by window ID
9184         """
9185         return _core_.Window_FindWindowById(*args, **kwargs)
9186
9187     def FindWindowByName(*args, **kwargs):
9188         """
9189         FindWindowByName(self, String name) -> Window
9190
9191         Find a child of this window by name
9192         """
9193         return _core_.Window_FindWindowByName(*args, **kwargs)
9194
9195     def GetEventHandler(*args, **kwargs):
9196         """
9197         GetEventHandler(self) -> EvtHandler
9198
9199         Returns the event handler for this window. By default, the window is
9200         its own event handler.
9201         """
9202         return _core_.Window_GetEventHandler(*args, **kwargs)
9203
9204     def SetEventHandler(*args, **kwargs):
9205         """
9206         SetEventHandler(self, EvtHandler handler)
9207
9208         Sets the event handler for this window.  An event handler is an object
9209         that is capable of processing the events sent to a window.  (In other
9210         words, is able to dispatch the events to handler function.)  By
9211         default, the window is its own event handler, but an application may
9212         wish to substitute another, for example to allow central
9213         implementation of event-handling for a variety of different window
9214         classes.
9215
9216         It is usually better to use `wx.Window.PushEventHandler` since this sets
9217         up a chain of event handlers, where an event not handled by one event
9218         handler is handed off to the next one in the chain.
9219         """
9220         return _core_.Window_SetEventHandler(*args, **kwargs)
9221
9222     def PushEventHandler(*args, **kwargs):
9223         """
9224         PushEventHandler(self, EvtHandler handler)
9225
9226         Pushes this event handler onto the event handler stack for the window.
9227         An event handler is an object that is capable of processing the events
9228         sent to a window.  (In other words, is able to dispatch the events to
9229         handler function.)  By default, the window is its own event handler,
9230         but an application may wish to substitute another, for example to
9231         allow central implementation of event-handling for a variety of
9232         different window classes.
9233
9234         wx.Window.PushEventHandler allows an application to set up a chain of
9235         event handlers, where an event not handled by one event handler is
9236         handed to the next one in the chain.  Use `wx.Window.PopEventHandler`
9237         to remove the event handler.  Ownership of the handler is *not* given
9238         to the window, so you should be sure to pop the handler before the
9239         window is destroyed and either let PopEventHandler destroy it, or call
9240         its Destroy method yourself.
9241         """
9242         return _core_.Window_PushEventHandler(*args, **kwargs)
9243
9244     def PopEventHandler(*args, **kwargs):
9245         """
9246         PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
9247
9248         Removes and returns the top-most event handler on the event handler
9249         stack.  If deleteHandler is True then the wx.EvtHandler object will be
9250         destroyed after it is popped, and ``None`` will be returned instead.
9251         """
9252         return _core_.Window_PopEventHandler(*args, **kwargs)
9253
9254     def RemoveEventHandler(*args, **kwargs):
9255         """
9256         RemoveEventHandler(self, EvtHandler handler) -> bool
9257
9258         Find the given handler in the event handler chain and remove (but not
9259         delete) it from the event handler chain, returns True if it was found
9260         and False otherwise (this also results in an assert failure so this
9261         function should only be called when the handler is supposed to be
9262         there.)
9263         """
9264         return _core_.Window_RemoveEventHandler(*args, **kwargs)
9265
9266     def SetValidator(*args, **kwargs):
9267         """
9268         SetValidator(self, Validator validator)
9269
9270         Deletes the current validator (if any) and sets the window validator,
9271         having called wx.Validator.Clone to create a new validator of this
9272         type.
9273         """
9274         return _core_.Window_SetValidator(*args, **kwargs)
9275
9276     def GetValidator(*args, **kwargs):
9277         """
9278         GetValidator(self) -> Validator
9279
9280         Returns a pointer to the current validator for the window, or None if
9281         there is none.
9282         """
9283         return _core_.Window_GetValidator(*args, **kwargs)
9284
9285     def Validate(*args, **kwargs):
9286         """
9287         Validate(self) -> bool
9288
9289         Validates the current values of the child controls using their
9290         validators.  If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
9291         style flag set, the method will also call Validate() of all child
9292         windows.  Returns false if any of the validations failed.
9293         """
9294         return _core_.Window_Validate(*args, **kwargs)
9295
9296     def TransferDataToWindow(*args, **kwargs):
9297         """
9298         TransferDataToWindow(self) -> bool
9299
9300         Transfers values to child controls from data areas specified by their
9301         validators.  If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
9302         style flag set, the method will also call TransferDataToWindow() of
9303         all child windows.
9304         """
9305         return _core_.Window_TransferDataToWindow(*args, **kwargs)
9306
9307     def TransferDataFromWindow(*args, **kwargs):
9308         """
9309         TransferDataFromWindow(self) -> bool
9310
9311         Transfers values from child controls to data areas specified by their
9312         validators. Returns false if a transfer failed.  If the window has
9313         wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
9314         also call TransferDataFromWindow() of all child windows.
9315         """
9316         return _core_.Window_TransferDataFromWindow(*args, **kwargs)
9317
9318     def InitDialog(*args, **kwargs):
9319         """
9320         InitDialog(self)
9321
9322         Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
9323         to the dialog via validators.
9324         """
9325         return _core_.Window_InitDialog(*args, **kwargs)
9326
9327     def SetAcceleratorTable(*args, **kwargs):
9328         """
9329         SetAcceleratorTable(self, AcceleratorTable accel)
9330
9331         Sets the accelerator table for this window.
9332         """
9333         return _core_.Window_SetAcceleratorTable(*args, **kwargs)
9334
9335     def GetAcceleratorTable(*args, **kwargs):
9336         """
9337         GetAcceleratorTable(self) -> AcceleratorTable
9338
9339         Gets the accelerator table for this window.
9340         """
9341         return _core_.Window_GetAcceleratorTable(*args, **kwargs)
9342
9343     def RegisterHotKey(*args, **kwargs):
9344         """
9345         RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
9346
9347         Registers a system wide hotkey. Every time the user presses the hotkey
9348         registered here, this window will receive a hotkey event. It will
9349         receive the event even if the application is in the background and
9350         does not have the input focus because the user is working with some
9351         other application.  To bind an event handler function to this hotkey
9352         use EVT_HOTKEY with an id equal to hotkeyId.  Returns True if the
9353         hotkey was registered successfully.
9354         """
9355         return _core_.Window_RegisterHotKey(*args, **kwargs)
9356
9357     def UnregisterHotKey(*args, **kwargs):
9358         """
9359         UnregisterHotKey(self, int hotkeyId) -> bool
9360
9361         Unregisters a system wide hotkey.
9362         """
9363         return _core_.Window_UnregisterHotKey(*args, **kwargs)
9364
9365     def ConvertDialogPointToPixels(*args, **kwargs):
9366         """
9367         ConvertDialogPointToPixels(self, Point pt) -> Point
9368
9369         Converts a point or size from dialog units to pixels.  Dialog units
9370         are used for maintaining a dialog's proportions even if the font
9371         changes. For the x dimension, the dialog units are multiplied by the
9372         average character width and then divided by 4. For the y dimension,
9373         the dialog units are multiplied by the average character height and
9374         then divided by 8.
9375         """
9376         return _core_.Window_ConvertDialogPointToPixels(*args, **kwargs)
9377
9378     def ConvertDialogSizeToPixels(*args, **kwargs):
9379         """
9380         ConvertDialogSizeToPixels(self, Size sz) -> Size
9381
9382         Converts a point or size from dialog units to pixels.  Dialog units
9383         are used for maintaining a dialog's proportions even if the font
9384         changes. For the x dimension, the dialog units are multiplied by the
9385         average character width and then divided by 4. For the y dimension,
9386         the dialog units are multiplied by the average character height and
9387         then divided by 8.
9388         """
9389         return _core_.Window_ConvertDialogSizeToPixels(*args, **kwargs)
9390
9391     def DLG_PNT(*args, **kwargs):
9392         """
9393         DLG_PNT(self, Point pt) -> Point
9394
9395         Converts a point or size from dialog units to pixels.  Dialog units
9396         are used for maintaining a dialog's proportions even if the font
9397         changes. For the x dimension, the dialog units are multiplied by the
9398         average character width and then divided by 4. For the y dimension,
9399         the dialog units are multiplied by the average character height and
9400         then divided by 8.
9401         """
9402         return _core_.Window_DLG_PNT(*args, **kwargs)
9403
9404     def DLG_SZE(*args, **kwargs):
9405         """
9406         DLG_SZE(self, Size sz) -> Size
9407
9408         Converts a point or size from dialog units to pixels.  Dialog units
9409         are used for maintaining a dialog's proportions even if the font
9410         changes. For the x dimension, the dialog units are multiplied by the
9411         average character width and then divided by 4. For the y dimension,
9412         the dialog units are multiplied by the average character height and
9413         then divided by 8.
9414         """
9415         return _core_.Window_DLG_SZE(*args, **kwargs)
9416
9417     def ConvertPixelPointToDialog(*args, **kwargs):
9418         """ConvertPixelPointToDialog(self, Point pt) -> Point"""
9419         return _core_.Window_ConvertPixelPointToDialog(*args, **kwargs)
9420
9421     def ConvertPixelSizeToDialog(*args, **kwargs):
9422         """ConvertPixelSizeToDialog(self, Size sz) -> Size"""
9423         return _core_.Window_ConvertPixelSizeToDialog(*args, **kwargs)
9424
9425     def WarpPointer(*args, **kwargs):
9426         """
9427         WarpPointer(self, int x, int y)
9428
9429         Moves the pointer to the given position on the window.
9430
9431         NOTE: This function is not supported under Mac because Apple Human
9432         Interface Guidelines forbid moving the mouse cursor programmatically.
9433         """
9434         return _core_.Window_WarpPointer(*args, **kwargs)
9435
9436     def CaptureMouse(*args, **kwargs):
9437         """
9438         CaptureMouse(self)
9439
9440         Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
9441         release the capture.
9442
9443         Note that wxWindows maintains the stack of windows having captured the
9444         mouse and when the mouse is released the capture returns to the window
9445         which had had captured it previously and it is only really released if
9446         there were no previous window. In particular, this means that you must
9447         release the mouse as many times as you capture it, unless the window
9448         receives the `wx.MouseCaptureLostEvent` event.
9449
9450         Any application which captures the mouse in the beginning of some
9451         operation *must* handle `wx.MouseCaptureLostEvent` and cancel this
9452         operation when it receives the event. The event handler must not
9453         recapture mouse.
9454         """
9455         return _core_.Window_CaptureMouse(*args, **kwargs)
9456
9457     def ReleaseMouse(*args, **kwargs):
9458         """
9459         ReleaseMouse(self)
9460
9461         Releases mouse input captured with wx.Window.CaptureMouse.
9462         """
9463         return _core_.Window_ReleaseMouse(*args, **kwargs)
9464
9465     def GetCapture(*args, **kwargs):
9466         """
9467         GetCapture() -> Window
9468
9469         Returns the window which currently captures the mouse or None
9470         """
9471         return _core_.Window_GetCapture(*args, **kwargs)
9472
9473     GetCapture = staticmethod(GetCapture)
9474     def HasCapture(*args, **kwargs):
9475         """
9476         HasCapture(self) -> bool
9477
9478         Returns true if this window has the current mouse capture.
9479         """
9480         return _core_.Window_HasCapture(*args, **kwargs)
9481
9482     def Refresh(*args, **kwargs):
9483         """
9484         Refresh(self, bool eraseBackground=True, Rect rect=None)
9485
9486         Mark the specified rectangle (or the whole window) as "dirty" so it
9487         will be repainted.  Causes an EVT_PAINT event to be generated and sent
9488         to the window.
9489         """
9490         return _core_.Window_Refresh(*args, **kwargs)
9491
9492     def RefreshRect(*args, **kwargs):
9493         """
9494         RefreshRect(self, Rect rect, bool eraseBackground=True)
9495
9496         Redraws the contents of the given rectangle: the area inside it will
9497         be repainted.  This is the same as Refresh but has a nicer syntax.
9498         """
9499         return _core_.Window_RefreshRect(*args, **kwargs)
9500
9501     def Update(*args, **kwargs):
9502         """
9503         Update(self)
9504
9505         Calling this method immediately repaints the invalidated area of the
9506         window instead of waiting for the EVT_PAINT event to happen, (normally
9507         this would usually only happen when the flow of control returns to the
9508         event loop.)  Notice that this function doesn't refresh the window and
9509         does nothing if the window has been already repainted.  Use `Refresh`
9510         first if you want to immediately redraw the window (or some portion of
9511         it) unconditionally.
9512         """
9513         return _core_.Window_Update(*args, **kwargs)
9514
9515     def ClearBackground(*args, **kwargs):
9516         """
9517         ClearBackground(self)
9518
9519         Clears the window by filling it with the current background
9520         colour. Does not cause an erase background event to be generated.
9521         """
9522         return _core_.Window_ClearBackground(*args, **kwargs)
9523
9524     def Freeze(*args, **kwargs):
9525         """
9526         Freeze(self)
9527
9528         Freezes the window or, in other words, prevents any updates from
9529         taking place on screen, the window is not redrawn at all. Thaw must be
9530         called to reenable window redrawing.  Calls to Freeze/Thaw may be
9531         nested, with the actual Thaw being delayed until all the nesting has
9532         been undone.
9533
9534         This method is useful for visual appearance optimization (for example,
9535         it is a good idea to use it before inserting large amount of text into
9536         a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
9537         for all controls so it is mostly just a hint to wxWindows and not a
9538         mandatory directive.
9539         """
9540         return _core_.Window_Freeze(*args, **kwargs)
9541
9542     def IsFrozen(*args, **kwargs):
9543         """
9544         IsFrozen(self) -> bool
9545
9546         Returns ``True`` if the window has been frozen and not thawed yet.
9547
9548         :see: `Freeze` and `Thaw`
9549         """
9550         return _core_.Window_IsFrozen(*args, **kwargs)
9551
9552     def Thaw(*args, **kwargs):
9553         """
9554         Thaw(self)
9555
9556         Reenables window updating after a previous call to Freeze.  Calls to
9557         Freeze/Thaw may be nested, so Thaw must be called the same number of
9558         times that Freeze was before the window will be updated.
9559         """
9560         return _core_.Window_Thaw(*args, **kwargs)
9561
9562     def PrepareDC(*args, **kwargs):
9563         """
9564         PrepareDC(self, DC dc)
9565
9566         Call this function to prepare the device context for drawing a
9567         scrolled image. It sets the device origin according to the current
9568         scroll position.
9569         """
9570         return _core_.Window_PrepareDC(*args, **kwargs)
9571
9572     def IsDoubleBuffered(*args, **kwargs):
9573         """
9574         IsDoubleBuffered(self) -> bool
9575
9576         Returns ``True`` if the window contents is double-buffered by the
9577         system, i.e. if any drawing done on the window is really done on a
9578         temporary backing surface and transferred to the screen all at once
9579         later.
9580         """
9581         return _core_.Window_IsDoubleBuffered(*args, **kwargs)
9582
9583     def GetUpdateRegion(*args, **kwargs):
9584         """
9585         GetUpdateRegion(self) -> Region
9586
9587         Returns the region specifying which parts of the window have been
9588         damaged. Should only be called within an EVT_PAINT handler.
9589         """
9590         return _core_.Window_GetUpdateRegion(*args, **kwargs)
9591
9592     def GetUpdateClientRect(*args, **kwargs):
9593         """
9594         GetUpdateClientRect(self) -> Rect
9595
9596         Get the update rectangle region bounding box in client coords.
9597         """
9598         return _core_.Window_GetUpdateClientRect(*args, **kwargs)
9599
9600     def IsExposed(*args, **kwargs):
9601         """
9602         IsExposed(self, int x, int y, int w=1, int h=1) -> bool
9603
9604         Returns true if the given point or rectangle area has been exposed
9605         since the last repaint. Call this in an paint event handler to
9606         optimize redrawing by only redrawing those areas, which have been
9607         exposed.
9608         """
9609         return _core_.Window_IsExposed(*args, **kwargs)
9610
9611     def IsExposedPoint(*args, **kwargs):
9612         """
9613         IsExposedPoint(self, Point pt) -> bool
9614
9615         Returns true if the given point or rectangle area has been exposed
9616         since the last repaint. Call this in an paint event handler to
9617         optimize redrawing by only redrawing those areas, which have been
9618         exposed.
9619         """
9620         return _core_.Window_IsExposedPoint(*args, **kwargs)
9621
9622     def IsExposedRect(*args, **kwargs):
9623         """
9624         IsExposedRect(self, Rect rect) -> bool
9625
9626         Returns true if the given point or rectangle area has been exposed
9627         since the last repaint. Call this in an paint event handler to
9628         optimize redrawing by only redrawing those areas, which have been
9629         exposed.
9630         """
9631         return _core_.Window_IsExposedRect(*args, **kwargs)
9632
9633     def GetDefaultAttributes(*args, **kwargs):
9634         """
9635         GetDefaultAttributes(self) -> VisualAttributes
9636
9637         Get the default attributes for an instance of this class.  This is
9638         useful if you want to use the same font or colour in your own control
9639         as in a standard control -- which is a much better idea than hard
9640         coding specific colours or fonts which might look completely out of
9641         place on the user's system, especially if it uses themes.
9642         """
9643         return _core_.Window_GetDefaultAttributes(*args, **kwargs)
9644
9645     def GetClassDefaultAttributes(*args, **kwargs):
9646         """
9647         GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
9648
9649         Get the default attributes for this class.  This is useful if you want
9650         to use the same font or colour in your own control as in a standard
9651         control -- which is a much better idea than hard coding specific
9652         colours or fonts which might look completely out of place on the
9653         user's system, especially if it uses themes.
9654
9655         The variant parameter is only relevant under Mac currently and is
9656         ignore under other platforms. Under Mac, it will change the size of
9657         the returned font. See `wx.Window.SetWindowVariant` for more about
9658         this.
9659         """
9660         return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
9661
9662     GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
9663     def SetBackgroundColour(*args, **kwargs):
9664         """
9665         SetBackgroundColour(self, Colour colour) -> bool
9666
9667         Sets the background colour of the window.  Returns True if the colour
9668         was changed.  The background colour is usually painted by the default
9669         EVT_ERASE_BACKGROUND event handler function under Windows and
9670         automatically under GTK.  Using `wx.NullColour` will reset the window
9671         to the default background colour.
9672
9673         Note that setting the background colour may not cause an immediate
9674         refresh, so you may wish to call `ClearBackground` or `Refresh` after
9675         calling this function.
9676
9677         Using this function will disable attempts to use themes for this
9678         window, if the system supports them.  Use with care since usually the
9679         themes represent the appearance chosen by the user to be used for all
9680         applications on the system.
9681         """
9682         return _core_.Window_SetBackgroundColour(*args, **kwargs)
9683
9684     def SetOwnBackgroundColour(*args, **kwargs):
9685         """SetOwnBackgroundColour(self, Colour colour)"""
9686         return _core_.Window_SetOwnBackgroundColour(*args, **kwargs)
9687
9688     def SetForegroundColour(*args, **kwargs):
9689         """
9690         SetForegroundColour(self, Colour colour) -> bool
9691
9692         Sets the foreground colour of the window.  Returns True is the colour
9693         was changed.  The interpretation of foreground colour is dependent on
9694         the window class; it may be the text colour or other colour, or it may
9695         not be used at all.
9696         """
9697         return _core_.Window_SetForegroundColour(*args, **kwargs)
9698
9699     def SetOwnForegroundColour(*args, **kwargs):
9700         """SetOwnForegroundColour(self, Colour colour)"""
9701         return _core_.Window_SetOwnForegroundColour(*args, **kwargs)
9702
9703     def GetBackgroundColour(*args, **kwargs):
9704         """
9705         GetBackgroundColour(self) -> Colour
9706
9707         Returns the background colour of the window.
9708         """
9709         return _core_.Window_GetBackgroundColour(*args, **kwargs)
9710
9711     def GetForegroundColour(*args, **kwargs):
9712         """
9713         GetForegroundColour(self) -> Colour
9714
9715         Returns the foreground colour of the window.  The interpretation of
9716         foreground colour is dependent on the window class; it may be the text
9717         colour or other colour, or it may not be used at all.
9718         """
9719         return _core_.Window_GetForegroundColour(*args, **kwargs)
9720
9721     def InheritsBackgroundColour(*args, **kwargs):
9722         """InheritsBackgroundColour(self) -> bool"""
9723         return _core_.Window_InheritsBackgroundColour(*args, **kwargs)
9724
9725     def UseBgCol(*args, **kwargs):
9726         """UseBgCol(self) -> bool"""
9727         return _core_.Window_UseBgCol(*args, **kwargs)
9728
9729     def SetBackgroundStyle(*args, **kwargs):
9730         """
9731         SetBackgroundStyle(self, int style) -> bool
9732
9733         Returns the background style of the window. The background style
9734         indicates how the background of the window is drawn.
9735
9736             ======================  ========================================
9737             wx.BG_STYLE_SYSTEM      The background colour or pattern should
9738                                     be determined by the system
9739             wx.BG_STYLE_COLOUR      The background should be a solid colour
9740             wx.BG_STYLE_CUSTOM      The background will be implemented by the
9741                                     application.
9742             ======================  ========================================
9743
9744         On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
9745         a custom background, such as a tiled bitmap. Currently the style has
9746         no effect on other platforms.
9747
9748         :see: `GetBackgroundStyle`, `SetBackgroundColour`
9749         """
9750         return _core_.Window_SetBackgroundStyle(*args, **kwargs)
9751
9752     def GetBackgroundStyle(*args, **kwargs):
9753         """
9754         GetBackgroundStyle(self) -> int
9755
9756         Returns the background style of the window.
9757
9758         :see: `SetBackgroundStyle`
9759         """
9760         return _core_.Window_GetBackgroundStyle(*args, **kwargs)
9761
9762     def HasTransparentBackground(*args, **kwargs):
9763         """
9764         HasTransparentBackground(self) -> bool
9765
9766         Returns True if this window's background is transparent (as, for
9767         example, for `wx.StaticText`) and should show the parent window's
9768         background.
9769
9770         This method is mostly used internally by the library itself and you
9771         normally shouldn't have to call it. You may, however, have to override
9772         it in your custom control classes to ensure that background is painted
9773         correctly.
9774         """
9775         return _core_.Window_HasTransparentBackground(*args, **kwargs)
9776
9777     def SetCursor(*args, **kwargs):
9778         """
9779         SetCursor(self, Cursor cursor) -> bool
9780
9781         Sets the window's cursor. Notice that the window cursor also sets it
9782         for the children of the window implicitly.
9783
9784         The cursor may be wx.NullCursor in which case the window cursor will
9785         be reset back to default.
9786         """
9787         return _core_.Window_SetCursor(*args, **kwargs)
9788
9789     def GetCursor(*args, **kwargs):
9790         """
9791         GetCursor(self) -> Cursor
9792
9793         Return the cursor associated with this window.
9794         """
9795         return _core_.Window_GetCursor(*args, **kwargs)
9796
9797     def SetFont(*args, **kwargs):
9798         """
9799         SetFont(self, Font font) -> bool
9800
9801         Sets the font for this window.
9802         """
9803         return _core_.Window_SetFont(*args, **kwargs)
9804
9805     def SetOwnFont(*args, **kwargs):
9806         """SetOwnFont(self, Font font)"""
9807         return _core_.Window_SetOwnFont(*args, **kwargs)
9808
9809     def GetFont(*args, **kwargs):
9810         """
9811         GetFont(self) -> Font
9812
9813         Returns the default font used for this window.
9814         """
9815         return _core_.Window_GetFont(*args, **kwargs)
9816
9817     def SetCaret(*args, **kwargs):
9818         """
9819         SetCaret(self, Caret caret)
9820
9821         Sets the caret associated with the window.
9822         """
9823         return _core_.Window_SetCaret(*args, **kwargs)
9824
9825     def GetCaret(*args, **kwargs):
9826         """
9827         GetCaret(self) -> Caret
9828
9829         Returns the caret associated with the window.
9830         """
9831         return _core_.Window_GetCaret(*args, **kwargs)
9832
9833     def GetCharHeight(*args, **kwargs):
9834         """
9835         GetCharHeight(self) -> int
9836
9837         Get the (average) character size for the current font.
9838         """
9839         return _core_.Window_GetCharHeight(*args, **kwargs)
9840
9841     def GetCharWidth(*args, **kwargs):
9842         """
9843         GetCharWidth(self) -> int
9844
9845         Get the (average) character size for the current font.
9846         """
9847         return _core_.Window_GetCharWidth(*args, **kwargs)
9848
9849     def GetTextExtent(*args, **kwargs):
9850         """
9851         GetTextExtent(String string) -> (width, height)
9852
9853         Get the width and height of the text using the current font.
9854         """
9855         return _core_.Window_GetTextExtent(*args, **kwargs)
9856
9857     def GetFullTextExtent(*args, **kwargs):
9858         """
9859         GetFullTextExtent(String string, Font font=None) ->
9860            (width, height, descent, externalLeading)
9861
9862         Get the width, height, decent and leading of the text using the
9863         current or specified font.
9864         """
9865         return _core_.Window_GetFullTextExtent(*args, **kwargs)
9866
9867     def ClientToScreenXY(*args, **kwargs):
9868         """
9869         ClientToScreenXY(int x, int y) -> (x,y)
9870
9871         Converts to screen coordinates from coordinates relative to this window.
9872         """
9873         return _core_.Window_ClientToScreenXY(*args, **kwargs)
9874
9875     def ScreenToClientXY(*args, **kwargs):
9876         """
9877         ScreenToClientXY(int x, int y) -> (x,y)
9878
9879         Converts from screen to client window coordinates.
9880         """
9881         return _core_.Window_ScreenToClientXY(*args, **kwargs)
9882
9883     def ClientToScreen(*args, **kwargs):
9884         """
9885         ClientToScreen(self, Point pt) -> Point
9886
9887         Converts to screen coordinates from coordinates relative to this window.
9888         """
9889         return _core_.Window_ClientToScreen(*args, **kwargs)
9890
9891     def ScreenToClient(*args, **kwargs):
9892         """
9893         ScreenToClient(self, Point pt) -> Point
9894
9895         Converts from screen to client window coordinates.
9896         """
9897         return _core_.Window_ScreenToClient(*args, **kwargs)
9898
9899     def HitTestXY(*args, **kwargs):
9900         """
9901         HitTestXY(self, int x, int y) -> int
9902
9903         Test where the given (in client coords) point lies
9904         """
9905         return _core_.Window_HitTestXY(*args, **kwargs)
9906
9907     def HitTest(*args, **kwargs):
9908         """
9909         HitTest(self, Point pt) -> int
9910
9911         Test where the given (in client coords) point lies
9912         """
9913         return _core_.Window_HitTest(*args, **kwargs)
9914
9915     def GetBorder(*args):
9916         """
9917         GetBorder(self, long flags) -> int
9918         GetBorder(self) -> int
9919
9920         Get border for the flags of this window
9921         """
9922         return _core_.Window_GetBorder(*args)
9923
9924     def UpdateWindowUI(*args, **kwargs):
9925         """
9926         UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
9927
9928         This function sends EVT_UPDATE_UI events to the window. The particular
9929         implementation depends on the window; for example a wx.ToolBar will
9930         send an update UI event for each toolbar button, and a wx.Frame will
9931         send an update UI event for each menubar menu item. You can call this
9932         function from your application to ensure that your UI is up-to-date at
9933         a particular point in time (as far as your EVT_UPDATE_UI handlers are
9934         concerned). This may be necessary if you have called
9935         `wx.UpdateUIEvent.SetMode` or `wx.UpdateUIEvent.SetUpdateInterval` to
9936         limit the overhead that wxWindows incurs by sending update UI events
9937         in idle time.
9938         """
9939         return _core_.Window_UpdateWindowUI(*args, **kwargs)
9940
9941     def PopupMenuXY(*args, **kwargs):
9942         """
9943         PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
9944
9945         Pops up the given menu at the specified coordinates, relative to this window,
9946         and returns control when the user has dismissed the menu. If a menu item is
9947         selected, the corresponding menu event is generated and will be processed as
9948         usual.  If the default position is given then the current position of the
9949         mouse cursor will be used.
9950         """
9951         return _core_.Window_PopupMenuXY(*args, **kwargs)
9952
9953     def PopupMenu(*args, **kwargs):
9954         """
9955         PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
9956
9957         Pops up the given menu at the specified coordinates, relative to this window,
9958         and returns control when the user has dismissed the menu. If a menu item is
9959         selected, the corresponding menu event is generated and will be processed as
9960         usual.  If the default position is given then the current position of the
9961         mouse cursor will be used.
9962         """
9963         return _core_.Window_PopupMenu(*args, **kwargs)
9964
9965     def HasMultiplePages(*args, **kwargs):
9966         """HasMultiplePages(self) -> bool"""
9967         return _core_.Window_HasMultiplePages(*args, **kwargs)
9968
9969     def GetHandle(*args, **kwargs):
9970         """
9971         GetHandle(self) -> long
9972
9973         Returns the platform-specific handle (as a long integer) of the
9974         physical window.  Currently on wxMac it returns the handle of the
9975         toplevel parent of the window.
9976         """
9977         return _core_.Window_GetHandle(*args, **kwargs)
9978
9979     def AssociateHandle(*args, **kwargs):
9980         """
9981         AssociateHandle(self, long handle)
9982
9983         Associate the window with a new native handle
9984         """
9985         return _core_.Window_AssociateHandle(*args, **kwargs)
9986
9987     def DissociateHandle(*args, **kwargs):
9988         """
9989         DissociateHandle(self)
9990
9991         Dissociate the current native handle from the window
9992         """
9993         return _core_.Window_DissociateHandle(*args, **kwargs)
9994
9995     def HasScrollbar(*args, **kwargs):
9996         """
9997         HasScrollbar(self, int orient) -> bool
9998
9999         Does the window have the scrollbar for this orientation?
10000         """
10001         return _core_.Window_HasScrollbar(*args, **kwargs)
10002
10003     def SetScrollbar(*args, **kwargs):
10004         """
10005         SetScrollbar(self, int orientation, int position, int thumbSize, int range,
10006             bool refresh=True)
10007
10008         Sets the scrollbar properties of a built-in scrollbar.
10009         """
10010         return _core_.Window_SetScrollbar(*args, **kwargs)
10011
10012     def SetScrollPos(*args, **kwargs):
10013         """
10014         SetScrollPos(self, int orientation, int pos, bool refresh=True)
10015
10016         Sets the position of one of the built-in scrollbars.
10017         """
10018         return _core_.Window_SetScrollPos(*args, **kwargs)
10019
10020     def GetScrollPos(*args, **kwargs):
10021         """
10022         GetScrollPos(self, int orientation) -> int
10023
10024         Returns the built-in scrollbar position.
10025         """
10026         return _core_.Window_GetScrollPos(*args, **kwargs)
10027
10028     def GetScrollThumb(*args, **kwargs):
10029         """
10030         GetScrollThumb(self, int orientation) -> int
10031
10032         Returns the built-in scrollbar thumb size.
10033         """
10034         return _core_.Window_GetScrollThumb(*args, **kwargs)
10035
10036     def GetScrollRange(*args, **kwargs):
10037         """
10038         GetScrollRange(self, int orientation) -> int
10039
10040         Returns the built-in scrollbar range.
10041         """
10042         return _core_.Window_GetScrollRange(*args, **kwargs)
10043
10044     def ScrollWindow(*args, **kwargs):
10045         """
10046         ScrollWindow(self, int dx, int dy, Rect rect=None)
10047
10048         Physically scrolls the pixels in the window and move child windows
10049         accordingly.  Use this function to optimise your scrolling
10050         implementations, to minimise the area that must be redrawn. Note that
10051         it is rarely required to call this function from a user program.
10052         """
10053         return _core_.Window_ScrollWindow(*args, **kwargs)
10054
10055     def ScrollLines(*args, **kwargs):
10056         """
10057         ScrollLines(self, int lines) -> bool
10058
10059         If the platform and window class supports it, scrolls the window by
10060         the given number of lines down, if lines is positive, or up if lines
10061         is negative.  Returns True if the window was scrolled, False if it was
10062         already on top/bottom and nothing was done.
10063         """
10064         return _core_.Window_ScrollLines(*args, **kwargs)
10065
10066     def ScrollPages(*args, **kwargs):
10067         """
10068         ScrollPages(self, int pages) -> bool
10069
10070         If the platform and window class supports it, scrolls the window by
10071         the given number of pages down, if pages is positive, or up if pages
10072         is negative.  Returns True if the window was scrolled, False if it was
10073         already on top/bottom and nothing was done.
10074         """
10075         return _core_.Window_ScrollPages(*args, **kwargs)
10076
10077     def LineUp(*args, **kwargs):
10078         """
10079         LineUp(self) -> bool
10080
10081         This is just a wrapper for ScrollLines(-1).
10082         """
10083         return _core_.Window_LineUp(*args, **kwargs)
10084
10085     def LineDown(*args, **kwargs):
10086         """
10087         LineDown(self) -> bool
10088
10089         This is just a wrapper for ScrollLines(1).
10090         """
10091         return _core_.Window_LineDown(*args, **kwargs)
10092
10093     def PageUp(*args, **kwargs):
10094         """
10095         PageUp(self) -> bool
10096
10097         This is just a wrapper for ScrollPages(-1).
10098         """
10099         return _core_.Window_PageUp(*args, **kwargs)
10100
10101     def PageDown(*args, **kwargs):
10102         """
10103         PageDown(self) -> bool
10104
10105         This is just a wrapper for ScrollPages(1).
10106         """
10107         return _core_.Window_PageDown(*args, **kwargs)
10108
10109     def SetHelpText(*args, **kwargs):
10110         """
10111         SetHelpText(self, String text)
10112
10113         Sets the help text to be used as context-sensitive help for this
10114         window.  Note that the text is actually stored by the current
10115         `wx.HelpProvider` implementation, and not in the window object itself.
10116         """
10117         return _core_.Window_SetHelpText(*args, **kwargs)
10118
10119     def SetHelpTextForId(*args, **kwargs):
10120         """
10121         SetHelpTextForId(self, String text)
10122
10123         Associate this help text with all windows with the same id as this
10124         one.
10125         """
10126         return _core_.Window_SetHelpTextForId(*args, **kwargs)
10127
10128     def GetHelpTextAtPoint(*args, **kwargs):
10129         """
10130         GetHelpTextAtPoint(self, Point pt, wxHelpEvent::Origin origin) -> String
10131
10132         Get the help string associated with the given position in this window.
10133
10134         Notice that pt may be invalid if event origin is keyboard or unknown
10135         and this method should return the global window help text then
10136
10137         """
10138         return _core_.Window_GetHelpTextAtPoint(*args, **kwargs)
10139
10140     def GetHelpText(*args, **kwargs):
10141         """
10142         GetHelpText(self) -> String
10143
10144         Gets the help text to be used as context-sensitive help for this
10145         window.  Note that the text is actually stored by the current
10146         `wx.HelpProvider` implementation, and not in the window object itself.
10147         """
10148         return _core_.Window_GetHelpText(*args, **kwargs)
10149
10150     def SetToolTipString(*args, **kwargs):
10151         """
10152         SetToolTipString(self, String tip)
10153
10154         Attach a tooltip to the window.
10155         """
10156         return _core_.Window_SetToolTipString(*args, **kwargs)
10157
10158     def SetToolTip(*args, **kwargs):
10159         """
10160         SetToolTip(self, ToolTip tip)
10161
10162         Attach a tooltip to the window.
10163         """
10164         return _core_.Window_SetToolTip(*args, **kwargs)
10165
10166     def GetToolTip(*args, **kwargs):
10167         """
10168         GetToolTip(self) -> ToolTip
10169
10170         get the associated tooltip or None if none
10171         """
10172         return _core_.Window_GetToolTip(*args, **kwargs)
10173
10174     def SetDropTarget(*args, **kwargs):
10175         """
10176         SetDropTarget(self, DropTarget dropTarget)
10177
10178         Associates a drop target with this window.  If the window already has
10179         a drop target, it is deleted.
10180         """
10181         return _core_.Window_SetDropTarget(*args, **kwargs)
10182
10183     def GetDropTarget(*args, **kwargs):
10184         """
10185         GetDropTarget(self) -> DropTarget
10186
10187         Returns the associated drop target, which may be None.
10188         """
10189         return _core_.Window_GetDropTarget(*args, **kwargs)
10190
10191     def DragAcceptFiles(*args, **kwargs):
10192         """
10193         DragAcceptFiles(self, bool accept)
10194
10195         Enables or disables eligibility for drop file events, EVT_DROP_FILES.
10196         Only functional on Windows.
10197         """
10198         return _core_.Window_DragAcceptFiles(*args, **kwargs)
10199
10200     def SetConstraints(*args, **kwargs):
10201         """
10202         SetConstraints(self, LayoutConstraints constraints)
10203
10204         Sets the window to have the given layout constraints. If an existing
10205         layout constraints object is already owned by the window, it will be
10206         deleted.  Pass None to disassociate and delete the window's current
10207         constraints.
10208
10209         You must call SetAutoLayout to tell a window to use the constraints
10210         automatically in its default EVT_SIZE handler; otherwise, you must
10211         handle EVT_SIZE yourself and call Layout() explicitly. When setting
10212         both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
10213         effect.
10214         """
10215         return _core_.Window_SetConstraints(*args, **kwargs)
10216
10217     def GetConstraints(*args, **kwargs):
10218         """
10219         GetConstraints(self) -> LayoutConstraints
10220
10221         Returns a pointer to the window's layout constraints, or None if there
10222         are none.
10223         """
10224         return _core_.Window_GetConstraints(*args, **kwargs)
10225
10226     def SetAutoLayout(*args, **kwargs):
10227         """
10228         SetAutoLayout(self, bool autoLayout)
10229
10230         Determines whether the Layout function will be called automatically
10231         when the window is resized.  lease note that this only happens for the
10232         windows usually used to contain children, namely `wx.Panel` and
10233         `wx.TopLevelWindow` (and the classes deriving from them).
10234
10235         This method is called implicitly by `SetSizer` but if you use
10236         `SetConstraints` you should call it manually or otherwise the window
10237         layout won't be correctly updated when its size changes.
10238         """
10239         return _core_.Window_SetAutoLayout(*args, **kwargs)
10240
10241     def GetAutoLayout(*args, **kwargs):
10242         """
10243         GetAutoLayout(self) -> bool
10244
10245         Returns the current autoLayout setting
10246         """
10247         return _core_.Window_GetAutoLayout(*args, **kwargs)
10248
10249     def Layout(*args, **kwargs):
10250         """
10251         Layout(self) -> bool
10252
10253         Invokes the constraint-based layout algorithm or the sizer-based
10254         algorithm for this window.  See SetAutoLayout: when auto layout is on,
10255         this function gets called automatically by the default EVT_SIZE
10256         handler when the window is resized.
10257         """
10258         return _core_.Window_Layout(*args, **kwargs)
10259
10260     def SetSizer(*args, **kwargs):
10261         """
10262         SetSizer(self, Sizer sizer, bool deleteOld=True)
10263
10264         Sets the window to have the given layout sizer. The window will then
10265         own the object, and will take care of its deletion. If an existing
10266         layout sizer object is already owned by the window, it will be deleted
10267         if the deleteOld parameter is true. Note that this function will also
10268         call SetAutoLayout implicitly with a True parameter if the sizer is
10269         non-None, and False otherwise.
10270         """
10271         return _core_.Window_SetSizer(*args, **kwargs)
10272
10273     def SetSizerAndFit(*args, **kwargs):
10274         """
10275         SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
10276
10277         The same as SetSizer, except it also sets the size hints for the
10278         window based on the sizer's minimum size.
10279         """
10280         return _core_.Window_SetSizerAndFit(*args, **kwargs)
10281
10282     def GetSizer(*args, **kwargs):
10283         """
10284         GetSizer(self) -> Sizer
10285
10286         Return the sizer associated with the window by a previous call to
10287         SetSizer or None if there isn't one.
10288         """
10289         return _core_.Window_GetSizer(*args, **kwargs)
10290
10291     def SetContainingSizer(*args, **kwargs):
10292         """
10293         SetContainingSizer(self, Sizer sizer)
10294
10295         This normally does not need to be called by application code. It is
10296         called internally when a window is added to a sizer, and is used so
10297         the window can remove itself from the sizer when it is destroyed.
10298         """
10299         return _core_.Window_SetContainingSizer(*args, **kwargs)
10300
10301     def GetContainingSizer(*args, **kwargs):
10302         """
10303         GetContainingSizer(self) -> Sizer
10304
10305         Return the sizer that this window is a member of, if any, otherwise None.
10306         """
10307         return _core_.Window_GetContainingSizer(*args, **kwargs)
10308
10309     def InheritAttributes(*args, **kwargs):
10310         """
10311         InheritAttributes(self)
10312
10313         This function is (or should be, in case of custom controls) called
10314         during window creation to intelligently set up the window visual
10315         attributes, that is the font and the foreground and background
10316         colours.
10317
10318         By 'intelligently' the following is meant: by default, all windows use
10319         their own default attributes. However if some of the parent's
10320         attributes are explicitly changed (that is, using SetFont and not
10321         SetOwnFont) and if the corresponding attribute hadn't been
10322         explicitly set for this window itself, then this window takes the same
10323         value as used by the parent. In addition, if the window overrides
10324         ShouldInheritColours to return false, the colours will not be changed
10325         no matter what and only the font might.
10326
10327         This rather complicated logic is necessary in order to accommodate the
10328         different usage scenarios. The most common one is when all default
10329         attributes are used and in this case, nothing should be inherited as
10330         in modern GUIs different controls use different fonts (and colours)
10331         than their siblings so they can't inherit the same value from the
10332         parent. However it was also deemed desirable to allow to simply change
10333         the attributes of all children at once by just changing the font or
10334         colour of their common parent, hence in this case we do inherit the
10335         parents attributes.
10336
10337         """
10338         return _core_.Window_InheritAttributes(*args, **kwargs)
10339
10340     def ShouldInheritColours(*args, **kwargs):
10341         """
10342         ShouldInheritColours(self) -> bool
10343
10344         Return true from here to allow the colours of this window to be
10345         changed by InheritAttributes, returning false forbids inheriting them
10346         from the parent window.
10347
10348         The base class version returns false, but this method is overridden in
10349         wxControl where it returns true.
10350         """
10351         return _core_.Window_ShouldInheritColours(*args, **kwargs)
10352
10353     def CanSetTransparent(*args, **kwargs):
10354         """
10355         CanSetTransparent(self) -> bool
10356
10357         Returns ``True`` if the platform supports setting the transparency for
10358         this window.  Note that this method will err on the side of caution,
10359         so it is possible that this will return ``False`` when it is in fact
10360         possible to set the transparency.
10361
10362         NOTE: On X-windows systems the X server must have the composite
10363         extension loaded, and there must be a composite manager program (such
10364         as xcompmgr) running.
10365         """
10366         return _core_.Window_CanSetTransparent(*args, **kwargs)
10367
10368     def SetTransparent(*args, **kwargs):
10369         """
10370         SetTransparent(self, byte alpha) -> bool
10371
10372         Attempt to set the transparency of this window to the ``alpha`` value,
10373         returns True on success.  The ``alpha`` value is an integer in the
10374         range of 0 to 255, where 0 is fully transparent and 255 is fully
10375         opaque.
10376         """
10377         return _core_.Window_SetTransparent(*args, **kwargs)
10378
10379     def PostCreate(self, pre):
10380         """
10381         Phase 3 of the 2-phase create <wink!>
10382         Call this method after precreating the window with the 2-phase create method.
10383         """
10384         self.this = pre.this
10385         self.thisown = pre.thisown
10386         pre.thisown = 0
10387         if hasattr(self, '_setOORInfo'):
10388             try:
10389                 self._setOORInfo(self)
10390             except TypeError:
10391                 pass
10392         if hasattr(self, '_setCallbackInfo'):
10393             try:
10394                 self._setCallbackInfo(self, pre.__class__)
10395             except TypeError:
10396                 pass
10397
10398     def SendSizeEvent(self):
10399         self.GetEventHandler().ProcessEvent(wx.SizeEvent((-1,-1)))
10400
10401     AcceleratorTable = property(GetAcceleratorTable,SetAcceleratorTable,doc="See `GetAcceleratorTable` and `SetAcceleratorTable`")
10402     AutoLayout = property(GetAutoLayout,SetAutoLayout,doc="See `GetAutoLayout` and `SetAutoLayout`")
10403     BackgroundColour = property(GetBackgroundColour,SetBackgroundColour,doc="See `GetBackgroundColour` and `SetBackgroundColour`")
10404     BackgroundStyle = property(GetBackgroundStyle,SetBackgroundStyle,doc="See `GetBackgroundStyle` and `SetBackgroundStyle`")
10405     EffectiveMinSize = property(GetEffectiveMinSize,doc="See `GetEffectiveMinSize`")
10406     BestSize = property(GetBestSize,doc="See `GetBestSize`")
10407     BestVirtualSize = property(GetBestVirtualSize,doc="See `GetBestVirtualSize`")
10408     Border = property(GetBorder,doc="See `GetBorder`")
10409     Caret = property(GetCaret,SetCaret,doc="See `GetCaret` and `SetCaret`")
10410     CharHeight = property(GetCharHeight,doc="See `GetCharHeight`")
10411     CharWidth = property(GetCharWidth,doc="See `GetCharWidth`")
10412     Children = property(GetChildren,doc="See `GetChildren`")
10413     ClientAreaOrigin = property(GetClientAreaOrigin,doc="See `GetClientAreaOrigin`")
10414     ClientRect = property(GetClientRect,SetClientRect,doc="See `GetClientRect` and `SetClientRect`")
10415     ClientSize = property(GetClientSize,SetClientSize,doc="See `GetClientSize` and `SetClientSize`")
10416     Constraints = property(GetConstraints,SetConstraints,doc="See `GetConstraints` and `SetConstraints`")
10417     ContainingSizer = property(GetContainingSizer,SetContainingSizer,doc="See `GetContainingSizer` and `SetContainingSizer`")
10418     Cursor = property(GetCursor,SetCursor,doc="See `GetCursor` and `SetCursor`")
10419     DefaultAttributes = property(GetDefaultAttributes,doc="See `GetDefaultAttributes`")
10420     DropTarget = property(GetDropTarget,SetDropTarget,doc="See `GetDropTarget` and `SetDropTarget`")
10421     EventHandler = property(GetEventHandler,SetEventHandler,doc="See `GetEventHandler` and `SetEventHandler`")
10422     ExtraStyle = property(GetExtraStyle,SetExtraStyle,doc="See `GetExtraStyle` and `SetExtraStyle`")
10423     Font = property(GetFont,SetFont,doc="See `GetFont` and `SetFont`")
10424     ForegroundColour = property(GetForegroundColour,SetForegroundColour,doc="See `GetForegroundColour` and `SetForegroundColour`")
10425     GrandParent = property(GetGrandParent,doc="See `GetGrandParent`")
10426     Handle = property(GetHandle,doc="See `GetHandle`")
10427     HelpText = property(GetHelpText,SetHelpText,doc="See `GetHelpText` and `SetHelpText`")
10428     Id = property(GetId,SetId,doc="See `GetId` and `SetId`")
10429     Label = property(GetLabel,SetLabel,doc="See `GetLabel` and `SetLabel`")
10430     LayoutDirection = property(GetLayoutDirection,SetLayoutDirection,doc="See `GetLayoutDirection` and `SetLayoutDirection`")
10431     MaxHeight = property(GetMaxHeight,doc="See `GetMaxHeight`")
10432     MaxSize = property(GetMaxSize,SetMaxSize,doc="See `GetMaxSize` and `SetMaxSize`")
10433     MaxWidth = property(GetMaxWidth,doc="See `GetMaxWidth`")
10434     MinHeight = property(GetMinHeight,doc="See `GetMinHeight`")
10435     MinSize = property(GetMinSize,SetMinSize,doc="See `GetMinSize` and `SetMinSize`")
10436     MinWidth = property(GetMinWidth,doc="See `GetMinWidth`")
10437     Name = property(GetName,SetName,doc="See `GetName` and `SetName`")
10438     Parent = property(GetParent,doc="See `GetParent`")
10439     Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
10440     Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`")
10441     ScreenPosition = property(GetScreenPosition,doc="See `GetScreenPosition`")
10442     ScreenRect = property(GetScreenRect,doc="See `GetScreenRect`")
10443     Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`")
10444     Sizer = property(GetSizer,SetSizer,doc="See `GetSizer` and `SetSizer`")
10445     ThemeEnabled = property(GetThemeEnabled,SetThemeEnabled,doc="See `GetThemeEnabled` and `SetThemeEnabled`")
10446     ToolTip = property(GetToolTip,SetToolTip,doc="See `GetToolTip` and `SetToolTip`")
10447     UpdateClientRect = property(GetUpdateClientRect,doc="See `GetUpdateClientRect`")
10448     UpdateRegion = property(GetUpdateRegion,doc="See `GetUpdateRegion`")
10449     Validator = property(GetValidator,SetValidator,doc="See `GetValidator` and `SetValidator`")
10450     VirtualSize = property(GetVirtualSize,SetVirtualSize,doc="See `GetVirtualSize` and `SetVirtualSize`")
10451     WindowStyle = property(GetWindowStyle,SetWindowStyle,doc="See `GetWindowStyle` and `SetWindowStyle`")
10452     WindowStyleFlag = property(GetWindowStyleFlag,SetWindowStyleFlag,doc="See `GetWindowStyleFlag` and `SetWindowStyleFlag`")
10453     WindowVariant = property(GetWindowVariant,SetWindowVariant,doc="See `GetWindowVariant` and `SetWindowVariant`")
10454     Shown = property(IsShown,Show,doc="See `IsShown` and `Show`")
10455     Enabled = property(IsEnabled,Enable,doc="See `IsEnabled` and `Enable`")
10456     TopLevel = property(IsTopLevel,doc="See `IsTopLevel`")
10457 _core_.Window_swigregister(Window)
10458
10459 def PreWindow(*args, **kwargs):
10460     """
10461     PreWindow() -> Window
10462
10463     Precreate a Window for 2-phase creation.
10464     """
10465     val = _core_.new_PreWindow(*args, **kwargs)
10466     return val
10467
10468 def Window_NewControlId(*args):
10469   """
10470     Window_NewControlId() -> int
10471
10472     Generate a control id for the controls which were not given one.
10473     """
10474   return _core_.Window_NewControlId(*args)
10475
10476 def Window_NextControlId(*args, **kwargs):
10477   """
10478     Window_NextControlId(int winid) -> int
10479
10480     Get the id of the control following the one with the given
10481     autogenerated) id
10482     """
10483   return _core_.Window_NextControlId(*args, **kwargs)
10484
10485 def Window_PrevControlId(*args, **kwargs):
10486   """
10487     Window_PrevControlId(int winid) -> int
10488
10489     Get the id of the control preceding the one with the given
10490     autogenerated) id
10491     """
10492   return _core_.Window_PrevControlId(*args, **kwargs)
10493
10494 def Window_FindFocus(*args):
10495   """
10496     Window_FindFocus() -> Window
10497
10498     Returns the window or control that currently has the keyboard focus,
10499     or None.
10500     """
10501   return _core_.Window_FindFocus(*args)
10502
10503 def Window_GetCapture(*args):
10504   """
10505     Window_GetCapture() -> Window
10506
10507     Returns the window which currently captures the mouse or None
10508     """
10509   return _core_.Window_GetCapture(*args)
10510
10511 def Window_GetClassDefaultAttributes(*args, **kwargs):
10512   """
10513     Window_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
10514
10515     Get the default attributes for this class.  This is useful if you want
10516     to use the same font or colour in your own control as in a standard
10517     control -- which is a much better idea than hard coding specific
10518     colours or fonts which might look completely out of place on the
10519     user's system, especially if it uses themes.
10520
10521     The variant parameter is only relevant under Mac currently and is
10522     ignore under other platforms. Under Mac, it will change the size of
10523     the returned font. See `wx.Window.SetWindowVariant` for more about
10524     this.
10525     """
10526   return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
10527
10528 def DLG_PNT(win, point_or_x, y=None):
10529     """
10530     Convenience function for converting a Point or (x,y) in
10531     dialog units to pixel units.
10532     """
10533     if y is None:
10534         return win.ConvertDialogPointToPixels(point_or_x)
10535     else:
10536         return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y))
10537
10538 def DLG_SZE(win, size_width, height=None):
10539     """
10540     Convenience function for converting a Size or (w,h) in
10541     dialog units to pixel units.
10542     """
10543     if height is None:
10544         return win.ConvertDialogSizeToPixels(size_width)
10545     else:
10546         return win.ConvertDialogSizeToPixels(wx.Size(size_width, height))
10547
10548
10549 def FindWindowById(*args, **kwargs):
10550   """
10551     FindWindowById(long id, Window parent=None) -> Window
10552
10553     Find the first window in the application with the given id. If parent
10554     is None, the search will start from all top-level frames and dialog
10555     boxes; if non-None, the search will be limited to the given window
10556     hierarchy. The search is recursive in both cases.
10557     """
10558   return _core_.FindWindowById(*args, **kwargs)
10559
10560 def FindWindowByName(*args, **kwargs):
10561   """
10562     FindWindowByName(String name, Window parent=None) -> Window
10563
10564     Find a window by its name (as given in a window constructor or Create
10565     function call). If parent is None, the search will start from all
10566     top-level frames and dialog boxes; if non-None, the search will be
10567     limited to the given window hierarchy. The search is recursive in both
10568     cases.
10569
10570     If no window with such name is found, wx.FindWindowByLabel is called.
10571     """
10572   return _core_.FindWindowByName(*args, **kwargs)
10573
10574 def FindWindowByLabel(*args, **kwargs):
10575   """
10576     FindWindowByLabel(String label, Window parent=None) -> Window
10577
10578     Find a window by its label. Depending on the type of window, the label
10579     may be a window title or panel item label. If parent is None, the
10580     search will start from all top-level frames and dialog boxes; if
10581     non-None, the search will be limited to the given window
10582     hierarchy. The search is recursive in both cases.
10583     """
10584   return _core_.FindWindowByLabel(*args, **kwargs)
10585
10586 def Window_FromHWND(*args, **kwargs):
10587   """Window_FromHWND(Window parent, unsigned long _hWnd) -> Window"""
10588   return _core_.Window_FromHWND(*args, **kwargs)
10589
10590 def GetTopLevelWindows(*args):
10591   """
10592     GetTopLevelWindows() -> PyObject
10593
10594     Returns a list of the the application's top-level windows, (frames,
10595     dialogs, etc.)  NOTE: Currently this is a copy of the list maintained
10596     by wxWidgets, and so it is only valid as long as no top-level windows
10597     are closed or new top-level windows are created.
10598
10599     """
10600   return _core_.GetTopLevelWindows(*args)
10601 #---------------------------------------------------------------------------
10602
10603 class Validator(EvtHandler):
10604     """Proxy of C++ Validator class"""
10605     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10606     __repr__ = _swig_repr
10607     def __init__(self, *args, **kwargs):
10608         """__init__(self) -> Validator"""
10609         _core_.Validator_swiginit(self,_core_.new_Validator(*args, **kwargs))
10610         self._setOORInfo(self)
10611
10612     def Clone(*args, **kwargs):
10613         """Clone(self) -> Validator"""
10614         return _core_.Validator_Clone(*args, **kwargs)
10615
10616     def Validate(*args, **kwargs):
10617         """Validate(self, Window parent) -> bool"""
10618         return _core_.Validator_Validate(*args, **kwargs)
10619
10620     def TransferToWindow(*args, **kwargs):
10621         """TransferToWindow(self) -> bool"""
10622         return _core_.Validator_TransferToWindow(*args, **kwargs)
10623
10624     def TransferFromWindow(*args, **kwargs):
10625         """TransferFromWindow(self) -> bool"""
10626         return _core_.Validator_TransferFromWindow(*args, **kwargs)
10627
10628     def GetWindow(*args, **kwargs):
10629         """GetWindow(self) -> Window"""
10630         return _core_.Validator_GetWindow(*args, **kwargs)
10631
10632     def SetWindow(*args, **kwargs):
10633         """SetWindow(self, Window window)"""
10634         return _core_.Validator_SetWindow(*args, **kwargs)
10635
10636     def IsSilent(*args, **kwargs):
10637         """IsSilent() -> bool"""
10638         return _core_.Validator_IsSilent(*args, **kwargs)
10639
10640     IsSilent = staticmethod(IsSilent)
10641     def SetBellOnError(*args, **kwargs):
10642         """SetBellOnError(int doIt=True)"""
10643         return _core_.Validator_SetBellOnError(*args, **kwargs)
10644
10645     SetBellOnError = staticmethod(SetBellOnError)
10646     Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`")
10647 _core_.Validator_swigregister(Validator)
10648
10649 def Validator_IsSilent(*args):
10650   """Validator_IsSilent() -> bool"""
10651   return _core_.Validator_IsSilent(*args)
10652
10653 def Validator_SetBellOnError(*args, **kwargs):
10654   """Validator_SetBellOnError(int doIt=True)"""
10655   return _core_.Validator_SetBellOnError(*args, **kwargs)
10656
10657 class PyValidator(Validator):
10658     """Proxy of C++ PyValidator class"""
10659     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10660     __repr__ = _swig_repr
10661     def __init__(self, *args, **kwargs):
10662         """__init__(self) -> PyValidator"""
10663         _core_.PyValidator_swiginit(self,_core_.new_PyValidator(*args, **kwargs))
10664         self._setOORInfo(self);PyValidator._setCallbackInfo(self, self, PyValidator)
10665
10666     def _setCallbackInfo(*args, **kwargs):
10667         """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=1)"""
10668         return _core_.PyValidator__setCallbackInfo(*args, **kwargs)
10669
10670 _core_.PyValidator_swigregister(PyValidator)
10671
10672 #---------------------------------------------------------------------------
10673
10674 class Menu(EvtHandler):
10675     """Proxy of C++ Menu class"""
10676     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10677     __repr__ = _swig_repr
10678     def __init__(self, *args, **kwargs):
10679         """__init__(self, String title=EmptyString, long style=0) -> Menu"""
10680         _core_.Menu_swiginit(self,_core_.new_Menu(*args, **kwargs))
10681         self._setOORInfo(self)
10682
10683     def Append(*args, **kwargs):
10684         """
10685         Append(self, int id, String text=EmptyString, String help=EmptyString,
10686             int kind=ITEM_NORMAL) -> MenuItem
10687         """
10688         return _core_.Menu_Append(*args, **kwargs)
10689
10690     def AppendSeparator(*args, **kwargs):
10691         """AppendSeparator(self) -> MenuItem"""
10692         return _core_.Menu_AppendSeparator(*args, **kwargs)
10693
10694     def AppendCheckItem(*args, **kwargs):
10695         """AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10696         return _core_.Menu_AppendCheckItem(*args, **kwargs)
10697
10698     def AppendRadioItem(*args, **kwargs):
10699         """AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10700         return _core_.Menu_AppendRadioItem(*args, **kwargs)
10701
10702     def AppendMenu(*args, **kwargs):
10703         """AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10704         return _core_.Menu_AppendMenu(*args, **kwargs)
10705
10706     def AppendSubMenu(*args, **kwargs):
10707         """AppendSubMenu(self, Menu submenu, String text, String help=EmptyString) -> MenuItem"""
10708         return _core_.Menu_AppendSubMenu(*args, **kwargs)
10709
10710     def AppendItem(*args, **kwargs):
10711         """AppendItem(self, MenuItem item) -> MenuItem"""
10712         return _core_.Menu_AppendItem(*args, **kwargs)
10713
10714     def InsertItem(*args, **kwargs):
10715         """InsertItem(self, size_t pos, MenuItem item) -> MenuItem"""
10716         return _core_.Menu_InsertItem(*args, **kwargs)
10717
10718     def PrependItem(*args, **kwargs):
10719         """PrependItem(self, MenuItem item) -> MenuItem"""
10720         return _core_.Menu_PrependItem(*args, **kwargs)
10721
10722     def Break(*args, **kwargs):
10723         """Break(self)"""
10724         return _core_.Menu_Break(*args, **kwargs)
10725
10726     def Insert(*args, **kwargs):
10727         """
10728         Insert(self, size_t pos, int id, String text=EmptyString, String help=EmptyString,
10729             int kind=ITEM_NORMAL) -> MenuItem
10730         """
10731         return _core_.Menu_Insert(*args, **kwargs)
10732
10733     def InsertSeparator(*args, **kwargs):
10734         """InsertSeparator(self, size_t pos) -> MenuItem"""
10735         return _core_.Menu_InsertSeparator(*args, **kwargs)
10736
10737     def InsertCheckItem(*args, **kwargs):
10738         """InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
10739         return _core_.Menu_InsertCheckItem(*args, **kwargs)
10740
10741     def InsertRadioItem(*args, **kwargs):
10742         """InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
10743         return _core_.Menu_InsertRadioItem(*args, **kwargs)
10744
10745     def InsertMenu(*args, **kwargs):
10746         """InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10747         return _core_.Menu_InsertMenu(*args, **kwargs)
10748
10749     def Prepend(*args, **kwargs):
10750         """
10751         Prepend(self, int id, String text=EmptyString, String help=EmptyString,
10752             int kind=ITEM_NORMAL) -> MenuItem
10753         """
10754         return _core_.Menu_Prepend(*args, **kwargs)
10755
10756     def PrependSeparator(*args, **kwargs):
10757         """PrependSeparator(self) -> MenuItem"""
10758         return _core_.Menu_PrependSeparator(*args, **kwargs)
10759
10760     def PrependCheckItem(*args, **kwargs):
10761         """PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10762         return _core_.Menu_PrependCheckItem(*args, **kwargs)
10763
10764     def PrependRadioItem(*args, **kwargs):
10765         """PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10766         return _core_.Menu_PrependRadioItem(*args, **kwargs)
10767
10768     def PrependMenu(*args, **kwargs):
10769         """PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10770         return _core_.Menu_PrependMenu(*args, **kwargs)
10771
10772     def Remove(*args, **kwargs):
10773         """Remove(self, int id) -> MenuItem"""
10774         return _core_.Menu_Remove(*args, **kwargs)
10775
10776     def RemoveItem(self, item):
10777         """RemoveItem(self, MenuItem item) -> MenuItem"""
10778         #// The return object is always the parameter, so return that
10779         #// proxy instead of the new one
10780         val = _core_.Menu_RemoveItem(self, item)
10781         item.this.own(val.this.own())
10782         val.this.disown()
10783         return item
10784
10785
10786     def Delete(*args, **kwargs):
10787         """Delete(self, int id) -> bool"""
10788         return _core_.Menu_Delete(*args, **kwargs)
10789
10790     def DeleteItem(*args, **kwargs):
10791         """DeleteItem(self, MenuItem item) -> bool"""
10792         return _core_.Menu_DeleteItem(*args, **kwargs)
10793
10794     def Destroy(*args, **kwargs):
10795         """
10796         Destroy(self)
10797
10798         Deletes the C++ object this Python object is a proxy for.
10799         """
10800         args[0].this.own(False)
10801         return _core_.Menu_Destroy(*args, **kwargs)
10802
10803     def DestroyId(*args, **kwargs):
10804         """DestroyId(self, int id) -> bool"""
10805         return _core_.Menu_DestroyId(*args, **kwargs)
10806
10807     def DestroyItem(*args, **kwargs):
10808         """DestroyItem(self, MenuItem item) -> bool"""
10809         return _core_.Menu_DestroyItem(*args, **kwargs)
10810
10811     def GetMenuItemCount(*args, **kwargs):
10812         """GetMenuItemCount(self) -> size_t"""
10813         return _core_.Menu_GetMenuItemCount(*args, **kwargs)
10814
10815     def GetMenuItems(*args, **kwargs):
10816         """GetMenuItems(self) -> PyObject"""
10817         return _core_.Menu_GetMenuItems(*args, **kwargs)
10818
10819     def FindItem(*args, **kwargs):
10820         """FindItem(self, String item) -> int"""
10821         return _core_.Menu_FindItem(*args, **kwargs)
10822
10823     def FindItemById(*args, **kwargs):
10824         """FindItemById(self, int id) -> MenuItem"""
10825         return _core_.Menu_FindItemById(*args, **kwargs)
10826
10827     def FindItemByPosition(*args, **kwargs):
10828         """FindItemByPosition(self, size_t position) -> MenuItem"""
10829         return _core_.Menu_FindItemByPosition(*args, **kwargs)
10830
10831     def Enable(*args, **kwargs):
10832         """Enable(self, int id, bool enable)"""
10833         return _core_.Menu_Enable(*args, **kwargs)
10834
10835     def IsEnabled(*args, **kwargs):
10836         """IsEnabled(self, int id) -> bool"""
10837         return _core_.Menu_IsEnabled(*args, **kwargs)
10838
10839     def Check(*args, **kwargs):
10840         """Check(self, int id, bool check)"""
10841         return _core_.Menu_Check(*args, **kwargs)
10842
10843     def IsChecked(*args, **kwargs):
10844         """IsChecked(self, int id) -> bool"""
10845         return _core_.Menu_IsChecked(*args, **kwargs)
10846
10847     def SetLabel(*args, **kwargs):
10848         """SetLabel(self, int id, String label)"""
10849         return _core_.Menu_SetLabel(*args, **kwargs)
10850
10851     def GetLabel(*args, **kwargs):
10852         """GetLabel(self, int id) -> String"""
10853         return _core_.Menu_GetLabel(*args, **kwargs)
10854
10855     def SetHelpString(*args, **kwargs):
10856         """SetHelpString(self, int id, String helpString)"""
10857         return _core_.Menu_SetHelpString(*args, **kwargs)
10858
10859     def GetHelpString(*args, **kwargs):
10860         """GetHelpString(self, int id) -> String"""
10861         return _core_.Menu_GetHelpString(*args, **kwargs)
10862
10863     def SetTitle(*args, **kwargs):
10864         """SetTitle(self, String title)"""
10865         return _core_.Menu_SetTitle(*args, **kwargs)
10866
10867     def GetTitle(*args, **kwargs):
10868         """GetTitle(self) -> String"""
10869         return _core_.Menu_GetTitle(*args, **kwargs)
10870
10871     def SetEventHandler(*args, **kwargs):
10872         """SetEventHandler(self, EvtHandler handler)"""
10873         return _core_.Menu_SetEventHandler(*args, **kwargs)
10874
10875     def GetEventHandler(*args, **kwargs):
10876         """GetEventHandler(self) -> EvtHandler"""
10877         return _core_.Menu_GetEventHandler(*args, **kwargs)
10878
10879     def SetInvokingWindow(*args, **kwargs):
10880         """SetInvokingWindow(self, Window win)"""
10881         return _core_.Menu_SetInvokingWindow(*args, **kwargs)
10882
10883     def GetInvokingWindow(*args, **kwargs):
10884         """GetInvokingWindow(self) -> Window"""
10885         return _core_.Menu_GetInvokingWindow(*args, **kwargs)
10886
10887     def GetStyle(*args, **kwargs):
10888         """GetStyle(self) -> long"""
10889         return _core_.Menu_GetStyle(*args, **kwargs)
10890
10891     def UpdateUI(*args, **kwargs):
10892         """UpdateUI(self, EvtHandler source=None)"""
10893         return _core_.Menu_UpdateUI(*args, **kwargs)
10894
10895     def GetMenuBar(*args, **kwargs):
10896         """GetMenuBar(self) -> MenuBar"""
10897         return _core_.Menu_GetMenuBar(*args, **kwargs)
10898
10899     def Attach(*args, **kwargs):
10900         """Attach(self, wxMenuBarBase menubar)"""
10901         return _core_.Menu_Attach(*args, **kwargs)
10902
10903     def Detach(*args, **kwargs):
10904         """Detach(self)"""
10905         return _core_.Menu_Detach(*args, **kwargs)
10906
10907     def IsAttached(*args, **kwargs):
10908         """IsAttached(self) -> bool"""
10909         return _core_.Menu_IsAttached(*args, **kwargs)
10910
10911     def SetParent(*args, **kwargs):
10912         """SetParent(self, Menu parent)"""
10913         return _core_.Menu_SetParent(*args, **kwargs)
10914
10915     def GetParent(*args, **kwargs):
10916         """GetParent(self) -> Menu"""
10917         return _core_.Menu_GetParent(*args, **kwargs)
10918
10919     EventHandler = property(GetEventHandler,SetEventHandler,doc="See `GetEventHandler` and `SetEventHandler`")
10920     HelpString = property(GetHelpString,SetHelpString,doc="See `GetHelpString` and `SetHelpString`")
10921     InvokingWindow = property(GetInvokingWindow,SetInvokingWindow,doc="See `GetInvokingWindow` and `SetInvokingWindow`")
10922     MenuBar = property(GetMenuBar,doc="See `GetMenuBar`")
10923     MenuItemCount = property(GetMenuItemCount,doc="See `GetMenuItemCount`")
10924     MenuItems = property(GetMenuItems,doc="See `GetMenuItems`")
10925     Parent = property(GetParent,SetParent,doc="See `GetParent` and `SetParent`")
10926     Style = property(GetStyle,doc="See `GetStyle`")
10927     Title = property(GetTitle,SetTitle,doc="See `GetTitle` and `SetTitle`")
10928 _core_.Menu_swigregister(Menu)
10929 DefaultValidator = cvar.DefaultValidator
10930
10931 #---------------------------------------------------------------------------
10932
10933 class MenuBar(Window):
10934     """Proxy of C++ MenuBar class"""
10935     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10936     __repr__ = _swig_repr
10937     def __init__(self, *args, **kwargs):
10938         """__init__(self, long style=0) -> MenuBar"""
10939         _core_.MenuBar_swiginit(self,_core_.new_MenuBar(*args, **kwargs))
10940         self._setOORInfo(self)
10941
10942     def Append(*args, **kwargs):
10943         """Append(self, Menu menu, String title) -> bool"""
10944         return _core_.MenuBar_Append(*args, **kwargs)
10945
10946     def Insert(*args, **kwargs):
10947         """Insert(self, size_t pos, Menu menu, String title) -> bool"""
10948         return _core_.MenuBar_Insert(*args, **kwargs)
10949
10950     def GetMenuCount(*args, **kwargs):
10951         """GetMenuCount(self) -> size_t"""
10952         return _core_.MenuBar_GetMenuCount(*args, **kwargs)
10953
10954     def GetMenu(*args, **kwargs):
10955         """GetMenu(self, size_t pos) -> Menu"""
10956         return _core_.MenuBar_GetMenu(*args, **kwargs)
10957
10958     def Replace(*args, **kwargs):
10959         """Replace(self, size_t pos, Menu menu, String title) -> Menu"""
10960         return _core_.MenuBar_Replace(*args, **kwargs)
10961
10962     def Remove(*args, **kwargs):
10963         """Remove(self, size_t pos) -> Menu"""
10964         return _core_.MenuBar_Remove(*args, **kwargs)
10965
10966     def EnableTop(*args, **kwargs):
10967         """EnableTop(self, size_t pos, bool enable)"""
10968         return _core_.MenuBar_EnableTop(*args, **kwargs)
10969
10970     def IsEnabledTop(*args, **kwargs):
10971         """IsEnabledTop(self, size_t pos) -> bool"""
10972         return _core_.MenuBar_IsEnabledTop(*args, **kwargs)
10973
10974     def SetLabelTop(*args, **kwargs):
10975         """SetLabelTop(self, size_t pos, String label)"""
10976         return _core_.MenuBar_SetLabelTop(*args, **kwargs)
10977
10978     def GetLabelTop(*args, **kwargs):
10979         """GetLabelTop(self, size_t pos) -> String"""
10980         return _core_.MenuBar_GetLabelTop(*args, **kwargs)
10981
10982     def FindMenuItem(*args, **kwargs):
10983         """FindMenuItem(self, String menu, String item) -> int"""
10984         return _core_.MenuBar_FindMenuItem(*args, **kwargs)
10985
10986     def FindItemById(*args, **kwargs):
10987         """FindItemById(self, int id) -> MenuItem"""
10988         return _core_.MenuBar_FindItemById(*args, **kwargs)
10989
10990     def FindMenu(*args, **kwargs):
10991         """FindMenu(self, String title) -> int"""
10992         return _core_.MenuBar_FindMenu(*args, **kwargs)
10993
10994     def Enable(*args, **kwargs):
10995         """Enable(self, int id, bool enable)"""
10996         return _core_.MenuBar_Enable(*args, **kwargs)
10997
10998     def Check(*args, **kwargs):
10999         """Check(self, int id, bool check)"""
11000         return _core_.MenuBar_Check(*args, **kwargs)
11001
11002     def IsChecked(*args, **kwargs):
11003         """IsChecked(self, int id) -> bool"""
11004         return _core_.MenuBar_IsChecked(*args, **kwargs)
11005
11006     def IsEnabled(*args, **kwargs):
11007         """IsEnabled(self, int id) -> bool"""
11008         return _core_.MenuBar_IsEnabled(*args, **kwargs)
11009
11010     def SetLabel(*args, **kwargs):
11011         """SetLabel(self, int id, String label)"""
11012         return _core_.MenuBar_SetLabel(*args, **kwargs)
11013
11014     def GetLabel(*args, **kwargs):
11015         """GetLabel(self, int id) -> String"""
11016         return _core_.MenuBar_GetLabel(*args, **kwargs)
11017
11018     def SetHelpString(*args, **kwargs):
11019         """SetHelpString(self, int id, String helpString)"""
11020         return _core_.MenuBar_SetHelpString(*args, **kwargs)
11021
11022     def GetHelpString(*args, **kwargs):
11023         """GetHelpString(self, int id) -> String"""
11024         return _core_.MenuBar_GetHelpString(*args, **kwargs)
11025
11026     def GetFrame(*args, **kwargs):
11027         """GetFrame(self) -> wxFrame"""
11028         return _core_.MenuBar_GetFrame(*args, **kwargs)
11029
11030     def IsAttached(*args, **kwargs):
11031         """IsAttached(self) -> bool"""
11032         return _core_.MenuBar_IsAttached(*args, **kwargs)
11033
11034     def Attach(*args, **kwargs):
11035         """Attach(self, wxFrame frame)"""
11036         return _core_.MenuBar_Attach(*args, **kwargs)
11037
11038     def Detach(*args, **kwargs):
11039         """Detach(self)"""
11040         return _core_.MenuBar_Detach(*args, **kwargs)
11041
11042     def UpdateMenus(*args, **kwargs):
11043         """UpdateMenus(self)"""
11044         return _core_.MenuBar_UpdateMenus(*args, **kwargs)
11045
11046     def SetAutoWindowMenu(*args, **kwargs):
11047         """SetAutoWindowMenu(bool enable)"""
11048         return _core_.MenuBar_SetAutoWindowMenu(*args, **kwargs)
11049
11050     SetAutoWindowMenu = staticmethod(SetAutoWindowMenu)
11051     def GetAutoWindowMenu(*args, **kwargs):
11052         """GetAutoWindowMenu() -> bool"""
11053         return _core_.MenuBar_GetAutoWindowMenu(*args, **kwargs)
11054
11055     GetAutoWindowMenu = staticmethod(GetAutoWindowMenu)
11056     def GetMenus(self):
11057         """Return a list of (menu, label) items for the menus in the MenuBar. """
11058         return [(self.GetMenu(i), self.GetLabelTop(i))
11059                 for i in range(self.GetMenuCount())]
11060
11061     def SetMenus(self, items):
11062         """Clear and add new menus to the MenuBar from a list of (menu, label) items. """
11063         for i in range(self.GetMenuCount()-1, -1, -1):
11064             self.Remove(i)
11065         for m, l in items:
11066             self.Append(m, l)
11067
11068     Frame = property(GetFrame,doc="See `GetFrame`")
11069     Menu = property(GetMenu,doc="See `GetMenu`")
11070     MenuCount = property(GetMenuCount,doc="See `GetMenuCount`")
11071     Menus = property(GetMenus,SetMenus,doc="See `GetMenus` and `SetMenus`")
11072 _core_.MenuBar_swigregister(MenuBar)
11073
11074 def MenuBar_SetAutoWindowMenu(*args, **kwargs):
11075   """MenuBar_SetAutoWindowMenu(bool enable)"""
11076   return _core_.MenuBar_SetAutoWindowMenu(*args, **kwargs)
11077
11078 def MenuBar_GetAutoWindowMenu(*args):
11079   """MenuBar_GetAutoWindowMenu() -> bool"""
11080   return _core_.MenuBar_GetAutoWindowMenu(*args)
11081
11082 #---------------------------------------------------------------------------
11083
11084 class MenuItem(Object):
11085     """Proxy of C++ MenuItem class"""
11086     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11087     __repr__ = _swig_repr
11088     def __init__(self, *args, **kwargs):
11089         """
11090         __init__(self, Menu parentMenu=None, int id=ID_SEPARATOR, String text=EmptyString,
11091             String help=EmptyString, int kind=ITEM_NORMAL,
11092             Menu subMenu=None) -> MenuItem
11093         """
11094         _core_.MenuItem_swiginit(self,_core_.new_MenuItem(*args, **kwargs))
11095     __swig_destroy__ = _core_.delete_MenuItem
11096     __del__ = lambda self : None;
11097     def Destroy(self): pass
11098     def GetMenu(*args, **kwargs):
11099         """GetMenu(self) -> Menu"""
11100         return _core_.MenuItem_GetMenu(*args, **kwargs)
11101
11102     def SetMenu(*args, **kwargs):
11103         """SetMenu(self, Menu menu)"""
11104         return _core_.MenuItem_SetMenu(*args, **kwargs)
11105
11106     def SetId(*args, **kwargs):
11107         """SetId(self, int id)"""
11108         return _core_.MenuItem_SetId(*args, **kwargs)
11109
11110     def GetId(*args, **kwargs):
11111         """GetId(self) -> int"""
11112         return _core_.MenuItem_GetId(*args, **kwargs)
11113
11114     def IsSeparator(*args, **kwargs):
11115         """IsSeparator(self) -> bool"""
11116         return _core_.MenuItem_IsSeparator(*args, **kwargs)
11117
11118     def SetText(*args, **kwargs):
11119         """SetText(self, String str)"""
11120         return _core_.MenuItem_SetText(*args, **kwargs)
11121
11122     def GetLabel(*args, **kwargs):
11123         """GetLabel(self) -> String"""
11124         return _core_.MenuItem_GetLabel(*args, **kwargs)
11125
11126     def GetText(*args, **kwargs):
11127         """GetText(self) -> String"""
11128         return _core_.MenuItem_GetText(*args, **kwargs)
11129
11130     def GetLabelFromText(*args, **kwargs):
11131         """GetLabelFromText(String text) -> String"""
11132         return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
11133
11134     GetLabelFromText = staticmethod(GetLabelFromText)
11135     def GetKind(*args, **kwargs):
11136         """GetKind(self) -> int"""
11137         return _core_.MenuItem_GetKind(*args, **kwargs)
11138
11139     def SetKind(*args, **kwargs):
11140         """SetKind(self, int kind)"""
11141         return _core_.MenuItem_SetKind(*args, **kwargs)
11142
11143     def SetCheckable(*args, **kwargs):
11144         """SetCheckable(self, bool checkable)"""
11145         return _core_.MenuItem_SetCheckable(*args, **kwargs)
11146
11147     def IsCheckable(*args, **kwargs):
11148         """IsCheckable(self) -> bool"""
11149         return _core_.MenuItem_IsCheckable(*args, **kwargs)
11150
11151     def IsSubMenu(*args, **kwargs):
11152         """IsSubMenu(self) -> bool"""
11153         return _core_.MenuItem_IsSubMenu(*args, **kwargs)
11154
11155     def SetSubMenu(*args, **kwargs):
11156         """SetSubMenu(self, Menu menu)"""
11157         return _core_.MenuItem_SetSubMenu(*args, **kwargs)
11158
11159     def GetSubMenu(*args, **kwargs):
11160         """GetSubMenu(self) -> Menu"""
11161         return _core_.MenuItem_GetSubMenu(*args, **kwargs)
11162
11163     def Enable(*args, **kwargs):
11164         """Enable(self, bool enable=True)"""
11165         return _core_.MenuItem_Enable(*args, **kwargs)
11166
11167     def IsEnabled(*args, **kwargs):
11168         """IsEnabled(self) -> bool"""
11169         return _core_.MenuItem_IsEnabled(*args, **kwargs)
11170
11171     def Check(*args, **kwargs):
11172         """Check(self, bool check=True)"""
11173         return _core_.MenuItem_Check(*args, **kwargs)
11174
11175     def IsChecked(*args, **kwargs):
11176         """IsChecked(self) -> bool"""
11177         return _core_.MenuItem_IsChecked(*args, **kwargs)
11178
11179     def Toggle(*args, **kwargs):
11180         """Toggle(self)"""
11181         return _core_.MenuItem_Toggle(*args, **kwargs)
11182
11183     def SetHelp(*args, **kwargs):
11184         """SetHelp(self, String str)"""
11185         return _core_.MenuItem_SetHelp(*args, **kwargs)
11186
11187     def GetHelp(*args, **kwargs):
11188         """GetHelp(self) -> String"""
11189         return _core_.MenuItem_GetHelp(*args, **kwargs)
11190
11191     def GetAccel(*args, **kwargs):
11192         """GetAccel(self) -> AcceleratorEntry"""
11193         return _core_.MenuItem_GetAccel(*args, **kwargs)
11194
11195     def SetAccel(*args, **kwargs):
11196         """SetAccel(self, AcceleratorEntry accel)"""
11197         return _core_.MenuItem_SetAccel(*args, **kwargs)
11198
11199     def SetBitmap(*args, **kwargs):
11200         """SetBitmap(self, Bitmap bitmap)"""
11201         return _core_.MenuItem_SetBitmap(*args, **kwargs)
11202
11203     def GetBitmap(*args, **kwargs):
11204         """GetBitmap(self) -> Bitmap"""
11205         return _core_.MenuItem_GetBitmap(*args, **kwargs)
11206
11207     def SetFont(*args, **kwargs):
11208         """SetFont(self, Font font)"""
11209         return _core_.MenuItem_SetFont(*args, **kwargs)
11210
11211     def GetFont(*args, **kwargs):
11212         """GetFont(self) -> Font"""
11213         return _core_.MenuItem_GetFont(*args, **kwargs)
11214
11215     def SetTextColour(*args, **kwargs):
11216         """SetTextColour(self, Colour colText)"""
11217         return _core_.MenuItem_SetTextColour(*args, **kwargs)
11218
11219     def GetTextColour(*args, **kwargs):
11220         """GetTextColour(self) -> Colour"""
11221         return _core_.MenuItem_GetTextColour(*args, **kwargs)
11222
11223     def SetBackgroundColour(*args, **kwargs):
11224         """SetBackgroundColour(self, Colour colBack)"""
11225         return _core_.MenuItem_SetBackgroundColour(*args, **kwargs)
11226
11227     def GetBackgroundColour(*args, **kwargs):
11228         """GetBackgroundColour(self) -> Colour"""
11229         return _core_.MenuItem_GetBackgroundColour(*args, **kwargs)
11230
11231     def SetBitmaps(*args, **kwargs):
11232         """SetBitmaps(self, Bitmap bmpChecked, Bitmap bmpUnchecked=wxNullBitmap)"""
11233         return _core_.MenuItem_SetBitmaps(*args, **kwargs)
11234
11235     def SetDisabledBitmap(*args, **kwargs):
11236         """SetDisabledBitmap(self, Bitmap bmpDisabled)"""
11237         return _core_.MenuItem_SetDisabledBitmap(*args, **kwargs)
11238
11239     def GetDisabledBitmap(*args, **kwargs):
11240         """GetDisabledBitmap(self) -> Bitmap"""
11241         return _core_.MenuItem_GetDisabledBitmap(*args, **kwargs)
11242
11243     def SetMarginWidth(*args, **kwargs):
11244         """SetMarginWidth(self, int nWidth)"""
11245         return _core_.MenuItem_SetMarginWidth(*args, **kwargs)
11246
11247     def GetMarginWidth(*args, **kwargs):
11248         """GetMarginWidth(self) -> int"""
11249         return _core_.MenuItem_GetMarginWidth(*args, **kwargs)
11250
11251     def GetDefaultMarginWidth(*args, **kwargs):
11252         """GetDefaultMarginWidth() -> int"""
11253         return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
11254
11255     GetDefaultMarginWidth = staticmethod(GetDefaultMarginWidth)
11256     def IsOwnerDrawn(*args, **kwargs):
11257         """IsOwnerDrawn(self) -> bool"""
11258         return _core_.MenuItem_IsOwnerDrawn(*args, **kwargs)
11259
11260     def SetOwnerDrawn(*args, **kwargs):
11261         """SetOwnerDrawn(self, bool ownerDrawn=True)"""
11262         return _core_.MenuItem_SetOwnerDrawn(*args, **kwargs)
11263
11264     def ResetOwnerDrawn(*args, **kwargs):
11265         """ResetOwnerDrawn(self)"""
11266         return _core_.MenuItem_ResetOwnerDrawn(*args, **kwargs)
11267
11268     Accel = property(GetAccel,SetAccel,doc="See `GetAccel` and `SetAccel`")
11269     BackgroundColour = property(GetBackgroundColour,SetBackgroundColour,doc="See `GetBackgroundColour` and `SetBackgroundColour`")
11270     Bitmap = property(GetBitmap,SetBitmap,doc="See `GetBitmap` and `SetBitmap`")
11271     DisabledBitmap = property(GetDisabledBitmap,SetDisabledBitmap,doc="See `GetDisabledBitmap` and `SetDisabledBitmap`")
11272     Font = property(GetFont,SetFont,doc="See `GetFont` and `SetFont`")
11273     Help = property(GetHelp,SetHelp,doc="See `GetHelp` and `SetHelp`")
11274     Id = property(GetId,SetId,doc="See `GetId` and `SetId`")
11275     Kind = property(GetKind,SetKind,doc="See `GetKind` and `SetKind`")
11276     Label = property(GetLabel,doc="See `GetLabel`")
11277     MarginWidth = property(GetMarginWidth,SetMarginWidth,doc="See `GetMarginWidth` and `SetMarginWidth`")
11278     Menu = property(GetMenu,SetMenu,doc="See `GetMenu` and `SetMenu`")
11279     SubMenu = property(GetSubMenu,SetSubMenu,doc="See `GetSubMenu` and `SetSubMenu`")
11280     Text = property(GetText,SetText,doc="See `GetText` and `SetText`")
11281     TextColour = property(GetTextColour,SetTextColour,doc="See `GetTextColour` and `SetTextColour`")
11282 _core_.MenuItem_swigregister(MenuItem)
11283
11284 def MenuItem_GetLabelFromText(*args, **kwargs):
11285   """MenuItem_GetLabelFromText(String text) -> String"""
11286   return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
11287
11288 def MenuItem_GetDefaultMarginWidth(*args):
11289   """MenuItem_GetDefaultMarginWidth() -> int"""
11290   return _core_.MenuItem_GetDefaultMarginWidth(*args)
11291
11292 #---------------------------------------------------------------------------
11293
11294 class Control(Window):
11295     """
11296     This is the base class for a control or 'widget'.
11297
11298     A control is generally a small window which processes user input
11299     and/or displays one or more item of data.
11300     """
11301     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11302     __repr__ = _swig_repr
11303     def __init__(self, *args, **kwargs):
11304         """
11305         __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
11306             Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
11307             String name=ControlNameStr) -> Control
11308
11309         Create a Control.  Normally you should only call this from a subclass'
11310         __init__ as a plain old wx.Control is not very useful.
11311         """
11312         _core_.Control_swiginit(self,_core_.new_Control(*args, **kwargs))
11313         self._setOORInfo(self)
11314
11315     def Create(*args, **kwargs):
11316         """
11317         Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
11318             Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
11319             String name=ControlNameStr) -> bool
11320
11321         Do the 2nd phase and create the GUI control.
11322         """
11323         return _core_.Control_Create(*args, **kwargs)
11324
11325     def GetAlignment(*args, **kwargs):
11326         """
11327         GetAlignment(self) -> int
11328
11329         Get the control alignment (left/right/centre, top/bottom/centre)
11330         """
11331         return _core_.Control_GetAlignment(*args, **kwargs)
11332
11333     def GetLabelText(*args, **kwargs):
11334         """
11335         GetLabelText(self) -> String
11336
11337         Get just the text of the label, without mnemonic characters ('&')
11338         """
11339         return _core_.Control_GetLabelText(*args, **kwargs)
11340
11341     def Command(*args, **kwargs):
11342         """
11343         Command(self, CommandEvent event)
11344
11345         Simulates the effect of the user issuing a command to the item.
11346
11347         :see: `wx.CommandEvent`
11348
11349         """
11350         return _core_.Control_Command(*args, **kwargs)
11351
11352     def GetClassDefaultAttributes(*args, **kwargs):
11353         """
11354         GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
11355
11356         Get the default attributes for this class.  This is useful if you want
11357         to use the same font or colour in your own control as in a standard
11358         control -- which is a much better idea than hard coding specific
11359         colours or fonts which might look completely out of place on the
11360         user's system, especially if it uses themes.
11361
11362         The variant parameter is only relevant under Mac currently and is
11363         ignore under other platforms. Under Mac, it will change the size of
11364         the returned font. See `wx.Window.SetWindowVariant` for more about
11365         this.
11366         """
11367         return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
11368
11369     GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
11370     Alignment = property(GetAlignment,doc="See `GetAlignment`")
11371     LabelText = property(GetLabelText,doc="See `GetLabelText`")
11372 _core_.Control_swigregister(Control)
11373 ControlNameStr = cvar.ControlNameStr
11374
11375 def PreControl(*args, **kwargs):
11376     """
11377     PreControl() -> Control
11378
11379     Precreate a Control control for 2-phase creation
11380     """
11381     val = _core_.new_PreControl(*args, **kwargs)
11382     return val
11383
11384 def Control_GetClassDefaultAttributes(*args, **kwargs):
11385   """
11386     Control_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
11387
11388     Get the default attributes for this class.  This is useful if you want
11389     to use the same font or colour in your own control as in a standard
11390     control -- which is a much better idea than hard coding specific
11391     colours or fonts which might look completely out of place on the
11392     user's system, especially if it uses themes.
11393
11394     The variant parameter is only relevant under Mac currently and is
11395     ignore under other platforms. Under Mac, it will change the size of
11396     the returned font. See `wx.Window.SetWindowVariant` for more about
11397     this.
11398     """
11399   return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
11400
11401 #---------------------------------------------------------------------------
11402
11403 class ItemContainer(object):
11404     """
11405     The wx.ItemContainer class defines an interface which is implemented
11406     by all controls which have string subitems, each of which may be
11407     selected, such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well
11408     as `wx.ComboBox` which implements an extended interface deriving from
11409     this one.
11410
11411     It defines the methods for accessing the control's items and although
11412     each of the derived classes implements them differently, they still
11413     all conform to the same interface.
11414
11415     The items in a wx.ItemContainer have (non empty) string labels and,
11416     optionally, client data associated with them.
11417
11418     """
11419     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11420     def __init__(self): raise AttributeError, "No constructor defined"
11421     __repr__ = _swig_repr
11422     def Append(*args, **kwargs):
11423         """
11424         Append(self, String item, PyObject clientData=None) -> int
11425
11426         Adds the item to the control, associating the given data with the item
11427         if not None.  The return value is the index of the newly added item
11428         which may be different from the last one if the control is sorted (e.g.
11429         has wx.LB_SORT or wx.CB_SORT style).
11430         """
11431         return _core_.ItemContainer_Append(*args, **kwargs)
11432
11433     def AppendItems(*args, **kwargs):
11434         """
11435         AppendItems(self, List strings)
11436
11437         Apend several items at once to the control.  Notice that calling this
11438         method may be much faster than appending the items one by one if you
11439         need to add a lot of items.
11440         """
11441         return _core_.ItemContainer_AppendItems(*args, **kwargs)
11442
11443     def Insert(*args, **kwargs):
11444         """
11445         Insert(self, String item, int pos, PyObject clientData=None) -> int
11446
11447         Insert an item into the control before the item at the ``pos`` index,
11448         optionally associating some data object with the item.
11449         """
11450         return _core_.ItemContainer_Insert(*args, **kwargs)
11451
11452     def Clear(*args, **kwargs):
11453         """
11454         Clear(self)
11455
11456         Removes all items from the control.
11457         """
11458         return _core_.ItemContainer_Clear(*args, **kwargs)
11459
11460     def Delete(*args, **kwargs):
11461         """
11462         Delete(self, int n)
11463
11464         Deletes the item at the zero-based index 'n' from the control. Note
11465         that it is an error (signalled by a `wx.PyAssertionError` exception if
11466         enabled) to remove an item with the index negative or greater or equal
11467         than the number of items in the control.
11468         """
11469         return _core_.ItemContainer_Delete(*args, **kwargs)
11470
11471     def GetClientData(*args, **kwargs):
11472         """
11473         GetClientData(self, int n) -> PyObject
11474
11475         Returns the client data associated with the given item, (if any.)
11476         """
11477         return _core_.ItemContainer_GetClientData(*args, **kwargs)
11478
11479     def SetClientData(*args, **kwargs):
11480         """
11481         SetClientData(self, int n, PyObject clientData)
11482
11483         Associate the given client data with the item at position n.
11484         """
11485         return _core_.ItemContainer_SetClientData(*args, **kwargs)
11486
11487     def GetCount(*args, **kwargs):
11488         """
11489         GetCount(self) -> int
11490
11491         Returns the number of items in the control.
11492         """
11493         return _core_.ItemContainer_GetCount(*args, **kwargs)
11494
11495     def IsEmpty(*args, **kwargs):
11496         """
11497         IsEmpty(self) -> bool
11498
11499         Returns True if the control is empty or False if it has some items.
11500         """
11501         return _core_.ItemContainer_IsEmpty(*args, **kwargs)
11502
11503     def GetString(*args, **kwargs):
11504         """
11505         GetString(self, int n) -> String
11506
11507         Returns the label of the item with the given index.
11508         """
11509         return _core_.ItemContainer_GetString(*args, **kwargs)
11510
11511     def GetStrings(*args, **kwargs):
11512         """GetStrings(self) -> wxArrayString"""
11513         return _core_.ItemContainer_GetStrings(*args, **kwargs)
11514
11515     def SetString(*args, **kwargs):
11516         """
11517         SetString(self, int n, String s)
11518
11519         Sets the label for the given item.
11520         """
11521         return _core_.ItemContainer_SetString(*args, **kwargs)
11522
11523     def FindString(*args, **kwargs):
11524         """
11525         FindString(self, String s) -> int
11526
11527         Finds an item whose label matches the given string.  Returns the
11528         zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not
11529         found.
11530         """
11531         return _core_.ItemContainer_FindString(*args, **kwargs)
11532
11533     def SetSelection(*args, **kwargs):
11534         """
11535         SetSelection(self, int n)
11536
11537         Sets the item at index 'n' to be the selected item.
11538         """
11539         return _core_.ItemContainer_SetSelection(*args, **kwargs)
11540
11541     def GetSelection(*args, **kwargs):
11542         """
11543         GetSelection(self) -> int
11544
11545         Returns the index of the selected item or ``wx.NOT_FOUND`` if no item
11546         is selected.
11547         """
11548         return _core_.ItemContainer_GetSelection(*args, **kwargs)
11549
11550     def SetStringSelection(*args, **kwargs):
11551         """SetStringSelection(self, String s) -> bool"""
11552         return _core_.ItemContainer_SetStringSelection(*args, **kwargs)
11553
11554     def GetStringSelection(*args, **kwargs):
11555         """
11556         GetStringSelection(self) -> String
11557
11558         Returns the label of the selected item or an empty string if no item
11559         is selected.
11560         """
11561         return _core_.ItemContainer_GetStringSelection(*args, **kwargs)
11562
11563     def Select(*args, **kwargs):
11564         """
11565         Select(self, int n)
11566
11567         This is the same as `SetSelection` and exists only because it is
11568         slightly more natural for controls which support multiple selection.
11569         """
11570         return _core_.ItemContainer_Select(*args, **kwargs)
11571
11572     def GetItems(self):
11573         """Return a list of the strings in the control"""
11574         return [self.GetString(i) for i in xrange(self.GetCount())]
11575
11576     def SetItems(self, items):
11577         """Clear and set the strings in the control from a list"""
11578         self.Clear()
11579         for i in items:
11580             self.Append(i)
11581
11582     Count = property(GetCount,doc="See `GetCount`")
11583     Items = property(GetItems,SetItems,doc="See `GetItems` and `SetItems`")
11584     Selection = property(GetSelection,SetSelection,doc="See `GetSelection` and `SetSelection`")
11585     StringSelection = property(GetStringSelection,SetStringSelection,doc="See `GetStringSelection` and `SetStringSelection`")
11586     Strings = property(GetStrings,doc="See `GetStrings`")
11587 _core_.ItemContainer_swigregister(ItemContainer)
11588
11589 #---------------------------------------------------------------------------
11590
11591 class ControlWithItems(Control,ItemContainer):
11592     """
11593     wx.ControlWithItems combines the ``wx.ItemContainer`` class with the
11594     wx.Control class, and is used for the base class of various controls
11595     that have items.
11596     """
11597     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11598     def __init__(self): raise AttributeError, "No constructor defined"
11599     __repr__ = _swig_repr
11600 _core_.ControlWithItems_swigregister(ControlWithItems)
11601
11602 #---------------------------------------------------------------------------
11603
11604 class SizerItem(Object):
11605     """
11606     The wx.SizerItem class is used to track the position, size and other
11607     attributes of each item managed by a `wx.Sizer`. It is not usually
11608     necessary to use this class because the sizer elements can also be
11609     identified by their positions or window or sizer references but
11610     sometimes it may be more convenient to use wx.SizerItem directly.
11611     Also, custom classes derived from `wx.PySizer` will probably need to
11612     use the collection of wx.SizerItems held by wx.Sizer when calculating
11613     layout.
11614
11615     :see: `wx.Sizer`, `wx.GBSizerItem`
11616     """
11617     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11618     __repr__ = _swig_repr
11619     def __init__(self, *args, **kwargs):
11620         """
11621         __init__(self) -> SizerItem
11622
11623         Constructs an empty wx.SizerItem.  Either a window, sizer or spacer
11624         size will need to be set before this item can be used in a Sizer.
11625
11626         You will probably never need to create a wx.SizerItem directly as they
11627         are created automatically when the sizer's Add, Insert or Prepend
11628         methods are called.
11629
11630         :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer`
11631         """
11632         _core_.SizerItem_swiginit(self,_core_.new_SizerItem(*args, **kwargs))
11633     __swig_destroy__ = _core_.delete_SizerItem
11634     __del__ = lambda self : None;
11635     def DeleteWindows(*args, **kwargs):
11636         """
11637         DeleteWindows(self)
11638
11639         Destroy the window or the windows in a subsizer, depending on the type
11640         of item.
11641         """
11642         return _core_.SizerItem_DeleteWindows(*args, **kwargs)
11643
11644     def DetachSizer(*args, **kwargs):
11645         """
11646         DetachSizer(self)
11647
11648         Enable deleting the SizerItem without destroying the contained sizer.
11649         """
11650         return _core_.SizerItem_DetachSizer(*args, **kwargs)
11651
11652     def GetSize(*args, **kwargs):
11653         """
11654         GetSize(self) -> Size
11655
11656         Get the current size of the item, as set in the last Layout.
11657         """
11658         return _core_.SizerItem_GetSize(*args, **kwargs)
11659
11660     def CalcMin(*args, **kwargs):
11661         """
11662         CalcMin(self) -> Size
11663
11664         Calculates the minimum desired size for the item, including any space
11665         needed by borders.
11666         """
11667         return _core_.SizerItem_CalcMin(*args, **kwargs)
11668
11669     def SetDimension(*args, **kwargs):
11670         """
11671         SetDimension(self, Point pos, Size size)
11672
11673         Set the position and size of the space allocated for this item by the
11674         sizer, and adjust the position and size of the item (window or
11675         subsizer) to be within that space taking alignment and borders into
11676         account.
11677         """
11678         return _core_.SizerItem_SetDimension(*args, **kwargs)
11679
11680     def GetMinSize(*args, **kwargs):
11681         """
11682         GetMinSize(self) -> Size
11683
11684         Get the minimum size needed for the item.
11685         """
11686         return _core_.SizerItem_GetMinSize(*args, **kwargs)
11687
11688     def GetMinSizeWithBorder(*args, **kwargs):
11689         """
11690         GetMinSizeWithBorder(self) -> Size
11691
11692         Get the minimum size needed for the item with space for the borders
11693         added, if needed.
11694         """
11695         return _core_.SizerItem_GetMinSizeWithBorder(*args, **kwargs)
11696
11697     def SetInitSize(*args, **kwargs):
11698         """SetInitSize(self, int x, int y)"""
11699         return _core_.SizerItem_SetInitSize(*args, **kwargs)
11700
11701     def SetRatioWH(*args, **kwargs):
11702         """
11703         SetRatioWH(self, int width, int height)
11704
11705         Set the ratio item attribute.
11706         """
11707         return _core_.SizerItem_SetRatioWH(*args, **kwargs)
11708
11709     def SetRatioSize(*args, **kwargs):
11710         """
11711         SetRatioSize(self, Size size)
11712
11713         Set the ratio item attribute.
11714         """
11715         return _core_.SizerItem_SetRatioSize(*args, **kwargs)
11716
11717     def SetRatio(*args, **kwargs):
11718         """
11719         SetRatio(self, float ratio)
11720
11721         Set the ratio item attribute.
11722         """
11723         return _core_.SizerItem_SetRatio(*args, **kwargs)
11724
11725     def GetRatio(*args, **kwargs):
11726         """
11727         GetRatio(self) -> float
11728
11729         Set the ratio item attribute.
11730         """
11731         return _core_.SizerItem_GetRatio(*args, **kwargs)
11732
11733     def GetRect(*args, **kwargs):
11734         """
11735         GetRect(self) -> Rect
11736
11737         Returns the rectangle that the sizer item should occupy
11738         """
11739         return _core_.SizerItem_GetRect(*args, **kwargs)
11740
11741     def IsWindow(*args, **kwargs):
11742         """
11743         IsWindow(self) -> bool
11744
11745         Is this sizer item a window?
11746         """
11747         return _core_.SizerItem_IsWindow(*args, **kwargs)
11748
11749     def IsSizer(*args, **kwargs):
11750         """
11751         IsSizer(self) -> bool
11752
11753         Is this sizer item a subsizer?
11754         """
11755         return _core_.SizerItem_IsSizer(*args, **kwargs)
11756
11757     def IsSpacer(*args, **kwargs):
11758         """
11759         IsSpacer(self) -> bool
11760
11761         Is this sizer item a spacer?
11762         """
11763         return _core_.SizerItem_IsSpacer(*args, **kwargs)
11764
11765     def SetProportion(*args, **kwargs):
11766         """
11767         SetProportion(self, int proportion)
11768
11769         Set the proportion value for this item.
11770         """
11771         return _core_.SizerItem_SetProportion(*args, **kwargs)
11772
11773     def GetProportion(*args, **kwargs):
11774         """
11775         GetProportion(self) -> int
11776
11777         Get the proportion value for this item.
11778         """
11779         return _core_.SizerItem_GetProportion(*args, **kwargs)
11780
11781     SetOption = wx._deprecated(SetProportion, "Please use `SetProportion` instead.")
11782     GetOption = wx._deprecated(GetProportion, "Please use `GetProportion` instead.")
11783     def SetFlag(*args, **kwargs):
11784         """
11785         SetFlag(self, int flag)
11786
11787         Set the flag value for this item.
11788         """
11789         return _core_.SizerItem_SetFlag(*args, **kwargs)
11790
11791     def GetFlag(*args, **kwargs):
11792         """
11793         GetFlag(self) -> int
11794
11795         Get the flag value for this item.
11796         """
11797         return _core_.SizerItem_GetFlag(*args, **kwargs)
11798
11799     def SetBorder(*args, **kwargs):
11800         """
11801         SetBorder(self, int border)
11802
11803         Set the border value for this item.
11804         """
11805         return _core_.SizerItem_SetBorder(*args, **kwargs)
11806
11807     def GetBorder(*args, **kwargs):
11808         """
11809         GetBorder(self) -> int
11810
11811         Get the border value for this item.
11812         """
11813         return _core_.SizerItem_GetBorder(*args, **kwargs)
11814
11815     def GetWindow(*args, **kwargs):
11816         """
11817         GetWindow(self) -> Window
11818
11819         Get the window (if any) that is managed by this sizer item.
11820         """
11821         return _core_.SizerItem_GetWindow(*args, **kwargs)
11822
11823     def SetWindow(*args, **kwargs):
11824         """
11825         SetWindow(self, Window window)
11826
11827         Set the window to be managed by this sizer item.
11828         """
11829         return _core_.SizerItem_SetWindow(*args, **kwargs)
11830
11831     def GetSizer(*args, **kwargs):
11832         """
11833         GetSizer(self) -> Sizer
11834
11835         Get the subsizer (if any) that is managed by this sizer item.
11836         """
11837         return _core_.SizerItem_GetSizer(*args, **kwargs)
11838
11839     def SetSizer(*args, **kwargs):
11840         """
11841         SetSizer(self, Sizer sizer)
11842
11843         Set the subsizer to be managed by this sizer item.
11844         """
11845         return _core_.SizerItem_SetSizer(*args, **kwargs)
11846
11847     def GetSpacer(*args, **kwargs):
11848         """
11849         GetSpacer(self) -> Size
11850
11851         Get the size of the spacer managed by this sizer item.
11852         """
11853         return _core_.SizerItem_GetSpacer(*args, **kwargs)
11854
11855     def SetSpacer(*args, **kwargs):
11856         """
11857         SetSpacer(self, Size size)
11858
11859         Set the size of the spacer to be managed by this sizer item.
11860         """
11861         return _core_.SizerItem_SetSpacer(*args, **kwargs)
11862
11863     def Show(*args, **kwargs):
11864         """
11865         Show(self, bool show)
11866
11867         Set the show item attribute, which sizers use to determine if the item
11868         is to be made part of the layout or not. If the item is tracking a
11869         window then it is shown or hidden as needed.
11870         """
11871         return _core_.SizerItem_Show(*args, **kwargs)
11872
11873     def IsShown(*args, **kwargs):
11874         """
11875         IsShown(self) -> bool
11876
11877         Is the item to be shown in the layout?
11878         """
11879         return _core_.SizerItem_IsShown(*args, **kwargs)
11880
11881     def GetPosition(*args, **kwargs):
11882         """
11883         GetPosition(self) -> Point
11884
11885         Returns the current position of the item, as set in the last Layout.
11886         """
11887         return _core_.SizerItem_GetPosition(*args, **kwargs)
11888
11889     def GetUserData(*args, **kwargs):
11890         """
11891         GetUserData(self) -> PyObject
11892
11893         Returns the userData associated with this sizer item, or None if there
11894         isn't any.
11895         """
11896         return _core_.SizerItem_GetUserData(*args, **kwargs)
11897
11898     def SetUserData(*args, **kwargs):
11899         """
11900         SetUserData(self, PyObject userData)
11901
11902         Associate a Python object with this sizer item.
11903         """
11904         return _core_.SizerItem_SetUserData(*args, **kwargs)
11905
11906     Border = property(GetBorder,SetBorder,doc="See `GetBorder` and `SetBorder`")
11907     Flag = property(GetFlag,SetFlag,doc="See `GetFlag` and `SetFlag`")
11908     MinSize = property(GetMinSize,doc="See `GetMinSize`")
11909     MinSizeWithBorder = property(GetMinSizeWithBorder,doc="See `GetMinSizeWithBorder`")
11910     Position = property(GetPosition,doc="See `GetPosition`")
11911     Proportion = property(GetProportion,SetProportion,doc="See `GetProportion` and `SetProportion`")
11912     Ratio = property(GetRatio,SetRatio,doc="See `GetRatio` and `SetRatio`")
11913     Rect = property(GetRect,doc="See `GetRect`")
11914     Size = property(GetSize,doc="See `GetSize`")
11915     Sizer = property(GetSizer,SetSizer,doc="See `GetSizer` and `SetSizer`")
11916     Spacer = property(GetSpacer,SetSpacer,doc="See `GetSpacer` and `SetSpacer`")
11917     UserData = property(GetUserData,SetUserData,doc="See `GetUserData` and `SetUserData`")
11918     Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`")
11919 _core_.SizerItem_swigregister(SizerItem)
11920
11921 def SizerItemWindow(*args, **kwargs):
11922     """
11923     SizerItemWindow(Window window, int proportion, int flag, int border,
11924         PyObject userData=None) -> SizerItem
11925
11926     Constructs a `wx.SizerItem` for tracking a window.
11927     """
11928     val = _core_.new_SizerItemWindow(*args, **kwargs)
11929     return val
11930
11931 def SizerItemSpacer(*args, **kwargs):
11932     """
11933     SizerItemSpacer(int width, int height, int proportion, int flag, int border,
11934         PyObject userData=None) -> SizerItem
11935
11936     Constructs a `wx.SizerItem` for tracking a spacer.
11937     """
11938     val = _core_.new_SizerItemSpacer(*args, **kwargs)
11939     return val
11940
11941 def SizerItemSizer(*args, **kwargs):
11942     """
11943     SizerItemSizer(Sizer sizer, int proportion, int flag, int border,
11944         PyObject userData=None) -> SizerItem
11945
11946     Constructs a `wx.SizerItem` for tracking a subsizer
11947     """
11948     val = _core_.new_SizerItemSizer(*args, **kwargs)
11949     return val
11950
11951 class Sizer(Object):
11952     """
11953     wx.Sizer is the abstract base class used for laying out subwindows in
11954     a window.  You cannot use wx.Sizer directly; instead, you will have to
11955     use one of the sizer classes derived from it such as `wx.BoxSizer`,
11956     `wx.StaticBoxSizer`, `wx.GridSizer`, `wx.FlexGridSizer` and
11957     `wx.GridBagSizer`.
11958
11959     The concept implemented by sizers in wxWidgets is closely related to
11960     layout tools in other GUI toolkits, such as Java's AWT, the GTK
11961     toolkit or the Qt toolkit. It is based upon the idea of the individual
11962     subwindows reporting their minimal required size and their ability to
11963     get stretched if the size of the parent window has changed. This will
11964     most often mean that the programmer does not set the original size of
11965     a dialog in the beginning, rather the dialog will assigned a sizer and
11966     this sizer will be queried about the recommended size. The sizer in
11967     turn will query its children, which can be normal windows or contorls,
11968     empty space or other sizers, so that a hierarchy of sizers can be
11969     constructed. Note that wxSizer does not derive from wxWindow and thus
11970     do not interfere with tab ordering and requires very little resources
11971     compared to a real window on screen.
11972
11973     What makes sizers so well fitted for use in wxWidgets is the fact that
11974     every control reports its own minimal size and the algorithm can
11975     handle differences in font sizes or different window (dialog item)
11976     sizes on different platforms without problems. If for example the
11977     standard font as well as the overall design of Mac widgets requires
11978     more space than on Windows, then the initial size of a dialog using a
11979     sizer will automatically be bigger on Mac than on Windows.
11980     """
11981     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11982     def __init__(self): raise AttributeError, "No constructor defined"
11983     __repr__ = _swig_repr
11984     __swig_destroy__ = _core_.delete_Sizer
11985     __del__ = lambda self : None;
11986     def _setOORInfo(*args, **kwargs):
11987         """_setOORInfo(self, PyObject _self)"""
11988         return _core_.Sizer__setOORInfo(*args, **kwargs)
11989
11990     def Add(*args, **kwargs):
11991         """
11992         Add(self, item, int proportion=0, int flag=0, int border=0,
11993             PyObject userData=None) -> wx.SizerItem
11994
11995         Appends a child item to the sizer.
11996         """
11997         return _core_.Sizer_Add(*args, **kwargs)
11998
11999     def Insert(*args, **kwargs):
12000         """
12001         Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
12002             PyObject userData=None) -> wx.SizerItem
12003
12004         Inserts a new item into the list of items managed by this sizer before
12005         the item at index *before*.  See `Add` for a description of the parameters.
12006         """
12007         return _core_.Sizer_Insert(*args, **kwargs)
12008
12009     def Prepend(*args, **kwargs):
12010         """
12011         Prepend(self, item, int proportion=0, int flag=0, int border=0,
12012             PyObject userData=None) -> wx.SizerItem
12013
12014         Adds a new item to the begining of the list of sizer items managed by
12015         this sizer.  See `Add` for a description of the parameters.
12016         """
12017         return _core_.Sizer_Prepend(*args, **kwargs)
12018
12019     def Remove(*args, **kwargs):
12020         """
12021         Remove(self, item) -> bool
12022
12023         Removes an item from the sizer and destroys it.  This method does not
12024         cause any layout or resizing to take place, call `Layout` to update
12025         the layout on screen after removing a child from the sizer.  The
12026         *item* parameter can be either a window, a sizer, or the zero-based
12027         index of an item to remove.  Returns True if the child item was found
12028         and removed.
12029         """
12030         return _core_.Sizer_Remove(*args, **kwargs)
12031
12032     def Detach(*args, **kwargs):
12033         """
12034         Detach(self, item) -> bool
12035
12036         Detaches an item from the sizer without destroying it.  This method
12037         does not cause any layout or resizing to take place, call `Layout` to
12038         do so.  The *item* parameter can be either a window, a sizer, or the
12039         zero-based index of the item to be detached.  Returns True if the child item
12040         was found and detached.
12041         """
12042         return _core_.Sizer_Detach(*args, **kwargs)
12043
12044     def GetItem(*args, **kwargs):
12045         """
12046         GetItem(self, item) -> wx.SizerItem
12047
12048         Returns the `wx.SizerItem` which holds the *item* given.  The *item*
12049         parameter can be either a window, a sizer, or the zero-based index of
12050         the item to be found.
12051         """
12052         return _core_.Sizer_GetItem(*args, **kwargs)
12053
12054     def _SetItemMinSize(*args, **kwargs):
12055         """_SetItemMinSize(self, PyObject item, Size size)"""
12056         return _core_.Sizer__SetItemMinSize(*args, **kwargs)
12057
12058     def _ReplaceWin(*args, **kwargs):
12059         """_ReplaceWin(self, Window oldwin, Window newwin, bool recursive=False) -> bool"""
12060         return _core_.Sizer__ReplaceWin(*args, **kwargs)
12061
12062     def _ReplaceSizer(*args, **kwargs):
12063         """_ReplaceSizer(self, Sizer oldsz, Sizer newsz, bool recursive=False) -> bool"""
12064         return _core_.Sizer__ReplaceSizer(*args, **kwargs)
12065
12066     def _ReplaceItem(*args, **kwargs):
12067         """_ReplaceItem(self, size_t index, SizerItem newitem) -> bool"""
12068         return _core_.Sizer__ReplaceItem(*args, **kwargs)
12069
12070     def Replace(self, olditem, item, recursive=False):
12071         """
12072         Detaches the given ``olditem`` from the sizer and replaces it with
12073         ``item`` which can be a window, sizer, or `wx.SizerItem`.  The
12074         detached child is destroyed only if it is not a window, (because
12075         windows are owned by their parent, not the sizer.)  The
12076         ``recursive`` parameter can be used to search for the given
12077         element recursivly in subsizers.
12078
12079         This method does not cause any layout or resizing to take place,
12080         call `Layout` to do so.
12081
12082         Returns ``True`` if the child item was found and removed.
12083         """
12084         if isinstance(olditem, wx.Window):
12085             return self._ReplaceWin(olditem, item, recursive)
12086         elif isinstnace(olditem, wx.Sizer):
12087             return self._ReplaceSizer(olditem, item, recursive)
12088         elif isinstnace(olditem, int):
12089             return self._ReplaceItem(olditem, item)
12090         else:
12091             raise TypeError("Expected Window, Sizer, or integer for first parameter.")
12092
12093     def SetContainingWindow(*args, **kwargs):
12094         """
12095         SetContainingWindow(self, Window window)
12096
12097         Set (or unset) the window this sizer is used in.
12098         """
12099         return _core_.Sizer_SetContainingWindow(*args, **kwargs)
12100
12101     def GetContainingWindow(*args, **kwargs):
12102         """
12103         GetContainingWindow(self) -> Window
12104
12105         Get the window this sizer is used in.
12106         """
12107         return _core_.Sizer_GetContainingWindow(*args, **kwargs)
12108
12109     def SetItemMinSize(self, item, *args):
12110         """
12111         SetItemMinSize(self, item, Size size)
12112
12113         Sets the minimum size that will be allocated for an item in the sizer.
12114         The *item* parameter can be either a window, a sizer, or the
12115         zero-based index of the item.  If a window or sizer is given then it
12116         will be searched for recursivly in subsizers if neccessary.
12117         """
12118         if len(args) == 2:
12119             # for backward compatibility accept separate width,height args too
12120             return self._SetItemMinSize(item, args)
12121         else:
12122             return self._SetItemMinSize(item, args[0])
12123
12124     def AddItem(*args, **kwargs):
12125         """
12126         AddItem(self, SizerItem item)
12127
12128         Adds a `wx.SizerItem` to the sizer.
12129         """
12130         return _core_.Sizer_AddItem(*args, **kwargs)
12131
12132     def InsertItem(*args, **kwargs):
12133         """
12134         InsertItem(self, int index, SizerItem item)
12135
12136         Inserts a `wx.SizerItem` to the sizer at the position given by *index*.
12137         """
12138         return _core_.Sizer_InsertItem(*args, **kwargs)
12139
12140     def PrependItem(*args, **kwargs):
12141         """
12142         PrependItem(self, SizerItem item)
12143
12144         Prepends a `wx.SizerItem` to the sizer.
12145         """
12146         return _core_.Sizer_PrependItem(*args, **kwargs)
12147
12148     def AddMany(self, items):
12149         """
12150         AddMany is a convenience method for adding several items
12151         to a sizer at one time.  Simply pass it a list of tuples,
12152         where each tuple consists of the parameters that you
12153         would normally pass to the `Add` method.
12154         """
12155         for item in items:
12156             if type(item) != type(()) or (len(item) == 2 and type(item[0]) == type(1)):
12157                 item = (item, )
12158             self.Add(*item)
12159
12160     def AddSpacer(self, *args, **kw):
12161         """AddSpacer(int size) --> SizerItem
12162
12163         Add a spacer that is (size,size) pixels.
12164         """
12165         if args and type(args[0]) == int:
12166             return self.Add( (args[0],args[0] ), 0)
12167         else: # otherwise stay compatible with old AddSpacer
12168             return self.Add(*args, **kw)
12169     def PrependSpacer(self, *args, **kw):
12170         """PrependSpacer(int size) --> SizerItem
12171
12172         Prepend a spacer that is (size, size) pixels."""
12173         if args and type(args[0]) == int:
12174             return self.Prepend( (args[0],args[0] ), 0)
12175         else: # otherwise stay compatible with old PrependSpacer
12176             return self.Prepend(*args, **kw)
12177     def InsertSpacer(self, index, *args, **kw):
12178         """InsertSpacer(int index, int size) --> SizerItem
12179
12180         Insert a spacer at position index that is (size, size) pixels."""
12181         if args and type(args[0]) == int:
12182             return self.Insert( index, (args[0],args[0] ), 0)
12183         else: # otherwise stay compatible with old InsertSpacer
12184             return self.Insert(index, *args, **kw)
12185
12186
12187     def AddStretchSpacer(self, prop=1):
12188         """AddStretchSpacer(int prop=1) --> SizerItem
12189
12190         Add a stretchable spacer."""
12191         return self.Add((0,0), prop)
12192     def PrependStretchSpacer(self, prop=1):
12193         """PrependStretchSpacer(int prop=1) --> SizerItem
12194
12195         Prepend a stretchable spacer."""
12196         return self.Prepend((0,0), prop)
12197     def InsertStretchSpacer(self, index, prop=1):
12198         """InsertStretchSpacer(int index, int prop=1) --> SizerItem
12199
12200         Insert a stretchable spacer."""
12201         return self.Insert(index, (0,0), prop)
12202
12203
12204     # for backwards compatibility only, please do not use in new code
12205     def AddWindow(self, *args, **kw):
12206         """Compatibility alias for `Add`."""
12207         return self.Add(*args, **kw)
12208     def AddSizer(self, *args, **kw):
12209         """Compatibility alias for `Add`."""
12210         return self.Add(*args, **kw)
12211
12212     def PrependWindow(self, *args, **kw):
12213         """Compatibility alias for `Prepend`."""
12214         return self.Prepend(*args, **kw)
12215     def PrependSizer(self, *args, **kw):
12216         """Compatibility alias for `Prepend`."""
12217         return self.Prepend(*args, **kw)
12218
12219     def InsertWindow(self, *args, **kw):
12220         """Compatibility alias for `Insert`."""
12221         return self.Insert(*args, **kw)
12222     def InsertSizer(self, *args, **kw):
12223         """Compatibility alias for `Insert`."""
12224         return self.Insert(*args, **kw)
12225
12226     def RemoveWindow(self, *args, **kw):
12227         """Compatibility alias for `Remove`."""
12228         return self.Remove(*args, **kw)
12229     def RemoveSizer(self, *args, **kw):
12230         """Compatibility alias for `Remove`."""
12231         return self.Remove(*args, **kw)
12232     def RemovePos(self, *args, **kw):
12233         """Compatibility alias for `Remove`."""
12234         return self.Remove(*args, **kw)
12235
12236
12237     def SetDimension(*args, **kwargs):
12238         """
12239         SetDimension(self, int x, int y, int width, int height)
12240
12241         Call this to force the sizer to take the given dimension and thus
12242         force the items owned by the sizer to resize themselves according to
12243         the rules defined by the parameter in the `Add`, `Insert` or `Prepend`
12244         methods.
12245         """
12246         return _core_.Sizer_SetDimension(*args, **kwargs)
12247
12248     def SetMinSize(*args, **kwargs):
12249         """
12250         SetMinSize(self, Size size)
12251
12252         Call this to give the sizer a minimal size. Normally, the sizer will
12253         calculate its minimal size based purely on how much space its children
12254         need. After calling this method `GetMinSize` will return either the
12255         minimal size as requested by its children or the minimal size set
12256         here, depending on which is bigger.
12257         """
12258         return _core_.Sizer_SetMinSize(*args, **kwargs)
12259
12260     def GetSize(*args, **kwargs):
12261         """
12262         GetSize(self) -> Size
12263
12264         Returns the current size of the space managed by the sizer.
12265         """
12266         return _core_.Sizer_GetSize(*args, **kwargs)
12267
12268     def GetPosition(*args, **kwargs):
12269         """
12270         GetPosition(self) -> Point
12271
12272         Returns the current position of the sizer's managed space.
12273         """
12274         return _core_.Sizer_GetPosition(*args, **kwargs)
12275
12276     def GetMinSize(*args, **kwargs):
12277         """
12278         GetMinSize(self) -> Size
12279
12280         Returns the minimal size of the sizer. This is either the combined
12281         minimal size of all the children and their borders or the minimal size
12282         set by SetMinSize, depending on which is bigger.
12283         """
12284         return _core_.Sizer_GetMinSize(*args, **kwargs)
12285
12286     def GetSizeTuple(self):
12287         return self.GetSize().Get()
12288     def GetPositionTuple(self):
12289         return self.GetPosition().Get()
12290     def GetMinSizeTuple(self):
12291         return self.GetMinSize().Get()
12292
12293     def RecalcSizes(*args, **kwargs):
12294         """
12295         RecalcSizes(self)
12296
12297         Using the sizes calculated by `CalcMin` reposition and resize all the
12298         items managed by this sizer.  You should not need to call this directly as
12299         it is called by `Layout`.
12300         """
12301         return _core_.Sizer_RecalcSizes(*args, **kwargs)
12302
12303     def CalcMin(*args, **kwargs):
12304         """
12305         CalcMin(self) -> Size
12306
12307         This method is where the sizer will do the actual calculation of its
12308         children's minimal sizes.  You should not need to call this directly as
12309         it is called by `Layout`.
12310         """
12311         return _core_.Sizer_CalcMin(*args, **kwargs)
12312
12313     def Layout(*args, **kwargs):
12314         """
12315         Layout(self)
12316
12317         This method will force the recalculation and layout of the items
12318         controlled by the sizer using the current space allocated to the
12319         sizer.  Normally this is called automatically from the owning window's
12320         EVT_SIZE handler, but it is also useful to call it from user code when
12321         one of the items in a sizer change size, or items are added or
12322         removed.
12323         """
12324         return _core_.Sizer_Layout(*args, **kwargs)
12325
12326     def Fit(*args, **kwargs):
12327         """
12328         Fit(self, Window window) -> Size
12329
12330         Tell the sizer to resize the *window* to match the sizer's minimal
12331         size. This is commonly done in the constructor of the window itself in
12332         order to set its initial size to match the needs of the children as
12333         determined by the sizer.  Returns the new size.
12334
12335         For a top level window this is the total window size, not the client size.
12336         """
12337         return _core_.Sizer_Fit(*args, **kwargs)
12338
12339     def FitInside(*args, **kwargs):
12340         """
12341         FitInside(self, Window window)
12342
12343         Tell the sizer to resize the *virtual size* of the *window* to match the
12344         sizer's minimal size. This will not alter the on screen size of the
12345         window, but may cause the addition/removal/alteration of scrollbars
12346         required to view the virtual area in windows which manage it.
12347
12348         :see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints`
12349
12350         """
12351         return _core_.Sizer_FitInside(*args, **kwargs)
12352
12353     def SetSizeHints(*args, **kwargs):
12354         """
12355         SetSizeHints(self, Window window)
12356
12357         Tell the sizer to set (and `Fit`) the minimal size of the *window* to
12358         match the sizer's minimal size. This is commonly done in the
12359         constructor of the window itself if the window is resizable (as are
12360         many dialogs under Unix and frames on probably all platforms) in order
12361         to prevent the window from being sized smaller than the minimal size
12362         required by the sizer.
12363         """
12364         return _core_.Sizer_SetSizeHints(*args, **kwargs)
12365
12366     def SetVirtualSizeHints(*args, **kwargs):
12367         """
12368         SetVirtualSizeHints(self, Window window)
12369
12370         Tell the sizer to set the minimal size of the window virtual area to
12371         match the sizer's minimal size. For windows with managed scrollbars
12372         this will set them appropriately.
12373
12374         :see: `wx.ScrolledWindow.SetScrollbars`
12375
12376         """
12377         return _core_.Sizer_SetVirtualSizeHints(*args, **kwargs)
12378
12379     def Clear(*args, **kwargs):
12380         """
12381         Clear(self, bool deleteWindows=False)
12382
12383         Clear all items from the sizer, optionally destroying the window items
12384         as well.
12385         """
12386         return _core_.Sizer_Clear(*args, **kwargs)
12387
12388     def DeleteWindows(*args, **kwargs):
12389         """
12390         DeleteWindows(self)
12391
12392         Destroy all windows managed by the sizer.
12393         """
12394         return _core_.Sizer_DeleteWindows(*args, **kwargs)
12395
12396     def GetChildren(*args, **kwargs):
12397         """
12398         GetChildren(self) -> list
12399
12400         Returns a list of all the `wx.SizerItem` objects managed by the sizer.
12401         """
12402         return _core_.Sizer_GetChildren(*args, **kwargs)
12403
12404     def Show(*args, **kwargs):
12405         """
12406         Show(self, item, bool show=True, bool recursive=false) -> bool
12407
12408         Shows or hides an item managed by the sizer.  To make a sizer item
12409         disappear or reappear, use Show followed by `Layout`.  The *item*
12410         parameter can be either a window, a sizer, or the zero-based index of
12411         the item.  Use the recursive parameter to show or hide an item in a
12412         subsizer.  Returns True if the item was found.
12413         """
12414         return _core_.Sizer_Show(*args, **kwargs)
12415
12416     def IsShown(*args, **kwargs):
12417         """
12418         IsShown(self, item)
12419
12420         Determines if the item is currently shown. To make a sizer
12421         item disappear or reappear, use Show followed by `Layout`.  The *item*
12422         parameter can be either a window, a sizer, or the zero-based index of
12423         the item.
12424         """
12425         return _core_.Sizer_IsShown(*args, **kwargs)
12426
12427     def Hide(self, item, recursive=False):
12428         """
12429         A convenience method for `Show` (item, False, recursive).
12430         """
12431         return self.Show(item, False, recursive)
12432
12433     def ShowItems(*args, **kwargs):
12434         """
12435         ShowItems(self, bool show)
12436
12437         Recursively call `wx.SizerItem.Show` on all sizer items.
12438         """
12439         return _core_.Sizer_ShowItems(*args, **kwargs)
12440
12441     Children = property(GetChildren,doc="See `GetChildren`")
12442     ContainingWindow = property(GetContainingWindow,SetContainingWindow,doc="See `GetContainingWindow` and `SetContainingWindow`")
12443     MinSize = property(GetMinSize,SetMinSize,doc="See `GetMinSize` and `SetMinSize`")
12444     Position = property(GetPosition,doc="See `GetPosition`")
12445     Size = property(GetSize,doc="See `GetSize`")
12446 _core_.Sizer_swigregister(Sizer)
12447
12448 class PySizer(Sizer):
12449     """
12450     wx.PySizer is a special version of `wx.Sizer` that has been
12451     instrumented to allow the C++ virtual methods to be overloaded in
12452     Python derived classes.  You would derive from this class if you are
12453     wanting to implement a custom sizer in Python code.  Simply implement
12454     `CalcMin` and `RecalcSizes` in the derived class and you're all set.
12455     For example::
12456
12457         class MySizer(wx.PySizer):
12458              def __init__(self):
12459                  wx.PySizer.__init__(self)
12460
12461              def CalcMin(self):
12462                  for item in self.GetChildren():
12463                       # calculate the total minimum width and height needed
12464                       # by all items in the sizer according to this sizer's
12465                       # layout algorithm.
12466                       ...
12467                  return wx.Size(width, height)
12468
12469               def RecalcSizes(self):
12470                   # find the space allotted to this sizer
12471                   pos = self.GetPosition()
12472                   size = self.GetSize()
12473                   for item in self.GetChildren():
12474                       # Recalculate (if necessary) the position and size of
12475                       # each item and then call item.SetDimension to do the
12476                       # actual positioning and sizing of the items within the
12477                       # space alloted to this sizer.
12478                       ...
12479                       item.SetDimension(itemPos, itemSize)
12480
12481
12482     When `Layout` is called it first calls `CalcMin` followed by
12483     `RecalcSizes` so you can optimize a bit by saving the results of
12484     `CalcMin` and reusing them in `RecalcSizes`.
12485
12486     :see: `wx.SizerItem`, `wx.Sizer.GetChildren`
12487
12488
12489     """
12490     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12491     __repr__ = _swig_repr
12492     def __init__(self, *args, **kwargs):
12493         """
12494         __init__(self) -> PySizer
12495
12496         Creates a wx.PySizer.  Must be called from the __init__ in the derived
12497         class.
12498         """
12499         _core_.PySizer_swiginit(self,_core_.new_PySizer(*args, **kwargs))
12500         self._setOORInfo(self);PySizer._setCallbackInfo(self, self, PySizer)
12501
12502     def _setCallbackInfo(*args, **kwargs):
12503         """_setCallbackInfo(self, PyObject self, PyObject _class)"""
12504         return _core_.PySizer__setCallbackInfo(*args, **kwargs)
12505
12506 _core_.PySizer_swigregister(PySizer)
12507
12508 #---------------------------------------------------------------------------
12509
12510 class BoxSizer(Sizer):
12511     """
12512     The basic idea behind a box sizer is that windows will most often be
12513     laid out in rather simple basic geometry, typically in a row or a
12514     column or nested hierarchies of either.  A wx.BoxSizer will lay out
12515     its items in a simple row or column, depending on the orientation
12516     parameter passed to the constructor.
12517     """
12518     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12519     __repr__ = _swig_repr
12520     def __init__(self, *args, **kwargs):
12521         """
12522         __init__(self, int orient=HORIZONTAL) -> BoxSizer
12523
12524         Constructor for a wx.BoxSizer. *orient* may be one of ``wx.VERTICAL``
12525         or ``wx.HORIZONTAL`` for creating either a column sizer or a row
12526         sizer.
12527         """
12528         _core_.BoxSizer_swiginit(self,_core_.new_BoxSizer(*args, **kwargs))
12529         self._setOORInfo(self)
12530
12531     def GetOrientation(*args, **kwargs):
12532         """
12533         GetOrientation(self) -> int
12534
12535         Returns the current orientation of the sizer.
12536         """
12537         return _core_.BoxSizer_GetOrientation(*args, **kwargs)
12538
12539     def SetOrientation(*args, **kwargs):
12540         """
12541         SetOrientation(self, int orient)
12542
12543         Resets the orientation of the sizer.
12544         """
12545         return _core_.BoxSizer_SetOrientation(*args, **kwargs)
12546
12547     Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`")
12548 _core_.BoxSizer_swigregister(BoxSizer)
12549
12550 #---------------------------------------------------------------------------
12551
12552 class StaticBoxSizer(BoxSizer):
12553     """
12554     wx.StaticBoxSizer derives from and functions identically to the
12555     `wx.BoxSizer` and adds a `wx.StaticBox` around the items that the sizer
12556     manages.  Note that this static box must be created separately and
12557     passed to the sizer constructor.
12558     """
12559     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12560     __repr__ = _swig_repr
12561     def __init__(self, *args, **kwargs):
12562         """
12563         __init__(self, StaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer
12564
12565         Constructor. It takes an associated static box and the orientation
12566         *orient* as parameters - orient can be either of ``wx.VERTICAL`` or
12567         ``wx.HORIZONTAL``.
12568         """
12569         _core_.StaticBoxSizer_swiginit(self,_core_.new_StaticBoxSizer(*args, **kwargs))
12570         self._setOORInfo(self)
12571
12572     def GetStaticBox(*args, **kwargs):
12573         """
12574         GetStaticBox(self) -> StaticBox
12575
12576         Returns the static box associated with this sizer.
12577         """
12578         return _core_.StaticBoxSizer_GetStaticBox(*args, **kwargs)
12579
12580     StaticBox = property(GetStaticBox,doc="See `GetStaticBox`")
12581 _core_.StaticBoxSizer_swigregister(StaticBoxSizer)
12582
12583 #---------------------------------------------------------------------------
12584
12585 class GridSizer(Sizer):
12586     """
12587     A grid sizer is a sizer which lays out its children in a
12588     two-dimensional table with all cells having the same size.  In other
12589     words, the width of each cell within the grid is the width of the
12590     widest item added to the sizer and the height of each grid cell is the
12591     height of the tallest item.  An optional vertical and/or horizontal
12592     gap between items can also be specified (in pixels.)
12593
12594     Items are placed in the cells of the grid in the order they are added,
12595     in row-major order.  In other words, the first row is filled first,
12596     then the second, and so on until all items have been added. (If
12597     neccessary, additional rows will be added as items are added.)  If you
12598     need to have greater control over the cells that items are placed in
12599     then use the `wx.GridBagSizer`.
12600
12601     """
12602     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12603     __repr__ = _swig_repr
12604     def __init__(self, *args, **kwargs):
12605         """
12606         __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer
12607
12608         Constructor for a wx.GridSizer. *rows* and *cols* determine the number
12609         of columns and rows in the sizer - if either of the parameters is
12610         zero, it will be calculated to from the total number of children in
12611         the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
12612         define extra space between all children.
12613         """
12614         _core_.GridSizer_swiginit(self,_core_.new_GridSizer(*args, **kwargs))
12615         self._setOORInfo(self)
12616
12617     def SetCols(*args, **kwargs):
12618         """
12619         SetCols(self, int cols)
12620
12621         Sets the number of columns in the sizer.
12622         """
12623         return _core_.GridSizer_SetCols(*args, **kwargs)
12624
12625     def SetRows(*args, **kwargs):
12626         """
12627         SetRows(self, int rows)
12628
12629         Sets the number of rows in the sizer.
12630         """
12631         return _core_.GridSizer_SetRows(*args, **kwargs)
12632
12633     def SetVGap(*args, **kwargs):
12634         """
12635         SetVGap(self, int gap)
12636
12637         Sets the vertical gap (in pixels) between the cells in the sizer.
12638         """
12639         return _core_.GridSizer_SetVGap(*args, **kwargs)
12640
12641     def SetHGap(*args, **kwargs):
12642         """
12643         SetHGap(self, int gap)
12644
12645         Sets the horizontal gap (in pixels) between cells in the sizer
12646         """
12647         return _core_.GridSizer_SetHGap(*args, **kwargs)
12648
12649     def GetCols(*args, **kwargs):
12650         """
12651         GetCols(self) -> int
12652
12653         Returns the number of columns in the sizer.
12654         """
12655         return _core_.GridSizer_GetCols(*args, **kwargs)
12656
12657     def GetRows(*args, **kwargs):
12658         """
12659         GetRows(self) -> int
12660
12661         Returns the number of rows in the sizer.
12662         """
12663         return _core_.GridSizer_GetRows(*args, **kwargs)
12664
12665     def GetVGap(*args, **kwargs):
12666         """
12667         GetVGap(self) -> int
12668
12669         Returns the vertical gap (in pixels) between the cells in the sizer.
12670         """
12671         return _core_.GridSizer_GetVGap(*args, **kwargs)
12672
12673     def GetHGap(*args, **kwargs):
12674         """
12675         GetHGap(self) -> int
12676
12677         Returns the horizontal gap (in pixels) between cells in the sizer.
12678         """
12679         return _core_.GridSizer_GetHGap(*args, **kwargs)
12680
12681     def CalcRowsCols(self):
12682         """
12683         CalcRowsCols() -> (rows, cols)
12684
12685         Calculates how many rows and columns will be in the sizer based
12686         on the current number of items and also the rows, cols specified
12687         in the constructor.
12688         """
12689         nitems = len(self.GetChildren())
12690         rows = self.GetRows()
12691         cols = self.GetCols()
12692         assert rows != 0 or cols != 0, "Grid sizer must have either rows or columns fixed"
12693         if cols != 0:
12694             rows = (nitems + cols - 1) / cols
12695         elif rows != 0:
12696             cols = (nitems + rows - 1) / rows
12697         return (rows, cols)
12698
12699     Cols = property(GetCols,SetCols,doc="See `GetCols` and `SetCols`")
12700     HGap = property(GetHGap,SetHGap,doc="See `GetHGap` and `SetHGap`")
12701     Rows = property(GetRows,SetRows,doc="See `GetRows` and `SetRows`")
12702     VGap = property(GetVGap,SetVGap,doc="See `GetVGap` and `SetVGap`")
12703 _core_.GridSizer_swigregister(GridSizer)
12704
12705 #---------------------------------------------------------------------------
12706
12707 FLEX_GROWMODE_NONE = _core_.FLEX_GROWMODE_NONE
12708 FLEX_GROWMODE_SPECIFIED = _core_.FLEX_GROWMODE_SPECIFIED
12709 FLEX_GROWMODE_ALL = _core_.FLEX_GROWMODE_ALL
12710 class FlexGridSizer(GridSizer):
12711     """
12712     A flex grid sizer is a sizer which lays out its children in a
12713     two-dimensional table with all table cells in one row having the same
12714     height and all cells in one column having the same width, but all
12715     rows or all columns are not necessarily the same height or width as in
12716     the `wx.GridSizer`.
12717
12718     wx.FlexGridSizer can also size items equally in one direction but
12719     unequally ("flexibly") in the other. If the sizer is only flexible
12720     in one direction (this can be changed using `SetFlexibleDirection`), it
12721     needs to be decided how the sizer should grow in the other ("non
12722     flexible") direction in order to fill the available space. The
12723     `SetNonFlexibleGrowMode` method serves this purpose.
12724
12725
12726     """
12727     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12728     __repr__ = _swig_repr
12729     def __init__(self, *args, **kwargs):
12730         """
12731         __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer
12732
12733         Constructor for a wx.FlexGridSizer. *rows* and *cols* determine the
12734         number of columns and rows in the sizer - if either of the parameters
12735         is zero, it will be calculated to from the total number of children in
12736         the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
12737         define extra space between all children.
12738         """
12739         _core_.FlexGridSizer_swiginit(self,_core_.new_FlexGridSizer(*args, **kwargs))
12740         self._setOORInfo(self)
12741
12742     def AddGrowableRow(*args, **kwargs):
12743         """
12744         AddGrowableRow(self, size_t idx, int proportion=0)
12745
12746         Specifies that row *idx* (starting from zero) should be grown if there
12747         is extra space available to the sizer.
12748
12749         The *proportion* parameter has the same meaning as the stretch factor
12750         for the box sizers except that if all proportions are 0, then all
12751         columns are resized equally (instead of not being resized at all).
12752         """
12753         return _core_.FlexGridSizer_AddGrowableRow(*args, **kwargs)
12754
12755     def RemoveGrowableRow(*args, **kwargs):
12756         """
12757         RemoveGrowableRow(self, size_t idx)
12758
12759         Specifies that row *idx* is no longer growable.
12760         """
12761         return _core_.FlexGridSizer_RemoveGrowableRow(*args, **kwargs)
12762
12763     def AddGrowableCol(*args, **kwargs):
12764         """
12765         AddGrowableCol(self, size_t idx, int proportion=0)
12766
12767         Specifies that column *idx* (starting from zero) should be grown if
12768         there is extra space available to the sizer.
12769
12770         The *proportion* parameter has the same meaning as the stretch factor
12771         for the box sizers except that if all proportions are 0, then all
12772         columns are resized equally (instead of not being resized at all).
12773         """
12774         return _core_.FlexGridSizer_AddGrowableCol(*args, **kwargs)
12775
12776     def RemoveGrowableCol(*args, **kwargs):
12777         """
12778         RemoveGrowableCol(self, size_t idx)
12779
12780         Specifies that column *idx* is no longer growable.
12781         """
12782         return _core_.FlexGridSizer_RemoveGrowableCol(*args, **kwargs)
12783
12784     def SetFlexibleDirection(*args, **kwargs):
12785         """
12786         SetFlexibleDirection(self, int direction)
12787
12788         Specifies whether the sizer should flexibly resize its columns, rows,
12789         or both. Argument *direction* can be one of the following values.  Any
12790         other value is ignored.
12791
12792             ==============    =======================================
12793             wx.VERTICAL       Rows are flexibly sized.
12794             wx.HORIZONTAL     Columns are flexibly sized.
12795             wx.BOTH           Both rows and columns are flexibly sized
12796                               (this is the default value).
12797             ==============    =======================================
12798
12799         Note that this method does not trigger relayout.
12800
12801         """
12802         return _core_.FlexGridSizer_SetFlexibleDirection(*args, **kwargs)
12803
12804     def GetFlexibleDirection(*args, **kwargs):
12805         """
12806         GetFlexibleDirection(self) -> int
12807
12808         Returns a value that specifies whether the sizer
12809         flexibly resizes its columns, rows, or both (default).
12810
12811         :see: `SetFlexibleDirection`
12812         """
12813         return _core_.FlexGridSizer_GetFlexibleDirection(*args, **kwargs)
12814
12815     def SetNonFlexibleGrowMode(*args, **kwargs):
12816         """
12817         SetNonFlexibleGrowMode(self, int mode)
12818
12819         Specifies how the sizer should grow in the non-flexible direction if
12820         there is one (so `SetFlexibleDirection` must have been called
12821         previously). Argument *mode* can be one of the following values:
12822
12823             ==========================  =================================================
12824             wx.FLEX_GROWMODE_NONE       Sizer doesn't grow in the non flexible direction.
12825             wx.FLEX_GROWMODE_SPECIFIED  Sizer honors growable columns/rows set with
12826                                         `AddGrowableCol` and `AddGrowableRow`. In this
12827                                         case equal sizing applies to minimum sizes of
12828                                         columns or rows (this is the default value).
12829             wx.FLEX_GROWMODE_ALL        Sizer equally stretches all columns or rows in
12830                                         the non flexible direction, whether they are
12831                                         growable or not in the flexbile direction.
12832             ==========================  =================================================
12833
12834         Note that this method does not trigger relayout.
12835         """
12836         return _core_.FlexGridSizer_SetNonFlexibleGrowMode(*args, **kwargs)
12837
12838     def GetNonFlexibleGrowMode(*args, **kwargs):
12839         """
12840         GetNonFlexibleGrowMode(self) -> int
12841
12842         Returns the value that specifies how the sizer grows in the
12843         non-flexible direction if there is one.
12844
12845         :see: `SetNonFlexibleGrowMode`
12846         """
12847         return _core_.FlexGridSizer_GetNonFlexibleGrowMode(*args, **kwargs)
12848
12849     def GetRowHeights(*args, **kwargs):
12850         """
12851         GetRowHeights(self) -> list
12852
12853         Returns a list of integers representing the heights of each of the
12854         rows in the sizer.
12855         """
12856         return _core_.FlexGridSizer_GetRowHeights(*args, **kwargs)
12857
12858     def GetColWidths(*args, **kwargs):
12859         """
12860         GetColWidths(self) -> list
12861
12862         Returns a list of integers representing the widths of each of the
12863         columns in the sizer.
12864         """
12865         return _core_.FlexGridSizer_GetColWidths(*args, **kwargs)
12866
12867     ColWidths = property(GetColWidths,doc="See `GetColWidths`")
12868     FlexibleDirection = property(GetFlexibleDirection,SetFlexibleDirection,doc="See `GetFlexibleDirection` and `SetFlexibleDirection`")
12869     NonFlexibleGrowMode = property(GetNonFlexibleGrowMode,SetNonFlexibleGrowMode,doc="See `GetNonFlexibleGrowMode` and `SetNonFlexibleGrowMode`")
12870     RowHeights = property(GetRowHeights,doc="See `GetRowHeights`")
12871 _core_.FlexGridSizer_swigregister(FlexGridSizer)
12872
12873 class StdDialogButtonSizer(BoxSizer):
12874     """
12875     A special sizer that knows how to order and position standard buttons
12876     in order to conform to the current platform's standards.  You simply
12877     need to add each `wx.Button` to the sizer, and be sure to create the
12878     buttons using the standard ID's.  Then call `Realize` and the sizer
12879     will take care of the rest.
12880
12881     """
12882     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12883     __repr__ = _swig_repr
12884     def __init__(self, *args, **kwargs):
12885         """__init__(self) -> StdDialogButtonSizer"""
12886         _core_.StdDialogButtonSizer_swiginit(self,_core_.new_StdDialogButtonSizer(*args, **kwargs))
12887     def AddButton(*args, **kwargs):
12888         """
12889         AddButton(self, wxButton button)
12890
12891         Use this to add the buttons to this sizer.  Do not use the `Add`
12892         method in the base class.
12893         """
12894         return _core_.StdDialogButtonSizer_AddButton(*args, **kwargs)
12895
12896     def Realize(*args, **kwargs):
12897         """
12898         Realize(self)
12899
12900         This funciton needs to be called after all the buttons have been added
12901         to the sizer.  It will reorder them and position them in a platform
12902         specifc manner.
12903         """
12904         return _core_.StdDialogButtonSizer_Realize(*args, **kwargs)
12905
12906     def SetAffirmativeButton(*args, **kwargs):
12907         """SetAffirmativeButton(self, wxButton button)"""
12908         return _core_.StdDialogButtonSizer_SetAffirmativeButton(*args, **kwargs)
12909
12910     def SetNegativeButton(*args, **kwargs):
12911         """SetNegativeButton(self, wxButton button)"""
12912         return _core_.StdDialogButtonSizer_SetNegativeButton(*args, **kwargs)
12913
12914     def SetCancelButton(*args, **kwargs):
12915         """SetCancelButton(self, wxButton button)"""
12916         return _core_.StdDialogButtonSizer_SetCancelButton(*args, **kwargs)
12917
12918     def GetAffirmativeButton(*args, **kwargs):
12919         """GetAffirmativeButton(self) -> wxButton"""
12920         return _core_.StdDialogButtonSizer_GetAffirmativeButton(*args, **kwargs)
12921
12922     def GetApplyButton(*args, **kwargs):
12923         """GetApplyButton(self) -> wxButton"""
12924         return _core_.StdDialogButtonSizer_GetApplyButton(*args, **kwargs)
12925
12926     def GetNegativeButton(*args, **kwargs):
12927         """GetNegativeButton(self) -> wxButton"""
12928         return _core_.StdDialogButtonSizer_GetNegativeButton(*args, **kwargs)
12929
12930     def GetCancelButton(*args, **kwargs):
12931         """GetCancelButton(self) -> wxButton"""
12932         return _core_.StdDialogButtonSizer_GetCancelButton(*args, **kwargs)
12933
12934     def GetHelpButton(*args, **kwargs):
12935         """GetHelpButton(self) -> wxButton"""
12936         return _core_.StdDialogButtonSizer_GetHelpButton(*args, **kwargs)
12937
12938     AffirmativeButton = property(GetAffirmativeButton,SetAffirmativeButton,doc="See `GetAffirmativeButton` and `SetAffirmativeButton`")
12939     ApplyButton = property(GetApplyButton,doc="See `GetApplyButton`")
12940     CancelButton = property(GetCancelButton,SetCancelButton,doc="See `GetCancelButton` and `SetCancelButton`")
12941     HelpButton = property(GetHelpButton,doc="See `GetHelpButton`")
12942     NegativeButton = property(GetNegativeButton,SetNegativeButton,doc="See `GetNegativeButton` and `SetNegativeButton`")
12943 _core_.StdDialogButtonSizer_swigregister(StdDialogButtonSizer)
12944
12945 #---------------------------------------------------------------------------
12946
12947 class GBPosition(object):
12948     """
12949     This class represents the position of an item in a virtual grid of
12950     rows and columns managed by a `wx.GridBagSizer`.  wxPython has
12951     typemaps that will automatically convert from a 2-element sequence of
12952     integers to a wx.GBPosition, so you can use the more pythonic
12953     representation of the position nearly transparently in Python code.
12954     """
12955     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12956     __repr__ = _swig_repr
12957     def __init__(self, *args, **kwargs):
12958         """
12959         __init__(self, int row=0, int col=0) -> GBPosition
12960
12961         This class represents the position of an item in a virtual grid of
12962         rows and columns managed by a `wx.GridBagSizer`.  wxPython has
12963         typemaps that will automatically convert from a 2-element sequence of
12964         integers to a wx.GBPosition, so you can use the more pythonic
12965         representation of the position nearly transparently in Python code.
12966         """
12967         _core_.GBPosition_swiginit(self,_core_.new_GBPosition(*args, **kwargs))
12968     __swig_destroy__ = _core_.delete_GBPosition
12969     __del__ = lambda self : None;
12970     def GetRow(*args, **kwargs):
12971         """GetRow(self) -> int"""
12972         return _core_.GBPosition_GetRow(*args, **kwargs)
12973
12974     def GetCol(*args, **kwargs):
12975         """GetCol(self) -> int"""
12976         return _core_.GBPosition_GetCol(*args, **kwargs)
12977
12978     def SetRow(*args, **kwargs):
12979         """SetRow(self, int row)"""
12980         return _core_.GBPosition_SetRow(*args, **kwargs)
12981
12982     def SetCol(*args, **kwargs):
12983         """SetCol(self, int col)"""
12984         return _core_.GBPosition_SetCol(*args, **kwargs)
12985
12986     def __eq__(*args, **kwargs):
12987         """
12988         __eq__(self, PyObject other) -> bool
12989
12990         Compare GBPosition for equality.
12991         """
12992         return _core_.GBPosition___eq__(*args, **kwargs)
12993
12994     def __ne__(*args, **kwargs):
12995         """
12996         __ne__(self, PyObject other) -> bool
12997
12998         Compare GBPosition for inequality.
12999         """
13000         return _core_.GBPosition___ne__(*args, **kwargs)
13001
13002     def Set(*args, **kwargs):
13003         """Set(self, int row=0, int col=0)"""
13004         return _core_.GBPosition_Set(*args, **kwargs)
13005
13006     def Get(*args, **kwargs):
13007         """Get(self) -> PyObject"""
13008         return _core_.GBPosition_Get(*args, **kwargs)
13009
13010     asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
13011     def __str__(self):                   return str(self.Get())
13012     def __repr__(self):                  return 'wx.GBPosition'+str(self.Get())
13013     def __len__(self):                   return len(self.Get())
13014     def __getitem__(self, index):        return self.Get()[index]
13015     def __setitem__(self, index, val):
13016         if index == 0: self.SetRow(val)
13017         elif index == 1: self.SetCol(val)
13018         else: raise IndexError
13019     def __nonzero__(self):               return self.Get() != (0,0)
13020     __safe_for_unpickling__ = True
13021     def __reduce__(self):                return (wx.GBPosition, self.Get())
13022
13023     row = property(GetRow, SetRow)
13024     col = property(GetCol, SetCol)
13025
13026 _core_.GBPosition_swigregister(GBPosition)
13027
13028 class GBSpan(object):
13029     """
13030     This class is used to hold the row and column spanning attributes of
13031     items in a `wx.GridBagSizer`.  wxPython has typemaps that will
13032     automatically convert from a 2-element sequence of integers to a
13033     wx.GBSpan, so you can use the more pythonic representation of the span
13034     nearly transparently in Python code.
13035
13036     """
13037     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13038     __repr__ = _swig_repr
13039     def __init__(self, *args, **kwargs):
13040         """
13041         __init__(self, int rowspan=1, int colspan=1) -> GBSpan
13042
13043         Construct a new wxGBSpan, optionally setting the rowspan and
13044         colspan. The default is (1,1). (Meaning that the item occupies one
13045         cell in each direction.
13046         """
13047         _core_.GBSpan_swiginit(self,_core_.new_GBSpan(*args, **kwargs))
13048     __swig_destroy__ = _core_.delete_GBSpan
13049     __del__ = lambda self : None;
13050     def GetRowspan(*args, **kwargs):
13051         """GetRowspan(self) -> int"""
13052         return _core_.GBSpan_GetRowspan(*args, **kwargs)
13053
13054     def GetColspan(*args, **kwargs):
13055         """GetColspan(self) -> int"""
13056         return _core_.GBSpan_GetColspan(*args, **kwargs)
13057
13058     def SetRowspan(*args, **kwargs):
13059         """SetRowspan(self, int rowspan)"""
13060         return _core_.GBSpan_SetRowspan(*args, **kwargs)
13061
13062     def SetColspan(*args, **kwargs):
13063         """SetColspan(self, int colspan)"""
13064         return _core_.GBSpan_SetColspan(*args, **kwargs)
13065
13066     def __eq__(*args, **kwargs):
13067         """
13068         __eq__(self, PyObject other) -> bool
13069
13070         Compare wxGBSpan for equality.
13071         """
13072         return _core_.GBSpan___eq__(*args, **kwargs)
13073
13074     def __ne__(*args, **kwargs):
13075         """
13076         __ne__(self, PyObject other) -> bool
13077
13078         Compare GBSpan for inequality.
13079         """
13080         return _core_.GBSpan___ne__(*args, **kwargs)
13081
13082     def Set(*args, **kwargs):
13083         """Set(self, int rowspan=1, int colspan=1)"""
13084         return _core_.GBSpan_Set(*args, **kwargs)
13085
13086     def Get(*args, **kwargs):
13087         """Get(self) -> PyObject"""
13088         return _core_.GBSpan_Get(*args, **kwargs)
13089
13090     asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
13091     def __str__(self):                   return str(self.Get())
13092     def __repr__(self):                  return 'wx.GBSpan'+str(self.Get())
13093     def __len__(self):                   return len(self.Get())
13094     def __getitem__(self, index):        return self.Get()[index]
13095     def __setitem__(self, index, val):
13096         if index == 0: self.SetRowspan(val)
13097         elif index == 1: self.SetColspan(val)
13098         else: raise IndexError
13099     def __nonzero__(self):               return self.Get() != (0,0)
13100     __safe_for_unpickling__ = True
13101     def __reduce__(self):                return (wx.GBSpan, self.Get())
13102
13103     rowspan = property(GetRowspan, SetRowspan)
13104     colspan = property(GetColspan, SetColspan)
13105
13106 _core_.GBSpan_swigregister(GBSpan)
13107
13108 class GBSizerItem(SizerItem):
13109     """
13110     The wx.GBSizerItem class is used to track the additional data about
13111     items in a `wx.GridBagSizer` such as the item's position in the grid
13112     and how many rows or columns it spans.
13113
13114     """
13115     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13116     __repr__ = _swig_repr
13117     def __init__(self, *args, **kwargs):
13118         """
13119         __init__(self) -> GBSizerItem
13120
13121         Constructs an empty wx.GBSizerItem.  Either a window, sizer or spacer
13122         size will need to be set, as well as a position and span before this
13123         item can be used in a Sizer.
13124
13125         You will probably never need to create a wx.GBSizerItem directly as they
13126         are created automatically when the sizer's Add method is called.
13127         """
13128         _core_.GBSizerItem_swiginit(self,_core_.new_GBSizerItem(*args, **kwargs))
13129     __swig_destroy__ = _core_.delete_GBSizerItem
13130     __del__ = lambda self : None;
13131     def GetPos(*args, **kwargs):
13132         """
13133         GetPos(self) -> GBPosition
13134
13135         Get the grid position of the item
13136         """
13137         return _core_.GBSizerItem_GetPos(*args, **kwargs)
13138
13139     def GetPosTuple(self): return self.GetPos().Get()
13140     def GetSpan(*args, **kwargs):
13141         """
13142         GetSpan(self) -> GBSpan
13143
13144         Get the row and column spanning of the item
13145         """
13146         return _core_.GBSizerItem_GetSpan(*args, **kwargs)
13147
13148     def GetSpanTuple(self): return self.GetSpan().Get()
13149     def SetPos(*args, **kwargs):
13150         """
13151         SetPos(self, GBPosition pos) -> bool
13152
13153         If the item is already a member of a sizer then first ensure that
13154         there is no other item that would intersect with this one at the new
13155         position, then set the new position.  Returns True if the change is
13156         successful and after the next Layout() the item will be moved.
13157         """
13158         return _core_.GBSizerItem_SetPos(*args, **kwargs)
13159
13160     def SetSpan(*args, **kwargs):
13161         """
13162         SetSpan(self, GBSpan span) -> bool
13163
13164         If the item is already a member of a sizer then first ensure that
13165         there is no other item that would intersect with this one with its new
13166         spanning size, then set the new spanning.  Returns True if the change
13167         is successful and after the next Layout() the item will be resized.
13168
13169         """
13170         return _core_.GBSizerItem_SetSpan(*args, **kwargs)
13171
13172     def Intersects(*args, **kwargs):
13173         """
13174         Intersects(self, GBSizerItem other) -> bool
13175
13176         Returns True if this item and the other item instersect.
13177         """
13178         return _core_.GBSizerItem_Intersects(*args, **kwargs)
13179
13180     def IntersectsPos(*args, **kwargs):
13181         """
13182         IntersectsPos(self, GBPosition pos, GBSpan span) -> bool
13183
13184         Returns True if the given pos/span would intersect with this item.
13185         """
13186         return _core_.GBSizerItem_IntersectsPos(*args, **kwargs)
13187
13188     def GetEndPos(*args, **kwargs):
13189         """
13190         GetEndPos(self) -> GBPosition
13191
13192         Get the row and column of the endpoint of this item.
13193         """
13194         return _core_.GBSizerItem_GetEndPos(*args, **kwargs)
13195
13196     def GetGBSizer(*args, **kwargs):
13197         """
13198         GetGBSizer(self) -> GridBagSizer
13199
13200         Get the sizer this item is a member of.
13201         """
13202         return _core_.GBSizerItem_GetGBSizer(*args, **kwargs)
13203
13204     def SetGBSizer(*args, **kwargs):
13205         """
13206         SetGBSizer(self, GridBagSizer sizer)
13207
13208         Set the sizer this item is a member of.
13209         """
13210         return _core_.GBSizerItem_SetGBSizer(*args, **kwargs)
13211
13212     EndPos = property(GetEndPos,doc="See `GetEndPos`")
13213     GBSizer = property(GetGBSizer,SetGBSizer,doc="See `GetGBSizer` and `SetGBSizer`")
13214     Pos = property(GetPos,SetPos,doc="See `GetPos` and `SetPos`")
13215     Span = property(GetSpan,SetSpan,doc="See `GetSpan` and `SetSpan`")
13216 _core_.GBSizerItem_swigregister(GBSizerItem)
13217 DefaultSpan = cvar.DefaultSpan
13218
13219 def GBSizerItemWindow(*args, **kwargs):
13220     """
13221     GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag,
13222         int border, PyObject userData=None) -> GBSizerItem
13223
13224     Construct a `wx.GBSizerItem` for a window.
13225     """
13226     val = _core_.new_GBSizerItemWindow(*args, **kwargs)
13227     return val
13228
13229 def GBSizerItemSizer(*args, **kwargs):
13230     """
13231     GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag,
13232         int border, PyObject userData=None) -> GBSizerItem
13233
13234     Construct a `wx.GBSizerItem` for a sizer
13235     """
13236     val = _core_.new_GBSizerItemSizer(*args, **kwargs)
13237     return val
13238
13239 def GBSizerItemSpacer(*args, **kwargs):
13240     """
13241     GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span,
13242         int flag, int border, PyObject userData=None) -> GBSizerItem
13243
13244     Construct a `wx.GBSizerItem` for a spacer.
13245     """
13246     val = _core_.new_GBSizerItemSpacer(*args, **kwargs)
13247     return val
13248
13249 class GridBagSizer(FlexGridSizer):
13250     """
13251     A `wx.Sizer` that can lay out items in a virtual grid like a
13252     `wx.FlexGridSizer` but in this case explicit positioning of the items
13253     is allowed using `wx.GBPosition`, and items can optionally span more
13254     than one row and/or column using `wx.GBSpan`.  The total size of the
13255     virtual grid is determined by the largest row and column that items are
13256     positioned at, adjusted for spanning.
13257
13258     """
13259     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13260     __repr__ = _swig_repr
13261     def __init__(self, *args, **kwargs):
13262         """
13263         __init__(self, int vgap=0, int hgap=0) -> GridBagSizer
13264
13265         Constructor, with optional parameters to specify the gap between the
13266         rows and columns.
13267         """
13268         _core_.GridBagSizer_swiginit(self,_core_.new_GridBagSizer(*args, **kwargs))
13269         self._setOORInfo(self)
13270
13271     def Add(*args, **kwargs):
13272         """
13273         Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=0,
13274         int border=0, userData=None) -> wx.GBSizerItem
13275
13276         Adds an item to the sizer at the grid cell *pos*, optionally spanning
13277         more than one row or column as specified with *span*.  The remaining
13278         args behave similarly to `wx.Sizer.Add`.
13279
13280         Returns True if the item was successfully placed at the given cell
13281         position, False if something was already there.
13282
13283         """
13284         return _core_.GridBagSizer_Add(*args, **kwargs)
13285
13286     def AddItem(*args, **kwargs):
13287         """
13288         Add(self, GBSizerItem item) -> wx.GBSizerItem
13289
13290         Add an item to the sizer using a `wx.GBSizerItem`.  Returns True if
13291         the item was successfully placed at its given cell position, False if
13292         something was already there.
13293         """
13294         return _core_.GridBagSizer_AddItem(*args, **kwargs)
13295
13296     def GetCellSize(*args, **kwargs):
13297         """
13298         GetCellSize(self, int row, int col) -> Size
13299
13300         Get the size of the specified cell, including hgap and
13301         vgap.  Only valid after a Layout.
13302         """
13303         return _core_.GridBagSizer_GetCellSize(*args, **kwargs)
13304
13305     def GetEmptyCellSize(*args, **kwargs):
13306         """
13307         GetEmptyCellSize(self) -> Size
13308
13309         Get the size used for cells in the grid with no item.
13310         """
13311         return _core_.GridBagSizer_GetEmptyCellSize(*args, **kwargs)
13312
13313     def SetEmptyCellSize(*args, **kwargs):
13314         """
13315         SetEmptyCellSize(self, Size sz)
13316
13317         Set the size used for cells in the grid with no item.
13318         """
13319         return _core_.GridBagSizer_SetEmptyCellSize(*args, **kwargs)
13320
13321     def GetItemPosition(*args):
13322         """
13323         GetItemPosition(self, item) -> GBPosition
13324
13325         Get the grid position of the specified *item* where *item* is either a
13326         window or subsizer that is a member of this sizer, or a zero-based
13327         index of an item.
13328         """
13329         return _core_.GridBagSizer_GetItemPosition(*args)
13330
13331     def SetItemPosition(*args):
13332         """
13333         SetItemPosition(self, item, GBPosition pos) -> bool
13334
13335         Set the grid position of the specified *item* where *item* is either a
13336         window or subsizer that is a member of this sizer, or a zero-based
13337         index of an item.  Returns True on success.  If the move is not
13338         allowed (because an item is already there) then False is returned.
13339
13340         """
13341         return _core_.GridBagSizer_SetItemPosition(*args)
13342
13343     def GetItemSpan(*args):
13344         """
13345         GetItemSpan(self, item) -> GBSpan
13346
13347         Get the row/col spanning of the specified *item* where *item* is
13348         either a window or subsizer that is a member of this sizer, or a
13349         zero-based index of an item.
13350         """
13351         return _core_.GridBagSizer_GetItemSpan(*args)
13352
13353     def SetItemSpan(*args):
13354         """
13355         SetItemSpan(self, item, GBSpan span) -> bool
13356
13357         Set the row/col spanning of the specified *item* where *item* is
13358         either a window or subsizer that is a member of this sizer, or a
13359         zero-based index of an item.  Returns True on success.  If the move is
13360         not allowed (because an item is already there) then False is returned.
13361         """
13362         return _core_.GridBagSizer_SetItemSpan(*args)
13363
13364     def FindItem(*args):
13365         """
13366         FindItem(self, item) -> GBSizerItem
13367
13368         Find the sizer item for the given window or subsizer, returns None if
13369         not found. (non-recursive)
13370         """
13371         return _core_.GridBagSizer_FindItem(*args)
13372
13373     def GetItem(self, item):
13374         gbsi = None
13375         si = wx.FlexGridSizer.GetItem(self, item)
13376         if not si:
13377             return None
13378         if type(item) is not int:
13379             gbsi = self.FindItem(item)
13380         if gbsi: return gbsi
13381         return si
13382
13383     def FindItemAtPosition(*args, **kwargs):
13384         """
13385         FindItemAtPosition(self, GBPosition pos) -> GBSizerItem
13386
13387         Return the sizer item for the given grid cell, or None if there is no
13388         item at that position. (non-recursive)
13389         """
13390         return _core_.GridBagSizer_FindItemAtPosition(*args, **kwargs)
13391
13392     def FindItemAtPoint(*args, **kwargs):
13393         """
13394         FindItemAtPoint(self, Point pt) -> GBSizerItem
13395
13396         Return the sizer item located at the point given in *pt*, or None if
13397         there is no item at that point. The (x,y) coordinates in pt correspond
13398         to the client coordinates of the window using the sizer for
13399         layout. (non-recursive)
13400         """
13401         return _core_.GridBagSizer_FindItemAtPoint(*args, **kwargs)
13402
13403     def CheckForIntersection(*args, **kwargs):
13404         """
13405         CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool
13406
13407         Look at all items and see if any intersect (or would overlap) the
13408         given *item*.  Returns True if so, False if there would be no overlap.
13409         If an *excludeItem* is given then it will not be checked for
13410         intersection, for example it may be the item we are checking the
13411         position of.
13412
13413         """
13414         return _core_.GridBagSizer_CheckForIntersection(*args, **kwargs)
13415
13416     def CheckForIntersectionPos(*args, **kwargs):
13417         """
13418         CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool
13419
13420         Look at all items and see if any intersect (or would overlap) the
13421         given position and span.  Returns True if so, False if there would be
13422         no overlap.  If an *excludeItem* is given then it will not be checked
13423         for intersection, for example it may be the item we are checking the
13424         position of.
13425         """
13426         return _core_.GridBagSizer_CheckForIntersectionPos(*args, **kwargs)
13427
13428 _core_.GridBagSizer_swigregister(GridBagSizer)
13429
13430 #---------------------------------------------------------------------------
13431
13432 Left = _core_.Left
13433 Top = _core_.Top
13434 Right = _core_.Right
13435 Bottom = _core_.Bottom
13436 Width = _core_.Width
13437 Height = _core_.Height
13438 Centre = _core_.Centre
13439 Center = _core_.Center
13440 CentreX = _core_.CentreX
13441 CentreY = _core_.CentreY
13442 Unconstrained = _core_.Unconstrained
13443 AsIs = _core_.AsIs
13444 PercentOf = _core_.PercentOf
13445 Above = _core_.Above
13446 Below = _core_.Below
13447 LeftOf = _core_.LeftOf
13448 RightOf = _core_.RightOf
13449 SameAs = _core_.SameAs
13450 Absolute = _core_.Absolute
13451 class IndividualLayoutConstraint(Object):
13452     """
13453     Objects of this class are stored in the `wx.LayoutConstraints` class as
13454     one of eight possible constraints that a window can be involved in.
13455     You will never need to create an instance of
13456     wx.IndividualLayoutConstraint, rather you should create a
13457     `wx.LayoutConstraints` instance and use the individual contstraints
13458     that it contains.
13459     """
13460     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13461     def __init__(self): raise AttributeError, "No constructor defined"
13462     __repr__ = _swig_repr
13463     def Set(*args, **kwargs):
13464         """
13465         Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN)
13466
13467         Sets the properties of the constraint. Normally called by one of the
13468         convenience functions such as Above, RightOf, SameAs.
13469         """
13470         return _core_.IndividualLayoutConstraint_Set(*args, **kwargs)
13471
13472     def LeftOf(*args, **kwargs):
13473         """
13474         LeftOf(self, Window sibling, int marg=0)
13475
13476         Constrains this edge to be to the left of the given window, with an
13477         optional margin. Implicitly, this is relative to the left edge of the
13478         other window.
13479         """
13480         return _core_.IndividualLayoutConstraint_LeftOf(*args, **kwargs)
13481
13482     def RightOf(*args, **kwargs):
13483         """
13484         RightOf(self, Window sibling, int marg=0)
13485
13486         Constrains this edge to be to the right of the given window, with an
13487         optional margin. Implicitly, this is relative to the right edge of the
13488         other window.
13489         """
13490         return _core_.IndividualLayoutConstraint_RightOf(*args, **kwargs)
13491
13492     def Above(*args, **kwargs):
13493         """
13494         Above(self, Window sibling, int marg=0)
13495
13496         Constrains this edge to be above the given window, with an optional
13497         margin. Implicitly, this is relative to the top edge of the other
13498         window.
13499         """
13500         return _core_.IndividualLayoutConstraint_Above(*args, **kwargs)
13501
13502     def Below(*args, **kwargs):
13503         """
13504         Below(self, Window sibling, int marg=0)
13505
13506         Constrains this edge to be below the given window, with an optional
13507         margin. Implicitly, this is relative to the bottom edge of the other
13508         window.
13509         """
13510         return _core_.IndividualLayoutConstraint_Below(*args, **kwargs)
13511
13512     def SameAs(*args, **kwargs):
13513         """
13514         SameAs(self, Window otherW, int edge, int marg=0)
13515
13516         Constrains this edge or dimension to be to the same as the edge of the
13517         given window, with an optional margin.
13518         """
13519         return _core_.IndividualLayoutConstraint_SameAs(*args, **kwargs)
13520
13521     def PercentOf(*args, **kwargs):
13522         """
13523         PercentOf(self, Window otherW, int wh, int per)
13524
13525         Constrains this edge or dimension to be to a percentage of the given
13526         window, with an optional margin.
13527         """
13528         return _core_.IndividualLayoutConstraint_PercentOf(*args, **kwargs)
13529
13530     def Absolute(*args, **kwargs):
13531         """
13532         Absolute(self, int val)
13533
13534         Constrains this edge or dimension to be the given absolute value.
13535         """
13536         return _core_.IndividualLayoutConstraint_Absolute(*args, **kwargs)
13537
13538     def Unconstrained(*args, **kwargs):
13539         """
13540         Unconstrained(self)
13541
13542         Sets this edge or dimension to be unconstrained, that is, dependent on
13543         other edges and dimensions from which this value can be deduced.
13544         """
13545         return _core_.IndividualLayoutConstraint_Unconstrained(*args, **kwargs)
13546
13547     def AsIs(*args, **kwargs):
13548         """
13549         AsIs(self)
13550
13551         Sets this edge or constraint to be whatever the window's value is at
13552         the moment. If either of the width and height constraints are *as is*,
13553         the window will not be resized, but moved instead. This is important
13554         when considering panel items which are intended to have a default
13555         size, such as a button, which may take its size from the size of the
13556         button label.
13557         """
13558         return _core_.IndividualLayoutConstraint_AsIs(*args, **kwargs)
13559
13560     def GetOtherWindow(*args, **kwargs):
13561         """GetOtherWindow(self) -> Window"""
13562         return _core_.IndividualLayoutConstraint_GetOtherWindow(*args, **kwargs)
13563
13564     def GetMyEdge(*args, **kwargs):
13565         """GetMyEdge(self) -> int"""
13566         return _core_.IndividualLayoutConstraint_GetMyEdge(*args, **kwargs)
13567
13568     def SetEdge(*args, **kwargs):
13569         """SetEdge(self, int which)"""
13570         return _core_.IndividualLayoutConstraint_SetEdge(*args, **kwargs)
13571
13572     def SetValue(*args, **kwargs):
13573         """SetValue(self, int v)"""
13574         return _core_.IndividualLayoutConstraint_SetValue(*args, **kwargs)
13575
13576     def GetMargin(*args, **kwargs):
13577         """GetMargin(self) -> int"""
13578         return _core_.IndividualLayoutConstraint_GetMargin(*args, **kwargs)
13579
13580     def SetMargin(*args, **kwargs):
13581         """SetMargin(self, int m)"""
13582         return _core_.IndividualLayoutConstraint_SetMargin(*args, **kwargs)
13583
13584     def GetValue(*args, **kwargs):
13585         """GetValue(self) -> int"""
13586         return _core_.IndividualLayoutConstraint_GetValue(*args, **kwargs)
13587
13588     def GetPercent(*args, **kwargs):
13589         """GetPercent(self) -> int"""
13590         return _core_.IndividualLayoutConstraint_GetPercent(*args, **kwargs)
13591
13592     def GetOtherEdge(*args, **kwargs):
13593         """GetOtherEdge(self) -> int"""
13594         return _core_.IndividualLayoutConstraint_GetOtherEdge(*args, **kwargs)
13595
13596     def GetDone(*args, **kwargs):
13597         """GetDone(self) -> bool"""
13598         return _core_.IndividualLayoutConstraint_GetDone(*args, **kwargs)
13599
13600     def SetDone(*args, **kwargs):
13601         """SetDone(self, bool d)"""
13602         return _core_.IndividualLayoutConstraint_SetDone(*args, **kwargs)
13603
13604     def GetRelationship(*args, **kwargs):
13605         """GetRelationship(self) -> int"""
13606         return _core_.IndividualLayoutConstraint_GetRelationship(*args, **kwargs)
13607
13608     def SetRelationship(*args, **kwargs):
13609         """SetRelationship(self, int r)"""
13610         return _core_.IndividualLayoutConstraint_SetRelationship(*args, **kwargs)
13611
13612     def ResetIfWin(*args, **kwargs):
13613         """
13614         ResetIfWin(self, Window otherW) -> bool
13615
13616         Reset constraint if it mentions otherWin
13617         """
13618         return _core_.IndividualLayoutConstraint_ResetIfWin(*args, **kwargs)
13619
13620     def SatisfyConstraint(*args, **kwargs):
13621         """
13622         SatisfyConstraint(self, LayoutConstraints constraints, Window win) -> bool
13623
13624         Try to satisfy constraint
13625         """
13626         return _core_.IndividualLayoutConstraint_SatisfyConstraint(*args, **kwargs)
13627
13628     def GetEdge(*args, **kwargs):
13629         """
13630         GetEdge(self, int which, Window thisWin, Window other) -> int
13631
13632         Get the value of this edge or dimension, or if this
13633         is not determinable, -1.
13634         """
13635         return _core_.IndividualLayoutConstraint_GetEdge(*args, **kwargs)
13636
13637     Done = property(GetDone,SetDone,doc="See `GetDone` and `SetDone`")
13638     Margin = property(GetMargin,SetMargin,doc="See `GetMargin` and `SetMargin`")
13639     MyEdge = property(GetMyEdge,doc="See `GetMyEdge`")
13640     OtherEdge = property(GetOtherEdge,doc="See `GetOtherEdge`")
13641     OtherWindow = property(GetOtherWindow,doc="See `GetOtherWindow`")
13642     Percent = property(GetPercent,doc="See `GetPercent`")
13643     Relationship = property(GetRelationship,SetRelationship,doc="See `GetRelationship` and `SetRelationship`")
13644     Value = property(GetValue,SetValue,doc="See `GetValue` and `SetValue`")
13645 _core_.IndividualLayoutConstraint_swigregister(IndividualLayoutConstraint)
13646
13647 class LayoutConstraints(Object):
13648     """
13649     **Note:** constraints are now deprecated and you should use sizers
13650     instead.
13651
13652     Objects of this class can be associated with a window to define its
13653     layout constraints, with respect to siblings or its parent.
13654
13655     The class consists of the following eight constraints of class
13656     wx.IndividualLayoutConstraint, some or all of which should be accessed
13657     directly to set the appropriate constraints.
13658
13659         * left: represents the left hand edge of the window
13660         * right: represents the right hand edge of the window
13661         * top: represents the top edge of the window
13662         * bottom: represents the bottom edge of the window
13663         * width: represents the width of the window
13664         * height: represents the height of the window
13665         * centreX: represents the horizontal centre point of the window
13666         * centreY: represents the vertical centre point of the window
13667
13668     Most constraints are initially set to have the relationship
13669     wxUnconstrained, which means that their values should be calculated by
13670     looking at known constraints. The exceptions are width and height,
13671     which are set to wxAsIs to ensure that if the user does not specify a
13672     constraint, the existing width and height will be used, to be
13673     compatible with panel items which often have take a default size. If
13674     the constraint is ``wx.AsIs``, the dimension will not be changed.
13675
13676     :see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints`
13677
13678     """
13679     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13680     __repr__ = _swig_repr
13681     left = property(_core_.LayoutConstraints_left_get)
13682     top = property(_core_.LayoutConstraints_top_get)
13683     right = property(_core_.LayoutConstraints_right_get)
13684     bottom = property(_core_.LayoutConstraints_bottom_get)
13685     width = property(_core_.LayoutConstraints_width_get)
13686     height = property(_core_.LayoutConstraints_height_get)
13687     centreX = property(_core_.LayoutConstraints_centreX_get)
13688     centreY = property(_core_.LayoutConstraints_centreY_get)
13689     def __init__(self, *args, **kwargs):
13690         """__init__(self) -> LayoutConstraints"""
13691         _core_.LayoutConstraints_swiginit(self,_core_.new_LayoutConstraints(*args, **kwargs))
13692     __swig_destroy__ = _core_.delete_LayoutConstraints
13693     __del__ = lambda self : None;
13694     def SatisfyConstraints(*args, **kwargs):
13695         """SatisfyConstraints(Window win) -> (areSatisfied, noChanges)"""
13696         return _core_.LayoutConstraints_SatisfyConstraints(*args, **kwargs)
13697
13698     def AreSatisfied(*args, **kwargs):
13699         """AreSatisfied(self) -> bool"""
13700         return _core_.LayoutConstraints_AreSatisfied(*args, **kwargs)
13701
13702 _core_.LayoutConstraints_swigregister(LayoutConstraints)
13703
13704 #----------------------------------------------------------------------------
13705
13706 # Use Python's bool constants if available, make some if not
13707 try:
13708     True
13709 except NameError:
13710     __builtins__.True = 1==1
13711     __builtins__.False = 1==0
13712     def bool(value): return not not value
13713     __builtins__.bool = bool
13714
13715
13716
13717 # workarounds for bad wxRTTI names
13718 __wxPyPtrTypeMap['wxGauge95']    = 'wxGauge'
13719 __wxPyPtrTypeMap['wxSlider95']   = 'wxSlider'
13720 __wxPyPtrTypeMap['wxStatusBar95']   = 'wxStatusBar'
13721
13722
13723 #----------------------------------------------------------------------------
13724 # Load version numbers from __version__...  Ensure that major and minor
13725 # versions are the same for both wxPython and wxWidgets.
13726
13727 from __version__ import *
13728 __version__ = VERSION_STRING
13729
13730 assert MAJOR_VERSION == _core_.MAJOR_VERSION, "wxPython/wxWidgets version mismatch"
13731 assert MINOR_VERSION == _core_.MINOR_VERSION, "wxPython/wxWidgets version mismatch"
13732 if RELEASE_VERSION != _core_.RELEASE_VERSION:
13733     import warnings
13734     warnings.warn("wxPython/wxWidgets release number mismatch")
13735
13736
13737 def version():
13738     """Returns a string containing version and port info"""
13739     ctype = wx.USE_UNICODE and 'unicode' or 'ansi'
13740     if wx.Platform == '__WXMSW__':
13741         port = 'msw'
13742     elif wx.Platform == '__WXMAC__':
13743         port = 'mac'
13744     elif wx.Platform == '__WXGTK__':
13745         port = 'gtk'
13746         if 'gtk2' in wx.PlatformInfo:
13747             port = 'gtk2'
13748     else:
13749         port = '?'
13750
13751     return "%s (%s-%s)" % (wx.VERSION_STRING, port, ctype)
13752
13753
13754 #----------------------------------------------------------------------------
13755
13756 # Set wxPython's default string<-->unicode conversion encoding from
13757 # the locale, but only if Python's default hasn't been changed.  (We
13758 # assume that if the user has customized it already then that is the
13759 # encoding we need to use as well.)
13760 #
13761 # The encoding selected here is used when string or unicode objects
13762 # need to be converted in order to pass them to wxWidgets.  Please be
13763 # aware that the default encoding within the same locale may be
13764 # slightly different on different platforms.  For example, please see
13765 # http://www.alanwood.net/demos/charsetdiffs.html for differences
13766 # between the common latin/roman encodings.
13767
13768 default = _sys.getdefaultencoding()
13769 if default == 'ascii':
13770     import locale
13771     import codecs
13772     try:
13773         if hasattr(locale, 'getpreferredencoding'):
13774             default = locale.getpreferredencoding()
13775         else:
13776             default = locale.getdefaultlocale()[1]
13777         codecs.lookup(default)
13778     except (ValueError, LookupError, TypeError):
13779         default = _sys.getdefaultencoding()
13780     del locale
13781     del codecs
13782 if default:
13783     wx.SetDefaultPyEncoding(default)
13784 del default
13785
13786 #----------------------------------------------------------------------------
13787
13788 class PyDeadObjectError(AttributeError):
13789     pass
13790
13791 class _wxPyDeadObject(object):
13792     """
13793     Instances of wx objects that are OOR capable will have their __class__
13794     changed to this class when the C++ object is deleted.  This should help
13795     prevent crashes due to referencing a bogus C++ pointer.
13796     """
13797     reprStr = "wxPython wrapper for DELETED %s object! (The C++ object no longer exists.)"
13798     attrStr = "The C++ part of the %s object has been deleted, attribute access no longer allowed."
13799
13800     def __repr__(self):
13801         if not hasattr(self, "_name"):
13802             self._name = "[unknown]"
13803         return self.reprStr % self._name
13804
13805     def __getattr__(self, *args):
13806         if not hasattr(self, "_name"):
13807             self._name = "[unknown]"
13808         raise PyDeadObjectError(self.attrStr % self._name)
13809
13810     def __nonzero__(self):
13811         return 0
13812
13813
13814
13815 class PyUnbornObjectError(AttributeError):
13816     pass
13817
13818 class _wxPyUnbornObject(object):
13819     """
13820     Some stock objects are created when the wx._core module is
13821     imported, but their C++ instance is not created until the wx.App
13822     object is created and initialized.  These object instances will
13823     temporarily have their __class__ changed to this class so an
13824     exception will be raised if they are used before the C++ instance
13825     is ready.
13826     """
13827
13828     reprStr = "wxPython wrapper for UNBORN object! (The C++ object is not initialized yet.)"
13829     attrStr = "The C++ part of this object has not been initialized, attribute access not allowed."
13830
13831     def __repr__(self):
13832         #if not hasattr(self, "_name"):
13833         #    self._name = "[unknown]"
13834         return self.reprStr #% self._name
13835
13836     def __getattr__(self, *args):
13837         #if not hasattr(self, "_name"):
13838         #    self._name = "[unknown]"
13839         raise PyUnbornObjectError(self.attrStr) # % self._name )
13840
13841     def __nonzero__(self):
13842         return 0
13843
13844
13845 #----------------------------------------------------------------------------
13846
13847 def CallAfter(callable, *args, **kw):
13848     """
13849     Call the specified function after the current and pending event
13850     handlers have been completed.  This is also good for making GUI
13851     method calls from non-GUI threads.  Any extra positional or
13852     keyword args are passed on to the callable when it is called.
13853
13854     :see: `wx.CallLater`
13855     """
13856     app = wx.GetApp()
13857     assert app is not None, 'No wx.App created yet'
13858
13859     if not hasattr(app, "_CallAfterId"):
13860         app._CallAfterId = wx.NewEventType()
13861         app.Connect(-1, -1, app._CallAfterId,
13862                     lambda event: event.callable(*event.args, **event.kw) )
13863     evt = wx.PyEvent()
13864     evt.SetEventType(app._CallAfterId)
13865     evt.callable = callable
13866     evt.args = args
13867     evt.kw = kw
13868     wx.PostEvent(app, evt)
13869
13870 #----------------------------------------------------------------------------
13871
13872
13873 class CallLater:
13874     """
13875     A convenience class for `wx.Timer`, that calls the given callable
13876     object once after the given amount of milliseconds, passing any
13877     positional or keyword args.  The return value of the callable is
13878     availbale after it has been run with the `GetResult` method.
13879
13880     If you don't need to get the return value or restart the timer
13881     then there is no need to hold a reference to this object.  It will
13882     hold a reference to itself while the timer is running (the timer
13883     has a reference to self.Notify) but the cycle will be broken when
13884     the timer completes, automatically cleaning up the wx.CallLater
13885     object.
13886
13887     :see: `wx.CallAfter`
13888     """
13889     def __init__(self, millis, callable, *args, **kwargs):
13890         self.millis = millis
13891         self.callable = callable
13892         self.SetArgs(*args, **kwargs)
13893         self.runCount = 0
13894         self.running = False
13895         self.hasRun = False
13896         self.result = None
13897         self.timer = None
13898         self.Start()
13899
13900     def __del__(self):
13901         self.Stop()
13902
13903
13904     def Start(self, millis=None, *args, **kwargs):
13905         """
13906         (Re)start the timer
13907         """
13908         self.hasRun = False
13909         if millis is not None:
13910             self.millis = millis
13911         if args or kwargs:
13912             self.SetArgs(*args, **kwargs)
13913         self.Stop()
13914         self.timer = wx.PyTimer(self.Notify)
13915         self.timer.Start(self.millis, wx.TIMER_ONE_SHOT)
13916         self.running = True
13917     Restart = Start
13918
13919
13920     def Stop(self):
13921         """
13922         Stop and destroy the timer.
13923         """
13924         if self.timer is not None:
13925             self.timer.Stop()
13926             self.timer = None
13927
13928
13929     def GetInterval(self):
13930         if self.timer is not None:
13931             return self.timer.GetInterval()
13932         else:
13933             return 0
13934
13935
13936     def IsRunning(self):
13937         return self.timer is not None and self.timer.IsRunning()
13938
13939
13940     def SetArgs(self, *args, **kwargs):
13941         """
13942         (Re)set the args passed to the callable object.  This is
13943         useful in conjunction with Restart if you want to schedule a
13944         new call to the same callable object but with different
13945         parameters.
13946         """
13947         self.args = args
13948         self.kwargs = kwargs
13949
13950
13951     def HasRun(self):
13952         return self.hasRun
13953
13954     def GetResult(self):
13955         return self.result
13956
13957     def Notify(self):
13958         """
13959         The timer has expired so call the callable.
13960         """
13961         if self.callable and getattr(self.callable, 'im_self', True):
13962             self.runCount += 1
13963             self.running = False
13964             self.result = self.callable(*self.args, **self.kwargs)
13965         self.hasRun = True
13966         if not self.running:
13967             # if it wasn't restarted, then cleanup
13968             wx.CallAfter(self.Stop)
13969
13970     Interval = property(GetInterval)
13971     Result = property(GetResult)
13972
13973
13974 class FutureCall(CallLater):
13975     """A compatibility alias for `CallLater`."""
13976
13977 #----------------------------------------------------------------------------
13978 # Control which items in this module should be documented by epydoc.
13979 # We allow only classes and functions, which will help reduce the size
13980 # of the docs by filtering out the zillions of constants, EVT objects,
13981 # and etc that don't make much sense by themselves, but are instead
13982 # documented (or will be) as part of the classes/functions/methods
13983 # where they should be used.
13984
13985 class __DocFilter:
13986     """
13987     A filter for epydoc that only allows non-Ptr classes and
13988     functions, in order to reduce the clutter in the API docs.
13989     """
13990     def __init__(self, globals):
13991         self._globals = globals
13992
13993     def __call__(self, name):
13994         import types
13995         obj = self._globals.get(name, None)
13996
13997         # only document classes and function
13998         if type(obj) not in [type, types.ClassType, types.FunctionType, types.BuiltinFunctionType]:
13999             return False
14000
14001         # skip other things that are private or will be documented as part of somethign else
14002         if name.startswith('_') or name.startswith('EVT') or name.endswith('_swigregister')  or name.endswith('Ptr') :
14003             return False
14004
14005         # skip functions that are duplicates of static functions in a class
14006         if name.find('_') != -1:
14007             cls = self._globals.get(name.split('_')[0], None)
14008             methname = name.split('_')[1]
14009             if hasattr(cls, methname) and type(getattr(cls, methname)) is types.FunctionType:
14010                 return False
14011
14012         return True
14013
14014 #----------------------------------------------------------------------------
14015 #----------------------------------------------------------------------------
14016
14017 # Import other modules in this package that should show up in the
14018 # "core" wx namespace
14019 from _gdi import *
14020 from _windows import *
14021 from _controls import *
14022 from _misc import *
14023
14024 #----------------------------------------------------------------------------
14025 #----------------------------------------------------------------------------
14026
14027
14028