1# -*- coding: utf-8 -*- 2#--------------------------------------------------------------------------- 3# This file is generated by wxPython's PI generator. Do not edit by hand. 4# 5# The *.pyi files are used by PyCharm and other development tools to provide 6# more information, such as PEP 484 type hints, than it is able to glean from 7# introspection of extension types and methods. They are not intended to be 8# imported, executed or used for any other purpose other than providing info 9# to the tools. If you don't use use a tool that makes use of .pyi files then 10# you can safely ignore this file. 11# 12# See: https://www.python.org/dev/peps/pep-0484/ 13# https://www.jetbrains.com/help/pycharm/2016.1/type-hinting-in-pycharm.html 14# 15# Copyright: (c) 2018 by Total Control Software 16# License: wxWindows License 17#--------------------------------------------------------------------------- 18 19 20""" 21The classes in this module are the most commonly used classes for wxPython, 22which is why they have been made visible in the core `wx` namespace. 23Everything you need for building typical GUI applications is here. 24""" 25#-- begin-_core --# 26 27#-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 28# This code block was included from src/core_ex.py 29import sys as _sys 30 31# Load version numbers from __version__ and some other initialization tasks... 32if 'wxEVT_NULL' in dir(): 33 from wx.__version__ import * 34 import wx._core 35 __version__ = VERSION_STRING 36 37 # Add the build type to PlatformInfo 38 PlatformInfo = PlatformInfo + ('build-type: ' + BUILD_TYPE, ) 39 40 # Register a function to be called when Python terminates that will clean 41 # up and release all system resources that wxWidgets allocated. 42 import atexit 43 atexit.register(wx._core._wxPyCleanup) 44 del atexit 45 46else: 47 Port = '' 48 Platform = '' 49 PlatformInfo = [] 50 51# A little trick to make 'wx' be a reference to this module so wx.Names can 52# be used in the python code here. 53wx = _sys.modules[__name__] 54 55 56import warnings 57class wxPyDeprecationWarning(DeprecationWarning): 58 pass 59 60warnings.simplefilter('default', wxPyDeprecationWarning) 61del warnings 62 63 64def deprecated(item, msg='', useName=False): 65 """ 66 Create a delegating wrapper that raises a deprecation warning. Can be 67 used with callable objects (functions, methods, classes) or with 68 properties. 69 """ 70 import warnings 71 72 name = '' 73 if useName: 74 try: 75 name = ' ' + item.__name__ 76 except AttributeError: 77 pass 78 79 if isinstance(item, type): 80 # It is a class. Make a subclass that raises a warning. 81 class DeprecatedClassProxy(item): 82 def __init__(*args, **kw): 83 warnings.warn("Using deprecated class%s. %s" % (name, msg), 84 wxPyDeprecationWarning, stacklevel=2) 85 item.__init__(*args, **kw) 86 DeprecatedClassProxy.__name__ = item.__name__ 87 return DeprecatedClassProxy 88 89 elif callable(item): 90 # wrap a new function around the callable 91 def deprecated_func(*args, **kw): 92 warnings.warn("Call to deprecated item%s. %s" % (name, msg), 93 wxPyDeprecationWarning, stacklevel=2) 94 if not kw: 95 return item(*args) 96 return item(*args, **kw) 97 deprecated_func.__name__ = item.__name__ 98 deprecated_func.__doc__ = item.__doc__ 99 if hasattr(item, '__dict__'): 100 deprecated_func.__dict__.update(item.__dict__) 101 return deprecated_func 102 103 elif hasattr(item, '__get__'): 104 # it should be a property if there is a getter 105 class DepGetProp(object): 106 def __init__(self, item, msg): 107 self.item = item 108 self.msg = msg 109 def __get__(self, inst, klass): 110 warnings.warn("Accessing deprecated property. %s" % msg, 111 wxPyDeprecationWarning, stacklevel=2) 112 return self.item.__get__(inst, klass) 113 class DepGetSetProp(DepGetProp): 114 def __set__(self, inst, val): 115 warnings.warn("Accessing deprecated property. %s" % msg, 116 wxPyDeprecationWarning, stacklevel=2) 117 return self.item.__set__(inst, val) 118 class DepGetSetDelProp(DepGetSetProp): 119 def __delete__(self, inst): 120 warnings.warn("Accessing deprecated property. %s" % msg, 121 wxPyDeprecationWarning, stacklevel=2) 122 return self.item.__delete__(inst) 123 124 if hasattr(item, '__set__') and hasattr(item, '__delete__'): 125 return DepGetSetDelProp(item, msg) 126 elif hasattr(item, '__set__'): 127 return DepGetSetProp(item, msg) 128 else: 129 return DepGetProp(item, msg) 130 else: 131 raise TypeError("unsupported type %s" % type(item)) 132 133 134def deprecatedMsg(msg): 135 """ 136 A wrapper for the deprecated decorator that makes it easier to attach a 137 custom message to the warning that is raised if the item is used. This 138 can also be used in the @decorator role since it returns the real 139 decorator when called. 140 """ 141 import functools 142 return functools.partial(deprecated, msg=msg, useName=True) 143 144#---------------------------------------------------------------------------- 145 146EmptyString = "" 147 148#---------------------------------------------------------------------------- 149 150# End of included code block 151#-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 152 153def version(): 154 """ 155 Returns a string containing version and port info 156 """ 157 pass 158 159def CallAfter(callableObj, *args, **kw): 160 """ 161 Call the specified function after the current and pending event 162 handlers have been completed. This is also good for making GUI 163 method calls from non-GUI threads. Any extra positional or 164 keyword args are passed on to the callable when it is called. 165 166 :param PyObject callableObj: the callable object 167 :param args: arguments to be passed to the callable object 168 :param kw: keywords to be passed to the callable object 169 170 .. seealso:: 171 :ref:`wx.CallLater` 172 """ 173 pass 174class CallLater(object): 175 """ 176 A convenience class for :class:`wx.Timer`, that calls the given callable 177 object once after the given amount of milliseconds, passing any 178 positional or keyword args. The return value of the callable is 179 available after it has been run with the :meth:`~wx.CallLater.GetResult` 180 method. 181 182 If you don't need to get the return value or restart the timer 183 then there is no need to hold a reference to this object. CallLater 184 maintains references to its instances while they are running. When they 185 finish, the internal reference is deleted and the GC is free to collect 186 naturally. 187 188 .. seealso:: 189 :func:`wx.CallAfter` 190 """ 191 192 __instances = {} 193 194 def __init__(self, millis, callableObj, *args, **kwargs): 195 """ 196 Constructs a new :class:`wx.CallLater` object. 197 198 :param int millis: number of milliseconds to delay until calling the callable object 199 :param PyObject callableObj: the callable object 200 :param args: arguments to be passed to the callable object 201 :param kw: keywords to be passed to the callable object 202 """ 203 pass 204 205 def __del__(self): 206 pass 207 208 def Start(self, millis=None, *args, **kwargs): 209 """ 210 (Re)start the timer 211 212 :param int millis: number of milli seconds 213 :param args: arguments to be passed to the callable object 214 :param kw: keywords to be passed to the callable object 215 """ 216 pass 217 218 Restart = Start 219 220 def Stop(self): 221 """ 222 Stop and destroy the timer. 223 """ 224 pass 225 226 def GetInterval(self): 227 pass 228 229 def IsRunning(self): 230 pass 231 232 def SetArgs(self, *args, **kwargs): 233 """ 234 (Re)set the args passed to the callable object. This is 235 useful in conjunction with :meth:`Start` if 236 you want to schedule a new call to the same callable 237 object but with different parameters. 238 239 :param args: arguments to be passed to the callable object 240 :param kw: keywords to be passed to the callable object 241 """ 242 pass 243 244 def HasRun(self): 245 """ 246 Returns whether or not the callable has run. 247 248 :rtype: bool 249 """ 250 pass 251 252 def GetResult(self): 253 """ 254 Returns the value of the callable. 255 256 :rtype: a Python object 257 :return: result from callable 258 """ 259 pass 260 261 def Notify(self): 262 """ 263 The timer has expired so call the callable. 264 """ 265 pass 266 Interval = property(None, None) 267 Result = property(None, None) 268 269FutureCall = deprecated(CallLater, 'Use CallLater instead.') 270 271def GetDefaultPyEncoding(): 272 return "utf-8" 273GetDefaultPyEncoding = deprecated(GetDefaultPyEncoding, msg="wxPython now always uses utf-8") 274 275def IsMainThread(self): 276 """ 277 IsMainThread() -> bool 278 279 Returns ``True`` if the current thread is what wx considers the GUI 280 thread. 281 """ 282#-- end-_core --# 283#-- begin-defs --# 284INT8_MIN = 0 285INT8_MAX = 0 286UINT8_MAX = 0 287INT16_MIN = 0 288INT16_MAX = 0 289UINT16_MAX = 0 290INT32_MIN = 0 291INT32_MAX = 0 292UINT32_MAX = 0 293INT64_MIN = 0 294INT64_MAX = 0 295UINT64_MAX = 0 296SIZE_AUTO_WIDTH = 0 297SIZE_AUTO_HEIGHT = 0 298SIZE_AUTO = 0 299SIZE_USE_EXISTING = 0 300SIZE_ALLOW_MINUS_ONE = 0 301SIZE_NO_ADJUSTMENTS = 0 302SIZE_FORCE = 0 303SIZE_FORCE_EVENT = 0 304VSCROLL = 0 305HSCROLL = 0 306CAPTION = 0 307DOUBLE_BORDER = 0 308SUNKEN_BORDER = 0 309RAISED_BORDER = 0 310BORDER = 0 311SIMPLE_BORDER = 0 312STATIC_BORDER = 0 313NO_BORDER = 0 314ALWAYS_SHOW_SB = 0 315CLIP_CHILDREN = 0 316CLIP_SIBLINGS = 0 317TRANSPARENT_WINDOW = 0 318TAB_TRAVERSAL = 0 319WANTS_CHARS = 0 320RETAINED = 0 321BACKINGSTORE = 0 322POPUP_WINDOW = 0 323FULL_REPAINT_ON_RESIZE = 0 324NO_FULL_REPAINT_ON_RESIZE = 0 325WINDOW_STYLE_MASK = 0 326WS_EX_VALIDATE_RECURSIVELY = 0 327WS_EX_BLOCK_EVENTS = 0 328WS_EX_TRANSIENT = 0 329WS_EX_THEMED_BACKGROUND = 0 330WS_EX_PROCESS_IDLE = 0 331WS_EX_PROCESS_UI_UPDATES = 0 332FRAME_EX_METAL = 0 333DIALOG_EX_METAL = 0 334WS_EX_CONTEXTHELP = 0 335FRAME_EX_CONTEXTHELP = 0 336DIALOG_EX_CONTEXTHELP = 0 337FRAME_DRAWER = 0 338FRAME_NO_WINDOW_MENU = 0 339MB_DOCKABLE = 0 340MENU_TEAROFF = 0 341COLOURED = 0 342FIXED_LENGTH = 0 343LB_SORT = 0 344LB_SINGLE = 0 345LB_MULTIPLE = 0 346LB_EXTENDED = 0 347LB_NEEDED_SB = 0 348LB_OWNERDRAW = 0 349LB_ALWAYS_SB = 0 350LB_NO_SB = 0 351LB_HSCROLL = 0 352LB_INT_HEIGHT = 0 353CB_SIMPLE = 0 354CB_SORT = 0 355CB_READONLY = 0 356CB_DROPDOWN = 0 357RA_LEFTTORIGHT = 0 358RA_TOPTOBOTTOM = 0 359RA_SPECIFY_COLS = 0 360RA_SPECIFY_ROWS = 0 361RA_HORIZONTAL = 0 362RA_VERTICAL = 0 363RB_GROUP = 0 364RB_SINGLE = 0 365SB_HORIZONTAL = 0 366SB_VERTICAL = 0 367SP_HORIZONTAL = 0 368SP_VERTICAL = 0 369SP_ARROW_KEYS = 0 370SP_WRAP = 0 371TC_RIGHTJUSTIFY = 0 372TC_FIXEDWIDTH = 0 373TC_TOP = 0 374TC_LEFT = 0 375TC_RIGHT = 0 376TC_BOTTOM = 0 377TC_MULTILINE = 0 378TC_OWNERDRAW = 0 379BI_EXPAND = 0 380LI_HORIZONTAL = 0 381LI_VERTICAL = 0 382YES = 0 383OK = 0 384NO = 0 385YES_NO = 0 386CANCEL = 0 387APPLY = 0 388CLOSE = 0 389OK_DEFAULT = 0 390YES_DEFAULT = 0 391NO_DEFAULT = 0 392CANCEL_DEFAULT = 0 393ICON_EXCLAMATION = 0 394ICON_HAND = 0 395ICON_WARNING = 0 396ICON_ERROR = 0 397ICON_QUESTION = 0 398ICON_INFORMATION = 0 399ICON_STOP = 0 400ICON_ASTERISK = 0 401HELP = 0 402FORWARD = 0 403BACKWARD = 0 404RESET = 0 405MORE = 0 406SETUP = 0 407ICON_NONE = 0 408ICON_AUTH_NEEDED = 0 409ICON_MASK = 0 410NOT_FOUND = 0 411PRINT_QUALITY_HIGH = 0 412PRINT_QUALITY_MEDIUM = 0 413PRINT_QUALITY_LOW = 0 414PRINT_QUALITY_DRAFT = 0 415STAY_ON_TOP = 0 416ICONIZE = 0 417MINIMIZE = 0 418MAXIMIZE = 0 419CLOSE_BOX = 0 420SYSTEM_MENU = 0 421MINIMIZE_BOX = 0 422MAXIMIZE_BOX = 0 423TINY_CAPTION = 0 424RESIZE_BORDER = 0 425CENTRE = 0 426CENTER = 0 427HORIZONTAL = 0 428VERTICAL = 0 429BOTH = 0 430ORIENTATION_MASK = 0 431LEFT = 0 432RIGHT = 0 433UP = 0 434DOWN = 0 435TOP = 0 436BOTTOM = 0 437NORTH = 0 438SOUTH = 0 439WEST = 0 440EAST = 0 441ALL = 0 442DIRECTION_MASK = 0 443ALIGN_INVALID = 0 444ALIGN_NOT = 0 445ALIGN_CENTER_HORIZONTAL = 0 446ALIGN_CENTRE_HORIZONTAL = 0 447ALIGN_LEFT = 0 448ALIGN_TOP = 0 449ALIGN_RIGHT = 0 450ALIGN_BOTTOM = 0 451ALIGN_CENTER_VERTICAL = 0 452ALIGN_CENTRE_VERTICAL = 0 453ALIGN_CENTER = 0 454ALIGN_CENTRE = 0 455ALIGN_MASK = 0 456FIXED_MINSIZE = 0 457RESERVE_SPACE_EVEN_IF_HIDDEN = 0 458SIZER_FLAG_BITS_MASK = 0 459STRETCH_NOT = 0 460SHRINK = 0 461GROW = 0 462EXPAND = 0 463SHAPED = 0 464TILE = 0 465STRETCH_MASK = 0 466BORDER_DEFAULT = 0 467BORDER_NONE = 0 468BORDER_STATIC = 0 469BORDER_SIMPLE = 0 470BORDER_RAISED = 0 471BORDER_SUNKEN = 0 472BORDER_DOUBLE = 0 473BORDER_THEME = 0 474BORDER_MASK = 0 475BG_STYLE_ERASE = 0 476BG_STYLE_SYSTEM = 0 477BG_STYLE_PAINT = 0 478BG_STYLE_COLOUR = 0 479BG_STYLE_TRANSPARENT = 0 480ID_AUTO_LOWEST = 0 481ID_AUTO_HIGHEST = 0 482ID_NONE = 0 483ID_SEPARATOR = 0 484ID_ANY = 0 485ID_LOWEST = 0 486ID_OPEN = 0 487ID_CLOSE = 0 488ID_NEW = 0 489ID_SAVE = 0 490ID_SAVEAS = 0 491ID_REVERT = 0 492ID_EXIT = 0 493ID_UNDO = 0 494ID_REDO = 0 495ID_HELP = 0 496ID_PRINT = 0 497ID_PRINT_SETUP = 0 498ID_PAGE_SETUP = 0 499ID_PREVIEW = 0 500ID_ABOUT = 0 501ID_HELP_CONTENTS = 0 502ID_HELP_INDEX = 0 503ID_HELP_SEARCH = 0 504ID_HELP_COMMANDS = 0 505ID_HELP_PROCEDURES = 0 506ID_HELP_CONTEXT = 0 507ID_CLOSE_ALL = 0 508ID_PREFERENCES = 0 509ID_EDIT = 0 510ID_CUT = 0 511ID_COPY = 0 512ID_PASTE = 0 513ID_CLEAR = 0 514ID_FIND = 0 515ID_DUPLICATE = 0 516ID_SELECTALL = 0 517ID_DELETE = 0 518ID_REPLACE = 0 519ID_REPLACE_ALL = 0 520ID_PROPERTIES = 0 521ID_VIEW_DETAILS = 0 522ID_VIEW_LARGEICONS = 0 523ID_VIEW_SMALLICONS = 0 524ID_VIEW_LIST = 0 525ID_VIEW_SORTDATE = 0 526ID_VIEW_SORTNAME = 0 527ID_VIEW_SORTSIZE = 0 528ID_VIEW_SORTTYPE = 0 529ID_FILE = 0 530ID_FILE1 = 0 531ID_FILE2 = 0 532ID_FILE3 = 0 533ID_FILE4 = 0 534ID_FILE5 = 0 535ID_FILE6 = 0 536ID_FILE7 = 0 537ID_FILE8 = 0 538ID_FILE9 = 0 539ID_OK = 0 540ID_CANCEL = 0 541ID_APPLY = 0 542ID_YES = 0 543ID_NO = 0 544ID_STATIC = 0 545ID_FORWARD = 0 546ID_BACKWARD = 0 547ID_DEFAULT = 0 548ID_MORE = 0 549ID_SETUP = 0 550ID_RESET = 0 551ID_CONTEXT_HELP = 0 552ID_YESTOALL = 0 553ID_NOTOALL = 0 554ID_ABORT = 0 555ID_RETRY = 0 556ID_IGNORE = 0 557ID_ADD = 0 558ID_REMOVE = 0 559ID_UP = 0 560ID_DOWN = 0 561ID_HOME = 0 562ID_REFRESH = 0 563ID_STOP = 0 564ID_INDEX = 0 565ID_BOLD = 0 566ID_ITALIC = 0 567ID_JUSTIFY_CENTER = 0 568ID_JUSTIFY_FILL = 0 569ID_JUSTIFY_RIGHT = 0 570ID_JUSTIFY_LEFT = 0 571ID_UNDERLINE = 0 572ID_INDENT = 0 573ID_UNINDENT = 0 574ID_ZOOM_100 = 0 575ID_ZOOM_FIT = 0 576ID_ZOOM_IN = 0 577ID_ZOOM_OUT = 0 578ID_UNDELETE = 0 579ID_REVERT_TO_SAVED = 0 580ID_CDROM = 0 581ID_CONVERT = 0 582ID_EXECUTE = 0 583ID_FLOPPY = 0 584ID_HARDDISK = 0 585ID_BOTTOM = 0 586ID_FIRST = 0 587ID_LAST = 0 588ID_TOP = 0 589ID_INFO = 0 590ID_JUMP_TO = 0 591ID_NETWORK = 0 592ID_SELECT_COLOR = 0 593ID_SELECT_FONT = 0 594ID_SORT_ASCENDING = 0 595ID_SORT_DESCENDING = 0 596ID_SPELL_CHECK = 0 597ID_STRIKETHROUGH = 0 598ID_SYSTEM_MENU = 0 599ID_CLOSE_FRAME = 0 600ID_MOVE_FRAME = 0 601ID_RESIZE_FRAME = 0 602ID_MAXIMIZE_FRAME = 0 603ID_ICONIZE_FRAME = 0 604ID_RESTORE_FRAME = 0 605ID_MDI_WINDOW_FIRST = 0 606ID_MDI_WINDOW_CASCADE = 0 607ID_MDI_WINDOW_TILE_HORZ = 0 608ID_MDI_WINDOW_TILE_VERT = 0 609ID_MDI_WINDOW_ARRANGE_ICONS = 0 610ID_MDI_WINDOW_PREV = 0 611ID_MDI_WINDOW_NEXT = 0 612ID_MDI_WINDOW_LAST = 0 613ID_FILEDLGG = 0 614ID_FILECTRL = 0 615ID_HIGHEST = 0 616ITEM_SEPARATOR = 0 617ITEM_NORMAL = 0 618ITEM_CHECK = 0 619ITEM_RADIO = 0 620ITEM_DROPDOWN = 0 621ITEM_MAX = 0 622HT_NOWHERE = 0 623HT_SCROLLBAR_FIRST = 0 624HT_SCROLLBAR_ARROW_LINE_1 = 0 625HT_SCROLLBAR_ARROW_LINE_2 = 0 626HT_SCROLLBAR_ARROW_PAGE_1 = 0 627HT_SCROLLBAR_ARROW_PAGE_2 = 0 628HT_SCROLLBAR_THUMB = 0 629HT_SCROLLBAR_BAR_1 = 0 630HT_SCROLLBAR_BAR_2 = 0 631HT_SCROLLBAR_LAST = 0 632HT_WINDOW_OUTSIDE = 0 633HT_WINDOW_INSIDE = 0 634HT_WINDOW_VERT_SCROLLBAR = 0 635HT_WINDOW_HORZ_SCROLLBAR = 0 636HT_WINDOW_CORNER = 0 637HT_MAX = 0 638DF_INVALID = 0 639DF_TEXT = 0 640DF_BITMAP = 0 641DF_METAFILE = 0 642DF_SYLK = 0 643DF_DIF = 0 644DF_TIFF = 0 645DF_OEMTEXT = 0 646DF_DIB = 0 647DF_PALETTE = 0 648DF_PENDATA = 0 649DF_RIFF = 0 650DF_WAVE = 0 651DF_UNICODETEXT = 0 652DF_ENHMETAFILE = 0 653DF_FILENAME = 0 654DF_LOCALE = 0 655DF_PRIVATE = 0 656DF_HTML = 0 657DF_MAX = 0 658WXK_NONE = 0 659WXK_CONTROL_A = 0 660WXK_CONTROL_B = 0 661WXK_CONTROL_C = 0 662WXK_CONTROL_D = 0 663WXK_CONTROL_E = 0 664WXK_CONTROL_F = 0 665WXK_CONTROL_G = 0 666WXK_CONTROL_H = 0 667WXK_CONTROL_I = 0 668WXK_CONTROL_J = 0 669WXK_CONTROL_K = 0 670WXK_CONTROL_L = 0 671WXK_CONTROL_M = 0 672WXK_CONTROL_N = 0 673WXK_CONTROL_O = 0 674WXK_CONTROL_P = 0 675WXK_CONTROL_Q = 0 676WXK_CONTROL_R = 0 677WXK_CONTROL_S = 0 678WXK_CONTROL_T = 0 679WXK_CONTROL_U = 0 680WXK_CONTROL_V = 0 681WXK_CONTROL_W = 0 682WXK_CONTROL_X = 0 683WXK_CONTROL_Y = 0 684WXK_CONTROL_Z = 0 685WXK_BACK = 0 686WXK_TAB = 0 687WXK_RETURN = 0 688WXK_ESCAPE = 0 689WXK_SPACE = 0 690WXK_DELETE = 0 691WXK_START = 0 692WXK_LBUTTON = 0 693WXK_RBUTTON = 0 694WXK_CANCEL = 0 695WXK_MBUTTON = 0 696WXK_CLEAR = 0 697WXK_SHIFT = 0 698WXK_ALT = 0 699WXK_CONTROL = 0 700WXK_RAW_CONTROL = 0 701WXK_MENU = 0 702WXK_PAUSE = 0 703WXK_CAPITAL = 0 704WXK_END = 0 705WXK_HOME = 0 706WXK_LEFT = 0 707WXK_UP = 0 708WXK_RIGHT = 0 709WXK_DOWN = 0 710WXK_SELECT = 0 711WXK_PRINT = 0 712WXK_EXECUTE = 0 713WXK_SNAPSHOT = 0 714WXK_INSERT = 0 715WXK_HELP = 0 716WXK_NUMPAD0 = 0 717WXK_NUMPAD1 = 0 718WXK_NUMPAD2 = 0 719WXK_NUMPAD3 = 0 720WXK_NUMPAD4 = 0 721WXK_NUMPAD5 = 0 722WXK_NUMPAD6 = 0 723WXK_NUMPAD7 = 0 724WXK_NUMPAD8 = 0 725WXK_NUMPAD9 = 0 726WXK_MULTIPLY = 0 727WXK_ADD = 0 728WXK_SEPARATOR = 0 729WXK_SUBTRACT = 0 730WXK_DECIMAL = 0 731WXK_DIVIDE = 0 732WXK_F1 = 0 733WXK_F2 = 0 734WXK_F3 = 0 735WXK_F4 = 0 736WXK_F5 = 0 737WXK_F6 = 0 738WXK_F7 = 0 739WXK_F8 = 0 740WXK_F9 = 0 741WXK_F10 = 0 742WXK_F11 = 0 743WXK_F12 = 0 744WXK_F13 = 0 745WXK_F14 = 0 746WXK_F15 = 0 747WXK_F16 = 0 748WXK_F17 = 0 749WXK_F18 = 0 750WXK_F19 = 0 751WXK_F20 = 0 752WXK_F21 = 0 753WXK_F22 = 0 754WXK_F23 = 0 755WXK_F24 = 0 756WXK_NUMLOCK = 0 757WXK_SCROLL = 0 758WXK_PAGEUP = 0 759WXK_PAGEDOWN = 0 760WXK_NUMPAD_SPACE = 0 761WXK_NUMPAD_TAB = 0 762WXK_NUMPAD_ENTER = 0 763WXK_NUMPAD_F1 = 0 764WXK_NUMPAD_F2 = 0 765WXK_NUMPAD_F3 = 0 766WXK_NUMPAD_F4 = 0 767WXK_NUMPAD_HOME = 0 768WXK_NUMPAD_LEFT = 0 769WXK_NUMPAD_UP = 0 770WXK_NUMPAD_RIGHT = 0 771WXK_NUMPAD_DOWN = 0 772WXK_NUMPAD_PAGEUP = 0 773WXK_NUMPAD_PAGEDOWN = 0 774WXK_NUMPAD_END = 0 775WXK_NUMPAD_BEGIN = 0 776WXK_NUMPAD_INSERT = 0 777WXK_NUMPAD_DELETE = 0 778WXK_NUMPAD_EQUAL = 0 779WXK_NUMPAD_MULTIPLY = 0 780WXK_NUMPAD_ADD = 0 781WXK_NUMPAD_SEPARATOR = 0 782WXK_NUMPAD_SUBTRACT = 0 783WXK_NUMPAD_DECIMAL = 0 784WXK_NUMPAD_DIVIDE = 0 785WXK_WINDOWS_LEFT = 0 786WXK_WINDOWS_RIGHT = 0 787WXK_WINDOWS_MENU = 0 788WXK_COMMAND = 0 789WXK_SPECIAL1 = 0 790WXK_SPECIAL2 = 0 791WXK_SPECIAL3 = 0 792WXK_SPECIAL4 = 0 793WXK_SPECIAL5 = 0 794WXK_SPECIAL6 = 0 795WXK_SPECIAL7 = 0 796WXK_SPECIAL8 = 0 797WXK_SPECIAL9 = 0 798WXK_SPECIAL10 = 0 799WXK_SPECIAL11 = 0 800WXK_SPECIAL12 = 0 801WXK_SPECIAL13 = 0 802WXK_SPECIAL14 = 0 803WXK_SPECIAL15 = 0 804WXK_SPECIAL16 = 0 805WXK_SPECIAL17 = 0 806WXK_SPECIAL18 = 0 807WXK_SPECIAL19 = 0 808WXK_SPECIAL20 = 0 809MOD_NONE = 0 810MOD_ALT = 0 811MOD_CONTROL = 0 812MOD_ALTGR = 0 813MOD_SHIFT = 0 814MOD_META = 0 815MOD_WIN = 0 816MOD_RAW_CONTROL = 0 817MOD_CMD = 0 818MOD_ALL = 0 819PAPER_10X11 = 0 820PAPER_10X14 = 0 821PAPER_11X17 = 0 822PAPER_12X11 = 0 823PAPER_15X11 = 0 824PAPER_9X11 = 0 825PAPER_A2 = 0 826PAPER_A3 = 0 827PAPER_A3_EXTRA = 0 828PAPER_A3_EXTRA_TRANSVERSE = 0 829PAPER_A3_ROTATED = 0 830PAPER_A3_TRANSVERSE = 0 831PAPER_A4 = 0 832PAPER_A4SMALL = 0 833PAPER_A4_EXTRA = 0 834PAPER_A4_PLUS = 0 835PAPER_A4_ROTATED = 0 836PAPER_A4_TRANSVERSE = 0 837PAPER_A5 = 0 838PAPER_A5_EXTRA = 0 839PAPER_A5_ROTATED = 0 840PAPER_A5_TRANSVERSE = 0 841PAPER_A6 = 0 842PAPER_A6_ROTATED = 0 843PAPER_A_PLUS = 0 844PAPER_B4 = 0 845PAPER_B4_JIS_ROTATED = 0 846PAPER_B5 = 0 847PAPER_B5_EXTRA = 0 848PAPER_B5_JIS_ROTATED = 0 849PAPER_B5_TRANSVERSE = 0 850PAPER_B6_JIS = 0 851PAPER_B6_JIS_ROTATED = 0 852PAPER_B_PLUS = 0 853PAPER_CSHEET = 0 854PAPER_DBL_JAPANESE_POSTCARD = 0 855PAPER_DBL_JAPANESE_POSTCARD_ROTATED = 0 856PAPER_DSHEET = 0 857PAPER_ENV_10 = 0 858PAPER_ENV_11 = 0 859PAPER_ENV_12 = 0 860PAPER_ENV_14 = 0 861PAPER_ENV_9 = 0 862PAPER_ENV_B4 = 0 863PAPER_ENV_B5 = 0 864PAPER_ENV_B6 = 0 865PAPER_ENV_C3 = 0 866PAPER_ENV_C4 = 0 867PAPER_ENV_C5 = 0 868PAPER_ENV_C6 = 0 869PAPER_ENV_C65 = 0 870PAPER_ENV_DL = 0 871PAPER_ENV_INVITE = 0 872PAPER_ENV_ITALY = 0 873PAPER_ENV_MONARCH = 0 874PAPER_ENV_PERSONAL = 0 875PAPER_ESHEET = 0 876PAPER_EXECUTIVE = 0 877PAPER_FANFOLD_LGL_GERMAN = 0 878PAPER_FANFOLD_STD_GERMAN = 0 879PAPER_FANFOLD_US = 0 880PAPER_FOLIO = 0 881PAPER_ISO_B4 = 0 882PAPER_JAPANESE_POSTCARD = 0 883PAPER_JAPANESE_POSTCARD_ROTATED = 0 884PAPER_JENV_CHOU3 = 0 885PAPER_JENV_CHOU3_ROTATED = 0 886PAPER_JENV_CHOU4 = 0 887PAPER_JENV_CHOU4_ROTATED = 0 888PAPER_JENV_KAKU2 = 0 889PAPER_JENV_KAKU2_ROTATED = 0 890PAPER_JENV_KAKU3 = 0 891PAPER_JENV_KAKU3_ROTATED = 0 892PAPER_JENV_YOU4 = 0 893PAPER_JENV_YOU4_ROTATED = 0 894PAPER_LEDGER = 0 895PAPER_LEGAL = 0 896PAPER_LEGAL_EXTRA = 0 897PAPER_LETTER = 0 898PAPER_LETTERSMALL = 0 899PAPER_LETTER_EXTRA = 0 900PAPER_LETTER_EXTRA_TRANSVERSE = 0 901PAPER_LETTER_PLUS = 0 902PAPER_LETTER_ROTATED = 0 903PAPER_LETTER_TRANSVERSE = 0 904PAPER_NONE = 0 905PAPER_NOTE = 0 906PAPER_P16K = 0 907PAPER_P16K_ROTATED = 0 908PAPER_P32K = 0 909PAPER_P32KBIG = 0 910PAPER_P32KBIG_ROTATED = 0 911PAPER_P32K_ROTATED = 0 912PAPER_PENV_1 = 0 913PAPER_PENV_10 = 0 914PAPER_PENV_10_ROTATED = 0 915PAPER_PENV_1_ROTATED = 0 916PAPER_PENV_2 = 0 917PAPER_PENV_2_ROTATED = 0 918PAPER_PENV_3 = 0 919PAPER_PENV_3_ROTATED = 0 920PAPER_PENV_4 = 0 921PAPER_PENV_4_ROTATED = 0 922PAPER_PENV_5 = 0 923PAPER_PENV_5_ROTATED = 0 924PAPER_PENV_6 = 0 925PAPER_PENV_6_ROTATED = 0 926PAPER_PENV_7 = 0 927PAPER_PENV_7_ROTATED = 0 928PAPER_PENV_8 = 0 929PAPER_PENV_8_ROTATED = 0 930PAPER_PENV_9 = 0 931PAPER_PENV_9_ROTATED = 0 932PAPER_QUARTO = 0 933PAPER_STATEMENT = 0 934PAPER_TABLOID = 0 935PAPER_TABLOID_EXTRA = 0 936PORTRAIT = 0 937LANDSCAPE = 0 938DUPLEX_SIMPLEX = 0 939DUPLEX_HORIZONTAL = 0 940DUPLEX_VERTICAL = 0 941PRINT_MODE_NONE = 0 942PRINT_MODE_PREVIEW = 0 943PRINT_MODE_FILE = 0 944PRINT_MODE_PRINTER = 0 945PRINT_MODE_STREAM = 0 946UPDATE_UI_NONE = 0 947UPDATE_UI_RECURSE = 0 948UPDATE_UI_FROMIDLE = 0 949DefaultCoord = 0 950 951BG_STYLE_CUSTOM = BG_STYLE_PAINT 952ADJUST_MINSIZE = 0 953#-- end-defs --# 954#-- begin-debug --# 955 956def Abort(): 957 """ 958 Abort() 959 960 Exits the program immediately. 961 """ 962 963def DisableAsserts(): 964 """ 965 DisableAsserts() 966 967 Disable the condition checks in the assertions. 968 """ 969 970def Trap(): 971 """ 972 Trap() 973 974 Generate a debugger exception meaning that the control is passed to 975 the debugger if one is attached to the process. 976 """ 977#-- end-debug --# 978#-- begin-object --# 979 980class RefCounter(object): 981 """ 982 RefCounter() 983 984 This class is used to manage reference-counting providing a simple 985 interface and a counter. 986 """ 987 988 def __init__(self): 989 """ 990 RefCounter() 991 992 This class is used to manage reference-counting providing a simple 993 interface and a counter. 994 """ 995 996 def DecRef(self): 997 """ 998 DecRef() 999 1000 Decrements the reference count associated with this shared data and, 1001 if it reaches zero, destroys this instance of wxRefCounter releasing 1002 its memory. 1003 """ 1004 1005 def GetRefCount(self): 1006 """ 1007 GetRefCount() -> int 1008 1009 Returns the reference count associated with this shared data. 1010 """ 1011 1012 def IncRef(self): 1013 """ 1014 IncRef() 1015 1016 Increments the reference count associated with this shared data. 1017 """ 1018 RefCount = property(None, None) 1019# end of class RefCounter 1020 1021 1022class Object(object): 1023 """ 1024 Object() 1025 Object(other) 1026 1027 This is the root class of many of the wxWidgets classes. 1028 """ 1029 1030 def __init__(self, *args, **kw): 1031 """ 1032 Object() 1033 Object(other) 1034 1035 This is the root class of many of the wxWidgets classes. 1036 """ 1037 1038 def GetClassInfo(self): 1039 """ 1040 GetClassInfo() -> ClassInfo 1041 1042 This virtual function is redefined for every class that requires run- 1043 time type information, when using the wxDECLARE_CLASS macro (or 1044 similar). 1045 """ 1046 1047 def GetRefData(self): 1048 """ 1049 GetRefData() -> ObjectRefData 1050 1051 Returns the wxObject::m_refData pointer, i.e. the data referenced by 1052 this object. 1053 """ 1054 1055 def IsSameAs(self, obj): 1056 """ 1057 IsSameAs(obj) -> bool 1058 1059 Returns true if this object has the same data pointer as obj. 1060 """ 1061 1062 def Ref(self, clone): 1063 """ 1064 Ref(clone) 1065 1066 Makes this object refer to the data in clone. 1067 """ 1068 1069 def SetRefData(self, data): 1070 """ 1071 SetRefData(data) 1072 1073 Sets the wxObject::m_refData pointer. 1074 """ 1075 1076 def UnRef(self): 1077 """ 1078 UnRef() 1079 1080 Decrements the reference count in the associated data, and if it is 1081 zero, deletes the data. 1082 """ 1083 1084 def UnShare(self): 1085 """ 1086 UnShare() 1087 1088 This is the same of AllocExclusive() but this method is public. 1089 """ 1090 1091 def GetClassName(self): 1092 """ 1093 GetClassName() -> Char 1094 1095 Returns the class name of the C++ class using wxRTTI. 1096 """ 1097 1098 def Destroy(self): 1099 """ 1100 Destroy() 1101 1102 Deletes the C++ object this Python object is a proxy for. 1103 """ 1104 ClassInfo = property(None, None) 1105 ClassName = property(None, None) 1106 RefData = property(None, None) 1107# end of class Object 1108 1109 1110class ClassInfo(object): 1111 """ 1112 This class stores meta-information about classes. 1113 """ 1114 1115 def CreateObject(self): 1116 """ 1117 CreateObject() -> Object 1118 1119 Creates an object of the appropriate kind. 1120 """ 1121 1122 def GetBaseClassName1(self): 1123 """ 1124 GetBaseClassName1() -> Char 1125 1126 Returns the name of the first base class (NULL if none). 1127 """ 1128 1129 def GetBaseClassName2(self): 1130 """ 1131 GetBaseClassName2() -> Char 1132 1133 Returns the name of the second base class (NULL if none). 1134 """ 1135 1136 def GetClassName(self): 1137 """ 1138 GetClassName() -> Char 1139 1140 Returns the string form of the class name. 1141 """ 1142 1143 def GetSize(self): 1144 """ 1145 GetSize() -> int 1146 1147 Returns the size of the class. 1148 """ 1149 1150 def IsDynamic(self): 1151 """ 1152 IsDynamic() -> bool 1153 1154 Returns true if this class info can create objects of the associated 1155 class. 1156 """ 1157 1158 def IsKindOf(self, info): 1159 """ 1160 IsKindOf(info) -> bool 1161 1162 Returns true if this class is a kind of (inherits from) the given 1163 class. 1164 """ 1165 1166 @staticmethod 1167 def FindClass(className): 1168 """ 1169 FindClass(className) -> ClassInfo 1170 1171 Finds the wxClassInfo object for a class with the given name. 1172 """ 1173 BaseClassName1 = property(None, None) 1174 BaseClassName2 = property(None, None) 1175 ClassName = property(None, None) 1176 Size = property(None, None) 1177# end of class ClassInfo 1178 1179#-- end-object --# 1180#-- begin-clntdatactnr --# 1181 1182class ClientDataContainer(object): 1183 """ 1184 ClientDataContainer() 1185 1186 This class is a mixin that provides storage and management of "client 1187 data". 1188 """ 1189 1190 def __init__(self): 1191 """ 1192 ClientDataContainer() 1193 1194 This class is a mixin that provides storage and management of "client 1195 data". 1196 """ 1197 1198 def GetClientData(self): 1199 """ 1200 GetClientData() -> ClientData 1201 1202 Get a pointer to the client data object. 1203 """ 1204 1205 def SetClientData(self, data): 1206 """ 1207 SetClientData(data) 1208 1209 Set the client data object. 1210 """ 1211 1212 def GetClientObject(self): 1213 """ 1214 Alias for :meth:`GetClientData` 1215 """ 1216 1217 def SetClientObject(self, data): 1218 """ 1219 Alias for :meth:`SetClientData` 1220 """ 1221 ClientData = property(None, None) 1222# end of class ClientDataContainer 1223 1224#-- end-clntdatactnr --# 1225#-- begin-wxdatetime --# 1226DefaultTimeSpanFormat = "" 1227DefaultDateTimeFormat = "" 1228 1229class DateTime(object): 1230 """ 1231 DateTime() 1232 DateTime(date) 1233 DateTime(day, month, year=Inv_Year, hour=0, minute=0, second=0, millisec=0) 1234 1235 wxDateTime class represents an absolute moment in time. 1236 """ 1237 1238 class TimeZone(object): 1239 """ 1240 TimeZone(tz) 1241 TimeZone(offset=0) 1242 1243 Class representing a time zone. 1244 """ 1245 1246 def __init__(self, *args, **kw): 1247 """ 1248 TimeZone(tz) 1249 TimeZone(offset=0) 1250 1251 Class representing a time zone. 1252 """ 1253 1254 def GetOffset(self): 1255 """ 1256 GetOffset() -> long 1257 1258 Return the offset of this time zone from UTC, in seconds. 1259 """ 1260 1261 @staticmethod 1262 def Make(offset): 1263 """ 1264 Make(offset) -> DateTime.TimeZone 1265 1266 Create a time zone with the given offset in seconds. 1267 """ 1268 Offset = property(None, None) 1269 # end of class TimeZone 1270 1271 1272 class Tm(object): 1273 """ 1274 Contains broken down date-time representation. 1275 """ 1276 msec = property(None, None) 1277 sec = property(None, None) 1278 min = property(None, None) 1279 hour = property(None, None) 1280 mday = property(None, None) 1281 yday = property(None, None) 1282 mon = property(None, None) 1283 year = property(None, None) 1284 1285 def IsValid(self): 1286 """ 1287 IsValid() -> bool 1288 1289 Check if the given date/time is valid (in Gregorian calendar). 1290 """ 1291 1292 def GetWeekDay(self): 1293 """ 1294 GetWeekDay() -> DateTime.WeekDay 1295 1296 Return the week day corresponding to this date. 1297 """ 1298 WeekDay = property(None, None) 1299 # end of class Tm 1300 1301 Local = 0 1302 GMT_12 = 0 1303 GMT_11 = 0 1304 GMT_10 = 0 1305 GMT_9 = 0 1306 GMT_8 = 0 1307 GMT_7 = 0 1308 GMT_6 = 0 1309 GMT_5 = 0 1310 GMT_4 = 0 1311 GMT_3 = 0 1312 GMT_2 = 0 1313 GMT_1 = 0 1314 GMT0 = 0 1315 GMT1 = 0 1316 GMT2 = 0 1317 GMT3 = 0 1318 GMT4 = 0 1319 GMT5 = 0 1320 GMT6 = 0 1321 GMT7 = 0 1322 GMT8 = 0 1323 GMT9 = 0 1324 GMT10 = 0 1325 GMT11 = 0 1326 GMT12 = 0 1327 GMT13 = 0 1328 WET = 0 1329 WEST = 0 1330 CET = 0 1331 CEST = 0 1332 EET = 0 1333 EEST = 0 1334 MSK = 0 1335 MSD = 0 1336 AST = 0 1337 ADT = 0 1338 EST = 0 1339 EDT = 0 1340 CST = 0 1341 CDT = 0 1342 MST = 0 1343 MDT = 0 1344 PST = 0 1345 PDT = 0 1346 HST = 0 1347 AKST = 0 1348 AKDT = 0 1349 A_WST = 0 1350 A_CST = 0 1351 A_EST = 0 1352 A_ESST = 0 1353 NZST = 0 1354 NZDT = 0 1355 UTC = 0 1356 Gregorian = 0 1357 Julian = 0 1358 Country_Unknown = 0 1359 Country_Default = 0 1360 Country_WesternEurope_Start = 0 1361 Country_EEC = 0 1362 France = 0 1363 Germany = 0 1364 UK = 0 1365 Country_WesternEurope_End = 0 1366 Russia = 0 1367 USA = 0 1368 Jan = 0 1369 Feb = 0 1370 Mar = 0 1371 Apr = 0 1372 May = 0 1373 Jun = 0 1374 Jul = 0 1375 Aug = 0 1376 Sep = 0 1377 Oct = 0 1378 Nov = 0 1379 Dec = 0 1380 Inv_Month = 0 1381 Sun = 0 1382 Mon = 0 1383 Tue = 0 1384 Wed = 0 1385 Thu = 0 1386 Fri = 0 1387 Sat = 0 1388 Inv_WeekDay = 0 1389 Inv_Year = 0 1390 Name_Full = 0 1391 Name_Abbr = 0 1392 Default_First = 0 1393 Monday_First = 0 1394 Sunday_First = 0 1395 1396 def __init__(self, *args, **kw): 1397 """ 1398 DateTime() 1399 DateTime(date) 1400 DateTime(day, month, year=Inv_Year, hour=0, minute=0, second=0, millisec=0) 1401 1402 wxDateTime class represents an absolute moment in time. 1403 """ 1404 1405 def ResetTime(self): 1406 """ 1407 ResetTime() -> DateTime 1408 1409 Reset time to midnight (00:00:00) without changing the date. 1410 """ 1411 1412 def Set(self, day, month, year=Inv_Year, hour=0, minute=0, second=0, millisec=0): 1413 """ 1414 Set(day, month, year=Inv_Year, hour=0, minute=0, second=0, millisec=0) -> DateTime 1415 1416 Sets the date and time from the parameters. 1417 """ 1418 1419 def SetHMS(self, hour, minute=0, second=0, millisec=0): 1420 """ 1421 SetHMS(hour, minute=0, second=0, millisec=0) -> DateTime 1422 1423 Sets the date to be equal to Today() and the time from supplied 1424 parameters. 1425 """ 1426 1427 def SetJDN(self, jdn): 1428 """ 1429 SetJDN(jdn) -> DateTime 1430 1431 Sets the date from the so-called Julian Day Number. 1432 """ 1433 1434 def SetTimeT(self, timet): 1435 """ 1436 SetTimeT(timet) -> DateTime 1437 1438 Constructs the object from timet value holding the number of seconds 1439 since Jan 1, 1970 UTC. 1440 """ 1441 1442 def SetTm(self, tm): 1443 """ 1444 SetTm(tm) -> DateTime 1445 1446 Sets the date and time from the broken down representation in the 1447 wxDateTime::Tm structure. 1448 """ 1449 1450 def SetDay(self, day): 1451 """ 1452 SetDay(day) -> DateTime 1453 1454 Sets the day without changing other date components. 1455 """ 1456 1457 def SetFromDOS(self, ddt): 1458 """ 1459 SetFromDOS(ddt) -> DateTime 1460 1461 Sets the date from the date and time in DOS format. 1462 """ 1463 1464 def SetHour(self, hour): 1465 """ 1466 SetHour(hour) -> DateTime 1467 1468 Sets the hour without changing other date components. 1469 """ 1470 1471 def SetMillisecond(self, millisecond): 1472 """ 1473 SetMillisecond(millisecond) -> DateTime 1474 1475 Sets the millisecond without changing other date components. 1476 """ 1477 1478 def SetMinute(self, minute): 1479 """ 1480 SetMinute(minute) -> DateTime 1481 1482 Sets the minute without changing other date components. 1483 """ 1484 1485 def SetMonth(self, month): 1486 """ 1487 SetMonth(month) -> DateTime 1488 1489 Sets the month without changing other date components. 1490 """ 1491 1492 def SetSecond(self, second): 1493 """ 1494 SetSecond(second) -> DateTime 1495 1496 Sets the second without changing other date components. 1497 """ 1498 1499 def SetToCurrent(self): 1500 """ 1501 SetToCurrent() -> DateTime 1502 1503 Sets the date and time of to the current values. 1504 """ 1505 1506 def SetYear(self, year): 1507 """ 1508 SetYear(year) -> DateTime 1509 1510 Sets the year without changing other date components. 1511 """ 1512 1513 def GetAsDOS(self): 1514 """ 1515 GetAsDOS() -> unsignedlong 1516 1517 Returns the date and time in DOS format. 1518 """ 1519 1520 def GetCentury(self, tz=Local): 1521 """ 1522 GetCentury(tz=Local) -> int 1523 1524 Returns the century of this date. 1525 """ 1526 1527 def GetDateOnly(self): 1528 """ 1529 GetDateOnly() -> DateTime 1530 1531 Returns the object having the same date component as this one but time 1532 of 00:00:00. 1533 """ 1534 1535 def GetDay(self, tz=Local): 1536 """ 1537 GetDay(tz=Local) -> unsignedshort 1538 1539 Returns the day in the given timezone (local one by default). 1540 """ 1541 1542 def GetDayOfYear(self, tz=Local): 1543 """ 1544 GetDayOfYear(tz=Local) -> unsignedshort 1545 1546 Returns the day of the year (in 1-366 range) in the given timezone 1547 (local one by default). 1548 """ 1549 1550 def GetHour(self, tz=Local): 1551 """ 1552 GetHour(tz=Local) -> unsignedshort 1553 1554 Returns the hour in the given timezone (local one by default). 1555 """ 1556 1557 def GetMillisecond(self, tz=Local): 1558 """ 1559 GetMillisecond(tz=Local) -> unsignedshort 1560 1561 Returns the milliseconds in the given timezone (local one by default). 1562 """ 1563 1564 def GetMinute(self, tz=Local): 1565 """ 1566 GetMinute(tz=Local) -> unsignedshort 1567 1568 Returns the minute in the given timezone (local one by default). 1569 """ 1570 1571 def GetMonth(self, tz=Local): 1572 """ 1573 GetMonth(tz=Local) -> DateTime.Month 1574 1575 Returns the month in the given timezone (local one by default). 1576 """ 1577 1578 def GetSecond(self, tz=Local): 1579 """ 1580 GetSecond(tz=Local) -> unsignedshort 1581 1582 Returns the seconds in the given timezone (local one by default). 1583 """ 1584 1585 def GetTicks(self): 1586 """ 1587 GetTicks() -> time_t 1588 1589 Returns the number of seconds since Jan 1, 1970 UTC. 1590 """ 1591 1592 def GetTm(self, tz=Local): 1593 """ 1594 GetTm(tz=Local) -> DateTime.Tm 1595 1596 Returns broken down representation of the date and time. 1597 """ 1598 1599 def GetWeekDay(self, *args, **kw): 1600 """ 1601 GetWeekDay(tz=Local) -> DateTime.WeekDay 1602 GetWeekDay(weekday, n=1, month=Inv_Month, year=Inv_Year) -> DateTime 1603 1604 Returns the week day in the given timezone (local one by default). 1605 """ 1606 1607 def GetWeekOfMonth(self, flags=Monday_First, tz=Local): 1608 """ 1609 GetWeekOfMonth(flags=Monday_First, tz=Local) -> unsignedshort 1610 1611 Returns the ordinal number of the week in the month (in 1-5 range). 1612 """ 1613 1614 def GetWeekOfYear(self, flags=Monday_First, tz=Local): 1615 """ 1616 GetWeekOfYear(flags=Monday_First, tz=Local) -> unsignedshort 1617 1618 Returns the number of the week of the year this date is in. 1619 """ 1620 1621 def GetYear(self, tz=Local): 1622 """ 1623 GetYear(tz=Local) -> int 1624 1625 Returns the year in the given timezone (local one by default). 1626 """ 1627 1628 def IsValid(self): 1629 """ 1630 IsValid() -> bool 1631 1632 Returns true if the object represents a valid time moment. 1633 """ 1634 1635 def IsWorkDay(self, country=Country_Default): 1636 """ 1637 IsWorkDay(country=Country_Default) -> bool 1638 1639 Returns true is this day is not a holiday in the given country. 1640 """ 1641 1642 def IsEarlierThan(self, datetime): 1643 """ 1644 IsEarlierThan(datetime) -> bool 1645 1646 Returns true if this date precedes the given one. 1647 """ 1648 1649 def IsEqualTo(self, datetime): 1650 """ 1651 IsEqualTo(datetime) -> bool 1652 1653 Returns true if the two dates are strictly identical. 1654 """ 1655 1656 def IsEqualUpTo(self, dt, ts): 1657 """ 1658 IsEqualUpTo(dt, ts) -> bool 1659 1660 Returns true if the date is equal to another one up to the given time 1661 interval, i.e. if the absolute difference between the two dates is 1662 less than this interval. 1663 """ 1664 1665 def IsLaterThan(self, datetime): 1666 """ 1667 IsLaterThan(datetime) -> bool 1668 1669 Returns true if this date is later than the given one. 1670 """ 1671 1672 def IsSameDate(self, dt): 1673 """ 1674 IsSameDate(dt) -> bool 1675 1676 Returns true if the date is the same without comparing the time parts. 1677 """ 1678 1679 def IsSameTime(self, dt): 1680 """ 1681 IsSameTime(dt) -> bool 1682 1683 Returns true if the time is the same (although dates may differ). 1684 """ 1685 1686 def IsStrictlyBetween(self, t1, t2): 1687 """ 1688 IsStrictlyBetween(t1, t2) -> bool 1689 1690 Returns true if this date lies strictly between the two given dates. 1691 """ 1692 1693 def IsBetween(self, t1, t2): 1694 """ 1695 IsBetween(t1, t2) -> bool 1696 1697 Returns true if IsStrictlyBetween() is true or if the date is equal to 1698 one of the limit values. 1699 """ 1700 1701 def Add(self, *args, **kw): 1702 """ 1703 Add(diff) -> DateTime 1704 Add(diff) -> DateTime 1705 1706 Adds the given date span to this object. 1707 """ 1708 1709 def Subtract(self, *args, **kw): 1710 """ 1711 Subtract(diff) -> DateTime 1712 Subtract(diff) -> DateTime 1713 Subtract(dt) -> TimeSpan 1714 1715 Subtracts the given time span from this object. 1716 """ 1717 1718 def DiffAsDateSpan(self, dt): 1719 """ 1720 DiffAsDateSpan(dt) -> DateSpan 1721 1722 Returns the difference between this object and dt as a wxDateSpan. 1723 """ 1724 1725 def Format(self, format=DefaultDateTimeFormat, tz=Local): 1726 """ 1727 Format(format=DefaultDateTimeFormat, tz=Local) -> String 1728 1729 This function does the same as the standard ANSI C strftime(3) 1730 function 1731 (http://www.cplusplus.com/reference/clibrary/ctime/strftime.html). 1732 """ 1733 1734 def FormatDate(self): 1735 """ 1736 FormatDate() -> String 1737 1738 Identical to calling Format() with "%x" argument (which means 1739 "preferred date representation for the current locale"). 1740 """ 1741 1742 def FormatISOCombined(self, sep='T'): 1743 """ 1744 FormatISOCombined(sep='T') -> String 1745 1746 Returns the combined date-time representation in the ISO 8601 format 1747 "YYYY-MM-DDTHH:MM:SS". 1748 """ 1749 1750 def FormatISODate(self): 1751 """ 1752 FormatISODate() -> String 1753 1754 This function returns the date representation in the ISO 8601 format 1755 "YYYY-MM-DD". 1756 """ 1757 1758 def FormatISOTime(self): 1759 """ 1760 FormatISOTime() -> String 1761 1762 This function returns the time representation in the ISO 8601 format 1763 "HH:MM:SS". 1764 """ 1765 1766 def FormatTime(self): 1767 """ 1768 FormatTime() -> String 1769 1770 Identical to calling Format() with "%X" argument (which means 1771 "preferred time representation for the current locale"). 1772 """ 1773 1774 def ParseDate(self, date): 1775 """ 1776 ParseDate(date) -> int 1777 1778 This function is like ParseDateTime(), but it only allows the date to 1779 be specified. 1780 """ 1781 1782 def ParseDateTime(self, datetime): 1783 """ 1784 ParseDateTime(datetime) -> int 1785 1786 Parses the string datetime containing the date and time in free 1787 format. 1788 """ 1789 1790 def ParseFormat(self, *args, **kw): 1791 """ 1792 ParseFormat(date, format, dateDef) -> int 1793 ParseFormat(date, format) -> int 1794 ParseFormat(date) -> int 1795 1796 This function parses the string date according to the given format. 1797 """ 1798 1799 def ParseISOCombined(self, date, sep='T'): 1800 """ 1801 ParseISOCombined(date, sep='T') -> bool 1802 1803 This function parses the string containing the date and time in ISO 1804 8601 combined format "YYYY-MM-DDTHH:MM:SS". 1805 """ 1806 1807 def ParseISODate(self, date): 1808 """ 1809 ParseISODate(date) -> bool 1810 1811 This function parses the date in ISO 8601 format "YYYY-MM-DD". 1812 """ 1813 1814 def ParseISOTime(self, date): 1815 """ 1816 ParseISOTime(date) -> bool 1817 1818 This function parses the time in ISO 8601 format "HH:MM:SS". 1819 """ 1820 1821 def ParseRfc822Date(self, date): 1822 """ 1823 ParseRfc822Date(date) -> int 1824 1825 Parses the string date looking for a date formatted according to the 1826 RFC 822 in it. 1827 """ 1828 1829 def ParseTime(self, time): 1830 """ 1831 ParseTime(time) -> int 1832 1833 This functions is like ParseDateTime(), but only allows the time to be 1834 specified in the input string. 1835 """ 1836 1837 def GetLastMonthDay(self, month=Inv_Month, year=Inv_Year): 1838 """ 1839 GetLastMonthDay(month=Inv_Month, year=Inv_Year) -> DateTime 1840 1841 Returns the copy of this object to which SetToLastMonthDay() was 1842 applied. 1843 """ 1844 1845 def GetLastWeekDay(self, weekday, month=Inv_Month, year=Inv_Year): 1846 """ 1847 GetLastWeekDay(weekday, month=Inv_Month, year=Inv_Year) -> DateTime 1848 1849 Returns the copy of this object to which SetToLastWeekDay() was 1850 applied. 1851 """ 1852 1853 def GetNextWeekDay(self, weekday): 1854 """ 1855 GetNextWeekDay(weekday) -> DateTime 1856 1857 Returns the copy of this object to which SetToNextWeekDay() was 1858 applied. 1859 """ 1860 1861 def GetPrevWeekDay(self, weekday): 1862 """ 1863 GetPrevWeekDay(weekday) -> DateTime 1864 1865 Returns the copy of this object to which SetToPrevWeekDay() was 1866 applied. 1867 """ 1868 1869 def GetWeekDayInSameWeek(self, weekday, flags=Monday_First): 1870 """ 1871 GetWeekDayInSameWeek(weekday, flags=Monday_First) -> DateTime 1872 1873 Returns the copy of this object to which SetToWeekDayInSameWeek() was 1874 applied. 1875 """ 1876 1877 def GetYearDay(self, yday): 1878 """ 1879 GetYearDay(yday) -> DateTime 1880 1881 Returns the copy of this object to which SetToYearDay() was applied. 1882 """ 1883 1884 def SetToLastMonthDay(self, month=Inv_Month, year=Inv_Year): 1885 """ 1886 SetToLastMonthDay(month=Inv_Month, year=Inv_Year) -> DateTime 1887 1888 Sets the date to the last day in the specified month (the current one 1889 by default). 1890 """ 1891 1892 def SetToLastWeekDay(self, weekday, month=Inv_Month, year=Inv_Year): 1893 """ 1894 SetToLastWeekDay(weekday, month=Inv_Month, year=Inv_Year) -> bool 1895 1896 The effect of calling this function is the same as of calling 1897 SetToWeekDay(-1, weekday, month, year). 1898 """ 1899 1900 def SetToNextWeekDay(self, weekday): 1901 """ 1902 SetToNextWeekDay(weekday) -> DateTime 1903 1904 Sets the date so that it will be the first weekday following the 1905 current date. 1906 """ 1907 1908 def SetToPrevWeekDay(self, weekday): 1909 """ 1910 SetToPrevWeekDay(weekday) -> DateTime 1911 1912 Sets the date so that it will be the last weekday before the current 1913 date. 1914 """ 1915 1916 def SetToWeekDay(self, weekday, n=1, month=Inv_Month, year=Inv_Year): 1917 """ 1918 SetToWeekDay(weekday, n=1, month=Inv_Month, year=Inv_Year) -> bool 1919 1920 Sets the date to the n-th weekday in the given month of the given year 1921 (the current month and year are used by default). 1922 """ 1923 1924 def SetToWeekDayInSameWeek(self, weekday, flags=Monday_First): 1925 """ 1926 SetToWeekDayInSameWeek(weekday, flags=Monday_First) -> DateTime 1927 1928 Adjusts the date so that it will still lie in the same week as before, 1929 but its week day will be the given one. 1930 """ 1931 1932 def SetToYearDay(self, yday): 1933 """ 1934 SetToYearDay(yday) -> DateTime 1935 1936 Sets the date to the day number yday in the same year (i.e. unlike the 1937 other functions, this one does not use the current year). 1938 """ 1939 1940 def GetJDN(self): 1941 """ 1942 GetJDN() -> double 1943 1944 Synonym for GetJulianDayNumber(). 1945 """ 1946 1947 def GetJulianDayNumber(self): 1948 """ 1949 GetJulianDayNumber() -> double 1950 1951 Returns the JDN corresponding to this date. 1952 """ 1953 1954 def GetMJD(self): 1955 """ 1956 GetMJD() -> double 1957 1958 Synonym for GetModifiedJulianDayNumber(). 1959 """ 1960 1961 def GetModifiedJulianDayNumber(self): 1962 """ 1963 GetModifiedJulianDayNumber() -> double 1964 1965 Returns the "Modified Julian Day Number" (MJD) which is, by 1966 definition, is equal to JDN - 2400000.5. 1967 """ 1968 1969 def GetRataDie(self): 1970 """ 1971 GetRataDie() -> double 1972 1973 Return the Rata Die number of this date. 1974 """ 1975 1976 def FromTimezone(self, tz, noDST=False): 1977 """ 1978 FromTimezone(tz, noDST=False) -> DateTime 1979 1980 Transform the date from the given time zone to the local one. 1981 """ 1982 1983 def IsDST(self, country=Country_Default): 1984 """ 1985 IsDST(country=Country_Default) -> int 1986 1987 Returns true if the DST is applied for this date in the given country. 1988 """ 1989 1990 def MakeFromTimezone(self, tz, noDST=False): 1991 """ 1992 MakeFromTimezone(tz, noDST=False) -> DateTime 1993 1994 Same as FromTimezone() but modifies the object in place. 1995 """ 1996 1997 def MakeTimezone(self, tz, noDST=False): 1998 """ 1999 MakeTimezone(tz, noDST=False) -> DateTime 2000 2001 Modifies the object in place to represent the date in another time 2002 zone. 2003 """ 2004 2005 def MakeUTC(self, noDST=False): 2006 """ 2007 MakeUTC(noDST=False) -> DateTime 2008 2009 This is the same as calling MakeTimezone() with the argument GMT0. 2010 """ 2011 2012 def ToTimezone(self, tz, noDST=False): 2013 """ 2014 ToTimezone(tz, noDST=False) -> DateTime 2015 2016 Transform the date to the given time zone. 2017 """ 2018 2019 def ToUTC(self, noDST=False): 2020 """ 2021 ToUTC(noDST=False) -> DateTime 2022 2023 This is the same as calling ToTimezone() with the argument GMT0. 2024 """ 2025 2026 @staticmethod 2027 def ConvertYearToBC(year): 2028 """ 2029 ConvertYearToBC(year) -> int 2030 2031 Converts the year in absolute notation (i.e. a number which can be 2032 negative, positive or zero) to the year in BC/AD notation. 2033 """ 2034 2035 @staticmethod 2036 def GetAmPmStrings(): 2037 """ 2038 GetAmPmStrings() -> (am, pm) 2039 2040 Returns the translations of the strings AM and PM used for time 2041 formatting for the current locale. 2042 """ 2043 2044 @staticmethod 2045 def GetBeginDST(year=Inv_Year, country=Country_Default): 2046 """ 2047 GetBeginDST(year=Inv_Year, country=Country_Default) -> DateTime 2048 2049 Get the beginning of DST for the given country in the given year 2050 (current one by default). 2051 """ 2052 2053 @staticmethod 2054 def GetEndDST(year=Inv_Year, country=Country_Default): 2055 """ 2056 GetEndDST(year=Inv_Year, country=Country_Default) -> DateTime 2057 2058 Returns the end of DST for the given country in the given year 2059 (current one by default). 2060 """ 2061 2062 @staticmethod 2063 def GetCountry(): 2064 """ 2065 GetCountry() -> Country 2066 2067 Returns the current default country. 2068 """ 2069 2070 @staticmethod 2071 def GetCurrentMonth(cal=Gregorian): 2072 """ 2073 GetCurrentMonth(cal=Gregorian) -> DateTime.Month 2074 2075 Get the current month in given calendar (only Gregorian is currently 2076 supported). 2077 """ 2078 2079 @staticmethod 2080 def GetCurrentYear(cal=Gregorian): 2081 """ 2082 GetCurrentYear(cal=Gregorian) -> int 2083 2084 Get the current year in given calendar (only Gregorian is currently 2085 supported). 2086 """ 2087 2088 @staticmethod 2089 def GetEnglishMonthName(month, flags=Name_Full): 2090 """ 2091 GetEnglishMonthName(month, flags=Name_Full) -> String 2092 2093 Return the standard English name of the given month. 2094 """ 2095 2096 @staticmethod 2097 def GetEnglishWeekDayName(weekday, flags=Name_Full): 2098 """ 2099 GetEnglishWeekDayName(weekday, flags=Name_Full) -> String 2100 2101 Return the standard English name of the given week day. 2102 """ 2103 2104 @staticmethod 2105 def GetMonthName(month, flags=Name_Full): 2106 """ 2107 GetMonthName(month, flags=Name_Full) -> String 2108 2109 Gets the full (default) or abbreviated name of the given month. 2110 """ 2111 2112 @staticmethod 2113 def GetNumberOfDays(month, year=Inv_Year, cal=Gregorian): 2114 """ 2115 GetNumberOfDays(month, year=Inv_Year, cal=Gregorian) -> unsignedshort 2116 2117 Returns the number of days in the given month of the given year. 2118 """ 2119 2120 @staticmethod 2121 def GetTimeNow(): 2122 """ 2123 GetTimeNow() -> time_t 2124 2125 Returns the current time. 2126 """ 2127 2128 @staticmethod 2129 def GetWeekDayName(weekday, flags=Name_Full): 2130 """ 2131 GetWeekDayName(weekday, flags=Name_Full) -> String 2132 2133 Gets the full (default) or abbreviated name of the given week day. 2134 """ 2135 2136 @staticmethod 2137 def IsDSTApplicable(year=Inv_Year, country=Country_Default): 2138 """ 2139 IsDSTApplicable(year=Inv_Year, country=Country_Default) -> bool 2140 2141 Returns true if DST was used in the given year (the current one by 2142 default) in the given country. 2143 """ 2144 2145 @staticmethod 2146 def IsLeapYear(year=Inv_Year, cal=Gregorian): 2147 """ 2148 IsLeapYear(year=Inv_Year, cal=Gregorian) -> bool 2149 2150 Returns true if the year is a leap one in the specified calendar. 2151 """ 2152 2153 @staticmethod 2154 def IsWestEuropeanCountry(country=Country_Default): 2155 """ 2156 IsWestEuropeanCountry(country=Country_Default) -> bool 2157 2158 This function returns true if the specified (or default) country is 2159 one of Western European ones. 2160 """ 2161 2162 @staticmethod 2163 def Now(): 2164 """ 2165 Now() -> DateTime 2166 2167 Returns the object corresponding to the current time. 2168 """ 2169 2170 @staticmethod 2171 def SetCountry(country): 2172 """ 2173 SetCountry(country) 2174 2175 Sets the country to use by default. 2176 """ 2177 2178 @staticmethod 2179 def SetToWeekOfYear(year, numWeek, weekday=Mon): 2180 """ 2181 SetToWeekOfYear(year, numWeek, weekday=Mon) -> DateTime 2182 2183 Set the date to the given weekday in the week number numWeek of the 2184 given year . 2185 """ 2186 2187 @staticmethod 2188 def Today(): 2189 """ 2190 Today() -> DateTime 2191 2192 Returns the object corresponding to the midnight of the current day 2193 (i.e. the same as Now(), but the time part is set to 0). 2194 """ 2195 2196 @staticmethod 2197 def UNow(): 2198 """ 2199 UNow() -> DateTime 2200 2201 Returns the object corresponding to the current UTC time including the 2202 milliseconds. 2203 """ 2204 2205 @staticmethod 2206 def FromTimeT(timet): 2207 """ 2208 FromTimeT(timet) -> DateTime 2209 2210 Construct a :class:`DateTime` from a C ``time_t`` value, the number of 2211 seconds since the epoch. 2212 """ 2213 2214 @staticmethod 2215 def FromJDN(jdn): 2216 """ 2217 FromJDN(jdn) -> DateTime 2218 2219 Construct a :class:`DateTime` from a Julian Day Number. 2220 2221 By definition, the Julian Day Number, usually abbreviated as JDN, of a 2222 particular instant is the fractional number of days since 12 hours 2223 Universal Coordinated Time (Greenwich mean noon) on January 1 of the 2224 year -4712 in the Julian proleptic calendar. 2225 """ 2226 2227 @staticmethod 2228 def FromHMS(hour, minute=0, second=0, millisecond=0): 2229 """ 2230 FromHMS(hour, minute=0, second=0, millisecond=0) -> DateTime 2231 2232 Construct a :class:`DateTime` equal to :meth:`Today` () with the time 2233 set to the supplied parameters. 2234 """ 2235 2236 @staticmethod 2237 def FromDMY(day, month, year=Inv_Year, hour=0, minute=0, second=0, millisecond=0): 2238 """ 2239 FromDMY(day, month, year=Inv_Year, hour=0, minute=0, second=0, millisecond=0) -> DateTime 2240 2241 Construct a :class:`DateTime` using the supplied parameters. 2242 """ 2243 2244 def __repr__(self): 2245 """ 2246 2247 """ 2248 2249 def __str__(self): 2250 """ 2251 2252 """ 2253 day = property(None, None) 2254 month = property(None, None) 2255 year = property(None, None) 2256 hour = property(None, None) 2257 minute = property(None, None) 2258 second = property(None, None) 2259 millisecond = property(None, None) 2260 JDN = property(None, None) 2261 DayOfYear = property(None, None) 2262 JulianDayNumber = property(None, None) 2263 LastMonthDay = property(None, None) 2264 MJD = property(None, None) 2265 ModifiedJulianDayNumber = property(None, None) 2266 RataDie = property(None, None) 2267 Ticks = property(None, None) 2268 WeekOfMonth = property(None, None) 2269 WeekOfYear = property(None, None) 2270# end of class DateTime 2271 2272 2273class DateSpan(object): 2274 """ 2275 DateSpan(years=0, months=0, weeks=0, days=0) 2276 2277 This class is a "logical time span" and is useful for implementing 2278 program logic for such things as "add one month to the date" which, in 2279 general, doesn't mean to add 60*60*24*31 seconds to it, but to take 2280 the same date the next month (to understand that this is indeed 2281 different consider adding one month to Feb, 15 we want to get Mar, 2282 15, of course). 2283 """ 2284 2285 def __init__(self, years=0, months=0, weeks=0, days=0): 2286 """ 2287 DateSpan(years=0, months=0, weeks=0, days=0) 2288 2289 This class is a "logical time span" and is useful for implementing 2290 program logic for such things as "add one month to the date" which, in 2291 general, doesn't mean to add 60*60*24*31 seconds to it, but to take 2292 the same date the next month (to understand that this is indeed 2293 different consider adding one month to Feb, 15 we want to get Mar, 2294 15, of course). 2295 """ 2296 2297 def Add(self, other): 2298 """ 2299 Add(other) -> DateSpan 2300 2301 Adds the given wxDateSpan to this wxDateSpan and returns a reference 2302 to itself. 2303 """ 2304 2305 def GetDays(self): 2306 """ 2307 GetDays() -> int 2308 2309 Returns the number of days (not counting the weeks component) in this 2310 date span. 2311 """ 2312 2313 def GetMonths(self): 2314 """ 2315 GetMonths() -> int 2316 2317 Returns the number of the months (not counting the years) in this date 2318 span. 2319 """ 2320 2321 def GetTotalMonths(self): 2322 """ 2323 GetTotalMonths() -> int 2324 2325 Returns the combined number of months in this date span, counting both 2326 years and months. 2327 """ 2328 2329 def GetTotalDays(self): 2330 """ 2331 GetTotalDays() -> int 2332 2333 Returns the combined number of days in this date span, counting both 2334 weeks and days. 2335 """ 2336 2337 def GetWeeks(self): 2338 """ 2339 GetWeeks() -> int 2340 2341 Returns the number of weeks in this date span. 2342 """ 2343 2344 def GetYears(self): 2345 """ 2346 GetYears() -> int 2347 2348 Returns the number of years in this date span. 2349 """ 2350 2351 def Multiply(self, factor): 2352 """ 2353 Multiply(factor) -> DateSpan 2354 2355 Multiplies this date span by the specified factor. 2356 """ 2357 2358 def Neg(self): 2359 """ 2360 Neg() -> DateSpan 2361 2362 Changes the sign of this date span. 2363 """ 2364 2365 def Negate(self): 2366 """ 2367 Negate() -> DateSpan 2368 2369 Returns a date span with the opposite sign. 2370 """ 2371 2372 def SetDays(self, n): 2373 """ 2374 SetDays(n) -> DateSpan 2375 2376 Sets the number of days (without modifying any other components) in 2377 this date span. 2378 """ 2379 2380 def SetMonths(self, n): 2381 """ 2382 SetMonths(n) -> DateSpan 2383 2384 Sets the number of months (without modifying any other components) in 2385 this date span. 2386 """ 2387 2388 def SetWeeks(self, n): 2389 """ 2390 SetWeeks(n) -> DateSpan 2391 2392 Sets the number of weeks (without modifying any other components) in 2393 this date span. 2394 """ 2395 2396 def SetYears(self, n): 2397 """ 2398 SetYears(n) -> DateSpan 2399 2400 Sets the number of years (without modifying any other components) in 2401 this date span. 2402 """ 2403 2404 def Subtract(self, other): 2405 """ 2406 Subtract(other) -> DateSpan 2407 2408 Subtracts the given wxDateSpan to this wxDateSpan and returns a 2409 reference to itself. 2410 """ 2411 2412 @staticmethod 2413 def Day(): 2414 """ 2415 Day() -> DateSpan 2416 2417 Returns a date span object corresponding to one day. 2418 """ 2419 2420 @staticmethod 2421 def Days(days): 2422 """ 2423 Days(days) -> DateSpan 2424 2425 Returns a date span object corresponding to the given number of days. 2426 """ 2427 2428 @staticmethod 2429 def Month(): 2430 """ 2431 Month() -> DateSpan 2432 2433 Returns a date span object corresponding to one month. 2434 """ 2435 2436 @staticmethod 2437 def Months(mon): 2438 """ 2439 Months(mon) -> DateSpan 2440 2441 Returns a date span object corresponding to the given number of 2442 months. 2443 """ 2444 2445 @staticmethod 2446 def Week(): 2447 """ 2448 Week() -> DateSpan 2449 2450 Returns a date span object corresponding to one week. 2451 """ 2452 2453 @staticmethod 2454 def Weeks(weeks): 2455 """ 2456 Weeks(weeks) -> DateSpan 2457 2458 Returns a date span object corresponding to the given number of weeks. 2459 """ 2460 2461 @staticmethod 2462 def Year(): 2463 """ 2464 Year() -> DateSpan 2465 2466 Returns a date span object corresponding to one year. 2467 """ 2468 2469 @staticmethod 2470 def Years(years): 2471 """ 2472 Years(years) -> DateSpan 2473 2474 Returns a date span object corresponding to the given number of years. 2475 """ 2476# end of class DateSpan 2477 2478 2479class TimeSpan(object): 2480 """ 2481 TimeSpan() 2482 TimeSpan(hours, min=0, sec=0, msec=0) 2483 2484 wxTimeSpan class represents a time interval. 2485 """ 2486 2487 def __init__(self, *args, **kw): 2488 """ 2489 TimeSpan() 2490 TimeSpan(hours, min=0, sec=0, msec=0) 2491 2492 wxTimeSpan class represents a time interval. 2493 """ 2494 2495 def Abs(self): 2496 """ 2497 Abs() -> TimeSpan 2498 2499 Returns the absolute value of the timespan: does not modify the 2500 object. 2501 """ 2502 2503 def Add(self, diff): 2504 """ 2505 Add(diff) -> TimeSpan 2506 2507 Adds the given wxTimeSpan to this wxTimeSpan and returns a reference 2508 to itself. 2509 """ 2510 2511 def Format(self, format=DefaultTimeSpanFormat): 2512 """ 2513 Format(format=DefaultTimeSpanFormat) -> String 2514 2515 Returns the string containing the formatted representation of the time 2516 span. 2517 """ 2518 2519 def GetDays(self): 2520 """ 2521 GetDays() -> int 2522 2523 Returns the difference in number of days. 2524 """ 2525 2526 def GetHours(self): 2527 """ 2528 GetHours() -> int 2529 2530 Returns the difference in number of hours. 2531 """ 2532 2533 def GetMilliseconds(self): 2534 """ 2535 GetMilliseconds() -> LongLong 2536 2537 Returns the difference in number of milliseconds. 2538 """ 2539 2540 def GetMinutes(self): 2541 """ 2542 GetMinutes() -> int 2543 2544 Returns the difference in number of minutes. 2545 """ 2546 2547 def GetSeconds(self): 2548 """ 2549 GetSeconds() -> LongLong 2550 2551 Returns the difference in number of seconds. 2552 """ 2553 2554 def GetValue(self): 2555 """ 2556 GetValue() -> LongLong 2557 2558 Returns the internal representation of timespan. 2559 """ 2560 2561 def GetWeeks(self): 2562 """ 2563 GetWeeks() -> int 2564 2565 Returns the difference in number of weeks. 2566 """ 2567 2568 def IsEqualTo(self, ts): 2569 """ 2570 IsEqualTo(ts) -> bool 2571 2572 Returns true if two timespans are equal. 2573 """ 2574 2575 def IsLongerThan(self, ts): 2576 """ 2577 IsLongerThan(ts) -> bool 2578 2579 Compares two timespans: works with the absolute values, i.e. -2 hours 2580 is longer than 1 hour. 2581 """ 2582 2583 def IsNegative(self): 2584 """ 2585 IsNegative() -> bool 2586 2587 Returns true if the timespan is negative. 2588 """ 2589 2590 def IsNull(self): 2591 """ 2592 IsNull() -> bool 2593 2594 Returns true if the timespan is empty. 2595 """ 2596 2597 def IsPositive(self): 2598 """ 2599 IsPositive() -> bool 2600 2601 Returns true if the timespan is positive. 2602 """ 2603 2604 def IsShorterThan(self, ts): 2605 """ 2606 IsShorterThan(ts) -> bool 2607 2608 Compares two timespans: works with the absolute values, i.e. 1 hour is 2609 shorter than -2 hours. 2610 """ 2611 2612 def Multiply(self, n): 2613 """ 2614 Multiply(n) -> TimeSpan 2615 2616 Multiplies this time span by n. 2617 """ 2618 2619 def Neg(self): 2620 """ 2621 Neg() -> TimeSpan 2622 2623 Negate the value of the timespan. 2624 """ 2625 2626 def Negate(self): 2627 """ 2628 Negate() -> TimeSpan 2629 2630 Returns timespan with inverted sign. 2631 """ 2632 2633 def Subtract(self, diff): 2634 """ 2635 Subtract(diff) -> TimeSpan 2636 2637 Subtracts the given wxTimeSpan to this wxTimeSpan and returns a 2638 reference to itself. 2639 """ 2640 2641 @staticmethod 2642 def Day(): 2643 """ 2644 Day() -> TimeSpan 2645 2646 Returns the timespan for one day. 2647 """ 2648 2649 @staticmethod 2650 def Days(days): 2651 """ 2652 Days(days) -> TimeSpan 2653 2654 Returns the timespan for the given number of days. 2655 """ 2656 2657 @staticmethod 2658 def Hour(): 2659 """ 2660 Hour() -> TimeSpan 2661 2662 Returns the timespan for one hour. 2663 """ 2664 2665 @staticmethod 2666 def Hours(hours): 2667 """ 2668 Hours(hours) -> TimeSpan 2669 2670 Returns the timespan for the given number of hours. 2671 """ 2672 2673 @staticmethod 2674 def Millisecond(): 2675 """ 2676 Millisecond() -> TimeSpan 2677 2678 Returns the timespan for one millisecond. 2679 """ 2680 2681 @staticmethod 2682 def Milliseconds(ms): 2683 """ 2684 Milliseconds(ms) -> TimeSpan 2685 2686 Returns the timespan for the given number of milliseconds. 2687 """ 2688 2689 @staticmethod 2690 def Minute(): 2691 """ 2692 Minute() -> TimeSpan 2693 2694 Returns the timespan for one minute. 2695 """ 2696 2697 @staticmethod 2698 def Minutes(min): 2699 """ 2700 Minutes(min) -> TimeSpan 2701 2702 Returns the timespan for the given number of minutes. 2703 """ 2704 2705 @staticmethod 2706 def Second(): 2707 """ 2708 Second() -> TimeSpan 2709 2710 Returns the timespan for one second. 2711 """ 2712 2713 @staticmethod 2714 def Seconds(sec): 2715 """ 2716 Seconds(sec) -> TimeSpan 2717 2718 Returns the timespan for the given number of seconds. 2719 """ 2720 2721 @staticmethod 2722 def Week(): 2723 """ 2724 Week() -> TimeSpan 2725 2726 Returns the timespan for one week. 2727 """ 2728 2729 @staticmethod 2730 def Weeks(weeks): 2731 """ 2732 Weeks(weeks) -> TimeSpan 2733 2734 Returns the timespan for the given number of weeks. 2735 """ 2736# end of class TimeSpan 2737 2738DefaultDateTime = DateTime() 2739 2740InvalidDateTime = DefaultDateTime 2741 2742@wx.deprecated 2743def DateTimeFromTimeT(timet): 2744 """ 2745 Compatibility wrapper for :meth:`DateTime.FromTimeT` 2746 """ 2747 pass 2748 2749@wx.deprecated 2750def DateTimeFromJDN(jdn): 2751 """ 2752 Compatibility wrapper for :meth:`DateTime.FromJDN` 2753 """ 2754 pass 2755 2756@wx.deprecated 2757def DateTimeFromHMS(hour, minute=0, second=0, millisecond=0): 2758 """ 2759 Compatibility wrapper for :meth:`DateTime.FromHMS` 2760 """ 2761 pass 2762 2763@wx.deprecated 2764def DateTimeFromDMY(day, month, year=DateTime.Inv_Year, hour=0, minute=0, second=0, millisecond=0): 2765 """ 2766 Compatibility wrapper for :meth:`DateTime.FromDMY` 2767 """ 2768 pass 2769 2770def pydate2wxdate(date): 2771 """ 2772 Convert a Python date or datetime to a :class:`DateTime` object 2773 """ 2774 pass 2775 2776def wxdate2pydate(date): 2777 """ 2778 Convert a :class:`DateTime` object to a Python datetime. 2779 """ 2780 pass 2781#-- end-wxdatetime --# 2782#-- begin-stopwatch --# 2783 2784class StopWatch(object): 2785 """ 2786 StopWatch() 2787 2788 The wxStopWatch class allow you to measure time intervals. 2789 """ 2790 2791 def __init__(self): 2792 """ 2793 StopWatch() 2794 2795 The wxStopWatch class allow you to measure time intervals. 2796 """ 2797 2798 def Pause(self): 2799 """ 2800 Pause() 2801 2802 Pauses the stop watch. 2803 """ 2804 2805 def Resume(self): 2806 """ 2807 Resume() 2808 2809 Resumes the stop watch which had been paused with Pause(). 2810 """ 2811 2812 def Start(self, milliseconds=0): 2813 """ 2814 Start(milliseconds=0) 2815 2816 (Re)starts the stop watch with a given initial value. 2817 """ 2818 2819 def Time(self): 2820 """ 2821 Time() -> long 2822 2823 Returns the time in milliseconds since the start (or restart) or the 2824 last call of Pause(). 2825 """ 2826 2827 def TimeInMicro(self): 2828 """ 2829 TimeInMicro() -> LongLong 2830 2831 Returns elapsed time in microseconds. 2832 """ 2833# end of class StopWatch 2834 2835#-- end-stopwatch --# 2836#-- begin-windowid --# 2837 2838class IdManager(object): 2839 """ 2840 wxIdManager is responsible for allocating and releasing window IDs. 2841 """ 2842 2843 @staticmethod 2844 def ReserveId(count=1): 2845 """ 2846 ReserveId(count=1) -> WindowID 2847 2848 Called directly by wxWindow::NewControlId(), this function will create 2849 a new ID or range of IDs. 2850 """ 2851 2852 @staticmethod 2853 def UnreserveId(id, count=1): 2854 """ 2855 UnreserveId(id, count=1) 2856 2857 Called directly by wxWindow::UnreserveControlId(), this function will 2858 unreserve an ID or range of IDs that is currently reserved. 2859 """ 2860# end of class IdManager 2861 2862 2863class WindowIDRef(object): 2864 """ 2865 WindowIDRef() 2866 WindowIDRef(id) 2867 WindowIDRef(idref) 2868 2869 A wxWindowIDRef object wraps an ID value and marks it as being in-use 2870 until all references to that ID are gone. 2871 """ 2872 2873 def __init__(self, *args, **kw): 2874 """ 2875 WindowIDRef() 2876 WindowIDRef(id) 2877 WindowIDRef(idref) 2878 2879 A wxWindowIDRef object wraps an ID value and marks it as being in-use 2880 until all references to that ID are gone. 2881 """ 2882 2883 def GetValue(self): 2884 """ 2885 GetValue() -> int 2886 2887 Get the ID value 2888 """ 2889 2890 def GetId(self): 2891 """ 2892 GetId() -> int 2893 2894 Alias for GetValue allowing the IDRef to be passed as the source 2895 parameter to :meth:`wx.EvtHandler.Bind`. 2896 """ 2897 2898 def __int__(self): 2899 """ 2900 __int__() -> int 2901 2902 Alias for GetValue allowing the IDRef to be passed as the WindowID 2903 parameter when creating widgets or etc. 2904 """ 2905 2906 def __eq__(self, id): 2907 """ 2908 __eq__(id) -> bool 2909 """ 2910 2911 def __ne__(self, id): 2912 """ 2913 __ne__(id) -> bool 2914 """ 2915 2916 def __lt__(self, id): 2917 """ 2918 __lt__(id) -> bool 2919 """ 2920 2921 def __gt__(self, id): 2922 """ 2923 __gt__(id) -> bool 2924 """ 2925 2926 def __le__(self, id): 2927 """ 2928 __le__(id) -> bool 2929 """ 2930 2931 def __ge__(self, id): 2932 """ 2933 __ge__(id) -> bool 2934 """ 2935 2936 def __repr__(self): 2937 """ 2938 2939 """ 2940 2941 def __hash__(self): 2942 """ 2943 2944 """ 2945 Id = property(None, None) 2946 Value = property(None, None) 2947# end of class WindowIDRef 2948 2949 2950def NewIdRef(count=1): 2951 """ 2952 Reserves a new Window ID (or range of WindowIDs) and returns a 2953 :class:`wx.WindowIDRef` object (or list of them) that will help 2954 manage the reservation of that ID. 2955 2956 This function is intended to be a drop-in replacement of the old 2957 and deprecated :func:`wx.NewId` function, with the added benefit 2958 that the ID should never conflict with an in-use ID or other IDs 2959 generated by this function. 2960 """ 2961 pass 2962#-- end-windowid --# 2963#-- begin-platinfo --# 2964OS_UNKNOWN = 0 2965OS_MAC_OS = 0 2966OS_MAC_OSX_DARWIN = 0 2967OS_MAC = 0 2968OS_WINDOWS_9X = 0 2969OS_WINDOWS_NT = 0 2970OS_WINDOWS_MICRO = 0 2971OS_WINDOWS_CE = 0 2972OS_WINDOWS = 0 2973OS_UNIX_LINUX = 0 2974OS_UNIX_FREEBSD = 0 2975OS_UNIX_OPENBSD = 0 2976OS_UNIX_NETBSD = 0 2977OS_UNIX_SOLARIS = 0 2978OS_UNIX_AIX = 0 2979OS_UNIX_HPUX = 0 2980OS_UNIX = 0 2981OS_DOS = 0 2982OS_OS2 = 0 2983PORT_UNKNOWN = 0 2984PORT_BASE = 0 2985PORT_MSW = 0 2986PORT_MOTIF = 0 2987PORT_GTK = 0 2988PORT_DFB = 0 2989PORT_X11 = 0 2990PORT_OS2 = 0 2991PORT_MAC = 0 2992PORT_COCOA = 0 2993PORT_WINCE = 0 2994ARCH_INVALID = 0 2995ARCH_32 = 0 2996ARCH_64 = 0 2997ARCH_MAX = 0 2998ENDIAN_INVALID = 0 2999ENDIAN_BIG = 0 3000ENDIAN_LITTLE = 0 3001ENDIAN_PDP = 0 3002ENDIAN_MAX = 0 3003 3004class PlatformInformation(object): 3005 """ 3006 PlatformInfo() 3007 PlatformInfo(pid, tkMajor=-1, tkMinor=-1, id=OS_UNKNOWN, osMajor=-1, osMinor=-1, arch=ARCH_INVALID, endian=ENDIAN_INVALID) 3008 3009 This class holds information about the operating system, the toolkit 3010 and the basic architecture of the machine where the application is 3011 currently running. 3012 """ 3013 3014 def __init__(self, *args, **kw): 3015 """ 3016 PlatformInfo() 3017 PlatformInfo(pid, tkMajor=-1, tkMinor=-1, id=OS_UNKNOWN, osMajor=-1, osMinor=-1, arch=ARCH_INVALID, endian=ENDIAN_INVALID) 3018 3019 This class holds information about the operating system, the toolkit 3020 and the basic architecture of the machine where the application is 3021 currently running. 3022 """ 3023 3024 @staticmethod 3025 def GetArch(arch): 3026 """ 3027 GetArch(arch) -> Architecture 3028 3029 Converts the given string to a wxArchitecture enum value or to 3030 wxARCH_INVALID if the given string is not a valid architecture string 3031 (i.e. 3032 """ 3033 3034 def GetEndianness(self): 3035 """ 3036 GetEndianness() -> Endianness 3037 3038 Returns the endianness ID of this wxPlatformInfo instance. 3039 """ 3040 3041 def GetOperatingSystemId(self): 3042 """ 3043 GetOperatingSystemId() -> OperatingSystemId 3044 3045 Returns the operating system ID of this wxPlatformInfo instance. 3046 """ 3047 3048 def GetPortId(self): 3049 """ 3050 GetPortId() -> PortId 3051 3052 Returns the wxWidgets port ID associated with this wxPlatformInfo 3053 instance. 3054 """ 3055 3056 def GetArchName(self): 3057 """ 3058 GetArchName() -> String 3059 3060 Returns the name for the architecture of this wxPlatformInfo instance. 3061 """ 3062 3063 def GetEndiannessName(self): 3064 """ 3065 GetEndiannessName() -> String 3066 3067 Returns the name for the endianness of this wxPlatformInfo instance. 3068 """ 3069 3070 def GetOperatingSystemFamilyName(self): 3071 """ 3072 GetOperatingSystemFamilyName() -> String 3073 3074 Returns the operating system family name of the OS associated with 3075 this wxPlatformInfo instance. 3076 """ 3077 3078 def GetOperatingSystemIdName(self): 3079 """ 3080 GetOperatingSystemIdName() -> String 3081 3082 Returns the operating system name of the OS associated with this 3083 wxPlatformInfo instance. 3084 """ 3085 3086 def GetPortIdName(self): 3087 """ 3088 GetPortIdName() -> String 3089 3090 Returns the name of the wxWidgets port ID associated with this 3091 wxPlatformInfo instance. 3092 """ 3093 3094 def GetPortIdShortName(self): 3095 """ 3096 GetPortIdShortName() -> String 3097 3098 Returns the short name of the wxWidgets port ID associated with this 3099 wxPlatformInfo instance. 3100 """ 3101 3102 @staticmethod 3103 def GetOperatingSystemDirectory(): 3104 """ 3105 GetOperatingSystemDirectory() -> String 3106 3107 Returns the operating system directory. 3108 """ 3109 3110 def GetArchitecture(self): 3111 """ 3112 GetArchitecture() -> Architecture 3113 3114 Returns the architecture ID of this wxPlatformInfo instance. 3115 """ 3116 3117 def GetOSMajorVersion(self): 3118 """ 3119 GetOSMajorVersion() -> int 3120 3121 Returns the run-time major version of the OS associated with this 3122 wxPlatformInfo instance. 3123 """ 3124 3125 def GetOSMinorVersion(self): 3126 """ 3127 GetOSMinorVersion() -> int 3128 3129 Returns the run-time minor version of the OS associated with this 3130 wxPlatformInfo instance. 3131 """ 3132 3133 def GetOperatingSystemDescription(self): 3134 """ 3135 GetOperatingSystemDescription() -> String 3136 3137 Returns the description of the operating system of this wxPlatformInfo 3138 instance. 3139 """ 3140 3141 def GetLinuxDistributionInfo(self): 3142 """ 3143 GetLinuxDistributionInfo() -> LinuxDistributionInfo 3144 3145 Returns the Linux distribution info associated with this 3146 wxPlatformInfo instance. 3147 """ 3148 3149 def GetDesktopEnvironment(self): 3150 """ 3151 GetDesktopEnvironment() -> String 3152 3153 Returns the desktop environment associated with this wxPlatformInfo 3154 instance. 3155 """ 3156 3157 def GetToolkitMajorVersion(self): 3158 """ 3159 GetToolkitMajorVersion() -> int 3160 3161 Returns the run-time major version of the toolkit associated with this 3162 wxPlatformInfo instance. 3163 """ 3164 3165 def GetToolkitMinorVersion(self): 3166 """ 3167 GetToolkitMinorVersion() -> int 3168 3169 Returns the run-time minor version of the toolkit associated with this 3170 wxPlatformInfo instance. 3171 """ 3172 3173 def SetArchitecture(self, n): 3174 """ 3175 SetArchitecture(n) 3176 3177 Sets the architecture enum value associated with this wxPlatformInfo 3178 instance. 3179 """ 3180 3181 def SetEndianness(self, n): 3182 """ 3183 SetEndianness(n) 3184 3185 Sets the endianness enum value associated with this wxPlatformInfo 3186 instance. 3187 """ 3188 3189 def SetOSVersion(self, major, minor): 3190 """ 3191 SetOSVersion(major, minor) 3192 3193 Sets the version of the operating system associated with this 3194 wxPlatformInfo instance. 3195 """ 3196 3197 def SetOperatingSystemId(self, n): 3198 """ 3199 SetOperatingSystemId(n) 3200 3201 Sets the operating system associated with this wxPlatformInfo 3202 instance. 3203 """ 3204 3205 def SetPortId(self, n): 3206 """ 3207 SetPortId(n) 3208 3209 Sets the wxWidgets port ID associated with this wxPlatformInfo 3210 instance. 3211 """ 3212 3213 def SetToolkitVersion(self, major, minor): 3214 """ 3215 SetToolkitVersion(major, minor) 3216 3217 Sets the version of the toolkit associated with this wxPlatformInfo 3218 instance. 3219 """ 3220 3221 def SetOperatingSystemDescription(self, desc): 3222 """ 3223 SetOperatingSystemDescription(desc) 3224 3225 Sets the operating system description associated with this 3226 wxPlatformInfo instance. 3227 """ 3228 3229 def SetDesktopEnvironment(self, de): 3230 """ 3231 SetDesktopEnvironment(de) 3232 3233 Sets the desktop environment associated with this wxPlatformInfo 3234 instance. 3235 """ 3236 3237 def SetLinuxDistributionInfo(self, di): 3238 """ 3239 SetLinuxDistributionInfo(di) 3240 3241 Sets the linux distribution info associated with this wxPlatformInfo 3242 instance. 3243 """ 3244 3245 def CheckOSVersion(self, major, minor): 3246 """ 3247 CheckOSVersion(major, minor) -> bool 3248 3249 Returns true if the OS version is at least major.minor. 3250 """ 3251 3252 def CheckToolkitVersion(self, major, minor): 3253 """ 3254 CheckToolkitVersion(major, minor) -> bool 3255 3256 Returns true if the toolkit version is at least major.minor. 3257 """ 3258 3259 def IsOk(self): 3260 """ 3261 IsOk() -> bool 3262 3263 Returns true if this instance is fully initialized with valid values. 3264 """ 3265 3266 def IsUsingUniversalWidgets(self): 3267 """ 3268 IsUsingUniversalWidgets() -> bool 3269 3270 Returns true if this wxPlatformInfo describes wxUniversal build. 3271 """ 3272 3273 def __ne__(self): 3274 """ 3275 """ 3276 3277 def __eq__(self): 3278 """ 3279 """ 3280 3281 @staticmethod 3282 def Get(): 3283 """ 3284 Get() -> PlatformInfo 3285 3286 Returns the global wxPlatformInfo object, initialized with the values 3287 for the currently running platform. 3288 """ 3289 ArchName = property(None, None) 3290 Architecture = property(None, None) 3291 DesktopEnvironment = property(None, None) 3292 Endianness = property(None, None) 3293 EndiannessName = property(None, None) 3294 LinuxDistributionInfo = property(None, None) 3295 OSMajorVersion = property(None, None) 3296 OSMinorVersion = property(None, None) 3297 OperatingSystemDescription = property(None, None) 3298 OperatingSystemFamilyName = property(None, None) 3299 OperatingSystemId = property(None, None) 3300 OperatingSystemIdName = property(None, None) 3301 PortId = property(None, None) 3302 PortIdName = property(None, None) 3303 PortIdShortName = property(None, None) 3304 ToolkitMajorVersion = property(None, None) 3305 ToolkitMinorVersion = property(None, None) 3306# end of class PlatformInformation 3307 3308 3309class LinuxDistributionInfo(object): 3310 """ 3311 A structure containing information about a Linux distribution as 3312 returned by the lsb_release utility. 3313 """ 3314 Id = property(None, None) 3315 Release = property(None, None) 3316 CodeName = property(None, None) 3317 Description = property(None, None) 3318 3319 def __eq__(self): 3320 """ 3321 """ 3322 3323 def __ne__(self): 3324 """ 3325 """ 3326# end of class LinuxDistributionInfo 3327 3328#-- end-platinfo --# 3329#-- begin-vidmode --# 3330 3331class VideoMode(object): 3332 """ 3333 VideoMode(width=0, height=0, depth=0, freq=0) 3334 3335 Determines the sizes and locations of displays connected to the 3336 system. 3337 """ 3338 3339 def __init__(self, width=0, height=0, depth=0, freq=0): 3340 """ 3341 VideoMode(width=0, height=0, depth=0, freq=0) 3342 3343 Determines the sizes and locations of displays connected to the 3344 system. 3345 """ 3346 w = property(None, None) 3347 h = property(None, None) 3348 bpp = property(None, None) 3349 refresh = property(None, None) 3350 3351 def Matches(self, other): 3352 """ 3353 Matches(other) -> bool 3354 3355 Returns true if this mode matches the other one in the sense that all 3356 non zero fields of the other mode have the same value in this one 3357 (except for refresh which is allowed to have a greater value). 3358 """ 3359 3360 def GetWidth(self): 3361 """ 3362 GetWidth() -> int 3363 3364 Returns the screen width in pixels (e.g. 640), 0 means unspecified. 3365 """ 3366 3367 def GetHeight(self): 3368 """ 3369 GetHeight() -> int 3370 3371 Returns the screen height in pixels (e.g. 480), 0 means unspecified. 3372 """ 3373 3374 def GetDepth(self): 3375 """ 3376 GetDepth() -> int 3377 3378 Returns bits per pixel (e.g. 32), 1 is monochrome and 0 means 3379 unspecified/known. 3380 """ 3381 3382 def IsOk(self): 3383 """ 3384 IsOk() -> bool 3385 3386 Returns true if the object has been initialized. 3387 """ 3388 3389 def __eq__(self): 3390 """ 3391 """ 3392 3393 def __ne__(self): 3394 """ 3395 """ 3396 3397 def __nonzero__(self): 3398 """ 3399 __nonzero__() -> int 3400 """ 3401 3402 def __bool__(self): 3403 """ 3404 __bool__() -> int 3405 """ 3406 Depth = property(None, None) 3407 Height = property(None, None) 3408 Width = property(None, None) 3409# end of class VideoMode 3410 3411DefaultVideoMode = VideoMode() 3412#-- end-vidmode --# 3413#-- begin-display --# 3414 3415class Display(object): 3416 """ 3417 Display(index=0) 3418 3419 Determines the sizes and locations of displays connected to the 3420 system. 3421 """ 3422 3423 def __init__(self, index=0): 3424 """ 3425 Display(index=0) 3426 3427 Determines the sizes and locations of displays connected to the 3428 system. 3429 """ 3430 3431 def ChangeMode(self, mode=DefaultVideoMode): 3432 """ 3433 ChangeMode(mode=DefaultVideoMode) -> bool 3434 3435 Changes the video mode of this display to the mode specified in the 3436 mode parameter. 3437 """ 3438 3439 def GetClientArea(self): 3440 """ 3441 GetClientArea() -> Rect 3442 3443 Returns the client area of the display. 3444 """ 3445 3446 def GetCurrentMode(self): 3447 """ 3448 GetCurrentMode() -> VideoMode 3449 3450 Returns the current video mode that this display is in. 3451 """ 3452 3453 def GetGeometry(self): 3454 """ 3455 GetGeometry() -> Rect 3456 3457 Returns the bounding rectangle of the display whose index was passed 3458 to the constructor. 3459 """ 3460 3461 def GetModes(self, mode=DefaultVideoMode): 3462 """ 3463 GetModes(mode=DefaultVideoMode) -> ArrayVideoModes 3464 3465 Fills and returns an array with all the video modes that are supported 3466 by this display, or video modes that are supported by this display and 3467 match the mode parameter (if mode is not wxDefaultVideoMode). 3468 """ 3469 3470 def GetName(self): 3471 """ 3472 GetName() -> String 3473 3474 Returns the display's name. 3475 """ 3476 3477 def IsPrimary(self): 3478 """ 3479 IsPrimary() -> bool 3480 3481 Returns true if the display is the primary display. 3482 """ 3483 3484 @staticmethod 3485 def GetCount(): 3486 """ 3487 GetCount() -> unsignedint 3488 3489 Returns the number of connected displays. 3490 """ 3491 3492 @staticmethod 3493 def GetFromPoint(pt): 3494 """ 3495 GetFromPoint(pt) -> int 3496 3497 Returns the index of the display on which the given point lies, or 3498 wxNOT_FOUND if the point is not on any connected display. 3499 """ 3500 3501 @staticmethod 3502 def GetFromWindow(win): 3503 """ 3504 GetFromWindow(win) -> int 3505 3506 Returns the index of the display on which the given window lies. 3507 """ 3508 ClientArea = property(None, None) 3509 CurrentMode = property(None, None) 3510 Geometry = property(None, None) 3511 Name = property(None, None) 3512# end of class Display 3513 3514#-- end-display --# 3515#-- begin-intl --# 3516LANGUAGE_DEFAULT = 0 3517LANGUAGE_UNKNOWN = 0 3518LANGUAGE_ABKHAZIAN = 0 3519LANGUAGE_AFAR = 0 3520LANGUAGE_AFRIKAANS = 0 3521LANGUAGE_ALBANIAN = 0 3522LANGUAGE_AMHARIC = 0 3523LANGUAGE_ARABIC = 0 3524LANGUAGE_ARABIC_ALGERIA = 0 3525LANGUAGE_ARABIC_BAHRAIN = 0 3526LANGUAGE_ARABIC_EGYPT = 0 3527LANGUAGE_ARABIC_IRAQ = 0 3528LANGUAGE_ARABIC_JORDAN = 0 3529LANGUAGE_ARABIC_KUWAIT = 0 3530LANGUAGE_ARABIC_LEBANON = 0 3531LANGUAGE_ARABIC_LIBYA = 0 3532LANGUAGE_ARABIC_MOROCCO = 0 3533LANGUAGE_ARABIC_OMAN = 0 3534LANGUAGE_ARABIC_QATAR = 0 3535LANGUAGE_ARABIC_SAUDI_ARABIA = 0 3536LANGUAGE_ARABIC_SUDAN = 0 3537LANGUAGE_ARABIC_SYRIA = 0 3538LANGUAGE_ARABIC_TUNISIA = 0 3539LANGUAGE_ARABIC_UAE = 0 3540LANGUAGE_ARABIC_YEMEN = 0 3541LANGUAGE_ARMENIAN = 0 3542LANGUAGE_ASSAMESE = 0 3543LANGUAGE_ASTURIAN = 0 3544LANGUAGE_AYMARA = 0 3545LANGUAGE_AZERI = 0 3546LANGUAGE_AZERI_CYRILLIC = 0 3547LANGUAGE_AZERI_LATIN = 0 3548LANGUAGE_BASHKIR = 0 3549LANGUAGE_BASQUE = 0 3550LANGUAGE_BELARUSIAN = 0 3551LANGUAGE_BENGALI = 0 3552LANGUAGE_BHUTANI = 0 3553LANGUAGE_BIHARI = 0 3554LANGUAGE_BISLAMA = 0 3555LANGUAGE_BOSNIAN = 0 3556LANGUAGE_BRETON = 0 3557LANGUAGE_BULGARIAN = 0 3558LANGUAGE_BURMESE = 0 3559LANGUAGE_CAMBODIAN = 0 3560LANGUAGE_CATALAN = 0 3561LANGUAGE_CHINESE = 0 3562LANGUAGE_CHINESE_SIMPLIFIED = 0 3563LANGUAGE_CHINESE_TRADITIONAL = 0 3564LANGUAGE_CHINESE_HONGKONG = 0 3565LANGUAGE_CHINESE_MACAU = 0 3566LANGUAGE_CHINESE_SINGAPORE = 0 3567LANGUAGE_CHINESE_TAIWAN = 0 3568LANGUAGE_CORSICAN = 0 3569LANGUAGE_CROATIAN = 0 3570LANGUAGE_CZECH = 0 3571LANGUAGE_DANISH = 0 3572LANGUAGE_DUTCH = 0 3573LANGUAGE_DUTCH_BELGIAN = 0 3574LANGUAGE_ENGLISH = 0 3575LANGUAGE_ENGLISH_UK = 0 3576LANGUAGE_ENGLISH_US = 0 3577LANGUAGE_ENGLISH_AUSTRALIA = 0 3578LANGUAGE_ENGLISH_BELIZE = 0 3579LANGUAGE_ENGLISH_BOTSWANA = 0 3580LANGUAGE_ENGLISH_CANADA = 0 3581LANGUAGE_ENGLISH_CARIBBEAN = 0 3582LANGUAGE_ENGLISH_DENMARK = 0 3583LANGUAGE_ENGLISH_EIRE = 0 3584LANGUAGE_ENGLISH_JAMAICA = 0 3585LANGUAGE_ENGLISH_NEW_ZEALAND = 0 3586LANGUAGE_ENGLISH_PHILIPPINES = 0 3587LANGUAGE_ENGLISH_SOUTH_AFRICA = 0 3588LANGUAGE_ENGLISH_TRINIDAD = 0 3589LANGUAGE_ENGLISH_ZIMBABWE = 0 3590LANGUAGE_ESPERANTO = 0 3591LANGUAGE_ESTONIAN = 0 3592LANGUAGE_FAEROESE = 0 3593LANGUAGE_FARSI = 0 3594LANGUAGE_FIJI = 0 3595LANGUAGE_FINNISH = 0 3596LANGUAGE_FRENCH = 0 3597LANGUAGE_FRENCH_BELGIAN = 0 3598LANGUAGE_FRENCH_CANADIAN = 0 3599LANGUAGE_FRENCH_LUXEMBOURG = 0 3600LANGUAGE_FRENCH_MONACO = 0 3601LANGUAGE_FRENCH_SWISS = 0 3602LANGUAGE_FRISIAN = 0 3603LANGUAGE_GALICIAN = 0 3604LANGUAGE_GEORGIAN = 0 3605LANGUAGE_GERMAN = 0 3606LANGUAGE_GERMAN_AUSTRIAN = 0 3607LANGUAGE_GERMAN_BELGIUM = 0 3608LANGUAGE_GERMAN_LIECHTENSTEIN = 0 3609LANGUAGE_GERMAN_LUXEMBOURG = 0 3610LANGUAGE_GERMAN_SWISS = 0 3611LANGUAGE_GREEK = 0 3612LANGUAGE_GREENLANDIC = 0 3613LANGUAGE_GUARANI = 0 3614LANGUAGE_GUJARATI = 0 3615LANGUAGE_HAUSA = 0 3616LANGUAGE_HEBREW = 0 3617LANGUAGE_HINDI = 0 3618LANGUAGE_HUNGARIAN = 0 3619LANGUAGE_ICELANDIC = 0 3620LANGUAGE_INDONESIAN = 0 3621LANGUAGE_INTERLINGUA = 0 3622LANGUAGE_INTERLINGUE = 0 3623LANGUAGE_INUKTITUT = 0 3624LANGUAGE_INUPIAK = 0 3625LANGUAGE_IRISH = 0 3626LANGUAGE_ITALIAN = 0 3627LANGUAGE_ITALIAN_SWISS = 0 3628LANGUAGE_JAPANESE = 0 3629LANGUAGE_JAVANESE = 0 3630LANGUAGE_KANNADA = 0 3631LANGUAGE_KASHMIRI = 0 3632LANGUAGE_KASHMIRI_INDIA = 0 3633LANGUAGE_KAZAKH = 0 3634LANGUAGE_KERNEWEK = 0 3635LANGUAGE_KINYARWANDA = 0 3636LANGUAGE_KIRGHIZ = 0 3637LANGUAGE_KIRUNDI = 0 3638LANGUAGE_KONKANI = 0 3639LANGUAGE_KOREAN = 0 3640LANGUAGE_KURDISH = 0 3641LANGUAGE_LAOTHIAN = 0 3642LANGUAGE_LATIN = 0 3643LANGUAGE_LATVIAN = 0 3644LANGUAGE_LINGALA = 0 3645LANGUAGE_LITHUANIAN = 0 3646LANGUAGE_MACEDONIAN = 0 3647LANGUAGE_MALAGASY = 0 3648LANGUAGE_MALAY = 0 3649LANGUAGE_MALAYALAM = 0 3650LANGUAGE_MALAY_BRUNEI_DARUSSALAM = 0 3651LANGUAGE_MALAY_MALAYSIA = 0 3652LANGUAGE_MALTESE = 0 3653LANGUAGE_MANIPURI = 0 3654LANGUAGE_MAORI = 0 3655LANGUAGE_MARATHI = 0 3656LANGUAGE_MOLDAVIAN = 0 3657LANGUAGE_MONGOLIAN = 0 3658LANGUAGE_NAURU = 0 3659LANGUAGE_NEPALI = 0 3660LANGUAGE_NEPALI_INDIA = 0 3661LANGUAGE_NORWEGIAN_BOKMAL = 0 3662LANGUAGE_NORWEGIAN_NYNORSK = 0 3663LANGUAGE_OCCITAN = 0 3664LANGUAGE_ORIYA = 0 3665LANGUAGE_OROMO = 0 3666LANGUAGE_PASHTO = 0 3667LANGUAGE_POLISH = 0 3668LANGUAGE_PORTUGUESE = 0 3669LANGUAGE_PORTUGUESE_BRAZILIAN = 0 3670LANGUAGE_PUNJABI = 0 3671LANGUAGE_QUECHUA = 0 3672LANGUAGE_RHAETO_ROMANCE = 0 3673LANGUAGE_ROMANIAN = 0 3674LANGUAGE_RUSSIAN = 0 3675LANGUAGE_RUSSIAN_UKRAINE = 0 3676LANGUAGE_SAMI = 0 3677LANGUAGE_SAMOAN = 0 3678LANGUAGE_SANGHO = 0 3679LANGUAGE_SANSKRIT = 0 3680LANGUAGE_SCOTS_GAELIC = 0 3681LANGUAGE_SERBIAN = 0 3682LANGUAGE_SERBIAN_CYRILLIC = 0 3683LANGUAGE_SERBIAN_LATIN = 0 3684LANGUAGE_SERBO_CROATIAN = 0 3685LANGUAGE_SESOTHO = 0 3686LANGUAGE_SETSWANA = 0 3687LANGUAGE_SHONA = 0 3688LANGUAGE_SINDHI = 0 3689LANGUAGE_SINHALESE = 0 3690LANGUAGE_SISWATI = 0 3691LANGUAGE_SLOVAK = 0 3692LANGUAGE_SLOVENIAN = 0 3693LANGUAGE_SOMALI = 0 3694LANGUAGE_SPANISH = 0 3695LANGUAGE_SPANISH_ARGENTINA = 0 3696LANGUAGE_SPANISH_BOLIVIA = 0 3697LANGUAGE_SPANISH_CHILE = 0 3698LANGUAGE_SPANISH_COLOMBIA = 0 3699LANGUAGE_SPANISH_COSTA_RICA = 0 3700LANGUAGE_SPANISH_DOMINICAN_REPUBLIC = 0 3701LANGUAGE_SPANISH_ECUADOR = 0 3702LANGUAGE_SPANISH_EL_SALVADOR = 0 3703LANGUAGE_SPANISH_GUATEMALA = 0 3704LANGUAGE_SPANISH_HONDURAS = 0 3705LANGUAGE_SPANISH_MEXICAN = 0 3706LANGUAGE_SPANISH_MODERN = 0 3707LANGUAGE_SPANISH_NICARAGUA = 0 3708LANGUAGE_SPANISH_PANAMA = 0 3709LANGUAGE_SPANISH_PARAGUAY = 0 3710LANGUAGE_SPANISH_PERU = 0 3711LANGUAGE_SPANISH_PUERTO_RICO = 0 3712LANGUAGE_SPANISH_URUGUAY = 0 3713LANGUAGE_SPANISH_US = 0 3714LANGUAGE_SPANISH_VENEZUELA = 0 3715LANGUAGE_SUNDANESE = 0 3716LANGUAGE_SWAHILI = 0 3717LANGUAGE_SWEDISH = 0 3718LANGUAGE_SWEDISH_FINLAND = 0 3719LANGUAGE_TAGALOG = 0 3720LANGUAGE_TAJIK = 0 3721LANGUAGE_TAMIL = 0 3722LANGUAGE_TATAR = 0 3723LANGUAGE_TELUGU = 0 3724LANGUAGE_THAI = 0 3725LANGUAGE_TIBETAN = 0 3726LANGUAGE_TIGRINYA = 0 3727LANGUAGE_TONGA = 0 3728LANGUAGE_TSONGA = 0 3729LANGUAGE_TURKISH = 0 3730LANGUAGE_TURKMEN = 0 3731LANGUAGE_TWI = 0 3732LANGUAGE_UIGHUR = 0 3733LANGUAGE_UKRAINIAN = 0 3734LANGUAGE_URDU = 0 3735LANGUAGE_URDU_INDIA = 0 3736LANGUAGE_URDU_PAKISTAN = 0 3737LANGUAGE_UZBEK = 0 3738LANGUAGE_UZBEK_CYRILLIC = 0 3739LANGUAGE_UZBEK_LATIN = 0 3740LANGUAGE_VALENCIAN = 0 3741LANGUAGE_VIETNAMESE = 0 3742LANGUAGE_VOLAPUK = 0 3743LANGUAGE_WELSH = 0 3744LANGUAGE_WOLOF = 0 3745LANGUAGE_XHOSA = 0 3746LANGUAGE_YIDDISH = 0 3747LANGUAGE_YORUBA = 0 3748LANGUAGE_ZHUANG = 0 3749LANGUAGE_ZULU = 0 3750LANGUAGE_KABYLE = 0 3751LANGUAGE_USER_DEFINED = 0 3752Layout_Default = 0 3753Layout_LeftToRight = 0 3754Layout_RightToLeft = 0 3755LOCALE_CAT_NUMBER = 0 3756LOCALE_CAT_DATE = 0 3757LOCALE_CAT_MONEY = 0 3758LOCALE_CAT_DEFAULT = 0 3759LOCALE_THOUSANDS_SEP = 0 3760LOCALE_DECIMAL_POINT = 0 3761LOCALE_SHORT_DATE_FMT = 0 3762LOCALE_LONG_DATE_FMT = 0 3763LOCALE_DATE_TIME_FMT = 0 3764LOCALE_TIME_FMT = 0 3765LOCALE_DONT_LOAD_DEFAULT = 0 3766LOCALE_LOAD_DEFAULT = 0 3767 3768class LanguageInfo(object): 3769 """ 3770 Encapsulates a wxLanguage identifier together with OS-specific 3771 information related to that language. 3772 """ 3773 Language = property(None, None) 3774 CanonicalName = property(None, None) 3775 Description = property(None, None) 3776 LayoutDirection = property(None, None) 3777 3778 def GetLocaleName(self): 3779 """ 3780 GetLocaleName() -> String 3781 3782 Return the locale name corresponding to this language usable with 3783 setlocale() on the current system. 3784 """ 3785 LocaleName = property(None, None) 3786# end of class LanguageInfo 3787 3788 3789class Locale(object): 3790 """ 3791 Locale() 3792 Locale(language, flags=LOCALE_LOAD_DEFAULT) 3793 Locale(name, shortName=EmptyString, locale=EmptyString, bLoadDefault=True) 3794 3795 wxLocale class encapsulates all language-dependent settings and is a 3796 generalization of the C locale concept. 3797 """ 3798 3799 def __init__(self, *args, **kw): 3800 """ 3801 Locale() 3802 Locale(language, flags=LOCALE_LOAD_DEFAULT) 3803 Locale(name, shortName=EmptyString, locale=EmptyString, bLoadDefault=True) 3804 3805 wxLocale class encapsulates all language-dependent settings and is a 3806 generalization of the C locale concept. 3807 """ 3808 3809 def AddCatalog(self, *args, **kw): 3810 """ 3811 AddCatalog(domain) -> bool 3812 AddCatalog(domain, msgIdLanguage) -> bool 3813 AddCatalog(domain, msgIdLanguage, msgIdCharset) -> bool 3814 3815 Calls wxTranslations::AddCatalog(const wxString&). 3816 """ 3817 3818 def GetCanonicalName(self): 3819 """ 3820 GetCanonicalName() -> String 3821 3822 Returns the canonical form of current locale name. 3823 """ 3824 3825 def GetHeaderValue(self, header, domain=EmptyString): 3826 """ 3827 GetHeaderValue(header, domain=EmptyString) -> String 3828 3829 Calls wxTranslations::GetHeaderValue(). 3830 """ 3831 3832 def GetLanguage(self): 3833 """ 3834 GetLanguage() -> int 3835 3836 Returns the wxLanguage constant of current language. 3837 """ 3838 3839 def GetLocale(self): 3840 """ 3841 GetLocale() -> String 3842 3843 Returns the locale name as passed to the constructor or Init(). 3844 """ 3845 3846 def GetName(self): 3847 """ 3848 GetName() -> String 3849 3850 Returns the current short name for the locale (as given to the 3851 constructor or the Init() function). 3852 """ 3853 3854 def GetString(self, *args, **kw): 3855 """ 3856 GetString(origString, domain=EmptyString) -> String 3857 GetString(origString, origString2, n, domain=EmptyString) -> String 3858 3859 Calls wxGetTranslation(const wxString&, const wxString&). 3860 """ 3861 3862 def GetSysName(self): 3863 """ 3864 GetSysName() -> String 3865 3866 Returns current platform-specific locale name as passed to 3867 setlocale(). 3868 """ 3869 3870 def Init(self, *args, **kw): 3871 """ 3872 Init(language=LANGUAGE_DEFAULT, flags=LOCALE_LOAD_DEFAULT) -> bool 3873 Init(name, shortName=EmptyString, locale=EmptyString, bLoadDefault=True) -> bool 3874 3875 Initializes the wxLocale instance. 3876 """ 3877 3878 def IsLoaded(self, domain): 3879 """ 3880 IsLoaded(domain) -> bool 3881 3882 Calls wxTranslations::IsLoaded(). 3883 """ 3884 3885 def IsOk(self): 3886 """ 3887 IsOk() -> bool 3888 3889 Returns true if the locale could be set successfully. 3890 """ 3891 3892 @staticmethod 3893 def AddCatalogLookupPathPrefix(prefix): 3894 """ 3895 AddCatalogLookupPathPrefix(prefix) 3896 3897 Calls wxFileTranslationsLoader::AddCatalogLookupPathPrefix(). 3898 """ 3899 3900 @staticmethod 3901 def AddLanguage(info): 3902 """ 3903 AddLanguage(info) 3904 3905 Adds custom, user-defined language to the database of known languages. 3906 """ 3907 3908 @staticmethod 3909 def FindLanguageInfo(locale): 3910 """ 3911 FindLanguageInfo(locale) -> LanguageInfo 3912 3913 This function may be used to find the language description structure 3914 for the given locale, specified either as a two letter ISO language 3915 code (for example, "pt"), a language code followed by the country code 3916 ("pt_BR") or a full, human readable, language description 3917 ("Portuguese-Brazil"). 3918 """ 3919 3920 @staticmethod 3921 def GetLanguageInfo(lang): 3922 """ 3923 GetLanguageInfo(lang) -> LanguageInfo 3924 3925 Returns a pointer to wxLanguageInfo structure containing information 3926 about the given language or NULL if this language is unknown. 3927 """ 3928 3929 @staticmethod 3930 def GetLanguageName(lang): 3931 """ 3932 GetLanguageName(lang) -> String 3933 3934 Returns English name of the given language or empty string if this 3935 language is unknown. 3936 """ 3937 3938 @staticmethod 3939 def GetLanguageCanonicalName(lang): 3940 """ 3941 GetLanguageCanonicalName(lang) -> String 3942 3943 Returns canonical name (see GetCanonicalName()) of the given language 3944 or empty string if this language is unknown. 3945 """ 3946 3947 @staticmethod 3948 def GetSystemEncoding(): 3949 """ 3950 GetSystemEncoding() -> FontEncoding 3951 3952 Tries to detect the user's default font encoding. 3953 """ 3954 3955 @staticmethod 3956 def GetSystemEncodingName(): 3957 """ 3958 GetSystemEncodingName() -> String 3959 3960 Tries to detect the name of the user's default font encoding. 3961 """ 3962 3963 @staticmethod 3964 def GetSystemLanguage(): 3965 """ 3966 GetSystemLanguage() -> int 3967 3968 Tries to detect the user's default locale setting. 3969 """ 3970 3971 @staticmethod 3972 def GetInfo(index, cat=LOCALE_CAT_DEFAULT): 3973 """ 3974 GetInfo(index, cat=LOCALE_CAT_DEFAULT) -> String 3975 3976 Get the values of the given locale-dependent datum. 3977 """ 3978 3979 @staticmethod 3980 def IsAvailable(lang): 3981 """ 3982 IsAvailable(lang) -> bool 3983 3984 Check whether the operating system and/or C run time environment 3985 supports this locale. 3986 """ 3987 3988 def __nonzero__(self): 3989 """ 3990 __nonzero__() -> int 3991 """ 3992 3993 def __bool__(self): 3994 """ 3995 __bool__() -> int 3996 """ 3997 CanonicalName = property(None, None) 3998 Language = property(None, None) 3999 Locale = property(None, None) 4000 Name = property(None, None) 4001 SysName = property(None, None) 4002# end of class Locale 4003 4004 4005def GetLocale(): 4006 """ 4007 GetLocale() -> Locale 4008 4009 Get the current locale object (note that it may be NULL!) 4010 """ 4011 4012#---------------------------------------------------------------------------- 4013# Add the directory where the wxWidgets catalogs were installed 4014# to the default catalog path, if they were put in the pacakge dir. 4015import os 4016_localedir = os.path.join(os.path.dirname(__file__), "locale") 4017if os.path.exists(_localedir): 4018 Locale.AddCatalogLookupPathPrefix(_localedir) 4019del os 4020#---------------------------------------------------------------------------- 4021#-- end-intl --# 4022#-- begin-translation --# 4023 4024class Translations(object): 4025 """ 4026 Translations() 4027 4028 This class allows getting translations for strings. 4029 """ 4030 4031 def __init__(self): 4032 """ 4033 Translations() 4034 4035 This class allows getting translations for strings. 4036 """ 4037 4038 def SetLoader(self, loader): 4039 """ 4040 SetLoader(loader) 4041 4042 Changes loader use to read catalogs to a non-default one. 4043 """ 4044 4045 def SetLanguage(self, *args, **kw): 4046 """ 4047 SetLanguage(lang) 4048 SetLanguage(lang) 4049 4050 Sets translations language to use. 4051 """ 4052 4053 def GetAvailableTranslations(self, domain): 4054 """ 4055 GetAvailableTranslations(domain) -> ArrayString 4056 4057 Returns list of all translations of domain that were found. 4058 """ 4059 4060 def GetBestTranslation(self, *args, **kw): 4061 """ 4062 GetBestTranslation(domain, msgIdLanguage) -> String 4063 GetBestTranslation(domain, msgIdLanguage="en") -> String 4064 4065 Returns the best UI language for the domain. 4066 """ 4067 4068 def AddStdCatalog(self): 4069 """ 4070 AddStdCatalog() -> bool 4071 4072 Add standard wxWidgets catalogs ("wxstd" and possible port-specific 4073 catalogs). 4074 """ 4075 4076 def AddCatalog(self, *args, **kw): 4077 """ 4078 AddCatalog(domain) -> bool 4079 AddCatalog(domain, msgIdLanguage) -> bool 4080 4081 Add a catalog for use with the current locale. 4082 """ 4083 4084 def IsLoaded(self, domain): 4085 """ 4086 IsLoaded(domain) -> bool 4087 4088 Check if the given catalog is loaded, and returns true if it is. 4089 """ 4090 4091 def GetTranslatedString(self, *args, **kw): 4092 """ 4093 GetTranslatedString(origString, domain=EmptyString) -> String 4094 GetTranslatedString(origString, n, domain=EmptyString) -> String 4095 4096 Retrieves the translation for a string in all loaded domains unless 4097 the domain parameter is specified (and then only this catalog/domain 4098 is searched). 4099 """ 4100 4101 def GetHeaderValue(self, header, domain=EmptyString): 4102 """ 4103 GetHeaderValue(header, domain=EmptyString) -> String 4104 4105 Returns the header value for header header. 4106 """ 4107 4108 @staticmethod 4109 def Get(): 4110 """ 4111 Get() -> Translations 4112 4113 Returns current translations object, may return NULL. 4114 """ 4115 4116 @staticmethod 4117 def Set(t): 4118 """ 4119 Set(t) 4120 4121 Sets current translations object. 4122 """ 4123# end of class Translations 4124 4125 4126class TranslationsLoader(object): 4127 """ 4128 TranslationsLoader() 4129 4130 Abstraction of translations discovery and loading. 4131 """ 4132 4133 def __init__(self): 4134 """ 4135 TranslationsLoader() 4136 4137 Abstraction of translations discovery and loading. 4138 """ 4139 4140 def LoadCatalog(self, domain, lang): 4141 """ 4142 LoadCatalog(domain, lang) -> MsgCatalog 4143 4144 Called to load requested catalog. 4145 """ 4146 4147 def GetAvailableTranslations(self, domain): 4148 """ 4149 GetAvailableTranslations(domain) -> ArrayString 4150 4151 Implements wxTranslations::GetAvailableTranslations(). 4152 """ 4153# end of class TranslationsLoader 4154 4155 4156class FileTranslationsLoader(TranslationsLoader): 4157 """ 4158 Standard wxTranslationsLoader implementation. 4159 """ 4160 4161 @staticmethod 4162 def AddCatalogLookupPathPrefix(prefix): 4163 """ 4164 AddCatalogLookupPathPrefix(prefix) 4165 4166 Add a prefix to the catalog lookup path: the message catalog files 4167 will be looked up under prefix/lang/LC_MESSAGES and prefix/lang 4168 directories (in this order). 4169 """ 4170# end of class FileTranslationsLoader 4171 4172 4173def GetTranslation(*args, **kw): 4174 """ 4175 GetTranslation(string, domain=EmptyString) -> String 4176 GetTranslation(string, plural, n, domain=EmptyString) -> String 4177 4178 This function returns the translation of string in the current 4179 locale(). 4180 """ 4181#-- end-translation --# 4182#-- begin-cmndata --# 4183PRINTBIN_DEFAULT = 0 4184PRINTBIN_ONLYONE = 0 4185PRINTBIN_LOWER = 0 4186PRINTBIN_MIDDLE = 0 4187PRINTBIN_MANUAL = 0 4188PRINTBIN_ENVELOPE = 0 4189PRINTBIN_ENVMANUAL = 0 4190PRINTBIN_AUTO = 0 4191PRINTBIN_TRACTOR = 0 4192PRINTBIN_SMALLFMT = 0 4193PRINTBIN_LARGEFMT = 0 4194PRINTBIN_LARGECAPACITY = 0 4195PRINTBIN_CASSETTE = 0 4196PRINTBIN_FORMSOURCE = 0 4197PRINTBIN_USER = 0 4198 4199class PageSetupDialogData(Object): 4200 """ 4201 PageSetupDialogData() 4202 PageSetupDialogData(data) 4203 PageSetupDialogData(printData) 4204 4205 This class holds a variety of information related to 4206 wxPageSetupDialog. 4207 """ 4208 4209 def __init__(self, *args, **kw): 4210 """ 4211 PageSetupDialogData() 4212 PageSetupDialogData(data) 4213 PageSetupDialogData(printData) 4214 4215 This class holds a variety of information related to 4216 wxPageSetupDialog. 4217 """ 4218 4219 def EnableHelp(self, flag): 4220 """ 4221 EnableHelp(flag) 4222 4223 Enables or disables the "Help" button (Windows only). 4224 """ 4225 4226 def EnableMargins(self, flag): 4227 """ 4228 EnableMargins(flag) 4229 4230 Enables or disables the margin controls (Windows only). 4231 """ 4232 4233 def EnableOrientation(self, flag): 4234 """ 4235 EnableOrientation(flag) 4236 4237 Enables or disables the orientation control (Windows only). 4238 """ 4239 4240 def EnablePaper(self, flag): 4241 """ 4242 EnablePaper(flag) 4243 4244 Enables or disables the paper size control (Windows only). 4245 """ 4246 4247 def EnablePrinter(self, flag): 4248 """ 4249 EnablePrinter(flag) 4250 4251 Enables or disables the "Printer" button, which invokes a printer 4252 setup dialog. 4253 """ 4254 4255 def GetDefaultInfo(self): 4256 """ 4257 GetDefaultInfo() -> bool 4258 4259 Returns true if the dialog will simply return default printer 4260 information (such as orientation) instead of showing a dialog (Windows 4261 only). 4262 """ 4263 4264 def GetDefaultMinMargins(self): 4265 """ 4266 GetDefaultMinMargins() -> bool 4267 4268 Returns true if the page setup dialog will take its minimum margin 4269 values from the currently selected printer properties (Windows only). 4270 """ 4271 4272 def GetEnableHelp(self): 4273 """ 4274 GetEnableHelp() -> bool 4275 4276 Returns true if the printer setup button is enabled. 4277 """ 4278 4279 def GetEnableMargins(self): 4280 """ 4281 GetEnableMargins() -> bool 4282 4283 Returns true if the margin controls are enabled (Windows only). 4284 """ 4285 4286 def GetEnableOrientation(self): 4287 """ 4288 GetEnableOrientation() -> bool 4289 4290 Returns true if the orientation control is enabled (Windows only). 4291 """ 4292 4293 def GetEnablePaper(self): 4294 """ 4295 GetEnablePaper() -> bool 4296 4297 Returns true if the paper size control is enabled (Windows only). 4298 """ 4299 4300 def GetEnablePrinter(self): 4301 """ 4302 GetEnablePrinter() -> bool 4303 4304 Returns true if the printer setup button is enabled. 4305 """ 4306 4307 def GetMarginBottomRight(self): 4308 """ 4309 GetMarginBottomRight() -> Point 4310 4311 Returns the right (x) and bottom (y) margins in millimetres. 4312 """ 4313 4314 def GetMarginTopLeft(self): 4315 """ 4316 GetMarginTopLeft() -> Point 4317 4318 Returns the left (x) and top (y) margins in millimetres. 4319 """ 4320 4321 def GetMinMarginBottomRight(self): 4322 """ 4323 GetMinMarginBottomRight() -> Point 4324 4325 Returns the right (x) and bottom (y) minimum margins the user can 4326 enter (Windows only). 4327 """ 4328 4329 def GetMinMarginTopLeft(self): 4330 """ 4331 GetMinMarginTopLeft() -> Point 4332 4333 Returns the left (x) and top (y) minimum margins the user can enter 4334 (Windows only). 4335 """ 4336 4337 def GetPaperId(self): 4338 """ 4339 GetPaperId() -> PaperSize 4340 4341 Returns the paper id (stored in the internal wxPrintData object). 4342 """ 4343 4344 def GetPaperSize(self): 4345 """ 4346 GetPaperSize() -> Size 4347 4348 Returns the paper size in millimetres. 4349 """ 4350 4351 def GetPrintData(self): 4352 """ 4353 GetPrintData() -> PrintData 4354 4355 Returns a reference to the print data associated with this object. 4356 """ 4357 4358 def IsOk(self): 4359 """ 4360 IsOk() -> bool 4361 4362 Returns true if the print data associated with the dialog data is 4363 valid. 4364 """ 4365 4366 def SetDefaultInfo(self, flag): 4367 """ 4368 SetDefaultInfo(flag) 4369 4370 Pass true if the dialog will simply return default printer information 4371 (such as orientation) instead of showing a dialog (Windows only). 4372 """ 4373 4374 def SetDefaultMinMargins(self, flag): 4375 """ 4376 SetDefaultMinMargins(flag) 4377 4378 Pass true if the page setup dialog will take its minimum margin values 4379 from the currently selected printer properties (Windows only). 4380 """ 4381 4382 def SetMarginBottomRight(self, pt): 4383 """ 4384 SetMarginBottomRight(pt) 4385 4386 Sets the right (x) and bottom (y) margins in millimetres. 4387 """ 4388 4389 def SetMarginTopLeft(self, pt): 4390 """ 4391 SetMarginTopLeft(pt) 4392 4393 Sets the left (x) and top (y) margins in millimetres. 4394 """ 4395 4396 def SetMinMarginBottomRight(self, pt): 4397 """ 4398 SetMinMarginBottomRight(pt) 4399 4400 Sets the right (x) and bottom (y) minimum margins the user can enter 4401 (Windows only). 4402 """ 4403 4404 def SetMinMarginTopLeft(self, pt): 4405 """ 4406 SetMinMarginTopLeft(pt) 4407 4408 Sets the left (x) and top (y) minimum margins the user can enter 4409 (Windows only). 4410 """ 4411 4412 def SetPaperId(self, id): 4413 """ 4414 SetPaperId(id) 4415 4416 Sets the paper size id. 4417 """ 4418 4419 def SetPaperSize(self, size): 4420 """ 4421 SetPaperSize(size) 4422 4423 Sets the paper size in millimetres. 4424 """ 4425 4426 def SetPrintData(self, printData): 4427 """ 4428 SetPrintData(printData) 4429 4430 Sets the print data associated with this object. 4431 """ 4432 4433 def __nonzero__(self): 4434 """ 4435 __nonzero__() -> int 4436 """ 4437 4438 def __bool__(self): 4439 """ 4440 __bool__() -> int 4441 """ 4442 MarginBottomRight = property(None, None) 4443 MarginTopLeft = property(None, None) 4444 MinMarginBottomRight = property(None, None) 4445 MinMarginTopLeft = property(None, None) 4446 PaperId = property(None, None) 4447 PaperSize = property(None, None) 4448 PrintData = property(None, None) 4449# end of class PageSetupDialogData 4450 4451 4452class PrintData(Object): 4453 """ 4454 PrintData() 4455 PrintData(data) 4456 4457 This class holds a variety of information related to printers and 4458 printer device contexts. 4459 """ 4460 4461 def __init__(self, *args, **kw): 4462 """ 4463 PrintData() 4464 PrintData(data) 4465 4466 This class holds a variety of information related to printers and 4467 printer device contexts. 4468 """ 4469 4470 def GetBin(self): 4471 """ 4472 GetBin() -> PrintBin 4473 4474 Returns the current bin (papersource). 4475 """ 4476 4477 def GetCollate(self): 4478 """ 4479 GetCollate() -> bool 4480 4481 Returns true if collation is on. 4482 """ 4483 4484 def GetColour(self): 4485 """ 4486 GetColour() -> bool 4487 4488 Returns true if colour printing is on. 4489 """ 4490 4491 def GetDuplex(self): 4492 """ 4493 GetDuplex() -> DuplexMode 4494 4495 Returns the duplex mode. 4496 """ 4497 4498 def GetNoCopies(self): 4499 """ 4500 GetNoCopies() -> int 4501 4502 Returns the number of copies requested by the user. 4503 """ 4504 4505 def GetOrientation(self): 4506 """ 4507 GetOrientation() -> PrintOrientation 4508 4509 Gets the orientation. 4510 """ 4511 4512 def GetPaperId(self): 4513 """ 4514 GetPaperId() -> PaperSize 4515 4516 Returns the paper size id. 4517 """ 4518 4519 def GetPrinterName(self): 4520 """ 4521 GetPrinterName() -> String 4522 4523 Returns the printer name. 4524 """ 4525 4526 def GetQuality(self): 4527 """ 4528 GetQuality() -> PrintQuality 4529 4530 Returns the current print quality. 4531 """ 4532 4533 def IsOk(self): 4534 """ 4535 IsOk() -> bool 4536 4537 Returns true if the print data is valid for using in print dialogs. 4538 """ 4539 4540 def SetBin(self, flag): 4541 """ 4542 SetBin(flag) 4543 4544 Sets the current bin. 4545 """ 4546 4547 def SetCollate(self, flag): 4548 """ 4549 SetCollate(flag) 4550 4551 Sets collation to on or off. 4552 """ 4553 4554 def SetColour(self, flag): 4555 """ 4556 SetColour(flag) 4557 4558 Sets colour printing on or off. 4559 """ 4560 4561 def SetDuplex(self, mode): 4562 """ 4563 SetDuplex(mode) 4564 4565 Returns the duplex mode. 4566 """ 4567 4568 def SetNoCopies(self, n): 4569 """ 4570 SetNoCopies(n) 4571 4572 Sets the default number of copies to be printed out. 4573 """ 4574 4575 def SetOrientation(self, orientation): 4576 """ 4577 SetOrientation(orientation) 4578 4579 Sets the orientation. 4580 """ 4581 4582 def SetPaperId(self, paperId): 4583 """ 4584 SetPaperId(paperId) 4585 4586 Sets the paper id. 4587 """ 4588 4589 def SetPrinterName(self, printerName): 4590 """ 4591 SetPrinterName(printerName) 4592 4593 Sets the printer name. 4594 """ 4595 4596 def SetQuality(self, quality): 4597 """ 4598 SetQuality(quality) 4599 4600 Sets the desired print quality. 4601 """ 4602 4603 def GetFilename(self): 4604 """ 4605 GetFilename() -> String 4606 """ 4607 4608 def SetFilename(self, filename): 4609 """ 4610 SetFilename(filename) 4611 """ 4612 4613 def GetPrintMode(self): 4614 """ 4615 GetPrintMode() -> PrintMode 4616 """ 4617 4618 def SetPrintMode(self, printMode): 4619 """ 4620 SetPrintMode(printMode) 4621 """ 4622 4623 def GetPaperSize(self): 4624 """ 4625 GetPaperSize() -> Size 4626 """ 4627 4628 def SetPaperSize(self, sz): 4629 """ 4630 SetPaperSize(sz) 4631 """ 4632 4633 def __nonzero__(self): 4634 """ 4635 __nonzero__() -> int 4636 """ 4637 4638 def __bool__(self): 4639 """ 4640 __bool__() -> int 4641 """ 4642 4643 def GetPrivData(self): 4644 """ 4645 GetPrivData() -> PyObject 4646 """ 4647 4648 def SetPrivData(self, data): 4649 """ 4650 SetPrivData(data) 4651 """ 4652 Bin = property(None, None) 4653 Collate = property(None, None) 4654 Colour = property(None, None) 4655 Duplex = property(None, None) 4656 Filename = property(None, None) 4657 NoCopies = property(None, None) 4658 Orientation = property(None, None) 4659 PaperId = property(None, None) 4660 PaperSize = property(None, None) 4661 PrintMode = property(None, None) 4662 PrinterName = property(None, None) 4663 PrivData = property(None, None) 4664 Quality = property(None, None) 4665# end of class PrintData 4666 4667 4668class PrintDialogData(Object): 4669 """ 4670 PrintDialogData() 4671 PrintDialogData(dialogData) 4672 PrintDialogData(printData) 4673 4674 This class holds information related to the visual characteristics of 4675 wxPrintDialog. 4676 """ 4677 4678 def __init__(self, *args, **kw): 4679 """ 4680 PrintDialogData() 4681 PrintDialogData(dialogData) 4682 PrintDialogData(printData) 4683 4684 This class holds information related to the visual characteristics of 4685 wxPrintDialog. 4686 """ 4687 4688 def EnableHelp(self, flag): 4689 """ 4690 EnableHelp(flag) 4691 4692 Enables or disables the "Help" button. 4693 """ 4694 4695 def EnablePageNumbers(self, flag): 4696 """ 4697 EnablePageNumbers(flag) 4698 4699 Enables or disables the "Page numbers" controls. 4700 """ 4701 4702 def EnablePrintToFile(self, flag): 4703 """ 4704 EnablePrintToFile(flag) 4705 4706 Enables or disables the "Print to file" checkbox. 4707 """ 4708 4709 def EnableSelection(self, flag): 4710 """ 4711 EnableSelection(flag) 4712 4713 Enables or disables the "Selection" radio button. 4714 """ 4715 4716 def GetAllPages(self): 4717 """ 4718 GetAllPages() -> bool 4719 4720 Returns true if the user requested that all pages be printed. 4721 """ 4722 4723 def GetCollate(self): 4724 """ 4725 GetCollate() -> bool 4726 4727 Returns true if the user requested that the document(s) be collated. 4728 """ 4729 4730 def GetFromPage(self): 4731 """ 4732 GetFromPage() -> int 4733 4734 Returns the from page number, as entered by the user. 4735 """ 4736 4737 def GetMaxPage(self): 4738 """ 4739 GetMaxPage() -> int 4740 4741 Returns the maximum page number. 4742 """ 4743 4744 def GetMinPage(self): 4745 """ 4746 GetMinPage() -> int 4747 4748 Returns the minimum page number. 4749 """ 4750 4751 def GetNoCopies(self): 4752 """ 4753 GetNoCopies() -> int 4754 4755 Returns the number of copies requested by the user. 4756 """ 4757 4758 def GetPrintData(self): 4759 """ 4760 GetPrintData() -> PrintData 4761 4762 Returns a reference to the internal wxPrintData object. 4763 """ 4764 4765 def GetPrintToFile(self): 4766 """ 4767 GetPrintToFile() -> bool 4768 4769 Returns true if the user has selected printing to a file. 4770 """ 4771 4772 def GetSelection(self): 4773 """ 4774 GetSelection() -> bool 4775 4776 Returns true if the user requested that the selection be printed 4777 (where "selection" is a concept specific to the application). 4778 """ 4779 4780 def GetToPage(self): 4781 """ 4782 GetToPage() -> int 4783 4784 Returns the "print to" page number, as entered by the user. 4785 """ 4786 4787 def IsOk(self): 4788 """ 4789 IsOk() -> bool 4790 4791 Returns true if the print data is valid for using in print dialogs. 4792 """ 4793 4794 def SetCollate(self, flag): 4795 """ 4796 SetCollate(flag) 4797 4798 Sets the "Collate" checkbox to true or false. 4799 """ 4800 4801 def SetFromPage(self, page): 4802 """ 4803 SetFromPage(page) 4804 4805 Sets the from page number. 4806 """ 4807 4808 def SetMaxPage(self, page): 4809 """ 4810 SetMaxPage(page) 4811 4812 Sets the maximum page number. 4813 """ 4814 4815 def SetMinPage(self, page): 4816 """ 4817 SetMinPage(page) 4818 4819 Sets the minimum page number. 4820 """ 4821 4822 def SetNoCopies(self, n): 4823 """ 4824 SetNoCopies(n) 4825 4826 Sets the default number of copies the user has requested to be printed 4827 out. 4828 """ 4829 4830 def SetPrintData(self, printData): 4831 """ 4832 SetPrintData(printData) 4833 4834 Sets the internal wxPrintData. 4835 """ 4836 4837 def SetPrintToFile(self, flag): 4838 """ 4839 SetPrintToFile(flag) 4840 4841 Sets the "Print to file" checkbox to true or false. 4842 """ 4843 4844 def SetSelection(self, flag): 4845 """ 4846 SetSelection(flag) 4847 4848 Selects the "Selection" radio button. 4849 """ 4850 4851 def SetToPage(self, page): 4852 """ 4853 SetToPage(page) 4854 4855 Sets the "print to" page number. 4856 """ 4857 4858 def __nonzero__(self): 4859 """ 4860 __nonzero__() -> int 4861 """ 4862 4863 def __bool__(self): 4864 """ 4865 __bool__() -> int 4866 """ 4867 AllPages = property(None, None) 4868 Collate = property(None, None) 4869 FromPage = property(None, None) 4870 MaxPage = property(None, None) 4871 MinPage = property(None, None) 4872 NoCopies = property(None, None) 4873 PrintData = property(None, None) 4874 PrintToFile = property(None, None) 4875 Selection = property(None, None) 4876 ToPage = property(None, None) 4877# end of class PrintDialogData 4878 4879#-- end-cmndata --# 4880#-- begin-gdicmn --# 4881BITMAP_TYPE_INVALID = 0 4882BITMAP_TYPE_BMP = 0 4883BITMAP_TYPE_ICO = 0 4884BITMAP_TYPE_CUR = 0 4885BITMAP_TYPE_XBM = 0 4886BITMAP_TYPE_XBM_DATA = 0 4887BITMAP_TYPE_XPM = 0 4888BITMAP_TYPE_XPM_DATA = 0 4889BITMAP_TYPE_TIFF = 0 4890BITMAP_TYPE_TIF = 0 4891BITMAP_TYPE_GIF = 0 4892BITMAP_TYPE_PNG = 0 4893BITMAP_TYPE_JPEG = 0 4894BITMAP_TYPE_PNM = 0 4895BITMAP_TYPE_PCX = 0 4896BITMAP_TYPE_PICT = 0 4897BITMAP_TYPE_ICON = 0 4898BITMAP_TYPE_ANI = 0 4899BITMAP_TYPE_IFF = 0 4900BITMAP_TYPE_TGA = 0 4901BITMAP_TYPE_MACCURSOR = 0 4902BITMAP_TYPE_ANY = 0 4903ODDEVEN_RULE = 0 4904WINDING_RULE = 0 4905CURSOR_NONE = 0 4906CURSOR_ARROW = 0 4907CURSOR_RIGHT_ARROW = 0 4908CURSOR_BULLSEYE = 0 4909CURSOR_CHAR = 0 4910CURSOR_CROSS = 0 4911CURSOR_HAND = 0 4912CURSOR_IBEAM = 0 4913CURSOR_LEFT_BUTTON = 0 4914CURSOR_MAGNIFIER = 0 4915CURSOR_MIDDLE_BUTTON = 0 4916CURSOR_NO_ENTRY = 0 4917CURSOR_PAINT_BRUSH = 0 4918CURSOR_PENCIL = 0 4919CURSOR_POINT_LEFT = 0 4920CURSOR_POINT_RIGHT = 0 4921CURSOR_QUESTION_ARROW = 0 4922CURSOR_RIGHT_BUTTON = 0 4923CURSOR_SIZENESW = 0 4924CURSOR_SIZENS = 0 4925CURSOR_SIZENWSE = 0 4926CURSOR_SIZEWE = 0 4927CURSOR_SIZING = 0 4928CURSOR_SPRAYCAN = 0 4929CURSOR_WAIT = 0 4930CURSOR_WATCH = 0 4931CURSOR_BLANK = 0 4932CURSOR_DEFAULT = 0 4933CURSOR_COPY_ARROW = 0 4934CURSOR_ARROWWAIT = 0 4935CURSOR_MAX = 0 4936 4937class Point(object): 4938 """ 4939 Point() 4940 Point(x, y) 4941 Point(pt) 4942 4943 A wxPoint is a useful data structure for graphics operations. 4944 """ 4945 4946 def __init__(self, *args, **kw): 4947 """ 4948 Point() 4949 Point(x, y) 4950 Point(pt) 4951 4952 A wxPoint is a useful data structure for graphics operations. 4953 """ 4954 4955 def __iadd__(self, *args, **kw): 4956 """ 4957 """ 4958 4959 def __isub__(self, *args, **kw): 4960 """ 4961 """ 4962 4963 def IsFullySpecified(self): 4964 """ 4965 IsFullySpecified() -> bool 4966 4967 Returns true if neither of the point components is equal to 4968 wxDefaultCoord. 4969 """ 4970 4971 def SetDefaults(self, pt): 4972 """ 4973 SetDefaults(pt) 4974 4975 Combine this object with another one replacing the uninitialized 4976 values. 4977 """ 4978 x = property(None, None) 4979 y = property(None, None) 4980 4981 def __eq__(self, other): 4982 """ 4983 __eq__(other) -> bool 4984 """ 4985 4986 def __ne__(self, other): 4987 """ 4988 __ne__(other) -> bool 4989 """ 4990 4991 def Get(self): 4992 """ 4993 Get() -> (x,y) 4994 4995 Return the x and y properties as a tuple. 4996 """ 4997 4998 def GetIM(self): 4999 """ 5000 Returns an immutable representation of the ``wx.Point`` object, based on ``namedtuple``. 5001 5002 This new object is hashable and can be used as a dictionary key, 5003 be added to sets, etc. It can be converted back into a real ``wx.Point`` 5004 with a simple statement like this: ``obj = wx.Point(imObj)``. 5005 """ 5006 5007 def __str__(self): 5008 """ 5009 5010 """ 5011 5012 def __repr__(self): 5013 """ 5014 5015 """ 5016 5017 def __len__(self): 5018 """ 5019 5020 """ 5021 5022 def __reduce__(self): 5023 """ 5024 5025 """ 5026 5027 def __getitem__(self, idx): 5028 """ 5029 5030 """ 5031 5032 def __setitem__(self, idx, val): 5033 """ 5034 5035 """ 5036 5037 __safe_for_unpickling__ = True 5038 IM = property(None, None) 5039# end of class Point 5040 5041 5042class Size(object): 5043 """ 5044 Size() 5045 Size(width, height) 5046 5047 A wxSize is a useful data structure for graphics operations. 5048 """ 5049 5050 def __init__(self, *args, **kw): 5051 """ 5052 Size() 5053 Size(width, height) 5054 5055 A wxSize is a useful data structure for graphics operations. 5056 """ 5057 5058 def DecBy(self, *args, **kw): 5059 """ 5060 DecBy(pt) 5061 DecBy(size) 5062 DecBy(dx, dy) 5063 DecBy(d) 5064 5065 Decreases the size in both x and y directions. 5066 """ 5067 5068 def IncBy(self, *args, **kw): 5069 """ 5070 IncBy(pt) 5071 IncBy(size) 5072 IncBy(dx, dy) 5073 IncBy(d) 5074 5075 Increases the size in both x and y directions. 5076 """ 5077 5078 def __iadd__(self): 5079 """ 5080 """ 5081 5082 def __isub__(self): 5083 """ 5084 """ 5085 5086 def __idiv__(self): 5087 """ 5088 """ 5089 5090 def __imul__(self): 5091 """ 5092 """ 5093 5094 def DecTo(self, size): 5095 """ 5096 DecTo(size) 5097 5098 Decrements this object so that both of its dimensions are not greater 5099 than the corresponding dimensions of the size. 5100 """ 5101 5102 def DecToIfSpecified(self, size): 5103 """ 5104 DecToIfSpecified(size) 5105 5106 Decrements this object to be not bigger than the given size ignoring 5107 non-specified components. 5108 """ 5109 5110 def GetHeight(self): 5111 """ 5112 GetHeight() -> int 5113 5114 Gets the height member. 5115 """ 5116 5117 def GetWidth(self): 5118 """ 5119 GetWidth() -> int 5120 5121 Gets the width member. 5122 """ 5123 5124 def IncTo(self, size): 5125 """ 5126 IncTo(size) 5127 5128 Increments this object so that both of its dimensions are not less 5129 than the corresponding dimensions of the size. 5130 """ 5131 5132 def IsFullySpecified(self): 5133 """ 5134 IsFullySpecified() -> bool 5135 5136 Returns true if neither of the size object components is equal to -1, 5137 which is used as default for the size values in wxWidgets (hence the 5138 predefined wxDefaultSize has both of its components equal to -1). 5139 """ 5140 5141 def Scale(self, xscale, yscale): 5142 """ 5143 Scale(xscale, yscale) -> Size 5144 5145 Scales the dimensions of this object by the given factors. 5146 """ 5147 5148 def Set(self, width, height): 5149 """ 5150 Set(width, height) 5151 5152 Sets the width and height members. 5153 """ 5154 5155 def SetDefaults(self, sizeDefault): 5156 """ 5157 SetDefaults(sizeDefault) 5158 5159 Combine this size object with another one replacing the default (i.e. 5160 equal to -1) components of this object with those of the other. 5161 """ 5162 5163 def SetHeight(self, height): 5164 """ 5165 SetHeight(height) 5166 5167 Sets the height. 5168 """ 5169 5170 def SetWidth(self, width): 5171 """ 5172 SetWidth(width) 5173 5174 Sets the width. 5175 """ 5176 Height = property(None, None) 5177 Width = property(None, None) 5178 width = property(None, None) 5179 height = property(None, None) 5180 x = property(None, None) 5181 y = property(None, None) 5182 5183 def __eq__(self, other): 5184 """ 5185 __eq__(other) -> bool 5186 """ 5187 5188 def __ne__(self, other): 5189 """ 5190 __ne__(other) -> bool 5191 """ 5192 5193 def Get(self): 5194 """ 5195 Get() -> (width, height) 5196 5197 Return the width and height properties as a tuple. 5198 """ 5199 5200 def GetIM(self): 5201 """ 5202 Returns an immutable representation of the ``wx.Size`` object, based on ``namedtuple``. 5203 5204 This new object is hashable and can be used as a dictionary key, 5205 be added to sets, etc. It can be converted back into a real ``wx.Size`` 5206 with a simple statement like this: ``obj = wx.Size(imObj)``. 5207 """ 5208 5209 def __str__(self): 5210 """ 5211 5212 """ 5213 5214 def __repr__(self): 5215 """ 5216 5217 """ 5218 5219 def __len__(self): 5220 """ 5221 5222 """ 5223 5224 def __nonzero__(self): 5225 """ 5226 5227 """ 5228 5229 def __bool__(self): 5230 """ 5231 5232 """ 5233 5234 def __reduce__(self): 5235 """ 5236 5237 """ 5238 5239 def __getitem__(self, idx): 5240 """ 5241 5242 """ 5243 5244 def __setitem__(self, idx, val): 5245 """ 5246 5247 """ 5248 5249 __safe_for_unpickling__ = True 5250# end of class Size 5251 5252 5253class Rect(object): 5254 """ 5255 Rect() 5256 Rect(x, y, width, height) 5257 Rect(pos, size) 5258 Rect(size) 5259 Rect(topLeft, bottomRight) 5260 5261 A class for manipulating rectangles. 5262 """ 5263 5264 def __init__(self, *args, **kw): 5265 """ 5266 Rect() 5267 Rect(x, y, width, height) 5268 Rect(pos, size) 5269 Rect(size) 5270 Rect(topLeft, bottomRight) 5271 5272 A class for manipulating rectangles. 5273 """ 5274 5275 def CentreIn(self, r, dir=BOTH): 5276 """ 5277 CentreIn(r, dir=BOTH) -> Rect 5278 5279 Returns the rectangle having the same size as this one but centered 5280 relatively to the given rectangle r. 5281 """ 5282 5283 def CenterIn(self, r, dir=BOTH): 5284 """ 5285 CenterIn(r, dir=BOTH) -> Rect 5286 5287 Returns the rectangle having the same size as this one but centered 5288 relatively to the given rectangle r. 5289 """ 5290 5291 def Deflate(self, *args, **kw): 5292 """ 5293 Deflate(dx, dy) -> Rect 5294 Deflate(diff) -> Rect 5295 Deflate(diff) -> Rect 5296 5297 Decrease the rectangle size. 5298 """ 5299 5300 def Inflate(self, *args, **kw): 5301 """ 5302 Inflate(dx, dy) -> Rect 5303 Inflate(diff) -> Rect 5304 Inflate(diff) -> Rect 5305 5306 Increases the size of the rectangle. 5307 """ 5308 5309 def Offset(self, *args, **kw): 5310 """ 5311 Offset(dx, dy) 5312 Offset(pt) 5313 5314 Moves the rectangle by the specified offset. 5315 """ 5316 5317 def Union(self, rect): 5318 """ 5319 Union(rect) -> Rect 5320 5321 Modifies the rectangle to contain the bounding box of this rectangle 5322 and the one passed in as parameter. 5323 """ 5324 5325 def __iadd__(self): 5326 """ 5327 """ 5328 5329 def __imul__(self): 5330 """ 5331 """ 5332 height = property(None, None) 5333 width = property(None, None) 5334 x = property(None, None) 5335 y = property(None, None) 5336 5337 def Contains(self, *args, **kw): 5338 """ 5339 Contains(x, y) -> bool 5340 Contains(pt) -> bool 5341 Contains(rect) -> bool 5342 5343 Returns true if the given point is inside the rectangle (or on its 5344 boundary) and false otherwise. 5345 """ 5346 5347 def GetBottom(self): 5348 """ 5349 GetBottom() -> int 5350 5351 Gets the bottom point of the rectangle. 5352 """ 5353 5354 def GetBottomLeft(self): 5355 """ 5356 GetBottomLeft() -> Point 5357 5358 Gets the position of the bottom left corner. 5359 """ 5360 5361 def GetBottomRight(self): 5362 """ 5363 GetBottomRight() -> Point 5364 5365 Gets the position of the bottom right corner. 5366 """ 5367 5368 def GetHeight(self): 5369 """ 5370 GetHeight() -> int 5371 5372 Gets the height member. 5373 """ 5374 5375 def GetLeft(self): 5376 """ 5377 GetLeft() -> int 5378 5379 Gets the left point of the rectangle (the same as GetX()). 5380 """ 5381 5382 def GetPosition(self): 5383 """ 5384 GetPosition() -> Point 5385 5386 Gets the position. 5387 """ 5388 5389 def GetRight(self): 5390 """ 5391 GetRight() -> int 5392 5393 Gets the right point of the rectangle. 5394 """ 5395 5396 def GetSize(self): 5397 """ 5398 GetSize() -> Size 5399 5400 Gets the size. 5401 """ 5402 5403 def GetTop(self): 5404 """ 5405 GetTop() -> int 5406 5407 Gets the top point of the rectangle (the same as GetY()). 5408 """ 5409 5410 def GetTopLeft(self): 5411 """ 5412 GetTopLeft() -> Point 5413 5414 Gets the position of the top left corner of the rectangle, same as 5415 GetPosition(). 5416 """ 5417 5418 def GetTopRight(self): 5419 """ 5420 GetTopRight() -> Point 5421 5422 Gets the position of the top right corner. 5423 """ 5424 5425 def GetWidth(self): 5426 """ 5427 GetWidth() -> int 5428 5429 Gets the width member. 5430 """ 5431 5432 def GetX(self): 5433 """ 5434 GetX() -> int 5435 5436 Gets the x member. 5437 """ 5438 5439 def GetY(self): 5440 """ 5441 GetY() -> int 5442 5443 Gets the y member. 5444 """ 5445 5446 def Intersect(self, rect): 5447 """ 5448 Intersect(rect) -> Rect 5449 5450 Modifies this rectangle to contain the overlapping portion of this 5451 rectangle and the one passed in as parameter. 5452 """ 5453 5454 def Intersects(self, rect): 5455 """ 5456 Intersects(rect) -> bool 5457 5458 Returns true if this rectangle has a non-empty intersection with the 5459 rectangle rect and false otherwise. 5460 """ 5461 5462 def IsEmpty(self): 5463 """ 5464 IsEmpty() -> bool 5465 5466 Returns true if this rectangle has a width or height less than or 5467 equal to 0 and false otherwise. 5468 """ 5469 5470 def SetHeight(self, height): 5471 """ 5472 SetHeight(height) 5473 5474 Sets the height. 5475 """ 5476 5477 def SetPosition(self, pos): 5478 """ 5479 SetPosition(pos) 5480 5481 Sets the position. 5482 """ 5483 5484 def SetSize(self, s): 5485 """ 5486 SetSize(s) 5487 5488 Sets the size. 5489 """ 5490 5491 def SetWidth(self, width): 5492 """ 5493 SetWidth(width) 5494 5495 Sets the width. 5496 """ 5497 5498 def SetX(self, x): 5499 """ 5500 SetX(x) 5501 5502 Sets the x position. 5503 """ 5504 5505 def SetY(self, y): 5506 """ 5507 SetY(y) 5508 5509 Sets the y position. 5510 """ 5511 5512 def SetLeft(self, left): 5513 """ 5514 SetLeft(left) 5515 5516 Set the left side of the rectangle. 5517 """ 5518 5519 def SetRight(self, right): 5520 """ 5521 SetRight(right) 5522 5523 Set the right side of the rectangle. 5524 """ 5525 5526 def SetTop(self, top): 5527 """ 5528 SetTop(top) 5529 5530 Set the top edge of the rectangle. 5531 """ 5532 5533 def SetBottom(self, bottom): 5534 """ 5535 SetBottom(bottom) 5536 5537 Set the bottom edge of the rectangle. 5538 """ 5539 5540 def SetTopLeft(self, p): 5541 """ 5542 SetTopLeft(p) 5543 5544 Set the top-left point of the rectangle. 5545 """ 5546 5547 def SetBottomRight(self, p): 5548 """ 5549 SetBottomRight(p) 5550 5551 Set the bottom-right point of the rectangle. 5552 """ 5553 5554 def SetTopRight(self, p): 5555 """ 5556 SetTopRight(p) 5557 5558 Set the top-right point of the rectangle. 5559 """ 5560 5561 def SetBottomLeft(self, p): 5562 """ 5563 SetBottomLeft(p) 5564 5565 Set the bottom-left point of the rectangle. 5566 """ 5567 Bottom = property(None, None) 5568 BottomLeft = property(None, None) 5569 BottomRight = property(None, None) 5570 Height = property(None, None) 5571 Left = property(None, None) 5572 Position = property(None, None) 5573 Right = property(None, None) 5574 Size = property(None, None) 5575 Top = property(None, None) 5576 TopLeft = property(None, None) 5577 TopRight = property(None, None) 5578 Width = property(None, None) 5579 X = property(None, None) 5580 Y = property(None, None) 5581 left = property(None, None) 5582 top = property(None, None) 5583 right = property(None, None) 5584 bottom = property(None, None) 5585 bottomLeft = property(None, None) 5586 bottomRight = property(None, None) 5587 topLeft = property(None, None) 5588 topRight = property(None, None) 5589 5590 def __eq__(self, other): 5591 """ 5592 __eq__(other) -> bool 5593 """ 5594 5595 def __ne__(self, other): 5596 """ 5597 __ne__(other) -> bool 5598 """ 5599 5600 def Get(self): 5601 """ 5602 Get() -> (x, y, width, height) 5603 5604 Return the rectangle's properties as a tuple. 5605 """ 5606 5607 def GetIM(self): 5608 """ 5609 Returns an immutable representation of the ``wx.Rect`` object, based on ``namedtuple``. 5610 5611 This new object is hashable and can be used as a dictionary key, 5612 be added to sets, etc. It can be converted back into a real ``wx.Rect`` 5613 with a simple statement like this: ``obj = wx.Rect(imObj)``. 5614 """ 5615 5616 def __str__(self): 5617 """ 5618 5619 """ 5620 5621 def __repr__(self): 5622 """ 5623 5624 """ 5625 5626 def __len__(self): 5627 """ 5628 5629 """ 5630 5631 def __nonzero__(self): 5632 """ 5633 5634 """ 5635 5636 def __bool__(self): 5637 """ 5638 5639 """ 5640 5641 def __reduce__(self): 5642 """ 5643 5644 """ 5645 5646 def __getitem__(self, idx): 5647 """ 5648 5649 """ 5650 5651 def __setitem__(self, idx, val): 5652 """ 5653 5654 """ 5655 5656 __safe_for_unpickling__ = True 5657# end of class Rect 5658 5659 5660class RealPoint(object): 5661 """ 5662 RealPoint() 5663 RealPoint(x, y) 5664 RealPoint(pt) 5665 5666 A wxRealPoint is a useful data structure for graphics operations. 5667 """ 5668 5669 def __init__(self, *args, **kw): 5670 """ 5671 RealPoint() 5672 RealPoint(x, y) 5673 RealPoint(pt) 5674 5675 A wxRealPoint is a useful data structure for graphics operations. 5676 """ 5677 5678 def __iadd__(self, *args, **kw): 5679 """ 5680 """ 5681 5682 def __isub__(self, *args, **kw): 5683 """ 5684 """ 5685 x = property(None, None) 5686 y = property(None, None) 5687 5688 def __eq__(self, other): 5689 """ 5690 __eq__(other) -> bool 5691 """ 5692 5693 def __ne__(self, other): 5694 """ 5695 __ne__(other) -> bool 5696 """ 5697 5698 def __mul__(self, d): 5699 """ 5700 __mul__(d) -> RealPoint 5701 """ 5702 5703 def Get(self): 5704 """ 5705 Get() -> (x, y) 5706 5707 Return the point's properties as a tuple. 5708 """ 5709 5710 def GetIM(self): 5711 """ 5712 Returns an immutable representation of the ``wx.RealPoint`` object, based on ``namedtuple``. 5713 5714 This new object is hashable and can be used as a dictionary key, 5715 be added to sets, etc. It can be converted back into a real ``wx.RealPoint`` 5716 with a simple statement like this: ``obj = wx.RealPoint(imObj)``. 5717 """ 5718 5719 def __str__(self): 5720 """ 5721 5722 """ 5723 5724 def __repr__(self): 5725 """ 5726 5727 """ 5728 5729 def __len__(self): 5730 """ 5731 5732 """ 5733 5734 def __nonzero__(self): 5735 """ 5736 5737 """ 5738 5739 def __bool__(self): 5740 """ 5741 5742 """ 5743 5744 def __reduce__(self): 5745 """ 5746 5747 """ 5748 5749 def __getitem__(self, idx): 5750 """ 5751 5752 """ 5753 5754 def __setitem__(self, idx, val): 5755 """ 5756 5757 """ 5758 5759 __safe_for_unpickling__ = True 5760 IM = property(None, None) 5761# end of class RealPoint 5762 5763 5764class ColourDatabase(object): 5765 """ 5766 ColourDatabase() 5767 5768 wxWidgets maintains a database of standard RGB colours for a 5769 predefined set of named colours. 5770 """ 5771 5772 def __init__(self): 5773 """ 5774 ColourDatabase() 5775 5776 wxWidgets maintains a database of standard RGB colours for a 5777 predefined set of named colours. 5778 """ 5779 5780 def AddColour(self, colourName, colour): 5781 """ 5782 AddColour(colourName, colour) 5783 5784 Adds a colour to the database. 5785 """ 5786 5787 def Find(self, colourName): 5788 """ 5789 Find(colourName) -> Colour 5790 5791 Finds a colour given the name. 5792 """ 5793 5794 def FindName(self, colour): 5795 """ 5796 FindName(colour) -> String 5797 5798 Finds a colour name given the colour. 5799 """ 5800 5801 def FindColour(self, colour): 5802 """ 5803 5804 """ 5805# end of class ColourDatabase 5806 5807 5808def ColourDisplay(): 5809 """ 5810 ColourDisplay() -> bool 5811 5812 Returns true if the display is colour, false otherwise. 5813 """ 5814 5815def DisplayDepth(): 5816 """ 5817 DisplayDepth() -> int 5818 5819 Returns the depth of the display (a value of 1 denotes a monochrome 5820 display). 5821 """ 5822 5823def SetCursor(cursor): 5824 """ 5825 SetCursor(cursor) 5826 5827 Globally sets the cursor; only has an effect on Windows, Mac and GTK+. 5828 """ 5829 5830def ClientDisplayRect(): 5831 """ 5832 ClientDisplayRect() -> (x, y, width, height) 5833 5834 Returns the dimensions of the work area on the display. 5835 """ 5836 5837def GetClientDisplayRect(): 5838 """ 5839 GetClientDisplayRect() -> Rect 5840 5841 Returns the dimensions of the work area on the display. 5842 """ 5843 5844def GetDisplayPPI(): 5845 """ 5846 GetDisplayPPI() -> Size 5847 5848 Returns the display resolution in pixels per inch. 5849 """ 5850 5851def DisplaySize(): 5852 """ 5853 DisplaySize() -> (width, height) 5854 5855 Returns the display size in pixels. 5856 """ 5857 5858def GetDisplaySize(): 5859 """ 5860 GetDisplaySize() -> Size 5861 5862 Returns the display size in pixels. 5863 """ 5864 5865def DisplaySizeMM(): 5866 """ 5867 DisplaySizeMM() -> (width, height) 5868 5869 Returns the display size in millimeters. 5870 """ 5871 5872def GetDisplaySizeMM(): 5873 """ 5874 GetDisplaySizeMM() -> Size 5875 5876 Returns the display size in millimeters. 5877 """ 5878DefaultPosition = Point() 5879DefaultSize = Size() 5880 5881from collections import namedtuple 5882_im_Point = namedtuple('_im_Point', ['x', 'y']) 5883del namedtuple 5884 5885from collections import namedtuple 5886_im_Size = namedtuple('_im_Size', ['width', 'height']) 5887del namedtuple 5888 5889from collections import namedtuple 5890_im_Rect = namedtuple('_im_Rect', ['x', 'y', 'width', 'height']) 5891del namedtuple 5892 5893from collections import namedtuple 5894_im_RealPoint = namedtuple('_im_RealPoint', ['x', 'y']) 5895del namedtuple 5896 5897def IntersectRect(self, r1, r2): 5898 """ 5899 IntersectRect(r1, r2) -> PyObject 5900 5901 Calculate and return the intersection of r1 and r2. Returns None if 5902 there 5903 is no intersection. 5904 """ 5905#-- end-gdicmn --# 5906#-- begin-geometry --# 5907Inside = 0 5908OutLeft = 0 5909OutRight = 0 5910OutTop = 0 5911OutBottom = 0 5912 5913class Point2D(object): 5914 """ 5915 Point2DDouble() 5916 Point2DDouble(x, y) 5917 Point2DDouble(pt) 5918 Point2DDouble(pt) 5919 """ 5920 5921 def __init__(self, *args, **kw): 5922 """ 5923 Point2DDouble() 5924 Point2DDouble(x, y) 5925 Point2DDouble(pt) 5926 Point2DDouble(pt) 5927 """ 5928 m_x = property(None, None) 5929 m_y = property(None, None) 5930 5931 def GetFloor(self): 5932 """ 5933 GetFloor() -> (x, y) 5934 """ 5935 5936 def GetRounded(self): 5937 """ 5938 GetRounded() -> (x, y) 5939 """ 5940 5941 def GetVectorLength(self): 5942 """ 5943 GetVectorLength() -> Double 5944 """ 5945 5946 def GetVectorAngle(self): 5947 """ 5948 GetVectorAngle() -> Double 5949 """ 5950 5951 def SetVectorLength(self, length): 5952 """ 5953 SetVectorLength(length) 5954 """ 5955 5956 def SetVectorAngle(self, degrees): 5957 """ 5958 SetVectorAngle(degrees) 5959 """ 5960 5961 def Normalize(self): 5962 """ 5963 Normalize() 5964 """ 5965 5966 def GetDistance(self, pt): 5967 """ 5968 GetDistance(pt) -> Double 5969 """ 5970 5971 def GetDistanceSquare(self, pt): 5972 """ 5973 GetDistanceSquare(pt) -> Double 5974 """ 5975 5976 def GetDotProduct(self, vec): 5977 """ 5978 GetDotProduct(vec) -> Double 5979 """ 5980 5981 def GetCrossProduct(self, vec): 5982 """ 5983 GetCrossProduct(vec) -> Double 5984 """ 5985 5986 def __sub__(self): 5987 """ 5988 """ 5989 5990 def __iadd__(self): 5991 """ 5992 """ 5993 5994 def __isub__(self): 5995 """ 5996 """ 5997 5998 def __imul__(self): 5999 """ 6000 """ 6001 6002 def __idiv__(self): 6003 """ 6004 """ 6005 6006 def __eq__(self): 6007 """ 6008 """ 6009 6010 def __ne__(self): 6011 """ 6012 """ 6013 6014 def Get(self): 6015 """ 6016 Get() -> PyObject 6017 6018 Get() -> (x,y) 6019 6020 Return the x and y properties as a tuple. 6021 """ 6022 6023 def GetIM(self): 6024 """ 6025 Returns an immutable representation of the ``wx.Point2D`` object, based on ``namedtuple``. 6026 6027 This new object is hashable and can be used as a dictionary key, 6028 be added to sets, etc. It can be converted back into a real ``wx.Point2D`` 6029 with a simple statement like this: ``obj = wx.Point2D(imObj)``. 6030 """ 6031 6032 def __str__(self): 6033 """ 6034 6035 """ 6036 6037 def __repr__(self): 6038 """ 6039 6040 """ 6041 6042 def __len__(self): 6043 """ 6044 6045 """ 6046 6047 def __nonzero__(self): 6048 """ 6049 6050 """ 6051 6052 def __bool__(self): 6053 """ 6054 6055 """ 6056 6057 def __reduce__(self): 6058 """ 6059 6060 """ 6061 6062 def __getitem__(self, idx): 6063 """ 6064 6065 """ 6066 6067 def __setitem__(self, idx, val): 6068 """ 6069 6070 """ 6071 6072 __safe_for_unpickling__ = True 6073 IM = property(None, None) 6074 VectorAngle = property(None, None) 6075 VectorLength = property(None, None) 6076# end of class Point2D 6077 6078 6079class Rect2D(object): 6080 """ 6081 Rect2DDouble() 6082 Rect2DDouble(x, y, w, h) 6083 """ 6084 6085 def __init__(self, *args, **kw): 6086 """ 6087 Rect2DDouble() 6088 Rect2DDouble(x, y, w, h) 6089 """ 6090 m_x = property(None, None) 6091 m_y = property(None, None) 6092 m_width = property(None, None) 6093 m_height = property(None, None) 6094 6095 def GetPosition(self): 6096 """ 6097 GetPosition() -> Point2DDouble 6098 """ 6099 6100 def GetSize(self): 6101 """ 6102 GetSize() -> Size 6103 """ 6104 6105 def GetLeft(self): 6106 """ 6107 GetLeft() -> Double 6108 """ 6109 6110 def SetLeft(self, n): 6111 """ 6112 SetLeft(n) 6113 """ 6114 6115 def MoveLeftTo(self, n): 6116 """ 6117 MoveLeftTo(n) 6118 """ 6119 6120 def GetTop(self): 6121 """ 6122 GetTop() -> Double 6123 """ 6124 6125 def SetTop(self, n): 6126 """ 6127 SetTop(n) 6128 """ 6129 6130 def MoveTopTo(self, n): 6131 """ 6132 MoveTopTo(n) 6133 """ 6134 6135 def GetBottom(self): 6136 """ 6137 GetBottom() -> Double 6138 """ 6139 6140 def SetBottom(self, n): 6141 """ 6142 SetBottom(n) 6143 """ 6144 6145 def MoveBottomTo(self, n): 6146 """ 6147 MoveBottomTo(n) 6148 """ 6149 6150 def GetRight(self): 6151 """ 6152 GetRight() -> Double 6153 """ 6154 6155 def SetRight(self, n): 6156 """ 6157 SetRight(n) 6158 """ 6159 6160 def MoveRightTo(self, n): 6161 """ 6162 MoveRightTo(n) 6163 """ 6164 6165 def GetLeftTop(self): 6166 """ 6167 GetLeftTop() -> Point2DDouble 6168 """ 6169 6170 def SetLeftTop(self, pt): 6171 """ 6172 SetLeftTop(pt) 6173 """ 6174 6175 def MoveLeftTopTo(self, pt): 6176 """ 6177 MoveLeftTopTo(pt) 6178 """ 6179 6180 def GetLeftBottom(self): 6181 """ 6182 GetLeftBottom() -> Point2DDouble 6183 """ 6184 6185 def SetLeftBottom(self, pt): 6186 """ 6187 SetLeftBottom(pt) 6188 """ 6189 6190 def MoveLeftBottomTo(self, pt): 6191 """ 6192 MoveLeftBottomTo(pt) 6193 """ 6194 6195 def GetRightTop(self): 6196 """ 6197 GetRightTop() -> Point2DDouble 6198 """ 6199 6200 def SetRightTop(self, pt): 6201 """ 6202 SetRightTop(pt) 6203 """ 6204 6205 def MoveRightTopTo(self, pt): 6206 """ 6207 MoveRightTopTo(pt) 6208 """ 6209 6210 def GetRightBottom(self): 6211 """ 6212 GetRightBottom() -> Point2DDouble 6213 """ 6214 6215 def SetRightBottom(self, pt): 6216 """ 6217 SetRightBottom(pt) 6218 """ 6219 6220 def MoveRightBottomTo(self, pt): 6221 """ 6222 MoveRightBottomTo(pt) 6223 """ 6224 6225 def GetCentre(self): 6226 """ 6227 GetCentre() -> Point2DDouble 6228 """ 6229 6230 def SetCentre(self, pt): 6231 """ 6232 SetCentre(pt) 6233 """ 6234 6235 def MoveCentreTo(self, pt): 6236 """ 6237 MoveCentreTo(pt) 6238 """ 6239 6240 def GetOutCode(self, pt): 6241 """ 6242 GetOutCode(pt) -> OutCode 6243 """ 6244 6245 def GetOutcode(self, pt): 6246 """ 6247 GetOutcode(pt) -> OutCode 6248 """ 6249 6250 def Contains(self, *args, **kw): 6251 """ 6252 Contains(pt) -> bool 6253 Contains(rect) -> bool 6254 """ 6255 6256 def IsEmpty(self): 6257 """ 6258 IsEmpty() -> bool 6259 """ 6260 6261 def HaveEqualSize(self, rect): 6262 """ 6263 HaveEqualSize(rect) -> bool 6264 """ 6265 6266 def Inset(self, *args, **kw): 6267 """ 6268 Inset(x, y) 6269 Inset(left, top, right, bottom) 6270 """ 6271 6272 def Offset(self, pt): 6273 """ 6274 Offset(pt) 6275 """ 6276 6277 def ConstrainTo(self, rect): 6278 """ 6279 ConstrainTo(rect) 6280 """ 6281 6282 def Interpolate(self, widthfactor, heightfactor): 6283 """ 6284 Interpolate(widthfactor, heightfactor) -> Point2DDouble 6285 """ 6286 6287 def Intersect(self, *args, **kw): 6288 """ 6289 Intersect(otherRect) 6290 Intersect(src1, src2, dest) 6291 """ 6292 6293 def CreateIntersection(self, otherRect): 6294 """ 6295 CreateIntersection(otherRect) -> Rect2DDouble 6296 """ 6297 6298 def Intersects(self, rect): 6299 """ 6300 Intersects(rect) -> bool 6301 """ 6302 6303 def Union(self, *args, **kw): 6304 """ 6305 Union(otherRect) 6306 Union(pt) 6307 Union(src1, src2, dest) 6308 """ 6309 6310 def CreateUnion(self, otherRect): 6311 """ 6312 CreateUnion(otherRect) -> Rect2DDouble 6313 """ 6314 6315 def Scale(self, *args, **kw): 6316 """ 6317 Scale(f) 6318 Scale(num, denum) 6319 """ 6320 6321 def __eq__(self): 6322 """ 6323 """ 6324 6325 def __ne__(self): 6326 """ 6327 """ 6328 6329 def Get(self): 6330 """ 6331 Get() -> PyObject 6332 6333 Get() -> (x, y, width, height) 6334 6335 Return the rectangle's properties as a tuple. 6336 """ 6337 6338 def GetIM(self): 6339 """ 6340 Returns an immutable representation of the ``wx.Rect2D`` object, based on ``namedtuple``. 6341 6342 This new object is hashable and can be used as a dictionary key, 6343 be added to sets, etc. It can be converted back into a real ``wx.Rect2D`` 6344 with a simple statement like this: ``obj = wx.Rect2D(imObj)``. 6345 """ 6346 6347 def __str__(self): 6348 """ 6349 6350 """ 6351 6352 def __repr__(self): 6353 """ 6354 6355 """ 6356 6357 def __len__(self): 6358 """ 6359 6360 """ 6361 6362 def __nonzero__(self): 6363 """ 6364 6365 """ 6366 6367 def __bool__(self): 6368 """ 6369 6370 """ 6371 6372 def __reduce__(self): 6373 """ 6374 6375 """ 6376 6377 def __getitem__(self, idx): 6378 """ 6379 6380 """ 6381 6382 def __setitem__(self, idx, val): 6383 """ 6384 6385 """ 6386 6387 __safe_for_unpickling__ = True 6388 Bottom = property(None, None) 6389 Centre = property(None, None) 6390 IM = property(None, None) 6391 Left = property(None, None) 6392 LeftBottom = property(None, None) 6393 LeftTop = property(None, None) 6394 Position = property(None, None) 6395 Right = property(None, None) 6396 RightBottom = property(None, None) 6397 RightTop = property(None, None) 6398 Size = property(None, None) 6399 Top = property(None, None) 6400# end of class Rect2D 6401 6402 6403from collections import namedtuple 6404_im_Point2D = namedtuple('_im_Point2D', ['x', 'y']) 6405del namedtuple 6406 6407from collections import namedtuple 6408_im_Rect2D = namedtuple('_im_Rect2D', ['x', 'y', 'width', 'height']) 6409del namedtuple 6410#-- end-geometry --# 6411#-- begin-affinematrix2d --# 6412 6413class Matrix2D(object): 6414 """ 6415 Matrix2D(v11=1, v12=0, v21=0, v22=1) 6416 6417 A simple container for 2x2 matrix. 6418 """ 6419 6420 def __init__(self, v11=1, v12=0, v21=0, v22=1): 6421 """ 6422 Matrix2D(v11=1, v12=0, v21=0, v22=1) 6423 6424 A simple container for 2x2 matrix. 6425 """ 6426 m_11 = property(None, None) 6427 m_12 = property(None, None) 6428 m_21 = property(None, None) 6429 m_22 = property(None, None) 6430# end of class Matrix2D 6431 6432 6433class AffineMatrix2DBase(object): 6434 """ 6435 AffineMatrix2DBase() 6436 6437 A 2x3 matrix representing an affine 2D transformation. 6438 """ 6439 6440 def __init__(self): 6441 """ 6442 AffineMatrix2DBase() 6443 6444 A 2x3 matrix representing an affine 2D transformation. 6445 """ 6446 6447 def IsEqual(self, t): 6448 """ 6449 IsEqual(t) -> bool 6450 6451 Check that this matrix is identical with t. 6452 """ 6453 6454 def __eq__(self): 6455 """ 6456 """ 6457 6458 def Set(self, mat2D, tr): 6459 """ 6460 Set(mat2D, tr) 6461 6462 Set all elements of this matrix. 6463 """ 6464 6465 def Get(self): 6466 """ 6467 Get() -> (mat2D, tr) 6468 6469 Get the component values of the matrix. 6470 """ 6471 6472 def Concat(self, t): 6473 """ 6474 Concat(t) 6475 6476 Concatenate this matrix with another one. 6477 """ 6478 6479 def Invert(self): 6480 """ 6481 Invert() -> bool 6482 6483 Invert this matrix. 6484 """ 6485 6486 def IsIdentity(self): 6487 """ 6488 IsIdentity() -> bool 6489 6490 Check if this is the identity matrix. 6491 """ 6492 6493 def __ne__(self): 6494 """ 6495 """ 6496 6497 def Translate(self, dx, dy): 6498 """ 6499 Translate(dx, dy) 6500 6501 Add the translation to this matrix. 6502 """ 6503 6504 def Scale(self, xScale, yScale): 6505 """ 6506 Scale(xScale, yScale) 6507 6508 Add scaling to this matrix. 6509 """ 6510 6511 def Rotate(self, cRadians): 6512 """ 6513 Rotate(cRadians) 6514 6515 Add clockwise rotation to this matrix. 6516 """ 6517 6518 def Mirror(self, direction=HORIZONTAL): 6519 """ 6520 Mirror(direction=HORIZONTAL) 6521 6522 Add mirroring to this matrix. 6523 """ 6524 6525 def TransformPoint(self, *args, **kw): 6526 """ 6527 TransformPoint(p) -> Point2DDouble 6528 TransformPoint(x, y) -> (x, y) 6529 6530 Applies this matrix to the point. 6531 """ 6532 6533 def TransformDistance(self, *args, **kw): 6534 """ 6535 TransformDistance(p) -> Point2DDouble 6536 TransformDistance(dx, dy) -> (dx, dy) 6537 6538 Applies the linear part of this matrix, i.e. without translation. 6539 """ 6540# end of class AffineMatrix2DBase 6541 6542 6543class AffineMatrix2D(AffineMatrix2DBase): 6544 """ 6545 AffineMatrix2D() 6546 6547 A 3x2 matrix representing an affine 2D transformation. 6548 """ 6549 6550 def __init__(self): 6551 """ 6552 AffineMatrix2D() 6553 6554 A 3x2 matrix representing an affine 2D transformation. 6555 """ 6556 6557 def IsEqual(self, t): 6558 """ 6559 IsEqual(t) 6560 6561 Check that this matrix is identical with t. 6562 """ 6563 6564 def __eq__(self): 6565 """ 6566 """ 6567 6568 def Get(self): 6569 """ 6570 Get() -> (mat2D, tr) 6571 6572 Get the component values of the matrix. 6573 """ 6574 6575 def Set(self, mat2D, tr): 6576 """ 6577 Set(mat2D, tr) 6578 6579 Set all elements of this matrix. 6580 """ 6581 6582 def Concat(self, t): 6583 """ 6584 Concat(t) 6585 6586 Concatenate this matrix with another one. 6587 """ 6588 6589 def Invert(self): 6590 """ 6591 Invert() -> bool 6592 6593 Invert this matrix. 6594 """ 6595 6596 def IsIdentity(self): 6597 """ 6598 IsIdentity() -> bool 6599 6600 Check if this is the identity matrix. 6601 """ 6602 6603 def __ne__(self): 6604 """ 6605 """ 6606 6607 def Translate(self, dx, dy): 6608 """ 6609 Translate(dx, dy) 6610 6611 Add the translation to this matrix. 6612 """ 6613 6614 def Scale(self, xScale, yScale): 6615 """ 6616 Scale(xScale, yScale) 6617 6618 Add scaling to this matrix. 6619 """ 6620 6621 def Mirror(self, direction=HORIZONTAL): 6622 """ 6623 Mirror(direction=HORIZONTAL) 6624 6625 Add mirroring to this matrix. 6626 """ 6627 6628 def Rotate(self, cRadians): 6629 """ 6630 Rotate(cRadians) 6631 6632 Add clockwise rotation to this matrix. 6633 """ 6634 6635 def TransformPoint(self, *args, **kw): 6636 """ 6637 TransformPoint(p) -> Point2DDouble 6638 TransformPoint(x, y) -> (x, y) 6639 6640 Applies this matrix to the point. 6641 """ 6642 6643 def TransformDistance(self, *args, **kw): 6644 """ 6645 TransformDistance(p) -> Point2DDouble 6646 TransformDistance(dx, dy) -> (dx, dy) 6647 6648 Applies the linear part of this matrix, i.e. without translation. 6649 """ 6650# end of class AffineMatrix2D 6651 6652#-- end-affinematrix2d --# 6653#-- begin-position --# 6654 6655class Position(object): 6656 """ 6657 Position() 6658 Position(row, col) 6659 6660 This class represents the position of an item in any kind of grid of 6661 rows and columns such as wxGridBagSizer, or wxHVScrolledWindow. 6662 """ 6663 6664 def __init__(self, *args, **kw): 6665 """ 6666 Position() 6667 Position(row, col) 6668 6669 This class represents the position of an item in any kind of grid of 6670 rows and columns such as wxGridBagSizer, or wxHVScrolledWindow. 6671 """ 6672 6673 def __eq__(self): 6674 """ 6675 """ 6676 6677 def __ne__(self): 6678 """ 6679 """ 6680 6681 def __iadd__(self, *args, **kw): 6682 """ 6683 """ 6684 6685 def __isub__(self, *args, **kw): 6686 """ 6687 """ 6688 6689 def __add__(self, *args, **kw): 6690 """ 6691 """ 6692 6693 def __sub__(self, *args, **kw): 6694 """ 6695 """ 6696 6697 def GetCol(self): 6698 """ 6699 GetCol() -> int 6700 6701 A synonym for GetColumn(). 6702 """ 6703 6704 def GetColumn(self): 6705 """ 6706 GetColumn() -> int 6707 6708 Get the current row value. 6709 """ 6710 6711 def GetRow(self): 6712 """ 6713 GetRow() -> int 6714 6715 Get the current row value. 6716 """ 6717 6718 def SetCol(self, column): 6719 """ 6720 SetCol(column) 6721 6722 A synonym for SetColumn(). 6723 """ 6724 6725 def SetColumn(self, column): 6726 """ 6727 SetColumn(column) 6728 6729 Set a new column value. 6730 """ 6731 6732 def SetRow(self, row): 6733 """ 6734 SetRow(row) 6735 6736 Set a new row value. 6737 """ 6738 6739 def Get(self): 6740 """ 6741 Get() -> (row,col) 6742 6743 Return the row and col properties as a tuple. 6744 """ 6745 6746 def GetIM(self): 6747 """ 6748 Returns an immutable representation of the ``wx.Position`` object, based on ``namedtuple``. 6749 6750 This new object is hashable and can be used as a dictionary key, 6751 be added to sets, etc. It can be converted back into a real ``wx.Position`` 6752 with a simple statement like this: ``obj = wx.Position(imObj)``. 6753 """ 6754 6755 def __str__(self): 6756 """ 6757 6758 """ 6759 6760 def __repr__(self): 6761 """ 6762 6763 """ 6764 6765 def __len__(self): 6766 """ 6767 6768 """ 6769 6770 def __nonzero__(self): 6771 """ 6772 6773 """ 6774 6775 def __bool__(self): 6776 """ 6777 6778 """ 6779 6780 def __reduce__(self): 6781 """ 6782 6783 """ 6784 6785 def __getitem__(self, idx): 6786 """ 6787 6788 """ 6789 6790 def __setitem__(self, idx, val): 6791 """ 6792 6793 """ 6794 6795 __safe_for_unpickling__ = True 6796 Col = property(None, None) 6797 Column = property(None, None) 6798 IM = property(None, None) 6799 Row = property(None, None) 6800# end of class Position 6801 6802 6803from collections import namedtuple 6804_im_Position = namedtuple('_im_Position', ['Row', 'Col']) 6805del namedtuple 6806#-- end-position --# 6807#-- begin-colour --# 6808C2S_NAME = 0 6809C2S_CSS_SYNTAX = 0 6810C2S_HTML_SYNTAX = 0 6811ALPHA_TRANSPARENT = 0 6812ALPHA_OPAQUE = 0 6813 6814class Colour(Object): 6815 """ 6816 Colour() 6817 Colour(red, green, blue, alpha=ALPHA_OPAQUE) 6818 Colour(colRGB) 6819 Colour(colour) 6820 6821 A colour is an object representing a combination of Red, Green, and 6822 Blue (RGB) intensity values, and is used to determine drawing colours. 6823 """ 6824 6825 def __init__(self, *args, **kw): 6826 """ 6827 Colour() 6828 Colour(red, green, blue, alpha=ALPHA_OPAQUE) 6829 Colour(colRGB) 6830 Colour(colour) 6831 6832 A colour is an object representing a combination of Red, Green, and 6833 Blue (RGB) intensity values, and is used to determine drawing colours. 6834 """ 6835 6836 def SetRGB(self, colRGB): 6837 """ 6838 SetRGB(colRGB) 6839 6840 Sets the RGB or RGBA colour values from a single 32 bit value. 6841 """ 6842 6843 def SetRGBA(self, colRGBA): 6844 """ 6845 SetRGBA(colRGBA) 6846 6847 Sets the RGB or RGBA colour values from a single 32 bit value. 6848 """ 6849 6850 def GetRGB(self): 6851 """ 6852 GetRGB() -> Uint32 6853 6854 Gets the RGB or RGBA colour values as a single 32 bit value. 6855 """ 6856 6857 def GetRGBA(self): 6858 """ 6859 GetRGBA() -> Uint32 6860 6861 Gets the RGB or RGBA colour values as a single 32 bit value. 6862 """ 6863 6864 def Set(self, *args, **kw): 6865 """ 6866 Set(red, green, blue, alpha=ALPHA_OPAQUE) 6867 Set(RGB) 6868 Set(str) -> bool 6869 6870 Sets the RGB intensity values using the given values (first overload), 6871 extracting them from the packed long (second overload), using the 6872 given string (third overload). 6873 """ 6874 6875 def Alpha(self): 6876 """ 6877 Alpha() -> unsignedchar 6878 6879 Returns the alpha value, on platforms where alpha is not yet 6880 supported, this always returns wxALPHA_OPAQUE. 6881 """ 6882 6883 def Blue(self): 6884 """ 6885 Blue() -> unsignedchar 6886 6887 Returns the blue intensity. 6888 """ 6889 6890 def GetAsString(self, flags=C2S_NAME|C2S_CSS_SYNTAX): 6891 """ 6892 GetAsString(flags=C2S_NAME|C2S_CSS_SYNTAX) -> String 6893 6894 Converts this colour to a wxString using the given flags. 6895 """ 6896 6897 def GetPixel(self): 6898 """ 6899 GetPixel() -> IntPtr 6900 """ 6901 6902 def Green(self): 6903 """ 6904 Green() -> unsignedchar 6905 6906 Returns the green intensity. 6907 """ 6908 6909 def IsOk(self): 6910 """ 6911 IsOk() -> bool 6912 6913 Returns true if the colour object is valid (the colour has been 6914 initialised with RGB values). 6915 """ 6916 6917 def Red(self): 6918 """ 6919 Red() -> unsignedchar 6920 6921 Returns the red intensity. 6922 """ 6923 6924 def __ne__(self): 6925 """ 6926 """ 6927 6928 def __eq__(self): 6929 """ 6930 """ 6931 6932 def MakeDisabled(self, *args, **kw): 6933 """ 6934 MakeDisabled(brightness=255) -> Colour 6935 MakeDisabled(r, g, b, brightness=255) -> (r, g, b) 6936 6937 Make a disabled version of this colour. 6938 """ 6939 6940 def ChangeLightness(self, *args, **kw): 6941 """ 6942 ChangeLightness(ialpha) -> Colour 6943 ChangeLightness(r, g, b, ialpha) -> (r, g, b) 6944 6945 wxColour wrapper for ChangeLightness(r,g,b,ialpha). 6946 """ 6947 6948 @staticmethod 6949 def MakeMono(on): 6950 """ 6951 MakeMono(on) -> (r, g, b) 6952 6953 Assign 0 or 255 to rgb out parameters. 6954 """ 6955 6956 @staticmethod 6957 def MakeGrey(*args, **kw): 6958 """ 6959 MakeGrey(r, g, b) -> (r, g, b) 6960 MakeGrey(r, g, b, weight_r, weight_g, weight_b) -> (r, g, b) 6961 6962 Create a grey colour from (in/out) rgb parameters using integer 6963 arithmetic. 6964 """ 6965 6966 @staticmethod 6967 def AlphaBlend(fg, bg, alpha): 6968 """ 6969 AlphaBlend(fg, bg, alpha) -> unsignedchar 6970 6971 Blend colour, taking alpha into account. 6972 """ 6973 Pixel = property(None, None) 6974 RGB = property(None, None) 6975 RGBA = property(None, None) 6976 red = property(None, None) 6977 green = property(None, None) 6978 blue = property(None, None) 6979 alpha = property(None, None) 6980 6981 def _copyFrom(self, other): 6982 """ 6983 _copyFrom(other) 6984 6985 For internal use only. 6986 """ 6987 6988 def Get(self, includeAlpha=True): 6989 """ 6990 Get(includeAlpha=True) -> (r,g,b) or (r,g,b,a) 6991 6992 Returns the RGB intensity values as a tuple, optionally the alpha 6993 value as well. 6994 """ 6995 6996 def GetIM(self): 6997 """ 6998 Returns an immutable representation of the ``wx.Colour`` object, based on ``namedtuple``. 6999 7000 This new object is hashable and can be used as a dictionary key, 7001 be added to sets, etc. It can be converted back into a real ``wx.Colour`` 7002 with a simple statement like this: ``obj = wx.Colour(imObj)``. 7003 """ 7004 7005 def __str__(self): 7006 """ 7007 7008 """ 7009 7010 def __repr__(self): 7011 """ 7012 7013 """ 7014 7015 def __len__(self): 7016 """ 7017 7018 """ 7019 7020 def __reduce__(self): 7021 """ 7022 7023 """ 7024 7025 def __getitem__(self, idx): 7026 """ 7027 7028 """ 7029 7030 def __setitem__(self, idx, val): 7031 """ 7032 7033 """ 7034 7035 __safe_for_unpickling__ = True 7036 7037 def __nonzero__(self): 7038 """ 7039 __nonzero__() -> int 7040 """ 7041 7042 def __bool__(self): 7043 """ 7044 __bool__() -> int 7045 """ 7046# end of class Colour 7047 7048NullColour = Colour() 7049TransparentColour = Colour() 7050 7051def MacThemeColour(self, themeBrushID): 7052 """ 7053 MacThemeColour(themeBrushID) -> Colour 7054 """ 7055 7056# These stock colours will be initialized when the wx.App object is created. 7057BLACK = Colour() 7058BLUE = Colour() 7059CYAN = Colour() 7060GREEN = Colour() 7061YELLOW = Colour() 7062LIGHT_GREY = Colour() 7063RED = Colour() 7064WHITE = Colour() 7065 7066from collections import namedtuple 7067_im_Colour = namedtuple('_im_Colour', ['red', 'green', 'blue', 'alpha']) 7068del namedtuple 7069 7070NamedColour = wx.deprecated(Colour, "Use Colour instead.") 7071#-- end-colour --# 7072#-- begin-stream --# 7073STREAM_NO_ERROR = 0 7074STREAM_EOF = 0 7075STREAM_WRITE_ERROR = 0 7076STREAM_READ_ERROR = 0 7077FromStart = 0 7078FromCurrent = 0 7079FromEnd = 0 7080 7081class StreamBase(object): 7082 """ 7083 StreamBase() 7084 7085 This class is the base class of most stream related classes in 7086 wxWidgets. 7087 """ 7088 7089 def __init__(self): 7090 """ 7091 StreamBase() 7092 7093 This class is the base class of most stream related classes in 7094 wxWidgets. 7095 """ 7096 7097 def GetLastError(self): 7098 """ 7099 GetLastError() -> StreamError 7100 7101 This function returns the last error. 7102 """ 7103 7104 def GetLength(self): 7105 """ 7106 GetLength() -> FileOffset 7107 7108 Returns the length of the stream in bytes. 7109 """ 7110 7111 def GetSize(self): 7112 """ 7113 GetSize() -> size_t 7114 7115 This function returns the size of the stream. 7116 """ 7117 7118 def IsOk(self): 7119 """ 7120 IsOk() -> bool 7121 7122 Returns true if no error occurred on the stream. 7123 """ 7124 7125 def IsSeekable(self): 7126 """ 7127 IsSeekable() -> bool 7128 7129 Returns true if the stream supports seeking to arbitrary offsets. 7130 """ 7131 7132 def Reset(self, error=STREAM_NO_ERROR): 7133 """ 7134 Reset(error=STREAM_NO_ERROR) 7135 7136 Resets the stream state. 7137 """ 7138 LastError = property(None, None) 7139 Length = property(None, None) 7140 Size = property(None, None) 7141# end of class StreamBase 7142 7143 7144class InputStream(StreamBase): 7145 """ 7146 InputStream() 7147 7148 wxInputStream is an abstract base class which may not be used 7149 directly. 7150 """ 7151 7152 def __init__(self): 7153 """ 7154 InputStream() 7155 7156 wxInputStream is an abstract base class which may not be used 7157 directly. 7158 """ 7159 7160 def CanRead(self): 7161 """ 7162 CanRead() -> bool 7163 7164 Returns true if some data is available in the stream right now, so 7165 that calling Read() wouldn't block. 7166 """ 7167 7168 def Eof(self): 7169 """ 7170 Eof() -> bool 7171 7172 Returns true after an attempt has been made to read past the end of 7173 the stream. 7174 """ 7175 7176 def GetC(self): 7177 """ 7178 GetC() -> int 7179 7180 Returns the first character in the input queue and removes it, 7181 blocking until it appears if necessary. 7182 """ 7183 7184 def LastRead(self): 7185 """ 7186 LastRead() -> size_t 7187 7188 Returns the last number of bytes read. 7189 """ 7190 7191 def Peek(self): 7192 """ 7193 Peek() -> char 7194 7195 Returns the first character in the input queue without removing it. 7196 """ 7197 7198 def Read(self, *args, **kw): 7199 """ 7200 Read(buffer, size) -> InputStream 7201 Read(stream_out) -> InputStream 7202 7203 Reads the specified amount of bytes and stores the data in buffer. 7204 """ 7205 7206 def ReadAll(self, buffer, size): 7207 """ 7208 ReadAll(buffer, size) -> bool 7209 7210 Reads exactly the specified number of bytes into the buffer. 7211 """ 7212 7213 def SeekI(self, pos, mode=FromStart): 7214 """ 7215 SeekI(pos, mode=FromStart) -> FileOffset 7216 7217 Changes the stream current position. 7218 """ 7219 7220 def TellI(self): 7221 """ 7222 TellI() -> FileOffset 7223 7224 Returns the current stream position or wxInvalidOffset if it's not 7225 available (e.g. 7226 """ 7227 7228 def Ungetch(self, *args, **kw): 7229 """ 7230 Ungetch(buffer, size) -> size_t 7231 Ungetch(c) -> bool 7232 7233 This function is only useful in read mode. 7234 """ 7235 7236 def seek(self, offset, whence=0): 7237 """ 7238 seek(offset, whence=0) 7239 """ 7240 7241 def tell(self): 7242 """ 7243 tell() -> FileOffset 7244 """ 7245 7246 def close(self): 7247 """ 7248 close() 7249 """ 7250 7251 def flush(self): 7252 """ 7253 flush() 7254 """ 7255 7256 def eof(self): 7257 """ 7258 eof() -> bool 7259 """ 7260 7261 def read(self, *args, **kw): 7262 """ 7263 read() -> PyObject 7264 read(size) -> PyObject 7265 """ 7266 7267 def readline(self, *args, **kw): 7268 """ 7269 readline() -> PyObject 7270 readline(size) -> PyObject 7271 """ 7272 7273 def readlines(self, *args, **kw): 7274 """ 7275 readlines() -> PyObject 7276 readlines(sizehint) -> PyObject 7277 """ 7278 C = property(None, None) 7279# end of class InputStream 7280 7281 7282class OutputStream(StreamBase): 7283 """ 7284 OutputStream() 7285 7286 wxOutputStream is an abstract base class which may not be used 7287 directly. 7288 """ 7289 7290 def __init__(self): 7291 """ 7292 OutputStream() 7293 7294 wxOutputStream is an abstract base class which may not be used 7295 directly. 7296 """ 7297 7298 def Close(self): 7299 """ 7300 Close() -> bool 7301 7302 Closes the stream, returning false if an error occurs. 7303 """ 7304 7305 def LastWrite(self): 7306 """ 7307 LastWrite() -> size_t 7308 7309 Returns the number of bytes written during the last Write(). 7310 """ 7311 7312 def PutC(self, c): 7313 """ 7314 PutC(c) 7315 7316 Puts the specified character in the output queue and increments the 7317 stream position. 7318 """ 7319 7320 def SeekO(self, pos, mode=FromStart): 7321 """ 7322 SeekO(pos, mode=FromStart) -> FileOffset 7323 7324 Changes the stream current position. 7325 """ 7326 7327 def TellO(self): 7328 """ 7329 TellO() -> FileOffset 7330 7331 Returns the current stream position. 7332 """ 7333 7334 def Write(self, *args, **kw): 7335 """ 7336 Write(buffer, size) -> OutputStream 7337 Write(stream_in) -> OutputStream 7338 7339 Writes up to the specified amount of bytes using the data of buffer. 7340 """ 7341 7342 def WriteAll(self, buffer, size): 7343 """ 7344 WriteAll(buffer, size) -> bool 7345 7346 Writes exactly the specified number of bytes from the buffer. 7347 """ 7348 7349 def seek(self, offset, whence=0): 7350 """ 7351 seek(offset, whence=0) 7352 """ 7353 7354 def tell(self): 7355 """ 7356 tell() -> FileOffset 7357 """ 7358 7359 def close(self): 7360 """ 7361 close() 7362 """ 7363 7364 def flush(self): 7365 """ 7366 flush() 7367 """ 7368 7369 def eof(self): 7370 """ 7371 eof() -> bool 7372 """ 7373 7374 def write(self, data): 7375 """ 7376 write(data) -> PyObject 7377 """ 7378# end of class OutputStream 7379 7380#-- end-stream --# 7381#-- begin-filesys --# 7382FS_READ = 0 7383FS_SEEKABLE = 0 7384 7385class FileSystem(Object): 7386 """ 7387 FileSystem() 7388 7389 This class provides an interface for opening files on different file 7390 systems. 7391 """ 7392 7393 def __init__(self): 7394 """ 7395 FileSystem() 7396 7397 This class provides an interface for opening files on different file 7398 systems. 7399 """ 7400 7401 def ChangePathTo(self, location, is_dir=False): 7402 """ 7403 ChangePathTo(location, is_dir=False) 7404 7405 Sets the current location. 7406 """ 7407 7408 def FindFileInPath(self, pStr, path, file): 7409 """ 7410 FindFileInPath(pStr, path, file) -> bool 7411 7412 Looks for the file with the given name file in a colon or semi-colon 7413 (depending on the current platform) separated list of directories in 7414 path. 7415 """ 7416 7417 def FindFirst(self, wildcard, flags=0): 7418 """ 7419 FindFirst(wildcard, flags=0) -> String 7420 7421 Works like wxFindFirstFile(). 7422 """ 7423 7424 def FindNext(self): 7425 """ 7426 FindNext() -> String 7427 7428 Returns the next filename that matches the parameters passed to 7429 FindFirst(). 7430 """ 7431 7432 def GetPath(self): 7433 """ 7434 GetPath() -> String 7435 7436 Returns the actual path (set by wxFileSystem::ChangePathTo). 7437 """ 7438 7439 def OpenFile(self, location, flags=FS_READ): 7440 """ 7441 OpenFile(location, flags=FS_READ) -> FSFile 7442 7443 Opens the file and returns a pointer to a wxFSFile object or NULL if 7444 failed. 7445 """ 7446 7447 @staticmethod 7448 def AddHandler(handler): 7449 """ 7450 AddHandler(handler) 7451 7452 This static function adds new handler into the list of handlers (see 7453 wxFileSystemHandler) which provide access to virtual FS. 7454 """ 7455 7456 @staticmethod 7457 def RemoveHandler(handler): 7458 """ 7459 RemoveHandler(handler) -> FileSystemHandler 7460 7461 Remove a filesystem handler from the list of handlers. 7462 """ 7463 7464 @staticmethod 7465 def FileNameToURL(filename): 7466 """ 7467 FileNameToURL(filename) -> String 7468 7469 Converts a wxFileName into an URL. 7470 """ 7471 7472 @staticmethod 7473 def HasHandlerForPath(location): 7474 """ 7475 HasHandlerForPath(location) -> bool 7476 7477 This static function returns true if there is a registered handler 7478 which can open the given location. 7479 """ 7480 7481 @staticmethod 7482 def URLToFileName(url): 7483 """ 7484 URLToFileName(url) -> FileName 7485 7486 Converts URL into a well-formed filename. 7487 """ 7488 Path = property(None, None) 7489# end of class FileSystem 7490 7491 7492class FSFile(Object): 7493 """ 7494 FSFile(stream, location, mimetype, anchor, modif) 7495 7496 This class represents a single file opened by wxFileSystem. 7497 """ 7498 7499 def __init__(self, stream, location, mimetype, anchor, modif): 7500 """ 7501 FSFile(stream, location, mimetype, anchor, modif) 7502 7503 This class represents a single file opened by wxFileSystem. 7504 """ 7505 7506 def DetachStream(self): 7507 """ 7508 DetachStream() -> InputStream 7509 7510 Detaches the stream from the wxFSFile object. 7511 """ 7512 7513 def GetAnchor(self): 7514 """ 7515 GetAnchor() -> String 7516 7517 Returns anchor (if present). 7518 """ 7519 7520 def GetLocation(self): 7521 """ 7522 GetLocation() -> String 7523 7524 Returns full location of the file, including path and protocol. 7525 """ 7526 7527 def GetMimeType(self): 7528 """ 7529 GetMimeType() -> String 7530 7531 Returns the MIME type of the content of this file. 7532 """ 7533 7534 def GetModificationTime(self): 7535 """ 7536 GetModificationTime() -> DateTime 7537 7538 Returns time when this file was modified. 7539 """ 7540 7541 def GetStream(self): 7542 """ 7543 GetStream() -> InputStream 7544 7545 Returns pointer to the stream. 7546 """ 7547 Anchor = property(None, None) 7548 Location = property(None, None) 7549 MimeType = property(None, None) 7550 ModificationTime = property(None, None) 7551 Stream = property(None, None) 7552# end of class FSFile 7553 7554 7555class FileSystemHandler(Object): 7556 """ 7557 FileSystemHandler() 7558 7559 Classes derived from wxFileSystemHandler are used to access virtual 7560 file systems. 7561 """ 7562 7563 def __init__(self): 7564 """ 7565 FileSystemHandler() 7566 7567 Classes derived from wxFileSystemHandler are used to access virtual 7568 file systems. 7569 """ 7570 7571 def CanOpen(self, location): 7572 """ 7573 CanOpen(location) -> bool 7574 7575 Returns true if the handler is able to open this file. 7576 """ 7577 7578 def FindFirst(self, wildcard, flags=0): 7579 """ 7580 FindFirst(wildcard, flags=0) -> String 7581 7582 Works like wxFindFirstFile(). 7583 """ 7584 7585 def FindNext(self): 7586 """ 7587 FindNext() -> String 7588 7589 Returns next filename that matches parameters passed to 7590 wxFileSystem::FindFirst. 7591 """ 7592 7593 def OpenFile(self, fs, location): 7594 """ 7595 OpenFile(fs, location) -> FSFile 7596 7597 Opens the file and returns wxFSFile pointer or NULL if failed. 7598 """ 7599 7600 @staticmethod 7601 def GetMimeTypeFromExt(location): 7602 """ 7603 GetMimeTypeFromExt(location) -> String 7604 7605 Returns the MIME type based on extension of location. 7606 """ 7607 7608 @staticmethod 7609 def GetAnchor(location): 7610 """ 7611 GetAnchor(location) -> String 7612 7613 Returns the anchor if present in the location. 7614 """ 7615 7616 @staticmethod 7617 def GetLeftLocation(location): 7618 """ 7619 GetLeftLocation(location) -> String 7620 7621 Returns the left location string extracted from location. 7622 """ 7623 7624 @staticmethod 7625 def GetProtocol(location): 7626 """ 7627 GetProtocol(location) -> String 7628 7629 Returns the protocol string extracted from location. 7630 """ 7631 7632 @staticmethod 7633 def GetRightLocation(location): 7634 """ 7635 GetRightLocation(location) -> String 7636 7637 Returns the right location string extracted from location. 7638 """ 7639# end of class FileSystemHandler 7640 7641 7642class MemoryFSHandler(FileSystemHandler): 7643 """ 7644 MemoryFSHandler() 7645 7646 This wxFileSystem handler can store arbitrary data in memory stream 7647 and make them accessible via an URL. 7648 """ 7649 7650 def __init__(self): 7651 """ 7652 MemoryFSHandler() 7653 7654 This wxFileSystem handler can store arbitrary data in memory stream 7655 and make them accessible via an URL. 7656 """ 7657 7658 @staticmethod 7659 def AddFile(*args, **kw): 7660 """ 7661 AddFile(filename, image, type) 7662 AddFile(filename, bitmap, type) 7663 AddFile(filename, textdata) 7664 AddFile(filename, binarydata) 7665 7666 Adds a file to the list of the files stored in memory. 7667 """ 7668 7669 @staticmethod 7670 def AddFileWithMimeType(*args, **kw): 7671 """ 7672 AddFileWithMimeType(filename, textdata, mimetype) 7673 AddFileWithMimeType(filename, binarydata, mimetype) 7674 7675 Add a file from text data, which will first be converted to utf-8 7676 encoded bytes. 7677 """ 7678 7679 @staticmethod 7680 def RemoveFile(filename): 7681 """ 7682 RemoveFile(filename) 7683 7684 Removes a file from memory FS and frees the occupied memory. 7685 """ 7686# end of class MemoryFSHandler 7687 7688 7689class ArchiveFSHandler(FileSystemHandler): 7690 """ 7691 ArchiveFSHandler() 7692 7693 A file system handler for accessing files inside of archives. 7694 """ 7695 7696 def __init__(self): 7697 """ 7698 ArchiveFSHandler() 7699 7700 A file system handler for accessing files inside of archives. 7701 """ 7702 7703 def Cleanup(self): 7704 """ 7705 Cleanup() 7706 """ 7707# end of class ArchiveFSHandler 7708 7709 7710class FilterFSHandler(FileSystemHandler): 7711 """ 7712 FilterFSHandler() 7713 7714 Filter file system handler. 7715 """ 7716 7717 def __init__(self): 7718 """ 7719 FilterFSHandler() 7720 7721 Filter file system handler. 7722 """ 7723# end of class FilterFSHandler 7724 7725 7726class InternetFSHandler(FileSystemHandler): 7727 """ 7728 InternetFSHandler() 7729 7730 A file system handler for accessing files from internet servers. 7731 """ 7732 7733 def __init__(self): 7734 """ 7735 InternetFSHandler() 7736 7737 A file system handler for accessing files from internet servers. 7738 """ 7739# end of class InternetFSHandler 7740 7741 7742ZipFSHandler = wx.deprecated(ArchiveFSHandler, "Use ArchiveFSHandler instead.") 7743#-- end-filesys --# 7744#-- begin-image --# 7745IMAGE_RESOLUTION_NONE = 0 7746IMAGE_RESOLUTION_INCHES = 0 7747IMAGE_RESOLUTION_CM = 0 7748IMAGE_QUALITY_NEAREST = 0 7749IMAGE_QUALITY_BILINEAR = 0 7750IMAGE_QUALITY_BICUBIC = 0 7751IMAGE_QUALITY_BOX_AVERAGE = 0 7752IMAGE_QUALITY_NORMAL = 0 7753IMAGE_QUALITY_HIGH = 0 7754PNG_TYPE_COLOUR = 0 7755PNG_TYPE_GREY = 0 7756PNG_TYPE_GREY_RED = 0 7757PNG_TYPE_PALETTE = 0 7758BMP_24BPP = 0 7759BMP_8BPP = 0 7760BMP_8BPP_GREY = 0 7761BMP_8BPP_GRAY = 0 7762BMP_8BPP_RED = 0 7763BMP_8BPP_PALETTE = 0 7764BMP_4BPP = 0 7765BMP_1BPP = 0 7766BMP_1BPP_BW = 0 7767IMAGE_ALPHA_TRANSPARENT = 0 7768IMAGE_ALPHA_OPAQUE = 0 7769IMAGE_ALPHA_THRESHOLD = 0 7770 7771class Image(Object): 7772 """ 7773 Image() 7774 Image(width, height, clear=True) 7775 Image(sz, clear=True) 7776 Image(name, type=BITMAP_TYPE_ANY, index=-1) 7777 Image(name, mimetype, index=-1) 7778 Image(stream, type=BITMAP_TYPE_ANY, index=-1) 7779 Image(stream, mimetype, index=-1) 7780 Image(width, height, data) 7781 Image(width, height, data, alpha) 7782 Image(size, data) 7783 Image(size, data, alpha) 7784 7785 This class encapsulates a platform-independent image. 7786 """ 7787 7788 class HSVValue(object): 7789 """ 7790 HSVValue(h=0.0, s=0.0, v=0.0) 7791 7792 A simple class which stores hue, saturation and value as doubles in 7793 the range 0.0-1.0. 7794 """ 7795 7796 def __init__(self, h=0.0, s=0.0, v=0.0): 7797 """ 7798 HSVValue(h=0.0, s=0.0, v=0.0) 7799 7800 A simple class which stores hue, saturation and value as doubles in 7801 the range 0.0-1.0. 7802 """ 7803 hue = property(None, None) 7804 saturation = property(None, None) 7805 value = property(None, None) 7806 # end of class HSVValue 7807 7808 7809 class RGBValue(object): 7810 """ 7811 RGBValue(r=0, g=0, b=0) 7812 7813 A simple class which stores red, green and blue values as 8 bit 7814 unsigned integers in the range of 0-255. 7815 """ 7816 7817 def __init__(self, r=0, g=0, b=0): 7818 """ 7819 RGBValue(r=0, g=0, b=0) 7820 7821 A simple class which stores red, green and blue values as 8 bit 7822 unsigned integers in the range of 0-255. 7823 """ 7824 red = property(None, None) 7825 green = property(None, None) 7826 blue = property(None, None) 7827 # end of class RGBValue 7828 7829 7830 def __init__(self, *args, **kw): 7831 """ 7832 Image() 7833 Image(width, height, clear=True) 7834 Image(sz, clear=True) 7835 Image(name, type=BITMAP_TYPE_ANY, index=-1) 7836 Image(name, mimetype, index=-1) 7837 Image(stream, type=BITMAP_TYPE_ANY, index=-1) 7838 Image(stream, mimetype, index=-1) 7839 Image(width, height, data) 7840 Image(width, height, data, alpha) 7841 Image(size, data) 7842 Image(size, data, alpha) 7843 7844 This class encapsulates a platform-independent image. 7845 """ 7846 7847 def Copy(self): 7848 """ 7849 Copy() -> Image 7850 7851 Returns an identical copy of this image. 7852 """ 7853 7854 def Create(self, *args, **kw): 7855 """ 7856 Create(width, height, clear=True) -> bool 7857 Create(sz, clear=True) -> bool 7858 Create(width, height, data) -> bool 7859 Create(width, height, data, alpha) -> bool 7860 Create(size, data) -> bool 7861 Create(size, data, alpha) -> bool 7862 7863 Creates a fresh image. 7864 """ 7865 7866 def Clear(self, value=0): 7867 """ 7868 Clear(value=0) 7869 7870 Initialize the image data with zeroes (the default) or with the byte 7871 value given as value. 7872 """ 7873 7874 def Destroy(self): 7875 """ 7876 Destroy() 7877 7878 Destroys the image data. 7879 """ 7880 7881 def InitAlpha(self): 7882 """ 7883 InitAlpha() 7884 7885 Initializes the image alpha channel data. 7886 """ 7887 7888 def Blur(self, blurRadius): 7889 """ 7890 Blur(blurRadius) -> Image 7891 7892 Blurs the image in both horizontal and vertical directions by the 7893 specified pixel blurRadius. 7894 """ 7895 7896 def BlurHorizontal(self, blurRadius): 7897 """ 7898 BlurHorizontal(blurRadius) -> Image 7899 7900 Blurs the image in the horizontal direction only. 7901 """ 7902 7903 def BlurVertical(self, blurRadius): 7904 """ 7905 BlurVertical(blurRadius) -> Image 7906 7907 Blurs the image in the vertical direction only. 7908 """ 7909 7910 def Mirror(self, horizontally=True): 7911 """ 7912 Mirror(horizontally=True) -> Image 7913 7914 Returns a mirrored copy of the image. 7915 """ 7916 7917 def Paste(self, image, x, y): 7918 """ 7919 Paste(image, x, y) 7920 7921 Copy the data of the given image to the specified position in this 7922 image. 7923 """ 7924 7925 def Replace(self, r1, g1, b1, r2, g2, b2): 7926 """ 7927 Replace(r1, g1, b1, r2, g2, b2) 7928 7929 Replaces the colour specified by r1,g1,b1 by the colour r2,g2,b2. 7930 """ 7931 7932 def Rescale(self, width, height, quality=IMAGE_QUALITY_NORMAL): 7933 """ 7934 Rescale(width, height, quality=IMAGE_QUALITY_NORMAL) -> Image 7935 7936 Changes the size of the image in-place by scaling it: after a call to 7937 this function,the image will have the given width and height. 7938 """ 7939 7940 def Resize(self, size, pos, red=-1, green=-1, blue=-1): 7941 """ 7942 Resize(size, pos, red=-1, green=-1, blue=-1) -> Image 7943 7944 Changes the size of the image in-place without scaling it by adding 7945 either a border with the given colour or cropping as necessary. 7946 """ 7947 7948 def Rotate(self, angle, rotationCentre, interpolating=True, offsetAfterRotation=None): 7949 """ 7950 Rotate(angle, rotationCentre, interpolating=True, offsetAfterRotation=None) -> Image 7951 7952 Rotates the image about the given point, by angle radians. 7953 """ 7954 7955 def Rotate90(self, clockwise=True): 7956 """ 7957 Rotate90(clockwise=True) -> Image 7958 7959 Returns a copy of the image rotated 90 degrees in the direction 7960 indicated by clockwise. 7961 """ 7962 7963 def Rotate180(self): 7964 """ 7965 Rotate180() -> Image 7966 7967 Returns a copy of the image rotated by 180 degrees. 7968 """ 7969 7970 def RotateHue(self, angle): 7971 """ 7972 RotateHue(angle) 7973 7974 Rotates the hue of each pixel in the image by angle, which is a double 7975 in the range of -1.0 to +1.0, where -1.0 corresponds to -360 degrees 7976 and +1.0 corresponds to +360 degrees. 7977 """ 7978 7979 def Scale(self, width, height, quality=IMAGE_QUALITY_NORMAL): 7980 """ 7981 Scale(width, height, quality=IMAGE_QUALITY_NORMAL) -> Image 7982 7983 Returns a scaled version of the image. 7984 """ 7985 7986 def Size(self, size, pos, red=-1, green=-1, blue=-1): 7987 """ 7988 Size(size, pos, red=-1, green=-1, blue=-1) -> Image 7989 7990 Returns a resized version of this image without scaling it by adding 7991 either a border with the given colour or cropping as necessary. 7992 """ 7993 7994 def ConvertAlphaToMask(self, *args, **kw): 7995 """ 7996 ConvertAlphaToMask(threshold=IMAGE_ALPHA_THRESHOLD) -> bool 7997 ConvertAlphaToMask(mr, mg, mb, threshold=IMAGE_ALPHA_THRESHOLD) -> bool 7998 7999 If the image has alpha channel, this method converts it to mask. 8000 """ 8001 8002 def ConvertToGreyscale(self, *args, **kw): 8003 """ 8004 ConvertToGreyscale(weight_r, weight_g, weight_b) -> Image 8005 ConvertToGreyscale() -> Image 8006 8007 Returns a greyscale version of the image. 8008 """ 8009 8010 def ConvertToMono(self, r, g, b): 8011 """ 8012 ConvertToMono(r, g, b) -> Image 8013 8014 Returns monochromatic version of the image. 8015 """ 8016 8017 def ConvertToDisabled(self, brightness=255): 8018 """ 8019 ConvertToDisabled(brightness=255) -> Image 8020 8021 Returns disabled (dimmed) version of the image. 8022 """ 8023 8024 def ComputeHistogram(self, histogram): 8025 """ 8026 ComputeHistogram(histogram) -> unsignedlong 8027 8028 Computes the histogram of the image. 8029 """ 8030 8031 def FindFirstUnusedColour(self, startR=1, startG=0, startB=0): 8032 """ 8033 FindFirstUnusedColour(startR=1, startG=0, startB=0) -> (r, g, b) 8034 8035 Finds the first colour that is never used in the image. 8036 """ 8037 8038 def GetAlpha(self, *args, **kw): 8039 """ 8040 GetAlpha(x, y) -> unsignedchar 8041 GetAlpha() -> PyObject 8042 8043 Return alpha value at given pixel location. 8044 """ 8045 8046 def GetData(self): 8047 """ 8048 GetData() -> PyObject 8049 8050 Returns a copy of the RGB bytes of the image. 8051 """ 8052 8053 def GetRed(self, x, y): 8054 """ 8055 GetRed(x, y) -> unsignedchar 8056 8057 Returns the red intensity at the given coordinate. 8058 """ 8059 8060 def GetGreen(self, x, y): 8061 """ 8062 GetGreen(x, y) -> unsignedchar 8063 8064 Returns the green intensity at the given coordinate. 8065 """ 8066 8067 def GetBlue(self, x, y): 8068 """ 8069 GetBlue(x, y) -> unsignedchar 8070 8071 Returns the blue intensity at the given coordinate. 8072 """ 8073 8074 def GetMaskRed(self): 8075 """ 8076 GetMaskRed() -> unsignedchar 8077 8078 Gets the red value of the mask colour. 8079 """ 8080 8081 def GetMaskGreen(self): 8082 """ 8083 GetMaskGreen() -> unsignedchar 8084 8085 Gets the green value of the mask colour. 8086 """ 8087 8088 def GetMaskBlue(self): 8089 """ 8090 GetMaskBlue() -> unsignedchar 8091 8092 Gets the blue value of the mask colour. 8093 """ 8094 8095 def GetWidth(self): 8096 """ 8097 GetWidth() -> int 8098 8099 Gets the width of the image in pixels. 8100 """ 8101 8102 def GetHeight(self): 8103 """ 8104 GetHeight() -> int 8105 8106 Gets the height of the image in pixels. 8107 """ 8108 8109 def GetSize(self): 8110 """ 8111 GetSize() -> Size 8112 8113 Returns the size of the image in pixels. 8114 """ 8115 8116 def GetOption(self, name): 8117 """ 8118 GetOption(name) -> String 8119 8120 Gets a user-defined string-valued option. 8121 """ 8122 8123 def GetOptionInt(self, name): 8124 """ 8125 GetOptionInt(name) -> int 8126 8127 Gets a user-defined integer-valued option. 8128 """ 8129 8130 def GetOrFindMaskColour(self): 8131 """ 8132 GetOrFindMaskColour() -> (r, g, b) 8133 8134 Get the current mask colour or find a suitable unused colour that 8135 could be used as a mask colour. 8136 """ 8137 8138 def GetPalette(self): 8139 """ 8140 GetPalette() -> Palette 8141 8142 Returns the palette associated with the image. 8143 """ 8144 8145 def GetSubImage(self, rect): 8146 """ 8147 GetSubImage(rect) -> Image 8148 8149 Returns a sub image of the current one as long as the rect belongs 8150 entirely to the image. 8151 """ 8152 8153 def GetType(self): 8154 """ 8155 GetType() -> BitmapType 8156 8157 Gets the type of image found by LoadFile() or specified with 8158 SaveFile(). 8159 """ 8160 8161 def HasAlpha(self): 8162 """ 8163 HasAlpha() -> bool 8164 8165 Returns true if this image has alpha channel, false otherwise. 8166 """ 8167 8168 def HasMask(self): 8169 """ 8170 HasMask() -> bool 8171 8172 Returns true if there is a mask active, false otherwise. 8173 """ 8174 8175 def HasOption(self, name): 8176 """ 8177 HasOption(name) -> bool 8178 8179 Returns true if the given option is present. 8180 """ 8181 8182 def IsOk(self): 8183 """ 8184 IsOk() -> bool 8185 8186 Returns true if image data is present. 8187 """ 8188 8189 def IsTransparent(self, x, y, threshold=IMAGE_ALPHA_THRESHOLD): 8190 """ 8191 IsTransparent(x, y, threshold=IMAGE_ALPHA_THRESHOLD) -> bool 8192 8193 Returns true if the given pixel is transparent, i.e. either has the 8194 mask colour if this image has a mask or if this image has alpha 8195 channel and alpha value of this pixel is strictly less than threshold. 8196 """ 8197 8198 def LoadFile(self, *args, **kw): 8199 """ 8200 LoadFile(stream, type=BITMAP_TYPE_ANY, index=-1) -> bool 8201 LoadFile(name, type=BITMAP_TYPE_ANY, index=-1) -> bool 8202 LoadFile(name, mimetype, index=-1) -> bool 8203 LoadFile(stream, mimetype, index=-1) -> bool 8204 8205 Loads an image from an input stream. 8206 """ 8207 8208 def SaveFile(self, *args, **kw): 8209 """ 8210 SaveFile(stream, mimetype) -> bool 8211 SaveFile(name, type) -> bool 8212 SaveFile(name, mimetype) -> bool 8213 SaveFile(name) -> bool 8214 SaveFile(stream, type) -> bool 8215 8216 Saves an image in the given stream. 8217 """ 8218 8219 def SetAlpha(self, *args, **kw): 8220 """ 8221 SetAlpha(x, y, alpha) 8222 SetAlpha(alpha) 8223 8224 Sets the alpha value for the given pixel. 8225 """ 8226 8227 def ClearAlpha(self): 8228 """ 8229 ClearAlpha() 8230 8231 Removes the alpha channel from the image. 8232 """ 8233 8234 def SetData(self, *args, **kw): 8235 """ 8236 SetData(data) 8237 SetData(data, new_width, new_height) 8238 8239 Sets the image data without performing checks. 8240 """ 8241 8242 def SetMask(self, hasMask=True): 8243 """ 8244 SetMask(hasMask=True) 8245 8246 Specifies whether there is a mask or not. 8247 """ 8248 8249 def SetMaskColour(self, red, green, blue): 8250 """ 8251 SetMaskColour(red, green, blue) 8252 8253 Sets the mask colour for this image (and tells the image to use the 8254 mask). 8255 """ 8256 8257 def SetMaskFromImage(self, mask, mr, mg, mb): 8258 """ 8259 SetMaskFromImage(mask, mr, mg, mb) -> bool 8260 8261 Sets image's mask so that the pixels that have RGB value of mr,mg,mb 8262 in mask will be masked in the image. 8263 """ 8264 8265 def SetOption(self, *args, **kw): 8266 """ 8267 SetOption(name, value) 8268 SetOption(name, value) 8269 8270 Sets a user-defined option. 8271 """ 8272 8273 def SetPalette(self, palette): 8274 """ 8275 SetPalette(palette) 8276 8277 Associates a palette with the image. 8278 """ 8279 8280 def SetRGB(self, *args, **kw): 8281 """ 8282 SetRGB(x, y, r, g, b) 8283 SetRGB(rect, red, green, blue) 8284 8285 Set the color of the pixel at the given x and y coordinate. 8286 """ 8287 8288 def SetType(self, type): 8289 """ 8290 SetType(type) 8291 8292 Set the type of image returned by GetType(). 8293 """ 8294 8295 @staticmethod 8296 def AddHandler(handler): 8297 """ 8298 AddHandler(handler) 8299 8300 Register an image handler. 8301 """ 8302 8303 @staticmethod 8304 def CleanUpHandlers(): 8305 """ 8306 CleanUpHandlers() 8307 8308 Deletes all image handlers. 8309 """ 8310 8311 @staticmethod 8312 def FindHandler(*args, **kw): 8313 """ 8314 FindHandler(name) -> ImageHandler 8315 FindHandler(extension, imageType) -> ImageHandler 8316 FindHandler(imageType) -> ImageHandler 8317 8318 Finds the handler with the given name. 8319 """ 8320 8321 @staticmethod 8322 def FindHandlerMime(mimetype): 8323 """ 8324 FindHandlerMime(mimetype) -> ImageHandler 8325 8326 Finds the handler associated with the given MIME type. 8327 """ 8328 8329 @staticmethod 8330 def InitStandardHandlers(): 8331 """ 8332 InitStandardHandlers() 8333 8334 Internal use only. 8335 """ 8336 8337 @staticmethod 8338 def InsertHandler(handler): 8339 """ 8340 InsertHandler(handler) 8341 8342 Adds a handler at the start of the static list of format handlers. 8343 """ 8344 8345 @staticmethod 8346 def RemoveHandler(name): 8347 """ 8348 RemoveHandler(name) -> bool 8349 8350 Finds the handler with the given name, and removes it. 8351 """ 8352 8353 @staticmethod 8354 def GetImageCount(*args, **kw): 8355 """ 8356 GetImageCount(filename, type=BITMAP_TYPE_ANY) -> int 8357 GetImageCount(stream, type=BITMAP_TYPE_ANY) -> int 8358 8359 If the image file contains more than one image and the image handler 8360 is capable of retrieving these individually, this function will return 8361 the number of available images. 8362 """ 8363 8364 @staticmethod 8365 def CanRead(*args, **kw): 8366 """ 8367 CanRead(filename) -> bool 8368 CanRead(stream) -> bool 8369 8370 Returns true if at least one of the available image handlers can read 8371 the file with the given name. 8372 """ 8373 8374 @staticmethod 8375 def GetImageExtWildcard(): 8376 """ 8377 GetImageExtWildcard() -> String 8378 8379 Iterates all registered wxImageHandler objects, and returns a string 8380 containing file extension masks suitable for passing to file open/save 8381 dialog boxes. 8382 """ 8383 8384 @staticmethod 8385 def RGBtoHSV(rgb): 8386 """ 8387 RGBtoHSV(rgb) -> Image.HSVValue 8388 8389 Converts a color in RGB color space to HSV color space. 8390 """ 8391 8392 @staticmethod 8393 def HSVtoRGB(hsv): 8394 """ 8395 HSVtoRGB(hsv) -> Image.RGBValue 8396 8397 Converts a color in HSV color space to RGB color space. 8398 """ 8399 8400 def GetDataBuffer(self): 8401 """ 8402 GetDataBuffer() -> PyObject 8403 8404 Returns a writable Python buffer object that is pointing at the RGB 8405 image data buffer inside the :class:`Image`. You need to ensure that 8406 you do 8407 not use this buffer object after the image has been destroyed. 8408 """ 8409 8410 def GetAlphaBuffer(self): 8411 """ 8412 GetAlphaBuffer() -> PyObject 8413 8414 Returns a writable Python buffer object that is pointing at the Alpha 8415 data buffer inside the :class:`Image`. You need to ensure that you do 8416 not use this buffer object after the image has been destroyed. 8417 """ 8418 8419 def SetDataBuffer(self, *args, **kw): 8420 """ 8421 SetDataBuffer(data) 8422 SetDataBuffer(data, new_width, new_height) 8423 8424 Sets the internal image data pointer to point at a Python buffer 8425 object. This can save making an extra copy of the data but you must 8426 ensure that the buffer object lives lives at least as long as the 8427 :class:`Image` does. 8428 """ 8429 8430 def SetAlphaBuffer(self, alpha): 8431 """ 8432 SetAlphaBuffer(alpha) 8433 8434 Sets the internal image alpha pointer to point at a Python buffer 8435 object. This can save making an extra copy of the data but you must 8436 ensure that the buffer object lives lives at least as long as the 8437 :class:`Image` does. 8438 """ 8439 8440 def __nonzero__(self): 8441 """ 8442 __nonzero__() -> int 8443 """ 8444 8445 def __bool__(self): 8446 """ 8447 __bool__() -> int 8448 """ 8449 8450 def ConvertToBitmap(self, depth=-1): 8451 """ 8452 ConvertToBitmap(depth=-1) -> Bitmap 8453 8454 Convert the image to a :class:`wx.Bitmap`. 8455 """ 8456 8457 def ConvertToMonoBitmap(self, red, green, blue): 8458 """ 8459 ConvertToMonoBitmap(red, green, blue) -> Bitmap 8460 8461 Creates a monochrome version of the image and returns it as a :class:`wx.Bitmap`. 8462 """ 8463 8464 def AdjustChannels(self, factor_red, factor_green, factor_blue, factor_alpha=1.0): 8465 """ 8466 AdjustChannels(factor_red, factor_green, factor_blue, factor_alpha=1.0) -> Image 8467 8468 This function muliplies all 4 channels (red, green, blue, alpha) with 8469 a factor (around 1.0). Useful for gamma correction, colour correction 8470 and to add a certain amount of transparency to a image (fade in fade 8471 out effects). If factor_alpha is given but the original image has no 8472 alpha channel then a alpha channel will be added. 8473 """ 8474 Width = property(None, None) 8475 Height = property(None, None) 8476 MaskBlue = property(None, None) 8477 MaskGreen = property(None, None) 8478 MaskRed = property(None, None) 8479 Type = property(None, None) 8480# end of class Image 8481 8482 8483class ImageHistogram(object): 8484 """ 8485 ImageHistogram() 8486 """ 8487 8488 def __init__(self): 8489 """ 8490 ImageHistogram() 8491 """ 8492 8493 def FindFirstUnusedColour(self, startR=1, startG=0, startB=0): 8494 """ 8495 FindFirstUnusedColour(startR=1, startG=0, startB=0) -> (r, g, b) 8496 """ 8497 8498 @staticmethod 8499 def MakeKey(r, g, b): 8500 """ 8501 MakeKey(r, g, b) -> unsignedlong 8502 """ 8503# end of class ImageHistogram 8504 8505 8506class ImageHandler(Object): 8507 """ 8508 ImageHandler() 8509 8510 This is the base class for implementing image file loading/saving, and 8511 image creation from data. 8512 """ 8513 8514 def __init__(self): 8515 """ 8516 ImageHandler() 8517 8518 This is the base class for implementing image file loading/saving, and 8519 image creation from data. 8520 """ 8521 8522 def CanRead(self, *args, **kw): 8523 """ 8524 CanRead(stream) -> bool 8525 CanRead(filename) -> bool 8526 8527 Returns true if this handler supports the image format contained in 8528 the given stream. 8529 """ 8530 8531 def GetExtension(self): 8532 """ 8533 GetExtension() -> String 8534 8535 Gets the preferred file extension associated with this handler. 8536 """ 8537 8538 def GetAltExtensions(self): 8539 """ 8540 GetAltExtensions() -> ArrayString 8541 8542 Returns the other file extensions associated with this handler. 8543 """ 8544 8545 def GetImageCount(self, stream): 8546 """ 8547 GetImageCount(stream) -> int 8548 8549 If the image file contains more than one image and the image handler 8550 is capable of retrieving these individually, this function will return 8551 the number of available images. 8552 """ 8553 8554 def GetMimeType(self): 8555 """ 8556 GetMimeType() -> String 8557 8558 Gets the MIME type associated with this handler. 8559 """ 8560 8561 def GetName(self): 8562 """ 8563 GetName() -> String 8564 8565 Gets the name of this handler. 8566 """ 8567 8568 def GetType(self): 8569 """ 8570 GetType() -> BitmapType 8571 8572 Gets the image type associated with this handler. 8573 """ 8574 8575 def LoadFile(self, image, stream, verbose=True, index=-1): 8576 """ 8577 LoadFile(image, stream, verbose=True, index=-1) -> bool 8578 8579 Loads a image from a stream, putting the resulting data into image. 8580 """ 8581 8582 def SaveFile(self, image, stream, verbose=True): 8583 """ 8584 SaveFile(image, stream, verbose=True) -> bool 8585 8586 Saves a image in the output stream. 8587 """ 8588 8589 def SetExtension(self, extension): 8590 """ 8591 SetExtension(extension) 8592 8593 Sets the preferred file extension associated with this handler. 8594 """ 8595 8596 def SetAltExtensions(self, extensions): 8597 """ 8598 SetAltExtensions(extensions) 8599 8600 Sets the alternative file extensions associated with this handler. 8601 """ 8602 8603 def SetMimeType(self, mimetype): 8604 """ 8605 SetMimeType(mimetype) 8606 8607 Sets the handler MIME type. 8608 """ 8609 8610 def SetName(self, name): 8611 """ 8612 SetName(name) 8613 8614 Sets the handler name. 8615 """ 8616 8617 def SetType(self, type): 8618 """ 8619 SetType(type) 8620 8621 Sets the bitmap type for the handler. 8622 """ 8623 AltExtensions = property(None, None) 8624 Extension = property(None, None) 8625 MimeType = property(None, None) 8626 Name = property(None, None) 8627 Type = property(None, None) 8628 8629 def DoGetImageCount(self, stream): 8630 """ 8631 DoGetImageCount(stream) -> int 8632 8633 Called to get the number of images available in a multi-image file 8634 type, if supported. 8635 """ 8636 8637 def DoCanRead(self, stream): 8638 """ 8639 DoCanRead(stream) -> bool 8640 8641 Called to test if this handler can read an image from the given 8642 stream. 8643 """ 8644# end of class ImageHandler 8645 8646 8647class TIFFHandler(ImageHandler): 8648 """ 8649 TIFFHandler() 8650 8651 This is the image handler for the TIFF format. 8652 """ 8653 8654 def __init__(self): 8655 """ 8656 TIFFHandler() 8657 8658 This is the image handler for the TIFF format. 8659 """ 8660 8661 def LoadFile(self, image, stream, verbose=True, index=-1): 8662 """ 8663 LoadFile(image, stream, verbose=True, index=-1) -> bool 8664 8665 Loads a image from a stream, putting the resulting data into image. 8666 """ 8667 8668 def DoCanRead(self, stream): 8669 """ 8670 DoCanRead(stream) -> bool 8671 8672 Called to test if this handler can read an image from the given 8673 stream. 8674 """ 8675# end of class TIFFHandler 8676 8677 8678class GIFHandler(ImageHandler): 8679 """ 8680 GIFHandler() 8681 8682 This is the image handler for the GIF format. 8683 """ 8684 8685 def __init__(self): 8686 """ 8687 GIFHandler() 8688 8689 This is the image handler for the GIF format. 8690 """ 8691 8692 def LoadFile(self, image, stream, verbose=True, index=-1): 8693 """ 8694 LoadFile(image, stream, verbose=True, index=-1) -> bool 8695 8696 Loads a image from a stream, putting the resulting data into image. 8697 """ 8698 8699 def SaveFile(self, image, stream, verbose=True): 8700 """ 8701 SaveFile(image, stream, verbose=True) -> bool 8702 8703 Saves a image in the output stream. 8704 """ 8705 8706 def SaveAnimation(self, images, stream, verbose=True, delayMilliSecs=1000): 8707 """ 8708 SaveAnimation(images, stream, verbose=True, delayMilliSecs=1000) -> bool 8709 8710 Save the animated gif. 8711 """ 8712 8713 def DoCanRead(self, stream): 8714 """ 8715 DoCanRead(stream) -> bool 8716 8717 Called to test if this handler can read an image from the given 8718 stream. 8719 """ 8720# end of class GIFHandler 8721 8722 8723class IFFHandler(ImageHandler): 8724 """ 8725 IFFHandler() 8726 8727 This is the image handler for the IFF format. 8728 """ 8729 8730 def __init__(self): 8731 """ 8732 IFFHandler() 8733 8734 This is the image handler for the IFF format. 8735 """ 8736 8737 def LoadFile(self, image, stream, verbose=True, index=-1): 8738 """ 8739 LoadFile(image, stream, verbose=True, index=-1) -> bool 8740 8741 Loads a image from a stream, putting the resulting data into image. 8742 """ 8743 8744 def SaveFile(self, image, stream, verbose=True): 8745 """ 8746 SaveFile(image, stream, verbose=True) -> bool 8747 8748 Saves a image in the output stream. 8749 """ 8750 8751 def DoCanRead(self, stream): 8752 """ 8753 DoCanRead(stream) -> bool 8754 8755 Called to test if this handler can read an image from the given 8756 stream. 8757 """ 8758# end of class IFFHandler 8759 8760 8761class JPEGHandler(ImageHandler): 8762 """ 8763 JPEGHandler() 8764 8765 This is the image handler for the JPEG format. 8766 """ 8767 8768 def __init__(self): 8769 """ 8770 JPEGHandler() 8771 8772 This is the image handler for the JPEG format. 8773 """ 8774 8775 def LoadFile(self, image, stream, verbose=True, index=-1): 8776 """ 8777 LoadFile(image, stream, verbose=True, index=-1) -> bool 8778 8779 Loads a image from a stream, putting the resulting data into image. 8780 """ 8781 8782 def SaveFile(self, image, stream, verbose=True): 8783 """ 8784 SaveFile(image, stream, verbose=True) -> bool 8785 8786 Saves a image in the output stream. 8787 """ 8788 8789 @staticmethod 8790 def GetLibraryVersionInfo(): 8791 """ 8792 GetLibraryVersionInfo() -> VersionInfo 8793 8794 Retrieve the version information about the JPEG library used by this 8795 handler. 8796 """ 8797 8798 def DoCanRead(self, stream): 8799 """ 8800 DoCanRead(stream) -> bool 8801 8802 Called to test if this handler can read an image from the given 8803 stream. 8804 """ 8805# end of class JPEGHandler 8806 8807 8808class PCXHandler(ImageHandler): 8809 """ 8810 PCXHandler() 8811 8812 This is the image handler for the PCX format. 8813 """ 8814 8815 def __init__(self): 8816 """ 8817 PCXHandler() 8818 8819 This is the image handler for the PCX format. 8820 """ 8821 8822 def LoadFile(self, image, stream, verbose=True, index=-1): 8823 """ 8824 LoadFile(image, stream, verbose=True, index=-1) -> bool 8825 8826 Loads a image from a stream, putting the resulting data into image. 8827 """ 8828 8829 def SaveFile(self, image, stream, verbose=True): 8830 """ 8831 SaveFile(image, stream, verbose=True) -> bool 8832 8833 Saves a image in the output stream. 8834 """ 8835 8836 def DoCanRead(self, stream): 8837 """ 8838 DoCanRead(stream) -> bool 8839 8840 Called to test if this handler can read an image from the given 8841 stream. 8842 """ 8843# end of class PCXHandler 8844 8845 8846class PNGHandler(ImageHandler): 8847 """ 8848 PNGHandler() 8849 8850 This is the image handler for the PNG format. 8851 """ 8852 8853 def __init__(self): 8854 """ 8855 PNGHandler() 8856 8857 This is the image handler for the PNG format. 8858 """ 8859 8860 def LoadFile(self, image, stream, verbose=True, index=-1): 8861 """ 8862 LoadFile(image, stream, verbose=True, index=-1) -> bool 8863 8864 Loads a image from a stream, putting the resulting data into image. 8865 """ 8866 8867 def SaveFile(self, image, stream, verbose=True): 8868 """ 8869 SaveFile(image, stream, verbose=True) -> bool 8870 8871 Saves a image in the output stream. 8872 """ 8873 8874 def DoCanRead(self, stream): 8875 """ 8876 DoCanRead(stream) -> bool 8877 8878 Called to test if this handler can read an image from the given 8879 stream. 8880 """ 8881# end of class PNGHandler 8882 8883 8884class PNMHandler(ImageHandler): 8885 """ 8886 PNMHandler() 8887 8888 This is the image handler for the PNM format. 8889 """ 8890 8891 def __init__(self): 8892 """ 8893 PNMHandler() 8894 8895 This is the image handler for the PNM format. 8896 """ 8897 8898 def LoadFile(self, image, stream, verbose=True, index=-1): 8899 """ 8900 LoadFile(image, stream, verbose=True, index=-1) -> bool 8901 8902 Loads a image from a stream, putting the resulting data into image. 8903 """ 8904 8905 def SaveFile(self, image, stream, verbose=True): 8906 """ 8907 SaveFile(image, stream, verbose=True) -> bool 8908 8909 Saves a image in the output stream. 8910 """ 8911 8912 def DoCanRead(self, stream): 8913 """ 8914 DoCanRead(stream) -> bool 8915 8916 Called to test if this handler can read an image from the given 8917 stream. 8918 """ 8919# end of class PNMHandler 8920 8921 8922class TGAHandler(ImageHandler): 8923 """ 8924 TGAHandler() 8925 8926 This is the image handler for the TGA format. 8927 """ 8928 8929 def __init__(self): 8930 """ 8931 TGAHandler() 8932 8933 This is the image handler for the TGA format. 8934 """ 8935 8936 def LoadFile(self, image, stream, verbose=True, index=-1): 8937 """ 8938 LoadFile(image, stream, verbose=True, index=-1) -> bool 8939 8940 Loads a image from a stream, putting the resulting data into image. 8941 """ 8942 8943 def SaveFile(self, image, stream, verbose=True): 8944 """ 8945 SaveFile(image, stream, verbose=True) -> bool 8946 8947 Saves a image in the output stream. 8948 """ 8949 8950 def DoCanRead(self, stream): 8951 """ 8952 DoCanRead(stream) -> bool 8953 8954 Called to test if this handler can read an image from the given 8955 stream. 8956 """ 8957# end of class TGAHandler 8958 8959 8960class XPMHandler(ImageHandler): 8961 """ 8962 XPMHandler() 8963 8964 This is the image handler for the XPM format. 8965 """ 8966 8967 def __init__(self): 8968 """ 8969 XPMHandler() 8970 8971 This is the image handler for the XPM format. 8972 """ 8973 8974 def LoadFile(self, image, stream, verbose=True, index=-1): 8975 """ 8976 LoadFile(image, stream, verbose=True, index=-1) -> bool 8977 8978 Loads a image from a stream, putting the resulting data into image. 8979 """ 8980 8981 def SaveFile(self, image, stream, verbose=True): 8982 """ 8983 SaveFile(image, stream, verbose=True) -> bool 8984 8985 Saves a image in the output stream. 8986 """ 8987 8988 def DoCanRead(self, stream): 8989 """ 8990 DoCanRead(stream) -> bool 8991 8992 Called to test if this handler can read an image from the given 8993 stream. 8994 """ 8995# end of class XPMHandler 8996 8997 8998def InitAllImageHandlers(): 8999 """ 9000 InitAllImageHandlers() 9001 9002 Initializes all available image handlers. 9003 """ 9004NullImage = Image() 9005 9006@wx.deprecated 9007def EmptyImage(width=0, height=0, clear=True): 9008 """ 9009 A compatibility wrapper for the wx.Image(width, height) constructor 9010 """ 9011 pass 9012 9013@wx.deprecated 9014def ImageFromBitmap(bitmap): 9015 """ 9016 Create a :class:`Image` from a :class:`wx.Bitmap` 9017 """ 9018 pass 9019 9020@wx.deprecated 9021def ImageFromStream(stream, type=BITMAP_TYPE_ANY, index=-1): 9022 """ 9023 Load an image from a stream (file-like object) 9024 """ 9025 pass 9026 9027@wx.deprecated 9028def ImageFromData(width, height, data): 9029 """ 9030 Compatibility wrapper for creating an image from RGB data 9031 """ 9032 pass 9033 9034@wx.deprecated 9035def ImageFromDataWithAlpha(width, height, data, alpha): 9036 """ 9037 Compatibility wrapper for creating an image from RGB and Alpha data 9038 """ 9039 pass 9040 9041def ImageFromBuffer(width, height, dataBuffer, alphaBuffer=None): 9042 """ 9043 Creates a :class:`Image` from the data in `dataBuffer`. The `dataBuffer` 9044 parameter must be a Python object that implements the buffer interface, 9045 such as a string, array, etc. The `dataBuffer` object is expected to 9046 contain a series of RGB bytes and be width*height*3 bytes long. A buffer 9047 object can optionally be supplied for the image's alpha channel data, and 9048 it is expected to be width*height bytes long. 9049 9050 The :class:`Image` will be created with its data and alpha pointers initialized 9051 to the memory address pointed to by the buffer objects, thus saving the 9052 time needed to copy the image data from the buffer object to the :class:`Image`. 9053 While this has advantages, it also has the shoot-yourself-in-the-foot 9054 risks associated with sharing a C pointer between two objects. 9055 9056 To help alleviate the risk a reference to the data and alpha buffer 9057 objects are kept with the :class:`Image`, so that they won't get deleted until 9058 after the wx.Image is deleted. However please be aware that it is not 9059 guaranteed that an object won't move its memory buffer to a new location 9060 when it needs to resize its contents. If that happens then the :class:`Image` 9061 will end up referring to an invalid memory location and could cause the 9062 application to crash. Therefore care should be taken to not manipulate 9063 the objects used for the data and alpha buffers in a way that would cause 9064 them to change size. 9065 """ 9066 pass 9067 9068IMAGE_OPTION_QUALITY = "quality" 9069IMAGE_OPTION_FILENAME = "FileName" 9070IMAGE_OPTION_RESOLUTION = "Resolution" 9071IMAGE_OPTION_RESOLUTIONX = "ResolutionX" 9072IMAGE_OPTION_RESOLUTIONY = "ResolutionY" 9073IMAGE_OPTION_RESOLUTIONUNIT = "ResolutionUnit" 9074IMAGE_OPTION_MAX_WIDTH = "MaxWidth" 9075IMAGE_OPTION_MAX_HEIGHT = "MaxHeight" 9076IMAGE_OPTION_ORIGINAL_WIDTH = "OriginalWidth" 9077IMAGE_OPTION_ORIGINAL_HEIGHT = "OriginalHeight" 9078IMAGE_OPTION_BMP_FORMAT = "wxBMP_FORMAT" 9079IMAGE_OPTION_CUR_HOTSPOT_X = "HotSpotX" 9080IMAGE_OPTION_CUR_HOTSPOT_Y = "HotSpotY" 9081IMAGE_OPTION_GIF_COMMENT = "GifComment" 9082IMAGE_OPTION_PNG_FORMAT = "PngFormat" 9083IMAGE_OPTION_PNG_BITDEPTH = "PngBitDepth" 9084IMAGE_OPTION_PNG_FILTER = "PngF" 9085IMAGE_OPTION_PNG_COMPRESSION_LEVEL = "PngZL" 9086IMAGE_OPTION_PNG_COMPRESSION_MEM_LEVEL = "PngZM" 9087IMAGE_OPTION_PNG_COMPRESSION_STRATEGY = "PngZS" 9088IMAGE_OPTION_PNG_COMPRESSION_BUFFER_SIZE = "PngZB" 9089IMAGE_OPTION_TIFF_BITSPERSAMPLE = "BitsPerSample" 9090IMAGE_OPTION_TIFF_SAMPLESPERPIXEL = "SamplesPerPixel" 9091IMAGE_OPTION_TIFF_COMPRESSION = "Compression" 9092IMAGE_OPTION_TIFF_PHOTOMETRIC = "Photometric" 9093IMAGE_OPTION_TIFF_IMAGEDESCRIPTOR = "ImageDescriptor" 9094IMAGE_OPTION_TIFF_BITSPERSAMPLE = "BitsPerSample" 9095IMAGE_OPTION_TIFF_SAMPLESPERPIXEL = "SamplesPerPixel" 9096IMAGE_OPTION_TIFF_COMPRESSION = "Compression" 9097IMAGE_OPTION_TIFF_PHOTOMETRIC = "Photometric" 9098IMAGE_OPTION_TIFF_IMAGEDESCRIPTOR = "ImageDescriptor" 9099IMAGE_OPTION_GIF_COMMENT = "GifComment" 9100IMAGE_OPTION_PNG_FORMAT = "PngFormat" 9101IMAGE_OPTION_PNG_BITDEPTH = "PngBitDepth" 9102IMAGE_OPTION_PNG_FILTER = "PngF" 9103IMAGE_OPTION_PNG_COMPRESSION_LEVEL = "PngZL" 9104IMAGE_OPTION_PNG_COMPRESSION_MEM_LEVEL = "PngZM" 9105IMAGE_OPTION_PNG_COMPRESSION_STRATEGY = "PngZS" 9106IMAGE_OPTION_PNG_COMPRESSION_BUFFER_SIZE = "PngZB" 9107#-- end-image --# 9108#-- begin-gdiobj --# 9109 9110class GDIObject(Object): 9111 """ 9112 GDIObject() 9113 9114 This class allows platforms to implement functionality to optimise GDI 9115 objects, such as wxPen, wxBrush and wxFont. 9116 """ 9117 9118 def __init__(self): 9119 """ 9120 GDIObject() 9121 9122 This class allows platforms to implement functionality to optimise GDI 9123 objects, such as wxPen, wxBrush and wxFont. 9124 """ 9125# end of class GDIObject 9126 9127#-- end-gdiobj --# 9128#-- begin-bitmap --# 9129BitmapBufferFormat_RGB = 0 9130BitmapBufferFormat_RGBA = 0 9131BitmapBufferFormat_RGB32 = 0 9132BitmapBufferFormat_ARGB32 = 0 9133BITMAP_SCREEN_DEPTH = 0 9134 9135class Bitmap(GDIObject): 9136 """ 9137 Bitmap() 9138 Bitmap(bitmap) 9139 Bitmap(bits, width, height, depth=1) 9140 Bitmap(width, height, depth=BITMAP_SCREEN_DEPTH) 9141 Bitmap(sz, depth=BITMAP_SCREEN_DEPTH) 9142 Bitmap(name, type=BITMAP_TYPE_ANY) 9143 Bitmap(img, depth=BITMAP_SCREEN_DEPTH) 9144 Bitmap(listOfBytes) 9145 9146 This class encapsulates the concept of a platform-dependent bitmap, 9147 either monochrome or colour or colour with alpha channel support. 9148 """ 9149 9150 def __init__(self, *args, **kw): 9151 """ 9152 Bitmap() 9153 Bitmap(bitmap) 9154 Bitmap(bits, width, height, depth=1) 9155 Bitmap(width, height, depth=BITMAP_SCREEN_DEPTH) 9156 Bitmap(sz, depth=BITMAP_SCREEN_DEPTH) 9157 Bitmap(name, type=BITMAP_TYPE_ANY) 9158 Bitmap(img, depth=BITMAP_SCREEN_DEPTH) 9159 Bitmap(listOfBytes) 9160 9161 This class encapsulates the concept of a platform-dependent bitmap, 9162 either monochrome or colour or colour with alpha channel support. 9163 """ 9164 9165 def ConvertToImage(self): 9166 """ 9167 ConvertToImage() -> Image 9168 9169 Creates an image from a platform-dependent bitmap. 9170 """ 9171 9172 def CopyFromIcon(self, icon): 9173 """ 9174 CopyFromIcon(icon) -> bool 9175 9176 Creates the bitmap from an icon. 9177 """ 9178 9179 def Create(self, *args, **kw): 9180 """ 9181 Create(width, height, depth=BITMAP_SCREEN_DEPTH) -> bool 9182 Create(sz, depth=BITMAP_SCREEN_DEPTH) -> bool 9183 9184 Creates a fresh bitmap. 9185 """ 9186 9187 def GetDepth(self): 9188 """ 9189 GetDepth() -> int 9190 9191 Gets the colour depth of the bitmap. 9192 """ 9193 9194 def GetHeight(self): 9195 """ 9196 GetHeight() -> int 9197 9198 Gets the height of the bitmap in pixels. 9199 """ 9200 9201 def GetMask(self): 9202 """ 9203 GetMask() -> Mask 9204 9205 Gets the associated mask (if any) which may have been loaded from a 9206 file or set for the bitmap. 9207 """ 9208 9209 def GetPalette(self): 9210 """ 9211 GetPalette() -> Palette 9212 9213 Gets the associated palette (if any) which may have been loaded from a 9214 file or set for the bitmap. 9215 """ 9216 9217 def GetSubBitmap(self, rect): 9218 """ 9219 GetSubBitmap(rect) -> Bitmap 9220 9221 Returns a sub bitmap of the current one as long as the rect belongs 9222 entirely to the bitmap. 9223 """ 9224 9225 def GetSize(self): 9226 """ 9227 GetSize() -> Size 9228 9229 Returns the size of the bitmap in pixels. 9230 """ 9231 9232 def ConvertToDisabled(self, brightness=255): 9233 """ 9234 ConvertToDisabled(brightness=255) -> Bitmap 9235 9236 Returns disabled (dimmed) version of the bitmap. 9237 """ 9238 9239 def GetWidth(self): 9240 """ 9241 GetWidth() -> int 9242 9243 Gets the width of the bitmap in pixels. 9244 """ 9245 9246 def IsOk(self): 9247 """ 9248 IsOk() -> bool 9249 9250 Returns true if bitmap data is present. 9251 """ 9252 9253 def LoadFile(self, name, type=BITMAP_TYPE_ANY): 9254 """ 9255 LoadFile(name, type=BITMAP_TYPE_ANY) -> bool 9256 9257 Loads a bitmap from a file or resource. 9258 """ 9259 9260 def SaveFile(self, name, type, palette=None): 9261 """ 9262 SaveFile(name, type, palette=None) -> bool 9263 9264 Saves a bitmap in the named file. 9265 """ 9266 9267 def SetDepth(self, depth): 9268 """ 9269 SetDepth(depth) 9270 9271 Sets the depth member (does not affect the bitmap data). 9272 """ 9273 9274 def SetHeight(self, height): 9275 """ 9276 SetHeight(height) 9277 9278 Sets the height member (does not affect the bitmap data). 9279 """ 9280 9281 def SetMask(self, mask): 9282 """ 9283 SetMask(mask) 9284 9285 Sets the mask for this bitmap. 9286 """ 9287 9288 def SetPalette(self, palette): 9289 """ 9290 SetPalette(palette) 9291 9292 Sets the associated palette. 9293 """ 9294 9295 def SetWidth(self, width): 9296 """ 9297 SetWidth(width) 9298 9299 Sets the width member (does not affect the bitmap data). 9300 """ 9301 9302 @staticmethod 9303 def NewFromPNGData(data, size): 9304 """ 9305 NewFromPNGData(data, size) -> Bitmap 9306 9307 Loads a bitmap from the memory containing image data in PNG format. 9308 """ 9309 9310 def SetMaskColour(self, colour): 9311 """ 9312 SetMaskColour(colour) 9313 """ 9314 9315 def __nonzero__(self): 9316 """ 9317 __nonzero__() -> int 9318 """ 9319 9320 def __bool__(self): 9321 """ 9322 __bool__() -> int 9323 """ 9324 9325 def GetHandle(self): 9326 """ 9327 GetHandle() -> long 9328 9329 MSW-only method to fetch the windows handle for the bitmap. 9330 """ 9331 9332 def SetHandle(self, handle): 9333 """ 9334 SetHandle(handle) 9335 9336 MSW-only method to set the windows handle for the bitmap. 9337 """ 9338 9339 def SetSize(self, size): 9340 """ 9341 SetSize(size) 9342 9343 Set the bitmap size (does not alter the existing native bitmap data or 9344 image size). 9345 """ 9346 9347 def CopyFromBuffer(self, data, format=BitmapBufferFormat_RGB, stride=-1): 9348 """ 9349 CopyFromBuffer(data, format=BitmapBufferFormat_RGB, stride=-1) 9350 9351 Copy data from a buffer object to replace the bitmap pixel data. 9352 Default format is plain RGB, but other formats are now supported as 9353 well. The following symbols are used to specify the format of the 9354 bytes in the buffer: 9355 9356 ============================= ================================ 9357 wx.BitmapBufferFormat_RGB A simple sequence of RGB bytes 9358 wx.BitmapBufferFormat_RGBA A simple sequence of RGBA bytes 9359 wx.BitmapBufferFormat_ARGB32 A sequence of 32-bit values in 9360 native endian order, with alpha in the upper 8 bits, followed by red, 9361 green, and blue. 9362 wx.BitmapBufferFormat_RGB32 Same as above but the alpha byte is 9363 ignored. 9364 ============================= ================================ 9365 """ 9366 9367 def CopyToBuffer(self, data, format=BitmapBufferFormat_RGB, stride=-1): 9368 """ 9369 CopyToBuffer(data, format=BitmapBufferFormat_RGB, stride=-1) 9370 9371 Copy pixel data to a buffer object. See :meth:`CopyFromBuffer` for 9372 buffer 9373 format details. 9374 """ 9375 9376 @staticmethod 9377 def FromBufferAndAlpha(width, height, data, alpha): 9378 """ 9379 FromBufferAndAlpha(width, height, data, alpha) -> Bitmap 9380 9381 Creates a :class:`wx.Bitmap` from in-memory data. The data and alpha 9382 parameters must be a Python object that implements the buffer 9383 interface, such as a string, bytearray, etc. The data object 9384 is expected to contain a series of RGB bytes and be at least 9385 width*height*3 bytes long, while the alpha object is expected 9386 to be width*height bytes long and represents the image's alpha 9387 channel. On Windows and Mac the RGB values will be 9388 'premultiplied' by the alpha values. (The other platforms do 9389 the multiplication themselves.) 9390 9391 Unlike :func:`wx.ImageFromBuffer` the bitmap created with this 9392 function 9393 does not share the memory block with the buffer object. This is 9394 because the native pixel buffer format varies on different 9395 platforms, and so instead an efficient as possible copy of the 9396 data is made from the buffer object to the bitmap's native pixel 9397 buffer. 9398 """ 9399 9400 @staticmethod 9401 def FromBuffer(width, height, data): 9402 """ 9403 FromBuffer(width, height, data) -> Bitmap 9404 9405 Creates a :class:`wx.Bitmap` from in-memory data. The data parameter 9406 must be a Python object that implements the buffer interface, such 9407 as a string, bytearray, etc. The data object is expected to contain 9408 a series of RGB bytes and be at least width*height*3 bytes long. 9409 9410 Unlike :func:`wx.ImageFromBuffer` the bitmap created with this 9411 function 9412 does not share the memory block with the buffer object. This is 9413 because the native pixel buffer format varies on different 9414 platforms, and so instead an efficient as possible copy of the 9415 data is made from the buffer object to the bitmap's native pixel 9416 buffer. 9417 """ 9418 9419 @staticmethod 9420 def FromBufferRGBA(width, height, data): 9421 """ 9422 FromBufferRGBA(width, height, data) -> Bitmap 9423 9424 Creates a :class:`wx.Bitmap` from in-memory data. The data parameter 9425 must be a Python object that implements the buffer interface, such 9426 as a string, bytearray, etc. The data object is expected to contain 9427 a series of RGBA bytes and be at least width*height*4 bytes long. 9428 On Windows and Mac the RGB values will be 'premultiplied' by the 9429 alpha values. (The other platforms do the multiplication themselves.) 9430 9431 Unlike :func:`wx.ImageFromBuffer` the bitmap created with this 9432 function 9433 does not share the memory block with the buffer object. This is 9434 because the native pixel buffer format varies on different 9435 platforms, and so instead an efficient as possible copy of the 9436 data is made from the buffer object to the bitmap's native pixel 9437 buffer. 9438 """ 9439 9440 @staticmethod 9441 def FromRGBA(width, height, red=0, green=0, blue=0, alpha=0): 9442 """ 9443 FromRGBA(width, height, red=0, green=0, blue=0, alpha=0) -> Bitmap 9444 9445 Creates a new empty 32-bit :class:`wx.Bitmap` where every pixel has 9446 been 9447 initialized with the given RGBA values. 9448 """ 9449 Depth = property(None, None) 9450 Handle = property(None, None) 9451 Height = property(None, None) 9452 Mask = property(None, None) 9453 Palette = property(None, None) 9454 Size = property(None, None) 9455 Width = property(None, None) 9456# end of class Bitmap 9457 9458 9459class Mask(Object): 9460 """ 9461 Mask() 9462 Mask(bitmap, index) 9463 Mask(bitmap) 9464 Mask(bitmap, colour) 9465 9466 This class encapsulates a monochrome mask bitmap, where the masked 9467 area is black and the unmasked area is white. 9468 """ 9469 9470 def __init__(self, *args, **kw): 9471 """ 9472 Mask() 9473 Mask(bitmap, index) 9474 Mask(bitmap) 9475 Mask(bitmap, colour) 9476 9477 This class encapsulates a monochrome mask bitmap, where the masked 9478 area is black and the unmasked area is white. 9479 """ 9480 9481 def Create(self, *args, **kw): 9482 """ 9483 Create(bitmap, index) -> bool 9484 Create(bitmap) -> bool 9485 Create(bitmap, colour) -> bool 9486 9487 Constructs a mask from a bitmap and a palette index that indicates the 9488 background. 9489 """ 9490 9491 def GetBitmap(self): 9492 """ 9493 GetBitmap() -> Bitmap 9494 9495 Returns the mask as a monochrome bitmap. 9496 """ 9497 Bitmap = property(None, None) 9498# end of class Mask 9499 9500NullBitmap = Bitmap() 9501 9502@wx.deprecated 9503def BitmapFromBuffer(width, height, dataBuffer, alphaBuffer=None): 9504 """ 9505 A compatibility wrapper for :meth:`wx.Bitmap.FromBuffer` and :meth:`wx.Bitmap.FromBufferAndAlpha` 9506 """ 9507 pass 9508 9509@wx.deprecated 9510def BitmapFromBufferRGBA(width, height, dataBuffer): 9511 """ 9512 A compatibility wrapper for :meth:`wx.Bitmap.FromBufferRGBA` 9513 """ 9514 pass 9515 9516@wx.deprecated 9517def EmptyBitmapRGBA(width, height, red=0, green=0, blue=0, alpha=0): 9518 """ 9519 A compatibility wrapper for :meth:`wx.Bitmap.FromRGBA` 9520 """ 9521 pass 9522 9523@wx.deprecated 9524def EmptyBitmap(width, height, depth=BITMAP_SCREEN_DEPTH): 9525 """ 9526 A compatibility wrapper for the wx.Bitmap(width, height, depth) constructor 9527 """ 9528 pass 9529 9530@wx.deprecated 9531def BitmapFromImage(image): 9532 """ 9533 A compatibility wrapper for the wx.Bitmap(wx.Image) constructor 9534 """ 9535 pass 9536#-- end-bitmap --# 9537#-- begin-icon --# 9538ICON_SCREEN_DEPTH = 0 9539 9540class Icon(GDIObject): 9541 """ 9542 Icon() 9543 Icon(icon) 9544 Icon(name, type=BITMAP_TYPE_ANY, desiredWidth=-1, desiredHeight=-1) 9545 Icon(loc) 9546 Icon(bmp) 9547 9548 An icon is a small rectangular bitmap usually used for denoting a 9549 minimized application. 9550 """ 9551 9552 def __init__(self, *args, **kw): 9553 """ 9554 Icon() 9555 Icon(icon) 9556 Icon(name, type=BITMAP_TYPE_ANY, desiredWidth=-1, desiredHeight=-1) 9557 Icon(loc) 9558 Icon(bmp) 9559 9560 An icon is a small rectangular bitmap usually used for denoting a 9561 minimized application. 9562 """ 9563 9564 def CreateFromHICON(self, hicon): 9565 """ 9566 CreateFromHICON(hicon) -> bool 9567 9568 MSW-only method to create a wx.Icon from a native icon handle. 9569 """ 9570 9571 def CopyFromBitmap(self, bmp): 9572 """ 9573 CopyFromBitmap(bmp) 9574 9575 Copies bmp bitmap to this icon. 9576 """ 9577 9578 def GetDepth(self): 9579 """ 9580 GetDepth() -> int 9581 9582 Gets the colour depth of the icon. 9583 """ 9584 9585 def GetHeight(self): 9586 """ 9587 GetHeight() -> int 9588 9589 Gets the height of the icon in pixels. 9590 """ 9591 9592 def GetWidth(self): 9593 """ 9594 GetWidth() -> int 9595 9596 Gets the width of the icon in pixels. 9597 """ 9598 9599 def IsOk(self): 9600 """ 9601 IsOk() -> bool 9602 9603 Returns true if icon data is present. 9604 """ 9605 9606 def LoadFile(self, name, type=BITMAP_TYPE_ANY, desiredWidth=-1, desiredHeight=-1): 9607 """ 9608 LoadFile(name, type=BITMAP_TYPE_ANY, desiredWidth=-1, desiredHeight=-1) -> bool 9609 9610 Loads an icon from a file or resource. 9611 """ 9612 9613 def SetDepth(self, depth): 9614 """ 9615 SetDepth(depth) 9616 9617 Sets the depth member (does not affect the icon data). 9618 """ 9619 9620 def SetHeight(self, height): 9621 """ 9622 SetHeight(height) 9623 9624 Sets the height member (does not affect the icon data). 9625 """ 9626 9627 def SetWidth(self, width): 9628 """ 9629 SetWidth(width) 9630 9631 Sets the width member (does not affect the icon data). 9632 """ 9633 9634 def __nonzero__(self): 9635 """ 9636 __nonzero__() -> int 9637 """ 9638 9639 def __bool__(self): 9640 """ 9641 __bool__() -> int 9642 """ 9643 9644 def GetHandle(self): 9645 """ 9646 GetHandle() -> long 9647 """ 9648 9649 def SetHandle(self, handle): 9650 """ 9651 SetHandle(handle) 9652 """ 9653 Depth = property(None, None) 9654 Handle = property(None, None) 9655 Height = property(None, None) 9656 Width = property(None, None) 9657# end of class Icon 9658 9659NullIcon = Icon() 9660 9661@wx.deprecated 9662def EmptyIcon(): 9663 """ 9664 A compatibility wrapper for the :class:`Icon` constructor 9665 """ 9666 pass 9667#-- end-icon --# 9668#-- begin-iconloc --# 9669 9670class IconLocation(object): 9671 """ 9672 IconLocation() 9673 IconLocation(filename, num=0) 9674 9675 wxIconLocation is a tiny class describing the location of an 9676 (external, i.e. 9677 """ 9678 9679 def __init__(self, *args, **kw): 9680 """ 9681 IconLocation() 9682 IconLocation(filename, num=0) 9683 9684 wxIconLocation is a tiny class describing the location of an 9685 (external, i.e. 9686 """ 9687 9688 def IsOk(self): 9689 """ 9690 IsOk() -> bool 9691 9692 Returns true if the object is valid, i.e. was properly initialized, 9693 and false otherwise. 9694 """ 9695 9696 def SetFileName(self, filename): 9697 """ 9698 SetFileName(filename) 9699 """ 9700 9701 def GetFileName(self): 9702 """ 9703 GetFileName() -> String 9704 """ 9705 9706 def __nonzero__(self): 9707 """ 9708 __nonzero__() -> int 9709 """ 9710 9711 def __bool__(self): 9712 """ 9713 __bool__() -> int 9714 """ 9715 9716 def GetIndex(self): 9717 """ 9718 GetIndex() -> int 9719 """ 9720 9721 def SetIndex(self, num): 9722 """ 9723 SetIndex(num) 9724 """ 9725 FileName = property(None, None) 9726 Index = property(None, None) 9727# end of class IconLocation 9728 9729#-- end-iconloc --# 9730#-- begin-iconbndl --# 9731 9732class IconBundle(GDIObject): 9733 """ 9734 IconBundle() 9735 IconBundle(file, type=BITMAP_TYPE_ANY) 9736 IconBundle(stream, type=BITMAP_TYPE_ANY) 9737 IconBundle(icon) 9738 IconBundle(ic) 9739 9740 This class contains multiple copies of an icon in different sizes. 9741 """ 9742 FALLBACK_NONE = 0 9743 FALLBACK_SYSTEM = 0 9744 FALLBACK_NEAREST_LARGER = 0 9745 9746 def __init__(self, *args, **kw): 9747 """ 9748 IconBundle() 9749 IconBundle(file, type=BITMAP_TYPE_ANY) 9750 IconBundle(stream, type=BITMAP_TYPE_ANY) 9751 IconBundle(icon) 9752 IconBundle(ic) 9753 9754 This class contains multiple copies of an icon in different sizes. 9755 """ 9756 9757 def AddIcon(self, *args, **kw): 9758 """ 9759 AddIcon(file, type=BITMAP_TYPE_ANY) 9760 AddIcon(stream, type=BITMAP_TYPE_ANY) 9761 AddIcon(icon) 9762 9763 Adds all the icons contained in the file to the bundle; if the 9764 collection already contains icons with the same width and height, they 9765 are replaced by the new ones. 9766 """ 9767 9768 def GetIcon(self, *args, **kw): 9769 """ 9770 GetIcon(size, flags=FALLBACK_SYSTEM) -> Icon 9771 GetIcon(size=DefaultCoord, flags=FALLBACK_SYSTEM) -> Icon 9772 9773 Returns the icon with the given size. 9774 """ 9775 9776 def GetIconOfExactSize(self, size): 9777 """ 9778 GetIconOfExactSize(size) -> Icon 9779 9780 Returns the icon with exactly the given size or wxNullIcon if this 9781 size is not available. 9782 """ 9783 9784 def GetIconCount(self): 9785 """ 9786 GetIconCount() -> size_t 9787 9788 return the number of available icons 9789 """ 9790 9791 def GetIconByIndex(self, n): 9792 """ 9793 GetIconByIndex(n) -> Icon 9794 9795 return the icon at index (must be < GetIconCount()) 9796 """ 9797 9798 def IsEmpty(self): 9799 """ 9800 IsEmpty() -> bool 9801 9802 Returns true if the bundle doesn't contain any icons, false otherwise 9803 (in which case a call to GetIcon() with default parameter should 9804 return a valid icon). 9805 """ 9806 Icon = property(None, None) 9807 IconCount = property(None, None) 9808# end of class IconBundle 9809 9810NullIconBundle = IconBundle() 9811#-- end-iconbndl --# 9812#-- begin-font --# 9813FONTFAMILY_DEFAULT = 0 9814FONTFAMILY_DECORATIVE = 0 9815FONTFAMILY_ROMAN = 0 9816FONTFAMILY_SCRIPT = 0 9817FONTFAMILY_SWISS = 0 9818FONTFAMILY_MODERN = 0 9819FONTFAMILY_TELETYPE = 0 9820FONTFAMILY_MAX = 0 9821FONTFAMILY_UNKNOWN = 0 9822FONTSTYLE_NORMAL = 0 9823FONTSTYLE_ITALIC = 0 9824FONTSTYLE_SLANT = 0 9825FONTSTYLE_MAX = 0 9826FONTWEIGHT_NORMAL = 0 9827FONTWEIGHT_LIGHT = 0 9828FONTWEIGHT_BOLD = 0 9829FONTWEIGHT_MAX = 0 9830FONTSIZE_XX_SMALL = 0 9831FONTSIZE_X_SMALL = 0 9832FONTSIZE_SMALL = 0 9833FONTSIZE_MEDIUM = 0 9834FONTSIZE_LARGE = 0 9835FONTSIZE_X_LARGE = 0 9836FONTSIZE_XX_LARGE = 0 9837FONTFLAG_DEFAULT = 0 9838FONTFLAG_ITALIC = 0 9839FONTFLAG_SLANT = 0 9840FONTFLAG_LIGHT = 0 9841FONTFLAG_BOLD = 0 9842FONTFLAG_ANTIALIASED = 0 9843FONTFLAG_NOT_ANTIALIASED = 0 9844FONTFLAG_UNDERLINED = 0 9845FONTFLAG_STRIKETHROUGH = 0 9846FONTFLAG_MASK = 0 9847FONTENCODING_SYSTEM = 0 9848FONTENCODING_DEFAULT = 0 9849FONTENCODING_ISO8859_1 = 0 9850FONTENCODING_ISO8859_2 = 0 9851FONTENCODING_ISO8859_3 = 0 9852FONTENCODING_ISO8859_4 = 0 9853FONTENCODING_ISO8859_5 = 0 9854FONTENCODING_ISO8859_6 = 0 9855FONTENCODING_ISO8859_7 = 0 9856FONTENCODING_ISO8859_8 = 0 9857FONTENCODING_ISO8859_9 = 0 9858FONTENCODING_ISO8859_10 = 0 9859FONTENCODING_ISO8859_11 = 0 9860FONTENCODING_ISO8859_12 = 0 9861FONTENCODING_ISO8859_13 = 0 9862FONTENCODING_ISO8859_14 = 0 9863FONTENCODING_ISO8859_15 = 0 9864FONTENCODING_ISO8859_MAX = 0 9865FONTENCODING_KOI8 = 0 9866FONTENCODING_KOI8_U = 0 9867FONTENCODING_ALTERNATIVE = 0 9868FONTENCODING_BULGARIAN = 0 9869FONTENCODING_CP437 = 0 9870FONTENCODING_CP850 = 0 9871FONTENCODING_CP852 = 0 9872FONTENCODING_CP855 = 0 9873FONTENCODING_CP866 = 0 9874FONTENCODING_CP874 = 0 9875FONTENCODING_CP932 = 0 9876FONTENCODING_CP936 = 0 9877FONTENCODING_CP949 = 0 9878FONTENCODING_CP950 = 0 9879FONTENCODING_CP1250 = 0 9880FONTENCODING_CP1251 = 0 9881FONTENCODING_CP1252 = 0 9882FONTENCODING_CP1253 = 0 9883FONTENCODING_CP1254 = 0 9884FONTENCODING_CP1255 = 0 9885FONTENCODING_CP1256 = 0 9886FONTENCODING_CP1257 = 0 9887FONTENCODING_CP1258 = 0 9888FONTENCODING_CP1361 = 0 9889FONTENCODING_CP12_MAX = 0 9890FONTENCODING_UTF7 = 0 9891FONTENCODING_UTF8 = 0 9892FONTENCODING_EUC_JP = 0 9893FONTENCODING_UTF16BE = 0 9894FONTENCODING_UTF16LE = 0 9895FONTENCODING_UTF32BE = 0 9896FONTENCODING_UTF32LE = 0 9897FONTENCODING_MACROMAN = 0 9898FONTENCODING_MACJAPANESE = 0 9899FONTENCODING_MACCHINESETRAD = 0 9900FONTENCODING_MACKOREAN = 0 9901FONTENCODING_MACARABIC = 0 9902FONTENCODING_MACHEBREW = 0 9903FONTENCODING_MACGREEK = 0 9904FONTENCODING_MACCYRILLIC = 0 9905FONTENCODING_MACDEVANAGARI = 0 9906FONTENCODING_MACGURMUKHI = 0 9907FONTENCODING_MACGUJARATI = 0 9908FONTENCODING_MACORIYA = 0 9909FONTENCODING_MACBENGALI = 0 9910FONTENCODING_MACTAMIL = 0 9911FONTENCODING_MACTELUGU = 0 9912FONTENCODING_MACKANNADA = 0 9913FONTENCODING_MACMALAJALAM = 0 9914FONTENCODING_MACSINHALESE = 0 9915FONTENCODING_MACBURMESE = 0 9916FONTENCODING_MACKHMER = 0 9917FONTENCODING_MACTHAI = 0 9918FONTENCODING_MACLAOTIAN = 0 9919FONTENCODING_MACGEORGIAN = 0 9920FONTENCODING_MACARMENIAN = 0 9921FONTENCODING_MACCHINESESIMP = 0 9922FONTENCODING_MACTIBETAN = 0 9923FONTENCODING_MACMONGOLIAN = 0 9924FONTENCODING_MACETHIOPIC = 0 9925FONTENCODING_MACCENTRALEUR = 0 9926FONTENCODING_MACVIATNAMESE = 0 9927FONTENCODING_MACARABICEXT = 0 9928FONTENCODING_MACSYMBOL = 0 9929FONTENCODING_MACDINGBATS = 0 9930FONTENCODING_MACTURKISH = 0 9931FONTENCODING_MACCROATIAN = 0 9932FONTENCODING_MACICELANDIC = 0 9933FONTENCODING_MACROMANIAN = 0 9934FONTENCODING_MACCELTIC = 0 9935FONTENCODING_MACGAELIC = 0 9936FONTENCODING_MACKEYBOARD = 0 9937FONTENCODING_ISO2022_JP = 0 9938FONTENCODING_MAX = 0 9939FONTENCODING_MACMIN = 0 9940FONTENCODING_MACMAX = 0 9941FONTENCODING_UTF16 = 0 9942FONTENCODING_UTF32 = 0 9943FONTENCODING_UNICODE = 0 9944FONTENCODING_GB2312 = 0 9945FONTENCODING_BIG5 = 0 9946FONTENCODING_SHIFT_JIS = 0 9947FONTENCODING_EUC_KR = 0 9948FONTENCODING_JOHAB = 0 9949FONTENCODING_VIETNAMESE = 0 9950 9951class FontInfo(object): 9952 """ 9953 FontInfo() 9954 FontInfo(pointSize) 9955 FontInfo(pixelSize) 9956 9957 This class is a helper used for wxFont creation using named parameter 9958 idiom: it allows specifying various wxFont attributes using the 9959 chained calls to its clearly named methods instead of passing them in 9960 the fixed order to wxFont constructors. 9961 """ 9962 9963 def __init__(self, *args, **kw): 9964 """ 9965 FontInfo() 9966 FontInfo(pointSize) 9967 FontInfo(pixelSize) 9968 9969 This class is a helper used for wxFont creation using named parameter 9970 idiom: it allows specifying various wxFont attributes using the 9971 chained calls to its clearly named methods instead of passing them in 9972 the fixed order to wxFont constructors. 9973 """ 9974 9975 def Family(self, family): 9976 """ 9977 Family(family) -> FontInfo 9978 9979 Set the font family. 9980 """ 9981 9982 def FaceName(self, faceName): 9983 """ 9984 FaceName(faceName) -> FontInfo 9985 9986 Set the font face name to use. 9987 """ 9988 9989 def Bold(self, bold=True): 9990 """ 9991 Bold(bold=True) -> FontInfo 9992 9993 Use a bold version of the font. 9994 """ 9995 9996 def Light(self, light=True): 9997 """ 9998 Light(light=True) -> FontInfo 9999 10000 Use a lighter version of the font. 10001 """ 10002 10003 def Italic(self, italic=True): 10004 """ 10005 Italic(italic=True) -> FontInfo 10006 10007 Use an italic version of the font. 10008 """ 10009 10010 def Slant(self, slant=True): 10011 """ 10012 Slant(slant=True) -> FontInfo 10013 10014 Use a slanted version of the font. 10015 """ 10016 10017 def AntiAliased(self, antiAliased=True): 10018 """ 10019 AntiAliased(antiAliased=True) -> FontInfo 10020 10021 Set anti-aliasing flag. 10022 """ 10023 10024 def Underlined(self, underlined=True): 10025 """ 10026 Underlined(underlined=True) -> FontInfo 10027 10028 Use an underlined version of the font. 10029 """ 10030 10031 def Strikethrough(self, strikethrough=True): 10032 """ 10033 Strikethrough(strikethrough=True) -> FontInfo 10034 10035 Use a strike-through version of the font. 10036 """ 10037 10038 def Encoding(self, encoding): 10039 """ 10040 Encoding(encoding) -> FontInfo 10041 10042 Set the font encoding to use. 10043 """ 10044 10045 def AllFlags(self, flags): 10046 """ 10047 AllFlags(flags) -> FontInfo 10048 10049 Set all the font attributes at once. 10050 """ 10051# end of class FontInfo 10052 10053 10054class Font(GDIObject): 10055 """ 10056 Font() 10057 Font(font) 10058 Font(fontInfo) 10059 Font(pointSize, family, style, weight, underline=False, faceName=EmptyString, encoding=FONTENCODING_DEFAULT) 10060 Font(pixelSize, family, style, weight, underline=False, faceName=EmptyString, encoding=FONTENCODING_DEFAULT) 10061 Font(nativeInfoString) 10062 Font(nativeInfo) 10063 10064 A font is an object which determines the appearance of text. 10065 """ 10066 10067 def __init__(self, *args, **kw): 10068 """ 10069 Font() 10070 Font(font) 10071 Font(fontInfo) 10072 Font(pointSize, family, style, weight, underline=False, faceName=EmptyString, encoding=FONTENCODING_DEFAULT) 10073 Font(pixelSize, family, style, weight, underline=False, faceName=EmptyString, encoding=FONTENCODING_DEFAULT) 10074 Font(nativeInfoString) 10075 Font(nativeInfo) 10076 10077 A font is an object which determines the appearance of text. 10078 """ 10079 10080 def GetEncoding(self): 10081 """ 10082 GetEncoding() -> FontEncoding 10083 10084 Returns the encoding of this font. 10085 """ 10086 10087 def GetFaceName(self): 10088 """ 10089 GetFaceName() -> String 10090 10091 Returns the face name associated with the font, or the empty string if 10092 there is no face information. 10093 """ 10094 10095 def GetFamily(self): 10096 """ 10097 GetFamily() -> FontFamily 10098 10099 Gets the font family if possible. 10100 """ 10101 10102 def GetNativeFontInfoDesc(self): 10103 """ 10104 GetNativeFontInfoDesc() -> String 10105 10106 Returns the platform-dependent string completely describing this font. 10107 """ 10108 10109 def GetNativeFontInfoUserDesc(self): 10110 """ 10111 GetNativeFontInfoUserDesc() -> String 10112 10113 Returns a user-friendly string for this font object. 10114 """ 10115 10116 def GetNativeFontInfo(self): 10117 """ 10118 GetNativeFontInfo() -> NativeFontInfo 10119 10120 Returns the encoding of this font. 10121 """ 10122 10123 def GetPointSize(self): 10124 """ 10125 GetPointSize() -> int 10126 10127 Gets the point size. 10128 """ 10129 10130 def GetPixelSize(self): 10131 """ 10132 GetPixelSize() -> Size 10133 10134 Gets the pixel size. 10135 """ 10136 10137 def GetStyle(self): 10138 """ 10139 GetStyle() -> FontStyle 10140 10141 Gets the font style. 10142 """ 10143 10144 def GetUnderlined(self): 10145 """ 10146 GetUnderlined() -> bool 10147 10148 Returns true if the font is underlined, false otherwise. 10149 """ 10150 10151 def GetStrikethrough(self): 10152 """ 10153 GetStrikethrough() -> bool 10154 10155 Returns true if the font is stricken-through, false otherwise. 10156 """ 10157 10158 def GetWeight(self): 10159 """ 10160 GetWeight() -> FontWeight 10161 10162 Gets the font weight. 10163 """ 10164 10165 def IsFixedWidth(self): 10166 """ 10167 IsFixedWidth() -> bool 10168 10169 Returns true if the font is a fixed width (or monospaced) font, false 10170 if it is a proportional one or font is invalid. 10171 """ 10172 10173 def IsOk(self): 10174 """ 10175 IsOk() -> bool 10176 10177 Returns true if this object is a valid font, false otherwise. 10178 """ 10179 10180 def Bold(self): 10181 """ 10182 Bold() -> Font 10183 10184 Returns a bold version of this font. 10185 """ 10186 10187 def Italic(self): 10188 """ 10189 Italic() -> Font 10190 10191 Returns an italic version of this font. 10192 """ 10193 10194 def Larger(self): 10195 """ 10196 Larger() -> Font 10197 10198 Returns a larger version of this font. 10199 """ 10200 10201 def Smaller(self): 10202 """ 10203 Smaller() -> Font 10204 10205 Returns a smaller version of this font. 10206 """ 10207 10208 def Underlined(self): 10209 """ 10210 Underlined() -> Font 10211 10212 Returns underlined version of this font. 10213 """ 10214 10215 def Strikethrough(self): 10216 """ 10217 Strikethrough() -> Font 10218 10219 Returns stricken-through version of this font. 10220 """ 10221 10222 def MakeBold(self): 10223 """ 10224 MakeBold() -> Font 10225 10226 Changes this font to be bold. 10227 """ 10228 10229 def MakeItalic(self): 10230 """ 10231 MakeItalic() -> Font 10232 10233 Changes this font to be italic. 10234 """ 10235 10236 def MakeLarger(self): 10237 """ 10238 MakeLarger() -> Font 10239 10240 Changes this font to be larger. 10241 """ 10242 10243 def MakeSmaller(self): 10244 """ 10245 MakeSmaller() -> Font 10246 10247 Changes this font to be smaller. 10248 """ 10249 10250 def MakeUnderlined(self): 10251 """ 10252 MakeUnderlined() -> Font 10253 10254 Changes this font to be underlined. 10255 """ 10256 10257 def MakeStrikethrough(self): 10258 """ 10259 MakeStrikethrough() -> Font 10260 10261 Changes this font to be stricken-through. 10262 """ 10263 10264 def Scale(self, x): 10265 """ 10266 Scale(x) -> Font 10267 10268 Changes the size of this font. 10269 """ 10270 10271 def Scaled(self, x): 10272 """ 10273 Scaled(x) -> Font 10274 10275 Returns a scaled version of this font. 10276 """ 10277 10278 def SetEncoding(self, encoding): 10279 """ 10280 SetEncoding(encoding) 10281 10282 Sets the encoding for this font. 10283 """ 10284 10285 def SetFaceName(self, faceName): 10286 """ 10287 SetFaceName(faceName) -> bool 10288 10289 Sets the facename for the font. 10290 """ 10291 10292 def SetFamily(self, family): 10293 """ 10294 SetFamily(family) 10295 10296 Sets the font family. 10297 """ 10298 10299 def SetNativeFontInfo(self, *args, **kw): 10300 """ 10301 SetNativeFontInfo(info) -> bool 10302 SetNativeFontInfo(info) 10303 10304 Creates the font corresponding to the given native font description 10305 string which must have been previously returned by 10306 GetNativeFontInfoDesc(). 10307 """ 10308 10309 def SetNativeFontInfoUserDesc(self, info): 10310 """ 10311 SetNativeFontInfoUserDesc(info) -> bool 10312 10313 Creates the font corresponding to the given native font description 10314 string and returns true if the creation was successful. 10315 """ 10316 10317 def SetPointSize(self, pointSize): 10318 """ 10319 SetPointSize(pointSize) 10320 10321 Sets the point size. 10322 """ 10323 10324 def SetPixelSize(self, pixelSize): 10325 """ 10326 SetPixelSize(pixelSize) 10327 10328 Sets the pixel size. 10329 """ 10330 10331 def SetStyle(self, style): 10332 """ 10333 SetStyle(style) 10334 10335 Sets the font style. 10336 """ 10337 10338 def SetSymbolicSize(self, size): 10339 """ 10340 SetSymbolicSize(size) 10341 10342 Sets the font size using a predefined symbolic size name. 10343 """ 10344 10345 def SetSymbolicSizeRelativeTo(self, size, base): 10346 """ 10347 SetSymbolicSizeRelativeTo(size, base) 10348 10349 Sets the font size compared to the base font size. 10350 """ 10351 10352 def SetUnderlined(self, underlined): 10353 """ 10354 SetUnderlined(underlined) 10355 10356 Sets underlining. 10357 """ 10358 10359 def SetStrikethrough(self, strikethrough): 10360 """ 10361 SetStrikethrough(strikethrough) 10362 10363 Sets strike-through attribute of the font. 10364 """ 10365 10366 def SetWeight(self, weight): 10367 """ 10368 SetWeight(weight) 10369 10370 Sets the font weight. 10371 """ 10372 10373 @staticmethod 10374 def New(*args, **kw): 10375 """ 10376 New(pointSize, family, style, weight, underline=False, faceName=EmptyString, encoding=FONTENCODING_DEFAULT) -> Font 10377 New(pointSize, family, flags=FONTFLAG_DEFAULT, faceName=EmptyString, encoding=FONTENCODING_DEFAULT) -> Font 10378 New(pixelSize, family, style, weight, underline=False, faceName=EmptyString, encoding=FONTENCODING_DEFAULT) -> Font 10379 New(pixelSize, family, flags=FONTFLAG_DEFAULT, faceName=EmptyString, encoding=FONTENCODING_DEFAULT) -> Font 10380 New(nativeInfo) -> Font 10381 New(nativeInfoString) -> Font 10382 10383 This function takes the same parameters as the relative wxFont 10384 constructor and returns a new font object allocated on the heap. 10385 """ 10386 10387 def __ne__(self): 10388 """ 10389 """ 10390 10391 def __eq__(self): 10392 """ 10393 """ 10394 10395 @staticmethod 10396 def GetDefaultEncoding(): 10397 """ 10398 GetDefaultEncoding() -> FontEncoding 10399 10400 Returns the current application's default encoding. 10401 """ 10402 10403 @staticmethod 10404 def SetDefaultEncoding(encoding): 10405 """ 10406 SetDefaultEncoding(encoding) 10407 10408 Sets the default font encoding. 10409 """ 10410 Encoding = property(None, None) 10411 FaceName = property(None, None) 10412 Family = property(None, None) 10413 NativeFontInfoDesc = property(None, None) 10414 NativeFontInfoUserDesc = property(None, None) 10415 PointSize = property(None, None) 10416 PixelSize = property(None, None) 10417 Style = property(None, None) 10418 Weight = property(None, None) 10419 10420 def __nonzero__(self): 10421 """ 10422 __nonzero__() -> int 10423 """ 10424 10425 def __bool__(self): 10426 """ 10427 __bool__() -> int 10428 """ 10429 10430 def GetHFONT(self): 10431 """ 10432 GetHFONT() -> void 10433 10434 Returns the font's native handle. 10435 """ 10436 10437 def OSXGetCGFont(self): 10438 """ 10439 OSXGetCGFont() -> void 10440 10441 Returns the font's native handle. 10442 """ 10443 10444 def GetPangoFontDescription(self): 10445 """ 10446 GetPangoFontDescription() -> void 10447 10448 Returns the font's native handle. 10449 """ 10450 10451 def _copyFrom(self, other): 10452 """ 10453 _copyFrom(other) 10454 10455 For internal use only. 10456 """ 10457 10458 def SetNoAntiAliasing(self, no=True): 10459 """ 10460 10461 """ 10462 10463 def GetNoAntiAliasing(self): 10464 """ 10465 10466 """ 10467# end of class Font 10468 10469 10470class FontList(object): 10471 """ 10472 FontList() 10473 10474 A font list is a list containing all fonts which have been created. 10475 """ 10476 10477 def __init__(self): 10478 """ 10479 FontList() 10480 10481 A font list is a list containing all fonts which have been created. 10482 """ 10483 10484 def FindOrCreateFont(self, point_size, family, style, weight, underline=False, facename=EmptyString, encoding=FONTENCODING_DEFAULT): 10485 """ 10486 FindOrCreateFont(point_size, family, style, weight, underline=False, facename=EmptyString, encoding=FONTENCODING_DEFAULT) -> Font 10487 10488 Finds a font of the given specification, or creates one and adds it to 10489 the list. 10490 """ 10491# end of class FontList 10492 10493NullFont = Font() 10494 10495def FFont(self, pointSize, family, flags=FONTFLAG_DEFAULT, faceName=EmptyString, encoding=FONTENCODING_DEFAULT): 10496 """ 10497 FFont(pointSize, family, flags=FONTFLAG_DEFAULT, faceName=EmptyString, encoding=FONTENCODING_DEFAULT) 10498 """ 10499 10500# These stock fonts will be initialized when the wx.App object is created. 10501NORMAL_FONT = Font() 10502SMALL_FONT = Font() 10503ITALIC_FONT = Font() 10504SWISS_FONT = Font() 10505 10506wx.DEFAULT = int(wx.FONTFAMILY_DEFAULT) 10507wx.DECORATIVE = int(wx.FONTFAMILY_DECORATIVE) 10508wx.ROMAN = int(wx.FONTFAMILY_ROMAN) 10509wx.SCRIPT = int(wx.FONTFAMILY_SCRIPT) 10510wx.SWISS = int(wx.FONTFAMILY_SWISS) 10511wx.MODERN = int(wx.FONTFAMILY_MODERN) 10512wx.TELETYPE = int(wx.FONTFAMILY_TELETYPE) 10513 10514wx.NORMAL = int(wx.FONTWEIGHT_NORMAL) 10515wx.LIGHT = int(wx.FONTWEIGHT_LIGHT) 10516wx.BOLD = int(wx.FONTWEIGHT_BOLD) 10517 10518wx.NORMAL = int(wx.FONTSTYLE_NORMAL) 10519wx.ITALIC = int(wx.FONTSTYLE_ITALIC) 10520wx.SLANT = int(wx.FONTSTYLE_SLANT) 10521#-- end-font --# 10522#-- begin-fontutil --# 10523 10524class NativeFontInfo(object): 10525 """ 10526 NativeFontInfo() 10527 NativeFontInfo(info) 10528 10529 wxNativeFontInfo is platform-specific font representation: this class 10530 should be considered as an opaque font description only used by the 10531 native functions, the user code can only get the objects of this type 10532 from somewhere and pass it somewhere else (possibly save them 10533 somewhere using ToString() and restore them using FromString()) 10534 """ 10535 10536 def __init__(self, *args, **kw): 10537 """ 10538 NativeFontInfo() 10539 NativeFontInfo(info) 10540 10541 wxNativeFontInfo is platform-specific font representation: this class 10542 should be considered as an opaque font description only used by the 10543 native functions, the user code can only get the objects of this type 10544 from somewhere and pass it somewhere else (possibly save them 10545 somewhere using ToString() and restore them using FromString()) 10546 """ 10547 10548 def Init(self): 10549 """ 10550 Init() 10551 """ 10552 10553 def InitFromFont(self, font): 10554 """ 10555 InitFromFont(font) 10556 """ 10557 10558 def GetPointSize(self): 10559 """ 10560 GetPointSize() -> int 10561 """ 10562 10563 def GetStyle(self): 10564 """ 10565 GetStyle() -> FontStyle 10566 """ 10567 10568 def GetWeight(self): 10569 """ 10570 GetWeight() -> FontWeight 10571 """ 10572 10573 def GetUnderlined(self): 10574 """ 10575 GetUnderlined() -> bool 10576 """ 10577 10578 def GetFaceName(self): 10579 """ 10580 GetFaceName() -> String 10581 """ 10582 10583 def GetFamily(self): 10584 """ 10585 GetFamily() -> FontFamily 10586 """ 10587 10588 def GetEncoding(self): 10589 """ 10590 GetEncoding() -> FontEncoding 10591 """ 10592 10593 def SetPointSize(self, pointsize): 10594 """ 10595 SetPointSize(pointsize) 10596 """ 10597 10598 def SetStyle(self, style): 10599 """ 10600 SetStyle(style) 10601 """ 10602 10603 def SetWeight(self, weight): 10604 """ 10605 SetWeight(weight) 10606 """ 10607 10608 def SetUnderlined(self, underlined): 10609 """ 10610 SetUnderlined(underlined) 10611 """ 10612 10613 def SetFaceName(self, *args, **kw): 10614 """ 10615 SetFaceName(facename) -> bool 10616 SetFaceName(facenames) 10617 """ 10618 10619 def SetFamily(self, family): 10620 """ 10621 SetFamily(family) 10622 """ 10623 10624 def SetEncoding(self, encoding): 10625 """ 10626 SetEncoding(encoding) 10627 """ 10628 10629 def FromString(self, s): 10630 """ 10631 FromString(s) -> bool 10632 """ 10633 10634 def ToString(self): 10635 """ 10636 ToString() -> String 10637 """ 10638 10639 def FromUserString(self, s): 10640 """ 10641 FromUserString(s) -> bool 10642 """ 10643 10644 def ToUserString(self): 10645 """ 10646 ToUserString() -> String 10647 """ 10648 10649 def __str__(self): 10650 """ 10651 __str__() -> String 10652 """ 10653 Encoding = property(None, None) 10654 FaceName = property(None, None) 10655 Family = property(None, None) 10656 PointSize = property(None, None) 10657 Style = property(None, None) 10658 Underlined = property(None, None) 10659 Weight = property(None, None) 10660# end of class NativeFontInfo 10661 10662#-- end-fontutil --# 10663#-- begin-pen --# 10664PENSTYLE_INVALID = 0 10665PENSTYLE_SOLID = 0 10666PENSTYLE_DOT = 0 10667PENSTYLE_LONG_DASH = 0 10668PENSTYLE_SHORT_DASH = 0 10669PENSTYLE_DOT_DASH = 0 10670PENSTYLE_USER_DASH = 0 10671PENSTYLE_TRANSPARENT = 0 10672PENSTYLE_STIPPLE_MASK_OPAQUE = 0 10673PENSTYLE_STIPPLE_MASK = 0 10674PENSTYLE_STIPPLE = 0 10675PENSTYLE_BDIAGONAL_HATCH = 0 10676PENSTYLE_CROSSDIAG_HATCH = 0 10677PENSTYLE_FDIAGONAL_HATCH = 0 10678PENSTYLE_CROSS_HATCH = 0 10679PENSTYLE_HORIZONTAL_HATCH = 0 10680PENSTYLE_VERTICAL_HATCH = 0 10681PENSTYLE_FIRST_HATCH = 0 10682PENSTYLE_LAST_HATCH = 0 10683JOIN_INVALID = 0 10684JOIN_BEVEL = 0 10685JOIN_MITER = 0 10686JOIN_ROUND = 0 10687CAP_INVALID = 0 10688CAP_ROUND = 0 10689CAP_PROJECTING = 0 10690CAP_BUTT = 0 10691 10692class Pen(GDIObject): 10693 """ 10694 Pen() 10695 Pen(colour, width=1, style=PENSTYLE_SOLID) 10696 Pen(pen) 10697 10698 A pen is a drawing tool for drawing outlines. 10699 """ 10700 10701 def __init__(self, *args, **kw): 10702 """ 10703 Pen() 10704 Pen(colour, width=1, style=PENSTYLE_SOLID) 10705 Pen(pen) 10706 10707 A pen is a drawing tool for drawing outlines. 10708 """ 10709 10710 def SetColour(self, *args, **kw): 10711 """ 10712 SetColour(colour) 10713 SetColour(red, green, blue) 10714 10715 The pen's colour is changed to the given colour. 10716 """ 10717 10718 def GetCap(self): 10719 """ 10720 GetCap() -> PenCap 10721 10722 Returns the pen cap style, which may be one of wxCAP_ROUND, 10723 wxCAP_PROJECTING and wxCAP_BUTT. 10724 """ 10725 10726 def GetColour(self): 10727 """ 10728 GetColour() -> Colour 10729 10730 Returns a reference to the pen colour. 10731 """ 10732 10733 def GetDashes(self): 10734 """ 10735 GetDashes() -> ArrayInt 10736 10737 Gets an array of dashes (defined as char in X, DWORD under Windows). 10738 """ 10739 10740 def GetJoin(self): 10741 """ 10742 GetJoin() -> PenJoin 10743 10744 Returns the pen join style, which may be one of wxJOIN_BEVEL, 10745 wxJOIN_ROUND and wxJOIN_MITER. 10746 """ 10747 10748 def GetStipple(self): 10749 """ 10750 GetStipple() -> Bitmap 10751 10752 Gets a pointer to the stipple bitmap. 10753 """ 10754 10755 def GetStyle(self): 10756 """ 10757 GetStyle() -> PenStyle 10758 10759 Returns the pen style. 10760 """ 10761 10762 def GetWidth(self): 10763 """ 10764 GetWidth() -> int 10765 10766 Returns the pen width. 10767 """ 10768 10769 def IsOk(self): 10770 """ 10771 IsOk() -> bool 10772 10773 Returns true if the pen is initialised. 10774 """ 10775 10776 def IsNonTransparent(self): 10777 """ 10778 IsNonTransparent() -> bool 10779 10780 Returns true if the pen is a valid non-transparent pen. 10781 """ 10782 10783 def IsTransparent(self): 10784 """ 10785 IsTransparent() -> bool 10786 10787 Returns true if the pen is transparent. 10788 """ 10789 10790 def SetCap(self, capStyle): 10791 """ 10792 SetCap(capStyle) 10793 10794 Sets the pen cap style, which may be one of wxCAP_ROUND, 10795 wxCAP_PROJECTING and wxCAP_BUTT. 10796 """ 10797 10798 def SetDashes(self, dashes): 10799 """ 10800 SetDashes(dashes) 10801 10802 Associates an array of dash values (defined as char in X, DWORD under 10803 Windows) with the pen. 10804 """ 10805 10806 def SetJoin(self, join_style): 10807 """ 10808 SetJoin(join_style) 10809 10810 Sets the pen join style, which may be one of wxJOIN_BEVEL, 10811 wxJOIN_ROUND and wxJOIN_MITER. 10812 """ 10813 10814 def SetStipple(self, stipple): 10815 """ 10816 SetStipple(stipple) 10817 10818 Sets the bitmap for stippling. 10819 """ 10820 10821 def SetStyle(self, style): 10822 """ 10823 SetStyle(style) 10824 10825 Set the pen style. 10826 """ 10827 10828 def SetWidth(self, width): 10829 """ 10830 SetWidth(width) 10831 10832 Sets the pen width. 10833 """ 10834 10835 def __ne__(self): 10836 """ 10837 """ 10838 10839 def __eq__(self): 10840 """ 10841 """ 10842 Cap = property(None, None) 10843 Colour = property(None, None) 10844 Dashes = property(None, None) 10845 Join = property(None, None) 10846 Stipple = property(None, None) 10847 Style = property(None, None) 10848 Width = property(None, None) 10849 10850 def _copyFrom(self, other): 10851 """ 10852 _copyFrom(other) 10853 10854 For internal use only. 10855 """ 10856# end of class Pen 10857 10858 10859class PenList(object): 10860 """ 10861 PenList() 10862 10863 There is only one instance of this class: wxThePenList. 10864 """ 10865 10866 def __init__(self): 10867 """ 10868 PenList() 10869 10870 There is only one instance of this class: wxThePenList. 10871 """ 10872 10873 def FindOrCreatePen(self, colour, width=1, style=PENSTYLE_SOLID): 10874 """ 10875 FindOrCreatePen(colour, width=1, style=PENSTYLE_SOLID) -> Pen 10876 10877 Finds a pen with the specified attributes and returns it, else creates 10878 a new pen, adds it to the pen list, and returns it. 10879 """ 10880# end of class PenList 10881 10882NullPen = Pen() 10883 10884# These stock pens will be initialized when the wx.App object is created. 10885RED_PEN = Pen() 10886BLUE_PEN = Pen() 10887CYAN_PEN = Pen() 10888GREEN_PEN = Pen() 10889YELLOW_PEN = Pen() 10890BLACK_PEN = Pen() 10891WHITE_PEN = Pen() 10892TRANSPARENT_PEN = Pen() 10893BLACK_DASHED_PEN = Pen() 10894GREY_PEN = Pen() 10895MEDIUM_GREY_PEN = Pen() 10896LIGHT_GREY_PEN = Pen() 10897 10898wx.SOLID = int(wx.PENSTYLE_SOLID) 10899wx.DOT = int(wx.PENSTYLE_DOT) 10900wx.LONG_DASH = int(wx.PENSTYLE_LONG_DASH) 10901wx.SHORT_DASH = int(wx.PENSTYLE_SHORT_DASH) 10902wx.DOT_DASH = int(wx.PENSTYLE_DOT_DASH) 10903wx.USER_DASH = int(wx.PENSTYLE_USER_DASH) 10904wx.TRANSPARENT = int(wx.PENSTYLE_TRANSPARENT) 10905#-- end-pen --# 10906#-- begin-brush --# 10907BRUSHSTYLE_INVALID = 0 10908BRUSHSTYLE_SOLID = 0 10909BRUSHSTYLE_TRANSPARENT = 0 10910BRUSHSTYLE_STIPPLE_MASK_OPAQUE = 0 10911BRUSHSTYLE_STIPPLE_MASK = 0 10912BRUSHSTYLE_STIPPLE = 0 10913BRUSHSTYLE_BDIAGONAL_HATCH = 0 10914BRUSHSTYLE_CROSSDIAG_HATCH = 0 10915BRUSHSTYLE_FDIAGONAL_HATCH = 0 10916BRUSHSTYLE_CROSS_HATCH = 0 10917BRUSHSTYLE_HORIZONTAL_HATCH = 0 10918BRUSHSTYLE_VERTICAL_HATCH = 0 10919BRUSHSTYLE_FIRST_HATCH = 0 10920BRUSHSTYLE_LAST_HATCH = 0 10921 10922class Brush(GDIObject): 10923 """ 10924 Brush() 10925 Brush(colour, style=BRUSHSTYLE_SOLID) 10926 Brush(stippleBitmap) 10927 Brush(brush) 10928 10929 A brush is a drawing tool for filling in areas. 10930 """ 10931 10932 def __init__(self, *args, **kw): 10933 """ 10934 Brush() 10935 Brush(colour, style=BRUSHSTYLE_SOLID) 10936 Brush(stippleBitmap) 10937 Brush(brush) 10938 10939 A brush is a drawing tool for filling in areas. 10940 """ 10941 10942 def SetColour(self, *args, **kw): 10943 """ 10944 SetColour(colour) 10945 SetColour(red, green, blue) 10946 10947 Sets the brush colour using red, green and blue values. 10948 """ 10949 10950 def GetColour(self): 10951 """ 10952 GetColour() -> Colour 10953 10954 Returns a reference to the brush colour. 10955 """ 10956 10957 def GetStipple(self): 10958 """ 10959 GetStipple() -> Bitmap 10960 10961 Gets a pointer to the stipple bitmap. 10962 """ 10963 10964 def GetStyle(self): 10965 """ 10966 GetStyle() -> BrushStyle 10967 10968 Returns the brush style, one of the wxBrushStyle values. 10969 """ 10970 10971 def IsHatch(self): 10972 """ 10973 IsHatch() -> bool 10974 10975 Returns true if the style of the brush is any of hatched fills. 10976 """ 10977 10978 def IsOk(self): 10979 """ 10980 IsOk() -> bool 10981 10982 Returns true if the brush is initialised. 10983 """ 10984 10985 def IsNonTransparent(self): 10986 """ 10987 IsNonTransparent() -> bool 10988 10989 Returns true if the brush is a valid non-transparent brush. 10990 """ 10991 10992 def IsTransparent(self): 10993 """ 10994 IsTransparent() -> bool 10995 10996 Returns true if the brush is transparent. 10997 """ 10998 10999 def SetStipple(self, bitmap): 11000 """ 11001 SetStipple(bitmap) 11002 11003 Sets the stipple bitmap. 11004 """ 11005 11006 def SetStyle(self, style): 11007 """ 11008 SetStyle(style) 11009 11010 Sets the brush style. 11011 """ 11012 11013 def __ne__(self): 11014 """ 11015 """ 11016 11017 def __eq__(self): 11018 """ 11019 """ 11020 11021 def __nonzero__(self): 11022 """ 11023 __nonzero__() -> int 11024 """ 11025 11026 def __bool__(self): 11027 """ 11028 __bool__() -> int 11029 """ 11030 11031 def MacSetTheme(self, macThemeBrushID): 11032 """ 11033 MacSetTheme(macThemeBrushID) 11034 """ 11035 Colour = property(None, None) 11036 Stipple = property(None, None) 11037 Style = property(None, None) 11038 11039 def _copyFrom(self, other): 11040 """ 11041 _copyFrom(other) 11042 11043 For internal use only. 11044 """ 11045# end of class Brush 11046 11047 11048class BrushList(object): 11049 """ 11050 A brush list is a list containing all brushes which have been created. 11051 """ 11052 11053 def FindOrCreateBrush(self, colour, style=BRUSHSTYLE_SOLID): 11054 """ 11055 FindOrCreateBrush(colour, style=BRUSHSTYLE_SOLID) -> Brush 11056 11057 Finds a brush with the specified attributes and returns it, else 11058 creates a new brush, adds it to the brush list, and returns it. 11059 """ 11060# end of class BrushList 11061 11062NullBrush = Brush() 11063 11064# These stock brushes will be initialized when the wx.App object is created. 11065BLUE_BRUSH = Brush() 11066GREEN_BRUSH = Brush() 11067YELLOW_BRUSH = Brush() 11068WHITE_BRUSH = Brush() 11069BLACK_BRUSH = Brush() 11070GREY_BRUSH = Brush() 11071MEDIUM_GREY_BRUSH = Brush() 11072LIGHT_GREY_BRUSH = Brush() 11073TRANSPARENT_BRUSH = Brush() 11074CYAN_BRUSH = Brush() 11075RED_BRUSH = Brush() 11076 11077wx.STIPPLE_MASK_OPAQUE = int(wx.BRUSHSTYLE_STIPPLE_MASK_OPAQUE) 11078wx.STIPPLE_MASK = int(wx.BRUSHSTYLE_STIPPLE_MASK) 11079wx.STIPPLE = int(wx.BRUSHSTYLE_STIPPLE) 11080wx.BDIAGONAL_HATCH = int(wx.BRUSHSTYLE_BDIAGONAL_HATCH) 11081wx.CROSSDIAG_HATCH = int(wx.BRUSHSTYLE_CROSSDIAG_HATCH) 11082wx.FDIAGONAL_HATCH = int(wx.BRUSHSTYLE_FDIAGONAL_HATCH) 11083wx.CROSS_HATCH = int(wx.BRUSHSTYLE_CROSS_HATCH) 11084wx.HORIZONTAL_HATCH = int(wx.BRUSHSTYLE_HORIZONTAL_HATCH) 11085wx.VERTICAL_HATCH = int(wx.BRUSHSTYLE_VERTICAL_HATCH) 11086#-- end-brush --# 11087#-- begin-cursor --# 11088 11089class Cursor(GDIObject): 11090 """ 11091 Cursor() 11092 Cursor(cursorName, type=BITMAP_TYPE_ANY, hotSpotX=0, hotSpotY=0) 11093 Cursor(cursorId) 11094 Cursor(image) 11095 Cursor(cursor) 11096 11097 A cursor is a small bitmap usually used for denoting where the mouse 11098 pointer is, with a picture that might indicate the interpretation of a 11099 mouse click. 11100 """ 11101 11102 def __init__(self, *args, **kw): 11103 """ 11104 Cursor() 11105 Cursor(cursorName, type=BITMAP_TYPE_ANY, hotSpotX=0, hotSpotY=0) 11106 Cursor(cursorId) 11107 Cursor(image) 11108 Cursor(cursor) 11109 11110 A cursor is a small bitmap usually used for denoting where the mouse 11111 pointer is, with a picture that might indicate the interpretation of a 11112 mouse click. 11113 """ 11114 11115 def IsOk(self): 11116 """ 11117 IsOk() -> bool 11118 11119 Returns true if cursor data is present. 11120 """ 11121 11122 def __nonzero__(self): 11123 """ 11124 __nonzero__() -> int 11125 """ 11126 11127 def __bool__(self): 11128 """ 11129 __bool__() -> int 11130 """ 11131 11132 def GetHandle(self): 11133 """ 11134 GetHandle() -> long 11135 11136 Get the handle for the Cursor. Windows only. 11137 """ 11138 11139 def SetHandle(self, handle): 11140 """ 11141 SetHandle(handle) 11142 11143 Set the handle to use for this Cursor. Windows only. 11144 """ 11145 11146 def _copyFrom(self, other): 11147 """ 11148 _copyFrom(other) 11149 11150 For internal use only. 11151 """ 11152 Handle = property(None, None) 11153# end of class Cursor 11154 11155NullCursor = Cursor() 11156 11157# These stock cursors will be initialized when the wx.App object is created. 11158STANDARD_CURSOR = Cursor() 11159HOURGLASS_CURSOR = Cursor() 11160CROSS_CURSOR = Cursor() 11161 11162StockCursor = wx.deprecated(Cursor, "Use Cursor instead.") 11163 11164CursorFromImage = wx.deprecated(Cursor, "Use Cursor instead.") 11165#-- end-cursor --# 11166#-- begin-region --# 11167OutRegion = 0 11168PartRegion = 0 11169InRegion = 0 11170 11171class RegionIterator(Object): 11172 """ 11173 RegionIterator() 11174 RegionIterator(region) 11175 11176 This class is used to iterate through the rectangles in a region, 11177 typically when examining the damaged regions of a window within an 11178 OnPaint call. 11179 """ 11180 11181 def __init__(self, *args, **kw): 11182 """ 11183 RegionIterator() 11184 RegionIterator(region) 11185 11186 This class is used to iterate through the rectangles in a region, 11187 typically when examining the damaged regions of a window within an 11188 OnPaint call. 11189 """ 11190 11191 def GetH(self): 11192 """ 11193 GetH() -> Coord 11194 11195 An alias for GetHeight(). 11196 """ 11197 11198 def GetHeight(self): 11199 """ 11200 GetHeight() -> Coord 11201 11202 Returns the height value for the current region. 11203 """ 11204 11205 def GetRect(self): 11206 """ 11207 GetRect() -> Rect 11208 11209 Returns the current rectangle. 11210 """ 11211 11212 def GetW(self): 11213 """ 11214 GetW() -> Coord 11215 11216 An alias for GetWidth(). 11217 """ 11218 11219 def GetWidth(self): 11220 """ 11221 GetWidth() -> Coord 11222 11223 Returns the width value for the current region. 11224 """ 11225 11226 def GetX(self): 11227 """ 11228 GetX() -> Coord 11229 11230 Returns the x value for the current region. 11231 """ 11232 11233 def GetY(self): 11234 """ 11235 GetY() -> Coord 11236 11237 Returns the y value for the current region. 11238 """ 11239 11240 def HaveRects(self): 11241 """ 11242 HaveRects() -> bool 11243 11244 Returns true if there are still some rectangles; otherwise returns 11245 false. 11246 """ 11247 11248 def Reset(self, *args, **kw): 11249 """ 11250 Reset() 11251 Reset(region) 11252 11253 Resets the iterator to the beginning of the rectangles. 11254 """ 11255 11256 def __nonzero__(self): 11257 """ 11258 __nonzero__() -> int 11259 11260 Returns true while there are still rectangles available in the 11261 iteration. 11262 """ 11263 11264 def Next(self): 11265 """ 11266 Next() 11267 11268 Move the iterator to the next rectangle in the region. 11269 """ 11270 H = property(None, None) 11271 Height = property(None, None) 11272 Rect = property(None, None) 11273 W = property(None, None) 11274 Width = property(None, None) 11275 X = property(None, None) 11276 Y = property(None, None) 11277# end of class RegionIterator 11278 11279 11280class Region(GDIObject): 11281 """ 11282 Region() 11283 Region(x, y, width, height) 11284 Region(topLeft, bottomRight) 11285 Region(rect) 11286 Region(region) 11287 Region(bmp) 11288 Region(bmp, transColour, tolerance=0) 11289 Region(points, fillStyle=ODDEVEN_RULE) 11290 11291 A wxRegion represents a simple or complex region on a device context 11292 or window. 11293 """ 11294 11295 def __init__(self, *args, **kw): 11296 """ 11297 Region() 11298 Region(x, y, width, height) 11299 Region(topLeft, bottomRight) 11300 Region(rect) 11301 Region(region) 11302 Region(bmp) 11303 Region(bmp, transColour, tolerance=0) 11304 Region(points, fillStyle=ODDEVEN_RULE) 11305 11306 A wxRegion represents a simple or complex region on a device context 11307 or window. 11308 """ 11309 11310 def GetBox(self): 11311 """ 11312 GetBox() -> Rect 11313 11314 Returns the outer bounds of the region. 11315 """ 11316 11317 def Offset(self, *args, **kw): 11318 """ 11319 Offset(x, y) -> bool 11320 Offset(pt) -> bool 11321 11322 Moves the region by the specified offsets in horizontal and vertical 11323 directions. 11324 """ 11325 11326 def Clear(self): 11327 """ 11328 Clear() 11329 11330 Clears the current region. 11331 """ 11332 11333 def Contains(self, *args, **kw): 11334 """ 11335 Contains(x, y) -> RegionContain 11336 Contains(pt) -> RegionContain 11337 Contains(x, y, width, height) -> RegionContain 11338 Contains(rect) -> RegionContain 11339 11340 Returns a value indicating whether the given point is contained within 11341 the region. 11342 """ 11343 11344 def ConvertToBitmap(self): 11345 """ 11346 ConvertToBitmap() -> Bitmap 11347 11348 Convert the region to a black and white bitmap with the white pixels 11349 being inside the region. 11350 """ 11351 11352 def Intersect(self, *args, **kw): 11353 """ 11354 Intersect(x, y, width, height) -> bool 11355 Intersect(rect) -> bool 11356 Intersect(region) -> bool 11357 11358 Finds the intersection of this region and another, rectangular region, 11359 specified using position and size. 11360 """ 11361 11362 def IsEmpty(self): 11363 """ 11364 IsEmpty() -> bool 11365 11366 Returns true if the region is empty, false otherwise. 11367 """ 11368 11369 def IsEqual(self, region): 11370 """ 11371 IsEqual(region) -> bool 11372 11373 Returns true if the region is equal to, i.e. covers the same area as, 11374 another one. 11375 """ 11376 11377 def Subtract(self, *args, **kw): 11378 """ 11379 Subtract(rect) -> bool 11380 Subtract(region) -> bool 11381 11382 Subtracts a rectangular region from this region. 11383 """ 11384 11385 def Union(self, *args, **kw): 11386 """ 11387 Union(x, y, width, height) -> bool 11388 Union(rect) -> bool 11389 Union(region) -> bool 11390 Union(bmp) -> bool 11391 Union(bmp, transColour, tolerance=0) -> bool 11392 11393 Finds the union of this region and another, rectangular region, 11394 specified using position and size. 11395 """ 11396 11397 def Xor(self, *args, **kw): 11398 """ 11399 Xor(x, y, width, height) -> bool 11400 Xor(rect) -> bool 11401 Xor(region) -> bool 11402 11403 Finds the Xor of this region and another, rectangular region, 11404 specified using position and size. 11405 """ 11406 11407 def __iter__(self): 11408 """ 11409 Returns a rectangle interator conforming to the Python iterator 11410 protocol. 11411 """ 11412 11413 class PyRegionIterator(object): 11414 "A Python iterator for wx.Region objects" 11415 def __init__(self, region): 11416 self._region = region 11417 self._iterator = wx.RegionIterator(region) 11418 def next(self): 11419 if not self._iterator: 11420 raise StopIteration 11421 rect = self._iterator.GetRect() 11422 if self._iterator.HaveRects(): 11423 self._iterator.Next() 11424 return rect 11425 __next__ = next # for Python 3 11426 Box = property(None, None) 11427# end of class Region 11428 11429#-- end-region --# 11430#-- begin-dc --# 11431CLEAR = 0 11432XOR = 0 11433INVERT = 0 11434OR_REVERSE = 0 11435AND_REVERSE = 0 11436COPY = 0 11437AND = 0 11438AND_INVERT = 0 11439NO_OP = 0 11440NOR = 0 11441EQUIV = 0 11442SRC_INVERT = 0 11443OR_INVERT = 0 11444NAND = 0 11445OR = 0 11446SET = 0 11447FLOOD_SURFACE = 0 11448FLOOD_BORDER = 0 11449MM_TEXT = 0 11450MM_METRIC = 0 11451MM_LOMETRIC = 0 11452MM_TWIPS = 0 11453MM_POINTS = 0 11454 11455class FontMetrics(object): 11456 """ 11457 FontMetrics() 11458 11459 Simple collection of various font metrics. 11460 """ 11461 11462 def __init__(self): 11463 """ 11464 FontMetrics() 11465 11466 Simple collection of various font metrics. 11467 """ 11468 height = property(None, None) 11469 ascent = property(None, None) 11470 descent = property(None, None) 11471 internalLeading = property(None, None) 11472 externalLeading = property(None, None) 11473 averageWidth = property(None, None) 11474# end of class FontMetrics 11475 11476 11477class DC(Object): 11478 """ 11479 A wxDC is a "device context" onto which graphics and text can be 11480 drawn. 11481 """ 11482 11483 def DeviceToLogicalX(self, x): 11484 """ 11485 DeviceToLogicalX(x) -> Coord 11486 11487 Convert device X coordinate to logical coordinate, using the current 11488 mapping mode, user scale factor, device origin and axis orientation. 11489 """ 11490 11491 def DeviceToLogicalXRel(self, x): 11492 """ 11493 DeviceToLogicalXRel(x) -> Coord 11494 11495 Convert device X coordinate to relative logical coordinate, using the 11496 current mapping mode and user scale factor but ignoring the axis 11497 orientation. 11498 """ 11499 11500 def DeviceToLogicalY(self, y): 11501 """ 11502 DeviceToLogicalY(y) -> Coord 11503 11504 Converts device Y coordinate to logical coordinate, using the current 11505 mapping mode, user scale factor, device origin and axis orientation. 11506 """ 11507 11508 def DeviceToLogicalYRel(self, y): 11509 """ 11510 DeviceToLogicalYRel(y) -> Coord 11511 11512 Convert device Y coordinate to relative logical coordinate, using the 11513 current mapping mode and user scale factor but ignoring the axis 11514 orientation. 11515 """ 11516 11517 def LogicalToDeviceX(self, x): 11518 """ 11519 LogicalToDeviceX(x) -> Coord 11520 11521 Converts logical X coordinate to device coordinate, using the current 11522 mapping mode, user scale factor, device origin and axis orientation. 11523 """ 11524 11525 def LogicalToDeviceXRel(self, x): 11526 """ 11527 LogicalToDeviceXRel(x) -> Coord 11528 11529 Converts logical X coordinate to relative device coordinate, using the 11530 current mapping mode and user scale factor but ignoring the axis 11531 orientation. 11532 """ 11533 11534 def LogicalToDeviceY(self, y): 11535 """ 11536 LogicalToDeviceY(y) -> Coord 11537 11538 Converts logical Y coordinate to device coordinate, using the current 11539 mapping mode, user scale factor, device origin and axis orientation. 11540 """ 11541 11542 def LogicalToDeviceYRel(self, y): 11543 """ 11544 LogicalToDeviceYRel(y) -> Coord 11545 11546 Converts logical Y coordinate to relative device coordinate, using the 11547 current mapping mode and user scale factor but ignoring the axis 11548 orientation. 11549 """ 11550 11551 def Clear(self): 11552 """ 11553 Clear() 11554 11555 Clears the device context using the current background brush. 11556 """ 11557 11558 def DrawArc(self, *args, **kw): 11559 """ 11560 DrawArc(xStart, yStart, xEnd, yEnd, xc, yc) 11561 DrawArc(ptStart, ptEnd, centre) 11562 11563 Draws an arc from the given start to the given end point. 11564 """ 11565 11566 def DrawBitmap(self, *args, **kw): 11567 """ 11568 DrawBitmap(bitmap, x, y, useMask=False) 11569 DrawBitmap(bmp, pt, useMask=False) 11570 11571 Draw a bitmap on the device context at the specified point. 11572 """ 11573 11574 def DrawCheckMark(self, *args, **kw): 11575 """ 11576 DrawCheckMark(x, y, width, height) 11577 DrawCheckMark(rect) 11578 11579 Draws a check mark inside the given rectangle. 11580 """ 11581 11582 def DrawCircle(self, *args, **kw): 11583 """ 11584 DrawCircle(x, y, radius) 11585 DrawCircle(pt, radius) 11586 11587 Draws a circle with the given centre and radius. 11588 """ 11589 11590 def DrawEllipse(self, *args, **kw): 11591 """ 11592 DrawEllipse(x, y, width, height) 11593 DrawEllipse(pt, size) 11594 DrawEllipse(rect) 11595 11596 Draws an ellipse contained in the rectangle specified either with the 11597 given top left corner and the given size or directly. 11598 """ 11599 11600 def DrawEllipticArc(self, *args, **kw): 11601 """ 11602 DrawEllipticArc(x, y, width, height, start, end) 11603 DrawEllipticArc(pt, sz, sa, ea) 11604 11605 Draws an arc of an ellipse. 11606 """ 11607 11608 def DrawIcon(self, *args, **kw): 11609 """ 11610 DrawIcon(icon, x, y) 11611 DrawIcon(icon, pt) 11612 11613 Draw an icon on the display (does nothing if the device context is 11614 PostScript). 11615 """ 11616 11617 def DrawLabel(self, *args, **kw): 11618 """ 11619 DrawLabel(text, bitmap, rect, alignment=ALIGN_LEFT|ALIGN_TOP, indexAccel=-1) -> Rect 11620 DrawLabel(text, rect, alignment=ALIGN_LEFT|ALIGN_TOP, indexAccel=-1) 11621 11622 Draw optional bitmap and the text into the given rectangle and aligns 11623 it as specified by alignment parameter; it also will emphasize the 11624 character with the given index if it is != -1 and return the bounding 11625 rectangle if required. 11626 """ 11627 11628 def DrawLine(self, *args, **kw): 11629 """ 11630 DrawLine(x1, y1, x2, y2) 11631 DrawLine(pt1, pt2) 11632 11633 Draws a line from the first point to the second. 11634 """ 11635 11636 def DrawLines(self, points, xoffset=0, yoffset=0): 11637 """ 11638 DrawLines(points, xoffset=0, yoffset=0) 11639 11640 This method uses a list of wxPoints, adding the optional offset 11641 coordinate. 11642 """ 11643 11644 def DrawPoint(self, *args, **kw): 11645 """ 11646 DrawPoint(x, y) 11647 DrawPoint(pt) 11648 11649 Draws a point using the color of the current pen. 11650 """ 11651 11652 def DrawPolygon(self, points, xoffset=0, yoffset=0, fill_style=ODDEVEN_RULE): 11653 """ 11654 DrawPolygon(points, xoffset=0, yoffset=0, fill_style=ODDEVEN_RULE) 11655 11656 This method draws a filled polygon using a list of wxPoints, adding 11657 the optional offset coordinate. 11658 """ 11659 11660 def DrawRectangle(self, *args, **kw): 11661 """ 11662 DrawRectangle(x, y, width, height) 11663 DrawRectangle(pt, sz) 11664 DrawRectangle(rect) 11665 11666 Draws a rectangle with the given top left corner, and with the given 11667 size. 11668 """ 11669 11670 def DrawRotatedText(self, *args, **kw): 11671 """ 11672 DrawRotatedText(text, x, y, angle) 11673 DrawRotatedText(text, point, angle) 11674 11675 Draws the text rotated by angle degrees (positive angles are 11676 counterclockwise; the full angle is 360 degrees). 11677 """ 11678 11679 def DrawRoundedRectangle(self, *args, **kw): 11680 """ 11681 DrawRoundedRectangle(x, y, width, height, radius) 11682 DrawRoundedRectangle(pt, sz, radius) 11683 DrawRoundedRectangle(rect, radius) 11684 11685 Draws a rectangle with the given top left corner, and with the given 11686 size. 11687 """ 11688 11689 def DrawSpline(self, *args, **kw): 11690 """ 11691 DrawSpline(points) 11692 DrawSpline(x1, y1, x2, y2, x3, y3) 11693 11694 This is an overloaded member function, provided for convenience. It 11695 differs from the above function only in what argument(s) it accepts. 11696 """ 11697 11698 def DrawText(self, *args, **kw): 11699 """ 11700 DrawText(text, x, y) 11701 DrawText(text, pt) 11702 11703 Draws a text string at the specified point, using the current text 11704 font, and the current text foreground and background colours. 11705 """ 11706 11707 def GradientFillConcentric(self, *args, **kw): 11708 """ 11709 GradientFillConcentric(rect, initialColour, destColour) 11710 GradientFillConcentric(rect, initialColour, destColour, circleCenter) 11711 11712 Fill the area specified by rect with a radial gradient, starting from 11713 initialColour at the centre of the circle and fading to destColour on 11714 the circle outside. 11715 """ 11716 11717 def GradientFillLinear(self, rect, initialColour, destColour, nDirection=RIGHT): 11718 """ 11719 GradientFillLinear(rect, initialColour, destColour, nDirection=RIGHT) 11720 11721 Fill the area specified by rect with a linear gradient, starting from 11722 initialColour and eventually fading to destColour. 11723 """ 11724 11725 def FloodFill(self, *args, **kw): 11726 """ 11727 FloodFill(x, y, colour, style=FLOOD_SURFACE) -> bool 11728 FloodFill(pt, col, style=FLOOD_SURFACE) -> bool 11729 11730 Flood fills the device context starting from the given point, using 11731 the current brush colour, and using a style: 11732 """ 11733 11734 def CrossHair(self, *args, **kw): 11735 """ 11736 CrossHair(x, y) 11737 CrossHair(pt) 11738 11739 Displays a cross hair using the current pen. 11740 """ 11741 11742 def DestroyClippingRegion(self): 11743 """ 11744 DestroyClippingRegion() 11745 11746 Destroys the current clipping region so that none of the DC is 11747 clipped. 11748 """ 11749 11750 def GetClippingBox(self): 11751 """ 11752 GetClippingBox() -> (x, y, width, height) 11753 11754 Gets the rectangle surrounding the current clipping region. 11755 """ 11756 11757 def SetClippingRegion(self, *args, **kw): 11758 """ 11759 SetClippingRegion(x, y, width, height) 11760 SetClippingRegion(pt, sz) 11761 SetClippingRegion(rect) 11762 11763 Sets the clipping region for this device context to the intersection 11764 of the given region described by the parameters of this method and the 11765 previously set clipping region. 11766 """ 11767 11768 def SetDeviceClippingRegion(self, region): 11769 """ 11770 SetDeviceClippingRegion(region) 11771 11772 Sets the clipping region for this device context. 11773 """ 11774 11775 def GetCharHeight(self): 11776 """ 11777 GetCharHeight() -> Coord 11778 11779 Gets the character height of the currently set font. 11780 """ 11781 11782 def GetCharWidth(self): 11783 """ 11784 GetCharWidth() -> Coord 11785 11786 Gets the average character width of the currently set font. 11787 """ 11788 11789 def GetFontMetrics(self): 11790 """ 11791 GetFontMetrics() -> FontMetrics 11792 11793 Returns the various font characteristics. 11794 """ 11795 11796 def GetFullMultiLineTextExtent(self, string, font=None): 11797 """ 11798 GetFullMultiLineTextExtent(string, font=None) -> (w, h, heightLine) 11799 11800 Gets the dimensions of the string as it would be drawn. 11801 """ 11802 11803 def GetPartialTextExtents(self, text): 11804 """ 11805 GetPartialTextExtents(text) -> ArrayInt 11806 11807 Fills the widths array with the widths from the beginning of text to 11808 the corresponding character of text. 11809 """ 11810 11811 def GetFullTextExtent(self, string, font=None): 11812 """ 11813 GetFullTextExtent(string, font=None) -> (w, h, descent, externalLeading) 11814 11815 Gets the dimensions of the string as it would be drawn. 11816 """ 11817 11818 def GetBackgroundMode(self): 11819 """ 11820 GetBackgroundMode() -> int 11821 11822 Returns the current background mode: wxSOLID or wxTRANSPARENT. 11823 """ 11824 11825 def GetFont(self): 11826 """ 11827 GetFont() -> Font 11828 11829 Gets the current font. 11830 """ 11831 11832 def GetLayoutDirection(self): 11833 """ 11834 GetLayoutDirection() -> LayoutDirection 11835 11836 Gets the current layout direction of the device context. 11837 """ 11838 11839 def GetTextBackground(self): 11840 """ 11841 GetTextBackground() -> Colour 11842 11843 Gets the current text background colour. 11844 """ 11845 11846 def GetTextForeground(self): 11847 """ 11848 GetTextForeground() -> Colour 11849 11850 Gets the current text foreground colour. 11851 """ 11852 11853 def SetBackgroundMode(self, mode): 11854 """ 11855 SetBackgroundMode(mode) 11856 11857 mode may be one of wxSOLID and wxTRANSPARENT. 11858 """ 11859 11860 def SetFont(self, font): 11861 """ 11862 SetFont(font) 11863 11864 Sets the current font for the DC. 11865 """ 11866 11867 def SetTextBackground(self, colour): 11868 """ 11869 SetTextBackground(colour) 11870 11871 Sets the current text background colour for the DC. 11872 """ 11873 11874 def SetTextForeground(self, colour): 11875 """ 11876 SetTextForeground(colour) 11877 11878 Sets the current text foreground colour for the DC. 11879 """ 11880 11881 def SetLayoutDirection(self, dir): 11882 """ 11883 SetLayoutDirection(dir) 11884 11885 Sets the current layout direction for the device context. 11886 """ 11887 11888 def CalcBoundingBox(self, x, y): 11889 """ 11890 CalcBoundingBox(x, y) 11891 11892 Adds the specified point to the bounding box which can be retrieved 11893 with MinX(), MaxX() and MinY(), MaxY() functions. 11894 """ 11895 11896 def MaxX(self): 11897 """ 11898 MaxX() -> Coord 11899 11900 Gets the maximum horizontal extent used in drawing commands so far. 11901 """ 11902 11903 def MaxY(self): 11904 """ 11905 MaxY() -> Coord 11906 11907 Gets the maximum vertical extent used in drawing commands so far. 11908 """ 11909 11910 def MinX(self): 11911 """ 11912 MinX() -> Coord 11913 11914 Gets the minimum horizontal extent used in drawing commands so far. 11915 """ 11916 11917 def MinY(self): 11918 """ 11919 MinY() -> Coord 11920 11921 Gets the minimum vertical extent used in drawing commands so far. 11922 """ 11923 11924 def ResetBoundingBox(self): 11925 """ 11926 ResetBoundingBox() 11927 11928 Resets the bounding box: after a call to this function, the bounding 11929 box doesn't contain anything. 11930 """ 11931 11932 def StartDoc(self, message): 11933 """ 11934 StartDoc(message) -> bool 11935 11936 Starts a document (only relevant when outputting to a printer). 11937 """ 11938 11939 def StartPage(self): 11940 """ 11941 StartPage() 11942 11943 Starts a document page (only relevant when outputting to a printer). 11944 """ 11945 11946 def EndDoc(self): 11947 """ 11948 EndDoc() 11949 11950 Ends a document (only relevant when outputting to a printer). 11951 """ 11952 11953 def EndPage(self): 11954 """ 11955 EndPage() 11956 11957 Ends a document page (only relevant when outputting to a printer). 11958 """ 11959 11960 def Blit(self, xdest, ydest, width, height, source, xsrc, ysrc, logicalFunc=COPY, useMask=False, xsrcMask=DefaultCoord, ysrcMask=DefaultCoord): 11961 """ 11962 Blit(xdest, ydest, width, height, source, xsrc, ysrc, logicalFunc=COPY, useMask=False, xsrcMask=DefaultCoord, ysrcMask=DefaultCoord) -> bool 11963 11964 Copy from a source DC to this DC. 11965 """ 11966 11967 def StretchBlit(self, xdest, ydest, dstWidth, dstHeight, source, xsrc, ysrc, srcWidth, srcHeight, logicalFunc=COPY, useMask=False, xsrcMask=DefaultCoord, ysrcMask=DefaultCoord): 11968 """ 11969 StretchBlit(xdest, ydest, dstWidth, dstHeight, source, xsrc, ysrc, srcWidth, srcHeight, logicalFunc=COPY, useMask=False, xsrcMask=DefaultCoord, ysrcMask=DefaultCoord) -> bool 11970 11971 Copy from a source DC to this DC possibly changing the scale. 11972 """ 11973 11974 def GetBackground(self): 11975 """ 11976 GetBackground() -> Brush 11977 11978 Gets the brush used for painting the background. 11979 """ 11980 11981 def GetBrush(self): 11982 """ 11983 GetBrush() -> Brush 11984 11985 Gets the current brush. 11986 """ 11987 11988 def GetPen(self): 11989 """ 11990 GetPen() -> Pen 11991 11992 Gets the current pen. 11993 """ 11994 11995 def SetBackground(self, brush): 11996 """ 11997 SetBackground(brush) 11998 11999 Sets the current background brush for the DC. 12000 """ 12001 12002 def SetBrush(self, brush): 12003 """ 12004 SetBrush(brush) 12005 12006 Sets the current brush for the DC. 12007 """ 12008 12009 def SetPen(self, pen): 12010 """ 12011 SetPen(pen) 12012 12013 Sets the current pen for the DC. 12014 """ 12015 12016 def CanUseTransformMatrix(self): 12017 """ 12018 CanUseTransformMatrix() -> bool 12019 12020 Check if the use of transformation matrix is supported by the current 12021 system. 12022 """ 12023 12024 def SetTransformMatrix(self, matrix): 12025 """ 12026 SetTransformMatrix(matrix) -> bool 12027 12028 Set the transformation matrix. 12029 """ 12030 12031 def GetTransformMatrix(self): 12032 """ 12033 GetTransformMatrix() -> AffineMatrix2D 12034 12035 Return the transformation matrix used by this device context. 12036 """ 12037 12038 def ResetTransformMatrix(self): 12039 """ 12040 ResetTransformMatrix() 12041 12042 Revert the transformation matrix to identity matrix. 12043 """ 12044 12045 def CanDrawBitmap(self): 12046 """ 12047 CanDrawBitmap() -> bool 12048 12049 Does the DC support drawing bitmaps? 12050 """ 12051 12052 def CanGetTextExtent(self): 12053 """ 12054 CanGetTextExtent() -> bool 12055 12056 Does the DC support calculating the size required to draw text? 12057 """ 12058 12059 def GetLogicalOrigin(self): 12060 """ 12061 GetLogicalOrigin() -> (x, y) 12062 12063 Return the coordinates of the logical point (0, 0). 12064 """ 12065 12066 def CopyAttributes(self, dc): 12067 """ 12068 CopyAttributes(dc) 12069 12070 Copy attributes from another DC. 12071 """ 12072 12073 def GetDepth(self): 12074 """ 12075 GetDepth() -> int 12076 12077 Returns the depth (number of bits/pixel) of this DC. 12078 """ 12079 12080 def GetDeviceOrigin(self): 12081 """ 12082 GetDeviceOrigin() -> Point 12083 12084 Returns the current device origin. 12085 """ 12086 12087 def GetLogicalFunction(self): 12088 """ 12089 GetLogicalFunction() -> RasterOperationMode 12090 12091 Gets the current logical function. 12092 """ 12093 12094 def GetMapMode(self): 12095 """ 12096 GetMapMode() -> MappingMode 12097 12098 Gets the current mapping mode for the device context. 12099 """ 12100 12101 def GetPixel(self, x, y): 12102 """ 12103 GetPixel(x, y) -> Colour 12104 12105 Gets the colour at the specified location on the DC. 12106 """ 12107 12108 def GetPPI(self): 12109 """ 12110 GetPPI() -> Size 12111 12112 Returns the resolution of the device in pixels per inch. 12113 """ 12114 12115 def GetSize(self): 12116 """ 12117 GetSize() -> Size 12118 12119 This is an overloaded member function, provided for convenience. It 12120 differs from the above function only in what argument(s) it accepts. 12121 """ 12122 12123 def GetSizeMM(self): 12124 """ 12125 GetSizeMM() -> Size 12126 12127 This is an overloaded member function, provided for convenience. It 12128 differs from the above function only in what argument(s) it accepts. 12129 """ 12130 12131 def GetUserScale(self): 12132 """ 12133 GetUserScale() -> (x, y) 12134 12135 Gets the current user scale factor. 12136 """ 12137 12138 def IsOk(self): 12139 """ 12140 IsOk() -> bool 12141 12142 Returns true if the DC is ok to use. 12143 """ 12144 12145 def SetAxisOrientation(self, xLeftRight, yBottomUp): 12146 """ 12147 SetAxisOrientation(xLeftRight, yBottomUp) 12148 12149 Sets the x and y axis orientation (i.e. the direction from lowest to 12150 highest values on the axis). 12151 """ 12152 12153 def SetDeviceOrigin(self, x, y): 12154 """ 12155 SetDeviceOrigin(x, y) 12156 12157 Sets the device origin (i.e. the origin in pixels after scaling has 12158 been applied). 12159 """ 12160 12161 def SetLogicalFunction(self, function): 12162 """ 12163 SetLogicalFunction(function) 12164 12165 Sets the current logical function for the device context. 12166 """ 12167 12168 def SetMapMode(self, mode): 12169 """ 12170 SetMapMode(mode) 12171 12172 The mapping mode of the device context defines the unit of measurement 12173 used to convert logical units to device units. 12174 """ 12175 12176 def SetPalette(self, palette): 12177 """ 12178 SetPalette(palette) 12179 12180 If this is a window DC or memory DC, assigns the given palette to the 12181 window or bitmap associated with the DC. 12182 """ 12183 12184 def SetUserScale(self, xScale, yScale): 12185 """ 12186 SetUserScale(xScale, yScale) 12187 12188 Sets the user scaling factor, useful for applications which require 12189 'zooming'. 12190 """ 12191 12192 def GetHandle(self): 12193 """ 12194 GetHandle() -> UIntPtr 12195 12196 Returns a value that can be used as a handle to the native drawing 12197 context, if this wxDC has something that could be thought of in that 12198 way. 12199 """ 12200 12201 def GetAsBitmap(self, subrect=None): 12202 """ 12203 GetAsBitmap(subrect=None) -> Bitmap 12204 12205 If supported by the platform and the type of DC, fetch the contents of 12206 the DC, or a subset of it, as a bitmap. 12207 """ 12208 12209 def SetLogicalScale(self, x, y): 12210 """ 12211 SetLogicalScale(x, y) 12212 12213 Set the scale to use for translating wxDC coordinates to the physical 12214 pixels. 12215 """ 12216 12217 def GetLogicalScale(self): 12218 """ 12219 GetLogicalScale() -> (x, y) 12220 12221 Return the scale set by the last call to SetLogicalScale(). 12222 """ 12223 12224 def SetLogicalOrigin(self, x, y): 12225 """ 12226 SetLogicalOrigin(x, y) 12227 12228 Change the offset used for translating wxDC coordinates. 12229 """ 12230 12231 def GetClippingRect(self): 12232 """ 12233 Gets the rectangle surrounding the current clipping region 12234 """ 12235 12236 def GetTextExtent(self, st): 12237 """ 12238 GetTextExtent(st) -> Size 12239 12240 Return the dimensions of the given string's text extent using the 12241 currently selected font. 12242 12243 :param st: The string to be measured 12244 12245 .. seealso:: :meth:`~wx.DC.GetFullTextExtent` 12246 """ 12247 12248 def GetMultiLineTextExtent(self, st): 12249 """ 12250 GetMultiLineTextExtent(st) -> Size 12251 12252 Return the dimensions of the given string's text extent using the 12253 currently selected font, taking into account multiple lines if 12254 present in the string. 12255 12256 :param st: The string to be measured 12257 12258 .. seealso:: :meth:`~wx.DC.GetFullMultiLineTextExtent` 12259 """ 12260 12261 DrawImageLabel = wx.deprecated(DrawLabel, "Use DrawLabel instead.") 12262 12263 def __nonzero__(self): 12264 """ 12265 __nonzero__() -> int 12266 """ 12267 12268 def __bool__(self): 12269 """ 12270 __bool__() -> int 12271 """ 12272 12273 def GetBoundingBox(self): 12274 """ 12275 GetBoundingBox() -> (x1,y1, x2,y2) 12276 12277 Returns the min and max points used in drawing commands so far. 12278 """ 12279 12280 def GetHDC(self): 12281 """ 12282 GetHDC() -> long 12283 """ 12284 12285 def GetCGContext(self): 12286 """ 12287 GetCGContext() -> UIntPtr 12288 """ 12289 12290 def GetGdkDrawable(self): 12291 """ 12292 GetGdkDrawable() -> UIntPtr 12293 """ 12294 12295 GetHDC = wx.deprecated(GetHDC, "Use GetHandle instead.") 12296 12297 GetCGContext = wx.deprecated(GetCGContext, "Use GetHandle instead.") 12298 12299 GetGdkDrawable = wx.deprecated(GetGdkDrawable, "Use GetHandle instead.") 12300 12301 def __enter__(self): 12302 """ 12303 12304 """ 12305 12306 def __exit__(self, exc_type, exc_val, exc_tb): 12307 """ 12308 12309 """ 12310 12311 def _DrawPointList(self, pyCoords, pyPens, pyBrushes): 12312 """ 12313 _DrawPointList(pyCoords, pyPens, pyBrushes) -> PyObject 12314 """ 12315 12316 def _DrawLineList(self, pyCoords, pyPens, pyBrushes): 12317 """ 12318 _DrawLineList(pyCoords, pyPens, pyBrushes) -> PyObject 12319 """ 12320 12321 def _DrawRectangleList(self, pyCoords, pyPens, pyBrushes): 12322 """ 12323 _DrawRectangleList(pyCoords, pyPens, pyBrushes) -> PyObject 12324 """ 12325 12326 def _DrawEllipseList(self, pyCoords, pyPens, pyBrushes): 12327 """ 12328 _DrawEllipseList(pyCoords, pyPens, pyBrushes) -> PyObject 12329 """ 12330 12331 def _DrawPolygonList(self, pyCoords, pyPens, pyBrushes): 12332 """ 12333 _DrawPolygonList(pyCoords, pyPens, pyBrushes) -> PyObject 12334 """ 12335 12336 def _DrawTextList(self, textList, pyPoints, foregroundList, backgroundList): 12337 """ 12338 _DrawTextList(textList, pyPoints, foregroundList, backgroundList) -> PyObject 12339 """ 12340 12341 def DrawPointList(self, points, pens=None): 12342 """ 12343 Draw a list of points as quickly as possible. 12344 12345 :param points: A sequence of 2-element sequences representing 12346 each point to draw, (x,y). 12347 :param pens: If None, then the current pen is used. If a single 12348 pen then it will be used for all points. If a list of 12349 pens then there should be one for each point in points. 12350 """ 12351 12352 def DrawLineList(self, lines, pens=None): 12353 """ 12354 Draw a list of lines as quickly as possible. 12355 12356 :param lines: A sequence of 4-element sequences representing 12357 each line to draw, (x1,y1, x2,y2). 12358 :param pens: If None, then the current pen is used. If a 12359 single pen then it will be used for all lines. If 12360 a list of pens then there should be one for each line 12361 in lines. 12362 """ 12363 12364 def DrawRectangleList(self, rectangles, pens=None, brushes=None): 12365 """ 12366 Draw a list of rectangles as quickly as possible. 12367 12368 :param rectangles: A sequence of 4-element sequences representing 12369 each rectangle to draw, (x,y, w,h). 12370 :param pens: If None, then the current pen is used. If a 12371 single pen then it will be used for all rectangles. 12372 If a list of pens then there should be one for each 12373 rectangle in rectangles. 12374 :param brushes: A brush or brushes to be used to fill the rectagles, 12375 with similar semantics as the pens parameter. 12376 """ 12377 12378 def DrawEllipseList(self, ellipses, pens=None, brushes=None): 12379 """ 12380 Draw a list of ellipses as quickly as possible. 12381 12382 :param ellipses: A sequence of 4-element sequences representing 12383 each ellipse to draw, (x,y, w,h). 12384 :param pens: If None, then the current pen is used. If a 12385 single pen then it will be used for all ellipses. 12386 If a list of pens then there should be one for each 12387 ellipse in ellipses. 12388 :param brushes: A brush or brushes to be used to fill the ellipses, 12389 with similar semantics as the pens parameter. 12390 """ 12391 12392 def DrawPolygonList(self, polygons, pens=None, brushes=None): 12393 """ 12394 Draw a list of polygons, each of which is a list of points. 12395 12396 :param polygons: A sequence of sequences of sequences. 12397 [[(x1,y1),(x2,y2),(x3,y3)...], [(x1,y1),(x2,y2),(x3,y3)...]] 12398 12399 :param pens: If None, then the current pen is used. If a 12400 single pen then it will be used for all polygons. 12401 If a list of pens then there should be one for each 12402 polygon. 12403 :param brushes: A brush or brushes to be used to fill the polygons, 12404 with similar semantics as the pens parameter. 12405 """ 12406 12407 def DrawTextList(self, textList, coords, foregrounds=None, backgrounds=None): 12408 """ 12409 Draw a list of strings using a list of coordinants for positioning each string. 12410 12411 :param textList: A list of strings 12412 :param coords: A list of (x,y) positions 12413 :param foregrounds: A list of `wx.Colour` objects to use for the 12414 foregrounds of the strings. 12415 :param backgrounds: A list of `wx.Colour` objects to use for the 12416 backgrounds of the strings. 12417 12418 NOTE: Make sure you set background mode to wx.Solid (DC.SetBackgroundMode) 12419 If you want backgrounds to do anything. 12420 """ 12421 AsBitmap = property(None, None) 12422 Background = property(None, None) 12423 BackgroundMode = property(None, None) 12424 BoundingBox = property(None, None) 12425 Brush = property(None, None) 12426 CGContext = property(None, None) 12427 CharHeight = property(None, None) 12428 CharWidth = property(None, None) 12429 ClippingRect = property(None, None) 12430 Depth = property(None, None) 12431 DeviceOrigin = property(None, None) 12432 Font = property(None, None) 12433 FontMetrics = property(None, None) 12434 GdkDrawable = property(None, None) 12435 HDC = property(None, None) 12436 Handle = property(None, None) 12437 LayoutDirection = property(None, None) 12438 LogicalFunction = property(None, None) 12439 MapMode = property(None, None) 12440 MultiLineTextExtent = property(None, None) 12441 PPI = property(None, None) 12442 Pen = property(None, None) 12443 Pixel = property(None, None) 12444 Size = property(None, None) 12445 SizeMM = property(None, None) 12446 TextBackground = property(None, None) 12447 TextExtent = property(None, None) 12448 TextForeground = property(None, None) 12449 TransformMatrix = property(None, None) 12450# end of class DC 12451 12452 12453class DCClipper(object): 12454 """ 12455 DCClipper(dc, region) 12456 DCClipper(dc, rect) 12457 DCClipper(dc, x, y, w, h) 12458 12459 wxDCClipper is a helper class for setting a clipping region on a wxDC 12460 during its lifetime. 12461 """ 12462 12463 def __init__(self, *args, **kw): 12464 """ 12465 DCClipper(dc, region) 12466 DCClipper(dc, rect) 12467 DCClipper(dc, x, y, w, h) 12468 12469 wxDCClipper is a helper class for setting a clipping region on a wxDC 12470 during its lifetime. 12471 """ 12472 12473 def __enter__(self): 12474 """ 12475 12476 """ 12477 12478 def __exit__(self, exc_type, exc_val, exc_tb): 12479 """ 12480 12481 """ 12482# end of class DCClipper 12483 12484 12485class DCBrushChanger(object): 12486 """ 12487 DCBrushChanger(dc, brush) 12488 12489 wxDCBrushChanger is a small helper class for setting a brush on a wxDC 12490 and unsetting it automatically in the destructor, restoring the 12491 previous one. 12492 """ 12493 12494 def __init__(self, dc, brush): 12495 """ 12496 DCBrushChanger(dc, brush) 12497 12498 wxDCBrushChanger is a small helper class for setting a brush on a wxDC 12499 and unsetting it automatically in the destructor, restoring the 12500 previous one. 12501 """ 12502 12503 def __enter__(self): 12504 """ 12505 12506 """ 12507 12508 def __exit__(self, exc_type, exc_val, exc_tb): 12509 """ 12510 12511 """ 12512# end of class DCBrushChanger 12513 12514 12515class DCPenChanger(object): 12516 """ 12517 DCPenChanger(dc, pen) 12518 12519 wxDCPenChanger is a small helper class for setting a pen on a wxDC and 12520 unsetting it automatically in the destructor, restoring the previous 12521 one. 12522 """ 12523 12524 def __init__(self, dc, pen): 12525 """ 12526 DCPenChanger(dc, pen) 12527 12528 wxDCPenChanger is a small helper class for setting a pen on a wxDC and 12529 unsetting it automatically in the destructor, restoring the previous 12530 one. 12531 """ 12532 12533 def __enter__(self): 12534 """ 12535 12536 """ 12537 12538 def __exit__(self, exc_type, exc_val, exc_tb): 12539 """ 12540 12541 """ 12542# end of class DCPenChanger 12543 12544 12545class DCTextColourChanger(object): 12546 """ 12547 DCTextColourChanger(dc) 12548 DCTextColourChanger(dc, col) 12549 12550 wxDCTextColourChanger is a small helper class for setting a foreground 12551 text colour on a wxDC and unsetting it automatically in the 12552 destructor, restoring the previous one. 12553 """ 12554 12555 def __init__(self, *args, **kw): 12556 """ 12557 DCTextColourChanger(dc) 12558 DCTextColourChanger(dc, col) 12559 12560 wxDCTextColourChanger is a small helper class for setting a foreground 12561 text colour on a wxDC and unsetting it automatically in the 12562 destructor, restoring the previous one. 12563 """ 12564 12565 def Set(self, col): 12566 """ 12567 Set(col) 12568 12569 Set the colour to use. 12570 """ 12571 12572 def __enter__(self): 12573 """ 12574 12575 """ 12576 12577 def __exit__(self, exc_type, exc_val, exc_tb): 12578 """ 12579 12580 """ 12581# end of class DCTextColourChanger 12582 12583 12584class DCFontChanger(object): 12585 """ 12586 DCFontChanger(dc) 12587 DCFontChanger(dc, font) 12588 12589 wxDCFontChanger is a small helper class for setting a font on a wxDC 12590 and unsetting it automatically in the destructor, restoring the 12591 previous one. 12592 """ 12593 12594 def __init__(self, *args, **kw): 12595 """ 12596 DCFontChanger(dc) 12597 DCFontChanger(dc, font) 12598 12599 wxDCFontChanger is a small helper class for setting a font on a wxDC 12600 and unsetting it automatically in the destructor, restoring the 12601 previous one. 12602 """ 12603 12604 def Set(self, font): 12605 """ 12606 Set(font) 12607 12608 Set the font to use. 12609 """ 12610 12611 def __enter__(self): 12612 """ 12613 12614 """ 12615 12616 def __exit__(self, exc_type, exc_val, exc_tb): 12617 """ 12618 12619 """ 12620# end of class DCFontChanger 12621 12622#-- end-dc --# 12623#-- begin-dcclient --# 12624 12625class WindowDC(DC): 12626 """ 12627 WindowDC(window) 12628 12629 A wxWindowDC must be constructed if an application wishes to paint on 12630 the whole area of a window (client and decorations). 12631 """ 12632 12633 def __init__(self, window): 12634 """ 12635 WindowDC(window) 12636 12637 A wxWindowDC must be constructed if an application wishes to paint on 12638 the whole area of a window (client and decorations). 12639 """ 12640# end of class WindowDC 12641 12642 12643class ClientDC(WindowDC): 12644 """ 12645 ClientDC(window) 12646 12647 A wxClientDC must be constructed if an application wishes to paint on 12648 the client area of a window from outside an EVT_PAINT() handler. 12649 """ 12650 12651 def __init__(self, window): 12652 """ 12653 ClientDC(window) 12654 12655 A wxClientDC must be constructed if an application wishes to paint on 12656 the client area of a window from outside an EVT_PAINT() handler. 12657 """ 12658# end of class ClientDC 12659 12660 12661class PaintDC(ClientDC): 12662 """ 12663 PaintDC(window) 12664 12665 A wxPaintDC must be constructed if an application wishes to paint on 12666 the client area of a window from within an EVT_PAINT() event handler. 12667 """ 12668 12669 def __init__(self, window): 12670 """ 12671 PaintDC(window) 12672 12673 A wxPaintDC must be constructed if an application wishes to paint on 12674 the client area of a window from within an EVT_PAINT() event handler. 12675 """ 12676# end of class PaintDC 12677 12678#-- end-dcclient --# 12679#-- begin-dcmemory --# 12680 12681class MemoryDC(DC): 12682 """ 12683 MemoryDC() 12684 MemoryDC(dc) 12685 MemoryDC(bitmap) 12686 12687 A memory device context provides a means to draw graphics onto a 12688 bitmap. 12689 """ 12690 12691 def __init__(self, *args, **kw): 12692 """ 12693 MemoryDC() 12694 MemoryDC(dc) 12695 MemoryDC(bitmap) 12696 12697 A memory device context provides a means to draw graphics onto a 12698 bitmap. 12699 """ 12700 12701 def SelectObject(self, bitmap): 12702 """ 12703 SelectObject(bitmap) 12704 12705 Works exactly like SelectObjectAsSource() but this is the function you 12706 should use when you select a bitmap because you want to modify it, 12707 e.g. 12708 """ 12709 12710 def SelectObjectAsSource(self, bitmap): 12711 """ 12712 SelectObjectAsSource(bitmap) 12713 12714 Selects the given bitmap into the device context, to use as the memory 12715 bitmap. 12716 """ 12717# end of class MemoryDC 12718 12719#-- end-dcmemory --# 12720#-- begin-dcbuffer --# 12721BUFFER_VIRTUAL_AREA = 0 12722BUFFER_CLIENT_AREA = 0 12723BUFFER_USES_SHARED_BUFFER = 0 12724 12725class BufferedDC(MemoryDC): 12726 """ 12727 BufferedDC() 12728 BufferedDC(dc, area, style=BUFFER_CLIENT_AREA) 12729 BufferedDC(dc, buffer=NullBitmap, style=BUFFER_CLIENT_AREA) 12730 12731 This class provides a simple way to avoid flicker: when drawing on it, 12732 everything is in fact first drawn on an in-memory buffer (a wxBitmap) 12733 and then copied to the screen, using the associated wxDC, only once, 12734 when this object is destroyed. 12735 """ 12736 12737 def __init__(self, *args, **kw): 12738 """ 12739 BufferedDC() 12740 BufferedDC(dc, area, style=BUFFER_CLIENT_AREA) 12741 BufferedDC(dc, buffer=NullBitmap, style=BUFFER_CLIENT_AREA) 12742 12743 This class provides a simple way to avoid flicker: when drawing on it, 12744 everything is in fact first drawn on an in-memory buffer (a wxBitmap) 12745 and then copied to the screen, using the associated wxDC, only once, 12746 when this object is destroyed. 12747 """ 12748 12749 def Init(self, *args, **kw): 12750 """ 12751 Init(dc, area, style=BUFFER_CLIENT_AREA) 12752 Init(dc, buffer=NullBitmap, style=BUFFER_CLIENT_AREA) 12753 12754 Initializes the object created using the default constructor. 12755 """ 12756 12757 def UnMask(self): 12758 """ 12759 UnMask() 12760 12761 Blits the buffer to the dc, and detaches the dc from the buffer (so it 12762 can be effectively used once only). 12763 """ 12764 12765 def SetStyle(self, style): 12766 """ 12767 SetStyle(style) 12768 12769 Set the style. 12770 """ 12771 12772 def GetStyle(self): 12773 """ 12774 GetStyle() -> int 12775 12776 Get the style. 12777 """ 12778 Style = property(None, None) 12779# end of class BufferedDC 12780 12781 12782class BufferedPaintDC(BufferedDC): 12783 """ 12784 BufferedPaintDC(window, buffer, style=BUFFER_CLIENT_AREA) 12785 BufferedPaintDC(window, style=BUFFER_CLIENT_AREA) 12786 12787 This is a subclass of wxBufferedDC which can be used inside of an 12788 EVT_PAINT() event handler to achieve double-buffered drawing. 12789 """ 12790 12791 def __init__(self, *args, **kw): 12792 """ 12793 BufferedPaintDC(window, buffer, style=BUFFER_CLIENT_AREA) 12794 BufferedPaintDC(window, style=BUFFER_CLIENT_AREA) 12795 12796 This is a subclass of wxBufferedDC which can be used inside of an 12797 EVT_PAINT() event handler to achieve double-buffered drawing. 12798 """ 12799# end of class BufferedPaintDC 12800 12801 12802class AutoBufferedPaintDC(DC): 12803 """ 12804 AutoBufferedPaintDC(window) 12805 12806 This wxDC derivative can be used inside of an EVT_PAINT() event 12807 handler to achieve double-buffered drawing. 12808 """ 12809 12810 def __init__(self, window): 12811 """ 12812 AutoBufferedPaintDC(window) 12813 12814 This wxDC derivative can be used inside of an EVT_PAINT() event 12815 handler to achieve double-buffered drawing. 12816 """ 12817# end of class AutoBufferedPaintDC 12818 12819 12820def AutoBufferedPaintDCFactory(window): 12821 """ 12822 AutoBufferedPaintDCFactory(window) -> DC 12823 12824 Check if the window is natively double buffered and will return a 12825 wxPaintDC if it is, a wxBufferedPaintDC otherwise. 12826 """ 12827#-- end-dcbuffer --# 12828#-- begin-dcscreen --# 12829 12830class ScreenDC(DC): 12831 """ 12832 ScreenDC() 12833 12834 A wxScreenDC can be used to paint on the screen. 12835 """ 12836 12837 def __init__(self): 12838 """ 12839 ScreenDC() 12840 12841 A wxScreenDC can be used to paint on the screen. 12842 """ 12843 12844 @staticmethod 12845 def EndDrawingOnTop(): 12846 """ 12847 EndDrawingOnTop() -> bool 12848 12849 Use this in conjunction with StartDrawingOnTop(). 12850 """ 12851 12852 @staticmethod 12853 def StartDrawingOnTop(*args, **kw): 12854 """ 12855 StartDrawingOnTop(window) -> bool 12856 StartDrawingOnTop(rect=None) -> bool 12857 12858 Use this in conjunction with EndDrawingOnTop() to ensure that drawing 12859 to the screen occurs on top of existing windows. 12860 """ 12861# end of class ScreenDC 12862 12863#-- end-dcscreen --# 12864#-- begin-dcgraph --# 12865 12866class GCDC(DC): 12867 """ 12868 GCDC(windowDC) 12869 GCDC(memoryDC) 12870 GCDC(printerDC) 12871 GCDC(context) 12872 GCDC() 12873 12874 wxGCDC is a device context that draws on a wxGraphicsContext. 12875 """ 12876 12877 def __init__(self, *args, **kw): 12878 """ 12879 GCDC(windowDC) 12880 GCDC(memoryDC) 12881 GCDC(printerDC) 12882 GCDC(context) 12883 GCDC() 12884 12885 wxGCDC is a device context that draws on a wxGraphicsContext. 12886 """ 12887 12888 def GetGraphicsContext(self): 12889 """ 12890 GetGraphicsContext() -> GraphicsContext 12891 12892 Retrieves associated wxGraphicsContext. 12893 """ 12894 12895 def SetGraphicsContext(self, ctx): 12896 """ 12897 SetGraphicsContext(ctx) 12898 12899 Set the graphics context to be used for this wxGCDC. 12900 """ 12901 GraphicsContext = property(None, None) 12902# end of class GCDC 12903 12904#-- end-dcgraph --# 12905#-- begin-dcmirror --# 12906 12907class MirrorDC(DC): 12908 """ 12909 MirrorDC(dc, mirror) 12910 12911 wxMirrorDC is a simple wrapper class which is always associated with a 12912 real wxDC object and either forwards all of its operations to it 12913 without changes (no mirroring takes place) or exchanges x and y 12914 coordinates which makes it possible to reuse the same code to draw a 12915 figure and its mirror i.e. 12916 """ 12917 12918 def __init__(self, dc, mirror): 12919 """ 12920 MirrorDC(dc, mirror) 12921 12922 wxMirrorDC is a simple wrapper class which is always associated with a 12923 real wxDC object and either forwards all of its operations to it 12924 without changes (no mirroring takes place) or exchanges x and y 12925 coordinates which makes it possible to reuse the same code to draw a 12926 figure and its mirror i.e. 12927 """ 12928# end of class MirrorDC 12929 12930#-- end-dcmirror --# 12931#-- begin-dcprint --# 12932 12933class PrinterDC(DC): 12934 """ 12935 PrinterDC(printData) 12936 12937 A printer device context is specific to MSW and Mac, and allows access 12938 to any printer with a Windows or Macintosh driver. 12939 """ 12940 12941 def __init__(self, printData): 12942 """ 12943 PrinterDC(printData) 12944 12945 A printer device context is specific to MSW and Mac, and allows access 12946 to any printer with a Windows or Macintosh driver. 12947 """ 12948 12949 def GetPaperRect(self): 12950 """ 12951 GetPaperRect() -> Rect 12952 12953 Return the rectangle in device coordinates that corresponds to the 12954 full paper area, including the nonprinting regions of the paper. 12955 """ 12956 PaperRect = property(None, None) 12957# end of class PrinterDC 12958 12959#-- end-dcprint --# 12960#-- begin-dcps --# 12961 12962class PostScriptDC(DC): 12963 """ 12964 PostScriptDC() 12965 PostScriptDC(printData) 12966 12967 This defines the wxWidgets Encapsulated PostScript device context, 12968 which can write PostScript files on any platform. 12969 """ 12970 12971 def __init__(self, *args, **kw): 12972 """ 12973 PostScriptDC() 12974 PostScriptDC(printData) 12975 12976 This defines the wxWidgets Encapsulated PostScript device context, 12977 which can write PostScript files on any platform. 12978 """ 12979# end of class PostScriptDC 12980 12981#-- end-dcps --# 12982#-- begin-dcsvg --# 12983 12984class SVGFileDC(DC): 12985 """ 12986 SVGFileDC(filename, width=320, height=240, dpi=72) 12987 12988 A wxSVGFileDC is a device context onto which graphics and text can be 12989 drawn, and the output produced as a vector file, in SVG format. 12990 """ 12991 12992 def __init__(self, filename, width=320, height=240, dpi=72): 12993 """ 12994 SVGFileDC(filename, width=320, height=240, dpi=72) 12995 12996 A wxSVGFileDC is a device context onto which graphics and text can be 12997 drawn, and the output produced as a vector file, in SVG format. 12998 """ 12999 13000 def CrossHair(self, x, y): 13001 """ 13002 CrossHair(x, y) 13003 13004 Functions not implemented in this DC class. 13005 """ 13006 13007 def FloodFill(self, x, y, colour, style=FLOOD_SURFACE): 13008 """ 13009 FloodFill(x, y, colour, style=FLOOD_SURFACE) -> bool 13010 13011 Functions not implemented in this DC class. 13012 """ 13013 13014 def GetClippingBox(self, x, y, width, height): 13015 """ 13016 GetClippingBox(x, y, width, height) 13017 13018 Functions not implemented in this DC class. 13019 """ 13020 13021 def GetPixel(self, x, y, colour): 13022 """ 13023 GetPixel(x, y, colour) -> bool 13024 13025 Functions not implemented in this DC class. 13026 """ 13027 13028 def SetPalette(self, palette): 13029 """ 13030 SetPalette(palette) 13031 13032 Functions not implemented in this DC class. 13033 """ 13034 13035 def StartDoc(self, message): 13036 """ 13037 StartDoc(message) -> bool 13038 13039 Functions not implemented in this DC class. 13040 """ 13041 13042 def EndDoc(self): 13043 """ 13044 EndDoc() 13045 13046 Does nothing. 13047 """ 13048 13049 def EndPage(self): 13050 """ 13051 EndPage() 13052 13053 Does nothing. 13054 """ 13055 13056 def Clear(self): 13057 """ 13058 Clear() 13059 13060 Draws a rectangle the size of the SVG using the wxDC::SetBackground() 13061 brush. 13062 """ 13063 13064 def SetLogicalFunction(self, function): 13065 """ 13066 SetLogicalFunction(function) 13067 13068 Does the same as wxDC::SetLogicalFunction(), except that only wxCOPY 13069 is available. 13070 """ 13071 13072 def SetClippingRegion(self, *args, **kw): 13073 """ 13074 SetClippingRegion(x, y, width, height) 13075 SetClippingRegion(pt, sz) 13076 SetClippingRegion(rect) 13077 SetClippingRegion(region) 13078 13079 Sets the clipping region for this device context to the intersection 13080 of the given region described by the parameters of this method and the 13081 previously set clipping region. 13082 """ 13083 13084 def DestroyClippingRegion(self): 13085 """ 13086 DestroyClippingRegion() 13087 13088 Destroys the current clipping region so that none of the DC is 13089 clipped. 13090 """ 13091# end of class SVGFileDC 13092 13093#-- end-dcsvg --# 13094#-- begin-metafile --# 13095 13096class Metafile(Object): 13097 """ 13098 Metafile(filename=EmptyString) 13099 13100 A wxMetafile represents the MS Windows metafile object, so metafile 13101 operations have no effect in X. 13102 """ 13103 13104 def __init__(self, filename=EmptyString): 13105 """ 13106 Metafile(filename=EmptyString) 13107 13108 A wxMetafile represents the MS Windows metafile object, so metafile 13109 operations have no effect in X. 13110 """ 13111 13112 def IsOk(self): 13113 """ 13114 IsOk() -> bool 13115 13116 Returns true if the metafile is valid. 13117 """ 13118 13119 def Play(self, dc): 13120 """ 13121 Play(dc) -> bool 13122 13123 Plays the metafile into the given device context, returning true if 13124 successful. 13125 """ 13126 13127 def SetClipboard(self, width=0, height=0): 13128 """ 13129 SetClipboard(width=0, height=0) -> bool 13130 13131 Passes the metafile data to the clipboard. 13132 """ 13133# end of class Metafile 13134 13135 13136class MetafileDC(DC): 13137 """ 13138 MetafileDC(filename=EmptyString) 13139 13140 This is a type of device context that allows a metafile object to be 13141 created (Windows only), and has most of the characteristics of a 13142 normal wxDC. 13143 """ 13144 13145 def __init__(self, filename=EmptyString): 13146 """ 13147 MetafileDC(filename=EmptyString) 13148 13149 This is a type of device context that allows a metafile object to be 13150 created (Windows only), and has most of the characteristics of a 13151 normal wxDC. 13152 """ 13153 13154 def Close(self): 13155 """ 13156 Close() -> Metafile 13157 13158 This must be called after the device context is finished with. 13159 """ 13160# end of class MetafileDC 13161 13162#-- end-metafile --# 13163#-- begin-graphics --# 13164ANTIALIAS_NONE = 0 13165ANTIALIAS_DEFAULT = 0 13166INTERPOLATION_DEFAULT = 0 13167INTERPOLATION_NONE = 0 13168INTERPOLATION_FAST = 0 13169INTERPOLATION_GOOD = 0 13170INTERPOLATION_BEST = 0 13171COMPOSITION_INVALID = 0 13172COMPOSITION_CLEAR = 0 13173COMPOSITION_SOURCE = 0 13174COMPOSITION_OVER = 0 13175COMPOSITION_IN = 0 13176COMPOSITION_OUT = 0 13177COMPOSITION_ATOP = 0 13178COMPOSITION_DEST = 0 13179COMPOSITION_DEST_OVER = 0 13180COMPOSITION_DEST_IN = 0 13181COMPOSITION_DEST_OUT = 0 13182COMPOSITION_DEST_ATOP = 0 13183COMPOSITION_XOR = 0 13184COMPOSITION_ADD = 0 13185 13186class GraphicsObject(Object): 13187 """ 13188 This class is the superclass of native graphics objects like pens etc. 13189 """ 13190 13191 def GetRenderer(self): 13192 """ 13193 GetRenderer() -> GraphicsRenderer 13194 13195 Returns the renderer that was used to create this instance, or NULL if 13196 it has not been initialized yet. 13197 """ 13198 13199 def IsNull(self): 13200 """ 13201 IsNull() -> bool 13202 """ 13203 13204 def IsOk(self): 13205 """ 13206 IsOk() -> bool 13207 """ 13208 13209 def __nonzero__(self): 13210 """ 13211 __nonzero__() -> int 13212 """ 13213 13214 def __bool__(self): 13215 """ 13216 __bool__() -> int 13217 """ 13218 Renderer = property(None, None) 13219# end of class GraphicsObject 13220 13221 13222class GraphicsBitmap(GraphicsObject): 13223 """ 13224 GraphicsBitmap() 13225 13226 Represents a bitmap. 13227 """ 13228 13229 def __init__(self): 13230 """ 13231 GraphicsBitmap() 13232 13233 Represents a bitmap. 13234 """ 13235 13236 def ConvertToImage(self): 13237 """ 13238 ConvertToImage() -> Image 13239 13240 Return the contents of this bitmap as wxImage. 13241 """ 13242 13243 def GetNativeBitmap(self): 13244 """ 13245 GetNativeBitmap() -> void 13246 13247 Return the pointer to the native bitmap data. 13248 """ 13249 NativeBitmap = property(None, None) 13250# end of class GraphicsBitmap 13251 13252 13253class GraphicsBrush(GraphicsObject): 13254 """ 13255 A wxGraphicsBrush is a native representation of a brush. 13256 """ 13257# end of class GraphicsBrush 13258 13259 13260class GraphicsFont(GraphicsObject): 13261 """ 13262 A wxGraphicsFont is a native representation of a font. 13263 """ 13264# end of class GraphicsFont 13265 13266 13267class GraphicsPen(GraphicsObject): 13268 """ 13269 A wxGraphicsPen is a native representation of a pen. 13270 """ 13271# end of class GraphicsPen 13272 13273 13274class GraphicsContext(GraphicsObject): 13275 """ 13276 A wxGraphicsContext instance is the object that is drawn upon. 13277 """ 13278 13279 def CreateLinearGradientBrush(self, *args, **kw): 13280 """ 13281 CreateLinearGradientBrush(x1, y1, x2, y2, c1, c2) -> GraphicsBrush 13282 CreateLinearGradientBrush(x1, y1, x2, y2, stops) -> GraphicsBrush 13283 13284 Creates a native brush with a linear gradient. 13285 """ 13286 13287 def CreateRadialGradientBrush(self, *args, **kw): 13288 """ 13289 CreateRadialGradientBrush(xo, yo, xc, yc, radius, oColor, cColor) -> GraphicsBrush 13290 CreateRadialGradientBrush(xo, yo, xc, yc, radius, stops) -> GraphicsBrush 13291 13292 Creates a native brush with a radial gradient. 13293 """ 13294 13295 def DrawBitmap(self, *args, **kw): 13296 """ 13297 DrawBitmap(bmp, x, y, w, h) 13298 DrawBitmap(bmp, x, y, w, h) 13299 13300 Draws the bitmap. 13301 """ 13302 13303 @staticmethod 13304 def Create(*args, **kw): 13305 """ 13306 Create(window) -> GraphicsContext 13307 Create(windowDC) -> GraphicsContext 13308 Create(memoryDC) -> GraphicsContext 13309 Create(printerDC) -> GraphicsContext 13310 Create(metaFileDC) -> GraphicsContext 13311 Create(image) -> GraphicsContext 13312 Create() -> GraphicsContext 13313 Create(autoPaintDC) -> GraphicsContext 13314 13315 Creates a wxGraphicsContext from a wxWindow. 13316 """ 13317 13318 @staticmethod 13319 def CreateFromNative(context): 13320 """ 13321 CreateFromNative(context) -> GraphicsContext 13322 13323 Creates a wxGraphicsContext from a native context. 13324 """ 13325 13326 @staticmethod 13327 def CreateFromNativeWindow(window): 13328 """ 13329 CreateFromNativeWindow(window) -> GraphicsContext 13330 13331 Creates a wxGraphicsContext from a native window. 13332 """ 13333 13334 def Clip(self, *args, **kw): 13335 """ 13336 Clip(region) 13337 Clip(x, y, w, h) 13338 13339 Clips drawings to the specified region. 13340 """ 13341 13342 def ConcatTransform(self, matrix): 13343 """ 13344 ConcatTransform(matrix) 13345 13346 Concatenates the passed in transform with the current transform of 13347 this context. 13348 """ 13349 13350 def CreateBitmap(self, bitmap): 13351 """ 13352 CreateBitmap(bitmap) -> GraphicsBitmap 13353 13354 Creates wxGraphicsBitmap from an existing wxBitmap. 13355 """ 13356 13357 def CreateBitmapFromImage(self, image): 13358 """ 13359 CreateBitmapFromImage(image) -> GraphicsBitmap 13360 13361 Creates wxGraphicsBitmap from an existing wxImage. 13362 """ 13363 13364 def CreateSubBitmap(self, bitmap, x, y, w, h): 13365 """ 13366 CreateSubBitmap(bitmap, x, y, w, h) -> GraphicsBitmap 13367 13368 Extracts a sub-bitmap from an existing bitmap. 13369 """ 13370 13371 def CreateBrush(self, brush): 13372 """ 13373 CreateBrush(brush) -> GraphicsBrush 13374 13375 Creates a native brush from a wxBrush. 13376 """ 13377 13378 def CreateFont(self, *args, **kw): 13379 """ 13380 CreateFont(font, col=BLACK) -> GraphicsFont 13381 CreateFont(sizeInPixels, facename, flags=FONTFLAG_DEFAULT, col=BLACK) -> GraphicsFont 13382 13383 Creates a native graphics font from a wxFont and a text colour. 13384 """ 13385 13386 def CreateMatrix(self, *args, **kw): 13387 """ 13388 CreateMatrix(a=1.0, b=0.0, c=0.0, d=1.0, tx=0.0, ty=0.0) -> GraphicsMatrix 13389 CreateMatrix(mat) -> GraphicsMatrix 13390 13391 Creates a native affine transformation matrix from the passed in 13392 values. 13393 """ 13394 13395 def CreatePath(self): 13396 """ 13397 CreatePath() -> GraphicsPath 13398 13399 Creates a native graphics path which is initially empty. 13400 """ 13401 13402 def CreatePen(self, pen): 13403 """ 13404 CreatePen(pen) -> GraphicsPen 13405 13406 Creates a native pen from a wxPen. 13407 """ 13408 13409 def DrawEllipse(self, x, y, w, h): 13410 """ 13411 DrawEllipse(x, y, w, h) 13412 13413 Draws an ellipse. 13414 """ 13415 13416 def DrawIcon(self, icon, x, y, w, h): 13417 """ 13418 DrawIcon(icon, x, y, w, h) 13419 13420 Draws the icon. 13421 """ 13422 13423 def DrawLines(self, point2Ds, fillStyle=ODDEVEN_RULE): 13424 """ 13425 DrawLines(point2Ds, fillStyle=ODDEVEN_RULE) 13426 13427 Draws a polygon. 13428 """ 13429 13430 def DrawPath(self, path, fillStyle=ODDEVEN_RULE): 13431 """ 13432 DrawPath(path, fillStyle=ODDEVEN_RULE) 13433 13434 Draws the path by first filling and then stroking. 13435 """ 13436 13437 def DrawRectangle(self, x, y, w, h): 13438 """ 13439 DrawRectangle(x, y, w, h) 13440 13441 Draws a rectangle. 13442 """ 13443 13444 def DrawRoundedRectangle(self, x, y, w, h, radius): 13445 """ 13446 DrawRoundedRectangle(x, y, w, h, radius) 13447 13448 Draws a rounded rectangle. 13449 """ 13450 13451 def DrawText(self, *args, **kw): 13452 """ 13453 DrawText(str, x, y) 13454 DrawText(str, x, y, angle) 13455 DrawText(str, x, y, backgroundBrush) 13456 DrawText(str, x, y, angle, backgroundBrush) 13457 13458 Draws text at the defined position. 13459 """ 13460 13461 def FillPath(self, path, fillStyle=ODDEVEN_RULE): 13462 """ 13463 FillPath(path, fillStyle=ODDEVEN_RULE) 13464 13465 Fills the path with the current brush. 13466 """ 13467 13468 def GetNativeContext(self): 13469 """ 13470 GetNativeContext() -> void 13471 13472 Returns the native context (CGContextRef for Core Graphics, Graphics 13473 pointer for GDIPlus and cairo_t pointer for cairo). 13474 """ 13475 13476 def GetPartialTextExtents(self, text): 13477 """ 13478 GetPartialTextExtents(text) -> ArrayDouble 13479 13480 Fills the widths array with the widths from the beginning of text to 13481 the corresponding character of text. 13482 """ 13483 13484 def GetFullTextExtent(self, *args, **kw): 13485 """ 13486 GetFullTextExtent(text) -> (width, height, descent, externalLeading) 13487 GetTextExtent(text) -> (width, height) 13488 13489 Gets the dimensions of the string using the currently selected font. 13490 """ 13491 13492 def GetTransform(self): 13493 """ 13494 GetTransform() -> GraphicsMatrix 13495 13496 Gets the current transformation matrix of this context. 13497 """ 13498 13499 def ResetClip(self): 13500 """ 13501 ResetClip() 13502 13503 Resets the clipping to original shape. 13504 """ 13505 13506 def Rotate(self, angle): 13507 """ 13508 Rotate(angle) 13509 13510 Rotates the current transformation matrix (in radians). 13511 """ 13512 13513 def Scale(self, xScale, yScale): 13514 """ 13515 Scale(xScale, yScale) 13516 13517 Scales the current transformation matrix. 13518 """ 13519 13520 def SetBrush(self, *args, **kw): 13521 """ 13522 SetBrush(brush) 13523 SetBrush(brush) 13524 13525 Sets the brush for filling paths. 13526 """ 13527 13528 def SetFont(self, *args, **kw): 13529 """ 13530 SetFont(font, colour) 13531 SetFont(font) 13532 13533 Sets the font for drawing text. 13534 """ 13535 13536 def SetPen(self, *args, **kw): 13537 """ 13538 SetPen(pen) 13539 SetPen(pen) 13540 13541 Sets the pen used for stroking. 13542 """ 13543 13544 def SetTransform(self, matrix): 13545 """ 13546 SetTransform(matrix) 13547 13548 Sets the current transformation matrix of this context. 13549 """ 13550 13551 def StrokeLine(self, x1, y1, x2, y2): 13552 """ 13553 StrokeLine(x1, y1, x2, y2) 13554 13555 Strokes a single line. 13556 """ 13557 13558 def StrokeLines(self, point2Ds): 13559 """ 13560 StrokeLines(point2Ds) 13561 13562 Stroke lines conencting all the points. 13563 """ 13564 13565 def StrokePath(self, path): 13566 """ 13567 StrokePath(path) 13568 13569 Strokes along a path with the current pen. 13570 """ 13571 13572 def Translate(self, dx, dy): 13573 """ 13574 Translate(dx, dy) 13575 13576 Translates the current transformation matrix. 13577 """ 13578 13579 def BeginLayer(self, opacity): 13580 """ 13581 BeginLayer(opacity) 13582 13583 Redirects all rendering is done into a fully transparent temporary 13584 context. 13585 """ 13586 13587 def EndLayer(self): 13588 """ 13589 EndLayer() 13590 13591 Composites back the drawings into the context with the opacity given 13592 at the BeginLayer call. 13593 """ 13594 13595 def SetAntialiasMode(self, antialias): 13596 """ 13597 SetAntialiasMode(antialias) -> bool 13598 13599 Sets the antialiasing mode, returns true if it supported. 13600 """ 13601 13602 def GetAntialiasMode(self): 13603 """ 13604 GetAntialiasMode() -> AntialiasMode 13605 13606 Returns the current shape antialiasing mode. 13607 """ 13608 13609 def SetInterpolationQuality(self, interpolation): 13610 """ 13611 SetInterpolationQuality(interpolation) -> bool 13612 13613 Sets the interpolation quality, returns true if it is supported. 13614 """ 13615 13616 def GetInterpolationQuality(self): 13617 """ 13618 GetInterpolationQuality() -> InterpolationQuality 13619 13620 Returns the current interpolation quality. 13621 """ 13622 13623 def SetCompositionMode(self, op): 13624 """ 13625 SetCompositionMode(op) -> bool 13626 13627 Sets the compositing operator, returns true if it supported. 13628 """ 13629 13630 def GetCompositionMode(self): 13631 """ 13632 GetCompositionMode() -> CompositionMode 13633 13634 Returns the current compositing operator. 13635 """ 13636 13637 def PushState(self): 13638 """ 13639 PushState() 13640 13641 Push the current state of the context's transformation matrix on a 13642 stack. 13643 """ 13644 13645 def PopState(self): 13646 """ 13647 PopState() 13648 13649 Pops a stored state from the stack and sets the current transformation 13650 matrix to that state. 13651 """ 13652 13653 def ShouldOffset(self): 13654 """ 13655 ShouldOffset() -> bool 13656 """ 13657 13658 def EnableOffset(self, enable=True): 13659 """ 13660 EnableOffset(enable=True) 13661 """ 13662 13663 def DisableOffset(self): 13664 """ 13665 DisableOffset() 13666 """ 13667 13668 def OffsetEnabled(self): 13669 """ 13670 OffsetEnabled() -> bool 13671 """ 13672 13673 def StartDoc(self, message): 13674 """ 13675 StartDoc(message) -> bool 13676 13677 Begin a new document (relevant only for printing / pdf etc.) If there 13678 is a progress dialog, message will be shown. 13679 """ 13680 13681 def EndDoc(self): 13682 """ 13683 EndDoc() 13684 13685 Done with that document (relevant only for printing / pdf etc.) 13686 """ 13687 13688 def StartPage(self, width=0, height=0): 13689 """ 13690 StartPage(width=0, height=0) 13691 13692 Opens a new page (relevant only for printing / pdf etc.) with the 13693 given size in points. 13694 """ 13695 13696 def EndPage(self): 13697 """ 13698 EndPage() 13699 13700 Ends the current page (relevant only for printing / pdf etc.) 13701 """ 13702 13703 def Flush(self): 13704 """ 13705 Flush() 13706 13707 Make sure that the current content of this context is immediately 13708 visible. 13709 """ 13710 13711 def GetSize(self): 13712 """ 13713 GetSize() -> (width, height) 13714 13715 Returns the size of the graphics context in device coordinates. 13716 """ 13717 13718 def GetDPI(self): 13719 """ 13720 GetDPI() -> (dpiX, dpiY) 13721 13722 Returns the resolution of the graphics context in device points per 13723 inch. 13724 """ 13725 13726 DrawRotatedText = wx.deprecated(DrawText, 'Use DrawText instead.') 13727 13728 def StrokeLineSegments(self, beginPoint2Ds, endPoint2Ds): 13729 """ 13730 StrokeLineSegments(beginPoint2Ds, endPoint2Ds) 13731 13732 Stroke disconnected lines from begin to end points. 13733 """ 13734 AntialiasMode = property(None, None) 13735 CompositionMode = property(None, None) 13736 InterpolationQuality = property(None, None) 13737 NativeContext = property(None, None) 13738 TextExtent = property(None, None) 13739 Transform = property(None, None) 13740# end of class GraphicsContext 13741 13742 13743class GraphicsGradientStop(object): 13744 """ 13745 GraphicsGradientStop(col=TransparentColour, pos=0.) 13746 13747 Represents a single gradient stop in a collection of gradient stops as 13748 represented by wxGraphicsGradientStops. 13749 """ 13750 13751 def __init__(self, col=TransparentColour, pos=0.): 13752 """ 13753 GraphicsGradientStop(col=TransparentColour, pos=0.) 13754 13755 Represents a single gradient stop in a collection of gradient stops as 13756 represented by wxGraphicsGradientStops. 13757 """ 13758 13759 def GetColour(self): 13760 """ 13761 GetColour() -> Colour 13762 13763 Return the stop colour. 13764 """ 13765 13766 def SetColour(self, col): 13767 """ 13768 SetColour(col) 13769 13770 Change the stop colour. 13771 """ 13772 13773 def GetPosition(self): 13774 """ 13775 GetPosition() -> float 13776 13777 Return the stop position. 13778 """ 13779 13780 def SetPosition(self, pos): 13781 """ 13782 SetPosition(pos) 13783 13784 Change the stop position. 13785 """ 13786 Colour = property(None, None) 13787 Position = property(None, None) 13788# end of class GraphicsGradientStop 13789 13790 13791class GraphicsGradientStops(object): 13792 """ 13793 GraphicsGradientStops(startCol=TransparentColour, endCol=TransparentColour) 13794 13795 Represents a collection of wxGraphicGradientStop values for use with 13796 CreateLinearGradientBrush and CreateRadialGradientBrush. 13797 """ 13798 13799 def __init__(self, startCol=TransparentColour, endCol=TransparentColour): 13800 """ 13801 GraphicsGradientStops(startCol=TransparentColour, endCol=TransparentColour) 13802 13803 Represents a collection of wxGraphicGradientStop values for use with 13804 CreateLinearGradientBrush and CreateRadialGradientBrush. 13805 """ 13806 13807 def Add(self, *args, **kw): 13808 """ 13809 Add(stop) 13810 Add(col, pos) 13811 13812 Add a new stop. 13813 """ 13814 13815 def Item(self, n): 13816 """ 13817 Item(n) -> GraphicsGradientStop 13818 13819 Returns the stop at the given index. 13820 """ 13821 13822 def GetCount(self): 13823 """ 13824 GetCount() -> size_t 13825 13826 Returns the number of stops. 13827 """ 13828 13829 def SetStartColour(self, col): 13830 """ 13831 SetStartColour(col) 13832 13833 Set the start colour to col. 13834 """ 13835 13836 def GetStartColour(self): 13837 """ 13838 GetStartColour() -> Colour 13839 13840 Returns the start colour. 13841 """ 13842 13843 def SetEndColour(self, col): 13844 """ 13845 SetEndColour(col) 13846 13847 Set the end colour to col. 13848 """ 13849 13850 def GetEndColour(self): 13851 """ 13852 GetEndColour() -> Colour 13853 13854 Returns the end colour. 13855 """ 13856 13857 def __len__(self): 13858 """ 13859 __len__() -> SIP_SSIZE_T 13860 """ 13861 13862 def __getitem__(self, n): 13863 """ 13864 __getitem__(n) 13865 """ 13866 Count = property(None, None) 13867 EndColour = property(None, None) 13868 StartColour = property(None, None) 13869# end of class GraphicsGradientStops 13870 13871 13872class GraphicsMatrix(GraphicsObject): 13873 """ 13874 A wxGraphicsMatrix is a native representation of an affine matrix. 13875 """ 13876 13877 def Concat(self, t): 13878 """ 13879 Concat(t) 13880 13881 Concatenates the matrix passed with the current matrix. 13882 """ 13883 13884 def Get(self): 13885 """ 13886 Get() -> (a, b, c, d, tx, ty) 13887 13888 Returns the component values of the matrix via the argument pointers. 13889 """ 13890 13891 def GetNativeMatrix(self): 13892 """ 13893 GetNativeMatrix() -> void 13894 13895 Returns the native representation of the matrix. 13896 """ 13897 13898 def Invert(self): 13899 """ 13900 Invert() 13901 13902 Inverts the matrix. 13903 """ 13904 13905 def IsEqual(self, t): 13906 """ 13907 IsEqual(t) -> bool 13908 13909 Returns true if the elements of the transformation matrix are equal. 13910 """ 13911 13912 def IsIdentity(self): 13913 """ 13914 IsIdentity() -> bool 13915 13916 Return true if this is the identity matrix. 13917 """ 13918 13919 def Rotate(self, angle): 13920 """ 13921 Rotate(angle) 13922 13923 Rotates this matrix clockwise (in radians). 13924 """ 13925 13926 def Scale(self, xScale, yScale): 13927 """ 13928 Scale(xScale, yScale) 13929 13930 Scales this matrix. 13931 """ 13932 13933 def Set(self, a=1.0, b=0.0, c=0.0, d=1.0, tx=0.0, ty=0.0): 13934 """ 13935 Set(a=1.0, b=0.0, c=0.0, d=1.0, tx=0.0, ty=0.0) 13936 13937 Sets the matrix to the respective values (default values are the 13938 identity matrix). 13939 """ 13940 13941 def TransformDistance(self, dx, dy): 13942 """ 13943 TransformDistance(dx, dy) -> (dx, dy) 13944 13945 Applies this matrix to a distance (ie. 13946 """ 13947 13948 def TransformPoint(self, x, y): 13949 """ 13950 TransformPoint(x, y) -> (x, y) 13951 13952 Applies this matrix to a point. 13953 """ 13954 13955 def Translate(self, dx, dy): 13956 """ 13957 Translate(dx, dy) 13958 13959 Translates this matrix. 13960 """ 13961 NativeMatrix = property(None, None) 13962# end of class GraphicsMatrix 13963 13964 13965class GraphicsPath(GraphicsObject): 13966 """ 13967 A wxGraphicsPath is a native representation of a geometric path. 13968 """ 13969 13970 def AddArc(self, *args, **kw): 13971 """ 13972 AddArc(x, y, r, startAngle, endAngle, clockwise) 13973 AddArc(c, r, startAngle, endAngle, clockwise) 13974 13975 Adds an arc of a circle. 13976 """ 13977 13978 def AddArcToPoint(self, x1, y1, x2, y2, r): 13979 """ 13980 AddArcToPoint(x1, y1, x2, y2, r) 13981 13982 Appends a an arc to two tangents connecting (current) to (x1,y1) and 13983 (x1,y1) to (x2,y2), also a straight line from (current) to (x1,y1). 13984 """ 13985 13986 def AddCircle(self, x, y, r): 13987 """ 13988 AddCircle(x, y, r) 13989 13990 Appends a circle around (x,y) with radius r as a new closed subpath. 13991 """ 13992 13993 def AddCurveToPoint(self, *args, **kw): 13994 """ 13995 AddCurveToPoint(cx1, cy1, cx2, cy2, x, y) 13996 AddCurveToPoint(c1, c2, e) 13997 13998 Adds a cubic bezier curve from the current point, using two control 13999 points and an end point. 14000 """ 14001 14002 def AddEllipse(self, x, y, w, h): 14003 """ 14004 AddEllipse(x, y, w, h) 14005 14006 Appends an ellipse fitting into the passed in rectangle. 14007 """ 14008 14009 def AddLineToPoint(self, *args, **kw): 14010 """ 14011 AddLineToPoint(x, y) 14012 AddLineToPoint(p) 14013 14014 Adds a straight line from the current point to (x,y). 14015 """ 14016 14017 def AddPath(self, path): 14018 """ 14019 AddPath(path) 14020 14021 Adds another path. 14022 """ 14023 14024 def AddQuadCurveToPoint(self, cx, cy, x, y): 14025 """ 14026 AddQuadCurveToPoint(cx, cy, x, y) 14027 14028 Adds a quadratic bezier curve from the current point, using a control 14029 point and an end point. 14030 """ 14031 14032 def AddRectangle(self, x, y, w, h): 14033 """ 14034 AddRectangle(x, y, w, h) 14035 14036 Appends a rectangle as a new closed subpath. 14037 """ 14038 14039 def AddRoundedRectangle(self, x, y, w, h, radius): 14040 """ 14041 AddRoundedRectangle(x, y, w, h, radius) 14042 14043 Appends a rounded rectangle as a new closed subpath. 14044 """ 14045 14046 def CloseSubpath(self): 14047 """ 14048 CloseSubpath() 14049 14050 Closes the current sub-path. 14051 """ 14052 14053 def Contains(self, *args, **kw): 14054 """ 14055 Contains(c, fillStyle=ODDEVEN_RULE) -> bool 14056 Contains(x, y, fillStyle=ODDEVEN_RULE) -> bool 14057 """ 14058 14059 def GetBox(self): 14060 """ 14061 GetBox() -> Rect2D 14062 14063 Gets the bounding box enclosing all points (possibly including control 14064 points). 14065 """ 14066 14067 def GetCurrentPoint(self): 14068 """ 14069 GetCurrentPoint() -> Point2D 14070 14071 Gets the last point of the current path, (0,0) if not yet set. 14072 """ 14073 14074 def GetNativePath(self): 14075 """ 14076 GetNativePath() -> void 14077 14078 Returns the native path (CGPathRef for Core Graphics, Path pointer for 14079 GDIPlus and a cairo_path_t pointer for cairo). 14080 """ 14081 14082 def MoveToPoint(self, *args, **kw): 14083 """ 14084 MoveToPoint(x, y) 14085 MoveToPoint(p) 14086 14087 Begins a new subpath at (x,y). 14088 """ 14089 14090 def Transform(self, matrix): 14091 """ 14092 Transform(matrix) 14093 14094 Transforms each point of this path by the matrix. 14095 """ 14096 14097 def UnGetNativePath(self, p): 14098 """ 14099 UnGetNativePath(p) 14100 14101 Gives back the native path returned by GetNativePath() because there 14102 might be some deallocations necessary (e.g. 14103 """ 14104 Box = property(None, None) 14105 CurrentPoint = property(None, None) 14106 NativePath = property(None, None) 14107# end of class GraphicsPath 14108 14109 14110class GraphicsRenderer(Object): 14111 """ 14112 A wxGraphicsRenderer is the instance corresponding to the rendering 14113 engine used. 14114 """ 14115 14116 def CreateBitmap(self, bitmap): 14117 """ 14118 CreateBitmap(bitmap) -> GraphicsBitmap 14119 14120 Creates wxGraphicsBitmap from an existing wxBitmap. 14121 """ 14122 14123 def CreateBitmapFromImage(self, image): 14124 """ 14125 CreateBitmapFromImage(image) -> GraphicsBitmap 14126 14127 Creates wxGraphicsBitmap from an existing wxImage. 14128 """ 14129 14130 def CreateImageFromBitmap(self, bmp): 14131 """ 14132 CreateImageFromBitmap(bmp) -> Image 14133 14134 Creates a wxImage from a wxGraphicsBitmap. 14135 """ 14136 14137 def CreateBitmapFromNativeBitmap(self, bitmap): 14138 """ 14139 CreateBitmapFromNativeBitmap(bitmap) -> GraphicsBitmap 14140 14141 Creates wxGraphicsBitmap from a native bitmap handle. 14142 """ 14143 14144 def CreateContext(self, *args, **kw): 14145 """ 14146 CreateContext(window) -> GraphicsContext 14147 CreateContext(windowDC) -> GraphicsContext 14148 CreateContext(memoryDC) -> GraphicsContext 14149 CreateContext(printerDC) -> GraphicsContext 14150 14151 Creates a wxGraphicsContext from a wxWindow. 14152 """ 14153 14154 def CreateContextFromImage(self, image): 14155 """ 14156 CreateContextFromImage(image) -> GraphicsContext 14157 14158 Creates a wxGraphicsContext associated with a wxImage. 14159 """ 14160 14161 def CreateBrush(self, brush): 14162 """ 14163 CreateBrush(brush) -> GraphicsBrush 14164 14165 Creates a native brush from a wxBrush. 14166 """ 14167 14168 def CreateContextFromNativeContext(self, context): 14169 """ 14170 CreateContextFromNativeContext(context) -> GraphicsContext 14171 14172 Creates a wxGraphicsContext from a native context. 14173 """ 14174 14175 def CreateContextFromNativeWindow(self, window): 14176 """ 14177 CreateContextFromNativeWindow(window) -> GraphicsContext 14178 14179 Creates a wxGraphicsContext from a native window. 14180 """ 14181 14182 def CreateMeasuringContext(self): 14183 """ 14184 CreateMeasuringContext() -> GraphicsContext 14185 14186 Creates a wxGraphicsContext that can be used for measuring texts only. 14187 """ 14188 14189 def CreateFont(self, *args, **kw): 14190 """ 14191 CreateFont(font, col=BLACK) -> GraphicsFont 14192 CreateFont(sizeInPixels, facename, flags=FONTFLAG_DEFAULT, col=BLACK) -> GraphicsFont 14193 14194 Creates a native graphics font from a wxFont and a text colour. 14195 """ 14196 14197 def CreateLinearGradientBrush(self, x1, y1, x2, y2, stops): 14198 """ 14199 CreateLinearGradientBrush(x1, y1, x2, y2, stops) -> GraphicsBrush 14200 14201 Creates a native brush with a linear gradient. 14202 """ 14203 14204 def CreateMatrix(self, a=1.0, b=0.0, c=0.0, d=1.0, tx=0.0, ty=0.0): 14205 """ 14206 CreateMatrix(a=1.0, b=0.0, c=0.0, d=1.0, tx=0.0, ty=0.0) -> GraphicsMatrix 14207 14208 Creates a native affine transformation matrix from the passed in 14209 values. 14210 """ 14211 14212 def CreatePath(self): 14213 """ 14214 CreatePath() -> GraphicsPath 14215 14216 Creates a native graphics path which is initially empty. 14217 """ 14218 14219 def CreatePen(self, pen): 14220 """ 14221 CreatePen(pen) -> GraphicsPen 14222 14223 Creates a native pen from a wxPen. 14224 """ 14225 14226 def CreateRadialGradientBrush(self, xo, yo, xc, yc, radius, stops): 14227 """ 14228 CreateRadialGradientBrush(xo, yo, xc, yc, radius, stops) -> GraphicsBrush 14229 14230 Creates a native brush with a radial gradient. 14231 """ 14232 14233 def CreateSubBitmap(self, bitmap, x, y, w, h): 14234 """ 14235 CreateSubBitmap(bitmap, x, y, w, h) -> GraphicsBitmap 14236 14237 Extracts a sub-bitmap from an existing bitmap. 14238 """ 14239 14240 @staticmethod 14241 def GetDefaultRenderer(): 14242 """ 14243 GetDefaultRenderer() -> GraphicsRenderer 14244 14245 Returns the default renderer on this platform. 14246 """ 14247 14248 @staticmethod 14249 def GetCairoRenderer(): 14250 """ 14251 GetCairoRenderer() -> GraphicsRenderer 14252 """ 14253# end of class GraphicsRenderer 14254 14255NullGraphicsPen = GraphicsPen() 14256NullGraphicsBrush = GraphicsBrush() 14257NullGraphicsFont = GraphicsFont() 14258NullGraphicsBitmap = GraphicsBitmap() 14259NullGraphicsMatrix = GraphicsMatrix() 14260NullGraphicsPath = GraphicsPath() 14261#-- end-graphics --# 14262#-- begin-imaglist --# 14263IMAGELIST_DRAW_NORMAL = 0 14264IMAGELIST_DRAW_TRANSPARENT = 0 14265IMAGELIST_DRAW_SELECTED = 0 14266IMAGELIST_DRAW_FOCUSED = 0 14267IMAGE_LIST_NORMAL = 0 14268IMAGE_LIST_SMALL = 0 14269IMAGE_LIST_STATE = 0 14270 14271class ImageList(Object): 14272 """ 14273 ImageList() 14274 ImageList(width, height, mask=True, initialCount=1) 14275 14276 A wxImageList contains a list of images, which are stored in an 14277 unspecified form. 14278 """ 14279 14280 def __init__(self, *args, **kw): 14281 """ 14282 ImageList() 14283 ImageList(width, height, mask=True, initialCount=1) 14284 14285 A wxImageList contains a list of images, which are stored in an 14286 unspecified form. 14287 """ 14288 14289 def Add(self, *args, **kw): 14290 """ 14291 Add(bitmap, mask=NullBitmap) -> int 14292 Add(bitmap, maskColour) -> int 14293 Add(icon) -> int 14294 14295 Adds a new image or images using a bitmap and optional mask bitmap. 14296 """ 14297 14298 def Create(self, width, height, mask=True, initialCount=1): 14299 """ 14300 Create(width, height, mask=True, initialCount=1) -> bool 14301 14302 Initializes the list. 14303 """ 14304 14305 def Draw(self, index, dc, x, y, flags=IMAGELIST_DRAW_NORMAL, solidBackground=False): 14306 """ 14307 Draw(index, dc, x, y, flags=IMAGELIST_DRAW_NORMAL, solidBackground=False) -> bool 14308 14309 Draws a specified image onto a device context. 14310 """ 14311 14312 def GetBitmap(self, index): 14313 """ 14314 GetBitmap(index) -> Bitmap 14315 14316 Returns the bitmap corresponding to the given index. 14317 """ 14318 14319 def GetIcon(self, index): 14320 """ 14321 GetIcon(index) -> Icon 14322 14323 Returns the icon corresponding to the given index. 14324 """ 14325 14326 def GetImageCount(self): 14327 """ 14328 GetImageCount() -> int 14329 14330 Returns the number of images in the list. 14331 """ 14332 14333 def GetSize(self, index): 14334 """ 14335 GetSize(index) -> (width, height) 14336 14337 Retrieves the size of the images in the list. 14338 """ 14339 14340 def Remove(self, index): 14341 """ 14342 Remove(index) -> bool 14343 14344 Removes the image at the given position. 14345 """ 14346 14347 def RemoveAll(self): 14348 """ 14349 RemoveAll() -> bool 14350 14351 Removes all the images in the list. 14352 """ 14353 14354 def Replace(self, *args, **kw): 14355 """ 14356 Replace(index, bitmap, mask=NullBitmap) -> bool 14357 Replace(index, icon) -> bool 14358 14359 Replaces the existing image with the new image. 14360 """ 14361 ImageCount = property(None, None) 14362# end of class ImageList 14363 14364#-- end-imaglist --# 14365#-- begin-overlay --# 14366 14367class Overlay(object): 14368 """ 14369 Overlay() 14370 14371 Creates an overlay over an existing window, allowing for manipulations 14372 like rubberbanding, etc. 14373 """ 14374 14375 def __init__(self): 14376 """ 14377 Overlay() 14378 14379 Creates an overlay over an existing window, allowing for manipulations 14380 like rubberbanding, etc. 14381 """ 14382 14383 def Reset(self): 14384 """ 14385 Reset() 14386 14387 Clears the overlay without restoring the former state. 14388 """ 14389# end of class Overlay 14390 14391 14392class DCOverlay(object): 14393 """ 14394 DCOverlay(overlay, dc, x, y, width, height) 14395 DCOverlay(overlay, dc) 14396 14397 Connects an overlay with a drawing DC. 14398 """ 14399 14400 def __init__(self, *args, **kw): 14401 """ 14402 DCOverlay(overlay, dc, x, y, width, height) 14403 DCOverlay(overlay, dc) 14404 14405 Connects an overlay with a drawing DC. 14406 """ 14407 14408 def Clear(self): 14409 """ 14410 Clear() 14411 14412 Clears the layer, restoring the state at the last init. 14413 """ 14414# end of class DCOverlay 14415 14416#-- end-overlay --# 14417#-- begin-palette --# 14418 14419class Palette(GDIObject): 14420 """ 14421 Palette() 14422 Palette(palette) 14423 Palette(red, green, blue) 14424 14425 A palette is a table that maps pixel values to RGB colours. 14426 """ 14427 14428 def __init__(self, *args, **kw): 14429 """ 14430 Palette() 14431 Palette(palette) 14432 Palette(red, green, blue) 14433 14434 A palette is a table that maps pixel values to RGB colours. 14435 """ 14436 14437 def Create(self, red, green, blue): 14438 """ 14439 Create(red, green, blue) -> bool 14440 14441 Creates a palette from 3 sequences of integers, one for each red, blue 14442 or green component. 14443 14444 :param red: A sequence of integer values in the range 0..255 14445 inclusive. 14446 :param green: A sequence of integer values in the range 0..255 14447 inclusive. 14448 :param blue: A sequence of integer values in the range 0..255 14449 inclusive. 14450 14451 .. note:: All sequences must be the same length. 14452 """ 14453 14454 def GetColoursCount(self): 14455 """ 14456 GetColoursCount() -> int 14457 14458 Returns number of entries in palette. 14459 """ 14460 14461 def GetPixel(self, red, green, blue): 14462 """ 14463 GetPixel(red, green, blue) -> int 14464 14465 Returns a pixel value (index into the palette) for the given RGB 14466 values. 14467 """ 14468 14469 def GetRGB(self, pixel): 14470 """ 14471 GetRGB(pixel) -> (red, green, blue) 14472 14473 Returns RGB values for a given palette index. 14474 """ 14475 14476 def IsOk(self): 14477 """ 14478 IsOk() -> bool 14479 14480 Returns true if palette data is present. 14481 """ 14482 ColoursCount = property(None, None) 14483 RGB = property(None, None) 14484# end of class Palette 14485 14486NullPalette = Palette() 14487#-- end-palette --# 14488#-- begin-renderer --# 14489CONTROL_DISABLED = 0 14490CONTROL_FOCUSED = 0 14491CONTROL_PRESSED = 0 14492CONTROL_SPECIAL = 0 14493CONTROL_ISDEFAULT = 0 14494CONTROL_ISSUBMENU = 0 14495CONTROL_EXPANDED = 0 14496CONTROL_SIZEGRIP = 0 14497CONTROL_FLAT = 0 14498CONTROL_CURRENT = 0 14499CONTROL_SELECTED = 0 14500CONTROL_CHECKED = 0 14501CONTROL_CHECKABLE = 0 14502CONTROL_UNDETERMINED = 0 14503TITLEBAR_BUTTON_CLOSE = 0 14504TITLEBAR_BUTTON_MAXIMIZE = 0 14505TITLEBAR_BUTTON_ICONIZE = 0 14506TITLEBAR_BUTTON_RESTORE = 0 14507TITLEBAR_BUTTON_HELP = 0 14508HDR_SORT_ICON_NONE = 0 14509HDR_SORT_ICON_UP = 0 14510HDR_SORT_ICON_DOWN = 0 14511 14512class SplitterRenderParams(object): 14513 """ 14514 SplitterRenderParams(widthSash_, border_, isSens_) 14515 14516 This is just a simple struct used as a return value of 14517 wxRendererNative::GetSplitterParams(). 14518 """ 14519 14520 def __init__(self, widthSash_, border_, isSens_): 14521 """ 14522 SplitterRenderParams(widthSash_, border_, isSens_) 14523 14524 This is just a simple struct used as a return value of 14525 wxRendererNative::GetSplitterParams(). 14526 """ 14527 border = property(None, None) 14528 isHotSensitive = property(None, None) 14529 widthSash = property(None, None) 14530# end of class SplitterRenderParams 14531 14532 14533class HeaderButtonParams(object): 14534 """ 14535 HeaderButtonParams() 14536 14537 This struct can optionally be used with 14538 wxRendererNative::DrawHeaderButton() to specify custom values used to 14539 draw the text or bitmap label. 14540 """ 14541 14542 def __init__(self): 14543 """ 14544 HeaderButtonParams() 14545 14546 This struct can optionally be used with 14547 wxRendererNative::DrawHeaderButton() to specify custom values used to 14548 draw the text or bitmap label. 14549 """ 14550 m_arrowColour = property(None, None) 14551 m_selectionColour = property(None, None) 14552 m_labelText = property(None, None) 14553 m_labelFont = property(None, None) 14554 m_labelColour = property(None, None) 14555 m_labelBitmap = property(None, None) 14556 m_labelAlignment = property(None, None) 14557# end of class HeaderButtonParams 14558 14559 14560class RendererNative(object): 14561 """ 14562 First, a brief introduction to wxRendererNative and why it is needed. 14563 """ 14564 14565 def DrawCheckBox(self, win, dc, rect, flags=0): 14566 """ 14567 DrawCheckBox(win, dc, rect, flags=0) 14568 14569 Draw a check box. 14570 """ 14571 14572 def DrawComboBoxDropButton(self, win, dc, rect, flags=0): 14573 """ 14574 DrawComboBoxDropButton(win, dc, rect, flags=0) 14575 14576 Draw a button like the one used by wxComboBox to show a drop down 14577 window. 14578 """ 14579 14580 def DrawDropArrow(self, win, dc, rect, flags=0): 14581 """ 14582 DrawDropArrow(win, dc, rect, flags=0) 14583 14584 Draw a drop down arrow that is suitable for use outside a combo box. 14585 """ 14586 14587 def DrawFocusRect(self, win, dc, rect, flags=0): 14588 """ 14589 DrawFocusRect(win, dc, rect, flags=0) 14590 14591 Draw a focus rectangle using the specified rectangle. 14592 """ 14593 14594 def DrawHeaderButton(self, win, dc, rect, flags=0, sortArrow=HDR_SORT_ICON_NONE, params=None): 14595 """ 14596 DrawHeaderButton(win, dc, rect, flags=0, sortArrow=HDR_SORT_ICON_NONE, params=None) -> int 14597 14598 Draw the header control button (used, for example, by wxListCtrl). 14599 """ 14600 14601 def DrawHeaderButtonContents(self, win, dc, rect, flags=0, sortArrow=HDR_SORT_ICON_NONE, params=None): 14602 """ 14603 DrawHeaderButtonContents(win, dc, rect, flags=0, sortArrow=HDR_SORT_ICON_NONE, params=None) -> int 14604 14605 Draw the contents of a header control button (label, sort arrows, 14606 etc.). 14607 """ 14608 14609 def DrawItemSelectionRect(self, win, dc, rect, flags=0): 14610 """ 14611 DrawItemSelectionRect(win, dc, rect, flags=0) 14612 14613 Draw a selection rectangle underneath the text as used e.g. 14614 """ 14615 14616 def DrawPushButton(self, win, dc, rect, flags=0): 14617 """ 14618 DrawPushButton(win, dc, rect, flags=0) 14619 14620 Draw a blank push button that looks very similar to wxButton. 14621 """ 14622 14623 def DrawSplitterBorder(self, win, dc, rect, flags=0): 14624 """ 14625 DrawSplitterBorder(win, dc, rect, flags=0) 14626 14627 Draw the border for sash window: this border must be such that the 14628 sash drawn by DrawSplitterSash() blends into it well. 14629 """ 14630 14631 def DrawSplitterSash(self, win, dc, size, position, orient, flags=0): 14632 """ 14633 DrawSplitterSash(win, dc, size, position, orient, flags=0) 14634 14635 Draw a sash. 14636 """ 14637 14638 def DrawTreeItemButton(self, win, dc, rect, flags=0): 14639 """ 14640 DrawTreeItemButton(win, dc, rect, flags=0) 14641 14642 Draw the expanded/collapsed icon for a tree control item. 14643 """ 14644 14645 def DrawChoice(self, win, dc, rect, flags=0): 14646 """ 14647 DrawChoice(win, dc, rect, flags=0) 14648 14649 Draw a native wxChoice. 14650 """ 14651 14652 def DrawComboBox(self, win, dc, rect, flags=0): 14653 """ 14654 DrawComboBox(win, dc, rect, flags=0) 14655 14656 Draw a native wxComboBox. 14657 """ 14658 14659 def DrawTextCtrl(self, win, dc, rect, flags=0): 14660 """ 14661 DrawTextCtrl(win, dc, rect, flags=0) 14662 14663 Draw a native wxTextCtrl frame. 14664 """ 14665 14666 def DrawRadioBitmap(self, win, dc, rect, flags=0): 14667 """ 14668 DrawRadioBitmap(win, dc, rect, flags=0) 14669 14670 Draw a native wxRadioButton bitmap. 14671 """ 14672 14673 def GetCheckBoxSize(self, win): 14674 """ 14675 GetCheckBoxSize(win) -> Size 14676 14677 Returns the size of a check box. 14678 """ 14679 14680 def GetHeaderButtonHeight(self, win): 14681 """ 14682 GetHeaderButtonHeight(win) -> int 14683 14684 Returns the height of a header button, either a fixed platform height 14685 if available, or a generic height based on the win window's font. 14686 """ 14687 14688 def GetHeaderButtonMargin(self, win): 14689 """ 14690 GetHeaderButtonMargin(win) -> int 14691 14692 Returns the horizontal margin on the left and right sides of header 14693 button's label. 14694 """ 14695 14696 def GetSplitterParams(self, win): 14697 """ 14698 GetSplitterParams(win) -> SplitterRenderParams 14699 14700 Get the splitter parameters, see wxSplitterRenderParams. 14701 """ 14702 14703 def GetVersion(self): 14704 """ 14705 GetVersion() -> RendererVersion 14706 14707 This function is used for version checking: Load() refuses to load any 14708 shared libraries implementing an older or incompatible version. 14709 """ 14710 14711 @staticmethod 14712 def Get(): 14713 """ 14714 Get() -> RendererNative 14715 14716 Return the currently used renderer. 14717 """ 14718 14719 @staticmethod 14720 def GetDefault(): 14721 """ 14722 GetDefault() -> RendererNative 14723 14724 Return the default (native) implementation for this platform this is 14725 also the one used by default but this may be changed by calling Set() 14726 in which case the return value of this method may be different from 14727 the return value of Get(). 14728 """ 14729 14730 @staticmethod 14731 def GetGeneric(): 14732 """ 14733 GetGeneric() -> RendererNative 14734 14735 Return the generic implementation of the renderer. 14736 """ 14737 14738 @staticmethod 14739 def Load(name): 14740 """ 14741 Load(name) -> RendererNative 14742 14743 Load the renderer from the specified DLL, the returned pointer must be 14744 deleted by caller if not NULL when it is not used any more. 14745 """ 14746 14747 @staticmethod 14748 def Set(renderer): 14749 """ 14750 Set(renderer) -> RendererNative 14751 14752 Set the renderer to use, passing NULL reverts to using the default 14753 renderer (the global renderer must always exist). 14754 """ 14755 Version = property(None, None) 14756# end of class RendererNative 14757 14758 14759class DelegateRendererNative(RendererNative): 14760 """ 14761 DelegateRendererNative() 14762 DelegateRendererNative(rendererNative) 14763 14764 wxDelegateRendererNative allows reuse of renderers code by forwarding 14765 all the wxRendererNative methods to the given object and thus allowing 14766 you to only modify some of its methods without having to reimplement 14767 all of them. 14768 """ 14769 14770 def __init__(self, *args, **kw): 14771 """ 14772 DelegateRendererNative() 14773 DelegateRendererNative(rendererNative) 14774 14775 wxDelegateRendererNative allows reuse of renderers code by forwarding 14776 all the wxRendererNative methods to the given object and thus allowing 14777 you to only modify some of its methods without having to reimplement 14778 all of them. 14779 """ 14780 14781 def DrawHeaderButton(self, win, dc, rect, flags=0, sortArrow=HDR_SORT_ICON_NONE, params=None): 14782 """ 14783 DrawHeaderButton(win, dc, rect, flags=0, sortArrow=HDR_SORT_ICON_NONE, params=None) -> int 14784 14785 Draw the header control button (used, for example, by wxListCtrl). 14786 """ 14787 14788 def DrawHeaderButtonContents(self, win, dc, rect, flags=0, sortArrow=HDR_SORT_ICON_NONE, params=None): 14789 """ 14790 DrawHeaderButtonContents(win, dc, rect, flags=0, sortArrow=HDR_SORT_ICON_NONE, params=None) -> int 14791 14792 Draw the contents of a header control button (label, sort arrows, 14793 etc.). 14794 """ 14795 14796 def GetHeaderButtonHeight(self, win): 14797 """ 14798 GetHeaderButtonHeight(win) -> int 14799 14800 Returns the height of a header button, either a fixed platform height 14801 if available, or a generic height based on the win window's font. 14802 """ 14803 14804 def GetHeaderButtonMargin(self, win): 14805 """ 14806 GetHeaderButtonMargin(win) -> int 14807 14808 Returns the horizontal margin on the left and right sides of header 14809 button's label. 14810 """ 14811 14812 def DrawTreeItemButton(self, win, dc, rect, flags=0): 14813 """ 14814 DrawTreeItemButton(win, dc, rect, flags=0) 14815 14816 Draw the expanded/collapsed icon for a tree control item. 14817 """ 14818 14819 def DrawSplitterBorder(self, win, dc, rect, flags=0): 14820 """ 14821 DrawSplitterBorder(win, dc, rect, flags=0) 14822 14823 Draw the border for sash window: this border must be such that the 14824 sash drawn by DrawSplitterSash() blends into it well. 14825 """ 14826 14827 def DrawSplitterSash(self, win, dc, size, position, orient, flags=0): 14828 """ 14829 DrawSplitterSash(win, dc, size, position, orient, flags=0) 14830 14831 Draw a sash. 14832 """ 14833 14834 def DrawComboBoxDropButton(self, win, dc, rect, flags=0): 14835 """ 14836 DrawComboBoxDropButton(win, dc, rect, flags=0) 14837 14838 Draw a button like the one used by wxComboBox to show a drop down 14839 window. 14840 """ 14841 14842 def DrawDropArrow(self, win, dc, rect, flags=0): 14843 """ 14844 DrawDropArrow(win, dc, rect, flags=0) 14845 14846 Draw a drop down arrow that is suitable for use outside a combo box. 14847 """ 14848 14849 def DrawCheckBox(self, win, dc, rect, flags=0): 14850 """ 14851 DrawCheckBox(win, dc, rect, flags=0) 14852 14853 Draw a check box. 14854 """ 14855 14856 def GetCheckBoxSize(self, win): 14857 """ 14858 GetCheckBoxSize(win) -> Size 14859 14860 Returns the size of a check box. 14861 """ 14862 14863 def DrawPushButton(self, win, dc, rect, flags=0): 14864 """ 14865 DrawPushButton(win, dc, rect, flags=0) 14866 14867 Draw a blank push button that looks very similar to wxButton. 14868 """ 14869 14870 def DrawItemSelectionRect(self, win, dc, rect, flags=0): 14871 """ 14872 DrawItemSelectionRect(win, dc, rect, flags=0) 14873 14874 Draw a selection rectangle underneath the text as used e.g. 14875 """ 14876 14877 def DrawFocusRect(self, win, dc, rect, flags=0): 14878 """ 14879 DrawFocusRect(win, dc, rect, flags=0) 14880 14881 Draw a focus rectangle using the specified rectangle. 14882 """ 14883 14884 def GetSplitterParams(self, win): 14885 """ 14886 GetSplitterParams(win) -> SplitterRenderParams 14887 14888 Get the splitter parameters, see wxSplitterRenderParams. 14889 """ 14890 14891 def GetVersion(self): 14892 """ 14893 GetVersion() -> RendererVersion 14894 14895 This function is used for version checking: Load() refuses to load any 14896 shared libraries implementing an older or incompatible version. 14897 """ 14898 14899 def DrawTitleBarBitmap(self, win, dc, rect, button, flags=0): 14900 """ 14901 DrawTitleBarBitmap(win, dc, rect, button, flags=0) 14902 14903 Draw a title bar button in the given state. 14904 """ 14905 Version = property(None, None) 14906# end of class DelegateRendererNative 14907 14908 14909class RendererVersion(object): 14910 """ 14911 RendererVersion(version_, age_) 14912 14913 This simple struct represents the wxRendererNative interface version 14914 and is only used as the return value of 14915 wxRendererNative::GetVersion(). 14916 """ 14917 14918 def __init__(self, version_, age_): 14919 """ 14920 RendererVersion(version_, age_) 14921 14922 This simple struct represents the wxRendererNative interface version 14923 and is only used as the return value of 14924 wxRendererNative::GetVersion(). 14925 """ 14926 age = property(None, None) 14927 version = property(None, None) 14928 14929 @staticmethod 14930 def IsCompatible(ver): 14931 """ 14932 IsCompatible(ver) -> bool 14933 14934 Checks if the main program is compatible with the renderer having the 14935 version ver, returns true if it is and false otherwise. 14936 """ 14937# end of class RendererVersion 14938 14939#-- end-renderer --# 14940#-- begin-rawbmp --# 14941 14942class PixelDataBase(object): 14943 """ 14944 PixelDataBase() 14945 """ 14946 14947 def GetOrigin(self): 14948 """ 14949 GetOrigin() -> Point 14950 14951 Return the origin of the area this pixel data represents. 14952 """ 14953 14954 def GetWidth(self): 14955 """ 14956 GetWidth() -> int 14957 14958 Return the width of the area this pixel data represents. 14959 """ 14960 14961 def GetHeight(self): 14962 """ 14963 GetHeight() -> int 14964 14965 Return the height of the area this pixel data represents. 14966 """ 14967 14968 def GetSize(self): 14969 """ 14970 GetSize() -> Size 14971 14972 Return the size of the area this pixel data represents. 14973 """ 14974 14975 def GetRowStride(self): 14976 """ 14977 GetRowStride() -> int 14978 14979 Returns the distance between the start of one row to the start of the 14980 next row. 14981 """ 14982 14983 def __iter__(self): 14984 """ 14985 Create and return an iterator/generator object for traversing 14986 this pixel data object. 14987 """ 14988 Height = property(None, None) 14989 Origin = property(None, None) 14990 RowStride = property(None, None) 14991 Size = property(None, None) 14992 Width = property(None, None) 14993 14994 def wxPixelDataBase(self): 14995 """ 14996 """ 14997# end of class PixelDataBase 14998 14999 15000class NativePixelData(PixelDataBase): 15001 """ 15002 NativePixelData(bmp) 15003 NativePixelData(bmp, rect) 15004 NativePixelData(bmp, pt, sz) 15005 15006 A class providing direct access to a :class:`wx.Bitmap`'s 15007 internal data without alpha channel (RGB). 15008 """ 15009 15010 def __init__(self, *args, **kw): 15011 """ 15012 NativePixelData(bmp) 15013 NativePixelData(bmp, rect) 15014 NativePixelData(bmp, pt, sz) 15015 15016 A class providing direct access to a :class:`wx.Bitmap`'s 15017 internal data without alpha channel (RGB). 15018 """ 15019 15020 def GetPixels(self): 15021 """ 15022 GetPixels() -> NativePixelData_Accessor 15023 """ 15024 15025 def __nonzero__(self): 15026 """ 15027 __nonzero__() -> int 15028 """ 15029 15030 def __bool__(self): 15031 """ 15032 __bool__() -> int 15033 """ 15034 Pixels = property(None, None) 15035# end of class NativePixelData 15036 15037 15038class NativePixelData_Accessor(object): 15039 """ 15040 NativePixelData_Accessor(data) 15041 NativePixelData_Accessor(bmp, data) 15042 NativePixelData_Accessor() 15043 """ 15044 15045 def __init__(self, *args, **kw): 15046 """ 15047 NativePixelData_Accessor(data) 15048 NativePixelData_Accessor(bmp, data) 15049 NativePixelData_Accessor() 15050 """ 15051 15052 def Reset(self, data): 15053 """ 15054 Reset(data) 15055 """ 15056 15057 def IsOk(self): 15058 """ 15059 IsOk() -> bool 15060 """ 15061 15062 def __nonzero__(self): 15063 """ 15064 __nonzero__() -> int 15065 """ 15066 15067 def __bool__(self): 15068 """ 15069 __bool__() -> int 15070 """ 15071 15072 def Offset(self, data, x, y): 15073 """ 15074 Offset(data, x, y) 15075 """ 15076 15077 def OffsetX(self, data, x): 15078 """ 15079 OffsetX(data, x) 15080 """ 15081 15082 def OffsetY(self, data, y): 15083 """ 15084 OffsetY(data, y) 15085 """ 15086 15087 def MoveTo(self, data, x, y): 15088 """ 15089 MoveTo(data, x, y) 15090 """ 15091 15092 def nextPixel(self): 15093 """ 15094 nextPixel() 15095 """ 15096 15097 def Set(self, red, green, blue): 15098 """ 15099 Set(red, green, blue) 15100 """ 15101 15102 def Get(self): 15103 """ 15104 Get() -> PyObject 15105 """ 15106# end of class NativePixelData_Accessor 15107 15108 15109class AlphaPixelData(PixelDataBase): 15110 """ 15111 AlphaPixelData(bmp) 15112 AlphaPixelData(bmp, rect) 15113 AlphaPixelData(bmp, pt, sz) 15114 15115 A class providing direct access to a :class:`wx.Bitmap`'s 15116 internal data including the alpha channel (RGBA). 15117 """ 15118 15119 def __init__(self, *args, **kw): 15120 """ 15121 AlphaPixelData(bmp) 15122 AlphaPixelData(bmp, rect) 15123 AlphaPixelData(bmp, pt, sz) 15124 15125 A class providing direct access to a :class:`wx.Bitmap`'s 15126 internal data including the alpha channel (RGBA). 15127 """ 15128 15129 def GetPixels(self): 15130 """ 15131 GetPixels() -> AlphaPixelData_Accessor 15132 """ 15133 15134 def __nonzero__(self): 15135 """ 15136 __nonzero__() -> int 15137 """ 15138 15139 def __bool__(self): 15140 """ 15141 __bool__() -> int 15142 """ 15143 Pixels = property(None, None) 15144# end of class AlphaPixelData 15145 15146 15147class AlphaPixelData_Accessor(object): 15148 """ 15149 AlphaPixelData_Accessor(data) 15150 AlphaPixelData_Accessor(bmp, data) 15151 AlphaPixelData_Accessor() 15152 """ 15153 15154 def __init__(self, *args, **kw): 15155 """ 15156 AlphaPixelData_Accessor(data) 15157 AlphaPixelData_Accessor(bmp, data) 15158 AlphaPixelData_Accessor() 15159 """ 15160 15161 def Reset(self, data): 15162 """ 15163 Reset(data) 15164 """ 15165 15166 def IsOk(self): 15167 """ 15168 IsOk() -> bool 15169 """ 15170 15171 def __nonzero__(self): 15172 """ 15173 __nonzero__() -> int 15174 """ 15175 15176 def __bool__(self): 15177 """ 15178 __bool__() -> int 15179 """ 15180 15181 def Offset(self, data, x, y): 15182 """ 15183 Offset(data, x, y) 15184 """ 15185 15186 def OffsetX(self, data, x): 15187 """ 15188 OffsetX(data, x) 15189 """ 15190 15191 def OffsetY(self, data, y): 15192 """ 15193 OffsetY(data, y) 15194 """ 15195 15196 def MoveTo(self, data, x, y): 15197 """ 15198 MoveTo(data, x, y) 15199 """ 15200 15201 def nextPixel(self): 15202 """ 15203 nextPixel() 15204 """ 15205 15206 def Set(self, red, green, blue, alpha): 15207 """ 15208 Set(red, green, blue, alpha) 15209 """ 15210 15211 def Get(self): 15212 """ 15213 Get() -> PyObject 15214 """ 15215# end of class AlphaPixelData_Accessor 15216 15217#-- end-rawbmp --# 15218#-- begin-access --# 15219ACC_STATE_SYSTEM_ALERT_HIGH = 0 15220ACC_STATE_SYSTEM_ALERT_MEDIUM = 0 15221ACC_STATE_SYSTEM_ALERT_LOW = 0 15222ACC_STATE_SYSTEM_ANIMATED = 0 15223ACC_STATE_SYSTEM_BUSY = 0 15224ACC_STATE_SYSTEM_CHECKED = 0 15225ACC_STATE_SYSTEM_COLLAPSED = 0 15226ACC_STATE_SYSTEM_DEFAULT = 0 15227ACC_STATE_SYSTEM_EXPANDED = 0 15228ACC_STATE_SYSTEM_EXTSELECTABLE = 0 15229ACC_STATE_SYSTEM_FLOATING = 0 15230ACC_STATE_SYSTEM_FOCUSABLE = 0 15231ACC_STATE_SYSTEM_FOCUSED = 0 15232ACC_STATE_SYSTEM_HOTTRACKED = 0 15233ACC_STATE_SYSTEM_INVISIBLE = 0 15234ACC_STATE_SYSTEM_MARQUEED = 0 15235ACC_STATE_SYSTEM_MIXED = 0 15236ACC_STATE_SYSTEM_MULTISELECTABLE = 0 15237ACC_STATE_SYSTEM_OFFSCREEN = 0 15238ACC_STATE_SYSTEM_PRESSED = 0 15239ACC_STATE_SYSTEM_PROTECTED = 0 15240ACC_STATE_SYSTEM_READONLY = 0 15241ACC_STATE_SYSTEM_SELECTABLE = 0 15242ACC_STATE_SYSTEM_SELECTED = 0 15243ACC_STATE_SYSTEM_SELFVOICING = 0 15244ACC_STATE_SYSTEM_UNAVAILABLE = 0 15245ACC_EVENT_SYSTEM_SOUND = 0 15246ACC_EVENT_SYSTEM_ALERT = 0 15247ACC_EVENT_SYSTEM_FOREGROUND = 0 15248ACC_EVENT_SYSTEM_MENUSTART = 0 15249ACC_EVENT_SYSTEM_MENUEND = 0 15250ACC_EVENT_SYSTEM_MENUPOPUPSTART = 0 15251ACC_EVENT_SYSTEM_MENUPOPUPEND = 0 15252ACC_EVENT_SYSTEM_CAPTURESTART = 0 15253ACC_EVENT_SYSTEM_CAPTUREEND = 0 15254ACC_EVENT_SYSTEM_MOVESIZESTART = 0 15255ACC_EVENT_SYSTEM_MOVESIZEEND = 0 15256ACC_EVENT_SYSTEM_CONTEXTHELPSTART = 0 15257ACC_EVENT_SYSTEM_CONTEXTHELPEND = 0 15258ACC_EVENT_SYSTEM_DRAGDROPSTART = 0 15259ACC_EVENT_SYSTEM_DRAGDROPEND = 0 15260ACC_EVENT_SYSTEM_DIALOGSTART = 0 15261ACC_EVENT_SYSTEM_DIALOGEND = 0 15262ACC_EVENT_SYSTEM_SCROLLINGSTART = 0 15263ACC_EVENT_SYSTEM_SCROLLINGEND = 0 15264ACC_EVENT_SYSTEM_SWITCHSTART = 0 15265ACC_EVENT_SYSTEM_SWITCHEND = 0 15266ACC_EVENT_SYSTEM_MINIMIZESTART = 0 15267ACC_EVENT_SYSTEM_MINIMIZEEND = 0 15268ACC_EVENT_OBJECT_CREATE = 0 15269ACC_EVENT_OBJECT_DESTROY = 0 15270ACC_EVENT_OBJECT_SHOW = 0 15271ACC_EVENT_OBJECT_HIDE = 0 15272ACC_EVENT_OBJECT_REORDER = 0 15273ACC_EVENT_OBJECT_FOCUS = 0 15274ACC_EVENT_OBJECT_SELECTION = 0 15275ACC_EVENT_OBJECT_SELECTIONADD = 0 15276ACC_EVENT_OBJECT_SELECTIONREMOVE = 0 15277ACC_EVENT_OBJECT_SELECTIONWITHIN = 0 15278ACC_EVENT_OBJECT_STATECHANGE = 0 15279ACC_EVENT_OBJECT_LOCATIONCHANGE = 0 15280ACC_EVENT_OBJECT_NAMECHANGE = 0 15281ACC_EVENT_OBJECT_DESCRIPTIONCHANGE = 0 15282ACC_EVENT_OBJECT_VALUECHANGE = 0 15283ACC_EVENT_OBJECT_PARENTCHANGE = 0 15284ACC_EVENT_OBJECT_HELPCHANGE = 0 15285ACC_EVENT_OBJECT_DEFACTIONCHANGE = 0 15286ACC_EVENT_OBJECT_ACCELERATORCHANGE = 0 15287ACC_SELF = 0 15288ACC_FAIL = 0 15289ACC_FALSE = 0 15290ACC_OK = 0 15291ACC_NOT_IMPLEMENTED = 0 15292ACC_NOT_SUPPORTED = 0 15293NAVDIR_DOWN = 0 15294NAVDIR_FIRSTCHILD = 0 15295NAVDIR_LASTCHILD = 0 15296NAVDIR_LEFT = 0 15297NAVDIR_NEXT = 0 15298NAVDIR_PREVIOUS = 0 15299NAVDIR_RIGHT = 0 15300NAVDIR_UP = 0 15301ROLE_NONE = 0 15302ROLE_SYSTEM_ALERT = 0 15303ROLE_SYSTEM_ANIMATION = 0 15304ROLE_SYSTEM_APPLICATION = 0 15305ROLE_SYSTEM_BORDER = 0 15306ROLE_SYSTEM_BUTTONDROPDOWN = 0 15307ROLE_SYSTEM_BUTTONDROPDOWNGRID = 0 15308ROLE_SYSTEM_BUTTONMENU = 0 15309ROLE_SYSTEM_CARET = 0 15310ROLE_SYSTEM_CELL = 0 15311ROLE_SYSTEM_CHARACTER = 0 15312ROLE_SYSTEM_CHART = 0 15313ROLE_SYSTEM_CHECKBUTTON = 0 15314ROLE_SYSTEM_CLIENT = 0 15315ROLE_SYSTEM_CLOCK = 0 15316ROLE_SYSTEM_COLUMN = 0 15317ROLE_SYSTEM_COLUMNHEADER = 0 15318ROLE_SYSTEM_COMBOBOX = 0 15319ROLE_SYSTEM_CURSOR = 0 15320ROLE_SYSTEM_DIAGRAM = 0 15321ROLE_SYSTEM_DIAL = 0 15322ROLE_SYSTEM_DIALOG = 0 15323ROLE_SYSTEM_DOCUMENT = 0 15324ROLE_SYSTEM_DROPLIST = 0 15325ROLE_SYSTEM_EQUATION = 0 15326ROLE_SYSTEM_GRAPHIC = 0 15327ROLE_SYSTEM_GRIP = 0 15328ROLE_SYSTEM_GROUPING = 0 15329ROLE_SYSTEM_HELPBALLOON = 0 15330ROLE_SYSTEM_HOTKEYFIELD = 0 15331ROLE_SYSTEM_INDICATOR = 0 15332ROLE_SYSTEM_LINK = 0 15333ROLE_SYSTEM_LIST = 0 15334ROLE_SYSTEM_LISTITEM = 0 15335ROLE_SYSTEM_MENUBAR = 0 15336ROLE_SYSTEM_MENUITEM = 0 15337ROLE_SYSTEM_MENUPOPUP = 0 15338ROLE_SYSTEM_OUTLINE = 0 15339ROLE_SYSTEM_OUTLINEITEM = 0 15340ROLE_SYSTEM_PAGETAB = 0 15341ROLE_SYSTEM_PAGETABLIST = 0 15342ROLE_SYSTEM_PANE = 0 15343ROLE_SYSTEM_PROGRESSBAR = 0 15344ROLE_SYSTEM_PROPERTYPAGE = 0 15345ROLE_SYSTEM_PUSHBUTTON = 0 15346ROLE_SYSTEM_RADIOBUTTON = 0 15347ROLE_SYSTEM_ROW = 0 15348ROLE_SYSTEM_ROWHEADER = 0 15349ROLE_SYSTEM_SCROLLBAR = 0 15350ROLE_SYSTEM_SEPARATOR = 0 15351ROLE_SYSTEM_SLIDER = 0 15352ROLE_SYSTEM_SOUND = 0 15353ROLE_SYSTEM_SPINBUTTON = 0 15354ROLE_SYSTEM_STATICTEXT = 0 15355ROLE_SYSTEM_STATUSBAR = 0 15356ROLE_SYSTEM_TABLE = 0 15357ROLE_SYSTEM_TEXT = 0 15358ROLE_SYSTEM_TITLEBAR = 0 15359ROLE_SYSTEM_TOOLBAR = 0 15360ROLE_SYSTEM_TOOLTIP = 0 15361ROLE_SYSTEM_WHITESPACE = 0 15362ROLE_SYSTEM_WINDOW = 0 15363OBJID_WINDOW = 0 15364OBJID_SYSMENU = 0 15365OBJID_TITLEBAR = 0 15366OBJID_MENU = 0 15367OBJID_CLIENT = 0 15368OBJID_VSCROLL = 0 15369OBJID_HSCROLL = 0 15370OBJID_SIZEGRIP = 0 15371OBJID_CARET = 0 15372OBJID_CURSOR = 0 15373OBJID_ALERT = 0 15374OBJID_SOUND = 0 15375ACC_SEL_NONE = 0 15376ACC_SEL_TAKEFOCUS = 0 15377ACC_SEL_TAKESELECTION = 0 15378ACC_SEL_EXTENDSELECTION = 0 15379ACC_SEL_ADDSELECTION = 0 15380ACC_SEL_REMOVESELECTION = 0 15381 15382class Accessible(Object): 15383 """ 15384 Accessible(win=None) 15385 15386 The wxAccessible class allows wxWidgets applications, and wxWidgets 15387 itself, to return extended information about user interface elements 15388 to client applications such as screen readers. 15389 """ 15390 15391 def __init__(self, win=None): 15392 """ 15393 Accessible(win=None) 15394 15395 The wxAccessible class allows wxWidgets applications, and wxWidgets 15396 itself, to return extended information about user interface elements 15397 to client applications such as screen readers. 15398 """ 15399 15400 def DoDefaultAction(self, childId): 15401 """ 15402 DoDefaultAction(childId) -> AccStatus 15403 15404 Performs the default action for the object. 15405 """ 15406 15407 def GetChild(self, childId): 15408 """ 15409 GetChild(childId) -> (AccStatus, child) 15410 15411 Gets the specified child (starting from 1). 15412 """ 15413 15414 def GetChildCount(self): 15415 """ 15416 GetChildCount() -> (AccStatus, childCount) 15417 15418 Returns the number of children in childCount. 15419 """ 15420 15421 def GetDefaultAction(self, childId): 15422 """ 15423 GetDefaultAction(childId) -> (AccStatus, actionName) 15424 15425 Gets the default action for this object (0) or a child (greater than 15426 0). 15427 """ 15428 15429 def GetDescription(self, childId): 15430 """ 15431 GetDescription(childId) -> (AccStatus, description) 15432 15433 Returns the description for this object or a child. 15434 """ 15435 15436 def GetFocus(self, childId): 15437 """ 15438 GetFocus(childId) -> (AccStatus, child) 15439 15440 Gets the window with the keyboard focus. 15441 """ 15442 15443 def GetHelpText(self, childId): 15444 """ 15445 GetHelpText(childId) -> (AccStatus, helpText) 15446 15447 Returns help text for this object or a child, similar to tooltip text. 15448 """ 15449 15450 def GetKeyboardShortcut(self, childId): 15451 """ 15452 GetKeyboardShortcut(childId) -> (AccStatus, shortcut) 15453 15454 Returns the keyboard shortcut for this object or child. 15455 """ 15456 15457 def GetLocation(self, elementId): 15458 """ 15459 GetLocation(elementId) -> (AccStatus, rect) 15460 15461 Returns the rectangle for this object (id is 0) or a child element (id 15462 is greater than 0). 15463 """ 15464 15465 def GetName(self, childId): 15466 """ 15467 GetName(childId) -> (AccStatus, name) 15468 15469 Gets the name of the specified object. 15470 """ 15471 15472 def GetParent(self): 15473 """ 15474 GetParent() -> (AccStatus, parent) 15475 15476 Returns the parent of this object, or NULL. 15477 """ 15478 15479 def GetRole(self, childId): 15480 """ 15481 GetRole(childId) -> (AccStatus, role) 15482 15483 Returns a role constant describing this object. 15484 """ 15485 15486 def GetSelections(self): 15487 """ 15488 GetSelections() -> (AccStatus, selections) 15489 15490 Gets a variant representing the selected children of this object. 15491 """ 15492 15493 def GetState(self, childId): 15494 """ 15495 GetState(childId) -> (AccStatus, state) 15496 15497 Returns a state constant. 15498 """ 15499 15500 def GetValue(self, childId): 15501 """ 15502 GetValue(childId) -> (AccStatus, strValue) 15503 15504 Returns a localized string representing the value for the object or 15505 child. 15506 """ 15507 15508 def GetWindow(self): 15509 """ 15510 GetWindow() -> Window 15511 15512 Returns the window associated with this object. 15513 """ 15514 15515 def HitTest(self, pt, childId, childObject): 15516 """ 15517 HitTest(pt, childId, childObject) -> AccStatus 15518 15519 Returns a status value and object id to indicate whether the given 15520 point was on this or a child object. 15521 """ 15522 15523 def Navigate(self, navDir, fromId, toId, toObject): 15524 """ 15525 Navigate(navDir, fromId, toId, toObject) -> AccStatus 15526 15527 Navigates from fromId to toId or to toObject. 15528 """ 15529 15530 def Select(self, childId, selectFlags): 15531 """ 15532 Select(childId, selectFlags) -> AccStatus 15533 15534 Selects the object or child. 15535 """ 15536 15537 def SetWindow(self, window): 15538 """ 15539 SetWindow(window) 15540 15541 Sets the window associated with this object. 15542 """ 15543 15544 @staticmethod 15545 def NotifyEvent(eventType, window, objectType, objectId): 15546 """ 15547 NotifyEvent(eventType, window, objectType, objectId) 15548 15549 Allows the application to send an event when something changes in an 15550 accessible object. 15551 """ 15552 Window = property(None, None) 15553# end of class Accessible 15554 15555USE_ACCESSIBILITY = 0 15556#-- end-access --# 15557#-- begin-accel --# 15558ACCEL_NORMAL = 0 15559ACCEL_ALT = 0 15560ACCEL_CTRL = 0 15561ACCEL_SHIFT = 0 15562ACCEL_RAW_CTRL = 0 15563ACCEL_CMD = 0 15564 15565class AcceleratorEntry(object): 15566 """ 15567 AcceleratorEntry(flags=0, keyCode=0, cmd=0, item=None) 15568 AcceleratorEntry(entry) 15569 15570 An object used by an application wishing to create an accelerator 15571 table (see wxAcceleratorTable). 15572 """ 15573 15574 def __init__(self, *args, **kw): 15575 """ 15576 AcceleratorEntry(flags=0, keyCode=0, cmd=0, item=None) 15577 AcceleratorEntry(entry) 15578 15579 An object used by an application wishing to create an accelerator 15580 table (see wxAcceleratorTable). 15581 """ 15582 15583 def GetCommand(self): 15584 """ 15585 GetCommand() -> int 15586 15587 Returns the command identifier for the accelerator table entry. 15588 """ 15589 15590 def GetFlags(self): 15591 """ 15592 GetFlags() -> int 15593 15594 Returns the flags for the accelerator table entry. 15595 """ 15596 15597 def GetKeyCode(self): 15598 """ 15599 GetKeyCode() -> int 15600 15601 Returns the keycode for the accelerator table entry. 15602 """ 15603 15604 def GetMenuItem(self): 15605 """ 15606 GetMenuItem() -> MenuItem 15607 15608 Returns the menu item associated with this accelerator entry. 15609 """ 15610 15611 def Set(self, flags, keyCode, cmd, item=None): 15612 """ 15613 Set(flags, keyCode, cmd, item=None) 15614 15615 Sets the accelerator entry parameters. 15616 """ 15617 15618 def IsOk(self): 15619 """ 15620 IsOk() -> bool 15621 15622 Returns true if this object is correctly initialized. 15623 """ 15624 15625 def ToString(self): 15626 """ 15627 ToString() -> String 15628 15629 Returns a textual representation of this accelerator. 15630 """ 15631 15632 def ToRawString(self): 15633 """ 15634 ToRawString() -> String 15635 15636 Returns a textual representation of this accelerator which is 15637 appropriate for saving in configuration files. 15638 """ 15639 15640 def FromString(self, str): 15641 """ 15642 FromString(str) -> bool 15643 15644 Parses the given string and sets the accelerator accordingly. 15645 """ 15646 15647 def __eq__(self): 15648 """ 15649 """ 15650 15651 def __ne__(self): 15652 """ 15653 """ 15654 Command = property(None, None) 15655 Flags = property(None, None) 15656 KeyCode = property(None, None) 15657 MenuItem = property(None, None) 15658# end of class AcceleratorEntry 15659 15660 15661class AcceleratorTable(Object): 15662 """ 15663 AcceleratorTable() 15664 AcceleratorTable(entries) 15665 15666 An accelerator table allows the application to specify a table of 15667 keyboard shortcuts for menu or button commands. 15668 """ 15669 15670 def __init__(self, *args, **kw): 15671 """ 15672 AcceleratorTable() 15673 AcceleratorTable(entries) 15674 15675 An accelerator table allows the application to specify a table of 15676 keyboard shortcuts for menu or button commands. 15677 """ 15678 15679 def IsOk(self): 15680 """ 15681 IsOk() -> bool 15682 15683 Returns true if the accelerator table is valid. 15684 """ 15685# end of class AcceleratorTable 15686 15687NullAcceleratorTable = AcceleratorTable() 15688 15689@wx.deprecated 15690def GetAccelFromString(label): 15691 pass 15692#-- end-accel --# 15693#-- begin-log --# 15694LOG_FatalError = 0 15695LOG_Error = 0 15696LOG_Warning = 0 15697LOG_Message = 0 15698LOG_Status = 0 15699LOG_Info = 0 15700LOG_Debug = 0 15701LOG_Trace = 0 15702LOG_Progress = 0 15703LOG_User = 0 15704LOG_Max = 0 15705 15706class Log(object): 15707 """ 15708 wxLog class defines the interface for the log targets used by 15709 wxWidgets logging functions as explained in the Logging Overview. 15710 """ 15711 15712 @staticmethod 15713 def AddTraceMask(mask): 15714 """ 15715 AddTraceMask(mask) 15716 15717 Add the mask to the list of allowed masks for wxLogTrace(). 15718 """ 15719 15720 @staticmethod 15721 def ClearTraceMasks(): 15722 """ 15723 ClearTraceMasks() 15724 15725 Removes all trace masks previously set with AddTraceMask(). 15726 """ 15727 15728 @staticmethod 15729 def GetTraceMasks(): 15730 """ 15731 GetTraceMasks() -> ArrayString 15732 15733 Returns the currently allowed list of string trace masks. 15734 """ 15735 15736 @staticmethod 15737 def IsAllowedTraceMask(mask): 15738 """ 15739 IsAllowedTraceMask(mask) -> bool 15740 15741 Returns true if the mask is one of allowed masks for wxLogTrace(). 15742 """ 15743 15744 @staticmethod 15745 def RemoveTraceMask(mask): 15746 """ 15747 RemoveTraceMask(mask) 15748 15749 Remove the mask from the list of allowed masks for wxLogTrace(). 15750 """ 15751 15752 @staticmethod 15753 def DontCreateOnDemand(): 15754 """ 15755 DontCreateOnDemand() 15756 15757 Instructs wxLog to not create new log targets on the fly if there is 15758 none currently (see GetActiveTarget()). 15759 """ 15760 15761 @staticmethod 15762 def GetActiveTarget(): 15763 """ 15764 GetActiveTarget() -> Log 15765 15766 Returns the pointer to the active log target (may be NULL). 15767 """ 15768 15769 @staticmethod 15770 def SetActiveTarget(logtarget): 15771 """ 15772 SetActiveTarget(logtarget) -> Log 15773 15774 Sets the specified log target as the active one. 15775 """ 15776 15777 @staticmethod 15778 def SetThreadActiveTarget(logger): 15779 """ 15780 SetThreadActiveTarget(logger) -> Log 15781 15782 Sets a thread-specific log target. 15783 """ 15784 15785 @staticmethod 15786 def FlushActive(): 15787 """ 15788 FlushActive() 15789 15790 Flushes the current log target if any, does nothing if there is none. 15791 """ 15792 15793 @staticmethod 15794 def Resume(): 15795 """ 15796 Resume() 15797 15798 Resumes logging previously suspended by a call to Suspend(). 15799 """ 15800 15801 @staticmethod 15802 def Suspend(): 15803 """ 15804 Suspend() 15805 15806 Suspends the logging until Resume() is called. 15807 """ 15808 15809 @staticmethod 15810 def GetLogLevel(): 15811 """ 15812 GetLogLevel() -> LogLevel 15813 15814 Returns the current log level limit. 15815 """ 15816 15817 @staticmethod 15818 def IsLevelEnabled(level, component): 15819 """ 15820 IsLevelEnabled(level, component) -> bool 15821 15822 Returns true if logging at this level is enabled for the current 15823 thread. 15824 """ 15825 15826 @staticmethod 15827 def SetComponentLevel(component, level): 15828 """ 15829 SetComponentLevel(component, level) 15830 15831 Sets the log level for the given component. 15832 """ 15833 15834 @staticmethod 15835 def SetLogLevel(logLevel): 15836 """ 15837 SetLogLevel(logLevel) 15838 15839 Specifies that log messages with level greater (numerically) than 15840 logLevel should be ignored and not sent to the active log target. 15841 """ 15842 15843 @staticmethod 15844 def EnableLogging(enable=True): 15845 """ 15846 EnableLogging(enable=True) -> bool 15847 15848 Globally enable or disable logging. 15849 """ 15850 15851 @staticmethod 15852 def IsEnabled(): 15853 """ 15854 IsEnabled() -> bool 15855 15856 Returns true if logging is enabled at all now. 15857 """ 15858 15859 @staticmethod 15860 def GetRepetitionCounting(): 15861 """ 15862 GetRepetitionCounting() -> bool 15863 15864 Returns whether the repetition counting mode is enabled. 15865 """ 15866 15867 @staticmethod 15868 def SetRepetitionCounting(repetCounting=True): 15869 """ 15870 SetRepetitionCounting(repetCounting=True) 15871 15872 Enables logging mode in which a log message is logged once, and in 15873 case exactly the same message successively repeats one or more times, 15874 only the number of repetitions is logged. 15875 """ 15876 15877 @staticmethod 15878 def GetTimestamp(): 15879 """ 15880 GetTimestamp() -> String 15881 15882 Returns the current timestamp format string. 15883 """ 15884 15885 @staticmethod 15886 def SetTimestamp(format): 15887 """ 15888 SetTimestamp(format) 15889 15890 Sets the timestamp format prepended by the default log targets to all 15891 messages. 15892 """ 15893 15894 @staticmethod 15895 def DisableTimestamp(): 15896 """ 15897 DisableTimestamp() 15898 15899 Disables time stamping of the log messages. 15900 """ 15901 15902 @staticmethod 15903 def GetVerbose(): 15904 """ 15905 GetVerbose() -> bool 15906 15907 Returns whether the verbose mode is currently active. 15908 """ 15909 15910 @staticmethod 15911 def SetVerbose(verbose=True): 15912 """ 15913 SetVerbose(verbose=True) 15914 15915 Activates or deactivates verbose mode in which the verbose messages 15916 are logged as the normal ones instead of being silently dropped. 15917 """ 15918 15919 def SetFormatter(self, formatter): 15920 """ 15921 SetFormatter(formatter) -> LogFormatter 15922 15923 Sets the specified formatter as the active one. 15924 """ 15925 15926 def Flush(self): 15927 """ 15928 Flush() 15929 15930 Some of wxLog implementations, most notably the standard wxLogGui 15931 class, buffer the messages (for example, to avoid showing the user a 15932 zillion of modal message boxes one after another which would be 15933 really annoying). 15934 """ 15935 15936 def LogRecord(self, level, msg, info): 15937 """ 15938 LogRecord(level, msg, info) 15939 15940 Log the given record. 15941 """ 15942 15943 def DoLogRecord(self, level, msg, info): 15944 """ 15945 DoLogRecord(level, msg, info) 15946 15947 Called to log a new record. 15948 """ 15949 15950 def DoLogTextAtLevel(self, level, msg): 15951 """ 15952 DoLogTextAtLevel(level, msg) 15953 15954 Called to log the specified string at given level. 15955 """ 15956 15957 def DoLogText(self, msg): 15958 """ 15959 DoLogText(msg) 15960 15961 Called to log the specified string. 15962 """ 15963# end of class Log 15964 15965 15966class LogGui(Log): 15967 """ 15968 LogGui() 15969 15970 This is the default log target for the GUI wxWidgets applications. 15971 """ 15972 15973 def __init__(self): 15974 """ 15975 LogGui() 15976 15977 This is the default log target for the GUI wxWidgets applications. 15978 """ 15979 15980 def Flush(self): 15981 """ 15982 Flush() 15983 15984 Presents the accumulated log messages, if any, to the user. 15985 """ 15986# end of class LogGui 15987 15988 15989class LogNull(object): 15990 """ 15991 LogNull() 15992 15993 This class allows you to temporarily suspend logging. 15994 """ 15995 15996 def __init__(self): 15997 """ 15998 LogNull() 15999 16000 This class allows you to temporarily suspend logging. 16001 """ 16002# end of class LogNull 16003 16004 16005class LogRecordInfo(object): 16006 """ 16007 Information about a log record (unit of the log output). 16008 """ 16009 filename = property(None, None) 16010 line = property(None, None) 16011 func = property(None, None) 16012 timestamp = property(None, None) 16013# end of class LogRecordInfo 16014 16015 16016class LogChain(Log): 16017 """ 16018 LogChain(logger) 16019 16020 This simple class allows you to chain log sinks, that is to install a 16021 new sink but keep passing log messages to the old one instead of 16022 replacing it completely as wxLog::SetActiveTarget does. 16023 """ 16024 16025 def __init__(self, logger): 16026 """ 16027 LogChain(logger) 16028 16029 This simple class allows you to chain log sinks, that is to install a 16030 new sink but keep passing log messages to the old one instead of 16031 replacing it completely as wxLog::SetActiveTarget does. 16032 """ 16033 16034 def DetachOldLog(self): 16035 """ 16036 DetachOldLog() 16037 16038 Detaches the old log target so it won't be destroyed when the 16039 wxLogChain object is destroyed. 16040 """ 16041 16042 def GetOldLog(self): 16043 """ 16044 GetOldLog() -> Log 16045 16046 Returns the pointer to the previously active log target (which may be 16047 NULL). 16048 """ 16049 16050 def IsPassingMessages(self): 16051 """ 16052 IsPassingMessages() -> bool 16053 16054 Returns true if the messages are passed to the previously active log 16055 target (default) or false if PassMessages() had been called. 16056 """ 16057 16058 def PassMessages(self, passMessages): 16059 """ 16060 PassMessages(passMessages) 16061 16062 By default, the log messages are passed to the previously active log 16063 target. 16064 """ 16065 16066 def SetLog(self, logger): 16067 """ 16068 SetLog(logger) 16069 16070 Sets another log target to use (may be NULL). 16071 """ 16072 OldLog = property(None, None) 16073# end of class LogChain 16074 16075 16076class LogInterposer(LogChain): 16077 """ 16078 LogInterposer() 16079 16080 A special version of wxLogChain which uses itself as the new log 16081 target. 16082 """ 16083 16084 def __init__(self): 16085 """ 16086 LogInterposer() 16087 16088 A special version of wxLogChain which uses itself as the new log 16089 target. 16090 """ 16091# end of class LogInterposer 16092 16093 16094class LogInterposerTemp(LogChain): 16095 """ 16096 LogInterposerTemp() 16097 16098 A special version of wxLogChain which uses itself as the new log 16099 target. 16100 """ 16101 16102 def __init__(self): 16103 """ 16104 LogInterposerTemp() 16105 16106 A special version of wxLogChain which uses itself as the new log 16107 target. 16108 """ 16109# end of class LogInterposerTemp 16110 16111 16112class LogWindow(LogInterposer): 16113 """ 16114 LogWindow(pParent, szTitle, show=True, passToOld=True) 16115 16116 This class represents a background log window: to be precise, it 16117 collects all log messages in the log frame which it manages but also 16118 passes them on to the log target which was active at the moment of its 16119 creation. 16120 """ 16121 16122 def __init__(self, pParent, szTitle, show=True, passToOld=True): 16123 """ 16124 LogWindow(pParent, szTitle, show=True, passToOld=True) 16125 16126 This class represents a background log window: to be precise, it 16127 collects all log messages in the log frame which it manages but also 16128 passes them on to the log target which was active at the moment of its 16129 creation. 16130 """ 16131 16132 def GetFrame(self): 16133 """ 16134 GetFrame() -> Frame 16135 16136 Returns the associated log frame window. 16137 """ 16138 16139 def OnFrameClose(self, frame): 16140 """ 16141 OnFrameClose(frame) -> bool 16142 16143 Called if the user closes the window interactively, will not be called 16144 if it is destroyed for another reason (such as when program exits). 16145 """ 16146 16147 def OnFrameDelete(self, frame): 16148 """ 16149 OnFrameDelete(frame) 16150 16151 Called right before the log frame is going to be deleted: will always 16152 be called unlike OnFrameClose(). 16153 """ 16154 16155 def Show(self, show=True): 16156 """ 16157 Show(show=True) 16158 16159 Shows or hides the frame. 16160 """ 16161 Frame = property(None, None) 16162# end of class LogWindow 16163 16164 16165class LogStderr(Log): 16166 """ 16167 LogStderr() 16168 16169 This class can be used to redirect the log messages to a C file stream 16170 (not to be confused with C++ streams). 16171 """ 16172 16173 def __init__(self): 16174 """ 16175 LogStderr() 16176 16177 This class can be used to redirect the log messages to a C file stream 16178 (not to be confused with C++ streams). 16179 """ 16180# end of class LogStderr 16181 16182 16183class LogBuffer(Log): 16184 """ 16185 LogBuffer() 16186 16187 wxLogBuffer is a very simple implementation of log sink which simply 16188 collects all the logged messages in a string (except the debug 16189 messages which are output in the usual way immediately as we're 16190 presumably not interested in collecting them for later). 16191 """ 16192 16193 def __init__(self): 16194 """ 16195 LogBuffer() 16196 16197 wxLogBuffer is a very simple implementation of log sink which simply 16198 collects all the logged messages in a string (except the debug 16199 messages which are output in the usual way immediately as we're 16200 presumably not interested in collecting them for later). 16201 """ 16202 16203 def Flush(self): 16204 """ 16205 Flush() 16206 16207 Shows all the messages collected so far to the user (using a message 16208 box in the GUI applications or by printing them out to the console in 16209 text mode) and clears the internal buffer. 16210 """ 16211 16212 def GetBuffer(self): 16213 """ 16214 GetBuffer() -> String 16215 16216 Returns the current buffer contains. 16217 """ 16218 Buffer = property(None, None) 16219# end of class LogBuffer 16220 16221 16222class LogTextCtrl(Log): 16223 """ 16224 LogTextCtrl(pTextCtrl) 16225 16226 Using these target all the log messages can be redirected to a text 16227 control. 16228 """ 16229 16230 def __init__(self, pTextCtrl): 16231 """ 16232 LogTextCtrl(pTextCtrl) 16233 16234 Using these target all the log messages can be redirected to a text 16235 control. 16236 """ 16237# end of class LogTextCtrl 16238 16239 16240class LogFormatter(object): 16241 """ 16242 LogFormatter() 16243 16244 wxLogFormatter class is used to format the log messages. 16245 """ 16246 16247 def __init__(self): 16248 """ 16249 LogFormatter() 16250 16251 wxLogFormatter class is used to format the log messages. 16252 """ 16253 16254 def Format(self, level, msg, info): 16255 """ 16256 Format(level, msg, info) -> String 16257 16258 This function creates the full log message string. 16259 """ 16260 16261 def FormatTime(self, time): 16262 """ 16263 FormatTime(time) -> String 16264 16265 This function formats the time stamp part of the log message. 16266 """ 16267# end of class LogFormatter 16268 16269 16270def SafeShowMessage(title, text): 16271 """ 16272 SafeShowMessage(title, text) 16273 16274 This function shows a message to the user in a safe way and should be 16275 safe to call even before the application has been initialized or if it 16276 is currently in some other strange state (for example, about to 16277 crash). 16278 """ 16279 16280def SysErrorCode(): 16281 """ 16282 SysErrorCode() -> unsignedlong 16283 16284 Returns the error code from the last system call. 16285 """ 16286 16287def SysErrorMsg(errCode=0): 16288 """ 16289 SysErrorMsg(errCode=0) -> String 16290 16291 Returns the error message corresponding to the given system error 16292 code. 16293 """ 16294 16295def LogGeneric(level, message): 16296 """ 16297 LogGeneric(level, message) 16298 16299 Logs a message with the given wxLogLevel. 16300 """ 16301 16302def LogMessage(message): 16303 """ 16304 LogMessage(message) 16305 16306 For all normal, informational messages. 16307 """ 16308 16309def LogVerbose(message): 16310 """ 16311 LogVerbose(message) 16312 16313 For verbose output. 16314 """ 16315 16316def LogWarning(message): 16317 """ 16318 LogWarning(message) 16319 16320 For warnings - they are also normally shown to the user, but don't 16321 interrupt the program work. 16322 """ 16323 16324def LogFatalError(message): 16325 """ 16326 LogFatalError(message) 16327 16328 Like wxLogError(), but also terminates the program with the exit code 16329 3. 16330 """ 16331 16332def LogError(message): 16333 """ 16334 LogError(message) 16335 16336 The functions to use for error messages, i.e. 16337 """ 16338 16339def LogDebug(message): 16340 """ 16341 LogDebug(message) 16342 16343 The right functions for debug output. 16344 """ 16345 16346def LogStatus(*args, **kw): 16347 """ 16348 LogStatus(frame, message) 16349 LogStatus(message) 16350 16351 Messages logged by this function will appear in the statusbar of the 16352 frame or of the top level application window by default (i.e. 16353 """ 16354 16355def LogSysError(message): 16356 """ 16357 LogSysError(message) 16358 16359 Mostly used by wxWidgets itself, but might be handy for logging errors 16360 after system call (API function) failure. 16361 """ 16362#-- end-log --# 16363#-- begin-dataobj --# 16364 16365class DataFormat(object): 16366 """ 16367 DataFormat(format=DF_INVALID) 16368 DataFormat(format) 16369 16370 A wxDataFormat is an encapsulation of a platform-specific format 16371 handle which is used by the system for the clipboard and drag and drop 16372 operations. 16373 """ 16374 16375 def __init__(self, *args, **kw): 16376 """ 16377 DataFormat(format=DF_INVALID) 16378 DataFormat(format) 16379 16380 A wxDataFormat is an encapsulation of a platform-specific format 16381 handle which is used by the system for the clipboard and drag and drop 16382 operations. 16383 """ 16384 16385 def GetId(self): 16386 """ 16387 GetId() -> String 16388 16389 Returns the name of a custom format (this function will fail for a 16390 standard format). 16391 """ 16392 16393 def GetType(self): 16394 """ 16395 GetType() -> DataFormatId 16396 16397 Returns the platform-specific number identifying the format. 16398 """ 16399 16400 def SetId(self, format): 16401 """ 16402 SetId(format) 16403 16404 Sets the format to be the custom format identified by the given name. 16405 """ 16406 16407 def SetType(self, type): 16408 """ 16409 SetType(type) 16410 16411 Sets the format to the given value, which should be one of wxDF_XXX 16412 constants. 16413 """ 16414 16415 def __ne__(self, *args, **kw): 16416 """ 16417 """ 16418 16419 def __eq__(self, *args, **kw): 16420 """ 16421 """ 16422 Id = property(None, None) 16423 Type = property(None, None) 16424# end of class DataFormat 16425 16426FormatInvalid = DataFormat() 16427 16428class DataObject(object): 16429 """ 16430 DataObject() 16431 16432 A wxDataObject represents data that can be copied to or from the 16433 clipboard, or dragged and dropped. 16434 """ 16435 Get = 0 16436 Set = 0 16437 Both = 0 16438 16439 def __init__(self): 16440 """ 16441 DataObject() 16442 16443 A wxDataObject represents data that can be copied to or from the 16444 clipboard, or dragged and dropped. 16445 """ 16446 16447 def GetAllFormats(self, dir=Get): 16448 """ 16449 GetAllFormats(dir=Get) 16450 16451 Returns a list of wx.DataFormat objects which this data object 16452 supports transferring in the given direction. 16453 """ 16454 16455 def GetDataHere(self, format, buf): 16456 """ 16457 GetDataHere(format, buf) -> bool 16458 16459 Copies this data object's data in the requested format to the buffer 16460 provided. 16461 """ 16462 16463 def GetDataSize(self, format): 16464 """ 16465 GetDataSize(format) -> size_t 16466 16467 Returns the data size of the given format format. 16468 """ 16469 16470 def GetFormatCount(self, dir=Get): 16471 """ 16472 GetFormatCount(dir=Get) -> size_t 16473 16474 Returns the number of available formats for rendering or setting the 16475 data. 16476 """ 16477 16478 def GetPreferredFormat(self, dir=Get): 16479 """ 16480 GetPreferredFormat(dir=Get) -> DataFormat 16481 16482 Returns the preferred format for either rendering the data (if dir is 16483 Get, its default value) or for setting it. 16484 """ 16485 16486 def SetData(self, format, buf): 16487 """ 16488 SetData(format, buf) -> bool 16489 16490 Copies data from the provided buffer to this data object for the 16491 specified format. 16492 """ 16493 16494 def IsSupported(self, format, dir=Get): 16495 """ 16496 IsSupported(format, dir=Get) -> bool 16497 16498 Returns true if this format is supported. 16499 """ 16500 16501 def _testGetAllFormats(self): 16502 """ 16503 _testGetAllFormats() 16504 """ 16505 AllFormats = property(None, None) 16506 DataHere = property(None, None) 16507 FormatCount = property(None, None) 16508 PreferredFormat = property(None, None) 16509# end of class DataObject 16510 16511 16512class DataObjectSimple(DataObject): 16513 """ 16514 DataObjectSimple(format=FormatInvalid) 16515 DataObjectSimple(formatName) 16516 16517 This is the simplest possible implementation of the wxDataObject 16518 class. 16519 """ 16520 16521 def __init__(self, *args, **kw): 16522 """ 16523 DataObjectSimple(format=FormatInvalid) 16524 DataObjectSimple(formatName) 16525 16526 This is the simplest possible implementation of the wxDataObject 16527 class. 16528 """ 16529 16530 def GetDataHere(self, buf): 16531 """ 16532 GetDataHere(buf) -> bool 16533 16534 Copies this data object's data bytes to the given buffer 16535 """ 16536 16537 def GetDataSize(self): 16538 """ 16539 GetDataSize() -> size_t 16540 16541 Gets the size of our data. 16542 """ 16543 16544 def GetFormat(self): 16545 """ 16546 GetFormat() -> DataFormat 16547 16548 Returns the (one and only one) format supported by this object. 16549 """ 16550 16551 def SetData(self, *args, **kw): 16552 """ 16553 SetData(buf) -> bool 16554 SetData(format, buf) -> bool 16555 16556 Copies data from the provided buffer to this data object. 16557 """ 16558 16559 def SetFormat(self, format): 16560 """ 16561 SetFormat(format) 16562 16563 Sets the supported format. 16564 """ 16565 16566 def GetAllFormats(self, dir=DataObject.Get): 16567 """ 16568 GetAllFormats(dir=DataObject.Get) 16569 16570 Returns a list of wx.DataFormat objects which this data object 16571 supports transferring in the given direction. 16572 """ 16573 AllFormats = property(None, None) 16574 DataHere = property(None, None) 16575 DataSize = property(None, None) 16576 Format = property(None, None) 16577# end of class DataObjectSimple 16578 16579 16580class CustomDataObject(DataObjectSimple): 16581 """ 16582 CustomDataObject(format=FormatInvalid) 16583 CustomDataObject(formatName) 16584 16585 wxCustomDataObject is a specialization of wxDataObjectSimple for some 16586 application-specific data in arbitrary (either custom or one of the 16587 standard ones). 16588 """ 16589 16590 def __init__(self, *args, **kw): 16591 """ 16592 CustomDataObject(format=FormatInvalid) 16593 CustomDataObject(formatName) 16594 16595 wxCustomDataObject is a specialization of wxDataObjectSimple for some 16596 application-specific data in arbitrary (either custom or one of the 16597 standard ones). 16598 """ 16599 16600 def GetData(self): 16601 """ 16602 GetData() -> PyObject 16603 16604 Returns a reference to the data buffer. 16605 """ 16606 16607 def GetSize(self): 16608 """ 16609 GetSize() -> size_t 16610 16611 Returns the data size in bytes. 16612 """ 16613 16614 def SetData(self, *args, **kw): 16615 """ 16616 SetData(buf) -> bool 16617 SetData(format, buf) -> bool 16618 16619 Copies data from the provided buffer to this data object's buffer 16620 """ 16621 16622 def GetAllFormats(self, dir=DataObject.Get): 16623 """ 16624 GetAllFormats(dir=DataObject.Get) 16625 16626 Returns a list of wx.DataFormat objects which this data object 16627 supports transferring in the given direction. 16628 """ 16629 AllFormats = property(None, None) 16630 Data = property(None, None) 16631 Size = property(None, None) 16632# end of class CustomDataObject 16633 16634 16635class DataObjectComposite(DataObject): 16636 """ 16637 DataObjectComposite() 16638 16639 wxDataObjectComposite is the simplest wxDataObject derivation which 16640 may be used to support multiple formats. 16641 """ 16642 16643 def __init__(self): 16644 """ 16645 DataObjectComposite() 16646 16647 wxDataObjectComposite is the simplest wxDataObject derivation which 16648 may be used to support multiple formats. 16649 """ 16650 16651 def Add(self, dataObject, preferred=False): 16652 """ 16653 Add(dataObject, preferred=False) 16654 16655 Adds the dataObject to the list of supported objects and it becomes 16656 the preferred object if preferred is true. 16657 """ 16658 16659 def GetReceivedFormat(self): 16660 """ 16661 GetReceivedFormat() -> DataFormat 16662 16663 Report the format passed to the SetData() method. 16664 """ 16665 16666 def GetObject(self, format, dir=DataObject.Get): 16667 """ 16668 GetObject(format, dir=DataObject.Get) -> DataObjectSimple 16669 16670 Returns the pointer to the object which supports the passed format for 16671 the specified direction. 16672 """ 16673 16674 def GetAllFormats(self, dir=DataObject.Get): 16675 """ 16676 GetAllFormats(dir=DataObject.Get) 16677 16678 Returns a list of wx.DataFormat objects which this data object 16679 supports transferring in the given direction. 16680 """ 16681 16682 def SetData(self, format, buf): 16683 """ 16684 SetData(format, buf) -> bool 16685 """ 16686 AllFormats = property(None, None) 16687 ReceivedFormat = property(None, None) 16688# end of class DataObjectComposite 16689 16690 16691class BitmapDataObject(DataObjectSimple): 16692 """ 16693 BitmapDataObject(bitmap=NullBitmap) 16694 16695 wxBitmapDataObject is a specialization of wxDataObject for bitmap 16696 data. 16697 """ 16698 16699 def __init__(self, bitmap=NullBitmap): 16700 """ 16701 BitmapDataObject(bitmap=NullBitmap) 16702 16703 wxBitmapDataObject is a specialization of wxDataObject for bitmap 16704 data. 16705 """ 16706 16707 def GetBitmap(self): 16708 """ 16709 GetBitmap() -> Bitmap 16710 16711 Returns the bitmap associated with the data object. 16712 """ 16713 16714 def SetBitmap(self, bitmap): 16715 """ 16716 SetBitmap(bitmap) 16717 16718 Sets the bitmap associated with the data object. 16719 """ 16720 16721 def GetAllFormats(self, dir=DataObject.Get): 16722 """ 16723 GetAllFormats(dir=DataObject.Get) 16724 16725 Returns a list of wx.DataFormat objects which this data object 16726 supports transferring in the given direction. 16727 """ 16728 16729 def SetData(self, format, buf): 16730 """ 16731 SetData(format, buf) -> bool 16732 """ 16733 AllFormats = property(None, None) 16734 Bitmap = property(None, None) 16735# end of class BitmapDataObject 16736 16737 16738class TextDataObject(DataObjectSimple): 16739 """ 16740 TextDataObject(text=EmptyString) 16741 16742 wxTextDataObject is a specialization of wxDataObjectSimple for text 16743 data. 16744 """ 16745 16746 def __init__(self, text=EmptyString): 16747 """ 16748 TextDataObject(text=EmptyString) 16749 16750 wxTextDataObject is a specialization of wxDataObjectSimple for text 16751 data. 16752 """ 16753 16754 def GetText(self): 16755 """ 16756 GetText() -> String 16757 16758 Returns the text associated with the data object. 16759 """ 16760 16761 def GetTextLength(self): 16762 """ 16763 GetTextLength() -> size_t 16764 16765 Returns the data size. 16766 """ 16767 16768 def GetFormatCount(self, dir=DataObject.Get): 16769 """ 16770 GetFormatCount(dir=DataObject.Get) -> size_t 16771 16772 Returns 2 under wxMac and wxGTK, where text data coming from the 16773 clipboard may be provided as ANSI (wxDF_TEXT) or as Unicode text 16774 (wxDF_UNICODETEXT, but only when wxUSE_UNICODE==1). 16775 """ 16776 16777 def GetFormat(self): 16778 """ 16779 GetFormat() -> DataFormat 16780 16781 Returns the preferred format supported by this object. 16782 """ 16783 16784 def GetAllFormats(self, dir=DataObject.Get): 16785 """ 16786 GetAllFormats(dir=DataObject.Get) 16787 16788 Returns a list of wx.DataFormat objects which this data object 16789 supports transferring in the given direction. 16790 """ 16791 16792 def SetText(self, strText): 16793 """ 16794 SetText(strText) 16795 16796 Sets the text associated with the data object. 16797 """ 16798 16799 def SetData(self, format, buf): 16800 """ 16801 SetData(format, buf) -> bool 16802 """ 16803 AllFormats = property(None, None) 16804 Format = property(None, None) 16805 FormatCount = property(None, None) 16806 Text = property(None, None) 16807 TextLength = property(None, None) 16808# end of class TextDataObject 16809 16810 16811class URLDataObject(DataObject): 16812 """ 16813 URLDataObject(url=EmptyString) 16814 16815 wxURLDataObject is a wxDataObject containing an URL and can be used 16816 e.g. 16817 """ 16818 16819 def __init__(self, url=EmptyString): 16820 """ 16821 URLDataObject(url=EmptyString) 16822 16823 wxURLDataObject is a wxDataObject containing an URL and can be used 16824 e.g. 16825 """ 16826 16827 def GetURL(self): 16828 """ 16829 GetURL() -> String 16830 16831 Returns the URL stored by this object, as a string. 16832 """ 16833 16834 def SetURL(self, url): 16835 """ 16836 SetURL(url) 16837 16838 Sets the URL stored by this object. 16839 """ 16840 16841 def GetAllFormats(self, dir=DataObject.Get): 16842 """ 16843 GetAllFormats(dir=DataObject.Get) 16844 16845 Returns a list of wx.DataFormat objects which this data object 16846 supports transferring in the given direction. 16847 """ 16848 16849 def SetData(self, format, buf): 16850 """ 16851 SetData(format, buf) -> bool 16852 """ 16853 AllFormats = property(None, None) 16854 URL = property(None, None) 16855# end of class URLDataObject 16856 16857 16858class FileDataObject(DataObjectSimple): 16859 """ 16860 FileDataObject() 16861 16862 wxFileDataObject is a specialization of wxDataObject for file names. 16863 """ 16864 16865 def __init__(self): 16866 """ 16867 FileDataObject() 16868 16869 wxFileDataObject is a specialization of wxDataObject for file names. 16870 """ 16871 16872 def AddFile(self, file): 16873 """ 16874 AddFile(file) 16875 16876 Adds a file to the file list represented by this data object (Windows 16877 only). 16878 """ 16879 16880 def GetFilenames(self): 16881 """ 16882 GetFilenames() -> ArrayString 16883 16884 Returns the array of file names. 16885 """ 16886 16887 def GetAllFormats(self, dir=DataObject.Get): 16888 """ 16889 GetAllFormats(dir=DataObject.Get) 16890 16891 Returns a list of wx.DataFormat objects which this data object 16892 supports transferring in the given direction. 16893 """ 16894 16895 def SetData(self, format, buf): 16896 """ 16897 SetData(format, buf) -> bool 16898 """ 16899 AllFormats = property(None, None) 16900 Filenames = property(None, None) 16901# end of class FileDataObject 16902 16903 16904class HTMLDataObject(DataObjectSimple): 16905 """ 16906 HTMLDataObject(html=EmptyString) 16907 16908 wxHTMLDataObject is used for working with HTML-formatted text. 16909 """ 16910 16911 def __init__(self, html=EmptyString): 16912 """ 16913 HTMLDataObject(html=EmptyString) 16914 16915 wxHTMLDataObject is used for working with HTML-formatted text. 16916 """ 16917 16918 def GetHTML(self): 16919 """ 16920 GetHTML() -> String 16921 16922 Returns the HTML string. 16923 """ 16924 16925 def SetHTML(self, html): 16926 """ 16927 SetHTML(html) 16928 16929 Sets the HTML string. 16930 """ 16931 16932 def GetAllFormats(self, dir=DataObject.Get): 16933 """ 16934 GetAllFormats(dir=DataObject.Get) 16935 16936 Returns a list of wx.DataFormat objects which this data object 16937 supports transferring in the given direction. 16938 """ 16939 16940 def SetData(self, format, buf): 16941 """ 16942 SetData(format, buf) -> bool 16943 """ 16944 AllFormats = property(None, None) 16945 HTML = property(None, None) 16946# end of class HTMLDataObject 16947 16948 16949def CustomDataFormat(format): 16950 return wx.DataFormat(format) 16951CustomDataFormat = wx.deprecated(CustomDataFormat, "Use wx.DataFormat instead.") 16952 16953PyDataObjectSimple = wx.deprecated(DataObjectSimple), 'Use DataObjectSimple instead.' 16954 16955PyTextDataObject = wx.deprecated(TextDataObject, 'Use TextDataObject instead.') 16956 16957PyBitmapDataObject = wx.deprecated(BitmapDataObject, 'Use TextDataObject instead.') 16958#-- end-dataobj --# 16959#-- begin-dnd --# 16960Drag_CopyOnly = 0 16961Drag_AllowMove = 0 16962Drag_DefaultMove = 0 16963DragError = 0 16964DragNone = 0 16965DragCopy = 0 16966DragMove = 0 16967DragLink = 0 16968DragCancel = 0 16969 16970def IsDragResultOk(res): 16971 """ 16972 IsDragResultOk(res) -> bool 16973 16974 Returns true if res indicates that something was done during a DnD 16975 operation, i.e. 16976 """ 16977 16978class DropSource(object): 16979 """ 16980 DropSource(win=None) 16981 DropSource(data, win=None) 16982 16983 This class represents a source for a drag and drop operation. 16984 """ 16985 16986 def __init__(self, *args, **kw): 16987 """ 16988 DropSource(win=None) 16989 DropSource(data, win=None) 16990 16991 This class represents a source for a drag and drop operation. 16992 """ 16993 16994 def DoDragDrop(self, flags=Drag_CopyOnly): 16995 """ 16996 DoDragDrop(flags=Drag_CopyOnly) -> DragResult 16997 16998 Starts the drag-and-drop operation which will terminate when the user 16999 releases the mouse. 17000 """ 17001 17002 def GetDataObject(self): 17003 """ 17004 GetDataObject() -> DataObject 17005 17006 Returns the wxDataObject object that has been assigned previously. 17007 """ 17008 17009 def GiveFeedback(self, effect): 17010 """ 17011 GiveFeedback(effect) -> bool 17012 17013 You may give some custom UI feedback during the drag and drop 17014 operation by overriding this function. 17015 """ 17016 17017 def SetCursor(self, res, cursor): 17018 """ 17019 SetCursor(res, cursor) 17020 17021 Set the icon to use for a certain drag result. 17022 """ 17023 17024 def SetIcon(self, res, icon): 17025 """ 17026 SetIcon(res, icon) 17027 17028 Set the icon to use for a certain drag result. 17029 """ 17030 17031 def SetData(self, data): 17032 """ 17033 SetData(data) 17034 17035 Sets the data wxDataObject associated with the drop source. 17036 """ 17037 DataObject = property(None, None) 17038# end of class DropSource 17039 17040 17041class DropTarget(object): 17042 """ 17043 DropTarget(data=None) 17044 17045 This class represents a target for a drag and drop operation. 17046 """ 17047 17048 def __init__(self, data=None): 17049 """ 17050 DropTarget(data=None) 17051 17052 This class represents a target for a drag and drop operation. 17053 """ 17054 17055 def GetData(self): 17056 """ 17057 GetData() -> bool 17058 17059 This method may only be called from within OnData(). 17060 """ 17061 17062 def OnData(self, x, y, defResult): 17063 """ 17064 OnData(x, y, defResult) -> DragResult 17065 17066 Called after OnDrop() returns true. 17067 """ 17068 17069 def OnDragOver(self, x, y, defResult): 17070 """ 17071 OnDragOver(x, y, defResult) -> DragResult 17072 17073 Called when the mouse is being dragged over the drop target. 17074 """ 17075 17076 def OnDrop(self, x, y): 17077 """ 17078 OnDrop(x, y) -> bool 17079 17080 Called when the user drops a data object on the target. 17081 """ 17082 17083 def OnEnter(self, x, y, defResult): 17084 """ 17085 OnEnter(x, y, defResult) -> DragResult 17086 17087 Called when the mouse enters the drop target. 17088 """ 17089 17090 def OnLeave(self): 17091 """ 17092 OnLeave() 17093 17094 Called when the mouse leaves the drop target. 17095 """ 17096 17097 def GetDataObject(self): 17098 """ 17099 GetDataObject() -> DataObject 17100 17101 Returns the data wxDataObject associated with the drop target. 17102 """ 17103 17104 def SetDataObject(self, data): 17105 """ 17106 SetDataObject(data) 17107 17108 Sets the data wxDataObject associated with the drop target and deletes 17109 any previously associated data object. 17110 """ 17111 17112 def SetDefaultAction(self, action): 17113 """ 17114 SetDefaultAction(action) 17115 17116 Sets the default action for drag and drop. 17117 """ 17118 17119 def GetDefaultAction(self): 17120 """ 17121 GetDefaultAction() -> DragResult 17122 17123 Returns default action for drag and drop or wxDragNone if this not 17124 specified. 17125 """ 17126 Data = property(None, None) 17127 DataObject = property(None, None) 17128 DefaultAction = property(None, None) 17129# end of class DropTarget 17130 17131 17132class TextDropTarget(DropTarget): 17133 """ 17134 TextDropTarget() 17135 17136 A predefined drop target for dealing with text data. 17137 """ 17138 17139 def __init__(self): 17140 """ 17141 TextDropTarget() 17142 17143 A predefined drop target for dealing with text data. 17144 """ 17145 17146 def OnDrop(self, x, y): 17147 """ 17148 OnDrop(x, y) -> bool 17149 17150 See wxDropTarget::OnDrop(). 17151 """ 17152 17153 def OnDropText(self, x, y, data): 17154 """ 17155 OnDropText(x, y, data) -> bool 17156 17157 Override this function to receive dropped text. 17158 """ 17159# end of class TextDropTarget 17160 17161 17162class FileDropTarget(DropTarget): 17163 """ 17164 FileDropTarget() 17165 17166 This is a drop target which accepts files (dragged from File Manager 17167 or Explorer). 17168 """ 17169 17170 def __init__(self): 17171 """ 17172 FileDropTarget() 17173 17174 This is a drop target which accepts files (dragged from File Manager 17175 or Explorer). 17176 """ 17177 17178 def OnDrop(self, x, y): 17179 """ 17180 OnDrop(x, y) -> bool 17181 17182 See wxDropTarget::OnDrop(). 17183 """ 17184 17185 def OnDropFiles(self, x, y, filenames): 17186 """ 17187 OnDropFiles(x, y, filenames) -> bool 17188 17189 Override this function to receive dropped files. 17190 """ 17191# end of class FileDropTarget 17192 17193 17194PyDropTarget = wx.deprecated(DropTarget, 'Use DropTarget instead.') 17195#-- end-dnd --# 17196#-- begin-clipbrd --# 17197 17198class Clipboard(Object): 17199 """ 17200 Clipboard() 17201 17202 A class for manipulating the clipboard. 17203 """ 17204 17205 def __init__(self): 17206 """ 17207 Clipboard() 17208 17209 A class for manipulating the clipboard. 17210 """ 17211 17212 def AddData(self, data): 17213 """ 17214 AddData(data) -> bool 17215 17216 Call this function to add the data object to the clipboard. 17217 """ 17218 17219 def Clear(self): 17220 """ 17221 Clear() 17222 17223 Clears the global clipboard object and the system's clipboard if 17224 possible. 17225 """ 17226 17227 def Close(self): 17228 """ 17229 Close() 17230 17231 Call this function to close the clipboard, having opened it with 17232 Open(). 17233 """ 17234 17235 def Flush(self): 17236 """ 17237 Flush() -> bool 17238 17239 Flushes the clipboard: this means that the data which is currently on 17240 clipboard will stay available even after the application exits 17241 (possibly eating memory), otherwise the clipboard will be emptied on 17242 exit. 17243 """ 17244 17245 def GetData(self, data): 17246 """ 17247 GetData(data) -> bool 17248 17249 Call this function to fill data with data on the clipboard, if 17250 available in the required format. 17251 """ 17252 17253 def IsOpened(self): 17254 """ 17255 IsOpened() -> bool 17256 17257 Returns true if the clipboard has been opened. 17258 """ 17259 17260 def IsSupported(self, format): 17261 """ 17262 IsSupported(format) -> bool 17263 17264 Returns true if there is data which matches the data format of the 17265 given data object currently available on the clipboard. 17266 """ 17267 17268 def IsUsingPrimarySelection(self): 17269 """ 17270 IsUsingPrimarySelection() -> bool 17271 17272 Returns true if we are using the primary selection, false if clipboard 17273 one. 17274 """ 17275 17276 def Open(self): 17277 """ 17278 Open() -> bool 17279 17280 Call this function to open the clipboard before calling SetData() and 17281 GetData(). 17282 """ 17283 17284 def SetData(self, data): 17285 """ 17286 SetData(data) -> bool 17287 17288 Call this function to set the data object to the clipboard. 17289 """ 17290 17291 def UsePrimarySelection(self, primary=False): 17292 """ 17293 UsePrimarySelection(primary=False) 17294 17295 On platforms supporting it (all X11-based ports), wxClipboard uses the 17296 CLIPBOARD X11 selection by default. 17297 """ 17298 17299 @staticmethod 17300 def Get(): 17301 """ 17302 Get() -> Clipboard 17303 17304 Returns the global instance (wxTheClipboard) of the clipboard object. 17305 """ 17306# end of class Clipboard 17307 17308 17309# Since wxTheClipboard is not really a global variable (it is a macro 17310# that calls the Get static method) we can't declare it as a global 17311# variable for the wrapper generator, otherwise it will try to run the 17312# function at module import and the wxApp object won't exist yet. So 17313# we'll use a class that will allow us to delay calling the Get until 17314# wx.TheClipboard is actually being used for the first time. 17315class _wxPyDelayedInitWrapper(object): 17316 def __init__(self, initfunc, *args, **kwargs): 17317 self._initfunc = initfunc 17318 self._args = args 17319 self._kwargs = kwargs 17320 self._instance = None 17321 def _checkInstance(self): 17322 if self._instance is None: 17323 if wx.GetApp(): 17324 self._instance = self._initfunc(*self._args, **self._kwargs) 17325 def __getattr__(self, name): 17326 self._checkInstance() 17327 return getattr(self._instance, name) 17328 def __repr__(self): 17329 self._checkInstance() 17330 return repr(self._instance) 17331 17332 # context manager methods 17333 def __enter__(self): 17334 self._checkInstance() 17335 if not self.Open(): 17336 raise RuntimeError('Unable to open clipboard.') 17337 return self 17338 def __exit__(self, exc_type, exc_val, exc_tb): 17339 self.Close() 17340 17341TheClipboard = _wxPyDelayedInitWrapper(Clipboard.Get) 17342#-- end-clipbrd --# 17343#-- begin-config --# 17344CONFIG_USE_LOCAL_FILE = 0 17345CONFIG_USE_GLOBAL_FILE = 0 17346CONFIG_USE_RELATIVE_PATH = 0 17347CONFIG_USE_NO_ESCAPE_CHARACTERS = 0 17348CONFIG_USE_SUBDIR = 0 17349 17350class ConfigBase(Object): 17351 """ 17352 ConfigBase(appName=EmptyString, vendorName=EmptyString, localFilename=EmptyString, globalFilename=EmptyString, style=0) 17353 17354 wxConfigBase defines the basic interface of all config classes. 17355 """ 17356 Type_Unknown = 0 17357 Type_String = 0 17358 Type_Boolean = 0 17359 Type_Integer = 0 17360 Type_Float = 0 17361 17362 def __init__(self, appName=EmptyString, vendorName=EmptyString, localFilename=EmptyString, globalFilename=EmptyString, style=0): 17363 """ 17364 ConfigBase(appName=EmptyString, vendorName=EmptyString, localFilename=EmptyString, globalFilename=EmptyString, style=0) 17365 17366 wxConfigBase defines the basic interface of all config classes. 17367 """ 17368 17369 def GetPath(self): 17370 """ 17371 GetPath() -> String 17372 17373 Retrieve the current path (always as absolute path). 17374 """ 17375 17376 def SetPath(self, strPath): 17377 """ 17378 SetPath(strPath) 17379 17380 Set current path: if the first character is '/', it is the absolute 17381 path, otherwise it is a relative path. 17382 """ 17383 17384 def GetFirstEntry(self): 17385 """ 17386 GetFirstEntry() -> PyObject 17387 17388 GetFirstEntry() -> (more, value, index) 17389 17390 Allows enumerating the entries in the current group in a config 17391 object. Returns a tuple containing a flag indicating if there are 17392 more 17393 items, the name of the current item, and an index to pass to 17394 GetNextEntry to fetch the next item. 17395 """ 17396 17397 def GetFirstGroup(self): 17398 """ 17399 GetFirstGroup() -> PyObject 17400 17401 GetFirstGroup() -> (more, value, index) 17402 17403 Allows enumerating the subgroups in a config object. Returns a tuple 17404 containing a flag indicating if there are more items, the name of the 17405 current item, and an index to pass to GetNextGroup to fetch the next 17406 item. 17407 """ 17408 17409 def GetNextEntry(self, index): 17410 """ 17411 GetNextEntry(index) -> PyObject 17412 17413 GetNextEntry() -> (more, value, index) 17414 17415 Allows enumerating the entries in the current group in a config 17416 object. Returns a tuple containing a flag indicating if there are 17417 more 17418 items, the name of the current item, and an index to pass to 17419 GetNextEntry to fetch the next item. 17420 """ 17421 17422 def GetNextGroup(self, index): 17423 """ 17424 GetNextGroup(index) -> PyObject 17425 17426 GetNextGroup(long index) -> (more, value, index) 17427 17428 Allows enumerating the subgroups in a config object. Returns a tuple 17429 containing a flag indicating if there are more items, the name of the 17430 current item, and an index to pass to GetNextGroup to fetch the next 17431 item. 17432 """ 17433 17434 def GetNumberOfEntries(self, bRecursive=False): 17435 """ 17436 GetNumberOfEntries(bRecursive=False) -> size_t 17437 17438 Get number of entries in the current group. 17439 """ 17440 17441 def GetNumberOfGroups(self, bRecursive=False): 17442 """ 17443 GetNumberOfGroups(bRecursive=False) -> size_t 17444 17445 Get number of entries/subgroups in the current group, with or without 17446 its subgroups. 17447 """ 17448 17449 def Exists(self, strName): 17450 """ 17451 Exists(strName) -> bool 17452 """ 17453 17454 def GetEntryType(self, name): 17455 """ 17456 GetEntryType(name) -> ConfigBase.EntryType 17457 17458 Returns the type of the given entry or Unknown if the entry doesn't 17459 exist. 17460 """ 17461 17462 def HasEntry(self, strName): 17463 """ 17464 HasEntry(strName) -> bool 17465 """ 17466 17467 def HasGroup(self, strName): 17468 """ 17469 HasGroup(strName) -> bool 17470 """ 17471 17472 def GetAppName(self): 17473 """ 17474 GetAppName() -> String 17475 17476 Returns the application name. 17477 """ 17478 17479 def GetVendorName(self): 17480 """ 17481 GetVendorName() -> String 17482 17483 Returns the vendor name. 17484 """ 17485 17486 def Flush(self, bCurrentOnly=False): 17487 """ 17488 Flush(bCurrentOnly=False) -> bool 17489 17490 Permanently writes all changes (otherwise, they're only written from 17491 object's destructor). 17492 """ 17493 17494 def Read(self, key, defaultVal=EmptyString): 17495 """ 17496 Read(key, defaultVal=EmptyString) -> String 17497 17498 Another version of Read(), returning the string value directly. 17499 """ 17500 17501 def ReadBool(self, key, defaultVal=False): 17502 """ 17503 ReadBool(key, defaultVal=False) -> bool 17504 """ 17505 17506 def ReadDouble(self, key, defaultVal): 17507 """ 17508 ReadDouble(key, defaultVal) -> double 17509 17510 Reads a double value from the key and returns it. 17511 """ 17512 17513 def ReadLong(self, key, defaultVal): 17514 """ 17515 ReadLong(key, defaultVal) -> long 17516 17517 Reads a long value from the key and returns it. 17518 """ 17519 17520 def Write(self, key, value): 17521 """ 17522 Write(key, value) -> bool 17523 17524 Writes the wxString value to the config file and returns true on 17525 success. 17526 """ 17527 17528 def RenameEntry(self, oldName, newName): 17529 """ 17530 RenameEntry(oldName, newName) -> bool 17531 17532 Renames an entry in the current group. 17533 """ 17534 17535 def RenameGroup(self, oldName, newName): 17536 """ 17537 RenameGroup(oldName, newName) -> bool 17538 17539 Renames a subgroup of the current group. 17540 """ 17541 17542 def DeleteAll(self): 17543 """ 17544 DeleteAll() -> bool 17545 17546 Delete the whole underlying object (disk file, registry key, ...). 17547 """ 17548 17549 def DeleteEntry(self, key, bDeleteGroupIfEmpty=True): 17550 """ 17551 DeleteEntry(key, bDeleteGroupIfEmpty=True) -> bool 17552 17553 Deletes the specified entry and the group it belongs to if it was the 17554 last key in it and the second parameter is true. 17555 """ 17556 17557 def DeleteGroup(self, key): 17558 """ 17559 DeleteGroup(key) -> bool 17560 17561 Delete the group (with all subgroups). 17562 """ 17563 17564 def IsExpandingEnvVars(self): 17565 """ 17566 IsExpandingEnvVars() -> bool 17567 17568 Returns true if we are expanding environment variables in key values. 17569 """ 17570 17571 def IsRecordingDefaults(self): 17572 """ 17573 IsRecordingDefaults() -> bool 17574 17575 Returns true if we are writing defaults back to the config file. 17576 """ 17577 17578 def SetExpandEnvVars(self, bDoIt=True): 17579 """ 17580 SetExpandEnvVars(bDoIt=True) 17581 17582 Determine whether we wish to expand environment variables in key 17583 values. 17584 """ 17585 17586 def SetRecordDefaults(self, bDoIt=True): 17587 """ 17588 SetRecordDefaults(bDoIt=True) 17589 17590 Sets whether defaults are recorded to the config file whenever an 17591 attempt to read the value which is not present in it is done. 17592 """ 17593 17594 @staticmethod 17595 def Create(): 17596 """ 17597 Create() -> ConfigBase 17598 17599 Create a new config object and sets it as the current one. 17600 """ 17601 17602 @staticmethod 17603 def DontCreateOnDemand(): 17604 """ 17605 DontCreateOnDemand() 17606 17607 Calling this function will prevent Get() from automatically creating a 17608 new config object if the current one is NULL. 17609 """ 17610 17611 @staticmethod 17612 def Get(CreateOnDemand=True): 17613 """ 17614 Get(CreateOnDemand=True) -> ConfigBase 17615 17616 Get the current config object. 17617 """ 17618 17619 @staticmethod 17620 def Set(pConfig): 17621 """ 17622 Set(pConfig) -> ConfigBase 17623 17624 Sets the config object as the current one, returns the pointer to the 17625 previous current object (both the parameter and returned value may be 17626 NULL). 17627 """ 17628 17629 def _cpp_ReadInt(self, key, defaultVal=0): 17630 """ 17631 _cpp_ReadInt(key, defaultVal=0) -> long 17632 """ 17633 17634 def ReadInt(self, key, defaultVal=0): 17635 """ 17636 17637 """ 17638 17639 def ReadFloat(self, key, defaultVal=0.0): 17640 """ 17641 ReadFloat(key, defaultVal=0.0) -> double 17642 """ 17643 17644 def WriteInt(self, key, value): 17645 """ 17646 WriteInt(key, value) -> bool 17647 """ 17648 17649 def WriteFloat(self, key, value): 17650 """ 17651 WriteFloat(key, value) -> bool 17652 """ 17653 17654 def WriteBool(self, key, value): 17655 """ 17656 WriteBool(key, value) -> bool 17657 """ 17658 AppName = property(None, None) 17659 FirstEntry = property(None, None) 17660 FirstGroup = property(None, None) 17661 NextEntry = property(None, None) 17662 NextGroup = property(None, None) 17663 NumberOfEntries = property(None, None) 17664 NumberOfGroups = property(None, None) 17665 Path = property(None, None) 17666 VendorName = property(None, None) 17667# end of class ConfigBase 17668 17669 17670class FileConfig(ConfigBase): 17671 """ 17672 FileConfig(appName=EmptyString, vendorName=EmptyString, localFilename=EmptyString, globalFilename=EmptyString, style=CONFIG_USE_LOCAL_FILE|CONFIG_USE_GLOBAL_FILE) 17673 FileConfig(is) 17674 17675 wxFileConfig implements wxConfigBase interface for storing and 17676 retrieving configuration information using plain text files. 17677 """ 17678 17679 def __init__(self, *args, **kw): 17680 """ 17681 FileConfig(appName=EmptyString, vendorName=EmptyString, localFilename=EmptyString, globalFilename=EmptyString, style=CONFIG_USE_LOCAL_FILE|CONFIG_USE_GLOBAL_FILE) 17682 FileConfig(is) 17683 17684 wxFileConfig implements wxConfigBase interface for storing and 17685 retrieving configuration information using plain text files. 17686 """ 17687 17688 def Save(self, os): 17689 """ 17690 Save(os) -> bool 17691 17692 Saves all config data to the given stream, returns true if data was 17693 saved successfully or false on error. 17694 """ 17695 17696 def SetUmask(self, mode): 17697 """ 17698 SetUmask(mode) 17699 17700 Allows setting the mode to be used for the config file creation. 17701 """ 17702 17703 def SetPath(self, strPath): 17704 """ 17705 SetPath(strPath) 17706 17707 Set current path: if the first character is '/', it is the absolute 17708 path, otherwise it is a relative path. 17709 """ 17710 17711 def GetPath(self): 17712 """ 17713 GetPath() -> String 17714 17715 Retrieve the current path (always as absolute path). 17716 """ 17717 17718 def GetNumberOfEntries(self, bRecursive=False): 17719 """ 17720 GetNumberOfEntries(bRecursive=False) -> size_t 17721 17722 Get number of entries in the current group. 17723 """ 17724 17725 def GetNumberOfGroups(self, bRecursive=False): 17726 """ 17727 GetNumberOfGroups(bRecursive=False) -> size_t 17728 17729 Get number of entries/subgroups in the current group, with or without 17730 its subgroups. 17731 """ 17732 17733 def HasGroup(self, strName): 17734 """ 17735 HasGroup(strName) -> bool 17736 """ 17737 17738 def HasEntry(self, strName): 17739 """ 17740 HasEntry(strName) -> bool 17741 """ 17742 17743 def Flush(self, bCurrentOnly=False): 17744 """ 17745 Flush(bCurrentOnly=False) -> bool 17746 17747 Permanently writes all changes (otherwise, they're only written from 17748 object's destructor). 17749 """ 17750 17751 def RenameEntry(self, oldName, newName): 17752 """ 17753 RenameEntry(oldName, newName) -> bool 17754 17755 Renames an entry in the current group. 17756 """ 17757 17758 def RenameGroup(self, oldName, newName): 17759 """ 17760 RenameGroup(oldName, newName) -> bool 17761 17762 Renames a subgroup of the current group. 17763 """ 17764 17765 def DeleteEntry(self, key, bDeleteGroupIfEmpty=True): 17766 """ 17767 DeleteEntry(key, bDeleteGroupIfEmpty=True) -> bool 17768 17769 Deletes the specified entry and the group it belongs to if it was the 17770 last key in it and the second parameter is true. 17771 """ 17772 17773 def DeleteGroup(self, key): 17774 """ 17775 DeleteGroup(key) -> bool 17776 17777 Delete the group (with all subgroups). 17778 """ 17779 17780 def DeleteAll(self): 17781 """ 17782 DeleteAll() -> bool 17783 17784 Delete the whole underlying object (disk file, registry key, ...). 17785 """ 17786 17787 @staticmethod 17788 def GetGlobalFileName(szFile): 17789 """ 17790 GetGlobalFileName(szFile) -> String 17791 """ 17792 17793 @staticmethod 17794 def GetLocalFileName(szFile, style=0): 17795 """ 17796 GetLocalFileName(szFile, style=0) -> String 17797 """ 17798 NumberOfEntries = property(None, None) 17799 NumberOfGroups = property(None, None) 17800 Path = property(None, None) 17801# end of class FileConfig 17802 17803 17804class ConfigPathChanger(object): 17805 """ 17806 ConfigPathChanger(pContainer, strEntry) 17807 17808 A handy little class which changes the current path in a wxConfig 17809 object and restores it in dtor. 17810 """ 17811 17812 def __init__(self, pContainer, strEntry): 17813 """ 17814 ConfigPathChanger(pContainer, strEntry) 17815 17816 A handy little class which changes the current path in a wxConfig 17817 object and restores it in dtor. 17818 """ 17819 17820 def Name(self): 17821 """ 17822 Name() -> String 17823 17824 Returns the name of the key which was passed to the ctor. 17825 """ 17826 17827 def UpdateIfDeleted(self): 17828 """ 17829 UpdateIfDeleted() 17830 17831 This method must be called if the original path inside the wxConfig 17832 object (i.e. 17833 """ 17834 17835 def __enter__(self): 17836 """ 17837 17838 """ 17839 17840 def __exit__(self, exc_type, exc_val, exc_tb): 17841 """ 17842 17843 """ 17844# end of class ConfigPathChanger 17845 17846#-- end-config --# 17847#-- begin-tracker --# 17848 17849class Trackable(object): 17850 """ 17851 Add-on base class for a trackable object. 17852 """ 17853# end of class Trackable 17854 17855#-- end-tracker --# 17856#-- begin-kbdstate --# 17857 17858class KeyboardState(object): 17859 """ 17860 KeyboardState(controlDown=False, shiftDown=False, altDown=False, metaDown=False) 17861 17862 Provides methods for testing the state of the keyboard modifier keys. 17863 """ 17864 17865 def __init__(self, controlDown=False, shiftDown=False, altDown=False, metaDown=False): 17866 """ 17867 KeyboardState(controlDown=False, shiftDown=False, altDown=False, metaDown=False) 17868 17869 Provides methods for testing the state of the keyboard modifier keys. 17870 """ 17871 17872 def GetModifiers(self): 17873 """ 17874 GetModifiers() -> int 17875 17876 Return the bit mask of all pressed modifier keys. 17877 """ 17878 17879 def HasAnyModifiers(self): 17880 """ 17881 HasAnyModifiers() -> bool 17882 17883 Returns true if any modifiers at all are pressed. 17884 """ 17885 17886 def HasModifiers(self): 17887 """ 17888 HasModifiers() -> bool 17889 17890 Returns true if Control or Alt are pressed. 17891 """ 17892 17893 def ControlDown(self): 17894 """ 17895 ControlDown() -> bool 17896 17897 Returns true if the Control key or Apple/Command key under OS X is 17898 pressed. 17899 """ 17900 17901 def RawControlDown(self): 17902 """ 17903 RawControlDown() -> bool 17904 17905 Returns true if the Control key (also under OS X). 17906 """ 17907 17908 def ShiftDown(self): 17909 """ 17910 ShiftDown() -> bool 17911 17912 Returns true if the Shift key is pressed. 17913 """ 17914 17915 def MetaDown(self): 17916 """ 17917 MetaDown() -> bool 17918 17919 Returns true if the Meta/Windows/Apple key is pressed. 17920 """ 17921 17922 def AltDown(self): 17923 """ 17924 AltDown() -> bool 17925 17926 Returns true if the Alt key is pressed. 17927 """ 17928 17929 def CmdDown(self): 17930 """ 17931 CmdDown() -> bool 17932 17933 Returns true if the key used for command accelerators is pressed. 17934 """ 17935 17936 def SetControlDown(self, down): 17937 """ 17938 SetControlDown(down) 17939 """ 17940 17941 def SetRawControlDown(self, down): 17942 """ 17943 SetRawControlDown(down) 17944 """ 17945 17946 def SetShiftDown(self, down): 17947 """ 17948 SetShiftDown(down) 17949 """ 17950 17951 def SetAltDown(self, down): 17952 """ 17953 SetAltDown(down) 17954 """ 17955 17956 def SetMetaDown(self, down): 17957 """ 17958 SetMetaDown(down) 17959 """ 17960 controlDown = property(None, None) 17961 rawControlDown = property(None, None) 17962 shiftDown = property(None, None) 17963 altDown = property(None, None) 17964 metaDown = property(None, None) 17965 cmdDown = property(None, None) 17966 17967 # For 2.8 compatibility 17968 m_controlDown = wx.deprecated(controlDown, "Use controlDown instead.") 17969 m_shiftDown = wx.deprecated(shiftDown, "Use shiftDown instead.") 17970 m_altDown = wx.deprecated(altDown, "Use altDown instead.") 17971 m_metaDown = wx.deprecated(metaDown, "Use metaDown instead.") 17972# end of class KeyboardState 17973 17974#-- end-kbdstate --# 17975#-- begin-mousestate --# 17976MOUSE_BTN_ANY = 0 17977MOUSE_BTN_NONE = 0 17978MOUSE_BTN_LEFT = 0 17979MOUSE_BTN_MIDDLE = 0 17980MOUSE_BTN_RIGHT = 0 17981MOUSE_BTN_AUX1 = 0 17982MOUSE_BTN_AUX2 = 0 17983MOUSE_BTN_MAX = 0 17984 17985class MouseState(KeyboardState): 17986 """ 17987 MouseState() 17988 17989 Represents the mouse state. 17990 """ 17991 17992 def __init__(self): 17993 """ 17994 MouseState() 17995 17996 Represents the mouse state. 17997 """ 17998 17999 def GetPosition(self): 18000 """ 18001 GetPosition() -> Point 18002 18003 Returns the physical mouse position. 18004 """ 18005 18006 def GetX(self): 18007 """ 18008 GetX() -> Coord 18009 18010 Returns X coordinate of the physical mouse event position. 18011 """ 18012 18013 def GetY(self): 18014 """ 18015 GetY() -> Coord 18016 18017 Returns Y coordinate of the physical mouse event position. 18018 """ 18019 18020 def LeftIsDown(self): 18021 """ 18022 LeftIsDown() -> bool 18023 18024 Returns true if the left mouse button is currently down. 18025 """ 18026 18027 def MiddleIsDown(self): 18028 """ 18029 MiddleIsDown() -> bool 18030 18031 Returns true if the middle mouse button is currently down. 18032 """ 18033 18034 def RightIsDown(self): 18035 """ 18036 RightIsDown() -> bool 18037 18038 Returns true if the right mouse button is currently down. 18039 """ 18040 18041 def Aux1IsDown(self): 18042 """ 18043 Aux1IsDown() -> bool 18044 18045 Returns true if the first extra button mouse button is currently down. 18046 """ 18047 18048 def Aux2IsDown(self): 18049 """ 18050 Aux2IsDown() -> bool 18051 18052 Returns true if the second extra button mouse button is currently 18053 down. 18054 """ 18055 18056 def SetX(self, x): 18057 """ 18058 SetX(x) 18059 """ 18060 18061 def SetY(self, y): 18062 """ 18063 SetY(y) 18064 """ 18065 18066 def SetPosition(self, pos): 18067 """ 18068 SetPosition(pos) 18069 """ 18070 18071 def SetLeftDown(self, down): 18072 """ 18073 SetLeftDown(down) 18074 """ 18075 18076 def SetMiddleDown(self, down): 18077 """ 18078 SetMiddleDown(down) 18079 """ 18080 18081 def SetRightDown(self, down): 18082 """ 18083 SetRightDown(down) 18084 """ 18085 18086 def SetAux1Down(self, down): 18087 """ 18088 SetAux1Down(down) 18089 """ 18090 18091 def SetAux2Down(self, down): 18092 """ 18093 SetAux2Down(down) 18094 """ 18095 18096 def SetState(self, state): 18097 """ 18098 SetState(state) 18099 """ 18100 x = property(None, None) 18101 y = property(None, None) 18102 X = property(None, None) 18103 Y = property(None, None) 18104 leftIsDown = property(None, None) 18105 middleIsDown = property(None, None) 18106 rightIsDown = property(None, None) 18107 aux1IsDown = property(None, None) 18108 aux2IsDown = property(None, None) 18109 Position = property(None, None) 18110# end of class MouseState 18111 18112#-- end-mousestate --# 18113#-- begin-tooltip --# 18114 18115class ToolTip(Object): 18116 """ 18117 ToolTip(tip) 18118 18119 This class holds information about a tooltip associated with a window 18120 (see wxWindow::SetToolTip()). 18121 """ 18122 18123 def __init__(self, tip): 18124 """ 18125 ToolTip(tip) 18126 18127 This class holds information about a tooltip associated with a window 18128 (see wxWindow::SetToolTip()). 18129 """ 18130 18131 def GetTip(self): 18132 """ 18133 GetTip() -> String 18134 18135 Get the tooltip text. 18136 """ 18137 18138 def GetWindow(self): 18139 """ 18140 GetWindow() -> Window 18141 18142 Get the associated window. 18143 """ 18144 18145 def SetTip(self, tip): 18146 """ 18147 SetTip(tip) 18148 18149 Set the tooltip text. 18150 """ 18151 18152 @staticmethod 18153 def Enable(flag): 18154 """ 18155 Enable(flag) 18156 18157 Enable or disable tooltips globally. 18158 """ 18159 18160 @staticmethod 18161 def SetAutoPop(msecs): 18162 """ 18163 SetAutoPop(msecs) 18164 18165 Set the delay after which the tooltip disappears or how long a tooltip 18166 remains visible. 18167 """ 18168 18169 @staticmethod 18170 def SetDelay(msecs): 18171 """ 18172 SetDelay(msecs) 18173 18174 Set the delay after which the tooltip appears. 18175 """ 18176 18177 @staticmethod 18178 def SetMaxWidth(width): 18179 """ 18180 SetMaxWidth(width) 18181 18182 Set tooltip maximal width in pixels. 18183 """ 18184 18185 @staticmethod 18186 def SetReshow(msecs): 18187 """ 18188 SetReshow(msecs) 18189 18190 Set the delay between subsequent tooltips to appear. 18191 """ 18192 Tip = property(None, None) 18193 Window = property(None, None) 18194# end of class ToolTip 18195 18196#-- end-tooltip --# 18197#-- begin-layout --# 18198Left = 0 18199Top = 0 18200Right = 0 18201Bottom = 0 18202Width = 0 18203Height = 0 18204Centre = 0 18205Center = 0 18206CentreX = 0 18207CentreY = 0 18208Unconstrained = 0 18209AsIs = 0 18210PercentOf = 0 18211Above = 0 18212Below = 0 18213LeftOf = 0 18214RightOf = 0 18215SameAs = 0 18216Absolute = 0 18217LAYOUT_DEFAULT_MARGIN = 0 18218 18219class IndividualLayoutConstraint(Object): 18220 """ 18221 IndividualLayoutConstraint() 18222 """ 18223 18224 def __init__(self): 18225 """ 18226 IndividualLayoutConstraint() 18227 """ 18228 18229 def Set(self, rel, otherW, otherE, val=0, margin=LAYOUT_DEFAULT_MARGIN): 18230 """ 18231 Set(rel, otherW, otherE, val=0, margin=LAYOUT_DEFAULT_MARGIN) 18232 """ 18233 18234 def LeftOf(self, sibling, margin=LAYOUT_DEFAULT_MARGIN): 18235 """ 18236 LeftOf(sibling, margin=LAYOUT_DEFAULT_MARGIN) 18237 """ 18238 18239 def RightOf(self, sibling, margin=LAYOUT_DEFAULT_MARGIN): 18240 """ 18241 RightOf(sibling, margin=LAYOUT_DEFAULT_MARGIN) 18242 """ 18243 18244 def Above(self, sibling, margin=LAYOUT_DEFAULT_MARGIN): 18245 """ 18246 Above(sibling, margin=LAYOUT_DEFAULT_MARGIN) 18247 """ 18248 18249 def Below(self, sibling, margin=LAYOUT_DEFAULT_MARGIN): 18250 """ 18251 Below(sibling, margin=LAYOUT_DEFAULT_MARGIN) 18252 """ 18253 18254 def SameAs(self, otherW, edge, margin=LAYOUT_DEFAULT_MARGIN): 18255 """ 18256 SameAs(otherW, edge, margin=LAYOUT_DEFAULT_MARGIN) 18257 """ 18258 18259 def PercentOf(self, otherW, wh, per): 18260 """ 18261 PercentOf(otherW, wh, per) 18262 """ 18263 18264 def Absolute(self, val): 18265 """ 18266 Absolute(val) 18267 """ 18268 18269 def Unconstrained(self): 18270 """ 18271 Unconstrained() 18272 """ 18273 18274 def AsIs(self): 18275 """ 18276 AsIs() 18277 """ 18278 18279 def GetOtherWindow(self): 18280 """ 18281 GetOtherWindow() -> Window 18282 """ 18283 18284 def GetMyEdge(self): 18285 """ 18286 GetMyEdge() -> Edge 18287 """ 18288 18289 def SetEdge(self, which): 18290 """ 18291 SetEdge(which) 18292 """ 18293 18294 def SetValue(self, v): 18295 """ 18296 SetValue(v) 18297 """ 18298 18299 def GetMargin(self): 18300 """ 18301 GetMargin() -> int 18302 """ 18303 18304 def SetMargin(self, m): 18305 """ 18306 SetMargin(m) 18307 """ 18308 18309 def GetValue(self): 18310 """ 18311 GetValue() -> int 18312 """ 18313 18314 def GetPercent(self): 18315 """ 18316 GetPercent() -> int 18317 """ 18318 18319 def GetOtherEdge(self): 18320 """ 18321 GetOtherEdge() -> int 18322 """ 18323 18324 def GetDone(self): 18325 """ 18326 GetDone() -> bool 18327 """ 18328 18329 def SetDone(self, d): 18330 """ 18331 SetDone(d) 18332 """ 18333 18334 def GetRelationship(self): 18335 """ 18336 GetRelationship() -> Relationship 18337 """ 18338 18339 def SetRelationship(self, r): 18340 """ 18341 SetRelationship(r) 18342 """ 18343 18344 def ResetIfWin(self, otherW): 18345 """ 18346 ResetIfWin(otherW) -> bool 18347 """ 18348 18349 def SatisfyConstraint(self, constraints, win): 18350 """ 18351 SatisfyConstraint(constraints, win) -> bool 18352 """ 18353 18354 def GetEdge(self, which, thisWin, other): 18355 """ 18356 GetEdge(which, thisWin, other) -> int 18357 """ 18358 Done = property(None, None) 18359 Margin = property(None, None) 18360 MyEdge = property(None, None) 18361 OtherEdge = property(None, None) 18362 OtherWindow = property(None, None) 18363 Percent = property(None, None) 18364 Relationship = property(None, None) 18365 Value = property(None, None) 18366# end of class IndividualLayoutConstraint 18367 18368 18369class LayoutConstraints(Object): 18370 """ 18371 LayoutConstraints() 18372 """ 18373 18374 def __init__(self): 18375 """ 18376 LayoutConstraints() 18377 """ 18378 left = property(None, None) 18379 top = property(None, None) 18380 right = property(None, None) 18381 bottom = property(None, None) 18382 width = property(None, None) 18383 height = property(None, None) 18384 centreX = property(None, None) 18385 centreY = property(None, None) 18386 18387 def SatisfyConstraints(self, win, noChanges): 18388 """ 18389 SatisfyConstraints(win, noChanges) -> bool 18390 """ 18391 18392 def AreSatisfied(self): 18393 """ 18394 AreSatisfied() -> bool 18395 """ 18396# end of class LayoutConstraints 18397 18398#-- end-layout --# 18399#-- begin-event --# 18400EVENT_PROPAGATE_NONE = 0 18401EVENT_PROPAGATE_MAX = 0 18402wxEVT_CATEGORY_UI = 0 18403wxEVT_CATEGORY_USER_INPUT = 0 18404wxEVT_CATEGORY_SOCKET = 0 18405wxEVT_CATEGORY_TIMER = 0 18406wxEVT_CATEGORY_THREAD = 0 18407wxEVT_CATEGORY_ALL = 0 18408WXK_CATEGORY_ARROW = 0 18409WXK_CATEGORY_PAGING = 0 18410WXK_CATEGORY_JUMP = 0 18411WXK_CATEGORY_TAB = 0 18412WXK_CATEGORY_CUT = 0 18413WXK_CATEGORY_NAVIGATION = 0 18414JOYSTICK1 = 0 18415JOYSTICK2 = 0 18416JOY_BUTTON_ANY = 0 18417JOY_BUTTON1 = 0 18418JOY_BUTTON2 = 0 18419JOY_BUTTON3 = 0 18420JOY_BUTTON4 = 0 18421UPDATE_UI_PROCESS_ALL = 0 18422UPDATE_UI_PROCESS_SPECIFIED = 0 18423MOUSE_WHEEL_VERTICAL = 0 18424MOUSE_WHEEL_HORIZONTAL = 0 18425IDLE_PROCESS_ALL = 0 18426IDLE_PROCESS_SPECIFIED = 0 18427wxEVT_NULL = 0 18428wxEVT_ANY = 0 18429wxEVT_BUTTON = 0 18430wxEVT_CHECKBOX = 0 18431wxEVT_CHOICE = 0 18432wxEVT_LISTBOX = 0 18433wxEVT_LISTBOX_DCLICK = 0 18434wxEVT_CHECKLISTBOX = 0 18435wxEVT_MENU = 0 18436wxEVT_SLIDER = 0 18437wxEVT_RADIOBOX = 0 18438wxEVT_RADIOBUTTON = 0 18439wxEVT_SCROLLBAR = 0 18440wxEVT_VLBOX = 0 18441wxEVT_COMBOBOX = 0 18442wxEVT_TOOL_RCLICKED = 0 18443wxEVT_TOOL_DROPDOWN = 0 18444wxEVT_TOOL_ENTER = 0 18445wxEVT_COMBOBOX_DROPDOWN = 0 18446wxEVT_COMBOBOX_CLOSEUP = 0 18447wxEVT_THREAD = 0 18448wxEVT_LEFT_DOWN = 0 18449wxEVT_LEFT_UP = 0 18450wxEVT_MIDDLE_DOWN = 0 18451wxEVT_MIDDLE_UP = 0 18452wxEVT_RIGHT_DOWN = 0 18453wxEVT_RIGHT_UP = 0 18454wxEVT_MOTION = 0 18455wxEVT_ENTER_WINDOW = 0 18456wxEVT_LEAVE_WINDOW = 0 18457wxEVT_LEFT_DCLICK = 0 18458wxEVT_MIDDLE_DCLICK = 0 18459wxEVT_RIGHT_DCLICK = 0 18460wxEVT_SET_FOCUS = 0 18461wxEVT_KILL_FOCUS = 0 18462wxEVT_CHILD_FOCUS = 0 18463wxEVT_MOUSEWHEEL = 0 18464wxEVT_AUX1_DOWN = 0 18465wxEVT_AUX1_UP = 0 18466wxEVT_AUX1_DCLICK = 0 18467wxEVT_AUX2_DOWN = 0 18468wxEVT_AUX2_UP = 0 18469wxEVT_AUX2_DCLICK = 0 18470wxEVT_CHAR = 0 18471wxEVT_CHAR_HOOK = 0 18472wxEVT_NAVIGATION_KEY = 0 18473wxEVT_KEY_DOWN = 0 18474wxEVT_KEY_UP = 0 18475wxEVT_HOTKEY = 0 18476wxEVT_SET_CURSOR = 0 18477wxEVT_SCROLL_TOP = 0 18478wxEVT_SCROLL_BOTTOM = 0 18479wxEVT_SCROLL_LINEUP = 0 18480wxEVT_SCROLL_LINEDOWN = 0 18481wxEVT_SCROLL_PAGEUP = 0 18482wxEVT_SCROLL_PAGEDOWN = 0 18483wxEVT_SCROLL_THUMBTRACK = 0 18484wxEVT_SCROLL_THUMBRELEASE = 0 18485wxEVT_SCROLL_CHANGED = 0 18486wxEVT_SPIN_UP = 0 18487wxEVT_SPIN_DOWN = 0 18488wxEVT_SPIN = 0 18489wxEVT_SCROLLWIN_TOP = 0 18490wxEVT_SCROLLWIN_BOTTOM = 0 18491wxEVT_SCROLLWIN_LINEUP = 0 18492wxEVT_SCROLLWIN_LINEDOWN = 0 18493wxEVT_SCROLLWIN_PAGEUP = 0 18494wxEVT_SCROLLWIN_PAGEDOWN = 0 18495wxEVT_SCROLLWIN_THUMBTRACK = 0 18496wxEVT_SCROLLWIN_THUMBRELEASE = 0 18497wxEVT_SIZE = 0 18498wxEVT_MOVE = 0 18499wxEVT_CLOSE_WINDOW = 0 18500wxEVT_END_SESSION = 0 18501wxEVT_QUERY_END_SESSION = 0 18502wxEVT_ACTIVATE_APP = 0 18503wxEVT_ACTIVATE = 0 18504wxEVT_CREATE = 0 18505wxEVT_DESTROY = 0 18506wxEVT_SHOW = 0 18507wxEVT_ICONIZE = 0 18508wxEVT_MAXIMIZE = 0 18509wxEVT_MOUSE_CAPTURE_CHANGED = 0 18510wxEVT_MOUSE_CAPTURE_LOST = 0 18511wxEVT_PAINT = 0 18512wxEVT_ERASE_BACKGROUND = 0 18513wxEVT_NC_PAINT = 0 18514wxEVT_MENU_OPEN = 0 18515wxEVT_MENU_CLOSE = 0 18516wxEVT_MENU_HIGHLIGHT = 0 18517wxEVT_CONTEXT_MENU = 0 18518wxEVT_SYS_COLOUR_CHANGED = 0 18519wxEVT_DISPLAY_CHANGED = 0 18520wxEVT_QUERY_NEW_PALETTE = 0 18521wxEVT_PALETTE_CHANGED = 0 18522wxEVT_JOY_BUTTON_DOWN = 0 18523wxEVT_JOY_BUTTON_UP = 0 18524wxEVT_JOY_MOVE = 0 18525wxEVT_JOY_ZMOVE = 0 18526wxEVT_DROP_FILES = 0 18527wxEVT_INIT_DIALOG = 0 18528wxEVT_IDLE = 0 18529wxEVT_UPDATE_UI = 0 18530wxEVT_SIZING = 0 18531wxEVT_MOVING = 0 18532wxEVT_MOVE_START = 0 18533wxEVT_MOVE_END = 0 18534wxEVT_HIBERNATE = 0 18535wxEVT_TEXT_COPY = 0 18536wxEVT_TEXT_CUT = 0 18537wxEVT_TEXT_PASTE = 0 18538wxEVT_COMMAND_LEFT_CLICK = 0 18539wxEVT_COMMAND_LEFT_DCLICK = 0 18540wxEVT_COMMAND_RIGHT_CLICK = 0 18541wxEVT_COMMAND_RIGHT_DCLICK = 0 18542wxEVT_COMMAND_SET_FOCUS = 0 18543wxEVT_COMMAND_KILL_FOCUS = 0 18544wxEVT_COMMAND_ENTER = 0 18545wxEVT_HELP = 0 18546wxEVT_DETAILED_HELP = 0 18547wxEVT_TOOL = 0 18548wxEVT_WINDOW_MODAL_DIALOG_CLOSED = 0 18549 18550class EvtHandler(Object, Trackable): 18551 """ 18552 EvtHandler() 18553 18554 A class that can handle events from the windowing system. 18555 """ 18556 18557 def __init__(self): 18558 """ 18559 EvtHandler() 18560 18561 A class that can handle events from the windowing system. 18562 """ 18563 18564 def QueueEvent(self, event): 18565 """ 18566 QueueEvent(event) 18567 18568 Queue event for a later processing. 18569 """ 18570 18571 def AddPendingEvent(self, event): 18572 """ 18573 AddPendingEvent(event) 18574 18575 Post an event to be processed later. 18576 """ 18577 18578 def ProcessEvent(self, event): 18579 """ 18580 ProcessEvent(event) -> bool 18581 18582 Processes an event, searching event tables and calling zero or more 18583 suitable event handler function(s). 18584 """ 18585 18586 def ProcessEventLocally(self, event): 18587 """ 18588 ProcessEventLocally(event) -> bool 18589 18590 Try to process the event in this handler and all those chained to it. 18591 """ 18592 18593 def SafelyProcessEvent(self, event): 18594 """ 18595 SafelyProcessEvent(event) -> bool 18596 18597 Processes an event by calling ProcessEvent() and handles any 18598 exceptions that occur in the process. 18599 """ 18600 18601 def ProcessPendingEvents(self): 18602 """ 18603 ProcessPendingEvents() 18604 18605 Processes the pending events previously queued using QueueEvent() or 18606 AddPendingEvent(); you must call this function only if you are sure 18607 there are pending events for this handler, otherwise a wxCHECK will 18608 fail. 18609 """ 18610 18611 def DeletePendingEvents(self): 18612 """ 18613 DeletePendingEvents() 18614 18615 Deletes all events queued on this event handler using QueueEvent() or 18616 AddPendingEvent(). 18617 """ 18618 18619 def Connect(self, id, lastId, eventType, func): 18620 """ 18621 Connect(id, lastId, eventType, func) 18622 18623 Make an entry in the dynamic event table for an event binding. 18624 """ 18625 18626 def Disconnect(self, id, lastId=-1, eventType=wxEVT_NULL, func=None): 18627 """ 18628 Disconnect(id, lastId=-1, eventType=wxEVT_NULL, func=None) -> bool 18629 18630 Remove an event binding by removing its entry in the dynamic event 18631 table. 18632 """ 18633 18634 def GetEvtHandlerEnabled(self): 18635 """ 18636 GetEvtHandlerEnabled() -> bool 18637 18638 Returns true if the event handler is enabled, false otherwise. 18639 """ 18640 18641 def GetNextHandler(self): 18642 """ 18643 GetNextHandler() -> EvtHandler 18644 18645 Returns the pointer to the next handler in the chain. 18646 """ 18647 18648 def GetPreviousHandler(self): 18649 """ 18650 GetPreviousHandler() -> EvtHandler 18651 18652 Returns the pointer to the previous handler in the chain. 18653 """ 18654 18655 def SetEvtHandlerEnabled(self, enabled): 18656 """ 18657 SetEvtHandlerEnabled(enabled) 18658 18659 Enables or disables the event handler. 18660 """ 18661 18662 def SetNextHandler(self, handler): 18663 """ 18664 SetNextHandler(handler) 18665 18666 Sets the pointer to the next handler. 18667 """ 18668 18669 def SetPreviousHandler(self, handler): 18670 """ 18671 SetPreviousHandler(handler) 18672 18673 Sets the pointer to the previous handler. 18674 """ 18675 18676 def Unlink(self): 18677 """ 18678 Unlink() 18679 18680 Unlinks this event handler from the chain it's part of (if any); then 18681 links the "previous" event handler to the "next" one (so that the 18682 chain won't be interrupted). 18683 """ 18684 18685 def IsUnlinked(self): 18686 """ 18687 IsUnlinked() -> bool 18688 18689 Returns true if the next and the previous handler pointers of this 18690 event handler instance are NULL. 18691 """ 18692 18693 @staticmethod 18694 def AddFilter(filter): 18695 """ 18696 AddFilter(filter) 18697 18698 Add an event filter whose FilterEvent() method will be called for each 18699 and every event processed by wxWidgets. 18700 """ 18701 18702 @staticmethod 18703 def RemoveFilter(filter): 18704 """ 18705 RemoveFilter(filter) 18706 18707 Remove a filter previously installed with AddFilter(). 18708 """ 18709 18710 def Bind(self, event, handler, source=None, id=wx.ID_ANY, id2=wx.ID_ANY): 18711 """ 18712 Bind an event to an event handler. 18713 18714 :param event: One of the ``EVT_*`` event binder objects that 18715 specifies the type of event to bind. 18716 18717 :param handler: A callable object to be invoked when the 18718 event is delivered to self. Pass ``None`` to 18719 disconnect an event handler. 18720 18721 :param source: Sometimes the event originates from a 18722 different window than self, but you still 18723 want to catch it in self. (For example, a 18724 button event delivered to a frame.) By 18725 passing the source of the event, the event 18726 handling system is able to differentiate 18727 between the same event type from different 18728 controls. 18729 18730 :param id: Used to spcify the event source by ID instead 18731 of instance. 18732 18733 :param id2: Used when it is desirable to bind a handler 18734 to a range of IDs, such as with EVT_MENU_RANGE. 18735 """ 18736 18737 def Unbind(self, event, source=None, id=wx.ID_ANY, id2=wx.ID_ANY, handler=None): 18738 """ 18739 Disconnects the event handler binding for event from `self`. 18740 Returns ``True`` if successful. 18741 """ 18742 EvtHandlerEnabled = property(None, None) 18743 NextHandler = property(None, None) 18744 PreviousHandler = property(None, None) 18745 18746 def TryBefore(self, event): 18747 """ 18748 TryBefore(event) -> bool 18749 18750 Method called by ProcessEvent() before examining this object event 18751 tables. 18752 """ 18753 18754 def TryAfter(self, event): 18755 """ 18756 TryAfter(event) -> bool 18757 18758 Method called by ProcessEvent() as last resort. 18759 """ 18760# end of class EvtHandler 18761 18762 18763class EventBlocker(EvtHandler): 18764 """ 18765 EventBlocker(win, type=-1) 18766 18767 This class is a special event handler which allows discarding any 18768 event (or a set of event types) directed to a specific window. 18769 """ 18770 18771 def __init__(self, win, type=-1): 18772 """ 18773 EventBlocker(win, type=-1) 18774 18775 This class is a special event handler which allows discarding any 18776 event (or a set of event types) directed to a specific window. 18777 """ 18778 18779 def Block(self, eventType): 18780 """ 18781 Block(eventType) 18782 18783 Adds to the list of event types which should be blocked the given 18784 eventType. 18785 """ 18786 18787 def __enter__(self): 18788 """ 18789 18790 """ 18791 18792 def __exit__(self, exc_type, exc_val, exc_tb): 18793 """ 18794 18795 """ 18796# end of class EventBlocker 18797 18798 18799class PropagationDisabler(object): 18800 """ 18801 PropagationDisabler(event) 18802 18803 Helper class to temporarily change an event to not propagate. 18804 """ 18805 18806 def __init__(self, event): 18807 """ 18808 PropagationDisabler(event) 18809 18810 Helper class to temporarily change an event to not propagate. 18811 """ 18812 18813 def __enter__(self): 18814 """ 18815 18816 """ 18817 18818 def __exit__(self, exc_type, exc_val, exc_tb): 18819 """ 18820 18821 """ 18822# end of class PropagationDisabler 18823 18824 18825class PropagateOnce(object): 18826 """ 18827 PropagateOnce(event) 18828 18829 Helper class to temporarily lower propagation level. 18830 """ 18831 18832 def __init__(self, event): 18833 """ 18834 PropagateOnce(event) 18835 18836 Helper class to temporarily lower propagation level. 18837 """ 18838 18839 def __enter__(self): 18840 """ 18841 18842 """ 18843 18844 def __exit__(self, exc_type, exc_val, exc_tb): 18845 """ 18846 18847 """ 18848# end of class PropagateOnce 18849 18850 18851class Event(Object): 18852 """ 18853 Event(id=0, eventType=wxEVT_NULL) 18854 18855 An event is a structure holding information about an event passed to a 18856 callback or member function. 18857 """ 18858 18859 def __init__(self, id=0, eventType=wxEVT_NULL): 18860 """ 18861 Event(id=0, eventType=wxEVT_NULL) 18862 18863 An event is a structure holding information about an event passed to a 18864 callback or member function. 18865 """ 18866 18867 def Clone(self): 18868 """ 18869 Clone() -> Event 18870 18871 Returns a copy of the event. 18872 """ 18873 18874 def GetEventObject(self): 18875 """ 18876 GetEventObject() -> Object 18877 18878 Returns the object (usually a window) associated with the event, if 18879 any. 18880 """ 18881 18882 def GetEventType(self): 18883 """ 18884 GetEventType() -> EventType 18885 18886 Returns the identifier of the given event type, such as wxEVT_BUTTON. 18887 """ 18888 18889 def GetEventCategory(self): 18890 """ 18891 GetEventCategory() -> EventCategory 18892 18893 Returns a generic category for this event. 18894 """ 18895 18896 def GetId(self): 18897 """ 18898 GetId() -> int 18899 18900 Returns the identifier associated with this event, such as a button 18901 command id. 18902 """ 18903 18904 def GetEventUserData(self): 18905 """ 18906 GetEventUserData() -> Object 18907 18908 Return the user data associated with a dynamically connected event 18909 handler. 18910 """ 18911 18912 def GetSkipped(self): 18913 """ 18914 GetSkipped() -> bool 18915 18916 Returns true if the event handler should be skipped, false otherwise. 18917 """ 18918 18919 def GetTimestamp(self): 18920 """ 18921 GetTimestamp() -> long 18922 18923 Gets the timestamp for the event. 18924 """ 18925 18926 def IsCommandEvent(self): 18927 """ 18928 IsCommandEvent() -> bool 18929 18930 Returns true if the event is or is derived from wxCommandEvent else it 18931 returns false. 18932 """ 18933 18934 def ResumePropagation(self, propagationLevel): 18935 """ 18936 ResumePropagation(propagationLevel) 18937 18938 Sets the propagation level to the given value (for example returned 18939 from an earlier call to wxEvent::StopPropagation). 18940 """ 18941 18942 def SetEventObject(self, object): 18943 """ 18944 SetEventObject(object) 18945 18946 Sets the originating object. 18947 """ 18948 18949 def SetEventType(self, type): 18950 """ 18951 SetEventType(type) 18952 18953 Sets the event type. 18954 """ 18955 18956 def SetId(self, id): 18957 """ 18958 SetId(id) 18959 18960 Sets the identifier associated with this event, such as a button 18961 command id. 18962 """ 18963 18964 def SetTimestamp(self, timeStamp=0): 18965 """ 18966 SetTimestamp(timeStamp=0) 18967 18968 Sets the timestamp for the event. 18969 """ 18970 18971 def ShouldPropagate(self): 18972 """ 18973 ShouldPropagate() -> bool 18974 18975 Test if this event should be propagated or not, i.e. if the 18976 propagation level is currently greater than 0. 18977 """ 18978 18979 def Skip(self, skip=True): 18980 """ 18981 Skip(skip=True) 18982 18983 This method can be used inside an event handler to control whether 18984 further event handlers bound to this event will be called after the 18985 current one returns. 18986 """ 18987 18988 def StopPropagation(self): 18989 """ 18990 StopPropagation() -> int 18991 18992 Stop the event from propagating to its parent window. 18993 """ 18994 EventObject = property(None, None) 18995 EventType = property(None, None) 18996 Id = property(None, None) 18997 Skipped = property(None, None) 18998 Timestamp = property(None, None) 18999# end of class Event 19000 19001 19002class CommandEvent(Event): 19003 """ 19004 CommandEvent(commandEventType=wxEVT_NULL, id=0) 19005 19006 This event class contains information about command events, which 19007 originate from a variety of simple controls. 19008 """ 19009 19010 def __init__(self, commandEventType=wxEVT_NULL, id=0): 19011 """ 19012 CommandEvent(commandEventType=wxEVT_NULL, id=0) 19013 19014 This event class contains information about command events, which 19015 originate from a variety of simple controls. 19016 """ 19017 19018 def GetClientData(self): 19019 """ 19020 GetClientData() -> ClientData 19021 19022 Returns client object pointer for a listbox or choice selection event 19023 (not valid for a deselection). 19024 """ 19025 19026 def GetExtraLong(self): 19027 """ 19028 GetExtraLong() -> long 19029 19030 Returns extra information dependent on the event objects type. 19031 """ 19032 19033 def GetInt(self): 19034 """ 19035 GetInt() -> int 19036 19037 Returns the integer identifier corresponding to a listbox, choice or 19038 radiobox selection (only if the event was a selection, not a 19039 deselection), or a boolean value representing the value of a checkbox. 19040 """ 19041 19042 def GetSelection(self): 19043 """ 19044 GetSelection() -> int 19045 19046 Returns item index for a listbox or choice selection event (not valid 19047 for a deselection). 19048 """ 19049 19050 def GetString(self): 19051 """ 19052 GetString() -> String 19053 19054 Returns item string for a listbox or choice selection event. 19055 """ 19056 19057 def IsChecked(self): 19058 """ 19059 IsChecked() -> bool 19060 19061 This method can be used with checkbox and menu events: for the 19062 checkboxes, the method returns true for a selection event and false 19063 for a deselection one. 19064 """ 19065 19066 def IsSelection(self): 19067 """ 19068 IsSelection() -> bool 19069 19070 For a listbox or similar event, returns true if it is a selection, 19071 false if it is a deselection. 19072 """ 19073 19074 def SetClientData(self, data): 19075 """ 19076 SetClientData(data) 19077 19078 Sets the client object for this event. 19079 """ 19080 19081 def SetExtraLong(self, extraLong): 19082 """ 19083 SetExtraLong(extraLong) 19084 19085 Sets the m_extraLong member. 19086 """ 19087 19088 def SetInt(self, intCommand): 19089 """ 19090 SetInt(intCommand) 19091 19092 Sets the m_commandInt member. 19093 """ 19094 19095 def SetString(self, string): 19096 """ 19097 SetString(string) 19098 19099 Sets the m_commandString member. 19100 """ 19101 19102 def GetClientObject(self): 19103 """ 19104 Alias for :meth:`GetClientData` 19105 """ 19106 19107 def SetClientObject(self, data): 19108 """ 19109 Alias for :meth:`SetClientData` 19110 """ 19111 ClientData = property(None, None) 19112 ExtraLong = property(None, None) 19113 Int = property(None, None) 19114 Selection = property(None, None) 19115 String = property(None, None) 19116# end of class CommandEvent 19117 19118 19119class ActivateEvent(Event): 19120 """ 19121 ActivateEvent(eventType=wxEVT_NULL, active=True, id=0, ActivationReason=Reason_Unknown) 19122 19123 An activate event is sent when a window or application is being 19124 activated or deactivated. 19125 """ 19126 Reason_Mouse = 0 19127 Reason_Unknown = 0 19128 19129 def __init__(self, eventType=wxEVT_NULL, active=True, id=0, ActivationReason=Reason_Unknown): 19130 """ 19131 ActivateEvent(eventType=wxEVT_NULL, active=True, id=0, ActivationReason=Reason_Unknown) 19132 19133 An activate event is sent when a window or application is being 19134 activated or deactivated. 19135 """ 19136 19137 def GetActive(self): 19138 """ 19139 GetActive() -> bool 19140 19141 Returns true if the application or window is being activated, false 19142 otherwise. 19143 """ 19144 19145 def GetActivationReason(self): 19146 """ 19147 GetActivationReason() -> Reason 19148 19149 Allows checking if the window was activated by clicking it with the 19150 mouse or in some other way. 19151 """ 19152 Active = property(None, None) 19153# end of class ActivateEvent 19154 19155 19156class ChildFocusEvent(CommandEvent): 19157 """ 19158 ChildFocusEvent(win=None) 19159 19160 A child focus event is sent to a (parent-)window when one of its child 19161 windows gains focus, so that the window could restore the focus back 19162 to its corresponding child if it loses it now and regains later. 19163 """ 19164 19165 def __init__(self, win=None): 19166 """ 19167 ChildFocusEvent(win=None) 19168 19169 A child focus event is sent to a (parent-)window when one of its child 19170 windows gains focus, so that the window could restore the focus back 19171 to its corresponding child if it loses it now and regains later. 19172 """ 19173 19174 def GetWindow(self): 19175 """ 19176 GetWindow() -> Window 19177 19178 Returns the direct child which receives the focus, or a (grand-)parent 19179 of the control receiving the focus. 19180 """ 19181 Window = property(None, None) 19182# end of class ChildFocusEvent 19183 19184 19185class ClipboardTextEvent(CommandEvent): 19186 """ 19187 ClipboardTextEvent(commandType=wxEVT_NULL, id=0) 19188 19189 This class represents the events generated by a control (typically a 19190 wxTextCtrl but other windows can generate these events as well) when 19191 its content gets copied or cut to, or pasted from the clipboard. 19192 """ 19193 19194 def __init__(self, commandType=wxEVT_NULL, id=0): 19195 """ 19196 ClipboardTextEvent(commandType=wxEVT_NULL, id=0) 19197 19198 This class represents the events generated by a control (typically a 19199 wxTextCtrl but other windows can generate these events as well) when 19200 its content gets copied or cut to, or pasted from the clipboard. 19201 """ 19202# end of class ClipboardTextEvent 19203 19204 19205class CloseEvent(Event): 19206 """ 19207 CloseEvent(commandEventType=wxEVT_NULL, id=0) 19208 19209 This event class contains information about window and session close 19210 events. 19211 """ 19212 19213 def __init__(self, commandEventType=wxEVT_NULL, id=0): 19214 """ 19215 CloseEvent(commandEventType=wxEVT_NULL, id=0) 19216 19217 This event class contains information about window and session close 19218 events. 19219 """ 19220 19221 def CanVeto(self): 19222 """ 19223 CanVeto() -> bool 19224 19225 Returns true if you can veto a system shutdown or a window close 19226 event. 19227 """ 19228 19229 def GetLoggingOff(self): 19230 """ 19231 GetLoggingOff() -> bool 19232 19233 Returns true if the user is just logging off or false if the system is 19234 shutting down. 19235 """ 19236 19237 def SetCanVeto(self, canVeto): 19238 """ 19239 SetCanVeto(canVeto) 19240 19241 Sets the 'can veto' flag. 19242 """ 19243 19244 def SetLoggingOff(self, loggingOff): 19245 """ 19246 SetLoggingOff(loggingOff) 19247 19248 Sets the 'logging off' flag. 19249 """ 19250 19251 def Veto(self, veto=True): 19252 """ 19253 Veto(veto=True) 19254 19255 Call this from your event handler to veto a system shutdown or to 19256 signal to the calling application that a window close did not happen. 19257 """ 19258 19259 def GetVeto(self): 19260 """ 19261 GetVeto() -> bool 19262 19263 Returns whether the Veto flag was set. 19264 """ 19265 LoggingOff = property(None, None) 19266# end of class CloseEvent 19267 19268 19269class ContextMenuEvent(CommandEvent): 19270 """ 19271 ContextMenuEvent(type=wxEVT_NULL, id=0, pos=DefaultPosition) 19272 19273 This class is used for context menu events, sent to give the 19274 application a chance to show a context (popup) menu for a wxWindow. 19275 """ 19276 19277 def __init__(self, type=wxEVT_NULL, id=0, pos=DefaultPosition): 19278 """ 19279 ContextMenuEvent(type=wxEVT_NULL, id=0, pos=DefaultPosition) 19280 19281 This class is used for context menu events, sent to give the 19282 application a chance to show a context (popup) menu for a wxWindow. 19283 """ 19284 19285 def GetPosition(self): 19286 """ 19287 GetPosition() -> Point 19288 19289 Returns the position in screen coordinates at which the menu should be 19290 shown. 19291 """ 19292 19293 def SetPosition(self, point): 19294 """ 19295 SetPosition(point) 19296 19297 Sets the position at which the menu should be shown. 19298 """ 19299 Position = property(None, None) 19300# end of class ContextMenuEvent 19301 19302 19303class DisplayChangedEvent(Event): 19304 """ 19305 DisplayChangedEvent() 19306 """ 19307 19308 def __init__(self): 19309 """ 19310 DisplayChangedEvent() 19311 """ 19312# end of class DisplayChangedEvent 19313 19314 19315class DropFilesEvent(Event): 19316 """ 19317 DropFilesEvent(id=0, files=None) 19318 19319 This class is used for drop files events, that is, when files have 19320 been dropped onto the window. 19321 """ 19322 19323 def __init__(self, id=0, files=None): 19324 """ 19325 DropFilesEvent(id=0, files=None) 19326 19327 This class is used for drop files events, that is, when files have 19328 been dropped onto the window. 19329 """ 19330 19331 def GetFiles(self): 19332 """ 19333 GetFiles() -> PyObject 19334 19335 Returns an array of filenames. 19336 """ 19337 19338 def GetNumberOfFiles(self): 19339 """ 19340 GetNumberOfFiles() -> int 19341 19342 Returns the number of files dropped. 19343 """ 19344 19345 def GetPosition(self): 19346 """ 19347 GetPosition() -> Point 19348 19349 Returns the position at which the files were dropped. 19350 """ 19351 Files = property(None, None) 19352 NumberOfFiles = property(None, None) 19353 Position = property(None, None) 19354# end of class DropFilesEvent 19355 19356 19357class EraseEvent(Event): 19358 """ 19359 EraseEvent(id=0, dc=None) 19360 19361 An erase event is sent when a window's background needs to be 19362 repainted. 19363 """ 19364 19365 def __init__(self, id=0, dc=None): 19366 """ 19367 EraseEvent(id=0, dc=None) 19368 19369 An erase event is sent when a window's background needs to be 19370 repainted. 19371 """ 19372 19373 def GetDC(self): 19374 """ 19375 GetDC() -> DC 19376 19377 Returns the device context associated with the erase event to draw on. 19378 """ 19379 DC = property(None, None) 19380# end of class EraseEvent 19381 19382 19383class FocusEvent(Event): 19384 """ 19385 FocusEvent(eventType=wxEVT_NULL, id=0) 19386 19387 A focus event is sent when a window's focus changes. 19388 """ 19389 19390 def __init__(self, eventType=wxEVT_NULL, id=0): 19391 """ 19392 FocusEvent(eventType=wxEVT_NULL, id=0) 19393 19394 A focus event is sent when a window's focus changes. 19395 """ 19396 19397 def GetWindow(self): 19398 """ 19399 GetWindow() -> Window 19400 19401 Returns the window associated with this event, that is the window 19402 which had the focus before for the wxEVT_SET_FOCUS event and the 19403 window which is going to receive focus for the wxEVT_KILL_FOCUS one. 19404 """ 19405 19406 def SetWindow(self, win): 19407 """ 19408 SetWindow(win) 19409 """ 19410 Window = property(None, None) 19411# end of class FocusEvent 19412 19413 19414class HelpEvent(CommandEvent): 19415 """ 19416 HelpEvent(type=wxEVT_NULL, winid=0, pt=DefaultPosition, origin=Origin_Unknown) 19417 19418 A help event is sent when the user has requested context-sensitive 19419 help. 19420 """ 19421 Origin_Unknown = 0 19422 Origin_Keyboard = 0 19423 Origin_HelpButton = 0 19424 19425 def __init__(self, type=wxEVT_NULL, winid=0, pt=DefaultPosition, origin=Origin_Unknown): 19426 """ 19427 HelpEvent(type=wxEVT_NULL, winid=0, pt=DefaultPosition, origin=Origin_Unknown) 19428 19429 A help event is sent when the user has requested context-sensitive 19430 help. 19431 """ 19432 19433 def GetOrigin(self): 19434 """ 19435 GetOrigin() -> HelpEvent.Origin 19436 19437 Returns the origin of the help event which is one of the 19438 wxHelpEvent::Origin values. 19439 """ 19440 19441 def GetPosition(self): 19442 """ 19443 GetPosition() -> Point 19444 19445 Returns the left-click position of the mouse, in screen coordinates. 19446 """ 19447 19448 def SetOrigin(self, origin): 19449 """ 19450 SetOrigin(origin) 19451 19452 Set the help event origin, only used internally by wxWidgets normally. 19453 """ 19454 19455 def SetPosition(self, pt): 19456 """ 19457 SetPosition(pt) 19458 19459 Sets the left-click position of the mouse, in screen coordinates. 19460 """ 19461 Position = property(None, None) 19462# end of class HelpEvent 19463 19464 19465class IconizeEvent(Event): 19466 """ 19467 IconizeEvent(id=0, iconized=True) 19468 19469 An event being sent when the frame is iconized (minimized) or 19470 restored. 19471 """ 19472 19473 def __init__(self, id=0, iconized=True): 19474 """ 19475 IconizeEvent(id=0, iconized=True) 19476 19477 An event being sent when the frame is iconized (minimized) or 19478 restored. 19479 """ 19480 19481 def IsIconized(self): 19482 """ 19483 IsIconized() -> bool 19484 19485 Returns true if the frame has been iconized, false if it has been 19486 restored. 19487 """ 19488 19489 def Iconized(self): 19490 """ 19491 Iconized() -> bool 19492 """ 19493# end of class IconizeEvent 19494 19495 19496class IdleEvent(Event): 19497 """ 19498 IdleEvent() 19499 19500 This class is used for idle events, which are generated when the 19501 system becomes idle. 19502 """ 19503 19504 def __init__(self): 19505 """ 19506 IdleEvent() 19507 19508 This class is used for idle events, which are generated when the 19509 system becomes idle. 19510 """ 19511 19512 def MoreRequested(self): 19513 """ 19514 MoreRequested() -> bool 19515 19516 Returns true if the OnIdle function processing this event requested 19517 more processing time. 19518 """ 19519 19520 def RequestMore(self, needMore=True): 19521 """ 19522 RequestMore(needMore=True) 19523 19524 Tells wxWidgets that more processing is required. 19525 """ 19526 19527 @staticmethod 19528 def GetMode(): 19529 """ 19530 GetMode() -> IdleMode 19531 19532 Static function returning a value specifying how wxWidgets will send 19533 idle events: to all windows, or only to those which specify that they 19534 will process the events. 19535 """ 19536 19537 @staticmethod 19538 def SetMode(mode): 19539 """ 19540 SetMode(mode) 19541 19542 Static function for specifying how wxWidgets will send idle events: to 19543 all windows, or only to those which specify that they will process the 19544 events. 19545 """ 19546# end of class IdleEvent 19547 19548 19549class InitDialogEvent(Event): 19550 """ 19551 InitDialogEvent(id=0) 19552 19553 A wxInitDialogEvent is sent as a dialog or panel is being initialised. 19554 """ 19555 19556 def __init__(self, id=0): 19557 """ 19558 InitDialogEvent(id=0) 19559 19560 A wxInitDialogEvent is sent as a dialog or panel is being initialised. 19561 """ 19562# end of class InitDialogEvent 19563 19564 19565class JoystickEvent(Event): 19566 """ 19567 JoystickEvent(eventType=wxEVT_NULL, state=0, joystick=JOYSTICK1, change=0) 19568 19569 This event class contains information about joystick events, 19570 particularly events received by windows. 19571 """ 19572 19573 def __init__(self, eventType=wxEVT_NULL, state=0, joystick=JOYSTICK1, change=0): 19574 """ 19575 JoystickEvent(eventType=wxEVT_NULL, state=0, joystick=JOYSTICK1, change=0) 19576 19577 This event class contains information about joystick events, 19578 particularly events received by windows. 19579 """ 19580 19581 def ButtonDown(self, button=JOY_BUTTON_ANY): 19582 """ 19583 ButtonDown(button=JOY_BUTTON_ANY) -> bool 19584 19585 Returns true if the event was a down event from the specified button 19586 (or any button). 19587 """ 19588 19589 def ButtonIsDown(self, button=JOY_BUTTON_ANY): 19590 """ 19591 ButtonIsDown(button=JOY_BUTTON_ANY) -> bool 19592 19593 Returns true if the specified button (or any button) was in a down 19594 state. 19595 """ 19596 19597 def ButtonUp(self, button=JOY_BUTTON_ANY): 19598 """ 19599 ButtonUp(button=JOY_BUTTON_ANY) -> bool 19600 19601 Returns true if the event was an up event from the specified button 19602 (or any button). 19603 """ 19604 19605 def GetButtonChange(self): 19606 """ 19607 GetButtonChange() -> int 19608 19609 Returns the identifier of the button changing state. 19610 """ 19611 19612 def GetButtonState(self): 19613 """ 19614 GetButtonState() -> int 19615 19616 Returns the down state of the buttons. 19617 """ 19618 19619 def GetJoystick(self): 19620 """ 19621 GetJoystick() -> int 19622 19623 Returns the identifier of the joystick generating the event - one of 19624 wxJOYSTICK1 and wxJOYSTICK2. 19625 """ 19626 19627 def GetPosition(self): 19628 """ 19629 GetPosition() -> Point 19630 19631 Returns the x, y position of the joystick event. 19632 """ 19633 19634 def GetZPosition(self): 19635 """ 19636 GetZPosition() -> int 19637 19638 Returns the z position of the joystick event. 19639 """ 19640 19641 def IsButton(self): 19642 """ 19643 IsButton() -> bool 19644 19645 Returns true if this was a button up or down event (not 'is any button 19646 down?'). 19647 """ 19648 19649 def IsMove(self): 19650 """ 19651 IsMove() -> bool 19652 19653 Returns true if this was an x, y move event. 19654 """ 19655 19656 def IsZMove(self): 19657 """ 19658 IsZMove() -> bool 19659 19660 Returns true if this was a z move event. 19661 """ 19662 ButtonChange = property(None, None) 19663 ButtonState = property(None, None) 19664 Joystick = property(None, None) 19665 Position = property(None, None) 19666 ZPosition = property(None, None) 19667# end of class JoystickEvent 19668 19669 19670class KeyEvent(Event, KeyboardState): 19671 """ 19672 KeyEvent(keyEventType=wxEVT_NULL) 19673 19674 This event class contains information about key press and release 19675 events. 19676 """ 19677 19678 def __init__(self, keyEventType=wxEVT_NULL): 19679 """ 19680 KeyEvent(keyEventType=wxEVT_NULL) 19681 19682 This event class contains information about key press and release 19683 events. 19684 """ 19685 19686 def GetPosition(self): 19687 """ 19688 GetPosition() -> Point 19689 19690 Obtains the position (in client coordinates) at which the key was 19691 pressed. 19692 """ 19693 19694 def GetKeyCode(self): 19695 """ 19696 GetKeyCode() -> int 19697 19698 Returns the key code of the key that generated this event. 19699 """ 19700 19701 def IsKeyInCategory(self, category): 19702 """ 19703 IsKeyInCategory(category) -> bool 19704 19705 Returns true if the key is in the given key category. 19706 """ 19707 19708 def GetRawKeyCode(self): 19709 """ 19710 GetRawKeyCode() -> Uint32 19711 19712 Returns the raw key code for this event. 19713 """ 19714 19715 def GetRawKeyFlags(self): 19716 """ 19717 GetRawKeyFlags() -> Uint32 19718 19719 Returns the low level key flags for this event. 19720 """ 19721 19722 def GetUnicodeKey(self): 19723 """ 19724 GetUnicodeKey() -> int 19725 19726 Returns the Unicode character corresponding to this key event. 19727 """ 19728 19729 def GetX(self): 19730 """ 19731 GetX() -> Coord 19732 19733 Returns the X position (in client coordinates) of the event. 19734 """ 19735 19736 def GetY(self): 19737 """ 19738 GetY() -> Coord 19739 19740 Returns the Y position (in client coordinates) of the event. 19741 """ 19742 19743 def DoAllowNextEvent(self): 19744 """ 19745 DoAllowNextEvent() 19746 19747 Allow normal key events generation. 19748 """ 19749 19750 def IsNextEventAllowed(self): 19751 """ 19752 IsNextEventAllowed() -> bool 19753 19754 Returns true if DoAllowNextEvent() had been called, false by default. 19755 """ 19756 X = property(None, None) 19757 Y = property(None, None) 19758 KeyCode = property(None, None) 19759 Position = property(None, None) 19760 RawKeyCode = property(None, None) 19761 RawKeyFlags = property(None, None) 19762 UnicodeKey = property(None, None) 19763# end of class KeyEvent 19764 19765 19766class MaximizeEvent(Event): 19767 """ 19768 MaximizeEvent(id=0) 19769 19770 An event being sent when a top level window is maximized. 19771 """ 19772 19773 def __init__(self, id=0): 19774 """ 19775 MaximizeEvent(id=0) 19776 19777 An event being sent when a top level window is maximized. 19778 """ 19779# end of class MaximizeEvent 19780 19781 19782class MenuEvent(Event): 19783 """ 19784 MenuEvent(type=wxEVT_NULL, id=0, menu=None) 19785 19786 This class is used for a variety of menu-related events. 19787 """ 19788 19789 def __init__(self, type=wxEVT_NULL, id=0, menu=None): 19790 """ 19791 MenuEvent(type=wxEVT_NULL, id=0, menu=None) 19792 19793 This class is used for a variety of menu-related events. 19794 """ 19795 19796 def GetMenu(self): 19797 """ 19798 GetMenu() -> Menu 19799 19800 Returns the menu which is being opened or closed. 19801 """ 19802 19803 def GetMenuId(self): 19804 """ 19805 GetMenuId() -> int 19806 19807 Returns the menu identifier associated with the event. 19808 """ 19809 19810 def IsPopup(self): 19811 """ 19812 IsPopup() -> bool 19813 19814 Returns true if the menu which is being opened or closed is a popup 19815 menu, false if it is a normal one. 19816 """ 19817 Menu = property(None, None) 19818 MenuId = property(None, None) 19819# end of class MenuEvent 19820 19821 19822class MouseCaptureChangedEvent(Event): 19823 """ 19824 MouseCaptureChangedEvent(windowId=0, gainedCapture=None) 19825 19826 An mouse capture changed event is sent to a window that loses its 19827 mouse capture. 19828 """ 19829 19830 def __init__(self, windowId=0, gainedCapture=None): 19831 """ 19832 MouseCaptureChangedEvent(windowId=0, gainedCapture=None) 19833 19834 An mouse capture changed event is sent to a window that loses its 19835 mouse capture. 19836 """ 19837 19838 def GetCapturedWindow(self): 19839 """ 19840 GetCapturedWindow() -> Window 19841 19842 Returns the window that gained the capture, or NULL if it was a non- 19843 wxWidgets window. 19844 """ 19845 CapturedWindow = property(None, None) 19846# end of class MouseCaptureChangedEvent 19847 19848 19849class MouseCaptureLostEvent(Event): 19850 """ 19851 MouseCaptureLostEvent(windowId=0) 19852 19853 A mouse capture lost event is sent to a window that had obtained mouse 19854 capture, which was subsequently lost due to an "external" event (for 19855 example, when a dialog box is shown or if another application captures 19856 the mouse). 19857 """ 19858 19859 def __init__(self, windowId=0): 19860 """ 19861 MouseCaptureLostEvent(windowId=0) 19862 19863 A mouse capture lost event is sent to a window that had obtained mouse 19864 capture, which was subsequently lost due to an "external" event (for 19865 example, when a dialog box is shown or if another application captures 19866 the mouse). 19867 """ 19868# end of class MouseCaptureLostEvent 19869 19870 19871class MouseEvent(Event, MouseState): 19872 """ 19873 MouseEvent(mouseEventType=wxEVT_NULL) 19874 19875 This event class contains information about the events generated by 19876 the mouse: they include mouse buttons press and release events and 19877 mouse move events. 19878 """ 19879 19880 def __init__(self, mouseEventType=wxEVT_NULL): 19881 """ 19882 MouseEvent(mouseEventType=wxEVT_NULL) 19883 19884 This event class contains information about the events generated by 19885 the mouse: they include mouse buttons press and release events and 19886 mouse move events. 19887 """ 19888 19889 def Aux1DClick(self): 19890 """ 19891 Aux1DClick() -> bool 19892 19893 Returns true if the event was a first extra button double click. 19894 """ 19895 19896 def Aux1Down(self): 19897 """ 19898 Aux1Down() -> bool 19899 19900 Returns true if the first extra button mouse button changed to down. 19901 """ 19902 19903 def Aux1Up(self): 19904 """ 19905 Aux1Up() -> bool 19906 19907 Returns true if the first extra button mouse button changed to up. 19908 """ 19909 19910 def Aux2DClick(self): 19911 """ 19912 Aux2DClick() -> bool 19913 19914 Returns true if the event was a second extra button double click. 19915 """ 19916 19917 def Aux2Down(self): 19918 """ 19919 Aux2Down() -> bool 19920 19921 Returns true if the second extra button mouse button changed to down. 19922 """ 19923 19924 def Aux2Up(self): 19925 """ 19926 Aux2Up() -> bool 19927 19928 Returns true if the second extra button mouse button changed to up. 19929 """ 19930 19931 def Button(self, but): 19932 """ 19933 Button(but) -> bool 19934 19935 Returns true if the event was generated by the specified button. 19936 """ 19937 19938 def ButtonDClick(self, but=MOUSE_BTN_ANY): 19939 """ 19940 ButtonDClick(but=MOUSE_BTN_ANY) -> bool 19941 19942 If the argument is omitted, this returns true if the event was a mouse 19943 double click event. 19944 """ 19945 19946 def ButtonDown(self, but=MOUSE_BTN_ANY): 19947 """ 19948 ButtonDown(but=MOUSE_BTN_ANY) -> bool 19949 19950 If the argument is omitted, this returns true if the event was a mouse 19951 button down event. 19952 """ 19953 19954 def ButtonUp(self, but=MOUSE_BTN_ANY): 19955 """ 19956 ButtonUp(but=MOUSE_BTN_ANY) -> bool 19957 19958 If the argument is omitted, this returns true if the event was a mouse 19959 button up event. 19960 """ 19961 19962 def Dragging(self): 19963 """ 19964 Dragging() -> bool 19965 19966 Returns true if this was a dragging event (motion while a button is 19967 depressed). 19968 """ 19969 19970 def Entering(self): 19971 """ 19972 Entering() -> bool 19973 19974 Returns true if the mouse was entering the window. 19975 """ 19976 19977 def GetButton(self): 19978 """ 19979 GetButton() -> int 19980 19981 Returns the mouse button which generated this event or 19982 wxMOUSE_BTN_NONE if no button is involved (for mouse move, enter or 19983 leave event, for example). 19984 """ 19985 19986 def GetClickCount(self): 19987 """ 19988 GetClickCount() -> int 19989 19990 Returns the number of mouse clicks for this event: 1 for a simple 19991 click, 2 for a double-click, 3 for a triple-click and so on. 19992 """ 19993 19994 def GetLinesPerAction(self): 19995 """ 19996 GetLinesPerAction() -> int 19997 19998 Returns the configured number of lines (or whatever) to be scrolled 19999 per wheel action. 20000 """ 20001 20002 def GetColumnsPerAction(self): 20003 """ 20004 GetColumnsPerAction() -> int 20005 20006 Returns the configured number of columns (or whatever) to be scrolled 20007 per wheel action. 20008 """ 20009 20010 def GetLogicalPosition(self, dc): 20011 """ 20012 GetLogicalPosition(dc) -> Point 20013 20014 Returns the logical mouse position in pixels (i.e. translated 20015 according to the translation set for the DC, which usually indicates 20016 that the window has been scrolled). 20017 """ 20018 20019 def GetWheelDelta(self): 20020 """ 20021 GetWheelDelta() -> int 20022 20023 Get wheel delta, normally 120. 20024 """ 20025 20026 def GetWheelRotation(self): 20027 """ 20028 GetWheelRotation() -> int 20029 20030 Get wheel rotation, positive or negative indicates direction of 20031 rotation. 20032 """ 20033 20034 def GetWheelAxis(self): 20035 """ 20036 GetWheelAxis() -> MouseWheelAxis 20037 20038 Gets the axis the wheel operation concerns. 20039 """ 20040 20041 def IsButton(self): 20042 """ 20043 IsButton() -> bool 20044 20045 Returns true if the event was a mouse button event (not necessarily a 20046 button down event - that may be tested using ButtonDown()). 20047 """ 20048 20049 def IsPageScroll(self): 20050 """ 20051 IsPageScroll() -> bool 20052 20053 Returns true if the system has been setup to do page scrolling with 20054 the mouse wheel instead of line scrolling. 20055 """ 20056 20057 def Leaving(self): 20058 """ 20059 Leaving() -> bool 20060 20061 Returns true if the mouse was leaving the window. 20062 """ 20063 20064 def LeftDClick(self): 20065 """ 20066 LeftDClick() -> bool 20067 20068 Returns true if the event was a left double click. 20069 """ 20070 20071 def LeftDown(self): 20072 """ 20073 LeftDown() -> bool 20074 20075 Returns true if the left mouse button changed to down. 20076 """ 20077 20078 def LeftUp(self): 20079 """ 20080 LeftUp() -> bool 20081 20082 Returns true if the left mouse button changed to up. 20083 """ 20084 20085 def MetaDown(self): 20086 """ 20087 MetaDown() -> bool 20088 20089 Returns true if the Meta key was down at the time of the event. 20090 """ 20091 20092 def MiddleDClick(self): 20093 """ 20094 MiddleDClick() -> bool 20095 20096 Returns true if the event was a middle double click. 20097 """ 20098 20099 def MiddleDown(self): 20100 """ 20101 MiddleDown() -> bool 20102 20103 Returns true if the middle mouse button changed to down. 20104 """ 20105 20106 def MiddleUp(self): 20107 """ 20108 MiddleUp() -> bool 20109 20110 Returns true if the middle mouse button changed to up. 20111 """ 20112 20113 def Moving(self): 20114 """ 20115 Moving() -> bool 20116 20117 Returns true if this was a motion event and no mouse buttons were 20118 pressed. 20119 """ 20120 20121 def RightDClick(self): 20122 """ 20123 RightDClick() -> bool 20124 20125 Returns true if the event was a right double click. 20126 """ 20127 20128 def RightDown(self): 20129 """ 20130 RightDown() -> bool 20131 20132 Returns true if the right mouse button changed to down. 20133 """ 20134 20135 def RightUp(self): 20136 """ 20137 RightUp() -> bool 20138 20139 Returns true if the right mouse button changed to up. 20140 """ 20141 20142 def SetWheelAxis(self, wheelAxis): 20143 """ 20144 SetWheelAxis(wheelAxis) 20145 """ 20146 20147 def SetWheelRotation(self, wheelRotation): 20148 """ 20149 SetWheelRotation(wheelRotation) 20150 """ 20151 20152 def SetWheelDelta(self, wheelDelta): 20153 """ 20154 SetWheelDelta(wheelDelta) 20155 """ 20156 20157 def SetLinesPerAction(self, linesPerAction): 20158 """ 20159 SetLinesPerAction(linesPerAction) 20160 """ 20161 20162 def SetColumnsPerAction(self, columnsPerAction): 20163 """ 20164 SetColumnsPerAction(columnsPerAction) 20165 """ 20166 WheelAxis = property(None, None) 20167 WheelRotation = property(None, None) 20168 WheelDelta = property(None, None) 20169 LinesPerAction = property(None, None) 20170 ColumnsPerAction = property(None, None) 20171# end of class MouseEvent 20172 20173 20174class MoveEvent(Event): 20175 """ 20176 MoveEvent(pt, id=0) 20177 20178 A move event holds information about wxTopLevelWindow move change 20179 events. 20180 """ 20181 20182 def __init__(self, pt, id=0): 20183 """ 20184 MoveEvent(pt, id=0) 20185 20186 A move event holds information about wxTopLevelWindow move change 20187 events. 20188 """ 20189 20190 def GetPosition(self): 20191 """ 20192 GetPosition() -> Point 20193 20194 Returns the position of the window generating the move change event. 20195 """ 20196 20197 def GetRect(self): 20198 """ 20199 GetRect() -> Rect 20200 """ 20201 20202 def SetRect(self, rect): 20203 """ 20204 SetRect(rect) 20205 """ 20206 20207 def SetPosition(self, pos): 20208 """ 20209 SetPosition(pos) 20210 """ 20211 Rect = property(None, None) 20212 Position = property(None, None) 20213# end of class MoveEvent 20214 20215 20216class NavigationKeyEvent(Event): 20217 """ 20218 NavigationKeyEvent() 20219 NavigationKeyEvent(event) 20220 20221 This event class contains information about navigation events, 20222 generated by navigation keys such as tab and page down. 20223 """ 20224 IsBackward = 0 20225 IsForward = 0 20226 WinChange = 0 20227 FromTab = 0 20228 20229 def __init__(self, *args, **kw): 20230 """ 20231 NavigationKeyEvent() 20232 NavigationKeyEvent(event) 20233 20234 This event class contains information about navigation events, 20235 generated by navigation keys such as tab and page down. 20236 """ 20237 20238 def GetCurrentFocus(self): 20239 """ 20240 GetCurrentFocus() -> Window 20241 20242 Returns the child that has the focus, or NULL. 20243 """ 20244 20245 def GetDirection(self): 20246 """ 20247 GetDirection() -> bool 20248 20249 Returns true if the navigation was in the forward direction. 20250 """ 20251 20252 def IsFromTab(self): 20253 """ 20254 IsFromTab() -> bool 20255 20256 Returns true if the navigation event was from a tab key. 20257 """ 20258 20259 def IsWindowChange(self): 20260 """ 20261 IsWindowChange() -> bool 20262 20263 Returns true if the navigation event represents a window change (for 20264 example, from Ctrl-Page Down in a notebook). 20265 """ 20266 20267 def SetCurrentFocus(self, currentFocus): 20268 """ 20269 SetCurrentFocus(currentFocus) 20270 20271 Sets the current focus window member. 20272 """ 20273 20274 def SetDirection(self, direction): 20275 """ 20276 SetDirection(direction) 20277 20278 Sets the direction to forward if direction is true, or backward if 20279 false. 20280 """ 20281 20282 def SetFlags(self, flags): 20283 """ 20284 SetFlags(flags) 20285 20286 Sets the flags for this event. 20287 """ 20288 20289 def SetFromTab(self, fromTab): 20290 """ 20291 SetFromTab(fromTab) 20292 20293 Marks the navigation event as from a tab key. 20294 """ 20295 20296 def SetWindowChange(self, windowChange): 20297 """ 20298 SetWindowChange(windowChange) 20299 20300 Marks the event as a window change event. 20301 """ 20302 CurrentFocus = property(None, None) 20303 Direction = property(None, None) 20304# end of class NavigationKeyEvent 20305 20306 20307class NotifyEvent(CommandEvent): 20308 """ 20309 NotifyEvent(eventType=wxEVT_NULL, id=0) 20310 20311 This class is not used by the event handlers by itself, but is a base 20312 class for other event classes (such as wxBookCtrlEvent). 20313 """ 20314 20315 def __init__(self, eventType=wxEVT_NULL, id=0): 20316 """ 20317 NotifyEvent(eventType=wxEVT_NULL, id=0) 20318 20319 This class is not used by the event handlers by itself, but is a base 20320 class for other event classes (such as wxBookCtrlEvent). 20321 """ 20322 20323 def Allow(self): 20324 """ 20325 Allow() 20326 20327 This is the opposite of Veto(): it explicitly allows the event to be 20328 processed. 20329 """ 20330 20331 def IsAllowed(self): 20332 """ 20333 IsAllowed() -> bool 20334 20335 Returns true if the change is allowed (Veto() hasn't been called) or 20336 false otherwise (if it was). 20337 """ 20338 20339 def Veto(self): 20340 """ 20341 Veto() 20342 20343 Prevents the change announced by this event from happening. 20344 """ 20345# end of class NotifyEvent 20346 20347 20348class PaintEvent(Event): 20349 """ 20350 PaintEvent(id=0) 20351 20352 A paint event is sent when a window's contents needs to be repainted. 20353 """ 20354 20355 def __init__(self, id=0): 20356 """ 20357 PaintEvent(id=0) 20358 20359 A paint event is sent when a window's contents needs to be repainted. 20360 """ 20361# end of class PaintEvent 20362 20363 20364class PaletteChangedEvent(Event): 20365 """ 20366 PaletteChangedEvent(winid=0) 20367 """ 20368 20369 def __init__(self, winid=0): 20370 """ 20371 PaletteChangedEvent(winid=0) 20372 """ 20373 20374 def SetChangedWindow(self, win): 20375 """ 20376 SetChangedWindow(win) 20377 """ 20378 20379 def GetChangedWindow(self): 20380 """ 20381 GetChangedWindow() -> Window 20382 """ 20383 ChangedWindow = property(None, None) 20384# end of class PaletteChangedEvent 20385 20386 20387class QueryNewPaletteEvent(Event): 20388 """ 20389 QueryNewPaletteEvent(winid=0) 20390 """ 20391 20392 def __init__(self, winid=0): 20393 """ 20394 QueryNewPaletteEvent(winid=0) 20395 """ 20396 20397 def SetPaletteRealized(self, realized): 20398 """ 20399 SetPaletteRealized(realized) 20400 """ 20401 20402 def GetPaletteRealized(self): 20403 """ 20404 GetPaletteRealized() -> bool 20405 """ 20406 PaletteRealized = property(None, None) 20407# end of class QueryNewPaletteEvent 20408 20409 20410class ScrollEvent(CommandEvent): 20411 """ 20412 ScrollEvent(commandType=wxEVT_NULL, id=0, pos=0, orientation=0) 20413 20414 A scroll event holds information about events sent from stand-alone 20415 scrollbars (see wxScrollBar) and sliders (see wxSlider). 20416 """ 20417 20418 def __init__(self, commandType=wxEVT_NULL, id=0, pos=0, orientation=0): 20419 """ 20420 ScrollEvent(commandType=wxEVT_NULL, id=0, pos=0, orientation=0) 20421 20422 A scroll event holds information about events sent from stand-alone 20423 scrollbars (see wxScrollBar) and sliders (see wxSlider). 20424 """ 20425 20426 def GetOrientation(self): 20427 """ 20428 GetOrientation() -> int 20429 20430 Returns wxHORIZONTAL or wxVERTICAL, depending on the orientation of 20431 the scrollbar. 20432 """ 20433 20434 def GetPosition(self): 20435 """ 20436 GetPosition() -> int 20437 20438 Returns the position of the scrollbar. 20439 """ 20440 20441 def SetOrientation(self, orient): 20442 """ 20443 SetOrientation(orient) 20444 """ 20445 20446 def SetPosition(self, pos): 20447 """ 20448 SetPosition(pos) 20449 """ 20450 Orientation = property(None, None) 20451 Position = property(None, None) 20452# end of class ScrollEvent 20453 20454 20455class ScrollWinEvent(Event): 20456 """ 20457 ScrollWinEvent(commandType=wxEVT_NULL, pos=0, orientation=0) 20458 20459 A scroll event holds information about events sent from scrolling 20460 windows. 20461 """ 20462 20463 def __init__(self, commandType=wxEVT_NULL, pos=0, orientation=0): 20464 """ 20465 ScrollWinEvent(commandType=wxEVT_NULL, pos=0, orientation=0) 20466 20467 A scroll event holds information about events sent from scrolling 20468 windows. 20469 """ 20470 20471 def GetOrientation(self): 20472 """ 20473 GetOrientation() -> int 20474 20475 Returns wxHORIZONTAL or wxVERTICAL, depending on the orientation of 20476 the scrollbar. 20477 """ 20478 20479 def GetPosition(self): 20480 """ 20481 GetPosition() -> int 20482 20483 Returns the position of the scrollbar for the thumb track and release 20484 events. 20485 """ 20486 20487 def SetOrientation(self, orient): 20488 """ 20489 SetOrientation(orient) 20490 """ 20491 20492 def SetPosition(self, pos): 20493 """ 20494 SetPosition(pos) 20495 """ 20496 Orientation = property(None, None) 20497 Position = property(None, None) 20498# end of class ScrollWinEvent 20499 20500 20501class SetCursorEvent(Event): 20502 """ 20503 SetCursorEvent(x=0, y=0) 20504 20505 A wxSetCursorEvent is generated from wxWindow when the mouse cursor is 20506 about to be set as a result of mouse motion. 20507 """ 20508 20509 def __init__(self, x=0, y=0): 20510 """ 20511 SetCursorEvent(x=0, y=0) 20512 20513 A wxSetCursorEvent is generated from wxWindow when the mouse cursor is 20514 about to be set as a result of mouse motion. 20515 """ 20516 20517 def GetCursor(self): 20518 """ 20519 GetCursor() -> Cursor 20520 20521 Returns a reference to the cursor specified by this event. 20522 """ 20523 20524 def GetX(self): 20525 """ 20526 GetX() -> Coord 20527 20528 Returns the X coordinate of the mouse in client coordinates. 20529 """ 20530 20531 def GetY(self): 20532 """ 20533 GetY() -> Coord 20534 20535 Returns the Y coordinate of the mouse in client coordinates. 20536 """ 20537 20538 def HasCursor(self): 20539 """ 20540 HasCursor() -> bool 20541 20542 Returns true if the cursor specified by this event is a valid cursor. 20543 """ 20544 20545 def SetCursor(self, cursor): 20546 """ 20547 SetCursor(cursor) 20548 20549 Sets the cursor associated with this event. 20550 """ 20551 Cursor = property(None, None) 20552 X = property(None, None) 20553 Y = property(None, None) 20554# end of class SetCursorEvent 20555 20556 20557class ShowEvent(Event): 20558 """ 20559 ShowEvent(winid=0, show=False) 20560 20561 An event being sent when the window is shown or hidden. 20562 """ 20563 20564 def __init__(self, winid=0, show=False): 20565 """ 20566 ShowEvent(winid=0, show=False) 20567 20568 An event being sent when the window is shown or hidden. 20569 """ 20570 20571 def SetShow(self, show): 20572 """ 20573 SetShow(show) 20574 20575 Set whether the windows was shown or hidden. 20576 """ 20577 20578 def IsShown(self): 20579 """ 20580 IsShown() -> bool 20581 20582 Return true if the window has been shown, false if it has been hidden. 20583 """ 20584 Show = property(None, None) 20585# end of class ShowEvent 20586 20587 20588class SizeEvent(Event): 20589 """ 20590 SizeEvent(sz, id=0) 20591 20592 A size event holds information about size change events of wxWindow. 20593 """ 20594 20595 def __init__(self, sz, id=0): 20596 """ 20597 SizeEvent(sz, id=0) 20598 20599 A size event holds information about size change events of wxWindow. 20600 """ 20601 20602 def GetSize(self): 20603 """ 20604 GetSize() -> Size 20605 20606 Returns the entire size of the window generating the size change 20607 event. 20608 """ 20609 20610 def SetSize(self, size): 20611 """ 20612 SetSize(size) 20613 """ 20614 20615 def GetRect(self): 20616 """ 20617 GetRect() -> Rect 20618 """ 20619 20620 def SetRect(self, rect): 20621 """ 20622 SetRect(rect) 20623 """ 20624 Rect = property(None, None) 20625 Size = property(None, None) 20626# end of class SizeEvent 20627 20628 20629class SysColourChangedEvent(Event): 20630 """ 20631 SysColourChangedEvent() 20632 20633 This class is used for system colour change events, which are 20634 generated when the user changes the colour settings using the control 20635 panel. 20636 """ 20637 20638 def __init__(self): 20639 """ 20640 SysColourChangedEvent() 20641 20642 This class is used for system colour change events, which are 20643 generated when the user changes the colour settings using the control 20644 panel. 20645 """ 20646# end of class SysColourChangedEvent 20647 20648 20649class UpdateUIEvent(CommandEvent): 20650 """ 20651 UpdateUIEvent(commandId=0) 20652 20653 This class is used for pseudo-events which are called by wxWidgets to 20654 give an application the chance to update various user interface 20655 elements. 20656 """ 20657 20658 def __init__(self, commandId=0): 20659 """ 20660 UpdateUIEvent(commandId=0) 20661 20662 This class is used for pseudo-events which are called by wxWidgets to 20663 give an application the chance to update various user interface 20664 elements. 20665 """ 20666 20667 def Check(self, check): 20668 """ 20669 Check(check) 20670 20671 Check or uncheck the UI element. 20672 """ 20673 20674 def Enable(self, enable): 20675 """ 20676 Enable(enable) 20677 20678 Enable or disable the UI element. 20679 """ 20680 20681 def GetChecked(self): 20682 """ 20683 GetChecked() -> bool 20684 20685 Returns true if the UI element should be checked. 20686 """ 20687 20688 def GetEnabled(self): 20689 """ 20690 GetEnabled() -> bool 20691 20692 Returns true if the UI element should be enabled. 20693 """ 20694 20695 def GetSetChecked(self): 20696 """ 20697 GetSetChecked() -> bool 20698 20699 Returns true if the application has called Check(). 20700 """ 20701 20702 def GetSetEnabled(self): 20703 """ 20704 GetSetEnabled() -> bool 20705 20706 Returns true if the application has called Enable(). 20707 """ 20708 20709 def GetSetShown(self): 20710 """ 20711 GetSetShown() -> bool 20712 20713 Returns true if the application has called Show(). 20714 """ 20715 20716 def GetSetText(self): 20717 """ 20718 GetSetText() -> bool 20719 20720 Returns true if the application has called SetText(). 20721 """ 20722 20723 def GetShown(self): 20724 """ 20725 GetShown() -> bool 20726 20727 Returns true if the UI element should be shown. 20728 """ 20729 20730 def GetText(self): 20731 """ 20732 GetText() -> String 20733 20734 Returns the text that should be set for the UI element. 20735 """ 20736 20737 def SetText(self, text): 20738 """ 20739 SetText(text) 20740 20741 Sets the text for this UI element. 20742 """ 20743 20744 def Show(self, show): 20745 """ 20746 Show(show) 20747 20748 Show or hide the UI element. 20749 """ 20750 20751 @staticmethod 20752 def CanUpdate(window): 20753 """ 20754 CanUpdate(window) -> bool 20755 20756 Returns true if it is appropriate to update (send UI update events to) 20757 this window. 20758 """ 20759 20760 @staticmethod 20761 def GetMode(): 20762 """ 20763 GetMode() -> UpdateUIMode 20764 20765 Static function returning a value specifying how wxWidgets will send 20766 update events: to all windows, or only to those which specify that 20767 they will process the events. 20768 """ 20769 20770 @staticmethod 20771 def GetUpdateInterval(): 20772 """ 20773 GetUpdateInterval() -> long 20774 20775 Returns the current interval between updates in milliseconds. 20776 """ 20777 20778 @staticmethod 20779 def ResetUpdateTime(): 20780 """ 20781 ResetUpdateTime() 20782 20783 Used internally to reset the last-updated time to the current time. 20784 """ 20785 20786 @staticmethod 20787 def SetMode(mode): 20788 """ 20789 SetMode(mode) 20790 20791 Specify how wxWidgets will send update events: to all windows, or only 20792 to those which specify that they will process the events. 20793 """ 20794 20795 @staticmethod 20796 def SetUpdateInterval(updateInterval): 20797 """ 20798 SetUpdateInterval(updateInterval) 20799 20800 Sets the interval between updates in milliseconds. 20801 """ 20802 Checked = property(None, None) 20803 Enabled = property(None, None) 20804 Shown = property(None, None) 20805 Text = property(None, None) 20806# end of class UpdateUIEvent 20807 20808 20809class WindowCreateEvent(CommandEvent): 20810 """ 20811 WindowCreateEvent(win=None) 20812 20813 This event is sent just after the actual window associated with a 20814 wxWindow object has been created. 20815 """ 20816 20817 def __init__(self, win=None): 20818 """ 20819 WindowCreateEvent(win=None) 20820 20821 This event is sent just after the actual window associated with a 20822 wxWindow object has been created. 20823 """ 20824 20825 def GetWindow(self): 20826 """ 20827 GetWindow() -> Window 20828 20829 Return the window being created. 20830 """ 20831 Window = property(None, None) 20832# end of class WindowCreateEvent 20833 20834 20835class WindowDestroyEvent(CommandEvent): 20836 """ 20837 WindowDestroyEvent(win=None) 20838 20839 This event is sent as early as possible during the window destruction 20840 process. 20841 """ 20842 20843 def __init__(self, win=None): 20844 """ 20845 WindowDestroyEvent(win=None) 20846 20847 This event is sent as early as possible during the window destruction 20848 process. 20849 """ 20850 20851 def GetWindow(self): 20852 """ 20853 GetWindow() -> Window 20854 20855 Return the window being destroyed. 20856 """ 20857 Window = property(None, None) 20858# end of class WindowDestroyEvent 20859 20860 20861def NewEventType(): 20862 """ 20863 NewEventType() -> EventType 20864 20865 Generates a new unique event type. 20866 """ 20867 20868def PostEvent(dest, event): 20869 """ 20870 PostEvent(dest, event) 20871 20872 In a GUI application, this function posts event to the specified dest 20873 object using wxEvtHandler::AddPendingEvent(). 20874 """ 20875 20876def QueueEvent(dest, event): 20877 """ 20878 QueueEvent(dest, event) 20879 20880 Queue an event for processing on the given object. 20881 """ 20882class PyEventBinder(object): 20883 """ 20884 Instances of this class are used to bind specific events to event handlers. 20885 """ 20886 20887 def __init__(self, evtType, expectedIDs=0): 20888 pass 20889 20890 def Bind(self, target, id1, id2, function): 20891 """ 20892 Bind this set of event types to target using its Connect() method. 20893 """ 20894 pass 20895 20896 def Unbind(self, target, id1, id2, handler=None): 20897 """ 20898 Remove an event binding. 20899 """ 20900 pass 20901 20902 def _getEvtType(self): 20903 """ 20904 Make it easy to get to the default wxEventType typeID for this 20905 event binder. 20906 """ 20907 pass 20908 typeId = property(None, None) 20909 20910 @wx.deprecated 20911 def __call__(self, *args): 20912 """ 20913 For backwards compatibility with the old ``EVT_*`` functions. 20914 Should be called with either (window, func), (window, ID, 20915 func) or (window, ID1, ID2, func) parameters depending on the 20916 type of the event. 20917 """ 20918 pass 20919 20920#-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 20921# This code block was included from src/event_ex.py 20922# Create some event binders 20923EVT_SIZE = wx.PyEventBinder( wxEVT_SIZE ) 20924EVT_SIZING = wx.PyEventBinder( wxEVT_SIZING ) 20925EVT_MOVE = wx.PyEventBinder( wxEVT_MOVE ) 20926EVT_MOVING = wx.PyEventBinder( wxEVT_MOVING ) 20927EVT_MOVE_START = wx.PyEventBinder( wxEVT_MOVE_START ) 20928EVT_MOVE_END = wx.PyEventBinder( wxEVT_MOVE_END ) 20929EVT_CLOSE = wx.PyEventBinder( wxEVT_CLOSE_WINDOW ) 20930EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION ) 20931EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION ) 20932EVT_PAINT = wx.PyEventBinder( wxEVT_PAINT ) 20933EVT_NC_PAINT = wx.PyEventBinder( wxEVT_NC_PAINT ) 20934EVT_ERASE_BACKGROUND = wx.PyEventBinder( wxEVT_ERASE_BACKGROUND ) 20935EVT_CHAR = wx.PyEventBinder( wxEVT_CHAR ) 20936EVT_KEY_DOWN = wx.PyEventBinder( wxEVT_KEY_DOWN ) 20937EVT_KEY_UP = wx.PyEventBinder( wxEVT_KEY_UP ) 20938EVT_HOTKEY = wx.PyEventBinder( wxEVT_HOTKEY, 1) 20939EVT_CHAR_HOOK = wx.PyEventBinder( wxEVT_CHAR_HOOK ) 20940EVT_MENU_OPEN = wx.PyEventBinder( wxEVT_MENU_OPEN ) 20941EVT_MENU_CLOSE = wx.PyEventBinder( wxEVT_MENU_CLOSE ) 20942EVT_MENU_HIGHLIGHT = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT, 1) 20943EVT_MENU_HIGHLIGHT_ALL = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT ) 20944EVT_SET_FOCUS = wx.PyEventBinder( wxEVT_SET_FOCUS ) 20945EVT_KILL_FOCUS = wx.PyEventBinder( wxEVT_KILL_FOCUS ) 20946EVT_CHILD_FOCUS = wx.PyEventBinder( wxEVT_CHILD_FOCUS ) 20947EVT_ACTIVATE = wx.PyEventBinder( wxEVT_ACTIVATE ) 20948EVT_ACTIVATE_APP = wx.PyEventBinder( wxEVT_ACTIVATE_APP ) 20949EVT_HIBERNATE = wx.PyEventBinder( wxEVT_HIBERNATE ) 20950EVT_DROP_FILES = wx.PyEventBinder( wxEVT_DROP_FILES ) 20951EVT_INIT_DIALOG = wx.PyEventBinder( wxEVT_INIT_DIALOG ) 20952EVT_SYS_COLOUR_CHANGED = wx.PyEventBinder( wxEVT_SYS_COLOUR_CHANGED ) 20953EVT_DISPLAY_CHANGED = wx.PyEventBinder( wxEVT_DISPLAY_CHANGED ) 20954EVT_SHOW = wx.PyEventBinder( wxEVT_SHOW ) 20955EVT_MAXIMIZE = wx.PyEventBinder( wxEVT_MAXIMIZE ) 20956EVT_ICONIZE = wx.PyEventBinder( wxEVT_ICONIZE ) 20957EVT_NAVIGATION_KEY = wx.PyEventBinder( wxEVT_NAVIGATION_KEY ) 20958EVT_PALETTE_CHANGED = wx.PyEventBinder( wxEVT_PALETTE_CHANGED ) 20959EVT_QUERY_NEW_PALETTE = wx.PyEventBinder( wxEVT_QUERY_NEW_PALETTE ) 20960EVT_WINDOW_CREATE = wx.PyEventBinder( wxEVT_CREATE ) 20961EVT_WINDOW_DESTROY = wx.PyEventBinder( wxEVT_DESTROY ) 20962EVT_SET_CURSOR = wx.PyEventBinder( wxEVT_SET_CURSOR ) 20963EVT_MOUSE_CAPTURE_CHANGED = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_CHANGED ) 20964EVT_MOUSE_CAPTURE_LOST = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_LOST ) 20965 20966EVT_LEFT_DOWN = wx.PyEventBinder( wxEVT_LEFT_DOWN ) 20967EVT_LEFT_UP = wx.PyEventBinder( wxEVT_LEFT_UP ) 20968EVT_MIDDLE_DOWN = wx.PyEventBinder( wxEVT_MIDDLE_DOWN ) 20969EVT_MIDDLE_UP = wx.PyEventBinder( wxEVT_MIDDLE_UP ) 20970EVT_RIGHT_DOWN = wx.PyEventBinder( wxEVT_RIGHT_DOWN ) 20971EVT_RIGHT_UP = wx.PyEventBinder( wxEVT_RIGHT_UP ) 20972EVT_MOTION = wx.PyEventBinder( wxEVT_MOTION ) 20973EVT_LEFT_DCLICK = wx.PyEventBinder( wxEVT_LEFT_DCLICK ) 20974EVT_MIDDLE_DCLICK = wx.PyEventBinder( wxEVT_MIDDLE_DCLICK ) 20975EVT_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_RIGHT_DCLICK ) 20976EVT_LEAVE_WINDOW = wx.PyEventBinder( wxEVT_LEAVE_WINDOW ) 20977EVT_ENTER_WINDOW = wx.PyEventBinder( wxEVT_ENTER_WINDOW ) 20978EVT_MOUSEWHEEL = wx.PyEventBinder( wxEVT_MOUSEWHEEL ) 20979EVT_MOUSE_AUX1_DOWN = wx.PyEventBinder( wxEVT_AUX1_DOWN ) 20980EVT_MOUSE_AUX1_UP = wx.PyEventBinder( wxEVT_AUX1_UP ) 20981EVT_MOUSE_AUX1_DCLICK = wx.PyEventBinder( wxEVT_AUX1_DCLICK ) 20982EVT_MOUSE_AUX2_DOWN = wx.PyEventBinder( wxEVT_AUX2_DOWN ) 20983EVT_MOUSE_AUX2_UP = wx.PyEventBinder( wxEVT_AUX2_UP ) 20984EVT_MOUSE_AUX2_DCLICK = wx.PyEventBinder( wxEVT_AUX2_DCLICK ) 20985 20986EVT_MOUSE_EVENTS = wx.PyEventBinder([ wxEVT_LEFT_DOWN, 20987 wxEVT_LEFT_UP, 20988 wxEVT_MIDDLE_DOWN, 20989 wxEVT_MIDDLE_UP, 20990 wxEVT_RIGHT_DOWN, 20991 wxEVT_RIGHT_UP, 20992 wxEVT_MOTION, 20993 wxEVT_LEFT_DCLICK, 20994 wxEVT_MIDDLE_DCLICK, 20995 wxEVT_RIGHT_DCLICK, 20996 wxEVT_ENTER_WINDOW, 20997 wxEVT_LEAVE_WINDOW, 20998 wxEVT_MOUSEWHEEL, 20999 wxEVT_AUX1_DOWN, 21000 wxEVT_AUX1_UP, 21001 wxEVT_AUX1_DCLICK, 21002 wxEVT_AUX2_DOWN, 21003 wxEVT_AUX2_UP, 21004 wxEVT_AUX2_DCLICK, 21005 ]) 21006 21007 21008# Scrolling from wxWindow (sent to wxScrolledWindow) 21009EVT_SCROLLWIN = wx.PyEventBinder([ wxEVT_SCROLLWIN_TOP, 21010 wxEVT_SCROLLWIN_BOTTOM, 21011 wxEVT_SCROLLWIN_LINEUP, 21012 wxEVT_SCROLLWIN_LINEDOWN, 21013 wxEVT_SCROLLWIN_PAGEUP, 21014 wxEVT_SCROLLWIN_PAGEDOWN, 21015 wxEVT_SCROLLWIN_THUMBTRACK, 21016 wxEVT_SCROLLWIN_THUMBRELEASE, 21017 ]) 21018 21019EVT_SCROLLWIN_TOP = wx.PyEventBinder( wxEVT_SCROLLWIN_TOP ) 21020EVT_SCROLLWIN_BOTTOM = wx.PyEventBinder( wxEVT_SCROLLWIN_BOTTOM ) 21021EVT_SCROLLWIN_LINEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEUP ) 21022EVT_SCROLLWIN_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEDOWN ) 21023EVT_SCROLLWIN_PAGEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEUP ) 21024EVT_SCROLLWIN_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEDOWN ) 21025EVT_SCROLLWIN_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBTRACK ) 21026EVT_SCROLLWIN_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBRELEASE ) 21027 21028# Scrolling from wx.Slider and wx.ScrollBar 21029EVT_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP, 21030 wxEVT_SCROLL_BOTTOM, 21031 wxEVT_SCROLL_LINEUP, 21032 wxEVT_SCROLL_LINEDOWN, 21033 wxEVT_SCROLL_PAGEUP, 21034 wxEVT_SCROLL_PAGEDOWN, 21035 wxEVT_SCROLL_THUMBTRACK, 21036 wxEVT_SCROLL_THUMBRELEASE, 21037 wxEVT_SCROLL_CHANGED, 21038 ]) 21039 21040EVT_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP ) 21041EVT_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM ) 21042EVT_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP ) 21043EVT_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN ) 21044EVT_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP ) 21045EVT_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN ) 21046EVT_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK ) 21047EVT_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE ) 21048EVT_SCROLL_CHANGED = wx.PyEventBinder( wxEVT_SCROLL_CHANGED ) 21049EVT_SCROLL_ENDSCROLL = EVT_SCROLL_CHANGED 21050 21051# Scrolling from wx.Slider and wx.ScrollBar, with an id 21052EVT_COMMAND_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP, 21053 wxEVT_SCROLL_BOTTOM, 21054 wxEVT_SCROLL_LINEUP, 21055 wxEVT_SCROLL_LINEDOWN, 21056 wxEVT_SCROLL_PAGEUP, 21057 wxEVT_SCROLL_PAGEDOWN, 21058 wxEVT_SCROLL_THUMBTRACK, 21059 wxEVT_SCROLL_THUMBRELEASE, 21060 wxEVT_SCROLL_CHANGED, 21061 ], 1) 21062 21063EVT_COMMAND_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP, 1) 21064EVT_COMMAND_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM, 1) 21065EVT_COMMAND_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP, 1) 21066EVT_COMMAND_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN, 1) 21067EVT_COMMAND_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP, 1) 21068EVT_COMMAND_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN, 1) 21069EVT_COMMAND_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK, 1) 21070EVT_COMMAND_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE, 1) 21071EVT_COMMAND_SCROLL_CHANGED = wx.PyEventBinder( wxEVT_SCROLL_CHANGED, 1) 21072EVT_COMMAND_SCROLL_ENDSCROLL = EVT_COMMAND_SCROLL_CHANGED 21073 21074EVT_BUTTON = wx.PyEventBinder( wxEVT_BUTTON, 1) 21075EVT_CHECKBOX = wx.PyEventBinder( wxEVT_CHECKBOX, 1) 21076EVT_CHOICE = wx.PyEventBinder( wxEVT_CHOICE, 1) 21077EVT_LISTBOX = wx.PyEventBinder( wxEVT_LISTBOX, 1) 21078EVT_LISTBOX_DCLICK = wx.PyEventBinder( wxEVT_LISTBOX_DCLICK, 1) 21079EVT_MENU = wx.PyEventBinder( wxEVT_MENU, 1) 21080EVT_MENU_RANGE = wx.PyEventBinder( wxEVT_MENU, 2) 21081EVT_SLIDER = wx.PyEventBinder( wxEVT_SLIDER, 1) 21082EVT_RADIOBOX = wx.PyEventBinder( wxEVT_RADIOBOX, 1) 21083EVT_RADIOBUTTON = wx.PyEventBinder( wxEVT_RADIOBUTTON, 1) 21084 21085EVT_SCROLLBAR = wx.PyEventBinder( wxEVT_SCROLLBAR, 1) 21086EVT_VLBOX = wx.PyEventBinder( wxEVT_VLBOX, 1) 21087EVT_COMBOBOX = wx.PyEventBinder( wxEVT_COMBOBOX, 1) 21088EVT_TOOL = wx.PyEventBinder( wxEVT_TOOL, 1) 21089EVT_TOOL_RANGE = wx.PyEventBinder( wxEVT_TOOL, 2) 21090EVT_TOOL_RCLICKED = wx.PyEventBinder( wxEVT_TOOL_RCLICKED, 1) 21091EVT_TOOL_RCLICKED_RANGE = wx.PyEventBinder( wxEVT_TOOL_RCLICKED, 2) 21092EVT_TOOL_ENTER = wx.PyEventBinder( wxEVT_TOOL_ENTER, 1) 21093EVT_TOOL_DROPDOWN = wx.PyEventBinder( wxEVT_TOOL_DROPDOWN, 1) 21094EVT_CHECKLISTBOX = wx.PyEventBinder( wxEVT_CHECKLISTBOX, 1) 21095EVT_COMBOBOX_DROPDOWN = wx.PyEventBinder( wxEVT_COMBOBOX_DROPDOWN , 1) 21096EVT_COMBOBOX_CLOSEUP = wx.PyEventBinder( wxEVT_COMBOBOX_CLOSEUP , 1) 21097 21098EVT_COMMAND_LEFT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_CLICK, 1) 21099EVT_COMMAND_LEFT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_DCLICK, 1) 21100EVT_COMMAND_RIGHT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_CLICK, 1) 21101EVT_COMMAND_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_DCLICK, 1) 21102EVT_COMMAND_SET_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_SET_FOCUS, 1) 21103EVT_COMMAND_KILL_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_KILL_FOCUS, 1) 21104EVT_COMMAND_ENTER = wx.PyEventBinder( wxEVT_COMMAND_ENTER, 1) 21105 21106EVT_HELP = wx.PyEventBinder( wxEVT_HELP, 1) 21107EVT_HELP_RANGE = wx.PyEventBinder( wxEVT_HELP, 2) 21108EVT_DETAILED_HELP = wx.PyEventBinder( wxEVT_DETAILED_HELP, 1) 21109EVT_DETAILED_HELP_RANGE = wx.PyEventBinder( wxEVT_DETAILED_HELP, 2) 21110 21111EVT_IDLE = wx.PyEventBinder( wxEVT_IDLE ) 21112 21113EVT_UPDATE_UI = wx.PyEventBinder( wxEVT_UPDATE_UI, 1) 21114EVT_UPDATE_UI_RANGE = wx.PyEventBinder( wxEVT_UPDATE_UI, 2) 21115 21116EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU ) 21117 21118EVT_THREAD = wx.PyEventBinder( wxEVT_THREAD ) 21119 21120EVT_WINDOW_MODAL_DIALOG_CLOSED = wx.PyEventBinder( wxEVT_WINDOW_MODAL_DIALOG_CLOSED ) 21121 21122EVT_JOY_BUTTON_DOWN = wx.PyEventBinder( wxEVT_JOY_BUTTON_DOWN ) 21123EVT_JOY_BUTTON_UP = wx.PyEventBinder( wxEVT_JOY_BUTTON_UP ) 21124EVT_JOY_MOVE = wx.PyEventBinder( wxEVT_JOY_MOVE ) 21125EVT_JOY_ZMOVE = wx.PyEventBinder( wxEVT_JOY_ZMOVE ) 21126EVT_JOYSTICK_EVENTS = wx.PyEventBinder([ wxEVT_JOY_BUTTON_DOWN, 21127 wxEVT_JOY_BUTTON_UP, 21128 wxEVT_JOY_MOVE, 21129 wxEVT_JOY_ZMOVE, 21130 ]) 21131 21132# deprecated wxEVT aliases 21133wxEVT_COMMAND_BUTTON_CLICKED = wxEVT_BUTTON 21134wxEVT_COMMAND_CHECKBOX_CLICKED = wxEVT_CHECKBOX 21135wxEVT_COMMAND_CHOICE_SELECTED = wxEVT_CHOICE 21136wxEVT_COMMAND_LISTBOX_SELECTED = wxEVT_LISTBOX 21137wxEVT_COMMAND_LISTBOX_DOUBLECLICKED = wxEVT_LISTBOX_DCLICK 21138wxEVT_COMMAND_CHECKLISTBOX_TOGGLED = wxEVT_CHECKLISTBOX 21139wxEVT_COMMAND_MENU_SELECTED = wxEVT_MENU 21140wxEVT_COMMAND_TOOL_CLICKED = wxEVT_TOOL 21141wxEVT_COMMAND_SLIDER_UPDATED = wxEVT_SLIDER 21142wxEVT_COMMAND_RADIOBOX_SELECTED = wxEVT_RADIOBOX 21143wxEVT_COMMAND_RADIOBUTTON_SELECTED = wxEVT_RADIOBUTTON 21144wxEVT_COMMAND_SCROLLBAR_UPDATED = wxEVT_SCROLLBAR 21145wxEVT_COMMAND_VLBOX_SELECTED = wxEVT_VLBOX 21146wxEVT_COMMAND_COMBOBOX_SELECTED = wxEVT_COMBOBOX 21147wxEVT_COMMAND_TOOL_RCLICKED = wxEVT_TOOL_RCLICKED 21148wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED = wxEVT_TOOL_DROPDOWN 21149wxEVT_COMMAND_TOOL_ENTER = wxEVT_TOOL_ENTER 21150wxEVT_COMMAND_COMBOBOX_DROPDOWN = wxEVT_COMBOBOX_DROPDOWN 21151wxEVT_COMMAND_COMBOBOX_CLOSEUP = wxEVT_COMBOBOX_CLOSEUP 21152 21153# End of included code block 21154#-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 21155 21156PyEvtHandler = wx.deprecated(EvtHandler, "Use :class:`EvtHandler` instead.") 21157#-- end-event --# 21158#-- begin-pyevent --# 21159 21160class PyEvent(Event): 21161 """ 21162 PyEvent(id=0, eventType=wxEVT_NULL) 21163 21164 :class:`PyEvent` can be used as a base class for implementing custom 21165 event types in Python. You should derive from this class instead 21166 of :class:`Event` because this class is Python-aware and is able to 21167 transport its Python bits safely through the wxWidgets event 21168 system and have them still be there when the event handler is 21169 invoked. Note that since :class:`PyEvent` is taking care of preserving 21170 the extra attributes that have been set then you do not need to 21171 override the Clone method in your derived classes. 21172 21173 :see: :class:`PyCommandEvent` 21174 """ 21175 21176 def __init__(self, id=0, eventType=wxEVT_NULL): 21177 """ 21178 PyEvent(id=0, eventType=wxEVT_NULL) 21179 21180 :class:`PyEvent` can be used as a base class for implementing custom 21181 event types in Python. You should derive from this class instead 21182 of :class:`Event` because this class is Python-aware and is able to 21183 transport its Python bits safely through the wxWidgets event 21184 system and have them still be there when the event handler is 21185 invoked. Note that since :class:`PyEvent` is taking care of preserving 21186 the extra attributes that have been set then you do not need to 21187 override the Clone method in your derived classes. 21188 21189 :see: :class:`PyCommandEvent` 21190 """ 21191 21192 def __getattr__(self, name): 21193 """ 21194 __getattr__(name) -> PyObject 21195 """ 21196 21197 def __delattr__(self, name): 21198 """ 21199 __delattr__(name) 21200 """ 21201 21202 def __setattr__(self, name, value): 21203 """ 21204 __setattr__(name, value) 21205 """ 21206 21207 def Clone(self): 21208 """ 21209 Clone() -> Event 21210 """ 21211 21212 def _getAttrDict(self): 21213 """ 21214 _getAttrDict() -> PyObject 21215 21216 Gives access to the internal object that is tracking the event's 21217 python attributes. 21218 """ 21219 21220 def Clone(self): 21221 """ 21222 Make a new instance of the event that is a copy of self. 21223 21224 Through the magic of Python this implementation should work for 21225 this and all derived classes. 21226 """ 21227# end of class PyEvent 21228 21229 21230class PyCommandEvent(CommandEvent): 21231 """ 21232 PyCommandEvent(eventType=wxEVT_NULL, id=0) 21233 21234 :class:`PyCommandEvent` can be used as a base class for implementing 21235 custom event types in Python. You should derive from this class 21236 instead of :class:`CommandEvent` because this class is Python-aware 21237 and is able to transport its Python bits safely through the 21238 wxWidgets event system and have them still be there when the 21239 event handler is invoked. Note that since :class:`PyCommandEvent` is 21240 taking care of preserving the extra attributes that have been set 21241 then you do not need to override the Clone method in your 21242 derived classes. 21243 21244 :see: :class:`PyEvent` 21245 """ 21246 21247 def __init__(self, eventType=wxEVT_NULL, id=0): 21248 """ 21249 PyCommandEvent(eventType=wxEVT_NULL, id=0) 21250 21251 :class:`PyCommandEvent` can be used as a base class for implementing 21252 custom event types in Python. You should derive from this class 21253 instead of :class:`CommandEvent` because this class is Python-aware 21254 and is able to transport its Python bits safely through the 21255 wxWidgets event system and have them still be there when the 21256 event handler is invoked. Note that since :class:`PyCommandEvent` is 21257 taking care of preserving the extra attributes that have been set 21258 then you do not need to override the Clone method in your 21259 derived classes. 21260 21261 :see: :class:`PyEvent` 21262 """ 21263 21264 def __getattr__(self, name): 21265 """ 21266 __getattr__(name) -> PyObject 21267 """ 21268 21269 def __delattr__(self, name): 21270 """ 21271 __delattr__(name) 21272 """ 21273 21274 def __setattr__(self, name, value): 21275 """ 21276 __setattr__(name, value) 21277 """ 21278 21279 def Clone(self): 21280 """ 21281 Clone() -> Event 21282 """ 21283 21284 def _getAttrDict(self): 21285 """ 21286 _getAttrDict() -> PyObject 21287 21288 Gives access to the internal object that is tracking the event's 21289 python attributes. 21290 """ 21291 21292 def Clone(self): 21293 """ 21294 Make a new instance of the event that is a copy of self. 21295 21296 Through the magic of Python this implementation should work for 21297 this and all derived classes. 21298 """ 21299# end of class PyCommandEvent 21300 21301#-- end-pyevent --# 21302#-- begin-sizer --# 21303FLEX_GROWMODE_NONE = 0 21304FLEX_GROWMODE_SPECIFIED = 0 21305FLEX_GROWMODE_ALL = 0 21306 21307class SizerItem(Object): 21308 """ 21309 SizerItem(window, flags) 21310 SizerItem(window, proportion=0, flag=0, border=0, userData=None) 21311 SizerItem(sizer, flags) 21312 SizerItem(sizer, proportion=0, flag=0, border=0, userData=None) 21313 SizerItem(width, height, proportion=0, flag=0, border=0, userData=None) 21314 21315 The wxSizerItem class is used to track the position, size and other 21316 attributes of each item managed by a wxSizer. 21317 """ 21318 21319 def __init__(self, *args, **kw): 21320 """ 21321 SizerItem(window, flags) 21322 SizerItem(window, proportion=0, flag=0, border=0, userData=None) 21323 SizerItem(sizer, flags) 21324 SizerItem(sizer, proportion=0, flag=0, border=0, userData=None) 21325 SizerItem(width, height, proportion=0, flag=0, border=0, userData=None) 21326 21327 The wxSizerItem class is used to track the position, size and other 21328 attributes of each item managed by a wxSizer. 21329 """ 21330 21331 def AssignSpacer(self, *args, **kw): 21332 """ 21333 AssignSpacer(size) 21334 AssignSpacer(w, h) 21335 21336 Set the size of the spacer tracked by this item. 21337 """ 21338 21339 def SetRatio(self, *args, **kw): 21340 """ 21341 SetRatio(width, height) 21342 SetRatio(size) 21343 SetRatio(ratio) 21344 21345 Set the ratio item attribute. 21346 """ 21347 21348 def AssignWindow(self, window): 21349 """ 21350 AssignWindow(window) 21351 21352 Set the window to be tracked by this item. 21353 """ 21354 21355 def AssignSizer(self, sizer): 21356 """ 21357 AssignSizer(sizer) 21358 21359 Set the sizer tracked by this item. 21360 """ 21361 21362 def CalcMin(self): 21363 """ 21364 CalcMin() -> Size 21365 21366 Calculates the minimum desired size for the item, including any space 21367 needed by borders. 21368 """ 21369 21370 def DeleteWindows(self): 21371 """ 21372 DeleteWindows() 21373 21374 Destroy the window or the windows in a subsizer, depending on the type 21375 of item. 21376 """ 21377 21378 def DetachSizer(self): 21379 """ 21380 DetachSizer() 21381 21382 Enable deleting the SizerItem without destroying the contained sizer. 21383 """ 21384 21385 def GetBorder(self): 21386 """ 21387 GetBorder() -> int 21388 21389 Return the border attribute. 21390 """ 21391 21392 def GetFlag(self): 21393 """ 21394 GetFlag() -> int 21395 21396 Return the flags attribute. 21397 """ 21398 21399 def GetId(self): 21400 """ 21401 GetId() -> int 21402 21403 Return the numeric id of wxSizerItem, or wxID_NONE if the id has not 21404 been set. 21405 """ 21406 21407 def GetMinSize(self): 21408 """ 21409 GetMinSize() -> Size 21410 21411 Get the minimum size needed for the item. 21412 """ 21413 21414 def SetMinSize(self, *args, **kw): 21415 """ 21416 SetMinSize(size) 21417 SetMinSize(x, y) 21418 21419 Sets the minimum size to be allocated for this item. 21420 """ 21421 21422 def GetPosition(self): 21423 """ 21424 GetPosition() -> Point 21425 21426 What is the current position of the item, as set in the last Layout. 21427 """ 21428 21429 def GetProportion(self): 21430 """ 21431 GetProportion() -> int 21432 21433 Get the proportion item attribute. 21434 """ 21435 21436 def GetRatio(self): 21437 """ 21438 GetRatio() -> float 21439 21440 Get the ration item attribute. 21441 """ 21442 21443 def GetRect(self): 21444 """ 21445 GetRect() -> Rect 21446 21447 Get the rectangle of the item on the parent window, excluding borders. 21448 """ 21449 21450 def GetSize(self): 21451 """ 21452 GetSize() -> Size 21453 21454 Get the current size of the item, as set in the last Layout. 21455 """ 21456 21457 def GetSizer(self): 21458 """ 21459 GetSizer() -> Sizer 21460 21461 If this item is tracking a sizer, return it. 21462 """ 21463 21464 def GetSpacer(self): 21465 """ 21466 GetSpacer() -> Size 21467 21468 If this item is tracking a spacer, return its size. 21469 """ 21470 21471 def GetUserData(self): 21472 """ 21473 GetUserData() -> PyUserData 21474 21475 Get the userData item attribute. 21476 """ 21477 21478 def GetWindow(self): 21479 """ 21480 GetWindow() -> Window 21481 21482 If this item is tracking a window then return it. 21483 """ 21484 21485 def IsShown(self): 21486 """ 21487 IsShown() -> bool 21488 21489 Returns true if this item is a window or a spacer and it is shown or 21490 if this item is a sizer and not all of its elements are hidden. 21491 """ 21492 21493 def IsSizer(self): 21494 """ 21495 IsSizer() -> bool 21496 21497 Is this item a sizer? 21498 """ 21499 21500 def IsSpacer(self): 21501 """ 21502 IsSpacer() -> bool 21503 21504 Is this item a spacer? 21505 """ 21506 21507 def IsWindow(self): 21508 """ 21509 IsWindow() -> bool 21510 21511 Is this item a window? 21512 """ 21513 21514 def SetBorder(self, border): 21515 """ 21516 SetBorder(border) 21517 21518 Set the border item attribute. 21519 """ 21520 21521 def SetDimension(self, pos, size): 21522 """ 21523 SetDimension(pos, size) 21524 21525 Set the position and size of the space allocated to the sizer, and 21526 adjust the position and size of the item to be within that space 21527 taking alignment and borders into account. 21528 """ 21529 21530 def SetFlag(self, flag): 21531 """ 21532 SetFlag(flag) 21533 21534 Set the flag item attribute. 21535 """ 21536 21537 def SetId(self, id): 21538 """ 21539 SetId(id) 21540 21541 Sets the numeric id of the wxSizerItem to id. 21542 """ 21543 21544 def SetInitSize(self, x, y): 21545 """ 21546 SetInitSize(x, y) 21547 """ 21548 21549 def SetProportion(self, proportion): 21550 """ 21551 SetProportion(proportion) 21552 21553 Set the proportion item attribute. 21554 """ 21555 21556 def SetUserData(self, userData): 21557 """ 21558 SetUserData(userData) 21559 """ 21560 21561 def Show(self, show): 21562 """ 21563 Show(show) 21564 21565 Set the show item attribute, which sizers use to determine if the item 21566 is to be made part of the layout or not. 21567 """ 21568 Border = property(None, None) 21569 Flag = property(None, None) 21570 Id = property(None, None) 21571 MinSize = property(None, None) 21572 Position = property(None, None) 21573 Proportion = property(None, None) 21574 Ratio = property(None, None) 21575 Rect = property(None, None) 21576 Size = property(None, None) 21577 Sizer = property(None, None) 21578 Spacer = property(None, None) 21579 UserData = property(None, None) 21580 Window = property(None, None) 21581# end of class SizerItem 21582 21583 21584class SizerFlags(object): 21585 """ 21586 SizerFlags(proportion=0) 21587 21588 Container for sizer items flags providing readable names for them. 21589 """ 21590 21591 def __init__(self, proportion=0): 21592 """ 21593 SizerFlags(proportion=0) 21594 21595 Container for sizer items flags providing readable names for them. 21596 """ 21597 21598 def Align(self, alignment): 21599 """ 21600 Align(alignment) -> SizerFlags 21601 21602 Sets the alignment of this wxSizerFlags to align. 21603 """ 21604 21605 def Border(self, *args, **kw): 21606 """ 21607 Border(direction, borderinpixels) -> SizerFlags 21608 Border(direction=ALL) -> SizerFlags 21609 21610 Sets the wxSizerFlags to have a border of a number of pixels specified 21611 by borderinpixels with the directions specified by direction. 21612 """ 21613 21614 def Bottom(self): 21615 """ 21616 Bottom() -> SizerFlags 21617 21618 Aligns the object to the bottom, similar for Align(wxALIGN_BOTTOM). 21619 """ 21620 21621 def Center(self): 21622 """ 21623 Center() -> SizerFlags 21624 21625 Sets the object of the wxSizerFlags to center itself in the area it is 21626 given. 21627 """ 21628 21629 def Centre(self): 21630 """ 21631 Centre() -> SizerFlags 21632 21633 Center() for people with the other dialect of English. 21634 """ 21635 21636 def DoubleBorder(self, direction=ALL): 21637 """ 21638 DoubleBorder(direction=ALL) -> SizerFlags 21639 21640 Sets the border in the given direction having twice the default border 21641 size. 21642 """ 21643 21644 def DoubleHorzBorder(self): 21645 """ 21646 DoubleHorzBorder() -> SizerFlags 21647 21648 Sets the border in left and right directions having twice the default 21649 border size. 21650 """ 21651 21652 def Expand(self): 21653 """ 21654 Expand() -> SizerFlags 21655 21656 Sets the object of the wxSizerFlags to expand to fill as much area as 21657 it can. 21658 """ 21659 21660 def FixedMinSize(self): 21661 """ 21662 FixedMinSize() -> SizerFlags 21663 21664 Set the wxFIXED_MINSIZE flag which indicates that the initial size of 21665 the window should be also set as its minimal size. 21666 """ 21667 21668 def ReserveSpaceEvenIfHidden(self): 21669 """ 21670 ReserveSpaceEvenIfHidden() -> SizerFlags 21671 21672 Set the wxRESERVE_SPACE_EVEN_IF_HIDDEN flag. 21673 """ 21674 21675 def Left(self): 21676 """ 21677 Left() -> SizerFlags 21678 21679 Aligns the object to the left, similar for Align(wxALIGN_LEFT). 21680 """ 21681 21682 def Proportion(self, proportion): 21683 """ 21684 Proportion(proportion) -> SizerFlags 21685 21686 Sets the proportion of this wxSizerFlags to proportion. 21687 """ 21688 21689 def Right(self): 21690 """ 21691 Right() -> SizerFlags 21692 21693 Aligns the object to the right, similar for Align(wxALIGN_RIGHT). 21694 """ 21695 21696 def Shaped(self): 21697 """ 21698 Shaped() -> SizerFlags 21699 21700 Set the wx_SHAPED flag which indicates that the elements should always 21701 keep the fixed width to height ratio equal to its original value. 21702 """ 21703 21704 def Top(self): 21705 """ 21706 Top() -> SizerFlags 21707 21708 Aligns the object to the top, similar for Align(wxALIGN_TOP). 21709 """ 21710 21711 def TripleBorder(self, direction=ALL): 21712 """ 21713 TripleBorder(direction=ALL) -> SizerFlags 21714 21715 Sets the border in the given direction having thrice the default 21716 border size. 21717 """ 21718 21719 @staticmethod 21720 def GetDefaultBorder(): 21721 """ 21722 GetDefaultBorder() -> int 21723 21724 Returns the border used by default in Border() method. 21725 """ 21726# end of class SizerFlags 21727 21728 21729class Sizer(Object): 21730 """ 21731 Sizer() 21732 21733 wxSizer is the abstract base class used for laying out subwindows in a 21734 window. 21735 """ 21736 21737 def __init__(self): 21738 """ 21739 Sizer() 21740 21741 wxSizer is the abstract base class used for laying out subwindows in a 21742 window. 21743 """ 21744 21745 def GetChildren(self): 21746 """ 21747 GetChildren() -> SizerItemList 21748 21749 Returns the list of the items in this sizer. 21750 """ 21751 21752 def SetItemMinSize(self, *args, **kw): 21753 """ 21754 SetItemMinSize(window, width, height) -> bool 21755 SetItemMinSize(window, size) -> bool 21756 SetItemMinSize(sizer, width, height) -> bool 21757 SetItemMinSize(sizer, size) -> bool 21758 SetItemMinSize(index, width, height) -> bool 21759 SetItemMinSize(index, size) -> bool 21760 21761 Set an item's minimum size by window, sizer, or position. 21762 """ 21763 21764 def Add(self, *args, **kw): 21765 """ 21766 Add(window, flags) -> SizerItem 21767 Add(window, proportion=0, flag=0, border=0, userData=None) -> SizerItem 21768 Add(sizer, flags) -> SizerItem 21769 Add(sizer, proportion=0, flag=0, border=0, userData=None) -> SizerItem 21770 Add(width, height, proportion=0, flag=0, border=0, userData=None) -> SizerItem 21771 Add(width, height, flags) -> SizerItem 21772 Add(item) -> SizerItem 21773 Add(size, proportion=0, flag=0, border=0, /Transfer/=None) -> SizerItem 21774 Add(size, flags) -> SizerItem 21775 21776 Appends a child to the sizer. 21777 """ 21778 21779 def AddSpacer(self, size): 21780 """ 21781 AddSpacer(size) -> SizerItem 21782 21783 This base function adds non-stretchable space to both the horizontal 21784 and vertical orientation of the sizer. 21785 """ 21786 21787 def AddStretchSpacer(self, prop=1): 21788 """ 21789 AddStretchSpacer(prop=1) -> SizerItem 21790 21791 Adds stretchable space to the sizer. 21792 """ 21793 21794 def CalcMin(self): 21795 """ 21796 CalcMin() -> Size 21797 21798 This method is abstract and has to be overwritten by any derived 21799 class. 21800 """ 21801 21802 def Clear(self, delete_windows=False): 21803 """ 21804 Clear(delete_windows=False) 21805 21806 Detaches all children from the sizer. 21807 """ 21808 21809 def ComputeFittingClientSize(self, window): 21810 """ 21811 ComputeFittingClientSize(window) -> Size 21812 21813 Computes client area size for window so that it matches the sizer's 21814 minimal size. 21815 """ 21816 21817 def ComputeFittingWindowSize(self, window): 21818 """ 21819 ComputeFittingWindowSize(window) -> Size 21820 21821 Like ComputeFittingClientSize(), but converts the result into window 21822 size. 21823 """ 21824 21825 def Detach(self, *args, **kw): 21826 """ 21827 Detach(window) -> bool 21828 Detach(sizer) -> bool 21829 Detach(index) -> bool 21830 21831 Detach the child window from the sizer without destroying it. 21832 """ 21833 21834 def Fit(self, window): 21835 """ 21836 Fit(window) -> Size 21837 21838 Tell the sizer to resize the window so that its client area matches 21839 the sizer's minimal size (ComputeFittingClientSize() is called to 21840 determine it). 21841 """ 21842 21843 def FitInside(self, window): 21844 """ 21845 FitInside(window) 21846 21847 Tell the sizer to resize the virtual size of the window to match the 21848 sizer's minimal size. 21849 """ 21850 21851 def InformFirstDirection(self, direction, size, availableOtherDir): 21852 """ 21853 InformFirstDirection(direction, size, availableOtherDir) -> bool 21854 21855 Inform sizer about the first direction that has been decided (by 21856 parent item). 21857 """ 21858 21859 def GetContainingWindow(self): 21860 """ 21861 GetContainingWindow() -> Window 21862 21863 Returns the window this sizer is used in or NULL if none. 21864 """ 21865 21866 def SetContainingWindow(self, window): 21867 """ 21868 SetContainingWindow(window) 21869 21870 Set the window this sizer is used in. 21871 """ 21872 21873 def GetItemCount(self): 21874 """ 21875 GetItemCount() -> size_t 21876 21877 Returns the number of items in the sizer. 21878 """ 21879 21880 def GetItem(self, *args, **kw): 21881 """ 21882 GetItem(window, recursive=False) -> SizerItem 21883 GetItem(sizer, recursive=False) -> SizerItem 21884 GetItem(index) -> SizerItem 21885 21886 Finds wxSizerItem which holds the given window. 21887 """ 21888 21889 def GetItemById(self, id, recursive=False): 21890 """ 21891 GetItemById(id, recursive=False) -> SizerItem 21892 21893 Finds item of the sizer which has the given id. 21894 """ 21895 21896 def GetMinSize(self): 21897 """ 21898 GetMinSize() -> Size 21899 21900 Returns the minimal size of the sizer. 21901 """ 21902 21903 def GetPosition(self): 21904 """ 21905 GetPosition() -> Point 21906 21907 Returns the current position of the sizer. 21908 """ 21909 21910 def GetSize(self): 21911 """ 21912 GetSize() -> Size 21913 21914 Returns the current size of the sizer. 21915 """ 21916 21917 def Hide(self, *args, **kw): 21918 """ 21919 Hide(window, recursive=False) -> bool 21920 Hide(sizer, recursive=False) -> bool 21921 Hide(index) -> bool 21922 21923 Hides the child window. 21924 """ 21925 21926 def Insert(self, *args, **kw): 21927 """ 21928 Insert(index, window, flags) -> SizerItem 21929 Insert(index, window, proportion=0, flag=0, border=0, userData=None) -> SizerItem 21930 Insert(index, sizer, flags) -> SizerItem 21931 Insert(index, sizer, proportion=0, flag=0, border=0, userData=None) -> SizerItem 21932 Insert(index, width, height, proportion=0, flag=0, border=0, userData=None) -> SizerItem 21933 Insert(index, width, height, flags) -> SizerItem 21934 Insert(index, item) -> SizerItem 21935 Insert(index, size, proportion=0, flag=0, border=0, /Transfer/=None) -> SizerItem 21936 Insert(index, size, flags) -> SizerItem 21937 21938 Insert a child into the sizer before any existing item at index. 21939 """ 21940 21941 def InsertSpacer(self, index, size): 21942 """ 21943 InsertSpacer(index, size) -> SizerItem 21944 21945 Inserts non-stretchable space to the sizer. 21946 """ 21947 21948 def InsertStretchSpacer(self, index, prop=1): 21949 """ 21950 InsertStretchSpacer(index, prop=1) -> SizerItem 21951 21952 Inserts stretchable space to the sizer. 21953 """ 21954 21955 def IsEmpty(self): 21956 """ 21957 IsEmpty() -> bool 21958 21959 Return true if the sizer has no elements. 21960 """ 21961 21962 def IsShown(self, *args, **kw): 21963 """ 21964 IsShown(window) -> bool 21965 IsShown(sizer) -> bool 21966 IsShown(index) -> bool 21967 21968 Returns true if the window is shown. 21969 """ 21970 21971 def Layout(self): 21972 """ 21973 Layout() 21974 21975 Call this to force layout of the children anew, e.g. after having 21976 added a child to or removed a child (window, other sizer or space) 21977 from the sizer while keeping the current dimension. 21978 """ 21979 21980 def Prepend(self, *args, **kw): 21981 """ 21982 Prepend(window, flags) -> SizerItem 21983 Prepend(window, proportion=0, flag=0, border=0, userData=None) -> SizerItem 21984 Prepend(sizer, flags) -> SizerItem 21985 Prepend(sizer, proportion=0, flag=0, border=0, userData=None) -> SizerItem 21986 Prepend(width, height, proportion=0, flag=0, border=0, userData=None) -> SizerItem 21987 Prepend(width, height, flags) -> SizerItem 21988 Prepend(item) -> SizerItem 21989 Prepend(size, proportion=0, flag=0, border=0, /Transfer/=None) -> SizerItem 21990 Prepend(size, flags) -> SizerItem 21991 21992 Same as Add(), but prepends the items to the beginning of the list of 21993 items (windows, subsizers or spaces) owned by this sizer. 21994 """ 21995 21996 def PrependSpacer(self, size): 21997 """ 21998 PrependSpacer(size) -> SizerItem 21999 22000 Prepends non-stretchable space to the sizer. 22001 """ 22002 22003 def PrependStretchSpacer(self, prop=1): 22004 """ 22005 PrependStretchSpacer(prop=1) -> SizerItem 22006 22007 Prepends stretchable space to the sizer. 22008 """ 22009 22010 def RecalcSizes(self): 22011 """ 22012 RecalcSizes() 22013 22014 This method is abstract and has to be overwritten by any derived 22015 class. 22016 """ 22017 22018 def Remove(self, *args, **kw): 22019 """ 22020 Remove(sizer) -> bool 22021 Remove(index) -> bool 22022 22023 Removes a sizer child from the sizer and destroys it. 22024 """ 22025 22026 def Replace(self, *args, **kw): 22027 """ 22028 Replace(oldwin, newwin, recursive=False) -> bool 22029 Replace(oldsz, newsz, recursive=False) -> bool 22030 Replace(index, newitem) -> bool 22031 22032 Detaches the given oldwin from the sizer and replaces it with the 22033 given newwin. 22034 """ 22035 22036 def SetDimension(self, *args, **kw): 22037 """ 22038 SetDimension(x, y, width, height) 22039 SetDimension(pos, size) 22040 22041 Call this to force the sizer to take the given dimension and thus 22042 force the items owned by the sizer to resize themselves according to 22043 the rules defined by the parameter in the Add() and Prepend() methods. 22044 """ 22045 22046 def SetMinSize(self, *args, **kw): 22047 """ 22048 SetMinSize(size) 22049 SetMinSize(width, height) 22050 22051 Call this to give the sizer a minimal size. 22052 """ 22053 22054 def SetSizeHints(self, window): 22055 """ 22056 SetSizeHints(window) 22057 22058 This method first calls Fit() and then 22059 wxTopLevelWindow::SetSizeHints() on the window passed to it. 22060 """ 22061 22062 def SetVirtualSizeHints(self, window): 22063 """ 22064 SetVirtualSizeHints(window) 22065 22066 Tell the sizer to set the minimal size of the window virtual area to 22067 match the sizer's minimal size. 22068 """ 22069 22070 def Show(self, *args, **kw): 22071 """ 22072 Show(window, show=True, recursive=False) -> bool 22073 Show(sizer, show=True, recursive=False) -> bool 22074 Show(index, show=True) -> bool 22075 22076 Shows or hides the window. 22077 """ 22078 22079 def ShowItems(self, show): 22080 """ 22081 ShowItems(show) 22082 22083 Show or hide all items managed by the sizer. 22084 """ 22085 22086 def AddMany(self, items): 22087 """ 22088 :meth:`AddMany` is a convenience method for adding several items to a sizer 22089 at one time. Simply pass it a list of tuples, where each tuple 22090 consists of the parameters that you would normally pass to the :meth:`Add` 22091 method. 22092 """ 22093 22094 def __nonzero__(self): 22095 """ 22096 Can be used to test if the C++ part of the sizer still exists, with 22097 code like this:: 22098 22099 if theSizer: 22100 doSomething() 22101 """ 22102 22103 def __iter__(self): 22104 """ 22105 A Py convenience method that allows Sizers to act as iterables that will yield their wx.SizerItems. 22106 """ 22107 22108 __bool__ = __nonzero__ 22109 Children = property(None, None) 22110 ContainingWindow = property(None, None) 22111 ItemCount = property(None, None) 22112 MinSize = property(None, None) 22113 Position = property(None, None) 22114 Size = property(None, None) 22115# end of class Sizer 22116 22117 22118class BoxSizer(Sizer): 22119 """ 22120 BoxSizer(orient=HORIZONTAL) 22121 22122 The basic idea behind a box sizer is that windows will most often be 22123 laid out in rather simple basic geometry, typically in a row or a 22124 column or several hierarchies of either. 22125 """ 22126 22127 def __init__(self, orient=HORIZONTAL): 22128 """ 22129 BoxSizer(orient=HORIZONTAL) 22130 22131 The basic idea behind a box sizer is that windows will most often be 22132 laid out in rather simple basic geometry, typically in a row or a 22133 column or several hierarchies of either. 22134 """ 22135 22136 def AddSpacer(self, size): 22137 """ 22138 AddSpacer(size) -> SizerItem 22139 22140 Adds non-stretchable space to the main orientation of the sizer only. 22141 """ 22142 22143 def CalcMin(self): 22144 """ 22145 CalcMin() -> Size 22146 22147 Implements the calculation of a box sizer's minimal. 22148 """ 22149 22150 def GetOrientation(self): 22151 """ 22152 GetOrientation() -> int 22153 22154 Returns the orientation of the box sizer, either wxVERTICAL or 22155 wxHORIZONTAL. 22156 """ 22157 22158 def SetOrientation(self, orient): 22159 """ 22160 SetOrientation(orient) 22161 22162 Sets the orientation of the box sizer, either wxVERTICAL or 22163 wxHORIZONTAL. 22164 """ 22165 22166 def RecalcSizes(self): 22167 """ 22168 RecalcSizes() 22169 22170 Implements the calculation of a box sizer's dimensions and then sets 22171 the size of its children (calling wxWindow::SetSize if the child is a 22172 window). 22173 """ 22174 Orientation = property(None, None) 22175# end of class BoxSizer 22176 22177 22178class StaticBoxSizer(BoxSizer): 22179 """ 22180 StaticBoxSizer(box, orient=HORIZONTAL) 22181 StaticBoxSizer(orient, parent, label=EmptyString) 22182 22183 wxStaticBoxSizer is a sizer derived from wxBoxSizer but adds a static 22184 box around the sizer. 22185 """ 22186 22187 def __init__(self, *args, **kw): 22188 """ 22189 StaticBoxSizer(box, orient=HORIZONTAL) 22190 StaticBoxSizer(orient, parent, label=EmptyString) 22191 22192 wxStaticBoxSizer is a sizer derived from wxBoxSizer but adds a static 22193 box around the sizer. 22194 """ 22195 22196 def GetStaticBox(self): 22197 """ 22198 GetStaticBox() -> StaticBox 22199 22200 Returns the static box associated with the sizer. 22201 """ 22202 22203 def CalcMin(self): 22204 """ 22205 CalcMin() -> Size 22206 22207 Implements the calculation of a box sizer's minimal. 22208 """ 22209 22210 def RecalcSizes(self): 22211 """ 22212 RecalcSizes() 22213 22214 Implements the calculation of a box sizer's dimensions and then sets 22215 the size of its children (calling wxWindow::SetSize if the child is a 22216 window). 22217 """ 22218 StaticBox = property(None, None) 22219# end of class StaticBoxSizer 22220 22221 22222class GridSizer(Sizer): 22223 """ 22224 GridSizer(cols, vgap, hgap) 22225 GridSizer(cols, gap=Size(0,0)) 22226 GridSizer(rows, cols, vgap, hgap) 22227 GridSizer(rows, cols, gap) 22228 22229 A grid sizer is a sizer which lays out its children in a two- 22230 dimensional table with all table fields having the same size, i.e. 22231 """ 22232 22233 def __init__(self, *args, **kw): 22234 """ 22235 GridSizer(cols, vgap, hgap) 22236 GridSizer(cols, gap=Size(0,0)) 22237 GridSizer(rows, cols, vgap, hgap) 22238 GridSizer(rows, cols, gap) 22239 22240 A grid sizer is a sizer which lays out its children in a two- 22241 dimensional table with all table fields having the same size, i.e. 22242 """ 22243 22244 def GetCols(self): 22245 """ 22246 GetCols() -> int 22247 22248 Returns the number of columns that has been specified for the sizer. 22249 """ 22250 22251 def GetRows(self): 22252 """ 22253 GetRows() -> int 22254 22255 Returns the number of rows that has been specified for the sizer. 22256 """ 22257 22258 def GetEffectiveColsCount(self): 22259 """ 22260 GetEffectiveColsCount() -> int 22261 22262 Returns the number of columns currently used by the sizer. 22263 """ 22264 22265 def GetEffectiveRowsCount(self): 22266 """ 22267 GetEffectiveRowsCount() -> int 22268 22269 Returns the number of rows currently used by the sizer. 22270 """ 22271 22272 def GetHGap(self): 22273 """ 22274 GetHGap() -> int 22275 22276 Returns the horizontal gap (in pixels) between cells in the sizer. 22277 """ 22278 22279 def GetVGap(self): 22280 """ 22281 GetVGap() -> int 22282 22283 Returns the vertical gap (in pixels) between the cells in the sizer. 22284 """ 22285 22286 def SetCols(self, cols): 22287 """ 22288 SetCols(cols) 22289 22290 Sets the number of columns in the sizer. 22291 """ 22292 22293 def SetHGap(self, gap): 22294 """ 22295 SetHGap(gap) 22296 22297 Sets the horizontal gap (in pixels) between cells in the sizer. 22298 """ 22299 22300 def SetRows(self, rows): 22301 """ 22302 SetRows(rows) 22303 22304 Sets the number of rows in the sizer. 22305 """ 22306 22307 def SetVGap(self, gap): 22308 """ 22309 SetVGap(gap) 22310 22311 Sets the vertical gap (in pixels) between the cells in the sizer. 22312 """ 22313 22314 def CalcMin(self): 22315 """ 22316 CalcMin() -> Size 22317 22318 This method is abstract and has to be overwritten by any derived 22319 class. 22320 """ 22321 22322 def RecalcSizes(self): 22323 """ 22324 RecalcSizes() 22325 22326 This method is abstract and has to be overwritten by any derived 22327 class. 22328 """ 22329 22330 def CalcRowsCols(self): 22331 """ 22332 CalcRowsCols() -> (rows, cols) 22333 22334 Calculates how many rows and columns will be in the sizer based 22335 on the current number of items and also the rows, cols specified 22336 in the constructor. 22337 """ 22338 Cols = property(None, None) 22339 EffectiveColsCount = property(None, None) 22340 EffectiveRowsCount = property(None, None) 22341 HGap = property(None, None) 22342 Rows = property(None, None) 22343 VGap = property(None, None) 22344# end of class GridSizer 22345 22346 22347class FlexGridSizer(GridSizer): 22348 """ 22349 FlexGridSizer(cols, vgap, hgap) 22350 FlexGridSizer(cols, gap=Size(0,0)) 22351 FlexGridSizer(rows, cols, vgap, hgap) 22352 FlexGridSizer(rows, cols, gap) 22353 22354 A flex grid sizer is a sizer which lays out its children in a two- 22355 dimensional table with all table fields in one row having the same 22356 height and all fields in one column having the same width, but all 22357 rows or all columns are not necessarily the same height or width as in 22358 the wxGridSizer. 22359 """ 22360 22361 def __init__(self, *args, **kw): 22362 """ 22363 FlexGridSizer(cols, vgap, hgap) 22364 FlexGridSizer(cols, gap=Size(0,0)) 22365 FlexGridSizer(rows, cols, vgap, hgap) 22366 FlexGridSizer(rows, cols, gap) 22367 22368 A flex grid sizer is a sizer which lays out its children in a two- 22369 dimensional table with all table fields in one row having the same 22370 height and all fields in one column having the same width, but all 22371 rows or all columns are not necessarily the same height or width as in 22372 the wxGridSizer. 22373 """ 22374 22375 def AddGrowableCol(self, idx, proportion=0): 22376 """ 22377 AddGrowableCol(idx, proportion=0) 22378 22379 Specifies that column idx (starting from zero) should be grown if 22380 there is extra space available to the sizer. 22381 """ 22382 22383 def AddGrowableRow(self, idx, proportion=0): 22384 """ 22385 AddGrowableRow(idx, proportion=0) 22386 22387 Specifies that row idx (starting from zero) should be grown if there 22388 is extra space available to the sizer. 22389 """ 22390 22391 def GetFlexibleDirection(self): 22392 """ 22393 GetFlexibleDirection() -> int 22394 22395 Returns a wxOrientation value that specifies whether the sizer 22396 flexibly resizes its columns, rows, or both (default). 22397 """ 22398 22399 def GetNonFlexibleGrowMode(self): 22400 """ 22401 GetNonFlexibleGrowMode() -> FlexSizerGrowMode 22402 22403 Returns the value that specifies how the sizer grows in the "non- 22404 flexible" direction if there is one. 22405 """ 22406 22407 def IsColGrowable(self, idx): 22408 """ 22409 IsColGrowable(idx) -> bool 22410 22411 Returns true if column idx is growable. 22412 """ 22413 22414 def IsRowGrowable(self, idx): 22415 """ 22416 IsRowGrowable(idx) -> bool 22417 22418 Returns true if row idx is growable. 22419 """ 22420 22421 def RemoveGrowableCol(self, idx): 22422 """ 22423 RemoveGrowableCol(idx) 22424 22425 Specifies that the idx column index is no longer growable. 22426 """ 22427 22428 def RemoveGrowableRow(self, idx): 22429 """ 22430 RemoveGrowableRow(idx) 22431 22432 Specifies that the idx row index is no longer growable. 22433 """ 22434 22435 def SetFlexibleDirection(self, direction): 22436 """ 22437 SetFlexibleDirection(direction) 22438 22439 Specifies whether the sizer should flexibly resize its columns, rows, 22440 or both. 22441 """ 22442 22443 def SetNonFlexibleGrowMode(self, mode): 22444 """ 22445 SetNonFlexibleGrowMode(mode) 22446 22447 Specifies how the sizer should grow in the non-flexible direction if 22448 there is one (so SetFlexibleDirection() must have been called 22449 previously). 22450 """ 22451 22452 def GetRowHeights(self): 22453 """ 22454 GetRowHeights() -> ArrayInt 22455 22456 Returns a read-only array containing the heights of the rows in the 22457 sizer. 22458 """ 22459 22460 def GetColWidths(self): 22461 """ 22462 GetColWidths() -> ArrayInt 22463 22464 Returns a read-only array containing the widths of the columns in the 22465 sizer. 22466 """ 22467 22468 def RecalcSizes(self): 22469 """ 22470 RecalcSizes() 22471 22472 This method is abstract and has to be overwritten by any derived 22473 class. 22474 """ 22475 22476 def CalcMin(self): 22477 """ 22478 CalcMin() -> Size 22479 22480 This method is abstract and has to be overwritten by any derived 22481 class. 22482 """ 22483 ColWidths = property(None, None) 22484 FlexibleDirection = property(None, None) 22485 NonFlexibleGrowMode = property(None, None) 22486 RowHeights = property(None, None) 22487# end of class FlexGridSizer 22488 22489 22490class StdDialogButtonSizer(BoxSizer): 22491 """ 22492 StdDialogButtonSizer() 22493 22494 This class creates button layouts which conform to the standard button 22495 spacing and ordering defined by the platform or toolkit's user 22496 interface guidelines (if such things exist). 22497 """ 22498 22499 def __init__(self): 22500 """ 22501 StdDialogButtonSizer() 22502 22503 This class creates button layouts which conform to the standard button 22504 spacing and ordering defined by the platform or toolkit's user 22505 interface guidelines (if such things exist). 22506 """ 22507 22508 def AddButton(self, button): 22509 """ 22510 AddButton(button) 22511 22512 Adds a button to the wxStdDialogButtonSizer. 22513 """ 22514 22515 def Realize(self): 22516 """ 22517 Realize() 22518 22519 Rearranges the buttons and applies proper spacing between buttons to 22520 make them match the platform or toolkit's interface guidelines. 22521 """ 22522 22523 def SetAffirmativeButton(self, button): 22524 """ 22525 SetAffirmativeButton(button) 22526 22527 Sets the affirmative button for the sizer. 22528 """ 22529 22530 def SetCancelButton(self, button): 22531 """ 22532 SetCancelButton(button) 22533 22534 Sets the cancel button for the sizer. 22535 """ 22536 22537 def SetNegativeButton(self, button): 22538 """ 22539 SetNegativeButton(button) 22540 22541 Sets the negative button for the sizer. 22542 """ 22543 22544 def RecalcSizes(self): 22545 """ 22546 RecalcSizes() 22547 22548 Implements the calculation of a box sizer's dimensions and then sets 22549 the size of its children (calling wxWindow::SetSize if the child is a 22550 window). 22551 """ 22552 22553 def CalcMin(self): 22554 """ 22555 CalcMin() -> Size 22556 22557 Implements the calculation of a box sizer's minimal. 22558 """ 22559# end of class StdDialogButtonSizer 22560 22561 22562PySizer = wx.deprecated(Sizer, 'Use Sizer instead.') 22563#-- end-sizer --# 22564#-- begin-gbsizer --# 22565 22566class GBPosition(object): 22567 """ 22568 GBPosition() 22569 GBPosition(row, col) 22570 22571 This class represents the position of an item in a virtual grid of 22572 rows and columns managed by a wxGridBagSizer. 22573 """ 22574 22575 def __init__(self, *args, **kw): 22576 """ 22577 GBPosition() 22578 GBPosition(row, col) 22579 22580 This class represents the position of an item in a virtual grid of 22581 rows and columns managed by a wxGridBagSizer. 22582 """ 22583 22584 def GetCol(self): 22585 """ 22586 GetCol() -> int 22587 22588 Get the current column value. 22589 """ 22590 22591 def GetRow(self): 22592 """ 22593 GetRow() -> int 22594 22595 Get the current row value. 22596 """ 22597 22598 def SetCol(self, col): 22599 """ 22600 SetCol(col) 22601 22602 Set a new column value. 22603 """ 22604 22605 def SetRow(self, row): 22606 """ 22607 SetRow(row) 22608 22609 Set a new row value. 22610 """ 22611 22612 def __ne__(self): 22613 """ 22614 """ 22615 22616 def __eq__(self): 22617 """ 22618 """ 22619 22620 def Get(self): 22621 """ 22622 Get() -> (row, col) 22623 22624 Return the row and col properties as a tuple. 22625 """ 22626 22627 def Set(self, row=0, col=0): 22628 """ 22629 Set(row=0, col=0) 22630 22631 Set both the row and column properties. 22632 """ 22633 22634 def GetIM(self): 22635 """ 22636 Returns an immutable representation of the ``wx.GBPosition`` object, based on ``namedtuple``. 22637 22638 This new object is hashable and can be used as a dictionary key, 22639 be added to sets, etc. It can be converted back into a real ``wx.GBPosition`` 22640 with a simple statement like this: ``obj = wx.GBPosition(imObj)``. 22641 """ 22642 22643 def __str__(self): 22644 """ 22645 22646 """ 22647 22648 def __repr__(self): 22649 """ 22650 22651 """ 22652 22653 def __len__(self): 22654 """ 22655 22656 """ 22657 22658 def __nonzero__(self): 22659 """ 22660 22661 """ 22662 22663 def __bool__(self): 22664 """ 22665 22666 """ 22667 22668 def __reduce__(self): 22669 """ 22670 22671 """ 22672 22673 def __getitem__(self, idx): 22674 """ 22675 22676 """ 22677 22678 def __setitem__(self, idx, val): 22679 """ 22680 22681 """ 22682 22683 __safe_for_unpickling__ = True 22684 Row = property(None, None) 22685 Col = property(None, None) 22686 row = property(None, None) 22687 col = property(None, None) 22688# end of class GBPosition 22689 22690 22691class GBSpan(object): 22692 """ 22693 GBSpan() 22694 GBSpan(rowspan, colspan) 22695 22696 This class is used to hold the row and column spanning attributes of 22697 items in a wxGridBagSizer. 22698 """ 22699 22700 def __init__(self, *args, **kw): 22701 """ 22702 GBSpan() 22703 GBSpan(rowspan, colspan) 22704 22705 This class is used to hold the row and column spanning attributes of 22706 items in a wxGridBagSizer. 22707 """ 22708 22709 def GetColspan(self): 22710 """ 22711 GetColspan() -> int 22712 22713 Get the current colspan value. 22714 """ 22715 22716 def GetRowspan(self): 22717 """ 22718 GetRowspan() -> int 22719 22720 Get the current rowspan value. 22721 """ 22722 22723 def SetColspan(self, colspan): 22724 """ 22725 SetColspan(colspan) 22726 22727 Set a new colspan value. 22728 """ 22729 22730 def SetRowspan(self, rowspan): 22731 """ 22732 SetRowspan(rowspan) 22733 22734 Set a new rowspan value. 22735 """ 22736 22737 def __ne__(self): 22738 """ 22739 """ 22740 22741 def __eq__(self): 22742 """ 22743 """ 22744 22745 def Get(self): 22746 """ 22747 Get() -> (rowspan, colspan) 22748 22749 Return the rowspan and colspan properties as a tuple. 22750 """ 22751 22752 def Set(self, rowspan=0, colspan=0): 22753 """ 22754 Set(rowspan=0, colspan=0) 22755 22756 Set both the rowspan and colspan properties. 22757 """ 22758 22759 def GetIM(self): 22760 """ 22761 Returns an immutable representation of the ``wx.GBSpan`` object, based on ``namedtuple``. 22762 22763 This new object is hashable and can be used as a dictionary key, 22764 be added to sets, etc. It can be converted back into a real ``wx.GBSpan`` 22765 with a simple statement like this: ``obj = wx.GBSpan(imObj)``. 22766 """ 22767 22768 def __str__(self): 22769 """ 22770 22771 """ 22772 22773 def __repr__(self): 22774 """ 22775 22776 """ 22777 22778 def __len__(self): 22779 """ 22780 22781 """ 22782 22783 def __nonzero__(self): 22784 """ 22785 22786 """ 22787 22788 def __bool__(self): 22789 """ 22790 22791 """ 22792 22793 def __reduce__(self): 22794 """ 22795 22796 """ 22797 22798 def __getitem__(self, idx): 22799 """ 22800 22801 """ 22802 22803 def __setitem__(self, idx, val): 22804 """ 22805 22806 """ 22807 22808 __safe_for_unpickling__ = True 22809 Rowspan = property(None, None) 22810 Colspan = property(None, None) 22811 rowspan = property(None, None) 22812 colspan = property(None, None) 22813# end of class GBSpan 22814 22815 22816class GBSizerItem(SizerItem): 22817 """ 22818 GBSizerItem(width, height, pos, span=DefaultSpan, flag=0, border=0, userData=None) 22819 GBSizerItem(window, pos, span=DefaultSpan, flag=0, border=0, userData=None) 22820 GBSizerItem(sizer, pos, span=DefaultSpan, flag=0, border=0, userData=None) 22821 22822 The wxGBSizerItem class is used by the wxGridBagSizer for tracking the 22823 items in the sizer. 22824 """ 22825 22826 def __init__(self, *args, **kw): 22827 """ 22828 GBSizerItem(width, height, pos, span=DefaultSpan, flag=0, border=0, userData=None) 22829 GBSizerItem(window, pos, span=DefaultSpan, flag=0, border=0, userData=None) 22830 GBSizerItem(sizer, pos, span=DefaultSpan, flag=0, border=0, userData=None) 22831 22832 The wxGBSizerItem class is used by the wxGridBagSizer for tracking the 22833 items in the sizer. 22834 """ 22835 22836 def GetPos(self): 22837 """ 22838 GetPos() -> GBPosition 22839 22840 Get the grid position of the item. 22841 """ 22842 22843 def GetSpan(self): 22844 """ 22845 GetSpan() -> GBSpan 22846 22847 Get the row and column spanning of the item. 22848 """ 22849 22850 def GetEndPos(self): 22851 """ 22852 GetEndPos() -> (row, col) 22853 22854 Get the row and column of the endpoint of this item. 22855 """ 22856 22857 def Intersects(self, *args, **kw): 22858 """ 22859 Intersects(other) -> bool 22860 Intersects(pos, span) -> bool 22861 22862 Returns true if this item and the other item intersect. 22863 """ 22864 22865 def SetPos(self, pos): 22866 """ 22867 SetPos(pos) -> bool 22868 22869 If the item is already a member of a sizer then first ensure that 22870 there is no other item that would intersect with this one at the new 22871 position, then set the new position. 22872 """ 22873 22874 def SetSpan(self, span): 22875 """ 22876 SetSpan(span) -> bool 22877 22878 If the item is already a member of a sizer then first ensure that 22879 there is no other item that would intersect with this one with its new 22880 spanning size, then set the new spanning. 22881 """ 22882 22883 def GetGBSizer(self): 22884 """ 22885 GetGBSizer() -> GridBagSizer 22886 """ 22887 22888 def SetGBSizer(self, sizer): 22889 """ 22890 SetGBSizer(sizer) 22891 """ 22892 GBSizer = property(None, None) 22893 Pos = property(None, None) 22894 Span = property(None, None) 22895# end of class GBSizerItem 22896 22897 22898class GridBagSizer(FlexGridSizer): 22899 """ 22900 GridBagSizer(vgap=0, hgap=0) 22901 22902 A wxSizer that can lay out items in a virtual grid like a 22903 wxFlexGridSizer but in this case explicit positioning of the items is 22904 allowed using wxGBPosition, and items can optionally span more than 22905 one row and/or column using wxGBSpan. 22906 """ 22907 22908 def __init__(self, vgap=0, hgap=0): 22909 """ 22910 GridBagSizer(vgap=0, hgap=0) 22911 22912 A wxSizer that can lay out items in a virtual grid like a 22913 wxFlexGridSizer but in this case explicit positioning of the items is 22914 allowed using wxGBPosition, and items can optionally span more than 22915 one row and/or column using wxGBSpan. 22916 """ 22917 22918 def Add(self, *args, **kw): 22919 """ 22920 Add(window, pos, span=DefaultSpan, flag=0, border=0, userData=None) -> SizerItem 22921 Add(sizer, pos, span=DefaultSpan, flag=0, border=0, userData=None) -> SizerItem 22922 Add(item) -> SizerItem 22923 Add(width, height, pos, span=DefaultSpan, flag=0, border=0, userData=None) -> SizerItem 22924 Add(size, pos, span=DefaultSpan, flag=0, border=0, /Transfer/=None) -> SizerItem 22925 22926 Adds the given item to the given position. 22927 """ 22928 22929 def CheckForIntersection(self, *args, **kw): 22930 """ 22931 CheckForIntersection(item, excludeItem=None) -> bool 22932 CheckForIntersection(pos, span, excludeItem=None) -> bool 22933 22934 Look at all items and see if any intersect (or would overlap) the 22935 given item. 22936 """ 22937 22938 def FindItem(self, *args, **kw): 22939 """ 22940 FindItem(window) -> GBSizerItem 22941 FindItem(sizer) -> GBSizerItem 22942 22943 Find the sizer item for the given window or subsizer, returns NULL if 22944 not found. 22945 """ 22946 22947 def GetItemPosition(self, *args, **kw): 22948 """ 22949 GetItemPosition(window) -> GBPosition 22950 GetItemPosition(sizer) -> GBPosition 22951 GetItemPosition(index) -> GBPosition 22952 22953 Get the grid position of the specified item. 22954 """ 22955 22956 def GetItemSpan(self, *args, **kw): 22957 """ 22958 GetItemSpan(window) -> GBSpan 22959 GetItemSpan(sizer) -> GBSpan 22960 GetItemSpan(index) -> GBSpan 22961 22962 Get the row/col spanning of the specified item. 22963 """ 22964 22965 def SetItemPosition(self, *args, **kw): 22966 """ 22967 SetItemPosition(window, pos) -> bool 22968 SetItemPosition(sizer, pos) -> bool 22969 SetItemPosition(index, pos) -> bool 22970 22971 Set the grid position of the specified item. 22972 """ 22973 22974 def SetItemSpan(self, *args, **kw): 22975 """ 22976 SetItemSpan(window, span) -> bool 22977 SetItemSpan(sizer, span) -> bool 22978 SetItemSpan(index, span) -> bool 22979 22980 Set the row/col spanning of the specified item. 22981 """ 22982 22983 def CalcMin(self): 22984 """ 22985 CalcMin() -> Size 22986 22987 Called when the managed size of the sizer is needed or when layout 22988 needs done. 22989 """ 22990 22991 def FindItemAtPoint(self, pt): 22992 """ 22993 FindItemAtPoint(pt) -> GBSizerItem 22994 22995 Return the sizer item located at the point given in pt, or NULL if 22996 there is no item at that point. 22997 """ 22998 22999 def FindItemAtPosition(self, pos): 23000 """ 23001 FindItemAtPosition(pos) -> GBSizerItem 23002 23003 Return the sizer item for the given grid cell, or NULL if there is no 23004 item at that position. 23005 """ 23006 23007 def FindItemWithData(self, userData): 23008 """ 23009 FindItemWithData(userData) -> GBSizerItem 23010 23011 Return the sizer item that has a matching user data (it only compares 23012 pointer values) or NULL if not found. 23013 """ 23014 23015 def GetCellSize(self, row, col): 23016 """ 23017 GetCellSize(row, col) -> Size 23018 23019 Get the size of the specified cell, including hgap and vgap. 23020 """ 23021 23022 def GetEmptyCellSize(self): 23023 """ 23024 GetEmptyCellSize() -> Size 23025 23026 Get the size used for cells in the grid with no item. 23027 """ 23028 23029 def RecalcSizes(self): 23030 """ 23031 RecalcSizes() 23032 23033 Called when the managed size of the sizer is needed or when layout 23034 needs done. 23035 """ 23036 23037 def SetEmptyCellSize(self, sz): 23038 """ 23039 SetEmptyCellSize(sz) 23040 23041 Set the size used for cells in the grid with no item. 23042 """ 23043 23044 CheckForIntersectionPos = wx.deprecated(CheckForIntersection, 'Use CheckForIntersection instead.') 23045 EmptyCellSize = property(None, None) 23046# end of class GridBagSizer 23047 23048DefaultSpan = GBSpan() 23049 23050from collections import namedtuple 23051_im_GBPosition = namedtuple('_im_GBPosition', ['row', 'col']) 23052del namedtuple 23053 23054from collections import namedtuple 23055_im_GBSpan = namedtuple('_im_GBSpan', ['rowspan', 'colspan']) 23056del namedtuple 23057#-- end-gbsizer --# 23058#-- begin-wrapsizer --# 23059EXTEND_LAST_ON_EACH_LINE = 0 23060REMOVE_LEADING_SPACES = 0 23061WRAPSIZER_DEFAULT_FLAGS = 0 23062 23063class WrapSizer(BoxSizer): 23064 """ 23065 WrapSizer(orient=HORIZONTAL, flags=WRAPSIZER_DEFAULT_FLAGS) 23066 23067 A wrap sizer lays out its items in a single line, like a box sizer as 23068 long as there is space available in that direction. 23069 """ 23070 23071 def __init__(self, orient=HORIZONTAL, flags=WRAPSIZER_DEFAULT_FLAGS): 23072 """ 23073 WrapSizer(orient=HORIZONTAL, flags=WRAPSIZER_DEFAULT_FLAGS) 23074 23075 A wrap sizer lays out its items in a single line, like a box sizer as 23076 long as there is space available in that direction. 23077 """ 23078 23079 def InformFirstDirection(self, direction, size, availableOtherDir): 23080 """ 23081 InformFirstDirection(direction, size, availableOtherDir) -> bool 23082 23083 Not used by an application. 23084 """ 23085 23086 def RecalcSizes(self): 23087 """ 23088 RecalcSizes() 23089 23090 Implements the calculation of a box sizer's dimensions and then sets 23091 the size of its children (calling wxWindow::SetSize if the child is a 23092 window). 23093 """ 23094 23095 def CalcMin(self): 23096 """ 23097 CalcMin() -> Size 23098 23099 Implements the calculation of a box sizer's minimal. 23100 """ 23101 23102 def IsSpaceItem(self, item): 23103 """ 23104 IsSpaceItem(item) -> bool 23105 23106 Can be overridden in the derived classes to treat some normal items as 23107 spacers. 23108 """ 23109# end of class WrapSizer 23110 23111#-- end-wrapsizer --# 23112#-- begin-stdpaths --# 23113 23114class StandardPaths(object): 23115 """ 23116 StandardPaths() 23117 23118 wxStandardPaths returns the standard locations in the file system and 23119 should be used by applications to find their data files in a portable 23120 way. 23121 """ 23122 ResourceCat_None = 0 23123 ResourceCat_Messages = 0 23124 23125 def GetAppDocumentsDir(self): 23126 """ 23127 GetAppDocumentsDir() -> String 23128 23129 Return the directory for the document files used by this application. 23130 """ 23131 23132 def GetConfigDir(self): 23133 """ 23134 GetConfigDir() -> String 23135 23136 Return the directory containing the system config files. 23137 """ 23138 23139 def GetDataDir(self): 23140 """ 23141 GetDataDir() -> String 23142 23143 Return the location of the applications global, i.e. not user- 23144 specific, data files. 23145 """ 23146 23147 def GetDocumentsDir(self): 23148 """ 23149 GetDocumentsDir() -> String 23150 23151 Return the directory containing the current user's documents. 23152 """ 23153 23154 def GetExecutablePath(self): 23155 """ 23156 GetExecutablePath() -> String 23157 23158 Return the directory and the filename for the current executable. 23159 """ 23160 23161 def GetInstallPrefix(self): 23162 """ 23163 GetInstallPrefix() -> String 23164 23165 Return the program installation prefix, e.g. /usr, /opt or 23166 /home/zeitlin. 23167 """ 23168 23169 def GetLocalDataDir(self): 23170 """ 23171 GetLocalDataDir() -> String 23172 23173 Return the location for application data files which are host-specific 23174 and can't, or shouldn't, be shared with the other machines. 23175 """ 23176 23177 def GetLocalizedResourcesDir(self, lang, category=ResourceCat_None): 23178 """ 23179 GetLocalizedResourcesDir(lang, category=ResourceCat_None) -> String 23180 23181 Return the localized resources directory containing the resource files 23182 of the specified category for the given language. 23183 """ 23184 23185 def GetPluginsDir(self): 23186 """ 23187 GetPluginsDir() -> String 23188 23189 Return the directory where the loadable modules (plugins) live. 23190 """ 23191 23192 def GetResourcesDir(self): 23193 """ 23194 GetResourcesDir() -> String 23195 23196 Return the directory where the application resource files are located. 23197 """ 23198 23199 def GetTempDir(self): 23200 """ 23201 GetTempDir() -> String 23202 23203 Return the directory for storing temporary files. 23204 """ 23205 23206 def GetUserConfigDir(self): 23207 """ 23208 GetUserConfigDir() -> String 23209 23210 Return the directory for the user config files: 23211 """ 23212 23213 def GetUserDataDir(self): 23214 """ 23215 GetUserDataDir() -> String 23216 23217 Return the directory for the user-dependent application data files: 23218 """ 23219 23220 def GetUserLocalDataDir(self): 23221 """ 23222 GetUserLocalDataDir() -> String 23223 23224 Return the directory for user data files which shouldn't be shared 23225 with the other machines. 23226 """ 23227 23228 def SetInstallPrefix(self, prefix): 23229 """ 23230 SetInstallPrefix(prefix) 23231 23232 Lets wxStandardPaths know about the real program installation prefix 23233 on a Unix system. 23234 """ 23235 23236 def UseAppInfo(self, info): 23237 """ 23238 UseAppInfo(info) 23239 23240 Controls what application information is used when constructing paths 23241 that should be unique to this program, such as the application data 23242 directory, the plugins directory on Unix, etc. 23243 """ 23244 23245 @staticmethod 23246 def Get(): 23247 """ 23248 Get() -> StandardPaths 23249 23250 Returns reference to the unique global standard paths object. 23251 """ 23252 23253 @staticmethod 23254 def MSWGetShellDir(csidl): 23255 """ 23256 MSWGetShellDir(csidl) -> String 23257 23258 Returns location of Windows shell special folder. 23259 """ 23260 AppDocumentsDir = property(None, None) 23261 ConfigDir = property(None, None) 23262 DataDir = property(None, None) 23263 DocumentsDir = property(None, None) 23264 ExecutablePath = property(None, None) 23265 InstallPrefix = property(None, None) 23266 LocalDataDir = property(None, None) 23267 PluginsDir = property(None, None) 23268 ResourcesDir = property(None, None) 23269 TempDir = property(None, None) 23270 UserConfigDir = property(None, None) 23271 UserDataDir = property(None, None) 23272 UserLocalDataDir = property(None, None) 23273 23274 def wxStandardPaths(self): 23275 """ 23276 """ 23277# end of class StandardPaths 23278 23279#-- end-stdpaths --# 23280#-- begin-eventfilter --# 23281 23282class EventFilter(object): 23283 """ 23284 EventFilter() 23285 23286 A global event filter for pre-processing all the events generated in 23287 the program. 23288 """ 23289 Event_Skip = 0 23290 Event_Ignore = 0 23291 Event_Processed = 0 23292 23293 def __init__(self): 23294 """ 23295 EventFilter() 23296 23297 A global event filter for pre-processing all the events generated in 23298 the program. 23299 """ 23300 23301 def FilterEvent(self, event): 23302 """ 23303 FilterEvent(event) -> int 23304 23305 Override this method to implement event pre-processing. 23306 """ 23307# end of class EventFilter 23308 23309#-- end-eventfilter --# 23310#-- begin-evtloop --# 23311 23312class EventLoopBase(object): 23313 """ 23314 Base class for all event loop implementations. 23315 """ 23316 23317 def Run(self): 23318 """ 23319 Run() -> int 23320 23321 Start the event loop, return the exit code when it is finished. 23322 """ 23323 23324 def IsRunning(self): 23325 """ 23326 IsRunning() -> bool 23327 23328 Return true if this event loop is currently running. 23329 """ 23330 23331 def IsOk(self): 23332 """ 23333 IsOk() -> bool 23334 23335 Use this to check whether the event loop was successfully created 23336 before using it. 23337 """ 23338 23339 def Exit(self, rc=0): 23340 """ 23341 Exit(rc=0) 23342 23343 Exit the currently running loop with the given exit code. 23344 """ 23345 23346 def ScheduleExit(self, rc=0): 23347 """ 23348 ScheduleExit(rc=0) 23349 23350 Schedule an exit from the loop with the given exit code. 23351 """ 23352 23353 def Pending(self): 23354 """ 23355 Pending() -> bool 23356 23357 Return true if any events are available. 23358 """ 23359 23360 def Dispatch(self): 23361 """ 23362 Dispatch() -> bool 23363 23364 Dispatches the next event in the windowing system event queue. 23365 """ 23366 23367 def DispatchTimeout(self, timeout): 23368 """ 23369 DispatchTimeout(timeout) -> int 23370 23371 Dispatch an event but not wait longer than the specified timeout for 23372 it. 23373 """ 23374 23375 def WakeUp(self): 23376 """ 23377 WakeUp() 23378 23379 Called by wxWidgets to wake up the event loop even if it is currently 23380 blocked inside Dispatch(). 23381 """ 23382 23383 def WakeUpIdle(self): 23384 """ 23385 WakeUpIdle() 23386 23387 Makes sure that idle events are sent again. 23388 """ 23389 23390 def ProcessIdle(self): 23391 """ 23392 ProcessIdle() -> bool 23393 23394 This virtual function is called when the application becomes idle and 23395 normally just sends wxIdleEvent to all interested parties. 23396 """ 23397 23398 def IsYielding(self): 23399 """ 23400 IsYielding() -> bool 23401 23402 Returns true if called from inside Yield() or from inside YieldFor(). 23403 """ 23404 23405 def Yield(self, onlyIfNeeded=False): 23406 """ 23407 Yield(onlyIfNeeded=False) -> bool 23408 23409 Yields control to pending messages in the windowing system. 23410 """ 23411 23412 def YieldFor(self, eventsToProcess): 23413 """ 23414 YieldFor(eventsToProcess) -> bool 23415 23416 Works like Yield() with onlyIfNeeded == true, except that it allows 23417 the caller to specify a mask of the wxEventCategory values which 23418 indicates which events should be processed and which should instead be 23419 "delayed" (i.e. 23420 """ 23421 23422 def IsEventAllowedInsideYield(self, cat): 23423 """ 23424 IsEventAllowedInsideYield(cat) -> bool 23425 23426 Returns true if the given event category is allowed inside a 23427 YieldFor() call (i.e. 23428 """ 23429 23430 @staticmethod 23431 def GetActive(): 23432 """ 23433 GetActive() -> EventLoopBase 23434 23435 Return the currently active (running) event loop. 23436 """ 23437 23438 @staticmethod 23439 def SetActive(loop): 23440 """ 23441 SetActive(loop) 23442 23443 Set currently active (running) event loop. 23444 """ 23445 23446 def IsMain(self): 23447 """ 23448 IsMain() -> bool 23449 23450 Returns true if this is the main loop executed by wxApp::OnRun(). 23451 """ 23452 23453 def OnExit(self): 23454 """ 23455 OnExit() 23456 23457 This function is called before the event loop terminates, whether this 23458 happens normally (because of Exit() call) or abnormally (because of an 23459 exception thrown from inside the loop). 23460 """ 23461# end of class EventLoopBase 23462 23463 23464class EventLoopActivator(object): 23465 """ 23466 EventLoopActivator(loop) 23467 23468 Makes an event loop temporarily active. 23469 """ 23470 23471 def __init__(self, loop): 23472 """ 23473 EventLoopActivator(loop) 23474 23475 Makes an event loop temporarily active. 23476 """ 23477 23478 def __enter__(self): 23479 """ 23480 23481 """ 23482 23483 def __exit__(self, exc_type, exc_val, exc_tb): 23484 """ 23485 23486 """ 23487# end of class EventLoopActivator 23488 23489 23490class GUIEventLoop(EventLoopBase): 23491 """ 23492 GUIEventLoop() 23493 23494 A generic implementation of the GUI event loop. 23495 """ 23496 23497 def __init__(self): 23498 """ 23499 GUIEventLoop() 23500 23501 A generic implementation of the GUI event loop. 23502 """ 23503# end of class GUIEventLoop 23504 23505 23506@wx.deprecatedMsg('Use GUIEventLoop instead.') 23507class EventLoop(GUIEventLoop): 23508 '''A class using the old name for compatibility.''' 23509 def __init__(self): 23510 GUIEventLoop.__init__(self) 23511#-- end-evtloop --# 23512#-- begin-apptrait --# 23513 23514class AppTraits(object): 23515 """ 23516 The wxAppTraits class defines various configurable aspects of a wxApp. 23517 """ 23518 23519 def CreateConfig(self): 23520 """ 23521 CreateConfig() -> ConfigBase 23522 23523 Called by wxWidgets to create the default configuration object for the 23524 application. 23525 """ 23526 23527 def CreateEventLoop(self): 23528 """ 23529 CreateEventLoop() -> EventLoopBase 23530 23531 Used by wxWidgets to create the main event loop used by 23532 wxApp::OnRun(). 23533 """ 23534 23535 def CreateLogTarget(self): 23536 """ 23537 CreateLogTarget() -> Log 23538 23539 Creates a wxLog class for the application to use for logging errors. 23540 """ 23541 23542 def GetDesktopEnvironment(self): 23543 """ 23544 GetDesktopEnvironment() -> String 23545 23546 This method returns the name of the desktop environment currently 23547 running in a Unix desktop. 23548 """ 23549 23550 def GetStandardPaths(self): 23551 """ 23552 GetStandardPaths() -> StandardPaths 23553 23554 Returns the wxStandardPaths object for the application. 23555 """ 23556 23557 def GetToolkitVersion(self, major=None, minor=None): 23558 """ 23559 GetToolkitVersion(major=None, minor=None) -> PortId 23560 23561 Returns the wxWidgets port ID used by the running program and 23562 eventually fills the given pointers with the values of the major and 23563 minor digits of the native toolkit currently used. 23564 """ 23565 23566 def HasStderr(self): 23567 """ 23568 HasStderr() -> bool 23569 23570 Returns true if fprintf(stderr) goes somewhere, false otherwise. 23571 """ 23572 23573 def IsUsingUniversalWidgets(self): 23574 """ 23575 IsUsingUniversalWidgets() -> bool 23576 23577 Returns true if the library was built as wxUniversal. 23578 """ 23579 23580 def ShowAssertDialog(self, msg): 23581 """ 23582 ShowAssertDialog(msg) -> bool 23583 23584 Shows the assert dialog with the specified message in GUI mode or just 23585 prints the string to stderr in console mode. 23586 """ 23587 DesktopEnvironment = property(None, None) 23588 StandardPaths = property(None, None) 23589 ToolkitVersion = property(None, None) 23590# end of class AppTraits 23591 23592#-- end-apptrait --# 23593#-- begin-app --# 23594 23595class AppConsole(EvtHandler, EventFilter): 23596 """ 23597 This class is essential for writing console-only or hybrid apps 23598 without having to define wxUSE_GUI=0. 23599 """ 23600 23601 def MainLoop(self): 23602 """ 23603 MainLoop() -> int 23604 23605 Called by wxWidgets on creation of the application. 23606 """ 23607 23608 def ExitMainLoop(self): 23609 """ 23610 ExitMainLoop() 23611 23612 Call this to explicitly exit the main message (event) loop. 23613 """ 23614 23615 def FilterEvent(self, event): 23616 """ 23617 FilterEvent(event) -> int 23618 23619 Overridden wxEventFilter method. 23620 """ 23621 23622 def GetMainLoop(self): 23623 """ 23624 GetMainLoop() -> EventLoopBase 23625 23626 Returns the main event loop instance, i.e. the event loop which is 23627 started by OnRun() and which dispatches all events sent from the 23628 native toolkit to the application (except when new event loops are 23629 temporarily set-up). 23630 """ 23631 23632 def UsesEventLoop(self): 23633 """ 23634 UsesEventLoop() -> bool 23635 23636 Returns true if the application is using an event loop. 23637 """ 23638 23639 def ProcessPendingEvents(self): 23640 """ 23641 ProcessPendingEvents() 23642 23643 Process all pending events; it is necessary to call this function to 23644 process events posted with wxEvtHandler::QueueEvent or 23645 wxEvtHandler::AddPendingEvent. 23646 """ 23647 23648 def DeletePendingEvents(self): 23649 """ 23650 DeletePendingEvents() 23651 23652 Deletes the pending events of all wxEvtHandlers of this application. 23653 """ 23654 23655 def HasPendingEvents(self): 23656 """ 23657 HasPendingEvents() -> bool 23658 23659 Returns true if there are pending events on the internal pending event 23660 list. 23661 """ 23662 23663 def SuspendProcessingOfPendingEvents(self): 23664 """ 23665 SuspendProcessingOfPendingEvents() 23666 23667 Temporary suspends processing of the pending events. 23668 """ 23669 23670 def ResumeProcessingOfPendingEvents(self): 23671 """ 23672 ResumeProcessingOfPendingEvents() 23673 23674 Resume processing of the pending events previously stopped because of 23675 a call to SuspendProcessingOfPendingEvents(). 23676 """ 23677 23678 def ScheduleForDestruction(self, object): 23679 """ 23680 ScheduleForDestruction(object) 23681 23682 Delayed objects destruction. 23683 """ 23684 23685 def IsScheduledForDestruction(self, object): 23686 """ 23687 IsScheduledForDestruction(object) -> bool 23688 23689 Check if the object had been scheduled for destruction with 23690 ScheduleForDestruction(). 23691 """ 23692 23693 def OnEventLoopEnter(self, loop): 23694 """ 23695 OnEventLoopEnter(loop) 23696 23697 Called by wxEventLoopBase::SetActive(): you can override this function 23698 and put here the code which needs an active event loop. 23699 """ 23700 23701 def OnEventLoopExit(self, loop): 23702 """ 23703 OnEventLoopExit(loop) 23704 23705 Called by wxEventLoopBase::OnExit() for each event loop which is 23706 exited. 23707 """ 23708 23709 def OnExit(self): 23710 """ 23711 OnExit() -> int 23712 23713 Override this member function for any processing which needs to be 23714 done as the application is about to exit. 23715 """ 23716 23717 def OnInit(self): 23718 """ 23719 OnInit() -> bool 23720 23721 This must be provided by the application, and will usually create the 23722 application's main window, optionally calling SetTopWindow(). 23723 """ 23724 23725 def OnRun(self): 23726 """ 23727 OnRun() -> int 23728 23729 This virtual function is where the execution of a program written in 23730 wxWidgets starts. 23731 """ 23732 23733 def GetAppDisplayName(self): 23734 """ 23735 GetAppDisplayName() -> String 23736 23737 Returns the user-readable application name. 23738 """ 23739 23740 def GetAppName(self): 23741 """ 23742 GetAppName() -> String 23743 23744 Returns the application name. 23745 """ 23746 23747 def GetClassName(self): 23748 """ 23749 GetClassName() -> String 23750 23751 Gets the class name of the application. 23752 """ 23753 23754 def GetTraits(self): 23755 """ 23756 GetTraits() -> AppTraits 23757 23758 Returns a pointer to the wxAppTraits object for the application. 23759 """ 23760 23761 def GetVendorDisplayName(self): 23762 """ 23763 GetVendorDisplayName() -> String 23764 23765 Returns the user-readable vendor name. 23766 """ 23767 23768 def GetVendorName(self): 23769 """ 23770 GetVendorName() -> String 23771 23772 Returns the application's vendor name. 23773 """ 23774 23775 def SetAppDisplayName(self, name): 23776 """ 23777 SetAppDisplayName(name) 23778 23779 Set the application name to be used in the user-visible places such as 23780 window titles. 23781 """ 23782 23783 def SetAppName(self, name): 23784 """ 23785 SetAppName(name) 23786 23787 Sets the name of the application. 23788 """ 23789 23790 def SetClassName(self, name): 23791 """ 23792 SetClassName(name) 23793 23794 Sets the class name of the application. 23795 """ 23796 23797 def SetVendorDisplayName(self, name): 23798 """ 23799 SetVendorDisplayName(name) 23800 23801 Set the vendor name to be used in the user-visible places. 23802 """ 23803 23804 def SetVendorName(self, name): 23805 """ 23806 SetVendorName(name) 23807 23808 Sets the name of application's vendor. 23809 """ 23810 23811 def Yield(self, onlyIfNeeded=False): 23812 """ 23813 Yield(onlyIfNeeded=False) -> bool 23814 """ 23815 23816 def SetCLocale(self): 23817 """ 23818 SetCLocale() 23819 23820 Sets the C locale to the default locale for the current environment. 23821 """ 23822 23823 @staticmethod 23824 def SetInstance(app): 23825 """ 23826 SetInstance(app) 23827 23828 Allows external code to modify global wxTheApp, but you should really 23829 know what you're doing if you call it. 23830 """ 23831 23832 @staticmethod 23833 def GetInstance(): 23834 """ 23835 GetInstance() -> AppConsole 23836 23837 Returns the one and only global application object. 23838 """ 23839 23840 @staticmethod 23841 def IsMainLoopRunning(): 23842 """ 23843 IsMainLoopRunning() -> bool 23844 23845 Returns true if the main event loop is currently running, i.e. if the 23846 application is inside OnRun(). 23847 """ 23848 AppDisplayName = property(None, None) 23849 AppName = property(None, None) 23850 ClassName = property(None, None) 23851 VendorDisplayName = property(None, None) 23852 VendorName = property(None, None) 23853 Traits = property(None, None) 23854# end of class AppConsole 23855 23856APP_ASSERT_SUPPRESS = 0 23857APP_ASSERT_EXCEPTION = 0 23858APP_ASSERT_DIALOG = 0 23859APP_ASSERT_LOG = 0 23860 23861class PyApp(AppConsole): 23862 """ 23863 PyApp() 23864 23865 The wxApp class represents the application itself when wxUSE_GUI=1. 23866 """ 23867 23868 def __init__(self): 23869 """ 23870 PyApp() 23871 23872 The wxApp class represents the application itself when wxUSE_GUI=1. 23873 """ 23874 23875 def MacNewFile(self): 23876 """ 23877 MacNewFile() 23878 23879 Called in response of an "open-application" Apple event. 23880 """ 23881 23882 def MacOpenFiles(self, fileNames): 23883 """ 23884 MacOpenFiles(fileNames) 23885 23886 Called in response of an openFiles message with Cocoa, or an "open- 23887 document" Apple event with Carbon. 23888 """ 23889 23890 def MacOpenFile(self, fileName): 23891 """ 23892 MacOpenFile(fileName) 23893 23894 Called in response of an "open-document" Apple event. 23895 """ 23896 23897 def MacOpenURL(self, url): 23898 """ 23899 MacOpenURL(url) 23900 23901 Called in response of a "get-url" Apple event. 23902 """ 23903 23904 def MacPrintFile(self, fileName): 23905 """ 23906 MacPrintFile(fileName) 23907 23908 Called in response of a "print-document" Apple event. 23909 """ 23910 23911 def MacReopenApp(self): 23912 """ 23913 MacReopenApp() 23914 23915 Called in response of a "reopen-application" Apple event. 23916 """ 23917 23918 def OSXIsGUIApplication(self): 23919 """ 23920 OSXIsGUIApplication() -> bool 23921 23922 May be overridden to indicate that the application is not a foreground 23923 GUI application under OS X. 23924 """ 23925 23926 def GetDisplayMode(self): 23927 """ 23928 GetDisplayMode() -> VideoMode 23929 23930 Get display mode that is used use. 23931 """ 23932 23933 def GetExitOnFrameDelete(self): 23934 """ 23935 GetExitOnFrameDelete() -> bool 23936 23937 Returns true if the application will exit when the top-level frame is 23938 deleted. 23939 """ 23940 23941 def GetLayoutDirection(self): 23942 """ 23943 GetLayoutDirection() -> LayoutDirection 23944 23945 Return the layout direction for the current locale or wxLayout_Default 23946 if it's unknown. 23947 """ 23948 23949 def GetUseBestVisual(self): 23950 """ 23951 GetUseBestVisual() -> bool 23952 23953 Returns true if the application will use the best visual on systems 23954 that support different visuals, false otherwise. 23955 """ 23956 23957 def GetTopWindow(self): 23958 """ 23959 GetTopWindow() -> Window 23960 23961 Returns a pointer to the top window. 23962 """ 23963 23964 def IsActive(self): 23965 """ 23966 IsActive() -> bool 23967 23968 Returns true if the application is active, i.e. if one of its windows 23969 is currently in the foreground. 23970 """ 23971 23972 def SafeYield(self, win, onlyIfNeeded): 23973 """ 23974 SafeYield(win, onlyIfNeeded) -> bool 23975 23976 This function is similar to wxYield(), except that it disables the 23977 user input to all program windows before calling wxAppConsole::Yield 23978 and re-enables it again afterwards. 23979 """ 23980 23981 def SafeYieldFor(self, win, eventsToProcess): 23982 """ 23983 SafeYieldFor(win, eventsToProcess) -> bool 23984 23985 Works like SafeYield() with onlyIfNeeded == true except that it allows 23986 the caller to specify a mask of events to be processed. 23987 """ 23988 23989 def SetDisplayMode(self, info): 23990 """ 23991 SetDisplayMode(info) -> bool 23992 23993 Set display mode to use. 23994 """ 23995 23996 def SetExitOnFrameDelete(self, flag): 23997 """ 23998 SetExitOnFrameDelete(flag) 23999 24000 Allows the programmer to specify whether the application will exit 24001 when the top-level frame is deleted. 24002 """ 24003 24004 def SetNativeTheme(self, theme): 24005 """ 24006 SetNativeTheme(theme) -> bool 24007 24008 Allows runtime switching of the UI environment theme. 24009 """ 24010 24011 def SetTopWindow(self, window): 24012 """ 24013 SetTopWindow(window) 24014 24015 Sets the 'top' window. 24016 """ 24017 24018 def SetUseBestVisual(self, flag, forceTrueColour=False): 24019 """ 24020 SetUseBestVisual(flag, forceTrueColour=False) 24021 24022 Allows the programmer to specify whether the application will use the 24023 best visual on systems that support several visual on the same 24024 display. 24025 """ 24026 24027 def MacHideApp(self): 24028 """ 24029 MacHideApp() 24030 24031 Hide all application windows just as the user can do with the 24032 system Hide command. Mac only. 24033 """ 24034 24035 @staticmethod 24036 def GetComCtl32Version(): 24037 """ 24038 GetComCtl32Version() -> int 24039 24040 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if 24041 it wasn't found at all. Raises an exception on non-Windows platforms. 24042 """ 24043 24044 @staticmethod 24045 def GetShell32Version(): 24046 """ 24047 GetShell32Version() -> int 24048 24049 Returns 400, 470, 471, etc. for shell32.dll 4.00, 4.70, 4.71 or 0 if 24050 it wasn't found at all. Raises an exception on non-Windows platforms. 24051 """ 24052 24053 def GetAssertMode(self): 24054 """ 24055 GetAssertMode() -> AppAssertMode 24056 24057 Returns the current mode for how the application responds to wx 24058 asserts. 24059 """ 24060 24061 def SetAssertMode(self, AppAssertMode): 24062 """ 24063 SetAssertMode(AppAssertMode) 24064 24065 Set the mode indicating how the application responds to wx assertion 24066 statements. Valid settings are a combination of these flags: 24067 24068 - wx.APP_ASSERT_SUPPRESS 24069 - wx.APP_ASSERT_EXCEPTION 24070 - wx.APP_ASSERT_DIALOG 24071 - wx.APP_ASSERT_LOG 24072 24073 The default behavior is to raise a wx.wxAssertionError exception. 24074 """ 24075 24076 @staticmethod 24077 def IsDisplayAvailable(): 24078 """ 24079 IsDisplayAvailable() -> bool 24080 24081 Returns True if the application is able to connect to the system's 24082 display, or whatever the equivallent is for the platform. 24083 """ 24084 AssertMode = property(None, None) 24085 DisplayMode = property(None, None) 24086 ExitOnFrameDelete = property(None, None) 24087 LayoutDirection = property(None, None) 24088 UseBestVisual = property(None, None) 24089 TopWindow = property(None, None) 24090# end of class PyApp 24091 24092 24093def GetApp(): 24094 """ 24095 GetApp() -> AppConsole 24096 24097 Returns the current application object. 24098 """ 24099 24100def HandleFatalExceptions(doIt=True): 24101 """ 24102 HandleFatalExceptions(doIt=True) -> bool 24103 24104 If doIt is true, the fatal exceptions (also known as general 24105 protection faults under Windows or segmentation violations in the Unix 24106 world) will be caught and passed to wxApp::OnFatalException. 24107 """ 24108 24109def WakeUpIdle(): 24110 """ 24111 WakeUpIdle() 24112 24113 This function wakes up the (internal and platform dependent) idle 24114 system, i.e. 24115 """ 24116 24117def Yield(): 24118 """ 24119 Yield() -> bool 24120 24121 Calls wxAppConsole::Yield. 24122 """ 24123 24124def SafeYield(win=None, onlyIfNeeded=False): 24125 """ 24126 SafeYield(win=None, onlyIfNeeded=False) -> bool 24127 24128 Calls wxApp::SafeYield. 24129 """ 24130 24131def Exit(): 24132 """ 24133 Exit() 24134 24135 Exits application after calling wxApp::OnExit. 24136 """ 24137 24138def YieldIfNeeded(): 24139 """ 24140 Convenience function for wx.GetApp().Yield(True) 24141 """ 24142 pass 24143class PyOnDemandOutputWindow(object): 24144 """ 24145 A class that can be used for redirecting Python's stdout and 24146 stderr streams. It will do nothing until something is wrriten to 24147 the stream at which point it will create a Frame with a text area 24148 and write the text there. 24149 """ 24150 24151 def __init__(self, title="wxPython: stdout/stderr"): 24152 pass 24153 24154 def SetParent(self, parent): 24155 """ 24156 Set the window to be used as the popup Frame's parent. 24157 """ 24158 pass 24159 24160 def CreateOutputWindow(self, txt): 24161 pass 24162 24163 def OnCloseWindow(self, event): 24164 pass 24165 24166 def write(self, text): 24167 """ 24168 Create the output window if needed and write the string to it. 24169 If not called in the context of the gui thread then CallAfter is 24170 used to do the work there. 24171 """ 24172 pass 24173 24174 def close(self): 24175 pass 24176 24177 def flush(self): 24178 pass 24179class App(PyApp): 24180 """ 24181 The ``wx.App`` class represents the application and is used to: 24182 24183 * bootstrap the wxPython system and initialize the underlying 24184 gui toolkit 24185 * set and get application-wide properties 24186 * implement the native windowing system main message or event loop, 24187 and to dispatch events to window instances 24188 * etc. 24189 24190 Every wx application must have a single ``wx.App`` instance, and all 24191 creation of UI objects should be delayed until after the ``wx.App`` object 24192 has been created in order to ensure that the gui platform and wxWidgets 24193 have been fully initialized. 24194 24195 Normally you would derive from this class and implement an ``OnInit`` 24196 method that creates a frame and then calls ``self.SetTopWindow(frame)``, 24197 however ``wx.App`` is also usable on it's own without derivation. 24198 """ 24199 24200 outputWindowClass = PyOnDemandOutputWindow 24201 24202 def __init__(self, redirect=False, filename=None, useBestVisual=False, clearSigInt=True): 24203 """ 24204 Construct a ``wx.App`` object. 24205 24206 :param redirect: Should ``sys.stdout`` and ``sys.stderr`` be 24207 redirected? Defaults to False. If ``filename`` is None 24208 then output will be redirected to a window that pops up 24209 as needed. (You can control what kind of window is created 24210 for the output by resetting the class variable 24211 ``outputWindowClass`` to a class of your choosing.) 24212 24213 :param filename: The name of a file to redirect output to, if 24214 redirect is True. 24215 24216 :param useBestVisual: Should the app try to use the best 24217 available visual provided by the system (only relevant on 24218 systems that have more than one visual.) This parameter 24219 must be used instead of calling `SetUseBestVisual` later 24220 on because it must be set before the underlying GUI 24221 toolkit is initialized. 24222 24223 :param clearSigInt: Should SIGINT be cleared? This allows the 24224 app to terminate upon a Ctrl-C in the console like other 24225 GUI apps will. 24226 24227 :note: You should override OnInit to do application 24228 initialization to ensure that the system, toolkit and 24229 wxWidgets are fully initialized. 24230 """ 24231 pass 24232 24233 def OnPreInit(self): 24234 """ 24235 Things that must be done after _BootstrapApp has done its thing, but 24236 would be nice if they were already done by the time that OnInit is 24237 called. This can be overridden in derived classes, but be sure to call 24238 this method from there. 24239 """ 24240 pass 24241 24242 def __del__(self): 24243 pass 24244 24245 def SetTopWindow(self, frame): 24246 """ 24247 Set the "main" top level window, which will be used for the parent of 24248 the on-demand output window as well as for dialogs that do not have 24249 an explicit parent set. 24250 """ 24251 pass 24252 24253 def MainLoop(self): 24254 """ 24255 Execute the main GUI event loop 24256 """ 24257 pass 24258 24259 def RedirectStdio(self, filename=None): 24260 """ 24261 Redirect sys.stdout and sys.stderr to a file or a popup window. 24262 """ 24263 pass 24264 24265 def RestoreStdio(self): 24266 pass 24267 24268 def SetOutputWindowAttributes(self, title=None, pos=None, size=None): 24269 """ 24270 Set the title, position and/or size of the output window if the stdio 24271 has been redirected. This should be called before any output would 24272 cause the output window to be created. 24273 """ 24274 pass 24275 24276 def InitLocale(self): 24277 """ 24278 Try to ensure that the C and Python locale is in sync with wxWidgets locale. 24279 """ 24280 pass 24281 24282 def ResetLocale(self): 24283 """ 24284 Release the wx.Locale object created in :meth:`InitLocale`. 24285 This will reset the application's locale to the previous settings. 24286 """ 24287 pass 24288 24289 @staticmethod 24290 def Get(): 24291 """ 24292 A staticmethod returning the currently active application object. 24293 Essentially just a more pythonic version of :meth:`GetApp`. 24294 """ 24295 pass 24296@wx.deprecated 24297class PySimpleApp(App): 24298 """ 24299 This class is deprecated. Please use :class:`App` instead. 24300 """ 24301 24302 def __init__(self, *args, **kw): 24303 pass 24304#-- end-app --# 24305#-- begin-timer --# 24306TIMER_CONTINUOUS = 0 24307TIMER_ONE_SHOT = 0 24308wxEVT_TIMER = 0 24309 24310class Timer(EvtHandler): 24311 """ 24312 Timer() 24313 Timer(owner, id=-1) 24314 24315 The wxTimer class allows you to execute code at specified intervals. 24316 """ 24317 24318 def __init__(self, *args, **kw): 24319 """ 24320 Timer() 24321 Timer(owner, id=-1) 24322 24323 The wxTimer class allows you to execute code at specified intervals. 24324 """ 24325 24326 def GetId(self): 24327 """ 24328 GetId() -> int 24329 24330 Returns the ID of the events generated by this timer. 24331 """ 24332 24333 def GetInterval(self): 24334 """ 24335 GetInterval() -> int 24336 24337 Returns the current interval for the timer (in milliseconds). 24338 """ 24339 24340 def GetOwner(self): 24341 """ 24342 GetOwner() -> EvtHandler 24343 24344 Returns the current owner of the timer. 24345 """ 24346 24347 def IsOneShot(self): 24348 """ 24349 IsOneShot() -> bool 24350 24351 Returns true if the timer is one shot, i.e. if it will stop after 24352 firing the first notification automatically. 24353 """ 24354 24355 def IsRunning(self): 24356 """ 24357 IsRunning() -> bool 24358 24359 Returns true if the timer is running, false if it is stopped. 24360 """ 24361 24362 def Notify(self): 24363 """ 24364 Notify() 24365 24366 This member should be overridden by the user if the default 24367 constructor was used and SetOwner() wasn't called. 24368 """ 24369 24370 def SetOwner(self, owner, id=-1): 24371 """ 24372 SetOwner(owner, id=-1) 24373 24374 Associates the timer with the given owner object. 24375 """ 24376 24377 def Start(self, milliseconds=-1, oneShot=TIMER_CONTINUOUS): 24378 """ 24379 Start(milliseconds=-1, oneShot=TIMER_CONTINUOUS) -> bool 24380 24381 (Re)starts the timer. 24382 """ 24383 24384 def StartOnce(self, milliseconds=-1): 24385 """ 24386 StartOnce(milliseconds=-1) -> bool 24387 24388 Starts the timer for a once-only notification. 24389 """ 24390 24391 def Stop(self): 24392 """ 24393 Stop() 24394 24395 Stops the timer. 24396 """ 24397 Id = property(None, None) 24398 Interval = property(None, None) 24399 Owner = property(None, None) 24400# end of class Timer 24401 24402 24403class TimerRunner(object): 24404 """ 24405 TimerRunner(timer) 24406 TimerRunner(timer, milli, oneShot=False) 24407 24408 Starts the timer in its ctor, stops in the dtor. 24409 """ 24410 24411 def __init__(self, *args, **kw): 24412 """ 24413 TimerRunner(timer) 24414 TimerRunner(timer, milli, oneShot=False) 24415 24416 Starts the timer in its ctor, stops in the dtor. 24417 """ 24418 24419 def Start(self, milli, oneShot=False): 24420 """ 24421 Start(milli, oneShot=False) 24422 """ 24423# end of class TimerRunner 24424 24425 24426class TimerEvent(Event): 24427 """ 24428 TimerEvent() 24429 TimerEvent(timer) 24430 24431 wxTimerEvent object is passed to the event handler of timer events 24432 (see wxTimer::SetOwner). 24433 """ 24434 24435 def __init__(self, *args, **kw): 24436 """ 24437 TimerEvent() 24438 TimerEvent(timer) 24439 24440 wxTimerEvent object is passed to the event handler of timer events 24441 (see wxTimer::SetOwner). 24442 """ 24443 24444 def GetInterval(self): 24445 """ 24446 GetInterval() -> int 24447 24448 Returns the interval of the timer which generated this event. 24449 """ 24450 24451 def GetTimer(self): 24452 """ 24453 GetTimer() -> Timer 24454 24455 Returns the timer object which generated this event. 24456 """ 24457 Interval = property(None, None) 24458 Timer = property(None, None) 24459# end of class TimerEvent 24460 24461 24462EVT_TIMER = wx.PyEventBinder( wxEVT_TIMER ) 24463 24464class PyTimer(Timer): 24465 '''This timer class is passed the callable object to be called when the timer expires.''' 24466 def __init__(self, notify): 24467 Timer.__init__(self) 24468 self.notify = notify 24469 24470 def Notify(self): 24471 if self.notify: 24472 self.notify() 24473#-- end-timer --# 24474#-- begin-window --# 24475SHOW_EFFECT_NONE = 0 24476SHOW_EFFECT_ROLL_TO_LEFT = 0 24477SHOW_EFFECT_ROLL_TO_RIGHT = 0 24478SHOW_EFFECT_ROLL_TO_TOP = 0 24479SHOW_EFFECT_ROLL_TO_BOTTOM = 0 24480SHOW_EFFECT_SLIDE_TO_LEFT = 0 24481SHOW_EFFECT_SLIDE_TO_RIGHT = 0 24482SHOW_EFFECT_SLIDE_TO_TOP = 0 24483SHOW_EFFECT_SLIDE_TO_BOTTOM = 0 24484SHOW_EFFECT_BLEND = 0 24485SHOW_EFFECT_EXPAND = 0 24486SHOW_EFFECT_MAX = 0 24487SEND_EVENT_POST = 0 24488WINDOW_VARIANT_NORMAL = 0 24489WINDOW_VARIANT_SMALL = 0 24490WINDOW_VARIANT_MINI = 0 24491WINDOW_VARIANT_LARGE = 0 24492WINDOW_VARIANT_MAX = 0 24493 24494class VisualAttributes(object): 24495 """ 24496 Struct containing all the visual attributes of a control. 24497 """ 24498 font = property(None, None) 24499 colFg = property(None, None) 24500 colBg = property(None, None) 24501# end of class VisualAttributes 24502 24503PanelNameStr = "" 24504 24505class WindowBase(EvtHandler): 24506 """ 24507 24508 """ 24509 24510 def AddChild(self, child): 24511 """ 24512 AddChild(child) 24513 """ 24514 24515 def RemoveChild(self, child): 24516 """ 24517 RemoveChild(child) 24518 """ 24519# end of class WindowBase 24520 24521 24522class Window(WindowBase): 24523 """ 24524 Window() 24525 Window(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=PanelNameStr) 24526 24527 wxWindow is the base class for all windows and represents any visible 24528 object on screen. 24529 """ 24530 24531 class ChildrenRepositioningGuard(object): 24532 """ 24533 ChildrenRepositioningGuard(win) 24534 24535 Helper for ensuring EndRepositioningChildren() is called correctly. 24536 """ 24537 24538 def __init__(self, win): 24539 """ 24540 ChildrenRepositioningGuard(win) 24541 24542 Helper for ensuring EndRepositioningChildren() is called correctly. 24543 """ 24544 # end of class ChildrenRepositioningGuard 24545 24546 24547 def __init__(self, *args, **kw): 24548 """ 24549 Window() 24550 Window(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=PanelNameStr) 24551 24552 wxWindow is the base class for all windows and represents any visible 24553 object on screen. 24554 """ 24555 24556 def AcceptsFocus(self): 24557 """ 24558 AcceptsFocus() -> bool 24559 24560 This method may be overridden in the derived classes to return false 24561 to indicate that this control doesn't accept input at all (i.e. 24562 behaves like e.g. wxStaticText) and so doesn't need focus. 24563 """ 24564 24565 def AcceptsFocusFromKeyboard(self): 24566 """ 24567 AcceptsFocusFromKeyboard() -> bool 24568 24569 This method may be overridden in the derived classes to return false 24570 to indicate that while this control can, in principle, have focus if 24571 the user clicks it with the mouse, it shouldn't be included in the TAB 24572 traversal chain when using the keyboard. 24573 """ 24574 24575 def AcceptsFocusRecursively(self): 24576 """ 24577 AcceptsFocusRecursively() -> bool 24578 24579 Overridden to indicate whether this window or one of its children 24580 accepts focus. 24581 """ 24582 24583 def IsFocusable(self): 24584 """ 24585 IsFocusable() -> bool 24586 24587 Can this window itself have focus? 24588 """ 24589 24590 def CanAcceptFocus(self): 24591 """ 24592 CanAcceptFocus() -> bool 24593 24594 Can this window have focus right now? 24595 """ 24596 24597 def CanAcceptFocusFromKeyboard(self): 24598 """ 24599 CanAcceptFocusFromKeyboard() -> bool 24600 24601 Can this window be assigned focus from keyboard right now? 24602 """ 24603 24604 def HasFocus(self): 24605 """ 24606 HasFocus() -> bool 24607 24608 Returns true if the window (or in case of composite controls, its main 24609 child window) has focus. 24610 """ 24611 24612 def SetCanFocus(self, canFocus): 24613 """ 24614 SetCanFocus(canFocus) 24615 24616 This method is only implemented by ports which have support for native 24617 TAB traversal (such as GTK+ 2.0). 24618 """ 24619 24620 def SetFocus(self): 24621 """ 24622 SetFocus() 24623 24624 This sets the window to receive keyboard input. 24625 """ 24626 24627 def SetFocusFromKbd(self): 24628 """ 24629 SetFocusFromKbd() 24630 24631 This function is called by wxWidgets keyboard navigation code when the 24632 user gives the focus to this window from keyboard (e.g. 24633 """ 24634 24635 def AddChild(self, child): 24636 """ 24637 AddChild(child) 24638 24639 Adds a child window. 24640 """ 24641 24642 def DestroyChildren(self): 24643 """ 24644 DestroyChildren() -> bool 24645 24646 Destroys all children of a window. 24647 """ 24648 24649 def FindWindow(self, *args, **kw): 24650 """ 24651 FindWindow(id) -> Window 24652 FindWindow(name) -> Window 24653 24654 Find a child of this window, by id. 24655 """ 24656 24657 def GetChildren(self): 24658 """ 24659 GetChildren() -> WindowList 24660 24661 Returns a reference to the list of the window's children. 24662 """ 24663 24664 def RemoveChild(self, child): 24665 """ 24666 RemoveChild(child) 24667 24668 Removes a child window. 24669 """ 24670 24671 def GetGrandParent(self): 24672 """ 24673 GetGrandParent() -> Window 24674 24675 Returns the grandparent of a window, or NULL if there isn't one. 24676 """ 24677 24678 def GetNextSibling(self): 24679 """ 24680 GetNextSibling() -> Window 24681 24682 Returns the next window after this one among the parent's children or 24683 NULL if this window is the last child. 24684 """ 24685 24686 def GetParent(self): 24687 """ 24688 GetParent() -> Window 24689 24690 Returns the parent of the window, or NULL if there is no parent. 24691 """ 24692 24693 def GetPrevSibling(self): 24694 """ 24695 GetPrevSibling() -> Window 24696 24697 Returns the previous window before this one among the parent's 24698 children or NULL if this window is the first child. 24699 """ 24700 24701 def IsDescendant(self, win): 24702 """ 24703 IsDescendant(win) -> bool 24704 24705 Check if the specified window is a descendant of this one. 24706 """ 24707 24708 def Reparent(self, newParent): 24709 """ 24710 Reparent(newParent) -> bool 24711 24712 Reparents the window, i.e. the window will be removed from its current 24713 parent window (e.g. 24714 """ 24715 24716 def AlwaysShowScrollbars(self, hflag=True, vflag=True): 24717 """ 24718 AlwaysShowScrollbars(hflag=True, vflag=True) 24719 24720 Call this function to force one or both scrollbars to be always shown, 24721 even if the window is big enough to show its entire contents without 24722 scrolling. 24723 """ 24724 24725 def GetScrollPos(self, orientation): 24726 """ 24727 GetScrollPos(orientation) -> int 24728 24729 Returns the built-in scrollbar position. 24730 """ 24731 24732 def GetScrollRange(self, orientation): 24733 """ 24734 GetScrollRange(orientation) -> int 24735 24736 Returns the built-in scrollbar range. 24737 """ 24738 24739 def GetScrollThumb(self, orientation): 24740 """ 24741 GetScrollThumb(orientation) -> int 24742 24743 Returns the built-in scrollbar thumb size. 24744 """ 24745 24746 def CanScroll(self, orient): 24747 """ 24748 CanScroll(orient) -> bool 24749 24750 Returns true if this window can have a scroll bar in this orientation. 24751 """ 24752 24753 def HasScrollbar(self, orient): 24754 """ 24755 HasScrollbar(orient) -> bool 24756 24757 Returns true if this window currently has a scroll bar for this 24758 orientation. 24759 """ 24760 24761 def IsScrollbarAlwaysShown(self, orient): 24762 """ 24763 IsScrollbarAlwaysShown(orient) -> bool 24764 24765 Return whether a scrollbar is always shown. 24766 """ 24767 24768 def ScrollLines(self, lines): 24769 """ 24770 ScrollLines(lines) -> bool 24771 24772 Scrolls the window by the given number of lines down (if lines is 24773 positive) or up. 24774 """ 24775 24776 def ScrollPages(self, pages): 24777 """ 24778 ScrollPages(pages) -> bool 24779 24780 Scrolls the window by the given number of pages down (if pages is 24781 positive) or up. 24782 """ 24783 24784 def ScrollWindow(self, dx, dy, rect=None): 24785 """ 24786 ScrollWindow(dx, dy, rect=None) 24787 24788 Physically scrolls the pixels in the window and move child windows 24789 accordingly. 24790 """ 24791 24792 def LineUp(self): 24793 """ 24794 LineUp() -> bool 24795 24796 Same as ScrollLines (-1). 24797 """ 24798 24799 def LineDown(self): 24800 """ 24801 LineDown() -> bool 24802 24803 Same as ScrollLines (1). 24804 """ 24805 24806 def PageUp(self): 24807 """ 24808 PageUp() -> bool 24809 24810 Same as ScrollPages (-1). 24811 """ 24812 24813 def PageDown(self): 24814 """ 24815 PageDown() -> bool 24816 24817 Same as ScrollPages (1). 24818 """ 24819 24820 def SetScrollPos(self, orientation, pos, refresh=True): 24821 """ 24822 SetScrollPos(orientation, pos, refresh=True) 24823 24824 Sets the position of one of the built-in scrollbars. 24825 """ 24826 24827 def SetScrollbar(self, orientation, position, thumbSize, range, refresh=True): 24828 """ 24829 SetScrollbar(orientation, position, thumbSize, range, refresh=True) 24830 24831 Sets the scrollbar properties of a built-in scrollbar. 24832 """ 24833 24834 def BeginRepositioningChildren(self): 24835 """ 24836 BeginRepositioningChildren() -> bool 24837 24838 Prepare for changing positions of multiple child windows. 24839 """ 24840 24841 def EndRepositioningChildren(self): 24842 """ 24843 EndRepositioningChildren() 24844 24845 Fix child window positions after setting all of them at once. 24846 """ 24847 24848 def CacheBestSize(self, size): 24849 """ 24850 CacheBestSize(size) 24851 24852 Sets the cached best size value. 24853 """ 24854 24855 def ClientToWindowSize(self, size): 24856 """ 24857 ClientToWindowSize(size) -> Size 24858 24859 Converts client area size size to corresponding window size. 24860 """ 24861 24862 def WindowToClientSize(self, size): 24863 """ 24864 WindowToClientSize(size) -> Size 24865 24866 Converts window size size to corresponding client area size In other 24867 words, the returned value is what would GetClientSize() return if this 24868 window had given window size. 24869 """ 24870 24871 def Fit(self): 24872 """ 24873 Fit() 24874 24875 Sizes the window so that it fits around its subwindows. 24876 """ 24877 24878 def FitInside(self): 24879 """ 24880 FitInside() 24881 24882 Similar to Fit(), but sizes the interior (virtual) size of a window. 24883 """ 24884 24885 def GetBestSize(self): 24886 """ 24887 GetBestSize() -> Size 24888 24889 This functions returns the best acceptable minimal size for the 24890 window. 24891 """ 24892 24893 def GetBestHeight(self, width): 24894 """ 24895 GetBestHeight(width) -> int 24896 24897 Returns the best height needed by this window if it had the given 24898 width. 24899 """ 24900 24901 def GetBestWidth(self, height): 24902 """ 24903 GetBestWidth(height) -> int 24904 24905 Returns the best width needed by this window if it had the given 24906 height. 24907 """ 24908 24909 def GetClientSize(self): 24910 """ 24911 GetClientSize() -> Size 24912 24913 Returns the size of the window 'client area' in pixels. 24914 """ 24915 24916 def GetEffectiveMinSize(self): 24917 """ 24918 GetEffectiveMinSize() -> Size 24919 24920 Merges the window's best size into the min size and returns the 24921 result. 24922 """ 24923 24924 def GetMaxClientSize(self): 24925 """ 24926 GetMaxClientSize() -> Size 24927 24928 Returns the maximum size of window's client area. 24929 """ 24930 24931 def GetMaxSize(self): 24932 """ 24933 GetMaxSize() -> Size 24934 24935 Returns the maximum size of the window. 24936 """ 24937 24938 def GetMinClientSize(self): 24939 """ 24940 GetMinClientSize() -> Size 24941 24942 Returns the minimum size of window's client area, an indication to the 24943 sizer layout mechanism that this is the minimum required size of its 24944 client area. 24945 """ 24946 24947 def GetMinSize(self): 24948 """ 24949 GetMinSize() -> Size 24950 24951 Returns the minimum size of the window, an indication to the sizer 24952 layout mechanism that this is the minimum required size. 24953 """ 24954 24955 def GetMinWidth(self): 24956 """ 24957 GetMinWidth() -> int 24958 24959 Returns the horizontal component of window minimal size. 24960 """ 24961 24962 def GetMinHeight(self): 24963 """ 24964 GetMinHeight() -> int 24965 24966 Returns the vertical component of window minimal size. 24967 """ 24968 24969 def GetMaxWidth(self): 24970 """ 24971 GetMaxWidth() -> int 24972 24973 Returns the horizontal component of window maximal size. 24974 """ 24975 24976 def GetMaxHeight(self): 24977 """ 24978 GetMaxHeight() -> int 24979 24980 Returns the vertical component of window maximal size. 24981 """ 24982 24983 def GetSize(self): 24984 """ 24985 GetSize() -> Size 24986 24987 Returns the size of the entire window in pixels, including title bar, 24988 border, scrollbars, etc. 24989 """ 24990 24991 def GetVirtualSize(self): 24992 """ 24993 GetVirtualSize() -> Size 24994 24995 This gets the virtual size of the window in pixels. 24996 """ 24997 24998 def GetBestVirtualSize(self): 24999 """ 25000 GetBestVirtualSize() -> Size 25001 25002 Return the largest of ClientSize and BestSize (as determined by a 25003 sizer, interior children, or other means) 25004 """ 25005 25006 def GetContentScaleFactor(self): 25007 """ 25008 GetContentScaleFactor() -> double 25009 25010 Returns the magnification of the backing store of this window, eg 2.0 25011 for a window on a retina screen. 25012 """ 25013 25014 def GetWindowBorderSize(self): 25015 """ 25016 GetWindowBorderSize() -> Size 25017 25018 Returns the size of the left/right and top/bottom borders of this 25019 window in x and y components of the result respectively. 25020 """ 25021 25022 def InformFirstDirection(self, direction, size, availableOtherDir): 25023 """ 25024 InformFirstDirection(direction, size, availableOtherDir) -> bool 25025 25026 wxSizer and friends use this to give a chance to a component to recalc 25027 its min size once one of the final size components is known. 25028 """ 25029 25030 def InvalidateBestSize(self): 25031 """ 25032 InvalidateBestSize() 25033 25034 Resets the cached best size value so it will be recalculated the next 25035 time it is needed. 25036 """ 25037 25038 def PostSizeEvent(self): 25039 """ 25040 PostSizeEvent() 25041 25042 Posts a size event to the window. 25043 """ 25044 25045 def PostSizeEventToParent(self): 25046 """ 25047 PostSizeEventToParent() 25048 25049 Posts a size event to the parent of this window. 25050 """ 25051 25052 def SendSizeEvent(self, flags=0): 25053 """ 25054 SendSizeEvent(flags=0) 25055 25056 This function sends a dummy size event to the window allowing it to 25057 re-layout its children positions. 25058 """ 25059 25060 def SendSizeEventToParent(self, flags=0): 25061 """ 25062 SendSizeEventToParent(flags=0) 25063 25064 Safe wrapper for GetParent()->SendSizeEvent(). 25065 """ 25066 25067 def SetClientSize(self, *args, **kw): 25068 """ 25069 SetClientSize(width, height) 25070 SetClientSize(size) 25071 SetClientSize(rect) 25072 25073 This sets the size of the window client area in pixels. 25074 """ 25075 25076 def SetContainingSizer(self, sizer): 25077 """ 25078 SetContainingSizer(sizer) 25079 25080 This normally does not need to be called by user code. 25081 """ 25082 25083 def SetInitialSize(self, size=DefaultSize): 25084 """ 25085 SetInitialSize(size=DefaultSize) 25086 25087 A smart SetSize that will fill in default size components with the 25088 window's best size values. 25089 """ 25090 25091 def SetMaxClientSize(self, size): 25092 """ 25093 SetMaxClientSize(size) 25094 25095 Sets the maximum client size of the window, to indicate to the sizer 25096 layout mechanism that this is the maximum possible size of its client 25097 area. 25098 """ 25099 25100 def SetMaxSize(self, size): 25101 """ 25102 SetMaxSize(size) 25103 25104 Sets the maximum size of the window, to indicate to the sizer layout 25105 mechanism that this is the maximum possible size. 25106 """ 25107 25108 def SetMinClientSize(self, size): 25109 """ 25110 SetMinClientSize(size) 25111 25112 Sets the minimum client size of the window, to indicate to the sizer 25113 layout mechanism that this is the minimum required size of window's 25114 client area. 25115 """ 25116 25117 def SetMinSize(self, size): 25118 """ 25119 SetMinSize(size) 25120 25121 Sets the minimum size of the window, to indicate to the sizer layout 25122 mechanism that this is the minimum required size. 25123 """ 25124 25125 def SetSize(self, *args, **kw): 25126 """ 25127 SetSize(x, y, width, height, sizeFlags=SIZE_AUTO) 25128 SetSize(rect) 25129 SetSize(size) 25130 SetSize(width, height) 25131 25132 Sets the size of the window in pixels. 25133 """ 25134 25135 def SetSizeHints(self, *args, **kw): 25136 """ 25137 SetSizeHints(minSize, maxSize=DefaultSize, incSize=DefaultSize) 25138 SetSizeHints(minW, minH, maxW=-1, maxH=-1, incW=-1, incH=-1) 25139 25140 Use of this function for windows which are not toplevel windows (such 25141 as wxDialog or wxFrame) is discouraged. 25142 """ 25143 25144 def SetVirtualSize(self, *args, **kw): 25145 """ 25146 SetVirtualSize(width, height) 25147 SetVirtualSize(size) 25148 25149 Sets the virtual size of the window in pixels. 25150 """ 25151 25152 def Center(self, dir=BOTH): 25153 """ 25154 Center(dir=BOTH) 25155 25156 A synonym for Centre(). 25157 """ 25158 25159 def CenterOnParent(self, dir=BOTH): 25160 """ 25161 CenterOnParent(dir=BOTH) 25162 25163 A synonym for CentreOnParent(). 25164 """ 25165 25166 def Centre(self, direction=BOTH): 25167 """ 25168 Centre(direction=BOTH) 25169 25170 Centres the window. 25171 """ 25172 25173 def CentreOnParent(self, direction=BOTH): 25174 """ 25175 CentreOnParent(direction=BOTH) 25176 25177 Centres the window on its parent. 25178 """ 25179 25180 def GetPosition(self): 25181 """ 25182 GetPosition() -> Point 25183 25184 This gets the position of the window in pixels, relative to the parent 25185 window for the child windows or relative to the display origin for the 25186 top level windows. 25187 """ 25188 25189 def GetRect(self): 25190 """ 25191 GetRect() -> Rect 25192 25193 Returns the position and size of the window as a wxRect object. 25194 """ 25195 25196 def GetScreenPosition(self): 25197 """ 25198 GetScreenPosition() -> Point 25199 25200 Returns the window position in screen coordinates, whether the window 25201 is a child window or a top level one. 25202 """ 25203 25204 def GetScreenRect(self): 25205 """ 25206 GetScreenRect() -> Rect 25207 25208 Returns the position and size of the window on the screen as a wxRect 25209 object. 25210 """ 25211 25212 def GetClientAreaOrigin(self): 25213 """ 25214 GetClientAreaOrigin() -> Point 25215 25216 Get the origin of the client area of the window relative to the window 25217 top left corner (the client area may be shifted because of the 25218 borders, scrollbars, other decorations...) 25219 """ 25220 25221 def GetClientRect(self): 25222 """ 25223 GetClientRect() -> Rect 25224 25225 Get the client rectangle in window (i.e. client) coordinates. 25226 """ 25227 25228 def Move(self, *args, **kw): 25229 """ 25230 Move(x, y, flags=SIZE_USE_EXISTING) 25231 Move(pt, flags=SIZE_USE_EXISTING) 25232 25233 Moves the window to the given position. 25234 """ 25235 25236 def SetPosition(self, pt): 25237 """ 25238 SetPosition(pt) 25239 25240 Moves the window to the specified position. 25241 """ 25242 25243 def ClientToScreen(self, *args, **kw): 25244 """ 25245 ClientToScreen(x, y) -> (x, y) 25246 ClientToScreen(pt) -> Point 25247 25248 Converts to screen coordinates from coordinates relative to this 25249 window. 25250 """ 25251 25252 def ConvertDialogToPixels(self, *args, **kw): 25253 """ 25254 ConvertDialogToPixels(pt) -> Point 25255 ConvertDialogToPixels(sz) -> Size 25256 25257 Converts a point or size from dialog units to pixels. 25258 """ 25259 25260 def ConvertPixelsToDialog(self, *args, **kw): 25261 """ 25262 ConvertPixelsToDialog(pt) -> Point 25263 ConvertPixelsToDialog(sz) -> Size 25264 25265 Converts a point or size from pixels to dialog units. 25266 """ 25267 25268 def ScreenToClient(self, *args, **kw): 25269 """ 25270 ScreenToClient(x, y) -> (x, y) 25271 ScreenToClient(pt) -> Point 25272 25273 Converts from screen to client window coordinates. 25274 """ 25275 25276 def ClearBackground(self): 25277 """ 25278 ClearBackground() 25279 25280 Clears the window by filling it with the current background colour. 25281 """ 25282 25283 def Freeze(self): 25284 """ 25285 Freeze() 25286 25287 Freezes the window or, in other words, prevents any updates from 25288 taking place on screen, the window is not redrawn at all. 25289 """ 25290 25291 def Thaw(self): 25292 """ 25293 Thaw() 25294 25295 Re-enables window updating after a previous call to Freeze(). 25296 """ 25297 25298 def IsFrozen(self): 25299 """ 25300 IsFrozen() -> bool 25301 25302 Returns true if the window is currently frozen by a call to Freeze(). 25303 """ 25304 25305 def GetBackgroundColour(self): 25306 """ 25307 GetBackgroundColour() -> Colour 25308 25309 Returns the background colour of the window. 25310 """ 25311 25312 def GetBackgroundStyle(self): 25313 """ 25314 GetBackgroundStyle() -> BackgroundStyle 25315 25316 Returns the background style of the window. 25317 """ 25318 25319 def GetCharHeight(self): 25320 """ 25321 GetCharHeight() -> int 25322 25323 Returns the character height for this window. 25324 """ 25325 25326 def GetCharWidth(self): 25327 """ 25328 GetCharWidth() -> int 25329 25330 Returns the average character width for this window. 25331 """ 25332 25333 def GetDefaultAttributes(self): 25334 """ 25335 GetDefaultAttributes() -> VisualAttributes 25336 25337 Currently this is the same as calling 25338 wxWindow::GetClassDefaultAttributes(wxWindow::GetWindowVariant()). 25339 """ 25340 25341 def GetFont(self): 25342 """ 25343 GetFont() -> Font 25344 25345 Returns the font for this window. 25346 """ 25347 25348 def GetForegroundColour(self): 25349 """ 25350 GetForegroundColour() -> Colour 25351 25352 Returns the foreground colour of the window. 25353 """ 25354 25355 def GetFullTextExtent(self, *args, **kw): 25356 """ 25357 GetFullTextExtent(string, font=None) -> (w, h, descent, externalLeading) 25358 GetTextExtent(string) -> Size 25359 25360 Gets the dimensions of the string as it would be drawn on the window 25361 with the currently selected font. 25362 """ 25363 25364 def GetUpdateRegion(self): 25365 """ 25366 GetUpdateRegion() -> Region 25367 25368 Returns the region specifying which parts of the window have been 25369 damaged. 25370 """ 25371 25372 def GetUpdateClientRect(self): 25373 """ 25374 GetUpdateClientRect() -> Rect 25375 25376 Get the update rectangle bounding box in client coords. 25377 """ 25378 25379 def HasTransparentBackground(self): 25380 """ 25381 HasTransparentBackground() -> bool 25382 25383 Returns true if this window background is transparent (as, for 25384 example, for wxStaticText) and should show the parent window 25385 background. 25386 """ 25387 25388 def Refresh(self, eraseBackground=True, rect=None): 25389 """ 25390 Refresh(eraseBackground=True, rect=None) 25391 25392 Causes this window, and all of its children recursively (except under 25393 wxGTK1 where this is not implemented), to be repainted. 25394 """ 25395 25396 def RefreshRect(self, rect, eraseBackground=True): 25397 """ 25398 RefreshRect(rect, eraseBackground=True) 25399 25400 Redraws the contents of the given rectangle: only the area inside it 25401 will be repainted. 25402 """ 25403 25404 def Update(self): 25405 """ 25406 Update() 25407 25408 Calling this method immediately repaints the invalidated area of the 25409 window and all of its children recursively (this normally only happens 25410 when the flow of control returns to the event loop). 25411 """ 25412 25413 def SetBackgroundColour(self, colour): 25414 """ 25415 SetBackgroundColour(colour) -> bool 25416 25417 Sets the background colour of the window. 25418 """ 25419 25420 def SetBackgroundStyle(self, style): 25421 """ 25422 SetBackgroundStyle(style) -> bool 25423 25424 Sets the background style of the window. 25425 """ 25426 25427 def IsTransparentBackgroundSupported(self, reason=None): 25428 """ 25429 IsTransparentBackgroundSupported(reason=None) -> bool 25430 25431 Checks whether using transparent background might work. 25432 """ 25433 25434 def SetFont(self, font): 25435 """ 25436 SetFont(font) -> bool 25437 25438 Sets the font for this window. 25439 """ 25440 25441 def SetForegroundColour(self, colour): 25442 """ 25443 SetForegroundColour(colour) -> bool 25444 25445 Sets the foreground colour of the window. 25446 """ 25447 25448 def SetOwnBackgroundColour(self, colour): 25449 """ 25450 SetOwnBackgroundColour(colour) 25451 25452 Sets the background colour of the window but prevents it from being 25453 inherited by the children of this window. 25454 """ 25455 25456 def InheritsBackgroundColour(self): 25457 """ 25458 InheritsBackgroundColour() -> bool 25459 25460 Return true if this window inherits the background colour from its 25461 parent. 25462 """ 25463 25464 def UseBgCol(self): 25465 """ 25466 UseBgCol() -> bool 25467 25468 Return true if a background colour has been set for this window. 25469 """ 25470 25471 def SetOwnFont(self, font): 25472 """ 25473 SetOwnFont(font) 25474 25475 Sets the font of the window but prevents it from being inherited by 25476 the children of this window. 25477 """ 25478 25479 def SetOwnForegroundColour(self, colour): 25480 """ 25481 SetOwnForegroundColour(colour) 25482 25483 Sets the foreground colour of the window but prevents it from being 25484 inherited by the children of this window. 25485 """ 25486 25487 def SetPalette(self, pal): 25488 """ 25489 SetPalette(pal) 25490 """ 25491 25492 def ShouldInheritColours(self): 25493 """ 25494 ShouldInheritColours() -> bool 25495 25496 Return true from here to allow the colours of this window to be 25497 changed by InheritAttributes(). 25498 """ 25499 25500 def SetThemeEnabled(self, enable): 25501 """ 25502 SetThemeEnabled(enable) 25503 25504 This function tells a window if it should use the system's "theme" 25505 code to draw the windows' background instead of its own background 25506 drawing code. 25507 """ 25508 25509 def GetThemeEnabled(self): 25510 """ 25511 GetThemeEnabled() -> bool 25512 25513 Clears the window by filling it with the current background colour. 25514 """ 25515 25516 def CanSetTransparent(self): 25517 """ 25518 CanSetTransparent() -> bool 25519 25520 Returns true if the system supports transparent windows and calling 25521 SetTransparent() may succeed. 25522 """ 25523 25524 def SetTransparent(self, alpha): 25525 """ 25526 SetTransparent(alpha) -> bool 25527 25528 Set the transparency of the window. 25529 """ 25530 25531 def GetEventHandler(self): 25532 """ 25533 GetEventHandler() -> EvtHandler 25534 25535 Returns the event handler for this window. 25536 """ 25537 25538 def HandleAsNavigationKey(self, event): 25539 """ 25540 HandleAsNavigationKey(event) -> bool 25541 25542 This function will generate the appropriate call to Navigate() if the 25543 key event is one normally used for keyboard navigation and return true 25544 in this case. 25545 """ 25546 25547 def HandleWindowEvent(self, event): 25548 """ 25549 HandleWindowEvent(event) -> bool 25550 25551 Shorthand for: 25552 """ 25553 25554 def ProcessWindowEvent(self, event): 25555 """ 25556 ProcessWindowEvent(event) -> bool 25557 25558 Convenient wrapper for ProcessEvent(). 25559 """ 25560 25561 def ProcessWindowEventLocally(self, event): 25562 """ 25563 ProcessWindowEventLocally(event) -> bool 25564 25565 Wrapper for wxEvtHandler::ProcessEventLocally(). 25566 """ 25567 25568 def PopEventHandler(self, deleteHandler=False): 25569 """ 25570 PopEventHandler(deleteHandler=False) -> EvtHandler 25571 25572 Removes and returns the top-most event handler on the event handler 25573 stack. 25574 """ 25575 25576 def PushEventHandler(self, handler): 25577 """ 25578 PushEventHandler(handler) 25579 25580 Pushes this event handler onto the event stack for the window. 25581 """ 25582 25583 def RemoveEventHandler(self, handler): 25584 """ 25585 RemoveEventHandler(handler) -> bool 25586 25587 Find the given handler in the windows event handler stack and removes 25588 (but does not delete) it from the stack. 25589 """ 25590 25591 def SetEventHandler(self, handler): 25592 """ 25593 SetEventHandler(handler) 25594 25595 Sets the event handler for this window. 25596 """ 25597 25598 def SetNextHandler(self, handler): 25599 """ 25600 SetNextHandler(handler) 25601 25602 wxWindows cannot be used to form event handler chains; this function 25603 thus will assert when called. 25604 """ 25605 25606 def SetPreviousHandler(self, handler): 25607 """ 25608 SetPreviousHandler(handler) 25609 25610 wxWindows cannot be used to form event handler chains; this function 25611 thus will assert when called. 25612 """ 25613 25614 def GetExtraStyle(self): 25615 """ 25616 GetExtraStyle() -> long 25617 25618 Returns the extra style bits for the window. 25619 """ 25620 25621 def GetWindowStyleFlag(self): 25622 """ 25623 GetWindowStyleFlag() -> long 25624 25625 Gets the window style that was passed to the constructor or Create() 25626 method. 25627 """ 25628 25629 def GetWindowStyle(self): 25630 """ 25631 GetWindowStyle() -> long 25632 25633 See GetWindowStyleFlag() for more info. 25634 """ 25635 25636 def HasExtraStyle(self, exFlag): 25637 """ 25638 HasExtraStyle(exFlag) -> bool 25639 25640 Returns true if the window has the given exFlag bit set in its extra 25641 styles. 25642 """ 25643 25644 def HasFlag(self, flag): 25645 """ 25646 HasFlag(flag) -> bool 25647 25648 Returns true if the window has the given flag bit set. 25649 """ 25650 25651 def SetExtraStyle(self, exStyle): 25652 """ 25653 SetExtraStyle(exStyle) 25654 25655 Sets the extra style bits for the window. 25656 """ 25657 25658 def SetWindowStyleFlag(self, style): 25659 """ 25660 SetWindowStyleFlag(style) 25661 25662 Sets the style of the window. 25663 """ 25664 25665 def SetWindowStyle(self, style): 25666 """ 25667 SetWindowStyle(style) 25668 25669 See SetWindowStyleFlag() for more info. 25670 """ 25671 25672 def ToggleWindowStyle(self, flag): 25673 """ 25674 ToggleWindowStyle(flag) -> bool 25675 25676 Turns the given flag on if it's currently turned off and vice versa. 25677 """ 25678 25679 def MoveAfterInTabOrder(self, win): 25680 """ 25681 MoveAfterInTabOrder(win) 25682 25683 Moves this window in the tab navigation order after the specified win. 25684 """ 25685 25686 def MoveBeforeInTabOrder(self, win): 25687 """ 25688 MoveBeforeInTabOrder(win) 25689 25690 Same as MoveAfterInTabOrder() except that it inserts this window just 25691 before win instead of putting it right after it. 25692 """ 25693 25694 def Navigate(self, flags=NavigationKeyEvent.IsForward): 25695 """ 25696 Navigate(flags=NavigationKeyEvent.IsForward) -> bool 25697 25698 Performs a keyboard navigation action starting from this window. 25699 """ 25700 25701 def NavigateIn(self, flags=NavigationKeyEvent.IsForward): 25702 """ 25703 NavigateIn(flags=NavigationKeyEvent.IsForward) -> bool 25704 25705 Performs a keyboard navigation action inside this window. 25706 """ 25707 25708 def Lower(self): 25709 """ 25710 Lower() 25711 25712 Lowers the window to the bottom of the window hierarchy (Z-order). 25713 """ 25714 25715 def Raise(self): 25716 """ 25717 Raise() 25718 25719 Raises the window to the top of the window hierarchy (Z-order). 25720 """ 25721 25722 def Hide(self): 25723 """ 25724 Hide() -> bool 25725 25726 Equivalent to calling wxWindow::Show(false). 25727 """ 25728 25729 def HideWithEffect(self, effect, timeout=0): 25730 """ 25731 HideWithEffect(effect, timeout=0) -> bool 25732 25733 This function hides a window, like Hide(), but using a special visual 25734 effect if possible. 25735 """ 25736 25737 def IsEnabled(self): 25738 """ 25739 IsEnabled() -> bool 25740 25741 Returns true if the window is enabled, i.e. if it accepts user input, 25742 false otherwise. 25743 """ 25744 25745 def IsExposed(self, *args, **kw): 25746 """ 25747 IsExposed(x, y) -> bool 25748 IsExposed(pt) -> bool 25749 IsExposed(x, y, w, h) -> bool 25750 IsExposed(rect) -> bool 25751 25752 Returns true if the given point or rectangle area has been exposed 25753 since the last repaint. 25754 """ 25755 25756 def IsShown(self): 25757 """ 25758 IsShown() -> bool 25759 25760 Returns true if the window is shown, false if it has been hidden. 25761 """ 25762 25763 def IsShownOnScreen(self): 25764 """ 25765 IsShownOnScreen() -> bool 25766 25767 Returns true if the window is physically visible on the screen, i.e. 25768 it is shown and all its parents up to the toplevel window are shown as 25769 well. 25770 """ 25771 25772 def Disable(self): 25773 """ 25774 Disable() -> bool 25775 25776 Disables the window. 25777 """ 25778 25779 def Enable(self, enable=True): 25780 """ 25781 Enable(enable=True) -> bool 25782 25783 Enable or disable the window for user input. 25784 """ 25785 25786 def Show(self, show=True): 25787 """ 25788 Show(show=True) -> bool 25789 25790 Shows or hides the window. 25791 """ 25792 25793 def ShowWithEffect(self, effect, timeout=0): 25794 """ 25795 ShowWithEffect(effect, timeout=0) -> bool 25796 25797 This function shows a window, like Show(), but using a special visual 25798 effect if possible. 25799 """ 25800 25801 def GetHelpText(self): 25802 """ 25803 GetHelpText() -> String 25804 25805 Gets the help text to be used as context-sensitive help for this 25806 window. 25807 """ 25808 25809 def SetHelpText(self, helpText): 25810 """ 25811 SetHelpText(helpText) 25812 25813 Sets the help text to be used as context-sensitive help for this 25814 window. 25815 """ 25816 25817 def GetHelpTextAtPoint(self, point, origin): 25818 """ 25819 GetHelpTextAtPoint(point, origin) -> String 25820 25821 Gets the help text to be used as context-sensitive help for this 25822 window. 25823 """ 25824 25825 def GetToolTip(self): 25826 """ 25827 GetToolTip() -> ToolTip 25828 25829 Get the associated tooltip or NULL if none. 25830 """ 25831 25832 def GetToolTipText(self): 25833 """ 25834 GetToolTipText() -> String 25835 25836 Get the text of the associated tooltip or empty string if none. 25837 """ 25838 25839 def SetToolTip(self, *args, **kw): 25840 """ 25841 SetToolTip(tipString) 25842 SetToolTip(tip) 25843 25844 Attach a tooltip to the window. 25845 """ 25846 25847 def UnsetToolTip(self): 25848 """ 25849 UnsetToolTip() 25850 25851 Unset any existing tooltip. 25852 """ 25853 25854 def GetPopupMenuSelectionFromUser(self, *args, **kw): 25855 """ 25856 GetPopupMenuSelectionFromUser(menu, pos=DefaultPosition) -> int 25857 GetPopupMenuSelectionFromUser(menu, x, y) -> int 25858 25859 This function shows a popup menu at the given position in this window 25860 and returns the selected id. 25861 """ 25862 25863 def PopupMenu(self, *args, **kw): 25864 """ 25865 PopupMenu(menu, pos=DefaultPosition) -> bool 25866 PopupMenu(menu, x, y) -> bool 25867 25868 Pops up the given menu at the specified coordinates, relative to this 25869 window, and returns control when the user has dismissed the menu. 25870 """ 25871 25872 def GetValidator(self): 25873 """ 25874 GetValidator() -> Validator 25875 25876 Validator functions. 25877 """ 25878 25879 def SetValidator(self, validator): 25880 """ 25881 SetValidator(validator) 25882 25883 Deletes the current validator (if any) and sets the window validator, 25884 having called wxValidator::Clone to create a new validator of this 25885 type. 25886 """ 25887 25888 def TransferDataFromWindow(self): 25889 """ 25890 TransferDataFromWindow() -> bool 25891 25892 Transfers values from child controls to data areas specified by their 25893 validators. 25894 """ 25895 25896 def TransferDataToWindow(self): 25897 """ 25898 TransferDataToWindow() -> bool 25899 25900 Transfers values to child controls from data areas specified by their 25901 validators. 25902 """ 25903 25904 def Validate(self): 25905 """ 25906 Validate() -> bool 25907 25908 Validates the current values of the child controls using their 25909 validators. 25910 """ 25911 25912 def GetId(self): 25913 """ 25914 GetId() -> WindowID 25915 25916 Returns the identifier of the window. 25917 """ 25918 25919 def GetLabel(self): 25920 """ 25921 GetLabel() -> String 25922 25923 Generic way of getting a label from any window, for identification 25924 purposes. 25925 """ 25926 25927 def GetLayoutDirection(self): 25928 """ 25929 GetLayoutDirection() -> LayoutDirection 25930 25931 Returns the layout direction for this window, Note that 25932 wxLayout_Default is returned if layout direction is not supported. 25933 """ 25934 25935 def AdjustForLayoutDirection(self, x, width, widthTotal): 25936 """ 25937 AdjustForLayoutDirection(x, width, widthTotal) -> Coord 25938 25939 Mirror coordinates for RTL layout if this window uses it and if the 25940 mirroring is not done automatically like Win32. 25941 """ 25942 25943 def GetName(self): 25944 """ 25945 GetName() -> String 25946 25947 Returns the window's name. 25948 """ 25949 25950 def GetWindowVariant(self): 25951 """ 25952 GetWindowVariant() -> WindowVariant 25953 25954 Returns the value previously passed to SetWindowVariant(). 25955 """ 25956 25957 def SetId(self, winid): 25958 """ 25959 SetId(winid) 25960 25961 Sets the identifier of the window. 25962 """ 25963 25964 def SetLabel(self, label): 25965 """ 25966 SetLabel(label) 25967 25968 Sets the window's label. 25969 """ 25970 25971 def SetLayoutDirection(self, dir): 25972 """ 25973 SetLayoutDirection(dir) 25974 25975 Sets the layout direction for this window. 25976 """ 25977 25978 def SetName(self, name): 25979 """ 25980 SetName(name) 25981 25982 Sets the window's name. 25983 """ 25984 25985 def SetWindowVariant(self, variant): 25986 """ 25987 SetWindowVariant(variant) 25988 25989 Chooses a different variant of the window display to use. 25990 """ 25991 25992 def GetAcceleratorTable(self): 25993 """ 25994 GetAcceleratorTable() -> AcceleratorTable 25995 25996 Gets the accelerator table for this window. 25997 """ 25998 25999 def GetAccessible(self): 26000 """ 26001 GetAccessible() -> Accessible 26002 26003 Returns the accessible object for this window, if any. 26004 """ 26005 26006 def SetAcceleratorTable(self, accel): 26007 """ 26008 SetAcceleratorTable(accel) 26009 26010 Sets the accelerator table for this window. 26011 """ 26012 26013 def SetAccessible(self, accessible): 26014 """ 26015 SetAccessible(accessible) 26016 26017 Sets the accessible for this window. 26018 """ 26019 26020 def Close(self, force=False): 26021 """ 26022 Close(force=False) -> bool 26023 26024 This function simply generates a wxCloseEvent whose handler usually 26025 tries to close the window. 26026 """ 26027 26028 def Destroy(self): 26029 """ 26030 Destroy() -> bool 26031 26032 Destroys the window safely. 26033 """ 26034 26035 def IsBeingDeleted(self): 26036 """ 26037 IsBeingDeleted() -> bool 26038 26039 Returns true if this window is in process of being destroyed. 26040 """ 26041 26042 def GetDropTarget(self): 26043 """ 26044 GetDropTarget() -> DropTarget 26045 26046 Returns the associated drop target, which may be NULL. 26047 """ 26048 26049 def SetDropTarget(self, target): 26050 """ 26051 SetDropTarget(target) 26052 26053 Associates a drop target with this window. 26054 """ 26055 26056 def DragAcceptFiles(self, accept): 26057 """ 26058 DragAcceptFiles(accept) 26059 26060 Enables or disables eligibility for drop file events (OnDropFiles). 26061 """ 26062 26063 def GetContainingSizer(self): 26064 """ 26065 GetContainingSizer() -> Sizer 26066 26067 Returns the sizer of which this window is a member, if any, otherwise 26068 NULL. 26069 """ 26070 26071 def GetSizer(self): 26072 """ 26073 GetSizer() -> Sizer 26074 26075 Returns the sizer associated with the window by a previous call to 26076 SetSizer(), or NULL. 26077 """ 26078 26079 def SetSizer(self, sizer, deleteOld=True): 26080 """ 26081 SetSizer(sizer, deleteOld=True) 26082 26083 Sets the window to have the given layout sizer. 26084 """ 26085 26086 def SetSizerAndFit(self, sizer, deleteOld=True): 26087 """ 26088 SetSizerAndFit(sizer, deleteOld=True) 26089 26090 This method calls SetSizer() and then wxSizer::SetSizeHints which sets 26091 the initial window size to the size needed to accommodate all sizer 26092 elements and sets the size hints which, if this window is a top level 26093 one, prevent the user from resizing it to be less than this minimal 26094 size. 26095 """ 26096 26097 def GetConstraints(self): 26098 """ 26099 GetConstraints() -> LayoutConstraints 26100 26101 Returns a pointer to the window's layout constraints, or NULL if there 26102 are none. 26103 """ 26104 26105 def SetConstraints(self, constraints): 26106 """ 26107 SetConstraints(constraints) 26108 26109 Sets the window to have the given layout constraints. 26110 """ 26111 26112 def Layout(self): 26113 """ 26114 Layout() -> bool 26115 26116 Invokes the constraint-based layout algorithm or the sizer-based 26117 algorithm for this window. 26118 """ 26119 26120 def SetAutoLayout(self, autoLayout): 26121 """ 26122 SetAutoLayout(autoLayout) 26123 26124 Determines whether the Layout() function will be called automatically 26125 when the window is resized. 26126 """ 26127 26128 def GetAutoLayout(self): 26129 """ 26130 GetAutoLayout() -> bool 26131 26132 Returns the sizer of which this window is a member, if any, otherwise 26133 NULL. 26134 """ 26135 26136 def CaptureMouse(self): 26137 """ 26138 CaptureMouse() 26139 26140 Directs all mouse input to this window. 26141 """ 26142 26143 def GetCaret(self): 26144 """ 26145 GetCaret() -> Caret 26146 26147 Returns the caret() associated with the window. 26148 """ 26149 26150 def GetCursor(self): 26151 """ 26152 GetCursor() -> Cursor 26153 26154 Return the cursor associated with this window. 26155 """ 26156 26157 def HasCapture(self): 26158 """ 26159 HasCapture() -> bool 26160 26161 Returns true if this window has the current mouse capture. 26162 """ 26163 26164 def ReleaseMouse(self): 26165 """ 26166 ReleaseMouse() 26167 26168 Releases mouse input captured with CaptureMouse(). 26169 """ 26170 26171 def SetCaret(self, caret): 26172 """ 26173 SetCaret(caret) 26174 26175 Sets the caret() associated with the window. 26176 """ 26177 26178 def SetCursor(self, cursor): 26179 """ 26180 SetCursor(cursor) -> bool 26181 26182 Sets the window's cursor. 26183 """ 26184 26185 def WarpPointer(self, x, y): 26186 """ 26187 WarpPointer(x, y) 26188 26189 Moves the pointer to the given position on the window. 26190 """ 26191 26192 def HitTest(self, *args, **kw): 26193 """ 26194 HitTest(x, y) -> HitTest 26195 HitTest(pt) -> HitTest 26196 26197 Get the window border style from the given flags: this is different 26198 from simply doing flags & wxBORDER_MASK because it uses 26199 GetDefaultBorder() to translate wxBORDER_DEFAULT to something 26200 reasonable. 26201 """ 26202 26203 def GetBorder(self, *args, **kw): 26204 """ 26205 GetBorder(flags) -> Border 26206 GetBorder() -> Border 26207 26208 Get the window border style from the given flags: this is different 26209 from simply doing flags & wxBORDER_MASK because it uses 26210 GetDefaultBorder() to translate wxBORDER_DEFAULT to something 26211 reasonable. 26212 """ 26213 26214 def DoUpdateWindowUI(self, event): 26215 """ 26216 DoUpdateWindowUI(event) 26217 26218 Does the window-specific updating after processing the update event. 26219 """ 26220 26221 def GetHandle(self): 26222 """ 26223 GetHandle() -> UIntPtr 26224 26225 Returns the platform-specific handle of the physical window. 26226 """ 26227 26228 def HasMultiplePages(self): 26229 """ 26230 HasMultiplePages() -> bool 26231 26232 This method should be overridden to return true if this window has 26233 multiple pages. 26234 """ 26235 26236 def InheritAttributes(self): 26237 """ 26238 InheritAttributes() 26239 26240 This function is (or should be, in case of custom controls) called 26241 during window creation to intelligently set up the window visual 26242 attributes, that is the font and the foreground and background 26243 colours. 26244 """ 26245 26246 def InitDialog(self): 26247 """ 26248 InitDialog() 26249 26250 Sends an wxEVT_INIT_DIALOG event, whose handler usually transfers data 26251 to the dialog via validators. 26252 """ 26253 26254 def IsDoubleBuffered(self): 26255 """ 26256 IsDoubleBuffered() -> bool 26257 26258 Returns true if the window contents is double-buffered by the system, 26259 i.e. if any drawing done on the window is really done on a temporary 26260 backing surface and transferred to the screen all at once later. 26261 """ 26262 26263 def SetDoubleBuffered(self, on): 26264 """ 26265 SetDoubleBuffered(on) 26266 26267 Turn on or off double buffering of the window if the system supports 26268 it. 26269 """ 26270 26271 def IsRetained(self): 26272 """ 26273 IsRetained() -> bool 26274 26275 Returns true if the window is retained, false otherwise. 26276 """ 26277 26278 def IsThisEnabled(self): 26279 """ 26280 IsThisEnabled() -> bool 26281 26282 Returns true if this window is intrinsically enabled, false otherwise, 26283 i.e. if Enable() Enable(false) had been called. 26284 """ 26285 26286 def IsTopLevel(self): 26287 """ 26288 IsTopLevel() -> bool 26289 26290 Returns true if the given window is a top-level one. 26291 """ 26292 26293 def OnInternalIdle(self): 26294 """ 26295 OnInternalIdle() 26296 26297 This virtual function is normally only used internally, but sometimes 26298 an application may need it to implement functionality that should not 26299 be disabled by an application defining an OnIdle handler in a derived 26300 class. 26301 """ 26302 26303 def SendIdleEvents(self, event): 26304 """ 26305 SendIdleEvents(event) -> bool 26306 26307 Send idle event to window and all subwindows. 26308 """ 26309 26310 def RegisterHotKey(self, hotkeyId, modifiers, virtualKeyCode): 26311 """ 26312 RegisterHotKey(hotkeyId, modifiers, virtualKeyCode) -> bool 26313 26314 Registers a system wide hotkey. 26315 """ 26316 26317 def UnregisterHotKey(self, hotkeyId): 26318 """ 26319 UnregisterHotKey(hotkeyId) -> bool 26320 26321 Unregisters a system wide hotkey. 26322 """ 26323 26324 def UpdateWindowUI(self, flags=UPDATE_UI_NONE): 26325 """ 26326 UpdateWindowUI(flags=UPDATE_UI_NONE) 26327 26328 This function sends one or more wxUpdateUIEvent to the window. 26329 """ 26330 26331 @staticmethod 26332 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 26333 """ 26334 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 26335 26336 Returns the default font and colours which are used by the control. 26337 """ 26338 26339 @staticmethod 26340 def FindFocus(): 26341 """ 26342 FindFocus() -> Window 26343 26344 Finds the window or control which currently has the keyboard focus. 26345 """ 26346 26347 @staticmethod 26348 def FindWindowById(id, parent=None): 26349 """ 26350 FindWindowById(id, parent=None) -> Window 26351 26352 Find the first window with the given id. 26353 """ 26354 26355 @staticmethod 26356 def FindWindowByLabel(label, parent=None): 26357 """ 26358 FindWindowByLabel(label, parent=None) -> Window 26359 26360 Find a window by its label. 26361 """ 26362 26363 @staticmethod 26364 def FindWindowByName(name, parent=None): 26365 """ 26366 FindWindowByName(name, parent=None) -> Window 26367 26368 Find a window by its name (as given in a window constructor or 26369 Create() function call). 26370 """ 26371 26372 @staticmethod 26373 def GetCapture(): 26374 """ 26375 GetCapture() -> Window 26376 26377 Returns the currently captured window. 26378 """ 26379 26380 @staticmethod 26381 def NewControlId(count=1): 26382 """ 26383 NewControlId(count=1) -> WindowID 26384 26385 Create a new ID or range of IDs that are not currently in use. 26386 """ 26387 26388 @staticmethod 26389 def UnreserveControlId(id, count=1): 26390 """ 26391 UnreserveControlId(id, count=1) 26392 26393 Unreserve an ID or range of IDs that was reserved by NewControlId(). 26394 """ 26395 26396 def Create(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=PanelNameStr): 26397 """ 26398 Create(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=PanelNameStr) -> bool 26399 """ 26400 26401 def SetRect(self, rect): 26402 """ 26403 26404 """ 26405 Rect = property(None, None) 26406 26407 def SetClientRect(self, rect): 26408 """ 26409 26410 """ 26411 ClientRect = property(None, None) 26412 26413 def GetGtkWidget(self): 26414 """ 26415 GetGtkWidget() -> void 26416 """ 26417 26418 def AssociateHandle(self, handle): 26419 """ 26420 AssociateHandle(handle) 26421 26422 Associate the window with a new native handle 26423 """ 26424 26425 def DissociateHandle(self): 26426 """ 26427 DissociateHandle() 26428 26429 Dissociate the current native handle from the window 26430 """ 26431 26432 def GetTopLevelParent(self): 26433 """ 26434 GetTopLevelParent() -> Window 26435 26436 Returns the first ancestor of this window which is a top-level window. 26437 """ 26438 26439 def MacIsWindowScrollbar(self, sb): 26440 """ 26441 MacIsWindowScrollbar(sb) 26442 26443 Is the given widget one of this window's built-in scrollbars? Only 26444 applicable on Mac. 26445 """ 26446 26447 def SetDimensions(self, x, y, width, height, sizeFlags=SIZE_AUTO): 26448 """ 26449 SetDimensions(x, y, width, height, sizeFlags=SIZE_AUTO) 26450 """ 26451 26452 SetDimensions = wx.deprecated(SetDimensions, 'Use SetSize instead.') 26453 26454 def __nonzero__(self): 26455 """ 26456 Can be used to test if the C++ part of the window still exists, with 26457 code like this:: 26458 26459 if theWindow: 26460 doSomething() 26461 """ 26462 26463 __bool__ = __nonzero__ 26464 26465 def DestroyLater(self): 26466 """ 26467 Schedules the window to be destroyed in the near future. 26468 26469 This should be used whenever Destroy could happen too soon, such 26470 as when there may still be events for this window or its children 26471 waiting in the event queue. 26472 """ 26473 26474 def DLG_UNIT(self, dlg_unit): 26475 """ 26476 A convenience wrapper for :meth:`ConvertDialogToPixels`. 26477 """ 26478 26479 def PostCreate(self, pre): 26480 """ 26481 26482 """ 26483 AcceleratorTable = property(None, None) 26484 AutoLayout = property(None, None) 26485 BackgroundColour = property(None, None) 26486 BackgroundStyle = property(None, None) 26487 EffectiveMinSize = property(None, None) 26488 BestSize = property(None, None) 26489 BestVirtualSize = property(None, None) 26490 Border = property(None, None) 26491 Caret = property(None, None) 26492 CharHeight = property(None, None) 26493 CharWidth = property(None, None) 26494 Children = property(None, None) 26495 ClientAreaOrigin = property(None, None) 26496 ClientSize = property(None, None) 26497 Constraints = property(None, None) 26498 ContainingSizer = property(None, None) 26499 Cursor = property(None, None) 26500 DefaultAttributes = property(None, None) 26501 DropTarget = property(None, None) 26502 EventHandler = property(None, None) 26503 ExtraStyle = property(None, None) 26504 Font = property(None, None) 26505 ForegroundColour = property(None, None) 26506 GrandParent = property(None, None) 26507 TopLevelParent = property(None, None) 26508 Handle = property(None, None) 26509 HelpText = property(None, None) 26510 Id = property(None, None) 26511 Label = property(None, None) 26512 LayoutDirection = property(None, None) 26513 MaxHeight = property(None, None) 26514 MaxSize = property(None, None) 26515 MaxWidth = property(None, None) 26516 MinHeight = property(None, None) 26517 MinSize = property(None, None) 26518 MinWidth = property(None, None) 26519 Name = property(None, None) 26520 Parent = property(None, None) 26521 Position = property(None, None) 26522 ScreenPosition = property(None, None) 26523 ScreenRect = property(None, None) 26524 Size = property(None, None) 26525 Sizer = property(None, None) 26526 ThemeEnabled = property(None, None) 26527 ToolTip = property(None, None) 26528 UpdateClientRect = property(None, None) 26529 UpdateRegion = property(None, None) 26530 Validator = property(None, None) 26531 VirtualSize = property(None, None) 26532 WindowStyle = property(None, None) 26533 WindowStyleFlag = property(None, None) 26534 WindowVariant = property(None, None) 26535 Shown = property(None, None) 26536 Enabled = property(None, None) 26537 TopLevel = property(None, None) 26538 MinClientSize = property(None, None) 26539 MaxClientSize = property(None, None) 26540 26541 def GetPositionTuple(self): 26542 """ 26543 26544 """ 26545 26546 def GetSizeTuple(self): 26547 """ 26548 26549 """ 26550 26551 def MoveXY(self, x, y): 26552 """ 26553 26554 """ 26555 26556 def SetSizeWH(self, w, h): 26557 """ 26558 26559 """ 26560 26561 def SetVirtualSizeWH(self, w, h): 26562 """ 26563 26564 """ 26565 26566 def GetVirtualSizeTuple(self): 26567 """ 26568 26569 """ 26570 26571 def SetToolTipString(self, string): 26572 """ 26573 26574 """ 26575 26576 def ConvertDialogPointToPixels(self, point): 26577 """ 26578 26579 """ 26580 26581 def ConvertDialogSizeToPixels(self, size): 26582 """ 26583 26584 """ 26585 26586 def SetSizeHintsSz(self, minSize, maxSize=wx.DefaultSize, incSize=wx.DefaultSize): 26587 """ 26588 26589 """ 26590 26591 def DoGetBestSize(self): 26592 """ 26593 DoGetBestSize() -> Size 26594 26595 Implementation of GetBestSize() that can be overridden. 26596 """ 26597 26598 def DoGetBestClientSize(self): 26599 """ 26600 DoGetBestClientSize() -> Size 26601 26602 Override this method to return the best size for a custom control. 26603 """ 26604 26605 def SendDestroyEvent(self): 26606 """ 26607 SendDestroyEvent() 26608 26609 Generate wxWindowDestroyEvent for this window. 26610 """ 26611 26612 def ProcessEvent(self, event): 26613 """ 26614 ProcessEvent(event) -> bool 26615 26616 This function is public in wxEvtHandler but protected in wxWindow 26617 because for wxWindows you should always call ProcessEvent() on the 26618 pointer returned by GetEventHandler() and not on the wxWindow object 26619 itself. 26620 """ 26621# end of class Window 26622 26623 26624def FindWindowAtPointer(): 26625 """ 26626 FindWindowAtPointer() -> (Window, pt) 26627 26628 Find the deepest window at the mouse pointer position, returning the 26629 window and current pointer position in screen coordinates. 26630 """ 26631 26632def GetActiveWindow(): 26633 """ 26634 GetActiveWindow() -> Window 26635 26636 Gets the currently active window (implemented for MSW and GTK only 26637 currently, always returns NULL in the other ports). 26638 """ 26639 26640def GetTopLevelParent(window): 26641 """ 26642 GetTopLevelParent(window) -> Window 26643 26644 Returns the first top level parent of the given window, or in other 26645 words, the frame or dialog containing it, or NULL. 26646 """ 26647 26648class FrozenWindow(object): 26649 """ 26650 A context manager to be used with Python 'with' statements 26651 that will freeze the given window for the duration of the 26652 with block. 26653 """ 26654 def __init__(self, window): 26655 self._win = window 26656 def __enter__(self): 26657 self._win.Freeze() 26658 return self 26659 def __exit__(self, exc_type, exc_val, exc_tb): 26660 self._win.Thaw() 26661 26662def DLG_UNIT(win, dlg_unit, val2=None): 26663 """ 26664 Convenience function for converting a wx.Point, wx.Size or 26665 (x,y) in dialog units to pixels, using the given window as a 26666 reference. 26667 """ 26668 if val2 is not None: 26669 dlg_unit = (dlg_unit, val2) 26670 is_wxType = isinstance(dlg_unit, (wx.Size, wx.Point)) 26671 pix = win.ConvertDialogToPixels(dlg_unit) 26672 if not is_wxType: 26673 pix = tuple(pix) 26674 return pix 26675 26676DLG_PNT = wx.deprecated(DLG_UNIT, "Use DLG_UNIT instead.") 26677DLG_SZE = wx.deprecated(DLG_UNIT, "Use DLG_UNIT instead.") 26678 26679def GetTopLevelWindows(self): 26680 """ 26681 GetTopLevelWindows() -> WindowList 26682 26683 Returns a list-like object of the the application's top-level windows, 26684 (frames,dialogs, etc.) 26685 """ 26686 26687PyWindow = wx.deprecated(Window, 'Use Window instead.') 26688 26689def FindWindowById(self, id, parent=None): 26690 """ 26691 FindWindowById(id, parent=None) -> Window 26692 26693 FindWindowById(id, parent=None) -> Window 26694 26695 Find the first window in the application with the given id. If parent 26696 is None, the search will start from all top-level frames and dialog 26697 boxes; if non-None, the search will be limited to the given window 26698 hierarchy. The search is recursive in both cases. 26699 """ 26700 26701def FindWindowByName(self, name, parent=None): 26702 """ 26703 FindWindowByName(name, parent=None) -> Window 26704 26705 FindWindowByName(name, parent=None) -> Window 26706 26707 Find a window by its name (as given in a window constructor or Create 26708 function call). If parent is None, the search will start from all 26709 top-level frames and dialog boxes; if non-None, the search will be 26710 limited to the given window hierarchy. The search is recursive in both 26711 cases. 26712 26713 If no window with the name is found, wx.FindWindowByLabel is called. 26714 """ 26715 26716def FindWindowByLabel(self, label, parent=None): 26717 """ 26718 FindWindowByLabel(label, parent=None) -> Window 26719 26720 FindWindowByLabel(label, parent=None) -> Window 26721 26722 Find a window by its label. Depending on the type of window, the label 26723 may be a window title or panel item label. If parent is None, the 26724 search will start from all top-level frames and dialog boxes; if 26725 non-None, the search will be limited to the given window 26726 hierarchy. The search is recursive in both cases. 26727 """ 26728#-- end-window --# 26729#-- begin-validate --# 26730 26731class Validator(EvtHandler): 26732 """ 26733 Validator() 26734 26735 wxValidator is the base class for a family of validator classes that 26736 mediate between a class of control, and application data. 26737 """ 26738 26739 def __init__(self): 26740 """ 26741 Validator() 26742 26743 wxValidator is the base class for a family of validator classes that 26744 mediate between a class of control, and application data. 26745 """ 26746 26747 def Clone(self): 26748 """ 26749 Clone() -> Object 26750 26751 All validator classes must implement the Clone() function, which 26752 returns an identical copy of itself. 26753 """ 26754 26755 def GetWindow(self): 26756 """ 26757 GetWindow() -> Window 26758 26759 Returns the window associated with the validator. 26760 """ 26761 26762 def SetWindow(self, window): 26763 """ 26764 SetWindow(window) 26765 26766 Associates a window with the validator. 26767 """ 26768 26769 def TransferFromWindow(self): 26770 """ 26771 TransferFromWindow() -> bool 26772 26773 This overridable function is called when the value in the window must 26774 be transferred to the validator. 26775 """ 26776 26777 def TransferToWindow(self): 26778 """ 26779 TransferToWindow() -> bool 26780 26781 This overridable function is called when the value associated with the 26782 validator must be transferred to the window. 26783 """ 26784 26785 def Validate(self, parent): 26786 """ 26787 Validate(parent) -> bool 26788 26789 This overridable function is called when the value in the associated 26790 window must be validated. 26791 """ 26792 26793 @staticmethod 26794 def SuppressBellOnError(suppress=True): 26795 """ 26796 SuppressBellOnError(suppress=True) 26797 26798 This functions switches on or turns off the error sound produced by 26799 the validators if an invalid key is pressed. 26800 """ 26801 26802 @staticmethod 26803 def IsSilent(): 26804 """ 26805 IsSilent() -> bool 26806 26807 Returns if the error sound is currently disabled. 26808 """ 26809 Window = property(None, None) 26810# end of class Validator 26811 26812DefaultValidator = Validator() 26813 26814PyValidator = wx.deprecated(Validator, 'Use Validator instead.') 26815#-- end-validate --# 26816#-- begin-panel --# 26817 26818class Panel(Window): 26819 """ 26820 Panel() 26821 Panel(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=TAB_TRAVERSAL, name=PanelNameStr) 26822 26823 A panel is a window on which controls are placed. 26824 """ 26825 26826 def __init__(self, *args, **kw): 26827 """ 26828 Panel() 26829 Panel(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=TAB_TRAVERSAL, name=PanelNameStr) 26830 26831 A panel is a window on which controls are placed. 26832 """ 26833 26834 def AcceptsFocus(self): 26835 """ 26836 AcceptsFocus() -> bool 26837 26838 This method is overridden from wxWindow::AcceptsFocus() and returns 26839 true only if there is no child window in the panel which can accept 26840 the focus. 26841 """ 26842 26843 def Create(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=TAB_TRAVERSAL, name=PanelNameStr): 26844 """ 26845 Create(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=TAB_TRAVERSAL, name=PanelNameStr) -> bool 26846 26847 Used for two-step panel construction. 26848 """ 26849 26850 def InitDialog(self): 26851 """ 26852 InitDialog() 26853 26854 Sends a wxInitDialogEvent, which in turn transfers data to the dialog 26855 via validators. 26856 """ 26857 26858 def Layout(self): 26859 """ 26860 Layout() -> bool 26861 26862 See wxWindow::SetAutoLayout(): when auto layout is on, this function 26863 gets called automatically when the window is resized. 26864 """ 26865 26866 def SetFocus(self): 26867 """ 26868 SetFocus() 26869 26870 Overrides wxWindow::SetFocus(). 26871 """ 26872 26873 def SetFocusIgnoringChildren(self): 26874 """ 26875 SetFocusIgnoringChildren() 26876 26877 In contrast to SetFocus() (see above) this will set the focus to the 26878 panel even if there are child windows in the panel. 26879 """ 26880 26881 @staticmethod 26882 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 26883 """ 26884 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 26885 """ 26886# end of class Panel 26887 26888 26889PyPanel = wx.deprecated(Panel, 'Use Panel instead.') 26890#-- end-panel --# 26891#-- begin-menuitem --# 26892 26893class MenuItem(Object): 26894 """ 26895 MenuItem(parentMenu=None, id=ID_SEPARATOR, text=EmptyString, helpString=EmptyString, kind=ITEM_NORMAL, subMenu=None) 26896 26897 A menu item represents an item in a menu. 26898 """ 26899 26900 def __init__(self, parentMenu=None, id=ID_SEPARATOR, text=EmptyString, helpString=EmptyString, kind=ITEM_NORMAL, subMenu=None): 26901 """ 26902 MenuItem(parentMenu=None, id=ID_SEPARATOR, text=EmptyString, helpString=EmptyString, kind=ITEM_NORMAL, subMenu=None) 26903 26904 A menu item represents an item in a menu. 26905 """ 26906 26907 def GetBackgroundColour(self): 26908 """ 26909 GetBackgroundColour() -> Colour 26910 26911 Returns the background colour associated with the menu item. 26912 """ 26913 26914 def GetBitmap(self, checked=True): 26915 """ 26916 GetBitmap(checked=True) -> Bitmap 26917 26918 Returns the checked or unchecked bitmap. 26919 """ 26920 26921 def GetDisabledBitmap(self): 26922 """ 26923 GetDisabledBitmap() -> Bitmap 26924 26925 Returns the bitmap to be used for disabled items. 26926 """ 26927 26928 def GetFont(self): 26929 """ 26930 GetFont() -> Font 26931 26932 Returns the font associated with the menu item. 26933 """ 26934 26935 def GetHelp(self): 26936 """ 26937 GetHelp() -> String 26938 26939 Returns the help string associated with the menu item. 26940 """ 26941 26942 def GetId(self): 26943 """ 26944 GetId() -> int 26945 26946 Returns the menu item identifier. 26947 """ 26948 26949 def GetItemLabel(self): 26950 """ 26951 GetItemLabel() -> String 26952 26953 Returns the text associated with the menu item including any 26954 accelerator characters that were passed to the constructor or 26955 SetItemLabel(). 26956 """ 26957 26958 def GetItemLabelText(self): 26959 """ 26960 GetItemLabelText() -> String 26961 26962 Returns the text associated with the menu item, without any 26963 accelerator characters. 26964 """ 26965 26966 def GetKind(self): 26967 """ 26968 GetKind() -> ItemKind 26969 26970 Returns the item kind, one of wxITEM_SEPARATOR, wxITEM_NORMAL, 26971 wxITEM_CHECK or wxITEM_RADIO. 26972 """ 26973 26974 def GetLabel(self): 26975 """ 26976 GetLabel() -> String 26977 26978 Returns the text associated with the menu item without any accelerator 26979 characters it might contain. 26980 """ 26981 26982 def GetMarginWidth(self): 26983 """ 26984 GetMarginWidth() -> int 26985 26986 Gets the width of the menu item checkmark bitmap. 26987 """ 26988 26989 def GetMenu(self): 26990 """ 26991 GetMenu() -> Menu 26992 26993 Returns the menu this menu item is in, or NULL if this menu item is 26994 not attached. 26995 """ 26996 26997 def GetName(self): 26998 """ 26999 GetName() -> String 27000 27001 Returns the text associated with the menu item. 27002 """ 27003 27004 def GetSubMenu(self): 27005 """ 27006 GetSubMenu() -> Menu 27007 27008 Returns the submenu associated with the menu item, or NULL if there 27009 isn't one. 27010 """ 27011 27012 def GetText(self): 27013 """ 27014 GetText() -> String 27015 27016 Returns the text associated with the menu item, such as it was passed 27017 to the wxMenuItem constructor, i.e. 27018 """ 27019 27020 def GetTextColour(self): 27021 """ 27022 GetTextColour() -> Colour 27023 27024 Returns the text colour associated with the menu item. 27025 """ 27026 27027 def GetAccel(self): 27028 """ 27029 GetAccel() -> AcceleratorEntry 27030 27031 Get our accelerator or NULL (caller must delete the pointer) 27032 """ 27033 27034 def IsCheck(self): 27035 """ 27036 IsCheck() -> bool 27037 27038 Returns true if the item is a check item. 27039 """ 27040 27041 def IsCheckable(self): 27042 """ 27043 IsCheckable() -> bool 27044 27045 Returns true if the item is checkable. 27046 """ 27047 27048 def IsChecked(self): 27049 """ 27050 IsChecked() -> bool 27051 27052 Returns true if the item is checked. 27053 """ 27054 27055 def IsEnabled(self): 27056 """ 27057 IsEnabled() -> bool 27058 27059 Returns true if the item is enabled. 27060 """ 27061 27062 def IsRadio(self): 27063 """ 27064 IsRadio() -> bool 27065 27066 Returns true if the item is a radio button. 27067 """ 27068 27069 def IsSeparator(self): 27070 """ 27071 IsSeparator() -> bool 27072 27073 Returns true if the item is a separator. 27074 """ 27075 27076 def IsSubMenu(self): 27077 """ 27078 IsSubMenu() -> bool 27079 27080 Returns true if the item is a submenu. 27081 """ 27082 27083 def SetBackgroundColour(self, colour): 27084 """ 27085 SetBackgroundColour(colour) 27086 27087 Sets the background colour associated with the menu item. 27088 """ 27089 27090 def SetBitmap(self, bmp, checked=True): 27091 """ 27092 SetBitmap(bmp, checked=True) 27093 27094 Sets the bitmap for the menu item. 27095 """ 27096 27097 def SetBitmaps(self, checked, unchecked=NullBitmap): 27098 """ 27099 SetBitmaps(checked, unchecked=NullBitmap) 27100 27101 Sets the checked/unchecked bitmaps for the menu item. 27102 """ 27103 27104 def SetDisabledBitmap(self, disabled): 27105 """ 27106 SetDisabledBitmap(disabled) 27107 27108 Sets the to be used for disabled menu items. 27109 """ 27110 27111 def SetFont(self, font): 27112 """ 27113 SetFont(font) 27114 27115 Sets the font associated with the menu item. 27116 """ 27117 27118 def SetHelp(self, helpString): 27119 """ 27120 SetHelp(helpString) 27121 27122 Sets the help string. 27123 """ 27124 27125 def SetItemLabel(self, label): 27126 """ 27127 SetItemLabel(label) 27128 27129 Sets the label associated with the menu item. 27130 """ 27131 27132 def SetMarginWidth(self, width): 27133 """ 27134 SetMarginWidth(width) 27135 27136 Sets the width of the menu item checkmark bitmap. 27137 """ 27138 27139 def SetMenu(self, menu): 27140 """ 27141 SetMenu(menu) 27142 27143 Sets the parent menu which will contain this menu item. 27144 """ 27145 27146 def SetSubMenu(self, menu): 27147 """ 27148 SetSubMenu(menu) 27149 27150 Sets the submenu of this menu item. 27151 """ 27152 27153 def SetText(self, text): 27154 """ 27155 SetText(text) 27156 27157 Sets the text associated with the menu item. 27158 """ 27159 27160 def SetTextColour(self, colour): 27161 """ 27162 SetTextColour(colour) 27163 27164 Sets the text colour associated with the menu item. 27165 """ 27166 27167 def SetAccel(self, accel): 27168 """ 27169 SetAccel(accel) 27170 27171 Set the accel for this item - this may also be done indirectly with 27172 SetText() 27173 """ 27174 27175 def Check(self, check=True): 27176 """ 27177 Check(check=True) 27178 27179 Checks or unchecks the menu item. 27180 """ 27181 27182 def Enable(self, enable=True): 27183 """ 27184 Enable(enable=True) 27185 27186 Enables or disables the menu item. 27187 """ 27188 27189 @staticmethod 27190 def GetLabelFromText(text): 27191 """ 27192 GetLabelFromText(text) -> String 27193 """ 27194 27195 @staticmethod 27196 def GetLabelText(text): 27197 """ 27198 GetLabelText(text) -> String 27199 27200 Strips all accelerator characters and mnemonics from the given text. 27201 """ 27202 Accel = property(None, None) 27203 BackgroundColour = property(None, None) 27204 Bitmap = property(None, None) 27205 DisabledBitmap = property(None, None) 27206 Font = property(None, None) 27207 Help = property(None, None) 27208 Id = property(None, None) 27209 ItemLabel = property(None, None) 27210 ItemLabelText = property(None, None) 27211 Kind = property(None, None) 27212 Label = property(None, None) 27213 MarginWidth = property(None, None) 27214 Menu = property(None, None) 27215 Name = property(None, None) 27216 SubMenu = property(None, None) 27217 Text = property(None, None) 27218 TextColour = property(None, None) 27219 Enabled = property(None, None) 27220# end of class MenuItem 27221 27222#-- end-menuitem --# 27223#-- begin-menu --# 27224 27225class Menu(EvtHandler): 27226 """ 27227 Menu() 27228 Menu(style) 27229 Menu(title, style=0) 27230 27231 A menu is a popup (or pull down) list of items, one of which may be 27232 selected before the menu goes away (clicking elsewhere dismisses the 27233 menu). 27234 """ 27235 27236 def __init__(self, *args, **kw): 27237 """ 27238 Menu() 27239 Menu(style) 27240 Menu(title, style=0) 27241 27242 A menu is a popup (or pull down) list of items, one of which may be 27243 selected before the menu goes away (clicking elsewhere dismisses the 27244 menu). 27245 """ 27246 27247 def GetMenuItems(self): 27248 """ 27249 GetMenuItems() -> MenuItemList 27250 27251 Returns the list of items in the menu. 27252 """ 27253 27254 def Append(self, *args, **kw): 27255 """ 27256 Append(id, item=EmptyString, helpString=EmptyString, kind=ITEM_NORMAL) -> MenuItem 27257 Append(id, item, subMenu, helpString=EmptyString) -> MenuItem 27258 Append(menuItem) -> MenuItem 27259 27260 Adds a menu item. 27261 """ 27262 27263 def AppendCheckItem(self, id, item, help=EmptyString): 27264 """ 27265 AppendCheckItem(id, item, help=EmptyString) -> MenuItem 27266 27267 Adds a checkable item to the end of the menu. 27268 """ 27269 27270 def AppendRadioItem(self, id, item, help=EmptyString): 27271 """ 27272 AppendRadioItem(id, item, help=EmptyString) -> MenuItem 27273 27274 Adds a radio item to the end of the menu. 27275 """ 27276 27277 def AppendSeparator(self): 27278 """ 27279 AppendSeparator() -> MenuItem 27280 27281 Adds a separator to the end of the menu. 27282 """ 27283 27284 def AppendSubMenu(self, submenu, text, help=EmptyString): 27285 """ 27286 AppendSubMenu(submenu, text, help=EmptyString) -> MenuItem 27287 27288 Adds the given submenu to this menu. 27289 """ 27290 27291 def Break(self): 27292 """ 27293 Break() 27294 27295 Inserts a break in a menu, causing the next appended item to appear in 27296 a new column. 27297 """ 27298 27299 def Check(self, id, check): 27300 """ 27301 Check(id, check) 27302 27303 Checks or unchecks the menu item. 27304 """ 27305 27306 def Delete(self, *args, **kw): 27307 """ 27308 Delete(id) -> bool 27309 Delete(item) -> bool 27310 27311 Deletes the menu item from the menu. 27312 """ 27313 27314 def DestroyItem(self, *args, **kw): 27315 """ 27316 DestroyItem(id) -> bool 27317 DestroyItem(item) -> bool 27318 27319 Deletes the menu item from the menu. 27320 """ 27321 27322 def Enable(self, id, enable): 27323 """ 27324 Enable(id, enable) 27325 27326 Enables or disables (greys out) a menu item. 27327 """ 27328 27329 def FindChildItem(self, id): 27330 """ 27331 FindChildItem(id) -> (MenuItem, pos) 27332 27333 Finds the menu item object associated with the given menu item 27334 identifier and, optionally, the position of the item in the menu. 27335 """ 27336 27337 def FindItem(self, *args, **kw): 27338 """ 27339 FindItem(itemString) -> int 27340 FindItem(id) -> (MenuItem, menu) 27341 27342 Finds the menu id for a menu item string. 27343 """ 27344 27345 def FindItemByPosition(self, position): 27346 """ 27347 FindItemByPosition(position) -> MenuItem 27348 27349 Returns the wxMenuItem given a position in the menu. 27350 """ 27351 27352 def GetHelpString(self, id): 27353 """ 27354 GetHelpString(id) -> String 27355 27356 Returns the help string associated with a menu item. 27357 """ 27358 27359 def GetLabel(self, id): 27360 """ 27361 GetLabel(id) -> String 27362 27363 Returns a menu item label. 27364 """ 27365 27366 def GetLabelText(self, id): 27367 """ 27368 GetLabelText(id) -> String 27369 27370 Returns a menu item label, without any of the original mnemonics and 27371 accelerators. 27372 """ 27373 27374 def GetMenuItemCount(self): 27375 """ 27376 GetMenuItemCount() -> size_t 27377 27378 Returns the number of items in the menu. 27379 """ 27380 27381 def GetTitle(self): 27382 """ 27383 GetTitle() -> String 27384 27385 Returns the title of the menu. 27386 """ 27387 27388 def Insert(self, *args, **kw): 27389 """ 27390 Insert(pos, menuItem) -> MenuItem 27391 Insert(pos, id, item=EmptyString, helpString=EmptyString, kind=ITEM_NORMAL) -> MenuItem 27392 Insert(pos, id, text, submenu, help=EmptyString) -> MenuItem 27393 27394 Inserts the given item before the position pos. 27395 """ 27396 27397 def InsertCheckItem(self, pos, id, item, helpString=EmptyString): 27398 """ 27399 InsertCheckItem(pos, id, item, helpString=EmptyString) -> MenuItem 27400 27401 Inserts a checkable item at the given position. 27402 """ 27403 27404 def InsertRadioItem(self, pos, id, item, helpString=EmptyString): 27405 """ 27406 InsertRadioItem(pos, id, item, helpString=EmptyString) -> MenuItem 27407 27408 Inserts a radio item at the given position. 27409 """ 27410 27411 def InsertSeparator(self, pos): 27412 """ 27413 InsertSeparator(pos) -> MenuItem 27414 27415 Inserts a separator at the given position. 27416 """ 27417 27418 def IsChecked(self, id): 27419 """ 27420 IsChecked(id) -> bool 27421 27422 Determines whether a menu item is checked. 27423 """ 27424 27425 def IsEnabled(self, id): 27426 """ 27427 IsEnabled(id) -> bool 27428 27429 Determines whether a menu item is enabled. 27430 """ 27431 27432 def Prepend(self, *args, **kw): 27433 """ 27434 Prepend(menuItem) -> MenuItem 27435 Prepend(id, item=EmptyString, helpString=EmptyString, kind=ITEM_NORMAL) -> MenuItem 27436 Prepend(id, text, subMenu, help=EmptyString) -> MenuItem 27437 27438 Inserts the given item at position 0, i.e. before all the other 27439 existing items. 27440 """ 27441 27442 def PrependCheckItem(self, id, item, helpString=EmptyString): 27443 """ 27444 PrependCheckItem(id, item, helpString=EmptyString) -> MenuItem 27445 27446 Inserts a checkable item at position 0. 27447 """ 27448 27449 def PrependRadioItem(self, id, item, helpString=EmptyString): 27450 """ 27451 PrependRadioItem(id, item, helpString=EmptyString) -> MenuItem 27452 27453 Inserts a radio item at position 0. 27454 """ 27455 27456 def PrependSeparator(self): 27457 """ 27458 PrependSeparator() -> MenuItem 27459 27460 Inserts a separator at position 0. 27461 """ 27462 27463 def Remove(self, *args, **kw): 27464 """ 27465 Remove(id) -> MenuItem 27466 Remove(item) -> MenuItem 27467 27468 Removes the menu item from the menu but doesn't delete the associated 27469 C++ object. 27470 """ 27471 27472 def SetHelpString(self, id, helpString): 27473 """ 27474 SetHelpString(id, helpString) 27475 27476 Sets an item's help string. 27477 """ 27478 27479 def SetLabel(self, id, label): 27480 """ 27481 SetLabel(id, label) 27482 27483 Sets the label of a menu item. 27484 """ 27485 27486 def SetTitle(self, title): 27487 """ 27488 SetTitle(title) 27489 27490 Sets the title of the menu. 27491 """ 27492 27493 def UpdateUI(self, source=None): 27494 """ 27495 UpdateUI(source=None) 27496 27497 Sends events to source (or owning window if NULL) to update the menu 27498 UI. 27499 """ 27500 27501 def SetInvokingWindow(self, win): 27502 """ 27503 SetInvokingWindow(win) 27504 """ 27505 27506 def GetInvokingWindow(self): 27507 """ 27508 GetInvokingWindow() -> Window 27509 """ 27510 27511 def GetWindow(self): 27512 """ 27513 GetWindow() -> Window 27514 """ 27515 27516 def GetStyle(self): 27517 """ 27518 GetStyle() -> long 27519 """ 27520 27521 def SetParent(self, parent): 27522 """ 27523 SetParent(parent) 27524 """ 27525 27526 def GetParent(self): 27527 """ 27528 GetParent() -> Menu 27529 """ 27530 27531 def Attach(self, menubar): 27532 """ 27533 Attach(menubar) 27534 """ 27535 27536 def Detach(self): 27537 """ 27538 Detach() 27539 """ 27540 27541 def IsAttached(self): 27542 """ 27543 IsAttached() -> bool 27544 """ 27545 27546 def AppendMenu(self, id, item, subMenu, help=""): 27547 """ 27548 27549 """ 27550 27551 def AppendItem(self, menuItem): 27552 """ 27553 27554 """ 27555 27556 def InsertMenu(self, pos, id, item, subMenu, help=""): 27557 """ 27558 27559 """ 27560 27561 def InsertItem(self, pos, menuItem): 27562 """ 27563 27564 """ 27565 27566 def PrependMenu(self, id, item, subMenu, help=""): 27567 """ 27568 27569 """ 27570 27571 def PrependItem(self, menuItem): 27572 """ 27573 27574 """ 27575 27576 def RemoveMenu(self, id, item, subMenu, help=""): 27577 """ 27578 27579 """ 27580 27581 def RemoveItem(self, menuItem): 27582 """ 27583 27584 """ 27585 27586 def FindItemById(self, id): 27587 """ 27588 FindItemById(id) -> MenuItem 27589 27590 FindItemById(id) -> MenuItem 27591 27592 Finds the menu item object associated with the given menu item 27593 identifier. 27594 """ 27595 InvokingWindow = property(None, None) 27596 MenuItemCount = property(None, None) 27597 MenuItems = property(None, None) 27598 Parent = property(None, None) 27599 Style = property(None, None) 27600 Title = property(None, None) 27601 Window = property(None, None) 27602# end of class Menu 27603 27604 27605class MenuBar(Window): 27606 """ 27607 MenuBar(style=0) 27608 27609 A menu bar is a series of menus accessible from the top of a frame. 27610 """ 27611 27612 def __init__(self, style=0): 27613 """ 27614 MenuBar(style=0) 27615 27616 A menu bar is a series of menus accessible from the top of a frame. 27617 """ 27618 27619 def Append(self, menu, title): 27620 """ 27621 Append(menu, title) -> bool 27622 27623 Adds the item to the end of the menu bar. 27624 """ 27625 27626 def Check(self, id, check): 27627 """ 27628 Check(id, check) 27629 27630 Checks or unchecks a menu item. 27631 """ 27632 27633 def Enable(self, id, enable): 27634 """ 27635 Enable(id, enable) 27636 27637 Enables or disables (greys out) a menu item. 27638 """ 27639 27640 def IsEnabledTop(self, pos): 27641 """ 27642 IsEnabledTop(pos) -> bool 27643 27644 Returns true if the menu with the given index is enabled. 27645 """ 27646 27647 def EnableTop(self, pos, enable): 27648 """ 27649 EnableTop(pos, enable) 27650 27651 Enables or disables a whole menu. 27652 """ 27653 27654 def FindItem(self, id): 27655 """ 27656 FindItem(id) -> (MenuItem, menu) 27657 27658 Finds the menu item object associated with the given menu item 27659 identifier. 27660 """ 27661 27662 def FindMenu(self, title): 27663 """ 27664 FindMenu(title) -> int 27665 27666 Returns the index of the menu with the given title or wxNOT_FOUND if 27667 no such menu exists in this menubar. 27668 """ 27669 27670 def FindMenuItem(self, menuString, itemString): 27671 """ 27672 FindMenuItem(menuString, itemString) -> int 27673 27674 Finds the menu item id for a menu name/menu item string pair. 27675 """ 27676 27677 def GetHelpString(self, id): 27678 """ 27679 GetHelpString(id) -> String 27680 27681 Gets the help string associated with the menu item identifier. 27682 """ 27683 27684 def GetLabel(self, id): 27685 """ 27686 GetLabel(id) -> String 27687 27688 Gets the label associated with a menu item. 27689 """ 27690 27691 def GetLabelTop(self, pos): 27692 """ 27693 GetLabelTop(pos) -> String 27694 27695 Returns the label of a top-level menu. 27696 """ 27697 27698 def GetMenu(self, menuIndex): 27699 """ 27700 GetMenu(menuIndex) -> Menu 27701 27702 Returns the menu at menuIndex (zero-based). 27703 """ 27704 27705 def GetMenuCount(self): 27706 """ 27707 GetMenuCount() -> size_t 27708 27709 Returns the number of menus in this menubar. 27710 """ 27711 27712 def GetMenuLabel(self, pos): 27713 """ 27714 GetMenuLabel(pos) -> String 27715 27716 Returns the label of a top-level menu. 27717 """ 27718 27719 def GetMenuLabelText(self, pos): 27720 """ 27721 GetMenuLabelText(pos) -> String 27722 27723 Returns the label of a top-level menu. 27724 """ 27725 27726 def Insert(self, pos, menu, title): 27727 """ 27728 Insert(pos, menu, title) -> bool 27729 27730 Inserts the menu at the given position into the menu bar. 27731 """ 27732 27733 def IsChecked(self, id): 27734 """ 27735 IsChecked(id) -> bool 27736 27737 Determines whether an item is checked. 27738 """ 27739 27740 def IsEnabled(self, id): 27741 """ 27742 IsEnabled(id) -> bool 27743 27744 Determines whether an item is enabled. 27745 """ 27746 27747 def Refresh(self, eraseBackground=True, rect=None): 27748 """ 27749 Refresh(eraseBackground=True, rect=None) 27750 27751 Redraw the menu bar. 27752 """ 27753 27754 def Remove(self, pos): 27755 """ 27756 Remove(pos) -> Menu 27757 27758 Removes the menu from the menu bar and returns the menu object - the 27759 caller is responsible for deleting it. 27760 """ 27761 27762 def Replace(self, pos, menu, title): 27763 """ 27764 Replace(pos, menu, title) -> Menu 27765 27766 Replaces the menu at the given position with another one. 27767 """ 27768 27769 def SetHelpString(self, id, helpString): 27770 """ 27771 SetHelpString(id, helpString) 27772 27773 Sets the help string associated with a menu item. 27774 """ 27775 27776 def SetLabel(self, id, label): 27777 """ 27778 SetLabel(id, label) 27779 27780 Sets the label of a menu item. 27781 """ 27782 27783 def SetLabelTop(self, pos, label): 27784 """ 27785 SetLabelTop(pos, label) 27786 27787 Sets the label of a top-level menu. 27788 """ 27789 27790 def SetMenuLabel(self, pos, label): 27791 """ 27792 SetMenuLabel(pos, label) 27793 27794 Sets the label of a top-level menu. 27795 """ 27796 27797 def OSXGetAppleMenu(self): 27798 """ 27799 OSXGetAppleMenu() -> Menu 27800 27801 Returns the Apple menu. 27802 """ 27803 27804 def GetFrame(self): 27805 """ 27806 GetFrame() -> Frame 27807 """ 27808 27809 def IsAttached(self): 27810 """ 27811 IsAttached() -> bool 27812 """ 27813 27814 def Attach(self, frame): 27815 """ 27816 Attach(frame) 27817 """ 27818 27819 def Detach(self): 27820 """ 27821 Detach() 27822 """ 27823 27824 @staticmethod 27825 def MacSetCommonMenuBar(menubar): 27826 """ 27827 MacSetCommonMenuBar(menubar) 27828 27829 Enables you to set the global menubar on Mac, that is, the menubar 27830 displayed when the app is running without any frames open. 27831 """ 27832 27833 @staticmethod 27834 def MacGetCommonMenuBar(): 27835 """ 27836 MacGetCommonMenuBar() -> MenuBar 27837 27838 Enables you to get the global menubar on Mac, that is, the menubar 27839 displayed when the app is running without any frames open. 27840 """ 27841 27842 def FindItemById(self, id): 27843 """ 27844 FindItemById(id) -> MenuItem 27845 27846 FindItemById(id) -> MenuItem 27847 27848 Finds the menu item object associated with the given menu item 27849 identifier. 27850 """ 27851 27852 def GetMenus(self): 27853 """ 27854 GetMenus() -> (menu, label) 27855 27856 Return a list of (menu, label) items for the menus in the :class:`MenuBar`. 27857 """ 27858 27859 def SetMenus(self, items): 27860 """ 27861 SetMenus() 27862 27863 Clear and add new menus to the :class:`MenuBar` from a list of (menu, label) items. 27864 """ 27865 Menus = property(None, None) 27866# end of class MenuBar 27867 27868#-- end-menu --# 27869#-- begin-scrolwin --# 27870SHOW_SB_NEVER = 0 27871SHOW_SB_DEFAULT = 0 27872SHOW_SB_ALWAYS = 0 27873 27874class Scrolled(object): 27875 """ 27876 Scrolled() 27877 Scrolled(parent, id=-1, pos=DefaultPosition, size=DefaultSize, style=HSCROLL|VSCROLL, name="scrolledWindow") 27878 27879 The wxScrolled class manages scrolling for its client area, 27880 transforming the coordinates according to the scrollbar positions, and 27881 setting the scroll positions, thumb sizes and ranges according to the 27882 area in view. 27883 """ 27884 27885 def __init__(self, *args, **kw): 27886 """ 27887 Scrolled() 27888 Scrolled(parent, id=-1, pos=DefaultPosition, size=DefaultSize, style=HSCROLL|VSCROLL, name="scrolledWindow") 27889 27890 The wxScrolled class manages scrolling for its client area, 27891 transforming the coordinates according to the scrollbar positions, and 27892 setting the scroll positions, thumb sizes and ranges according to the 27893 area in view. 27894 """ 27895 27896 def CalcScrolledPosition(self, *args, **kw): 27897 """ 27898 CalcScrolledPosition(x, y) -> (xx, yy) 27899 CalcScrolledPosition(pt) -> Point 27900 27901 Translates the logical coordinates to the device ones. 27902 """ 27903 27904 def CalcUnscrolledPosition(self, *args, **kw): 27905 """ 27906 CalcUnscrolledPosition(x, y) -> (xx, yy) 27907 CalcUnscrolledPosition(pt) -> Point 27908 27909 Translates the device coordinates to the logical ones. 27910 """ 27911 27912 def Create(self, parent, id=-1, pos=DefaultPosition, size=DefaultSize, style=HSCROLL|VSCROLL, name="scrolledWindow"): 27913 """ 27914 Create(parent, id=-1, pos=DefaultPosition, size=DefaultSize, style=HSCROLL|VSCROLL, name="scrolledWindow") -> bool 27915 27916 Creates the window for two-step construction. 27917 """ 27918 27919 def DisableKeyboardScrolling(self): 27920 """ 27921 DisableKeyboardScrolling() 27922 27923 Disable use of keyboard keys for scrolling. 27924 """ 27925 27926 def DoPrepareDC(self, dc): 27927 """ 27928 DoPrepareDC(dc) 27929 27930 Call this function to prepare the device context for drawing a 27931 scrolled image. 27932 """ 27933 27934 def EnableScrolling(self, xScrolling, yScrolling): 27935 """ 27936 EnableScrolling(xScrolling, yScrolling) 27937 27938 Enable or disable use of wxWindow::ScrollWindow() for scrolling. 27939 """ 27940 27941 def ShowScrollbars(self, horz, vert): 27942 """ 27943 ShowScrollbars(horz, vert) 27944 27945 Set the scrollbar visibility. 27946 """ 27947 27948 def GetScrollPixelsPerUnit(self): 27949 """ 27950 GetScrollPixelsPerUnit() -> (xUnit, yUnit) 27951 27952 Get the number of pixels per scroll unit (line), in each direction, as 27953 set by SetScrollbars(). 27954 """ 27955 27956 def GetViewStart(self): 27957 """ 27958 GetViewStart() -> (x, y) 27959 27960 Get the position at which the visible portion of the window starts. 27961 """ 27962 27963 def IsRetained(self): 27964 """ 27965 IsRetained() -> bool 27966 27967 Motif only: true if the window has a backing bitmap. 27968 """ 27969 27970 def OnDraw(self, dc): 27971 """ 27972 OnDraw(dc) 27973 27974 Called by the default paint event handler to allow the application to 27975 define painting behaviour without having to worry about calling 27976 DoPrepareDC(). 27977 """ 27978 27979 def PrepareDC(self, dc): 27980 """ 27981 PrepareDC(dc) 27982 27983 This function is for backwards compatibility only and simply calls 27984 DoPrepareDC() now. 27985 """ 27986 27987 def Scroll(self, *args, **kw): 27988 """ 27989 Scroll(x, y) 27990 Scroll(pt) 27991 27992 Scrolls a window so the view start is at the given point. 27993 """ 27994 27995 def SetScrollRate(self, xstep, ystep): 27996 """ 27997 SetScrollRate(xstep, ystep) 27998 27999 Set the horizontal and vertical scrolling increment only. 28000 """ 28001 28002 def SetScrollbars(self, pixelsPerUnitX, pixelsPerUnitY, noUnitsX, noUnitsY, xPos=0, yPos=0, noRefresh=False): 28003 """ 28004 SetScrollbars(pixelsPerUnitX, pixelsPerUnitY, noUnitsX, noUnitsY, xPos=0, yPos=0, noRefresh=False) 28005 28006 Sets up vertical and/or horizontal scrollbars. 28007 """ 28008 28009 def SetTargetWindow(self, window): 28010 """ 28011 SetTargetWindow(window) 28012 28013 Call this function to tell wxScrolled to perform the actual scrolling 28014 on a different window (and not on itself). 28015 """ 28016 28017 def GetTargetWindow(self): 28018 """ 28019 GetTargetWindow() -> Window 28020 """ 28021 28022 def SetTargetRect(self, rect): 28023 """ 28024 SetTargetRect(rect) 28025 """ 28026 28027 def GetTargetRect(self): 28028 """ 28029 GetTargetRect() -> Rect 28030 """ 28031 28032 def GetScrollPageSize(self, orient): 28033 """ 28034 GetScrollPageSize(orient) -> int 28035 """ 28036 28037 def SetScrollPageSize(self, orient, pageSize): 28038 """ 28039 SetScrollPageSize(orient, pageSize) 28040 """ 28041 28042 def GetScrollLines(self, orient): 28043 """ 28044 GetScrollLines(orient) -> int 28045 """ 28046 28047 def SetScale(self, xs, ys): 28048 """ 28049 SetScale(xs, ys) 28050 """ 28051 28052 def GetScaleX(self): 28053 """ 28054 GetScaleX() -> double 28055 """ 28056 28057 def GetScaleY(self): 28058 """ 28059 GetScaleY() -> double 28060 """ 28061 28062 def AdjustScrollbars(self): 28063 """ 28064 AdjustScrollbars() 28065 """ 28066 28067 def IsAutoScrolling(self): 28068 """ 28069 IsAutoScrolling() -> bool 28070 28071 Are we generating the autoscroll events? 28072 """ 28073 28074 def StopAutoScrolling(self): 28075 """ 28076 StopAutoScrolling() 28077 28078 Stop generating the scroll events when mouse is held outside the 28079 window. 28080 """ 28081 28082 def SendAutoScrollEvents(self, event): 28083 """ 28084 SendAutoScrollEvents(event) -> bool 28085 28086 This method can be overridden in a derived class to forbid sending the 28087 auto scroll events - note that unlike StopAutoScrolling() it doesn't 28088 stop the timer, so it will be called repeatedly and will typically 28089 return different values depending on the current mouse position. 28090 """ 28091 28092 @staticmethod 28093 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 28094 """ 28095 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 28096 """ 28097 ScaleX = property(None, None) 28098 ScaleY = property(None, None) 28099 TargetRect = property(None, None) 28100 TargetWindow = property(None, None) 28101 28102 def GetSizeAvailableForScrollTarget(self, size): 28103 """ 28104 GetSizeAvailableForScrollTarget(size) -> Size 28105 28106 Function which must be overridden to implement the size available for 28107 the scroll target for the given size of the main window. 28108 """ 28109# end of class Scrolled 28110 28111class ScrolledCanvas(Window, Scrolled): 28112 """ 28113 The :ref:`ScrolledCanvas` class is a combination of the :ref:`Window` and 28114 :ref:`Scrolled` classes, and manages scrolling for its client area, 28115 transforming the coordinates according to the scrollbar positions, 28116 and setting the scroll positions, thumb sizes and ranges according to 28117 the area in view. 28118 """ 28119 28120class ScrolledWindow(Window, Scrolled): 28121 """ 28122 ScrolledWindow() 28123 ScrolledWindow(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=ScrolledWindowStyle, name=PanelNameStr) 28124 28125 Scrolled window derived from wxPanel. 28126 """ 28127 28128 def __init__(self, *args, **kw): 28129 """ 28130 ScrolledWindow() 28131 ScrolledWindow(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=ScrolledWindowStyle, name=PanelNameStr) 28132 28133 Scrolled window derived from wxPanel. 28134 """ 28135 28136 def SetFocusIgnoringChildren(self): 28137 """ 28138 SetFocusIgnoringChildren() 28139 28140 In contrast to SetFocus() this will set the focus to the panel even if 28141 there are child windows in the panel. This is only rarely needed. 28142 """ 28143 28144 @staticmethod 28145 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 28146 """ 28147 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 28148 """ 28149# end of class ScrolledWindow 28150 28151 28152PyScrolledWindow = wx.deprecated(ScrolledWindow, 'Use ScrolledWindow instead.') 28153#-- end-scrolwin --# 28154#-- begin-vscroll --# 28155 28156class VarScrollHelperBase(object): 28157 """ 28158 VarScrollHelperBase(winToScroll) 28159 28160 This class provides all common base functionality for scroll 28161 calculations shared among all variable scrolled window implementations 28162 as well as automatic scrollbar functionality, saved scroll positions, 28163 controlling target windows to be scrolled, as well as defining all 28164 required virtual functions that need to be implemented for any 28165 orientation specific work. 28166 """ 28167 28168 def __init__(self, winToScroll): 28169 """ 28170 VarScrollHelperBase(winToScroll) 28171 28172 This class provides all common base functionality for scroll 28173 calculations shared among all variable scrolled window implementations 28174 as well as automatic scrollbar functionality, saved scroll positions, 28175 controlling target windows to be scrolled, as well as defining all 28176 required virtual functions that need to be implemented for any 28177 orientation specific work. 28178 """ 28179 28180 def CalcScrolledPosition(self, coord): 28181 """ 28182 CalcScrolledPosition(coord) -> int 28183 28184 Translates the logical coordinate given to the current device 28185 coordinate. 28186 """ 28187 28188 def CalcUnscrolledPosition(self, coord): 28189 """ 28190 CalcUnscrolledPosition(coord) -> int 28191 28192 Translates the device coordinate given to the corresponding logical 28193 coordinate. 28194 """ 28195 28196 def EnablePhysicalScrolling(self, scrolling=True): 28197 """ 28198 EnablePhysicalScrolling(scrolling=True) 28199 28200 With physical scrolling on (when this is true), the device origin is 28201 changed properly when a wxPaintDC is prepared, children are actually 28202 moved and laid out properly, and the contents of the window (pixels) 28203 are actually moved. 28204 """ 28205 28206 def GetNonOrientationTargetSize(self): 28207 """ 28208 GetNonOrientationTargetSize() -> int 28209 28210 This function needs to be overridden in the in the derived class to 28211 return the window size with respect to the opposing orientation. 28212 """ 28213 28214 def GetOrientation(self): 28215 """ 28216 GetOrientation() -> Orientation 28217 28218 This function need to be overridden to return the orientation that 28219 this helper is working with, either wxHORIZONTAL or wxVERTICAL. 28220 """ 28221 28222 def GetOrientationTargetSize(self): 28223 """ 28224 GetOrientationTargetSize() -> int 28225 28226 This function needs to be overridden in the in the derived class to 28227 return the window size with respect to the orientation this helper is 28228 working with. 28229 """ 28230 28231 def GetTargetWindow(self): 28232 """ 28233 GetTargetWindow() -> Window 28234 28235 This function will return the target window this helper class is 28236 currently scrolling. 28237 """ 28238 28239 def GetVisibleBegin(self): 28240 """ 28241 GetVisibleBegin() -> size_t 28242 28243 Returns the index of the first visible unit based on the scroll 28244 position. 28245 """ 28246 28247 def GetVisibleEnd(self): 28248 """ 28249 GetVisibleEnd() -> size_t 28250 28251 Returns the index of the last visible unit based on the scroll 28252 position. 28253 """ 28254 28255 def IsVisible(self, unit): 28256 """ 28257 IsVisible(unit) -> bool 28258 28259 Returns true if the given scroll unit is currently visible (even if 28260 only partially visible) or false otherwise. 28261 """ 28262 28263 def RefreshAll(self): 28264 """ 28265 RefreshAll() 28266 28267 Recalculate all parameters and repaint all units. 28268 """ 28269 28270 def SetTargetWindow(self, target): 28271 """ 28272 SetTargetWindow(target) 28273 28274 Normally the window will scroll itself, but in some rare occasions you 28275 might want it to scroll (part of) another window (e.g. 28276 """ 28277 28278 def UpdateScrollbar(self): 28279 """ 28280 UpdateScrollbar() 28281 28282 Update the thumb size shown by the scrollbar. 28283 """ 28284 28285 def VirtualHitTest(self, coord): 28286 """ 28287 VirtualHitTest(coord) -> int 28288 28289 Returns the virtual scroll unit under the device unit given accounting 28290 for scroll position or wxNOT_FOUND if none (i.e. 28291 """ 28292 NonOrientationTargetSize = property(None, None) 28293 Orientation = property(None, None) 28294 OrientationTargetSize = property(None, None) 28295 TargetWindow = property(None, None) 28296 VisibleBegin = property(None, None) 28297 VisibleEnd = property(None, None) 28298 28299 def OnGetUnitsSizeHint(self, unitMin, unitMax): 28300 """ 28301 OnGetUnitsSizeHint(unitMin, unitMax) 28302 28303 This function doesn't have to be overridden but it may be useful to do 28304 so if calculating the units' sizes is a relatively expensive operation 28305 as it gives your code a chance to calculate several of them at once 28306 and cache the result if necessary. 28307 """ 28308 28309 def EstimateTotalSize(self): 28310 """ 28311 EstimateTotalSize() -> Coord 28312 28313 When the number of scroll units change, we try to estimate the total 28314 size of all units when the full window size is needed (i.e. 28315 """ 28316 28317 def OnGetUnitSize(self, unit): 28318 """ 28319 OnGetUnitSize(unit) -> Coord 28320 28321 This function must be overridden in the derived class, and should 28322 return the size of the given unit in pixels. 28323 """ 28324# end of class VarScrollHelperBase 28325 28326 28327class VarVScrollHelper(VarScrollHelperBase): 28328 """ 28329 VarVScrollHelper(winToScroll) 28330 28331 This class provides functions wrapping the wxVarScrollHelperBase 28332 class, targeted for vertical-specific scrolling. 28333 """ 28334 28335 def __init__(self, winToScroll): 28336 """ 28337 VarVScrollHelper(winToScroll) 28338 28339 This class provides functions wrapping the wxVarScrollHelperBase 28340 class, targeted for vertical-specific scrolling. 28341 """ 28342 28343 def GetRowCount(self): 28344 """ 28345 GetRowCount() -> size_t 28346 28347 Returns the number of rows the target window contains. 28348 """ 28349 28350 def GetVisibleRowsBegin(self): 28351 """ 28352 GetVisibleRowsBegin() -> size_t 28353 28354 Returns the index of the first visible row based on the scroll 28355 position. 28356 """ 28357 28358 def GetVisibleRowsEnd(self): 28359 """ 28360 GetVisibleRowsEnd() -> size_t 28361 28362 Returns the index of the last visible row based on the scroll 28363 position. 28364 """ 28365 28366 def IsRowVisible(self, row): 28367 """ 28368 IsRowVisible(row) -> bool 28369 28370 Returns true if the given row is currently visible (even if only 28371 partially visible) or false otherwise. 28372 """ 28373 28374 def RefreshRow(self, row): 28375 """ 28376 RefreshRow(row) 28377 28378 Triggers a refresh for just the given row's area of the window if it's 28379 visible. 28380 """ 28381 28382 def RefreshRows(self, from_, to_): 28383 """ 28384 RefreshRows(from_, to_) 28385 28386 Triggers a refresh for the area between the specified range of rows 28387 given (inclusively). 28388 """ 28389 28390 def ScrollRowPages(self, pages): 28391 """ 28392 ScrollRowPages(pages) -> bool 28393 28394 Scroll by the specified number of pages which may be positive (to 28395 scroll down) or negative (to scroll up). 28396 """ 28397 28398 def ScrollRows(self, rows): 28399 """ 28400 ScrollRows(rows) -> bool 28401 28402 Scroll by the specified number of rows which may be positive (to 28403 scroll down) or negative (to scroll up). 28404 """ 28405 28406 def ScrollToRow(self, row): 28407 """ 28408 ScrollToRow(row) -> bool 28409 28410 Scroll to the specified row. 28411 """ 28412 28413 def SetRowCount(self, rowCount): 28414 """ 28415 SetRowCount(rowCount) 28416 28417 Set the number of rows the window contains. 28418 """ 28419 RowCount = property(None, None) 28420 VisibleRowsBegin = property(None, None) 28421 VisibleRowsEnd = property(None, None) 28422 28423 def OnGetRowsHeightHint(self, rowMin, rowMax): 28424 """ 28425 OnGetRowsHeightHint(rowMin, rowMax) 28426 28427 This function doesn't have to be overridden but it may be useful to do 28428 so if calculating the rows' sizes is a relatively expensive operation 28429 as it gives your code a chance to calculate several of them at once 28430 and cache the result if necessary. 28431 """ 28432 28433 def EstimateTotalHeight(self): 28434 """ 28435 EstimateTotalHeight() -> Coord 28436 28437 This class forwards calls from EstimateTotalSize() to this function so 28438 derived classes can override either just the height or the width 28439 estimation, or just estimate both differently if desired in any 28440 wxHVScrolledWindow derived class. 28441 """ 28442 28443 def OnGetRowHeight(self, row): 28444 """ 28445 OnGetRowHeight(row) -> Coord 28446 28447 This function must be overridden in the derived class, and should 28448 return the height of the given row in pixels. 28449 """ 28450# end of class VarVScrollHelper 28451 28452 28453class VarHScrollHelper(VarScrollHelperBase): 28454 """ 28455 VarHScrollHelper(winToScroll) 28456 28457 This class provides functions wrapping the wxVarScrollHelperBase 28458 class, targeted for horizontal-specific scrolling. 28459 """ 28460 28461 def __init__(self, winToScroll): 28462 """ 28463 VarHScrollHelper(winToScroll) 28464 28465 This class provides functions wrapping the wxVarScrollHelperBase 28466 class, targeted for horizontal-specific scrolling. 28467 """ 28468 28469 def GetColumnCount(self): 28470 """ 28471 GetColumnCount() -> size_t 28472 28473 Returns the number of columns the target window contains. 28474 """ 28475 28476 def GetVisibleColumnsBegin(self): 28477 """ 28478 GetVisibleColumnsBegin() -> size_t 28479 28480 Returns the index of the first visible column based on the scroll 28481 position. 28482 """ 28483 28484 def GetVisibleColumnsEnd(self): 28485 """ 28486 GetVisibleColumnsEnd() -> size_t 28487 28488 Returns the index of the last visible column based on the scroll 28489 position. 28490 """ 28491 28492 def IsColumnVisible(self, column): 28493 """ 28494 IsColumnVisible(column) -> bool 28495 28496 Returns true if the given column is currently visible (even if only 28497 partially visible) or false otherwise. 28498 """ 28499 28500 def RefreshColumn(self, column): 28501 """ 28502 RefreshColumn(column) 28503 28504 Triggers a refresh for just the given column's area of the window if 28505 it's visible. 28506 """ 28507 28508 def RefreshColumns(self, from_, to_): 28509 """ 28510 RefreshColumns(from_, to_) 28511 28512 Triggers a refresh for the area between the specified range of columns 28513 given (inclusively). 28514 """ 28515 28516 def ScrollColumnPages(self, pages): 28517 """ 28518 ScrollColumnPages(pages) -> bool 28519 28520 Scroll by the specified number of pages which may be positive (to 28521 scroll right) or negative (to scroll left). 28522 """ 28523 28524 def ScrollColumns(self, columns): 28525 """ 28526 ScrollColumns(columns) -> bool 28527 28528 Scroll by the specified number of columns which may be positive (to 28529 scroll right) or negative (to scroll left). 28530 """ 28531 28532 def ScrollToColumn(self, column): 28533 """ 28534 ScrollToColumn(column) -> bool 28535 28536 Scroll to the specified column. 28537 """ 28538 28539 def SetColumnCount(self, columnCount): 28540 """ 28541 SetColumnCount(columnCount) 28542 28543 Set the number of columns the window contains. 28544 """ 28545 ColumnCount = property(None, None) 28546 VisibleColumnsBegin = property(None, None) 28547 VisibleColumnsEnd = property(None, None) 28548 28549 def EstimateTotalWidth(self): 28550 """ 28551 EstimateTotalWidth() -> Coord 28552 28553 This class forwards calls from EstimateTotalSize() to this function so 28554 derived classes can override either just the height or the width 28555 estimation, or just estimate both differently if desired in any 28556 wxHVScrolledWindow derived class. 28557 """ 28558 28559 def OnGetColumnsWidthHint(self, columnMin, columnMax): 28560 """ 28561 OnGetColumnsWidthHint(columnMin, columnMax) 28562 28563 This function doesn't have to be overridden but it may be useful to do 28564 so if calculating the columns' sizes is a relatively expensive 28565 operation as it gives your code a chance to calculate several of them 28566 at once and cache the result if necessary. 28567 """ 28568 28569 def OnGetColumnWidth(self, column): 28570 """ 28571 OnGetColumnWidth(column) -> Coord 28572 28573 This function must be overridden in the derived class, and should 28574 return the width of the given column in pixels. 28575 """ 28576# end of class VarHScrollHelper 28577 28578 28579class VarHVScrollHelper(VarVScrollHelper, VarHScrollHelper): 28580 """ 28581 VarHVScrollHelper(winToScroll) 28582 28583 This class provides functions wrapping the wxVarHScrollHelper and 28584 wxVarVScrollHelper classes, targeted for scrolling a window in both 28585 axis. 28586 """ 28587 28588 def __init__(self, winToScroll): 28589 """ 28590 VarHVScrollHelper(winToScroll) 28591 28592 This class provides functions wrapping the wxVarHScrollHelper and 28593 wxVarVScrollHelper classes, targeted for scrolling a window in both 28594 axis. 28595 """ 28596 28597 def IsVisible(self, *args, **kw): 28598 """ 28599 IsVisible(row, column) -> bool 28600 IsVisible(pos) -> bool 28601 28602 Returns true if both the given row and column are currently visible 28603 (even if only partially visible) or false otherwise. 28604 """ 28605 28606 def RefreshRowColumn(self, *args, **kw): 28607 """ 28608 RefreshRowColumn(row, column) 28609 RefreshRowColumn(pos) 28610 28611 Triggers a refresh for just the area shared between the given row and 28612 column of the window if it is visible. 28613 """ 28614 28615 def RefreshRowsColumns(self, *args, **kw): 28616 """ 28617 RefreshRowsColumns(fromRow, toRow, fromColumn, toColumn) 28618 RefreshRowsColumns(from, to) 28619 28620 Triggers a refresh for the visible area shared between all given rows 28621 and columns (inclusive) of the window. 28622 """ 28623 28624 def ScrollToRowColumn(self, *args, **kw): 28625 """ 28626 ScrollToRowColumn(row, column) -> bool 28627 ScrollToRowColumn(pos) -> bool 28628 28629 Scroll to the specified row and column. 28630 """ 28631 28632 def VirtualHitTest(self, *args, **kw): 28633 """ 28634 VirtualHitTest(x, y) -> Position 28635 VirtualHitTest(pos) -> Position 28636 28637 Returns the virtual scroll unit under the device unit given accounting 28638 for scroll position or wxNOT_FOUND (for the row, column, or possibly 28639 both values) if none. 28640 """ 28641 28642 def EnablePhysicalScrolling(self, vscrolling=True, hscrolling=True): 28643 """ 28644 EnablePhysicalScrolling(vscrolling=True, hscrolling=True) 28645 28646 With physical scrolling on (when this is true), the device origin is 28647 changed properly when a wxPaintDC is prepared, children are actually 28648 moved and laid out properly, and the contents of the window (pixels) 28649 are actually moved. 28650 """ 28651 28652 def GetRowColumnCount(self): 28653 """ 28654 GetRowColumnCount() -> Size 28655 28656 Returns the number of columns and rows the target window contains. 28657 """ 28658 28659 def GetVisibleBegin(self): 28660 """ 28661 GetVisibleBegin() -> Position 28662 28663 Returns the index of the first visible column and row based on the 28664 current scroll position. 28665 """ 28666 28667 def GetVisibleEnd(self): 28668 """ 28669 GetVisibleEnd() -> Position 28670 28671 Returns the index of the last visible column and row based on the 28672 scroll position. 28673 """ 28674 28675 def SetRowColumnCount(self, rowCount, columnCount): 28676 """ 28677 SetRowColumnCount(rowCount, columnCount) 28678 28679 Set the number of rows and columns the target window will contain. 28680 """ 28681 RowColumnCount = property(None, None) 28682 VisibleBegin = property(None, None) 28683 VisibleEnd = property(None, None) 28684# end of class VarHVScrollHelper 28685 28686 28687class VScrolledWindow(Panel, VarVScrollHelper): 28688 """ 28689 VScrolledWindow() 28690 VScrolledWindow(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=PanelNameStr) 28691 28692 In the name of this class, "V" may stand for "variable" because it can 28693 be used for scrolling rows of variable heights; "virtual", because it 28694 is not necessary to know the heights of all rows in advance only 28695 those which are shown on the screen need to be measured; or even 28696 "vertical", because this class only supports scrolling vertically. 28697 """ 28698 28699 def __init__(self, *args, **kw): 28700 """ 28701 VScrolledWindow() 28702 VScrolledWindow(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=PanelNameStr) 28703 28704 In the name of this class, "V" may stand for "variable" because it can 28705 be used for scrolling rows of variable heights; "virtual", because it 28706 is not necessary to know the heights of all rows in advance only 28707 those which are shown on the screen need to be measured; or even 28708 "vertical", because this class only supports scrolling vertically. 28709 """ 28710 28711 def Create(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=PanelNameStr): 28712 """ 28713 Create(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=PanelNameStr) -> bool 28714 28715 Same as the non-default constructor, but returns a status code: true 28716 if ok, false if the window couldn't be created. 28717 """ 28718 28719 @staticmethod 28720 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 28721 """ 28722 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 28723 """ 28724 28725 def HitTest(self, *args): 28726 """ 28727 Deprecated compatibility helper. 28728 """ 28729 28730 def GetFirstVisibleLine(self): 28731 """ 28732 GetFirstVisibleLine() -> unsignedlong 28733 28734 Deprecated compatibility helper. 28735 """ 28736 28737 def GetLastVisibleLine(self): 28738 """ 28739 GetLastVisibleLine() -> unsignedlong 28740 28741 Deprecated compatibility helper. 28742 """ 28743 28744 def GetLineCount(self): 28745 """ 28746 GetLineCount() -> unsignedlong 28747 28748 Deprecated compatibility helper. 28749 """ 28750 28751 def SetLineCount(self, count): 28752 """ 28753 SetLineCount(count) 28754 28755 Deprecated compatibility helper. 28756 """ 28757 28758 def RefreshLine(self, line): 28759 """ 28760 RefreshLine(line) 28761 28762 Deprecated compatibility helper. 28763 """ 28764 28765 def RefreshLines(self, from_, to_): 28766 """ 28767 RefreshLines(from_, to_) 28768 28769 Deprecated compatibility helper. 28770 """ 28771 28772 def ScrollToLine(self, line): 28773 """ 28774 ScrollToLine(line) -> bool 28775 28776 Deprecated compatibility helper. 28777 """ 28778 28779 def ScrollLines(self, lines): 28780 """ 28781 ScrollLines(lines) -> bool 28782 28783 Deprecated compatibility helper. 28784 """ 28785 28786 def ScrollPages(self, pages): 28787 """ 28788 ScrollPages(pages) -> bool 28789 28790 Deprecated compatibility helper. 28791 """ 28792 FirstVisibleLine = property(None, None) 28793 LastVisibleLine = property(None, None) 28794 LineCount = property(None, None) 28795# end of class VScrolledWindow 28796 28797 28798class HScrolledWindow(Panel, VarHScrollHelper): 28799 """ 28800 HScrolledWindow() 28801 HScrolledWindow(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=PanelNameStr) 28802 28803 In the name of this class, "H" stands for "horizontal" because it can 28804 be used for scrolling columns of variable widths. 28805 """ 28806 28807 def __init__(self, *args, **kw): 28808 """ 28809 HScrolledWindow() 28810 HScrolledWindow(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=PanelNameStr) 28811 28812 In the name of this class, "H" stands for "horizontal" because it can 28813 be used for scrolling columns of variable widths. 28814 """ 28815 28816 def Create(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=PanelNameStr): 28817 """ 28818 Create(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=PanelNameStr) -> bool 28819 28820 Same as the non-default constructor, but returns a status code: true 28821 if ok, false if the window couldn't be created. 28822 """ 28823 28824 @staticmethod 28825 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 28826 """ 28827 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 28828 """ 28829# end of class HScrolledWindow 28830 28831 28832class HVScrolledWindow(Panel, VarHVScrollHelper): 28833 """ 28834 HVScrolledWindow() 28835 HVScrolledWindow(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=PanelNameStr) 28836 28837 This window inherits all functionality of both vertical and 28838 horizontal, variable scrolled windows. 28839 """ 28840 28841 def __init__(self, *args, **kw): 28842 """ 28843 HVScrolledWindow() 28844 HVScrolledWindow(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=PanelNameStr) 28845 28846 This window inherits all functionality of both vertical and 28847 horizontal, variable scrolled windows. 28848 """ 28849 28850 def Create(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=PanelNameStr): 28851 """ 28852 Create(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=PanelNameStr) -> bool 28853 28854 Same as the non-default constructor, but returns a status code: true 28855 if ok, false if the window couldn't be created. 28856 """ 28857 28858 @staticmethod 28859 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 28860 """ 28861 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 28862 """ 28863# end of class HVScrolledWindow 28864 28865#-- end-vscroll --# 28866#-- begin-control --# 28867ELLIPSIZE_FLAGS_NONE = 0 28868ELLIPSIZE_FLAGS_PROCESS_MNEMONICS = 0 28869ELLIPSIZE_FLAGS_EXPAND_TABS = 0 28870ELLIPSIZE_FLAGS_DEFAULT = 0 28871ELLIPSIZE_NONE = 0 28872ELLIPSIZE_START = 0 28873ELLIPSIZE_MIDDLE = 0 28874ELLIPSIZE_END = 0 28875ControlNameStr = "" 28876 28877class Control(Window): 28878 """ 28879 Control(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, validator=DefaultValidator, name=ControlNameStr) 28880 Control() 28881 28882 This is the base class for a control or "widget". 28883 """ 28884 28885 def __init__(self, *args, **kw): 28886 """ 28887 Control(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, validator=DefaultValidator, name=ControlNameStr) 28888 Control() 28889 28890 This is the base class for a control or "widget". 28891 """ 28892 28893 def Create(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, validator=DefaultValidator, name=ControlNameStr): 28894 """ 28895 Create(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, validator=DefaultValidator, name=ControlNameStr) -> bool 28896 """ 28897 28898 def Command(self, event): 28899 """ 28900 Command(event) 28901 28902 Simulates the effect of the user issuing a command to the item. 28903 """ 28904 28905 def GetLabel(self): 28906 """ 28907 GetLabel() -> String 28908 28909 Returns the control's label, as it was passed to SetLabel(). 28910 """ 28911 28912 def GetLabelText(self, *args, **kw): 28913 """ 28914 GetLabelText() -> String 28915 GetLabelText(label) -> String 28916 28917 Returns the control's label without mnemonics. 28918 """ 28919 28920 def GetSizeFromTextSize(self, *args, **kw): 28921 """ 28922 GetSizeFromTextSize(xlen, ylen=-1) -> Size 28923 GetSizeFromTextSize(tsize) -> Size 28924 28925 Determine the size needed by the control to leave the given area for 28926 its text. 28927 """ 28928 28929 def SetLabel(self, label): 28930 """ 28931 SetLabel(label) 28932 28933 Sets the control's label. 28934 """ 28935 28936 def SetLabelText(self, text): 28937 """ 28938 SetLabelText(text) 28939 28940 Sets the control's label to exactly the given string. 28941 """ 28942 28943 def SetLabelMarkup(self, markup): 28944 """ 28945 SetLabelMarkup(markup) -> bool 28946 28947 Sets the controls label to a string using markup. 28948 """ 28949 28950 @staticmethod 28951 def RemoveMnemonics(str): 28952 """ 28953 RemoveMnemonics(str) -> String 28954 28955 Returns the given str string without mnemonics ("&" characters). 28956 """ 28957 28958 @staticmethod 28959 def EscapeMnemonics(text): 28960 """ 28961 EscapeMnemonics(text) -> String 28962 28963 Escapes the special mnemonics characters ("&") in the given string. 28964 """ 28965 28966 @staticmethod 28967 def Ellipsize(label, dc, mode, maxWidth, flags=ELLIPSIZE_FLAGS_DEFAULT): 28968 """ 28969 Ellipsize(label, dc, mode, maxWidth, flags=ELLIPSIZE_FLAGS_DEFAULT) -> String 28970 28971 Replaces parts of the label string with ellipsis, if needed, so that 28972 it fits into maxWidth pixels if possible. 28973 """ 28974 28975 @staticmethod 28976 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 28977 """ 28978 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 28979 """ 28980 Label = property(None, None) 28981 LabelText = property(None, None) 28982# end of class Control 28983 28984 28985PyControl = wx.deprecated(Control, 'Use Control instead.') 28986#-- end-control --# 28987#-- begin-ctrlsub --# 28988 28989class ItemContainerImmutable(object): 28990 """ 28991 ItemContainerImmutable() 28992 28993 wxItemContainer defines an interface which is implemented by all 28994 controls which have string subitems each of which may be selected. 28995 """ 28996 28997 def __init__(self): 28998 """ 28999 ItemContainerImmutable() 29000 29001 wxItemContainer defines an interface which is implemented by all 29002 controls which have string subitems each of which may be selected. 29003 """ 29004 29005 def GetCount(self): 29006 """ 29007 GetCount() -> unsignedint 29008 29009 Returns the number of items in the control. 29010 """ 29011 29012 def IsEmpty(self): 29013 """ 29014 IsEmpty() -> bool 29015 29016 Returns true if the control is empty or false if it has some items. 29017 """ 29018 29019 def GetString(self, n): 29020 """ 29021 GetString(n) -> String 29022 29023 Returns the label of the item with the given index. 29024 """ 29025 29026 def GetStrings(self): 29027 """ 29028 GetStrings() -> ArrayString 29029 29030 Returns the array of the labels of all items in the control. 29031 """ 29032 29033 def SetString(self, n, string): 29034 """ 29035 SetString(n, string) 29036 29037 Sets the label for the given item. 29038 """ 29039 29040 def FindString(self, string, caseSensitive=False): 29041 """ 29042 FindString(string, caseSensitive=False) -> int 29043 29044 Finds an item whose label matches the given string. 29045 """ 29046 29047 def SetSelection(self, n): 29048 """ 29049 SetSelection(n) 29050 29051 Sets the selection to the given item n or removes the selection 29052 entirely if n == wxNOT_FOUND. 29053 """ 29054 29055 def GetSelection(self): 29056 """ 29057 GetSelection() -> int 29058 29059 Returns the index of the selected item or wxNOT_FOUND if no item is 29060 selected. 29061 """ 29062 29063 def SetStringSelection(self, string): 29064 """ 29065 SetStringSelection(string) -> bool 29066 29067 Selects the item with the specified string in the control. 29068 """ 29069 29070 def GetStringSelection(self): 29071 """ 29072 GetStringSelection() -> String 29073 29074 Returns the label of the selected item or an empty string if no item 29075 is selected. 29076 """ 29077 29078 def Select(self, n): 29079 """ 29080 Select(n) 29081 29082 This is the same as SetSelection() and exists only because it is 29083 slightly more natural for controls which support multiple selection. 29084 """ 29085 Count = property(None, None) 29086 Selection = property(None, None) 29087 StringSelection = property(None, None) 29088 Strings = property(None, None) 29089# end of class ItemContainerImmutable 29090 29091 29092class ItemContainer(ItemContainerImmutable): 29093 """ 29094 This class is an abstract base class for some wxWidgets controls which 29095 contain several items such as wxListBox, wxCheckListBox, wxComboBox or 29096 wxChoice. 29097 """ 29098 29099 def Append(self, *args, **kw): 29100 """ 29101 Append(item) -> int 29102 Append(item, clientData) -> int 29103 Append(items) -> int 29104 29105 Appends item into the control. 29106 """ 29107 29108 def GetClientData(self, n): 29109 """ 29110 GetClientData(n) -> ClientData 29111 29112 Returns a pointer to the client data associated with the given item 29113 (if any). 29114 """ 29115 29116 def SetClientData(self, n, data): 29117 """ 29118 SetClientData(n, data) 29119 29120 Associates the given typed client data pointer with the given item: 29121 the data object will be deleted when the item is deleted (either 29122 explicitly by using Delete() or implicitly when the control itself is 29123 destroyed). 29124 """ 29125 29126 def Insert(self, *args, **kw): 29127 """ 29128 Insert(item, pos) -> int 29129 Insert(item, pos, clientData) -> int 29130 Insert(items, pos) -> int 29131 29132 Inserts item into the control. 29133 """ 29134 29135 def Set(self, items): 29136 """ 29137 Set(items) 29138 29139 Replaces the current control contents with the given items. 29140 """ 29141 29142 def Clear(self): 29143 """ 29144 Clear() 29145 29146 Removes all items from the control. 29147 """ 29148 29149 def Delete(self, n): 29150 """ 29151 Delete(n) 29152 29153 Deletes an item from the control. 29154 """ 29155 29156 def DetachClientObject(self, n): 29157 """ 29158 DetachClientObject(n) -> ClientData 29159 29160 Returns the client object associated with the given item and transfers 29161 its ownership to the caller. 29162 """ 29163 29164 def HasClientData(self): 29165 """ 29166 HasClientData() -> bool 29167 29168 Returns true, if either untyped data (void*) or object data 29169 (wxClientData*) is associated with the items of the control. 29170 """ 29171 29172 def HasClientObjectData(self): 29173 """ 29174 HasClientObjectData() -> bool 29175 29176 Returns true, if object data is associated with the items of the 29177 control. 29178 """ 29179 29180 def HasClientUntypedData(self): 29181 """ 29182 HasClientUntypedData() -> bool 29183 29184 Returns true, if untyped data (void*) is associated with the items of 29185 the control. 29186 """ 29187 29188 def GetClientObject(self, n): 29189 """ 29190 Alias for :meth:`GetClientData` 29191 """ 29192 29193 def SetClientObject(self, n, data): 29194 """ 29195 Alias for :meth:`SetClientData` 29196 """ 29197 29198 def AppendItems(self, items): 29199 """ 29200 29201 """ 29202 29203 def GetItems(self): 29204 """ 29205 29206 """ 29207 29208 def SetItems(self, items): 29209 """ 29210 29211 """ 29212 Items = property(None, None) 29213# end of class ItemContainer 29214 29215 29216class ControlWithItems(Control, ItemContainer): 29217 """ 29218 This is convenience class that derives from both wxControl and 29219 wxItemContainer. 29220 """ 29221# end of class ControlWithItems 29222 29223#-- end-ctrlsub --# 29224#-- begin-statbmp --# 29225StaticBitmapNameStr = "" 29226 29227class StaticBitmap(Control): 29228 """ 29229 StaticBitmap() 29230 StaticBitmap(parent, id=ID_ANY, bitmap=NullBitmap, pos=DefaultPosition, size=DefaultSize, style=0, name=StaticBitmapNameStr) 29231 29232 A static bitmap control displays a bitmap. 29233 """ 29234 29235 def __init__(self, *args, **kw): 29236 """ 29237 StaticBitmap() 29238 StaticBitmap(parent, id=ID_ANY, bitmap=NullBitmap, pos=DefaultPosition, size=DefaultSize, style=0, name=StaticBitmapNameStr) 29239 29240 A static bitmap control displays a bitmap. 29241 """ 29242 29243 def Create(self, parent, id=ID_ANY, bitmap=NullBitmap, pos=DefaultPosition, size=DefaultSize, style=0, name=StaticBitmapNameStr): 29244 """ 29245 Create(parent, id=ID_ANY, bitmap=NullBitmap, pos=DefaultPosition, size=DefaultSize, style=0, name=StaticBitmapNameStr) -> bool 29246 29247 Creation function, for two-step construction. 29248 """ 29249 29250 def GetBitmap(self): 29251 """ 29252 GetBitmap() -> Bitmap 29253 29254 Returns the bitmap currently used in the control. 29255 """ 29256 29257 def GetIcon(self): 29258 """ 29259 GetIcon() -> Icon 29260 29261 Returns the icon currently used in the control. 29262 """ 29263 29264 def SetBitmap(self, label): 29265 """ 29266 SetBitmap(label) 29267 29268 Sets the bitmap label. 29269 """ 29270 29271 def SetIcon(self, label): 29272 """ 29273 SetIcon(label) 29274 29275 Sets the label to the given icon. 29276 """ 29277 29278 @staticmethod 29279 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 29280 """ 29281 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 29282 """ 29283 Bitmap = property(None, None) 29284 Icon = property(None, None) 29285# end of class StaticBitmap 29286 29287#-- end-statbmp --# 29288#-- begin-stattext --# 29289ST_NO_AUTORESIZE = 0 29290ST_ELLIPSIZE_START = 0 29291ST_ELLIPSIZE_MIDDLE = 0 29292ST_ELLIPSIZE_END = 0 29293StaticTextNameStr = "" 29294 29295class StaticText(Control): 29296 """ 29297 StaticText() 29298 StaticText(parent, id=ID_ANY, label=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, name=StaticTextNameStr) 29299 29300 A static text control displays one or more lines of read-only text. 29301 """ 29302 29303 def __init__(self, *args, **kw): 29304 """ 29305 StaticText() 29306 StaticText(parent, id=ID_ANY, label=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, name=StaticTextNameStr) 29307 29308 A static text control displays one or more lines of read-only text. 29309 """ 29310 29311 def Create(self, parent, id=ID_ANY, label=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, name=StaticTextNameStr): 29312 """ 29313 Create(parent, id=ID_ANY, label=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, name=StaticTextNameStr) -> bool 29314 29315 Creation function, for two-step construction. 29316 """ 29317 29318 def IsEllipsized(self): 29319 """ 29320 IsEllipsized() -> bool 29321 29322 Returns true if the window styles for this control contains one of the 29323 wxST_ELLIPSIZE_START, wxST_ELLIPSIZE_MIDDLE or wxST_ELLIPSIZE_END 29324 styles. 29325 """ 29326 29327 def Wrap(self, width): 29328 """ 29329 Wrap(width) 29330 29331 This functions wraps the controls label so that each of its lines 29332 becomes at most width pixels wide if possible (the lines are broken at 29333 words boundaries so it might not be the case if words are too long). 29334 """ 29335 29336 @staticmethod 29337 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 29338 """ 29339 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 29340 """ 29341# end of class StaticText 29342 29343#-- end-stattext --# 29344#-- begin-statbox --# 29345StaticBoxNameStr = "" 29346 29347class StaticBox(Control): 29348 """ 29349 StaticBox() 29350 StaticBox(parent, id=ID_ANY, label=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, name=StaticBoxNameStr) 29351 29352 A static box is a rectangle drawn around other windows to denote a 29353 logical grouping of items. 29354 """ 29355 29356 def __init__(self, *args, **kw): 29357 """ 29358 StaticBox() 29359 StaticBox(parent, id=ID_ANY, label=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, name=StaticBoxNameStr) 29360 29361 A static box is a rectangle drawn around other windows to denote a 29362 logical grouping of items. 29363 """ 29364 29365 def Create(self, parent, id=ID_ANY, label=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, name=StaticBoxNameStr): 29366 """ 29367 Create(parent, id=ID_ANY, label=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, name=StaticBoxNameStr) -> bool 29368 29369 Creates the static box for two-step construction. 29370 """ 29371 29372 @staticmethod 29373 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 29374 """ 29375 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 29376 """ 29377 29378 def GetBordersForSizer(self): 29379 """ 29380 GetBordersForSizer() -> (borderTop, borderOther) 29381 29382 Returns extra space that may be needed for borders within a StaticBox. 29383 """ 29384# end of class StaticBox 29385 29386#-- end-statbox --# 29387#-- begin-statusbar --# 29388STB_SIZEGRIP = 0 29389STB_SHOW_TIPS = 0 29390STB_ELLIPSIZE_START = 0 29391STB_ELLIPSIZE_MIDDLE = 0 29392STB_ELLIPSIZE_END = 0 29393STB_DEFAULT_STYLE = 0 29394SB_NORMAL = 0 29395SB_FLAT = 0 29396SB_RAISED = 0 29397SB_SUNKEN = 0 29398StatusBarNameStr = "" 29399 29400class StatusBar(Control): 29401 """ 29402 StatusBar() 29403 StatusBar(parent, id=ID_ANY, style=STB_DEFAULT_STYLE, name=StatusBarNameStr) 29404 29405 A status bar is a narrow window that can be placed along the bottom of 29406 a frame to give small amounts of status information. 29407 """ 29408 29409 def __init__(self, *args, **kw): 29410 """ 29411 StatusBar() 29412 StatusBar(parent, id=ID_ANY, style=STB_DEFAULT_STYLE, name=StatusBarNameStr) 29413 29414 A status bar is a narrow window that can be placed along the bottom of 29415 a frame to give small amounts of status information. 29416 """ 29417 29418 def Create(self, parent, id=ID_ANY, style=STB_DEFAULT_STYLE, name=StatusBarNameStr): 29419 """ 29420 Create(parent, id=ID_ANY, style=STB_DEFAULT_STYLE, name=StatusBarNameStr) -> bool 29421 29422 Creates the window, for two-step construction. 29423 """ 29424 29425 def GetFieldRect(self, i): 29426 """ 29427 GetFieldRect(i) -> Rect 29428 29429 Returns the size and position of a field's internal bounding 29430 rectangle. 29431 """ 29432 29433 def GetFieldsCount(self): 29434 """ 29435 GetFieldsCount() -> int 29436 29437 Returns the number of fields in the status bar. 29438 """ 29439 29440 def GetField(self, n): 29441 """ 29442 GetField(n) -> StatusBarPane 29443 29444 Returns the wxStatusBarPane representing the n-th field. 29445 """ 29446 29447 def GetBorders(self): 29448 """ 29449 GetBorders() -> Size 29450 29451 Returns the horizontal and vertical borders used when rendering the 29452 field text inside the field area. 29453 """ 29454 29455 def GetStatusText(self, i=0): 29456 """ 29457 GetStatusText(i=0) -> String 29458 29459 Returns the string associated with a status bar field. 29460 """ 29461 29462 def GetStatusWidth(self, n): 29463 """ 29464 GetStatusWidth(n) -> int 29465 29466 Returns the width of the n-th field. 29467 """ 29468 29469 def GetStatusStyle(self, n): 29470 """ 29471 GetStatusStyle(n) -> int 29472 29473 Returns the style of the n-th field. 29474 """ 29475 29476 def PopStatusText(self, field=0): 29477 """ 29478 PopStatusText(field=0) 29479 29480 Restores the text to the value it had before the last call to 29481 PushStatusText(). 29482 """ 29483 29484 def PushStatusText(self, string, field=0): 29485 """ 29486 PushStatusText(string, field=0) 29487 29488 Saves the current field text in a per-field stack, and sets the field 29489 text to the string passed as argument. 29490 """ 29491 29492 def SetFieldsCount(self, number=1, widths=None): 29493 """ 29494 SetFieldsCount(number=1, widths=None) 29495 29496 Sets the number of fields, and optionally the field widths. 29497 """ 29498 29499 def SetMinHeight(self, height): 29500 """ 29501 SetMinHeight(height) 29502 29503 Sets the minimal possible height for the status bar. 29504 """ 29505 29506 def SetStatusStyles(self, styles): 29507 """ 29508 SetStatusStyles(styles) 29509 29510 Sets the styles of the fields in the status line which can make fields 29511 appear flat or raised instead of the standard sunken 3D border. 29512 """ 29513 29514 def SetStatusText(self, text, i=0): 29515 """ 29516 SetStatusText(text, i=0) 29517 29518 Sets the status text for the i-th field. 29519 """ 29520 29521 def SetStatusWidths(self, widths): 29522 """ 29523 SetStatusWidths(widths) 29524 29525 Sets the widths of the fields in the status line. 29526 """ 29527 29528 @staticmethod 29529 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 29530 """ 29531 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 29532 """ 29533 Borders = property(None, None) 29534 FieldRect = property(None, None) 29535 FieldsCount = property(None, None) 29536 StatusText = property(None, None) 29537# end of class StatusBar 29538 29539 29540class StatusBarPane(object): 29541 """ 29542 StatusBarPane(style=SB_NORMAL, width=0) 29543 29544 A status bar pane data container used by wxStatusBar. 29545 """ 29546 29547 def __init__(self, style=SB_NORMAL, width=0): 29548 """ 29549 StatusBarPane(style=SB_NORMAL, width=0) 29550 29551 A status bar pane data container used by wxStatusBar. 29552 """ 29553 29554 def GetWidth(self): 29555 """ 29556 GetWidth() -> int 29557 29558 Returns the pane width; it maybe negative, indicating a variable-width 29559 field. 29560 """ 29561 29562 def GetStyle(self): 29563 """ 29564 GetStyle() -> int 29565 29566 Returns the pane style. 29567 """ 29568 29569 def GetText(self): 29570 """ 29571 GetText() -> String 29572 29573 Returns the text currently shown in this pane. 29574 """ 29575 29576 def IsEllipsized(self): 29577 """ 29578 IsEllipsized() -> bool 29579 """ 29580 29581 def SetIsEllipsized(self, isEllipsized): 29582 """ 29583 SetIsEllipsized(isEllipsized) 29584 """ 29585 29586 def SetWidth(self, width): 29587 """ 29588 SetWidth(width) 29589 """ 29590 29591 def SetStyle(self, style): 29592 """ 29593 SetStyle(style) 29594 """ 29595 29596 def SetText(self, text): 29597 """ 29598 SetText(text) -> bool 29599 29600 Set text. 29601 """ 29602 29603 def PushText(self, text): 29604 """ 29605 PushText(text) -> bool 29606 29607 Save the existing text on top of a stack and make the new text 29608 current. 29609 """ 29610 29611 def PopText(self): 29612 """ 29613 PopText() -> bool 29614 29615 Restore the message saved by the last call to Push() (unless it was 29616 changed by an intervening call to SetText()) and return true if we 29617 really restored anything. 29618 """ 29619 Style = property(None, None) 29620 Text = property(None, None) 29621 Width = property(None, None) 29622# end of class StatusBarPane 29623 29624#-- end-statusbar --# 29625#-- begin-choice --# 29626ChoiceNameStr = "" 29627 29628class Choice(Control, ItemContainer): 29629 """ 29630 Choice() 29631 Choice(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, choices=[], style=0, validator=DefaultValidator, name=ChoiceNameStr) 29632 29633 A choice item is used to select one of a list of strings. 29634 """ 29635 29636 def __init__(self, *args, **kw): 29637 """ 29638 Choice() 29639 Choice(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, choices=[], style=0, validator=DefaultValidator, name=ChoiceNameStr) 29640 29641 A choice item is used to select one of a list of strings. 29642 """ 29643 29644 def Create(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, choices=[], style=0, validator=DefaultValidator, name=ChoiceNameStr): 29645 """ 29646 Create(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, choices=[], style=0, validator=DefaultValidator, name=ChoiceNameStr) -> bool 29647 29648 Creates the choice for two-step construction. 29649 """ 29650 29651 def GetColumns(self): 29652 """ 29653 GetColumns() -> int 29654 29655 Gets the number of columns in this choice item. 29656 """ 29657 29658 def GetCurrentSelection(self): 29659 """ 29660 GetCurrentSelection() -> int 29661 29662 Unlike wxControlWithItems::GetSelection() which only returns the 29663 accepted selection value (the selection in the control once the user 29664 closes the dropdown list), this function returns the current 29665 selection. 29666 """ 29667 29668 def SetColumns(self, n=1): 29669 """ 29670 SetColumns(n=1) 29671 29672 Sets the number of columns in this choice item. 29673 """ 29674 29675 def IsSorted(self): 29676 """ 29677 IsSorted() -> bool 29678 """ 29679 29680 def GetCount(self): 29681 """ 29682 GetCount() -> unsignedint 29683 29684 Returns the number of items in the control. 29685 """ 29686 29687 def GetSelection(self): 29688 """ 29689 GetSelection() -> int 29690 29691 Returns the index of the selected item or wxNOT_FOUND if no item is 29692 selected. 29693 """ 29694 29695 def SetSelection(self, n): 29696 """ 29697 SetSelection(n) 29698 29699 Sets the selection to the given item n or removes the selection 29700 entirely if n == wxNOT_FOUND. 29701 """ 29702 29703 def FindString(self, string, caseSensitive=False): 29704 """ 29705 FindString(string, caseSensitive=False) -> int 29706 29707 Finds an item whose label matches the given string. 29708 """ 29709 29710 def GetString(self, n): 29711 """ 29712 GetString(n) -> String 29713 29714 Returns the label of the item with the given index. 29715 """ 29716 29717 def SetString(self, n, string): 29718 """ 29719 SetString(n, string) 29720 29721 Sets the label for the given item. 29722 """ 29723 29724 @staticmethod 29725 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 29726 """ 29727 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 29728 """ 29729 Columns = property(None, None) 29730 Count = property(None, None) 29731 CurrentSelection = property(None, None) 29732 Selection = property(None, None) 29733# end of class Choice 29734 29735#-- end-choice --# 29736#-- begin-anybutton --# 29737BU_LEFT = 0 29738BU_TOP = 0 29739BU_RIGHT = 0 29740BU_BOTTOM = 0 29741BU_ALIGN_MASK = 0 29742BU_EXACTFIT = 0 29743BU_NOTEXT = 0 29744BU_AUTODRAW = 0 29745 29746class AnyButton(Control): 29747 """ 29748 AnyButton() 29749 29750 A class for common button functionality used as the base for the 29751 various button classes. 29752 """ 29753 29754 def __init__(self): 29755 """ 29756 AnyButton() 29757 29758 A class for common button functionality used as the base for the 29759 various button classes. 29760 """ 29761 29762 def SetBitmapMargins(self, *args, **kw): 29763 """ 29764 SetBitmapMargins(x, y) 29765 SetBitmapMargins(sz) 29766 29767 Set the margins between the bitmap and the text of the button. 29768 """ 29769 29770 def GetBitmap(self): 29771 """ 29772 GetBitmap() -> Bitmap 29773 29774 Return the bitmap shown by the button. 29775 """ 29776 29777 def GetBitmapCurrent(self): 29778 """ 29779 GetBitmapCurrent() -> Bitmap 29780 29781 Returns the bitmap used when the mouse is over the button, which may 29782 be invalid. 29783 """ 29784 29785 def GetBitmapDisabled(self): 29786 """ 29787 GetBitmapDisabled() -> Bitmap 29788 29789 Returns the bitmap for the disabled state, which may be invalid. 29790 """ 29791 29792 def GetBitmapFocus(self): 29793 """ 29794 GetBitmapFocus() -> Bitmap 29795 29796 Returns the bitmap for the focused state, which may be invalid. 29797 """ 29798 29799 def GetBitmapLabel(self): 29800 """ 29801 GetBitmapLabel() -> Bitmap 29802 29803 Returns the bitmap for the normal state. 29804 """ 29805 29806 def GetBitmapPressed(self): 29807 """ 29808 GetBitmapPressed() -> Bitmap 29809 29810 Returns the bitmap for the pressed state, which may be invalid. 29811 """ 29812 29813 def SetBitmap(self, bitmap, dir=LEFT): 29814 """ 29815 SetBitmap(bitmap, dir=LEFT) 29816 29817 Sets the bitmap to display in the button. 29818 """ 29819 29820 def SetBitmapCurrent(self, bitmap): 29821 """ 29822 SetBitmapCurrent(bitmap) 29823 29824 Sets the bitmap to be shown when the mouse is over the button. 29825 """ 29826 29827 def SetBitmapDisabled(self, bitmap): 29828 """ 29829 SetBitmapDisabled(bitmap) 29830 29831 Sets the bitmap for the disabled button appearance. 29832 """ 29833 29834 def SetBitmapFocus(self, bitmap): 29835 """ 29836 SetBitmapFocus(bitmap) 29837 29838 Sets the bitmap for the button appearance when it has the keyboard 29839 focus. 29840 """ 29841 29842 def SetBitmapLabel(self, bitmap): 29843 """ 29844 SetBitmapLabel(bitmap) 29845 29846 Sets the bitmap label for the button. 29847 """ 29848 29849 def SetBitmapPressed(self, bitmap): 29850 """ 29851 SetBitmapPressed(bitmap) 29852 29853 Sets the bitmap for the selected (depressed) button appearance. 29854 """ 29855 29856 def GetBitmapMargins(self): 29857 """ 29858 GetBitmapMargins() -> Size 29859 29860 Get the margins between the bitmap and the text of the button. 29861 """ 29862 29863 def SetBitmapPosition(self, dir): 29864 """ 29865 SetBitmapPosition(dir) 29866 29867 Set the position at which the bitmap is displayed. 29868 """ 29869 Bitmap = property(None, None) 29870 BitmapCurrent = property(None, None) 29871 BitmapDisabled = property(None, None) 29872 BitmapFocus = property(None, None) 29873 BitmapLabel = property(None, None) 29874 BitmapMargins = property(None, None) 29875 BitmapPressed = property(None, None) 29876# end of class AnyButton 29877 29878#-- end-anybutton --# 29879#-- begin-button --# 29880ButtonNameStr = "" 29881 29882class Button(AnyButton): 29883 """ 29884 Button() 29885 Button(parent, id=ID_ANY, label=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, validator=DefaultValidator, name=ButtonNameStr) 29886 29887 A button is a control that contains a text string, and is one of the 29888 most common elements of a GUI. 29889 """ 29890 29891 def __init__(self, *args, **kw): 29892 """ 29893 Button() 29894 Button(parent, id=ID_ANY, label=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, validator=DefaultValidator, name=ButtonNameStr) 29895 29896 A button is a control that contains a text string, and is one of the 29897 most common elements of a GUI. 29898 """ 29899 29900 def Create(self, parent, id=ID_ANY, label=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, validator=DefaultValidator, name=ButtonNameStr): 29901 """ 29902 Create(parent, id=ID_ANY, label=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, validator=DefaultValidator, name=ButtonNameStr) -> bool 29903 29904 Button creation function for two-step creation. 29905 """ 29906 29907 def GetAuthNeeded(self): 29908 """ 29909 GetAuthNeeded() -> bool 29910 29911 Returns true if an authentication needed symbol is displayed on the 29912 button. 29913 """ 29914 29915 def GetLabel(self): 29916 """ 29917 GetLabel() -> String 29918 29919 Returns the string label for the button. 29920 """ 29921 29922 def SetAuthNeeded(self, needed=True): 29923 """ 29924 SetAuthNeeded(needed=True) 29925 29926 Sets whether an authentication needed symbol should be displayed on 29927 the button. 29928 """ 29929 29930 def SetDefault(self): 29931 """ 29932 SetDefault() -> Window 29933 29934 This sets the button to be the default item in its top-level window 29935 (e.g. 29936 """ 29937 29938 def SetLabel(self, label): 29939 """ 29940 SetLabel(label) 29941 29942 Sets the string label for the button. 29943 """ 29944 29945 @staticmethod 29946 def GetDefaultSize(): 29947 """ 29948 GetDefaultSize() -> Size 29949 29950 Returns the default size for the buttons. 29951 """ 29952 29953 @staticmethod 29954 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 29955 """ 29956 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 29957 """ 29958 AuthNeeded = property(None, None) 29959 Label = property(None, None) 29960# end of class Button 29961 29962#-- end-button --# 29963#-- begin-bmpbuttn --# 29964 29965class BitmapButton(Button): 29966 """ 29967 BitmapButton() 29968 BitmapButton(parent, id=ID_ANY, bitmap=NullBitmap, pos=DefaultPosition, size=DefaultSize, style=BU_AUTODRAW, validator=DefaultValidator, name=ButtonNameStr) 29969 29970 A bitmap button is a control that contains a bitmap. 29971 """ 29972 29973 def __init__(self, *args, **kw): 29974 """ 29975 BitmapButton() 29976 BitmapButton(parent, id=ID_ANY, bitmap=NullBitmap, pos=DefaultPosition, size=DefaultSize, style=BU_AUTODRAW, validator=DefaultValidator, name=ButtonNameStr) 29977 29978 A bitmap button is a control that contains a bitmap. 29979 """ 29980 29981 def Create(self, parent, id=ID_ANY, bitmap=NullBitmap, pos=DefaultPosition, size=DefaultSize, style=BU_AUTODRAW, validator=DefaultValidator, name=ButtonNameStr): 29982 """ 29983 Create(parent, id=ID_ANY, bitmap=NullBitmap, pos=DefaultPosition, size=DefaultSize, style=BU_AUTODRAW, validator=DefaultValidator, name=ButtonNameStr) -> bool 29984 29985 Button creation function for two-step creation. 29986 """ 29987 29988 @staticmethod 29989 def NewCloseButton(parent, winid): 29990 """ 29991 NewCloseButton(parent, winid) -> BitmapButton 29992 29993 Helper function creating a standard-looking "Close" button. 29994 """ 29995 29996 @staticmethod 29997 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 29998 """ 29999 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 30000 """ 30001# end of class BitmapButton 30002 30003#-- end-bmpbuttn --# 30004#-- begin-withimage --# 30005 30006class WithImages(object): 30007 """ 30008 WithImages() 30009 30010 A mixin class to be used with other classes that use a wxImageList. 30011 """ 30012 NO_IMAGE = 0 30013 30014 def __init__(self): 30015 """ 30016 WithImages() 30017 30018 A mixin class to be used with other classes that use a wxImageList. 30019 """ 30020 30021 def AssignImageList(self, imageList): 30022 """ 30023 AssignImageList(imageList) 30024 30025 Sets the image list for the page control and takes ownership of the 30026 list. 30027 """ 30028 30029 def SetImageList(self, imageList): 30030 """ 30031 SetImageList(imageList) 30032 30033 Sets the image list to use. 30034 """ 30035 30036 def GetImageList(self): 30037 """ 30038 GetImageList() -> ImageList 30039 30040 Returns the associated image list, may be NULL. 30041 """ 30042 ImageList = property(None, None) 30043# end of class WithImages 30044 30045NO_IMAGE = 0 30046#-- end-withimage --# 30047#-- begin-bookctrl --# 30048BK_DEFAULT = 0 30049BK_TOP = 0 30050BK_BOTTOM = 0 30051BK_LEFT = 0 30052BK_RIGHT = 0 30053BK_ALIGN_MASK = 0 30054BK_HITTEST_NOWHERE = 0 30055BK_HITTEST_ONICON = 0 30056BK_HITTEST_ONLABEL = 0 30057BK_HITTEST_ONITEM = 0 30058BK_HITTEST_ONPAGE = 0 30059 30060class BookCtrlBase(Control, WithImages): 30061 """ 30062 BookCtrlBase() 30063 BookCtrlBase(parent, winid, pos=DefaultPosition, size=DefaultSize, style=0, name=EmptyString) 30064 30065 A book control is a convenient way of displaying multiple pages of 30066 information, displayed one page at a time. 30067 """ 30068 NO_IMAGE = 0 30069 30070 def __init__(self, *args, **kw): 30071 """ 30072 BookCtrlBase() 30073 BookCtrlBase(parent, winid, pos=DefaultPosition, size=DefaultSize, style=0, name=EmptyString) 30074 30075 A book control is a convenient way of displaying multiple pages of 30076 information, displayed one page at a time. 30077 """ 30078 30079 def GetPageImage(self, nPage): 30080 """ 30081 GetPageImage(nPage) -> int 30082 30083 Returns the image index for the given page. 30084 """ 30085 30086 def SetPageImage(self, page, image): 30087 """ 30088 SetPageImage(page, image) -> bool 30089 30090 Sets the image index for the given page. 30091 """ 30092 30093 def GetPageText(self, nPage): 30094 """ 30095 GetPageText(nPage) -> String 30096 30097 Returns the string for the given page. 30098 """ 30099 30100 def SetPageText(self, page, text): 30101 """ 30102 SetPageText(page, text) -> bool 30103 30104 Sets the text for the given page. 30105 """ 30106 30107 def GetSelection(self): 30108 """ 30109 GetSelection() -> int 30110 30111 Returns the currently selected page, or wxNOT_FOUND if none was 30112 selected. 30113 """ 30114 30115 def GetCurrentPage(self): 30116 """ 30117 GetCurrentPage() -> Window 30118 30119 Returns the currently selected page or NULL. 30120 """ 30121 30122 def SetSelection(self, page): 30123 """ 30124 SetSelection(page) -> int 30125 30126 Sets the selection to the given page, returning the previous 30127 selection. 30128 """ 30129 30130 def AdvanceSelection(self, forward=True): 30131 """ 30132 AdvanceSelection(forward=True) 30133 30134 Cycles through the tabs. 30135 """ 30136 30137 def ChangeSelection(self, page): 30138 """ 30139 ChangeSelection(page) -> int 30140 30141 Changes the selection to the given page, returning the previous 30142 selection. 30143 """ 30144 30145 def FindPage(self, page): 30146 """ 30147 FindPage(page) -> int 30148 30149 Returns the index of the specified tab window or wxNOT_FOUND if not 30150 found. 30151 """ 30152 30153 def AddPage(self, page, text, select=False, imageId=NO_IMAGE): 30154 """ 30155 AddPage(page, text, select=False, imageId=NO_IMAGE) -> bool 30156 30157 Adds a new page. 30158 """ 30159 30160 def DeleteAllPages(self): 30161 """ 30162 DeleteAllPages() -> bool 30163 30164 Deletes all pages. 30165 """ 30166 30167 def DeletePage(self, page): 30168 """ 30169 DeletePage(page) -> bool 30170 30171 Deletes the specified page, and the associated window. 30172 """ 30173 30174 def InsertPage(self, index, page, text, select=False, imageId=NO_IMAGE): 30175 """ 30176 InsertPage(index, page, text, select=False, imageId=NO_IMAGE) -> bool 30177 30178 Inserts a new page at the specified position. 30179 """ 30180 30181 def RemovePage(self, page): 30182 """ 30183 RemovePage(page) -> bool 30184 30185 Deletes the specified page, without deleting the associated window. 30186 """ 30187 30188 def GetPageCount(self): 30189 """ 30190 GetPageCount() -> size_t 30191 30192 Returns the number of pages in the control. 30193 """ 30194 30195 def GetPage(self, page): 30196 """ 30197 GetPage(page) -> Window 30198 30199 Returns the window at the given page position. 30200 """ 30201 30202 def Create(self, parent, winid, pos=DefaultPosition, size=DefaultSize, style=0, name=EmptyString): 30203 """ 30204 Create(parent, winid, pos=DefaultPosition, size=DefaultSize, style=0, name=EmptyString) -> bool 30205 30206 Constructs the book control with the given parameters. 30207 """ 30208 30209 def SetPageSize(self, size): 30210 """ 30211 SetPageSize(size) 30212 30213 Sets the width and height of the pages. 30214 """ 30215 30216 def HitTest(self, pt): 30217 """ 30218 HitTest(pt) -> (int, flags) 30219 30220 Returns the index of the tab at the specified position or wxNOT_FOUND 30221 if none. 30222 """ 30223 CurrentPage = property(None, None) 30224 PageCount = property(None, None) 30225 Selection = property(None, None) 30226# end of class BookCtrlBase 30227 30228 30229class BookCtrlEvent(NotifyEvent): 30230 """ 30231 BookCtrlEvent(eventType=wxEVT_NULL, id=0, sel=NOT_FOUND, oldSel=NOT_FOUND) 30232 30233 This class represents the events generated by book controls 30234 (wxNotebook, wxListbook, wxChoicebook, wxTreebook, wxAuiNotebook). 30235 """ 30236 30237 def __init__(self, eventType=wxEVT_NULL, id=0, sel=NOT_FOUND, oldSel=NOT_FOUND): 30238 """ 30239 BookCtrlEvent(eventType=wxEVT_NULL, id=0, sel=NOT_FOUND, oldSel=NOT_FOUND) 30240 30241 This class represents the events generated by book controls 30242 (wxNotebook, wxListbook, wxChoicebook, wxTreebook, wxAuiNotebook). 30243 """ 30244 30245 def GetOldSelection(self): 30246 """ 30247 GetOldSelection() -> int 30248 30249 Returns the page that was selected before the change, wxNOT_FOUND if 30250 none was selected. 30251 """ 30252 30253 def GetSelection(self): 30254 """ 30255 GetSelection() -> int 30256 30257 Returns the currently selected page, or wxNOT_FOUND if none was 30258 selected. 30259 """ 30260 30261 def SetOldSelection(self, page): 30262 """ 30263 SetOldSelection(page) 30264 30265 Sets the id of the page selected before the change. 30266 """ 30267 30268 def SetSelection(self, page): 30269 """ 30270 SetSelection(page) 30271 30272 Sets the selection member variable. 30273 """ 30274 OldSelection = property(None, None) 30275 Selection = property(None, None) 30276# end of class BookCtrlEvent 30277 30278#-- end-bookctrl --# 30279#-- begin-notebook --# 30280NB_DEFAULT = 0 30281NB_TOP = 0 30282NB_BOTTOM = 0 30283NB_LEFT = 0 30284NB_RIGHT = 0 30285NB_FIXEDWIDTH = 0 30286NB_MULTILINE = 0 30287NB_NOPAGETHEME = 0 30288NB_FLAT = 0 30289NB_HITTEST_NOWHERE = 0 30290NB_HITTEST_ONICON = 0 30291NB_HITTEST_ONLABEL = 0 30292NB_HITTEST_ONITEM = 0 30293NB_HITTEST_ONPAGE = 0 30294wxEVT_NOTEBOOK_PAGE_CHANGED = 0 30295wxEVT_NOTEBOOK_PAGE_CHANGING = 0 30296NotebookNameStr = "" 30297 30298class Notebook(BookCtrlBase): 30299 """ 30300 Notebook() 30301 Notebook(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=NotebookNameStr) 30302 30303 This class represents a notebook control, which manages multiple 30304 windows with associated tabs. 30305 """ 30306 30307 def __init__(self, *args, **kw): 30308 """ 30309 Notebook() 30310 Notebook(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=NotebookNameStr) 30311 30312 This class represents a notebook control, which manages multiple 30313 windows with associated tabs. 30314 """ 30315 30316 def Create(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=NotebookNameStr): 30317 """ 30318 Create(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=NotebookNameStr) -> bool 30319 30320 Creates a notebook control. 30321 """ 30322 30323 def GetRowCount(self): 30324 """ 30325 GetRowCount() -> int 30326 30327 Returns the number of rows in the notebook control. 30328 """ 30329 30330 def GetThemeBackgroundColour(self): 30331 """ 30332 GetThemeBackgroundColour() -> Colour 30333 30334 If running under Windows and themes are enabled for the application, 30335 this function returns a suitable colour for painting the background of 30336 a notebook page, and can be passed to SetBackgroundColour(). 30337 """ 30338 30339 def SetPadding(self, padding): 30340 """ 30341 SetPadding(padding) 30342 30343 Sets the amount of space around each page's icon and label, in pixels. 30344 """ 30345 30346 def GetPageImage(self, nPage): 30347 """ 30348 GetPageImage(nPage) -> int 30349 30350 Returns the image index for the given page. 30351 """ 30352 30353 def SetPageImage(self, page, image): 30354 """ 30355 SetPageImage(page, image) -> bool 30356 30357 Sets the image index for the given page. 30358 """ 30359 30360 def GetPageText(self, nPage): 30361 """ 30362 GetPageText(nPage) -> String 30363 30364 Returns the string for the given page. 30365 """ 30366 30367 def SetPageText(self, page, text): 30368 """ 30369 SetPageText(page, text) -> bool 30370 30371 Sets the text for the given page. 30372 """ 30373 30374 def GetSelection(self): 30375 """ 30376 GetSelection() -> int 30377 30378 Returns the currently selected page, or wxNOT_FOUND if none was 30379 selected. 30380 """ 30381 30382 def SetSelection(self, page): 30383 """ 30384 SetSelection(page) -> int 30385 30386 Sets the selection to the given page, returning the previous 30387 selection. 30388 """ 30389 30390 def ChangeSelection(self, page): 30391 """ 30392 ChangeSelection(page) -> int 30393 30394 Changes the selection to the given page, returning the previous 30395 selection. 30396 """ 30397 30398 def InsertPage(self, index, page, text, select=False, imageId=NO_IMAGE): 30399 """ 30400 InsertPage(index, page, text, select=False, imageId=NO_IMAGE) -> bool 30401 30402 Inserts a new page at the specified position. 30403 """ 30404 30405 @staticmethod 30406 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 30407 """ 30408 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 30409 """ 30410 RowCount = property(None, None) 30411 Selection = property(None, None) 30412 ThemeBackgroundColour = property(None, None) 30413# end of class Notebook 30414 30415 30416EVT_NOTEBOOK_PAGE_CHANGED = wx.PyEventBinder( wxEVT_NOTEBOOK_PAGE_CHANGED, 1 ) 30417EVT_NOTEBOOK_PAGE_CHANGING = wx.PyEventBinder( wxEVT_NOTEBOOK_PAGE_CHANGING, 1 ) 30418 30419# Aliases for the "best book" control as described in the overview 30420BookCtrl = Notebook 30421wxEVT_BOOKCTRL_PAGE_CHANGED = wxEVT_NOTEBOOK_PAGE_CHANGED 30422wxEVT_BOOKCTRL_PAGE_CHANGING = wxEVT_NOTEBOOK_PAGE_CHANGING 30423EVT_BOOKCTRL_PAGE_CHANGED = EVT_NOTEBOOK_PAGE_CHANGED 30424EVT_BOOKCTRL_PAGE_CHANGING = EVT_NOTEBOOK_PAGE_CHANGING 30425 30426# deprecated wxEVT aliases 30427wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGED = wxEVT_BOOKCTRL_PAGE_CHANGED 30428wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGING = wxEVT_BOOKCTRL_PAGE_CHANGING 30429wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED = wxEVT_NOTEBOOK_PAGE_CHANGED 30430wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING = wxEVT_NOTEBOOK_PAGE_CHANGING 30431#-- end-notebook --# 30432#-- begin-splitter --# 30433SP_NOBORDER = 0 30434SP_THIN_SASH = 0 30435SP_NOSASH = 0 30436SP_PERMIT_UNSPLIT = 0 30437SP_LIVE_UPDATE = 0 30438SP_3DSASH = 0 30439SP_3DBORDER = 0 30440SP_NO_XP_THEME = 0 30441SP_BORDER = 0 30442SP_3D = 0 30443SPLIT_HORIZONTAL = 0 30444SPLIT_VERTICAL = 0 30445SPLIT_DRAG_NONE = 0 30446SPLIT_DRAG_DRAGGING = 0 30447SPLIT_DRAG_LEFT_DOWN = 0 30448wxEVT_SPLITTER_SASH_POS_CHANGED = 0 30449wxEVT_SPLITTER_SASH_POS_CHANGING = 0 30450wxEVT_SPLITTER_DOUBLECLICKED = 0 30451wxEVT_SPLITTER_UNSPLIT = 0 30452 30453class SplitterWindow(Window): 30454 """ 30455 SplitterWindow() 30456 SplitterWindow(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=SP_3D, name="splitterWindow") 30457 30458 This class manages up to two subwindows. 30459 """ 30460 30461 def __init__(self, *args, **kw): 30462 """ 30463 SplitterWindow() 30464 SplitterWindow(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=SP_3D, name="splitterWindow") 30465 30466 This class manages up to two subwindows. 30467 """ 30468 30469 def Create(self, parent, id=ID_ANY, point=DefaultPosition, size=DefaultSize, style=SP_3D, name="splitter"): 30470 """ 30471 Create(parent, id=ID_ANY, point=DefaultPosition, size=DefaultSize, style=SP_3D, name="splitter") -> bool 30472 30473 Creation function, for two-step construction. 30474 """ 30475 30476 def GetMinimumPaneSize(self): 30477 """ 30478 GetMinimumPaneSize() -> int 30479 30480 Returns the current minimum pane size (defaults to zero). 30481 """ 30482 30483 def GetSashGravity(self): 30484 """ 30485 GetSashGravity() -> double 30486 30487 Returns the current sash gravity. 30488 """ 30489 30490 def GetSashPosition(self): 30491 """ 30492 GetSashPosition() -> int 30493 30494 Returns the current sash position. 30495 """ 30496 30497 def GetSashSize(self): 30498 """ 30499 GetSashSize() -> int 30500 30501 Returns the default sash size in pixels or 0 if it is invisible. 30502 """ 30503 30504 def GetDefaultSashSize(self): 30505 """ 30506 GetDefaultSashSize() -> int 30507 30508 Returns the default sash size in pixels. 30509 """ 30510 30511 def GetSplitMode(self): 30512 """ 30513 GetSplitMode() -> SplitMode 30514 30515 Gets the split mode. 30516 """ 30517 30518 def GetWindow1(self): 30519 """ 30520 GetWindow1() -> Window 30521 30522 Returns the left/top or only pane. 30523 """ 30524 30525 def GetWindow2(self): 30526 """ 30527 GetWindow2() -> Window 30528 30529 Returns the right/bottom pane. 30530 """ 30531 30532 def Initialize(self, window): 30533 """ 30534 Initialize(window) 30535 30536 Initializes the splitter window to have one pane. 30537 """ 30538 30539 def IsSashInvisible(self): 30540 """ 30541 IsSashInvisible() -> bool 30542 30543 Returns true if the sash is invisible even when the window is split, 30544 false otherwise. 30545 """ 30546 30547 def IsSplit(self): 30548 """ 30549 IsSplit() -> bool 30550 30551 Returns true if the window is split, false otherwise. 30552 """ 30553 30554 def ReplaceWindow(self, winOld, winNew): 30555 """ 30556 ReplaceWindow(winOld, winNew) -> bool 30557 30558 This function replaces one of the windows managed by the 30559 wxSplitterWindow with another one. 30560 """ 30561 30562 def SetMinimumPaneSize(self, paneSize): 30563 """ 30564 SetMinimumPaneSize(paneSize) 30565 30566 Sets the minimum pane size. 30567 """ 30568 30569 def SetSashGravity(self, gravity): 30570 """ 30571 SetSashGravity(gravity) 30572 30573 Sets the sash gravity. 30574 """ 30575 30576 def SetSashPosition(self, position, redraw=True): 30577 """ 30578 SetSashPosition(position, redraw=True) 30579 30580 Sets the sash position. 30581 """ 30582 30583 def SetSashSize(self, size): 30584 """ 30585 SetSashSize(size) 30586 30587 Returns the default sash size in pixels or 0 if it is invisible. 30588 """ 30589 30590 def SetSplitMode(self, mode): 30591 """ 30592 SetSplitMode(mode) 30593 30594 Sets the split mode. 30595 """ 30596 30597 def SetSashInvisible(self, invisible=True): 30598 """ 30599 SetSashInvisible(invisible=True) 30600 30601 Sets whether the sash should be invisible, even when the window is 30602 split. 30603 """ 30604 30605 def SplitHorizontally(self, window1, window2, sashPosition=0): 30606 """ 30607 SplitHorizontally(window1, window2, sashPosition=0) -> bool 30608 30609 Initializes the top and bottom panes of the splitter window. 30610 """ 30611 30612 def SplitVertically(self, window1, window2, sashPosition=0): 30613 """ 30614 SplitVertically(window1, window2, sashPosition=0) -> bool 30615 30616 Initializes the left and right panes of the splitter window. 30617 """ 30618 30619 def Unsplit(self, toRemove=None): 30620 """ 30621 Unsplit(toRemove=None) -> bool 30622 30623 Unsplits the window. 30624 """ 30625 30626 def UpdateSize(self): 30627 """ 30628 UpdateSize() 30629 30630 Causes any pending sizing of the sash and child panes to take place 30631 immediately. 30632 """ 30633 30634 @staticmethod 30635 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 30636 """ 30637 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 30638 """ 30639 DefaultSashSize = property(None, None) 30640 MinimumPaneSize = property(None, None) 30641 SashGravity = property(None, None) 30642 SashPosition = property(None, None) 30643 SashSize = property(None, None) 30644 SplitMode = property(None, None) 30645 Window1 = property(None, None) 30646 Window2 = property(None, None) 30647 SashInvisible = property(None, None) 30648# end of class SplitterWindow 30649 30650 30651class SplitterEvent(NotifyEvent): 30652 """ 30653 SplitterEvent(eventType=wxEVT_NULL, splitter=None) 30654 30655 This class represents the events generated by a splitter control. 30656 """ 30657 30658 def __init__(self, eventType=wxEVT_NULL, splitter=None): 30659 """ 30660 SplitterEvent(eventType=wxEVT_NULL, splitter=None) 30661 30662 This class represents the events generated by a splitter control. 30663 """ 30664 30665 def GetSashPosition(self): 30666 """ 30667 GetSashPosition() -> int 30668 30669 Returns the new sash position. 30670 """ 30671 30672 def GetWindowBeingRemoved(self): 30673 """ 30674 GetWindowBeingRemoved() -> Window 30675 30676 Returns a pointer to the window being removed when a splitter window 30677 is unsplit. 30678 """ 30679 30680 def GetX(self): 30681 """ 30682 GetX() -> int 30683 30684 Returns the x coordinate of the double-click point. 30685 """ 30686 30687 def GetY(self): 30688 """ 30689 GetY() -> int 30690 30691 Returns the y coordinate of the double-click point. 30692 """ 30693 30694 def SetSashPosition(self, pos): 30695 """ 30696 SetSashPosition(pos) 30697 30698 In the case of wxEVT_SPLITTER_SASH_POS_CHANGED events, sets the new 30699 sash position. 30700 """ 30701 SashPosition = property(None, None) 30702 WindowBeingRemoved = property(None, None) 30703 X = property(None, None) 30704 Y = property(None, None) 30705# end of class SplitterEvent 30706 30707 30708EVT_SPLITTER_SASH_POS_CHANGED = wx.PyEventBinder( wxEVT_SPLITTER_SASH_POS_CHANGED, 1 ) 30709EVT_SPLITTER_SASH_POS_CHANGING = wx.PyEventBinder( wxEVT_SPLITTER_SASH_POS_CHANGING, 1 ) 30710EVT_SPLITTER_DOUBLECLICKED = wx.PyEventBinder( wxEVT_SPLITTER_DOUBLECLICKED, 1 ) 30711EVT_SPLITTER_UNSPLIT = wx.PyEventBinder( wxEVT_SPLITTER_UNSPLIT, 1 ) 30712EVT_SPLITTER_DCLICK = EVT_SPLITTER_DOUBLECLICKED 30713 30714# deprecated wxEVT aliases 30715wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED = wxEVT_SPLITTER_SASH_POS_CHANGED 30716wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING = wxEVT_SPLITTER_SASH_POS_CHANGING 30717wxEVT_COMMAND_SPLITTER_DOUBLECLICKED = wxEVT_SPLITTER_DOUBLECLICKED 30718wxEVT_COMMAND_SPLITTER_UNSPLIT = wxEVT_SPLITTER_UNSPLIT 30719#-- end-splitter --# 30720#-- begin-collpane --# 30721CP_DEFAULT_STYLE = 0 30722CP_NO_TLW_RESIZE = 0 30723wxEVT_COLLAPSIBLEPANE_CHANGED = 0 30724CollapsiblePaneNameStr = "" 30725 30726class CollapsiblePane(Control): 30727 """ 30728 CollapsiblePane() 30729 CollapsiblePane(parent, id=ID_ANY, label=EmptyString, pos=DefaultPosition, size=DefaultSize, style=CP_DEFAULT_STYLE, validator=DefaultValidator, name=CollapsiblePaneNameStr) 30730 30731 A collapsible pane is a container with an embedded button-like control 30732 which can be used by the user to collapse or expand the pane's 30733 contents. 30734 """ 30735 30736 def __init__(self, *args, **kw): 30737 """ 30738 CollapsiblePane() 30739 CollapsiblePane(parent, id=ID_ANY, label=EmptyString, pos=DefaultPosition, size=DefaultSize, style=CP_DEFAULT_STYLE, validator=DefaultValidator, name=CollapsiblePaneNameStr) 30740 30741 A collapsible pane is a container with an embedded button-like control 30742 which can be used by the user to collapse or expand the pane's 30743 contents. 30744 """ 30745 30746 def Create(self, parent, id=ID_ANY, label=EmptyString, pos=DefaultPosition, size=DefaultSize, style=CP_DEFAULT_STYLE, validator=DefaultValidator, name=CollapsiblePaneNameStr): 30747 """ 30748 Create(parent, id=ID_ANY, label=EmptyString, pos=DefaultPosition, size=DefaultSize, style=CP_DEFAULT_STYLE, validator=DefaultValidator, name=CollapsiblePaneNameStr) -> bool 30749 """ 30750 30751 def Collapse(self, collapse=True): 30752 """ 30753 Collapse(collapse=True) 30754 30755 Collapses or expands the pane window. 30756 """ 30757 30758 def Expand(self): 30759 """ 30760 Expand() 30761 30762 Same as calling Collapse(false). 30763 """ 30764 30765 def GetPane(self): 30766 """ 30767 GetPane() -> Window 30768 30769 Returns a pointer to the pane window. 30770 """ 30771 30772 def IsCollapsed(self): 30773 """ 30774 IsCollapsed() -> bool 30775 30776 Returns true if the pane window is currently hidden. 30777 """ 30778 30779 def IsExpanded(self): 30780 """ 30781 IsExpanded() -> bool 30782 30783 Returns true if the pane window is currently shown. 30784 """ 30785 30786 @staticmethod 30787 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 30788 """ 30789 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 30790 """ 30791 Pane = property(None, None) 30792# end of class CollapsiblePane 30793 30794 30795class CollapsiblePaneEvent(CommandEvent): 30796 """ 30797 CollapsiblePaneEvent(generator, id, collapsed) 30798 30799 This event class is used for the events generated by 30800 wxCollapsiblePane. 30801 """ 30802 30803 def __init__(self, generator, id, collapsed): 30804 """ 30805 CollapsiblePaneEvent(generator, id, collapsed) 30806 30807 This event class is used for the events generated by 30808 wxCollapsiblePane. 30809 """ 30810 30811 def GetCollapsed(self): 30812 """ 30813 GetCollapsed() -> bool 30814 30815 Returns true if the pane has been collapsed. 30816 """ 30817 30818 def SetCollapsed(self, collapsed): 30819 """ 30820 SetCollapsed(collapsed) 30821 30822 Sets this as a collapsed pane event (if collapsed is true) or as an 30823 expanded pane event (if collapsed is false). 30824 """ 30825 Collapsed = property(None, None) 30826# end of class CollapsiblePaneEvent 30827 30828 30829EVT_COLLAPSIBLEPANE_CHANGED = wx.PyEventBinder( wxEVT_COLLAPSIBLEPANE_CHANGED ) 30830 30831# deprecated wxEVT alias 30832wxEVT_COMMAND_COLLPANE_CHANGED = wxEVT_COLLAPSIBLEPANE_CHANGED 30833#-- end-collpane --# 30834#-- begin-statline --# 30835StaticLineNameStr = "" 30836 30837class StaticLine(Control): 30838 """ 30839 StaticLine() 30840 StaticLine(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=LI_HORIZONTAL, name=StaticLineNameStr) 30841 30842 A static line is just a line which may be used in a dialog to separate 30843 the groups of controls. 30844 """ 30845 30846 def __init__(self, *args, **kw): 30847 """ 30848 StaticLine() 30849 StaticLine(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=LI_HORIZONTAL, name=StaticLineNameStr) 30850 30851 A static line is just a line which may be used in a dialog to separate 30852 the groups of controls. 30853 """ 30854 30855 def Create(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=LI_HORIZONTAL, name=StaticLineNameStr): 30856 """ 30857 Create(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=LI_HORIZONTAL, name=StaticLineNameStr) -> bool 30858 30859 Creates the static line for two-step construction. 30860 """ 30861 30862 def IsVertical(self): 30863 """ 30864 IsVertical() -> bool 30865 30866 Returns true if the line is vertical, false if horizontal. 30867 """ 30868 30869 @staticmethod 30870 def GetDefaultSize(): 30871 """ 30872 GetDefaultSize() -> int 30873 30874 This static function returns the size which will be given to the 30875 smaller dimension of the static line, i.e. 30876 """ 30877 30878 @staticmethod 30879 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 30880 """ 30881 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 30882 """ 30883# end of class StaticLine 30884 30885#-- end-statline --# 30886#-- begin-textcompleter --# 30887 30888class TextCompleter(object): 30889 """ 30890 Base class for custom text completer objects. 30891 """ 30892 30893 def Start(self, prefix): 30894 """ 30895 Start(prefix) -> bool 30896 30897 Function called to start iteration over the completions for the given 30898 prefix. 30899 """ 30900 30901 def GetNext(self): 30902 """ 30903 GetNext() -> String 30904 30905 Called to retrieve the next completion. 30906 """ 30907 Next = property(None, None) 30908# end of class TextCompleter 30909 30910 30911class TextCompleterSimple(TextCompleter): 30912 """ 30913 A simpler base class for custom completer objects. 30914 """ 30915 30916 def GetCompletions(self, prefix): 30917 """ 30918 GetCompletions(prefix) -> res 30919 30920 Pure virtual method returning all possible completions for the given 30921 prefix. 30922 """ 30923 30924 def Start(self, prefix): 30925 """ 30926 Start(prefix) -> bool 30927 30928 Function called to start iteration over the completions for the given 30929 prefix. 30930 """ 30931 30932 def GetNext(self): 30933 """ 30934 GetNext() -> String 30935 30936 Called to retrieve the next completion. 30937 """ 30938 Next = property(None, None) 30939# end of class TextCompleterSimple 30940 30941#-- end-textcompleter --# 30942#-- begin-textentry --# 30943 30944class TextEntry(object): 30945 """ 30946 Common base class for single line text entry fields. 30947 """ 30948 30949 def SetMargins(self, *args, **kw): 30950 """ 30951 SetMargins(pt) -> bool 30952 SetMargins(left, top=-1) -> bool 30953 30954 Attempts to set the control margins. 30955 """ 30956 30957 def AppendText(self, text): 30958 """ 30959 AppendText(text) 30960 30961 Appends the text to the end of the text control. 30962 """ 30963 30964 def AutoComplete(self, *args, **kw): 30965 """ 30966 AutoComplete(choices) -> bool 30967 AutoComplete(completer) -> bool 30968 30969 Call this function to enable auto-completion of the text typed in a 30970 single-line text control using the given choices. 30971 """ 30972 30973 def AutoCompleteFileNames(self): 30974 """ 30975 AutoCompleteFileNames() -> bool 30976 30977 Call this function to enable auto-completion of the text typed in a 30978 single-line text control using all valid file system paths. 30979 """ 30980 30981 def AutoCompleteDirectories(self): 30982 """ 30983 AutoCompleteDirectories() -> bool 30984 30985 Call this function to enable auto-completion of the text using the 30986 file system directories. 30987 """ 30988 30989 def CanCopy(self): 30990 """ 30991 CanCopy() -> bool 30992 30993 Returns true if the selection can be copied to the clipboard. 30994 """ 30995 30996 def CanCut(self): 30997 """ 30998 CanCut() -> bool 30999 31000 Returns true if the selection can be cut to the clipboard. 31001 """ 31002 31003 def CanPaste(self): 31004 """ 31005 CanPaste() -> bool 31006 31007 Returns true if the contents of the clipboard can be pasted into the 31008 text control. 31009 """ 31010 31011 def CanRedo(self): 31012 """ 31013 CanRedo() -> bool 31014 31015 Returns true if there is a redo facility available and the last 31016 operation can be redone. 31017 """ 31018 31019 def CanUndo(self): 31020 """ 31021 CanUndo() -> bool 31022 31023 Returns true if there is an undo facility available and the last 31024 operation can be undone. 31025 """ 31026 31027 def ChangeValue(self, value): 31028 """ 31029 ChangeValue(value) 31030 31031 Sets the new text control value. 31032 """ 31033 31034 def Clear(self): 31035 """ 31036 Clear() 31037 31038 Clears the text in the control. 31039 """ 31040 31041 def Copy(self): 31042 """ 31043 Copy() 31044 31045 Copies the selected text to the clipboard. 31046 """ 31047 31048 def Cut(self): 31049 """ 31050 Cut() 31051 31052 Copies the selected text to the clipboard and removes it from the 31053 control. 31054 """ 31055 31056 def GetInsertionPoint(self): 31057 """ 31058 GetInsertionPoint() -> long 31059 31060 Returns the insertion point, or cursor, position. 31061 """ 31062 31063 def GetLastPosition(self): 31064 """ 31065 GetLastPosition() -> TextPos 31066 31067 Returns the zero based index of the last position in the text control, 31068 which is equal to the number of characters in the control. 31069 """ 31070 31071 def GetRange(self, from_, to_): 31072 """ 31073 GetRange(from_, to_) -> String 31074 31075 Returns the string containing the text starting in the positions from 31076 and up to to in the control. 31077 """ 31078 31079 def GetSelection(self): 31080 """ 31081 GetSelection() -> (from, to) 31082 31083 Gets the current selection span. 31084 """ 31085 31086 def GetStringSelection(self): 31087 """ 31088 GetStringSelection() -> String 31089 31090 Gets the text currently selected in the control. 31091 """ 31092 31093 def GetValue(self): 31094 """ 31095 GetValue() -> String 31096 31097 Gets the contents of the control. 31098 """ 31099 31100 def IsEditable(self): 31101 """ 31102 IsEditable() -> bool 31103 31104 Returns true if the controls contents may be edited by user (note that 31105 it always can be changed by the program). 31106 """ 31107 31108 def IsEmpty(self): 31109 """ 31110 IsEmpty() -> bool 31111 31112 Returns true if the control is currently empty. 31113 """ 31114 31115 def Paste(self): 31116 """ 31117 Paste() 31118 31119 Pastes text from the clipboard to the text item. 31120 """ 31121 31122 def Redo(self): 31123 """ 31124 Redo() 31125 31126 If there is a redo facility and the last operation can be redone, 31127 redoes the last operation. 31128 """ 31129 31130 def Remove(self, from_, to_): 31131 """ 31132 Remove(from_, to_) 31133 31134 Removes the text starting at the first given position up to (but not 31135 including) the character at the last position. 31136 """ 31137 31138 def Replace(self, from_, to_, value): 31139 """ 31140 Replace(from_, to_, value) 31141 31142 Replaces the text starting at the first position up to (but not 31143 including) the character at the last position with the given text. 31144 """ 31145 31146 def SetEditable(self, editable): 31147 """ 31148 SetEditable(editable) 31149 31150 Makes the text item editable or read-only, overriding the 31151 wxTE_READONLY flag. 31152 """ 31153 31154 def SetInsertionPoint(self, pos): 31155 """ 31156 SetInsertionPoint(pos) 31157 31158 Sets the insertion point at the given position. 31159 """ 31160 31161 def SetInsertionPointEnd(self): 31162 """ 31163 SetInsertionPointEnd() 31164 31165 Sets the insertion point at the end of the text control. 31166 """ 31167 31168 def SetMaxLength(self, len): 31169 """ 31170 SetMaxLength(len) 31171 31172 This function sets the maximum number of characters the user can enter 31173 into the control. 31174 """ 31175 31176 def SetSelection(self, from_, to_): 31177 """ 31178 SetSelection(from_, to_) 31179 31180 Selects the text starting at the first position up to (but not 31181 including) the character at the last position. 31182 """ 31183 31184 def SelectAll(self): 31185 """ 31186 SelectAll() 31187 31188 Selects all text in the control. 31189 """ 31190 31191 def SelectNone(self): 31192 """ 31193 SelectNone() 31194 31195 Deselects selected text in the control. 31196 """ 31197 31198 def SetHint(self, hint): 31199 """ 31200 SetHint(hint) -> bool 31201 31202 Sets a hint shown in an empty unfocused text control. 31203 """ 31204 31205 def GetHint(self): 31206 """ 31207 GetHint() -> String 31208 31209 Returns the current hint string. 31210 """ 31211 31212 def GetMargins(self): 31213 """ 31214 GetMargins() -> Point 31215 31216 Returns the margins used by the control. 31217 """ 31218 31219 def SetValue(self, value): 31220 """ 31221 SetValue(value) 31222 31223 Sets the new text control value. 31224 """ 31225 31226 def Undo(self): 31227 """ 31228 Undo() 31229 31230 If there is an undo facility and the last operation can be undone, 31231 undoes the last operation. 31232 """ 31233 31234 def WriteText(self, text): 31235 """ 31236 WriteText(text) 31237 31238 Writes the text into the text control at the current insertion 31239 position. 31240 """ 31241 Hint = property(None, None) 31242 InsertionPoint = property(None, None) 31243 LastPosition = property(None, None) 31244 Margins = property(None, None) 31245 StringSelection = property(None, None) 31246 Value = property(None, None) 31247# end of class TextEntry 31248 31249#-- end-textentry --# 31250#-- begin-textctrl --# 31251TE_NO_VSCROLL = 0 31252TE_READONLY = 0 31253TE_MULTILINE = 0 31254TE_PROCESS_TAB = 0 31255TE_LEFT = 0 31256TE_CENTER = 0 31257TE_RIGHT = 0 31258TE_CENTRE = 0 31259TE_RICH = 0 31260TE_PROCESS_ENTER = 0 31261TE_PASSWORD = 0 31262TE_AUTO_URL = 0 31263TE_NOHIDESEL = 0 31264TE_DONTWRAP = 0 31265TE_CHARWRAP = 0 31266TE_WORDWRAP = 0 31267TE_BESTWRAP = 0 31268TE_RICH2 = 0 31269TEXT_TYPE_ANY = 0 31270TEXT_ALIGNMENT_DEFAULT = 0 31271TEXT_ALIGNMENT_LEFT = 0 31272TEXT_ALIGNMENT_CENTRE = 0 31273TEXT_ALIGNMENT_CENTER = 0 31274TEXT_ALIGNMENT_RIGHT = 0 31275TEXT_ALIGNMENT_JUSTIFIED = 0 31276TEXT_ATTR_TEXT_COLOUR = 0 31277TEXT_ATTR_BACKGROUND_COLOUR = 0 31278TEXT_ATTR_FONT_FACE = 0 31279TEXT_ATTR_FONT_POINT_SIZE = 0 31280TEXT_ATTR_FONT_PIXEL_SIZE = 0 31281TEXT_ATTR_FONT_WEIGHT = 0 31282TEXT_ATTR_FONT_ITALIC = 0 31283TEXT_ATTR_FONT_UNDERLINE = 0 31284TEXT_ATTR_FONT_STRIKETHROUGH = 0 31285TEXT_ATTR_FONT_ENCODING = 0 31286TEXT_ATTR_FONT_FAMILY = 0 31287TEXT_ATTR_FONT_SIZE = 0 31288TEXT_ATTR_FONT = 0 31289TEXT_ATTR_ALIGNMENT = 0 31290TEXT_ATTR_LEFT_INDENT = 0 31291TEXT_ATTR_RIGHT_INDENT = 0 31292TEXT_ATTR_TABS = 0 31293TEXT_ATTR_PARA_SPACING_AFTER = 0 31294TEXT_ATTR_PARA_SPACING_BEFORE = 0 31295TEXT_ATTR_LINE_SPACING = 0 31296TEXT_ATTR_CHARACTER_STYLE_NAME = 0 31297TEXT_ATTR_PARAGRAPH_STYLE_NAME = 0 31298TEXT_ATTR_LIST_STYLE_NAME = 0 31299TEXT_ATTR_BULLET_STYLE = 0 31300TEXT_ATTR_BULLET_NUMBER = 0 31301TEXT_ATTR_BULLET_TEXT = 0 31302TEXT_ATTR_BULLET_NAME = 0 31303TEXT_ATTR_BULLET = 0 31304TEXT_ATTR_URL = 0 31305TEXT_ATTR_PAGE_BREAK = 0 31306TEXT_ATTR_EFFECTS = 0 31307TEXT_ATTR_OUTLINE_LEVEL = 0 31308TEXT_ATTR_CHARACTER = 0 31309TEXT_ATTR_PARAGRAPH = 0 31310TEXT_ATTR_ALL = 0 31311TEXT_ATTR_BULLET_STYLE_NONE = 0 31312TEXT_ATTR_BULLET_STYLE_ARABIC = 0 31313TEXT_ATTR_BULLET_STYLE_LETTERS_UPPER = 0 31314TEXT_ATTR_BULLET_STYLE_LETTERS_LOWER = 0 31315TEXT_ATTR_BULLET_STYLE_ROMAN_UPPER = 0 31316TEXT_ATTR_BULLET_STYLE_ROMAN_LOWER = 0 31317TEXT_ATTR_BULLET_STYLE_SYMBOL = 0 31318TEXT_ATTR_BULLET_STYLE_BITMAP = 0 31319TEXT_ATTR_BULLET_STYLE_PARENTHESES = 0 31320TEXT_ATTR_BULLET_STYLE_PERIOD = 0 31321TEXT_ATTR_BULLET_STYLE_STANDARD = 0 31322TEXT_ATTR_BULLET_STYLE_RIGHT_PARENTHESIS = 0 31323TEXT_ATTR_BULLET_STYLE_OUTLINE = 0 31324TEXT_ATTR_BULLET_STYLE_ALIGN_LEFT = 0 31325TEXT_ATTR_BULLET_STYLE_ALIGN_RIGHT = 0 31326TEXT_ATTR_BULLET_STYLE_ALIGN_CENTRE = 0 31327TEXT_ATTR_BULLET_STYLE_CONTINUATION = 0 31328TEXT_ATTR_EFFECT_NONE = 0 31329TEXT_ATTR_EFFECT_CAPITALS = 0 31330TEXT_ATTR_EFFECT_SMALL_CAPITALS = 0 31331TEXT_ATTR_EFFECT_STRIKETHROUGH = 0 31332TEXT_ATTR_EFFECT_DOUBLE_STRIKETHROUGH = 0 31333TEXT_ATTR_EFFECT_SHADOW = 0 31334TEXT_ATTR_EFFECT_EMBOSS = 0 31335TEXT_ATTR_EFFECT_OUTLINE = 0 31336TEXT_ATTR_EFFECT_ENGRAVE = 0 31337TEXT_ATTR_EFFECT_SUPERSCRIPT = 0 31338TEXT_ATTR_EFFECT_SUBSCRIPT = 0 31339TEXT_ATTR_LINE_SPACING_NORMAL = 0 31340TEXT_ATTR_LINE_SPACING_HALF = 0 31341TEXT_ATTR_LINE_SPACING_TWICE = 0 31342TE_HT_UNKNOWN = 0 31343TE_HT_BEFORE = 0 31344TE_HT_ON_TEXT = 0 31345TE_HT_BELOW = 0 31346TE_HT_BEYOND = 0 31347wxEVT_TEXT = 0 31348wxEVT_TEXT_ENTER = 0 31349wxEVT_TEXT_URL = 0 31350wxEVT_TEXT_MAXLEN = 0 31351 31352class TextAttr(object): 31353 """ 31354 TextAttr() 31355 TextAttr(colText, colBack=NullColour, font=NullFont, alignment=TEXT_ALIGNMENT_DEFAULT) 31356 TextAttr(attr) 31357 31358 wxTextAttr represents the character and paragraph attributes, or 31359 style, for a range of text in a wxTextCtrl or wxRichTextCtrl. 31360 """ 31361 31362 def __init__(self, *args, **kw): 31363 """ 31364 TextAttr() 31365 TextAttr(colText, colBack=NullColour, font=NullFont, alignment=TEXT_ALIGNMENT_DEFAULT) 31366 TextAttr(attr) 31367 31368 wxTextAttr represents the character and paragraph attributes, or 31369 style, for a range of text in a wxTextCtrl or wxRichTextCtrl. 31370 """ 31371 31372 def GetAlignment(self): 31373 """ 31374 GetAlignment() -> TextAttrAlignment 31375 31376 Returns the alignment flags. 31377 """ 31378 31379 def GetBackgroundColour(self): 31380 """ 31381 GetBackgroundColour() -> Colour 31382 31383 Returns the background colour. 31384 """ 31385 31386 def GetBulletFont(self): 31387 """ 31388 GetBulletFont() -> String 31389 31390 Returns a string containing the name of the font associated with the 31391 bullet symbol. 31392 """ 31393 31394 def GetBulletName(self): 31395 """ 31396 GetBulletName() -> String 31397 31398 Returns the standard bullet name, applicable if the bullet style is 31399 wxTEXT_ATTR_BULLET_STYLE_STANDARD. 31400 """ 31401 31402 def GetBulletNumber(self): 31403 """ 31404 GetBulletNumber() -> int 31405 31406 Returns the bullet number. 31407 """ 31408 31409 def GetBulletStyle(self): 31410 """ 31411 GetBulletStyle() -> int 31412 31413 Returns the bullet style. 31414 """ 31415 31416 def GetBulletText(self): 31417 """ 31418 GetBulletText() -> String 31419 31420 Returns the bullet text, which could be a symbol, or (for example) 31421 cached outline text. 31422 """ 31423 31424 def GetCharacterStyleName(self): 31425 """ 31426 GetCharacterStyleName() -> String 31427 31428 Returns the name of the character style. 31429 """ 31430 31431 def GetFlags(self): 31432 """ 31433 GetFlags() -> long 31434 31435 Returns flags indicating which attributes are applicable. 31436 """ 31437 31438 def GetFont(self): 31439 """ 31440 GetFont() -> Font 31441 31442 Creates and returns a font specified by the font attributes in the 31443 wxTextAttr object. 31444 """ 31445 31446 def GetFontAttributes(self, font, flags=TEXT_ATTR_FONT): 31447 """ 31448 GetFontAttributes(font, flags=TEXT_ATTR_FONT) -> bool 31449 31450 Gets the font attributes from the given font, using only the 31451 attributes specified by flags. 31452 """ 31453 31454 def GetFontEncoding(self): 31455 """ 31456 GetFontEncoding() -> FontEncoding 31457 31458 Returns the font encoding. 31459 """ 31460 31461 def GetFontFaceName(self): 31462 """ 31463 GetFontFaceName() -> String 31464 31465 Returns the font face name. 31466 """ 31467 31468 def GetFontFamily(self): 31469 """ 31470 GetFontFamily() -> FontFamily 31471 31472 Returns the font family. 31473 """ 31474 31475 def GetFontSize(self): 31476 """ 31477 GetFontSize() -> int 31478 31479 Returns the font size in points. 31480 """ 31481 31482 def GetFontStyle(self): 31483 """ 31484 GetFontStyle() -> FontStyle 31485 31486 Returns the font style. 31487 """ 31488 31489 def GetFontUnderlined(self): 31490 """ 31491 GetFontUnderlined() -> bool 31492 31493 Returns true if the font is underlined. 31494 """ 31495 31496 def GetFontWeight(self): 31497 """ 31498 GetFontWeight() -> FontWeight 31499 31500 Returns the font weight. 31501 """ 31502 31503 def GetLeftIndent(self): 31504 """ 31505 GetLeftIndent() -> long 31506 31507 Returns the left indent in tenths of a millimetre. 31508 """ 31509 31510 def GetLeftSubIndent(self): 31511 """ 31512 GetLeftSubIndent() -> long 31513 31514 Returns the left sub-indent in tenths of a millimetre. 31515 """ 31516 31517 def GetLineSpacing(self): 31518 """ 31519 GetLineSpacing() -> int 31520 31521 Returns the line spacing value, one of wxTextAttrLineSpacing values. 31522 """ 31523 31524 def GetListStyleName(self): 31525 """ 31526 GetListStyleName() -> String 31527 31528 Returns the name of the list style. 31529 """ 31530 31531 def GetOutlineLevel(self): 31532 """ 31533 GetOutlineLevel() -> int 31534 31535 Returns the outline level. 31536 """ 31537 31538 def GetParagraphSpacingAfter(self): 31539 """ 31540 GetParagraphSpacingAfter() -> int 31541 31542 Returns the space in tenths of a millimeter after the paragraph. 31543 """ 31544 31545 def GetParagraphSpacingBefore(self): 31546 """ 31547 GetParagraphSpacingBefore() -> int 31548 31549 Returns the space in tenths of a millimeter before the paragraph. 31550 """ 31551 31552 def GetParagraphStyleName(self): 31553 """ 31554 GetParagraphStyleName() -> String 31555 31556 Returns the name of the paragraph style. 31557 """ 31558 31559 def GetRightIndent(self): 31560 """ 31561 GetRightIndent() -> long 31562 31563 Returns the right indent in tenths of a millimeter. 31564 """ 31565 31566 def GetTabs(self): 31567 """ 31568 GetTabs() -> ArrayInt 31569 31570 Returns an array of tab stops, each expressed in tenths of a 31571 millimeter. 31572 """ 31573 31574 def GetTextColour(self): 31575 """ 31576 GetTextColour() -> Colour 31577 31578 Returns the text foreground colour. 31579 """ 31580 31581 def GetTextEffectFlags(self): 31582 """ 31583 GetTextEffectFlags() -> int 31584 31585 Returns the text effect bits of interest. 31586 """ 31587 31588 def GetTextEffects(self): 31589 """ 31590 GetTextEffects() -> int 31591 31592 Returns the text effects, a bit list of styles. 31593 """ 31594 31595 def GetURL(self): 31596 """ 31597 GetURL() -> String 31598 31599 Returns the URL for the content. 31600 """ 31601 31602 def HasAlignment(self): 31603 """ 31604 HasAlignment() -> bool 31605 31606 Returns true if the attribute object specifies alignment. 31607 """ 31608 31609 def HasBackgroundColour(self): 31610 """ 31611 HasBackgroundColour() -> bool 31612 31613 Returns true if the attribute object specifies a background colour. 31614 """ 31615 31616 def HasBulletName(self): 31617 """ 31618 HasBulletName() -> bool 31619 31620 Returns true if the attribute object specifies a standard bullet name. 31621 """ 31622 31623 def HasBulletNumber(self): 31624 """ 31625 HasBulletNumber() -> bool 31626 31627 Returns true if the attribute object specifies a bullet number. 31628 """ 31629 31630 def HasBulletStyle(self): 31631 """ 31632 HasBulletStyle() -> bool 31633 31634 Returns true if the attribute object specifies a bullet style. 31635 """ 31636 31637 def HasBulletText(self): 31638 """ 31639 HasBulletText() -> bool 31640 31641 Returns true if the attribute object specifies bullet text (usually 31642 specifying a symbol). 31643 """ 31644 31645 def HasCharacterStyleName(self): 31646 """ 31647 HasCharacterStyleName() -> bool 31648 31649 Returns true if the attribute object specifies a character style name. 31650 """ 31651 31652 def HasFlag(self, flag): 31653 """ 31654 HasFlag(flag) -> bool 31655 31656 Returns true if the flag is present in the attribute object's flag 31657 bitlist. 31658 """ 31659 31660 def HasFont(self): 31661 """ 31662 HasFont() -> bool 31663 31664 Returns true if the attribute object specifies any font attributes. 31665 """ 31666 31667 def HasFontEncoding(self): 31668 """ 31669 HasFontEncoding() -> bool 31670 31671 Returns true if the attribute object specifies an encoding. 31672 """ 31673 31674 def HasFontFaceName(self): 31675 """ 31676 HasFontFaceName() -> bool 31677 31678 Returns true if the attribute object specifies a font face name. 31679 """ 31680 31681 def HasFontFamily(self): 31682 """ 31683 HasFontFamily() -> bool 31684 31685 Returns true if the attribute object specifies a font family. 31686 """ 31687 31688 def HasFontItalic(self): 31689 """ 31690 HasFontItalic() -> bool 31691 31692 Returns true if the attribute object specifies italic style. 31693 """ 31694 31695 def HasFontSize(self): 31696 """ 31697 HasFontSize() -> bool 31698 31699 Returns true if the attribute object specifies a font point or pixel 31700 size. 31701 """ 31702 31703 def HasFontPointSize(self): 31704 """ 31705 HasFontPointSize() -> bool 31706 31707 Returns true if the attribute object specifies a font point size. 31708 """ 31709 31710 def HasFontPixelSize(self): 31711 """ 31712 HasFontPixelSize() -> bool 31713 31714 Returns true if the attribute object specifies a font pixel size. 31715 """ 31716 31717 def HasFontUnderlined(self): 31718 """ 31719 HasFontUnderlined() -> bool 31720 31721 Returns true if the attribute object specifies either underlining or 31722 no underlining. 31723 """ 31724 31725 def HasFontWeight(self): 31726 """ 31727 HasFontWeight() -> bool 31728 31729 Returns true if the attribute object specifies font weight (bold, 31730 light or normal). 31731 """ 31732 31733 def HasLeftIndent(self): 31734 """ 31735 HasLeftIndent() -> bool 31736 31737 Returns true if the attribute object specifies a left indent. 31738 """ 31739 31740 def HasLineSpacing(self): 31741 """ 31742 HasLineSpacing() -> bool 31743 31744 Returns true if the attribute object specifies line spacing. 31745 """ 31746 31747 def HasListStyleName(self): 31748 """ 31749 HasListStyleName() -> bool 31750 31751 Returns true if the attribute object specifies a list style name. 31752 """ 31753 31754 def HasOutlineLevel(self): 31755 """ 31756 HasOutlineLevel() -> bool 31757 31758 Returns true if the attribute object specifies an outline level. 31759 """ 31760 31761 def HasPageBreak(self): 31762 """ 31763 HasPageBreak() -> bool 31764 31765 Returns true if the attribute object specifies a page break before 31766 this paragraph. 31767 """ 31768 31769 def HasParagraphSpacingAfter(self): 31770 """ 31771 HasParagraphSpacingAfter() -> bool 31772 31773 Returns true if the attribute object specifies spacing after a 31774 paragraph. 31775 """ 31776 31777 def HasParagraphSpacingBefore(self): 31778 """ 31779 HasParagraphSpacingBefore() -> bool 31780 31781 Returns true if the attribute object specifies spacing before a 31782 paragraph. 31783 """ 31784 31785 def HasParagraphStyleName(self): 31786 """ 31787 HasParagraphStyleName() -> bool 31788 31789 Returns true if the attribute object specifies a paragraph style name. 31790 """ 31791 31792 def HasRightIndent(self): 31793 """ 31794 HasRightIndent() -> bool 31795 31796 Returns true if the attribute object specifies a right indent. 31797 """ 31798 31799 def HasTabs(self): 31800 """ 31801 HasTabs() -> bool 31802 31803 Returns true if the attribute object specifies tab stops. 31804 """ 31805 31806 def HasTextColour(self): 31807 """ 31808 HasTextColour() -> bool 31809 31810 Returns true if the attribute object specifies a text foreground 31811 colour. 31812 """ 31813 31814 def HasTextEffects(self): 31815 """ 31816 HasTextEffects() -> bool 31817 31818 Returns true if the attribute object specifies text effects. 31819 """ 31820 31821 def HasURL(self): 31822 """ 31823 HasURL() -> bool 31824 31825 Returns true if the attribute object specifies a URL. 31826 """ 31827 31828 def IsCharacterStyle(self): 31829 """ 31830 IsCharacterStyle() -> bool 31831 31832 Returns true if the object represents a character style, that is, the 31833 flags specify a font or a text background or foreground colour. 31834 """ 31835 31836 def IsDefault(self): 31837 """ 31838 IsDefault() -> bool 31839 31840 Returns false if we have any attributes set, true otherwise. 31841 """ 31842 31843 def IsParagraphStyle(self): 31844 """ 31845 IsParagraphStyle() -> bool 31846 31847 Returns true if the object represents a paragraph style, that is, the 31848 flags specify alignment, indentation, tabs, paragraph spacing, or 31849 bullet style. 31850 """ 31851 31852 def SetAlignment(self, alignment): 31853 """ 31854 SetAlignment(alignment) 31855 31856 Sets the paragraph alignment. 31857 """ 31858 31859 def SetBackgroundColour(self, colBack): 31860 """ 31861 SetBackgroundColour(colBack) 31862 31863 Sets the background colour. 31864 """ 31865 31866 def SetBulletFont(self, font): 31867 """ 31868 SetBulletFont(font) 31869 31870 Sets the name of the font associated with the bullet symbol. 31871 """ 31872 31873 def SetBulletName(self, name): 31874 """ 31875 SetBulletName(name) 31876 31877 Sets the standard bullet name, applicable if the bullet style is 31878 wxTEXT_ATTR_BULLET_STYLE_STANDARD. 31879 """ 31880 31881 def SetBulletNumber(self, n): 31882 """ 31883 SetBulletNumber(n) 31884 31885 Sets the bullet number. 31886 """ 31887 31888 def SetBulletStyle(self, style): 31889 """ 31890 SetBulletStyle(style) 31891 31892 Sets the bullet style. 31893 """ 31894 31895 def SetBulletText(self, text): 31896 """ 31897 SetBulletText(text) 31898 31899 Sets the bullet text, which could be a symbol, or (for example) cached 31900 outline text. 31901 """ 31902 31903 def SetCharacterStyleName(self, name): 31904 """ 31905 SetCharacterStyleName(name) 31906 31907 Sets the character style name. 31908 """ 31909 31910 def SetFlags(self, flags): 31911 """ 31912 SetFlags(flags) 31913 31914 Sets the flags determining which styles are being specified. 31915 """ 31916 31917 def SetFont(self, font, flags=TEXT_ATTR_FONT & ~TEXT_ATTR_FONT_PIXEL_SIZE): 31918 """ 31919 SetFont(font, flags=TEXT_ATTR_FONT & ~TEXT_ATTR_FONT_PIXEL_SIZE) 31920 31921 Sets the attributes for the given font. 31922 """ 31923 31924 def SetFontEncoding(self, encoding): 31925 """ 31926 SetFontEncoding(encoding) 31927 31928 Sets the font encoding. 31929 """ 31930 31931 def SetFontFaceName(self, faceName): 31932 """ 31933 SetFontFaceName(faceName) 31934 31935 Sets the font face name. 31936 """ 31937 31938 def SetFontFamily(self, family): 31939 """ 31940 SetFontFamily(family) 31941 31942 Sets the font family. 31943 """ 31944 31945 def SetFontSize(self, pointSize): 31946 """ 31947 SetFontSize(pointSize) 31948 31949 Sets the font size in points. 31950 """ 31951 31952 def SetFontPointSize(self, pointSize): 31953 """ 31954 SetFontPointSize(pointSize) 31955 31956 Sets the font size in points. 31957 """ 31958 31959 def SetFontPixelSize(self, pixelSize): 31960 """ 31961 SetFontPixelSize(pixelSize) 31962 31963 Sets the font size in pixels. 31964 """ 31965 31966 def SetFontStyle(self, fontStyle): 31967 """ 31968 SetFontStyle(fontStyle) 31969 31970 Sets the font style (normal, italic or slanted). 31971 """ 31972 31973 def SetFontUnderlined(self, underlined): 31974 """ 31975 SetFontUnderlined(underlined) 31976 31977 Sets the font underlining. 31978 """ 31979 31980 def SetFontWeight(self, fontWeight): 31981 """ 31982 SetFontWeight(fontWeight) 31983 31984 Sets the font weight. 31985 """ 31986 31987 def SetLeftIndent(self, indent, subIndent=0): 31988 """ 31989 SetLeftIndent(indent, subIndent=0) 31990 31991 Sets the left indent and left subindent in tenths of a millimetre. 31992 """ 31993 31994 def SetLineSpacing(self, spacing): 31995 """ 31996 SetLineSpacing(spacing) 31997 31998 Sets the line spacing. 31999 """ 32000 32001 def SetListStyleName(self, name): 32002 """ 32003 SetListStyleName(name) 32004 32005 Sets the list style name. 32006 """ 32007 32008 def SetOutlineLevel(self, level): 32009 """ 32010 SetOutlineLevel(level) 32011 32012 Specifies the outline level. 32013 """ 32014 32015 def SetPageBreak(self, pageBreak=True): 32016 """ 32017 SetPageBreak(pageBreak=True) 32018 32019 Specifies a page break before this paragraph. 32020 """ 32021 32022 def SetParagraphSpacingAfter(self, spacing): 32023 """ 32024 SetParagraphSpacingAfter(spacing) 32025 32026 Sets the spacing after a paragraph, in tenths of a millimetre. 32027 """ 32028 32029 def SetParagraphSpacingBefore(self, spacing): 32030 """ 32031 SetParagraphSpacingBefore(spacing) 32032 32033 Sets the spacing before a paragraph, in tenths of a millimetre. 32034 """ 32035 32036 def SetParagraphStyleName(self, name): 32037 """ 32038 SetParagraphStyleName(name) 32039 32040 Sets the name of the paragraph style. 32041 """ 32042 32043 def SetRightIndent(self, indent): 32044 """ 32045 SetRightIndent(indent) 32046 32047 Sets the right indent in tenths of a millimetre. 32048 """ 32049 32050 def SetTabs(self, tabs): 32051 """ 32052 SetTabs(tabs) 32053 32054 Sets the tab stops, expressed in tenths of a millimetre. 32055 """ 32056 32057 def SetTextColour(self, colText): 32058 """ 32059 SetTextColour(colText) 32060 32061 Sets the text foreground colour. 32062 """ 32063 32064 def SetTextEffectFlags(self, flags): 32065 """ 32066 SetTextEffectFlags(flags) 32067 32068 Sets the text effect bits of interest. 32069 """ 32070 32071 def SetTextEffects(self, effects): 32072 """ 32073 SetTextEffects(effects) 32074 32075 Sets the text effects, a bit list of styles. 32076 """ 32077 32078 def SetURL(self, url): 32079 """ 32080 SetURL(url) 32081 32082 Sets the URL for the content. 32083 """ 32084 32085 def Apply(self, style, compareWith=None): 32086 """ 32087 Apply(style, compareWith=None) -> bool 32088 32089 Applies the attributes in style to the original object, but not those 32090 attributes from style that are the same as those in compareWith (if 32091 passed). 32092 """ 32093 32094 def Merge(self, *args, **kw): 32095 """ 32096 Merge(overlay) 32097 Merge(base, overlay) -> TextAttr 32098 32099 Copies all defined/valid properties from overlay to current object. 32100 """ 32101 32102 def EqPartial(self, attr, weakTest=True): 32103 """ 32104 EqPartial(attr, weakTest=True) -> bool 32105 32106 Partial equality test. 32107 """ 32108 Alignment = property(None, None) 32109 BackgroundColour = property(None, None) 32110 BulletFont = property(None, None) 32111 BulletName = property(None, None) 32112 BulletNumber = property(None, None) 32113 BulletStyle = property(None, None) 32114 BulletText = property(None, None) 32115 CharacterStyleName = property(None, None) 32116 Flags = property(None, None) 32117 Font = property(None, None) 32118 FontEncoding = property(None, None) 32119 FontFaceName = property(None, None) 32120 FontFamily = property(None, None) 32121 FontSize = property(None, None) 32122 FontStyle = property(None, None) 32123 FontUnderlined = property(None, None) 32124 FontWeight = property(None, None) 32125 LeftIndent = property(None, None) 32126 LeftSubIndent = property(None, None) 32127 LineSpacing = property(None, None) 32128 ListStyleName = property(None, None) 32129 OutlineLevel = property(None, None) 32130 ParagraphSpacingAfter = property(None, None) 32131 ParagraphSpacingBefore = property(None, None) 32132 ParagraphStyleName = property(None, None) 32133 RightIndent = property(None, None) 32134 Tabs = property(None, None) 32135 TextColour = property(None, None) 32136 TextEffectFlags = property(None, None) 32137 TextEffects = property(None, None) 32138 URL = property(None, None) 32139# end of class TextAttr 32140 32141TextCtrlNameStr = "" 32142 32143class TextCtrl(Control, TextEntry): 32144 """ 32145 TextCtrl() 32146 TextCtrl(parent, id=ID_ANY, value=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, validator=DefaultValidator, name=TextCtrlNameStr) 32147 32148 A text control allows text to be displayed and edited. 32149 """ 32150 32151 def __init__(self, *args, **kw): 32152 """ 32153 TextCtrl() 32154 TextCtrl(parent, id=ID_ANY, value=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, validator=DefaultValidator, name=TextCtrlNameStr) 32155 32156 A text control allows text to be displayed and edited. 32157 """ 32158 32159 def Create(self, parent, id=ID_ANY, value=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, validator=DefaultValidator, name=TextCtrlNameStr): 32160 """ 32161 Create(parent, id=ID_ANY, value=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, validator=DefaultValidator, name=TextCtrlNameStr) -> bool 32162 32163 Creates the text control for two-step construction. 32164 """ 32165 32166 def DiscardEdits(self): 32167 """ 32168 DiscardEdits() 32169 32170 Resets the internal modified flag as if the current changes had been 32171 saved. 32172 """ 32173 32174 def EmulateKeyPress(self, event): 32175 """ 32176 EmulateKeyPress(event) -> bool 32177 32178 This function inserts into the control the character which would have 32179 been inserted if the given key event had occurred in the text control. 32180 """ 32181 32182 def GetDefaultStyle(self): 32183 """ 32184 GetDefaultStyle() -> TextAttr 32185 32186 Returns the style currently used for the new text. 32187 """ 32188 32189 def GetLineLength(self, lineNo): 32190 """ 32191 GetLineLength(lineNo) -> int 32192 32193 Gets the length of the specified line, not including any trailing 32194 newline character(s). 32195 """ 32196 32197 def GetLineText(self, lineNo): 32198 """ 32199 GetLineText(lineNo) -> String 32200 32201 Returns the contents of a given line in the text control, not 32202 including any trailing newline character(s). 32203 """ 32204 32205 def GetNumberOfLines(self): 32206 """ 32207 GetNumberOfLines() -> int 32208 32209 Returns the number of lines in the text control buffer. 32210 """ 32211 32212 def GetStyle(self, position, style): 32213 """ 32214 GetStyle(position, style) -> bool 32215 32216 Returns the style at this position in the text control. 32217 """ 32218 32219 def HitTestPos(self, pt): 32220 """ 32221 HitTestPos(pt) -> (TextCtrlHitTestResult, pos) 32222 32223 Finds the position of the character at the specified point. 32224 """ 32225 32226 def HitTest(self, pt): 32227 """ 32228 HitTest(pt) -> (TextCtrlHitTestResult, col, row) 32229 32230 Finds the row and column of the character at the specified point. 32231 """ 32232 32233 def IsModified(self): 32234 """ 32235 IsModified() -> bool 32236 32237 Returns true if the text has been modified by user. 32238 """ 32239 32240 def IsMultiLine(self): 32241 """ 32242 IsMultiLine() -> bool 32243 32244 Returns true if this is a multi line edit control and false otherwise. 32245 """ 32246 32247 def IsSingleLine(self): 32248 """ 32249 IsSingleLine() -> bool 32250 32251 Returns true if this is a single line edit control and false 32252 otherwise. 32253 """ 32254 32255 def LoadFile(self, filename, fileType=TEXT_TYPE_ANY): 32256 """ 32257 LoadFile(filename, fileType=TEXT_TYPE_ANY) -> bool 32258 32259 Loads and displays the named file, if it exists. 32260 """ 32261 32262 def MarkDirty(self): 32263 """ 32264 MarkDirty() 32265 32266 Mark text as modified (dirty). 32267 """ 32268 32269 def PositionToXY(self, pos): 32270 """ 32271 PositionToXY(pos) -> (bool, x, y) 32272 32273 Converts given position to a zero-based column, line number pair. 32274 """ 32275 32276 def PositionToCoords(self, pos): 32277 """ 32278 PositionToCoords(pos) -> Point 32279 32280 Converts given text position to client coordinates in pixels. 32281 """ 32282 32283 def SaveFile(self, filename=EmptyString, fileType=TEXT_TYPE_ANY): 32284 """ 32285 SaveFile(filename=EmptyString, fileType=TEXT_TYPE_ANY) -> bool 32286 32287 Saves the contents of the control in a text file. 32288 """ 32289 32290 def SetDefaultStyle(self, style): 32291 """ 32292 SetDefaultStyle(style) -> bool 32293 32294 Changes the default style to use for the new text which is going to be 32295 added to the control using WriteText() or AppendText(). 32296 """ 32297 32298 def SetModified(self, modified): 32299 """ 32300 SetModified(modified) 32301 32302 Marks the control as being modified by the user or not. 32303 """ 32304 32305 def SetStyle(self, start, end, style): 32306 """ 32307 SetStyle(start, end, style) -> bool 32308 32309 Changes the style of the given range. 32310 """ 32311 32312 def ShowPosition(self, pos): 32313 """ 32314 ShowPosition(pos) 32315 32316 Makes the line containing the given position visible. 32317 """ 32318 32319 def XYToPosition(self, x, y): 32320 """ 32321 XYToPosition(x, y) -> long 32322 32323 Converts the given zero based column and line number to a position. 32324 """ 32325 32326 @staticmethod 32327 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 32328 """ 32329 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 32330 """ 32331 32332 def MacCheckSpelling(self, check): 32333 """ 32334 MacCheckSpelling(check) 32335 32336 Turn on the native spell checking for the text widget on 32337 OSX. Ignored on other platforms. 32338 """ 32339 32340 def ShowNativeCaret(self, show=True): 32341 """ 32342 ShowNativeCaret(show=True) -> bool 32343 32344 Turn on the widget's native caret on Windows. 32345 Ignored on other platforms. 32346 """ 32347 32348 def HideNativeCaret(self): 32349 """ 32350 HideNativeCaret() -> bool 32351 32352 Turn off the widget's native caret on Windows. 32353 Ignored on other platforms. 32354 """ 32355 32356 def write(self, text): 32357 """ 32358 write(text) 32359 32360 Append text to the textctrl, for file-like compatibility. 32361 """ 32362 32363 def flush(self): 32364 """ 32365 flush() 32366 32367 NOP, for file-like compatibility. 32368 """ 32369 DefaultStyle = property(None, None) 32370 NumberOfLines = property(None, None) 32371# end of class TextCtrl 32372 32373 32374class TextUrlEvent(CommandEvent): 32375 """ 32376 TextUrlEvent(winid, evtMouse, start, end) 32377 TextUrlEvent(event) 32378 """ 32379 32380 def __init__(self, *args, **kw): 32381 """ 32382 TextUrlEvent(winid, evtMouse, start, end) 32383 TextUrlEvent(event) 32384 """ 32385 32386 def GetMouseEvent(self): 32387 """ 32388 GetMouseEvent() -> MouseEvent 32389 """ 32390 32391 def GetURLStart(self): 32392 """ 32393 GetURLStart() -> long 32394 """ 32395 32396 def GetURLEnd(self): 32397 """ 32398 GetURLEnd() -> long 32399 """ 32400 32401 def Clone(self): 32402 """ 32403 Clone() -> Event 32404 32405 Returns a copy of the event. 32406 """ 32407 MouseEvent = property(None, None) 32408 URLEnd = property(None, None) 32409 URLStart = property(None, None) 32410# end of class TextUrlEvent 32411 32412 32413EVT_TEXT = wx.PyEventBinder( wxEVT_TEXT, 1) 32414EVT_TEXT_ENTER = wx.PyEventBinder( wxEVT_TEXT_ENTER, 1) 32415EVT_TEXT_URL = wx.PyEventBinder( wxEVT_TEXT_URL, 1) 32416EVT_TEXT_MAXLEN = wx.PyEventBinder( wxEVT_TEXT_MAXLEN, 1) 32417EVT_TEXT_CUT = wx.PyEventBinder( wxEVT_TEXT_CUT ) 32418EVT_TEXT_COPY = wx.PyEventBinder( wxEVT_TEXT_COPY ) 32419EVT_TEXT_PASTE = wx.PyEventBinder( wxEVT_TEXT_PASTE ) 32420 32421# deprecated wxEVT aliases 32422wxEVT_COMMAND_TEXT_UPDATED = wxEVT_TEXT 32423wxEVT_COMMAND_TEXT_ENTER = wxEVT_TEXT_ENTER 32424wxEVT_COMMAND_TEXT_URL = wxEVT_TEXT_URL 32425wxEVT_COMMAND_TEXT_MAXLEN = wxEVT_TEXT_MAXLEN 32426wxEVT_COMMAND_TEXT_CUT = wxEVT_TEXT_CUT 32427wxEVT_COMMAND_TEXT_COPY = wxEVT_TEXT_COPY 32428wxEVT_COMMAND_TEXT_PASTE = wxEVT_TEXT_PASTE 32429#-- end-textctrl --# 32430#-- begin-combobox --# 32431ComboBoxNameStr = "" 32432 32433class ComboBox(Control, ItemContainer, TextEntry): 32434 """ 32435 ComboBox() 32436 ComboBox(parent, id=ID_ANY, value=EmptyString, pos=DefaultPosition, size=DefaultSize, choices=[], style=0, validator=DefaultValidator, name=ComboBoxNameStr) 32437 32438 A combobox is like a combination of an edit control and a listbox. 32439 """ 32440 32441 def __init__(self, *args, **kw): 32442 """ 32443 ComboBox() 32444 ComboBox(parent, id=ID_ANY, value=EmptyString, pos=DefaultPosition, size=DefaultSize, choices=[], style=0, validator=DefaultValidator, name=ComboBoxNameStr) 32445 32446 A combobox is like a combination of an edit control and a listbox. 32447 """ 32448 32449 def Create(self, parent, id=ID_ANY, value=EmptyString, pos=DefaultPosition, size=DefaultSize, choices=[], style=0, validator=DefaultValidator, name=ComboBoxNameStr): 32450 """ 32451 Create(parent, id=ID_ANY, value=EmptyString, pos=DefaultPosition, size=DefaultSize, choices=[], style=0, validator=DefaultValidator, name=ComboBoxNameStr) -> bool 32452 32453 Creates the combobox for two-step construction. 32454 """ 32455 32456 def GetCurrentSelection(self): 32457 """ 32458 GetCurrentSelection() -> int 32459 32460 Returns the item being selected right now. 32461 """ 32462 32463 def GetInsertionPoint(self): 32464 """ 32465 GetInsertionPoint() -> long 32466 32467 Same as wxTextEntry::GetInsertionPoint(). 32468 """ 32469 32470 def IsListEmpty(self): 32471 """ 32472 IsListEmpty() -> bool 32473 32474 Returns true if the list of combobox choices is empty. 32475 """ 32476 32477 def IsTextEmpty(self): 32478 """ 32479 IsTextEmpty() -> bool 32480 32481 Returns true if the text of the combobox is empty. 32482 """ 32483 32484 def SetSelection(self, *args, **kw): 32485 """ 32486 SetSelection(from_, to_) 32487 SetSelection(n) 32488 32489 Same as wxTextEntry::SetSelection(). 32490 """ 32491 32492 def SetTextSelection(self, from_, to_): 32493 """ 32494 SetTextSelection(from_, to_) 32495 32496 Same as wxTextEntry::SetSelection(). 32497 """ 32498 32499 def SetValue(self, text): 32500 """ 32501 SetValue(text) 32502 32503 Sets the text for the combobox text field. 32504 """ 32505 32506 def Popup(self): 32507 """ 32508 Popup() 32509 32510 Shows the list box portion of the combo box. 32511 """ 32512 32513 def Dismiss(self): 32514 """ 32515 Dismiss() 32516 32517 Hides the list box portion of the combo box. 32518 """ 32519 32520 def GetSelection(self): 32521 """ 32522 GetSelection() -> int 32523 32524 Returns the index of the selected item or wxNOT_FOUND if no item is 32525 selected. 32526 """ 32527 32528 def GetTextSelection(self): 32529 """ 32530 GetTextSelection() -> (from, to) 32531 32532 Gets the current selection span. 32533 """ 32534 32535 def FindString(self, string, caseSensitive=False): 32536 """ 32537 FindString(string, caseSensitive=False) -> int 32538 32539 Finds an item whose label matches the given string. 32540 """ 32541 32542 def GetString(self, n): 32543 """ 32544 GetString(n) -> String 32545 32546 Returns the label of the item with the given index. 32547 """ 32548 32549 def GetStringSelection(self): 32550 """ 32551 GetStringSelection() -> String 32552 32553 Gets the text currently selected in the control. 32554 """ 32555 32556 def SetString(self, n, text): 32557 """ 32558 SetString(n, text) 32559 32560 Changes the text of the specified combobox item. 32561 """ 32562 32563 def GetCount(self): 32564 """ 32565 GetCount() -> unsignedint 32566 32567 Returns the number of items in the control. 32568 """ 32569 32570 @staticmethod 32571 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 32572 """ 32573 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 32574 """ 32575 32576 SetMark = wx.deprecated(SetTextSelection, 'Use SetTextSelection instead.') 32577 32578 GetMark = wx.deprecated(GetTextSelection, 'Use GetTextSelection instead.') 32579 Count = property(None, None) 32580 CurrentSelection = property(None, None) 32581 InsertionPoint = property(None, None) 32582 Selection = property(None, None) 32583 StringSelection = property(None, None) 32584# end of class ComboBox 32585 32586#-- end-combobox --# 32587#-- begin-checkbox --# 32588CHK_2STATE = 0 32589CHK_3STATE = 0 32590CHK_ALLOW_3RD_STATE_FOR_USER = 0 32591CHK_UNCHECKED = 0 32592CHK_CHECKED = 0 32593CHK_UNDETERMINED = 0 32594CheckBoxNameStr = "" 32595 32596class CheckBox(Control): 32597 """ 32598 CheckBox() 32599 CheckBox(parent, id=ID_ANY, label=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, validator=DefaultValidator, name=CheckBoxNameStr) 32600 32601 A checkbox is a labelled box which by default is either on (checkmark 32602 is visible) or off (no checkmark). 32603 """ 32604 32605 def __init__(self, *args, **kw): 32606 """ 32607 CheckBox() 32608 CheckBox(parent, id=ID_ANY, label=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, validator=DefaultValidator, name=CheckBoxNameStr) 32609 32610 A checkbox is a labelled box which by default is either on (checkmark 32611 is visible) or off (no checkmark). 32612 """ 32613 32614 def Create(self, parent, id=ID_ANY, label=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, validator=DefaultValidator, name=CheckBoxNameStr): 32615 """ 32616 Create(parent, id=ID_ANY, label=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, validator=DefaultValidator, name=CheckBoxNameStr) -> bool 32617 32618 Creates the checkbox for two-step construction. 32619 """ 32620 32621 def GetValue(self): 32622 """ 32623 GetValue() -> bool 32624 32625 Gets the state of a 2-state checkbox. 32626 """ 32627 32628 def Get3StateValue(self): 32629 """ 32630 Get3StateValue() -> CheckBoxState 32631 32632 Gets the state of a 3-state checkbox. 32633 """ 32634 32635 def Is3State(self): 32636 """ 32637 Is3State() -> bool 32638 32639 Returns whether or not the checkbox is a 3-state checkbox. 32640 """ 32641 32642 def Is3rdStateAllowedForUser(self): 32643 """ 32644 Is3rdStateAllowedForUser() -> bool 32645 32646 Returns whether or not the user can set the checkbox to the third 32647 state. 32648 """ 32649 32650 def IsChecked(self): 32651 """ 32652 IsChecked() -> bool 32653 32654 This is just a maybe more readable synonym for GetValue(): just as the 32655 latter, it returns true if the checkbox is checked and false 32656 otherwise. 32657 """ 32658 32659 def SetValue(self, state): 32660 """ 32661 SetValue(state) 32662 32663 Sets the checkbox to the given state. 32664 """ 32665 32666 def Set3StateValue(self, state): 32667 """ 32668 Set3StateValue(state) 32669 32670 Sets the checkbox to the given state. 32671 """ 32672 Value = property(None, None) 32673 ThreeStateValue = property(None, None) 32674 32675 @staticmethod 32676 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 32677 """ 32678 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 32679 """ 32680# end of class CheckBox 32681 32682#-- end-checkbox --# 32683#-- begin-listbox --# 32684ListBoxNameStr = "" 32685 32686class ListBox(Control, ItemContainer): 32687 """ 32688 ListBox() 32689 ListBox(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, choices=[], style=0, validator=DefaultValidator, name=ListBoxNameStr) 32690 32691 A listbox is used to select one or more of a list of strings. 32692 """ 32693 32694 def __init__(self, *args, **kw): 32695 """ 32696 ListBox() 32697 ListBox(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, choices=[], style=0, validator=DefaultValidator, name=ListBoxNameStr) 32698 32699 A listbox is used to select one or more of a list of strings. 32700 """ 32701 32702 def Create(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, choices=[], style=0, validator=DefaultValidator, name=ListBoxNameStr): 32703 """ 32704 Create(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, choices=[], style=0, validator=DefaultValidator, name=ListBoxNameStr) -> bool 32705 32706 Creates the listbox for two-step construction. 32707 """ 32708 32709 def Deselect(self, n): 32710 """ 32711 Deselect(n) 32712 32713 Deselects an item in the list box. 32714 """ 32715 32716 def SetSelection(self, n): 32717 """ 32718 SetSelection(n) 32719 32720 Sets the selection to the given item n or removes the selection 32721 entirely if n == wxNOT_FOUND. 32722 """ 32723 32724 def GetSelection(self): 32725 """ 32726 GetSelection() -> int 32727 32728 Returns the index of the selected item or wxNOT_FOUND if no item is 32729 selected. 32730 """ 32731 32732 def SetStringSelection(self, *args, **kw): 32733 """ 32734 SetStringSelection(s, select) -> bool 32735 SetStringSelection(s) -> bool 32736 """ 32737 32738 def GetSelections(self): 32739 """ 32740 GetSelections() -> ArrayInt 32741 32742 Fill an array of ints with the positions of the currently selected 32743 items. 32744 """ 32745 32746 def HitTest(self, *args, **kw): 32747 """ 32748 HitTest(point) -> int 32749 HitTest(x, y) -> int 32750 32751 Returns the item located at point, or wxNOT_FOUND if there is no item 32752 located at point. 32753 """ 32754 32755 def InsertItems(self, items, pos): 32756 """ 32757 InsertItems(items, pos) 32758 32759 Insert the given number of strings before the specified position. 32760 """ 32761 32762 def IsSelected(self, n): 32763 """ 32764 IsSelected(n) -> bool 32765 32766 Determines whether an item is selected. 32767 """ 32768 32769 def SetFirstItem(self, *args, **kw): 32770 """ 32771 SetFirstItem(n) 32772 SetFirstItem(string) 32773 32774 Set the specified item to be the first visible item. 32775 """ 32776 32777 def EnsureVisible(self, n): 32778 """ 32779 EnsureVisible(n) 32780 32781 Ensure that the item with the given index is currently shown. 32782 """ 32783 32784 def IsSorted(self): 32785 """ 32786 IsSorted() -> bool 32787 32788 Return true if the listbox has wxLB_SORT style. 32789 """ 32790 32791 def GetCount(self): 32792 """ 32793 GetCount() -> unsignedint 32794 32795 Returns the number of items in the control. 32796 """ 32797 32798 def GetString(self, n): 32799 """ 32800 GetString(n) -> String 32801 32802 Returns the label of the item with the given index. 32803 """ 32804 32805 def SetString(self, n, string): 32806 """ 32807 SetString(n, string) 32808 32809 Sets the label for the given item. 32810 """ 32811 32812 def FindString(self, string, caseSensitive=False): 32813 """ 32814 FindString(string, caseSensitive=False) -> int 32815 32816 Finds an item whose label matches the given string. 32817 """ 32818 32819 def SetItemForegroundColour(self, item, c): 32820 """ 32821 SetItemForegroundColour(item, c) 32822 32823 Set the foreground colour of an item in the ListBox. 32824 Only valid on MSW and if the ``wx.LB_OWNERDRAW`` flag is set. 32825 """ 32826 32827 def SetItemBackgroundColour(self, item, c): 32828 """ 32829 SetItemBackgroundColour(item, c) 32830 32831 Set the background colour of an item in the ListBox. 32832 Only valid on MSW and if the ``wx.LB_OWNERDRAW`` flag is set. 32833 """ 32834 32835 def SetItemFont(self, item, f): 32836 """ 32837 SetItemFont(item, f) 32838 32839 Set the font of an item in the ListBox. 32840 Only valid on MSW and if the ``wx.LB_OWNERDRAW`` flag is set. 32841 """ 32842 32843 @staticmethod 32844 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 32845 """ 32846 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 32847 """ 32848 Count = property(None, None) 32849 Selection = property(None, None) 32850 Selections = property(None, None) 32851# end of class ListBox 32852 32853#-- end-listbox --# 32854#-- begin-checklst --# 32855 32856class CheckListBox(ListBox): 32857 """ 32858 CheckListBox(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, choices=[], style=0, validator=DefaultValidator, name="listBox") 32859 CheckListBox() 32860 32861 A wxCheckListBox is like a wxListBox, but allows items to be checked 32862 or unchecked. 32863 """ 32864 32865 def __init__(self, *args, **kw): 32866 """ 32867 CheckListBox(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, choices=[], style=0, validator=DefaultValidator, name="listBox") 32868 CheckListBox() 32869 32870 A wxCheckListBox is like a wxListBox, but allows items to be checked 32871 or unchecked. 32872 """ 32873 32874 def Create(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, choices=[], style=0, validator=DefaultValidator, name=ListBoxNameStr): 32875 """ 32876 Create(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, choices=[], style=0, validator=DefaultValidator, name=ListBoxNameStr) -> bool 32877 """ 32878 32879 def Check(self, item, check=True): 32880 """ 32881 Check(item, check=True) 32882 32883 Checks the given item. 32884 """ 32885 32886 def IsChecked(self, item): 32887 """ 32888 IsChecked(item) -> bool 32889 32890 Returns true if the given item is checked, false otherwise. 32891 """ 32892 32893 @staticmethod 32894 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 32895 """ 32896 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 32897 """ 32898 32899 def GetCheckedItems(self): 32900 """ 32901 GetCheckedItems() 32902 32903 Return a sequence of integers corresponding to the checked items in 32904 the control, based on :meth:`IsChecked`. 32905 """ 32906 32907 def GetCheckedStrings(self): 32908 """ 32909 GetCheckedStrings() 32910 32911 Return a tuple of strings corresponding to the checked 32912 items of the control, based on :meth:`GetChecked`. 32913 """ 32914 32915 def SetCheckedItems(self, indexes): 32916 """ 32917 SetCheckedItems(indexes) 32918 32919 Sets the checked state of items if the index of the item is 32920 found in the indexes sequence. 32921 """ 32922 32923 def SetCheckedStrings(self, strings): 32924 """ 32925 SetCheckedStrings(strings) 32926 32927 Sets the checked state of items if the item's string is found 32928 in the strings sequence. 32929 """ 32930 32931 def GetChecked(self): 32932 """ 32933 32934 """ 32935 32936 def SetChecked(self, indexes): 32937 """ 32938 32939 """ 32940 Checked = property(None, None) 32941 CheckedItems = property(None, None) 32942 CheckedStrings = property(None, None) 32943# end of class CheckListBox 32944 32945#-- end-checklst --# 32946#-- begin-gauge --# 32947GA_HORIZONTAL = 0 32948GA_VERTICAL = 0 32949GA_SMOOTH = 0 32950GaugeNameStr = "" 32951 32952class Gauge(Control): 32953 """ 32954 Gauge() 32955 Gauge(parent, id=ID_ANY, range=100, pos=DefaultPosition, size=DefaultSize, style=GA_HORIZONTAL, validator=DefaultValidator, name=GaugeNameStr) 32956 32957 A gauge is a horizontal or vertical bar which shows a quantity (often 32958 time). 32959 """ 32960 32961 def __init__(self, *args, **kw): 32962 """ 32963 Gauge() 32964 Gauge(parent, id=ID_ANY, range=100, pos=DefaultPosition, size=DefaultSize, style=GA_HORIZONTAL, validator=DefaultValidator, name=GaugeNameStr) 32965 32966 A gauge is a horizontal or vertical bar which shows a quantity (often 32967 time). 32968 """ 32969 32970 def Create(self, parent, id=ID_ANY, range=100, pos=DefaultPosition, size=DefaultSize, style=GA_HORIZONTAL, validator=DefaultValidator, name=GaugeNameStr): 32971 """ 32972 Create(parent, id=ID_ANY, range=100, pos=DefaultPosition, size=DefaultSize, style=GA_HORIZONTAL, validator=DefaultValidator, name=GaugeNameStr) -> bool 32973 32974 Creates the gauge for two-step construction. 32975 """ 32976 32977 def GetBezelFace(self): 32978 """ 32979 GetBezelFace() -> int 32980 32981 Returns the width of the 3D bezel face. 32982 """ 32983 32984 def GetRange(self): 32985 """ 32986 GetRange() -> int 32987 32988 Returns the maximum position of the gauge. 32989 """ 32990 32991 def GetShadowWidth(self): 32992 """ 32993 GetShadowWidth() -> int 32994 32995 Returns the 3D shadow margin width. 32996 """ 32997 32998 def GetValue(self): 32999 """ 33000 GetValue() -> int 33001 33002 Returns the current position of the gauge. 33003 """ 33004 33005 def IsVertical(self): 33006 """ 33007 IsVertical() -> bool 33008 33009 Returns true if the gauge is vertical (has wxGA_VERTICAL style) and 33010 false otherwise. 33011 """ 33012 33013 def Pulse(self): 33014 """ 33015 Pulse() 33016 33017 Switch the gauge to indeterminate mode (if required) and makes the 33018 gauge move a bit to indicate the user that some progress has been 33019 made. 33020 """ 33021 33022 def SetBezelFace(self, width): 33023 """ 33024 SetBezelFace(width) 33025 33026 Sets the 3D bezel face width. 33027 """ 33028 33029 def SetRange(self, range): 33030 """ 33031 SetRange(range) 33032 33033 Sets the range (maximum value) of the gauge. 33034 """ 33035 33036 def SetShadowWidth(self, width): 33037 """ 33038 SetShadowWidth(width) 33039 33040 Sets the 3D shadow width. 33041 """ 33042 33043 def SetValue(self, pos): 33044 """ 33045 SetValue(pos) 33046 33047 Sets the position of the gauge. 33048 """ 33049 33050 @staticmethod 33051 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 33052 """ 33053 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 33054 """ 33055 BezelFace = property(None, None) 33056 Range = property(None, None) 33057 ShadowWidth = property(None, None) 33058 Value = property(None, None) 33059# end of class Gauge 33060 33061#-- end-gauge --# 33062#-- begin-headercol --# 33063COL_WIDTH_DEFAULT = 0 33064COL_WIDTH_AUTOSIZE = 0 33065COL_RESIZABLE = 0 33066COL_SORTABLE = 0 33067COL_REORDERABLE = 0 33068COL_HIDDEN = 0 33069COL_DEFAULT_FLAGS = 0 33070 33071class HeaderColumn(object): 33072 """ 33073 Represents a column header in controls displaying tabular data such as 33074 wxDataViewCtrl or wxGrid. 33075 """ 33076 33077 def GetTitle(self): 33078 """ 33079 GetTitle() -> String 33080 33081 Get the text shown in the column header. 33082 """ 33083 33084 def GetBitmap(self): 33085 """ 33086 GetBitmap() -> Bitmap 33087 33088 Returns the bitmap in the header of the column, if any. 33089 """ 33090 33091 def GetWidth(self): 33092 """ 33093 GetWidth() -> int 33094 33095 Returns the current width of the column. 33096 """ 33097 33098 def GetMinWidth(self): 33099 """ 33100 GetMinWidth() -> int 33101 33102 Return the minimal column width. 33103 """ 33104 33105 def GetAlignment(self): 33106 """ 33107 GetAlignment() -> Alignment 33108 33109 Returns the current column alignment. 33110 """ 33111 33112 def GetFlags(self): 33113 """ 33114 GetFlags() -> int 33115 33116 Get the column flags. 33117 """ 33118 33119 def HasFlag(self, flag): 33120 """ 33121 HasFlag(flag) -> bool 33122 33123 Return true if the specified flag is currently set for this column. 33124 """ 33125 33126 def IsResizeable(self): 33127 """ 33128 IsResizeable() -> bool 33129 33130 Return true if the column can be resized by the user. 33131 """ 33132 33133 def IsSortable(self): 33134 """ 33135 IsSortable() -> bool 33136 33137 Returns true if the column can be clicked by user to sort the control 33138 contents by the field in this column. 33139 """ 33140 33141 def IsReorderable(self): 33142 """ 33143 IsReorderable() -> bool 33144 33145 Returns true if the column can be dragged by user to change its order. 33146 """ 33147 33148 def IsHidden(self): 33149 """ 33150 IsHidden() -> bool 33151 33152 Returns true if the column is currently hidden. 33153 """ 33154 33155 def IsShown(self): 33156 """ 33157 IsShown() -> bool 33158 33159 Returns true if the column is currently shown. 33160 """ 33161 33162 def IsSortKey(self): 33163 """ 33164 IsSortKey() -> bool 33165 33166 Returns true if the column is currently used for sorting. 33167 """ 33168 33169 def IsSortOrderAscending(self): 33170 """ 33171 IsSortOrderAscending() -> bool 33172 33173 Returns true, if the sort order is ascending. 33174 """ 33175 Alignment = property(None, None) 33176 Bitmap = property(None, None) 33177 Flags = property(None, None) 33178 MinWidth = property(None, None) 33179 Title = property(None, None) 33180 Width = property(None, None) 33181 Resizeable = property(None, None) 33182 Sortable = property(None, None) 33183 Reorderable = property(None, None) 33184 Hidden = property(None, None) 33185 Shown = property(None, None) 33186 SortOrderAscending = property(None, None) 33187 SortKey = property(None, None) 33188# end of class HeaderColumn 33189 33190 33191class SettableHeaderColumn(HeaderColumn): 33192 """ 33193 Adds methods to set the column attributes to wxHeaderColumn. 33194 """ 33195 33196 def SetTitle(self, title): 33197 """ 33198 SetTitle(title) 33199 33200 Set the text to display in the column header. 33201 """ 33202 33203 def SetBitmap(self, bitmap): 33204 """ 33205 SetBitmap(bitmap) 33206 33207 Set the bitmap to be displayed in the column header. 33208 """ 33209 33210 def SetWidth(self, width): 33211 """ 33212 SetWidth(width) 33213 33214 Set the column width. 33215 """ 33216 33217 def SetMinWidth(self, minWidth): 33218 """ 33219 SetMinWidth(minWidth) 33220 33221 Set the minimal column width. 33222 """ 33223 33224 def SetAlignment(self, align): 33225 """ 33226 SetAlignment(align) 33227 33228 Set the alignment of the column header. 33229 """ 33230 33231 def SetFlags(self, flags): 33232 """ 33233 SetFlags(flags) 33234 33235 Set the column flags. 33236 """ 33237 33238 def ChangeFlag(self, flag, set): 33239 """ 33240 ChangeFlag(flag, set) 33241 33242 Set or clear the given flag. 33243 """ 33244 33245 def SetFlag(self, flag): 33246 """ 33247 SetFlag(flag) 33248 33249 Set the specified flag for the column. 33250 """ 33251 33252 def ClearFlag(self, flag): 33253 """ 33254 ClearFlag(flag) 33255 33256 Clear the specified flag for the column. 33257 """ 33258 33259 def ToggleFlag(self, flag): 33260 """ 33261 ToggleFlag(flag) 33262 33263 Toggle the specified flag for the column. 33264 """ 33265 33266 def SetResizeable(self, resizable): 33267 """ 33268 SetResizeable(resizable) 33269 33270 Call this to enable or disable interactive resizing of the column by 33271 the user. 33272 """ 33273 33274 def SetSortable(self, sortable): 33275 """ 33276 SetSortable(sortable) 33277 33278 Allow clicking the column to sort the control contents by the field in 33279 this column. 33280 """ 33281 33282 def SetReorderable(self, reorderable): 33283 """ 33284 SetReorderable(reorderable) 33285 33286 Allow changing the column order by dragging it. 33287 """ 33288 33289 def SetHidden(self, hidden): 33290 """ 33291 SetHidden(hidden) 33292 33293 Hide or show the column. 33294 """ 33295 33296 def UnsetAsSortKey(self): 33297 """ 33298 UnsetAsSortKey() 33299 33300 Don't use this column for sorting. 33301 """ 33302 33303 def SetSortOrder(self, ascending): 33304 """ 33305 SetSortOrder(ascending) 33306 33307 Sets this column as the sort key for the associated control. 33308 """ 33309 33310 def ToggleSortOrder(self): 33311 """ 33312 ToggleSortOrder() 33313 33314 Inverses the sort order. 33315 """ 33316 Title = property(None, None) 33317 Bitmap = property(None, None) 33318 Width = property(None, None) 33319 MinWidth = property(None, None) 33320 Alignment = property(None, None) 33321 Flags = property(None, None) 33322 Resizeable = property(None, None) 33323 Sortable = property(None, None) 33324 Reorderable = property(None, None) 33325 Hidden = property(None, None) 33326# end of class SettableHeaderColumn 33327 33328 33329class HeaderColumnSimple(SettableHeaderColumn): 33330 """ 33331 HeaderColumnSimple(title, width=COL_WIDTH_DEFAULT, align=ALIGN_NOT, flags=COL_DEFAULT_FLAGS) 33332 HeaderColumnSimple(bitmap, width=COL_WIDTH_DEFAULT, align=ALIGN_CENTER, flags=COL_DEFAULT_FLAGS) 33333 33334 Simple container for the information about the column. 33335 """ 33336 33337 def __init__(self, *args, **kw): 33338 """ 33339 HeaderColumnSimple(title, width=COL_WIDTH_DEFAULT, align=ALIGN_NOT, flags=COL_DEFAULT_FLAGS) 33340 HeaderColumnSimple(bitmap, width=COL_WIDTH_DEFAULT, align=ALIGN_CENTER, flags=COL_DEFAULT_FLAGS) 33341 33342 Simple container for the information about the column. 33343 """ 33344 33345 def SetTitle(self, title): 33346 """ 33347 SetTitle(title) 33348 33349 Trivial implementations of the base class pure virtual functions. 33350 """ 33351 33352 def GetTitle(self): 33353 """ 33354 GetTitle() -> String 33355 33356 Trivial implementations of the base class pure virtual functions. 33357 """ 33358 33359 def SetBitmap(self, bitmap): 33360 """ 33361 SetBitmap(bitmap) 33362 33363 Trivial implementations of the base class pure virtual functions. 33364 """ 33365 33366 def GetBitmap(self): 33367 """ 33368 GetBitmap() -> Bitmap 33369 33370 Trivial implementations of the base class pure virtual functions. 33371 """ 33372 33373 def SetWidth(self, width): 33374 """ 33375 SetWidth(width) 33376 33377 Trivial implementations of the base class pure virtual functions. 33378 """ 33379 33380 def GetWidth(self): 33381 """ 33382 GetWidth() -> int 33383 33384 Trivial implementations of the base class pure virtual functions. 33385 """ 33386 33387 def SetMinWidth(self, minWidth): 33388 """ 33389 SetMinWidth(minWidth) 33390 33391 Trivial implementations of the base class pure virtual functions. 33392 """ 33393 33394 def GetMinWidth(self): 33395 """ 33396 GetMinWidth() -> int 33397 33398 Trivial implementations of the base class pure virtual functions. 33399 """ 33400 33401 def SetAlignment(self, align): 33402 """ 33403 SetAlignment(align) 33404 33405 Trivial implementations of the base class pure virtual functions. 33406 """ 33407 33408 def GetAlignment(self): 33409 """ 33410 GetAlignment() -> Alignment 33411 33412 Trivial implementations of the base class pure virtual functions. 33413 """ 33414 33415 def SetFlags(self, flags): 33416 """ 33417 SetFlags(flags) 33418 33419 Trivial implementations of the base class pure virtual functions. 33420 """ 33421 33422 def GetFlags(self): 33423 """ 33424 GetFlags() -> int 33425 33426 Trivial implementations of the base class pure virtual functions. 33427 """ 33428 33429 def IsSortKey(self): 33430 """ 33431 IsSortKey() -> bool 33432 33433 Trivial implementations of the base class pure virtual functions. 33434 """ 33435 33436 def SetSortOrder(self, ascending): 33437 """ 33438 SetSortOrder(ascending) 33439 33440 Trivial implementations of the base class pure virtual functions. 33441 """ 33442 33443 def IsSortOrderAscending(self): 33444 """ 33445 IsSortOrderAscending() -> bool 33446 33447 Trivial implementations of the base class pure virtual functions. 33448 """ 33449 Alignment = property(None, None) 33450 Bitmap = property(None, None) 33451 Flags = property(None, None) 33452 MinWidth = property(None, None) 33453 Title = property(None, None) 33454 Width = property(None, None) 33455# end of class HeaderColumnSimple 33456 33457#-- end-headercol --# 33458#-- begin-headerctrl --# 33459HD_ALLOW_REORDER = 0 33460HD_ALLOW_HIDE = 0 33461HD_DEFAULT_STYLE = 0 33462wxEVT_HEADER_CLICK = 0 33463wxEVT_HEADER_RIGHT_CLICK = 0 33464wxEVT_HEADER_MIDDLE_CLICK = 0 33465wxEVT_HEADER_DCLICK = 0 33466wxEVT_HEADER_RIGHT_DCLICK = 0 33467wxEVT_HEADER_MIDDLE_DCLICK = 0 33468wxEVT_HEADER_SEPARATOR_DCLICK = 0 33469wxEVT_HEADER_BEGIN_RESIZE = 0 33470wxEVT_HEADER_RESIZING = 0 33471wxEVT_HEADER_END_RESIZE = 0 33472wxEVT_HEADER_BEGIN_REORDER = 0 33473wxEVT_HEADER_END_REORDER = 0 33474wxEVT_HEADER_DRAGGING_CANCELLED = 0 33475HeaderCtrlNameStr = "" 33476 33477class HeaderCtrl(Control): 33478 """ 33479 HeaderCtrl() 33480 HeaderCtrl(parent, winid=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=HD_DEFAULT_STYLE, name=HeaderCtrlNameStr) 33481 33482 wxHeaderCtrl is the control containing the column headings which is 33483 usually used for display of tabular data. 33484 """ 33485 33486 def __init__(self, *args, **kw): 33487 """ 33488 HeaderCtrl() 33489 HeaderCtrl(parent, winid=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=HD_DEFAULT_STYLE, name=HeaderCtrlNameStr) 33490 33491 wxHeaderCtrl is the control containing the column headings which is 33492 usually used for display of tabular data. 33493 """ 33494 33495 def Create(self, parent, winid=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=HD_DEFAULT_STYLE, name=HeaderCtrlNameStr): 33496 """ 33497 Create(parent, winid=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=HD_DEFAULT_STYLE, name=HeaderCtrlNameStr) -> bool 33498 33499 Create the header control window. 33500 """ 33501 33502 def SetColumnCount(self, count): 33503 """ 33504 SetColumnCount(count) 33505 33506 Set the number of columns in the control. 33507 """ 33508 33509 def GetColumnCount(self): 33510 """ 33511 GetColumnCount() -> unsignedint 33512 33513 Return the number of columns in the control. 33514 """ 33515 33516 def IsEmpty(self): 33517 """ 33518 IsEmpty() -> bool 33519 33520 Return whether the control has any columns. 33521 """ 33522 33523 def UpdateColumn(self, idx): 33524 """ 33525 UpdateColumn(idx) 33526 33527 Update the column with the given index. 33528 """ 33529 33530 def SetColumnsOrder(self, order): 33531 """ 33532 SetColumnsOrder(order) 33533 33534 Change the columns display order. 33535 """ 33536 33537 def GetColumnsOrder(self): 33538 """ 33539 GetColumnsOrder() -> ArrayInt 33540 33541 Return the array describing the columns display order. 33542 """ 33543 33544 def GetColumnAt(self, pos): 33545 """ 33546 GetColumnAt(pos) -> unsignedint 33547 33548 Return the index of the column displayed at the given position. 33549 """ 33550 33551 def GetColumnPos(self, idx): 33552 """ 33553 GetColumnPos(idx) -> unsignedint 33554 33555 Get the position at which this column is currently displayed. 33556 """ 33557 33558 def ResetColumnsOrder(self): 33559 """ 33560 ResetColumnsOrder() 33561 33562 Reset the columns order to the natural one. 33563 """ 33564 33565 def ShowColumnsMenu(self, pt, title=""): 33566 """ 33567 ShowColumnsMenu(pt, title="") -> bool 33568 33569 Show the popup menu allowing the user to show or hide the columns. 33570 """ 33571 33572 def AddColumnsItems(self, menu, idColumnsBase=0): 33573 """ 33574 AddColumnsItems(menu, idColumnsBase=0) 33575 33576 Helper function appending the checkable items corresponding to all the 33577 columns to the given menu. 33578 """ 33579 33580 def ShowCustomizeDialog(self): 33581 """ 33582 ShowCustomizeDialog() -> bool 33583 33584 Show the column customization dialog. 33585 """ 33586 33587 def GetColumnTitleWidth(self, col): 33588 """ 33589 GetColumnTitleWidth(col) -> int 33590 33591 Returns width needed for given column's title. 33592 """ 33593 33594 @staticmethod 33595 def MoveColumnInOrderArray(order, idx, pos): 33596 """ 33597 MoveColumnInOrderArray(order, idx, pos) 33598 33599 Helper function to manipulate the array of column indices. 33600 """ 33601 33602 @staticmethod 33603 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 33604 """ 33605 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 33606 """ 33607 ColumnCount = property(None, None) 33608 ColumnsOrder = property(None, None) 33609 33610 def GetColumn(self, idx): 33611 """ 33612 GetColumn(idx) -> HeaderColumn 33613 33614 Method to be implemented by the derived classes to return the 33615 information for the given column. 33616 """ 33617 33618 def UpdateColumnVisibility(self, idx, show): 33619 """ 33620 UpdateColumnVisibility(idx, show) 33621 33622 Method called when the column visibility is changed by the user. 33623 """ 33624 33625 def UpdateColumnsOrder(self, order): 33626 """ 33627 UpdateColumnsOrder(order) 33628 33629 Method called when the columns order is changed in the customization 33630 dialog. 33631 """ 33632 33633 def UpdateColumnWidthToFit(self, idx, widthTitle): 33634 """ 33635 UpdateColumnWidthToFit(idx, widthTitle) -> bool 33636 33637 Method which may be implemented by the derived classes to allow double 33638 clicking the column separator to resize the column to fit its 33639 contents. 33640 """ 33641 33642 def OnColumnCountChanging(self, count): 33643 """ 33644 OnColumnCountChanging(count) 33645 33646 Can be overridden in the derived class to update internal data 33647 structures when the number of the columns in the control changes. 33648 """ 33649# end of class HeaderCtrl 33650 33651 33652class HeaderCtrlSimple(HeaderCtrl): 33653 """ 33654 HeaderCtrlSimple() 33655 HeaderCtrlSimple(parent, winid=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=HD_DEFAULT_STYLE, name=HeaderCtrlNameStr) 33656 33657 wxHeaderCtrlSimple is a concrete header control which can be used 33658 directly, without inheriting from it as you need to do when using 33659 wxHeaderCtrl itself. 33660 """ 33661 33662 def __init__(self, *args, **kw): 33663 """ 33664 HeaderCtrlSimple() 33665 HeaderCtrlSimple(parent, winid=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=HD_DEFAULT_STYLE, name=HeaderCtrlNameStr) 33666 33667 wxHeaderCtrlSimple is a concrete header control which can be used 33668 directly, without inheriting from it as you need to do when using 33669 wxHeaderCtrl itself. 33670 """ 33671 33672 def InsertColumn(self, col, idx): 33673 """ 33674 InsertColumn(col, idx) 33675 33676 Insert the column at the given position. 33677 """ 33678 33679 def AppendColumn(self, col): 33680 """ 33681 AppendColumn(col) 33682 33683 Append the column to the end of the control. 33684 """ 33685 33686 def DeleteColumn(self, idx): 33687 """ 33688 DeleteColumn(idx) 33689 33690 Delete the column at the given position. 33691 """ 33692 33693 def ShowColumn(self, idx, show=True): 33694 """ 33695 ShowColumn(idx, show=True) 33696 33697 Show or hide the column. 33698 """ 33699 33700 def HideColumn(self, idx): 33701 """ 33702 HideColumn(idx) 33703 33704 Hide the column with the given index. 33705 """ 33706 33707 def ShowSortIndicator(self, idx, sortOrder=True): 33708 """ 33709 ShowSortIndicator(idx, sortOrder=True) 33710 33711 Update the column sort indicator. 33712 """ 33713 33714 def RemoveSortIndicator(self): 33715 """ 33716 RemoveSortIndicator() 33717 33718 Remove the sort indicator from the column being used as sort key. 33719 """ 33720 33721 @staticmethod 33722 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 33723 """ 33724 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 33725 """ 33726 33727 def GetBestFittingWidth(self, idx): 33728 """ 33729 GetBestFittingWidth(idx) -> int 33730 33731 This function can be overridden in the classes deriving from this 33732 control instead of overriding UpdateColumnWidthToFit(). 33733 """ 33734# end of class HeaderCtrlSimple 33735 33736 33737class HeaderCtrlEvent(NotifyEvent): 33738 """ 33739 HeaderCtrlEvent(commandType=wxEVT_NULL, winid=0) 33740 HeaderCtrlEvent(event) 33741 33742 Event class representing the events generated by wxHeaderCtrl. 33743 """ 33744 33745 def __init__(self, *args, **kw): 33746 """ 33747 HeaderCtrlEvent(commandType=wxEVT_NULL, winid=0) 33748 HeaderCtrlEvent(event) 33749 33750 Event class representing the events generated by wxHeaderCtrl. 33751 """ 33752 33753 def GetColumn(self): 33754 """ 33755 GetColumn() -> int 33756 33757 Return the index of the column affected by this event. 33758 """ 33759 33760 def SetColumn(self, col): 33761 """ 33762 SetColumn(col) 33763 """ 33764 33765 def GetWidth(self): 33766 """ 33767 GetWidth() -> int 33768 33769 Return the current width of the column. 33770 """ 33771 33772 def SetWidth(self, width): 33773 """ 33774 SetWidth(width) 33775 """ 33776 33777 def GetNewOrder(self): 33778 """ 33779 GetNewOrder() -> unsignedint 33780 33781 Return the new order of the column. 33782 """ 33783 33784 def SetNewOrder(self, order): 33785 """ 33786 SetNewOrder(order) 33787 """ 33788 Column = property(None, None) 33789 NewOrder = property(None, None) 33790 Width = property(None, None) 33791# end of class HeaderCtrlEvent 33792 33793 33794EVT_HEADER_CLICK = wx.PyEventBinder( wxEVT_HEADER_CLICK ) 33795EVT_HEADER_RIGHT_CLICK = wx.PyEventBinder( wxEVT_HEADER_RIGHT_CLICK ) 33796EVT_HEADER_MIDDLE_CLICK = wx.PyEventBinder( wxEVT_HEADER_MIDDLE_CLICK ) 33797EVT_HEADER_DCLICK = wx.PyEventBinder( wxEVT_HEADER_DCLICK ) 33798EVT_HEADER_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_HEADER_RIGHT_DCLICK ) 33799EVT_HEADER_MIDDLE_DCLICK = wx.PyEventBinder( wxEVT_HEADER_MIDDLE_DCLICK ) 33800EVT_HEADER_SEPARATOR_DCLICK = wx.PyEventBinder( wxEVT_HEADER_SEPARATOR_DCLICK ) 33801EVT_HEADER_BEGIN_RESIZE = wx.PyEventBinder( wxEVT_HEADER_BEGIN_RESIZE ) 33802EVT_HEADER_RESIZING = wx.PyEventBinder( wxEVT_HEADER_RESIZING ) 33803EVT_HEADER_END_RESIZE = wx.PyEventBinder( wxEVT_HEADER_END_RESIZE ) 33804EVT_HEADER_BEGIN_REORDER = wx.PyEventBinder( wxEVT_HEADER_BEGIN_REORDER ) 33805EVT_HEADER_END_REORDER = wx.PyEventBinder( wxEVT_HEADER_END_REORDER ) 33806EVT_HEADER_DRAGGING_CANCELLED = wx.PyEventBinder( wxEVT_HEADER_DRAGGING_CANCELLED ) 33807 33808# deprecated wxEVT aliases 33809wxEVT_COMMAND_HEADER_CLICK = wxEVT_HEADER_CLICK 33810wxEVT_COMMAND_HEADER_RIGHT_CLICK = wxEVT_HEADER_RIGHT_CLICK 33811wxEVT_COMMAND_HEADER_MIDDLE_CLICK = wxEVT_HEADER_MIDDLE_CLICK 33812wxEVT_COMMAND_HEADER_DCLICK = wxEVT_HEADER_DCLICK 33813wxEVT_COMMAND_HEADER_RIGHT_DCLICK = wxEVT_HEADER_RIGHT_DCLICK 33814wxEVT_COMMAND_HEADER_MIDDLE_DCLICK = wxEVT_HEADER_MIDDLE_DCLICK 33815wxEVT_COMMAND_HEADER_SEPARATOR_DCLICK = wxEVT_HEADER_SEPARATOR_DCLICK 33816wxEVT_COMMAND_HEADER_BEGIN_RESIZE = wxEVT_HEADER_BEGIN_RESIZE 33817wxEVT_COMMAND_HEADER_RESIZING = wxEVT_HEADER_RESIZING 33818wxEVT_COMMAND_HEADER_END_RESIZE = wxEVT_HEADER_END_RESIZE 33819wxEVT_COMMAND_HEADER_BEGIN_REORDER = wxEVT_HEADER_BEGIN_REORDER 33820wxEVT_COMMAND_HEADER_END_REORDER = wxEVT_HEADER_END_REORDER 33821wxEVT_COMMAND_HEADER_DRAGGING_CANCELLED = wxEVT_HEADER_DRAGGING_CANCELLED 33822#-- end-headerctrl --# 33823#-- begin-srchctrl --# 33824wxEVT_SEARCHCTRL_CANCEL_BTN = 0 33825wxEVT_SEARCHCTRL_SEARCH_BTN = 0 33826SearchCtrlNameStr = "" 33827 33828class SearchCtrl(Control): 33829 """ 33830 SearchCtrl() 33831 SearchCtrl(parent, id=ID_ANY, value=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, validator=DefaultValidator, name=SearchCtrlNameStr) 33832 33833 A search control is a composite control with a search button, a text 33834 control, and a cancel button. 33835 """ 33836 33837 def __init__(self, *args, **kw): 33838 """ 33839 SearchCtrl() 33840 SearchCtrl(parent, id=ID_ANY, value=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, validator=DefaultValidator, name=SearchCtrlNameStr) 33841 33842 A search control is a composite control with a search button, a text 33843 control, and a cancel button. 33844 """ 33845 33846 def Create(self, parent, id=ID_ANY, value=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, validator=DefaultValidator, name=SearchCtrlNameStr): 33847 """ 33848 Create(parent, id=ID_ANY, value=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, validator=DefaultValidator, name=SearchCtrlNameStr) -> bool 33849 """ 33850 33851 def GetMenu(self): 33852 """ 33853 GetMenu() -> Menu 33854 33855 Returns a pointer to the search control's menu object or NULL if there 33856 is no menu attached. 33857 """ 33858 33859 def IsSearchButtonVisible(self): 33860 """ 33861 IsSearchButtonVisible() -> bool 33862 33863 Returns the search button visibility value. 33864 """ 33865 33866 def IsCancelButtonVisible(self): 33867 """ 33868 IsCancelButtonVisible() -> bool 33869 33870 Returns the cancel button's visibility state. 33871 """ 33872 33873 def SetMenu(self, menu): 33874 """ 33875 SetMenu(menu) 33876 33877 Sets the search control's menu object. 33878 """ 33879 33880 def ShowCancelButton(self, show): 33881 """ 33882 ShowCancelButton(show) 33883 33884 Shows or hides the cancel button. 33885 """ 33886 33887 def ShowSearchButton(self, show): 33888 """ 33889 ShowSearchButton(show) 33890 33891 Sets the search button visibility value on the search control. 33892 """ 33893 33894 def SetDescriptiveText(self, text): 33895 """ 33896 SetDescriptiveText(text) 33897 33898 Set the text to be displayed in the search control when the user has 33899 not yet typed anything in it. 33900 """ 33901 33902 def GetDescriptiveText(self): 33903 """ 33904 GetDescriptiveText() -> String 33905 33906 Return the text displayed when there is not yet any user input. 33907 """ 33908 33909 def SetSearchBitmap(self, bmp): 33910 """ 33911 SetSearchBitmap(bmp) 33912 """ 33913 33914 def SetSearchMenuBitmap(self, bmp): 33915 """ 33916 SetSearchMenuBitmap(bmp) 33917 """ 33918 33919 def SetCancelBitmap(self, bmp): 33920 """ 33921 SetCancelBitmap(bmp) 33922 """ 33923 33924 def SetMargins(self, *args, **kw): 33925 """ 33926 SetMargins(pt) -> bool 33927 SetMargins(left, top=-1) -> bool 33928 33929 Attempts to set the control margins. 33930 """ 33931 33932 def AppendText(self, text): 33933 """ 33934 AppendText(text) 33935 33936 Appends the text to the end of the text control. 33937 """ 33938 33939 def AutoComplete(self, *args, **kw): 33940 """ 33941 AutoComplete(choices) -> bool 33942 AutoComplete(completer) -> bool 33943 33944 Call this function to enable auto-completion of the text typed in a 33945 single-line text control using the given choices. 33946 """ 33947 33948 def AutoCompleteFileNames(self): 33949 """ 33950 AutoCompleteFileNames() -> bool 33951 33952 Call this function to enable auto-completion of the text typed in a 33953 single-line text control using all valid file system paths. 33954 """ 33955 33956 def AutoCompleteDirectories(self): 33957 """ 33958 AutoCompleteDirectories() -> bool 33959 33960 Call this function to enable auto-completion of the text using the 33961 file system directories. 33962 """ 33963 33964 def CanCopy(self): 33965 """ 33966 CanCopy() -> bool 33967 33968 Returns true if the selection can be copied to the clipboard. 33969 """ 33970 33971 def CanCut(self): 33972 """ 33973 CanCut() -> bool 33974 33975 Returns true if the selection can be cut to the clipboard. 33976 """ 33977 33978 def CanPaste(self): 33979 """ 33980 CanPaste() -> bool 33981 33982 Returns true if the contents of the clipboard can be pasted into the 33983 text control. 33984 """ 33985 33986 def CanRedo(self): 33987 """ 33988 CanRedo() -> bool 33989 33990 Returns true if there is a redo facility available and the last 33991 operation can be redone. 33992 """ 33993 33994 def CanUndo(self): 33995 """ 33996 CanUndo() -> bool 33997 33998 Returns true if there is an undo facility available and the last 33999 operation can be undone. 34000 """ 34001 34002 def ChangeValue(self, value): 34003 """ 34004 ChangeValue(value) 34005 34006 Sets the new text control value. 34007 """ 34008 34009 def Clear(self): 34010 """ 34011 Clear() 34012 34013 Clears the text in the control. 34014 """ 34015 34016 def Copy(self): 34017 """ 34018 Copy() 34019 34020 Copies the selected text to the clipboard. 34021 """ 34022 34023 def Cut(self): 34024 """ 34025 Cut() 34026 34027 Copies the selected text to the clipboard and removes it from the 34028 control. 34029 """ 34030 34031 def GetInsertionPoint(self): 34032 """ 34033 GetInsertionPoint() -> long 34034 34035 Returns the insertion point, or cursor, position. 34036 """ 34037 34038 def GetLastPosition(self): 34039 """ 34040 GetLastPosition() -> TextPos 34041 34042 Returns the zero based index of the last position in the text control, 34043 which is equal to the number of characters in the control. 34044 """ 34045 34046 def GetRange(self, from_, to_): 34047 """ 34048 GetRange(from_, to_) -> String 34049 34050 Returns the string containing the text starting in the positions from 34051 and up to to in the control. 34052 """ 34053 34054 def GetSelection(self): 34055 """ 34056 GetSelection() -> (from, to) 34057 34058 Gets the current selection span. 34059 """ 34060 34061 def GetStringSelection(self): 34062 """ 34063 GetStringSelection() -> String 34064 34065 Gets the text currently selected in the control. 34066 """ 34067 34068 def GetValue(self): 34069 """ 34070 GetValue() -> String 34071 34072 Gets the contents of the control. 34073 """ 34074 34075 def IsEditable(self): 34076 """ 34077 IsEditable() -> bool 34078 34079 Returns true if the controls contents may be edited by user (note that 34080 it always can be changed by the program). 34081 """ 34082 34083 def IsEmpty(self): 34084 """ 34085 IsEmpty() -> bool 34086 34087 Returns true if the control is currently empty. 34088 """ 34089 34090 def Paste(self): 34091 """ 34092 Paste() 34093 34094 Pastes text from the clipboard to the text item. 34095 """ 34096 34097 def Redo(self): 34098 """ 34099 Redo() 34100 34101 If there is a redo facility and the last operation can be redone, 34102 redoes the last operation. 34103 """ 34104 34105 def Remove(self, from_, to_): 34106 """ 34107 Remove(from_, to_) 34108 34109 Removes the text starting at the first given position up to (but not 34110 including) the character at the last position. 34111 """ 34112 34113 def Replace(self, from_, to_, value): 34114 """ 34115 Replace(from_, to_, value) 34116 34117 Replaces the text starting at the first position up to (but not 34118 including) the character at the last position with the given text. 34119 """ 34120 34121 def SetEditable(self, editable): 34122 """ 34123 SetEditable(editable) 34124 34125 Makes the text item editable or read-only, overriding the 34126 wxTE_READONLY flag. 34127 """ 34128 34129 def SetInsertionPoint(self, pos): 34130 """ 34131 SetInsertionPoint(pos) 34132 34133 Sets the insertion point at the given position. 34134 """ 34135 34136 def SetInsertionPointEnd(self): 34137 """ 34138 SetInsertionPointEnd() 34139 34140 Sets the insertion point at the end of the text control. 34141 """ 34142 34143 def SetMaxLength(self, len): 34144 """ 34145 SetMaxLength(len) 34146 34147 This function sets the maximum number of characters the user can enter 34148 into the control. 34149 """ 34150 34151 def SetSelection(self, from_, to_): 34152 """ 34153 SetSelection(from_, to_) 34154 34155 Selects the text starting at the first position up to (but not 34156 including) the character at the last position. 34157 """ 34158 34159 def SelectAll(self): 34160 """ 34161 SelectAll() 34162 34163 Selects all text in the control. 34164 """ 34165 34166 def SelectNone(self): 34167 """ 34168 SelectNone() 34169 34170 Deselects selected text in the control. 34171 """ 34172 34173 def SetHint(self, hint): 34174 """ 34175 SetHint(hint) -> bool 34176 34177 Sets a hint shown in an empty unfocused text control. 34178 """ 34179 34180 def GetHint(self): 34181 """ 34182 GetHint() -> String 34183 34184 Returns the current hint string. 34185 """ 34186 34187 def GetMargins(self): 34188 """ 34189 GetMargins() -> Point 34190 34191 Returns the margins used by the control. 34192 """ 34193 34194 def SetValue(self, value): 34195 """ 34196 SetValue(value) 34197 34198 Sets the new text control value. 34199 """ 34200 34201 def Undo(self): 34202 """ 34203 Undo() 34204 34205 If there is an undo facility and the last operation can be undone, 34206 undoes the last operation. 34207 """ 34208 34209 def WriteText(self, text): 34210 """ 34211 WriteText(text) 34212 34213 Writes the text into the text control at the current insertion 34214 position. 34215 """ 34216 34217 def DiscardEdits(self): 34218 """ 34219 DiscardEdits() 34220 34221 Resets the internal modified flag as if the current changes had been 34222 saved. 34223 """ 34224 34225 def EmulateKeyPress(self, event): 34226 """ 34227 EmulateKeyPress(event) -> bool 34228 34229 This function inserts into the control the character which would have 34230 been inserted if the given key event had occurred in the text control. 34231 """ 34232 34233 def GetDefaultStyle(self): 34234 """ 34235 GetDefaultStyle() -> TextAttr 34236 34237 Returns the style currently used for the new text. 34238 """ 34239 34240 def GetLineLength(self, lineNo): 34241 """ 34242 GetLineLength(lineNo) -> int 34243 34244 Gets the length of the specified line, not including any trailing 34245 newline character(s). 34246 """ 34247 34248 def GetLineText(self, lineNo): 34249 """ 34250 GetLineText(lineNo) -> String 34251 34252 Returns the contents of a given line in the text control, not 34253 including any trailing newline character(s). 34254 """ 34255 34256 def GetNumberOfLines(self): 34257 """ 34258 GetNumberOfLines() -> int 34259 34260 Returns the number of lines in the text control buffer. 34261 """ 34262 34263 def GetStyle(self, position, style): 34264 """ 34265 GetStyle(position, style) -> bool 34266 34267 Returns the style at this position in the text control. 34268 """ 34269 34270 def HitTestPos(self, pt): 34271 """ 34272 HitTestPos(pt) -> (TextCtrlHitTestResult, pos) 34273 34274 Finds the position of the character at the specified point. 34275 """ 34276 34277 def HitTest(self, pt): 34278 """ 34279 HitTest(pt) -> (TextCtrlHitTestResult, col, row) 34280 34281 Finds the row and column of the character at the specified point. 34282 """ 34283 34284 def IsModified(self): 34285 """ 34286 IsModified() -> bool 34287 34288 Returns true if the text has been modified by user. 34289 """ 34290 34291 def IsMultiLine(self): 34292 """ 34293 IsMultiLine() -> bool 34294 34295 Returns true if this is a multi line edit control and false otherwise. 34296 """ 34297 34298 def IsSingleLine(self): 34299 """ 34300 IsSingleLine() -> bool 34301 34302 Returns true if this is a single line edit control and false 34303 otherwise. 34304 """ 34305 34306 def MarkDirty(self): 34307 """ 34308 MarkDirty() 34309 34310 Mark text as modified (dirty). 34311 """ 34312 34313 def PositionToXY(self, pos): 34314 """ 34315 PositionToXY(pos) -> (bool, x, y) 34316 34317 Converts given position to a zero-based column, line number pair. 34318 """ 34319 34320 def PositionToCoords(self, pos): 34321 """ 34322 PositionToCoords(pos) -> Point 34323 34324 Converts given text position to client coordinates in pixels. 34325 """ 34326 34327 def SetDefaultStyle(self, style): 34328 """ 34329 SetDefaultStyle(style) -> bool 34330 34331 Changes the default style to use for the new text which is going to be 34332 added to the control using WriteText() or AppendText(). 34333 """ 34334 34335 def SetModified(self, modified): 34336 """ 34337 SetModified(modified) 34338 34339 Marks the control as being modified by the user or not. 34340 """ 34341 34342 def SetStyle(self, start, end, style): 34343 """ 34344 SetStyle(start, end, style) -> bool 34345 34346 Changes the style of the given range. 34347 """ 34348 34349 def ShowPosition(self, pos): 34350 """ 34351 ShowPosition(pos) 34352 34353 Makes the line containing the given position visible. 34354 """ 34355 34356 def XYToPosition(self, x, y): 34357 """ 34358 XYToPosition(x, y) -> long 34359 34360 Converts the given zero based column and line number to a position. 34361 """ 34362 34363 @staticmethod 34364 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 34365 """ 34366 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 34367 """ 34368 34369 def write(self, text): 34370 """ 34371 write(text) 34372 34373 Append text to the textctrl, for file-like compatibility. 34374 """ 34375 34376 def flush(self): 34377 """ 34378 flush() 34379 34380 NOP, for file-like compatibility. 34381 """ 34382 SearchButtonVisible = property(None, None) 34383 CancelButtonVisible = property(None, None) 34384 DefaultStyle = property(None, None) 34385 DescriptiveText = property(None, None) 34386 Hint = property(None, None) 34387 InsertionPoint = property(None, None) 34388 LastPosition = property(None, None) 34389 Margins = property(None, None) 34390 Menu = property(None, None) 34391 NumberOfLines = property(None, None) 34392 StringSelection = property(None, None) 34393 Value = property(None, None) 34394# end of class SearchCtrl 34395 34396 34397EVT_SEARCHCTRL_CANCEL_BTN = wx.PyEventBinder( wxEVT_SEARCHCTRL_CANCEL_BTN, 1) 34398EVT_SEARCHCTRL_SEARCH_BTN = wx.PyEventBinder( wxEVT_SEARCHCTRL_SEARCH_BTN, 1) 34399 34400# deprecated wxEVT aliases 34401wxEVT_COMMAND_SEARCHCTRL_CANCEL_BTN = wxEVT_SEARCHCTRL_CANCEL_BTN 34402wxEVT_COMMAND_SEARCHCTRL_SEARCH_BTN = wxEVT_SEARCHCTRL_SEARCH_BTN 34403#-- end-srchctrl --# 34404#-- begin-radiobox --# 34405RadioBoxNameStr = "" 34406 34407class RadioBox(Control, ItemContainerImmutable): 34408 """ 34409 RadioBox() 34410 RadioBox(parent, id=ID_ANY, label=EmptyString, pos=DefaultPosition, size=DefaultSize, choices=[], majorDimension=0, style=RA_SPECIFY_COLS, validator=DefaultValidator, name=RadioBoxNameStr) 34411 34412 A radio box item is used to select one of number of mutually exclusive 34413 choices. 34414 """ 34415 34416 def __init__(self, *args, **kw): 34417 """ 34418 RadioBox() 34419 RadioBox(parent, id=ID_ANY, label=EmptyString, pos=DefaultPosition, size=DefaultSize, choices=[], majorDimension=0, style=RA_SPECIFY_COLS, validator=DefaultValidator, name=RadioBoxNameStr) 34420 34421 A radio box item is used to select one of number of mutually exclusive 34422 choices. 34423 """ 34424 34425 def Create(self, parent, id=ID_ANY, label=EmptyString, pos=DefaultPosition, size=DefaultSize, choices=[], majorDimension=0, style=RA_SPECIFY_COLS, validator=DefaultValidator, name=RadioBoxNameStr): 34426 """ 34427 Create(parent, id=ID_ANY, label=EmptyString, pos=DefaultPosition, size=DefaultSize, choices=[], majorDimension=0, style=RA_SPECIFY_COLS, validator=DefaultValidator, name=RadioBoxNameStr) -> bool 34428 34429 Creates the radiobox for two-step construction. 34430 """ 34431 34432 def EnableItem(self, n, enable=True): 34433 """ 34434 EnableItem(n, enable=True) -> bool 34435 34436 Enables or disables an individual button in the radiobox. 34437 """ 34438 34439 def FindString(self, string, bCase=False): 34440 """ 34441 FindString(string, bCase=False) -> int 34442 34443 Finds a button matching the given string, returning the position if 34444 found, or wxNOT_FOUND if not found. 34445 """ 34446 34447 def GetColumnCount(self): 34448 """ 34449 GetColumnCount() -> unsignedint 34450 34451 Returns the number of columns in the radiobox. 34452 """ 34453 34454 def GetItemFromPoint(self, pt): 34455 """ 34456 GetItemFromPoint(pt) -> int 34457 34458 Returns a radio box item under the point, a zero-based item index, or 34459 wxNOT_FOUND if no item is under the point. 34460 """ 34461 34462 def GetItemHelpText(self, item): 34463 """ 34464 GetItemHelpText(item) -> String 34465 34466 Returns the helptext associated with the specified item if any or 34467 wxEmptyString. 34468 """ 34469 34470 def GetItemToolTip(self, item): 34471 """ 34472 GetItemToolTip(item) -> ToolTip 34473 34474 Returns the tooltip associated with the specified item if any or NULL. 34475 """ 34476 34477 def GetRowCount(self): 34478 """ 34479 GetRowCount() -> unsignedint 34480 34481 Returns the number of rows in the radiobox. 34482 """ 34483 34484 def IsItemEnabled(self, n): 34485 """ 34486 IsItemEnabled(n) -> bool 34487 34488 Returns true if the item is enabled or false if it was disabled using 34489 Enable(n, false). 34490 """ 34491 34492 def IsItemShown(self, n): 34493 """ 34494 IsItemShown(n) -> bool 34495 34496 Returns true if the item is currently shown or false if it was hidden 34497 using Show(n, false). 34498 """ 34499 34500 def SetItemHelpText(self, item, helptext): 34501 """ 34502 SetItemHelpText(item, helptext) 34503 34504 Sets the helptext for an item. 34505 """ 34506 34507 def SetItemToolTip(self, item, text): 34508 """ 34509 SetItemToolTip(item, text) 34510 34511 Sets the tooltip text for the specified item in the radio group. 34512 """ 34513 34514 def SetSelection(self, n): 34515 """ 34516 SetSelection(n) 34517 34518 Sets the selection to the given item. 34519 """ 34520 34521 def ShowItem(self, item, show=True): 34522 """ 34523 ShowItem(item, show=True) -> bool 34524 34525 Shows or hides individual buttons. 34526 """ 34527 34528 def GetCount(self): 34529 """ 34530 GetCount() -> unsignedint 34531 34532 Returns the number of items in the control. 34533 """ 34534 34535 def GetString(self, n): 34536 """ 34537 GetString(n) -> String 34538 34539 Returns the label of the item with the given index. 34540 """ 34541 34542 def SetString(self, n, string): 34543 """ 34544 SetString(n, string) 34545 34546 Sets the label for the given item. 34547 """ 34548 34549 def GetSelection(self): 34550 """ 34551 GetSelection() -> int 34552 34553 Returns the index of the selected item or wxNOT_FOUND if no item is 34554 selected. 34555 """ 34556 34557 def GetItemLabel(self, n): 34558 """ 34559 GetItemLabel(self, n) -> string 34560 34561 Return the text of the n'th item in the radio box. 34562 """ 34563 34564 def SetItemLabel(self, n, text): 34565 """ 34566 SetItemLabel(self, n, text) 34567 34568 Set the text of the n'th item in the radio box. 34569 """ 34570 34571 @staticmethod 34572 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 34573 """ 34574 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 34575 """ 34576 ColumnCount = property(None, None) 34577 Count = property(None, None) 34578 RowCount = property(None, None) 34579 Selection = property(None, None) 34580# end of class RadioBox 34581 34582#-- end-radiobox --# 34583#-- begin-radiobut --# 34584RadioButtonNameStr = "" 34585 34586class RadioButton(Control): 34587 """ 34588 RadioButton() 34589 RadioButton(parent, id=ID_ANY, label=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, validator=DefaultValidator, name=RadioButtonNameStr) 34590 34591 A radio button item is a button which usually denotes one of several 34592 mutually exclusive options. 34593 """ 34594 34595 def __init__(self, *args, **kw): 34596 """ 34597 RadioButton() 34598 RadioButton(parent, id=ID_ANY, label=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, validator=DefaultValidator, name=RadioButtonNameStr) 34599 34600 A radio button item is a button which usually denotes one of several 34601 mutually exclusive options. 34602 """ 34603 34604 def Create(self, parent, id=ID_ANY, label=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, validator=DefaultValidator, name=RadioButtonNameStr): 34605 """ 34606 Create(parent, id=ID_ANY, label=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, validator=DefaultValidator, name=RadioButtonNameStr) -> bool 34607 34608 Creates the choice for two-step construction. 34609 """ 34610 34611 def GetValue(self): 34612 """ 34613 GetValue() -> bool 34614 34615 Returns true if the radio button is checked, false otherwise. 34616 """ 34617 34618 def SetValue(self, value): 34619 """ 34620 SetValue(value) 34621 34622 Sets the radio button to checked or unchecked status. 34623 """ 34624 34625 @staticmethod 34626 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 34627 """ 34628 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 34629 """ 34630 Value = property(None, None) 34631# end of class RadioButton 34632 34633#-- end-radiobut --# 34634#-- begin-slider --# 34635SL_HORIZONTAL = 0 34636SL_VERTICAL = 0 34637SL_TICKS = 0 34638SL_AUTOTICKS = 0 34639SL_LEFT = 0 34640SL_TOP = 0 34641SL_RIGHT = 0 34642SL_BOTTOM = 0 34643SL_BOTH = 0 34644SL_SELRANGE = 0 34645SL_INVERSE = 0 34646SL_MIN_MAX_LABELS = 0 34647SL_VALUE_LABEL = 0 34648SL_LABELS = 0 34649SliderNameStr = "" 34650 34651class Slider(Control): 34652 """ 34653 Slider() 34654 Slider(parent, id=ID_ANY, value=0, minValue=0, maxValue=100, pos=DefaultPosition, size=DefaultSize, style=SL_HORIZONTAL, validator=DefaultValidator, name=SliderNameStr) 34655 34656 A slider is a control with a handle which can be pulled back and forth 34657 to change the value. 34658 """ 34659 34660 def __init__(self, *args, **kw): 34661 """ 34662 Slider() 34663 Slider(parent, id=ID_ANY, value=0, minValue=0, maxValue=100, pos=DefaultPosition, size=DefaultSize, style=SL_HORIZONTAL, validator=DefaultValidator, name=SliderNameStr) 34664 34665 A slider is a control with a handle which can be pulled back and forth 34666 to change the value. 34667 """ 34668 34669 def ClearSel(self): 34670 """ 34671 ClearSel() 34672 34673 Clears the selection, for a slider with the wxSL_SELRANGE style. 34674 """ 34675 34676 def ClearTicks(self): 34677 """ 34678 ClearTicks() 34679 34680 Clears the ticks. 34681 """ 34682 34683 def Create(self, parent, id=ID_ANY, value=0, minValue=0, maxValue=100, point=DefaultPosition, size=DefaultSize, style=SL_HORIZONTAL, validator=DefaultValidator, name=SliderNameStr): 34684 """ 34685 Create(parent, id=ID_ANY, value=0, minValue=0, maxValue=100, point=DefaultPosition, size=DefaultSize, style=SL_HORIZONTAL, validator=DefaultValidator, name=SliderNameStr) -> bool 34686 34687 Used for two-step slider construction. 34688 """ 34689 34690 def GetLineSize(self): 34691 """ 34692 GetLineSize() -> int 34693 34694 Returns the line size. 34695 """ 34696 34697 def GetMax(self): 34698 """ 34699 GetMax() -> int 34700 34701 Gets the maximum slider value. 34702 """ 34703 34704 def GetMin(self): 34705 """ 34706 GetMin() -> int 34707 34708 Gets the minimum slider value. 34709 """ 34710 34711 def GetPageSize(self): 34712 """ 34713 GetPageSize() -> int 34714 34715 Returns the page size. 34716 """ 34717 34718 def GetSelEnd(self): 34719 """ 34720 GetSelEnd() -> int 34721 34722 Returns the selection end point. 34723 """ 34724 34725 def GetSelStart(self): 34726 """ 34727 GetSelStart() -> int 34728 34729 Returns the selection start point. 34730 """ 34731 34732 def GetThumbLength(self): 34733 """ 34734 GetThumbLength() -> int 34735 34736 Returns the thumb length. 34737 """ 34738 34739 def GetTickFreq(self): 34740 """ 34741 GetTickFreq() -> int 34742 34743 Returns the tick frequency. 34744 """ 34745 34746 def GetValue(self): 34747 """ 34748 GetValue() -> int 34749 34750 Gets the current slider value. 34751 """ 34752 34753 def SetLineSize(self, lineSize): 34754 """ 34755 SetLineSize(lineSize) 34756 34757 Sets the line size for the slider. 34758 """ 34759 34760 def SetMin(self, minValue): 34761 """ 34762 SetMin(minValue) 34763 34764 Sets the minimum slider value. 34765 """ 34766 34767 def SetMax(self, maxValue): 34768 """ 34769 SetMax(maxValue) 34770 34771 Sets the maximum slider value. 34772 """ 34773 34774 def SetPageSize(self, pageSize): 34775 """ 34776 SetPageSize(pageSize) 34777 34778 Sets the page size for the slider. 34779 """ 34780 34781 def SetRange(self, minValue, maxValue): 34782 """ 34783 SetRange(minValue, maxValue) 34784 34785 Sets the minimum and maximum slider values. 34786 """ 34787 34788 def SetSelection(self, startPos, endPos): 34789 """ 34790 SetSelection(startPos, endPos) 34791 34792 Sets the selection. 34793 """ 34794 34795 def SetThumbLength(self, len): 34796 """ 34797 SetThumbLength(len) 34798 34799 Sets the slider thumb length. 34800 """ 34801 34802 def SetTick(self, tickPos): 34803 """ 34804 SetTick(tickPos) 34805 34806 Sets a tick position. 34807 """ 34808 34809 def SetTickFreq(self, n): 34810 """ 34811 SetTickFreq(n) 34812 34813 Sets the tick mark frequency and position. 34814 """ 34815 34816 def SetValue(self, value): 34817 """ 34818 SetValue(value) 34819 34820 Sets the slider position. 34821 """ 34822 34823 def GetRange(self): 34824 """ 34825 34826 """ 34827 34828 @staticmethod 34829 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 34830 """ 34831 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 34832 """ 34833 LineSize = property(None, None) 34834 Max = property(None, None) 34835 Min = property(None, None) 34836 PageSize = property(None, None) 34837 Range = property(None, None) 34838 SelEnd = property(None, None) 34839 SelStart = property(None, None) 34840 ThumbLength = property(None, None) 34841 TickFreq = property(None, None) 34842 Value = property(None, None) 34843# end of class Slider 34844 34845#-- end-slider --# 34846#-- begin-spinbutt --# 34847 34848class SpinButton(Control): 34849 """ 34850 SpinButton() 34851 SpinButton(parent, id=-1, pos=DefaultPosition, size=DefaultSize, style=SP_VERTICAL, name="spinButton") 34852 34853 A wxSpinButton has two small up and down (or left and right) arrow 34854 buttons. 34855 """ 34856 34857 def __init__(self, *args, **kw): 34858 """ 34859 SpinButton() 34860 SpinButton(parent, id=-1, pos=DefaultPosition, size=DefaultSize, style=SP_VERTICAL, name="spinButton") 34861 34862 A wxSpinButton has two small up and down (or left and right) arrow 34863 buttons. 34864 """ 34865 34866 def Create(self, parent, id=-1, pos=DefaultPosition, size=DefaultSize, style=SP_VERTICAL, name="wxSpinButton"): 34867 """ 34868 Create(parent, id=-1, pos=DefaultPosition, size=DefaultSize, style=SP_VERTICAL, name="wxSpinButton") -> bool 34869 34870 Scrollbar creation function called by the spin button constructor. 34871 """ 34872 34873 def GetMax(self): 34874 """ 34875 GetMax() -> int 34876 34877 Returns the maximum permissible value. 34878 """ 34879 34880 def GetMin(self): 34881 """ 34882 GetMin() -> int 34883 34884 Returns the minimum permissible value. 34885 """ 34886 34887 def GetValue(self): 34888 """ 34889 GetValue() -> int 34890 34891 Returns the current spin button value. 34892 """ 34893 34894 def SetRange(self, min, max): 34895 """ 34896 SetRange(min, max) 34897 34898 Sets the range of the spin button. 34899 """ 34900 34901 def SetValue(self, value): 34902 """ 34903 SetValue(value) 34904 34905 Sets the value of the spin button. 34906 """ 34907 34908 def GetRange(self): 34909 """ 34910 34911 """ 34912 34913 def SetMin(self, minVal): 34914 """ 34915 34916 """ 34917 34918 def SetMax(self, maxVal): 34919 """ 34920 34921 """ 34922 34923 @staticmethod 34924 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 34925 """ 34926 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 34927 """ 34928 Max = property(None, None) 34929 Min = property(None, None) 34930 Range = property(None, None) 34931 Value = property(None, None) 34932# end of class SpinButton 34933 34934 34935class SpinEvent(NotifyEvent): 34936 """ 34937 SpinEvent(commandType=wxEVT_NULL, id=0) 34938 34939 This event class is used for the events generated by wxSpinButton and 34940 wxSpinCtrl. 34941 """ 34942 34943 def __init__(self, commandType=wxEVT_NULL, id=0): 34944 """ 34945 SpinEvent(commandType=wxEVT_NULL, id=0) 34946 34947 This event class is used for the events generated by wxSpinButton and 34948 wxSpinCtrl. 34949 """ 34950 34951 def GetPosition(self): 34952 """ 34953 GetPosition() -> int 34954 34955 Retrieve the current spin button or control value. 34956 """ 34957 34958 def SetPosition(self, pos): 34959 """ 34960 SetPosition(pos) 34961 34962 Set the value associated with the event. 34963 """ 34964 Position = property(None, None) 34965# end of class SpinEvent 34966 34967 34968EVT_SPIN_UP = wx.PyEventBinder( wxEVT_SPIN_UP, 1) 34969EVT_SPIN_DOWN = wx.PyEventBinder( wxEVT_SPIN_DOWN, 1) 34970EVT_SPIN = wx.PyEventBinder( wxEVT_SPIN, 1) 34971#-- end-spinbutt --# 34972#-- begin-spinctrl --# 34973wxEVT_SPINCTRL = 0 34974wxEVT_SPINCTRLDOUBLE = 0 34975 34976class SpinCtrl(Control): 34977 """ 34978 SpinCtrl() 34979 SpinCtrl(parent, id=ID_ANY, value=EmptyString, pos=DefaultPosition, size=DefaultSize, style=SP_ARROW_KEYS, min=0, max=100, initial=0, name="wxSpinCtrl") 34980 34981 wxSpinCtrl combines wxTextCtrl and wxSpinButton in one control. 34982 """ 34983 34984 def __init__(self, *args, **kw): 34985 """ 34986 SpinCtrl() 34987 SpinCtrl(parent, id=ID_ANY, value=EmptyString, pos=DefaultPosition, size=DefaultSize, style=SP_ARROW_KEYS, min=0, max=100, initial=0, name="wxSpinCtrl") 34988 34989 wxSpinCtrl combines wxTextCtrl and wxSpinButton in one control. 34990 """ 34991 34992 def Create(self, parent, id=ID_ANY, value=EmptyString, pos=DefaultPosition, size=DefaultSize, style=SP_ARROW_KEYS, min=0, max=100, initial=0, name="wxSpinCtrl"): 34993 """ 34994 Create(parent, id=ID_ANY, value=EmptyString, pos=DefaultPosition, size=DefaultSize, style=SP_ARROW_KEYS, min=0, max=100, initial=0, name="wxSpinCtrl") -> bool 34995 34996 Creation function called by the spin control constructor. 34997 """ 34998 34999 def GetBase(self): 35000 """ 35001 GetBase() -> int 35002 35003 Returns the numerical base being currently used, 10 by default. 35004 """ 35005 35006 def GetMax(self): 35007 """ 35008 GetMax() -> int 35009 35010 Gets maximal allowable value. 35011 """ 35012 35013 def GetMin(self): 35014 """ 35015 GetMin() -> int 35016 35017 Gets minimal allowable value. 35018 """ 35019 35020 def GetValue(self): 35021 """ 35022 GetValue() -> int 35023 35024 Gets the value of the spin control. 35025 """ 35026 35027 def SetBase(self, base): 35028 """ 35029 SetBase(base) -> bool 35030 35031 Sets the base to use for the numbers in this control. 35032 """ 35033 35034 def SetRange(self, minVal, maxVal): 35035 """ 35036 SetRange(minVal, maxVal) 35037 35038 Sets range of allowable values. 35039 """ 35040 35041 def SetSelection(self, from_, to_): 35042 """ 35043 SetSelection(from_, to_) 35044 35045 Select the text in the text part of the control between positions from 35046 (inclusive) and to (exclusive). 35047 """ 35048 35049 def SetValue(self, *args, **kw): 35050 """ 35051 SetValue(text) 35052 SetValue(value) 35053 35054 Sets the value of the spin control. 35055 """ 35056 35057 def GetRange(self): 35058 """ 35059 35060 """ 35061 35062 def SetMin(self, minVal): 35063 """ 35064 35065 """ 35066 35067 def SetMax(self, maxVal): 35068 """ 35069 35070 """ 35071 35072 @staticmethod 35073 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 35074 """ 35075 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 35076 """ 35077 Base = property(None, None) 35078 Max = property(None, None) 35079 Min = property(None, None) 35080 Range = property(None, None) 35081 Value = property(None, None) 35082# end of class SpinCtrl 35083 35084 35085class SpinCtrlDouble(Control): 35086 """ 35087 SpinCtrlDouble() 35088 SpinCtrlDouble(parent, id=-1, value=EmptyString, pos=DefaultPosition, size=DefaultSize, style=SP_ARROW_KEYS, min=0, max=100, initial=0, inc=1, name=T("wxSpinCtrlDouble")) 35089 35090 wxSpinCtrlDouble combines wxTextCtrl and wxSpinButton in one control 35091 and displays a real number. 35092 """ 35093 35094 def __init__(self, *args, **kw): 35095 """ 35096 SpinCtrlDouble() 35097 SpinCtrlDouble(parent, id=-1, value=EmptyString, pos=DefaultPosition, size=DefaultSize, style=SP_ARROW_KEYS, min=0, max=100, initial=0, inc=1, name=T("wxSpinCtrlDouble")) 35098 35099 wxSpinCtrlDouble combines wxTextCtrl and wxSpinButton in one control 35100 and displays a real number. 35101 """ 35102 35103 def Create(self, parent, id=ID_ANY, value=EmptyString, pos=DefaultPosition, size=DefaultSize, style=SP_ARROW_KEYS, min=0, max=100, initial=0, inc=1, name="wxSpinCtrlDouble"): 35104 """ 35105 Create(parent, id=ID_ANY, value=EmptyString, pos=DefaultPosition, size=DefaultSize, style=SP_ARROW_KEYS, min=0, max=100, initial=0, inc=1, name="wxSpinCtrlDouble") -> bool 35106 35107 Creation function called by the spin control constructor. 35108 """ 35109 35110 def GetDigits(self): 35111 """ 35112 GetDigits() -> unsignedint 35113 35114 Gets the number of digits in the display. 35115 """ 35116 35117 def GetIncrement(self): 35118 """ 35119 GetIncrement() -> double 35120 35121 Gets the increment value. 35122 """ 35123 35124 def GetMax(self): 35125 """ 35126 GetMax() -> double 35127 35128 Gets maximal allowable value. 35129 """ 35130 35131 def GetMin(self): 35132 """ 35133 GetMin() -> double 35134 35135 Gets minimal allowable value. 35136 """ 35137 35138 def GetValue(self): 35139 """ 35140 GetValue() -> double 35141 35142 Gets the value of the spin control. 35143 """ 35144 35145 def SetDigits(self, digits): 35146 """ 35147 SetDigits(digits) 35148 35149 Sets the number of digits in the display. 35150 """ 35151 35152 def SetIncrement(self, inc): 35153 """ 35154 SetIncrement(inc) 35155 35156 Sets the increment value. 35157 """ 35158 35159 def SetRange(self, minVal, maxVal): 35160 """ 35161 SetRange(minVal, maxVal) 35162 35163 Sets range of allowable values. 35164 """ 35165 35166 def SetValue(self, *args, **kw): 35167 """ 35168 SetValue(text) 35169 SetValue(value) 35170 35171 Sets the value of the spin control. 35172 """ 35173 35174 def GetRange(self): 35175 """ 35176 35177 """ 35178 35179 def SetMin(self, minVal): 35180 """ 35181 35182 """ 35183 35184 def SetMax(self, maxVal): 35185 """ 35186 35187 """ 35188 35189 @staticmethod 35190 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 35191 """ 35192 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 35193 """ 35194 Digits = property(None, None) 35195 Increment = property(None, None) 35196 Max = property(None, None) 35197 Min = property(None, None) 35198 Range = property(None, None) 35199 Value = property(None, None) 35200# end of class SpinCtrlDouble 35201 35202 35203class SpinDoubleEvent(NotifyEvent): 35204 """ 35205 SpinDoubleEvent(commandType=wxEVT_NULL, winid=0, value=0) 35206 SpinDoubleEvent(event) 35207 35208 This event class is used for the events generated by wxSpinCtrlDouble. 35209 """ 35210 35211 def __init__(self, *args, **kw): 35212 """ 35213 SpinDoubleEvent(commandType=wxEVT_NULL, winid=0, value=0) 35214 SpinDoubleEvent(event) 35215 35216 This event class is used for the events generated by wxSpinCtrlDouble. 35217 """ 35218 35219 def GetValue(self): 35220 """ 35221 GetValue() -> double 35222 35223 Returns the value associated with this spin control event. 35224 """ 35225 35226 def SetValue(self, value): 35227 """ 35228 SetValue(value) 35229 35230 Set the value associated with the event. 35231 """ 35232 Value = property(None, None) 35233# end of class SpinDoubleEvent 35234 35235 35236EVT_SPINCTRL = wx.PyEventBinder( wxEVT_SPINCTRL, 1) 35237EVT_SPINCTRLDOUBLE = wx.PyEventBinder( wxEVT_SPINCTRLDOUBLE, 1) 35238 35239# deprecated wxEVT aliases 35240wxEVT_COMMAND_SPINCTRL_UPDATED = wxEVT_SPINCTRL 35241wxEVT_COMMAND_SPINCTRLDOUBLE_UPDATED = wxEVT_SPINCTRLDOUBLE 35242#-- end-spinctrl --# 35243#-- begin-tglbtn --# 35244wxEVT_TOGGLEBUTTON = 0 35245 35246class ToggleButton(AnyButton): 35247 """ 35248 ToggleButton() 35249 ToggleButton(parent, id=ID_ANY, label=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, val=DefaultValidator, name=CheckBoxNameStr) 35250 35251 wxToggleButton is a button that stays pressed when clicked by the 35252 user. 35253 """ 35254 35255 def __init__(self, *args, **kw): 35256 """ 35257 ToggleButton() 35258 ToggleButton(parent, id=ID_ANY, label=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, val=DefaultValidator, name=CheckBoxNameStr) 35259 35260 wxToggleButton is a button that stays pressed when clicked by the 35261 user. 35262 """ 35263 35264 def Create(self, parent, id=ID_ANY, label=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, val=DefaultValidator, name=CheckBoxNameStr): 35265 """ 35266 Create(parent, id=ID_ANY, label=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, val=DefaultValidator, name=CheckBoxNameStr) -> bool 35267 35268 Creates the toggle button for two-step construction. 35269 """ 35270 35271 def GetValue(self): 35272 """ 35273 GetValue() -> bool 35274 35275 Gets the state of the toggle button. 35276 """ 35277 35278 def SetValue(self, state): 35279 """ 35280 SetValue(state) 35281 35282 Sets the toggle button to the given state. 35283 """ 35284 35285 @staticmethod 35286 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 35287 """ 35288 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 35289 """ 35290 Value = property(None, None) 35291# end of class ToggleButton 35292 35293 35294class BitmapToggleButton(ToggleButton): 35295 """ 35296 BitmapToggleButton() 35297 BitmapToggleButton(parent, id=ID_ANY, label=NullBitmap, pos=DefaultPosition, size=DefaultSize, style=0, val=DefaultValidator, name=CheckBoxNameStr) 35298 35299 wxBitmapToggleButton is a wxToggleButton that contains a bitmap 35300 instead of text. 35301 """ 35302 35303 def __init__(self, *args, **kw): 35304 """ 35305 BitmapToggleButton() 35306 BitmapToggleButton(parent, id=ID_ANY, label=NullBitmap, pos=DefaultPosition, size=DefaultSize, style=0, val=DefaultValidator, name=CheckBoxNameStr) 35307 35308 wxBitmapToggleButton is a wxToggleButton that contains a bitmap 35309 instead of text. 35310 """ 35311 35312 def Create(self, parent, id=ID_ANY, label=NullBitmap, pos=DefaultPosition, size=DefaultSize, style=0, val=DefaultValidator, name=CheckBoxNameStr): 35313 """ 35314 Create(parent, id=ID_ANY, label=NullBitmap, pos=DefaultPosition, size=DefaultSize, style=0, val=DefaultValidator, name=CheckBoxNameStr) -> bool 35315 35316 Create method for two-step construction. 35317 """ 35318 35319 def GetValue(self): 35320 """ 35321 GetValue() -> bool 35322 35323 Gets the state of the toggle button. 35324 """ 35325 35326 def SetValue(self, state): 35327 """ 35328 SetValue(state) 35329 35330 Sets the toggle button to the given state. 35331 """ 35332 35333 @staticmethod 35334 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 35335 """ 35336 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 35337 """ 35338 Value = property(None, None) 35339# end of class BitmapToggleButton 35340 35341 35342EVT_TOGGLEBUTTON = PyEventBinder(wxEVT_TOGGLEBUTTON, 1) 35343 35344# deprecated wxEVT alias 35345wxEVT_COMMAND_TOGGLEBUTTON_CLICKED = wxEVT_TOGGLEBUTTON 35346#-- end-tglbtn --# 35347#-- begin-scrolbar --# 35348ScrollBarNameStr = "" 35349 35350class ScrollBar(Control): 35351 """ 35352 ScrollBar() 35353 ScrollBar(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=SB_HORIZONTAL, validator=DefaultValidator, name=ScrollBarNameStr) 35354 35355 A wxScrollBar is a control that represents a horizontal or vertical 35356 scrollbar. 35357 """ 35358 35359 def __init__(self, *args, **kw): 35360 """ 35361 ScrollBar() 35362 ScrollBar(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=SB_HORIZONTAL, validator=DefaultValidator, name=ScrollBarNameStr) 35363 35364 A wxScrollBar is a control that represents a horizontal or vertical 35365 scrollbar. 35366 """ 35367 35368 def Create(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=SB_HORIZONTAL, validator=DefaultValidator, name=ScrollBarNameStr): 35369 """ 35370 Create(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=SB_HORIZONTAL, validator=DefaultValidator, name=ScrollBarNameStr) -> bool 35371 35372 Scrollbar creation function called by the scrollbar constructor. 35373 """ 35374 35375 def GetPageSize(self): 35376 """ 35377 GetPageSize() -> int 35378 35379 Returns the page size of the scrollbar. 35380 """ 35381 35382 def GetRange(self): 35383 """ 35384 GetRange() -> int 35385 35386 Returns the length of the scrollbar. 35387 """ 35388 35389 def GetThumbPosition(self): 35390 """ 35391 GetThumbPosition() -> int 35392 35393 Returns the current position of the scrollbar thumb. 35394 """ 35395 35396 def GetThumbSize(self): 35397 """ 35398 GetThumbSize() -> int 35399 35400 Returns the thumb or 'view' size. 35401 """ 35402 35403 def SetScrollbar(self, position, thumbSize, range, pageSize, refresh=True): 35404 """ 35405 SetScrollbar(position, thumbSize, range, pageSize, refresh=True) 35406 35407 Sets the scrollbar properties. 35408 """ 35409 35410 def SetThumbPosition(self, viewStart): 35411 """ 35412 SetThumbPosition(viewStart) 35413 35414 Sets the position of the scrollbar. 35415 """ 35416 35417 def IsVertical(self): 35418 """ 35419 IsVertical() -> bool 35420 35421 Returns true for scrollbars that have the vertical style set. 35422 """ 35423 35424 @staticmethod 35425 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 35426 """ 35427 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 35428 """ 35429 PageSize = property(None, None) 35430 Range = property(None, None) 35431 ThumbPosition = property(None, None) 35432 ThumbSize = property(None, None) 35433# end of class ScrollBar 35434 35435#-- end-scrolbar --# 35436#-- begin-toolbar --# 35437TOOL_STYLE_BUTTON = 0 35438TOOL_STYLE_SEPARATOR = 0 35439TOOL_STYLE_CONTROL = 0 35440TB_HORIZONTAL = 0 35441TB_TOP = 0 35442TB_VERTICAL = 0 35443TB_LEFT = 0 35444TB_3DBUTTONS = 0 35445TB_FLAT = 0 35446TB_DOCKABLE = 0 35447TB_NOICONS = 0 35448TB_TEXT = 0 35449TB_NODIVIDER = 0 35450TB_NOALIGN = 0 35451TB_HORZ_LAYOUT = 0 35452TB_HORZ_TEXT = 0 35453TB_NO_TOOLTIPS = 0 35454TB_BOTTOM = 0 35455TB_RIGHT = 0 35456TB_DEFAULT_STYLE = 0 35457 35458class ToolBarToolBase(Object): 35459 """ 35460 ToolBarToolBase(tbar=None, toolid=ID_SEPARATOR, label=EmptyString, bmpNormal=NullBitmap, bmpDisabled=NullBitmap, kind=ITEM_NORMAL, clientData=None, shortHelpString=EmptyString, longHelpString=EmptyString) 35461 ToolBarToolBase(tbar, control, label) 35462 35463 A toolbar tool represents one item on the toolbar. 35464 """ 35465 35466 def __init__(self, *args, **kw): 35467 """ 35468 ToolBarToolBase(tbar=None, toolid=ID_SEPARATOR, label=EmptyString, bmpNormal=NullBitmap, bmpDisabled=NullBitmap, kind=ITEM_NORMAL, clientData=None, shortHelpString=EmptyString, longHelpString=EmptyString) 35469 ToolBarToolBase(tbar, control, label) 35470 35471 A toolbar tool represents one item on the toolbar. 35472 """ 35473 35474 def GetId(self): 35475 """ 35476 GetId() -> int 35477 """ 35478 35479 def GetControl(self): 35480 """ 35481 GetControl() -> Control 35482 """ 35483 35484 def GetToolBar(self): 35485 """ 35486 GetToolBar() -> ToolBar 35487 35488 Return the toolbar this tool is a member of. 35489 """ 35490 35491 def IsStretchable(self): 35492 """ 35493 IsStretchable() -> bool 35494 """ 35495 35496 def IsButton(self): 35497 """ 35498 IsButton() -> bool 35499 """ 35500 35501 def IsControl(self): 35502 """ 35503 IsControl() -> bool 35504 """ 35505 35506 def IsSeparator(self): 35507 """ 35508 IsSeparator() -> bool 35509 """ 35510 35511 def IsStretchableSpace(self): 35512 """ 35513 IsStretchableSpace() -> bool 35514 """ 35515 35516 def GetStyle(self): 35517 """ 35518 GetStyle() -> int 35519 """ 35520 35521 def GetKind(self): 35522 """ 35523 GetKind() -> ItemKind 35524 """ 35525 35526 def MakeStretchable(self): 35527 """ 35528 MakeStretchable() 35529 """ 35530 35531 def IsEnabled(self): 35532 """ 35533 IsEnabled() -> bool 35534 """ 35535 35536 def IsToggled(self): 35537 """ 35538 IsToggled() -> bool 35539 """ 35540 35541 def CanBeToggled(self): 35542 """ 35543 CanBeToggled() -> bool 35544 """ 35545 35546 def GetNormalBitmap(self): 35547 """ 35548 GetNormalBitmap() -> Bitmap 35549 """ 35550 35551 def GetDisabledBitmap(self): 35552 """ 35553 GetDisabledBitmap() -> Bitmap 35554 """ 35555 35556 def GetBitmap(self): 35557 """ 35558 GetBitmap() -> Bitmap 35559 """ 35560 35561 def GetLabel(self): 35562 """ 35563 GetLabel() -> String 35564 """ 35565 35566 def GetShortHelp(self): 35567 """ 35568 GetShortHelp() -> String 35569 """ 35570 35571 def GetLongHelp(self): 35572 """ 35573 GetLongHelp() -> String 35574 """ 35575 35576 def GetClientData(self): 35577 """ 35578 GetClientData() -> PyUserData 35579 """ 35580 35581 def Enable(self, enable): 35582 """ 35583 Enable(enable) -> bool 35584 """ 35585 35586 def Toggle(self, *args, **kw): 35587 """ 35588 Toggle(toggle) -> bool 35589 Toggle() 35590 """ 35591 35592 def SetToggle(self, toggle): 35593 """ 35594 SetToggle(toggle) -> bool 35595 """ 35596 35597 def SetShortHelp(self, help): 35598 """ 35599 SetShortHelp(help) -> bool 35600 """ 35601 35602 def SetLongHelp(self, help): 35603 """ 35604 SetLongHelp(help) -> bool 35605 """ 35606 35607 def SetNormalBitmap(self, bmp): 35608 """ 35609 SetNormalBitmap(bmp) 35610 """ 35611 35612 def SetDisabledBitmap(self, bmp): 35613 """ 35614 SetDisabledBitmap(bmp) 35615 """ 35616 35617 def SetLabel(self, label): 35618 """ 35619 SetLabel(label) 35620 """ 35621 35622 def SetClientData(self, clientData): 35623 """ 35624 SetClientData(clientData) 35625 """ 35626 35627 def Detach(self): 35628 """ 35629 Detach() 35630 """ 35631 35632 def Attach(self, tbar): 35633 """ 35634 Attach(tbar) 35635 """ 35636 35637 def SetDropdownMenu(self, menu): 35638 """ 35639 SetDropdownMenu(menu) 35640 """ 35641 35642 def GetDropdownMenu(self): 35643 """ 35644 GetDropdownMenu() -> Menu 35645 """ 35646 Bitmap = property(None, None) 35647 ClientData = property(None, None) 35648 Control = property(None, None) 35649 DisabledBitmap = property(None, None) 35650 DropdownMenu = property(None, None) 35651 Id = property(None, None) 35652 Kind = property(None, None) 35653 Label = property(None, None) 35654 LongHelp = property(None, None) 35655 NormalBitmap = property(None, None) 35656 ShortHelp = property(None, None) 35657 Style = property(None, None) 35658 ToolBar = property(None, None) 35659# end of class ToolBarToolBase 35660 35661ToolBarNameStr = "" 35662 35663class ToolBar(Control): 35664 """ 35665 ToolBar() 35666 ToolBar(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=TB_HORIZONTAL, name=ToolBarNameStr) 35667 35668 A toolbar is a bar of buttons and/or other controls usually placed 35669 below the menu bar in a wxFrame. 35670 """ 35671 35672 def __init__(self, *args, **kw): 35673 """ 35674 ToolBar() 35675 ToolBar(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=TB_HORIZONTAL, name=ToolBarNameStr) 35676 35677 A toolbar is a bar of buttons and/or other controls usually placed 35678 below the menu bar in a wxFrame. 35679 """ 35680 35681 def AddTool(self, *args, **kw): 35682 """ 35683 AddTool(tool) -> ToolBarToolBase 35684 AddTool(toolId, label, bitmap, shortHelp=EmptyString, kind=ITEM_NORMAL) -> ToolBarToolBase 35685 AddTool(toolId, label, bitmap, bmpDisabled, kind=ITEM_NORMAL, shortHelp=EmptyString, longHelp=EmptyString, clientData=None) -> ToolBarToolBase 35686 35687 Adds a tool to the toolbar. 35688 """ 35689 35690 def InsertTool(self, *args, **kw): 35691 """ 35692 InsertTool(pos, toolId, label, bitmap, bmpDisabled=NullBitmap, kind=ITEM_NORMAL, shortHelp=EmptyString, longHelp=EmptyString, clientData=None) -> ToolBarToolBase 35693 InsertTool(pos, tool) -> ToolBarToolBase 35694 35695 Inserts the tool with the specified attributes into the toolbar at the 35696 given position. 35697 """ 35698 35699 def SetMargins(self, *args, **kw): 35700 """ 35701 SetMargins(x, y) 35702 SetMargins(size) 35703 35704 Set the values to be used as margins for the toolbar. 35705 """ 35706 35707 def AddCheckTool(self, toolId, label, bitmap1, bmpDisabled=NullBitmap, shortHelp=EmptyString, longHelp=EmptyString, clientData=None): 35708 """ 35709 AddCheckTool(toolId, label, bitmap1, bmpDisabled=NullBitmap, shortHelp=EmptyString, longHelp=EmptyString, clientData=None) -> ToolBarToolBase 35710 35711 Adds a new check (or toggle) tool to the toolbar. 35712 """ 35713 35714 def AddControl(self, control, label=EmptyString): 35715 """ 35716 AddControl(control, label=EmptyString) -> ToolBarToolBase 35717 35718 Adds any control to the toolbar, typically e.g. a wxComboBox. 35719 """ 35720 35721 def AddRadioTool(self, toolId, label, bitmap1, bmpDisabled=NullBitmap, shortHelp=EmptyString, longHelp=EmptyString, clientData=None): 35722 """ 35723 AddRadioTool(toolId, label, bitmap1, bmpDisabled=NullBitmap, shortHelp=EmptyString, longHelp=EmptyString, clientData=None) -> ToolBarToolBase 35724 35725 Adds a new radio tool to the toolbar. 35726 """ 35727 35728 def AddSeparator(self): 35729 """ 35730 AddSeparator() -> ToolBarToolBase 35731 35732 Adds a separator for spacing groups of tools. 35733 """ 35734 35735 def AddStretchableSpace(self): 35736 """ 35737 AddStretchableSpace() -> ToolBarToolBase 35738 35739 Adds a stretchable space to the toolbar. 35740 """ 35741 35742 def ClearTools(self): 35743 """ 35744 ClearTools() 35745 35746 Deletes all the tools in the toolbar. 35747 """ 35748 35749 def DeleteTool(self, toolId): 35750 """ 35751 DeleteTool(toolId) -> bool 35752 35753 Removes the specified tool from the toolbar and deletes it. 35754 """ 35755 35756 def DeleteToolByPos(self, pos): 35757 """ 35758 DeleteToolByPos(pos) -> bool 35759 35760 This function behaves like DeleteTool() but it deletes the tool at the 35761 specified position and not the one with the given id. 35762 """ 35763 35764 def EnableTool(self, toolId, enable): 35765 """ 35766 EnableTool(toolId, enable) 35767 35768 Enables or disables the tool. 35769 """ 35770 35771 def FindById(self, id): 35772 """ 35773 FindById(id) -> ToolBarToolBase 35774 35775 Returns a pointer to the tool identified by id or NULL if no 35776 corresponding tool is found. 35777 """ 35778 35779 def FindControl(self, id): 35780 """ 35781 FindControl(id) -> Control 35782 35783 Returns a pointer to the control identified by id or NULL if no 35784 corresponding control is found. 35785 """ 35786 35787 def FindToolForPosition(self, x, y): 35788 """ 35789 FindToolForPosition(x, y) -> ToolBarToolBase 35790 35791 Finds a tool for the given mouse position. 35792 """ 35793 35794 def GetMargins(self): 35795 """ 35796 GetMargins() -> Size 35797 35798 Returns the left/right and top/bottom margins, which are also used for 35799 inter-toolspacing. 35800 """ 35801 35802 def GetToolBitmapSize(self): 35803 """ 35804 GetToolBitmapSize() -> Size 35805 35806 Returns the size of bitmap that the toolbar expects to have. 35807 """ 35808 35809 def GetToolByPos(self, pos): 35810 """ 35811 GetToolByPos(pos) -> ToolBarToolBase 35812 35813 Returns a pointer to the tool at ordinal position pos. 35814 """ 35815 35816 def GetToolClientData(self, toolId): 35817 """ 35818 GetToolClientData(toolId) -> PyUserData 35819 35820 Get any client data associated with the tool. 35821 """ 35822 35823 def GetToolEnabled(self, toolId): 35824 """ 35825 GetToolEnabled(toolId) -> bool 35826 35827 Called to determine whether a tool is enabled (responds to user 35828 input). 35829 """ 35830 35831 def GetToolLongHelp(self, toolId): 35832 """ 35833 GetToolLongHelp(toolId) -> String 35834 35835 Returns the long help for the given tool. 35836 """ 35837 35838 def GetToolPacking(self): 35839 """ 35840 GetToolPacking() -> int 35841 35842 Returns the value used for packing tools. 35843 """ 35844 35845 def GetToolPos(self, toolId): 35846 """ 35847 GetToolPos(toolId) -> int 35848 35849 Returns the tool position in the toolbar, or wxNOT_FOUND if the tool 35850 is not found. 35851 """ 35852 35853 def GetToolSeparation(self): 35854 """ 35855 GetToolSeparation() -> int 35856 35857 Returns the default separator size. 35858 """ 35859 35860 def GetToolShortHelp(self, toolId): 35861 """ 35862 GetToolShortHelp(toolId) -> String 35863 35864 Returns the short help for the given tool. 35865 """ 35866 35867 def GetToolSize(self): 35868 """ 35869 GetToolSize() -> Size 35870 35871 Returns the size of a whole button, which is usually larger than a 35872 tool bitmap because of added 3D effects. 35873 """ 35874 35875 def GetToolState(self, toolId): 35876 """ 35877 GetToolState(toolId) -> bool 35878 35879 Gets the on/off state of a toggle tool. 35880 """ 35881 35882 def GetToolsCount(self): 35883 """ 35884 GetToolsCount() -> size_t 35885 35886 Returns the number of tools in the toolbar. 35887 """ 35888 35889 def InsertControl(self, pos, control, label=EmptyString): 35890 """ 35891 InsertControl(pos, control, label=EmptyString) -> ToolBarToolBase 35892 35893 Inserts the control into the toolbar at the given position. 35894 """ 35895 35896 def InsertSeparator(self, pos): 35897 """ 35898 InsertSeparator(pos) -> ToolBarToolBase 35899 35900 Inserts the separator into the toolbar at the given position. 35901 """ 35902 35903 def InsertStretchableSpace(self, pos): 35904 """ 35905 InsertStretchableSpace(pos) -> ToolBarToolBase 35906 35907 Inserts a stretchable space at the given position. 35908 """ 35909 35910 def Realize(self): 35911 """ 35912 Realize() -> bool 35913 35914 This function should be called after you have added tools. 35915 """ 35916 35917 def RemoveTool(self, id): 35918 """ 35919 RemoveTool(id) -> ToolBarToolBase 35920 35921 Removes the given tool from the toolbar but doesn't delete it. 35922 """ 35923 35924 def SetDropdownMenu(self, id, menu): 35925 """ 35926 SetDropdownMenu(id, menu) -> bool 35927 35928 Sets the dropdown menu for the tool given by its id. 35929 """ 35930 35931 def SetToolBitmapSize(self, size): 35932 """ 35933 SetToolBitmapSize(size) 35934 35935 Sets the default size of each tool bitmap. 35936 """ 35937 35938 def SetToolClientData(self, id, clientData): 35939 """ 35940 SetToolClientData(id, clientData) 35941 35942 Sets the client data associated with the tool. 35943 """ 35944 35945 def SetToolDisabledBitmap(self, id, bitmap): 35946 """ 35947 SetToolDisabledBitmap(id, bitmap) 35948 35949 Sets the bitmap to be used by the tool with the given ID when the tool 35950 is in a disabled state. 35951 """ 35952 35953 def SetToolLongHelp(self, toolId, helpString): 35954 """ 35955 SetToolLongHelp(toolId, helpString) 35956 35957 Sets the long help for the given tool. 35958 """ 35959 35960 def SetToolNormalBitmap(self, id, bitmap): 35961 """ 35962 SetToolNormalBitmap(id, bitmap) 35963 35964 Sets the bitmap to be used by the tool with the given ID. 35965 """ 35966 35967 def SetToolPacking(self, packing): 35968 """ 35969 SetToolPacking(packing) 35970 35971 Sets the value used for spacing tools. 35972 """ 35973 35974 def SetToolSeparation(self, separation): 35975 """ 35976 SetToolSeparation(separation) 35977 35978 Sets the default separator size. 35979 """ 35980 35981 def SetToolShortHelp(self, toolId, helpString): 35982 """ 35983 SetToolShortHelp(toolId, helpString) 35984 35985 Sets the short help for the given tool. 35986 """ 35987 35988 def ToggleTool(self, toolId, toggle): 35989 """ 35990 ToggleTool(toolId, toggle) 35991 35992 Toggles a tool on or off. 35993 """ 35994 35995 def CreateTool(self, *args, **kw): 35996 """ 35997 CreateTool(toolId, label, bmpNormal, bmpDisabled=NullBitmap, kind=ITEM_NORMAL, clientData=None, shortHelp=EmptyString, longHelp=EmptyString) -> ToolBarToolBase 35998 CreateTool(control, label) -> ToolBarToolBase 35999 36000 Factory function to create a new toolbar tool. 36001 """ 36002 36003 @staticmethod 36004 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 36005 """ 36006 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 36007 """ 36008 36009 def AddSimpleTool(self, toolId, bitmap, shortHelpString="", longHelpString="", isToggle=0): 36010 """ 36011 Old style method to add a tool to the toolbar. 36012 """ 36013 36014 def AddLabelTool(self, id, label, bitmap, bmpDisabled=wx.NullBitmap, kind=wx.ITEM_NORMAL, shortHelp="", longHelp="", clientData=None): 36015 """ 36016 Old style method to add a tool in the toolbar. 36017 """ 36018 36019 def InsertSimpleTool(self, pos, toolId, bitmap, shortHelpString="", longHelpString="", isToggle=0): 36020 """ 36021 Old style method to insert a tool in the toolbar. 36022 """ 36023 36024 def InsertLabelTool(self, pos, id, label, bitmap, bmpDisabled=wx.NullBitmap, kind=wx.ITEM_NORMAL, shortHelp="", longHelp="", clientData=None): 36025 """ 36026 Old style method to insert a tool in the toolbar. 36027 """ 36028 Margins = property(None, None) 36029 ToolBitmapSize = property(None, None) 36030 ToolPacking = property(None, None) 36031 ToolSeparation = property(None, None) 36032 ToolSize = property(None, None) 36033 ToolsCount = property(None, None) 36034# end of class ToolBar 36035 36036#-- end-toolbar --# 36037#-- begin-infobar --# 36038 36039class InfoBar(Control): 36040 """ 36041 InfoBar() 36042 InfoBar(parent, winid=ID_ANY) 36043 36044 An info bar is a transient window shown at top or bottom of its parent 36045 window to display non-critical information to the user. 36046 """ 36047 36048 def __init__(self, *args, **kw): 36049 """ 36050 InfoBar() 36051 InfoBar(parent, winid=ID_ANY) 36052 36053 An info bar is a transient window shown at top or bottom of its parent 36054 window to display non-critical information to the user. 36055 """ 36056 36057 def SetShowHideEffects(self, showEffect, hideEffect): 36058 """ 36059 SetShowHideEffects(showEffect, hideEffect) 36060 36061 Set the effects to use when showing and hiding the bar. 36062 """ 36063 36064 def GetShowEffect(self): 36065 """ 36066 GetShowEffect() -> ShowEffect 36067 36068 Return the effect currently used for showing the bar. 36069 """ 36070 36071 def GetHideEffect(self): 36072 """ 36073 GetHideEffect() -> ShowEffect 36074 36075 Return the effect currently used for hiding the bar. 36076 """ 36077 36078 def SetEffectDuration(self, duration): 36079 """ 36080 SetEffectDuration(duration) 36081 36082 Set the duration of the animation used when showing or hiding the bar. 36083 """ 36084 36085 def GetEffectDuration(self): 36086 """ 36087 GetEffectDuration() -> int 36088 36089 Return the effect animation duration currently used. 36090 """ 36091 36092 def SetFont(self, font): 36093 """ 36094 SetFont(font) -> bool 36095 36096 Overridden base class methods changes the font of the text message. 36097 """ 36098 36099 def Create(self, parent, winid=ID_ANY): 36100 """ 36101 Create(parent, winid=ID_ANY) -> bool 36102 36103 Create the info bar window. 36104 """ 36105 36106 def AddButton(self, btnid, label=""): 36107 """ 36108 AddButton(btnid, label="") 36109 36110 Add a button to be shown in the info bar. 36111 """ 36112 36113 def Dismiss(self): 36114 """ 36115 Dismiss() 36116 36117 Hide the info bar window. 36118 """ 36119 36120 def RemoveButton(self, btnid): 36121 """ 36122 RemoveButton(btnid) 36123 36124 Remove a button previously added by AddButton(). 36125 """ 36126 36127 def ShowMessage(self, msg, flags=ICON_INFORMATION): 36128 """ 36129 ShowMessage(msg, flags=ICON_INFORMATION) 36130 36131 Show a message in the bar. 36132 """ 36133 36134 @staticmethod 36135 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 36136 """ 36137 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 36138 """ 36139 EffectDuration = property(None, None) 36140 HideEffect = property(None, None) 36141 ShowEffect = property(None, None) 36142# end of class InfoBar 36143 36144#-- end-infobar --# 36145#-- begin-listctrl --# 36146LC_VRULES = 0 36147LC_HRULES = 0 36148LC_ICON = 0 36149LC_SMALL_ICON = 0 36150LC_LIST = 0 36151LC_REPORT = 0 36152LC_ALIGN_TOP = 0 36153LC_ALIGN_LEFT = 0 36154LC_AUTOARRANGE = 0 36155LC_VIRTUAL = 0 36156LC_EDIT_LABELS = 0 36157LC_NO_HEADER = 0 36158LC_NO_SORT_HEADER = 0 36159LC_SINGLE_SEL = 0 36160LC_SORT_ASCENDING = 0 36161LC_SORT_DESCENDING = 0 36162LC_MASK_TYPE = 0 36163LC_MASK_ALIGN = 0 36164LC_MASK_SORT = 0 36165LIST_MASK_STATE = 0 36166LIST_MASK_TEXT = 0 36167LIST_MASK_IMAGE = 0 36168LIST_MASK_DATA = 0 36169LIST_SET_ITEM = 0 36170LIST_MASK_WIDTH = 0 36171LIST_MASK_FORMAT = 0 36172LIST_STATE_DONTCARE = 0 36173LIST_STATE_DROPHILITED = 0 36174LIST_STATE_FOCUSED = 0 36175LIST_STATE_SELECTED = 0 36176LIST_STATE_CUT = 0 36177LIST_STATE_DISABLED = 0 36178LIST_STATE_FILTERED = 0 36179LIST_STATE_INUSE = 0 36180LIST_STATE_PICKED = 0 36181LIST_STATE_SOURCE = 0 36182LIST_HITTEST_ABOVE = 0 36183LIST_HITTEST_BELOW = 0 36184LIST_HITTEST_NOWHERE = 0 36185LIST_HITTEST_ONITEMICON = 0 36186LIST_HITTEST_ONITEMLABEL = 0 36187LIST_HITTEST_ONITEMRIGHT = 0 36188LIST_HITTEST_ONITEMSTATEICON = 0 36189LIST_HITTEST_TOLEFT = 0 36190LIST_HITTEST_TORIGHT = 0 36191LIST_HITTEST_ONITEM = 0 36192LIST_GETSUBITEMRECT_WHOLEITEM = 0 36193LIST_NEXT_ABOVE = 0 36194LIST_NEXT_ALL = 0 36195LIST_NEXT_BELOW = 0 36196LIST_NEXT_LEFT = 0 36197LIST_NEXT_RIGHT = 0 36198LIST_ALIGN_DEFAULT = 0 36199LIST_ALIGN_LEFT = 0 36200LIST_ALIGN_TOP = 0 36201LIST_ALIGN_SNAP_TO_GRID = 0 36202LIST_FORMAT_LEFT = 0 36203LIST_FORMAT_RIGHT = 0 36204LIST_FORMAT_CENTRE = 0 36205LIST_FORMAT_CENTER = 0 36206LIST_AUTOSIZE = 0 36207LIST_AUTOSIZE_USEHEADER = 0 36208LIST_RECT_BOUNDS = 0 36209LIST_RECT_ICON = 0 36210LIST_RECT_LABEL = 0 36211LIST_FIND_UP = 0 36212LIST_FIND_DOWN = 0 36213LIST_FIND_LEFT = 0 36214LIST_FIND_RIGHT = 0 36215wxEVT_LIST_BEGIN_DRAG = 0 36216wxEVT_LIST_BEGIN_RDRAG = 0 36217wxEVT_LIST_BEGIN_LABEL_EDIT = 0 36218wxEVT_LIST_END_LABEL_EDIT = 0 36219wxEVT_LIST_DELETE_ITEM = 0 36220wxEVT_LIST_DELETE_ALL_ITEMS = 0 36221wxEVT_LIST_ITEM_SELECTED = 0 36222wxEVT_LIST_ITEM_DESELECTED = 0 36223wxEVT_LIST_KEY_DOWN = 0 36224wxEVT_LIST_INSERT_ITEM = 0 36225wxEVT_LIST_COL_CLICK = 0 36226wxEVT_LIST_ITEM_RIGHT_CLICK = 0 36227wxEVT_LIST_ITEM_MIDDLE_CLICK = 0 36228wxEVT_LIST_ITEM_ACTIVATED = 0 36229wxEVT_LIST_CACHE_HINT = 0 36230wxEVT_LIST_COL_RIGHT_CLICK = 0 36231wxEVT_LIST_COL_BEGIN_DRAG = 0 36232wxEVT_LIST_COL_DRAGGING = 0 36233wxEVT_LIST_COL_END_DRAG = 0 36234wxEVT_LIST_ITEM_FOCUSED = 0 36235 36236class ListItemAttr(object): 36237 """ 36238 ListItemAttr() 36239 ListItemAttr(colText, colBack, font) 36240 36241 Represents the attributes (color, font, ...) of a wxListCtrl's 36242 wxListItem. 36243 """ 36244 36245 def __init__(self, *args, **kw): 36246 """ 36247 ListItemAttr() 36248 ListItemAttr(colText, colBack, font) 36249 36250 Represents the attributes (color, font, ...) of a wxListCtrl's 36251 wxListItem. 36252 """ 36253 36254 def GetBackgroundColour(self): 36255 """ 36256 GetBackgroundColour() -> Colour 36257 36258 Returns the currently set background color. 36259 """ 36260 36261 def GetFont(self): 36262 """ 36263 GetFont() -> Font 36264 36265 Returns the currently set font. 36266 """ 36267 36268 def GetTextColour(self): 36269 """ 36270 GetTextColour() -> Colour 36271 36272 Returns the currently set text color. 36273 """ 36274 36275 def HasBackgroundColour(self): 36276 """ 36277 HasBackgroundColour() -> bool 36278 36279 Returns true if the currently set background color is valid. 36280 """ 36281 36282 def HasFont(self): 36283 """ 36284 HasFont() -> bool 36285 36286 Returns true if the currently set font is valid. 36287 """ 36288 36289 def HasTextColour(self): 36290 """ 36291 HasTextColour() -> bool 36292 36293 Returns true if the currently set text color is valid. 36294 """ 36295 36296 def SetBackgroundColour(self, colour): 36297 """ 36298 SetBackgroundColour(colour) 36299 36300 Sets a new background color. 36301 """ 36302 36303 def SetFont(self, font): 36304 """ 36305 SetFont(font) 36306 36307 Sets a new font. 36308 """ 36309 36310 def SetTextColour(self, colour): 36311 """ 36312 SetTextColour(colour) 36313 36314 Sets a new text color. 36315 """ 36316 BackgroundColour = property(None, None) 36317 Font = property(None, None) 36318 TextColour = property(None, None) 36319# end of class ListItemAttr 36320 36321 36322class ListItem(Object): 36323 """ 36324 ListItem() 36325 36326 This class stores information about a wxListCtrl item or column. 36327 """ 36328 36329 def __init__(self): 36330 """ 36331 ListItem() 36332 36333 This class stores information about a wxListCtrl item or column. 36334 """ 36335 36336 def SetData(self, data): 36337 """ 36338 SetData(data) 36339 36340 Sets client data for the item. 36341 """ 36342 36343 def Clear(self): 36344 """ 36345 Clear() 36346 36347 Resets the item state to the default. 36348 """ 36349 36350 def GetAlign(self): 36351 """ 36352 GetAlign() -> ListColumnFormat 36353 36354 Returns the alignment for this item. 36355 """ 36356 36357 def GetBackgroundColour(self): 36358 """ 36359 GetBackgroundColour() -> Colour 36360 36361 Returns the background colour for this item. 36362 """ 36363 36364 def GetColumn(self): 36365 """ 36366 GetColumn() -> int 36367 36368 Returns the zero-based column; meaningful only in report mode. 36369 """ 36370 36371 def GetData(self): 36372 """ 36373 GetData() -> long 36374 36375 Returns client data associated with the control. 36376 """ 36377 36378 def GetFont(self): 36379 """ 36380 GetFont() -> Font 36381 36382 Returns the font used to display the item. 36383 """ 36384 36385 def GetId(self): 36386 """ 36387 GetId() -> long 36388 36389 Returns the zero-based item position. 36390 """ 36391 36392 def GetImage(self): 36393 """ 36394 GetImage() -> int 36395 36396 Returns the zero-based index of the image associated with the item 36397 into the image list. 36398 """ 36399 36400 def GetMask(self): 36401 """ 36402 GetMask() -> long 36403 36404 Returns a bit mask indicating which fields of the structure are valid. 36405 """ 36406 36407 def GetState(self): 36408 """ 36409 GetState() -> long 36410 36411 Returns a bit field representing the state of the item. 36412 """ 36413 36414 def GetText(self): 36415 """ 36416 GetText() -> String 36417 36418 Returns the label/header text. 36419 """ 36420 36421 def GetTextColour(self): 36422 """ 36423 GetTextColour() -> Colour 36424 36425 Returns the text colour. 36426 """ 36427 36428 def GetWidth(self): 36429 """ 36430 GetWidth() -> int 36431 36432 Meaningful only for column headers in report mode. 36433 """ 36434 36435 def SetAlign(self, align): 36436 """ 36437 SetAlign(align) 36438 36439 Sets the alignment for the item. 36440 """ 36441 36442 def SetBackgroundColour(self, colBack): 36443 """ 36444 SetBackgroundColour(colBack) 36445 36446 Sets the background colour for the item. 36447 """ 36448 36449 def SetColumn(self, col): 36450 """ 36451 SetColumn(col) 36452 36453 Sets the zero-based column. 36454 """ 36455 36456 def SetFont(self, font): 36457 """ 36458 SetFont(font) 36459 36460 Sets the font for the item. 36461 """ 36462 36463 def SetId(self, id): 36464 """ 36465 SetId(id) 36466 36467 Sets the zero-based item position. 36468 """ 36469 36470 def SetImage(self, image): 36471 """ 36472 SetImage(image) 36473 36474 Sets the zero-based index of the image associated with the item into 36475 the image list. 36476 """ 36477 36478 def SetMask(self, mask): 36479 """ 36480 SetMask(mask) 36481 36482 Sets the mask of valid fields. 36483 """ 36484 36485 def SetState(self, state): 36486 """ 36487 SetState(state) 36488 36489 Sets the item state flags (note that the valid state flags are 36490 influenced by the value of the state mask, see 36491 wxListItem::SetStateMask). 36492 """ 36493 36494 def SetStateMask(self, stateMask): 36495 """ 36496 SetStateMask(stateMask) 36497 36498 Sets the bitmask that is used to determine which of the state flags 36499 are to be set. 36500 """ 36501 36502 def SetText(self, text): 36503 """ 36504 SetText(text) 36505 36506 Sets the text label for the item. 36507 """ 36508 36509 def SetTextColour(self, colText): 36510 """ 36511 SetTextColour(colText) 36512 36513 Sets the text colour for the item. 36514 """ 36515 36516 def SetWidth(self, width): 36517 """ 36518 SetWidth(width) 36519 36520 Meaningful only for column headers in report mode. 36521 """ 36522 Align = property(None, None) 36523 BackgroundColour = property(None, None) 36524 Column = property(None, None) 36525 Data = property(None, None) 36526 Font = property(None, None) 36527 Id = property(None, None) 36528 Image = property(None, None) 36529 Mask = property(None, None) 36530 State = property(None, None) 36531 Text = property(None, None) 36532 TextColour = property(None, None) 36533 Width = property(None, None) 36534# end of class ListItem 36535 36536ListCtrlNameStr = "" 36537 36538class ListCtrl(Control): 36539 """ 36540 ListCtrl() 36541 ListCtrl(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=LC_ICON, validator=DefaultValidator, name=ListCtrlNameStr) 36542 36543 A list control presents lists in a number of formats: list view, 36544 report view, icon view and small icon view. 36545 """ 36546 36547 def __init__(self, *args, **kw): 36548 """ 36549 ListCtrl() 36550 ListCtrl(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=LC_ICON, validator=DefaultValidator, name=ListCtrlNameStr) 36551 36552 A list control presents lists in a number of formats: list view, 36553 report view, icon view and small icon view. 36554 """ 36555 36556 def AppendColumn(self, heading, format=LIST_FORMAT_LEFT, width=-1): 36557 """ 36558 AppendColumn(heading, format=LIST_FORMAT_LEFT, width=-1) -> long 36559 36560 Adds a new column to the list control in report view mode. 36561 """ 36562 36563 def Arrange(self, flag=LIST_ALIGN_DEFAULT): 36564 """ 36565 Arrange(flag=LIST_ALIGN_DEFAULT) -> bool 36566 36567 Arranges the items in icon or small icon view. 36568 """ 36569 36570 def AssignImageList(self, imageList, which): 36571 """ 36572 AssignImageList(imageList, which) 36573 36574 Sets the image list associated with the control and takes ownership of 36575 it (i.e. 36576 """ 36577 36578 def ClearAll(self): 36579 """ 36580 ClearAll() 36581 36582 Deletes all items and all columns. 36583 """ 36584 36585 def Create(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=LC_ICON, validator=DefaultValidator, name=ListCtrlNameStr): 36586 """ 36587 Create(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=LC_ICON, validator=DefaultValidator, name=ListCtrlNameStr) -> bool 36588 36589 Creates the list control. 36590 """ 36591 36592 def DeleteAllColumns(self): 36593 """ 36594 DeleteAllColumns() -> bool 36595 36596 Delete all columns in the list control. 36597 """ 36598 36599 def DeleteAllItems(self): 36600 """ 36601 DeleteAllItems() -> bool 36602 36603 Deletes all items in the list control. 36604 """ 36605 36606 def DeleteColumn(self, col): 36607 """ 36608 DeleteColumn(col) -> bool 36609 36610 Deletes a column. 36611 """ 36612 36613 def DeleteItem(self, item): 36614 """ 36615 DeleteItem(item) -> bool 36616 36617 Deletes the specified item. 36618 """ 36619 36620 def EditLabel(self, item): 36621 """ 36622 EditLabel(item) -> TextCtrl 36623 36624 Starts editing the label of the given item. 36625 """ 36626 36627 def EnableAlternateRowColours(self, enable=True): 36628 """ 36629 EnableAlternateRowColours(enable=True) 36630 36631 Enable alternating row background colours (also called zebra 36632 striping). 36633 """ 36634 36635 def EnableBellOnNoMatch(self, on=True): 36636 """ 36637 EnableBellOnNoMatch(on=True) 36638 36639 Enable or disable a beep if there is no match for the currently 36640 entered text when searching for the item from keyboard. 36641 """ 36642 36643 def EnsureVisible(self, item): 36644 """ 36645 EnsureVisible(item) -> bool 36646 36647 Ensures this item is visible. 36648 """ 36649 36650 def FindItem(self, *args, **kw): 36651 """ 36652 FindItem(start, str, partial=False) -> long 36653 FindItem(start, data) -> long 36654 FindItem(start, pt, direction) -> long 36655 36656 Find an item whose label matches this string, starting from start or 36657 the beginning if start is -1. 36658 """ 36659 36660 def GetColumn(self, col): 36661 """ 36662 GetColumn(col) -> ListItem 36663 36664 Gets information about this column. See SetItem() for more 36665 information. 36666 """ 36667 36668 def GetColumnCount(self): 36669 """ 36670 GetColumnCount() -> int 36671 36672 Returns the number of columns. 36673 """ 36674 36675 def GetColumnIndexFromOrder(self, pos): 36676 """ 36677 GetColumnIndexFromOrder(pos) -> int 36678 36679 Gets the column index from its position in visual order. 36680 """ 36681 36682 def GetColumnOrder(self, col): 36683 """ 36684 GetColumnOrder(col) -> int 36685 36686 Gets the column visual order position. 36687 """ 36688 36689 def GetColumnWidth(self, col): 36690 """ 36691 GetColumnWidth(col) -> int 36692 36693 Gets the column width (report view only). 36694 """ 36695 36696 def GetColumnsOrder(self): 36697 """ 36698 GetColumnsOrder() -> ArrayInt 36699 36700 Returns the array containing the orders of all columns. 36701 """ 36702 36703 def GetCountPerPage(self): 36704 """ 36705 GetCountPerPage() -> int 36706 36707 Gets the number of items that can fit vertically in the visible area 36708 of the list control (list or report view) or the total number of items 36709 in the list control (icon or small icon view). 36710 """ 36711 36712 def GetEditControl(self): 36713 """ 36714 GetEditControl() -> TextCtrl 36715 36716 Returns the edit control being currently used to edit a label. 36717 """ 36718 36719 def GetImageList(self, which): 36720 """ 36721 GetImageList(which) -> ImageList 36722 36723 Returns the specified image list. 36724 """ 36725 36726 def GetItem(self, itemIdx, col=0): 36727 """ 36728 GetItem(itemIdx, col=0) -> ListItem 36729 36730 Gets information about the item. See SetItem() for more information. 36731 """ 36732 36733 def GetItemBackgroundColour(self, item): 36734 """ 36735 GetItemBackgroundColour(item) -> Colour 36736 36737 Returns the colour for this item. 36738 """ 36739 36740 def GetItemCount(self): 36741 """ 36742 GetItemCount() -> int 36743 36744 Returns the number of items in the list control. 36745 """ 36746 36747 def GetItemData(self, item): 36748 """ 36749 GetItemData(item) -> long 36750 36751 Gets the application-defined data associated with this item. 36752 """ 36753 36754 def GetItemFont(self, item): 36755 """ 36756 GetItemFont(item) -> Font 36757 36758 Returns the item's font. 36759 """ 36760 36761 def GetItemPosition(self, item): 36762 """ 36763 GetItemPosition(item) -> Point 36764 36765 Returns the position of the item, in icon or small icon view. 36766 """ 36767 36768 def GetItemRect(self, item, code=LIST_RECT_BOUNDS): 36769 """ 36770 GetItemRect(item, code=LIST_RECT_BOUNDS) -> Rect 36771 36772 Returns the rectangle representing the item's size and position, in 36773 physical coordinates. 36774 code is one of wx.LIST_RECT_BOUNDS, wx.LIST_RECT_ICON, 36775 wx.LIST_RECT_LABEL. 36776 """ 36777 36778 def GetItemSpacing(self): 36779 """ 36780 GetItemSpacing() -> Size 36781 36782 Retrieves the spacing between icons in pixels: horizontal spacing is 36783 returned as x component of the wxSize object and the vertical spacing 36784 as its y component. 36785 """ 36786 36787 def GetItemState(self, item, stateMask): 36788 """ 36789 GetItemState(item, stateMask) -> int 36790 36791 Gets the item state. 36792 """ 36793 36794 def GetItemText(self, item, col=0): 36795 """ 36796 GetItemText(item, col=0) -> String 36797 36798 Gets the item text for this item. 36799 """ 36800 36801 def GetItemTextColour(self, item): 36802 """ 36803 GetItemTextColour(item) -> Colour 36804 36805 Returns the colour for this item. 36806 """ 36807 36808 def GetNextItem(self, item, geometry=LIST_NEXT_ALL, state=LIST_STATE_DONTCARE): 36809 """ 36810 GetNextItem(item, geometry=LIST_NEXT_ALL, state=LIST_STATE_DONTCARE) -> long 36811 36812 Searches for an item with the given geometry or state, starting from 36813 item but excluding the item itself. 36814 """ 36815 36816 def GetSelectedItemCount(self): 36817 """ 36818 GetSelectedItemCount() -> int 36819 36820 Returns the number of selected items in the list control. 36821 """ 36822 36823 def GetSubItemRect(self, item, subItem, rect, code=LIST_RECT_BOUNDS): 36824 """ 36825 GetSubItemRect(item, subItem, rect, code=LIST_RECT_BOUNDS) -> bool 36826 36827 Returns the rectangle representing the size and position, in physical 36828 coordinates, of the given subitem, i.e. 36829 """ 36830 36831 def GetTextColour(self): 36832 """ 36833 GetTextColour() -> Colour 36834 36835 Gets the text colour of the list control. 36836 """ 36837 36838 def GetTopItem(self): 36839 """ 36840 GetTopItem() -> long 36841 36842 Gets the index of the topmost visible item when in list or report 36843 view. 36844 """ 36845 36846 def GetViewRect(self): 36847 """ 36848 GetViewRect() -> Rect 36849 36850 Returns the rectangle taken by all items in the control. 36851 """ 36852 36853 def SetAlternateRowColour(self, colour): 36854 """ 36855 SetAlternateRowColour(colour) 36856 36857 Set the alternative row background colour to a specific colour. 36858 """ 36859 36860 def HitTest(self, point): 36861 """ 36862 HitTest(point) -> (long, flags) 36863 36864 Determines which item (if any) is at the specified point, giving 36865 details in flags. 36866 """ 36867 36868 def InReportView(self): 36869 """ 36870 InReportView() -> bool 36871 36872 Returns true if the control is currently using wxLC_REPORT style. 36873 """ 36874 36875 def InsertColumn(self, *args, **kw): 36876 """ 36877 InsertColumn(col, info) -> long 36878 InsertColumn(col, heading, format=LIST_FORMAT_LEFT, width=LIST_AUTOSIZE) -> long 36879 36880 For report view mode (only), inserts a column. 36881 """ 36882 36883 def InsertItem(self, *args, **kw): 36884 """ 36885 InsertItem(info) -> long 36886 InsertItem(index, label) -> long 36887 InsertItem(index, imageIndex) -> long 36888 InsertItem(index, label, imageIndex) -> long 36889 36890 Inserts an item, returning the index of the new item if successful, -1 36891 otherwise. 36892 """ 36893 36894 def IsVirtual(self): 36895 """ 36896 IsVirtual() -> bool 36897 36898 Returns true if the control is currently in virtual report view. 36899 """ 36900 36901 def RefreshItem(self, item): 36902 """ 36903 RefreshItem(item) 36904 36905 Redraws the given item. 36906 """ 36907 36908 def RefreshItems(self, itemFrom, itemTo): 36909 """ 36910 RefreshItems(itemFrom, itemTo) 36911 36912 Redraws the items between itemFrom and itemTo. 36913 """ 36914 36915 def ScrollList(self, dx, dy): 36916 """ 36917 ScrollList(dx, dy) -> bool 36918 36919 Scrolls the list control. 36920 """ 36921 36922 def SetBackgroundColour(self, col): 36923 """ 36924 SetBackgroundColour(col) -> bool 36925 36926 Sets the background colour. 36927 """ 36928 36929 def SetColumn(self, col, item): 36930 """ 36931 SetColumn(col, item) -> bool 36932 36933 Sets information about this column. 36934 """ 36935 36936 def SetColumnWidth(self, col, width): 36937 """ 36938 SetColumnWidth(col, width) -> bool 36939 36940 Sets the column width. 36941 """ 36942 36943 def SetColumnsOrder(self, orders): 36944 """ 36945 SetColumnsOrder(orders) -> bool 36946 36947 Changes the order in which the columns are shown. 36948 """ 36949 36950 def SetImageList(self, imageList, which): 36951 """ 36952 SetImageList(imageList, which) 36953 36954 Sets the image list associated with the control. 36955 """ 36956 36957 def SetItem(self, *args, **kw): 36958 """ 36959 SetItem(info) -> bool 36960 SetItem(index, column, label, imageId=-1) -> long 36961 36962 Sets the data of an item. 36963 """ 36964 36965 def SetItemBackgroundColour(self, item, col): 36966 """ 36967 SetItemBackgroundColour(item, col) 36968 36969 Sets the background colour for this item. 36970 """ 36971 36972 def SetItemColumnImage(self, item, column, image): 36973 """ 36974 SetItemColumnImage(item, column, image) -> bool 36975 36976 Sets the image associated with the item. 36977 """ 36978 36979 def SetItemCount(self, count): 36980 """ 36981 SetItemCount(count) 36982 36983 This method can only be used with virtual list controls. 36984 """ 36985 36986 def SetItemData(self, item, data): 36987 """ 36988 SetItemData(item, data) -> bool 36989 36990 Associates application-defined data with this item. 36991 """ 36992 36993 def SetItemFont(self, item, font): 36994 """ 36995 SetItemFont(item, font) 36996 36997 Sets the item's font. 36998 """ 36999 37000 def SetItemImage(self, item, image, selImage=-1): 37001 """ 37002 SetItemImage(item, image, selImage=-1) -> bool 37003 37004 Sets the unselected and selected images associated with the item. 37005 """ 37006 37007 def SetItemPosition(self, item, pos): 37008 """ 37009 SetItemPosition(item, pos) -> bool 37010 37011 Sets the position of the item, in icon or small icon view. 37012 """ 37013 37014 def SetItemState(self, item, state, stateMask): 37015 """ 37016 SetItemState(item, state, stateMask) -> bool 37017 37018 Sets the item state. 37019 """ 37020 37021 def SetItemText(self, item, text): 37022 """ 37023 SetItemText(item, text) 37024 37025 Sets the item text for this item. 37026 """ 37027 37028 def SetItemTextColour(self, item, col): 37029 """ 37030 SetItemTextColour(item, col) 37031 37032 Sets the colour for this item. 37033 """ 37034 37035 def SetSingleStyle(self, style, add=True): 37036 """ 37037 SetSingleStyle(style, add=True) 37038 37039 Adds or removes a single window style. 37040 """ 37041 37042 def SetTextColour(self, col): 37043 """ 37044 SetTextColour(col) 37045 37046 Sets the text colour of the list control. 37047 """ 37048 37049 def SetWindowStyleFlag(self, style): 37050 """ 37051 SetWindowStyleFlag(style) 37052 37053 Sets the whole window style, deleting all items. 37054 """ 37055 37056 def SortItems(self, fnSortCallBack): 37057 """ 37058 SortItems(fnSortCallBack) -> bool 37059 37060 Call this function to sort the items in the list control. 37061 """ 37062 37063 @staticmethod 37064 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 37065 """ 37066 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 37067 """ 37068 37069 def HitTestSubItem(self, point): 37070 """ 37071 HitTestSubItemHitTestSubItem(point) -> (item, flags, subitem) 37072 37073 Determines which item (if any) is at the specified point, giving 37074 details in flags. 37075 """ 37076 37077 FindItemData = wx.deprecated(FindItem, "Use FindItem instead.") 37078 37079 FindItemAtPos = wx.deprecated(FindItem, "Use FindItem instead.") 37080 37081 InsertStringItem = wx.deprecated(InsertItem, "Use InsertItem instead.") 37082 37083 InsertImageItem = wx.deprecated(InsertItem, "Use InsertItem instead.") 37084 37085 InsertImageStringItem = wx.deprecated(InsertItem, "Use InsertItem instead.") 37086 37087 SetStringItem = wx.deprecated(SetItem, "Use SetItem instead.") 37088 37089 def HasColumnOrderSupport(self): 37090 """ 37091 HasColumnOrderSupport() -> bool 37092 """ 37093 37094 def Select(self, idx, on=1): 37095 """ 37096 Selects/deselects an item. 37097 """ 37098 37099 def Focus(self, idx): 37100 """ 37101 Focus and show the given item. 37102 """ 37103 37104 def GetFocusedItem(self): 37105 """ 37106 Gets the currently focused item or -1 if none is focused. 37107 """ 37108 37109 def GetFirstSelected(self, *args): 37110 """ 37111 Returns the first selected item, or -1 when none is selected. 37112 """ 37113 37114 def GetNextSelected(self, item): 37115 """ 37116 Returns subsequent selected items, or -1 when no more are selected. 37117 """ 37118 37119 def IsSelected(self, idx): 37120 """ 37121 Returns ``True`` if the item is selected. 37122 """ 37123 37124 def SetColumnImage(self, col, image): 37125 """ 37126 37127 """ 37128 37129 def ClearColumnImage(self, col): 37130 """ 37131 37132 """ 37133 37134 def Append(self, entry): 37135 """ 37136 Append an item to the list control. The `entry` parameter should be a 37137 sequence with an item for each column 37138 """ 37139 37140 def GetMainWindow(self): 37141 """ 37142 GetMainWindow() -> Window 37143 """ 37144 Column = property(None, None) 37145 ColumnCount = property(None, None) 37146 ColumnsOrder = property(None, None) 37147 CountPerPage = property(None, None) 37148 EditControl = property(None, None) 37149 FocusedItem = property(None, None) 37150 Item = property(None, None) 37151 ItemCount = property(None, None) 37152 ItemPosition = property(None, None) 37153 ItemRect = property(None, None) 37154 ItemSpacing = property(None, None) 37155 MainWindow = property(None, None) 37156 SelectedItemCount = property(None, None) 37157 TextColour = property(None, None) 37158 TopItem = property(None, None) 37159 ViewRect = property(None, None) 37160 37161 def OnGetItemAttr(self, item): 37162 """ 37163 OnGetItemAttr(item) -> ListItemAttr 37164 37165 This function may be overridden in the derived class for a control 37166 with wxLC_VIRTUAL style. 37167 """ 37168 37169 def OnGetItemColumnImage(self, item, column): 37170 """ 37171 OnGetItemColumnImage(item, column) -> int 37172 37173 Override this function in the derived class for a control with 37174 wxLC_VIRTUAL and wxLC_REPORT styles in order to specify the image 37175 index for the given line and column. 37176 """ 37177 37178 def OnGetItemImage(self, item): 37179 """ 37180 OnGetItemImage(item) -> int 37181 37182 This function must be overridden in the derived class for a control 37183 with wxLC_VIRTUAL style having an "image list" (see SetImageList(); if 37184 the control doesn't have an image list, it is not necessary to 37185 override it). 37186 """ 37187 37188 def OnGetItemText(self, item, column): 37189 """ 37190 OnGetItemText(item, column) -> String 37191 37192 This function must be overridden in the derived class for a control 37193 with wxLC_VIRTUAL style. 37194 """ 37195# end of class ListCtrl 37196 37197 37198class ListView(ListCtrl): 37199 """ 37200 ListView() 37201 ListView(parent, winid=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=LC_REPORT, validator=DefaultValidator, name=ListCtrlNameStr) 37202 37203 This class currently simply presents a simpler to use interface for 37204 the wxListCtrl it can be thought of as a façade for that complicated 37205 class. 37206 """ 37207 37208 def __init__(self, *args, **kw): 37209 """ 37210 ListView() 37211 ListView(parent, winid=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=LC_REPORT, validator=DefaultValidator, name=ListCtrlNameStr) 37212 37213 This class currently simply presents a simpler to use interface for 37214 the wxListCtrl it can be thought of as a façade for that complicated 37215 class. 37216 """ 37217 37218 def ClearColumnImage(self, col): 37219 """ 37220 ClearColumnImage(col) 37221 37222 Resets the column image after calling this function, no image will be 37223 shown. 37224 """ 37225 37226 def Focus(self, index): 37227 """ 37228 Focus(index) 37229 37230 Sets focus to the item with the given index. 37231 """ 37232 37233 def GetFirstSelected(self): 37234 """ 37235 GetFirstSelected() -> long 37236 37237 Returns the first selected item in a (presumably) multiple selection 37238 control. 37239 """ 37240 37241 def GetFocusedItem(self): 37242 """ 37243 GetFocusedItem() -> long 37244 37245 Returns the currently focused item or -1 if none. 37246 """ 37247 37248 def GetNextSelected(self, item): 37249 """ 37250 GetNextSelected(item) -> long 37251 37252 Used together with GetFirstSelected() to iterate over all selected 37253 items in the control. 37254 """ 37255 37256 def IsSelected(self, index): 37257 """ 37258 IsSelected(index) -> bool 37259 37260 Returns true if the item with the given index is selected, false 37261 otherwise. 37262 """ 37263 37264 def Select(self, n, on=True): 37265 """ 37266 Select(n, on=True) 37267 37268 Selects or unselects the given item. 37269 """ 37270 37271 def SetColumnImage(self, col, image): 37272 """ 37273 SetColumnImage(col, image) 37274 37275 Sets the column image for the specified column. 37276 """ 37277 37278 @staticmethod 37279 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 37280 """ 37281 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 37282 """ 37283 FirstSelected = property(None, None) 37284 FocusedItem = property(None, None) 37285# end of class ListView 37286 37287 37288class ListEvent(NotifyEvent): 37289 """ 37290 ListEvent(commandType=wxEVT_NULL, id=0) 37291 37292 A list event holds information about events associated with wxListCtrl 37293 objects. 37294 """ 37295 37296 def __init__(self, commandType=wxEVT_NULL, id=0): 37297 """ 37298 ListEvent(commandType=wxEVT_NULL, id=0) 37299 37300 A list event holds information about events associated with wxListCtrl 37301 objects. 37302 """ 37303 37304 def GetCacheFrom(self): 37305 """ 37306 GetCacheFrom() -> long 37307 37308 For EVT_LIST_CACHE_HINT event only: return the first item which the 37309 list control advises us to cache. 37310 """ 37311 37312 def GetCacheTo(self): 37313 """ 37314 GetCacheTo() -> long 37315 37316 For EVT_LIST_CACHE_HINT event only: return the last item (inclusive) 37317 which the list control advises us to cache. 37318 """ 37319 37320 def GetColumn(self): 37321 """ 37322 GetColumn() -> int 37323 37324 The column position: it is only used with COL events. 37325 """ 37326 37327 def GetData(self): 37328 """ 37329 GetData() -> UIntPtr 37330 37331 The data. 37332 """ 37333 37334 def GetImage(self): 37335 """ 37336 GetImage() -> int 37337 37338 The image. 37339 """ 37340 37341 def GetIndex(self): 37342 """ 37343 GetIndex() -> long 37344 37345 The item index. 37346 """ 37347 37348 def GetItem(self): 37349 """ 37350 GetItem() -> ListItem 37351 37352 An item object, used by some events. 37353 """ 37354 37355 def GetKeyCode(self): 37356 """ 37357 GetKeyCode() -> int 37358 37359 Key code if the event is a keypress event. 37360 """ 37361 37362 def GetLabel(self): 37363 """ 37364 GetLabel() -> String 37365 37366 The (new) item label for EVT_LIST_END_LABEL_EDIT event. 37367 """ 37368 37369 def GetMask(self): 37370 """ 37371 GetMask() -> long 37372 37373 The mask. 37374 """ 37375 37376 def GetPoint(self): 37377 """ 37378 GetPoint() -> Point 37379 37380 The position of the mouse pointer if the event is a drag event. 37381 """ 37382 37383 def GetText(self): 37384 """ 37385 GetText() -> String 37386 37387 The text. 37388 """ 37389 37390 def IsEditCancelled(self): 37391 """ 37392 IsEditCancelled() -> bool 37393 37394 This method only makes sense for EVT_LIST_END_LABEL_EDIT message and 37395 returns true if it the label editing has been cancelled by the user 37396 (GetLabel() returns an empty string in this case but it doesn't allow 37397 the application to distinguish between really cancelling the edit and 37398 the admittedly rare case when the user wants to rename it to an empty 37399 string). 37400 """ 37401 37402 def SetKeyCode(self, code): 37403 """ 37404 SetKeyCode(code) 37405 """ 37406 37407 def SetIndex(self, index): 37408 """ 37409 SetIndex(index) 37410 """ 37411 37412 def SetColumn(self, col): 37413 """ 37414 SetColumn(col) 37415 """ 37416 37417 def SetPoint(self, point): 37418 """ 37419 SetPoint(point) 37420 """ 37421 37422 def SetItem(self, item): 37423 """ 37424 SetItem(item) 37425 """ 37426 37427 def SetCacheFrom(self, cacheFrom): 37428 """ 37429 SetCacheFrom(cacheFrom) 37430 """ 37431 37432 def SetCacheTo(self, cacheTo): 37433 """ 37434 SetCacheTo(cacheTo) 37435 """ 37436 CacheFrom = property(None, None) 37437 CacheTo = property(None, None) 37438 Column = property(None, None) 37439 Data = property(None, None) 37440 Image = property(None, None) 37441 Index = property(None, None) 37442 Item = property(None, None) 37443 KeyCode = property(None, None) 37444 Label = property(None, None) 37445 Mask = property(None, None) 37446 Point = property(None, None) 37447 Text = property(None, None) 37448# end of class ListEvent 37449 37450 37451EVT_LIST_BEGIN_DRAG = PyEventBinder(wxEVT_LIST_BEGIN_DRAG , 1) 37452EVT_LIST_BEGIN_RDRAG = PyEventBinder(wxEVT_LIST_BEGIN_RDRAG , 1) 37453EVT_LIST_BEGIN_LABEL_EDIT = PyEventBinder(wxEVT_LIST_BEGIN_LABEL_EDIT , 1) 37454EVT_LIST_END_LABEL_EDIT = PyEventBinder(wxEVT_LIST_END_LABEL_EDIT , 1) 37455EVT_LIST_DELETE_ITEM = PyEventBinder(wxEVT_LIST_DELETE_ITEM , 1) 37456EVT_LIST_DELETE_ALL_ITEMS = PyEventBinder(wxEVT_LIST_DELETE_ALL_ITEMS , 1) 37457EVT_LIST_ITEM_SELECTED = PyEventBinder(wxEVT_LIST_ITEM_SELECTED , 1) 37458EVT_LIST_ITEM_DESELECTED = PyEventBinder(wxEVT_LIST_ITEM_DESELECTED , 1) 37459EVT_LIST_KEY_DOWN = PyEventBinder(wxEVT_LIST_KEY_DOWN , 1) 37460EVT_LIST_INSERT_ITEM = PyEventBinder(wxEVT_LIST_INSERT_ITEM , 1) 37461EVT_LIST_COL_CLICK = PyEventBinder(wxEVT_LIST_COL_CLICK , 1) 37462EVT_LIST_ITEM_RIGHT_CLICK = PyEventBinder(wxEVT_LIST_ITEM_RIGHT_CLICK , 1) 37463EVT_LIST_ITEM_MIDDLE_CLICK = PyEventBinder(wxEVT_LIST_ITEM_MIDDLE_CLICK, 1) 37464EVT_LIST_ITEM_ACTIVATED = PyEventBinder(wxEVT_LIST_ITEM_ACTIVATED , 1) 37465EVT_LIST_CACHE_HINT = PyEventBinder(wxEVT_LIST_CACHE_HINT , 1) 37466EVT_LIST_COL_RIGHT_CLICK = PyEventBinder(wxEVT_LIST_COL_RIGHT_CLICK , 1) 37467EVT_LIST_COL_BEGIN_DRAG = PyEventBinder(wxEVT_LIST_COL_BEGIN_DRAG , 1) 37468EVT_LIST_COL_DRAGGING = PyEventBinder(wxEVT_LIST_COL_DRAGGING , 1) 37469EVT_LIST_COL_END_DRAG = PyEventBinder(wxEVT_LIST_COL_END_DRAG , 1) 37470EVT_LIST_ITEM_FOCUSED = PyEventBinder(wxEVT_LIST_ITEM_FOCUSED , 1) 37471 37472# deprecated wxEVT aliases 37473wxEVT_COMMAND_LIST_BEGIN_DRAG = wxEVT_LIST_BEGIN_DRAG 37474wxEVT_COMMAND_LIST_BEGIN_RDRAG = wxEVT_LIST_BEGIN_RDRAG 37475wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT = wxEVT_LIST_BEGIN_LABEL_EDIT 37476wxEVT_COMMAND_LIST_END_LABEL_EDIT = wxEVT_LIST_END_LABEL_EDIT 37477wxEVT_COMMAND_LIST_DELETE_ITEM = wxEVT_LIST_DELETE_ITEM 37478wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS = wxEVT_LIST_DELETE_ALL_ITEMS 37479wxEVT_COMMAND_LIST_ITEM_SELECTED = wxEVT_LIST_ITEM_SELECTED 37480wxEVT_COMMAND_LIST_ITEM_DESELECTED = wxEVT_LIST_ITEM_DESELECTED 37481wxEVT_COMMAND_LIST_KEY_DOWN = wxEVT_LIST_KEY_DOWN 37482wxEVT_COMMAND_LIST_INSERT_ITEM = wxEVT_LIST_INSERT_ITEM 37483wxEVT_COMMAND_LIST_COL_CLICK = wxEVT_LIST_COL_CLICK 37484wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK = wxEVT_LIST_ITEM_RIGHT_CLICK 37485wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK = wxEVT_LIST_ITEM_MIDDLE_CLICK 37486wxEVT_COMMAND_LIST_ITEM_ACTIVATED = wxEVT_LIST_ITEM_ACTIVATED 37487wxEVT_COMMAND_LIST_CACHE_HINT = wxEVT_LIST_CACHE_HINT 37488wxEVT_COMMAND_LIST_COL_RIGHT_CLICK = wxEVT_LIST_COL_RIGHT_CLICK 37489wxEVT_COMMAND_LIST_COL_BEGIN_DRAG = wxEVT_LIST_COL_BEGIN_DRAG 37490wxEVT_COMMAND_LIST_COL_DRAGGING = wxEVT_LIST_COL_DRAGGING 37491wxEVT_COMMAND_LIST_COL_END_DRAG = wxEVT_LIST_COL_END_DRAG 37492wxEVT_COMMAND_LIST_ITEM_FOCUSED = wxEVT_LIST_ITEM_FOCUSED 37493#-- end-listctrl --# 37494#-- begin-treectrl --# 37495TR_NO_BUTTONS = 0 37496TR_HAS_BUTTONS = 0 37497TR_NO_LINES = 0 37498TR_LINES_AT_ROOT = 0 37499TR_TWIST_BUTTONS = 0 37500TR_SINGLE = 0 37501TR_MULTIPLE = 0 37502TR_HAS_VARIABLE_ROW_HEIGHT = 0 37503TR_EDIT_LABELS = 0 37504TR_ROW_LINES = 0 37505TR_HIDE_ROOT = 0 37506TR_FULL_ROW_HIGHLIGHT = 0 37507TR_DEFAULT_STYLE = 0 37508TreeItemIcon_Normal = 0 37509TreeItemIcon_Selected = 0 37510TreeItemIcon_Expanded = 0 37511TreeItemIcon_SelectedExpanded = 0 37512TreeItemIcon_Max = 0 37513TREE_ITEMSTATE_NONE = 0 37514TREE_ITEMSTATE_NEXT = 0 37515TREE_ITEMSTATE_PREV = 0 37516TREE_HITTEST_ABOVE = 0 37517TREE_HITTEST_BELOW = 0 37518TREE_HITTEST_NOWHERE = 0 37519TREE_HITTEST_ONITEMBUTTON = 0 37520TREE_HITTEST_ONITEMICON = 0 37521TREE_HITTEST_ONITEMINDENT = 0 37522TREE_HITTEST_ONITEMLABEL = 0 37523TREE_HITTEST_ONITEMRIGHT = 0 37524TREE_HITTEST_ONITEMSTATEICON = 0 37525TREE_HITTEST_TOLEFT = 0 37526TREE_HITTEST_TORIGHT = 0 37527TREE_HITTEST_ONITEMUPPERPART = 0 37528TREE_HITTEST_ONITEMLOWERPART = 0 37529TREE_HITTEST_ONITEM = 0 37530wxEVT_TREE_BEGIN_DRAG = 0 37531wxEVT_TREE_BEGIN_RDRAG = 0 37532wxEVT_TREE_BEGIN_LABEL_EDIT = 0 37533wxEVT_TREE_END_LABEL_EDIT = 0 37534wxEVT_TREE_DELETE_ITEM = 0 37535wxEVT_TREE_GET_INFO = 0 37536wxEVT_TREE_SET_INFO = 0 37537wxEVT_TREE_ITEM_EXPANDED = 0 37538wxEVT_TREE_ITEM_EXPANDING = 0 37539wxEVT_TREE_ITEM_COLLAPSED = 0 37540wxEVT_TREE_ITEM_COLLAPSING = 0 37541wxEVT_TREE_SEL_CHANGED = 0 37542wxEVT_TREE_SEL_CHANGING = 0 37543wxEVT_TREE_KEY_DOWN = 0 37544wxEVT_TREE_ITEM_ACTIVATED = 0 37545wxEVT_TREE_ITEM_RIGHT_CLICK = 0 37546wxEVT_TREE_ITEM_MIDDLE_CLICK = 0 37547wxEVT_TREE_END_DRAG = 0 37548wxEVT_TREE_STATE_IMAGE_CLICK = 0 37549wxEVT_TREE_ITEM_GETTOOLTIP = 0 37550wxEVT_TREE_ITEM_MENU = 0 37551 37552class TreeItemId(object): 37553 """ 37554 TreeItemId() 37555 TreeItemId(pItem) 37556 37557 An opaque reference to a tree item. 37558 """ 37559 37560 def __init__(self, *args, **kw): 37561 """ 37562 TreeItemId() 37563 TreeItemId(pItem) 37564 37565 An opaque reference to a tree item. 37566 """ 37567 37568 def IsOk(self): 37569 """ 37570 IsOk() -> bool 37571 37572 Returns true if this instance is referencing a valid tree item. 37573 """ 37574 37575 def GetID(self): 37576 """ 37577 GetID() -> void 37578 """ 37579 37580 def Unset(self): 37581 """ 37582 Unset() 37583 """ 37584 37585 def __nonzero__(self): 37586 """ 37587 __nonzero__() -> int 37588 """ 37589 37590 def __bool__(self): 37591 """ 37592 __bool__() -> int 37593 """ 37594 37595 def __eq__(self, other): 37596 """ 37597 __eq__(other) -> bool 37598 """ 37599 37600 def __ne__(self, other): 37601 """ 37602 __ne__(other) -> bool 37603 """ 37604 37605 def __hash__(self): 37606 """ 37607 37608 """ 37609 ID = property(None, None) 37610# end of class TreeItemId 37611 37612TreeCtrlNameStr = "" 37613 37614class TreeCtrl(Control): 37615 """ 37616 TreeCtrl() 37617 TreeCtrl(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=TR_DEFAULT_STYLE, validator=DefaultValidator, name=TreeCtrlNameStr) 37618 37619 A tree control presents information as a hierarchy, with items that 37620 may be expanded to show further items. 37621 """ 37622 37623 def __init__(self, *args, **kw): 37624 """ 37625 TreeCtrl() 37626 TreeCtrl(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=TR_DEFAULT_STYLE, validator=DefaultValidator, name=TreeCtrlNameStr) 37627 37628 A tree control presents information as a hierarchy, with items that 37629 may be expanded to show further items. 37630 """ 37631 37632 def AddRoot(self, text, image=-1, selImage=-1, data=None): 37633 """ 37634 AddRoot(text, image=-1, selImage=-1, data=None) -> TreeItemId 37635 37636 Adds the root node to the tree, returning the new item. 37637 """ 37638 37639 def AppendItem(self, parent, text, image=-1, selImage=-1, data=None): 37640 """ 37641 AppendItem(parent, text, image=-1, selImage=-1, data=None) -> TreeItemId 37642 37643 Appends an item to the end of the branch identified by parent, return 37644 a new item id. 37645 """ 37646 37647 def AssignImageList(self, imageList): 37648 """ 37649 AssignImageList(imageList) 37650 37651 Sets the normal image list. 37652 """ 37653 37654 def AssignStateImageList(self, imageList): 37655 """ 37656 AssignStateImageList(imageList) 37657 37658 Sets the state image list. 37659 """ 37660 37661 def Collapse(self, item): 37662 """ 37663 Collapse(item) 37664 37665 Collapses the given item. 37666 """ 37667 37668 def CollapseAll(self): 37669 """ 37670 CollapseAll() 37671 37672 Collapses the root item. 37673 """ 37674 37675 def CollapseAllChildren(self, item): 37676 """ 37677 CollapseAllChildren(item) 37678 37679 Collapses this item and all of its children, recursively. 37680 """ 37681 37682 def CollapseAndReset(self, item): 37683 """ 37684 CollapseAndReset(item) 37685 37686 Collapses the given item and removes all children. 37687 """ 37688 37689 def Create(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=TR_DEFAULT_STYLE, validator=DefaultValidator, name=TreeCtrlNameStr): 37690 """ 37691 Create(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=TR_DEFAULT_STYLE, validator=DefaultValidator, name=TreeCtrlNameStr) -> bool 37692 37693 Creates the tree control. 37694 """ 37695 37696 def Delete(self, item): 37697 """ 37698 Delete(item) 37699 37700 Deletes the specified item. 37701 """ 37702 37703 def DeleteAllItems(self): 37704 """ 37705 DeleteAllItems() 37706 37707 Deletes all items in the control. 37708 """ 37709 37710 def DeleteChildren(self, item): 37711 """ 37712 DeleteChildren(item) 37713 37714 Deletes all children of the given item (but not the item itself). 37715 """ 37716 37717 def EditLabel(self, item): 37718 """ 37719 EditLabel(item) -> TextCtrl 37720 37721 Starts editing the label of the given item. 37722 """ 37723 37724 def EnableBellOnNoMatch(self, on=True): 37725 """ 37726 EnableBellOnNoMatch(on=True) 37727 37728 Enable or disable a beep if there is no match for the currently 37729 entered text when searching for the item from keyboard. 37730 """ 37731 37732 def EndEditLabel(self, item, discardChanges=False): 37733 """ 37734 EndEditLabel(item, discardChanges=False) 37735 37736 Ends label editing. 37737 """ 37738 37739 def EnsureVisible(self, item): 37740 """ 37741 EnsureVisible(item) 37742 37743 Scrolls and/or expands items to ensure that the given item is visible. 37744 """ 37745 37746 def Expand(self, item): 37747 """ 37748 Expand(item) 37749 37750 Expands the given item. 37751 """ 37752 37753 def ExpandAll(self): 37754 """ 37755 ExpandAll() 37756 37757 Expands all items in the tree. 37758 """ 37759 37760 def ExpandAllChildren(self, item): 37761 """ 37762 ExpandAllChildren(item) 37763 37764 Expands the given item and all its children recursively. 37765 """ 37766 37767 def GetBoundingRect(self, item, textOnly=False): 37768 """ 37769 GetBoundingRect(item, textOnly=False) -> PyObject 37770 37771 Returns the rectangle bounding the item. If textOnly is true, 37772 only the rectangle around the item's label will be returned, otherwise 37773 the item's image is also taken into account. The return value may be 37774 None 37775 if the rectangle was not successfully retrieved, such as if the item 37776 is 37777 currently not visible. 37778 """ 37779 37780 def GetChildrenCount(self, item, recursively=True): 37781 """ 37782 GetChildrenCount(item, recursively=True) -> size_t 37783 37784 Returns the number of items in the branch. 37785 """ 37786 37787 def GetCount(self): 37788 """ 37789 GetCount() -> unsignedint 37790 37791 Returns the number of items in the control. 37792 """ 37793 37794 def GetEditControl(self): 37795 """ 37796 GetEditControl() -> TextCtrl 37797 37798 Returns the edit control being currently used to edit a label. 37799 """ 37800 37801 def GetFirstChild(self, item): 37802 """ 37803 GetFirstChild(item) -> (TreeItemId, cookie) 37804 37805 Returns the first child; call GetNextChild() for the next child. 37806 """ 37807 37808 def GetFirstVisibleItem(self): 37809 """ 37810 GetFirstVisibleItem() -> TreeItemId 37811 37812 Returns the first visible item. 37813 """ 37814 37815 def GetFocusedItem(self): 37816 """ 37817 GetFocusedItem() -> TreeItemId 37818 37819 Returns the item last clicked or otherwise selected. 37820 """ 37821 37822 def ClearFocusedItem(self): 37823 """ 37824 ClearFocusedItem() 37825 37826 Clears the currently focused item. 37827 """ 37828 37829 def SetFocusedItem(self, item): 37830 """ 37831 SetFocusedItem(item) 37832 37833 Sets the currently focused item. 37834 """ 37835 37836 def GetImageList(self): 37837 """ 37838 GetImageList() -> ImageList 37839 37840 Returns the normal image list. 37841 """ 37842 37843 def GetIndent(self): 37844 """ 37845 GetIndent() -> unsignedint 37846 37847 Returns the current tree control indentation. 37848 """ 37849 37850 def GetItemBackgroundColour(self, item): 37851 """ 37852 GetItemBackgroundColour(item) -> Colour 37853 37854 Returns the background colour of the item. 37855 """ 37856 37857 def GetItemData(self, item): 37858 """ 37859 GetItemData(item) -> TreeItemData 37860 37861 Returns the tree item data associated with the item. 37862 """ 37863 37864 def GetItemFont(self, item): 37865 """ 37866 GetItemFont(item) -> Font 37867 37868 Returns the font of the item label. 37869 """ 37870 37871 def GetItemImage(self, item, which=TreeItemIcon_Normal): 37872 """ 37873 GetItemImage(item, which=TreeItemIcon_Normal) -> int 37874 37875 Gets the specified item image. 37876 """ 37877 37878 def GetItemParent(self, item): 37879 """ 37880 GetItemParent(item) -> TreeItemId 37881 37882 Returns the item's parent. 37883 """ 37884 37885 def GetItemState(self, item): 37886 """ 37887 GetItemState(item) -> int 37888 37889 Gets the specified item state. 37890 """ 37891 37892 def GetItemText(self, item): 37893 """ 37894 GetItemText(item) -> String 37895 37896 Returns the item label. 37897 """ 37898 37899 def GetItemTextColour(self, item): 37900 """ 37901 GetItemTextColour(item) -> Colour 37902 37903 Returns the colour of the item label. 37904 """ 37905 37906 def GetLastChild(self, item): 37907 """ 37908 GetLastChild(item) -> TreeItemId 37909 37910 Returns the last child of the item (or an invalid tree item if this 37911 item has no children). 37912 """ 37913 37914 def GetNextChild(self, item, cookie): 37915 """ 37916 GetNextChild(item, cookie) -> (TreeItemId, cookie) 37917 37918 Returns the next child; call GetFirstChild() for the first child. 37919 """ 37920 37921 def GetNextSibling(self, item): 37922 """ 37923 GetNextSibling(item) -> TreeItemId 37924 37925 Returns the next sibling of the specified item; call GetPrevSibling() 37926 for the previous sibling. 37927 """ 37928 37929 def GetNextVisible(self, item): 37930 """ 37931 GetNextVisible(item) -> TreeItemId 37932 37933 Returns the next visible item or an invalid item if this item is the 37934 last visible one. 37935 """ 37936 37937 def GetPrevSibling(self, item): 37938 """ 37939 GetPrevSibling(item) -> TreeItemId 37940 37941 Returns the previous sibling of the specified item; call 37942 GetNextSibling() for the next sibling. 37943 """ 37944 37945 def GetPrevVisible(self, item): 37946 """ 37947 GetPrevVisible(item) -> TreeItemId 37948 37949 Returns the previous visible item or an invalid item if this item is 37950 the first visible one. 37951 """ 37952 37953 def GetQuickBestSize(self): 37954 """ 37955 GetQuickBestSize() -> bool 37956 37957 Returns true if the control will use a quick calculation for the best 37958 size, looking only at the first and last items. 37959 """ 37960 37961 def GetRootItem(self): 37962 """ 37963 GetRootItem() -> TreeItemId 37964 37965 Returns the root item for the tree control. 37966 """ 37967 37968 def GetSelection(self): 37969 """ 37970 GetSelection() -> TreeItemId 37971 37972 Returns the selection, or an invalid item if there is no selection. 37973 """ 37974 37975 def GetSelections(self): 37976 """ 37977 GetSelections() -> PyObject 37978 37979 Returns a list of currently selected items in the tree. This function 37980 can be called only if the control has the wx.TR_MULTIPLE style. 37981 """ 37982 37983 def GetStateImageList(self): 37984 """ 37985 GetStateImageList() -> ImageList 37986 37987 Returns the state image list (from which application-defined state 37988 images are taken). 37989 """ 37990 37991 def HitTest(self, point, flags): 37992 """ 37993 HitTest(point, flags) -> TreeItemId 37994 37995 Calculates which (if any) item is under the given point, returning the 37996 tree item id at this point plus extra information flags. 37997 """ 37998 37999 def InsertItem(self, *args, **kw): 38000 """ 38001 InsertItem(parent, previous, text, image=-1, selImage=-1, data=None) -> TreeItemId 38002 InsertItem(parent, pos, text, image=-1, selImage=-1, data=None) -> TreeItemId 38003 38004 Inserts an item after a given one (previous). 38005 """ 38006 38007 def IsBold(self, item): 38008 """ 38009 IsBold(item) -> bool 38010 38011 Returns true if the given item is in bold state. 38012 """ 38013 38014 def IsEmpty(self): 38015 """ 38016 IsEmpty() -> bool 38017 38018 Returns true if the control is empty (i.e. has no items, even no root 38019 one). 38020 """ 38021 38022 def IsExpanded(self, item): 38023 """ 38024 IsExpanded(item) -> bool 38025 38026 Returns true if the item is expanded (only makes sense if it has 38027 children). 38028 """ 38029 38030 def IsSelected(self, item): 38031 """ 38032 IsSelected(item) -> bool 38033 38034 Returns true if the item is selected. 38035 """ 38036 38037 def IsVisible(self, item): 38038 """ 38039 IsVisible(item) -> bool 38040 38041 Returns true if the item is visible on the screen. 38042 """ 38043 38044 def ItemHasChildren(self, item): 38045 """ 38046 ItemHasChildren(item) -> bool 38047 38048 Returns true if the item has children. 38049 """ 38050 38051 def OnCompareItems(self, item1, item2): 38052 """ 38053 OnCompareItems(item1, item2) -> int 38054 38055 Override this function in the derived class to change the sort order 38056 of the items in the tree control. 38057 """ 38058 38059 def PrependItem(self, parent, text, image=-1, selImage=-1, data=None): 38060 """ 38061 PrependItem(parent, text, image=-1, selImage=-1, data=None) -> TreeItemId 38062 38063 Appends an item as the first child of parent, return a new item id. 38064 """ 38065 38066 def ScrollTo(self, item): 38067 """ 38068 ScrollTo(item) 38069 38070 Scrolls the specified item into view. 38071 """ 38072 38073 def SelectItem(self, item, select=True): 38074 """ 38075 SelectItem(item, select=True) 38076 38077 Selects the given item. 38078 """ 38079 38080 def SetImageList(self, imageList): 38081 """ 38082 SetImageList(imageList) 38083 38084 Sets the normal image list. 38085 """ 38086 38087 def SetIndent(self, indent): 38088 """ 38089 SetIndent(indent) 38090 38091 Sets the indentation for the tree control. 38092 """ 38093 38094 def SetItemBackgroundColour(self, item, col): 38095 """ 38096 SetItemBackgroundColour(item, col) 38097 38098 Sets the colour of the item's background. 38099 """ 38100 38101 def SetItemBold(self, item, bold=True): 38102 """ 38103 SetItemBold(item, bold=True) 38104 38105 Makes item appear in bold font if bold parameter is true or resets it 38106 to the normal state. 38107 """ 38108 38109 def SetItemData(self, item, data): 38110 """ 38111 SetItemData(item, data) 38112 38113 Sets the item client data. 38114 """ 38115 38116 def SetItemDropHighlight(self, item, highlight=True): 38117 """ 38118 SetItemDropHighlight(item, highlight=True) 38119 38120 Gives the item the visual feedback for Drag'n'Drop actions, which is 38121 useful if something is dragged from the outside onto the tree control 38122 (as opposed to a DnD operation within the tree control, which already 38123 is implemented internally). 38124 """ 38125 38126 def SetItemFont(self, item, font): 38127 """ 38128 SetItemFont(item, font) 38129 38130 Sets the item's font. 38131 """ 38132 38133 def SetItemHasChildren(self, item, hasChildren=True): 38134 """ 38135 SetItemHasChildren(item, hasChildren=True) 38136 38137 Force appearance of the button next to the item. 38138 """ 38139 38140 def SetItemImage(self, item, image, which=TreeItemIcon_Normal): 38141 """ 38142 SetItemImage(item, image, which=TreeItemIcon_Normal) 38143 38144 Sets the specified item's image. 38145 """ 38146 38147 def SetItemState(self, item, state): 38148 """ 38149 SetItemState(item, state) 38150 38151 Sets the specified item state. 38152 """ 38153 38154 def SetItemText(self, item, text): 38155 """ 38156 SetItemText(item, text) 38157 38158 Sets the item label. 38159 """ 38160 38161 def SetItemTextColour(self, item, col): 38162 """ 38163 SetItemTextColour(item, col) 38164 38165 Sets the colour of the item's text. 38166 """ 38167 38168 def SetQuickBestSize(self, quickBestSize): 38169 """ 38170 SetQuickBestSize(quickBestSize) 38171 38172 If true is passed, specifies that the control will use a quick 38173 calculation for the best size, looking only at the first and last 38174 items. 38175 """ 38176 38177 def SetStateImageList(self, imageList): 38178 """ 38179 SetStateImageList(imageList) 38180 38181 Sets the state image list (from which application-defined state images 38182 are taken). 38183 """ 38184 38185 def SetWindowStyle(self, styles): 38186 """ 38187 SetWindowStyle(styles) 38188 38189 Sets the mode flags associated with the display of the tree control. 38190 """ 38191 38192 def SortChildren(self, item): 38193 """ 38194 SortChildren(item) 38195 38196 Sorts the children of the given item using OnCompareItems(). 38197 """ 38198 38199 def Toggle(self, item): 38200 """ 38201 Toggle(item) 38202 38203 Toggles the given item between collapsed and expanded states. 38204 """ 38205 38206 def ToggleItemSelection(self, item): 38207 """ 38208 ToggleItemSelection(item) 38209 38210 Toggles the given item between selected and unselected states. 38211 """ 38212 38213 def Unselect(self): 38214 """ 38215 Unselect() 38216 38217 Removes the selection from the currently selected item (if any). 38218 """ 38219 38220 def UnselectAll(self): 38221 """ 38222 UnselectAll() 38223 38224 This function either behaves the same as Unselect() if the control 38225 doesn't have wxTR_MULTIPLE style, or removes the selection from all 38226 items if it does have this style. 38227 """ 38228 38229 def UnselectItem(self, item): 38230 """ 38231 UnselectItem(item) 38232 38233 Unselects the given item. 38234 """ 38235 38236 def SelectChildren(self, parent): 38237 """ 38238 SelectChildren(parent) 38239 38240 Select all the immediate children of the given parent. 38241 """ 38242 38243 @staticmethod 38244 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 38245 """ 38246 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 38247 """ 38248 38249 GetItemPyData = wx.deprecated(GetItemData, 'Use GetItemData instead.') 38250 SetItemPyData = wx.deprecated(SetItemData, 'Use SetItemData instead.') 38251 GetPyData = wx.deprecated(GetItemData, 'Use GetItemData instead.') 38252 SetPyData = wx.deprecated(SetItemData, 'Use SetItemData instead.') 38253 BoundingRect = property(None, None) 38254 Count = property(None, None) 38255 EditControl = property(None, None) 38256 FirstVisibleItem = property(None, None) 38257 FocusedItem = property(None, None) 38258 ImageList = property(None, None) 38259 Indent = property(None, None) 38260 QuickBestSize = property(None, None) 38261 RootItem = property(None, None) 38262 Selection = property(None, None) 38263 Selections = property(None, None) 38264 StateImageList = property(None, None) 38265# end of class TreeCtrl 38266 38267 38268class TreeEvent(NotifyEvent): 38269 """ 38270 TreeEvent(commandType, tree, item=TreeItemId()) 38271 38272 A tree event holds information about events associated with wxTreeCtrl 38273 objects. 38274 """ 38275 38276 def __init__(self, commandType, tree, item=TreeItemId()): 38277 """ 38278 TreeEvent(commandType, tree, item=TreeItemId()) 38279 38280 A tree event holds information about events associated with wxTreeCtrl 38281 objects. 38282 """ 38283 38284 def GetItem(self): 38285 """ 38286 GetItem() -> TreeItemId 38287 38288 Returns the item (valid for all events). 38289 """ 38290 38291 def GetKeyCode(self): 38292 """ 38293 GetKeyCode() -> int 38294 38295 Returns the key code if the event is a key event. 38296 """ 38297 38298 def GetKeyEvent(self): 38299 """ 38300 GetKeyEvent() -> KeyEvent 38301 38302 Returns the key event for EVT_TREE_KEY_DOWN events. 38303 """ 38304 38305 def GetLabel(self): 38306 """ 38307 GetLabel() -> String 38308 38309 Returns the label if the event is a begin or end edit label event. 38310 """ 38311 38312 def GetOldItem(self): 38313 """ 38314 GetOldItem() -> TreeItemId 38315 38316 Returns the old item index (valid for EVT_TREE_ITEM_CHANGING and 38317 EVT_TREE_ITEM_CHANGED events). 38318 """ 38319 38320 def GetPoint(self): 38321 """ 38322 GetPoint() -> Point 38323 38324 Returns the position of the mouse pointer if the event is a drag or 38325 menu-context event. 38326 """ 38327 38328 def IsEditCancelled(self): 38329 """ 38330 IsEditCancelled() -> bool 38331 38332 Returns true if the label edit was cancelled. 38333 """ 38334 38335 def SetToolTip(self, tooltip): 38336 """ 38337 SetToolTip(tooltip) 38338 38339 Set the tooltip for the item (valid for EVT_TREE_ITEM_GETTOOLTIP 38340 events). 38341 """ 38342 Item = property(None, None) 38343 KeyCode = property(None, None) 38344 KeyEvent = property(None, None) 38345 Label = property(None, None) 38346 OldItem = property(None, None) 38347 Point = property(None, None) 38348# end of class TreeEvent 38349 38350 38351def TreeItemData(data): 38352 return data 38353TreeItemData = deprecated(TreeItemData, "The TreeItemData class no longer exists, just pass your object directly to the tree instead.") 38354 38355EVT_TREE_BEGIN_DRAG = PyEventBinder(wxEVT_TREE_BEGIN_DRAG , 1) 38356EVT_TREE_BEGIN_RDRAG = PyEventBinder(wxEVT_TREE_BEGIN_RDRAG , 1) 38357EVT_TREE_BEGIN_LABEL_EDIT = PyEventBinder(wxEVT_TREE_BEGIN_LABEL_EDIT , 1) 38358EVT_TREE_END_LABEL_EDIT = PyEventBinder(wxEVT_TREE_END_LABEL_EDIT , 1) 38359EVT_TREE_DELETE_ITEM = PyEventBinder(wxEVT_TREE_DELETE_ITEM , 1) 38360EVT_TREE_GET_INFO = PyEventBinder(wxEVT_TREE_GET_INFO , 1) 38361EVT_TREE_SET_INFO = PyEventBinder(wxEVT_TREE_SET_INFO , 1) 38362EVT_TREE_ITEM_EXPANDED = PyEventBinder(wxEVT_TREE_ITEM_EXPANDED , 1) 38363EVT_TREE_ITEM_EXPANDING = PyEventBinder(wxEVT_TREE_ITEM_EXPANDING , 1) 38364EVT_TREE_ITEM_COLLAPSED = PyEventBinder(wxEVT_TREE_ITEM_COLLAPSED , 1) 38365EVT_TREE_ITEM_COLLAPSING = PyEventBinder(wxEVT_TREE_ITEM_COLLAPSING , 1) 38366EVT_TREE_SEL_CHANGED = PyEventBinder(wxEVT_TREE_SEL_CHANGED , 1) 38367EVT_TREE_SEL_CHANGING = PyEventBinder(wxEVT_TREE_SEL_CHANGING , 1) 38368EVT_TREE_KEY_DOWN = PyEventBinder(wxEVT_TREE_KEY_DOWN , 1) 38369EVT_TREE_ITEM_ACTIVATED = PyEventBinder(wxEVT_TREE_ITEM_ACTIVATED , 1) 38370EVT_TREE_ITEM_RIGHT_CLICK = PyEventBinder(wxEVT_TREE_ITEM_RIGHT_CLICK , 1) 38371EVT_TREE_ITEM_MIDDLE_CLICK = PyEventBinder(wxEVT_TREE_ITEM_MIDDLE_CLICK, 1) 38372EVT_TREE_END_DRAG = PyEventBinder(wxEVT_TREE_END_DRAG , 1) 38373EVT_TREE_STATE_IMAGE_CLICK = PyEventBinder(wxEVT_TREE_STATE_IMAGE_CLICK, 1) 38374EVT_TREE_ITEM_GETTOOLTIP = PyEventBinder(wxEVT_TREE_ITEM_GETTOOLTIP, 1) 38375EVT_TREE_ITEM_MENU = PyEventBinder(wxEVT_TREE_ITEM_MENU, 1) 38376 38377# deprecated wxEVT aliases 38378wxEVT_COMMAND_TREE_BEGIN_DRAG = wxEVT_TREE_BEGIN_DRAG 38379wxEVT_COMMAND_TREE_BEGIN_RDRAG = wxEVT_TREE_BEGIN_RDRAG 38380wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT = wxEVT_TREE_BEGIN_LABEL_EDIT 38381wxEVT_COMMAND_TREE_END_LABEL_EDIT = wxEVT_TREE_END_LABEL_EDIT 38382wxEVT_COMMAND_TREE_DELETE_ITEM = wxEVT_TREE_DELETE_ITEM 38383wxEVT_COMMAND_TREE_GET_INFO = wxEVT_TREE_GET_INFO 38384wxEVT_COMMAND_TREE_SET_INFO = wxEVT_TREE_SET_INFO 38385wxEVT_COMMAND_TREE_ITEM_EXPANDED = wxEVT_TREE_ITEM_EXPANDED 38386wxEVT_COMMAND_TREE_ITEM_EXPANDING = wxEVT_TREE_ITEM_EXPANDING 38387wxEVT_COMMAND_TREE_ITEM_COLLAPSED = wxEVT_TREE_ITEM_COLLAPSED 38388wxEVT_COMMAND_TREE_ITEM_COLLAPSING = wxEVT_TREE_ITEM_COLLAPSING 38389wxEVT_COMMAND_TREE_SEL_CHANGED = wxEVT_TREE_SEL_CHANGED 38390wxEVT_COMMAND_TREE_SEL_CHANGING = wxEVT_TREE_SEL_CHANGING 38391wxEVT_COMMAND_TREE_KEY_DOWN = wxEVT_TREE_KEY_DOWN 38392wxEVT_COMMAND_TREE_ITEM_ACTIVATED = wxEVT_TREE_ITEM_ACTIVATED 38393wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK = wxEVT_TREE_ITEM_RIGHT_CLICK 38394wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK = wxEVT_TREE_ITEM_MIDDLE_CLICK 38395wxEVT_COMMAND_TREE_END_DRAG = wxEVT_TREE_END_DRAG 38396wxEVT_COMMAND_TREE_STATE_IMAGE_CLICK = wxEVT_TREE_STATE_IMAGE_CLICK 38397wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP = wxEVT_TREE_ITEM_GETTOOLTIP 38398wxEVT_COMMAND_TREE_ITEM_MENU = wxEVT_TREE_ITEM_MENU 38399#-- end-treectrl --# 38400#-- begin-pickers --# 38401PB_USE_TEXTCTRL = 0 38402PB_SMALL = 0 38403CLRP_USE_TEXTCTRL = 0 38404CLRP_DEFAULT_STYLE = 0 38405CLRP_SHOW_LABEL = 0 38406wxEVT_COLOURPICKER_CHANGED = 0 38407FLP_OPEN = 0 38408FLP_SAVE = 0 38409FLP_OVERWRITE_PROMPT = 0 38410FLP_FILE_MUST_EXIST = 0 38411FLP_CHANGE_DIR = 0 38412FLP_SMALL = 0 38413FLP_USE_TEXTCTRL = 0 38414FLP_DEFAULT_STYLE = 0 38415DIRP_DIR_MUST_EXIST = 0 38416DIRP_CHANGE_DIR = 0 38417DIRP_SMALL = 0 38418DIRP_USE_TEXTCTRL = 0 38419DIRP_DEFAULT_STYLE = 0 38420wxEVT_FILEPICKER_CHANGED = 0 38421wxEVT_DIRPICKER_CHANGED = 0 38422FNTP_FONTDESC_AS_LABEL = 0 38423FNTP_USEFONT_FOR_LABEL = 0 38424FONTBTN_DEFAULT_STYLE = 0 38425FNTP_USE_TEXTCTRL = 0 38426FNTP_DEFAULT_STYLE = 0 38427wxEVT_FONTPICKER_CHANGED = 0 38428 38429class PickerBase(Control): 38430 """ 38431 PickerBase() 38432 38433 Base abstract class for all pickers which support an auxiliary text 38434 control. 38435 """ 38436 38437 def __init__(self): 38438 """ 38439 PickerBase() 38440 38441 Base abstract class for all pickers which support an auxiliary text 38442 control. 38443 """ 38444 38445 def CreateBase(self, parent, id=ID_ANY, text=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, validator=DefaultValidator, name=ButtonNameStr): 38446 """ 38447 CreateBase(parent, id=ID_ANY, text=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, validator=DefaultValidator, name=ButtonNameStr) -> bool 38448 """ 38449 38450 def GetInternalMargin(self): 38451 """ 38452 GetInternalMargin() -> int 38453 38454 Returns the margin (in pixel) between the picker and the text control. 38455 """ 38456 38457 def GetPickerCtrlProportion(self): 38458 """ 38459 GetPickerCtrlProportion() -> int 38460 38461 Returns the proportion value of the picker. 38462 """ 38463 38464 def GetTextCtrl(self): 38465 """ 38466 GetTextCtrl() -> TextCtrl 38467 38468 Returns a pointer to the text control handled by this window or NULL 38469 if the wxPB_USE_TEXTCTRL style was not specified when this control was 38470 created. 38471 """ 38472 38473 def GetPickerCtrl(self): 38474 """ 38475 GetPickerCtrl() -> Control 38476 38477 Returns the native implementation of the real picker control. 38478 """ 38479 38480 def GetTextCtrlProportion(self): 38481 """ 38482 GetTextCtrlProportion() -> int 38483 38484 Returns the proportion value of the text control. 38485 """ 38486 38487 def HasTextCtrl(self): 38488 """ 38489 HasTextCtrl() -> bool 38490 38491 Returns true if this window has a valid text control (i.e. if the 38492 wxPB_USE_TEXTCTRL style was given when creating this control). 38493 """ 38494 38495 def IsPickerCtrlGrowable(self): 38496 """ 38497 IsPickerCtrlGrowable() -> bool 38498 38499 Returns true if the picker control is growable. 38500 """ 38501 38502 def IsTextCtrlGrowable(self): 38503 """ 38504 IsTextCtrlGrowable() -> bool 38505 38506 Returns true if the text control is growable. 38507 """ 38508 38509 def SetInternalMargin(self, margin): 38510 """ 38511 SetInternalMargin(margin) 38512 38513 Sets the margin (in pixel) between the picker and the text control. 38514 """ 38515 38516 def SetPickerCtrlGrowable(self, grow=True): 38517 """ 38518 SetPickerCtrlGrowable(grow=True) 38519 38520 Sets the picker control as growable when grow is true. 38521 """ 38522 38523 def SetPickerCtrlProportion(self, prop): 38524 """ 38525 SetPickerCtrlProportion(prop) 38526 38527 Sets the proportion value of the picker. 38528 """ 38529 38530 def SetTextCtrlGrowable(self, grow=True): 38531 """ 38532 SetTextCtrlGrowable(grow=True) 38533 38534 Sets the text control as growable when grow is true. 38535 """ 38536 38537 def SetTextCtrlProportion(self, prop): 38538 """ 38539 SetTextCtrlProportion(prop) 38540 38541 Sets the proportion value of the text control. 38542 """ 38543 38544 def SetTextCtrl(self, text): 38545 """ 38546 SetTextCtrl(text) 38547 """ 38548 38549 def SetPickerCtrl(self, picker): 38550 """ 38551 SetPickerCtrl(picker) 38552 """ 38553 38554 def UpdatePickerFromTextCtrl(self): 38555 """ 38556 UpdatePickerFromTextCtrl() 38557 """ 38558 38559 def UpdateTextCtrlFromPicker(self): 38560 """ 38561 UpdateTextCtrlFromPicker() 38562 """ 38563 InternalMargin = property(None, None) 38564 PickerCtrl = property(None, None) 38565 PickerCtrlProportion = property(None, None) 38566 TextCtrl = property(None, None) 38567 TextCtrlProportion = property(None, None) 38568 38569 def GetTextCtrlStyle(self, style): 38570 """ 38571 GetTextCtrlStyle(style) -> long 38572 """ 38573 38574 def GetPickerStyle(self, style): 38575 """ 38576 GetPickerStyle(style) -> long 38577 """ 38578 38579 def PostCreation(self): 38580 """ 38581 PostCreation() 38582 """ 38583# end of class PickerBase 38584 38585ColourPickerWidgetNameStr = "" 38586ColourPickerCtrlNameStr = "" 38587 38588class ColourPickerCtrl(PickerBase): 38589 """ 38590 ColourPickerCtrl() 38591 ColourPickerCtrl(parent, id=ID_ANY, colour=BLACK, pos=DefaultPosition, size=DefaultSize, style=CLRP_DEFAULT_STYLE, validator=DefaultValidator, name=ColourPickerCtrlNameStr) 38592 38593 This control allows the user to select a colour. 38594 """ 38595 38596 def __init__(self, *args, **kw): 38597 """ 38598 ColourPickerCtrl() 38599 ColourPickerCtrl(parent, id=ID_ANY, colour=BLACK, pos=DefaultPosition, size=DefaultSize, style=CLRP_DEFAULT_STYLE, validator=DefaultValidator, name=ColourPickerCtrlNameStr) 38600 38601 This control allows the user to select a colour. 38602 """ 38603 38604 def SetColour(self, *args, **kw): 38605 """ 38606 SetColour(col) 38607 SetColour(colname) 38608 38609 Sets the currently selected colour. 38610 """ 38611 38612 def Create(self, parent, id=ID_ANY, colour=BLACK, pos=DefaultPosition, size=DefaultSize, style=CLRP_DEFAULT_STYLE, validator=DefaultValidator, name=ColourPickerCtrlNameStr): 38613 """ 38614 Create(parent, id=ID_ANY, colour=BLACK, pos=DefaultPosition, size=DefaultSize, style=CLRP_DEFAULT_STYLE, validator=DefaultValidator, name=ColourPickerCtrlNameStr) -> bool 38615 38616 Creates a colour picker with the given arguments. 38617 """ 38618 38619 def GetColour(self): 38620 """ 38621 GetColour() -> Colour 38622 38623 Returns the currently selected colour. 38624 """ 38625 38626 @staticmethod 38627 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 38628 """ 38629 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 38630 """ 38631 Colour = property(None, None) 38632# end of class ColourPickerCtrl 38633 38634 38635class ColourPickerEvent(CommandEvent): 38636 """ 38637 ColourPickerEvent() 38638 ColourPickerEvent(generator, id, colour) 38639 38640 This event class is used for the events generated by 38641 wxColourPickerCtrl. 38642 """ 38643 38644 def __init__(self, *args, **kw): 38645 """ 38646 ColourPickerEvent() 38647 ColourPickerEvent(generator, id, colour) 38648 38649 This event class is used for the events generated by 38650 wxColourPickerCtrl. 38651 """ 38652 38653 def GetColour(self): 38654 """ 38655 GetColour() -> Colour 38656 38657 Retrieve the colour the user has just selected. 38658 """ 38659 38660 def SetColour(self, pos): 38661 """ 38662 SetColour(pos) 38663 38664 Set the colour associated with the event. 38665 """ 38666 Colour = property(None, None) 38667# end of class ColourPickerEvent 38668 38669FilePickerWidgetLabel = "" 38670FilePickerWidgetNameStr = "" 38671FilePickerCtrlNameStr = "" 38672FileSelectorPromptStr = "" 38673FileSelectorDefaultWildcardStr = "" 38674 38675class FilePickerCtrl(PickerBase): 38676 """ 38677 FilePickerCtrl() 38678 FilePickerCtrl(parent, id=ID_ANY, path=EmptyString, message=FileSelectorPromptStr, wildcard=FileSelectorDefaultWildcardStr, pos=DefaultPosition, size=DefaultSize, style=FLP_DEFAULT_STYLE, validator=DefaultValidator, name=FilePickerCtrlNameStr) 38679 38680 This control allows the user to select a file. 38681 """ 38682 38683 def __init__(self, *args, **kw): 38684 """ 38685 FilePickerCtrl() 38686 FilePickerCtrl(parent, id=ID_ANY, path=EmptyString, message=FileSelectorPromptStr, wildcard=FileSelectorDefaultWildcardStr, pos=DefaultPosition, size=DefaultSize, style=FLP_DEFAULT_STYLE, validator=DefaultValidator, name=FilePickerCtrlNameStr) 38687 38688 This control allows the user to select a file. 38689 """ 38690 38691 def Create(self, parent, id=ID_ANY, path=EmptyString, message=FileSelectorPromptStr, wildcard=FileSelectorDefaultWildcardStr, pos=DefaultPosition, size=DefaultSize, style=FLP_DEFAULT_STYLE, validator=DefaultValidator, name=FilePickerCtrlNameStr): 38692 """ 38693 Create(parent, id=ID_ANY, path=EmptyString, message=FileSelectorPromptStr, wildcard=FileSelectorDefaultWildcardStr, pos=DefaultPosition, size=DefaultSize, style=FLP_DEFAULT_STYLE, validator=DefaultValidator, name=FilePickerCtrlNameStr) -> bool 38694 38695 Creates this widget with the given parameters. 38696 """ 38697 38698 def GetPath(self): 38699 """ 38700 GetPath() -> String 38701 38702 Returns the absolute path of the currently selected file. 38703 """ 38704 38705 def SetInitialDirectory(self, dir): 38706 """ 38707 SetInitialDirectory(dir) 38708 38709 Set the directory to show when starting to browse for files. 38710 """ 38711 38712 def SetPath(self, filename): 38713 """ 38714 SetPath(filename) 38715 38716 Sets the absolute path of the currently selected file. 38717 """ 38718 38719 @staticmethod 38720 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 38721 """ 38722 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 38723 """ 38724 Path = property(None, None) 38725# end of class FilePickerCtrl 38726 38727DirPickerWidgetLabel = "" 38728DirPickerWidgetNameStr = "" 38729DirPickerCtrlNameStr = "" 38730DirSelectorPromptStr = "" 38731 38732class DirPickerCtrl(PickerBase): 38733 """ 38734 DirPickerCtrl() 38735 DirPickerCtrl(parent, id=ID_ANY, path=EmptyString, message=DirSelectorPromptStr, pos=DefaultPosition, size=DefaultSize, style=DIRP_DEFAULT_STYLE, validator=DefaultValidator, name=DirPickerCtrlNameStr) 38736 38737 This control allows the user to select a directory. 38738 """ 38739 38740 def __init__(self, *args, **kw): 38741 """ 38742 DirPickerCtrl() 38743 DirPickerCtrl(parent, id=ID_ANY, path=EmptyString, message=DirSelectorPromptStr, pos=DefaultPosition, size=DefaultSize, style=DIRP_DEFAULT_STYLE, validator=DefaultValidator, name=DirPickerCtrlNameStr) 38744 38745 This control allows the user to select a directory. 38746 """ 38747 38748 def Create(self, parent, id=ID_ANY, path=EmptyString, message=DirSelectorPromptStr, pos=DefaultPosition, size=DefaultSize, style=DIRP_DEFAULT_STYLE, validator=DefaultValidator, name=DirPickerCtrlNameStr): 38749 """ 38750 Create(parent, id=ID_ANY, path=EmptyString, message=DirSelectorPromptStr, pos=DefaultPosition, size=DefaultSize, style=DIRP_DEFAULT_STYLE, validator=DefaultValidator, name=DirPickerCtrlNameStr) -> bool 38751 38752 Creates the widgets with the given parameters. 38753 """ 38754 38755 def GetPath(self): 38756 """ 38757 GetPath() -> String 38758 38759 Returns the absolute path of the currently selected directory. 38760 """ 38761 38762 def SetInitialDirectory(self, dir): 38763 """ 38764 SetInitialDirectory(dir) 38765 38766 Set the directory to show when starting to browse for directories. 38767 """ 38768 38769 def SetPath(self, dirname): 38770 """ 38771 SetPath(dirname) 38772 38773 Sets the absolute path of the currently selected directory (the 38774 default converter uses current locale's charset). 38775 """ 38776 38777 @staticmethod 38778 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 38779 """ 38780 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 38781 """ 38782 Path = property(None, None) 38783# end of class DirPickerCtrl 38784 38785 38786class FileDirPickerEvent(CommandEvent): 38787 """ 38788 FileDirPickerEvent() 38789 FileDirPickerEvent(type, generator, id, path) 38790 38791 This event class is used for the events generated by wxFilePickerCtrl 38792 and by wxDirPickerCtrl. 38793 """ 38794 38795 def __init__(self, *args, **kw): 38796 """ 38797 FileDirPickerEvent() 38798 FileDirPickerEvent(type, generator, id, path) 38799 38800 This event class is used for the events generated by wxFilePickerCtrl 38801 and by wxDirPickerCtrl. 38802 """ 38803 38804 def GetPath(self): 38805 """ 38806 GetPath() -> String 38807 38808 Retrieve the absolute path of the file/directory the user has just 38809 selected. 38810 """ 38811 38812 def SetPath(self, path): 38813 """ 38814 SetPath(path) 38815 38816 Set the absolute path of the file/directory associated with the event. 38817 """ 38818 Path = property(None, None) 38819# end of class FileDirPickerEvent 38820 38821FontPickerWidgetNameStr = "" 38822FontPickerCtrlNameStr = "" 38823 38824class FontPickerCtrl(PickerBase): 38825 """ 38826 FontPickerCtrl() 38827 FontPickerCtrl(parent, id=ID_ANY, font=NullFont, pos=DefaultPosition, size=DefaultSize, style=FNTP_DEFAULT_STYLE, validator=DefaultValidator, name=FontPickerCtrlNameStr) 38828 38829 This control allows the user to select a font. 38830 """ 38831 38832 def __init__(self, *args, **kw): 38833 """ 38834 FontPickerCtrl() 38835 FontPickerCtrl(parent, id=ID_ANY, font=NullFont, pos=DefaultPosition, size=DefaultSize, style=FNTP_DEFAULT_STYLE, validator=DefaultValidator, name=FontPickerCtrlNameStr) 38836 38837 This control allows the user to select a font. 38838 """ 38839 38840 def Create(self, parent, id=ID_ANY, font=NullFont, pos=DefaultPosition, size=DefaultSize, style=FNTP_DEFAULT_STYLE, validator=DefaultValidator, name=FontPickerCtrlNameStr): 38841 """ 38842 Create(parent, id=ID_ANY, font=NullFont, pos=DefaultPosition, size=DefaultSize, style=FNTP_DEFAULT_STYLE, validator=DefaultValidator, name=FontPickerCtrlNameStr) -> bool 38843 38844 Creates this widget with given parameters. 38845 """ 38846 38847 def GetMaxPointSize(self): 38848 """ 38849 GetMaxPointSize() -> unsignedint 38850 38851 Returns the maximum point size value allowed for the user-chosen font. 38852 """ 38853 38854 def GetSelectedFont(self): 38855 """ 38856 GetSelectedFont() -> Font 38857 38858 Returns the currently selected font. 38859 """ 38860 38861 def SetMaxPointSize(self, max): 38862 """ 38863 SetMaxPointSize(max) 38864 38865 Sets the maximum point size value allowed for the user-chosen font. 38866 """ 38867 38868 def SetSelectedFont(self, font): 38869 """ 38870 SetSelectedFont(font) 38871 38872 Sets the currently selected font. 38873 """ 38874 38875 @staticmethod 38876 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 38877 """ 38878 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 38879 """ 38880 MaxPointSize = property(None, None) 38881 SelectedFont = property(None, None) 38882# end of class FontPickerCtrl 38883 38884 38885class FontPickerEvent(CommandEvent): 38886 """ 38887 FontPickerEvent(generator, id, font) 38888 38889 This event class is used for the events generated by wxFontPickerCtrl. 38890 """ 38891 38892 def __init__(self, generator, id, font): 38893 """ 38894 FontPickerEvent(generator, id, font) 38895 38896 This event class is used for the events generated by wxFontPickerCtrl. 38897 """ 38898 38899 def GetFont(self): 38900 """ 38901 GetFont() -> Font 38902 38903 Retrieve the font the user has just selected. 38904 """ 38905 38906 def SetFont(self, f): 38907 """ 38908 SetFont(f) 38909 38910 Set the font associated with the event. 38911 """ 38912 Font = property(None, None) 38913# end of class FontPickerEvent 38914 38915 38916EVT_COLOURPICKER_CHANGED = wx.PyEventBinder( wxEVT_COLOURPICKER_CHANGED, 1 ) 38917 38918# deprecated wxEVT alias 38919wxEVT_COMMAND_COLOURPICKER_CHANGED = wxEVT_COLOURPICKER_CHANGED 38920 38921EVT_FILEPICKER_CHANGED = wx.PyEventBinder( wxEVT_FILEPICKER_CHANGED, 1 ) 38922EVT_DIRPICKER_CHANGED = wx.PyEventBinder( wxEVT_DIRPICKER_CHANGED, 1 ) 38923 38924# deprecated wxEVT aliases 38925wxEVT_COMMAND_FILEPICKER_CHANGED = wxEVT_FILEPICKER_CHANGED 38926wxEVT_COMMAND_DIRPICKER_CHANGED = wxEVT_DIRPICKER_CHANGED 38927 38928EVT_FONTPICKER_CHANGED = wx.PyEventBinder( wxEVT_FONTPICKER_CHANGED, 1 ) 38929 38930# deprecated wxEVT alias 38931wxEVT_COMMAND_FONTPICKER_CHANGED = wxEVT_FONTPICKER_CHANGED 38932 38933if 'wxMac' in wx.PlatformInfo: 38934 class ColourPickerCtrl(PickerBase): 38935 ''' 38936 This control allows the user to select a colour. The 38937 implementation varies by platform but is usually a button which 38938 brings up a `wx.ColourDialog` when clicked. 38939 38940 38941 Window Styles 38942 ------------- 38943 38944 ====================== ============================================ 38945 wx.CLRP_DEFAULT Default style. 38946 wx.CLRP_USE_TEXTCTRL Creates a text control to the left of the 38947 picker button which is completely managed 38948 by the `wx.ColourPickerCtrl` and which can 38949 be used by the user to specify a colour. 38950 The text control is automatically synchronized 38951 with the button's value. Use functions defined in 38952 `wx.PickerBase` to modify the text control. 38953 wx.CLRP_SHOW_LABEL Shows the colour in HTML form (AABBCC) as the 38954 colour button label (instead of no label at all). 38955 ====================== ============================================ 38956 38957 Events 38958 ------ 38959 38960 ======================== ========================================== 38961 EVT_COLOURPICKER_CHANGED The user changed the colour selected in the 38962 control either using the button or using the 38963 text control (see wx.CLRP_USE_TEXTCTRL; note 38964 that in this case the event is fired only if 38965 the user's input is valid, i.e. recognizable). 38966 ======================== ========================================== 38967 ''' 38968 38969 # ColourData object to be shared by all colour pickers, so they can 38970 # share the custom colours 38971 _colourData = None 38972 38973 #-------------------------------------------------- 38974 class ColourPickerButton(BitmapButton): 38975 def __init__(self, parent, id=-1, colour=wx.BLACK, 38976 pos=wx.DefaultPosition, size=wx.DefaultSize, 38977 style = CLRP_DEFAULT_STYLE, 38978 validator = wx.DefaultValidator, 38979 name = "colourpickerwidget"): 38980 38981 wx.BitmapButton.__init__(self, parent, id, wx.Bitmap(1,1), 38982 pos, size, style, validator, name) 38983 self.SetColour(colour) 38984 self.InvalidateBestSize() 38985 self.SetInitialSize(size) 38986 self.Bind(wx.EVT_BUTTON, self.OnButtonClick) 38987 38988 if ColourPickerCtrl._colourData is None: 38989 ColourPickerCtrl._colourData = wx.ColourData() 38990 ColourPickerCtrl._colourData.SetChooseFull(True) 38991 grey = 0 38992 for i in range(16): 38993 c = wx.Colour(grey, grey, grey) 38994 ColourPickerCtrl._colourData.SetCustomColour(i, c) 38995 grey += 16 38996 38997 def SetColour(self, colour): 38998 # force a copy, in case the _colorData is shared 38999 self.colour = wx.Colour(colour) 39000 bmp = self._makeBitmap() 39001 self.SetBitmapLabel(bmp) 39002 39003 def GetColour(self): 39004 return self.colour 39005 39006 def OnButtonClick(self, evt): 39007 ColourPickerCtrl._colourData.SetColour(self.colour) 39008 dlg = wx.ColourDialog(self, ColourPickerCtrl._colourData) 39009 if dlg.ShowModal() == wx.ID_OK: 39010 ColourPickerCtrl._colourData = dlg.GetColourData() 39011 self.SetColour(ColourPickerCtrl._colourData.GetColour()) 39012 evt = wx.ColourPickerEvent(self, self.GetId(), self.GetColour()) 39013 self.GetEventHandler().ProcessEvent(evt) 39014 39015 def _makeBitmap(self): 39016 width = height = 24 39017 bg = self.GetColour() 39018 if self.HasFlag(CLRP_SHOW_LABEL): 39019 w, h = self.GetTextExtent(bg.GetAsString(wx.C2S_HTML_SYNTAX)) 39020 width += w 39021 bmp = wx.Bitmap(width, height) 39022 dc = wx.MemoryDC(bmp) 39023 dc.SetBackground(wx.Brush(self.colour)) 39024 dc.Clear() 39025 if self.HasFlag(CLRP_SHOW_LABEL): 39026 from wx.lib.colourutils import BestLabelColour 39027 fg = BestLabelColour(bg) 39028 dc.SetTextForeground(fg) 39029 dc.DrawText(bg.GetAsString(wx.C2S_HTML_SYNTAX), 39030 (width - w)/2, (height - h)/2) 39031 return bmp 39032 39033 #-------------------------------------------------- 39034 39035 def __init__(self, parent, id=-1, colour=wx.BLACK, 39036 pos=wx.DefaultPosition, size=wx.DefaultSize, 39037 style = CLRP_DEFAULT_STYLE, 39038 validator = wx.DefaultValidator, 39039 name = "colourpicker"): 39040 if type(colour) != wx.Colour: 39041 colour = wx.Colour(colour) 39042 wx.PickerBase.__init__(self) 39043 self.CreateBase(parent, id, colour.GetAsString(), 39044 pos, size, style, validator, name) 39045 widget = ColourPickerCtrl.ColourPickerButton( 39046 self, -1, colour, style=self.GetPickerStyle(style)) 39047 self.SetPickerCtrl(widget) 39048 widget.Bind(wx.EVT_COLOURPICKER_CHANGED, self.OnColourChange) 39049 self.PostCreation() 39050 39051 39052 def GetColour(self): 39053 '''Set the displayed colour.''' 39054 return self.GetPickerCtrl().GetColour() 39055 39056 def SetColour(self, colour): 39057 '''Returns the currently selected colour.''' 39058 self.GetPickerCtrl().SetColour(colour) 39059 self.UpdateTextCtrlFromPicker() 39060 Colour = property(GetColour, SetColour) 39061 39062 39063 def UpdatePickerFromTextCtrl(self): 39064 col = wx.Colour(self.GetTextCtrl().GetValue()) 39065 if not col.IsOk(): 39066 return 39067 if self.GetColour() != col: 39068 self.GetPickerCtrl().SetColour(col) 39069 evt = wx.ColourPickerEvent(self, self.GetId(), self.GetColour()) 39070 self.GetEventHandler().ProcessEvent(evt) 39071 39072 def UpdateTextCtrlFromPicker(self): 39073 if not self.GetTextCtrl(): 39074 return 39075 self.GetTextCtrl().SetValue(self.GetColour().GetAsString()) 39076 39077 def GetPickerStyle(self, style): 39078 return style & CLRP_SHOW_LABEL 39079 39080 def OnColourChange(self, evt): 39081 self.UpdateTextCtrlFromPicker() 39082 evt = wx.ColourPickerEvent(self, self.GetId(), self.GetColour()) 39083 self.GetEventHandler().ProcessEvent(evt) 39084#-- end-pickers --# 39085#-- begin-filectrl --# 39086FC_DEFAULT_STYLE = 0 39087FC_OPEN = 0 39088FC_SAVE = 0 39089FC_MULTIPLE = 0 39090FC_NOSHOWHIDDEN = 0 39091wxEVT_FILECTRL_SELECTIONCHANGED = 0 39092wxEVT_FILECTRL_FILEACTIVATED = 0 39093wxEVT_FILECTRL_FOLDERCHANGED = 0 39094wxEVT_FILECTRL_FILTERCHANGED = 0 39095FileCtrlNameStr = "" 39096 39097class FileCtrl(Control): 39098 """ 39099 FileCtrl() 39100 FileCtrl(parent, id=ID_ANY, defaultDirectory=EmptyString, defaultFilename=EmptyString, wildCard=FileSelectorDefaultWildcardStr, style=FC_DEFAULT_STYLE, pos=DefaultPosition, size=DefaultSize, name=FileCtrlNameStr) 39101 39102 This control allows the user to select a file. 39103 """ 39104 39105 def __init__(self, *args, **kw): 39106 """ 39107 FileCtrl() 39108 FileCtrl(parent, id=ID_ANY, defaultDirectory=EmptyString, defaultFilename=EmptyString, wildCard=FileSelectorDefaultWildcardStr, style=FC_DEFAULT_STYLE, pos=DefaultPosition, size=DefaultSize, name=FileCtrlNameStr) 39109 39110 This control allows the user to select a file. 39111 """ 39112 39113 def Create(self, parent, id=ID_ANY, defaultDirectory=EmptyString, defaultFilename=EmptyString, wildCard=FileSelectorDefaultWildcardStr, style=FC_DEFAULT_STYLE, pos=DefaultPosition, size=DefaultSize, name=FileCtrlNameStr): 39114 """ 39115 Create(parent, id=ID_ANY, defaultDirectory=EmptyString, defaultFilename=EmptyString, wildCard=FileSelectorDefaultWildcardStr, style=FC_DEFAULT_STYLE, pos=DefaultPosition, size=DefaultSize, name=FileCtrlNameStr) -> bool 39116 39117 Create function for two-step construction. 39118 """ 39119 39120 def GetDirectory(self): 39121 """ 39122 GetDirectory() -> String 39123 39124 Returns the current directory of the file control (i.e. the directory 39125 shown by it). 39126 """ 39127 39128 def GetFilename(self): 39129 """ 39130 GetFilename() -> String 39131 39132 Returns the currently selected filename. 39133 """ 39134 39135 def GetFilenames(self): 39136 """ 39137 GetFilenames() -> ArrayString 39138 39139 Returns a list of filenames selected in the control. This function 39140 should only be used with controls which have the wx.FC_MULTIPLE style, 39141 use GetFilename for the others. 39142 """ 39143 39144 def GetFilterIndex(self): 39145 """ 39146 GetFilterIndex() -> int 39147 39148 Returns the zero-based index of the currently selected filter. 39149 """ 39150 39151 def GetPath(self): 39152 """ 39153 GetPath() -> String 39154 39155 Returns the full path (directory and filename) of the currently 39156 selected file. 39157 """ 39158 39159 def GetPaths(self): 39160 """ 39161 GetPaths() -> ArrayString 39162 39163 Returns a list of the full paths (directory and filename) of the files 39164 chosen. This function should only be used with controlss which have 39165 the wx.FC_MULTIPLE style, use GetPath for the others. 39166 """ 39167 39168 def GetWildcard(self): 39169 """ 39170 GetWildcard() -> String 39171 39172 Returns the current wildcard. 39173 """ 39174 39175 def SetDirectory(self, directory): 39176 """ 39177 SetDirectory(directory) -> bool 39178 39179 Sets(changes) the current directory displayed in the control. 39180 """ 39181 39182 def SetFilename(self, filename): 39183 """ 39184 SetFilename(filename) -> bool 39185 39186 Selects a certain file. 39187 """ 39188 39189 def SetPath(self, path): 39190 """ 39191 SetPath(path) -> bool 39192 39193 Changes to a certain directory and selects a certain file. 39194 """ 39195 39196 def SetFilterIndex(self, filterIndex): 39197 """ 39198 SetFilterIndex(filterIndex) 39199 39200 Sets the current filter index, starting from zero. 39201 """ 39202 39203 def SetWildcard(self, wildCard): 39204 """ 39205 SetWildcard(wildCard) 39206 39207 Sets the wildcard, which can contain multiple file types, for example: 39208 "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif". 39209 """ 39210 39211 def ShowHidden(self, show): 39212 """ 39213 ShowHidden(show) 39214 39215 Sets whether hidden files and folders are shown or not. 39216 """ 39217 39218 @staticmethod 39219 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 39220 """ 39221 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 39222 """ 39223 Directory = property(None, None) 39224 Filename = property(None, None) 39225 Filenames = property(None, None) 39226 FilterIndex = property(None, None) 39227 Path = property(None, None) 39228 Paths = property(None, None) 39229 Wildcard = property(None, None) 39230# end of class FileCtrl 39231 39232 39233class FileCtrlEvent(CommandEvent): 39234 """ 39235 FileCtrlEvent(type, evtObject, id) 39236 39237 A file control event holds information about events associated with 39238 wxFileCtrl objects. 39239 """ 39240 39241 def __init__(self, type, evtObject, id): 39242 """ 39243 FileCtrlEvent(type, evtObject, id) 39244 39245 A file control event holds information about events associated with 39246 wxFileCtrl objects. 39247 """ 39248 39249 def GetDirectory(self): 39250 """ 39251 GetDirectory() -> String 39252 39253 Returns the current directory. 39254 """ 39255 39256 def GetFile(self): 39257 """ 39258 GetFile() -> String 39259 39260 Returns the file selected (assuming it is only one file). 39261 """ 39262 39263 def GetFiles(self): 39264 """ 39265 GetFiles() -> ArrayString 39266 39267 Returns the files selected. 39268 """ 39269 39270 def GetFilterIndex(self): 39271 """ 39272 GetFilterIndex() -> int 39273 39274 Returns the current file filter index. 39275 """ 39276 39277 def SetFiles(self, files): 39278 """ 39279 SetFiles(files) 39280 39281 Sets the files changed by this event. 39282 """ 39283 39284 def SetDirectory(self, directory): 39285 """ 39286 SetDirectory(directory) 39287 39288 Sets the directory of this event. 39289 """ 39290 39291 def SetFilterIndex(self, index): 39292 """ 39293 SetFilterIndex(index) 39294 39295 Sets the filter index changed by this event. 39296 """ 39297 Directory = property(None, None) 39298 File = property(None, None) 39299 Files = property(None, None) 39300 FilterIndex = property(None, None) 39301# end of class FileCtrlEvent 39302 39303 39304EVT_FILECTRL_SELECTIONCHANGED = wx.PyEventBinder( wxEVT_FILECTRL_SELECTIONCHANGED, 1) 39305EVT_FILECTRL_FILEACTIVATED = wx.PyEventBinder( wxEVT_FILECTRL_FILEACTIVATED, 1) 39306EVT_FILECTRL_FOLDERCHANGED = wx.PyEventBinder( wxEVT_FILECTRL_FOLDERCHANGED, 1) 39307EVT_FILECTRL_FILTERCHANGED = wx.PyEventBinder( wxEVT_FILECTRL_FILTERCHANGED, 1) 39308#-- end-filectrl --# 39309#-- begin-combo --# 39310CC_SPECIAL_DCLICK = 0 39311CC_STD_BUTTON = 0 39312 39313class ComboPopup(object): 39314 """ 39315 ComboPopup() 39316 39317 In order to use a custom popup with wxComboCtrl, an interface class 39318 must be derived from wxComboPopup. 39319 """ 39320 39321 def __init__(self): 39322 """ 39323 ComboPopup() 39324 39325 In order to use a custom popup with wxComboCtrl, an interface class 39326 must be derived from wxComboPopup. 39327 """ 39328 39329 def Create(self, parent): 39330 """ 39331 Create(parent) -> bool 39332 39333 The derived class must implement this to create the popup control. 39334 """ 39335 39336 def DestroyPopup(self): 39337 """ 39338 DestroyPopup() 39339 39340 You only need to implement this member function if you create your 39341 popup class in non-standard way. 39342 """ 39343 39344 def Dismiss(self): 39345 """ 39346 Dismiss() 39347 39348 Utility function that hides the popup. 39349 """ 39350 39351 def FindItem(self, item, trueItem=None): 39352 """ 39353 FindItem(item, trueItem=None) -> bool 39354 39355 Implement to customize matching of value string to an item container 39356 entry. 39357 """ 39358 39359 def GetAdjustedSize(self, minWidth, prefHeight, maxHeight): 39360 """ 39361 GetAdjustedSize(minWidth, prefHeight, maxHeight) -> Size 39362 39363 The derived class may implement this to return adjusted size for the 39364 popup control, according to the variables given. 39365 """ 39366 39367 def GetComboCtrl(self): 39368 """ 39369 GetComboCtrl() -> ComboCtrl 39370 39371 Returns pointer to the associated parent wxComboCtrl. 39372 """ 39373 39374 def GetControl(self): 39375 """ 39376 GetControl() -> Window 39377 39378 The derived class must implement this to return pointer to the 39379 associated control created in Create(). 39380 """ 39381 39382 def GetStringValue(self): 39383 """ 39384 GetStringValue() -> String 39385 39386 The derived class must implement this to return string representation 39387 of the value. 39388 """ 39389 39390 def Init(self): 39391 """ 39392 Init() 39393 39394 The derived class must implement this to initialize its internal 39395 variables. 39396 """ 39397 39398 def IsCreated(self): 39399 """ 39400 IsCreated() -> bool 39401 39402 Utility method that returns true if Create has been called. 39403 """ 39404 39405 def LazyCreate(self): 39406 """ 39407 LazyCreate() -> bool 39408 39409 The derived class may implement this to return true if it wants to 39410 delay call to Create() until the popup is shown for the first time. 39411 """ 39412 39413 def OnComboDoubleClick(self): 39414 """ 39415 OnComboDoubleClick() 39416 39417 The derived class may implement this to do something when the parent 39418 wxComboCtrl gets double-clicked. 39419 """ 39420 39421 def OnComboKeyEvent(self, event): 39422 """ 39423 OnComboKeyEvent(event) 39424 39425 The derived class may implement this to receive key events from the 39426 parent wxComboCtrl. 39427 """ 39428 39429 def OnDismiss(self): 39430 """ 39431 OnDismiss() 39432 39433 The derived class may implement this to do special processing when 39434 popup is hidden. 39435 """ 39436 39437 def OnPopup(self): 39438 """ 39439 OnPopup() 39440 39441 The derived class may implement this to do special processing when 39442 popup is shown. 39443 """ 39444 39445 def PaintComboControl(self, dc, rect): 39446 """ 39447 PaintComboControl(dc, rect) 39448 39449 The derived class may implement this to paint the parent wxComboCtrl. 39450 """ 39451 39452 def SetStringValue(self, value): 39453 """ 39454 SetStringValue(value) 39455 39456 The derived class must implement this to receive string value changes 39457 from wxComboCtrl. 39458 """ 39459 ComboCtrl = property(None, None) 39460 Control = property(None, None) 39461 StringValue = property(None, None) 39462# end of class ComboPopup 39463 39464 39465class ComboCtrlFeatures(object): 39466 """ 39467 Features enabled for wxComboCtrl. 39468 """ 39469 MovableButton = 0 39470 BitmapButton = 0 39471 ButtonSpacing = 0 39472 TextIndent = 0 39473 PaintControl = 0 39474 PaintWritable = 0 39475 Borderless = 0 39476 All = 0 39477# end of class ComboCtrlFeatures 39478 39479 39480class ComboCtrl(Control, TextEntry): 39481 """ 39482 ComboCtrl() 39483 ComboCtrl(parent, id=ID_ANY, value=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, validator=DefaultValidator, name=ComboBoxNameStr) 39484 39485 A combo control is a generic combobox that allows totally custom 39486 popup. 39487 """ 39488 39489 def __init__(self, *args, **kw): 39490 """ 39491 ComboCtrl() 39492 ComboCtrl(parent, id=ID_ANY, value=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, validator=DefaultValidator, name=ComboBoxNameStr) 39493 39494 A combo control is a generic combobox that allows totally custom 39495 popup. 39496 """ 39497 39498 def SetMargins(self, *args, **kw): 39499 """ 39500 SetMargins(pt) -> bool 39501 SetMargins(left, top=-1) -> bool 39502 39503 Attempts to set the control margins. 39504 """ 39505 39506 def Copy(self): 39507 """ 39508 Copy() 39509 39510 Copies the selected text to the clipboard. 39511 """ 39512 39513 def Create(self, parent, id=ID_ANY, value=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, validator=DefaultValidator, name=ComboBoxNameStr): 39514 """ 39515 Create(parent, id=ID_ANY, value=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, validator=DefaultValidator, name=ComboBoxNameStr) -> bool 39516 39517 Creates the combo control for two-step construction. 39518 """ 39519 39520 def Cut(self): 39521 """ 39522 Cut() 39523 39524 Copies the selected text to the clipboard and removes the selection. 39525 """ 39526 39527 def Dismiss(self): 39528 """ 39529 Dismiss() 39530 39531 Dismisses the popup window. 39532 """ 39533 39534 def EnablePopupAnimation(self, enable=True): 39535 """ 39536 EnablePopupAnimation(enable=True) 39537 39538 Enables or disables popup animation, if any, depending on the value of 39539 the argument. 39540 """ 39541 39542 def IsKeyPopupToggle(self, event): 39543 """ 39544 IsKeyPopupToggle(event) -> bool 39545 39546 Returns true if given key combination should toggle the popup. 39547 """ 39548 39549 def PrepareBackground(self, dc, rect, flags): 39550 """ 39551 PrepareBackground(dc, rect, flags) 39552 39553 Prepare background of combo control or an item in a dropdown list in a 39554 way typical on platform. 39555 """ 39556 39557 def ShouldDrawFocus(self): 39558 """ 39559 ShouldDrawFocus() -> bool 39560 39561 Returns true if focus indicator should be drawn in the control. 39562 """ 39563 39564 def GetBitmapDisabled(self): 39565 """ 39566 GetBitmapDisabled() -> Bitmap 39567 39568 Returns disabled button bitmap that has been set with 39569 SetButtonBitmaps(). 39570 """ 39571 39572 def GetBitmapHover(self): 39573 """ 39574 GetBitmapHover() -> Bitmap 39575 39576 Returns button mouse hover bitmap that has been set with 39577 SetButtonBitmaps(). 39578 """ 39579 39580 def GetBitmapNormal(self): 39581 """ 39582 GetBitmapNormal() -> Bitmap 39583 39584 Returns default button bitmap that has been set with 39585 SetButtonBitmaps(). 39586 """ 39587 39588 def GetBitmapPressed(self): 39589 """ 39590 GetBitmapPressed() -> Bitmap 39591 39592 Returns depressed button bitmap that has been set with 39593 SetButtonBitmaps(). 39594 """ 39595 39596 def GetButtonSize(self): 39597 """ 39598 GetButtonSize() -> Size 39599 39600 Returns current size of the dropdown button. 39601 """ 39602 39603 def GetCustomPaintWidth(self): 39604 """ 39605 GetCustomPaintWidth() -> int 39606 39607 Returns custom painted area in control. 39608 """ 39609 39610 def GetHint(self): 39611 """ 39612 GetHint() -> String 39613 39614 Returns the current hint string. 39615 """ 39616 39617 def GetInsertionPoint(self): 39618 """ 39619 GetInsertionPoint() -> long 39620 39621 Returns the insertion point for the combo control's text field. 39622 """ 39623 39624 def GetLastPosition(self): 39625 """ 39626 GetLastPosition() -> long 39627 39628 Returns the last position in the combo control text field. 39629 """ 39630 39631 def GetMargins(self): 39632 """ 39633 GetMargins() -> Point 39634 39635 Returns the margins used by the control. 39636 """ 39637 39638 def GetPopupControl(self): 39639 """ 39640 GetPopupControl() -> ComboPopup 39641 39642 Returns current popup interface that has been set with 39643 SetPopupControl(). 39644 """ 39645 39646 def GetPopupWindow(self): 39647 """ 39648 GetPopupWindow() -> Window 39649 39650 Returns popup window containing the popup control. 39651 """ 39652 39653 def GetTextCtrl(self): 39654 """ 39655 GetTextCtrl() -> TextCtrl 39656 39657 Get the text control which is part of the combo control. 39658 """ 39659 39660 def GetTextIndent(self): 39661 """ 39662 GetTextIndent() -> Coord 39663 39664 Returns actual indentation in pixels. 39665 """ 39666 39667 def GetTextRect(self): 39668 """ 39669 GetTextRect() -> Rect 39670 39671 Returns area covered by the text field (includes everything except 39672 borders and the dropdown button). 39673 """ 39674 39675 def GetValue(self): 39676 """ 39677 GetValue() -> String 39678 39679 Returns text representation of the current value. 39680 """ 39681 39682 def HidePopup(self, generateEvent=False): 39683 """ 39684 HidePopup(generateEvent=False) 39685 39686 Dismisses the popup window. 39687 """ 39688 39689 def IsPopupShown(self): 39690 """ 39691 IsPopupShown() -> bool 39692 39693 Returns true if the popup is currently shown. 39694 """ 39695 39696 def IsPopupWindowState(self, state): 39697 """ 39698 IsPopupWindowState(state) -> bool 39699 39700 Returns true if the popup window is in the given state. 39701 """ 39702 39703 def OnButtonClick(self): 39704 """ 39705 OnButtonClick() 39706 39707 Implement in a derived class to define what happens on dropdown button 39708 click. 39709 """ 39710 39711 def Paste(self): 39712 """ 39713 Paste() 39714 39715 Pastes text from the clipboard to the text field. 39716 """ 39717 39718 def Popup(self): 39719 """ 39720 Popup() 39721 39722 Shows the popup portion of the combo control. 39723 """ 39724 39725 def Remove(self, frm, to): 39726 """ 39727 Remove(frm, to) 39728 39729 Removes the text between the two positions in the combo control text 39730 field. 39731 """ 39732 39733 def Replace(self, frm, to, text): 39734 """ 39735 Replace(frm, to, text) 39736 39737 Replaces the text between two positions with the given text, in the 39738 combo control text field. 39739 """ 39740 39741 def SetButtonBitmaps(self, bmpNormal, pushButtonBg=False, bmpPressed=NullBitmap, bmpHover=NullBitmap, bmpDisabled=NullBitmap): 39742 """ 39743 SetButtonBitmaps(bmpNormal, pushButtonBg=False, bmpPressed=NullBitmap, bmpHover=NullBitmap, bmpDisabled=NullBitmap) 39744 39745 Sets custom dropdown button graphics. 39746 """ 39747 39748 def SetButtonPosition(self, width=-1, height=-1, side=RIGHT, spacingX=0): 39749 """ 39750 SetButtonPosition(width=-1, height=-1, side=RIGHT, spacingX=0) 39751 39752 Sets size and position of dropdown button. 39753 """ 39754 39755 def SetCustomPaintWidth(self, width): 39756 """ 39757 SetCustomPaintWidth(width) 39758 39759 Set width, in pixels, of custom painted area in control without 39760 wxCB_READONLY style. 39761 """ 39762 39763 def SetHint(self, hint): 39764 """ 39765 SetHint(hint) -> bool 39766 39767 Sets a hint shown in an empty unfocused combo control. 39768 """ 39769 39770 def SetInsertionPoint(self, pos): 39771 """ 39772 SetInsertionPoint(pos) 39773 39774 Sets the insertion point in the text field. 39775 """ 39776 39777 def SetInsertionPointEnd(self): 39778 """ 39779 SetInsertionPointEnd() 39780 39781 Sets the insertion point at the end of the combo control text field. 39782 """ 39783 39784 def SetPopupAnchor(self, anchorSide): 39785 """ 39786 SetPopupAnchor(anchorSide) 39787 39788 Set side of the control to which the popup will align itself. 39789 """ 39790 39791 def SetPopupControl(self, popup): 39792 """ 39793 SetPopupControl(popup) 39794 39795 Set popup interface class derived from wxComboPopup. 39796 """ 39797 39798 def SetPopupExtents(self, extLeft, extRight): 39799 """ 39800 SetPopupExtents(extLeft, extRight) 39801 39802 Extends popup size horizontally, relative to the edges of the combo 39803 control. 39804 """ 39805 39806 def SetPopupMaxHeight(self, height): 39807 """ 39808 SetPopupMaxHeight(height) 39809 39810 Sets preferred maximum height of the popup. 39811 """ 39812 39813 def SetPopupMinWidth(self, width): 39814 """ 39815 SetPopupMinWidth(width) 39816 39817 Sets minimum width of the popup. 39818 """ 39819 39820 def SetSelection(self, frm, to): 39821 """ 39822 SetSelection(frm, to) 39823 39824 Selects the text between the two positions, in the combo control text 39825 field. 39826 """ 39827 39828 def SetText(self, value): 39829 """ 39830 SetText(value) 39831 39832 Sets the text for the text field without affecting the popup. 39833 """ 39834 39835 def SetTextCtrlStyle(self, style): 39836 """ 39837 SetTextCtrlStyle(style) 39838 39839 Set a custom window style for the embedded wxTextCtrl. 39840 """ 39841 39842 def SetTextIndent(self, indent): 39843 """ 39844 SetTextIndent(indent) 39845 39846 This will set the space in pixels between left edge of the control and 39847 the text, regardless whether control is read-only or not. 39848 """ 39849 39850 def SetValue(self, value): 39851 """ 39852 SetValue(value) 39853 39854 Sets the text for the combo control text field. 39855 """ 39856 39857 def SetValueByUser(self, value): 39858 """ 39859 SetValueByUser(value) 39860 39861 Changes value of the control as if user had done it by selecting an 39862 item from a combo box drop-down list. 39863 """ 39864 39865 def ShowPopup(self): 39866 """ 39867 ShowPopup() 39868 39869 Show the popup. 39870 """ 39871 39872 def Undo(self): 39873 """ 39874 Undo() 39875 39876 Undoes the last edit in the text field. 39877 """ 39878 39879 def UseAltPopupWindow(self, enable=True): 39880 """ 39881 UseAltPopupWindow(enable=True) 39882 39883 Enable or disable usage of an alternative popup window, which 39884 guarantees ability to focus the popup control, and allows common 39885 native controls to function normally. 39886 """ 39887 39888 @staticmethod 39889 def GetFeatures(): 39890 """ 39891 GetFeatures() -> int 39892 39893 Returns features supported by wxComboCtrl. 39894 """ 39895 39896 @staticmethod 39897 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 39898 """ 39899 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 39900 """ 39901 BitmapDisabled = property(None, None) 39902 BitmapHover = property(None, None) 39903 BitmapNormal = property(None, None) 39904 BitmapPressed = property(None, None) 39905 ButtonSize = property(None, None) 39906 CustomPaintWidth = property(None, None) 39907 Hint = property(None, None) 39908 InsertionPoint = property(None, None) 39909 LastPosition = property(None, None) 39910 Margins = property(None, None) 39911 PopupControl = property(None, None) 39912 PopupWindow = property(None, None) 39913 TextCtrl = property(None, None) 39914 TextIndent = property(None, None) 39915 TextRect = property(None, None) 39916 Value = property(None, None) 39917 39918 def AnimateShow(self, rect, flags): 39919 """ 39920 AnimateShow(rect, flags) -> bool 39921 39922 This member function is not normally called in application code. 39923 """ 39924 39925 def DoSetPopupControl(self, popup): 39926 """ 39927 DoSetPopupControl(popup) 39928 39929 This member function is not normally called in application code. 39930 """ 39931 39932 def DoShowPopup(self, rect, flags): 39933 """ 39934 DoShowPopup(rect, flags) 39935 39936 This member function is not normally called in application code. 39937 """ 39938# end of class ComboCtrl 39939 39940#-- end-combo --# 39941#-- begin-choicebk --# 39942CHB_DEFAULT = 0 39943CHB_TOP = 0 39944CHB_BOTTOM = 0 39945CHB_LEFT = 0 39946CHB_RIGHT = 0 39947CHB_ALIGN_MASK = 0 39948wxEVT_CHOICEBOOK_PAGE_CHANGED = 0 39949wxEVT_CHOICEBOOK_PAGE_CHANGING = 0 39950 39951class Choicebook(BookCtrlBase): 39952 """ 39953 Choicebook() 39954 Choicebook(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=EmptyString) 39955 39956 wxChoicebook is a class similar to wxNotebook, but uses a wxChoice 39957 control to show the labels instead of the tabs. 39958 """ 39959 39960 def __init__(self, *args, **kw): 39961 """ 39962 Choicebook() 39963 Choicebook(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=EmptyString) 39964 39965 wxChoicebook is a class similar to wxNotebook, but uses a wxChoice 39966 control to show the labels instead of the tabs. 39967 """ 39968 39969 def Create(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=EmptyString): 39970 """ 39971 Create(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=EmptyString) -> bool 39972 39973 Create the choicebook control that has already been constructed with 39974 the default constructor. 39975 """ 39976 39977 def GetChoiceCtrl(self, *args, **kw): 39978 """ 39979 GetChoiceCtrl() -> Choice 39980 GetChoiceCtrl() -> Choice 39981 39982 Returns the wxChoice associated with the control. 39983 """ 39984 39985 @staticmethod 39986 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 39987 """ 39988 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 39989 """ 39990 ChoiceCtrl = property(None, None) 39991# end of class Choicebook 39992 39993 39994EVT_CHOICEBOOK_PAGE_CHANGED = wx.PyEventBinder( wxEVT_CHOICEBOOK_PAGE_CHANGED, 1 ) 39995EVT_CHOICEBOOK_PAGE_CHANGING = wx.PyEventBinder( wxEVT_CHOICEBOOK_PAGE_CHANGING, 1 ) 39996 39997# deprecated wxEVT aliases 39998wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGED = wxEVT_CHOICEBOOK_PAGE_CHANGED 39999wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGING = wxEVT_CHOICEBOOK_PAGE_CHANGING 40000#-- end-choicebk --# 40001#-- begin-listbook --# 40002LB_DEFAULT = 0 40003LB_TOP = 0 40004LB_BOTTOM = 0 40005LB_LEFT = 0 40006LB_RIGHT = 0 40007LB_ALIGN_MASK = 0 40008wxEVT_LISTBOOK_PAGE_CHANGED = 0 40009wxEVT_LISTBOOK_PAGE_CHANGING = 0 40010 40011class Listbook(BookCtrlBase): 40012 """ 40013 Listbook() 40014 Listbook(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=EmptyString) 40015 40016 wxListbook is a class similar to wxNotebook but which uses a 40017 wxListCtrl to show the labels instead of the tabs. 40018 """ 40019 40020 def __init__(self, *args, **kw): 40021 """ 40022 Listbook() 40023 Listbook(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=EmptyString) 40024 40025 wxListbook is a class similar to wxNotebook but which uses a 40026 wxListCtrl to show the labels instead of the tabs. 40027 """ 40028 40029 def Create(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=EmptyString): 40030 """ 40031 Create(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=EmptyString) -> bool 40032 40033 Create the list book control that has already been constructed with 40034 the default constructor. 40035 """ 40036 40037 def GetListView(self, *args, **kw): 40038 """ 40039 GetListView() -> ListView 40040 GetListView() -> ListView 40041 40042 Returns the wxListView associated with the control. 40043 """ 40044 40045 @staticmethod 40046 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 40047 """ 40048 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 40049 """ 40050 ListView = property(None, None) 40051# end of class Listbook 40052 40053 40054EVT_LISTBOOK_PAGE_CHANGED = wx.PyEventBinder( wxEVT_LISTBOOK_PAGE_CHANGED, 1 ) 40055EVT_LISTBOOK_PAGE_CHANGING = wx.PyEventBinder( wxEVT_LISTBOOK_PAGE_CHANGING, 1 ) 40056 40057# deprecated wxEVT aliases 40058wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED = wxEVT_LISTBOOK_PAGE_CHANGED 40059wxEVT_COMMAND_LISTBOOK_PAGE_CHANGING = wxEVT_LISTBOOK_PAGE_CHANGING 40060#-- end-listbook --# 40061#-- begin-toolbook --# 40062TBK_BUTTONBAR = 0 40063TBK_HORZ_LAYOUT = 0 40064wxEVT_TOOLBOOK_PAGE_CHANGED = 0 40065wxEVT_TOOLBOOK_PAGE_CHANGING = 0 40066 40067class Toolbook(BookCtrlBase): 40068 """ 40069 Toolbook() 40070 Toolbook(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=EmptyString) 40071 40072 wxToolbook is a class similar to wxNotebook but which uses a wxToolBar 40073 to show the labels instead of the tabs. 40074 """ 40075 40076 def __init__(self, *args, **kw): 40077 """ 40078 Toolbook() 40079 Toolbook(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=EmptyString) 40080 40081 wxToolbook is a class similar to wxNotebook but which uses a wxToolBar 40082 to show the labels instead of the tabs. 40083 """ 40084 40085 def Create(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=EmptyString): 40086 """ 40087 Create(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=EmptyString) -> bool 40088 40089 Create the tool book control that has already been constructed with 40090 the default constructor. 40091 """ 40092 40093 def GetToolBar(self): 40094 """ 40095 GetToolBar() -> ToolBar 40096 40097 Return the toolbar used for page selection. 40098 """ 40099 40100 @staticmethod 40101 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 40102 """ 40103 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 40104 """ 40105 ToolBar = property(None, None) 40106# end of class Toolbook 40107 40108 40109EVT_TOOLBOOK_PAGE_CHANGED = wx.PyEventBinder( wxEVT_TOOLBOOK_PAGE_CHANGED, 1 ) 40110EVT_TOOLBOOK_PAGE_CHANGING = wx.PyEventBinder( wxEVT_TOOLBOOK_PAGE_CHANGING, 1 ) 40111 40112# deprecated wxEVT aliases 40113wxEVT_COMMAND_TOOLBOOK_PAGE_CHANGED = wxEVT_TOOLBOOK_PAGE_CHANGED 40114wxEVT_COMMAND_TOOLBOOK_PAGE_CHANGING = wxEVT_TOOLBOOK_PAGE_CHANGING 40115#-- end-toolbook --# 40116#-- begin-treebook --# 40117wxEVT_TREEBOOK_PAGE_CHANGED = 0 40118wxEVT_TREEBOOK_PAGE_CHANGING = 0 40119wxEVT_TREEBOOK_NODE_COLLAPSED = 0 40120wxEVT_TREEBOOK_NODE_EXPANDED = 0 40121 40122class Treebook(BookCtrlBase): 40123 """ 40124 Treebook() 40125 Treebook(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=BK_DEFAULT, name=EmptyString) 40126 40127 This class is an extension of the wxNotebook class that allows a tree 40128 structured set of pages to be shown in a control. 40129 """ 40130 40131 def __init__(self, *args, **kw): 40132 """ 40133 Treebook() 40134 Treebook(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=BK_DEFAULT, name=EmptyString) 40135 40136 This class is an extension of the wxNotebook class that allows a tree 40137 structured set of pages to be shown in a control. 40138 """ 40139 40140 def AddPage(self, page, text, bSelect=False, imageId=NOT_FOUND): 40141 """ 40142 AddPage(page, text, bSelect=False, imageId=NOT_FOUND) -> bool 40143 40144 Adds a new page. 40145 """ 40146 40147 def AddSubPage(self, page, text, bSelect=False, imageId=NOT_FOUND): 40148 """ 40149 AddSubPage(page, text, bSelect=False, imageId=NOT_FOUND) -> bool 40150 40151 Adds a new child-page to the last top-level page. 40152 """ 40153 40154 def CollapseNode(self, pageId): 40155 """ 40156 CollapseNode(pageId) -> bool 40157 40158 Shortcut for ExpandNode( pageId, false ). 40159 """ 40160 40161 def Create(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=BK_DEFAULT, name=EmptyString): 40162 """ 40163 Create(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=BK_DEFAULT, name=EmptyString) -> bool 40164 40165 Creates a treebook control. 40166 """ 40167 40168 def DeletePage(self, pagePos): 40169 """ 40170 DeletePage(pagePos) -> bool 40171 40172 Deletes the page at the specified position and all its children. 40173 """ 40174 40175 def ExpandNode(self, pageId, expand=True): 40176 """ 40177 ExpandNode(pageId, expand=True) -> bool 40178 40179 Expands (collapses) the pageId node. 40180 """ 40181 40182 def GetPageParent(self, page): 40183 """ 40184 GetPageParent(page) -> int 40185 40186 Returns the parent page of the given one or wxNOT_FOUND if this is a 40187 top-level page. 40188 """ 40189 40190 def GetSelection(self): 40191 """ 40192 GetSelection() -> int 40193 40194 Returns the currently selected page, or wxNOT_FOUND if none was 40195 selected. 40196 """ 40197 40198 def InsertPage(self, pagePos, page, text, bSelect=False, imageId=NOT_FOUND): 40199 """ 40200 InsertPage(pagePos, page, text, bSelect=False, imageId=NOT_FOUND) -> bool 40201 40202 Inserts a new page just before the page indicated by pagePos. 40203 """ 40204 40205 def InsertSubPage(self, pagePos, page, text, bSelect=False, imageId=NOT_FOUND): 40206 """ 40207 InsertSubPage(pagePos, page, text, bSelect=False, imageId=NOT_FOUND) -> bool 40208 40209 Inserts a sub page under the specified page. 40210 """ 40211 40212 def IsNodeExpanded(self, pageId): 40213 """ 40214 IsNodeExpanded(pageId) -> bool 40215 40216 Returns true if the page represented by pageId is expanded. 40217 """ 40218 40219 @staticmethod 40220 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 40221 """ 40222 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 40223 """ 40224 40225 def GetTreeCtrl(self): 40226 """ 40227 GetTreeCtrl() -> TreeCtrl 40228 40229 Returns the tree control used for selecting pages. 40230 """ 40231 Selection = property(None, None) 40232 TreeCtrl = property(None, None) 40233# end of class Treebook 40234 40235 40236EVT_TREEBOOK_PAGE_CHANGED = wx.PyEventBinder( wxEVT_TREEBOOK_PAGE_CHANGED, 1 ) 40237EVT_TREEBOOK_PAGE_CHANGING = wx.PyEventBinder( wxEVT_TREEBOOK_PAGE_CHANGING, 1) 40238EVT_TREEBOOK_NODE_COLLAPSED = wx.PyEventBinder( wxEVT_TREEBOOK_NODE_COLLAPSED, 1 ) 40239EVT_TREEBOOK_NODE_EXPANDED = wx.PyEventBinder( wxEVT_TREEBOOK_NODE_EXPANDED, 1 ) 40240 40241# deprecated wxEVT aliases 40242wxEVT_COMMAND_TREEBOOK_PAGE_CHANGED = wxEVT_TREEBOOK_PAGE_CHANGED 40243wxEVT_COMMAND_TREEBOOK_PAGE_CHANGING = wxEVT_TREEBOOK_PAGE_CHANGING 40244wxEVT_COMMAND_TREEBOOK_NODE_COLLAPSED = wxEVT_TREEBOOK_NODE_COLLAPSED 40245wxEVT_COMMAND_TREEBOOK_NODE_EXPANDED = wxEVT_TREEBOOK_NODE_EXPANDED 40246#-- end-treebook --# 40247#-- begin-simplebook --# 40248 40249class Simplebook(BookCtrlBase): 40250 """ 40251 Simplebook() 40252 Simplebook(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=EmptyString) 40253 40254 wxSimplebook is a control showing exactly one of its several pages. 40255 """ 40256 40257 def __init__(self, *args, **kw): 40258 """ 40259 Simplebook() 40260 Simplebook(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=EmptyString) 40261 40262 wxSimplebook is a control showing exactly one of its several pages. 40263 """ 40264 40265 def Create(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=EmptyString): 40266 """ 40267 Create(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=EmptyString) -> bool 40268 40269 Really create the window of an object created using default 40270 constructor. 40271 """ 40272 40273 def SetEffects(self, showEffect, hideEffect): 40274 """ 40275 SetEffects(showEffect, hideEffect) 40276 40277 Set the effects to use for showing and hiding the pages. 40278 """ 40279 40280 def SetEffect(self, effect): 40281 """ 40282 SetEffect(effect) 40283 40284 Set the same effect to use for both showing and hiding the pages. 40285 """ 40286 40287 def SetEffectsTimeouts(self, showTimeout, hideTimeout): 40288 """ 40289 SetEffectsTimeouts(showTimeout, hideTimeout) 40290 40291 Set the effect timeout to use for showing and hiding the pages. 40292 """ 40293 40294 def SetEffectTimeout(self, timeout): 40295 """ 40296 SetEffectTimeout(timeout) 40297 40298 Set the same effect timeout to use for both showing and hiding the 40299 pages. 40300 """ 40301 40302 def ShowNewPage(self, page): 40303 """ 40304 ShowNewPage(page) -> bool 40305 40306 Add a new page and show it immediately. 40307 """ 40308 40309 @staticmethod 40310 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 40311 """ 40312 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 40313 """ 40314# end of class Simplebook 40315 40316#-- end-simplebook --# 40317#-- begin-vlbox --# 40318VListBoxNameStr = "" 40319 40320class VListBox(VScrolledWindow): 40321 """ 40322 VListBox() 40323 VListBox(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=VListBoxNameStr) 40324 40325 wxVListBox is a wxListBox-like control with the following two main 40326 differences from a regular wxListBox: it can have an arbitrarily huge 40327 number of items because it doesn't store them itself but uses the 40328 OnDrawItem() callback to draw them (so it is a virtual listbox) and 40329 its items can have variable height as determined by OnMeasureItem() 40330 (so it is also a listbox with the lines of variable height). 40331 """ 40332 40333 def __init__(self, *args, **kw): 40334 """ 40335 VListBox() 40336 VListBox(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=VListBoxNameStr) 40337 40338 wxVListBox is a wxListBox-like control with the following two main 40339 differences from a regular wxListBox: it can have an arbitrarily huge 40340 number of items because it doesn't store them itself but uses the 40341 OnDrawItem() callback to draw them (so it is a virtual listbox) and 40342 its items can have variable height as determined by OnMeasureItem() 40343 (so it is also a listbox with the lines of variable height). 40344 """ 40345 40346 def SetMargins(self, *args, **kw): 40347 """ 40348 SetMargins(pt) 40349 SetMargins(x, y) 40350 40351 Set the margins: horizontal margin is the distance between the window 40352 border and the item contents while vertical margin is half of the 40353 distance between items. 40354 """ 40355 40356 def Clear(self): 40357 """ 40358 Clear() 40359 40360 Deletes all items from the control. 40361 """ 40362 40363 def Create(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=VListBoxNameStr): 40364 """ 40365 Create(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=VListBoxNameStr) -> bool 40366 40367 Creates the control. 40368 """ 40369 40370 def DeselectAll(self): 40371 """ 40372 DeselectAll() -> bool 40373 40374 Deselects all the items in the listbox. 40375 """ 40376 40377 def GetFirstSelected(self): 40378 """ 40379 GetFirstSelected() -> (int, cookie) 40380 40381 Returns the index of the first selected item in the listbox or 40382 wxNOT_FOUND if no items are currently selected. 40383 """ 40384 40385 def GetItemCount(self): 40386 """ 40387 GetItemCount() -> size_t 40388 40389 Get the number of items in the control. 40390 """ 40391 40392 def GetMargins(self): 40393 """ 40394 GetMargins() -> Point 40395 40396 Returns the margins used by the control. 40397 """ 40398 40399 def GetItemRect(self, item): 40400 """ 40401 GetItemRect(item) -> Rect 40402 40403 Returns the rectangle occupied by this item in physical coordinates. 40404 """ 40405 40406 def GetNextSelected(self, cookie): 40407 """ 40408 GetNextSelected(cookie) -> (int, cookie) 40409 40410 Returns the index of the next selected item or wxNOT_FOUND if there 40411 are no more. 40412 """ 40413 40414 def GetSelectedCount(self): 40415 """ 40416 GetSelectedCount() -> size_t 40417 40418 Returns the number of the items currently selected. 40419 """ 40420 40421 def GetSelection(self): 40422 """ 40423 GetSelection() -> int 40424 40425 Get the currently selected item or wxNOT_FOUND if there is no 40426 selection. 40427 """ 40428 40429 def GetSelectionBackground(self): 40430 """ 40431 GetSelectionBackground() -> Colour 40432 40433 Returns the background colour used for the selected cells. 40434 """ 40435 40436 def HasMultipleSelection(self): 40437 """ 40438 HasMultipleSelection() -> bool 40439 40440 Returns true if the listbox was created with wxLB_MULTIPLE style and 40441 so supports multiple selection or false if it is a single selection 40442 listbox. 40443 """ 40444 40445 def IsCurrent(self, item): 40446 """ 40447 IsCurrent(item) -> bool 40448 40449 Returns true if this item is the current one, false otherwise. 40450 """ 40451 40452 def IsSelected(self, item): 40453 """ 40454 IsSelected(item) -> bool 40455 40456 Returns true if this item is selected, false otherwise. 40457 """ 40458 40459 def Select(self, item, select=True): 40460 """ 40461 Select(item, select=True) -> bool 40462 40463 Selects or deselects the specified item which must be valid (i.e. not 40464 equal to wxNOT_FOUND). 40465 """ 40466 40467 def SelectAll(self): 40468 """ 40469 SelectAll() -> bool 40470 40471 Selects all the items in the listbox. 40472 """ 40473 40474 def SelectRange(self, from_, to_): 40475 """ 40476 SelectRange(from_, to_) -> bool 40477 40478 Selects all items in the specified range which may be given in any 40479 order. 40480 """ 40481 40482 def SetItemCount(self, count): 40483 """ 40484 SetItemCount(count) 40485 40486 Set the number of items to be shown in the control. 40487 """ 40488 40489 def SetSelection(self, selection): 40490 """ 40491 SetSelection(selection) 40492 40493 Set the selection to the specified item, if it is -1 the selection is 40494 unset. 40495 """ 40496 40497 def SetSelectionBackground(self, col): 40498 """ 40499 SetSelectionBackground(col) 40500 40501 Sets the colour to be used for the selected cells background. 40502 """ 40503 40504 def Toggle(self, item): 40505 """ 40506 Toggle(item) 40507 40508 Toggles the state of the specified item, i.e. selects it if it was 40509 unselected and deselects it if it was selected. 40510 """ 40511 40512 @staticmethod 40513 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 40514 """ 40515 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 40516 """ 40517 ItemCount = property(None, None) 40518 Margins = property(None, None) 40519 SelectedCount = property(None, None) 40520 Selection = property(None, None) 40521 SelectionBackground = property(None, None) 40522 40523 def OnDrawItem(self, dc, rect, n): 40524 """ 40525 OnDrawItem(dc, rect, n) 40526 40527 The derived class must implement this function to actually draw the 40528 item with the given index on the provided DC. 40529 """ 40530 40531 def OnDrawBackground(self, dc, rect, n): 40532 """ 40533 OnDrawBackground(dc, rect, n) 40534 40535 This method is used to draw the item's background and, maybe, a border 40536 around it. 40537 """ 40538 40539 def OnDrawSeparator(self, dc, rect, n): 40540 """ 40541 OnDrawSeparator(dc, rect, n) 40542 40543 This method may be used to draw separators between the lines. 40544 """ 40545 40546 def OnMeasureItem(self, n): 40547 """ 40548 OnMeasureItem(n) -> Coord 40549 40550 The derived class must implement this method to return the height of 40551 the specified item (in pixels). 40552 """ 40553# end of class VListBox 40554 40555#-- end-vlbox --# 40556#-- begin-nonownedwnd --# 40557FRAME_SHAPED = 0 40558 40559class NonOwnedWindow(Window): 40560 """ 40561 Common base class for all non-child windows. 40562 """ 40563 40564 def SetShape(self, *args, **kw): 40565 """ 40566 SetShape(region) -> bool 40567 SetShape(path) -> bool 40568 40569 If the platform supports it, sets the shape of the window to that 40570 depicted by region. 40571 """ 40572# end of class NonOwnedWindow 40573 40574#-- end-nonownedwnd --# 40575#-- begin-toplevel --# 40576DEFAULT_FRAME_STYLE = 0 40577USER_ATTENTION_INFO = 0 40578USER_ATTENTION_ERROR = 0 40579FULLSCREEN_NOMENUBAR = 0 40580FULLSCREEN_NOTOOLBAR = 0 40581FULLSCREEN_NOSTATUSBAR = 0 40582FULLSCREEN_NOBORDER = 0 40583FULLSCREEN_NOCAPTION = 0 40584FULLSCREEN_ALL = 0 40585FrameNameStr = "" 40586 40587class TopLevelWindow(NonOwnedWindow): 40588 """ 40589 TopLevelWindow() 40590 TopLevelWindow(parent, id=ID_ANY, title=EmptyString, pos=DefaultPosition, size=DefaultSize, style=DEFAULT_FRAME_STYLE, name=FrameNameStr) 40591 40592 wxTopLevelWindow is a common base class for wxDialog and wxFrame. 40593 """ 40594 40595 def __init__(self, *args, **kw): 40596 """ 40597 TopLevelWindow() 40598 TopLevelWindow(parent, id=ID_ANY, title=EmptyString, pos=DefaultPosition, size=DefaultSize, style=DEFAULT_FRAME_STYLE, name=FrameNameStr) 40599 40600 wxTopLevelWindow is a common base class for wxDialog and wxFrame. 40601 """ 40602 40603 def Create(self, parent, id=ID_ANY, title=EmptyString, pos=DefaultPosition, size=DefaultSize, style=DEFAULT_FRAME_STYLE, name=FrameNameStr): 40604 """ 40605 Create(parent, id=ID_ANY, title=EmptyString, pos=DefaultPosition, size=DefaultSize, style=DEFAULT_FRAME_STYLE, name=FrameNameStr) -> bool 40606 40607 Creates the top level window. 40608 """ 40609 40610 def CanSetTransparent(self): 40611 """ 40612 CanSetTransparent() -> bool 40613 40614 Returns true if the platform supports making the window translucent. 40615 """ 40616 40617 def CenterOnScreen(self, direction=BOTH): 40618 """ 40619 CenterOnScreen(direction=BOTH) 40620 40621 A synonym for CentreOnScreen(). 40622 """ 40623 40624 def CentreOnScreen(self, direction=BOTH): 40625 """ 40626 CentreOnScreen(direction=BOTH) 40627 40628 Centres the window on screen. 40629 """ 40630 40631 def EnableCloseButton(self, enable=True): 40632 """ 40633 EnableCloseButton(enable=True) -> bool 40634 40635 Enables or disables the Close button (most often in the right upper 40636 corner of a dialog) and the Close entry of the system menu (most often 40637 in the left upper corner of the dialog). 40638 """ 40639 40640 def GetDefaultItem(self): 40641 """ 40642 GetDefaultItem() -> Window 40643 40644 Returns a pointer to the button which is the default for this window, 40645 or NULL. 40646 """ 40647 40648 def GetIcon(self): 40649 """ 40650 GetIcon() -> Icon 40651 40652 Returns the standard icon of the window. 40653 """ 40654 40655 def GetIcons(self): 40656 """ 40657 GetIcons() -> IconBundle 40658 40659 Returns all icons associated with the window, there will be none of 40660 them if neither SetIcon() nor SetIcons() had been called before. 40661 """ 40662 40663 def GetTitle(self): 40664 """ 40665 GetTitle() -> String 40666 40667 Gets a string containing the window title. 40668 """ 40669 40670 def Iconize(self, iconize=True): 40671 """ 40672 Iconize(iconize=True) 40673 40674 Iconizes or restores the window. 40675 """ 40676 40677 def IsActive(self): 40678 """ 40679 IsActive() -> bool 40680 40681 Returns true if this window is currently active, i.e. if the user is 40682 currently working with it. 40683 """ 40684 40685 def IsAlwaysMaximized(self): 40686 """ 40687 IsAlwaysMaximized() -> bool 40688 40689 Returns true if this window is expected to be always maximized, either 40690 due to platform policy or due to local policy regarding particular 40691 class. 40692 """ 40693 40694 def IsFullScreen(self): 40695 """ 40696 IsFullScreen() -> bool 40697 40698 Returns true if the window is in fullscreen mode. 40699 """ 40700 40701 def IsIconized(self): 40702 """ 40703 IsIconized() -> bool 40704 40705 Returns true if the window is iconized. 40706 """ 40707 40708 def IsMaximized(self): 40709 """ 40710 IsMaximized() -> bool 40711 40712 Returns true if the window is maximized. 40713 """ 40714 40715 def Layout(self): 40716 """ 40717 Layout() -> bool 40718 40719 See wxWindow::SetAutoLayout(): when auto layout is on, this function 40720 gets called automatically when the window is resized. 40721 """ 40722 40723 def Maximize(self, maximize=True): 40724 """ 40725 Maximize(maximize=True) 40726 40727 Maximizes or restores the window. 40728 """ 40729 40730 def RequestUserAttention(self, flags=USER_ATTENTION_INFO): 40731 """ 40732 RequestUserAttention(flags=USER_ATTENTION_INFO) 40733 40734 Use a system-dependent way to attract users attention to the window 40735 when it is in background. 40736 """ 40737 40738 def Restore(self): 40739 """ 40740 Restore() 40741 40742 Restore a previously iconized or maximized window to its normal state. 40743 """ 40744 40745 def SetDefaultItem(self, win): 40746 """ 40747 SetDefaultItem(win) -> Window 40748 40749 Changes the default item for the panel, usually win is a button. 40750 """ 40751 40752 def SetTmpDefaultItem(self, win): 40753 """ 40754 SetTmpDefaultItem(win) -> Window 40755 """ 40756 40757 def GetTmpDefaultItem(self): 40758 """ 40759 GetTmpDefaultItem() -> Window 40760 """ 40761 40762 def SetIcon(self, icon): 40763 """ 40764 SetIcon(icon) 40765 40766 Sets the icon for this window. 40767 """ 40768 40769 def SetIcons(self, icons): 40770 """ 40771 SetIcons(icons) 40772 40773 Sets several icons of different sizes for this window: this allows 40774 using different icons for different situations (e.g. 40775 """ 40776 40777 def SetMaxSize(self, size): 40778 """ 40779 SetMaxSize(size) 40780 40781 A simpler interface for setting the size hints than SetSizeHints(). 40782 """ 40783 40784 def SetMinSize(self, size): 40785 """ 40786 SetMinSize(size) 40787 40788 A simpler interface for setting the size hints than SetSizeHints(). 40789 """ 40790 40791 def SetSizeHints(self, *args, **kw): 40792 """ 40793 SetSizeHints(minW, minH, maxW=-1, maxH=-1, incW=-1, incH=-1) 40794 SetSizeHints(minSize, maxSize=DefaultSize, incSize=DefaultSize) 40795 40796 Allows specification of minimum and maximum window sizes, and window 40797 size increments. 40798 """ 40799 40800 def SetTitle(self, title): 40801 """ 40802 SetTitle(title) 40803 40804 Sets the window title. 40805 """ 40806 40807 def SetTransparent(self, alpha): 40808 """ 40809 SetTransparent(alpha) -> bool 40810 40811 If the platform supports it will set the window to be translucent. 40812 """ 40813 40814 def ShouldPreventAppExit(self): 40815 """ 40816 ShouldPreventAppExit() -> bool 40817 40818 This virtual function is not meant to be called directly but can be 40819 overridden to return false (it returns true by default) to allow the 40820 application to close even if this, presumably not very important, 40821 window is still opened. 40822 """ 40823 40824 def OSXSetModified(self, modified): 40825 """ 40826 OSXSetModified(modified) 40827 40828 This function sets the wxTopLevelWindow's modified state on OS X, 40829 which currently draws a black dot in the wxTopLevelWindow's close 40830 button. 40831 """ 40832 40833 def OSXIsModified(self): 40834 """ 40835 OSXIsModified() -> bool 40836 40837 Returns the current modified state of the wxTopLevelWindow on OS X. 40838 """ 40839 40840 def SetRepresentedFilename(self, filename): 40841 """ 40842 SetRepresentedFilename(filename) 40843 40844 Sets the file name represented by this wxTopLevelWindow. 40845 """ 40846 40847 def ShowWithoutActivating(self): 40848 """ 40849 ShowWithoutActivating() 40850 40851 Show the wxTopLevelWindow, but do not give it keyboard focus. 40852 """ 40853 40854 def ShowFullScreen(self, show, style=FULLSCREEN_ALL): 40855 """ 40856 ShowFullScreen(show, style=FULLSCREEN_ALL) -> bool 40857 40858 Depending on the value of show parameter the window is either shown 40859 full screen or restored to its normal state. 40860 """ 40861 40862 @staticmethod 40863 def GetDefaultSize(): 40864 """ 40865 GetDefaultSize() -> Size 40866 40867 Get the default size for a new top level window. 40868 """ 40869 40870 def MacSetMetalAppearance(self, on): 40871 """ 40872 MacSetMetalAppearance(on) 40873 """ 40874 40875 def MacGetMetalAppearance(self): 40876 """ 40877 MacGetMetalAppearance() -> bool 40878 """ 40879 40880 def MacGetUnifiedAppearance(self): 40881 """ 40882 MacGetUnifiedAppearance() -> bool 40883 """ 40884 40885 def MacGetTopLevelWindowRef(self): 40886 """ 40887 MacGetTopLevelWindowRef() -> void 40888 """ 40889 DefaultItem = property(None, None) 40890 Icon = property(None, None) 40891 Title = property(None, None) 40892 TmpDefaultItem = property(None, None) 40893 OSXModified = property(None, None) 40894 MacMetalAppearance = property(None, None) 40895 40896 @staticmethod 40897 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 40898 """ 40899 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 40900 """ 40901# end of class TopLevelWindow 40902 40903#-- end-toplevel --# 40904#-- begin-dialog --# 40905DIALOG_NO_PARENT = 0 40906DEFAULT_DIALOG_STYLE = 0 40907DIALOG_ADAPTATION_NONE = 0 40908DIALOG_ADAPTATION_STANDARD_SIZER = 0 40909DIALOG_ADAPTATION_ANY_SIZER = 0 40910DIALOG_ADAPTATION_LOOSE_BUTTONS = 0 40911DIALOG_ADAPTATION_MODE_DEFAULT = 0 40912DIALOG_ADAPTATION_MODE_ENABLED = 0 40913DIALOG_ADAPTATION_MODE_DISABLED = 0 40914DialogNameStr = "" 40915 40916class Dialog(TopLevelWindow): 40917 """ 40918 Dialog() 40919 Dialog(parent, id=ID_ANY, title=EmptyString, pos=DefaultPosition, size=DefaultSize, style=DEFAULT_DIALOG_STYLE, name=DialogNameStr) 40920 40921 A dialog box is a window with a title bar and sometimes a system menu, 40922 which can be moved around the screen. 40923 """ 40924 40925 def __init__(self, *args, **kw): 40926 """ 40927 Dialog() 40928 Dialog(parent, id=ID_ANY, title=EmptyString, pos=DefaultPosition, size=DefaultSize, style=DEFAULT_DIALOG_STYLE, name=DialogNameStr) 40929 40930 A dialog box is a window with a title bar and sometimes a system menu, 40931 which can be moved around the screen. 40932 """ 40933 40934 def AddMainButtonId(self, id): 40935 """ 40936 AddMainButtonId(id) 40937 40938 Adds an identifier to be regarded as a main button for the non- 40939 scrolling area of a dialog. 40940 """ 40941 40942 def CanDoLayoutAdaptation(self): 40943 """ 40944 CanDoLayoutAdaptation() -> bool 40945 40946 Returns true if this dialog can and should perform layout adaptation 40947 using DoLayoutAdaptation(), usually if the dialog is too large to fit 40948 on the display. 40949 """ 40950 40951 def Centre(self, direction=BOTH): 40952 """ 40953 Centre(direction=BOTH) 40954 40955 Centres the dialog box on the display. 40956 """ 40957 40958 def Create(self, parent, id=ID_ANY, title=EmptyString, pos=DefaultPosition, size=DefaultSize, style=DEFAULT_DIALOG_STYLE, name=DialogNameStr): 40959 """ 40960 Create(parent, id=ID_ANY, title=EmptyString, pos=DefaultPosition, size=DefaultSize, style=DEFAULT_DIALOG_STYLE, name=DialogNameStr) -> bool 40961 40962 Used for two-step dialog box construction. 40963 """ 40964 40965 def CreateButtonSizer(self, flags): 40966 """ 40967 CreateButtonSizer(flags) -> Sizer 40968 40969 Creates a sizer with standard buttons. 40970 """ 40971 40972 def CreateSeparatedButtonSizer(self, flags): 40973 """ 40974 CreateSeparatedButtonSizer(flags) -> Sizer 40975 40976 Creates a sizer with standard buttons using CreateButtonSizer() 40977 separated from the rest of the dialog contents by a horizontal 40978 wxStaticLine. 40979 """ 40980 40981 def CreateSeparatedSizer(self, sizer): 40982 """ 40983 CreateSeparatedSizer(sizer) -> Sizer 40984 40985 Returns the sizer containing the given one with a separating 40986 wxStaticLine if necessarily. 40987 """ 40988 40989 def CreateStdDialogButtonSizer(self, flags): 40990 """ 40991 CreateStdDialogButtonSizer(flags) -> StdDialogButtonSizer 40992 40993 Creates a wxStdDialogButtonSizer with standard buttons. 40994 """ 40995 40996 def CreateTextSizer(self, message): 40997 """ 40998 CreateTextSizer(message) -> Sizer 40999 41000 Splits text up at newlines and places the lines into wxStaticText 41001 objects in a vertical wxBoxSizer. 41002 """ 41003 41004 def DoLayoutAdaptation(self): 41005 """ 41006 DoLayoutAdaptation() -> bool 41007 41008 Performs layout adaptation, usually if the dialog is too large to fit 41009 on the display. 41010 """ 41011 41012 def EndModal(self, retCode): 41013 """ 41014 EndModal(retCode) 41015 41016 Ends a modal dialog, passing a value to be returned from the 41017 ShowModal() invocation. 41018 """ 41019 41020 def GetAffirmativeId(self): 41021 """ 41022 GetAffirmativeId() -> int 41023 41024 Gets the identifier of the button which works like standard OK button 41025 in this dialog. 41026 """ 41027 41028 def GetContentWindow(self): 41029 """ 41030 GetContentWindow() -> Window 41031 41032 Override this to return a window containing the main content of the 41033 dialog. 41034 """ 41035 41036 def GetEscapeId(self): 41037 """ 41038 GetEscapeId() -> int 41039 41040 Gets the identifier of the button to map presses of ESC button to. 41041 """ 41042 41043 def GetLayoutAdaptationDone(self): 41044 """ 41045 GetLayoutAdaptationDone() -> bool 41046 41047 Returns true if the dialog has been adapted, usually by making it 41048 scrollable to work with a small display. 41049 """ 41050 41051 def GetLayoutAdaptationLevel(self): 41052 """ 41053 GetLayoutAdaptationLevel() -> int 41054 41055 Gets a value representing the aggressiveness of search for buttons and 41056 sizers to be in the non-scrolling part of a layout-adapted dialog. 41057 """ 41058 41059 def GetLayoutAdaptationMode(self): 41060 """ 41061 GetLayoutAdaptationMode() -> DialogLayoutAdaptationMode 41062 41063 Gets the adaptation mode, overriding the global adaptation flag. 41064 """ 41065 41066 def GetMainButtonIds(self): 41067 """ 41068 GetMainButtonIds() -> ArrayInt 41069 41070 Returns an array of identifiers to be regarded as the main buttons for 41071 the non-scrolling area of a dialog. 41072 """ 41073 41074 def GetReturnCode(self): 41075 """ 41076 GetReturnCode() -> int 41077 41078 Gets the return code for this window. 41079 """ 41080 41081 def Iconize(self, iconize=True): 41082 """ 41083 Iconize(iconize=True) 41084 41085 Iconizes or restores the dialog. 41086 """ 41087 41088 def IsIconized(self): 41089 """ 41090 IsIconized() -> bool 41091 41092 Returns true if the dialog box is iconized. 41093 """ 41094 41095 def IsMainButtonId(self, id): 41096 """ 41097 IsMainButtonId(id) -> bool 41098 41099 Returns true if id is in the array of identifiers to be regarded as 41100 the main buttons for the non-scrolling area of a dialog. 41101 """ 41102 41103 def IsModal(self): 41104 """ 41105 IsModal() -> bool 41106 41107 Returns true if the dialog box is modal, false otherwise. 41108 """ 41109 41110 def SetAffirmativeId(self, id): 41111 """ 41112 SetAffirmativeId(id) 41113 41114 Sets the identifier to be used as OK button. 41115 """ 41116 41117 def SetEscapeId(self, id): 41118 """ 41119 SetEscapeId(id) 41120 41121 Sets the identifier of the button which should work like the standard 41122 "Cancel" button in this dialog. 41123 """ 41124 41125 def SetIcon(self, icon): 41126 """ 41127 SetIcon(icon) 41128 41129 Sets the icon for this dialog. 41130 """ 41131 41132 def SetIcons(self, icons): 41133 """ 41134 SetIcons(icons) 41135 41136 Sets the icons for this dialog. 41137 """ 41138 41139 def SetLayoutAdaptationDone(self, done): 41140 """ 41141 SetLayoutAdaptationDone(done) 41142 41143 Marks the dialog as having been adapted, usually by making it 41144 scrollable to work with a small display. 41145 """ 41146 41147 def SetLayoutAdaptationLevel(self, level): 41148 """ 41149 SetLayoutAdaptationLevel(level) 41150 41151 Sets the aggressiveness of search for buttons and sizers to be in the 41152 non-scrolling part of a layout-adapted dialog. 41153 """ 41154 41155 def SetLayoutAdaptationMode(self, mode): 41156 """ 41157 SetLayoutAdaptationMode(mode) 41158 41159 Sets the adaptation mode, overriding the global adaptation flag. 41160 """ 41161 41162 def SetReturnCode(self, retCode): 41163 """ 41164 SetReturnCode(retCode) 41165 41166 Sets the return code for this window. 41167 """ 41168 41169 def Show(self, show=1): 41170 """ 41171 Show(show=1) -> bool 41172 41173 Hides or shows the dialog. 41174 """ 41175 41176 def ShowModal(self): 41177 """ 41178 ShowModal() -> int 41179 41180 Shows an application-modal dialog. 41181 """ 41182 41183 def ShowWindowModal(self): 41184 """ 41185 ShowWindowModal() 41186 41187 Shows a dialog modal to the parent top level window only. 41188 """ 41189 41190 @staticmethod 41191 def EnableLayoutAdaptation(enable): 41192 """ 41193 EnableLayoutAdaptation(enable) 41194 41195 A static function enabling or disabling layout adaptation for all 41196 dialogs. 41197 """ 41198 41199 @staticmethod 41200 def GetLayoutAdapter(): 41201 """ 41202 GetLayoutAdapter() -> DialogLayoutAdapter 41203 41204 A static function getting the current layout adapter object. 41205 """ 41206 41207 @staticmethod 41208 def IsLayoutAdaptationEnabled(): 41209 """ 41210 IsLayoutAdaptationEnabled() -> bool 41211 41212 A static function returning true if layout adaptation is enabled for 41213 all dialogs. 41214 """ 41215 41216 @staticmethod 41217 def SetLayoutAdapter(adapter): 41218 """ 41219 SetLayoutAdapter(adapter) -> DialogLayoutAdapter 41220 41221 A static function for setting the current layout adapter object, 41222 returning the old adapter. 41223 """ 41224 41225 @staticmethod 41226 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 41227 """ 41228 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 41229 """ 41230 41231 def __enter__(self): 41232 """ 41233 41234 """ 41235 41236 def __exit__(self, exc_type, exc_val, exc_tb): 41237 """ 41238 41239 """ 41240 AffirmativeId = property(None, None) 41241 ContentWindow = property(None, None) 41242 EscapeId = property(None, None) 41243 LayoutAdaptationDone = property(None, None) 41244 LayoutAdaptationLevel = property(None, None) 41245 LayoutAdaptationMode = property(None, None) 41246 MainButtonIds = property(None, None) 41247 ReturnCode = property(None, None) 41248# end of class Dialog 41249 41250 41251class DialogLayoutAdapter(object): 41252 """ 41253 DialogLayoutAdapter() 41254 41255 This abstract class is the base for classes that help wxWidgets 41256 perform run-time layout adaptation of dialogs. 41257 """ 41258 41259 def __init__(self): 41260 """ 41261 DialogLayoutAdapter() 41262 41263 This abstract class is the base for classes that help wxWidgets 41264 perform run-time layout adaptation of dialogs. 41265 """ 41266 41267 def CanDoLayoutAdaptation(self, dialog): 41268 """ 41269 CanDoLayoutAdaptation(dialog) -> bool 41270 41271 Override this to returns true if adaptation can and should be done. 41272 """ 41273 41274 def DoLayoutAdaptation(self, dialog): 41275 """ 41276 DoLayoutAdaptation(dialog) -> bool 41277 41278 Override this to perform layout adaptation, such as making parts of 41279 the dialog scroll and resizing the dialog to fit the display. 41280 """ 41281# end of class DialogLayoutAdapter 41282 41283 41284class WindowModalDialogEvent(CommandEvent): 41285 """ 41286 WindowModalDialogEvent(commandType=wxEVT_NULL, id=0) 41287 41288 Event sent by wxDialog::ShowWindowModal() when the dialog closes. 41289 """ 41290 41291 def __init__(self, commandType=wxEVT_NULL, id=0): 41292 """ 41293 WindowModalDialogEvent(commandType=wxEVT_NULL, id=0) 41294 41295 Event sent by wxDialog::ShowWindowModal() when the dialog closes. 41296 """ 41297 41298 def GetDialog(self): 41299 """ 41300 GetDialog() -> Dialog 41301 41302 Return the corresponding dialog. 41303 """ 41304 41305 def GetReturnCode(self): 41306 """ 41307 GetReturnCode() -> int 41308 41309 Return the dialog's return code. 41310 """ 41311 41312 def Clone(self): 41313 """ 41314 Clone() -> Event 41315 41316 Clone the event. 41317 """ 41318 Dialog = property(None, None) 41319 ReturnCode = property(None, None) 41320# end of class WindowModalDialogEvent 41321 41322#-- end-dialog --# 41323#-- begin-dirdlg --# 41324DD_CHANGE_DIR = 0 41325DD_DIR_MUST_EXIST = 0 41326DD_NEW_DIR_BUTTON = 0 41327DD_DEFAULT_STYLE = 0 41328DirDialogNameStr = "" 41329DirDialogDefaultFolderStr = "" 41330 41331class DirDialog(Dialog): 41332 """ 41333 DirDialog(parent, message=DirSelectorPromptStr, defaultPath=EmptyString, style=DD_DEFAULT_STYLE, pos=DefaultPosition, size=DefaultSize, name=DirDialogNameStr) 41334 41335 This class represents the directory chooser dialog. 41336 """ 41337 41338 def __init__(self, parent, message=DirSelectorPromptStr, defaultPath=EmptyString, style=DD_DEFAULT_STYLE, pos=DefaultPosition, size=DefaultSize, name=DirDialogNameStr): 41339 """ 41340 DirDialog(parent, message=DirSelectorPromptStr, defaultPath=EmptyString, style=DD_DEFAULT_STYLE, pos=DefaultPosition, size=DefaultSize, name=DirDialogNameStr) 41341 41342 This class represents the directory chooser dialog. 41343 """ 41344 41345 def GetMessage(self): 41346 """ 41347 GetMessage() -> String 41348 41349 Returns the message that will be displayed on the dialog. 41350 """ 41351 41352 def GetPath(self): 41353 """ 41354 GetPath() -> String 41355 41356 Returns the default or user-selected path. 41357 """ 41358 41359 def SetMessage(self, message): 41360 """ 41361 SetMessage(message) 41362 41363 Sets the message that will be displayed on the dialog. 41364 """ 41365 41366 def SetPath(self, path): 41367 """ 41368 SetPath(path) 41369 41370 Sets the default path. 41371 """ 41372 41373 def ShowModal(self): 41374 """ 41375 ShowModal() -> int 41376 41377 Shows the dialog, returning wxID_OK if the user pressed OK, and 41378 wxID_CANCEL otherwise. 41379 """ 41380 41381 @staticmethod 41382 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 41383 """ 41384 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 41385 """ 41386 Message = property(None, None) 41387 Path = property(None, None) 41388# end of class DirDialog 41389 41390 41391def DirSelector(message=DirSelectorPromptStr, default_path=EmptyString, style=0, pos=DefaultPosition, parent=None): 41392 """ 41393 DirSelector(message=DirSelectorPromptStr, default_path=EmptyString, style=0, pos=DefaultPosition, parent=None) -> String 41394 41395 Pops up a directory selector dialog. 41396 """ 41397#-- end-dirdlg --# 41398#-- begin-dirctrl --# 41399DIRCTRL_DIR_ONLY = 0 41400DIRCTRL_SELECT_FIRST = 0 41401DIRCTRL_SHOW_FILTERS = 0 41402DIRCTRL_3D_INTERNAL = 0 41403DIRCTRL_EDIT_LABELS = 0 41404DIRCTRL_MULTIPLE = 0 41405wxEVT_DIRCTRL_SELECTIONCHANGED = 0 41406wxEVT_DIRCTRL_FILEACTIVATED = 0 41407 41408class GenericDirCtrl(Control): 41409 """ 41410 GenericDirCtrl() 41411 GenericDirCtrl(parent, id=ID_ANY, dir=DirDialogDefaultFolderStr, pos=DefaultPosition, size=DefaultSize, style=DIRCTRL_3D_INTERNAL, filter=EmptyString, defaultFilter=0, name=TreeCtrlNameStr) 41412 41413 This control can be used to place a directory listing (with optional 41414 files) on an arbitrary window. 41415 """ 41416 41417 def __init__(self, *args, **kw): 41418 """ 41419 GenericDirCtrl() 41420 GenericDirCtrl(parent, id=ID_ANY, dir=DirDialogDefaultFolderStr, pos=DefaultPosition, size=DefaultSize, style=DIRCTRL_3D_INTERNAL, filter=EmptyString, defaultFilter=0, name=TreeCtrlNameStr) 41421 41422 This control can be used to place a directory listing (with optional 41423 files) on an arbitrary window. 41424 """ 41425 41426 def CollapsePath(self, path): 41427 """ 41428 CollapsePath(path) -> bool 41429 41430 Collapse the given path. 41431 """ 41432 41433 def CollapseTree(self): 41434 """ 41435 CollapseTree() 41436 41437 Collapses the entire tree. 41438 """ 41439 41440 def Create(self, parent, id=ID_ANY, dir=DirDialogDefaultFolderStr, pos=DefaultPosition, size=DefaultSize, style=DIRCTRL_3D_INTERNAL, filter=EmptyString, defaultFilter=0, name=TreeCtrlNameStr): 41441 """ 41442 Create(parent, id=ID_ANY, dir=DirDialogDefaultFolderStr, pos=DefaultPosition, size=DefaultSize, style=DIRCTRL_3D_INTERNAL, filter=EmptyString, defaultFilter=0, name=TreeCtrlNameStr) -> bool 41443 41444 Create function for two-step construction. 41445 """ 41446 41447 def ExpandPath(self, path): 41448 """ 41449 ExpandPath(path) -> bool 41450 41451 Tries to expand as much of the given path as possible, so that the 41452 filename or directory is visible in the tree control. 41453 """ 41454 41455 def GetDefaultPath(self): 41456 """ 41457 GetDefaultPath() -> String 41458 41459 Gets the default path. 41460 """ 41461 41462 def GetFilePath(self): 41463 """ 41464 GetFilePath() -> String 41465 41466 Gets selected filename path only (else empty string). 41467 """ 41468 41469 def GetFilePaths(self, paths): 41470 """ 41471 GetFilePaths(paths) 41472 41473 Fills the array paths with the currently selected filepaths. 41474 """ 41475 41476 def GetFilter(self): 41477 """ 41478 GetFilter() -> String 41479 41480 Returns the filter string. 41481 """ 41482 41483 def GetFilterIndex(self): 41484 """ 41485 GetFilterIndex() -> int 41486 41487 Returns the current filter index (zero-based). 41488 """ 41489 41490 def GetFilterListCtrl(self): 41491 """ 41492 GetFilterListCtrl() -> DirFilterListCtrl 41493 41494 Returns a pointer to the filter list control (if present). 41495 """ 41496 41497 def GetPath(self, *args, **kw): 41498 """ 41499 GetPath() -> String 41500 GetPath(itemId) -> String 41501 41502 Gets the currently-selected directory or filename. 41503 """ 41504 41505 def GetPaths(self, paths): 41506 """ 41507 GetPaths(paths) 41508 41509 Fills the array paths with the selected directories and filenames. 41510 """ 41511 41512 def GetRootId(self): 41513 """ 41514 GetRootId() -> TreeItemId 41515 41516 Returns the root id for the tree control. 41517 """ 41518 41519 def GetTreeCtrl(self): 41520 """ 41521 GetTreeCtrl() -> TreeCtrl 41522 41523 Returns a pointer to the tree control. 41524 """ 41525 41526 def Init(self): 41527 """ 41528 Init() 41529 41530 Initializes variables. 41531 """ 41532 41533 def ReCreateTree(self): 41534 """ 41535 ReCreateTree() 41536 41537 Collapse and expand the tree, thus re-creating it from scratch. 41538 """ 41539 41540 def SetDefaultPath(self, path): 41541 """ 41542 SetDefaultPath(path) 41543 41544 Sets the default path. 41545 """ 41546 41547 def SetFilter(self, filter): 41548 """ 41549 SetFilter(filter) 41550 41551 Sets the filter string. 41552 """ 41553 41554 def SetFilterIndex(self, n): 41555 """ 41556 SetFilterIndex(n) 41557 41558 Sets the current filter index (zero-based). 41559 """ 41560 41561 def SetPath(self, path): 41562 """ 41563 SetPath(path) 41564 41565 Sets the current path. 41566 """ 41567 41568 def ShowHidden(self, show): 41569 """ 41570 ShowHidden(show) 41571 """ 41572 41573 def SelectPath(self, path, select=True): 41574 """ 41575 SelectPath(path, select=True) 41576 41577 Selects the given item. 41578 """ 41579 41580 def SelectPaths(self, paths): 41581 """ 41582 SelectPaths(paths) 41583 41584 Selects only the specified paths, clearing any previous selection. 41585 """ 41586 41587 def UnselectAll(self): 41588 """ 41589 UnselectAll() 41590 41591 Removes the selection from all currently selected items. 41592 """ 41593 41594 @staticmethod 41595 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 41596 """ 41597 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 41598 """ 41599 DefaultPath = property(None, None) 41600 FilePath = property(None, None) 41601 Filter = property(None, None) 41602 FilterIndex = property(None, None) 41603 FilterListCtrl = property(None, None) 41604 Path = property(None, None) 41605 RootId = property(None, None) 41606 TreeCtrl = property(None, None) 41607# end of class GenericDirCtrl 41608 41609 41610class DirFilterListCtrl(Choice): 41611 """ 41612 DirFilterListCtrl() 41613 DirFilterListCtrl(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0) 41614 """ 41615 41616 def __init__(self, *args, **kw): 41617 """ 41618 DirFilterListCtrl() 41619 DirFilterListCtrl(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0) 41620 """ 41621 41622 def Create(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0): 41623 """ 41624 Create(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0) -> bool 41625 """ 41626 41627 def Init(self): 41628 """ 41629 Init() 41630 """ 41631 41632 def FillFilterList(self, filter, defaultFilter): 41633 """ 41634 FillFilterList(filter, defaultFilter) 41635 """ 41636# end of class DirFilterListCtrl 41637 41638 41639EVT_DIRCTRL_SELECTIONCHANGED = wx.PyEventBinder( wxEVT_DIRCTRL_SELECTIONCHANGED, 1 ) 41640EVT_DIRCTRL_FILEACTIVATED = wx.PyEventBinder( wxEVT_DIRCTRL_FILEACTIVATED, 1 ) 41641#-- end-dirctrl --# 41642#-- begin-filedlg --# 41643FD_DEFAULT_STYLE = 0 41644FD_OPEN = 0 41645FD_SAVE = 0 41646FD_OVERWRITE_PROMPT = 0 41647FD_FILE_MUST_EXIST = 0 41648FD_MULTIPLE = 0 41649FD_CHANGE_DIR = 0 41650FD_PREVIEW = 0 41651FileDialogNameStr = "" 41652 41653class FileDialog(Dialog): 41654 """ 41655 FileDialog(parent, message=FileSelectorPromptStr, defaultDir=EmptyString, defaultFile=EmptyString, wildcard=FileSelectorDefaultWildcardStr, style=FD_DEFAULT_STYLE, pos=DefaultPosition, size=DefaultSize, name=FileDialogNameStr) 41656 41657 This class represents the file chooser dialog. 41658 """ 41659 41660 def __init__(self, parent, message=FileSelectorPromptStr, defaultDir=EmptyString, defaultFile=EmptyString, wildcard=FileSelectorDefaultWildcardStr, style=FD_DEFAULT_STYLE, pos=DefaultPosition, size=DefaultSize, name=FileDialogNameStr): 41661 """ 41662 FileDialog(parent, message=FileSelectorPromptStr, defaultDir=EmptyString, defaultFile=EmptyString, wildcard=FileSelectorDefaultWildcardStr, style=FD_DEFAULT_STYLE, pos=DefaultPosition, size=DefaultSize, name=FileDialogNameStr) 41663 41664 This class represents the file chooser dialog. 41665 """ 41666 41667 def GetCurrentlySelectedFilename(self): 41668 """ 41669 GetCurrentlySelectedFilename() -> String 41670 41671 Returns the path of the file currently selected in dialog. 41672 """ 41673 41674 def GetDirectory(self): 41675 """ 41676 GetDirectory() -> String 41677 41678 Returns the default directory. 41679 """ 41680 41681 def GetExtraControl(self): 41682 """ 41683 GetExtraControl() -> Window 41684 41685 If functions SetExtraControlCreator() and ShowModal() were called, 41686 returns the extra window. 41687 """ 41688 41689 def GetFilename(self): 41690 """ 41691 GetFilename() -> String 41692 41693 Returns the default filename. 41694 """ 41695 41696 def GetFilenames(self): 41697 """ 41698 GetFilenames() -> ArrayString 41699 41700 Returns a list of filenames chosen in the dialog. This function 41701 should only be used with the dialogs which have wx.MULTIPLE style, 41702 use GetFilename for the others. 41703 """ 41704 41705 def GetFilterIndex(self): 41706 """ 41707 GetFilterIndex() -> int 41708 41709 Returns the index into the list of filters supplied, optionally, in 41710 the wildcard parameter. 41711 """ 41712 41713 def GetMessage(self): 41714 """ 41715 GetMessage() -> String 41716 41717 Returns the message that will be displayed on the dialog. 41718 """ 41719 41720 def GetPath(self): 41721 """ 41722 GetPath() -> String 41723 41724 Returns the full path (directory and filename) of the selected file. 41725 """ 41726 41727 def GetPaths(self): 41728 """ 41729 GetPaths() -> ArrayString 41730 41731 Returns a list of the full paths of the files chosen. This function 41732 should only be used with the dialogs which have wx.MULTIPLE style, use 41733 GetPath for the others. 41734 """ 41735 41736 def GetWildcard(self): 41737 """ 41738 GetWildcard() -> String 41739 41740 Returns the file dialog wildcard. 41741 """ 41742 41743 def SetDirectory(self, directory): 41744 """ 41745 SetDirectory(directory) 41746 41747 Sets the default directory. 41748 """ 41749 41750 def SetFilename(self, setfilename): 41751 """ 41752 SetFilename(setfilename) 41753 41754 Sets the default filename. 41755 """ 41756 41757 def SetFilterIndex(self, filterIndex): 41758 """ 41759 SetFilterIndex(filterIndex) 41760 41761 Sets the default filter index, starting from zero. 41762 """ 41763 41764 def SetMessage(self, message): 41765 """ 41766 SetMessage(message) 41767 41768 Sets the message that will be displayed on the dialog. 41769 """ 41770 41771 def SetPath(self, path): 41772 """ 41773 SetPath(path) 41774 41775 Sets the path (the combined directory and filename that will be 41776 returned when the dialog is dismissed). 41777 """ 41778 41779 def SetWildcard(self, wildCard): 41780 """ 41781 SetWildcard(wildCard) 41782 41783 Sets the wildcard, which can contain multiple file types, for example: 41784 "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif". 41785 """ 41786 41787 def ShowModal(self): 41788 """ 41789 ShowModal() -> int 41790 41791 Shows the dialog, returning wxID_OK if the user pressed OK, and 41792 wxID_CANCEL otherwise. 41793 """ 41794 41795 @staticmethod 41796 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 41797 """ 41798 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 41799 """ 41800 CurrentlySelectedFilename = property(None, None) 41801 Directory = property(None, None) 41802 ExtraControl = property(None, None) 41803 Filename = property(None, None) 41804 Filenames = property(None, None) 41805 FilterIndex = property(None, None) 41806 Message = property(None, None) 41807 Path = property(None, None) 41808 Paths = property(None, None) 41809 Wildcard = property(None, None) 41810# end of class FileDialog 41811 41812 41813def FileSelector(message, default_path=EmptyString, default_filename=EmptyString, default_extension=EmptyString, wildcard=FileSelectorDefaultWildcardStr, flags=0, parent=None, x=DefaultCoord, y=DefaultCoord): 41814 """ 41815 FileSelector(message, default_path=EmptyString, default_filename=EmptyString, default_extension=EmptyString, wildcard=FileSelectorDefaultWildcardStr, flags=0, parent=None, x=DefaultCoord, y=DefaultCoord) -> String 41816 41817 Pops up a file selector box. 41818 """ 41819 41820def FileSelectorEx(message=FileSelectorPromptStr, default_path=EmptyString, default_filename=EmptyString, indexDefaultExtension=None, wildcard=FileSelectorDefaultWildcardStr, flags=0, parent=None, x=DefaultCoord, y=DefaultCoord): 41821 """ 41822 FileSelectorEx(message=FileSelectorPromptStr, default_path=EmptyString, default_filename=EmptyString, indexDefaultExtension=None, wildcard=FileSelectorDefaultWildcardStr, flags=0, parent=None, x=DefaultCoord, y=DefaultCoord) -> String 41823 41824 An extended version of wxFileSelector. 41825 """ 41826 41827def LoadFileSelector(what, extension, default_name=EmptyString, parent=None): 41828 """ 41829 LoadFileSelector(what, extension, default_name=EmptyString, parent=None) -> String 41830 41831 Ask for filename to load. 41832 """ 41833 41834def SaveFileSelector(what, extension, default_name=EmptyString, parent=None): 41835 """ 41836 SaveFileSelector(what, extension, default_name=EmptyString, parent=None) -> String 41837 41838 Ask for filename to save. 41839 """ 41840#-- end-filedlg --# 41841#-- begin-frame --# 41842FRAME_NO_TASKBAR = 0 41843FRAME_TOOL_WINDOW = 0 41844FRAME_FLOAT_ON_PARENT = 0 41845 41846class Frame(TopLevelWindow): 41847 """ 41848 Frame() 41849 Frame(parent, id=ID_ANY, title=EmptyString, pos=DefaultPosition, size=DefaultSize, style=DEFAULT_FRAME_STYLE, name=FrameNameStr) 41850 41851 A frame is a window whose size and position can (usually) be changed 41852 by the user. 41853 """ 41854 41855 def __init__(self, *args, **kw): 41856 """ 41857 Frame() 41858 Frame(parent, id=ID_ANY, title=EmptyString, pos=DefaultPosition, size=DefaultSize, style=DEFAULT_FRAME_STYLE, name=FrameNameStr) 41859 41860 A frame is a window whose size and position can (usually) be changed 41861 by the user. 41862 """ 41863 41864 def Centre(self, direction=BOTH): 41865 """ 41866 Centre(direction=BOTH) 41867 41868 Centres the frame on the display. 41869 """ 41870 41871 def Create(self, parent, id=ID_ANY, title=EmptyString, pos=DefaultPosition, size=DefaultSize, style=DEFAULT_FRAME_STYLE, name=FrameNameStr): 41872 """ 41873 Create(parent, id=ID_ANY, title=EmptyString, pos=DefaultPosition, size=DefaultSize, style=DEFAULT_FRAME_STYLE, name=FrameNameStr) -> bool 41874 41875 Used in two-step frame construction. 41876 """ 41877 41878 def CreateStatusBar(self, number=1, style=STB_DEFAULT_STYLE, id=0, name=StatusBarNameStr): 41879 """ 41880 CreateStatusBar(number=1, style=STB_DEFAULT_STYLE, id=0, name=StatusBarNameStr) -> StatusBar 41881 41882 Creates a status bar at the bottom of the frame. 41883 """ 41884 41885 def CreateToolBar(self, style=TB_DEFAULT_STYLE, id=ID_ANY, name=ToolBarNameStr): 41886 """ 41887 CreateToolBar(style=TB_DEFAULT_STYLE, id=ID_ANY, name=ToolBarNameStr) -> ToolBar 41888 41889 Creates a toolbar at the top or left of the frame. 41890 """ 41891 41892 def GetClientAreaOrigin(self): 41893 """ 41894 GetClientAreaOrigin() -> Point 41895 41896 Returns the origin of the frame client area (in client coordinates). 41897 """ 41898 41899 def GetMenuBar(self): 41900 """ 41901 GetMenuBar() -> MenuBar 41902 41903 Returns a pointer to the menubar currently associated with the frame 41904 (if any). 41905 """ 41906 41907 def GetStatusBar(self): 41908 """ 41909 GetStatusBar() -> StatusBar 41910 41911 Returns a pointer to the status bar currently associated with the 41912 frame (if any). 41913 """ 41914 41915 def GetStatusBarPane(self): 41916 """ 41917 GetStatusBarPane() -> int 41918 41919 Returns the status bar pane used to display menu and toolbar help. 41920 """ 41921 41922 def GetToolBar(self): 41923 """ 41924 GetToolBar() -> ToolBar 41925 41926 Returns a pointer to the toolbar currently associated with the frame 41927 (if any). 41928 """ 41929 41930 def OnCreateStatusBar(self, number, style, id, name): 41931 """ 41932 OnCreateStatusBar(number, style, id, name) -> StatusBar 41933 41934 Virtual function called when a status bar is requested by 41935 CreateStatusBar(). 41936 """ 41937 41938 def OnCreateToolBar(self, style, id, name): 41939 """ 41940 OnCreateToolBar(style, id, name) -> ToolBar 41941 41942 Virtual function called when a toolbar is requested by 41943 CreateToolBar(). 41944 """ 41945 41946 def ProcessCommand(self, id): 41947 """ 41948 ProcessCommand(id) -> bool 41949 41950 Simulate a menu command. 41951 """ 41952 41953 def SetMenuBar(self, menuBar): 41954 """ 41955 SetMenuBar(menuBar) 41956 41957 Tells the frame to show the given menu bar. 41958 """ 41959 41960 def SetStatusBar(self, statusBar): 41961 """ 41962 SetStatusBar(statusBar) 41963 41964 Associates a status bar with the frame. 41965 """ 41966 41967 def SetStatusBarPane(self, n): 41968 """ 41969 SetStatusBarPane(n) 41970 41971 Set the status bar pane used to display menu and toolbar help. 41972 """ 41973 41974 def SetStatusText(self, text, number=0): 41975 """ 41976 SetStatusText(text, number=0) 41977 41978 Sets the status bar text and redraws the status bar. 41979 """ 41980 41981 def SetStatusWidths(self, widths): 41982 """ 41983 SetStatusWidths(widths) 41984 41985 Sets the widths of the fields in the status bar. 41986 """ 41987 41988 def SetToolBar(self, toolBar): 41989 """ 41990 SetToolBar(toolBar) 41991 41992 Associates a toolbar with the frame. 41993 """ 41994 41995 def PushStatusText(self, text, number=0): 41996 """ 41997 PushStatusText(text, number=0) 41998 """ 41999 42000 def PopStatusText(self, number=0): 42001 """ 42002 PopStatusText(number=0) 42003 """ 42004 MenuBar = property(None, None) 42005 StatusBar = property(None, None) 42006 StatusBarPane = property(None, None) 42007 ToolBar = property(None, None) 42008 42009 @staticmethod 42010 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 42011 """ 42012 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 42013 """ 42014# end of class Frame 42015 42016#-- end-frame --# 42017#-- begin-msgdlg --# 42018MessageBoxCaptionStr = "" 42019 42020class MessageDialog(Dialog): 42021 """ 42022 MessageDialog(parent, message, caption=MessageBoxCaptionStr, style=OK|CENTRE, pos=DefaultPosition) 42023 42024 This class represents a dialog that shows a single or multi-line 42025 message, with a choice of OK, Yes, No and Cancel buttons. 42026 """ 42027 42028 def __init__(self, parent, message, caption=MessageBoxCaptionStr, style=OK|CENTRE, pos=DefaultPosition): 42029 """ 42030 MessageDialog(parent, message, caption=MessageBoxCaptionStr, style=OK|CENTRE, pos=DefaultPosition) 42031 42032 This class represents a dialog that shows a single or multi-line 42033 message, with a choice of OK, Yes, No and Cancel buttons. 42034 """ 42035 42036 def SetExtendedMessage(self, extendedMessage): 42037 """ 42038 SetExtendedMessage(extendedMessage) 42039 42040 Sets the extended message for the dialog: this message is usually an 42041 extension of the short message specified in the constructor or set 42042 with SetMessage(). 42043 """ 42044 42045 def SetHelpLabel(self, help): 42046 """ 42047 SetHelpLabel(help) -> bool 42048 42049 Sets the label for the Help button. 42050 """ 42051 42052 def SetMessage(self, message): 42053 """ 42054 SetMessage(message) 42055 42056 Sets the message shown by the dialog. 42057 """ 42058 42059 def SetOKCancelLabels(self, ok, cancel): 42060 """ 42061 SetOKCancelLabels(ok, cancel) -> bool 42062 42063 Overrides the default labels of the OK and Cancel buttons. 42064 """ 42065 42066 def SetOKLabel(self, ok): 42067 """ 42068 SetOKLabel(ok) -> bool 42069 42070 Overrides the default label of the OK button. 42071 """ 42072 42073 def SetYesNoCancelLabels(self, yes, no, cancel): 42074 """ 42075 SetYesNoCancelLabels(yes, no, cancel) -> bool 42076 42077 Overrides the default labels of the Yes, No and Cancel buttons. 42078 """ 42079 42080 def SetYesNoLabels(self, yes, no): 42081 """ 42082 SetYesNoLabels(yes, no) -> bool 42083 42084 Overrides the default labels of the Yes and No buttons. 42085 """ 42086 42087 def ShowModal(self): 42088 """ 42089 ShowModal() -> int 42090 42091 Shows the dialog, returning one of wxID_OK, wxID_CANCEL, wxID_YES, 42092 wxID_NO or wxID_HELP. 42093 """ 42094 42095 def GetCaption(self): 42096 """ 42097 GetCaption() -> String 42098 """ 42099 42100 def GetMessage(self): 42101 """ 42102 GetMessage() -> String 42103 """ 42104 42105 def GetExtendedMessage(self): 42106 """ 42107 GetExtendedMessage() -> String 42108 """ 42109 42110 def GetMessageDialogStyle(self): 42111 """ 42112 GetMessageDialogStyle() -> long 42113 """ 42114 42115 def HasCustomLabels(self): 42116 """ 42117 HasCustomLabels() -> bool 42118 """ 42119 42120 def GetYesLabel(self): 42121 """ 42122 GetYesLabel() -> String 42123 """ 42124 42125 def GetNoLabel(self): 42126 """ 42127 GetNoLabel() -> String 42128 """ 42129 42130 def GetOKLabel(self): 42131 """ 42132 GetOKLabel() -> String 42133 """ 42134 42135 def GetCancelLabel(self): 42136 """ 42137 GetCancelLabel() -> String 42138 """ 42139 42140 def GetHelpLabel(self): 42141 """ 42142 GetHelpLabel() -> String 42143 """ 42144 42145 def GetEffectiveIcon(self): 42146 """ 42147 GetEffectiveIcon() -> long 42148 """ 42149 42150 @staticmethod 42151 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 42152 """ 42153 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 42154 """ 42155 CancelLabel = property(None, None) 42156 Caption = property(None, None) 42157 EffectiveIcon = property(None, None) 42158 ExtendedMessage = property(None, None) 42159 HelpLabel = property(None, None) 42160 Message = property(None, None) 42161 MessageDialogStyle = property(None, None) 42162 NoLabel = property(None, None) 42163 OKLabel = property(None, None) 42164 YesLabel = property(None, None) 42165# end of class MessageDialog 42166 42167 42168def MessageBox(message, caption=MessageBoxCaptionStr, style=OK|CENTRE, parent=None, x=DefaultCoord, y=DefaultCoord): 42169 """ 42170 MessageBox(message, caption=MessageBoxCaptionStr, style=OK|CENTRE, parent=None, x=DefaultCoord, y=DefaultCoord) -> int 42171 42172 Show a general purpose message dialog. 42173 """ 42174 42175class GenericMessageDialog(Dialog): 42176 """ 42177 GenericMessageDialog(parent, message, caption=MessageBoxCaptionStr, style=OK|CENTRE, pos=DefaultPosition) 42178 42179 This class represents a dialog that shows a single or multi-line 42180 message, with a choice of OK, Yes, No and Cancel buttons. 42181 """ 42182 42183 def __init__(self, parent, message, caption=MessageBoxCaptionStr, style=OK|CENTRE, pos=DefaultPosition): 42184 """ 42185 GenericMessageDialog(parent, message, caption=MessageBoxCaptionStr, style=OK|CENTRE, pos=DefaultPosition) 42186 42187 This class represents a dialog that shows a single or multi-line 42188 message, with a choice of OK, Yes, No and Cancel buttons. 42189 """ 42190 42191 def SetExtendedMessage(self, extendedMessage): 42192 """ 42193 SetExtendedMessage(extendedMessage) 42194 42195 Sets the extended message for the dialog: this message is usually an 42196 extension of the short message specified in the constructor or set 42197 with SetMessage(). 42198 """ 42199 42200 def SetHelpLabel(self, help): 42201 """ 42202 SetHelpLabel(help) -> bool 42203 42204 Sets the label for the Help button. 42205 """ 42206 42207 def SetMessage(self, message): 42208 """ 42209 SetMessage(message) 42210 42211 Sets the message shown by the dialog. 42212 """ 42213 42214 def SetOKCancelLabels(self, ok, cancel): 42215 """ 42216 SetOKCancelLabels(ok, cancel) -> bool 42217 42218 Overrides the default labels of the OK and Cancel buttons. 42219 """ 42220 42221 def SetOKLabel(self, ok): 42222 """ 42223 SetOKLabel(ok) -> bool 42224 42225 Overrides the default label of the OK button. 42226 """ 42227 42228 def SetYesNoCancelLabels(self, yes, no, cancel): 42229 """ 42230 SetYesNoCancelLabels(yes, no, cancel) -> bool 42231 42232 Overrides the default labels of the Yes, No and Cancel buttons. 42233 """ 42234 42235 def SetYesNoLabels(self, yes, no): 42236 """ 42237 SetYesNoLabels(yes, no) -> bool 42238 42239 Overrides the default labels of the Yes and No buttons. 42240 """ 42241 42242 def ShowModal(self): 42243 """ 42244 ShowModal() -> int 42245 42246 Shows the dialog, returning one of wxID_OK, wxID_CANCEL, wxID_YES, 42247 wxID_NO or wxID_HELP. 42248 """ 42249 42250 def GetCaption(self): 42251 """ 42252 GetCaption() -> String 42253 """ 42254 42255 def GetMessage(self): 42256 """ 42257 GetMessage() -> String 42258 """ 42259 42260 def GetExtendedMessage(self): 42261 """ 42262 GetExtendedMessage() -> String 42263 """ 42264 42265 def GetMessageDialogStyle(self): 42266 """ 42267 GetMessageDialogStyle() -> long 42268 """ 42269 42270 def HasCustomLabels(self): 42271 """ 42272 HasCustomLabels() -> bool 42273 """ 42274 42275 def GetYesLabel(self): 42276 """ 42277 GetYesLabel() -> String 42278 """ 42279 42280 def GetNoLabel(self): 42281 """ 42282 GetNoLabel() -> String 42283 """ 42284 42285 def GetOKLabel(self): 42286 """ 42287 GetOKLabel() -> String 42288 """ 42289 42290 def GetCancelLabel(self): 42291 """ 42292 GetCancelLabel() -> String 42293 """ 42294 42295 def GetHelpLabel(self): 42296 """ 42297 GetHelpLabel() -> String 42298 """ 42299 42300 def GetEffectiveIcon(self): 42301 """ 42302 GetEffectiveIcon() -> long 42303 """ 42304 42305 @staticmethod 42306 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 42307 """ 42308 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 42309 """ 42310 CancelLabel = property(None, None) 42311 Caption = property(None, None) 42312 EffectiveIcon = property(None, None) 42313 ExtendedMessage = property(None, None) 42314 HelpLabel = property(None, None) 42315 Message = property(None, None) 42316 MessageDialogStyle = property(None, None) 42317 NoLabel = property(None, None) 42318 OKLabel = property(None, None) 42319 YesLabel = property(None, None) 42320 42321 def AddMessageDialogCheckBox(self, sizer): 42322 """ 42323 AddMessageDialogCheckBox(sizer) 42324 42325 Can be overridden to provide more contents for the dialog 42326 """ 42327 42328 def AddMessageDialogDetails(self, sizer): 42329 """ 42330 AddMessageDialogDetails(sizer) 42331 42332 Can be overridden to provide more contents for the dialog 42333 """ 42334# end of class GenericMessageDialog 42335 42336#-- end-msgdlg --# 42337#-- begin-richmsgdlg --# 42338 42339class RichMessageDialog(GenericMessageDialog): 42340 """ 42341 RichMessageDialog(parent, message, caption=MessageBoxCaptionStr, style=OK|CENTRE) 42342 42343 Extension of wxMessageDialog with additional functionality. 42344 """ 42345 42346 def __init__(self, parent, message, caption=MessageBoxCaptionStr, style=OK|CENTRE): 42347 """ 42348 RichMessageDialog(parent, message, caption=MessageBoxCaptionStr, style=OK|CENTRE) 42349 42350 Extension of wxMessageDialog with additional functionality. 42351 """ 42352 42353 def ShowCheckBox(self, checkBoxText, checked=False): 42354 """ 42355 ShowCheckBox(checkBoxText, checked=False) 42356 42357 Shows a checkbox with a given label or hides it. 42358 """ 42359 42360 def GetCheckBoxText(self): 42361 """ 42362 GetCheckBoxText() -> String 42363 42364 Retrieves the label for the checkbox. 42365 """ 42366 42367 def ShowDetailedText(self, detailedText): 42368 """ 42369 ShowDetailedText(detailedText) 42370 42371 Shows or hides a detailed text and an expander that is used to show or 42372 hide the detailed text. 42373 """ 42374 42375 def GetDetailedText(self): 42376 """ 42377 GetDetailedText() -> String 42378 42379 Retrieves the detailed text. 42380 """ 42381 42382 def IsCheckBoxChecked(self): 42383 """ 42384 IsCheckBoxChecked() -> bool 42385 42386 Retrieves the state of the checkbox. 42387 """ 42388 42389 def ShowModal(self): 42390 """ 42391 ShowModal() -> int 42392 42393 Shows the dialog, returning one of wxID_OK, wxID_CANCEL, wxID_YES, 42394 wxID_NO. 42395 """ 42396 42397 @staticmethod 42398 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 42399 """ 42400 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 42401 """ 42402 CheckBoxText = property(None, None) 42403 DetailedText = property(None, None) 42404# end of class RichMessageDialog 42405 42406#-- end-richmsgdlg --# 42407#-- begin-progdlg --# 42408PD_CAN_ABORT = 0 42409PD_APP_MODAL = 0 42410PD_AUTO_HIDE = 0 42411PD_ELAPSED_TIME = 0 42412PD_ESTIMATED_TIME = 0 42413PD_SMOOTH = 0 42414PD_REMAINING_TIME = 0 42415PD_CAN_SKIP = 0 42416 42417class GenericProgressDialog(Dialog): 42418 """ 42419 GenericProgressDialog(title, message, maximum=100, parent=None, style=PD_AUTO_HIDE|PD_APP_MODAL) 42420 42421 This class represents a dialog that shows a short message and a 42422 progress bar. 42423 """ 42424 42425 def __init__(self, title, message, maximum=100, parent=None, style=PD_AUTO_HIDE|PD_APP_MODAL): 42426 """ 42427 GenericProgressDialog(title, message, maximum=100, parent=None, style=PD_AUTO_HIDE|PD_APP_MODAL) 42428 42429 This class represents a dialog that shows a short message and a 42430 progress bar. 42431 """ 42432 42433 def GetValue(self): 42434 """ 42435 GetValue() -> int 42436 42437 Returns the last value passed to the Update() function or wxNOT_FOUND 42438 if the dialog has no progress bar. 42439 """ 42440 42441 def GetRange(self): 42442 """ 42443 GetRange() -> int 42444 42445 Returns the maximum value of the progress meter, as passed to the 42446 constructor or wxNOT_FOUND if the dialog has no progress bar. 42447 """ 42448 42449 def GetMessage(self): 42450 """ 42451 GetMessage() -> String 42452 42453 Returns the last message passed to the Update() function; if you 42454 always passed wxEmptyString to Update() then the message set through 42455 the constructor is returned. 42456 """ 42457 42458 def Pulse(self, newmsg=EmptyString): 42459 """ 42460 Pulse(newmsg=EmptyString) -> (bool, skip) 42461 42462 Like Update() but makes the gauge control run in indeterminate mode. 42463 """ 42464 42465 def Resume(self): 42466 """ 42467 Resume() 42468 42469 Can be used to continue with the dialog, after the user had clicked 42470 the "Abort" button. 42471 """ 42472 42473 def SetRange(self, maximum): 42474 """ 42475 SetRange(maximum) 42476 42477 Changes the maximum value of the progress meter given in the 42478 constructor. 42479 """ 42480 42481 def WasCancelled(self): 42482 """ 42483 WasCancelled() -> bool 42484 42485 Returns true if the "Cancel" button was pressed. 42486 """ 42487 42488 def WasSkipped(self): 42489 """ 42490 WasSkipped() -> bool 42491 42492 Returns true if the "Skip" button was pressed. 42493 """ 42494 42495 def Update(self, value, newmsg=EmptyString): 42496 """ 42497 Update(value, newmsg=EmptyString) -> (bool, skip) 42498 42499 Updates the dialog, setting the progress bar to the new value and 42500 updating the message if new one is specified. 42501 """ 42502 42503 @staticmethod 42504 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 42505 """ 42506 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 42507 """ 42508 Message = property(None, None) 42509 Range = property(None, None) 42510 Value = property(None, None) 42511# end of class GenericProgressDialog 42512 42513 42514class ProgressDialog(GenericProgressDialog): 42515 """ 42516 ProgressDialog(title, message, maximum=100, parent=None, style=PD_APP_MODAL|PD_AUTO_HIDE) 42517 42518 If supported by the platform this class will provide the platform's 42519 native progress dialog, else it will simply be the 42520 wxGenericProgressDialog. 42521 """ 42522 42523 def __init__(self, title, message, maximum=100, parent=None, style=PD_APP_MODAL|PD_AUTO_HIDE): 42524 """ 42525 ProgressDialog(title, message, maximum=100, parent=None, style=PD_APP_MODAL|PD_AUTO_HIDE) 42526 42527 If supported by the platform this class will provide the platform's 42528 native progress dialog, else it will simply be the 42529 wxGenericProgressDialog. 42530 """ 42531 42532 def GetValue(self): 42533 """ 42534 GetValue() -> int 42535 42536 Returns the last value passed to the Update() function or wxNOT_FOUND 42537 if the dialog has no progress bar. 42538 """ 42539 42540 def GetRange(self): 42541 """ 42542 GetRange() -> int 42543 42544 Returns the maximum value of the progress meter, as passed to the 42545 constructor or wxNOT_FOUND if the dialog has no progress bar. 42546 """ 42547 42548 def GetMessage(self): 42549 """ 42550 GetMessage() -> String 42551 42552 Returns the last message passed to the Update() function; if you 42553 always passed wxEmptyString to Update() then the message set through 42554 the constructor is returned. 42555 """ 42556 42557 def Pulse(self, newmsg=EmptyString): 42558 """ 42559 Pulse(newmsg=EmptyString) -> (bool, skip) 42560 42561 Like Update() but makes the gauge control run in indeterminate mode. 42562 """ 42563 42564 def Resume(self): 42565 """ 42566 Resume() 42567 42568 Can be used to continue with the dialog, after the user had clicked 42569 the "Abort" button. 42570 """ 42571 42572 def SetRange(self, maximum): 42573 """ 42574 SetRange(maximum) 42575 42576 Changes the maximum value of the progress meter given in the 42577 constructor. 42578 """ 42579 42580 def WasCancelled(self): 42581 """ 42582 WasCancelled() -> bool 42583 42584 Returns true if the "Cancel" button was pressed. 42585 """ 42586 42587 def WasSkipped(self): 42588 """ 42589 WasSkipped() -> bool 42590 42591 Returns true if the "Skip" button was pressed. 42592 """ 42593 42594 def Update(self, value, newmsg=EmptyString): 42595 """ 42596 Update(value, newmsg=EmptyString) -> (bool, skip) 42597 42598 Updates the dialog, setting the progress bar to the new value and 42599 updating the message if new one is specified. 42600 """ 42601 42602 @staticmethod 42603 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 42604 """ 42605 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 42606 """ 42607 Message = property(None, None) 42608 Range = property(None, None) 42609 Value = property(None, None) 42610# end of class ProgressDialog 42611 42612#-- end-progdlg --# 42613#-- begin-popupwin --# 42614 42615class PopupWindow(NonOwnedWindow): 42616 """ 42617 PopupWindow() 42618 PopupWindow(parent, flags=BORDER_NONE) 42619 42620 A special kind of top level window used for popup menus, combobox 42621 popups and such. 42622 """ 42623 42624 def __init__(self, *args, **kw): 42625 """ 42626 PopupWindow() 42627 PopupWindow(parent, flags=BORDER_NONE) 42628 42629 A special kind of top level window used for popup menus, combobox 42630 popups and such. 42631 """ 42632 42633 def Create(self, parent, flags=BORDER_NONE): 42634 """ 42635 Create(parent, flags=BORDER_NONE) -> bool 42636 42637 Create method for two-step creation. 42638 """ 42639 42640 def Position(self, ptOrigin, sizePopup): 42641 """ 42642 Position(ptOrigin, sizePopup) 42643 42644 Move the popup window to the right position, i.e. such that it is 42645 entirely visible. 42646 """ 42647 42648 @staticmethod 42649 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 42650 """ 42651 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 42652 """ 42653# end of class PopupWindow 42654 42655 42656class PopupTransientWindow(PopupWindow): 42657 """ 42658 PopupTransientWindow() 42659 PopupTransientWindow(parent, flags=BORDER_NONE) 42660 42661 A wxPopupWindow which disappears automatically when the user clicks 42662 mouse outside it or if it loses focus in any other way. 42663 """ 42664 42665 def __init__(self, *args, **kw): 42666 """ 42667 PopupTransientWindow() 42668 PopupTransientWindow(parent, flags=BORDER_NONE) 42669 42670 A wxPopupWindow which disappears automatically when the user clicks 42671 mouse outside it or if it loses focus in any other way. 42672 """ 42673 42674 def Popup(self, focus=None): 42675 """ 42676 Popup(focus=None) 42677 42678 Popup the window (this will show it too). 42679 """ 42680 42681 def Dismiss(self): 42682 """ 42683 Dismiss() 42684 42685 Hide the window. 42686 """ 42687 42688 def ProcessLeftDown(self, event): 42689 """ 42690 ProcessLeftDown(event) -> bool 42691 42692 Called when a mouse is pressed while the popup is shown. 42693 """ 42694 42695 @staticmethod 42696 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 42697 """ 42698 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 42699 """ 42700 42701 def OnDismiss(self): 42702 """ 42703 OnDismiss() 42704 42705 This is called when the popup is disappeared because of anything else 42706 but direct call to Dismiss(). 42707 """ 42708# end of class PopupTransientWindow 42709 42710#-- end-popupwin --# 42711#-- begin-tipwin --# 42712 42713class TipWindow(Window): 42714 """ 42715 TipWindow(parent, text, maxLength=100) 42716 42717 Shows simple text in a popup tip window on creation. 42718 """ 42719 42720 def __init__(self, parent, text, maxLength=100): 42721 """ 42722 TipWindow(parent, text, maxLength=100) 42723 42724 Shows simple text in a popup tip window on creation. 42725 """ 42726 42727 def SetBoundingRect(self, rectBound): 42728 """ 42729 SetBoundingRect(rectBound) 42730 42731 By default, the tip window disappears when the user clicks the mouse 42732 or presses a keyboard key or if it loses focus in any other way - for 42733 example because the user switched to another application window. 42734 """ 42735 42736 @staticmethod 42737 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 42738 """ 42739 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 42740 """ 42741# end of class TipWindow 42742 42743#-- end-tipwin --# 42744#-- begin-colordlg --# 42745 42746class ColourData(Object): 42747 """ 42748 ColourData() 42749 42750 This class holds a variety of information related to colour dialogs. 42751 """ 42752 NUM_CUSTOM = 0 42753 42754 def __init__(self): 42755 """ 42756 ColourData() 42757 42758 This class holds a variety of information related to colour dialogs. 42759 """ 42760 42761 def GetChooseFull(self): 42762 """ 42763 GetChooseFull() -> bool 42764 42765 Under Windows, determines whether the Windows colour dialog will 42766 display the full dialog with custom colour selection controls. 42767 """ 42768 42769 def GetColour(self): 42770 """ 42771 GetColour() -> Colour 42772 42773 Gets the current colour associated with the colour dialog. 42774 """ 42775 42776 def GetCustomColour(self, i): 42777 """ 42778 GetCustomColour(i) -> Colour 42779 42780 Returns custom colours associated with the colour dialog. 42781 """ 42782 42783 def SetChooseFull(self, flag): 42784 """ 42785 SetChooseFull(flag) 42786 42787 Under Windows, tells the Windows colour dialog to display the full 42788 dialog with custom colour selection controls. 42789 """ 42790 42791 def SetColour(self, colour): 42792 """ 42793 SetColour(colour) 42794 42795 Sets the default colour for the colour dialog. 42796 """ 42797 42798 def SetCustomColour(self, i, colour): 42799 """ 42800 SetCustomColour(i, colour) 42801 42802 Sets custom colours for the colour dialog. 42803 """ 42804 42805 def ToString(self): 42806 """ 42807 ToString() -> String 42808 42809 Converts the colours saved in this class in a string form, separating 42810 the various colours with a comma. 42811 """ 42812 42813 def FromString(self, str): 42814 """ 42815 FromString(str) -> bool 42816 42817 Decodes the given string, which should be in the same format returned 42818 by ToString(), and sets the internal colours. 42819 """ 42820 ChooseFull = property(None, None) 42821 Colour = property(None, None) 42822# end of class ColourData 42823 42824 42825class ColourDialog(Dialog): 42826 """ 42827 ColourDialog(parent, data=None) 42828 42829 This class represents the colour chooser dialog. 42830 """ 42831 42832 def __init__(self, parent, data=None): 42833 """ 42834 ColourDialog(parent, data=None) 42835 42836 This class represents the colour chooser dialog. 42837 """ 42838 42839 def Create(self, parent, data=None): 42840 """ 42841 Create(parent, data=None) -> bool 42842 42843 Same as wxColourDialog(). 42844 """ 42845 42846 def GetColourData(self): 42847 """ 42848 GetColourData() -> ColourData 42849 42850 Returns the colour data associated with the colour dialog. 42851 """ 42852 42853 def ShowModal(self): 42854 """ 42855 ShowModal() -> int 42856 42857 Shows the dialog, returning wxID_OK if the user pressed OK, and 42858 wxID_CANCEL otherwise. 42859 """ 42860 42861 @staticmethod 42862 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 42863 """ 42864 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 42865 """ 42866 ColourData = property(None, None) 42867# end of class ColourDialog 42868 42869 42870def GetColourFromUser(parent, colInit, caption=EmptyString, data=None): 42871 """ 42872 GetColourFromUser(parent, colInit, caption=EmptyString, data=None) -> Colour 42873 42874 Shows the colour selection dialog and returns the colour selected by 42875 user or invalid colour (use wxColour::IsOk() to test whether a colour 42876 is valid) if the dialog was cancelled. 42877 """ 42878#-- end-colordlg --# 42879#-- begin-choicdlg --# 42880CHOICE_WIDTH = 0 42881CHOICE_HEIGHT = 0 42882CHOICEDLG_STYLE = 0 42883 42884class MultiChoiceDialog(Dialog): 42885 """ 42886 MultiChoiceDialog(parent, message, caption, n, choices, style=CHOICEDLG_STYLE, pos=DefaultPosition) 42887 MultiChoiceDialog(parent, message, caption, choices, style=CHOICEDLG_STYLE, pos=DefaultPosition) 42888 42889 This class represents a dialog that shows a list of strings, and 42890 allows the user to select one or more. 42891 """ 42892 42893 def __init__(self, *args, **kw): 42894 """ 42895 MultiChoiceDialog(parent, message, caption, n, choices, style=CHOICEDLG_STYLE, pos=DefaultPosition) 42896 MultiChoiceDialog(parent, message, caption, choices, style=CHOICEDLG_STYLE, pos=DefaultPosition) 42897 42898 This class represents a dialog that shows a list of strings, and 42899 allows the user to select one or more. 42900 """ 42901 42902 def GetSelections(self): 42903 """ 42904 GetSelections() -> ArrayInt 42905 42906 Returns array with indexes of selected items. 42907 """ 42908 42909 def SetSelections(self, selections): 42910 """ 42911 SetSelections(selections) 42912 42913 Sets selected items from the array of selected items' indexes. 42914 """ 42915 42916 def ShowModal(self): 42917 """ 42918 ShowModal() -> int 42919 42920 Shows the dialog, returning either wxID_OK or wxID_CANCEL. 42921 """ 42922 42923 @staticmethod 42924 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 42925 """ 42926 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 42927 """ 42928 Selections = property(None, None) 42929# end of class MultiChoiceDialog 42930 42931 42932class SingleChoiceDialog(Dialog): 42933 """ 42934 PySingleChoiceDialog(parent, message, caption, choices, style=CHOICEDLG_STYLE, pos=DefaultPosition) 42935 42936 This class represents a dialog that shows a list of strings, and 42937 allows the user to select one. 42938 """ 42939 42940 def __init__(self, parent, message, caption, choices, style=CHOICEDLG_STYLE, pos=DefaultPosition): 42941 """ 42942 PySingleChoiceDialog(parent, message, caption, choices, style=CHOICEDLG_STYLE, pos=DefaultPosition) 42943 42944 This class represents a dialog that shows a list of strings, and 42945 allows the user to select one. 42946 """ 42947 42948 def GetSelection(self): 42949 """ 42950 GetSelection() -> int 42951 42952 Returns the index of selected item. 42953 """ 42954 42955 def GetStringSelection(self): 42956 """ 42957 GetStringSelection() -> String 42958 42959 Returns the selected string. 42960 """ 42961 42962 def SetSelection(self, selection): 42963 """ 42964 SetSelection(selection) 42965 42966 Sets the index of the initially selected item. 42967 """ 42968 42969 def ShowModal(self): 42970 """ 42971 ShowModal() -> int 42972 42973 Shows the dialog, returning either wxID_OK or wxID_CANCEL. 42974 """ 42975 42976 @staticmethod 42977 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 42978 """ 42979 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 42980 """ 42981 Selection = property(None, None) 42982 StringSelection = property(None, None) 42983# end of class SingleChoiceDialog 42984 42985 42986def GetSingleChoice(*args, **kw): 42987 """ 42988 GetSingleChoice(message, caption, aChoices, parent=None, x=DefaultCoord, y=DefaultCoord, centre=True, width=CHOICE_WIDTH, height=CHOICE_HEIGHT, initialSelection=0) -> String 42989 GetSingleChoice(message, caption, choices, initialSelection, parent=None) -> String 42990 42991 Pops up a dialog box containing a message, OK/Cancel buttons and a 42992 single-selection listbox. 42993 """ 42994#-- end-choicdlg --# 42995#-- begin-fdrepdlg --# 42996FR_DOWN = 0 42997FR_WHOLEWORD = 0 42998FR_MATCHCASE = 0 42999FR_REPLACEDIALOG = 0 43000FR_NOUPDOWN = 0 43001FR_NOMATCHCASE = 0 43002FR_NOWHOLEWORD = 0 43003wxEVT_FIND = 0 43004wxEVT_FIND_NEXT = 0 43005wxEVT_FIND_REPLACE = 0 43006wxEVT_FIND_REPLACE_ALL = 0 43007wxEVT_FIND_CLOSE = 0 43008 43009class FindDialogEvent(CommandEvent): 43010 """ 43011 FindDialogEvent(commandType=wxEVT_NULL, id=0) 43012 43013 wxFindReplaceDialog events. 43014 """ 43015 43016 def __init__(self, commandType=wxEVT_NULL, id=0): 43017 """ 43018 FindDialogEvent(commandType=wxEVT_NULL, id=0) 43019 43020 wxFindReplaceDialog events. 43021 """ 43022 43023 def GetDialog(self): 43024 """ 43025 GetDialog() -> FindReplaceDialog 43026 43027 Return the pointer to the dialog which generated this event. 43028 """ 43029 43030 def GetFindString(self): 43031 """ 43032 GetFindString() -> String 43033 43034 Return the string to find (never empty). 43035 """ 43036 43037 def GetFlags(self): 43038 """ 43039 GetFlags() -> int 43040 43041 Get the currently selected flags: this is the combination of the 43042 wxFindReplaceFlags enumeration values. 43043 """ 43044 43045 def GetReplaceString(self): 43046 """ 43047 GetReplaceString() -> String 43048 43049 Return the string to replace the search string with (only for replace 43050 and replace all events). 43051 """ 43052 Dialog = property(None, None) 43053 FindString = property(None, None) 43054 Flags = property(None, None) 43055 ReplaceString = property(None, None) 43056# end of class FindDialogEvent 43057 43058 43059class FindReplaceData(Object): 43060 """ 43061 FindReplaceData(flags=0) 43062 43063 wxFindReplaceData holds the data for wxFindReplaceDialog. 43064 """ 43065 43066 def __init__(self, flags=0): 43067 """ 43068 FindReplaceData(flags=0) 43069 43070 wxFindReplaceData holds the data for wxFindReplaceDialog. 43071 """ 43072 43073 def GetFindString(self): 43074 """ 43075 GetFindString() -> String 43076 43077 Get the string to find. 43078 """ 43079 43080 def GetFlags(self): 43081 """ 43082 GetFlags() -> int 43083 43084 Get the combination of wxFindReplaceFlags values. 43085 """ 43086 43087 def GetReplaceString(self): 43088 """ 43089 GetReplaceString() -> String 43090 43091 Get the replacement string. 43092 """ 43093 43094 def SetFindString(self, str): 43095 """ 43096 SetFindString(str) 43097 43098 Set the string to find (used as initial value by the dialog). 43099 """ 43100 43101 def SetFlags(self, flags): 43102 """ 43103 SetFlags(flags) 43104 43105 Set the flags to use to initialize the controls of the dialog. 43106 """ 43107 43108 def SetReplaceString(self, str): 43109 """ 43110 SetReplaceString(str) 43111 43112 Set the replacement string (used as initial value by the dialog). 43113 """ 43114 FindString = property(None, None) 43115 Flags = property(None, None) 43116 ReplaceString = property(None, None) 43117# end of class FindReplaceData 43118 43119 43120class FindReplaceDialog(Dialog): 43121 """ 43122 FindReplaceDialog() 43123 FindReplaceDialog(parent, data, title=EmptyString, style=0) 43124 43125 wxFindReplaceDialog is a standard modeless dialog which is used to 43126 allow the user to search for some text (and possibly replace it with 43127 something else). 43128 """ 43129 43130 def __init__(self, *args, **kw): 43131 """ 43132 FindReplaceDialog() 43133 FindReplaceDialog(parent, data, title=EmptyString, style=0) 43134 43135 wxFindReplaceDialog is a standard modeless dialog which is used to 43136 allow the user to search for some text (and possibly replace it with 43137 something else). 43138 """ 43139 43140 def Create(self, parent, data, title=EmptyString, style=0): 43141 """ 43142 Create(parent, data, title=EmptyString, style=0) -> bool 43143 43144 Creates the dialog; use wxWindow::Show to show it on screen. 43145 """ 43146 43147 def GetData(self): 43148 """ 43149 GetData() -> FindReplaceData 43150 43151 Get the wxFindReplaceData object used by this dialog. 43152 """ 43153 43154 @staticmethod 43155 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 43156 """ 43157 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 43158 """ 43159 Data = property(None, None) 43160# end of class FindReplaceDialog 43161 43162 43163EVT_FIND = wx.PyEventBinder( wxEVT_FIND, 1 ) 43164EVT_FIND_NEXT = wx.PyEventBinder( wxEVT_FIND_NEXT, 1 ) 43165EVT_FIND_REPLACE = wx.PyEventBinder( wxEVT_FIND_REPLACE, 1 ) 43166EVT_FIND_REPLACE_ALL = wx.PyEventBinder( wxEVT_FIND_REPLACE_ALL, 1 ) 43167EVT_FIND_CLOSE = wx.PyEventBinder( wxEVT_FIND_CLOSE, 1 ) 43168 43169# deprecated wxEVT aliases 43170wxEVT_COMMAND_FIND = wxEVT_FIND 43171wxEVT_COMMAND_FIND_NEXT = wxEVT_FIND_NEXT 43172wxEVT_COMMAND_FIND_REPLACE = wxEVT_FIND_REPLACE 43173wxEVT_COMMAND_FIND_REPLACE_ALL = wxEVT_FIND_REPLACE_ALL 43174wxEVT_COMMAND_FIND_CLOSE = wxEVT_FIND_CLOSE 43175#-- end-fdrepdlg --# 43176#-- begin-mdi --# 43177 43178class MDIClientWindow(Window): 43179 """ 43180 MDIClientWindow() 43181 43182 An MDI client window is a child of wxMDIParentFrame, and manages zero 43183 or more wxMDIChildFrame objects. 43184 """ 43185 43186 def __init__(self): 43187 """ 43188 MDIClientWindow() 43189 43190 An MDI client window is a child of wxMDIParentFrame, and manages zero 43191 or more wxMDIChildFrame objects. 43192 """ 43193 43194 def CreateClient(self, parent, style=0): 43195 """ 43196 CreateClient(parent, style=0) -> bool 43197 43198 Called by wxMDIParentFrame immediately after creating the client 43199 window. 43200 """ 43201 43202 @staticmethod 43203 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 43204 """ 43205 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 43206 """ 43207# end of class MDIClientWindow 43208 43209 43210class MDIParentFrame(Frame): 43211 """ 43212 MDIParentFrame() 43213 MDIParentFrame(parent, id=ID_ANY, title=EmptyString, pos=DefaultPosition, size=DefaultSize, style=DEFAULT_FRAME_STYLE|VSCROLL|HSCROLL, name=FrameNameStr) 43214 43215 An MDI (Multiple Document Interface) parent frame is a window which 43216 can contain MDI child frames in its client area which emulates the 43217 full desktop. 43218 """ 43219 43220 def __init__(self, *args, **kw): 43221 """ 43222 MDIParentFrame() 43223 MDIParentFrame(parent, id=ID_ANY, title=EmptyString, pos=DefaultPosition, size=DefaultSize, style=DEFAULT_FRAME_STYLE|VSCROLL|HSCROLL, name=FrameNameStr) 43224 43225 An MDI (Multiple Document Interface) parent frame is a window which 43226 can contain MDI child frames in its client area which emulates the 43227 full desktop. 43228 """ 43229 43230 def ActivateNext(self): 43231 """ 43232 ActivateNext() 43233 43234 Activates the MDI child following the currently active one. 43235 """ 43236 43237 def ActivatePrevious(self): 43238 """ 43239 ActivatePrevious() 43240 43241 Activates the MDI child preceding the currently active one. 43242 """ 43243 43244 def ArrangeIcons(self): 43245 """ 43246 ArrangeIcons() 43247 43248 Arranges any iconized (minimized) MDI child windows. 43249 """ 43250 43251 def Cascade(self): 43252 """ 43253 Cascade() 43254 43255 Arranges the MDI child windows in a cascade. 43256 """ 43257 43258 def Create(self, parent, id=ID_ANY, title=EmptyString, pos=DefaultPosition, size=DefaultSize, style=DEFAULT_FRAME_STYLE|VSCROLL|HSCROLL, name=FrameNameStr): 43259 """ 43260 Create(parent, id=ID_ANY, title=EmptyString, pos=DefaultPosition, size=DefaultSize, style=DEFAULT_FRAME_STYLE|VSCROLL|HSCROLL, name=FrameNameStr) -> bool 43261 43262 Used in two-step frame construction. 43263 """ 43264 43265 def GetActiveChild(self): 43266 """ 43267 GetActiveChild() -> MDIChildFrame 43268 43269 Returns a pointer to the active MDI child, if there is one. 43270 """ 43271 43272 def GetClientWindow(self): 43273 """ 43274 GetClientWindow() -> MDIClientWindow 43275 43276 Returns a pointer to the client window. 43277 """ 43278 43279 def GetWindowMenu(self): 43280 """ 43281 GetWindowMenu() -> Menu 43282 43283 Returns the current MDI Window menu. 43284 """ 43285 43286 def OnCreateClient(self): 43287 """ 43288 OnCreateClient() -> MDIClientWindow 43289 43290 Override this to return a different kind of client window. 43291 """ 43292 43293 def SetWindowMenu(self, menu): 43294 """ 43295 SetWindowMenu(menu) 43296 43297 Replace the current MDI Window menu. 43298 """ 43299 43300 def Tile(self, orient=HORIZONTAL): 43301 """ 43302 Tile(orient=HORIZONTAL) 43303 43304 Tiles the MDI child windows either horizontally or vertically 43305 depending on whether orient is wxHORIZONTAL or wxVERTICAL. 43306 """ 43307 43308 @staticmethod 43309 def IsTDI(): 43310 """ 43311 IsTDI() -> bool 43312 43313 Returns whether the MDI implementation is tab-based. 43314 """ 43315 43316 @staticmethod 43317 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 43318 """ 43319 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 43320 """ 43321 ActiveChild = property(None, None) 43322 ClientWindow = property(None, None) 43323 WindowMenu = property(None, None) 43324# end of class MDIParentFrame 43325 43326 43327class MDIChildFrame(Frame): 43328 """ 43329 MDIChildFrame() 43330 MDIChildFrame(parent, id=ID_ANY, title=EmptyString, pos=DefaultPosition, size=DefaultSize, style=DEFAULT_FRAME_STYLE, name=FrameNameStr) 43331 43332 An MDI child frame is a frame that can only exist inside a 43333 wxMDIClientWindow, which is itself a child of wxMDIParentFrame. 43334 """ 43335 43336 def __init__(self, *args, **kw): 43337 """ 43338 MDIChildFrame() 43339 MDIChildFrame(parent, id=ID_ANY, title=EmptyString, pos=DefaultPosition, size=DefaultSize, style=DEFAULT_FRAME_STYLE, name=FrameNameStr) 43340 43341 An MDI child frame is a frame that can only exist inside a 43342 wxMDIClientWindow, which is itself a child of wxMDIParentFrame. 43343 """ 43344 43345 def Activate(self): 43346 """ 43347 Activate() 43348 43349 Activates this MDI child frame. 43350 """ 43351 43352 def Create(self, parent, id=ID_ANY, title=EmptyString, pos=DefaultPosition, size=DefaultSize, style=DEFAULT_FRAME_STYLE, name=FrameNameStr): 43353 """ 43354 Create(parent, id=ID_ANY, title=EmptyString, pos=DefaultPosition, size=DefaultSize, style=DEFAULT_FRAME_STYLE, name=FrameNameStr) -> bool 43355 43356 Used in two-step frame construction. 43357 """ 43358 43359 def GetMDIParent(self): 43360 """ 43361 GetMDIParent() -> MDIParentFrame 43362 43363 Returns the MDI parent frame containing this child. 43364 """ 43365 43366 def IsAlwaysMaximized(self): 43367 """ 43368 IsAlwaysMaximized() -> bool 43369 43370 Returns true for MDI children in TDI implementations. 43371 """ 43372 43373 def Maximize(self, maximize=True): 43374 """ 43375 Maximize(maximize=True) 43376 43377 Maximizes this MDI child frame. 43378 """ 43379 43380 def Restore(self): 43381 """ 43382 Restore() 43383 43384 Restores this MDI child frame (unmaximizes). 43385 """ 43386 43387 @staticmethod 43388 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 43389 """ 43390 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 43391 """ 43392 MDIParent = property(None, None) 43393# end of class MDIChildFrame 43394 43395#-- end-mdi --# 43396#-- begin-fontdlg --# 43397 43398class FontData(Object): 43399 """ 43400 FontData() 43401 43402 This class holds a variety of information related to font dialogs. 43403 """ 43404 43405 def __init__(self): 43406 """ 43407 FontData() 43408 43409 This class holds a variety of information related to font dialogs. 43410 """ 43411 43412 def EnableEffects(self, enable): 43413 """ 43414 EnableEffects(enable) 43415 43416 Enables or disables "effects" under Windows or generic only. 43417 """ 43418 43419 def GetAllowSymbols(self): 43420 """ 43421 GetAllowSymbols() -> bool 43422 43423 Under Windows, returns a flag determining whether symbol fonts can be 43424 selected. 43425 """ 43426 43427 def GetChosenFont(self): 43428 """ 43429 GetChosenFont() -> Font 43430 43431 Gets the font chosen by the user if the user pressed OK 43432 (wxFontDialog::ShowModal() returned wxID_OK). 43433 """ 43434 43435 def GetColour(self): 43436 """ 43437 GetColour() -> Colour 43438 43439 Gets the colour associated with the font dialog. 43440 """ 43441 43442 def GetEnableEffects(self): 43443 """ 43444 GetEnableEffects() -> bool 43445 43446 Determines whether "effects" are enabled under Windows. 43447 """ 43448 43449 def GetInitialFont(self): 43450 """ 43451 GetInitialFont() -> Font 43452 43453 Gets the font that will be initially used by the font dialog. 43454 """ 43455 43456 def GetShowHelp(self): 43457 """ 43458 GetShowHelp() -> bool 43459 43460 Returns true if the Help button will be shown (Windows only). 43461 """ 43462 43463 def SetAllowSymbols(self, allowSymbols): 43464 """ 43465 SetAllowSymbols(allowSymbols) 43466 43467 Under Windows, determines whether symbol fonts can be selected. 43468 """ 43469 43470 def SetChosenFont(self, font): 43471 """ 43472 SetChosenFont(font) 43473 43474 Sets the font that will be returned to the user (for internal use 43475 only). 43476 """ 43477 43478 def SetColour(self, colour): 43479 """ 43480 SetColour(colour) 43481 43482 Sets the colour that will be used for the font foreground colour. 43483 """ 43484 43485 def SetInitialFont(self, font): 43486 """ 43487 SetInitialFont(font) 43488 43489 Sets the font that will be initially used by the font dialog. 43490 """ 43491 43492 def SetRange(self, min, max): 43493 """ 43494 SetRange(min, max) 43495 43496 Sets the valid range for the font point size (Windows only). 43497 """ 43498 43499 def SetShowHelp(self, showHelp): 43500 """ 43501 SetShowHelp(showHelp) 43502 43503 Determines whether the Help button will be displayed in the font 43504 dialog (Windows only). 43505 """ 43506 AllowSymbols = property(None, None) 43507 ChosenFont = property(None, None) 43508 Colour = property(None, None) 43509 InitialFont = property(None, None) 43510 ShowHelp = property(None, None) 43511# end of class FontData 43512 43513 43514class FontDialog(Dialog): 43515 """ 43516 FontDialog() 43517 FontDialog(parent) 43518 FontDialog(parent, data) 43519 43520 This class represents the font chooser dialog. 43521 """ 43522 43523 def __init__(self, *args, **kw): 43524 """ 43525 FontDialog() 43526 FontDialog(parent) 43527 FontDialog(parent, data) 43528 43529 This class represents the font chooser dialog. 43530 """ 43531 43532 def GetFontData(self): 43533 """ 43534 GetFontData() -> FontData 43535 43536 Returns the font data associated with the font dialog. 43537 """ 43538 43539 def Create(self, *args, **kw): 43540 """ 43541 Create(parent) -> bool 43542 Create(parent, data) -> bool 43543 43544 Creates the dialog if the wxFontDialog object had been initialized 43545 using the default constructor. 43546 """ 43547 43548 def ShowModal(self): 43549 """ 43550 ShowModal() -> int 43551 43552 Shows the dialog, returning wxID_OK if the user pressed Ok, and 43553 wxID_CANCEL otherwise. 43554 """ 43555 43556 @staticmethod 43557 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 43558 """ 43559 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 43560 """ 43561 FontData = property(None, None) 43562# end of class FontDialog 43563 43564 43565def GetFontFromUser(parent, fontInit, caption=EmptyString): 43566 """ 43567 GetFontFromUser(parent, fontInit, caption=EmptyString) -> Font 43568 43569 Shows the font selection dialog and returns the font selected by user 43570 or invalid font (use wxFont::IsOk() to test whether a font is valid) 43571 if the dialog was cancelled. 43572 """ 43573#-- end-fontdlg --# 43574#-- begin-rearrangectrl --# 43575RearrangeListNameStr = "" 43576RearrangeDialogNameStr = "" 43577 43578class RearrangeList(CheckListBox): 43579 """ 43580 RearrangeList() 43581 RearrangeList(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, order=[], items=[], style=0, validator=DefaultValidator, name=RearrangeListNameStr) 43582 43583 A listbox-like control allowing the user to rearrange the items and to 43584 enable or disable them. 43585 """ 43586 43587 def __init__(self, *args, **kw): 43588 """ 43589 RearrangeList() 43590 RearrangeList(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, order=[], items=[], style=0, validator=DefaultValidator, name=RearrangeListNameStr) 43591 43592 A listbox-like control allowing the user to rearrange the items and to 43593 enable or disable them. 43594 """ 43595 43596 def Create(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, order=[], items=[], style=0, validator=DefaultValidator, name=RearrangeListNameStr): 43597 """ 43598 Create(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, order=[], items=[], style=0, validator=DefaultValidator, name=RearrangeListNameStr) -> bool 43599 43600 Effectively creates the window for an object created using the default 43601 constructor. 43602 """ 43603 43604 def GetCurrentOrder(self): 43605 """ 43606 GetCurrentOrder() -> ArrayInt 43607 43608 Return the current order of the items. 43609 """ 43610 43611 def CanMoveCurrentUp(self): 43612 """ 43613 CanMoveCurrentUp() -> bool 43614 43615 Return true if the currently selected item can be moved up. 43616 """ 43617 43618 def CanMoveCurrentDown(self): 43619 """ 43620 CanMoveCurrentDown() -> bool 43621 43622 Return true if the currently selected item can be moved down. 43623 """ 43624 43625 def MoveCurrentUp(self): 43626 """ 43627 MoveCurrentUp() -> bool 43628 43629 Move the currently selected item one position above. 43630 """ 43631 43632 def MoveCurrentDown(self): 43633 """ 43634 MoveCurrentDown() -> bool 43635 43636 Move the currently selected item one position below. 43637 """ 43638 43639 @staticmethod 43640 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 43641 """ 43642 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 43643 """ 43644 CurrentOrder = property(None, None) 43645# end of class RearrangeList 43646 43647 43648class RearrangeCtrl(Panel): 43649 """ 43650 RearrangeCtrl() 43651 RearrangeCtrl(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, order=[], items=[], style=0, validator=DefaultValidator, name=RearrangeListNameStr) 43652 43653 A composite control containing a wxRearrangeList and the buttons 43654 allowing to move the items in it. 43655 """ 43656 43657 def __init__(self, *args, **kw): 43658 """ 43659 RearrangeCtrl() 43660 RearrangeCtrl(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, order=[], items=[], style=0, validator=DefaultValidator, name=RearrangeListNameStr) 43661 43662 A composite control containing a wxRearrangeList and the buttons 43663 allowing to move the items in it. 43664 """ 43665 43666 def Create(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, order=[], items=[], style=0, validator=DefaultValidator, name=RearrangeListNameStr): 43667 """ 43668 Create(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, order=[], items=[], style=0, validator=DefaultValidator, name=RearrangeListNameStr) -> bool 43669 43670 Effectively creates the window for an object created using the default 43671 constructor. 43672 """ 43673 43674 def GetList(self): 43675 """ 43676 GetList() -> RearrangeList 43677 43678 Return the listbox which is the main part of this control. 43679 """ 43680 43681 @staticmethod 43682 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 43683 """ 43684 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 43685 """ 43686 List = property(None, None) 43687# end of class RearrangeCtrl 43688 43689 43690class RearrangeDialog(Dialog): 43691 """ 43692 RearrangeDialog() 43693 RearrangeDialog(parent, message, title=EmptyString, order=[], items=[], pos=DefaultPosition, name=RearrangeDialogNameStr) 43694 43695 A dialog allowing the user to rearrange the specified items. 43696 """ 43697 43698 def __init__(self, *args, **kw): 43699 """ 43700 RearrangeDialog() 43701 RearrangeDialog(parent, message, title=EmptyString, order=[], items=[], pos=DefaultPosition, name=RearrangeDialogNameStr) 43702 43703 A dialog allowing the user to rearrange the specified items. 43704 """ 43705 43706 def Create(self, parent, message, title=EmptyString, order=[], items=[], pos=DefaultPosition, name=RearrangeDialogNameStr): 43707 """ 43708 Create(parent, message, title=EmptyString, order=[], items=[], pos=DefaultPosition, name=RearrangeDialogNameStr) -> bool 43709 43710 Effectively creates the dialog for an object created using the default 43711 constructor. 43712 """ 43713 43714 def AddExtraControls(self, win): 43715 """ 43716 AddExtraControls(win) 43717 43718 Customize the dialog by adding extra controls to it. 43719 """ 43720 43721 def GetList(self): 43722 """ 43723 GetList() -> RearrangeList 43724 43725 Return the list control used by the dialog. 43726 """ 43727 43728 def GetOrder(self): 43729 """ 43730 GetOrder() -> ArrayInt 43731 43732 Return the array describing the order of items after it was modified 43733 by the user. 43734 """ 43735 43736 @staticmethod 43737 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 43738 """ 43739 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 43740 """ 43741 List = property(None, None) 43742 Order = property(None, None) 43743# end of class RearrangeDialog 43744 43745#-- end-rearrangectrl --# 43746#-- begin-minifram --# 43747 43748class MiniFrame(Frame): 43749 """ 43750 MiniFrame() 43751 MiniFrame(parent, id=ID_ANY, title=EmptyString, pos=DefaultPosition, size=DefaultSize, style=CAPTION|RESIZE_BORDER, name=FrameNameStr) 43752 43753 A miniframe is a frame with a small title bar. 43754 """ 43755 43756 def __init__(self, *args, **kw): 43757 """ 43758 MiniFrame() 43759 MiniFrame(parent, id=ID_ANY, title=EmptyString, pos=DefaultPosition, size=DefaultSize, style=CAPTION|RESIZE_BORDER, name=FrameNameStr) 43760 43761 A miniframe is a frame with a small title bar. 43762 """ 43763 43764 def Create(self, parent, id=ID_ANY, title=EmptyString, pos=DefaultPosition, size=DefaultSize, style=CAPTION|RESIZE_BORDER, name=FrameNameStr): 43765 """ 43766 Create(parent, id=ID_ANY, title=EmptyString, pos=DefaultPosition, size=DefaultSize, style=CAPTION|RESIZE_BORDER, name=FrameNameStr) -> bool 43767 43768 Used in two-step frame construction. 43769 """ 43770 43771 @staticmethod 43772 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 43773 """ 43774 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 43775 """ 43776# end of class MiniFrame 43777 43778#-- end-minifram --# 43779#-- begin-textdlg --# 43780TextEntryDialogStyle = 0 43781GetTextFromUserPromptStr = "" 43782GetPasswordFromUserPromptStr = "" 43783 43784class TextEntryDialog(Dialog): 43785 """ 43786 TextEntryDialog() 43787 TextEntryDialog(parent, message, caption=GetTextFromUserPromptStr, value=EmptyString, style=TextEntryDialogStyle, pos=DefaultPosition) 43788 43789 This class represents a dialog that requests a one-line text string 43790 from the user. 43791 """ 43792 43793 def __init__(self, *args, **kw): 43794 """ 43795 TextEntryDialog() 43796 TextEntryDialog(parent, message, caption=GetTextFromUserPromptStr, value=EmptyString, style=TextEntryDialogStyle, pos=DefaultPosition) 43797 43798 This class represents a dialog that requests a one-line text string 43799 from the user. 43800 """ 43801 43802 def Create(self, parent, message, caption=GetTextFromUserPromptStr, value=EmptyString, style=TextEntryDialogStyle, pos=DefaultPosition): 43803 """ 43804 Create(parent, message, caption=GetTextFromUserPromptStr, value=EmptyString, style=TextEntryDialogStyle, pos=DefaultPosition) -> bool 43805 """ 43806 43807 def GetValue(self): 43808 """ 43809 GetValue() -> String 43810 43811 Returns the text that the user has entered if the user has pressed OK, 43812 or the original value if the user has pressed Cancel. 43813 """ 43814 43815 def SetMaxLength(self, len): 43816 """ 43817 SetMaxLength(len) 43818 43819 This function sets the maximum number of characters the user can enter 43820 into this dialog. 43821 """ 43822 43823 def SetValue(self, value): 43824 """ 43825 SetValue(value) 43826 43827 Sets the default text value. 43828 """ 43829 43830 def ShowModal(self): 43831 """ 43832 ShowModal() -> int 43833 43834 Shows the dialog, returning wxID_OK if the user pressed OK, and 43835 wxID_CANCEL otherwise. 43836 """ 43837 43838 @staticmethod 43839 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 43840 """ 43841 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 43842 """ 43843 Value = property(None, None) 43844# end of class TextEntryDialog 43845 43846 43847class PasswordEntryDialog(TextEntryDialog): 43848 """ 43849 PasswordEntryDialog(parent, message, caption=GetPasswordFromUserPromptStr, defaultValue=EmptyString, style=TextEntryDialogStyle, pos=DefaultPosition) 43850 43851 This class represents a dialog that requests a one-line password 43852 string from the user. 43853 """ 43854 43855 def __init__(self, parent, message, caption=GetPasswordFromUserPromptStr, defaultValue=EmptyString, style=TextEntryDialogStyle, pos=DefaultPosition): 43856 """ 43857 PasswordEntryDialog(parent, message, caption=GetPasswordFromUserPromptStr, defaultValue=EmptyString, style=TextEntryDialogStyle, pos=DefaultPosition) 43858 43859 This class represents a dialog that requests a one-line password 43860 string from the user. 43861 """ 43862 43863 @staticmethod 43864 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 43865 """ 43866 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 43867 """ 43868# end of class PasswordEntryDialog 43869 43870 43871def GetTextFromUser(message, caption=GetTextFromUserPromptStr, default_value=EmptyString, parent=None, x=DefaultCoord, y=DefaultCoord, centre=True): 43872 """ 43873 GetTextFromUser(message, caption=GetTextFromUserPromptStr, default_value=EmptyString, parent=None, x=DefaultCoord, y=DefaultCoord, centre=True) -> String 43874 43875 Pop up a dialog box with title set to caption, message, and a 43876 default_value. 43877 """ 43878 43879def GetPasswordFromUser(message, caption=GetPasswordFromUserPromptStr, default_value=EmptyString, parent=None, x=DefaultCoord, y=DefaultCoord, centre=True): 43880 """ 43881 GetPasswordFromUser(message, caption=GetPasswordFromUserPromptStr, default_value=EmptyString, parent=None, x=DefaultCoord, y=DefaultCoord, centre=True) -> String 43882 43883 Similar to wxGetTextFromUser() but the text entered in the dialog is 43884 not shown on screen but replaced with stars. 43885 """ 43886#-- end-textdlg --# 43887#-- begin-numdlg --# 43888 43889class NumberEntryDialog(Dialog): 43890 """ 43891 NumberEntryDialog(parent, message, prompt, caption, value, min, max, pos=DefaultPosition) 43892 43893 This class represents a dialog that requests a numeric input from the 43894 user. 43895 """ 43896 43897 def __init__(self, parent, message, prompt, caption, value, min, max, pos=DefaultPosition): 43898 """ 43899 NumberEntryDialog(parent, message, prompt, caption, value, min, max, pos=DefaultPosition) 43900 43901 This class represents a dialog that requests a numeric input from the 43902 user. 43903 """ 43904 43905 def GetValue(self): 43906 """ 43907 GetValue() -> long 43908 43909 Returns the value that the user has entered if the user has pressed 43910 OK, or the original value if the user has pressed Cancel. 43911 """ 43912 43913 @staticmethod 43914 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 43915 """ 43916 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 43917 """ 43918 Value = property(None, None) 43919# end of class NumberEntryDialog 43920 43921 43922def GetNumberFromUser(message, prompt, caption, value, min=0, max=100, parent=None, pos=DefaultPosition): 43923 """ 43924 GetNumberFromUser(message, prompt, caption, value, min=0, max=100, parent=None, pos=DefaultPosition) -> long 43925 43926 Shows a dialog asking the user for numeric input. 43927 """ 43928#-- end-numdlg --# 43929#-- begin-power --# 43930POWER_SOCKET = 0 43931POWER_BATTERY = 0 43932POWER_UNKNOWN = 0 43933BATTERY_NORMAL_STATE = 0 43934BATTERY_LOW_STATE = 0 43935BATTERY_CRITICAL_STATE = 0 43936BATTERY_SHUTDOWN_STATE = 0 43937BATTERY_UNKNOWN_STATE = 0 43938wxEVT_POWER_SUSPENDING = 0 43939wxEVT_POWER_SUSPENDED = 0 43940wxEVT_POWER_SUSPEND_CANCEL = 0 43941wxEVT_POWER_RESUME = 0 43942 43943class PowerEvent(Event): 43944 """ 43945 PowerEvent() 43946 PowerEvent(evtType) 43947 43948 The power events are generated when the system power state changes, 43949 e.g. 43950 """ 43951 43952 def __init__(self, *args, **kw): 43953 """ 43954 PowerEvent() 43955 PowerEvent(evtType) 43956 43957 The power events are generated when the system power state changes, 43958 e.g. 43959 """ 43960 43961 def Veto(self): 43962 """ 43963 Veto() 43964 43965 Call this to prevent suspend from taking place in 43966 wxEVT_POWER_SUSPENDING handler (it is ignored for all the others). 43967 """ 43968 43969 def IsVetoed(self): 43970 """ 43971 IsVetoed() -> bool 43972 43973 Returns whether Veto has been called. 43974 """ 43975# end of class PowerEvent 43976 43977 43978EVT_POWER_SUSPENDING = wx.PyEventBinder( wxEVT_POWER_SUSPENDING , 1 ) 43979EVT_POWER_SUSPENDED = wx.PyEventBinder( wxEVT_POWER_SUSPENDED , 1 ) 43980EVT_POWER_SUSPEND_CANCEL = wx.PyEventBinder( wxEVT_POWER_SUSPEND_CANCEL , 1 ) 43981EVT_POWER_RESUME = wx.PyEventBinder( wxEVT_POWER_RESUME , 1 ) 43982#-- end-power --# 43983#-- begin-utils --# 43984SIGNONE = 0 43985SIGHUP = 0 43986SIGINT = 0 43987SIGQUIT = 0 43988SIGILL = 0 43989SIGTRAP = 0 43990SIGABRT = 0 43991SIGEMT = 0 43992SIGFPE = 0 43993SIGKILL = 0 43994SIGBUS = 0 43995SIGSEGV = 0 43996SIGSYS = 0 43997SIGPIPE = 0 43998SIGALRM = 0 43999SIGTERM = 0 44000KILL_OK = 0 44001KILL_BAD_SIGNAL = 0 44002KILL_ACCESS_DENIED = 0 44003KILL_NO_PROCESS = 0 44004KILL_ERROR = 0 44005KILL_NOCHILDREN = 0 44006KILL_CHILDREN = 0 44007SHUTDOWN_FORCE = 0 44008SHUTDOWN_POWEROFF = 0 44009SHUTDOWN_REBOOT = 0 44010SHUTDOWN_LOGOFF = 0 44011Strip_Mnemonics = 0 44012Strip_Accel = 0 44013Strip_All = 0 44014EXEC_ASYNC = 0 44015EXEC_SYNC = 0 44016EXEC_SHOW_CONSOLE = 0 44017EXEC_MAKE_GROUP_LEADER = 0 44018EXEC_NODISABLE = 0 44019EXEC_NOEVENTS = 0 44020EXEC_HIDE_CONSOLE = 0 44021EXEC_BLOCK = 0 44022 44023def BeginBusyCursor(cursor=HOURGLASS_CURSOR): 44024 """ 44025 BeginBusyCursor(cursor=HOURGLASS_CURSOR) 44026 44027 Changes the cursor to the given cursor for all windows in the 44028 application. 44029 """ 44030 44031def EndBusyCursor(): 44032 """ 44033 EndBusyCursor() 44034 44035 Changes the cursor back to the original cursor, for all windows in the 44036 application. 44037 """ 44038 44039def IsBusy(): 44040 """ 44041 IsBusy() -> bool 44042 44043 Returns true if between two wxBeginBusyCursor() and wxEndBusyCursor() 44044 calls. 44045 """ 44046 44047def Bell(): 44048 """ 44049 Bell() 44050 44051 Ring the system bell. 44052 """ 44053 44054def InfoMessageBox(parent): 44055 """ 44056 InfoMessageBox(parent) 44057 44058 Shows a message box with the information about the wxWidgets build 44059 used, including its version, most important build parameters and the 44060 version of the underlying GUI toolkit. 44061 """ 44062 44063def GetLibraryVersionInfo(): 44064 """ 44065 GetLibraryVersionInfo() -> VersionInfo 44066 44067 Get wxWidgets version information. 44068 """ 44069 44070def GetBatteryState(): 44071 """ 44072 GetBatteryState() -> BatteryState 44073 44074 Returns battery state as one of wxBATTERY_NORMAL_STATE, 44075 wxBATTERY_LOW_STATE, wxBATTERY_CRITICAL_STATE, 44076 wxBATTERY_SHUTDOWN_STATE or wxBATTERY_UNKNOWN_STATE. 44077 """ 44078 44079def GetPowerType(): 44080 """ 44081 GetPowerType() -> PowerType 44082 44083 Returns the type of power source as one of wxPOWER_SOCKET, 44084 wxPOWER_BATTERY or wxPOWER_UNKNOWN. 44085 """ 44086 44087def GetKeyState(key): 44088 """ 44089 GetKeyState(key) -> bool 44090 44091 For normal keys, returns true if the specified key is currently down. 44092 """ 44093 44094def GetMousePosition(): 44095 """ 44096 GetMousePosition() -> Point 44097 44098 Returns the mouse position in screen coordinates. 44099 """ 44100 44101def GetMouseState(): 44102 """ 44103 GetMouseState() -> MouseState 44104 44105 Returns the current state of the mouse. 44106 """ 44107 44108def EnableTopLevelWindows(enable=True): 44109 """ 44110 EnableTopLevelWindows(enable=True) 44111 44112 This function enables or disables all top level windows. 44113 """ 44114 44115def FindWindowAtPoint(pt): 44116 """ 44117 FindWindowAtPoint(pt) -> Window 44118 44119 Find the deepest window at the given mouse position in screen 44120 coordinates, returning the window if found, or NULL if not. 44121 """ 44122 44123def FindWindowByLabel(label, parent=None): 44124 """ 44125 FindWindowByLabel(label, parent=None) -> Window 44126 """ 44127 44128def FindWindowByName(name, parent=None): 44129 """ 44130 FindWindowByName(name, parent=None) -> Window 44131 """ 44132 44133def FindMenuItemId(frame, menuString, itemString): 44134 """ 44135 FindMenuItemId(frame, menuString, itemString) -> int 44136 44137 Find a menu item identifier associated with the given frame's menu 44138 bar. 44139 """ 44140 44141def NewId(): 44142 """ 44143 NewId() -> int 44144 """ 44145 44146def RegisterId(id): 44147 """ 44148 RegisterId(id) 44149 44150 Ensures that Ids subsequently generated by wxNewId() do not clash with 44151 the given id. 44152 """ 44153 44154def LaunchDefaultApplication(document, flags=0): 44155 """ 44156 LaunchDefaultApplication(document, flags=0) -> bool 44157 44158 Opens the document in the application associated with the files of 44159 this type. 44160 """ 44161 44162def LaunchDefaultBrowser(url, flags=0): 44163 """ 44164 LaunchDefaultBrowser(url, flags=0) -> bool 44165 44166 Opens the url in user's default browser. 44167 """ 44168 44169def StripMenuCodes(str, flags=Strip_All): 44170 """ 44171 StripMenuCodes(str, flags=Strip_All) -> String 44172 44173 Strips any menu codes from str and returns the result. 44174 """ 44175 44176def GetEmailAddress(): 44177 """ 44178 GetEmailAddress() -> String 44179 44180 Copies the user's email address into the supplied buffer, by 44181 concatenating the values returned by wxGetFullHostName() and 44182 wxGetUserId(). 44183 """ 44184 44185def GetHomeDir(): 44186 """ 44187 GetHomeDir() -> String 44188 44189 Return the (current) user's home directory. 44190 """ 44191 44192def GetHostName(): 44193 """ 44194 GetHostName() -> String 44195 44196 Copies the current host machine's name into the supplied buffer. 44197 """ 44198 44199def GetFullHostName(): 44200 """ 44201 GetFullHostName() -> String 44202 44203 Returns the FQDN (fully qualified domain host name) or an empty string 44204 on error. 44205 """ 44206 44207def GetUserHome(user=EmptyString): 44208 """ 44209 GetUserHome(user=EmptyString) -> String 44210 44211 Returns the home directory for the given user. 44212 """ 44213 44214def GetUserId(): 44215 """ 44216 GetUserId() -> String 44217 44218 This function returns the "user id" also known as "login name" under 44219 Unix (i.e. 44220 """ 44221 44222def GetUserName(): 44223 """ 44224 GetUserName() -> String 44225 44226 This function returns the full user name (something like "Mr. John 44227 Smith"). 44228 """ 44229 44230def GetOsDescription(): 44231 """ 44232 GetOsDescription() -> String 44233 44234 Returns the string containing the description of the current platform 44235 in a user-readable form. 44236 """ 44237 44238def GetOsVersion(): 44239 """ 44240 GetOsVersion() -> (OperatingSystemId, major, minor) 44241 44242 Gets the version and the operating system ID for currently running OS. 44243 """ 44244 44245def IsPlatform64Bit(): 44246 """ 44247 IsPlatform64Bit() -> bool 44248 44249 Returns true if the operating system the program is running under is 44250 64 bit. 44251 """ 44252 44253def IsPlatformLittleEndian(): 44254 """ 44255 IsPlatformLittleEndian() -> bool 44256 44257 Returns true if the current platform is little endian (instead of big 44258 endian). 44259 """ 44260 44261def Execute(command, flags=EXEC_ASYNC, callback=None, env=None): 44262 """ 44263 Execute(command, flags=EXEC_ASYNC, callback=None, env=None) -> long 44264 44265 Executes another program in Unix or Windows. 44266 """ 44267 44268def GetProcessId(): 44269 """ 44270 GetProcessId() -> unsignedlong 44271 44272 Returns the number uniquely identifying the current process in the 44273 system. 44274 """ 44275 44276def Kill(pid, sig=SIGTERM, rc=None, flags=KILL_NOCHILDREN): 44277 """ 44278 Kill(pid, sig=SIGTERM, rc=None, flags=KILL_NOCHILDREN) -> int 44279 44280 Equivalent to the Unix kill function: send the given signal sig to the 44281 process with PID pid. 44282 """ 44283 44284def Shell(command=EmptyString): 44285 """ 44286 Shell(command=EmptyString) -> bool 44287 44288 Executes a command in an interactive shell window. 44289 """ 44290 44291def Shutdown(flags=SHUTDOWN_POWEROFF): 44292 """ 44293 Shutdown(flags=SHUTDOWN_POWEROFF) -> bool 44294 44295 This function shuts down or reboots the computer depending on the 44296 value of the flags. 44297 """ 44298 44299def MicroSleep(microseconds): 44300 """ 44301 MicroSleep(microseconds) 44302 44303 Sleeps for the specified number of microseconds. 44304 """ 44305 44306def MilliSleep(milliseconds): 44307 """ 44308 MilliSleep(milliseconds) 44309 44310 Sleeps for the specified number of milliseconds. 44311 """ 44312 44313def Now(): 44314 """ 44315 Now() -> String 44316 44317 Returns a string representing the current date and time. 44318 """ 44319 44320def Sleep(secs): 44321 """ 44322 Sleep(secs) 44323 44324 Sleeps for the specified number of seconds. 44325 """ 44326 44327def Usleep(milliseconds): 44328 """ 44329 Usleep(milliseconds) 44330 """ 44331 44332class WindowDisabler(object): 44333 """ 44334 WindowDisabler(disable=True) 44335 WindowDisabler(winToSkip) 44336 44337 This class disables all windows of the application (may be with the 44338 exception of one of them) in its constructor and enables them back in 44339 its destructor. 44340 """ 44341 44342 def __init__(self, *args, **kw): 44343 """ 44344 WindowDisabler(disable=True) 44345 WindowDisabler(winToSkip) 44346 44347 This class disables all windows of the application (may be with the 44348 exception of one of them) in its constructor and enables them back in 44349 its destructor. 44350 """ 44351 44352 def __enter__(self): 44353 """ 44354 44355 """ 44356 44357 def __exit__(self, exc_type, exc_val, exc_tb): 44358 """ 44359 44360 """ 44361# end of class WindowDisabler 44362 44363 44364class BusyCursor(object): 44365 """ 44366 BusyCursor(cursor=HOURGLASS_CURSOR) 44367 44368 This class makes it easy to tell your user that the program is 44369 temporarily busy. 44370 """ 44371 44372 def __init__(self, cursor=HOURGLASS_CURSOR): 44373 """ 44374 BusyCursor(cursor=HOURGLASS_CURSOR) 44375 44376 This class makes it easy to tell your user that the program is 44377 temporarily busy. 44378 """ 44379 44380 def __enter__(self): 44381 """ 44382 44383 """ 44384 44385 def __exit__(self, exc_type, exc_val, exc_tb): 44386 """ 44387 44388 """ 44389# end of class BusyCursor 44390 44391 44392class VersionInfo(object): 44393 """ 44394 VersionInfo(name="", major=0, minor=0, micro=0, description="", copyright="") 44395 44396 wxVersionInfo contains version information. 44397 """ 44398 44399 def __init__(self, name="", major=0, minor=0, micro=0, description="", copyright=""): 44400 """ 44401 VersionInfo(name="", major=0, minor=0, micro=0, description="", copyright="") 44402 44403 wxVersionInfo contains version information. 44404 """ 44405 44406 def GetName(self): 44407 """ 44408 GetName() -> String 44409 44410 Get the name of the object (library). 44411 """ 44412 44413 def GetMajor(self): 44414 """ 44415 GetMajor() -> int 44416 44417 Get the major version number. 44418 """ 44419 44420 def GetMinor(self): 44421 """ 44422 GetMinor() -> int 44423 44424 Get the minor version number. 44425 """ 44426 44427 def GetMicro(self): 44428 """ 44429 GetMicro() -> int 44430 44431 Get the micro version, or release number. 44432 """ 44433 44434 def ToString(self): 44435 """ 44436 ToString() -> String 44437 44438 Get the string representation of this version object. 44439 """ 44440 44441 def GetVersionString(self): 44442 """ 44443 GetVersionString() -> String 44444 44445 Get the string representation. 44446 """ 44447 44448 def HasDescription(self): 44449 """ 44450 HasDescription() -> bool 44451 44452 Return true if a description string has been specified. 44453 """ 44454 44455 def GetDescription(self): 44456 """ 44457 GetDescription() -> String 44458 44459 Get the description string. 44460 """ 44461 44462 def HasCopyright(self): 44463 """ 44464 HasCopyright() -> bool 44465 44466 Returns true if a copyright string has been specified. 44467 """ 44468 44469 def GetCopyright(self): 44470 """ 44471 GetCopyright() -> String 44472 44473 Get the copyright string. 44474 """ 44475 Copyright = property(None, None) 44476 Description = property(None, None) 44477 Major = property(None, None) 44478 Micro = property(None, None) 44479 Minor = property(None, None) 44480 Name = property(None, None) 44481 VersionString = property(None, None) 44482# end of class VersionInfo 44483 44484#-- end-utils --# 44485#-- begin-process --# 44486wxEVT_END_PROCESS = 0 44487 44488class Process(EvtHandler): 44489 """ 44490 Process(parent=None, id=-1) 44491 Process(flags) 44492 44493 The objects of this class are used in conjunction with the wxExecute() 44494 function. 44495 """ 44496 44497 def __init__(self, *args, **kw): 44498 """ 44499 Process(parent=None, id=-1) 44500 Process(flags) 44501 44502 The objects of this class are used in conjunction with the wxExecute() 44503 function. 44504 """ 44505 44506 def CloseOutput(self): 44507 """ 44508 CloseOutput() 44509 44510 Closes the output stream (the one connected to the stdin of the child 44511 process). 44512 """ 44513 44514 def Detach(self): 44515 """ 44516 Detach() 44517 44518 Detaches this event handler from the parent specified in the 44519 constructor (see wxEvtHandler::Unlink() for a similar but not 44520 identical function). 44521 """ 44522 44523 def GetErrorStream(self): 44524 """ 44525 GetErrorStream() -> InputStream 44526 44527 Returns an input stream which corresponds to the standard error output 44528 (stderr) of the child process. 44529 """ 44530 44531 def GetInputStream(self): 44532 """ 44533 GetInputStream() -> InputStream 44534 44535 It returns an input stream corresponding to the standard output stream 44536 of the subprocess. 44537 """ 44538 44539 def GetOutputStream(self): 44540 """ 44541 GetOutputStream() -> OutputStream 44542 44543 It returns an output stream corresponding to the input stream of the 44544 subprocess. 44545 """ 44546 44547 def GetPid(self): 44548 """ 44549 GetPid() -> long 44550 44551 Returns the process ID of the process launched by Open() or set by 44552 wxExecute() (if you passed this wxProcess as argument). 44553 """ 44554 44555 def IsErrorAvailable(self): 44556 """ 44557 IsErrorAvailable() -> bool 44558 44559 Returns true if there is data to be read on the child process standard 44560 error stream. 44561 """ 44562 44563 def IsInputAvailable(self): 44564 """ 44565 IsInputAvailable() -> bool 44566 44567 Returns true if there is data to be read on the child process standard 44568 output stream. 44569 """ 44570 44571 def IsInputOpened(self): 44572 """ 44573 IsInputOpened() -> bool 44574 44575 Returns true if the child process standard output stream is opened. 44576 """ 44577 44578 def OnTerminate(self, pid, status): 44579 """ 44580 OnTerminate(pid, status) 44581 44582 It is called when the process with the pid pid finishes. 44583 """ 44584 44585 def Redirect(self): 44586 """ 44587 Redirect() 44588 44589 Turns on redirection. 44590 """ 44591 44592 def SetPriority(self, priority): 44593 """ 44594 SetPriority(priority) 44595 44596 Sets the priority of the process, between 0 (lowest) and 100 44597 (highest). 44598 """ 44599 44600 @staticmethod 44601 def Exists(pid): 44602 """ 44603 Exists(pid) -> bool 44604 44605 Returns true if the given process exists in the system. 44606 """ 44607 44608 @staticmethod 44609 def Kill(pid, sig=SIGTERM, flags=KILL_NOCHILDREN): 44610 """ 44611 Kill(pid, sig=SIGTERM, flags=KILL_NOCHILDREN) -> KillError 44612 44613 Send the specified signal to the given process. 44614 """ 44615 44616 @staticmethod 44617 def Open(cmd, flags=EXEC_ASYNC): 44618 """ 44619 Open(cmd, flags=EXEC_ASYNC) -> Process 44620 44621 This static method replaces the standard popen() function: it launches 44622 the process specified by the cmd parameter and returns the wxProcess 44623 object which can be used to retrieve the streams connected to the 44624 standard input, output and error output of the child process. 44625 """ 44626 ErrorStream = property(None, None) 44627 InputStream = property(None, None) 44628 OutputStream = property(None, None) 44629 Pid = property(None, None) 44630# end of class Process 44631 44632 44633class ProcessEvent(Event): 44634 """ 44635 ProcessEvent(id=0, pid=0, exitcode=0) 44636 44637 A process event is sent to the wxEvtHandler specified to wxProcess 44638 when a process is terminated. 44639 """ 44640 44641 def __init__(self, id=0, pid=0, exitcode=0): 44642 """ 44643 ProcessEvent(id=0, pid=0, exitcode=0) 44644 44645 A process event is sent to the wxEvtHandler specified to wxProcess 44646 when a process is terminated. 44647 """ 44648 44649 def GetExitCode(self): 44650 """ 44651 GetExitCode() -> int 44652 44653 Returns the exist status. 44654 """ 44655 44656 def GetPid(self): 44657 """ 44658 GetPid() -> int 44659 44660 Returns the process id. 44661 """ 44662 ExitCode = property(None, None) 44663 Pid = property(None, None) 44664# end of class ProcessEvent 44665 44666 44667EVT_END_PROCESS = wx.PyEventBinder( wxEVT_END_PROCESS ) 44668#-- end-process --# 44669#-- begin-uiaction --# 44670 44671class UIActionSimulator(object): 44672 """ 44673 UIActionSimulator() 44674 44675 wxUIActionSimulator is a class used to simulate user interface actions 44676 such as a mouse click or a key press. 44677 """ 44678 44679 def __init__(self): 44680 """ 44681 UIActionSimulator() 44682 44683 wxUIActionSimulator is a class used to simulate user interface actions 44684 such as a mouse click or a key press. 44685 """ 44686 44687 def MouseMove(self, *args, **kw): 44688 """ 44689 MouseMove(x, y) -> bool 44690 MouseMove(point) -> bool 44691 44692 Move the mouse to the specified coordinates. 44693 """ 44694 44695 def MouseDown(self, button=MOUSE_BTN_LEFT): 44696 """ 44697 MouseDown(button=MOUSE_BTN_LEFT) -> bool 44698 44699 Press a mouse button. 44700 """ 44701 44702 def MouseUp(self, button=MOUSE_BTN_LEFT): 44703 """ 44704 MouseUp(button=MOUSE_BTN_LEFT) -> bool 44705 44706 Release a mouse button. 44707 """ 44708 44709 def MouseClick(self, button=MOUSE_BTN_LEFT): 44710 """ 44711 MouseClick(button=MOUSE_BTN_LEFT) -> bool 44712 44713 Click a mouse button. 44714 """ 44715 44716 def MouseDblClick(self, button=MOUSE_BTN_LEFT): 44717 """ 44718 MouseDblClick(button=MOUSE_BTN_LEFT) -> bool 44719 44720 Double-click a mouse button. 44721 """ 44722 44723 def MouseDragDrop(self, x1, y1, x2, y2, button=MOUSE_BTN_LEFT): 44724 """ 44725 MouseDragDrop(x1, y1, x2, y2, button=MOUSE_BTN_LEFT) -> bool 44726 44727 Perform a drag and drop operation. 44728 """ 44729 44730 def KeyDown(self, keycode, modifiers=MOD_NONE): 44731 """ 44732 KeyDown(keycode, modifiers=MOD_NONE) -> bool 44733 44734 Press a key. 44735 """ 44736 44737 def KeyUp(self, keycode, modifiers=MOD_NONE): 44738 """ 44739 KeyUp(keycode, modifiers=MOD_NONE) -> bool 44740 44741 Release a key. 44742 """ 44743 44744 def Char(self, keycode, modifiers=MOD_NONE): 44745 """ 44746 Char(keycode, modifiers=MOD_NONE) -> bool 44747 44748 Press and release a key. 44749 """ 44750 44751 def Text(self, text): 44752 """ 44753 Text(text) -> bool 44754 44755 Emulate typing in the keys representing the given string. 44756 """ 44757# end of class UIActionSimulator 44758 44759#-- end-uiaction --# 44760#-- begin-snglinst --# 44761 44762class SingleInstanceChecker(object): 44763 """ 44764 SingleInstanceChecker() 44765 SingleInstanceChecker(name, path=EmptyString) 44766 44767 wxSingleInstanceChecker class allows checking that only a single 44768 instance of a program is running. 44769 """ 44770 44771 def __init__(self, *args, **kw): 44772 """ 44773 SingleInstanceChecker() 44774 SingleInstanceChecker(name, path=EmptyString) 44775 44776 wxSingleInstanceChecker class allows checking that only a single 44777 instance of a program is running. 44778 """ 44779 44780 def Create(self, name, path=EmptyString): 44781 """ 44782 Create(name, path=EmptyString) -> bool 44783 44784 Initialize the object if it had been created using the default 44785 constructor. 44786 """ 44787 44788 def CreateDefault(self): 44789 """ 44790 CreateDefault() -> bool 44791 44792 Calls Create() with default name. 44793 """ 44794 44795 def IsAnotherRunning(self): 44796 """ 44797 IsAnotherRunning() -> bool 44798 44799 Returns true if another copy of this program is already running and 44800 false otherwise. 44801 """ 44802# end of class SingleInstanceChecker 44803 44804#-- end-snglinst --# 44805#-- begin-help --# 44806HELP_NETSCAPE = 0 44807HELP_SEARCH_INDEX = 0 44808HELP_SEARCH_ALL = 0 44809 44810class HelpControllerBase(Object): 44811 """ 44812 HelpControllerBase(parentWindow=None) 44813 44814 This is the abstract base class a family of classes by which 44815 applications may invoke a help viewer to provide on-line help. 44816 """ 44817 44818 def __init__(self, parentWindow=None): 44819 """ 44820 HelpControllerBase(parentWindow=None) 44821 44822 This is the abstract base class a family of classes by which 44823 applications may invoke a help viewer to provide on-line help. 44824 """ 44825 44826 def Initialize(self, *args, **kw): 44827 """ 44828 Initialize(file) -> bool 44829 Initialize(file, server) -> bool 44830 44831 Initializes the help instance with a help filename, and optionally a 44832 server socket number if using wxHelp (now obsolete). 44833 """ 44834 44835 def DisplayBlock(self, blockNo): 44836 """ 44837 DisplayBlock(blockNo) -> bool 44838 44839 If the help viewer is not running, runs it and displays the file at 44840 the given block number. 44841 """ 44842 44843 def DisplayContents(self): 44844 """ 44845 DisplayContents() -> bool 44846 44847 If the help viewer is not running, runs it and displays the contents. 44848 """ 44849 44850 def DisplayContextPopup(self, contextId): 44851 """ 44852 DisplayContextPopup(contextId) -> bool 44853 44854 Displays the section as a popup window using a context id. 44855 """ 44856 44857 def DisplaySection(self, *args, **kw): 44858 """ 44859 DisplaySection(section) -> bool 44860 DisplaySection(sectionNo) -> bool 44861 44862 If the help viewer is not running, runs it and displays the given 44863 section. 44864 """ 44865 44866 def DisplayTextPopup(self, text, pos): 44867 """ 44868 DisplayTextPopup(text, pos) -> bool 44869 44870 Displays the text in a popup window, if possible. 44871 """ 44872 44873 def GetFrameParameters(self): 44874 """ 44875 GetFrameParameters() -> (Frame, size, pos, newFrameEachTime) 44876 44877 For wxHtmlHelpController, returns the latest frame size and position 44878 settings and whether a new frame is drawn with each invocation. 44879 """ 44880 44881 def GetParentWindow(self): 44882 """ 44883 GetParentWindow() -> Window 44884 44885 Returns the window to be used as the parent for the help window. 44886 """ 44887 44888 def KeywordSearch(self, keyWord, mode=HELP_SEARCH_ALL): 44889 """ 44890 KeywordSearch(keyWord, mode=HELP_SEARCH_ALL) -> bool 44891 44892 If the help viewer is not running, runs it, and searches for sections 44893 matching the given keyword. 44894 """ 44895 44896 def LoadFile(self, file=EmptyString): 44897 """ 44898 LoadFile(file=EmptyString) -> bool 44899 44900 If the help viewer is not running, runs it and loads the given file. 44901 """ 44902 44903 def OnQuit(self): 44904 """ 44905 OnQuit() 44906 44907 Overridable member called when this application's viewer is quit by 44908 the user. 44909 """ 44910 44911 def Quit(self): 44912 """ 44913 Quit() -> bool 44914 44915 If the viewer is running, quits it by disconnecting. 44916 """ 44917 44918 def SetFrameParameters(self, titleFormat, size, pos=DefaultPosition, newFrameEachTime=False): 44919 """ 44920 SetFrameParameters(titleFormat, size, pos=DefaultPosition, newFrameEachTime=False) 44921 44922 Set the parameters of the frame window. 44923 """ 44924 44925 def SetParentWindow(self, parentWindow): 44926 """ 44927 SetParentWindow(parentWindow) 44928 44929 Sets the window to be used as the parent for the help window. 44930 """ 44931 44932 def SetViewer(self, viewer, flags=HELP_NETSCAPE): 44933 """ 44934 SetViewer(viewer, flags=HELP_NETSCAPE) 44935 44936 Sets detailed viewer information. 44937 """ 44938 FrameParameters = property(None, None) 44939 ParentWindow = property(None, None) 44940# end of class HelpControllerBase 44941 44942#-- end-help --# 44943#-- begin-cshelp --# 44944 44945class HelpProvider(object): 44946 """ 44947 wxHelpProvider is an abstract class used by a program implementing 44948 context-sensitive help to show the help text for the given window. 44949 """ 44950 44951 def AddHelp(self, *args, **kw): 44952 """ 44953 AddHelp(window, text) 44954 AddHelp(id, text) 44955 44956 Associates the text with the given window. 44957 """ 44958 44959 def GetHelp(self, window): 44960 """ 44961 GetHelp(window) -> String 44962 44963 This version associates the given text with all windows with this id. 44964 """ 44965 44966 def RemoveHelp(self, window): 44967 """ 44968 RemoveHelp(window) 44969 44970 Removes the association between the window pointer and the help text. 44971 """ 44972 44973 def ShowHelp(self, window): 44974 """ 44975 ShowHelp(window) -> bool 44976 44977 Shows help for the given window. 44978 """ 44979 44980 def ShowHelpAtPoint(self, window, point, origin): 44981 """ 44982 ShowHelpAtPoint(window, point, origin) -> bool 44983 44984 This function may be overridden to show help for the window when it 44985 should depend on the position inside the window, By default this 44986 method forwards to ShowHelp(), so it is enough to only implement the 44987 latter if the help doesn't depend on the position. 44988 """ 44989 44990 @staticmethod 44991 def Get(): 44992 """ 44993 Get() -> HelpProvider 44994 44995 Returns pointer to help provider instance. 44996 """ 44997 44998 @staticmethod 44999 def Set(helpProvider): 45000 """ 45001 Set(helpProvider) -> HelpProvider 45002 45003 Set the current, application-wide help provider. 45004 """ 45005# end of class HelpProvider 45006 45007 45008class SimpleHelpProvider(HelpProvider): 45009 """ 45010 wxSimpleHelpProvider is an implementation of wxHelpProvider which 45011 supports only plain text help strings, and shows the string associated 45012 with the control (if any) in a tooltip. 45013 """ 45014# end of class SimpleHelpProvider 45015 45016 45017class HelpControllerHelpProvider(SimpleHelpProvider): 45018 """ 45019 HelpControllerHelpProvider(hc=None) 45020 45021 wxHelpControllerHelpProvider is an implementation of wxHelpProvider 45022 which supports both context identifiers and plain text help strings. 45023 """ 45024 45025 def __init__(self, hc=None): 45026 """ 45027 HelpControllerHelpProvider(hc=None) 45028 45029 wxHelpControllerHelpProvider is an implementation of wxHelpProvider 45030 which supports both context identifiers and plain text help strings. 45031 """ 45032 45033 def GetHelpController(self): 45034 """ 45035 GetHelpController() -> HelpControllerBase 45036 45037 Returns the help controller associated with this help provider. 45038 """ 45039 45040 def SetHelpController(self, hc): 45041 """ 45042 SetHelpController(hc) 45043 45044 Sets the help controller associated with this help provider. 45045 """ 45046 HelpController = property(None, None) 45047# end of class HelpControllerHelpProvider 45048 45049 45050class ContextHelp(Object): 45051 """ 45052 ContextHelp(window=None, doNow=True) 45053 45054 This class changes the cursor to a query and puts the application into 45055 a 'context-sensitive help mode'. 45056 """ 45057 45058 def __init__(self, window=None, doNow=True): 45059 """ 45060 ContextHelp(window=None, doNow=True) 45061 45062 This class changes the cursor to a query and puts the application into 45063 a 'context-sensitive help mode'. 45064 """ 45065 45066 def BeginContextHelp(self, window): 45067 """ 45068 BeginContextHelp(window) -> bool 45069 45070 Puts the application into context-sensitive help mode. 45071 """ 45072 45073 def EndContextHelp(self): 45074 """ 45075 EndContextHelp() -> bool 45076 45077 Ends context-sensitive help mode. 45078 """ 45079# end of class ContextHelp 45080 45081 45082class ContextHelpButton(BitmapButton): 45083 """ 45084 ContextHelpButton(parent, id=ID_CONTEXT_HELP, pos=DefaultPosition, size=DefaultSize, style=BU_AUTODRAW) 45085 45086 Instances of this class may be used to add a question mark button that 45087 when pressed, puts the application into context-help mode. 45088 """ 45089 45090 def __init__(self, parent, id=ID_CONTEXT_HELP, pos=DefaultPosition, size=DefaultSize, style=BU_AUTODRAW): 45091 """ 45092 ContextHelpButton(parent, id=ID_CONTEXT_HELP, pos=DefaultPosition, size=DefaultSize, style=BU_AUTODRAW) 45093 45094 Instances of this class may be used to add a question mark button that 45095 when pressed, puts the application into context-help mode. 45096 """ 45097 45098 @staticmethod 45099 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 45100 """ 45101 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 45102 """ 45103# end of class ContextHelpButton 45104 45105#-- end-cshelp --# 45106#-- begin-settings --# 45107SYS_OEM_FIXED_FONT = 0 45108SYS_ANSI_FIXED_FONT = 0 45109SYS_ANSI_VAR_FONT = 0 45110SYS_SYSTEM_FONT = 0 45111SYS_DEVICE_DEFAULT_FONT = 0 45112SYS_DEFAULT_GUI_FONT = 0 45113SYS_COLOUR_SCROLLBAR = 0 45114SYS_COLOUR_DESKTOP = 0 45115SYS_COLOUR_ACTIVECAPTION = 0 45116SYS_COLOUR_INACTIVECAPTION = 0 45117SYS_COLOUR_MENU = 0 45118SYS_COLOUR_WINDOW = 0 45119SYS_COLOUR_WINDOWFRAME = 0 45120SYS_COLOUR_MENUTEXT = 0 45121SYS_COLOUR_WINDOWTEXT = 0 45122SYS_COLOUR_CAPTIONTEXT = 0 45123SYS_COLOUR_ACTIVEBORDER = 0 45124SYS_COLOUR_INACTIVEBORDER = 0 45125SYS_COLOUR_APPWORKSPACE = 0 45126SYS_COLOUR_HIGHLIGHT = 0 45127SYS_COLOUR_HIGHLIGHTTEXT = 0 45128SYS_COLOUR_BTNFACE = 0 45129SYS_COLOUR_BTNSHADOW = 0 45130SYS_COLOUR_GRAYTEXT = 0 45131SYS_COLOUR_BTNTEXT = 0 45132SYS_COLOUR_INACTIVECAPTIONTEXT = 0 45133SYS_COLOUR_BTNHIGHLIGHT = 0 45134SYS_COLOUR_3DDKSHADOW = 0 45135SYS_COLOUR_3DLIGHT = 0 45136SYS_COLOUR_INFOTEXT = 0 45137SYS_COLOUR_INFOBK = 0 45138SYS_COLOUR_LISTBOX = 0 45139SYS_COLOUR_HOTLIGHT = 0 45140SYS_COLOUR_GRADIENTACTIVECAPTION = 0 45141SYS_COLOUR_GRADIENTINACTIVECAPTION = 0 45142SYS_COLOUR_MENUHILIGHT = 0 45143SYS_COLOUR_MENUBAR = 0 45144SYS_COLOUR_LISTBOXTEXT = 0 45145SYS_COLOUR_LISTBOXHIGHLIGHTTEXT = 0 45146SYS_COLOUR_BACKGROUND = 0 45147SYS_COLOUR_3DFACE = 0 45148SYS_COLOUR_3DSHADOW = 0 45149SYS_COLOUR_BTNHILIGHT = 0 45150SYS_COLOUR_3DHIGHLIGHT = 0 45151SYS_COLOUR_3DHILIGHT = 0 45152SYS_COLOUR_FRAMEBK = 0 45153SYS_MOUSE_BUTTONS = 0 45154SYS_BORDER_X = 0 45155SYS_BORDER_Y = 0 45156SYS_CURSOR_X = 0 45157SYS_CURSOR_Y = 0 45158SYS_DCLICK_X = 0 45159SYS_DCLICK_Y = 0 45160SYS_DRAG_X = 0 45161SYS_DRAG_Y = 0 45162SYS_EDGE_X = 0 45163SYS_EDGE_Y = 0 45164SYS_HSCROLL_ARROW_X = 0 45165SYS_HSCROLL_ARROW_Y = 0 45166SYS_HTHUMB_X = 0 45167SYS_ICON_X = 0 45168SYS_ICON_Y = 0 45169SYS_ICONSPACING_X = 0 45170SYS_ICONSPACING_Y = 0 45171SYS_WINDOWMIN_X = 0 45172SYS_WINDOWMIN_Y = 0 45173SYS_SCREEN_X = 0 45174SYS_SCREEN_Y = 0 45175SYS_FRAMESIZE_X = 0 45176SYS_FRAMESIZE_Y = 0 45177SYS_SMALLICON_X = 0 45178SYS_SMALLICON_Y = 0 45179SYS_HSCROLL_Y = 0 45180SYS_VSCROLL_X = 0 45181SYS_VSCROLL_ARROW_X = 0 45182SYS_VSCROLL_ARROW_Y = 0 45183SYS_VTHUMB_Y = 0 45184SYS_CAPTION_Y = 0 45185SYS_MENU_Y = 0 45186SYS_NETWORK_PRESENT = 0 45187SYS_PENWINDOWS_PRESENT = 0 45188SYS_SHOW_SOUNDS = 0 45189SYS_SWAP_BUTTONS = 0 45190SYS_DCLICK_MSEC = 0 45191SYS_CAN_DRAW_FRAME_DECORATIONS = 0 45192SYS_CAN_ICONIZE_FRAME = 0 45193SYS_TABLET_PRESENT = 0 45194SYS_SCREEN_NONE = 0 45195SYS_SCREEN_TINY = 0 45196SYS_SCREEN_PDA = 0 45197SYS_SCREEN_SMALL = 0 45198SYS_SCREEN_DESKTOP = 0 45199 45200class SystemSettings(object): 45201 """ 45202 SystemSettings() 45203 45204 wxSystemSettings allows the application to ask for details about the 45205 system. 45206 """ 45207 45208 def __init__(self): 45209 """ 45210 SystemSettings() 45211 45212 wxSystemSettings allows the application to ask for details about the 45213 system. 45214 """ 45215 45216 @staticmethod 45217 def GetColour(index): 45218 """ 45219 GetColour(index) -> Colour 45220 45221 Returns a system colour. 45222 """ 45223 45224 @staticmethod 45225 def GetFont(index): 45226 """ 45227 GetFont(index) -> Font 45228 45229 Returns a system font. 45230 """ 45231 45232 @staticmethod 45233 def GetMetric(index, win=None): 45234 """ 45235 GetMetric(index, win=None) -> int 45236 45237 Returns the value of a system metric, or -1 if the metric is not 45238 supported on the current system. 45239 """ 45240 45241 @staticmethod 45242 def GetScreenType(): 45243 """ 45244 GetScreenType() -> SystemScreenType 45245 45246 Returns the screen type. 45247 """ 45248 45249 @staticmethod 45250 def HasFeature(index): 45251 """ 45252 HasFeature(index) -> bool 45253 45254 Returns true if the port has certain feature. 45255 """ 45256# end of class SystemSettings 45257 45258#-- end-settings --# 45259#-- begin-sysopt --# 45260 45261class SystemOptions(Object): 45262 """ 45263 SystemOptions() 45264 45265 wxSystemOptions stores option/value pairs that wxWidgets itself or 45266 applications can use to alter behaviour at run-time. 45267 """ 45268 45269 def __init__(self): 45270 """ 45271 SystemOptions() 45272 45273 wxSystemOptions stores option/value pairs that wxWidgets itself or 45274 applications can use to alter behaviour at run-time. 45275 """ 45276 45277 @staticmethod 45278 def SetOption(*args, **kw): 45279 """ 45280 SetOption(name, value) 45281 SetOption(name, value) 45282 45283 Sets an option. 45284 """ 45285 45286 @staticmethod 45287 def GetOption(name): 45288 """ 45289 GetOption(name) -> String 45290 45291 Gets an option. 45292 """ 45293 45294 @staticmethod 45295 def GetOptionInt(name): 45296 """ 45297 GetOptionInt(name) -> int 45298 45299 Gets an option as an integer. 45300 """ 45301 45302 @staticmethod 45303 def HasOption(name): 45304 """ 45305 HasOption(name) -> bool 45306 45307 Returns true if the given option is present. 45308 """ 45309 45310 @staticmethod 45311 def IsFalse(name): 45312 """ 45313 IsFalse(name) -> bool 45314 45315 Returns true if the option with the given name had been set to 0 45316 value. 45317 """ 45318# end of class SystemOptions 45319 45320#-- end-sysopt --# 45321#-- begin-artprov --# 45322ART_FIND_AND_REPLACE = "" 45323ART_FIND = "" 45324ART_QUIT = "" 45325ART_CLOSE = "" 45326ART_MINUS = "" 45327ART_PLUS = "" 45328ART_REDO = "" 45329ART_UNDO = "" 45330ART_NEW = "" 45331ART_DELETE = "" 45332ART_PASTE = "" 45333ART_CUT = "" 45334ART_COPY = "" 45335ART_MISSING_IMAGE = "" 45336ART_INFORMATION = "" 45337ART_WARNING = "" 45338ART_QUESTION = "" 45339ART_ERROR = "" 45340ART_CROSS_MARK = "" 45341ART_TICK_MARK = "" 45342ART_NORMAL_FILE = "" 45343ART_EXECUTABLE_FILE = "" 45344ART_GO_DIR_UP = "" 45345ART_FOLDER_OPEN = "" 45346ART_FOLDER = "" 45347ART_REMOVABLE = "" 45348ART_CDROM = "" 45349ART_FLOPPY = "" 45350ART_HARDDISK = "" 45351ART_NEW_DIR = "" 45352ART_LIST_VIEW = "" 45353ART_REPORT_VIEW = "" 45354ART_TIP = "" 45355ART_HELP = "" 45356ART_PRINT = "" 45357ART_FILE_SAVE_AS = "" 45358ART_FILE_SAVE = "" 45359ART_FILE_OPEN = "" 45360ART_GOTO_LAST = "" 45361ART_GOTO_FIRST = "" 45362ART_GO_HOME = "" 45363ART_GO_TO_PARENT = "" 45364ART_GO_DOWN = "" 45365ART_GO_UP = "" 45366ART_GO_FORWARD = "" 45367ART_GO_BACK = "" 45368ART_HELP_PAGE = "" 45369ART_HELP_FOLDER = "" 45370ART_HELP_BOOK = "" 45371ART_HELP_SETTINGS = "" 45372ART_HELP_SIDE_PANEL = "" 45373ART_DEL_BOOKMARK = "" 45374ART_ADD_BOOKMARK = "" 45375ART_OTHER = "" 45376ART_LIST = "" 45377ART_BUTTON = "" 45378ART_MESSAGE_BOX = "" 45379ART_HELP_BROWSER = "" 45380ART_CMN_DIALOG = "" 45381ART_FRAME_ICON = "" 45382ART_MENU = "" 45383ART_TOOLBAR = "" 45384 45385class ArtProvider(Object): 45386 """ 45387 wxArtProvider class is used to customize the look of wxWidgets 45388 application. 45389 """ 45390 45391 @staticmethod 45392 def Delete(provider): 45393 """ 45394 Delete(provider) -> bool 45395 45396 Delete the given provider. 45397 """ 45398 45399 @staticmethod 45400 def GetBitmap(id, client=ART_OTHER, size=DefaultSize): 45401 """ 45402 GetBitmap(id, client=ART_OTHER, size=DefaultSize) -> Bitmap 45403 45404 Query registered providers for bitmap with given ID. 45405 """ 45406 45407 @staticmethod 45408 def GetIcon(id, client=ART_OTHER, size=DefaultSize): 45409 """ 45410 GetIcon(id, client=ART_OTHER, size=DefaultSize) -> Icon 45411 45412 Same as wxArtProvider::GetBitmap, but return a wxIcon object (or 45413 wxNullIcon on failure). 45414 """ 45415 45416 @staticmethod 45417 def GetNativeSizeHint(client): 45418 """ 45419 GetNativeSizeHint(client) -> Size 45420 45421 Returns native icon size for use specified by client hint. 45422 """ 45423 45424 @staticmethod 45425 def GetSizeHint(client, platform_default=False): 45426 """ 45427 GetSizeHint(client, platform_default=False) -> Size 45428 45429 Returns a suitable size hint for the given wxArtClient. 45430 """ 45431 45432 @staticmethod 45433 def GetIconBundle(id, client=ART_OTHER): 45434 """ 45435 GetIconBundle(id, client=ART_OTHER) -> IconBundle 45436 45437 Query registered providers for icon bundle with given ID. 45438 """ 45439 45440 @staticmethod 45441 def HasNativeProvider(): 45442 """ 45443 HasNativeProvider() -> bool 45444 45445 Returns true if the platform uses native icons provider that should 45446 take precedence over any customizations. 45447 """ 45448 45449 @staticmethod 45450 def Insert(provider): 45451 """ 45452 Insert(provider) 45453 """ 45454 45455 @staticmethod 45456 def Pop(): 45457 """ 45458 Pop() -> bool 45459 45460 Remove latest added provider and delete it. 45461 """ 45462 45463 @staticmethod 45464 def Push(provider): 45465 """ 45466 Push(provider) 45467 45468 Register new art provider and add it to the top of providers stack 45469 (i.e. 45470 """ 45471 45472 @staticmethod 45473 def PushBack(provider): 45474 """ 45475 PushBack(provider) 45476 45477 Register new art provider and add it to the bottom of providers stack. 45478 """ 45479 45480 @staticmethod 45481 def Remove(provider): 45482 """ 45483 Remove(provider) -> bool 45484 45485 Remove a provider from the stack if it is on it. 45486 """ 45487 45488 @staticmethod 45489 def GetMessageBoxIconId(flags): 45490 """ 45491 GetMessageBoxIconId(flags) -> ArtID 45492 45493 Helper used by GetMessageBoxIcon(): return the art id corresponding to 45494 the standard wxICON_INFORMATION/WARNING/ERROR/QUESTION flags (only one 45495 can be set) 45496 """ 45497 45498 @staticmethod 45499 def GetMessageBoxIcon(flags): 45500 """ 45501 GetMessageBoxIcon(flags) -> Icon 45502 45503 Helper used by several generic classes: return the icon corresponding 45504 to the standard wxICON_INFORMATION/WARNING/ERROR/QUESTION flags (only 45505 one can be set) 45506 """ 45507 45508 def CreateBitmap(self, id, client, size): 45509 """ 45510 CreateBitmap(id, client, size) -> Bitmap 45511 45512 Derived art provider classes must override this method to create 45513 requested art resource. 45514 """ 45515 45516 def CreateIconBundle(self, id, client): 45517 """ 45518 CreateIconBundle(id, client) -> IconBundle 45519 45520 This method is similar to CreateBitmap() but can be used when a bitmap 45521 (or an icon) exists in several sizes. 45522 """ 45523# end of class ArtProvider 45524 45525#-- end-artprov --# 45526#-- begin-dragimag --# 45527 45528class DragImage(Object): 45529 """ 45530 DragImage() 45531 DragImage(image, cursor=NullCursor) 45532 DragImage(image, cursor=NullCursor) 45533 DragImage(text, cursor=NullCursor) 45534 DragImage(treeCtrl, id) 45535 DragImage(listCtrl, id) 45536 45537 This class is used when you wish to drag an object on the screen, and 45538 a simple cursor is not enough. 45539 """ 45540 45541 def __init__(self, *args, **kw): 45542 """ 45543 DragImage() 45544 DragImage(image, cursor=NullCursor) 45545 DragImage(image, cursor=NullCursor) 45546 DragImage(text, cursor=NullCursor) 45547 DragImage(treeCtrl, id) 45548 DragImage(listCtrl, id) 45549 45550 This class is used when you wish to drag an object on the screen, and 45551 a simple cursor is not enough. 45552 """ 45553 45554 def BeginDrag(self, *args, **kw): 45555 """ 45556 BeginDrag(hotspot, window, fullScreen=False, rect=None) -> bool 45557 BeginDrag(hotspot, window, boundingWindow) -> bool 45558 45559 Start dragging the image, in a window or full screen. 45560 """ 45561 45562 def EndDrag(self): 45563 """ 45564 EndDrag() -> bool 45565 45566 Call this when the drag has finished. 45567 """ 45568 45569 def Hide(self): 45570 """ 45571 Hide() -> bool 45572 45573 Hides the image. 45574 """ 45575 45576 def Move(self, pt): 45577 """ 45578 Move(pt) -> bool 45579 45580 Call this to move the image to a new position. 45581 """ 45582 45583 def Show(self): 45584 """ 45585 Show() -> bool 45586 45587 Shows the image. 45588 """ 45589# end of class DragImage 45590 45591 45592class GenericDragImage(Object): 45593 """ 45594 GenericDragImage() 45595 GenericDragImage(image, cursor=NullCursor) 45596 GenericDragImage(image, cursor=NullCursor) 45597 GenericDragImage(text, cursor=NullCursor) 45598 GenericDragImage(treeCtrl, id) 45599 GenericDragImage(listCtrl, id) 45600 45601 This class is used when you wish to drag an object on the screen, and 45602 a simple cursor is not enough. 45603 """ 45604 45605 def __init__(self, *args, **kw): 45606 """ 45607 GenericDragImage() 45608 GenericDragImage(image, cursor=NullCursor) 45609 GenericDragImage(image, cursor=NullCursor) 45610 GenericDragImage(text, cursor=NullCursor) 45611 GenericDragImage(treeCtrl, id) 45612 GenericDragImage(listCtrl, id) 45613 45614 This class is used when you wish to drag an object on the screen, and 45615 a simple cursor is not enough. 45616 """ 45617 45618 def BeginDrag(self, *args, **kw): 45619 """ 45620 BeginDrag(hotspot, window, fullScreen=False, rect=None) -> bool 45621 BeginDrag(hotspot, window, boundingWindow) -> bool 45622 45623 Start dragging the image, in a window or full screen. 45624 """ 45625 45626 def DoDrawImage(self, dc, pos): 45627 """ 45628 DoDrawImage(dc, pos) -> bool 45629 45630 Draws the image on the device context with top-left corner at the 45631 given position. 45632 """ 45633 45634 def EndDrag(self): 45635 """ 45636 EndDrag() -> bool 45637 45638 Call this when the drag has finished. 45639 """ 45640 45641 def GetImageRect(self, pos): 45642 """ 45643 GetImageRect(pos) -> Rect 45644 45645 Returns the rectangle enclosing the image, assuming that the image is 45646 drawn with its top-left corner at the given point. 45647 """ 45648 45649 def Hide(self): 45650 """ 45651 Hide() -> bool 45652 45653 Hides the image. 45654 """ 45655 45656 def Move(self, pt): 45657 """ 45658 Move(pt) -> bool 45659 45660 Call this to move the image to a new position. 45661 """ 45662 45663 def Show(self): 45664 """ 45665 Show() -> bool 45666 45667 Shows the image. 45668 """ 45669 45670 def UpdateBackingFromWindow(self, windowDC, destDC, sourceRect, destRect): 45671 """ 45672 UpdateBackingFromWindow(windowDC, destDC, sourceRect, destRect) -> bool 45673 45674 Override this if you wish to draw the window contents to the backing 45675 bitmap yourself. 45676 """ 45677# end of class GenericDragImage 45678 45679#-- end-dragimag --# 45680#-- begin-printfw --# 45681PREVIEW_PRINT = 0 45682PREVIEW_PREVIOUS = 0 45683PREVIEW_NEXT = 0 45684PREVIEW_ZOOM = 0 45685PREVIEW_FIRST = 0 45686PREVIEW_LAST = 0 45687PREVIEW_GOTO = 0 45688PREVIEW_DEFAULT = 0 45689ID_PREVIEW_CLOSE = 0 45690ID_PREVIEW_NEXT = 0 45691ID_PREVIEW_PREVIOUS = 0 45692ID_PREVIEW_PRINT = 0 45693ID_PREVIEW_ZOOM = 0 45694ID_PREVIEW_FIRST = 0 45695ID_PREVIEW_LAST = 0 45696ID_PREVIEW_GOTO = 0 45697ID_PREVIEW_ZOOM_IN = 0 45698ID_PREVIEW_ZOOM_OUT = 0 45699PRINTER_NO_ERROR = 0 45700PRINTER_CANCELLED = 0 45701PRINTER_ERROR = 0 45702PreviewFrame_AppModal = 0 45703PreviewFrame_WindowModal = 0 45704PreviewFrame_NonModal = 0 45705 45706class PreviewControlBar(Panel): 45707 """ 45708 PreviewControlBar(preview, buttons, parent, pos=DefaultPosition, size=DefaultSize, style=0, name="panel") 45709 45710 This is the default implementation of the preview control bar, a panel 45711 with buttons and a zoom control. 45712 """ 45713 45714 def __init__(self, preview, buttons, parent, pos=DefaultPosition, size=DefaultSize, style=0, name="panel"): 45715 """ 45716 PreviewControlBar(preview, buttons, parent, pos=DefaultPosition, size=DefaultSize, style=0, name="panel") 45717 45718 This is the default implementation of the preview control bar, a panel 45719 with buttons and a zoom control. 45720 """ 45721 45722 def CreateButtons(self): 45723 """ 45724 CreateButtons() 45725 45726 Creates buttons, according to value of the button style flags. 45727 """ 45728 45729 def GetPrintPreview(self): 45730 """ 45731 GetPrintPreview() -> PrintPreview 45732 45733 Gets the print preview object associated with the control bar. 45734 """ 45735 45736 def GetZoomControl(self): 45737 """ 45738 GetZoomControl() -> int 45739 45740 Gets the current zoom setting in percent. 45741 """ 45742 45743 def SetZoomControl(self, percent): 45744 """ 45745 SetZoomControl(percent) 45746 45747 Sets the zoom control. 45748 """ 45749 45750 @staticmethod 45751 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 45752 """ 45753 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 45754 """ 45755 PrintPreview = property(None, None) 45756 ZoomControl = property(None, None) 45757# end of class PreviewControlBar 45758 45759 45760class PreviewCanvas(ScrolledWindow): 45761 """ 45762 PreviewCanvas(preview, parent, pos=DefaultPosition, size=DefaultSize, style=0, name="canvas") 45763 45764 A preview canvas is the default canvas used by the print preview 45765 system to display the preview. 45766 """ 45767 45768 def __init__(self, preview, parent, pos=DefaultPosition, size=DefaultSize, style=0, name="canvas"): 45769 """ 45770 PreviewCanvas(preview, parent, pos=DefaultPosition, size=DefaultSize, style=0, name="canvas") 45771 45772 A preview canvas is the default canvas used by the print preview 45773 system to display the preview. 45774 """ 45775 45776 def OnPaint(self, event): 45777 """ 45778 OnPaint(event) 45779 45780 Calls wxPrintPreview::PaintPage() to refresh the canvas. 45781 """ 45782 45783 @staticmethod 45784 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 45785 """ 45786 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 45787 """ 45788# end of class PreviewCanvas 45789 45790 45791class PreviewFrame(Frame): 45792 """ 45793 PreviewFrame(preview, parent, title="PrintPreview", pos=DefaultPosition, size=DefaultSize, style=DEFAULT_FRAME_STYLE, name=FrameNameStr) 45794 45795 This class provides the default method of managing the print preview 45796 interface. 45797 """ 45798 45799 def __init__(self, preview, parent, title="PrintPreview", pos=DefaultPosition, size=DefaultSize, style=DEFAULT_FRAME_STYLE, name=FrameNameStr): 45800 """ 45801 PreviewFrame(preview, parent, title="PrintPreview", pos=DefaultPosition, size=DefaultSize, style=DEFAULT_FRAME_STYLE, name=FrameNameStr) 45802 45803 This class provides the default method of managing the print preview 45804 interface. 45805 """ 45806 45807 def CreateCanvas(self): 45808 """ 45809 CreateCanvas() 45810 45811 Creates a wxPreviewCanvas. 45812 """ 45813 45814 def CreateControlBar(self): 45815 """ 45816 CreateControlBar() 45817 45818 Creates a wxPreviewControlBar. 45819 """ 45820 45821 def Initialize(self): 45822 """ 45823 Initialize() 45824 45825 Initializes the frame elements and prepares for showing it. 45826 """ 45827 45828 def InitializeWithModality(self, kind): 45829 """ 45830 InitializeWithModality(kind) 45831 45832 Initializes the frame elements and prepares for showing it with the 45833 given modality kind. 45834 """ 45835 45836 def OnCloseWindow(self, event): 45837 """ 45838 OnCloseWindow(event) 45839 45840 Enables any disabled frames in the application, and deletes the print 45841 preview object, implicitly deleting any printout objects associated 45842 with the print preview object. 45843 """ 45844 45845 @staticmethod 45846 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 45847 """ 45848 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 45849 """ 45850# end of class PreviewFrame 45851 45852 45853class PrintPreview(Object): 45854 """ 45855 PrintPreview(printout, printoutForPrinting=None, data=None) 45856 PrintPreview(printout, printoutForPrinting, data) 45857 45858 Objects of this class manage the print preview process. 45859 """ 45860 45861 def __init__(self, *args, **kw): 45862 """ 45863 PrintPreview(printout, printoutForPrinting=None, data=None) 45864 PrintPreview(printout, printoutForPrinting, data) 45865 45866 Objects of this class manage the print preview process. 45867 """ 45868 45869 def GetCanvas(self): 45870 """ 45871 GetCanvas() -> PreviewCanvas 45872 45873 Gets the preview window used for displaying the print preview image. 45874 """ 45875 45876 def GetCurrentPage(self): 45877 """ 45878 GetCurrentPage() -> int 45879 45880 Gets the page currently being previewed. 45881 """ 45882 45883 def GetFrame(self): 45884 """ 45885 GetFrame() -> Frame 45886 45887 Gets the frame used for displaying the print preview canvas and 45888 control bar. 45889 """ 45890 45891 def GetMaxPage(self): 45892 """ 45893 GetMaxPage() -> int 45894 45895 Returns the maximum page number. 45896 """ 45897 45898 def GetMinPage(self): 45899 """ 45900 GetMinPage() -> int 45901 45902 Returns the minimum page number. 45903 """ 45904 45905 def GetPrintout(self): 45906 """ 45907 GetPrintout() -> Printout 45908 45909 Gets the preview printout object associated with the wxPrintPreview 45910 object. 45911 """ 45912 45913 def GetPrintoutForPrinting(self): 45914 """ 45915 GetPrintoutForPrinting() -> Printout 45916 45917 Gets the printout object to be used for printing from within the 45918 preview interface, or NULL if none exists. 45919 """ 45920 45921 def IsOk(self): 45922 """ 45923 IsOk() -> bool 45924 45925 Returns true if the wxPrintPreview is valid, false otherwise. 45926 """ 45927 45928 def PaintPage(self, canvas, dc): 45929 """ 45930 PaintPage(canvas, dc) -> bool 45931 45932 This refreshes the preview window with the preview image. 45933 """ 45934 45935 def Print(self, prompt): 45936 """ 45937 Print(prompt) -> bool 45938 45939 Invokes the print process using the second wxPrintout object supplied 45940 in the wxPrintPreview constructor. 45941 """ 45942 45943 def RenderPage(self, pageNum): 45944 """ 45945 RenderPage(pageNum) -> bool 45946 45947 Renders a page into a wxMemoryDC. 45948 """ 45949 45950 def SetCanvas(self, window): 45951 """ 45952 SetCanvas(window) 45953 45954 Sets the window to be used for displaying the print preview image. 45955 """ 45956 45957 def SetCurrentPage(self, pageNum): 45958 """ 45959 SetCurrentPage(pageNum) -> bool 45960 45961 Sets the current page to be previewed. 45962 """ 45963 45964 def SetFrame(self, frame): 45965 """ 45966 SetFrame(frame) 45967 45968 Sets the frame to be used for displaying the print preview canvas and 45969 control bar. 45970 """ 45971 45972 def SetPrintout(self, printout): 45973 """ 45974 SetPrintout(printout) 45975 45976 Associates a printout object with the wxPrintPreview object. 45977 """ 45978 45979 def SetZoom(self, percent): 45980 """ 45981 SetZoom(percent) 45982 45983 Sets the percentage preview zoom, and refreshes the preview canvas 45984 accordingly. 45985 """ 45986 45987 def __nonzero__(self): 45988 """ 45989 __nonzero__() -> int 45990 """ 45991 45992 def __bool__(self): 45993 """ 45994 __bool__() -> int 45995 """ 45996 45997 Ok = wx.deprecated(IsOk, 'Use IsOk instead.') 45998 Canvas = property(None, None) 45999 CurrentPage = property(None, None) 46000 Frame = property(None, None) 46001 MaxPage = property(None, None) 46002 MinPage = property(None, None) 46003 Printout = property(None, None) 46004 PrintoutForPrinting = property(None, None) 46005# end of class PrintPreview 46006 46007 46008class Printer(Object): 46009 """ 46010 Printer(data=None) 46011 46012 This class represents the Windows or PostScript printer, and is the 46013 vehicle through which printing may be launched by an application. 46014 """ 46015 46016 def __init__(self, data=None): 46017 """ 46018 Printer(data=None) 46019 46020 This class represents the Windows or PostScript printer, and is the 46021 vehicle through which printing may be launched by an application. 46022 """ 46023 46024 def CreateAbortWindow(self, parent, printout): 46025 """ 46026 CreateAbortWindow(parent, printout) -> PrintAbortDialog 46027 46028 Creates the default printing abort window, with a cancel button. 46029 """ 46030 46031 def GetAbort(self): 46032 """ 46033 GetAbort() -> bool 46034 46035 Returns true if the user has aborted the print job. 46036 """ 46037 46038 def GetPrintDialogData(self): 46039 """ 46040 GetPrintDialogData() -> PrintDialogData 46041 46042 Returns the print data associated with the printer object. 46043 """ 46044 46045 def Print(self, parent, printout, prompt=True): 46046 """ 46047 Print(parent, printout, prompt=True) -> bool 46048 46049 Starts the printing process. 46050 """ 46051 46052 def PrintDialog(self, parent): 46053 """ 46054 PrintDialog(parent) -> DC 46055 46056 Invokes the print dialog. 46057 """ 46058 46059 def ReportError(self, parent, printout, message): 46060 """ 46061 ReportError(parent, printout, message) 46062 46063 Default error-reporting function. 46064 """ 46065 46066 def Setup(self, parent): 46067 """ 46068 Setup(parent) -> bool 46069 46070 Invokes the print setup dialog. 46071 """ 46072 46073 @staticmethod 46074 def GetLastError(): 46075 """ 46076 GetLastError() -> PrinterError 46077 46078 Return last error. 46079 """ 46080 Abort = property(None, None) 46081 PrintDialogData = property(None, None) 46082# end of class Printer 46083 46084 46085class Printout(Object): 46086 """ 46087 Printout(title="Printout") 46088 46089 This class encapsulates the functionality of printing out an 46090 application document. 46091 """ 46092 46093 def __init__(self, title="Printout"): 46094 """ 46095 Printout(title="Printout") 46096 46097 This class encapsulates the functionality of printing out an 46098 application document. 46099 """ 46100 46101 def FitThisSizeToPage(self, imageSize): 46102 """ 46103 FitThisSizeToPage(imageSize) 46104 46105 Set the user scale and device origin of the wxDC associated with this 46106 wxPrintout so that the given image size fits entirely within the page 46107 rectangle and the origin is at the top left corner of the page 46108 rectangle. 46109 """ 46110 46111 def FitThisSizeToPageMargins(self, imageSize, pageSetupData): 46112 """ 46113 FitThisSizeToPageMargins(imageSize, pageSetupData) 46114 46115 Set the user scale and device origin of the wxDC associated with this 46116 wxPrintout so that the given image size fits entirely within the page 46117 margins set in the given wxPageSetupDialogData object. 46118 """ 46119 46120 def FitThisSizeToPaper(self, imageSize): 46121 """ 46122 FitThisSizeToPaper(imageSize) 46123 46124 Set the user scale and device origin of the wxDC associated with this 46125 wxPrintout so that the given image size fits entirely within the paper 46126 and the origin is at the top left corner of the paper. 46127 """ 46128 46129 def GetDC(self): 46130 """ 46131 GetDC() -> DC 46132 46133 Returns the device context associated with the printout (given to the 46134 printout at start of printing or previewing). 46135 """ 46136 46137 def GetLogicalPageMarginsRect(self, pageSetupData): 46138 """ 46139 GetLogicalPageMarginsRect(pageSetupData) -> Rect 46140 46141 Return the rectangle corresponding to the page margins specified by 46142 the given wxPageSetupDialogData object in the associated wxDC's 46143 logical coordinates for the current user scale and device origin. 46144 """ 46145 46146 def GetLogicalPageRect(self): 46147 """ 46148 GetLogicalPageRect() -> Rect 46149 46150 Return the rectangle corresponding to the page in the associated wxDC 46151 's logical coordinates for the current user scale and device origin. 46152 """ 46153 46154 def GetLogicalPaperRect(self): 46155 """ 46156 GetLogicalPaperRect() -> Rect 46157 46158 Return the rectangle corresponding to the paper in the associated wxDC 46159 's logical coordinates for the current user scale and device origin. 46160 """ 46161 46162 def GetPPIPrinter(self): 46163 """ 46164 GetPPIPrinter() -> (w, h) 46165 46166 Returns the number of pixels per logical inch of the printer device 46167 context. 46168 """ 46169 46170 def GetPPIScreen(self): 46171 """ 46172 GetPPIScreen() -> (w, h) 46173 46174 Returns the number of pixels per logical inch of the screen device 46175 context. 46176 """ 46177 46178 def GetPageInfo(self): 46179 """ 46180 GetPageInfo() -> (minPage, maxPage, pageFrom, pageTo) 46181 46182 Called by the framework to obtain information from the application 46183 about minimum and maximum page values that the user can select, and 46184 the required page range to be printed. 46185 """ 46186 46187 def GetPageSizeMM(self): 46188 """ 46189 GetPageSizeMM() -> (w, h) 46190 46191 Returns the size of the printer page in millimetres. 46192 """ 46193 46194 def GetPageSizePixels(self): 46195 """ 46196 GetPageSizePixels() -> (w, h) 46197 46198 Returns the size of the printer page in pixels, called the page 46199 rectangle. 46200 """ 46201 46202 def GetPaperRectPixels(self): 46203 """ 46204 GetPaperRectPixels() -> Rect 46205 46206 Returns the rectangle that corresponds to the entire paper in pixels, 46207 called the paper rectangle. 46208 """ 46209 46210 def GetTitle(self): 46211 """ 46212 GetTitle() -> String 46213 46214 Returns the title of the printout. 46215 """ 46216 46217 def HasPage(self, pageNum): 46218 """ 46219 HasPage(pageNum) -> bool 46220 46221 Should be overridden to return true if the document has this page, or 46222 false if not. 46223 """ 46224 46225 def IsPreview(self): 46226 """ 46227 IsPreview() -> bool 46228 46229 Returns true if the printout is currently being used for previewing. 46230 """ 46231 46232 def GetPreview(self): 46233 """ 46234 GetPreview() -> PrintPreview 46235 46236 Returns the associated preview object if any. 46237 """ 46238 46239 def MapScreenSizeToDevice(self): 46240 """ 46241 MapScreenSizeToDevice() 46242 46243 Set the user scale and device origin of the wxDC associated with this 46244 wxPrintout so that one screen pixel maps to one device pixel on the 46245 DC. 46246 """ 46247 46248 def MapScreenSizeToPage(self): 46249 """ 46250 MapScreenSizeToPage() 46251 46252 This sets the user scale of the wxDC associated with this wxPrintout 46253 to the same scale as MapScreenSizeToPaper() but sets the logical 46254 origin to the top left corner of the page rectangle. 46255 """ 46256 46257 def MapScreenSizeToPageMargins(self, pageSetupData): 46258 """ 46259 MapScreenSizeToPageMargins(pageSetupData) 46260 46261 This sets the user scale of the wxDC associated with this wxPrintout 46262 to the same scale as MapScreenSizeToPageMargins() but sets the logical 46263 origin to the top left corner of the page margins specified by the 46264 given wxPageSetupDialogData object. 46265 """ 46266 46267 def MapScreenSizeToPaper(self): 46268 """ 46269 MapScreenSizeToPaper() 46270 46271 Set the user scale and device origin of the wxDC associated with this 46272 wxPrintout so that the printed page matches the screen size as closely 46273 as possible and the logical origin is in the top left corner of the 46274 paper rectangle. 46275 """ 46276 46277 def OffsetLogicalOrigin(self, xoff, yoff): 46278 """ 46279 OffsetLogicalOrigin(xoff, yoff) 46280 46281 Shift the device origin by an amount specified in logical coordinates. 46282 """ 46283 46284 def OnBeginDocument(self, startPage, endPage): 46285 """ 46286 OnBeginDocument(startPage, endPage) -> bool 46287 46288 Called by the framework at the start of document printing. 46289 """ 46290 46291 def OnBeginPrinting(self): 46292 """ 46293 OnBeginPrinting() 46294 46295 Called by the framework at the start of printing. 46296 """ 46297 46298 def OnEndDocument(self): 46299 """ 46300 OnEndDocument() 46301 46302 Called by the framework at the end of document printing. 46303 """ 46304 46305 def OnEndPrinting(self): 46306 """ 46307 OnEndPrinting() 46308 46309 Called by the framework at the end of printing. 46310 """ 46311 46312 def OnPreparePrinting(self): 46313 """ 46314 OnPreparePrinting() 46315 46316 Called once by the framework before any other demands are made of the 46317 wxPrintout object. 46318 """ 46319 46320 def OnPrintPage(self, pageNum): 46321 """ 46322 OnPrintPage(pageNum) -> bool 46323 46324 Called by the framework when a page should be printed. 46325 """ 46326 46327 def SetLogicalOrigin(self, x, y): 46328 """ 46329 SetLogicalOrigin(x, y) 46330 46331 Set the device origin of the associated wxDC so that the current 46332 logical point becomes the new logical origin. 46333 """ 46334 DC = property(None, None) 46335 LogicalPageRect = property(None, None) 46336 LogicalPaperRect = property(None, None) 46337 PaperRectPixels = property(None, None) 46338 Preview = property(None, None) 46339 Title = property(None, None) 46340# end of class Printout 46341 46342 46343class PrintAbortDialog(Dialog): 46344 """ 46345 PrintAbortDialog(parent, documentTitle, pos=DefaultPosition, size=DefaultSize, style=DEFAULT_DIALOG_STYLE, name="dialog") 46346 46347 The dialog created by default by the print framework that enables 46348 aborting the printing process. 46349 """ 46350 46351 def __init__(self, parent, documentTitle, pos=DefaultPosition, size=DefaultSize, style=DEFAULT_DIALOG_STYLE, name="dialog"): 46352 """ 46353 PrintAbortDialog(parent, documentTitle, pos=DefaultPosition, size=DefaultSize, style=DEFAULT_DIALOG_STYLE, name="dialog") 46354 46355 The dialog created by default by the print framework that enables 46356 aborting the printing process. 46357 """ 46358 46359 def SetProgress(self, currentPage, totalPages, currentCopy, totalCopies): 46360 """ 46361 SetProgress(currentPage, totalPages, currentCopy, totalCopies) 46362 """ 46363 46364 @staticmethod 46365 def GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL): 46366 """ 46367 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes 46368 """ 46369# end of class PrintAbortDialog 46370 46371 46372PyPrintPreview = wx.deprecated(PrintPreview, 'Use PrintPreview instead.') 46373 46374PyPreviewFrame = wx.deprecated(PreviewFrame, 'Use PreviewFrame instead.') 46375 46376PyPreviewControlBar = wx.deprecated(PreviewControlBar, 'Use PreviewControlBar instead.') 46377 46378PyPrintout = wx.deprecated(Printout, 'Use Printout instead.') 46379#-- end-printfw --# 46380#-- begin-printdlg --# 46381 46382class PrintDialog(Object): 46383 """ 46384 PrintDialog(parent, data=None) 46385 PrintDialog(parent, data) 46386 46387 This class represents the print and print setup common dialogs. 46388 """ 46389 46390 def __init__(self, *args, **kw): 46391 """ 46392 PrintDialog(parent, data=None) 46393 PrintDialog(parent, data) 46394 46395 This class represents the print and print setup common dialogs. 46396 """ 46397 46398 def GetPrintDC(self): 46399 """ 46400 GetPrintDC() -> DC 46401 46402 Returns the device context created by the print dialog, if any. 46403 """ 46404 46405 def GetPrintDialogData(self): 46406 """ 46407 GetPrintDialogData() -> PrintDialogData 46408 46409 Returns the print dialog data associated with the print dialog. 46410 """ 46411 46412 def GetPrintData(self): 46413 """ 46414 GetPrintData() -> PrintData 46415 46416 Returns the print data associated with the print dialog. 46417 """ 46418 46419 def ShowModal(self): 46420 """ 46421 ShowModal() -> int 46422 46423 Shows the dialog, returning wxID_OK if the user pressed OK, and 46424 wxID_CANCEL otherwise. 46425 """ 46426 PrintDC = property(None, None) 46427 PrintData = property(None, None) 46428 PrintDialogData = property(None, None) 46429# end of class PrintDialog 46430 46431 46432class PageSetupDialog(Object): 46433 """ 46434 PageSetupDialog(parent, data=None) 46435 46436 This class represents the page setup common dialog. 46437 """ 46438 46439 def __init__(self, parent, data=None): 46440 """ 46441 PageSetupDialog(parent, data=None) 46442 46443 This class represents the page setup common dialog. 46444 """ 46445 46446 def GetPageSetupData(self): 46447 """ 46448 GetPageSetupData() -> PageSetupDialogData 46449 46450 Returns the wxPageSetupDialogData object associated with the dialog. 46451 """ 46452 46453 def ShowModal(self): 46454 """ 46455 ShowModal() -> int 46456 46457 Shows the dialog, returning wxID_OK if the user pressed OK, and 46458 wxID_CANCEL otherwise. 46459 """ 46460 PageSetupData = property(None, None) 46461# end of class PageSetupDialog 46462 46463#-- end-printdlg --# 46464#-- begin-mimetype --# 46465 46466class FileType(object): 46467 """ 46468 FileType(ftInfo) 46469 46470 This class holds information about a given file type. 46471 """ 46472 46473 class MessageParameters(object): 46474 """ 46475 MessageParameters() 46476 MessageParameters(filename, mimetype=EmptyString) 46477 46478 Class representing message parameters. 46479 """ 46480 46481 def __init__(self, *args, **kw): 46482 """ 46483 MessageParameters() 46484 MessageParameters(filename, mimetype=EmptyString) 46485 46486 Class representing message parameters. 46487 """ 46488 46489 def GetFileName(self): 46490 """ 46491 GetFileName() -> String 46492 46493 Return the filename. 46494 """ 46495 46496 def GetMimeType(self): 46497 """ 46498 GetMimeType() -> String 46499 46500 Return the MIME type. 46501 """ 46502 46503 def GetParamValue(self, name): 46504 """ 46505 GetParamValue(name) -> String 46506 46507 Overridable method for derived classes. Returns empty string by 46508 default. 46509 """ 46510 FileName = property(None, None) 46511 MimeType = property(None, None) 46512 # end of class MessageParameters 46513 46514 46515 def __init__(self, ftInfo): 46516 """ 46517 FileType(ftInfo) 46518 46519 This class holds information about a given file type. 46520 """ 46521 46522 def GetOpenCommand(self, *args, **kw): 46523 """ 46524 GetOpenCommand(params) -> String 46525 GetOpenCommand(filename) -> String 46526 46527 Returns the command which must be executed (see wx.Execute()) in order 46528 to open the file of the given type. The name of the file as well as 46529 any other parameters is retrieved from MessageParameters() class. 46530 """ 46531 46532 def GetDescription(self): 46533 """ 46534 GetDescription() -> String 46535 46536 Returns a brief description for this file type: for example, "text 46537 document" for 46538 the "text/plain" MIME type. 46539 """ 46540 46541 def GetExtensions(self): 46542 """ 46543 GetExtensions() -> ArrayString 46544 46545 Returns all extensions associated with this file type: for 46546 example, it may contain the following two elements for the MIME 46547 type "text/html" (notice the absence of the leading dot): "html" 46548 and "htm". 46549 46550 This function is not implemented on Windows, there is no (efficient) 46551 way to retrieve associated extensions from the given MIME type on 46552 this platform. 46553 """ 46554 46555 def GetIcon(self): 46556 """ 46557 GetIcon() -> Icon 46558 46559 Return the icon associated with this mime type, if any. 46560 """ 46561 46562 def GetMimeType(self): 46563 """ 46564 GetMimeType() -> String 46565 46566 Returns full MIME type specification for this file type: for example, 46567 "text/plain". 46568 """ 46569 46570 def GetMimeTypes(self): 46571 """ 46572 GetMimeTypes() -> ArrayString 46573 46574 Same as GetMimeType but returns a list of types. This will usually 46575 contain 46576 only one item, but sometimes, such as on Unix with KDE more than one 46577 type 46578 if there are differences between KDE< mailcap and mime.types. 46579 """ 46580 46581 def GetPrintCommand(self, params): 46582 """ 46583 GetPrintCommand(params) -> String 46584 46585 Returns the command which must be executed (see wxExecute()) in order 46586 to 46587 print the file of the given type. The name of the file is retrieved 46588 from 46589 the MessageParameters class. 46590 """ 46591 46592 def GetAllCommands(self, params): 46593 """ 46594 GetAllCommands(params) -> (verbs, commands) 46595 46596 Returns a tuple containing the `verbs` and `commands` arrays, 46597 corresponding for the registered information for this mime type. 46598 """ 46599 46600 @staticmethod 46601 def ExpandCommand(command, params): 46602 """ 46603 ExpandCommand(command, params) -> String 46604 46605 This function is primarily intended for GetOpenCommand and 46606 GetPrintCommand usage but may be also used by the application directly 46607 if, for example, you want to use some non-default command to open the 46608 file. 46609 """ 46610 46611 def GetIconLocation(self): 46612 """ 46613 GetIconLocation() -> IconLocation 46614 46615 Returns a wx.IconLocation that can be used to fetch the icon for this 46616 mime type. 46617 """ 46618 46619 def GetIconInfo(self): 46620 """ 46621 GetIconInfo() -> PyObject 46622 46623 Returns a tuple containing the Icon for this file type, the file where 46624 the 46625 icon is found, and the index of the image in that file, if applicable. 46626 """ 46627 Description = property(None, None) 46628 Extensions = property(None, None) 46629 Icon = property(None, None) 46630 IconInfo = property(None, None) 46631 IconLocation = property(None, None) 46632 MimeType = property(None, None) 46633 MimeTypes = property(None, None) 46634 OpenCommand = property(None, None) 46635 PrintCommand = property(None, None) 46636# end of class FileType 46637 46638 46639class FileTypeInfo(object): 46640 """ 46641 FileTypeInfo() 46642 FileTypeInfo(mimeType) 46643 FileTypeInfo(mimeType, openCmd, printCmd, description, extension) 46644 FileTypeInfo(sArray) 46645 46646 Container of information about wxFileType. 46647 """ 46648 46649 def __init__(self, *args, **kw): 46650 """ 46651 FileTypeInfo() 46652 FileTypeInfo(mimeType) 46653 FileTypeInfo(mimeType, openCmd, printCmd, description, extension) 46654 FileTypeInfo(sArray) 46655 46656 Container of information about wxFileType. 46657 """ 46658 46659 def AddExtension(self, ext): 46660 """ 46661 AddExtension(ext) 46662 46663 Add another extension associated with this file type. 46664 """ 46665 46666 def SetDescription(self, description): 46667 """ 46668 SetDescription(description) 46669 46670 Set the file type description. 46671 """ 46672 46673 def SetOpenCommand(self, command): 46674 """ 46675 SetOpenCommand(command) 46676 46677 Set the command to be used for opening files of this type. 46678 """ 46679 46680 def SetPrintCommand(self, command): 46681 """ 46682 SetPrintCommand(command) 46683 46684 Set the command to be used for printing files of this type. 46685 """ 46686 46687 def SetShortDesc(self, shortDesc): 46688 """ 46689 SetShortDesc(shortDesc) 46690 46691 Set the short description for the files of this type. 46692 """ 46693 46694 def SetIcon(self, iconFile, iconIndex=0): 46695 """ 46696 SetIcon(iconFile, iconIndex=0) 46697 46698 Set the icon information. 46699 """ 46700 46701 def GetMimeType(self): 46702 """ 46703 GetMimeType() -> String 46704 46705 Get the MIME type. 46706 """ 46707 46708 def GetOpenCommand(self): 46709 """ 46710 GetOpenCommand() -> String 46711 46712 Get the open command. 46713 """ 46714 46715 def GetPrintCommand(self): 46716 """ 46717 GetPrintCommand() -> String 46718 46719 Get the print command. 46720 """ 46721 46722 def GetShortDesc(self): 46723 """ 46724 GetShortDesc() -> String 46725 46726 Get the short description (only used under Win32 so far) 46727 """ 46728 46729 def GetDescription(self): 46730 """ 46731 GetDescription() -> String 46732 46733 Get the long, user visible description. 46734 """ 46735 46736 def GetExtensions(self): 46737 """ 46738 GetExtensions() -> ArrayString 46739 46740 Get the array of all extensions. 46741 """ 46742 46743 def GetExtensionsCount(self): 46744 """ 46745 GetExtensionsCount() -> size_t 46746 46747 Get the number of extensions. 46748 """ 46749 46750 def GetIconFile(self): 46751 """ 46752 GetIconFile() -> String 46753 46754 Get the icon filename. 46755 """ 46756 46757 def GetIconIndex(self): 46758 """ 46759 GetIconIndex() -> int 46760 46761 Get the index of the icon within the icon file. 46762 """ 46763 Description = property(None, None) 46764 Extensions = property(None, None) 46765 ExtensionsCount = property(None, None) 46766 IconFile = property(None, None) 46767 IconIndex = property(None, None) 46768 MimeType = property(None, None) 46769 OpenCommand = property(None, None) 46770 PrintCommand = property(None, None) 46771 ShortDesc = property(None, None) 46772# end of class FileTypeInfo 46773 46774 46775class MimeTypesManager(object): 46776 """ 46777 MimeTypesManager() 46778 46779 This class allows the application to retrieve information about all 46780 known MIME types from a system-specific location and the filename 46781 extensions to the MIME types and vice versa. 46782 """ 46783 46784 def __init__(self): 46785 """ 46786 MimeTypesManager() 46787 46788 This class allows the application to retrieve information about all 46789 known MIME types from a system-specific location and the filename 46790 extensions to the MIME types and vice versa. 46791 """ 46792 46793 def AddFallbacks(self, fallbacks): 46794 """ 46795 AddFallbacks(fallbacks) 46796 46797 This function may be used to provide hard-wired fallbacks for the MIME 46798 types and extensions that might not be present in the system MIME 46799 database. 46800 """ 46801 46802 def GetFileTypeFromExtension(self, extension): 46803 """ 46804 GetFileTypeFromExtension(extension) -> FileType 46805 46806 Gather information about the files with given extension and return the 46807 corresponding wxFileType object or NULL if the extension is unknown. 46808 """ 46809 46810 def GetFileTypeFromMimeType(self, mimeType): 46811 """ 46812 GetFileTypeFromMimeType(mimeType) -> FileType 46813 46814 Gather information about the files with given MIME type and return the 46815 corresponding wxFileType object or NULL if the MIME type is unknown. 46816 """ 46817 46818 def Associate(self, ftInfo): 46819 """ 46820 Associate(ftInfo) -> FileType 46821 46822 Create a new association using the fields of wxFileTypeInfo (at least 46823 the MIME type and the extension should be set). 46824 """ 46825 46826 def Unassociate(self, ft): 46827 """ 46828 Unassociate(ft) -> bool 46829 46830 Undo Associate(). 46831 """ 46832 46833 def EnumAllFileTypes(self): 46834 """ 46835 EnumAllFileTypes() -> ArrayString 46836 46837 Returns a list of all known file types. 46838 """ 46839 46840 @staticmethod 46841 def IsOfType(mimeType, wildcard): 46842 """ 46843 IsOfType(mimeType, wildcard) -> bool 46844 46845 This function returns true if either the given mimeType is exactly the 46846 same as wildcard or if it has the same category and the subtype of 46847 wildcard is '*'. 46848 """ 46849# end of class MimeTypesManager 46850 46851TheMimeTypesManager = MimeTypesManager() 46852#-- end-mimetype --# 46853#-- begin-busyinfo --# 46854 46855class BusyInfo(object): 46856 """ 46857 BusyInfo(msg, parent=None) 46858 46859 This class makes it easy to tell your user that the program is 46860 temporarily busy. 46861 """ 46862 46863 def __init__(self, msg, parent=None): 46864 """ 46865 BusyInfo(msg, parent=None) 46866 46867 This class makes it easy to tell your user that the program is 46868 temporarily busy. 46869 """ 46870 46871 def __enter__(self): 46872 """ 46873 46874 """ 46875 46876 def __exit__(self, exc_type, exc_val, exc_tb): 46877 """ 46878 46879 """ 46880# end of class BusyInfo 46881 46882#-- end-busyinfo --# 46883#-- begin-caret --# 46884 46885class Caret(object): 46886 """ 46887 Caret(window, width, height) 46888 Caret(window, size) 46889 Caret() 46890 46891 A caret is a blinking cursor showing the position where the typed text 46892 will appear. 46893 """ 46894 46895 def __init__(self, *args, **kw): 46896 """ 46897 Caret(window, width, height) 46898 Caret(window, size) 46899 Caret() 46900 46901 A caret is a blinking cursor showing the position where the typed text 46902 will appear. 46903 """ 46904 46905 def Create(self, *args, **kw): 46906 """ 46907 Create(window, width, height) -> bool 46908 Create(window, size) -> bool 46909 46910 Creates a caret with the given size (in pixels) and associates it with 46911 the window (same as the equivalent constructors). 46912 """ 46913 46914 def GetPosition(self): 46915 """ 46916 GetPosition() -> Point 46917 46918 Get the caret position (in pixels). 46919 """ 46920 46921 def GetSize(self): 46922 """ 46923 GetSize() -> Size 46924 46925 Get the caret size. 46926 """ 46927 46928 def Move(self, *args, **kw): 46929 """ 46930 Move(x, y) 46931 Move(pt) 46932 46933 Move the caret to given position (in logical coordinates). 46934 """ 46935 46936 def SetSize(self, *args, **kw): 46937 """ 46938 SetSize(width, height) 46939 SetSize(size) 46940 46941 Changes the size of the caret. 46942 """ 46943 46944 def GetWindow(self): 46945 """ 46946 GetWindow() -> Window 46947 46948 Get the window the caret is associated with. 46949 """ 46950 46951 def Hide(self): 46952 """ 46953 Hide() 46954 46955 Hides the caret, same as Show(false). 46956 """ 46957 46958 def IsOk(self): 46959 """ 46960 IsOk() -> bool 46961 46962 Returns true if the caret was created successfully. 46963 """ 46964 46965 def IsVisible(self): 46966 """ 46967 IsVisible() -> bool 46968 46969 Returns true if the caret is visible and false if it is permanently 46970 hidden (if it is blinking and not shown currently but will be after 46971 the next blink, this method still returns true). 46972 """ 46973 46974 def Show(self, show=True): 46975 """ 46976 Show(show=True) 46977 46978 Shows or hides the caret. 46979 """ 46980 46981 @staticmethod 46982 def GetBlinkTime(): 46983 """ 46984 GetBlinkTime() -> int 46985 46986 Returns the blink time which is measured in milliseconds and is the 46987 time elapsed between 2 inversions of the caret (blink time of the 46988 caret is the same for all carets, so this functions is static). 46989 """ 46990 46991 @staticmethod 46992 def SetBlinkTime(milliseconds): 46993 """ 46994 SetBlinkTime(milliseconds) 46995 46996 Sets the blink time for all the carets. 46997 """ 46998 46999 def __nonzero__(self): 47000 """ 47001 __nonzero__() -> int 47002 """ 47003 47004 def __bool__(self): 47005 """ 47006 __bool__() -> int 47007 """ 47008 Position = property(None, None) 47009 Size = property(None, None) 47010 Window = property(None, None) 47011# end of class Caret 47012 47013#-- end-caret --# 47014#-- begin-fontenum --# 47015 47016class FontEnumerator(object): 47017 """ 47018 FontEnumerator() 47019 47020 wxFontEnumerator enumerates either all available fonts on the system 47021 or only the ones with given attributes - either only fixed-width 47022 (suited for use in programs such as terminal emulators and the like) 47023 or the fonts available in the given encoding). 47024 """ 47025 47026 def __init__(self): 47027 """ 47028 FontEnumerator() 47029 47030 wxFontEnumerator enumerates either all available fonts on the system 47031 or only the ones with given attributes - either only fixed-width 47032 (suited for use in programs such as terminal emulators and the like) 47033 or the fonts available in the given encoding). 47034 """ 47035 47036 def EnumerateEncodings(self, font=EmptyString): 47037 """ 47038 EnumerateEncodings(font=EmptyString) -> bool 47039 47040 Call OnFontEncoding() for each encoding supported by the given font - 47041 or for each encoding supported by at least some font if font is not 47042 specified. 47043 """ 47044 47045 def EnumerateFacenames(self, encoding=FONTENCODING_SYSTEM, fixedWidthOnly=False): 47046 """ 47047 EnumerateFacenames(encoding=FONTENCODING_SYSTEM, fixedWidthOnly=False) -> bool 47048 47049 Call OnFacename() for each font which supports given encoding (only if 47050 it is not wxFONTENCODING_SYSTEM) and is of fixed width (if 47051 fixedWidthOnly is true). 47052 """ 47053 47054 def OnFacename(self, font): 47055 """ 47056 OnFacename(font) -> bool 47057 47058 Called by EnumerateFacenames() for each match. 47059 """ 47060 47061 def OnFontEncoding(self, font, encoding): 47062 """ 47063 OnFontEncoding(font, encoding) -> bool 47064 47065 Called by EnumerateEncodings() for each match. 47066 """ 47067 47068 @staticmethod 47069 def GetEncodings(facename=EmptyString): 47070 """ 47071 GetEncodings(facename=EmptyString) -> ArrayString 47072 47073 Return array of strings containing all encodings found by 47074 EnumerateEncodings(). 47075 """ 47076 47077 @staticmethod 47078 def GetFacenames(encoding=FONTENCODING_SYSTEM, fixedWidthOnly=False): 47079 """ 47080 GetFacenames(encoding=FONTENCODING_SYSTEM, fixedWidthOnly=False) -> ArrayString 47081 47082 Return array of strings containing all facenames found by 47083 EnumerateFacenames(). 47084 """ 47085 47086 @staticmethod 47087 def IsValidFacename(facename): 47088 """ 47089 IsValidFacename(facename) -> bool 47090 47091 Returns true if the given string is valid face name, i.e. 47092 """ 47093# end of class FontEnumerator 47094 47095#-- end-fontenum --# 47096#-- begin-fontmap --# 47097 47098class FontMapper(object): 47099 """ 47100 FontMapper() 47101 47102 wxFontMapper manages user-definable correspondence between logical 47103 font names and the fonts present on the machine. 47104 """ 47105 47106 def __init__(self): 47107 """ 47108 FontMapper() 47109 47110 wxFontMapper manages user-definable correspondence between logical 47111 font names and the fonts present on the machine. 47112 """ 47113 47114 def GetAltForEncoding(self, encoding, facename=EmptyString, interactive=True): 47115 """ 47116 GetAltForEncoding(encoding, facename=EmptyString, interactive=True) -> (bool, alt_encoding) 47117 47118 Find an alternative for the given encoding (which is supposed to not 47119 be available on this system). 47120 """ 47121 47122 def CharsetToEncoding(self, charset, interactive=True): 47123 """ 47124 CharsetToEncoding(charset, interactive=True) -> FontEncoding 47125 47126 Returns the encoding for the given charset (in the form of RFC 2046) 47127 or wxFONTENCODING_SYSTEM if couldn't decode it. 47128 """ 47129 47130 def IsEncodingAvailable(self, encoding, facename=EmptyString): 47131 """ 47132 IsEncodingAvailable(encoding, facename=EmptyString) -> bool 47133 47134 Check whether given encoding is available in given face or not. 47135 """ 47136 47137 def SetConfigPath(self, prefix): 47138 """ 47139 SetConfigPath(prefix) 47140 47141 Set the root config path to use (should be an absolute path). 47142 """ 47143 47144 def SetDialogParent(self, parent): 47145 """ 47146 SetDialogParent(parent) 47147 47148 The parent window for modal dialogs. 47149 """ 47150 47151 def SetDialogTitle(self, title): 47152 """ 47153 SetDialogTitle(title) 47154 47155 The title for the dialogs (note that default is quite reasonable). 47156 """ 47157 47158 @staticmethod 47159 def Get(): 47160 """ 47161 Get() -> FontMapper 47162 47163 Get the current font mapper object. 47164 """ 47165 47166 @staticmethod 47167 def GetAllEncodingNames(encoding): 47168 """ 47169 GetAllEncodingNames(encoding) -> ArrayString 47170 47171 Returns the array of all possible names for the given encoding. If it 47172 isn't empty, the first name in it is the canonical encoding name, 47173 i.e. the same string as returned by GetEncodingName() 47174 """ 47175 47176 @staticmethod 47177 def GetEncoding(n): 47178 """ 47179 GetEncoding(n) -> FontEncoding 47180 47181 Returns the n-th supported encoding. 47182 """ 47183 47184 @staticmethod 47185 def GetEncodingDescription(encoding): 47186 """ 47187 GetEncodingDescription(encoding) -> String 47188 47189 Return user-readable string describing the given encoding. 47190 """ 47191 47192 @staticmethod 47193 def GetEncodingFromName(encoding): 47194 """ 47195 GetEncodingFromName(encoding) -> FontEncoding 47196 47197 Return the encoding corresponding to the given internal name. 47198 """ 47199 47200 @staticmethod 47201 def GetEncodingName(encoding): 47202 """ 47203 GetEncodingName(encoding) -> String 47204 47205 Return internal string identifier for the encoding (see also 47206 wxFontMapper::GetEncodingDescription). 47207 """ 47208 47209 @staticmethod 47210 def GetSupportedEncodingsCount(): 47211 """ 47212 GetSupportedEncodingsCount() -> size_t 47213 47214 Returns the number of the font encodings supported by this class. 47215 """ 47216 47217 @staticmethod 47218 def Set(mapper): 47219 """ 47220 Set(mapper) -> FontMapper 47221 47222 Set the current font mapper object and return previous one (may be 47223 NULL). 47224 """ 47225# end of class FontMapper 47226 47227#-- end-fontmap --# 47228#-- begin-mousemanager --# 47229 47230class MouseEventsManager(EvtHandler): 47231 """ 47232 MouseEventsManager() 47233 MouseEventsManager(win) 47234 47235 Helper for handling mouse input events in windows containing multiple 47236 items. 47237 """ 47238 47239 def __init__(self, *args, **kw): 47240 """ 47241 MouseEventsManager() 47242 MouseEventsManager(win) 47243 47244 Helper for handling mouse input events in windows containing multiple 47245 items. 47246 """ 47247 47248 def Create(self, win): 47249 """ 47250 Create(win) -> bool 47251 47252 Finishes initialization of the object created using default 47253 constructor. 47254 """ 47255 47256 def MouseHitTest(self, pos): 47257 """ 47258 MouseHitTest(pos) -> int 47259 47260 Must be overridden to return the item at the given position. 47261 """ 47262 47263 def MouseClicked(self, item): 47264 """ 47265 MouseClicked(item) -> bool 47266 47267 Must be overridden to react to mouse clicks. 47268 """ 47269 47270 def MouseDragBegin(self, item, pos): 47271 """ 47272 MouseDragBegin(item, pos) -> bool 47273 47274 Must be overridden to allow or deny dragging of the item. 47275 """ 47276 47277 def MouseDragging(self, item, pos): 47278 """ 47279 MouseDragging(item, pos) 47280 47281 Must be overridden to provide feed back while an item is being 47282 dragged. 47283 """ 47284 47285 def MouseDragEnd(self, item, pos): 47286 """ 47287 MouseDragEnd(item, pos) 47288 47289 Must be overridden to handle item drop. 47290 """ 47291 47292 def MouseDragCancelled(self, item): 47293 """ 47294 MouseDragCancelled(item) 47295 47296 Must be overridden to handle cancellation of mouse dragging. 47297 """ 47298 47299 def MouseClickBegin(self, item): 47300 """ 47301 MouseClickBegin(item) 47302 47303 May be overridden to update the state of an item when it is pressed. 47304 """ 47305 47306 def MouseClickCancelled(self, item): 47307 """ 47308 MouseClickCancelled(item) 47309 47310 Must be overridden to reset the item appearance changed by 47311 MouseClickBegin(). 47312 """ 47313# end of class MouseEventsManager 47314 47315#-- end-mousemanager --# 47316#-- begin-filehistory --# 47317 47318class FileHistory(Object): 47319 """ 47320 FileHistory(maxFiles=9, idBase=ID_FILE1) 47321 47322 The wxFileHistory encapsulates a user interface convenience, the list 47323 of most recently visited files as shown on a menu (usually the File 47324 menu). 47325 """ 47326 47327 def __init__(self, maxFiles=9, idBase=ID_FILE1): 47328 """ 47329 FileHistory(maxFiles=9, idBase=ID_FILE1) 47330 47331 The wxFileHistory encapsulates a user interface convenience, the list 47332 of most recently visited files as shown on a menu (usually the File 47333 menu). 47334 """ 47335 47336 def AddFileToHistory(self, filename): 47337 """ 47338 AddFileToHistory(filename) 47339 47340 Adds a file to the file history list, if the object has a pointer to 47341 an appropriate file menu. 47342 """ 47343 47344 def AddFilesToMenu(self, *args, **kw): 47345 """ 47346 AddFilesToMenu() 47347 AddFilesToMenu(menu) 47348 47349 Appends the files in the history list, to all menus managed by the 47350 file history object. 47351 """ 47352 47353 def GetBaseId(self): 47354 """ 47355 GetBaseId() -> WindowID 47356 47357 Returns the base identifier for the range used for appending items. 47358 """ 47359 47360 def GetCount(self): 47361 """ 47362 GetCount() -> size_t 47363 47364 Returns the number of files currently stored in the file history. 47365 """ 47366 47367 def GetHistoryFile(self, index): 47368 """ 47369 GetHistoryFile(index) -> String 47370 47371 Returns the file at this index (zero-based). 47372 """ 47373 47374 def GetMaxFiles(self): 47375 """ 47376 GetMaxFiles() -> int 47377 47378 Returns the maximum number of files that can be stored. 47379 """ 47380 47381 def GetMenus(self): 47382 """ 47383 GetMenus() -> FileHistoryMenuList 47384 47385 Returns the list of menus that are managed by this file history 47386 object. 47387 """ 47388 47389 def Load(self, config): 47390 """ 47391 Load(config) 47392 47393 Loads the file history from the given config object. 47394 """ 47395 47396 def RemoveFileFromHistory(self, i): 47397 """ 47398 RemoveFileFromHistory(i) 47399 47400 Removes the specified file from the history. 47401 """ 47402 47403 def RemoveMenu(self, menu): 47404 """ 47405 RemoveMenu(menu) 47406 47407 Removes this menu from the list of those managed by this object. 47408 """ 47409 47410 def Save(self, config): 47411 """ 47412 Save(config) 47413 47414 Saves the file history into the given config object. 47415 """ 47416 47417 def SetBaseId(self, baseId): 47418 """ 47419 SetBaseId(baseId) 47420 47421 Sets the base identifier for the range used for appending items. 47422 """ 47423 47424 def UseMenu(self, menu): 47425 """ 47426 UseMenu(menu) 47427 47428 Adds this menu to the list of those menus that are managed by this 47429 file history object. 47430 """ 47431 BaseId = property(None, None) 47432 Count = property(None, None) 47433 MaxFiles = property(None, None) 47434 Menus = property(None, None) 47435# end of class FileHistory 47436 47437#-- end-filehistory --# 47438#-- begin-cmdproc --# 47439 47440class Command(Object): 47441 """ 47442 Command(canUndo=False, name=EmptyString) 47443 47444 wxCommand is a base class for modelling an application command, which 47445 is an action usually performed by selecting a menu item, pressing a 47446 toolbar button or any other means provided by the application to 47447 change the data or view. 47448 """ 47449 47450 def __init__(self, canUndo=False, name=EmptyString): 47451 """ 47452 Command(canUndo=False, name=EmptyString) 47453 47454 wxCommand is a base class for modelling an application command, which 47455 is an action usually performed by selecting a menu item, pressing a 47456 toolbar button or any other means provided by the application to 47457 change the data or view. 47458 """ 47459 47460 def CanUndo(self): 47461 """ 47462 CanUndo() -> bool 47463 47464 Returns true if the command can be undone, false otherwise. 47465 """ 47466 47467 def Do(self): 47468 """ 47469 Do() -> bool 47470 47471 Override this member function to execute the appropriate action when 47472 called. 47473 """ 47474 47475 def GetName(self): 47476 """ 47477 GetName() -> String 47478 47479 Returns the command name. 47480 """ 47481 47482 def Undo(self): 47483 """ 47484 Undo() -> bool 47485 47486 Override this member function to un-execute a previous Do. 47487 """ 47488 Name = property(None, None) 47489# end of class Command 47490 47491 47492class CommandProcessor(Object): 47493 """ 47494 CommandProcessor(maxCommands=-1) 47495 47496 wxCommandProcessor is a class that maintains a history of wxCommands, 47497 with undo/redo functionality built-in. 47498 """ 47499 47500 def __init__(self, maxCommands=-1): 47501 """ 47502 CommandProcessor(maxCommands=-1) 47503 47504 wxCommandProcessor is a class that maintains a history of wxCommands, 47505 with undo/redo functionality built-in. 47506 """ 47507 47508 def CanUndo(self): 47509 """ 47510 CanUndo() -> bool 47511 47512 Returns true if the currently-active command can be undone, false 47513 otherwise. 47514 """ 47515 47516 def CanRedo(self): 47517 """ 47518 CanRedo() -> bool 47519 47520 Returns true if the currently-active command can be redone, false 47521 otherwise. 47522 """ 47523 47524 def ClearCommands(self): 47525 """ 47526 ClearCommands() 47527 47528 Deletes all commands in the list and sets the current command pointer 47529 to NULL. 47530 """ 47531 47532 def GetCommands(self): 47533 """ 47534 GetCommands() -> CommandList 47535 47536 Returns the list of commands. 47537 """ 47538 47539 def GetCurrentCommand(self): 47540 """ 47541 GetCurrentCommand() -> Command 47542 47543 Returns the current command. 47544 """ 47545 47546 def GetEditMenu(self): 47547 """ 47548 GetEditMenu() -> Menu 47549 47550 Returns the edit menu associated with the command processor. 47551 """ 47552 47553 def GetMaxCommands(self): 47554 """ 47555 GetMaxCommands() -> int 47556 47557 Returns the maximum number of commands that the command processor 47558 stores. 47559 """ 47560 47561 def GetRedoAccelerator(self): 47562 """ 47563 GetRedoAccelerator() -> String 47564 47565 Returns the string that will be appended to the Redo menu item. 47566 """ 47567 47568 def GetRedoMenuLabel(self): 47569 """ 47570 GetRedoMenuLabel() -> String 47571 47572 Returns the string that will be shown for the redo menu item. 47573 """ 47574 47575 def GetUndoAccelerator(self): 47576 """ 47577 GetUndoAccelerator() -> String 47578 47579 Returns the string that will be appended to the Undo menu item. 47580 """ 47581 47582 def GetUndoMenuLabel(self): 47583 """ 47584 GetUndoMenuLabel() -> String 47585 47586 Returns the string that will be shown for the undo menu item. 47587 """ 47588 47589 def Initialize(self): 47590 """ 47591 Initialize() 47592 47593 Initializes the command processor, setting the current command to the 47594 last in the list (if any), and updating the edit menu (if one has been 47595 specified). 47596 """ 47597 47598 def IsDirty(self): 47599 """ 47600 IsDirty() -> bool 47601 47602 Returns a boolean value that indicates if changes have been made since 47603 the last save operation. 47604 """ 47605 47606 def MarkAsSaved(self): 47607 """ 47608 MarkAsSaved() 47609 47610 You must call this method whenever the project is saved if you plan to 47611 use IsDirty(). 47612 """ 47613 47614 def Redo(self): 47615 """ 47616 Redo() -> bool 47617 47618 Executes (redoes) the current command (the command that has just been 47619 undone if any). 47620 """ 47621 47622 def SetEditMenu(self, menu): 47623 """ 47624 SetEditMenu(menu) 47625 47626 Tells the command processor to update the Undo and Redo items on this 47627 menu as appropriate. 47628 """ 47629 47630 def SetMenuStrings(self): 47631 """ 47632 SetMenuStrings() 47633 47634 Sets the menu labels according to the currently set menu and the 47635 current command state. 47636 """ 47637 47638 def SetRedoAccelerator(self, accel): 47639 """ 47640 SetRedoAccelerator(accel) 47641 47642 Sets the string that will be appended to the Redo menu item. 47643 """ 47644 47645 def SetUndoAccelerator(self, accel): 47646 """ 47647 SetUndoAccelerator(accel) 47648 47649 Sets the string that will be appended to the Undo menu item. 47650 """ 47651 47652 def Submit(self, command, storeIt=True): 47653 """ 47654 Submit(command, storeIt=True) -> bool 47655 47656 Submits a new command to the command processor. 47657 """ 47658 47659 def Store(self, command): 47660 """ 47661 Store(command) 47662 47663 Just store the command without executing it. 47664 """ 47665 47666 def Undo(self): 47667 """ 47668 Undo() -> bool 47669 47670 Undoes the last command executed. 47671 """ 47672 Commands = property(None, None) 47673 CurrentCommand = property(None, None) 47674 EditMenu = property(None, None) 47675 MaxCommands = property(None, None) 47676 RedoAccelerator = property(None, None) 47677 RedoMenuLabel = property(None, None) 47678 UndoAccelerator = property(None, None) 47679 UndoMenuLabel = property(None, None) 47680# end of class CommandProcessor 47681 47682#-- end-cmdproc --# 47683#-- begin-fswatcher --# 47684FSW_EVENT_CREATE = 0 47685FSW_EVENT_DELETE = 0 47686FSW_EVENT_RENAME = 0 47687FSW_EVENT_MODIFY = 0 47688FSW_EVENT_ACCESS = 0 47689FSW_EVENT_ATTRIB = 0 47690FSW_EVENT_UNMOUNT = 0 47691FSW_EVENT_WARNING = 0 47692FSW_EVENT_ERROR = 0 47693FSW_EVENT_ALL = 0 47694FSW_WARNING_NONE = 0 47695FSW_WARNING_GENERAL = 0 47696FSW_WARNING_OVERFLOW = 0 47697wxEVT_FSWATCHER = 0 47698 47699class FileSystemWatcher(EvtHandler): 47700 """ 47701 FileSystemWatcher() 47702 47703 The wxFileSystemWatcher class allows receiving notifications of file 47704 system changes. 47705 """ 47706 47707 def __init__(self): 47708 """ 47709 FileSystemWatcher() 47710 47711 The wxFileSystemWatcher class allows receiving notifications of file 47712 system changes. 47713 """ 47714 47715 def Add(self, path, events=FSW_EVENT_ALL): 47716 """ 47717 Add(path, events=FSW_EVENT_ALL) -> bool 47718 47719 Adds path to currently watched files. 47720 """ 47721 47722 def AddTree(self, path, events=FSW_EVENT_ALL, filter=EmptyString): 47723 """ 47724 AddTree(path, events=FSW_EVENT_ALL, filter=EmptyString) -> bool 47725 47726 This is the same as Add(), but also recursively adds every 47727 file/directory in the tree rooted at path. 47728 """ 47729 47730 def Remove(self, path): 47731 """ 47732 Remove(path) -> bool 47733 47734 Removes path from the list of watched paths. 47735 """ 47736 47737 def RemoveTree(self, path): 47738 """ 47739 RemoveTree(path) -> bool 47740 47741 This is the same as Remove(), but also removes every file/directory 47742 belonging to the tree rooted at path. 47743 """ 47744 47745 def RemoveAll(self): 47746 """ 47747 RemoveAll() -> bool 47748 47749 Clears the list of currently watched paths. 47750 """ 47751 47752 def GetWatchedPathsCount(self): 47753 """ 47754 GetWatchedPathsCount() -> int 47755 47756 Returns the number of currently watched paths. 47757 """ 47758 47759 def GetWatchedPaths(self, paths): 47760 """ 47761 GetWatchedPaths(paths) -> int 47762 47763 Retrieves all watched paths and places them in paths. 47764 """ 47765 47766 def SetOwner(self, handler): 47767 """ 47768 SetOwner(handler) 47769 47770 Associates the file system watcher with the given handler object. 47771 """ 47772 WatchedPathsCount = property(None, None) 47773# end of class FileSystemWatcher 47774 47775 47776class FileSystemWatcherEvent(Event): 47777 """ 47778 FileSystemWatcherEvent(changeType=0, watchid=ID_ANY) 47779 FileSystemWatcherEvent(changeType, warningType, errorMsg, watchid=ID_ANY) 47780 FileSystemWatcherEvent(changeType, path, newPath, watchid=ID_ANY) 47781 47782 A class of events sent when a file system event occurs. 47783 """ 47784 47785 def __init__(self, *args, **kw): 47786 """ 47787 FileSystemWatcherEvent(changeType=0, watchid=ID_ANY) 47788 FileSystemWatcherEvent(changeType, warningType, errorMsg, watchid=ID_ANY) 47789 FileSystemWatcherEvent(changeType, path, newPath, watchid=ID_ANY) 47790 47791 A class of events sent when a file system event occurs. 47792 """ 47793 47794 def GetPath(self): 47795 """ 47796 GetPath() -> FileName 47797 47798 Returns the path at which the event occurred. 47799 """ 47800 47801 def GetNewPath(self): 47802 """ 47803 GetNewPath() -> FileName 47804 47805 Returns the new path of the renamed file/directory if this is a rename 47806 event. 47807 """ 47808 47809 def GetChangeType(self): 47810 """ 47811 GetChangeType() -> int 47812 47813 Returns the type of file system change that occurred. 47814 """ 47815 47816 def IsError(self): 47817 """ 47818 IsError() -> bool 47819 47820 Returns true if this error is an error event. 47821 """ 47822 47823 def GetErrorDescription(self): 47824 """ 47825 GetErrorDescription() -> String 47826 47827 Return a description of the warning or error if this is an error 47828 event. 47829 """ 47830 47831 def GetWarningType(self): 47832 """ 47833 GetWarningType() -> FSWWarningType 47834 47835 Return the type of the warning if this event is a warning one. 47836 """ 47837 47838 def ToString(self): 47839 """ 47840 ToString() -> String 47841 47842 Returns a wxString describing an event, useful for logging, debugging 47843 or testing. 47844 """ 47845 47846 def Clone(self): 47847 """ 47848 Clone() -> Event 47849 """ 47850 ChangeType = property(None, None) 47851 ErrorDescription = property(None, None) 47852 NewPath = property(None, None) 47853 Path = property(None, None) 47854 WarningType = property(None, None) 47855# end of class FileSystemWatcherEvent 47856 47857USE_FSWATCHER = 0 47858 47859EVT_FSWATCHER = wx.PyEventBinder(wxEVT_FSWATCHER) 47860#-- end-fswatcher --# 47861#-- begin-preferences --# 47862 47863class PreferencesEditor(object): 47864 """ 47865 PreferencesEditor(title="") 47866 47867 Manage preferences dialog. 47868 """ 47869 47870 def __init__(self, title=""): 47871 """ 47872 PreferencesEditor(title="") 47873 47874 Manage preferences dialog. 47875 """ 47876 47877 def AddPage(self, page): 47878 """ 47879 AddPage(page) 47880 47881 Add a new page to the editor. 47882 """ 47883 47884 def Show(self, parent): 47885 """ 47886 Show(parent) 47887 47888 Show the preferences dialog or bring it to the top if it's already 47889 shown. 47890 """ 47891 47892 def Dismiss(self): 47893 """ 47894 Dismiss() 47895 47896 Hide the currently shown dialog, if any. 47897 """ 47898 47899 @staticmethod 47900 def ShouldApplyChangesImmediately(): 47901 """ 47902 ShouldApplyChangesImmediately() -> bool 47903 47904 Returns whether changes to values in preferences pages should be 47905 applied immediately or only when the user clicks the OK button. 47906 """ 47907# end of class PreferencesEditor 47908 47909 47910class PreferencesPage(object): 47911 """ 47912 PreferencesPage() 47913 47914 One page of preferences dialog. 47915 """ 47916 47917 def __init__(self): 47918 """ 47919 PreferencesPage() 47920 47921 One page of preferences dialog. 47922 """ 47923 47924 def GetName(self): 47925 """ 47926 GetName() -> String 47927 47928 Return name of the page. 47929 """ 47930 47931 def GetLargeIcon(self): 47932 """ 47933 GetLargeIcon() -> Bitmap 47934 47935 Return 32x32 icon used for the page on some platforms. 47936 """ 47937 47938 def CreateWindow(self, parent): 47939 """ 47940 CreateWindow(parent) -> Window 47941 47942 Create a window for this page. 47943 """ 47944 LargeIcon = property(None, None) 47945 Name = property(None, None) 47946# end of class PreferencesPage 47947 47948 47949class StockPreferencesPage(PreferencesPage): 47950 """ 47951 StockPreferencesPage(kind) 47952 47953 Specialization of wxPreferencesPage useful for certain commonly used 47954 preferences page. 47955 """ 47956 Kind_General = 0 47957 Kind_Advanced = 0 47958 47959 def __init__(self, kind): 47960 """ 47961 StockPreferencesPage(kind) 47962 47963 Specialization of wxPreferencesPage useful for certain commonly used 47964 preferences page. 47965 """ 47966 47967 def GetKind(self): 47968 """ 47969 GetKind() -> Kind 47970 47971 Returns the page's kind. 47972 """ 47973 47974 def GetName(self): 47975 """ 47976 GetName() -> String 47977 47978 Reimplemented to return suitable name for the page's kind. 47979 """ 47980 47981 def GetLargeIcon(self): 47982 """ 47983 GetLargeIcon() -> Bitmap 47984 47985 Reimplemented to return stock icon on OS X. 47986 """ 47987 LargeIcon = property(None, None) 47988 Name = property(None, None) 47989# end of class StockPreferencesPage 47990 47991#-- end-preferences --# 47992#-- begin-modalhook --# 47993 47994class ModalDialogHook(object): 47995 """ 47996 ModalDialogHook() 47997 47998 Allows intercepting all modal dialog calls. 47999 """ 48000 48001 def __init__(self): 48002 """ 48003 ModalDialogHook() 48004 48005 Allows intercepting all modal dialog calls. 48006 """ 48007 48008 def Register(self): 48009 """ 48010 Register() 48011 48012 Register this hook as being active. 48013 """ 48014 48015 def Unregister(self): 48016 """ 48017 Unregister() 48018 48019 Unregister this hook. 48020 """ 48021 48022 def Enter(self, dialog): 48023 """ 48024 Enter(dialog) -> int 48025 48026 Called by wxWidgets before showing any modal dialogs. 48027 """ 48028 48029 def Exit(self, dialog): 48030 """ 48031 Exit(dialog) 48032 48033 Called by wxWidgets after dismissing the modal dialog. 48034 """ 48035# end of class ModalDialogHook 48036 48037#-- end-modalhook --# 48038#-- begin-unichar --# 48039 48040class UniChar(object): 48041 """ 48042 UniChar(c) 48043 UniChar(c) 48044 48045 This class represents a single Unicode character. 48046 """ 48047 48048 def __init__(self, *args, **kw): 48049 """ 48050 UniChar(c) 48051 UniChar(c) 48052 48053 This class represents a single Unicode character. 48054 """ 48055 48056 def GetValue(self): 48057 """ 48058 GetValue() -> value_type 48059 48060 Returns Unicode code point value of the character. 48061 """ 48062 48063 def IsAscii(self): 48064 """ 48065 IsAscii() -> bool 48066 48067 Returns true if the character is an ASCII character (i.e. if its value 48068 is less than 128). 48069 """ 48070 48071 def GetAsChar(self, c): 48072 """ 48073 GetAsChar(c) -> bool 48074 48075 Returns true if the character is representable as a single byte in the 48076 current locale encoding. 48077 """ 48078 Value = property(None, None) 48079# end of class UniChar 48080 48081#-- end-unichar --# 48082#-- begin-stockitem --# 48083STOCK_NOFLAGS = 0 48084STOCK_WITH_MNEMONIC = 0 48085STOCK_WITH_ACCELERATOR = 0 48086STOCK_WITHOUT_ELLIPSIS = 0 48087STOCK_FOR_BUTTON = 0 48088 48089def GetStockLabel(id, flags=STOCK_WITH_MNEMONIC): 48090 """ 48091 GetStockLabel(id, flags=STOCK_WITH_MNEMONIC) -> String 48092 48093 Returns label that should be used for given id element. 48094 """ 48095#-- end-stockitem --# 48096