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 ``wx.adv`` module contains classes which are more advanced and/or less 22commonly used than those in the core namespace. They are provided in a 23separate module to help reduce overhead and dependencies for those 24applications which do not need any of these classes. 25""" 26#-- begin-_adv --# 27 28import wx 29#-- end-_adv --# 30#-- begin-aboutdlg --# 31 32class AboutDialogInfo(object): 33 """ 34 AboutDialogInfo() 35 36 wxAboutDialogInfo contains information shown in the standard About 37 dialog displayed by the wxAboutBox() function. 38 """ 39 40 def __init__(self): 41 """ 42 AboutDialogInfo() 43 44 wxAboutDialogInfo contains information shown in the standard About 45 dialog displayed by the wxAboutBox() function. 46 """ 47 48 def AddArtist(self, artist): 49 """ 50 AddArtist(artist) 51 52 Adds an artist name to be shown in the program credits. 53 """ 54 55 def AddDeveloper(self, developer): 56 """ 57 AddDeveloper(developer) 58 59 Adds a developer name to be shown in the program credits. 60 """ 61 62 def AddDocWriter(self, docwriter): 63 """ 64 AddDocWriter(docwriter) 65 66 Adds a documentation writer name to be shown in the program credits. 67 """ 68 69 def AddTranslator(self, translator): 70 """ 71 AddTranslator(translator) 72 73 Adds a translator name to be shown in the program credits. 74 """ 75 76 def GetName(self): 77 """ 78 GetName() -> String 79 80 Get the name of the program. 81 """ 82 83 def HasDescription(self): 84 """ 85 HasDescription() -> bool 86 87 Returns true if a description string has been specified. 88 """ 89 90 def GetDescription(self): 91 """ 92 GetDescription() -> String 93 94 Get the description string. 95 """ 96 97 def HasCopyright(self): 98 """ 99 HasCopyright() -> bool 100 101 Returns true if a copyright string has been specified. 102 """ 103 104 def GetCopyright(self): 105 """ 106 GetCopyright() -> String 107 108 Get the copyright string. 109 """ 110 111 def SetArtists(self, artists): 112 """ 113 SetArtists(artists) 114 115 Sets the list of artists to be shown in the program credits. 116 """ 117 118 def SetCopyright(self, copyright): 119 """ 120 SetCopyright(copyright) 121 122 Set the short string containing the program copyright information. 123 """ 124 125 def SetDescription(self, desc): 126 """ 127 SetDescription(desc) 128 129 Set brief, but possibly multiline, description of the program. 130 """ 131 132 def SetDevelopers(self, developers): 133 """ 134 SetDevelopers(developers) 135 136 Set the list of developers of the program. 137 """ 138 139 def SetDocWriters(self, docwriters): 140 """ 141 SetDocWriters(docwriters) 142 143 Set the list of documentation writers. 144 """ 145 146 def HasIcon(self): 147 """ 148 HasIcon() -> bool 149 150 Returns true if an icon has been set for the about dialog. 151 """ 152 153 def GetIcon(self): 154 """ 155 GetIcon() -> wx.Icon 156 157 Returns the icon set by SetIcon(). 158 """ 159 160 def SetIcon(self, icon): 161 """ 162 SetIcon(icon) 163 164 Set the icon to be shown in the dialog. 165 """ 166 167 def HasLicence(self): 168 """ 169 HasLicence() -> bool 170 171 Returns true if the licence string has been set. 172 """ 173 174 def GetLicence(self): 175 """ 176 GetLicence() -> String 177 178 Returns the licence string. 179 """ 180 181 def SetLicence(self, licence): 182 """ 183 SetLicence(licence) 184 185 Set the long, multiline string containing the text of the program 186 licence. 187 """ 188 189 def SetLicense(self, licence): 190 """ 191 SetLicense(licence) 192 193 This is the same as SetLicence(). 194 """ 195 196 def SetName(self, name): 197 """ 198 SetName(name) 199 200 Set the name of the program. 201 """ 202 203 def SetTranslators(self, translators): 204 """ 205 SetTranslators(translators) 206 207 Set the list of translators. 208 """ 209 210 def SetVersion(self, version, longVersion=""): 211 """ 212 SetVersion(version, longVersion="") 213 214 Set the version of the program. 215 """ 216 217 def GetVersion(self): 218 """ 219 GetVersion() -> String 220 221 Return the short version string. 222 """ 223 224 def GetLongVersion(self): 225 """ 226 GetLongVersion() -> String 227 228 Return the long version string if set. 229 """ 230 231 def HasWebSite(self): 232 """ 233 HasWebSite() -> bool 234 235 Returns true if the website info has been set. 236 """ 237 238 def GetWebSiteURL(self): 239 """ 240 GetWebSiteURL() -> String 241 242 Returns the website URL set for the dialog. 243 """ 244 245 def GetWebSiteDescription(self): 246 """ 247 GetWebSiteDescription() -> String 248 249 Returns the description of the website URL set for the dialog. 250 """ 251 252 def SetWebSite(self, url, desc=wx.EmptyString): 253 """ 254 SetWebSite(url, desc=wx.EmptyString) 255 256 Set the web site for the program and its description (which defaults 257 to url itself if empty). 258 """ 259 260 def HasDevelopers(self): 261 """ 262 HasDevelopers() -> bool 263 264 Returns true if developers have been set in the dialog info. 265 """ 266 267 def GetDevelopers(self): 268 """ 269 GetDevelopers() -> ArrayString 270 271 Returns an array of the developer strings set in the dialog info. 272 """ 273 274 def HasDocWriters(self): 275 """ 276 HasDocWriters() -> bool 277 278 Returns true if writers have been set in the dialog info. 279 """ 280 281 def GetDocWriters(self): 282 """ 283 GetDocWriters() -> ArrayString 284 285 Returns an array of the writer strings set in the dialog info. 286 """ 287 288 def HasArtists(self): 289 """ 290 HasArtists() -> bool 291 292 Returns true if artists have been set in the dialog info. 293 """ 294 295 def GetArtists(self): 296 """ 297 GetArtists() -> ArrayString 298 299 Returns an array of the artist strings set in the dialog info. 300 """ 301 302 def HasTranslators(self): 303 """ 304 HasTranslators() -> bool 305 306 Returns true if translators have been set in the dialog info. 307 """ 308 309 def GetTranslators(self): 310 """ 311 GetTranslators() -> ArrayString 312 313 Returns an array of the translator strings set in the dialog info. 314 """ 315 Artists = property(None, None) 316 Copyright = property(None, None) 317 Description = property(None, None) 318 Developers = property(None, None) 319 DocWriters = property(None, None) 320 Icon = property(None, None) 321 Licence = property(None, None) 322 LongVersion = property(None, None) 323 Name = property(None, None) 324 Translators = property(None, None) 325 Version = property(None, None) 326 WebSiteDescription = property(None, None) 327 WebSiteURL = property(None, None) 328 329 HasLicense = HasLicence 330 GetLicense = GetLicence 331 License = Licence 332# end of class AboutDialogInfo 333 334 335def AboutBox(info, parent=None): 336 """ 337 AboutBox(info, parent=None) 338 339 This function shows the standard about dialog containing the 340 information specified in info. 341 """ 342 343def GenericAboutBox(info, parent=None): 344 """ 345 GenericAboutBox(info, parent=None) 346 347 This function does the same thing as wxAboutBox() except that it 348 always uses the generic wxWidgets version of the dialog instead of the 349 native one. 350 """ 351#-- end-aboutdlg --# 352#-- begin-helpext --# 353 354class ExtHelpController(wx.HelpControllerBase): 355 """ 356 ExtHelpController(parentWindow=None) 357 358 This class implements help via an external browser. 359 """ 360 361 def __init__(self, parentWindow=None): 362 """ 363 ExtHelpController(parentWindow=None) 364 365 This class implements help via an external browser. 366 """ 367 368 def SetViewer(self, viewer=wx.EmptyString, flags=wx.HELP_NETSCAPE): 369 """ 370 SetViewer(viewer=wx.EmptyString, flags=wx.HELP_NETSCAPE) 371 372 Tell it which browser to use. 373 """ 374 375 def Initialize(self, dir): 376 """ 377 Initialize(dir) -> bool 378 379 This must be called to tell the controller where to find the 380 documentation. 381 """ 382 383 def LoadFile(self, file=wx.EmptyString): 384 """ 385 LoadFile(file=wx.EmptyString) -> bool 386 387 If file is "", reloads file given in Initialize. 388 """ 389 390 def DisplayContents(self): 391 """ 392 DisplayContents() -> bool 393 394 Display list of all help entries. 395 """ 396 397 def DisplaySection(self, *args, **kw): 398 """ 399 DisplaySection(sectionNo) -> bool 400 DisplaySection(section) -> bool 401 402 Display help for id sectionNo. 403 """ 404 405 def DisplayBlock(self, blockNo): 406 """ 407 DisplayBlock(blockNo) -> bool 408 409 Display help for URL (using DisplayHelp) or keyword (using 410 KeywordSearch) 411 """ 412 413 def KeywordSearch(self, k, mode=wx.HELP_SEARCH_ALL): 414 """ 415 KeywordSearch(k, mode=wx.HELP_SEARCH_ALL) -> bool 416 417 Search comment/documentation fields in map file and present a list to 418 chose from. 419 """ 420 421 def Quit(self): 422 """ 423 Quit() -> bool 424 425 Does nothing. 426 """ 427 428 def OnQuit(self): 429 """ 430 OnQuit() 431 432 Does nothing. 433 """ 434 435 def DisplayHelp(self, relativeURL): 436 """ 437 DisplayHelp(relativeURL) -> bool 438 439 Call the browser using a relative URL. 440 """ 441 442 def SetFrameParameters(self, titleFormat, size, pos=wx.DefaultPosition, newFrameEachTime=False): 443 """ 444 SetFrameParameters(titleFormat, size, pos=wx.DefaultPosition, newFrameEachTime=False) 445 446 Allows one to override the default settings for the help frame. 447 """ 448 449 def GetFrameParameters(self, size=None, pos=None, newFrameEachTime=None): 450 """ 451 GetFrameParameters(size=None, pos=None, newFrameEachTime=None) -> wx.Frame 452 453 Obtains the latest settings used by the help frame and the help frame. 454 """ 455 FrameParameters = property(None, None) 456# end of class ExtHelpController 457 458#-- end-helpext --# 459#-- begin-commandlinkbutton --# 460 461class CommandLinkButton(wx.Button): 462 """ 463 CommandLinkButton() 464 CommandLinkButton(parent, id=wx.ID_ANY, mainLabel=wx.EmptyString, note=wx.EmptyString, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0, validator=wx.DefaultValidator, name=wx.ButtonNameStr) 465 466 Objects of this class are similar in appearance to the normal 467 wxButtons but are similar to the links in a web page in functionality. 468 """ 469 470 def __init__(self, *args, **kw): 471 """ 472 CommandLinkButton() 473 CommandLinkButton(parent, id=wx.ID_ANY, mainLabel=wx.EmptyString, note=wx.EmptyString, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0, validator=wx.DefaultValidator, name=wx.ButtonNameStr) 474 475 Objects of this class are similar in appearance to the normal 476 wxButtons but are similar to the links in a web page in functionality. 477 """ 478 479 def Create(self, parent, id=wx.ID_ANY, mainLabel=wx.EmptyString, note=wx.EmptyString, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0, validator=wx.DefaultValidator, name=wx.ButtonNameStr): 480 """ 481 Create(parent, id=wx.ID_ANY, mainLabel=wx.EmptyString, note=wx.EmptyString, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0, validator=wx.DefaultValidator, name=wx.ButtonNameStr) -> bool 482 483 Button creation function for two-step creation. 484 """ 485 486 def SetMainLabelAndNote(self, mainLabel, note): 487 """ 488 SetMainLabelAndNote(mainLabel, note) 489 490 Sets a new main label and note for the button. 491 """ 492 493 def SetLabel(self, label): 494 """ 495 SetLabel(label) 496 497 Sets the string label and note for the button. 498 """ 499 500 def GetLabel(self): 501 """ 502 GetLabel() -> String 503 504 Returns the string label for the button. 505 """ 506 507 def SetMainLabel(self, mainLabel): 508 """ 509 SetMainLabel(mainLabel) 510 511 Changes the main label. 512 """ 513 514 def SetNote(self, note): 515 """ 516 SetNote(note) 517 518 Changes the note. 519 """ 520 521 def GetMainLabel(self): 522 """ 523 GetMainLabel() -> String 524 525 Returns the current main label. 526 """ 527 528 def GetNote(self): 529 """ 530 GetNote() -> String 531 532 Returns the currently used note. 533 """ 534 535 @staticmethod 536 def GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL): 537 """ 538 GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) -> wx.VisualAttributes 539 """ 540 Label = property(None, None) 541 MainLabel = property(None, None) 542 Note = property(None, None) 543# end of class CommandLinkButton 544 545#-- end-commandlinkbutton --# 546#-- begin-dateevt --# 547wxEVT_DATE_CHANGED = 0 548wxEVT_TIME_CHANGED = 0 549 550class DateEvent(wx.CommandEvent): 551 """ 552 DateEvent() 553 DateEvent(win, dt, type) 554 555 This event class holds information about a date change and is used 556 together with wxDatePickerCtrl. 557 """ 558 559 def __init__(self, *args, **kw): 560 """ 561 DateEvent() 562 DateEvent(win, dt, type) 563 564 This event class holds information about a date change and is used 565 together with wxDatePickerCtrl. 566 """ 567 568 def GetDate(self): 569 """ 570 GetDate() -> wx.DateTime 571 572 Returns the date. 573 """ 574 575 def SetDate(self, date): 576 """ 577 SetDate(date) 578 579 Sets the date carried by the event, normally only used by the library 580 internally. 581 """ 582 583 def PyGetDate(self): 584 """ 585 Return the date as a Python datetime.date object. 586 """ 587 588 PySetDate = wx.deprecated(SetDate, 'Use SetDate instead.') 589 Date = property(None, None) 590# end of class DateEvent 591 592 593EVT_DATE_CHANGED = wx.PyEventBinder( wxEVT_DATE_CHANGED, 1 ) 594EVT_TIME_CHANGED = wx.PyEventBinder( wxEVT_TIME_CHANGED, 1 ) 595#-- end-dateevt --# 596#-- begin-datectrl --# 597DP_DEFAULT = 0 598DP_SPIN = 0 599DP_DROPDOWN = 0 600DP_SHOWCENTURY = 0 601DP_ALLOWNONE = 0 602 603class DatePickerCtrl(wx.Control): 604 """ 605 DatePickerCtrl() 606 DatePickerCtrl(parent, id=wx.ID_ANY, dt=wx.DefaultDateTime, pos=wx.DefaultPosition, size=wx.DefaultSize, style=DP_DEFAULT|DP_SHOWCENTURY, validator=wx.DefaultValidator, name="datectrl") 607 608 This control allows the user to select a date. 609 """ 610 611 def __init__(self, *args, **kw): 612 """ 613 DatePickerCtrl() 614 DatePickerCtrl(parent, id=wx.ID_ANY, dt=wx.DefaultDateTime, pos=wx.DefaultPosition, size=wx.DefaultSize, style=DP_DEFAULT|DP_SHOWCENTURY, validator=wx.DefaultValidator, name="datectrl") 615 616 This control allows the user to select a date. 617 """ 618 619 def Create(self, parent, id=wx.ID_ANY, dt=wx.DefaultDateTime, pos=wx.DefaultPosition, size=wx.DefaultSize, style=DP_DEFAULT|DP_SHOWCENTURY, validator=wx.DefaultValidator, name="datectrl"): 620 """ 621 Create(parent, id=wx.ID_ANY, dt=wx.DefaultDateTime, pos=wx.DefaultPosition, size=wx.DefaultSize, style=DP_DEFAULT|DP_SHOWCENTURY, validator=wx.DefaultValidator, name="datectrl") -> bool 622 623 Create the control window. 624 """ 625 626 def GetRange(self): 627 """ 628 GetRange() -> (bool, dt1, dt2) 629 630 If the control had been previously limited to a range of dates using 631 SetRange(), returns the lower and upper bounds of this range. 632 """ 633 634 def GetValue(self): 635 """ 636 GetValue() -> wx.DateTime 637 638 Returns the currently entered date. 639 """ 640 641 def SetRange(self, dt1, dt2): 642 """ 643 SetRange(dt1, dt2) 644 645 Sets the valid range for the date selection. 646 """ 647 648 def SetValue(self, dt): 649 """ 650 SetValue(dt) 651 652 Changes the current value of the control. 653 """ 654 655 @staticmethod 656 def GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL): 657 """ 658 GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) -> wx.VisualAttributes 659 """ 660 Value = property(None, None) 661# end of class DatePickerCtrl 662 663 664class GenericDatePickerCtrl(wx.Control): 665 """ 666 DatePickerCtrlGeneric() 667 DatePickerCtrlGeneric(parent, id=wx.ID_ANY, dt=wx.DefaultDateTime, pos=wx.DefaultPosition, size=wx.DefaultSize, style=DP_DEFAULT|DP_SHOWCENTURY, validator=wx.DefaultValidator, name="datectrl") 668 669 This control allows the user to select a date. 670 """ 671 672 def __init__(self, *args, **kw): 673 """ 674 DatePickerCtrlGeneric() 675 DatePickerCtrlGeneric(parent, id=wx.ID_ANY, dt=wx.DefaultDateTime, pos=wx.DefaultPosition, size=wx.DefaultSize, style=DP_DEFAULT|DP_SHOWCENTURY, validator=wx.DefaultValidator, name="datectrl") 676 677 This control allows the user to select a date. 678 """ 679 680 def Create(self, parent, id=wx.ID_ANY, dt=wx.DefaultDateTime, pos=wx.DefaultPosition, size=wx.DefaultSize, style=DP_DEFAULT|DP_SHOWCENTURY, validator=wx.DefaultValidator, name="datectrl"): 681 """ 682 Create(parent, id=wx.ID_ANY, dt=wx.DefaultDateTime, pos=wx.DefaultPosition, size=wx.DefaultSize, style=DP_DEFAULT|DP_SHOWCENTURY, validator=wx.DefaultValidator, name="datectrl") -> bool 683 684 Create the control window. 685 """ 686 687 def GetRange(self): 688 """ 689 GetRange() -> (bool, dt1, dt2) 690 691 If the control had been previously limited to a range of dates using 692 SetRange(), returns the lower and upper bounds of this range. 693 """ 694 695 def GetValue(self): 696 """ 697 GetValue() -> wx.DateTime 698 699 Returns the currently entered date. 700 """ 701 702 def SetRange(self, dt1, dt2): 703 """ 704 SetRange(dt1, dt2) 705 706 Sets the valid range for the date selection. 707 """ 708 709 def SetValue(self, dt): 710 """ 711 SetValue(dt) 712 713 Changes the current value of the control. 714 """ 715 716 @staticmethod 717 def GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL): 718 """ 719 GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) -> wx.VisualAttributes 720 """ 721 Value = property(None, None) 722# end of class GenericDatePickerCtrl 723 724#-- end-datectrl --# 725#-- begin-calctrl --# 726CAL_SUNDAY_FIRST = 0 727CAL_MONDAY_FIRST = 0 728CAL_SHOW_HOLIDAYS = 0 729CAL_NO_YEAR_CHANGE = 0 730CAL_NO_MONTH_CHANGE = 0 731CAL_SEQUENTIAL_MONTH_SELECTION = 0 732CAL_SHOW_SURROUNDING_WEEKS = 0 733CAL_SHOW_WEEK_NUMBERS = 0 734CAL_BORDER_NONE = 0 735CAL_BORDER_SQUARE = 0 736CAL_BORDER_ROUND = 0 737CAL_HITTEST_NOWHERE = 0 738CAL_HITTEST_HEADER = 0 739CAL_HITTEST_DAY = 0 740CAL_HITTEST_INCMONTH = 0 741CAL_HITTEST_DECMONTH = 0 742CAL_HITTEST_SURROUNDING_WEEK = 0 743CAL_HITTEST_WEEK = 0 744wxEVT_CALENDAR_SEL_CHANGED = 0 745wxEVT_CALENDAR_PAGE_CHANGED = 0 746wxEVT_CALENDAR_DOUBLECLICKED = 0 747wxEVT_CALENDAR_WEEKDAY_CLICKED = 0 748wxEVT_CALENDAR_WEEK_CLICKED = 0 749wxEVT_CALENDAR_YEAR_CHANGED = 0 750wxEVT_CALENDAR_MONTH_CHANGED = 0 751wxEVT_CALENDAR_DAY_CHANGED = 0 752 753class CalendarEvent(DateEvent): 754 """ 755 CalendarEvent() 756 CalendarEvent(win, dt, type) 757 758 The wxCalendarEvent class is used together with wxCalendarCtrl. 759 """ 760 761 def __init__(self, *args, **kw): 762 """ 763 CalendarEvent() 764 CalendarEvent(win, dt, type) 765 766 The wxCalendarEvent class is used together with wxCalendarCtrl. 767 """ 768 769 def GetWeekDay(self): 770 """ 771 GetWeekDay() -> DateTime.WeekDay 772 773 Returns the week day on which the user clicked in 774 EVT_CALENDAR_WEEKDAY_CLICKED handler. 775 """ 776 777 def SetWeekDay(self, day): 778 """ 779 SetWeekDay(day) 780 781 Sets the week day carried by the event, normally only used by the 782 library internally. 783 """ 784 WeekDay = property(None, None) 785# end of class CalendarEvent 786 787 788class CalendarDateAttr(object): 789 """ 790 CalendarDateAttr(colText=wx.NullColour, colBack=wx.NullColour, colBorder=wx.NullColour, font=wx.NullFont, border=CAL_BORDER_NONE) 791 CalendarDateAttr(border, colBorder=wx.NullColour) 792 793 wxCalendarDateAttr is a custom attributes for a calendar date. 794 """ 795 796 def __init__(self, *args, **kw): 797 """ 798 CalendarDateAttr(colText=wx.NullColour, colBack=wx.NullColour, colBorder=wx.NullColour, font=wx.NullFont, border=CAL_BORDER_NONE) 799 CalendarDateAttr(border, colBorder=wx.NullColour) 800 801 wxCalendarDateAttr is a custom attributes for a calendar date. 802 """ 803 804 def GetBackgroundColour(self): 805 """ 806 GetBackgroundColour() -> wx.Colour 807 808 Returns the background colour set for the calendar date. 809 """ 810 811 def GetBorder(self): 812 """ 813 GetBorder() -> CalendarDateBorder 814 815 Returns the border set for the calendar date. 816 """ 817 818 def GetBorderColour(self): 819 """ 820 GetBorderColour() -> wx.Colour 821 822 Returns the border colour set for the calendar date. 823 """ 824 825 def GetFont(self): 826 """ 827 GetFont() -> wx.Font 828 829 Returns the font set for the calendar date. 830 """ 831 832 def GetTextColour(self): 833 """ 834 GetTextColour() -> wx.Colour 835 836 Returns the text colour set for the calendar date. 837 """ 838 839 def HasBackgroundColour(self): 840 """ 841 HasBackgroundColour() -> bool 842 843 Returns true if a non-default text background colour is set. 844 """ 845 846 def HasBorder(self): 847 """ 848 HasBorder() -> bool 849 850 Returns true if a non-default (i.e. any) border is set. 851 """ 852 853 def HasBorderColour(self): 854 """ 855 HasBorderColour() -> bool 856 857 Returns true if a non-default border colour is set. 858 """ 859 860 def HasFont(self): 861 """ 862 HasFont() -> bool 863 864 Returns true if a non-default font is set. 865 """ 866 867 def HasTextColour(self): 868 """ 869 HasTextColour() -> bool 870 871 Returns true if a non-default text foreground colour is set. 872 """ 873 874 def IsHoliday(self): 875 """ 876 IsHoliday() -> bool 877 878 Returns true if this calendar day is displayed as a holiday. 879 """ 880 881 def SetBackgroundColour(self, colBack): 882 """ 883 SetBackgroundColour(colBack) 884 885 Sets the text background colour to use. 886 """ 887 888 def SetBorder(self, border): 889 """ 890 SetBorder(border) 891 892 Sets the border to use. 893 """ 894 895 def SetBorderColour(self, col): 896 """ 897 SetBorderColour(col) 898 899 Sets the border colour to use. 900 """ 901 902 def SetFont(self, font): 903 """ 904 SetFont(font) 905 906 Sets the font to use. 907 """ 908 909 def SetHoliday(self, holiday): 910 """ 911 SetHoliday(holiday) 912 913 If holiday is true, this calendar day will be displayed as a holiday. 914 """ 915 916 def SetTextColour(self, colText): 917 """ 918 SetTextColour(colText) 919 920 Sets the text (foreground) colour to use. 921 """ 922 923 @staticmethod 924 def GetMark(): 925 """ 926 GetMark() -> CalendarDateAttr 927 928 Used (internally) by the generic wxCalendarCtrl::Mark(). 929 """ 930 931 @staticmethod 932 def SetMark(m): 933 """ 934 SetMark(m) 935 936 Set the attributes that will be used to Mark() days on the generic 937 wxCalendarCtrl. 938 """ 939 BackgroundColour = property(None, None) 940 Border = property(None, None) 941 BorderColour = property(None, None) 942 Font = property(None, None) 943 TextColour = property(None, None) 944# end of class CalendarDateAttr 945 946CalendarNameStr = "" 947 948class CalendarCtrl(wx.Control): 949 """ 950 CalendarCtrl() 951 CalendarCtrl(parent, id=wx.ID_ANY, date=wx.DefaultDateTime, pos=wx.DefaultPosition, size=wx.DefaultSize, style=CAL_SHOW_HOLIDAYS, name=CalendarNameStr) 952 953 The calendar control allows the user to pick a date. 954 """ 955 956 def __init__(self, *args, **kw): 957 """ 958 CalendarCtrl() 959 CalendarCtrl(parent, id=wx.ID_ANY, date=wx.DefaultDateTime, pos=wx.DefaultPosition, size=wx.DefaultSize, style=CAL_SHOW_HOLIDAYS, name=CalendarNameStr) 960 961 The calendar control allows the user to pick a date. 962 """ 963 964 def SetDateRange(self, lowerdate=wx.DefaultDateTime, upperdate=wx.DefaultDateTime): 965 """ 966 SetDateRange(lowerdate=wx.DefaultDateTime, upperdate=wx.DefaultDateTime) -> bool 967 968 Restrict the dates that can be selected in the control to the 969 specified range. 970 """ 971 972 def GetDateRange(self): 973 """ 974 GetDateRange() -> (bool, lowerdate, upperdate) 975 976 Returns the limits currently being used. 977 """ 978 979 def Create(self, parent, id=wx.ID_ANY, date=wx.DefaultDateTime, pos=wx.DefaultPosition, size=wx.DefaultSize, style=CAL_SHOW_HOLIDAYS, name=CalendarNameStr): 980 """ 981 Create(parent, id=wx.ID_ANY, date=wx.DefaultDateTime, pos=wx.DefaultPosition, size=wx.DefaultSize, style=CAL_SHOW_HOLIDAYS, name=CalendarNameStr) -> bool 982 983 Creates the control. 984 """ 985 986 def EnableHolidayDisplay(self, display=True): 987 """ 988 EnableHolidayDisplay(display=True) 989 990 This function should be used instead of changing wxCAL_SHOW_HOLIDAYS 991 style bit directly. 992 """ 993 994 def EnableMonthChange(self, enable=True): 995 """ 996 EnableMonthChange(enable=True) -> bool 997 998 This function should be used instead of changing wxCAL_NO_MONTH_CHANGE 999 style bit. 1000 """ 1001 1002 def GetAttr(self, day): 1003 """ 1004 GetAttr(day) -> CalendarDateAttr 1005 1006 Returns the attribute for the given date (should be in the range 1007 1...31). 1008 """ 1009 1010 def GetDate(self): 1011 """ 1012 GetDate() -> wx.DateTime 1013 1014 Gets the currently selected date. 1015 """ 1016 1017 def GetHeaderColourBg(self): 1018 """ 1019 GetHeaderColourBg() -> wx.Colour 1020 1021 Gets the background colour of the header part of the calendar window. 1022 """ 1023 1024 def GetHeaderColourFg(self): 1025 """ 1026 GetHeaderColourFg() -> wx.Colour 1027 1028 Gets the foreground colour of the header part of the calendar window. 1029 """ 1030 1031 def GetHighlightColourBg(self): 1032 """ 1033 GetHighlightColourBg() -> wx.Colour 1034 1035 Gets the background highlight colour. 1036 """ 1037 1038 def GetHighlightColourFg(self): 1039 """ 1040 GetHighlightColourFg() -> wx.Colour 1041 1042 Gets the foreground highlight colour. 1043 """ 1044 1045 def GetHolidayColourBg(self): 1046 """ 1047 GetHolidayColourBg() -> wx.Colour 1048 1049 Return the background colour currently used for holiday highlighting. 1050 """ 1051 1052 def GetHolidayColourFg(self): 1053 """ 1054 GetHolidayColourFg() -> wx.Colour 1055 1056 Return the foreground colour currently used for holiday highlighting. 1057 """ 1058 1059 def HitTest(self, pos): 1060 """ 1061 HitTest(pos) -> (CalendarHitTestResult, date, wd) 1062 1063 Returns one of wxCalendarHitTestResult constants and fills either date 1064 or wd pointer with the corresponding value depending on the hit test 1065 code. 1066 """ 1067 1068 def ResetAttr(self, day): 1069 """ 1070 ResetAttr(day) 1071 1072 Clears any attributes associated with the given day (in the range 1073 1...31). 1074 """ 1075 1076 def SetAttr(self, day, attr): 1077 """ 1078 SetAttr(day, attr) 1079 1080 Associates the attribute with the specified date (in the range 1081 1...31). 1082 """ 1083 1084 def SetDate(self, date): 1085 """ 1086 SetDate(date) -> bool 1087 1088 Sets the current date. 1089 """ 1090 1091 def SetHeaderColours(self, colFg, colBg): 1092 """ 1093 SetHeaderColours(colFg, colBg) 1094 1095 Set the colours used for painting the weekdays at the top of the 1096 control. 1097 """ 1098 1099 def SetHighlightColours(self, colFg, colBg): 1100 """ 1101 SetHighlightColours(colFg, colBg) 1102 1103 Set the colours to be used for highlighting the currently selected 1104 date. 1105 """ 1106 1107 def SetHoliday(self, day): 1108 """ 1109 SetHoliday(day) 1110 1111 Marks the specified day as being a holiday in the current month. 1112 """ 1113 1114 def SetHolidayColours(self, colFg, colBg): 1115 """ 1116 SetHolidayColours(colFg, colBg) 1117 1118 Sets the colours to be used for the holidays highlighting. 1119 """ 1120 1121 def Mark(self, day, mark): 1122 """ 1123 Mark(day, mark) 1124 1125 Mark or unmark the day. 1126 """ 1127 1128 @staticmethod 1129 def GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL): 1130 """ 1131 GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) -> wx.VisualAttributes 1132 """ 1133 1134 def PyGetDate(self): 1135 """ 1136 Return the date as a Python datetime.date object. 1137 """ 1138 1139 PySetDate = wx.deprecated(SetDate, 'Use SetDate instead.') 1140 PySetDateRange = wx.deprecated(SetDateRange, 'Use SetDateRange instead.') 1141 Date = property(None, None) 1142 DateRange = property(None, None) 1143 HeaderColourBg = property(None, None) 1144 HeaderColourFg = property(None, None) 1145 HighlightColourBg = property(None, None) 1146 HighlightColourFg = property(None, None) 1147 HolidayColourBg = property(None, None) 1148 HolidayColourFg = property(None, None) 1149# end of class CalendarCtrl 1150 1151 1152class GenericCalendarCtrl(wx.Control): 1153 """ 1154 GenericCalendarCtrl() 1155 GenericCalendarCtrl(parent, id=wx.ID_ANY, date=wx.DefaultDateTime, pos=wx.DefaultPosition, size=wx.DefaultSize, style=CAL_SHOW_HOLIDAYS, name=CalendarNameStr) 1156 1157 The calendar control allows the user to pick a date. 1158 """ 1159 1160 def __init__(self, *args, **kw): 1161 """ 1162 GenericCalendarCtrl() 1163 GenericCalendarCtrl(parent, id=wx.ID_ANY, date=wx.DefaultDateTime, pos=wx.DefaultPosition, size=wx.DefaultSize, style=CAL_SHOW_HOLIDAYS, name=CalendarNameStr) 1164 1165 The calendar control allows the user to pick a date. 1166 """ 1167 1168 def SetDateRange(self, lowerdate=wx.DefaultDateTime, upperdate=wx.DefaultDateTime): 1169 """ 1170 SetDateRange(lowerdate=wx.DefaultDateTime, upperdate=wx.DefaultDateTime) -> bool 1171 1172 Restrict the dates that can be selected in the control to the 1173 specified range. 1174 """ 1175 1176 def GetDateRange(self): 1177 """ 1178 GetDateRange() -> (bool, lowerdate, upperdate) 1179 1180 Returns the limits currently being used. 1181 """ 1182 1183 def Create(self, parent, id=wx.ID_ANY, date=wx.DefaultDateTime, pos=wx.DefaultPosition, size=wx.DefaultSize, style=CAL_SHOW_HOLIDAYS, name=CalendarNameStr): 1184 """ 1185 Create(parent, id=wx.ID_ANY, date=wx.DefaultDateTime, pos=wx.DefaultPosition, size=wx.DefaultSize, style=CAL_SHOW_HOLIDAYS, name=CalendarNameStr) -> bool 1186 1187 Creates the control. 1188 """ 1189 1190 def EnableHolidayDisplay(self, display=True): 1191 """ 1192 EnableHolidayDisplay(display=True) 1193 1194 This function should be used instead of changing wxCAL_SHOW_HOLIDAYS 1195 style bit directly. 1196 """ 1197 1198 def EnableMonthChange(self, enable=True): 1199 """ 1200 EnableMonthChange(enable=True) -> bool 1201 1202 This function should be used instead of changing wxCAL_NO_MONTH_CHANGE 1203 style bit. 1204 """ 1205 1206 def EnableYearChange(self, enable=True): 1207 """ 1208 EnableYearChange(enable=True) 1209 """ 1210 1211 def GetAttr(self, day): 1212 """ 1213 GetAttr(day) -> CalendarDateAttr 1214 1215 Returns the attribute for the given date (should be in the range 1216 1...31). 1217 """ 1218 1219 def GetDate(self): 1220 """ 1221 GetDate() -> wx.DateTime 1222 1223 Gets the currently selected date. 1224 """ 1225 1226 def GetHeaderColourBg(self): 1227 """ 1228 GetHeaderColourBg() -> wx.Colour 1229 1230 Gets the background colour of the header part of the calendar window. 1231 """ 1232 1233 def GetHeaderColourFg(self): 1234 """ 1235 GetHeaderColourFg() -> wx.Colour 1236 1237 Gets the foreground colour of the header part of the calendar window. 1238 """ 1239 1240 def GetHighlightColourBg(self): 1241 """ 1242 GetHighlightColourBg() -> wx.Colour 1243 1244 Gets the background highlight colour. 1245 """ 1246 1247 def GetHighlightColourFg(self): 1248 """ 1249 GetHighlightColourFg() -> wx.Colour 1250 1251 Gets the foreground highlight colour. 1252 """ 1253 1254 def GetHolidayColourBg(self): 1255 """ 1256 GetHolidayColourBg() -> wx.Colour 1257 1258 Return the background colour currently used for holiday highlighting. 1259 """ 1260 1261 def GetHolidayColourFg(self): 1262 """ 1263 GetHolidayColourFg() -> wx.Colour 1264 1265 Return the foreground colour currently used for holiday highlighting. 1266 """ 1267 1268 def HitTest(self, pos): 1269 """ 1270 HitTest(pos) -> (CalendarHitTestResult, date, wd) 1271 1272 Returns one of wxCalendarHitTestResult constants and fills either date 1273 or wd pointer with the corresponding value depending on the hit test 1274 code. 1275 """ 1276 1277 def ResetAttr(self, day): 1278 """ 1279 ResetAttr(day) 1280 1281 Clears any attributes associated with the given day (in the range 1282 1...31). 1283 """ 1284 1285 def SetAttr(self, day, attr): 1286 """ 1287 SetAttr(day, attr) 1288 1289 Associates the attribute with the specified date (in the range 1290 1...31). 1291 """ 1292 1293 def SetDate(self, date): 1294 """ 1295 SetDate(date) -> bool 1296 1297 Sets the current date. 1298 """ 1299 1300 def SetHeaderColours(self, colFg, colBg): 1301 """ 1302 SetHeaderColours(colFg, colBg) 1303 1304 Set the colours used for painting the weekdays at the top of the 1305 control. 1306 """ 1307 1308 def SetHighlightColours(self, colFg, colBg): 1309 """ 1310 SetHighlightColours(colFg, colBg) 1311 1312 Set the colours to be used for highlighting the currently selected 1313 date. 1314 """ 1315 1316 def SetHoliday(self, day): 1317 """ 1318 SetHoliday(day) 1319 1320 Marks the specified day as being a holiday in the current month. 1321 """ 1322 1323 def SetHolidayColours(self, colFg, colBg): 1324 """ 1325 SetHolidayColours(colFg, colBg) 1326 1327 Sets the colours to be used for the holidays highlighting. 1328 """ 1329 1330 def Mark(self, day, mark): 1331 """ 1332 Mark(day, mark) 1333 1334 Mark or unmark the day. 1335 """ 1336 1337 @staticmethod 1338 def GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL): 1339 """ 1340 GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) -> wx.VisualAttributes 1341 """ 1342 1343 def PyGetDate(self): 1344 """ 1345 Return the date as a Python datetime.date object. 1346 """ 1347 1348 PySetDate = wx.deprecated(SetDate, 'Use SetDate instead.') 1349 PySetDateRange = wx.deprecated(SetDateRange, 'Use SetDateRange instead.') 1350 Date = property(None, None) 1351 DateRange = property(None, None) 1352 HeaderColourBg = property(None, None) 1353 HeaderColourFg = property(None, None) 1354 HighlightColourBg = property(None, None) 1355 HighlightColourFg = property(None, None) 1356 HolidayColourBg = property(None, None) 1357 HolidayColourFg = property(None, None) 1358# end of class GenericCalendarCtrl 1359 1360 1361EVT_CALENDAR = wx.PyEventBinder( wxEVT_CALENDAR_DOUBLECLICKED, 1) 1362EVT_CALENDAR_SEL_CHANGED = wx.PyEventBinder( wxEVT_CALENDAR_SEL_CHANGED, 1) 1363EVT_CALENDAR_WEEKDAY_CLICKED = wx.PyEventBinder( wxEVT_CALENDAR_WEEKDAY_CLICKED, 1) 1364EVT_CALENDAR_PAGE_CHANGED = wx.PyEventBinder( wxEVT_CALENDAR_PAGE_CHANGED, 1) 1365EVT_CALENDAR_WEEK_CLICKED = wx.PyEventBinder( wxEVT_CALENDAR_WEEK_CLICKED, 1) 1366 1367# These are deprecated, will be removed later... 1368EVT_CALENDAR_DAY = wx.PyEventBinder( wxEVT_CALENDAR_DAY_CHANGED, 1) 1369EVT_CALENDAR_MONTH = wx.PyEventBinder( wxEVT_CALENDAR_MONTH_CHANGED, 1) 1370EVT_CALENDAR_YEAR = wx.PyEventBinder( wxEVT_CALENDAR_YEAR_CHANGED, 1) 1371#-- end-calctrl --# 1372#-- begin-hyperlink --# 1373HL_CONTEXTMENU = 0 1374HL_ALIGN_LEFT = 0 1375HL_ALIGN_RIGHT = 0 1376HL_ALIGN_CENTRE = 0 1377HL_DEFAULT_STYLE = 0 1378wxEVT_HYPERLINK = 0 1379 1380class HyperlinkEvent(wx.CommandEvent): 1381 """ 1382 HyperlinkEvent(generator, id, url) 1383 1384 This event class is used for the events generated by wxHyperlinkCtrl. 1385 """ 1386 1387 def __init__(self, generator, id, url): 1388 """ 1389 HyperlinkEvent(generator, id, url) 1390 1391 This event class is used for the events generated by wxHyperlinkCtrl. 1392 """ 1393 1394 def GetURL(self): 1395 """ 1396 GetURL() -> String 1397 1398 Returns the URL of the hyperlink where the user has just clicked. 1399 """ 1400 1401 def SetURL(self, url): 1402 """ 1403 SetURL(url) 1404 1405 Sets the URL associated with the event. 1406 """ 1407 URL = property(None, None) 1408# end of class HyperlinkEvent 1409 1410HyperlinkCtrlNameStr = "" 1411 1412class HyperlinkCtrl(wx.Control): 1413 """ 1414 HyperlinkCtrl() 1415 HyperlinkCtrl(parent, id=wx.ID_ANY, label=wx.EmptyString, url=wx.EmptyString, pos=wx.DefaultPosition, size=wx.DefaultSize, style=HL_DEFAULT_STYLE, name=HyperlinkCtrlNameStr) 1416 1417 This class shows a static text element which links to an URL. 1418 """ 1419 1420 def __init__(self, *args, **kw): 1421 """ 1422 HyperlinkCtrl() 1423 HyperlinkCtrl(parent, id=wx.ID_ANY, label=wx.EmptyString, url=wx.EmptyString, pos=wx.DefaultPosition, size=wx.DefaultSize, style=HL_DEFAULT_STYLE, name=HyperlinkCtrlNameStr) 1424 1425 This class shows a static text element which links to an URL. 1426 """ 1427 1428 def Create(self, parent, id=wx.ID_ANY, label=wx.EmptyString, url=wx.EmptyString, pos=wx.DefaultPosition, size=wx.DefaultSize, style=HL_DEFAULT_STYLE, name=HyperlinkCtrlNameStr): 1429 """ 1430 Create(parent, id=wx.ID_ANY, label=wx.EmptyString, url=wx.EmptyString, pos=wx.DefaultPosition, size=wx.DefaultSize, style=HL_DEFAULT_STYLE, name=HyperlinkCtrlNameStr) -> bool 1431 1432 Creates the hyperlink control. 1433 """ 1434 1435 def GetHoverColour(self): 1436 """ 1437 GetHoverColour() -> wx.Colour 1438 1439 Returns the colour used to print the label of the hyperlink when the 1440 mouse is over the control. 1441 """ 1442 1443 def GetNormalColour(self): 1444 """ 1445 GetNormalColour() -> wx.Colour 1446 1447 Returns the colour used to print the label when the link has never 1448 been clicked before (i.e. the link has not been visited) and the mouse 1449 is not over the control. 1450 """ 1451 1452 def GetURL(self): 1453 """ 1454 GetURL() -> String 1455 1456 Returns the URL associated with the hyperlink. 1457 """ 1458 1459 def GetVisited(self): 1460 """ 1461 GetVisited() -> bool 1462 1463 Returns true if the hyperlink has already been clicked by the user at 1464 least one time. 1465 """ 1466 1467 def GetVisitedColour(self): 1468 """ 1469 GetVisitedColour() -> wx.Colour 1470 1471 Returns the colour used to print the label when the mouse is not over 1472 the control and the link has already been clicked before (i.e. the 1473 link has been visited). 1474 """ 1475 1476 def SetHoverColour(self, colour): 1477 """ 1478 SetHoverColour(colour) 1479 1480 Sets the colour used to print the label of the hyperlink when the 1481 mouse is over the control. 1482 """ 1483 1484 def SetNormalColour(self, colour): 1485 """ 1486 SetNormalColour(colour) 1487 1488 Sets the colour used to print the label when the link has never been 1489 clicked before (i.e. the link has not been visited) and the mouse is 1490 not over the control. 1491 """ 1492 1493 def SetURL(self, url): 1494 """ 1495 SetURL(url) 1496 1497 Sets the URL associated with the hyperlink. 1498 """ 1499 1500 def SetVisited(self, visited=True): 1501 """ 1502 SetVisited(visited=True) 1503 1504 Marks the hyperlink as visited (see 1505 wxHyperlinkCtrl::SetVisitedColour). 1506 """ 1507 1508 def SetVisitedColour(self, colour): 1509 """ 1510 SetVisitedColour(colour) 1511 1512 Sets the colour used to print the label when the mouse is not over the 1513 control and the link has already been clicked before (i.e. the link 1514 has been visited). 1515 """ 1516 1517 @staticmethod 1518 def GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL): 1519 """ 1520 GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) -> wx.VisualAttributes 1521 """ 1522 HoverColour = property(None, None) 1523 NormalColour = property(None, None) 1524 URL = property(None, None) 1525 Visited = property(None, None) 1526 VisitedColour = property(None, None) 1527# end of class HyperlinkCtrl 1528 1529 1530EVT_HYPERLINK = wx.PyEventBinder( wxEVT_HYPERLINK, 1 ) 1531 1532# deprecated wxEVT alias 1533wxEVT_COMMAND_HYPERLINK = wxEVT_HYPERLINK 1534#-- end-hyperlink --# 1535#-- begin-tipdlg --# 1536 1537class TipProvider(object): 1538 """ 1539 TipProvider(currentTip) 1540 1541 This is the class used together with wxShowTip() function. 1542 """ 1543 1544 def __init__(self, currentTip): 1545 """ 1546 TipProvider(currentTip) 1547 1548 This is the class used together with wxShowTip() function. 1549 """ 1550 1551 def GetCurrentTip(self): 1552 """ 1553 GetCurrentTip() -> size_t 1554 1555 Returns the index of the current tip (i.e. the one which would be 1556 returned by GetTip()). 1557 """ 1558 1559 def GetTip(self): 1560 """ 1561 GetTip() -> String 1562 1563 Return the text of the current tip and pass to the next one. 1564 """ 1565 1566 def PreprocessTip(self, tip): 1567 """ 1568 PreprocessTip(tip) -> String 1569 1570 Returns a modified tip. 1571 """ 1572 CurrentTip = property(None, None) 1573 Tip = property(None, None) 1574# end of class TipProvider 1575 1576 1577def CreateFileTipProvider(filename, currentTip): 1578 """ 1579 CreateFileTipProvider(filename, currentTip) -> TipProvider 1580 1581 This function creates a wxTipProvider which may be used with 1582 wxShowTip(). 1583 """ 1584 1585def ShowTip(parent, tipProvider, showAtStartup=True): 1586 """ 1587 ShowTip(parent, tipProvider, showAtStartup=True) -> bool 1588 1589 This function shows a "startup tip" to the user. 1590 """ 1591#-- end-tipdlg --# 1592#-- begin-taskbar --# 1593TBI_DOCK = 0 1594TBI_CUSTOM_STATUSITEM = 0 1595TBI_DEFAULT_TYPE = 0 1596wxEVT_TASKBAR_MOVE = 0 1597wxEVT_TASKBAR_LEFT_DOWN = 0 1598wxEVT_TASKBAR_LEFT_UP = 0 1599wxEVT_TASKBAR_RIGHT_DOWN = 0 1600wxEVT_TASKBAR_RIGHT_UP = 0 1601wxEVT_TASKBAR_LEFT_DCLICK = 0 1602wxEVT_TASKBAR_RIGHT_DCLICK = 0 1603wxEVT_TASKBAR_CLICK = 0 1604wxEVT_TASKBAR_BALLOON_TIMEOUT = 0 1605wxEVT_TASKBAR_BALLOON_CLICK = 0 1606 1607class TaskBarIconEvent(wx.Event): 1608 """ 1609 TaskBarIconEvent(evtType, tbIcon) 1610 1611 The event class used by wxTaskBarIcon. 1612 """ 1613 1614 def __init__(self, evtType, tbIcon): 1615 """ 1616 TaskBarIconEvent(evtType, tbIcon) 1617 1618 The event class used by wxTaskBarIcon. 1619 """ 1620# end of class TaskBarIconEvent 1621 1622 1623class TaskBarIcon(wx.EvtHandler): 1624 """ 1625 TaskBarIcon(iconType=TBI_DEFAULT_TYPE) 1626 1627 This class represents a taskbar icon. 1628 """ 1629 1630 def __init__(self, iconType=TBI_DEFAULT_TYPE): 1631 """ 1632 TaskBarIcon(iconType=TBI_DEFAULT_TYPE) 1633 1634 This class represents a taskbar icon. 1635 """ 1636 1637 def Destroy(self): 1638 """ 1639 Destroy() 1640 1641 This method is similar to wxWindow::Destroy and can be used to 1642 schedule the task bar icon object for the delayed destruction: it will 1643 be deleted during the next event loop iteration, which allows the task 1644 bar icon to process any pending events for it before being destroyed. 1645 """ 1646 1647 def IsIconInstalled(self): 1648 """ 1649 IsIconInstalled() -> bool 1650 1651 Returns true if SetIcon() was called with no subsequent RemoveIcon(). 1652 """ 1653 1654 def IsOk(self): 1655 """ 1656 IsOk() -> bool 1657 1658 Returns true if the object initialized successfully. 1659 """ 1660 1661 def PopupMenu(self, menu): 1662 """ 1663 PopupMenu(menu) -> bool 1664 1665 Pops up a menu at the current mouse position. 1666 """ 1667 1668 def RemoveIcon(self): 1669 """ 1670 RemoveIcon() -> bool 1671 1672 Removes the icon previously set with SetIcon(). 1673 """ 1674 1675 def SetIcon(self, icon, tooltip=wx.EmptyString): 1676 """ 1677 SetIcon(icon, tooltip=wx.EmptyString) -> bool 1678 1679 Sets the icon, and optional tooltip text. 1680 """ 1681 1682 @staticmethod 1683 def IsAvailable(): 1684 """ 1685 IsAvailable() -> bool 1686 1687 Returns true if system tray is available in the desktop environment 1688 the app runs under. 1689 """ 1690 1691 def ShowBalloon(self, title, text, msec=0, flags=0): 1692 """ 1693 ShowBalloon(title, text, msec=0, flags=0) -> bool 1694 1695 Show a balloon notification (the icon must have been already 1696 initialized using SetIcon). Only implemented for Windows. 1697 1698 The ``title`` and ``text`` parameters are limited to 63 and 255 1699 characters respectively, ``msec`` is the timeout, in milliseconds, 1700 before the balloon disappears (will be clamped down to the allowed 1701 10-30s range by Windows if it's outside it) and ``flags`` can 1702 include wxICON_ERROR/INFO/WARNING to show a corresponding icon. 1703 1704 Returns ``True`` if balloon was shown, ``False`` on error (incorrect 1705 parameters or function unsupported by OS). 1706 """ 1707 1708 def CreatePopupMenu(self): 1709 """ 1710 CreatePopupMenu() -> wx.Menu 1711 1712 This method is called by the library when the user requests popup menu 1713 (on Windows and Unix platforms, this is when the user right-clicks the 1714 icon). 1715 """ 1716# end of class TaskBarIcon 1717 1718 1719EVT_TASKBAR_MOVE = wx.PyEventBinder ( wxEVT_TASKBAR_MOVE ) 1720EVT_TASKBAR_LEFT_DOWN = wx.PyEventBinder ( wxEVT_TASKBAR_LEFT_DOWN ) 1721EVT_TASKBAR_LEFT_UP = wx.PyEventBinder ( wxEVT_TASKBAR_LEFT_UP ) 1722EVT_TASKBAR_RIGHT_DOWN = wx.PyEventBinder ( wxEVT_TASKBAR_RIGHT_DOWN ) 1723EVT_TASKBAR_RIGHT_UP = wx.PyEventBinder ( wxEVT_TASKBAR_RIGHT_UP ) 1724EVT_TASKBAR_LEFT_DCLICK = wx.PyEventBinder ( wxEVT_TASKBAR_LEFT_DCLICK ) 1725EVT_TASKBAR_RIGHT_DCLICK = wx.PyEventBinder ( wxEVT_TASKBAR_RIGHT_DCLICK ) 1726EVT_TASKBAR_CLICK = wx.PyEventBinder ( wxEVT_TASKBAR_CLICK ) 1727EVT_TASKBAR_BALLOON_TIMEOUT = wx.PyEventBinder ( wxEVT_TASKBAR_BALLOON_TIMEOUT ) 1728EVT_TASKBAR_BALLOON_CLICK = wx.PyEventBinder ( wxEVT_TASKBAR_BALLOON_CLICK ) 1729#-- end-taskbar --# 1730#-- begin-sound --# 1731SOUND_SYNC = 0 1732SOUND_ASYNC = 0 1733SOUND_LOOP = 0 1734 1735class Sound(wx.Object): 1736 """ 1737 Sound() 1738 Sound(fileName) 1739 1740 This class represents a short sound (loaded from Windows WAV file), 1741 that can be stored in memory and played. 1742 """ 1743 1744 def __init__(self, *args, **kw): 1745 """ 1746 Sound() 1747 Sound(fileName) 1748 1749 This class represents a short sound (loaded from Windows WAV file), 1750 that can be stored in memory and played. 1751 """ 1752 1753 def Play(self, flags=SOUND_ASYNC): 1754 """ 1755 Play(flags=SOUND_ASYNC) -> bool 1756 1757 Plays the sound file. 1758 """ 1759 1760 @staticmethod 1761 def PlaySound(filename, flags=SOUND_ASYNC): 1762 """ 1763 PlaySound(filename, flags=SOUND_ASYNC) -> bool 1764 1765 Plays the sound file. 1766 """ 1767 1768 def Create(self, fileName): 1769 """ 1770 Create(fileName) -> bool 1771 1772 Constructs a wave object from a file or resource. 1773 """ 1774 1775 def IsOk(self): 1776 """ 1777 IsOk() -> bool 1778 1779 Returns true if the object contains a successfully loaded file or 1780 resource, false otherwise. 1781 """ 1782 1783 @staticmethod 1784 def Stop(): 1785 """ 1786 Stop() 1787 1788 If a sound is played, this function stops it. 1789 """ 1790 1791 def CreateFromData(self, data): 1792 """ 1793 CreateFromData(data) -> bool 1794 1795 Create a sound object from data in a memory buffer in WAV format. 1796 """ 1797 1798 def __nonzero__(self): 1799 """ 1800 __nonzero__() -> int 1801 """ 1802 1803 def __bool__(self): 1804 """ 1805 __bool__() -> int 1806 """ 1807# end of class Sound 1808 1809#-- end-sound --# 1810#-- begin-joystick --# 1811 1812class Joystick(wx.Object): 1813 """ 1814 Joystick(joystick=wx.JOYSTICK1) 1815 1816 wxJoystick allows an application to control one or more joysticks. 1817 """ 1818 1819 def __init__(self, joystick=wx.JOYSTICK1): 1820 """ 1821 Joystick(joystick=wx.JOYSTICK1) 1822 1823 wxJoystick allows an application to control one or more joysticks. 1824 """ 1825 1826 def GetButtonState(self, *args, **kw): 1827 """ 1828 GetButtonState() -> int 1829 GetButtonState(id) -> bool 1830 1831 Returns the state of the joystick buttons. 1832 """ 1833 1834 def GetManufacturerId(self): 1835 """ 1836 GetManufacturerId() -> int 1837 1838 Returns the manufacturer id. 1839 """ 1840 1841 def GetMovementThreshold(self): 1842 """ 1843 GetMovementThreshold() -> int 1844 1845 Returns the movement threshold, the number of steps outside which the 1846 joystick is deemed to have moved. 1847 """ 1848 1849 def GetNumberAxes(self): 1850 """ 1851 GetNumberAxes() -> int 1852 1853 Returns the number of axes for this joystick. 1854 """ 1855 1856 def GetNumberButtons(self): 1857 """ 1858 GetNumberButtons() -> int 1859 1860 Returns the number of buttons for this joystick. 1861 """ 1862 1863 def GetPOVCTSPosition(self): 1864 """ 1865 GetPOVCTSPosition() -> int 1866 1867 Returns the point-of-view position, expressed in continuous, one- 1868 hundredth of a degree units. 1869 """ 1870 1871 def GetPOVPosition(self): 1872 """ 1873 GetPOVPosition() -> int 1874 1875 Returns the point-of-view position, expressed in continuous, one- 1876 hundredth of a degree units, but limited to return 0, 9000, 18000 or 1877 27000. 1878 """ 1879 1880 def GetPollingMax(self): 1881 """ 1882 GetPollingMax() -> int 1883 1884 Returns the maximum polling frequency. 1885 """ 1886 1887 def GetPollingMin(self): 1888 """ 1889 GetPollingMin() -> int 1890 1891 Returns the minimum polling frequency. 1892 """ 1893 1894 def GetPosition(self, *args, **kw): 1895 """ 1896 GetPosition() -> wx.Point 1897 GetPosition(axis) -> int 1898 1899 Returns the x, y position of the joystick. 1900 """ 1901 1902 def GetProductId(self): 1903 """ 1904 GetProductId() -> int 1905 1906 Returns the product id for the joystick. 1907 """ 1908 1909 def GetProductName(self): 1910 """ 1911 GetProductName() -> String 1912 1913 Returns the product name for the joystick. 1914 """ 1915 1916 def GetRudderMax(self): 1917 """ 1918 GetRudderMax() -> int 1919 1920 Returns the maximum rudder position. 1921 """ 1922 1923 def GetRudderMin(self): 1924 """ 1925 GetRudderMin() -> int 1926 1927 Returns the minimum rudder position. 1928 """ 1929 1930 def GetRudderPosition(self): 1931 """ 1932 GetRudderPosition() -> int 1933 1934 Returns the rudder position. 1935 """ 1936 1937 def GetUMax(self): 1938 """ 1939 GetUMax() -> int 1940 1941 Returns the maximum U position. 1942 """ 1943 1944 def GetUMin(self): 1945 """ 1946 GetUMin() -> int 1947 1948 Returns the minimum U position. 1949 """ 1950 1951 def GetUPosition(self): 1952 """ 1953 GetUPosition() -> int 1954 1955 Gets the position of the fifth axis of the joystick, if it exists. 1956 """ 1957 1958 def GetVMax(self): 1959 """ 1960 GetVMax() -> int 1961 1962 Returns the maximum V position. 1963 """ 1964 1965 def GetVMin(self): 1966 """ 1967 GetVMin() -> int 1968 1969 Returns the minimum V position. 1970 """ 1971 1972 def GetVPosition(self): 1973 """ 1974 GetVPosition() -> int 1975 1976 Gets the position of the sixth axis of the joystick, if it exists. 1977 """ 1978 1979 def GetXMax(self): 1980 """ 1981 GetXMax() -> int 1982 1983 Returns the maximum x position. 1984 """ 1985 1986 def GetXMin(self): 1987 """ 1988 GetXMin() -> int 1989 1990 Returns the minimum x position. 1991 """ 1992 1993 def GetYMax(self): 1994 """ 1995 GetYMax() -> int 1996 1997 Returns the maximum y position. 1998 """ 1999 2000 def GetYMin(self): 2001 """ 2002 GetYMin() -> int 2003 2004 Returns the minimum y position. 2005 """ 2006 2007 def GetZMax(self): 2008 """ 2009 GetZMax() -> int 2010 2011 Returns the maximum z position. 2012 """ 2013 2014 def GetZMin(self): 2015 """ 2016 GetZMin() -> int 2017 2018 Returns the minimum z position. 2019 """ 2020 2021 def GetZPosition(self): 2022 """ 2023 GetZPosition() -> int 2024 2025 Returns the z position of the joystick. 2026 """ 2027 2028 def HasPOV(self): 2029 """ 2030 HasPOV() -> bool 2031 2032 Returns true if the joystick has a point of view control. 2033 """ 2034 2035 def HasPOV4Dir(self): 2036 """ 2037 HasPOV4Dir() -> bool 2038 2039 Returns true if the joystick point-of-view supports discrete values 2040 (centered, forward, backward, left, and right). 2041 """ 2042 2043 def HasPOVCTS(self): 2044 """ 2045 HasPOVCTS() -> bool 2046 2047 Returns true if the joystick point-of-view supports continuous degree 2048 bearings. 2049 """ 2050 2051 def HasRudder(self): 2052 """ 2053 HasRudder() -> bool 2054 2055 Returns true if there is a rudder attached to the computer. 2056 """ 2057 2058 def HasU(self): 2059 """ 2060 HasU() -> bool 2061 2062 Returns true if the joystick has a U axis. 2063 """ 2064 2065 def HasV(self): 2066 """ 2067 HasV() -> bool 2068 2069 Returns true if the joystick has a V axis. 2070 """ 2071 2072 def HasZ(self): 2073 """ 2074 HasZ() -> bool 2075 2076 Returns true if the joystick has a Z axis. 2077 """ 2078 2079 def IsOk(self): 2080 """ 2081 IsOk() -> bool 2082 2083 Returns true if the joystick is functioning. 2084 """ 2085 2086 def ReleaseCapture(self): 2087 """ 2088 ReleaseCapture() -> bool 2089 2090 Releases the capture set by SetCapture. 2091 """ 2092 2093 def SetCapture(self, win, pollingFreq=0): 2094 """ 2095 SetCapture(win, pollingFreq=0) -> bool 2096 2097 Sets the capture to direct joystick events to win. 2098 """ 2099 2100 def SetMovementThreshold(self, threshold): 2101 """ 2102 SetMovementThreshold(threshold) 2103 2104 Sets the movement threshold, the number of steps outside which the 2105 joystick is deemed to have moved. 2106 """ 2107 2108 @staticmethod 2109 def GetNumberJoysticks(): 2110 """ 2111 GetNumberJoysticks() -> int 2112 2113 Returns the number of joysticks currently attached to the computer. 2114 """ 2115 2116 def GetMaxButtons(self): 2117 """ 2118 GetMaxButtons() -> int 2119 """ 2120 2121 def GetMaxAxes(self): 2122 """ 2123 GetMaxAxes() -> int 2124 """ 2125 ButtonState = property(None, None) 2126 ManufacturerId = property(None, None) 2127 MaxAxes = property(None, None) 2128 MaxButtons = property(None, None) 2129 MovementThreshold = property(None, None) 2130 NumberAxes = property(None, None) 2131 NumberButtons = property(None, None) 2132 POVCTSPosition = property(None, None) 2133 POVPosition = property(None, None) 2134 PollingMax = property(None, None) 2135 PollingMin = property(None, None) 2136 Position = property(None, None) 2137 ProductId = property(None, None) 2138 ProductName = property(None, None) 2139 RudderMax = property(None, None) 2140 RudderMin = property(None, None) 2141 RudderPosition = property(None, None) 2142 UMax = property(None, None) 2143 UMin = property(None, None) 2144 UPosition = property(None, None) 2145 VMax = property(None, None) 2146 VMin = property(None, None) 2147 VPosition = property(None, None) 2148 XMax = property(None, None) 2149 XMin = property(None, None) 2150 YMax = property(None, None) 2151 YMin = property(None, None) 2152 ZMax = property(None, None) 2153 ZMin = property(None, None) 2154 ZPosition = property(None, None) 2155# end of class Joystick 2156 2157USE_JOYSTICK = 0 2158#-- end-joystick --# 2159#-- begin-animate --# 2160AC_NO_AUTORESIZE = 0 2161AC_DEFAULT_STYLE = 0 2162ANIMATION_TYPE_INVALID = 0 2163ANIMATION_TYPE_GIF = 0 2164ANIMATION_TYPE_ANI = 0 2165ANIMATION_TYPE_ANY = 0 2166 2167class Animation(wx.Object): 2168 """ 2169 Animation() 2170 Animation(anim) 2171 Animation(name, type=ANIMATION_TYPE_ANY) 2172 2173 This class encapsulates the concept of a platform-dependent animation. 2174 """ 2175 2176 def __init__(self, *args, **kw): 2177 """ 2178 Animation() 2179 Animation(anim) 2180 Animation(name, type=ANIMATION_TYPE_ANY) 2181 2182 This class encapsulates the concept of a platform-dependent animation. 2183 """ 2184 2185 def GetDelay(self, i): 2186 """ 2187 GetDelay(i) -> int 2188 2189 Returns the delay for the i-th frame in milliseconds. 2190 """ 2191 2192 def GetFrame(self, i): 2193 """ 2194 GetFrame(i) -> wx.Image 2195 2196 Returns the i-th frame as a wxImage. 2197 """ 2198 2199 def GetFrameCount(self): 2200 """ 2201 GetFrameCount() -> unsignedint 2202 2203 Returns the number of frames for this animation. 2204 """ 2205 2206 def GetSize(self): 2207 """ 2208 GetSize() -> wx.Size 2209 2210 Returns the size of the animation. 2211 """ 2212 2213 def IsOk(self): 2214 """ 2215 IsOk() -> bool 2216 2217 Returns true if animation data is present. 2218 """ 2219 2220 def Load(self, stream, type=ANIMATION_TYPE_ANY): 2221 """ 2222 Load(stream, type=ANIMATION_TYPE_ANY) -> bool 2223 2224 Loads an animation from the given stream. 2225 """ 2226 2227 def LoadFile(self, name, type=ANIMATION_TYPE_ANY): 2228 """ 2229 LoadFile(name, type=ANIMATION_TYPE_ANY) -> bool 2230 2231 Loads an animation from a file. 2232 """ 2233 FrameCount = property(None, None) 2234 Size = property(None, None) 2235# end of class Animation 2236 2237AnimationCtrlNameStr = "" 2238NullAnimation = Animation() 2239 2240class AnimationCtrl(wx.Control): 2241 """ 2242 AnimationCtrl(parent, id=wx.ID_ANY, anim=NullAnimation, pos=wx.DefaultPosition, size=wx.DefaultSize, style=AC_DEFAULT_STYLE, name=AnimationCtrlNameStr) 2243 2244 This is a static control which displays an animation. 2245 """ 2246 2247 def __init__(self, parent, id=wx.ID_ANY, anim=NullAnimation, pos=wx.DefaultPosition, size=wx.DefaultSize, style=AC_DEFAULT_STYLE, name=AnimationCtrlNameStr): 2248 """ 2249 AnimationCtrl(parent, id=wx.ID_ANY, anim=NullAnimation, pos=wx.DefaultPosition, size=wx.DefaultSize, style=AC_DEFAULT_STYLE, name=AnimationCtrlNameStr) 2250 2251 This is a static control which displays an animation. 2252 """ 2253 2254 def Create(self, parent, id=wx.ID_ANY, anim=NullAnimation, pos=wx.DefaultPosition, size=wx.DefaultSize, style=AC_DEFAULT_STYLE, name=AnimationCtrlNameStr): 2255 """ 2256 Create(parent, id=wx.ID_ANY, anim=NullAnimation, pos=wx.DefaultPosition, size=wx.DefaultSize, style=AC_DEFAULT_STYLE, name=AnimationCtrlNameStr) -> bool 2257 2258 Creates the control with the given anim animation. 2259 """ 2260 2261 def GetAnimation(self): 2262 """ 2263 GetAnimation() -> Animation 2264 2265 Returns the animation associated with this control. 2266 """ 2267 2268 def GetInactiveBitmap(self): 2269 """ 2270 GetInactiveBitmap() -> wx.Bitmap 2271 2272 Returns the inactive bitmap shown in this control when the; see 2273 SetInactiveBitmap() for more info. 2274 """ 2275 2276 def IsPlaying(self): 2277 """ 2278 IsPlaying() -> bool 2279 2280 Returns true if the animation is being played. 2281 """ 2282 2283 def LoadFile(self, file, animType=ANIMATION_TYPE_ANY): 2284 """ 2285 LoadFile(file, animType=ANIMATION_TYPE_ANY) -> bool 2286 2287 Loads the animation from the given file and calls SetAnimation(). 2288 """ 2289 2290 def Load(self, file, animType=ANIMATION_TYPE_ANY): 2291 """ 2292 Load(file, animType=ANIMATION_TYPE_ANY) -> bool 2293 2294 Loads the animation from the given stream and calls SetAnimation(). 2295 """ 2296 2297 def Play(self): 2298 """ 2299 Play() -> bool 2300 2301 Starts playing the animation. 2302 """ 2303 2304 def SetAnimation(self, anim): 2305 """ 2306 SetAnimation(anim) 2307 2308 Sets the animation to play in this control. 2309 """ 2310 2311 def SetInactiveBitmap(self, bmp): 2312 """ 2313 SetInactiveBitmap(bmp) 2314 2315 Sets the bitmap to show on the control when it's not playing an 2316 animation. 2317 """ 2318 2319 def Stop(self): 2320 """ 2321 Stop() 2322 2323 Stops playing the animation. 2324 """ 2325 2326 @staticmethod 2327 def GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL): 2328 """ 2329 GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) -> wx.VisualAttributes 2330 """ 2331 Animation = property(None, None) 2332 InactiveBitmap = property(None, None) 2333# end of class AnimationCtrl 2334 2335#-- end-animate --# 2336#-- begin-bannerwindow --# 2337BannerWindowNameStr = "" 2338 2339class BannerWindow(wx.Window): 2340 """ 2341 BannerWindow() 2342 BannerWindow(parent, winid=wx.ID_ANY, dir=wx.LEFT, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0, name=BannerWindowNameStr) 2343 2344 A simple banner window showing either a bitmap or text. 2345 """ 2346 2347 def __init__(self, *args, **kw): 2348 """ 2349 BannerWindow() 2350 BannerWindow(parent, winid=wx.ID_ANY, dir=wx.LEFT, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0, name=BannerWindowNameStr) 2351 2352 A simple banner window showing either a bitmap or text. 2353 """ 2354 2355 def Create(self, parent, winid=wx.ID_ANY, dir=wx.LEFT, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0, name=BannerWindowNameStr): 2356 """ 2357 Create(parent, winid=wx.ID_ANY, dir=wx.LEFT, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0, name=BannerWindowNameStr) -> bool 2358 2359 Really create the banner window for the objects created using the 2360 default constructor. 2361 """ 2362 2363 def SetBitmap(self, bmp): 2364 """ 2365 SetBitmap(bmp) 2366 2367 Provide the bitmap to use as background. 2368 """ 2369 2370 def SetText(self, title, message): 2371 """ 2372 SetText(title, message) 2373 2374 Set the text to display. 2375 """ 2376 2377 def SetGradient(self, start, end): 2378 """ 2379 SetGradient(start, end) 2380 2381 Set the colours between which the gradient runs. 2382 """ 2383 2384 @staticmethod 2385 def GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL): 2386 """ 2387 GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) -> wx.VisualAttributes 2388 """ 2389# end of class BannerWindow 2390 2391#-- end-bannerwindow --# 2392#-- begin-editlbox --# 2393EL_ALLOW_NEW = 0 2394EL_ALLOW_EDIT = 0 2395EL_ALLOW_DELETE = 0 2396EL_NO_REORDER = 0 2397EL_DEFAULT_STYLE = 0 2398EditableListBoxNameStr = "" 2399 2400class EditableListBox(wx.Panel): 2401 """ 2402 EditableListBox() 2403 EditableListBox(parent, id=wx.ID_ANY, label=wx.EmptyString, pos=wx.DefaultPosition, size=wx.DefaultSize, style=EL_DEFAULT_STYLE, name=EditableListBoxNameStr) 2404 2405 An editable listbox is composite control that lets the user easily 2406 enter, delete and reorder a list of strings. 2407 """ 2408 2409 def __init__(self, *args, **kw): 2410 """ 2411 EditableListBox() 2412 EditableListBox(parent, id=wx.ID_ANY, label=wx.EmptyString, pos=wx.DefaultPosition, size=wx.DefaultSize, style=EL_DEFAULT_STYLE, name=EditableListBoxNameStr) 2413 2414 An editable listbox is composite control that lets the user easily 2415 enter, delete and reorder a list of strings. 2416 """ 2417 2418 def Create(self, parent, id=wx.ID_ANY, label=wx.EmptyString, pos=wx.DefaultPosition, size=wx.DefaultSize, style=EL_DEFAULT_STYLE, name=EditableListBoxNameStr): 2419 """ 2420 Create(parent, id=wx.ID_ANY, label=wx.EmptyString, pos=wx.DefaultPosition, size=wx.DefaultSize, style=EL_DEFAULT_STYLE, name=EditableListBoxNameStr) -> bool 2421 2422 Creates the editable listbox for two-step construction. 2423 """ 2424 2425 def SetStrings(self, strings): 2426 """ 2427 SetStrings(strings) 2428 2429 Replaces current contents with given strings. 2430 """ 2431 2432 def GetStrings(self): 2433 """ 2434 GetStrings() -> ArrayString 2435 2436 Returns a list of the current contents of the control. 2437 """ 2438 2439 @staticmethod 2440 def GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL): 2441 """ 2442 GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) -> wx.VisualAttributes 2443 """ 2444 2445 def GetListCtrl(self): 2446 """ 2447 GetListCtrl() -> wx.ListCtrl 2448 2449 Returns a reference to the listctrl used in the EditableListBox. 2450 """ 2451 2452 def GetDelButton(self): 2453 """ 2454 GetDelButton() -> wx.BitmapButton 2455 2456 Returns a reference to the delete button used in the EditableListBox. 2457 """ 2458 2459 def GetNewButton(self): 2460 """ 2461 GetNewButton() -> wx.BitmapButton 2462 2463 Returns a reference to the new button used in the EditableListBox. 2464 """ 2465 2466 def GetUpButton(self): 2467 """ 2468 GetUpButton() -> wx.BitmapButton 2469 2470 Returns a reference to the up button used in the EditableListBox. 2471 """ 2472 2473 def GetDownButton(self): 2474 """ 2475 GetDownButton() -> wx.BitmapButton 2476 2477 Returns a reference to the down button used in the EditableListBox. 2478 """ 2479 2480 def GetEditButton(self): 2481 """ 2482 GetEditButton() -> wx.BitmapButton 2483 2484 Returns a reference to the edit button used in the EditableListBox. 2485 """ 2486 DelButton = property(None, None) 2487 DownButton = property(None, None) 2488 EditButton = property(None, None) 2489 ListCtrl = property(None, None) 2490 NewButton = property(None, None) 2491 Strings = property(None, None) 2492 UpButton = property(None, None) 2493# end of class EditableListBox 2494 2495#-- end-editlbox --# 2496#-- begin-notifmsg --# 2497 2498class NotificationMessage(wx.EvtHandler): 2499 """ 2500 NotificationMessage() 2501 NotificationMessage(title, message=wx.EmptyString, parent=None, flags=wx.ICON_INFORMATION) 2502 2503 This class allows showing the user a message non intrusively. 2504 """ 2505 Timeout_Auto = 0 2506 Timeout_Never = 0 2507 2508 def __init__(self, *args, **kw): 2509 """ 2510 NotificationMessage() 2511 NotificationMessage(title, message=wx.EmptyString, parent=None, flags=wx.ICON_INFORMATION) 2512 2513 This class allows showing the user a message non intrusively. 2514 """ 2515 2516 def Close(self): 2517 """ 2518 Close() -> bool 2519 2520 Hides the notification. 2521 """ 2522 2523 def SetFlags(self, flags): 2524 """ 2525 SetFlags(flags) 2526 2527 This parameter can be currently used to specify the icon to show in 2528 the notification. 2529 """ 2530 2531 def SetMessage(self, message): 2532 """ 2533 SetMessage(message) 2534 2535 Set the main text of the notification. 2536 """ 2537 2538 def SetParent(self, parent): 2539 """ 2540 SetParent(parent) 2541 2542 Set the parent for this notification: the notification will be 2543 associated with the top level parent of this window or, if this method 2544 is not called, with the main application window by default. 2545 """ 2546 2547 def SetTitle(self, title): 2548 """ 2549 SetTitle(title) 2550 2551 Set the title, it must be a concise string (not more than 64 2552 characters), use SetMessage() to give the user more details. 2553 """ 2554 2555 def Show(self, timeout=Timeout_Auto): 2556 """ 2557 Show(timeout=Timeout_Auto) -> bool 2558 2559 Show the notification to the user and hides it after timeout seconds 2560 are elapsed. 2561 """ 2562# end of class NotificationMessage 2563 2564#-- end-notifmsg --# 2565#-- begin-splash --# 2566SPLASH_CENTRE_ON_PARENT = 0 2567SPLASH_CENTRE_ON_SCREEN = 0 2568SPLASH_NO_CENTRE = 0 2569SPLASH_TIMEOUT = 0 2570SPLASH_NO_TIMEOUT = 0 2571 2572class SplashScreen(wx.Frame): 2573 """ 2574 SplashScreen(bitmap, splashStyle, milliseconds, parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, style=wx.BORDER_SIMPLE|wx.FRAME_NO_TASKBAR|wx.STAY_ON_TOP) 2575 2576 wxSplashScreen shows a window with a thin border, displaying a bitmap 2577 describing your application. 2578 """ 2579 2580 def __init__(self, bitmap, splashStyle, milliseconds, parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, style=wx.BORDER_SIMPLE|wx.FRAME_NO_TASKBAR|wx.STAY_ON_TOP): 2581 """ 2582 SplashScreen(bitmap, splashStyle, milliseconds, parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, style=wx.BORDER_SIMPLE|wx.FRAME_NO_TASKBAR|wx.STAY_ON_TOP) 2583 2584 wxSplashScreen shows a window with a thin border, displaying a bitmap 2585 describing your application. 2586 """ 2587 2588 def GetSplashStyle(self): 2589 """ 2590 GetSplashStyle() -> long 2591 2592 Returns the splash style (see wxSplashScreen() for details). 2593 """ 2594 2595 def GetTimeout(self): 2596 """ 2597 GetTimeout() -> int 2598 2599 Returns the timeout in milliseconds. 2600 """ 2601 2602 @staticmethod 2603 def GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL): 2604 """ 2605 GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) -> wx.VisualAttributes 2606 """ 2607 2608 def GetBitmap(self): 2609 """ 2610 GetBitmap() -> wx.Bitmap 2611 2612 Get the spash screen's bitmap 2613 """ 2614 2615 def SetBitmap(self, bitmap): 2616 """ 2617 SetBitmap(bitmap) 2618 2619 Set a new bitmap for the splash screen. 2620 """ 2621 Bitmap = property(None, None) 2622 SplashStyle = property(None, None) 2623 Timeout = property(None, None) 2624# end of class SplashScreen 2625 2626 2627SPLASH_CENTER_ON_PARENT = SPLASH_CENTRE_ON_PARENT 2628SPLASH_CENTER_ON_SCREEN = SPLASH_CENTRE_ON_SCREEN 2629SPLASH_NO_CENTER = SPLASH_NO_CENTRE 2630#-- end-splash --# 2631#-- begin-sashwin --# 2632SW_NOBORDER = 0 2633SW_BORDER = 0 2634SW_3DSASH = 0 2635SW_3DBORDER = 0 2636SW_3D = 0 2637SASH_TOP = 0 2638SASH_RIGHT = 0 2639SASH_BOTTOM = 0 2640SASH_LEFT = 0 2641SASH_NONE = 0 2642SASH_STATUS_OK = 0 2643SASH_STATUS_OUT_OF_RANGE = 0 2644wxEVT_SASH_DRAGGED = 0 2645 2646class SashWindow(wx.Window): 2647 """ 2648 SashWindow() 2649 SashWindow(parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, style=wx.CLIP_CHILDREN|SW_3D, name="sashWindow") 2650 2651 wxSashWindow allows any of its edges to have a sash which can be 2652 dragged to resize the window. 2653 """ 2654 2655 def __init__(self, *args, **kw): 2656 """ 2657 SashWindow() 2658 SashWindow(parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, style=wx.CLIP_CHILDREN|SW_3D, name="sashWindow") 2659 2660 wxSashWindow allows any of its edges to have a sash which can be 2661 dragged to resize the window. 2662 """ 2663 2664 def GetMaximumSizeX(self): 2665 """ 2666 GetMaximumSizeX() -> int 2667 2668 Gets the maximum window size in the x direction. 2669 """ 2670 2671 def GetMaximumSizeY(self): 2672 """ 2673 GetMaximumSizeY() -> int 2674 2675 Gets the maximum window size in the y direction. 2676 """ 2677 2678 def GetMinimumSizeX(self): 2679 """ 2680 GetMinimumSizeX() -> int 2681 2682 Gets the minimum window size in the x direction. 2683 """ 2684 2685 def GetMinimumSizeY(self): 2686 """ 2687 GetMinimumSizeY() -> int 2688 2689 Gets the minimum window size in the y direction. 2690 """ 2691 2692 def GetSashVisible(self, edge): 2693 """ 2694 GetSashVisible(edge) -> bool 2695 2696 Returns true if a sash is visible on the given edge, false otherwise. 2697 """ 2698 2699 def SetMaximumSizeX(self, min): 2700 """ 2701 SetMaximumSizeX(min) 2702 2703 Sets the maximum window size in the x direction. 2704 """ 2705 2706 def SetMaximumSizeY(self, min): 2707 """ 2708 SetMaximumSizeY(min) 2709 2710 Sets the maximum window size in the y direction. 2711 """ 2712 2713 def SetMinimumSizeX(self, min): 2714 """ 2715 SetMinimumSizeX(min) 2716 2717 Sets the minimum window size in the x direction. 2718 """ 2719 2720 def SetMinimumSizeY(self, min): 2721 """ 2722 SetMinimumSizeY(min) 2723 2724 Sets the minimum window size in the y direction. 2725 """ 2726 2727 def SetSashVisible(self, edge, visible): 2728 """ 2729 SetSashVisible(edge, visible) 2730 2731 Call this function to make a sash visible or invisible on a particular 2732 edge. 2733 """ 2734 2735 def GetEdgeMargin(self, edge): 2736 """ 2737 GetEdgeMargin(edge) -> int 2738 2739 Get border size. 2740 """ 2741 2742 def SetDefaultBorderSize(self, width): 2743 """ 2744 SetDefaultBorderSize(width) 2745 2746 Sets the default sash border size. 2747 """ 2748 2749 def GetDefaultBorderSize(self): 2750 """ 2751 GetDefaultBorderSize() -> int 2752 2753 Gets the default sash border size. 2754 """ 2755 2756 def SetExtraBorderSize(self, width): 2757 """ 2758 SetExtraBorderSize(width) 2759 2760 Sets the additional border size between child and sash window. 2761 """ 2762 2763 def GetExtraBorderSize(self): 2764 """ 2765 GetExtraBorderSize() -> int 2766 2767 Gets the addition border size between child and sash window. 2768 """ 2769 2770 def SashHitTest(self, x, y, tolerance=2): 2771 """ 2772 SashHitTest(x, y, tolerance=2) -> SashEdgePosition 2773 2774 Tests for x, y over sash. 2775 """ 2776 2777 def SizeWindows(self): 2778 """ 2779 SizeWindows() 2780 2781 Resizes subwindows. 2782 """ 2783 2784 @staticmethod 2785 def GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL): 2786 """ 2787 GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) -> wx.VisualAttributes 2788 """ 2789 DefaultBorderSize = property(None, None) 2790 ExtraBorderSize = property(None, None) 2791 MaximumSizeX = property(None, None) 2792 MaximumSizeY = property(None, None) 2793 MinimumSizeX = property(None, None) 2794 MinimumSizeY = property(None, None) 2795# end of class SashWindow 2796 2797 2798class SashEvent(wx.CommandEvent): 2799 """ 2800 SashEvent(id=0, edge=SASH_NONE) 2801 2802 A sash event is sent when the sash of a wxSashWindow has been dragged 2803 by the user. 2804 """ 2805 2806 def __init__(self, id=0, edge=SASH_NONE): 2807 """ 2808 SashEvent(id=0, edge=SASH_NONE) 2809 2810 A sash event is sent when the sash of a wxSashWindow has been dragged 2811 by the user. 2812 """ 2813 2814 def GetDragRect(self): 2815 """ 2816 GetDragRect() -> wx.Rect 2817 2818 Returns the rectangle representing the new size the window would be if 2819 the resize was applied. 2820 """ 2821 2822 def GetDragStatus(self): 2823 """ 2824 GetDragStatus() -> SashDragStatus 2825 2826 Returns the status of the sash: one of wxSASH_STATUS_OK, 2827 wxSASH_STATUS_OUT_OF_RANGE. 2828 """ 2829 2830 def GetEdge(self): 2831 """ 2832 GetEdge() -> SashEdgePosition 2833 2834 Returns the dragged edge. 2835 """ 2836 2837 def SetEdge(self, edge): 2838 """ 2839 SetEdge(edge) 2840 """ 2841 2842 def SetDragRect(self, rect): 2843 """ 2844 SetDragRect(rect) 2845 """ 2846 2847 def SetDragStatus(self, status): 2848 """ 2849 SetDragStatus(status) 2850 """ 2851 DragRect = property(None, None) 2852 DragStatus = property(None, None) 2853 Edge = property(None, None) 2854# end of class SashEvent 2855 2856 2857EVT_SASH_DRAGGED = wx.PyEventBinder( wxEVT_SASH_DRAGGED, 1 ) 2858EVT_SASH_DRAGGED_RANGE = wx.PyEventBinder( wxEVT_SASH_DRAGGED, 2 ) 2859#-- end-sashwin --# 2860#-- begin-laywin --# 2861LAYOUT_HORIZONTAL = 0 2862LAYOUT_VERTICAL = 0 2863LAYOUT_NONE = 0 2864LAYOUT_TOP = 0 2865LAYOUT_LEFT = 0 2866LAYOUT_RIGHT = 0 2867LAYOUT_BOTTOM = 0 2868wxEVT_QUERY_LAYOUT_INFO = 0 2869wxEVT_CALCULATE_LAYOUT = 0 2870 2871class LayoutAlgorithm(wx.Object): 2872 """ 2873 LayoutAlgorithm() 2874 2875 wxLayoutAlgorithm implements layout of subwindows in MDI or SDI 2876 frames. 2877 """ 2878 2879 def __init__(self): 2880 """ 2881 LayoutAlgorithm() 2882 2883 wxLayoutAlgorithm implements layout of subwindows in MDI or SDI 2884 frames. 2885 """ 2886 2887 def LayoutFrame(self, frame, mainWindow=None): 2888 """ 2889 LayoutFrame(frame, mainWindow=None) -> bool 2890 2891 Lays out the children of a normal frame. 2892 """ 2893 2894 def LayoutMDIFrame(self, frame, rect=None): 2895 """ 2896 LayoutMDIFrame(frame, rect=None) -> bool 2897 2898 Lays out the children of an MDI parent frame. 2899 """ 2900 2901 def LayoutWindow(self, parent, mainWindow=None): 2902 """ 2903 LayoutWindow(parent, mainWindow=None) -> bool 2904 2905 Lays out the children of a normal frame or other window. 2906 """ 2907# end of class LayoutAlgorithm 2908 2909 2910class SashLayoutWindow(SashWindow): 2911 """ 2912 SashLayoutWindow() 2913 SashLayoutWindow(parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, style=wx.CLIP_CHILDREN|SW_3D, name="layoutWindow") 2914 2915 wxSashLayoutWindow responds to OnCalculateLayout events generated by 2916 wxLayoutAlgorithm. 2917 """ 2918 2919 def __init__(self, *args, **kw): 2920 """ 2921 SashLayoutWindow() 2922 SashLayoutWindow(parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, style=wx.CLIP_CHILDREN|SW_3D, name="layoutWindow") 2923 2924 wxSashLayoutWindow responds to OnCalculateLayout events generated by 2925 wxLayoutAlgorithm. 2926 """ 2927 2928 def Create(self, parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, style=wx.CLIP_CHILDREN|SW_3D, name="layoutWindow"): 2929 """ 2930 Create(parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, style=wx.CLIP_CHILDREN|SW_3D, name="layoutWindow") -> bool 2931 2932 Initializes a sash layout window, which can be a child of a frame, 2933 dialog or any other non-control window. 2934 """ 2935 2936 def GetAlignment(self): 2937 """ 2938 GetAlignment() -> LayoutAlignment 2939 2940 Returns the alignment of the window: one of wxLAYOUT_TOP, 2941 wxLAYOUT_LEFT, wxLAYOUT_RIGHT, wxLAYOUT_BOTTOM. 2942 """ 2943 2944 def GetOrientation(self): 2945 """ 2946 GetOrientation() -> LayoutOrientation 2947 2948 Returns the orientation of the window: one of wxLAYOUT_HORIZONTAL, 2949 wxLAYOUT_VERTICAL. 2950 """ 2951 2952 def OnCalculateLayout(self, event): 2953 """ 2954 OnCalculateLayout(event) 2955 2956 The default handler for the event that is generated by 2957 wxLayoutAlgorithm. 2958 """ 2959 2960 def OnQueryLayoutInfo(self, event): 2961 """ 2962 OnQueryLayoutInfo(event) 2963 2964 The default handler for the event that is generated by 2965 OnCalculateLayout to get size, alignment and orientation information 2966 for the window. 2967 """ 2968 2969 def SetAlignment(self, alignment): 2970 """ 2971 SetAlignment(alignment) 2972 2973 Sets the alignment of the window (which edge of the available parent 2974 client area the window is attached to). 2975 """ 2976 2977 def SetDefaultSize(self, size): 2978 """ 2979 SetDefaultSize(size) 2980 2981 Sets the default dimensions of the window. 2982 """ 2983 2984 def SetOrientation(self, orientation): 2985 """ 2986 SetOrientation(orientation) 2987 2988 Sets the orientation of the window (the direction the window will 2989 stretch in, to fill the available parent client area). 2990 """ 2991 2992 @staticmethod 2993 def GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL): 2994 """ 2995 GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) -> wx.VisualAttributes 2996 """ 2997 Alignment = property(None, None) 2998 Orientation = property(None, None) 2999# end of class SashLayoutWindow 3000 3001 3002class QueryLayoutInfoEvent(wx.Event): 3003 """ 3004 QueryLayoutInfoEvent(id=0) 3005 3006 This event is sent when wxLayoutAlgorithm wishes to get the size, 3007 orientation and alignment of a window. 3008 """ 3009 3010 def __init__(self, id=0): 3011 """ 3012 QueryLayoutInfoEvent(id=0) 3013 3014 This event is sent when wxLayoutAlgorithm wishes to get the size, 3015 orientation and alignment of a window. 3016 """ 3017 3018 def GetAlignment(self): 3019 """ 3020 GetAlignment() -> LayoutAlignment 3021 3022 Specifies the alignment of the window (which side of the remaining 3023 parent client area the window sticks to). 3024 """ 3025 3026 def GetFlags(self): 3027 """ 3028 GetFlags() -> int 3029 3030 Returns the flags associated with this event. 3031 """ 3032 3033 def GetOrientation(self): 3034 """ 3035 GetOrientation() -> LayoutOrientation 3036 3037 Returns the orientation that the event handler specified to the event 3038 object. 3039 """ 3040 3041 def GetRequestedLength(self): 3042 """ 3043 GetRequestedLength() -> int 3044 3045 Returns the requested length of the window in the direction of the 3046 window orientation. 3047 """ 3048 3049 def GetSize(self): 3050 """ 3051 GetSize() -> wx.Size 3052 3053 Returns the size that the event handler specified to the event object 3054 as being the requested size of the window. 3055 """ 3056 3057 def SetAlignment(self, alignment): 3058 """ 3059 SetAlignment(alignment) 3060 3061 Call this to specify the alignment of the window (which side of the 3062 remaining parent client area the window sticks to). 3063 """ 3064 3065 def SetFlags(self, flags): 3066 """ 3067 SetFlags(flags) 3068 3069 Sets the flags associated with this event. 3070 """ 3071 3072 def SetOrientation(self, orientation): 3073 """ 3074 SetOrientation(orientation) 3075 3076 Call this to specify the orientation of the window. 3077 """ 3078 3079 def SetRequestedLength(self, length): 3080 """ 3081 SetRequestedLength(length) 3082 3083 Sets the requested length of the window in the direction of the window 3084 orientation. 3085 """ 3086 3087 def SetSize(self, size): 3088 """ 3089 SetSize(size) 3090 3091 Call this to let the calling code know what the size of the window is. 3092 """ 3093 Alignment = property(None, None) 3094 Flags = property(None, None) 3095 Orientation = property(None, None) 3096 RequestedLength = property(None, None) 3097 Size = property(None, None) 3098# end of class QueryLayoutInfoEvent 3099 3100 3101class CalculateLayoutEvent(wx.Event): 3102 """ 3103 CalculateLayoutEvent(id=0) 3104 3105 This event is sent by wxLayoutAlgorithm to calculate the amount of the 3106 remaining client area that the window should occupy. 3107 """ 3108 3109 def __init__(self, id=0): 3110 """ 3111 CalculateLayoutEvent(id=0) 3112 3113 This event is sent by wxLayoutAlgorithm to calculate the amount of the 3114 remaining client area that the window should occupy. 3115 """ 3116 3117 def GetFlags(self): 3118 """ 3119 GetFlags() -> int 3120 3121 Returns the flags associated with this event. 3122 """ 3123 3124 def GetRect(self): 3125 """ 3126 GetRect() -> wx.Rect 3127 3128 Before the event handler is entered, returns the remaining parent 3129 client area that the window could occupy. 3130 """ 3131 3132 def SetFlags(self, flags): 3133 """ 3134 SetFlags(flags) 3135 3136 Sets the flags associated with this event. 3137 """ 3138 3139 def SetRect(self, rect): 3140 """ 3141 SetRect(rect) 3142 3143 Call this to specify the new remaining parent client area, after the 3144 space occupied by the window has been subtracted. 3145 """ 3146 Flags = property(None, None) 3147 Rect = property(None, None) 3148# end of class CalculateLayoutEvent 3149 3150 3151EVT_QUERY_LAYOUT_INFO = wx.PyEventBinder( wxEVT_QUERY_LAYOUT_INFO ) 3152EVT_CALCULATE_LAYOUT = wx.PyEventBinder( wxEVT_CALCULATE_LAYOUT ) 3153#-- end-laywin --# 3154#-- begin-odcombo --# 3155ODCB_PAINTING_CONTROL = 0 3156ODCB_PAINTING_SELECTED = 0 3157ODCB_DCLICK_CYCLES = 0 3158ODCB_STD_CONTROL_PAINT = 0 3159 3160class OwnerDrawnComboBox(wx.ComboCtrl, wx.ItemContainer): 3161 """ 3162 OwnerDrawnComboBox() 3163 OwnerDrawnComboBox(parent, id=wx.ID_ANY, value=wx.EmptyString, pos=wx.DefaultPosition, size=wx.DefaultSize, choices=[], style=0, validator=wx.DefaultValidator, name="comboBox") 3164 3165 wxOwnerDrawnComboBox is a combobox with owner-drawn list items. 3166 """ 3167 3168 def __init__(self, *args, **kw): 3169 """ 3170 OwnerDrawnComboBox() 3171 OwnerDrawnComboBox(parent, id=wx.ID_ANY, value=wx.EmptyString, pos=wx.DefaultPosition, size=wx.DefaultSize, choices=[], style=0, validator=wx.DefaultValidator, name="comboBox") 3172 3173 wxOwnerDrawnComboBox is a combobox with owner-drawn list items. 3174 """ 3175 3176 def Create(self, parent, id=wx.ID_ANY, value=wx.EmptyString, pos=wx.DefaultPosition, size=wx.DefaultSize, choices=[], style=0, validator=wx.DefaultValidator, name=wx.ComboBoxNameStr): 3177 """ 3178 Create(parent, id=wx.ID_ANY, value=wx.EmptyString, pos=wx.DefaultPosition, size=wx.DefaultSize, choices=[], style=0, validator=wx.DefaultValidator, name=wx.ComboBoxNameStr) -> bool 3179 3180 Creates the combobox for two-step construction. 3181 """ 3182 3183 def GetWidestItem(self): 3184 """ 3185 GetWidestItem() -> int 3186 3187 Returns index to the widest item in the list. 3188 """ 3189 3190 def GetWidestItemWidth(self): 3191 """ 3192 GetWidestItemWidth() -> int 3193 3194 Returns width of the widest item in the list. 3195 """ 3196 3197 @staticmethod 3198 def GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL): 3199 """ 3200 GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) -> wx.VisualAttributes 3201 """ 3202 WidestItem = property(None, None) 3203 WidestItemWidth = property(None, None) 3204 3205 def OnDrawBackground(self, dc, rect, item, flags): 3206 """ 3207 OnDrawBackground(dc, rect, item, flags) 3208 3209 This method is used to draw the items background and, maybe, a border 3210 around it. 3211 """ 3212 3213 def OnDrawItem(self, dc, rect, item, flags): 3214 """ 3215 OnDrawItem(dc, rect, item, flags) 3216 3217 The derived class may implement this function to actually draw the 3218 item with the given index on the provided DC. 3219 """ 3220 3221 def OnMeasureItem(self, item): 3222 """ 3223 OnMeasureItem(item) -> Coord 3224 3225 The derived class may implement this method to return the height of 3226 the specified item (in pixels). 3227 """ 3228 3229 def OnMeasureItemWidth(self, item): 3230 """ 3231 OnMeasureItemWidth(item) -> Coord 3232 3233 The derived class may implement this method to return the width of the 3234 specified item (in pixels). 3235 """ 3236# end of class OwnerDrawnComboBox 3237 3238#-- end-odcombo --# 3239#-- begin-bmpcbox --# 3240BitmapComboBoxNameStr = "" 3241 3242class BitmapComboBox(wx.Control, wx.TextEntry, wx.ItemContainer): 3243 """ 3244 BitmapComboBox() 3245 BitmapComboBox(parent, id=wx.ID_ANY, value=wx.EmptyString, pos=wx.DefaultPosition, size=wx.DefaultSize, choices=[], style=0, validator=wx.DefaultValidator, name=BitmapComboBoxNameStr) 3246 3247 A combobox that displays bitmap in front of the list items. 3248 """ 3249 3250 def __init__(self, *args, **kw): 3251 """ 3252 BitmapComboBox() 3253 BitmapComboBox(parent, id=wx.ID_ANY, value=wx.EmptyString, pos=wx.DefaultPosition, size=wx.DefaultSize, choices=[], style=0, validator=wx.DefaultValidator, name=BitmapComboBoxNameStr) 3254 3255 A combobox that displays bitmap in front of the list items. 3256 """ 3257 3258 def Append(self, *args, **kw): 3259 """ 3260 Append(item, bitmap=wx.NullBitmap) -> int 3261 Append(item, bitmap, clientData) -> int 3262 3263 Adds the item to the end of the combo box. 3264 """ 3265 3266 def Create(self, parent, id=wx.ID_ANY, value=wx.EmptyString, pos=wx.DefaultPosition, size=wx.DefaultSize, choices=[], style=0, validator=wx.DefaultValidator, name=BitmapComboBoxNameStr): 3267 """ 3268 Create(parent, id=wx.ID_ANY, value=wx.EmptyString, pos=wx.DefaultPosition, size=wx.DefaultSize, choices=[], style=0, validator=wx.DefaultValidator, name=BitmapComboBoxNameStr) -> bool 3269 3270 Creates the combobox for two-step construction. 3271 """ 3272 3273 def GetBitmapSize(self): 3274 """ 3275 GetBitmapSize() -> wx.Size 3276 3277 Returns the size of the bitmaps used in the combo box. 3278 """ 3279 3280 def GetItemBitmap(self, n): 3281 """ 3282 GetItemBitmap(n) -> wx.Bitmap 3283 3284 Returns the bitmap of the item with the given index. 3285 """ 3286 3287 def Insert(self, *args, **kw): 3288 """ 3289 Insert(item, bitmap, pos) -> int 3290 Insert(item, bitmap, pos, clientData) -> int 3291 3292 Inserts the item into the list before pos. 3293 """ 3294 3295 def SetItemBitmap(self, n, bitmap): 3296 """ 3297 SetItemBitmap(n, bitmap) 3298 3299 Sets the bitmap for the given item. 3300 """ 3301 3302 @staticmethod 3303 def GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL): 3304 """ 3305 GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) -> wx.VisualAttributes 3306 """ 3307 BitmapSize = property(None, None) 3308# end of class BitmapComboBox 3309 3310#-- end-bmpcbox --# 3311#-- begin-richtooltip --# 3312TipKind_None = 0 3313TipKind_TopLeft = 0 3314TipKind_Top = 0 3315TipKind_TopRight = 0 3316TipKind_BottomLeft = 0 3317TipKind_Bottom = 0 3318TipKind_BottomRight = 0 3319TipKind_Auto = 0 3320 3321class RichToolTip(object): 3322 """ 3323 RichToolTip(title, message) 3324 3325 Allows showing a tool tip with more customizations than wxToolTip. 3326 """ 3327 3328 def __init__(self, title, message): 3329 """ 3330 RichToolTip(title, message) 3331 3332 Allows showing a tool tip with more customizations than wxToolTip. 3333 """ 3334 3335 def SetIcon(self, *args, **kw): 3336 """ 3337 SetIcon(icon=wx.ICON_INFORMATION) 3338 SetIcon(icon) 3339 3340 Set the small icon to show. 3341 """ 3342 3343 def SetBackgroundColour(self, col, colEnd=wx.Colour()): 3344 """ 3345 SetBackgroundColour(col, colEnd=wx.Colour()) 3346 3347 Set the background colour. 3348 """ 3349 3350 def SetTimeout(self, millisecondsTimeout, millisecondsDelay=0): 3351 """ 3352 SetTimeout(millisecondsTimeout, millisecondsDelay=0) 3353 3354 Set timeout after which the tooltip should disappear and optionally 3355 set a delay before the tooltip is shown, in milliseconds. 3356 """ 3357 3358 def SetTipKind(self, tipKind): 3359 """ 3360 SetTipKind(tipKind) 3361 3362 Choose the tip kind, possibly none. 3363 """ 3364 3365 def SetTitleFont(self, font): 3366 """ 3367 SetTitleFont(font) 3368 3369 Set the title text font. 3370 """ 3371 3372 def ShowFor(self, win, rect=None): 3373 """ 3374 ShowFor(win, rect=None) 3375 3376 Show the tooltip for the given window and optionally specify where to 3377 show the tooltip. 3378 """ 3379# end of class RichToolTip 3380 3381#-- end-richtooltip --# 3382#-- begin-timectrl --# 3383TP_DEFAULT = 0 3384 3385class TimePickerCtrl(wx.Control): 3386 """ 3387 TimePickerCtrl() 3388 TimePickerCtrl(parent, id=wx.ID_ANY, dt=wx.DefaultDateTime, pos=wx.DefaultPosition, size=wx.DefaultSize, style=TP_DEFAULT, validator=wx.DefaultValidator, name="timectrl") 3389 3390 This control allows the user to enter time. 3391 """ 3392 3393 def __init__(self, *args, **kw): 3394 """ 3395 TimePickerCtrl() 3396 TimePickerCtrl(parent, id=wx.ID_ANY, dt=wx.DefaultDateTime, pos=wx.DefaultPosition, size=wx.DefaultSize, style=TP_DEFAULT, validator=wx.DefaultValidator, name="timectrl") 3397 3398 This control allows the user to enter time. 3399 """ 3400 3401 def Create(self, parent, id=wx.ID_ANY, dt=wx.DefaultDateTime, pos=wx.DefaultPosition, size=wx.DefaultSize, style=DP_DEFAULT|DP_SHOWCENTURY, validator=wx.DefaultValidator, name="timectrl"): 3402 """ 3403 Create(parent, id=wx.ID_ANY, dt=wx.DefaultDateTime, pos=wx.DefaultPosition, size=wx.DefaultSize, style=DP_DEFAULT|DP_SHOWCENTURY, validator=wx.DefaultValidator, name="timectrl") -> bool 3404 3405 Create the control window. 3406 """ 3407 3408 def GetTime(self): 3409 """ 3410 GetTime() -> (hour, min, sec) 3411 3412 Returns the currently entered time as hours, minutes and seconds. 3413 """ 3414 3415 def GetValue(self): 3416 """ 3417 GetValue() -> wx.DateTime 3418 3419 Returns the currently entered time. 3420 """ 3421 3422 def SetTime(self, hour, min, sec): 3423 """ 3424 SetTime(hour, min, sec) -> bool 3425 3426 Changes the current time of the control. 3427 """ 3428 3429 def SetValue(self, dt): 3430 """ 3431 SetValue(dt) 3432 3433 Changes the current value of the control. 3434 """ 3435 3436 @staticmethod 3437 def GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL): 3438 """ 3439 GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) -> wx.VisualAttributes 3440 """ 3441 Value = property(None, None) 3442# end of class TimePickerCtrl 3443 3444#-- end-timectrl --# 3445#-- begin-wizard --# 3446WIZARD_EX_HELPBUTTON = 0 3447WIZARD_VALIGN_TOP = 0 3448WIZARD_VALIGN_CENTRE = 0 3449WIZARD_VALIGN_BOTTOM = 0 3450WIZARD_HALIGN_LEFT = 0 3451WIZARD_HALIGN_CENTRE = 0 3452WIZARD_HALIGN_RIGHT = 0 3453WIZARD_TILE = 0 3454wxEVT_WIZARD_PAGE_CHANGED = 0 3455wxEVT_WIZARD_PAGE_CHANGING = 0 3456wxEVT_WIZARD_CANCEL = 0 3457wxEVT_WIZARD_HELP = 0 3458wxEVT_WIZARD_FINISHED = 0 3459wxEVT_WIZARD_PAGE_SHOWN = 0 3460wxEVT_WIZARD_BEFORE_PAGE_CHANGED = 0 3461 3462class WizardPage(wx.Panel): 3463 """ 3464 WizardPage() 3465 WizardPage(parent, bitmap=wx.NullBitmap) 3466 3467 wxWizardPage is one of the screens in wxWizard: it must know what are 3468 the following and preceding pages (which may be NULL for the 3469 first/last page). 3470 """ 3471 3472 def __init__(self, *args, **kw): 3473 """ 3474 WizardPage() 3475 WizardPage(parent, bitmap=wx.NullBitmap) 3476 3477 wxWizardPage is one of the screens in wxWizard: it must know what are 3478 the following and preceding pages (which may be NULL for the 3479 first/last page). 3480 """ 3481 3482 def Create(self, parent, bitmap=wx.NullBitmap): 3483 """ 3484 Create(parent, bitmap=wx.NullBitmap) -> bool 3485 3486 Creates the wizard page. 3487 """ 3488 3489 def GetBitmap(self): 3490 """ 3491 GetBitmap() -> wx.Bitmap 3492 3493 This method is called by wxWizard to get the bitmap to display 3494 alongside the page. 3495 """ 3496 3497 def GetNext(self): 3498 """ 3499 GetNext() -> WizardPage 3500 3501 Get the page which should be shown when the user chooses the "Next" 3502 button: if NULL is returned, this button will be disabled. 3503 """ 3504 3505 def GetPrev(self): 3506 """ 3507 GetPrev() -> WizardPage 3508 3509 Get the page which should be shown when the user chooses the "Back" 3510 button: if NULL is returned, this button will be disabled. 3511 """ 3512 3513 @staticmethod 3514 def GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL): 3515 """ 3516 GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) -> wx.VisualAttributes 3517 """ 3518 Bitmap = property(None, None) 3519 Next = property(None, None) 3520 Prev = property(None, None) 3521# end of class WizardPage 3522 3523 3524class WizardPageSimple(WizardPage): 3525 """ 3526 WizardPageSimple() 3527 WizardPageSimple(parent, prev=None, next=None, bitmap=wx.NullBitmap) 3528 3529 wxWizardPageSimple is the simplest possible wxWizardPage 3530 implementation: it just returns the pointers given to its constructor 3531 from wxWizardPage::GetNext() and wxWizardPage::GetPrev() functions. 3532 """ 3533 3534 def __init__(self, *args, **kw): 3535 """ 3536 WizardPageSimple() 3537 WizardPageSimple(parent, prev=None, next=None, bitmap=wx.NullBitmap) 3538 3539 wxWizardPageSimple is the simplest possible wxWizardPage 3540 implementation: it just returns the pointers given to its constructor 3541 from wxWizardPage::GetNext() and wxWizardPage::GetPrev() functions. 3542 """ 3543 3544 def Create(self, parent=None, prev=None, next=None, bitmap=wx.NullBitmap): 3545 """ 3546 Create(parent=None, prev=None, next=None, bitmap=wx.NullBitmap) -> bool 3547 3548 Creates the wizard page. 3549 """ 3550 3551 def Chain(self, *args, **kw): 3552 """ 3553 Chain(next) -> WizardPageSimple 3554 Chain(first, second) 3555 3556 A helper chaining this page with the next one. 3557 """ 3558 3559 def SetNext(self, next): 3560 """ 3561 SetNext(next) 3562 3563 Sets the next page. 3564 """ 3565 3566 def SetPrev(self, prev): 3567 """ 3568 SetPrev(prev) 3569 3570 Sets the previous page. 3571 """ 3572 3573 @staticmethod 3574 def GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL): 3575 """ 3576 GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) -> wx.VisualAttributes 3577 """ 3578# end of class WizardPageSimple 3579 3580 3581class Wizard(wx.Dialog): 3582 """ 3583 Wizard() 3584 Wizard(parent, id=wx.ID_ANY, title=wx.EmptyString, bitmap=wx.NullBitmap, pos=wx.DefaultPosition, style=wx.DEFAULT_DIALOG_STYLE) 3585 3586 wxWizard is the central class for implementing 'wizard-like' dialogs. 3587 """ 3588 3589 def __init__(self, *args, **kw): 3590 """ 3591 Wizard() 3592 Wizard(parent, id=wx.ID_ANY, title=wx.EmptyString, bitmap=wx.NullBitmap, pos=wx.DefaultPosition, style=wx.DEFAULT_DIALOG_STYLE) 3593 3594 wxWizard is the central class for implementing 'wizard-like' dialogs. 3595 """ 3596 3597 def Create(self, parent, id=wx.ID_ANY, title=wx.EmptyString, bitmap=wx.NullBitmap, pos=wx.DefaultPosition, style=wx.DEFAULT_DIALOG_STYLE): 3598 """ 3599 Create(parent, id=wx.ID_ANY, title=wx.EmptyString, bitmap=wx.NullBitmap, pos=wx.DefaultPosition, style=wx.DEFAULT_DIALOG_STYLE) -> bool 3600 3601 Creates the wizard dialog. 3602 """ 3603 3604 def FitToPage(self, firstPage): 3605 """ 3606 FitToPage(firstPage) 3607 3608 This method is obsolete, use GetPageAreaSizer() instead. 3609 """ 3610 3611 def GetBitmap(self): 3612 """ 3613 GetBitmap() -> wx.Bitmap 3614 3615 Returns the bitmap used for the wizard. 3616 """ 3617 3618 def GetBitmapBackgroundColour(self): 3619 """ 3620 GetBitmapBackgroundColour() -> wx.Colour 3621 3622 Returns the colour that should be used to fill the area not taken up 3623 by the wizard or page bitmap, if a non-zero bitmap placement flag has 3624 been set. 3625 """ 3626 3627 def GetBitmapPlacement(self): 3628 """ 3629 GetBitmapPlacement() -> int 3630 3631 Returns the flags indicating how the wizard or page bitmap should be 3632 expanded and positioned to fit the page height. 3633 """ 3634 3635 def GetCurrentPage(self): 3636 """ 3637 GetCurrentPage() -> WizardPage 3638 3639 Get the current page while the wizard is running. 3640 """ 3641 3642 def GetMinimumBitmapWidth(self): 3643 """ 3644 GetMinimumBitmapWidth() -> int 3645 3646 Returns the minimum width for the bitmap that will be constructed to 3647 contain the actual wizard or page bitmap if a non-zero bitmap 3648 placement flag has been set. 3649 """ 3650 3651 def GetPageAreaSizer(self): 3652 """ 3653 GetPageAreaSizer() -> wx.Sizer 3654 3655 Returns pointer to page area sizer. 3656 """ 3657 3658 def GetPageSize(self): 3659 """ 3660 GetPageSize() -> wx.Size 3661 3662 Returns the size available for the pages. 3663 """ 3664 3665 def HasNextPage(self, page): 3666 """ 3667 HasNextPage(page) -> bool 3668 3669 Return true if this page is not the last one in the wizard. 3670 """ 3671 3672 def HasPrevPage(self, page): 3673 """ 3674 HasPrevPage(page) -> bool 3675 3676 Returns true if this page is not the last one in the wizard. 3677 """ 3678 3679 def RunWizard(self, firstPage): 3680 """ 3681 RunWizard(firstPage) -> bool 3682 3683 Executes the wizard starting from the given page, returning true if it 3684 was successfully finished or false if user cancelled it. 3685 """ 3686 3687 def SetBitmap(self, bitmap): 3688 """ 3689 SetBitmap(bitmap) 3690 3691 Sets the bitmap used for the wizard. 3692 """ 3693 3694 def SetBitmapBackgroundColour(self, colour): 3695 """ 3696 SetBitmapBackgroundColour(colour) 3697 3698 Sets the colour that should be used to fill the area not taken up by 3699 the wizard or page bitmap, if a non-zero bitmap placement flag has 3700 been set. 3701 """ 3702 3703 def SetBitmapPlacement(self, placement): 3704 """ 3705 SetBitmapPlacement(placement) 3706 3707 Sets the flags indicating how the wizard or page bitmap should be 3708 expanded and positioned to fit the page height. 3709 """ 3710 3711 def SetBorder(self, border): 3712 """ 3713 SetBorder(border) 3714 3715 Sets width of border around page area. 3716 """ 3717 3718 def SetMinimumBitmapWidth(self, width): 3719 """ 3720 SetMinimumBitmapWidth(width) 3721 3722 Sets the minimum width for the bitmap that will be constructed to 3723 contain the actual wizard or page bitmap if a non-zero bitmap 3724 placement flag has been set. 3725 """ 3726 3727 def SetPageSize(self, sizePage): 3728 """ 3729 SetPageSize(sizePage) 3730 3731 Sets the minimal size to be made available for the wizard pages. 3732 """ 3733 3734 @staticmethod 3735 def GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL): 3736 """ 3737 GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) -> wx.VisualAttributes 3738 """ 3739 3740 def ShowPage(self, page, goingForward=True): 3741 """ 3742 ShowPage(page, goingForward=True) -> bool 3743 3744 Show the given wizard page. 3745 """ 3746 3747 def IsRunning(self): 3748 """ 3749 IsRunning() -> bool 3750 """ 3751 Bitmap = property(None, None) 3752 BitmapBackgroundColour = property(None, None) 3753 BitmapPlacement = property(None, None) 3754 CurrentPage = property(None, None) 3755 MinimumBitmapWidth = property(None, None) 3756 PageAreaSizer = property(None, None) 3757 PageSize = property(None, None) 3758# end of class Wizard 3759 3760 3761class WizardEvent(wx.NotifyEvent): 3762 """ 3763 WizardEvent(type=wx.wxEVT_NULL, id=wx.ID_ANY, direction=True, page=0) 3764 3765 wxWizardEvent class represents an event generated by the wxWizard: 3766 this event is first sent to the page itself and, if not processed 3767 there, goes up the window hierarchy as usual. 3768 """ 3769 3770 def __init__(self, type=wx.wxEVT_NULL, id=wx.ID_ANY, direction=True, page=0): 3771 """ 3772 WizardEvent(type=wx.wxEVT_NULL, id=wx.ID_ANY, direction=True, page=0) 3773 3774 wxWizardEvent class represents an event generated by the wxWizard: 3775 this event is first sent to the page itself and, if not processed 3776 there, goes up the window hierarchy as usual. 3777 """ 3778 3779 def GetDirection(self): 3780 """ 3781 GetDirection() -> bool 3782 3783 Return the direction in which the page is changing: for 3784 EVT_WIZARD_PAGE_CHANGING, return true if we're going forward or false 3785 otherwise and for EVT_WIZARD_PAGE_CHANGED return true if we came from 3786 the previous page and false if we returned from the next one. 3787 """ 3788 3789 def GetPage(self): 3790 """ 3791 GetPage() -> WizardPage 3792 3793 Returns the wxWizardPage which was active when this event was 3794 generated. 3795 """ 3796 Direction = property(None, None) 3797 Page = property(None, None) 3798# end of class WizardEvent 3799 3800 3801PyWizardPage = wx.deprecated(WizardPage, 'Use WizardPage instead.') 3802 3803EVT_WIZARD_BEFORE_PAGE_CHANGED = wx.PyEventBinder( wxEVT_WIZARD_BEFORE_PAGE_CHANGED, 1) 3804EVT_WIZARD_PAGE_CHANGED = wx.PyEventBinder( wxEVT_WIZARD_PAGE_CHANGED, 1) 3805EVT_WIZARD_PAGE_CHANGING = wx.PyEventBinder( wxEVT_WIZARD_PAGE_CHANGING, 1) 3806EVT_WIZARD_CANCEL = wx.PyEventBinder( wxEVT_WIZARD_CANCEL, 1) 3807EVT_WIZARD_HELP = wx.PyEventBinder( wxEVT_WIZARD_HELP, 1) 3808EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) 3809EVT_WIZARD_PAGE_SHOWN = wx.PyEventBinder( wxEVT_WIZARD_PAGE_SHOWN, 1) 3810#-- end-wizard --# 3811#-- begin-pseudodc --# 3812 3813class PseudoDC(wx.Object): 3814 """ 3815 PseudoDC() 3816 3817 A PseudoDC is an object that can be used much like real 3818 :class:`wx.DC`, however it provides some additional features for 3819 object recording and manipulation beyond what a ``wx.DC`` can 3820 provide. 3821 3822 All commands issued to the ``PseudoDC`` are stored in a list. You 3823 can then play these commands back to a real DC object as often as 3824 needed, using the :meth:`DrawToDC` method or one of the similar 3825 methods. Commands in the command list can be tagged by an ID. You 3826 can use this ID to clear the operations associated with a single 3827 ID, redraw the objects associated with that ID, grey them, adjust 3828 their position, etc. 3829 """ 3830 3831 def __init__(self): 3832 """ 3833 PseudoDC() 3834 3835 A PseudoDC is an object that can be used much like real 3836 :class:`wx.DC`, however it provides some additional features for 3837 object recording and manipulation beyond what a ``wx.DC`` can 3838 provide. 3839 3840 All commands issued to the ``PseudoDC`` are stored in a list. You 3841 can then play these commands back to a real DC object as often as 3842 needed, using the :meth:`DrawToDC` method or one of the similar 3843 methods. Commands in the command list can be tagged by an ID. You 3844 can use this ID to clear the operations associated with a single 3845 ID, redraw the objects associated with that ID, grey them, adjust 3846 their position, etc. 3847 """ 3848 3849 def RemoveAll(self): 3850 """ 3851 RemoveAll() 3852 3853 Removes all objects and operations from the recorded list. 3854 """ 3855 3856 def GetLen(self): 3857 """ 3858 GetLen() -> int 3859 3860 Returns the number of operations in the recorded list. 3861 """ 3862 3863 def SetId(self, id): 3864 """ 3865 SetId(id) 3866 3867 Sets the id to be associated with subsequent operations. 3868 """ 3869 3870 def ClearId(self, id): 3871 """ 3872 ClearId(id) 3873 3874 Removes all operations associated with id so the object can be 3875 redrawn. 3876 """ 3877 3878 def RemoveId(self, id): 3879 """ 3880 RemoveId(id) 3881 3882 Remove the object node (and all operations) associated with an id. 3883 """ 3884 3885 def TranslateId(self, id, dx, dy): 3886 """ 3887 TranslateId(id, dx, dy) 3888 3889 Translate the position of the operations of tag `id` by (`dx`, `dy`). 3890 """ 3891 3892 def SetIdGreyedOut(self, id, greyout): 3893 """ 3894 SetIdGreyedOut(id, greyout) 3895 3896 Set whether the set of objects with tag `id` are drawn greyed out or 3897 not. 3898 """ 3899 3900 def GetIdGreyedOut(self, id): 3901 """ 3902 GetIdGreyedOut(id) -> bool 3903 3904 Get whether the set of objects with tag `id` are drawn greyed out or 3905 not. 3906 """ 3907 3908 def FindObjects(self, x, y, radius=1, bg=wx.WHITE): 3909 """ 3910 FindObjects(x, y, radius=1, bg=wx.WHITE) -> PyObject 3911 3912 Returns a list of all the id's that draw a pixel with 3913 color not equal to bg within radius of (x,y). Returns an 3914 empty list if nothing is found. The list is in reverse 3915 drawing order so list[0] is the top id. 3916 """ 3917 3918 def FindObjectsByBBox(self, x, y): 3919 """ 3920 FindObjectsByBBox(x, y) -> PyObject 3921 3922 Returns a list of all the id's whose bounding boxes include (x,y). 3923 Returns an empty list if nothing is found. The list is in 3924 reverse drawing order so list[0] is the top id. 3925 """ 3926 3927 def DrawIdToDC(self, id, dc): 3928 """ 3929 DrawIdToDC(id, dc) 3930 3931 Draw recorded operations tagged with id to dc. 3932 """ 3933 3934 def SetIdBounds(self, id, rect): 3935 """ 3936 SetIdBounds(id, rect) 3937 3938 Set the bounding rect of a given object. 3939 This will create an object node if one doesn't exist. 3940 """ 3941 3942 def GetIdBounds(self, id): 3943 """ 3944 GetIdBounds(id) -> wx.Rect 3945 3946 Returns the bounding rectangle previously set with `SetIdBounds`. 3947 If no bounds have been set, it returns wx.Rect(0,0,0,0). 3948 """ 3949 3950 def DrawToDCClipped(self, dc, rect): 3951 """ 3952 DrawToDCClipped(dc, rect) 3953 3954 Draws the recorded operations to dc, 3955 unless the operation is known to be outside of rect. 3956 """ 3957 3958 def DrawToDCClippedRgn(self, dc, region): 3959 """ 3960 DrawToDCClippedRgn(dc, region) 3961 3962 Draws the recorded operations to dc, 3963 unless the operation is known to be outside the given region. 3964 """ 3965 3966 def DrawToDC(self, dc): 3967 """ 3968 DrawToDC(dc) 3969 3970 Draws the recorded operations to dc. 3971 """ 3972 3973 def FloodFill(self, *args, **kw): 3974 """ 3975 FloodFill(x, y, col, style=wx.FLOOD_SURFACE) 3976 FloodFill(pt, col, style=wx.FLOOD_SURFACE) 3977 3978 Flood fills the device context starting from the given point, 3979 using the current brush colour, and using a style: 3980 3981 - ``wx.FLOOD_SURFACE``: the flooding occurs until a colour other 3982 than the given colour is encountered. 3983 3984 - ``wx.FLOOD_BORDER``: the area to be flooded is bounded by the 3985 given colour. 3986 """ 3987 3988 def DrawLine(self, *args, **kw): 3989 """ 3990 DrawLine(x1, y1, x2, y2) 3991 DrawLine(pt1, pt2) 3992 3993 Draws a line from the first point to the second. 3994 The current pen is used for drawing the line. Note that 3995 the second point is *not* part of the line and is not 3996 drawn by this function (this is consistent with the 3997 behaviour of many other toolkits). 3998 """ 3999 4000 def CrossHair(self, *args, **kw): 4001 """ 4002 CrossHair(x, y) 4003 CrossHair(pt) 4004 4005 Displays a cross hair using the current pen. This is a 4006 vertical and horizontal line the height and width of the 4007 window, centred on the given point. 4008 """ 4009 4010 def DrawArc(self, x1, y1, x2, y2, xc, yc): 4011 """ 4012 DrawArc(x1, y1, x2, y2, xc, yc) 4013 4014 Draws an arc of a circle, centred on the *center* point 4015 (xc, yc), from the first point to the second. The current 4016 pen is used for the outline and the current brush for 4017 filling the shape. 4018 4019 The arc is drawn in an anticlockwise direction from the 4020 start point to the end point. 4021 """ 4022 4023 def DrawCheckMark(self, *args, **kw): 4024 """ 4025 DrawCheckMark(x, y, width, height) 4026 DrawCheckMark(rect) 4027 4028 Draws a check mark inside the given rectangle 4029 """ 4030 4031 def DrawEllipticArc(self, *args, **kw): 4032 """ 4033 DrawEllipticArc(x, y, w, h, start, end) 4034 DrawEllipticArc(pt, sz, start, end) 4035 4036 Draws an arc of an ellipse, with the given rectangle 4037 defining the bounds of the ellipse. The current pen is 4038 used for drawing the arc and the current brush is used for 4039 drawing the pie. 4040 4041 The *start* and *end* parameters specify the start and end 4042 of the arc relative to the three-o'clock position from the 4043 center of the rectangle. Angles are specified in degrees 4044 (360 is a complete circle). Positive values mean 4045 counter-clockwise motion. If start is equal to end, a 4046 complete ellipse will be drawn. 4047 """ 4048 4049 def DrawPoint(self, *args, **kw): 4050 """ 4051 DrawPoint(x, y) 4052 DrawPoint(pt) 4053 4054 Draws a point using the current pen. 4055 """ 4056 4057 def DrawRectangle(self, *args, **kw): 4058 """ 4059 DrawRectangle(x, y, width, height) 4060 DrawRectangle(rect) 4061 DrawRectangle(pt, sz) 4062 4063 Draws a rectangle with the given top left corner, and with 4064 the given size. The current pen is used for the outline 4065 and the current brush for filling the shape. 4066 """ 4067 4068 def DrawRoundedRectangle(self, *args, **kw): 4069 """ 4070 DrawRoundedRectangle(x, y, width, height, radius) 4071 DrawRoundedRectangle(rect, radius) 4072 DrawRoundedRectangle(pt, sz, radius) 4073 4074 Draws a rectangle with the given top left corner, and with 4075 the given size. The current pen is used for the outline 4076 and the current brush for filling the shape. 4077 """ 4078 4079 def DrawCircle(self, *args, **kw): 4080 """ 4081 DrawCircle(x, y, radius) 4082 DrawCircle(pt, radius) 4083 4084 Draws a circle with the given center point and radius. 4085 The current pen is used for the outline and the current 4086 brush for filling the shape. 4087 4088 :see: `DrawEllipse` 4089 """ 4090 4091 def DrawEllipse(self, *args, **kw): 4092 """ 4093 DrawEllipse(x, y, width, height) 4094 DrawEllipse(rect) 4095 DrawEllipse(pt, sz) 4096 4097 Draws an ellipse contained in the specified rectangle. The current pen 4098 is used for the outline and the current brush for filling the shape.", 4099 " 4100 4101 :see: `DrawCircle` 4102 """ 4103 4104 def DrawIcon(self, *args, **kw): 4105 """ 4106 DrawIcon(icon, x, y) 4107 DrawIcon(icon, pt) 4108 4109 Draw an icon on the display at the given position. 4110 """ 4111 4112 def DrawBitmap(self, *args, **kw): 4113 """ 4114 DrawBitmap(bmp, x, y, useMask=False) 4115 DrawBitmap(bmp, pt, useMask=False) 4116 4117 Draw a bitmap on the device context at the specified 4118 point. If *useMask* is true and the bitmap has a 4119 transparency mask, (or alpha channel on the platforms that 4120 support it) then the bitmap will be drawn transparently. 4121 4122 When drawing a mono-bitmap, the current text foreground 4123 colour will be used to draw the foreground of the bitmap 4124 (all bits set to 1), and the current text background 4125 colour to draw the background (all bits set to 0). 4126 4127 :see: `SetTextForeground`, `SetTextBackground` and `wx.MemoryDC` 4128 """ 4129 4130 def DrawText(self, *args, **kw): 4131 """ 4132 DrawText(text, x, y) 4133 DrawText(text, pt) 4134 4135 Draws a text string at the specified point, using the 4136 current text font, and the current text foreground and 4137 background colours. 4138 4139 The coordinates refer to the top-left corner of the 4140 rectangle bounding the string. See `wx.DC.GetTextExtent` 4141 for how to get the dimensions of a text string, which can 4142 be used to position the text more precisely, (you will 4143 need to use a real DC with GetTextExtent as wx.PseudoDC 4144 does not implement it.) 4145 4146 **NOTE**: under wxGTK the current logical function is used 4147 *by this function but it is ignored by wxMSW. Thus, you 4148 *should avoid using logical functions with this function 4149 *in portable programs.", " 4150 4151 :see: `DrawRotatedText` 4152 """ 4153 4154 def DrawRotatedText(self, *args, **kw): 4155 """ 4156 DrawRotatedText(text, x, y, angle) 4157 DrawRotatedText(text, pt, angle) 4158 4159 Draws the text rotated by *angle* degrees, if supported by the 4160 platform. 4161 """ 4162 4163 def DrawLabel(self, *args, **kw): 4164 """ 4165 DrawLabel(text, rect, alignment=wx.ALIGN_LEFT|wx.ALIGN_TOP, indexAccel=-1) 4166 DrawLabel(text, image, rect, alignment=wx.ALIGN_LEFT|wx.ALIGN_TOP, indexAccel=-1) 4167 4168 Draw *text* within the specified rectangle, abiding by the 4169 alignment flags. Will additionally emphasize the 4170 character at *indexAccel* if it is not -1. 4171 """ 4172 4173 def Clear(self): 4174 """ 4175 Clear() 4176 4177 Clears the device context using the current background brush. 4178 """ 4179 4180 def SetFont(self, font): 4181 """ 4182 SetFont(font) 4183 4184 Sets the current font for the DC. It must be a valid font, in 4185 particular you should not pass ``wx.NullFont`` to this method. 4186 4187 :see: `wx.Font` 4188 """ 4189 4190 def SetPen(self, pen): 4191 """ 4192 SetPen(pen) 4193 4194 Sets the current pen for the DC. 4195 4196 If the argument is ``wx.NullPen``, the current pen is selected out of 4197 the 4198 device context, and the original pen restored. 4199 4200 :see: `wx.Pen` 4201 """ 4202 4203 def SetBrush(self, brush): 4204 """ 4205 SetBrush(brush) 4206 4207 Sets the current brush for the DC. 4208 4209 If the argument is ``wx.NullBrush``, the current brush is selected out 4210 of the device context, and the original brush restored, allowing the 4211 current brush to be destroyed safely. 4212 4213 :see: `wx.Brush` 4214 """ 4215 4216 def SetBackground(self, brush): 4217 """ 4218 SetBackground(brush) 4219 4220 Sets the current background brush for the DC. 4221 """ 4222 4223 def SetBackgroundMode(self, mode): 4224 """ 4225 SetBackgroundMode(mode) 4226 4227 The *mode* parameter may be one of ``wx.SOLID`` and 4228 ``wx.TRANSPARENT``. This setting determines whether text 4229 will be drawn with a background colour or not. 4230 """ 4231 4232 def SetTextForeground(self, colour): 4233 """ 4234 SetTextForeground(colour) 4235 4236 Sets the current text foreground colour for the DC. 4237 """ 4238 4239 def SetTextBackground(self, colour): 4240 """ 4241 SetTextBackground(colour) 4242 4243 Sets the current text background colour for the DC. 4244 """ 4245 4246 def SetLogicalFunction(self, function): 4247 """ 4248 SetLogicalFunction(function) 4249 4250 Sets the current logical function for the device context. This 4251 determines how a source pixel (from a pen or brush colour, combines 4252 with a destination pixel in the current device context. 4253 4254 The possible values and their meaning in terms of source and 4255 destination pixel values are defined in the 4256 :ref:`wx.RasterOperationMode` 4257 enumeration. 4258 4259 The default is wx.COPY, which simply draws with the current 4260 colour. The others combine the current colour and the background using 4261 a logical operation. wx.INVERT is commonly used for drawing rubber 4262 bands or moving outlines, since drawing twice reverts to the original 4263 colour. 4264 """ 4265 4266 def DrawLines(self, points, xoffset=0, yoffset=0): 4267 """ 4268 DrawLines(points, xoffset=0, yoffset=0) 4269 4270 Draws lines using a sequence of `wx.Point` objects, adding the 4271 optional offset coordinate. The current pen is used for drawing the 4272 lines. 4273 """ 4274 4275 def DrawPolygon(self, points, xoffset=0, yoffset=0, fillStyle=wx.ODDEVEN_RULE): 4276 """ 4277 DrawPolygon(points, xoffset=0, yoffset=0, fillStyle=wx.ODDEVEN_RULE) 4278 4279 Draws a filled polygon using a sequence of `wx.Point` objects, adding 4280 the optional offset coordinate. The last argument specifies the fill 4281 rule: ``wx.ODDEVEN_RULE`` (the default) or ``wx.WINDING_RULE``. 4282 4283 The current pen is used for drawing the outline, and the current brush 4284 for filling the shape. Using a transparent brush suppresses 4285 filling. Note that wxWidgets automatically closes the first and last 4286 points. 4287 """ 4288 4289 def DrawSpline(self, points): 4290 """ 4291 DrawSpline(points) 4292 4293 Draws a spline between all given control points, (a list of `wx.Point` 4294 objects) using the current pen. The spline is drawn using a series of 4295 lines, using an algorithm taken from the X drawing program 'XFIG'. 4296 """ 4297 4298 BeginDrawing = wx.deprecated(lambda *args: None, 'BeginDrawing has been removed.') 4299 EndDrawing = wx.deprecated(lambda *args: None, 'EndDrawing has been removed.') 4300 FloodFillPoint = wx.deprecated(FloodFill, 'Use FloodFill instead.') 4301 DrawLinePoint = wx.deprecated(DrawLine, 'Use DrawLine instead.') 4302 CrossHairPoint = wx.deprecated(CrossHair, 'Use CrossHair instead.') 4303 DrawArcPoint = wx.deprecated(DrawArc, 'Use DrawArc instead.') 4304 DrawCheckMarkRect = wx.deprecated(DrawCheckMark, 'Use DrawArc instead.') 4305 DrawEllipticArcPointSize = wx.deprecated(DrawEllipticArc, 'Use DrawEllipticArc instead.') 4306 DrawPointPoint = wx.deprecated(DrawPoint, 'Use DrawPoint instead.') 4307 DrawRectangleRect = wx.deprecated(DrawRectangle, 'Use DrawRectangle instead.') 4308 DrawRectanglePointSize = wx.deprecated(DrawRectangle, 'Use DrawRectangle instead.') 4309 DrawRoundedRectangleRect = wx.deprecated(DrawRoundedRectangle, 'Use DrawRectangle instead.') 4310 DrawRoundedRectanglePointSize = wx.deprecated(DrawRoundedRectangle, 'Use DrawRectangle instead.') 4311 DrawCirclePoint = wx.deprecated(DrawCircle, 'Use DrawCircle instead.') 4312 DrawEllipseRect = wx.deprecated(DrawEllipse, 'Use DrawEllipse instead.') 4313 DrawEllipsePointSize = wx.deprecated(DrawEllipse, 'Use DrawEllipse instead.') 4314 DrawIconPoint = wx.deprecated(DrawIcon, 'Use DrawIcon instead.') 4315 DrawBitmapPoint = wx.deprecated(DrawBitmap, 'Use DrawBitmap instead.') 4316 DrawTextPoint = wx.deprecated(DrawText, 'Use DrawText instead.') 4317 DrawRotatedTextPoint = wx.deprecated(DrawRotatedText, 'Use DrawRotatedText instead.') 4318 DrawImageLabel = wx.deprecated(DrawLabel, 'Use DrawLabel instead.') 4319 Len = property(None, None) 4320# end of class PseudoDC 4321 4322#-- end-pseudodc --# 4323#-- begin-propdlg --# 4324PROPSHEET_DEFAULT = 0 4325PROPSHEET_NOTEBOOK = 0 4326PROPSHEET_TOOLBOOK = 0 4327PROPSHEET_CHOICEBOOK = 0 4328PROPSHEET_LISTBOOK = 0 4329PROPSHEET_BUTTONTOOLBOOK = 0 4330PROPSHEET_TREEBOOK = 0 4331PROPSHEET_SHRINKTOFIT = 0 4332 4333class PropertySheetDialog(wx.Dialog): 4334 """ 4335 PropertySheetDialog() 4336 PropertySheetDialog(parent, id=wx.ID_ANY, title=wx.EmptyString, pos=wx.DefaultPosition, size=wx.DefaultSize, style=wx.DEFAULT_DIALOG_STYLE, name=wx.DialogNameStr) 4337 4338 This class represents a property sheet dialog: a tabbed dialog for 4339 showing settings. 4340 """ 4341 4342 def __init__(self, *args, **kw): 4343 """ 4344 PropertySheetDialog() 4345 PropertySheetDialog(parent, id=wx.ID_ANY, title=wx.EmptyString, pos=wx.DefaultPosition, size=wx.DefaultSize, style=wx.DEFAULT_DIALOG_STYLE, name=wx.DialogNameStr) 4346 4347 This class represents a property sheet dialog: a tabbed dialog for 4348 showing settings. 4349 """ 4350 4351 def AddBookCtrl(self, sizer): 4352 """ 4353 AddBookCtrl(sizer) 4354 4355 Override this if you wish to add the book control in a way different 4356 from the standard way (for example, using different spacing). 4357 """ 4358 4359 def Create(self, parent, id=wx.ID_ANY, title=wx.EmptyString, pos=wx.DefaultPosition, size=wx.DefaultSize, style=wx.DEFAULT_DIALOG_STYLE, name=wx.DialogNameStr): 4360 """ 4361 Create(parent, id=wx.ID_ANY, title=wx.EmptyString, pos=wx.DefaultPosition, size=wx.DefaultSize, style=wx.DEFAULT_DIALOG_STYLE, name=wx.DialogNameStr) -> bool 4362 4363 Call this from your own Create function, before adding buttons and 4364 pages. 4365 """ 4366 4367 def CreateBookCtrl(self): 4368 """ 4369 CreateBookCtrl() -> wx.BookCtrlBase 4370 4371 Override this if you wish to create a different kind of book control; 4372 by default, the value passed to SetSheetStyle() is used to determine 4373 the control. 4374 """ 4375 4376 def CreateButtons(self, flags=wx.OK|wx.CANCEL): 4377 """ 4378 CreateButtons(flags=wx.OK|wx.CANCEL) 4379 4380 Call this to create the buttons for the dialog. 4381 """ 4382 4383 def GetBookCtrl(self): 4384 """ 4385 GetBookCtrl() -> wx.BookCtrlBase 4386 4387 Returns the book control that will contain your settings pages. 4388 """ 4389 4390 def GetInnerSizer(self): 4391 """ 4392 GetInnerSizer() -> wx.Sizer 4393 4394 Returns the inner sizer that contains the book control and button 4395 sizer. 4396 """ 4397 4398 def SetInnerSizer(self, sizer): 4399 """ 4400 SetInnerSizer(sizer) 4401 4402 Set the inner sizer that contains the book control and button sizer. 4403 """ 4404 4405 def GetSheetStyle(self): 4406 """ 4407 GetSheetStyle() -> long 4408 4409 Returns the sheet style. 4410 """ 4411 4412 def LayoutDialog(self, centreFlags=wx.BOTH): 4413 """ 4414 LayoutDialog(centreFlags=wx.BOTH) 4415 4416 Call this to lay out the dialog. 4417 """ 4418 4419 def SetBookCtrl(self, bookCtrl): 4420 """ 4421 SetBookCtrl(bookCtrl) 4422 4423 Sets the book control used for the dialog. 4424 """ 4425 4426 def SetSheetStyle(self, style): 4427 """ 4428 SetSheetStyle(style) 4429 4430 You can customize the look and feel of the dialog by setting the sheet 4431 style. 4432 """ 4433 4434 def SetSheetOuterBorder(self, border): 4435 """ 4436 SetSheetOuterBorder(border) 4437 4438 Set the border around the whole dialog. 4439 """ 4440 4441 def GetSheetOuterBorder(self): 4442 """ 4443 GetSheetOuterBorder() -> int 4444 4445 Returns the border around the whole dialog. 4446 """ 4447 4448 def SetSheetInnerBorder(self, border): 4449 """ 4450 SetSheetInnerBorder(border) 4451 4452 Set the border around the book control only. 4453 """ 4454 4455 def GetSheetInnerBorder(self): 4456 """ 4457 GetSheetInnerBorder() -> int 4458 4459 Returns the border around the book control only. 4460 """ 4461 4462 def GetContentWindow(self): 4463 """ 4464 GetContentWindow() -> wx.Window 4465 4466 Override this to return a window containing the main content of the 4467 dialog. 4468 """ 4469 4470 @staticmethod 4471 def GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL): 4472 """ 4473 GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) -> wx.VisualAttributes 4474 """ 4475 BookCtrl = property(None, None) 4476 ContentWindow = property(None, None) 4477 InnerSizer = property(None, None) 4478 SheetInnerBorder = property(None, None) 4479 SheetOuterBorder = property(None, None) 4480 SheetStyle = property(None, None) 4481# end of class PropertySheetDialog 4482 4483#-- end-propdlg --# 4484