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.ribbon` module contains a set of classes for writing a ribbon-based user interface. 22 23At the most generic level, this is a combination of a tab control with a 24toolbar. At a more functional level, it is similar to the user interface 25present in recent versions of Microsoft Office and in Windows 10. 26""" 27#-- begin-_ribbon --# 28 29import wx 30#-- end-_ribbon --# 31#-- begin-ribbon_control --# 32 33class RibbonControl(wx.Control): 34 """ 35 RibbonControl() 36 RibbonControl(parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0, validator=wx.DefaultValidator, name=wx.ControlNameStr) 37 38 wxRibbonControl serves as a base class for all controls which share 39 the ribbon characteristics of having a ribbon art provider, and 40 (optionally) non-continuous resizing. 41 """ 42 43 def __init__(self, *args, **kw): 44 """ 45 RibbonControl() 46 RibbonControl(parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0, validator=wx.DefaultValidator, name=wx.ControlNameStr) 47 48 wxRibbonControl serves as a base class for all controls which share 49 the ribbon characteristics of having a ribbon art provider, and 50 (optionally) non-continuous resizing. 51 """ 52 53 def SetArtProvider(self, art): 54 """ 55 SetArtProvider(art) 56 57 Set the art provider to be used. 58 """ 59 60 def GetArtProvider(self): 61 """ 62 GetArtProvider() -> RibbonArtProvider 63 64 Get the art provider to be used. 65 """ 66 67 def IsSizingContinuous(self): 68 """ 69 IsSizingContinuous() -> bool 70 """ 71 72 def GetNextSmallerSize(self, *args, **kw): 73 """ 74 GetNextSmallerSize(direction) -> wx.Size 75 GetNextSmallerSize(direction, relative_to) -> wx.Size 76 77 If sizing is not continuous, then return a suitable size for the 78 control which is smaller than the current size. 79 """ 80 81 def GetNextLargerSize(self, *args, **kw): 82 """ 83 GetNextLargerSize(direction) -> wx.Size 84 GetNextLargerSize(direction, relative_to) -> wx.Size 85 86 If sizing is not continuous, then return a suitable size for the 87 control which is larger than the current size. 88 """ 89 90 def Realize(self): 91 """ 92 Realize() -> bool 93 94 Perform initial size and layout calculations after children have been 95 added, and/or realize children. 96 """ 97 98 def Realise(self): 99 """ 100 Realise() -> bool 101 102 Alias for Realize(). 103 """ 104 105 def GetAncestorRibbonBar(self): 106 """ 107 GetAncestorRibbonBar() -> RibbonBar 108 109 Get the first ancestor which is a wxRibbonBar (or derived) or NULL if 110 not having such parent. 111 """ 112 113 def GetBestSizeForParentSize(self, parentSize): 114 """ 115 GetBestSizeForParentSize(parentSize) -> wx.Size 116 117 Finds the best width and height given the parent's width and height. 118 """ 119 120 @staticmethod 121 def GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL): 122 """ 123 GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) -> wx.VisualAttributes 124 """ 125 AncestorRibbonBar = property(None, None) 126 ArtProvider = property(None, None) 127 128 def DoGetNextSmallerSize(self, direction, relative_to): 129 """ 130 DoGetNextSmallerSize(direction, relative_to) -> wx.Size 131 132 Implementation of GetNextSmallerSize(). 133 """ 134 135 def DoGetNextLargerSize(self, direction, relative_to): 136 """ 137 DoGetNextLargerSize(direction, relative_to) -> wx.Size 138 139 Implementation of GetNextLargerSize(). 140 """ 141# end of class RibbonControl 142 143#-- end-ribbon_control --# 144#-- begin-ribbon_page --# 145 146class RibbonPage(RibbonControl): 147 """ 148 RibbonPage() 149 RibbonPage(parent, id=wx.ID_ANY, label=wx.EmptyString, icon=wx.NullBitmap, style=0) 150 151 Container for related ribbon panels, and a tab within a ribbon bar. 152 """ 153 154 def __init__(self, *args, **kw): 155 """ 156 RibbonPage() 157 RibbonPage(parent, id=wx.ID_ANY, label=wx.EmptyString, icon=wx.NullBitmap, style=0) 158 159 Container for related ribbon panels, and a tab within a ribbon bar. 160 """ 161 162 def Create(self, parent, id=wx.ID_ANY, label=wx.EmptyString, icon=wx.NullBitmap, style=0): 163 """ 164 Create(parent, id=wx.ID_ANY, label=wx.EmptyString, icon=wx.NullBitmap, style=0) -> bool 165 166 Create a ribbon page in two-step ribbon page construction. 167 """ 168 169 def SetArtProvider(self, art): 170 """ 171 SetArtProvider(art) 172 173 Set the art provider to be used. 174 """ 175 176 def GetIcon(self): 177 """ 178 GetIcon() -> wx.Bitmap 179 180 Get the icon used for the page in the ribbon bar tab area (only 181 displayed if the ribbon bar is actually showing icons). 182 """ 183 184 def SetSizeWithScrollButtonAdjustment(self, x, y, width, height): 185 """ 186 SetSizeWithScrollButtonAdjustment(x, y, width, height) 187 188 Set the size of the page and the external scroll buttons (if any). 189 """ 190 191 def AdjustRectToIncludeScrollButtons(self, rect): 192 """ 193 AdjustRectToIncludeScrollButtons(rect) 194 195 Expand a rectangle of the page to include external scroll buttons (if 196 any). 197 """ 198 199 def DismissExpandedPanel(self): 200 """ 201 DismissExpandedPanel() -> bool 202 203 Dismiss the current externally expanded panel, if there is one. 204 """ 205 206 def Realize(self): 207 """ 208 Realize() -> bool 209 210 Perform a full re-layout of all panels on the page. 211 """ 212 213 def ScrollLines(self, lines): 214 """ 215 ScrollLines(lines) -> bool 216 217 Scroll the page by some amount up / down / left / right. 218 """ 219 220 def ScrollPixels(self, pixels): 221 """ 222 ScrollPixels(pixels) -> bool 223 224 Scroll the page by a set number of pixels up / down / left / right. 225 """ 226 227 def ScrollSections(self, sections): 228 """ 229 ScrollSections(sections) -> bool 230 231 Scroll the page by an entire child section. 232 """ 233 234 def GetMajorAxis(self): 235 """ 236 GetMajorAxis() -> Orientation 237 238 Get the direction in which ribbon panels are stacked within the page. 239 """ 240 241 @staticmethod 242 def GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL): 243 """ 244 GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) -> wx.VisualAttributes 245 """ 246 Icon = property(None, None) 247 MajorAxis = property(None, None) 248# end of class RibbonPage 249 250#-- end-ribbon_page --# 251#-- begin-ribbon_panel --# 252RIBBON_PANEL_NO_AUTO_MINIMISE = 0 253RIBBON_PANEL_EXT_BUTTON = 0 254RIBBON_PANEL_MINIMISE_BUTTON = 0 255RIBBON_PANEL_STRETCH = 0 256RIBBON_PANEL_FLEXIBLE = 0 257RIBBON_PANEL_DEFAULT_STYLE = 0 258wxEVT_RIBBONPANEL_EXTBUTTON_ACTIVATED = 0 259 260class RibbonPanel(RibbonControl): 261 """ 262 RibbonPanel() 263 RibbonPanel(parent, id=wx.ID_ANY, label=wx.EmptyString, minimised_icon=wx.NullBitmap, pos=wx.DefaultPosition, size=wx.DefaultSize, style=RIBBON_PANEL_DEFAULT_STYLE) 264 265 Serves as a container for a group of (ribbon) controls. 266 """ 267 268 def __init__(self, *args, **kw): 269 """ 270 RibbonPanel() 271 RibbonPanel(parent, id=wx.ID_ANY, label=wx.EmptyString, minimised_icon=wx.NullBitmap, pos=wx.DefaultPosition, size=wx.DefaultSize, style=RIBBON_PANEL_DEFAULT_STYLE) 272 273 Serves as a container for a group of (ribbon) controls. 274 """ 275 276 def Create(self, parent, id=wx.ID_ANY, label=wx.EmptyString, icon=wx.NullBitmap, pos=wx.DefaultPosition, size=wx.DefaultSize, style=RIBBON_PANEL_DEFAULT_STYLE): 277 """ 278 Create(parent, id=wx.ID_ANY, label=wx.EmptyString, icon=wx.NullBitmap, pos=wx.DefaultPosition, size=wx.DefaultSize, style=RIBBON_PANEL_DEFAULT_STYLE) -> bool 279 280 Create a ribbon panel in two-step ribbon panel construction. 281 """ 282 283 def GetMinimisedIcon(self): 284 """ 285 GetMinimisedIcon() -> wx.Bitmap 286 287 Get the bitmap to be used in place of the panel children when it is 288 minimised. 289 """ 290 291 def HasExtButton(self): 292 """ 293 HasExtButton() -> bool 294 295 Test if the panel has an extension button. 296 """ 297 298 def IsMinimised(self, *args, **kw): 299 """ 300 IsMinimised() -> bool 301 IsMinimised(at_size) -> bool 302 303 Query if the panel is currently minimised. 304 """ 305 306 def IsHovered(self): 307 """ 308 IsHovered() -> bool 309 310 Query is the mouse is currently hovered over the panel. 311 """ 312 313 def IsExtButtonHovered(self): 314 """ 315 IsExtButtonHovered() -> bool 316 317 Query if the mouse is currently hovered over the extension button. 318 """ 319 320 def CanAutoMinimise(self): 321 """ 322 CanAutoMinimise() -> bool 323 324 Query if the panel can automatically minimise itself at small sizes. 325 """ 326 327 def ShowExpanded(self): 328 """ 329 ShowExpanded() -> bool 330 331 Show the panel externally expanded. 332 """ 333 334 def HideExpanded(self): 335 """ 336 HideExpanded() -> bool 337 338 Hide the panel's external expansion. 339 """ 340 341 def SetArtProvider(self, art): 342 """ 343 SetArtProvider(art) 344 345 Set the art provider to be used. 346 """ 347 348 def Realize(self): 349 """ 350 Realize() -> bool 351 352 Realize all children of the panel. 353 """ 354 355 def GetExpandedDummy(self): 356 """ 357 GetExpandedDummy() -> RibbonPanel 358 359 Get the dummy panel of an expanded panel. 360 """ 361 362 def GetExpandedPanel(self): 363 """ 364 GetExpandedPanel() -> RibbonPanel 365 366 Get the expanded panel of a dummy panel. 367 """ 368 369 @staticmethod 370 def GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL): 371 """ 372 GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) -> wx.VisualAttributes 373 """ 374 ExpandedDummy = property(None, None) 375 ExpandedPanel = property(None, None) 376 MinimisedIcon = property(None, None) 377# end of class RibbonPanel 378 379 380class RibbonPanelEvent(wx.CommandEvent): 381 """ 382 RibbonPanelEvent(command_type=wx.wxEVT_NULL, win_id=0, panel=None) 383 384 Event used to indicate various actions relating to a wxRibbonPanel. 385 """ 386 387 def __init__(self, command_type=wx.wxEVT_NULL, win_id=0, panel=None): 388 """ 389 RibbonPanelEvent(command_type=wx.wxEVT_NULL, win_id=0, panel=None) 390 391 Event used to indicate various actions relating to a wxRibbonPanel. 392 """ 393 394 def GetPanel(self): 395 """ 396 GetPanel() -> RibbonPanel 397 398 Returns the panel relating to this event. 399 """ 400 401 def SetPanel(self, page): 402 """ 403 SetPanel(page) 404 405 Sets the page relating to this event. 406 """ 407 Panel = property(None, None) 408# end of class RibbonPanelEvent 409 410 411EVT_RIBBONPANEL_EXTBUTTON_ACTIVATED = wx.PyEventBinder(wxEVT_RIBBONPANEL_EXTBUTTON_ACTIVATED, 1) 412#-- end-ribbon_panel --# 413#-- begin-ribbon_bar --# 414RIBBON_BAR_SHOW_PAGE_LABELS = 0 415RIBBON_BAR_SHOW_PAGE_ICONS = 0 416RIBBON_BAR_FLOW_HORIZONTAL = 0 417RIBBON_BAR_FLOW_VERTICAL = 0 418RIBBON_BAR_SHOW_PANEL_EXT_BUTTONS = 0 419RIBBON_BAR_SHOW_PANEL_MINIMISE_BUTTONS = 0 420RIBBON_BAR_ALWAYS_SHOW_TABS = 0 421RIBBON_BAR_SHOW_TOGGLE_BUTTON = 0 422RIBBON_BAR_SHOW_HELP_BUTTON = 0 423RIBBON_BAR_DEFAULT_STYLE = 0 424RIBBON_BAR_FOLDBAR_STYLE = 0 425RIBBON_BAR_PINNED = 0 426RIBBON_BAR_MINIMIZED = 0 427RIBBON_BAR_EXPANDED = 0 428wxEVT_RIBBONBAR_PAGE_CHANGED = 0 429wxEVT_RIBBONBAR_PAGE_CHANGING = 0 430wxEVT_RIBBONBAR_TAB_MIDDLE_DOWN = 0 431wxEVT_RIBBONBAR_TAB_MIDDLE_UP = 0 432wxEVT_RIBBONBAR_TAB_RIGHT_DOWN = 0 433wxEVT_RIBBONBAR_TAB_RIGHT_UP = 0 434wxEVT_RIBBONBAR_TAB_LEFT_DCLICK = 0 435wxEVT_RIBBONBAR_TOGGLED = 0 436wxEVT_RIBBONBAR_HELP_CLICK = 0 437 438class RibbonBarEvent(wx.NotifyEvent): 439 """ 440 RibbonBarEvent(command_type=wx.wxEVT_NULL, win_id=0, page=None) 441 442 Event used to indicate various actions relating to a wxRibbonBar. 443 """ 444 445 def __init__(self, command_type=wx.wxEVT_NULL, win_id=0, page=None): 446 """ 447 RibbonBarEvent(command_type=wx.wxEVT_NULL, win_id=0, page=None) 448 449 Event used to indicate various actions relating to a wxRibbonBar. 450 """ 451 452 def GetPage(self): 453 """ 454 GetPage() -> RibbonPage 455 456 Returns the page being changed to, or being clicked on. 457 """ 458 459 def SetPage(self, page): 460 """ 461 SetPage(page) 462 463 Sets the page relating to this event. 464 """ 465 Page = property(None, None) 466# end of class RibbonBarEvent 467 468 469class RibbonPageTabInfo(object): 470 """ 471 472 """ 473 rect = property(None, None) 474 page = property(None, None) 475 ideal_width = property(None, None) 476 small_begin_need_separator_width = property(None, None) 477 small_must_have_separator_width = property(None, None) 478 minimum_width = property(None, None) 479 active = property(None, None) 480 hovered = property(None, None) 481 highlight = property(None, None) 482 shown = property(None, None) 483# end of class RibbonPageTabInfo 484 485 486class RibbonBar(RibbonControl): 487 """ 488 RibbonBar() 489 RibbonBar(parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, style=RIBBON_BAR_DEFAULT_STYLE) 490 491 Top-level control in a ribbon user interface. 492 """ 493 494 def __init__(self, *args, **kw): 495 """ 496 RibbonBar() 497 RibbonBar(parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, style=RIBBON_BAR_DEFAULT_STYLE) 498 499 Top-level control in a ribbon user interface. 500 """ 501 502 def Create(self, parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, style=RIBBON_BAR_DEFAULT_STYLE): 503 """ 504 Create(parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, style=RIBBON_BAR_DEFAULT_STYLE) -> bool 505 506 Create a ribbon bar in two-step ribbon bar construction. 507 """ 508 509 def SetTabCtrlMargins(self, left, right): 510 """ 511 SetTabCtrlMargins(left, right) 512 513 Set the margin widths (in pixels) on the left and right sides of the 514 tab bar region of the ribbon bar. 515 """ 516 517 def SetArtProvider(self, art): 518 """ 519 SetArtProvider(art) 520 521 Set the art provider to be used be the ribbon bar. 522 """ 523 524 def SetActivePage(self, *args, **kw): 525 """ 526 SetActivePage(page) -> bool 527 SetActivePage(page) -> bool 528 529 Set the active page by index, without triggering any events. 530 """ 531 532 def GetActivePage(self): 533 """ 534 GetActivePage() -> int 535 536 Get the index of the active page. 537 """ 538 539 def GetPage(self, n): 540 """ 541 GetPage(n) -> RibbonPage 542 543 Get a page by index. 544 """ 545 546 def GetPageCount(self): 547 """ 548 GetPageCount() -> size_t 549 550 Get the number of pages in this bar. 551 """ 552 553 def DismissExpandedPanel(self): 554 """ 555 DismissExpandedPanel() -> bool 556 557 Dismiss the expanded panel of the currently active page. 558 """ 559 560 def GetPageNumber(self, page): 561 """ 562 GetPageNumber(page) -> int 563 564 Returns the number for a given ribbon bar page. 565 """ 566 567 def DeletePage(self, n): 568 """ 569 DeletePage(n) 570 571 Delete a single page from this ribbon bar. 572 """ 573 574 def ClearPages(self): 575 """ 576 ClearPages() 577 578 Delete all pages from the ribbon bar. 579 """ 580 581 def IsPageShown(self, page): 582 """ 583 IsPageShown(page) -> bool 584 585 Indicates whether the tab for the given page is shown to the user or 586 not. 587 """ 588 589 def ShowPage(self, page, show_tab=True): 590 """ 591 ShowPage(page, show_tab=True) 592 593 Show or hide the tab for a given page. 594 """ 595 596 def HidePage(self, page): 597 """ 598 HidePage(page) 599 600 Hides the tab for a given page. 601 """ 602 603 def IsPageHighlighted(self, page): 604 """ 605 IsPageHighlighted(page) -> bool 606 607 Indicates whether a tab is currently highlighted. 608 """ 609 610 def AddPageHighlight(self, page, highlight=True): 611 """ 612 AddPageHighlight(page, highlight=True) 613 614 Highlight the specified tab. 615 """ 616 617 def RemovePageHighlight(self, page): 618 """ 619 RemovePageHighlight(page) 620 621 Changes a tab to not be highlighted. 622 """ 623 624 def ShowPanels(self, show=True): 625 """ 626 ShowPanels(show=True) 627 628 Shows or hides the panel area of the ribbon bar. 629 """ 630 631 def HidePanels(self): 632 """ 633 HidePanels() 634 635 Hides the panel area of the ribbon bar. 636 """ 637 638 def ArePanelsShown(self): 639 """ 640 ArePanelsShown() -> bool 641 642 Indicates whether the panel area of the ribbon bar is shown. 643 """ 644 645 def Realize(self): 646 """ 647 Realize() -> bool 648 649 Perform initial layout and size calculations of the bar and its 650 children. 651 """ 652 653 @staticmethod 654 def GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL): 655 """ 656 GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) -> wx.VisualAttributes 657 """ 658 ActivePage = property(None, None) 659 PageCount = property(None, None) 660# end of class RibbonBar 661 662 663EVT_RIBBONBAR_PAGE_CHANGED = wx.PyEventBinder(wxEVT_RIBBONBAR_PAGE_CHANGED, 1) 664EVT_RIBBONBAR_PAGE_CHANGING = wx.PyEventBinder(wxEVT_RIBBONBAR_PAGE_CHANGING,1) 665EVT_RIBBONBAR_TAB_MIDDLE_DOWN = wx.PyEventBinder(wxEVT_RIBBONBAR_TAB_MIDDLE_DOWN, 1) 666EVT_RIBBONBAR_TAB_MIDDLE_UP = wx.PyEventBinder(wxEVT_RIBBONBAR_TAB_MIDDLE_UP, 1) 667EVT_RIBBONBAR_TAB_RIGHT_DOWN = wx.PyEventBinder(wxEVT_RIBBONBAR_TAB_RIGHT_DOWN, 1) 668EVT_RIBBONBAR_TAB_RIGHT_UP = wx.PyEventBinder(wxEVT_RIBBONBAR_TAB_RIGHT_UP, 1) 669EVT_RIBBONBAR_TAB_LEFT_DCLICK = wx.PyEventBinder(wxEVT_RIBBONBAR_TAB_LEFT_DCLICK, 1) 670EVT_RIBBONBAR_TOGGLED = wx.PyEventBinder(wxEVT_RIBBONBAR_TOGGLED, 1) 671EVT_RIBBONBAR_HELP_CLICK = wx.PyEventBinder(wxEVT_RIBBONBAR_HELP_CLICK, 1) 672#-- end-ribbon_bar --# 673#-- begin-ribbon_art --# 674RIBBON_ART_TAB_SEPARATION_SIZE = 0 675RIBBON_ART_PAGE_BORDER_LEFT_SIZE = 0 676RIBBON_ART_PAGE_BORDER_TOP_SIZE = 0 677RIBBON_ART_PAGE_BORDER_RIGHT_SIZE = 0 678RIBBON_ART_PAGE_BORDER_BOTTOM_SIZE = 0 679RIBBON_ART_PANEL_X_SEPARATION_SIZE = 0 680RIBBON_ART_PANEL_Y_SEPARATION_SIZE = 0 681RIBBON_ART_TOOL_GROUP_SEPARATION_SIZE = 0 682RIBBON_ART_GALLERY_BITMAP_PADDING_LEFT_SIZE = 0 683RIBBON_ART_GALLERY_BITMAP_PADDING_RIGHT_SIZE = 0 684RIBBON_ART_GALLERY_BITMAP_PADDING_TOP_SIZE = 0 685RIBBON_ART_GALLERY_BITMAP_PADDING_BOTTOM_SIZE = 0 686RIBBON_ART_PANEL_LABEL_FONT = 0 687RIBBON_ART_BUTTON_BAR_LABEL_FONT = 0 688RIBBON_ART_TAB_LABEL_FONT = 0 689RIBBON_ART_BUTTON_BAR_LABEL_COLOUR = 0 690RIBBON_ART_BUTTON_BAR_LABEL_DISABLED_COLOUR = 0 691RIBBON_ART_BUTTON_BAR_HOVER_BORDER_COLOUR = 0 692RIBBON_ART_BUTTON_BAR_HOVER_BACKGROUND_TOP_COLOUR = 0 693RIBBON_ART_BUTTON_BAR_HOVER_BACKGROUND_TOP_GRADIENT_COLOUR = 0 694RIBBON_ART_BUTTON_BAR_HOVER_BACKGROUND_COLOUR = 0 695RIBBON_ART_BUTTON_BAR_HOVER_BACKGROUND_GRADIENT_COLOUR = 0 696RIBBON_ART_BUTTON_BAR_ACTIVE_BORDER_COLOUR = 0 697RIBBON_ART_BUTTON_BAR_ACTIVE_BACKGROUND_TOP_COLOUR = 0 698RIBBON_ART_BUTTON_BAR_ACTIVE_BACKGROUND_TOP_GRADIENT_COLOUR = 0 699RIBBON_ART_BUTTON_BAR_ACTIVE_BACKGROUND_COLOUR = 0 700RIBBON_ART_BUTTON_BAR_ACTIVE_BACKGROUND_GRADIENT_COLOUR = 0 701RIBBON_ART_GALLERY_BORDER_COLOUR = 0 702RIBBON_ART_GALLERY_HOVER_BACKGROUND_COLOUR = 0 703RIBBON_ART_GALLERY_BUTTON_BACKGROUND_COLOUR = 0 704RIBBON_ART_GALLERY_BUTTON_BACKGROUND_GRADIENT_COLOUR = 0 705RIBBON_ART_GALLERY_BUTTON_BACKGROUND_TOP_COLOUR = 0 706RIBBON_ART_GALLERY_BUTTON_FACE_COLOUR = 0 707RIBBON_ART_GALLERY_BUTTON_HOVER_BACKGROUND_COLOUR = 0 708RIBBON_ART_GALLERY_BUTTON_HOVER_BACKGROUND_GRADIENT_COLOUR = 0 709RIBBON_ART_GALLERY_BUTTON_HOVER_BACKGROUND_TOP_COLOUR = 0 710RIBBON_ART_GALLERY_BUTTON_HOVER_FACE_COLOUR = 0 711RIBBON_ART_GALLERY_BUTTON_ACTIVE_BACKGROUND_COLOUR = 0 712RIBBON_ART_GALLERY_BUTTON_ACTIVE_BACKGROUND_GRADIENT_COLOUR = 0 713RIBBON_ART_GALLERY_BUTTON_ACTIVE_BACKGROUND_TOP_COLOUR = 0 714RIBBON_ART_GALLERY_BUTTON_ACTIVE_FACE_COLOUR = 0 715RIBBON_ART_GALLERY_BUTTON_DISABLED_BACKGROUND_COLOUR = 0 716RIBBON_ART_GALLERY_BUTTON_DISABLED_BACKGROUND_GRADIENT_COLOUR = 0 717RIBBON_ART_GALLERY_BUTTON_DISABLED_BACKGROUND_TOP_COLOUR = 0 718RIBBON_ART_GALLERY_BUTTON_DISABLED_FACE_COLOUR = 0 719RIBBON_ART_GALLERY_ITEM_BORDER_COLOUR = 0 720RIBBON_ART_TAB_LABEL_COLOUR = 0 721RIBBON_ART_TAB_SEPARATOR_COLOUR = 0 722RIBBON_ART_TAB_SEPARATOR_GRADIENT_COLOUR = 0 723RIBBON_ART_TAB_CTRL_BACKGROUND_COLOUR = 0 724RIBBON_ART_TAB_CTRL_BACKGROUND_GRADIENT_COLOUR = 0 725RIBBON_ART_TAB_HOVER_BACKGROUND_TOP_COLOUR = 0 726RIBBON_ART_TAB_HOVER_BACKGROUND_TOP_GRADIENT_COLOUR = 0 727RIBBON_ART_TAB_HOVER_BACKGROUND_COLOUR = 0 728RIBBON_ART_TAB_HOVER_BACKGROUND_GRADIENT_COLOUR = 0 729RIBBON_ART_TAB_ACTIVE_BACKGROUND_TOP_COLOUR = 0 730RIBBON_ART_TAB_ACTIVE_BACKGROUND_TOP_GRADIENT_COLOUR = 0 731RIBBON_ART_TAB_ACTIVE_BACKGROUND_COLOUR = 0 732RIBBON_ART_TAB_ACTIVE_BACKGROUND_GRADIENT_COLOUR = 0 733RIBBON_ART_TAB_BORDER_COLOUR = 0 734RIBBON_ART_PANEL_BORDER_COLOUR = 0 735RIBBON_ART_PANEL_BORDER_GRADIENT_COLOUR = 0 736RIBBON_ART_PANEL_MINIMISED_BORDER_COLOUR = 0 737RIBBON_ART_PANEL_MINIMISED_BORDER_GRADIENT_COLOUR = 0 738RIBBON_ART_PANEL_LABEL_BACKGROUND_COLOUR = 0 739RIBBON_ART_PANEL_LABEL_BACKGROUND_GRADIENT_COLOUR = 0 740RIBBON_ART_PANEL_LABEL_COLOUR = 0 741RIBBON_ART_PANEL_HOVER_LABEL_BACKGROUND_COLOUR = 0 742RIBBON_ART_PANEL_HOVER_LABEL_BACKGROUND_GRADIENT_COLOUR = 0 743RIBBON_ART_PANEL_HOVER_LABEL_COLOUR = 0 744RIBBON_ART_PANEL_MINIMISED_LABEL_COLOUR = 0 745RIBBON_ART_PANEL_ACTIVE_BACKGROUND_TOP_COLOUR = 0 746RIBBON_ART_PANEL_ACTIVE_BACKGROUND_TOP_GRADIENT_COLOUR = 0 747RIBBON_ART_PANEL_ACTIVE_BACKGROUND_COLOUR = 0 748RIBBON_ART_PANEL_ACTIVE_BACKGROUND_GRADIENT_COLOUR = 0 749RIBBON_ART_PAGE_BORDER_COLOUR = 0 750RIBBON_ART_PAGE_BACKGROUND_TOP_COLOUR = 0 751RIBBON_ART_PAGE_BACKGROUND_TOP_GRADIENT_COLOUR = 0 752RIBBON_ART_PAGE_BACKGROUND_COLOUR = 0 753RIBBON_ART_PAGE_BACKGROUND_GRADIENT_COLOUR = 0 754RIBBON_ART_PAGE_HOVER_BACKGROUND_TOP_COLOUR = 0 755RIBBON_ART_PAGE_HOVER_BACKGROUND_TOP_GRADIENT_COLOUR = 0 756RIBBON_ART_PAGE_HOVER_BACKGROUND_COLOUR = 0 757RIBBON_ART_PAGE_HOVER_BACKGROUND_GRADIENT_COLOUR = 0 758RIBBON_ART_TOOLBAR_BORDER_COLOUR = 0 759RIBBON_ART_TOOLBAR_HOVER_BORDER_COLOUR = 0 760RIBBON_ART_TOOLBAR_FACE_COLOUR = 0 761RIBBON_ART_TOOL_BACKGROUND_TOP_COLOUR = 0 762RIBBON_ART_TOOL_BACKGROUND_TOP_GRADIENT_COLOUR = 0 763RIBBON_ART_TOOL_BACKGROUND_COLOUR = 0 764RIBBON_ART_TOOL_BACKGROUND_GRADIENT_COLOUR = 0 765RIBBON_ART_TOOL_HOVER_BACKGROUND_TOP_COLOUR = 0 766RIBBON_ART_TOOL_HOVER_BACKGROUND_TOP_GRADIENT_COLOUR = 0 767RIBBON_ART_TOOL_HOVER_BACKGROUND_COLOUR = 0 768RIBBON_ART_TOOL_HOVER_BACKGROUND_GRADIENT_COLOUR = 0 769RIBBON_ART_TOOL_ACTIVE_BACKGROUND_TOP_COLOUR = 0 770RIBBON_ART_TOOL_ACTIVE_BACKGROUND_TOP_GRADIENT_COLOUR = 0 771RIBBON_ART_TOOL_ACTIVE_BACKGROUND_COLOUR = 0 772RIBBON_ART_TOOL_ACTIVE_BACKGROUND_GRADIENT_COLOUR = 0 773RIBBON_SCROLL_BTN_LEFT = 0 774RIBBON_SCROLL_BTN_RIGHT = 0 775RIBBON_SCROLL_BTN_UP = 0 776RIBBON_SCROLL_BTN_DOWN = 0 777RIBBON_SCROLL_BTN_DIRECTION_MASK = 0 778RIBBON_SCROLL_BTN_NORMAL = 0 779RIBBON_SCROLL_BTN_HOVERED = 0 780RIBBON_SCROLL_BTN_ACTIVE = 0 781RIBBON_SCROLL_BTN_STATE_MASK = 0 782RIBBON_SCROLL_BTN_FOR_OTHER = 0 783RIBBON_SCROLL_BTN_FOR_TABS = 0 784RIBBON_SCROLL_BTN_FOR_PAGE = 0 785RIBBON_SCROLL_BTN_FOR_MASK = 0 786RIBBON_BUTTON_NORMAL = 0 787RIBBON_BUTTON_DROPDOWN = 0 788RIBBON_BUTTON_HYBRID = 0 789RIBBON_BUTTON_TOGGLE = 0 790 791class RibbonArtProvider(object): 792 """ 793 RibbonArtProvider() 794 795 wxRibbonArtProvider is responsible for drawing all the components of 796 the ribbon interface. 797 """ 798 799 def __init__(self): 800 """ 801 RibbonArtProvider() 802 803 wxRibbonArtProvider is responsible for drawing all the components of 804 the ribbon interface. 805 """ 806 807 def Clone(self): 808 """ 809 Clone() -> RibbonArtProvider 810 811 Create a new art provider which is a clone of this one. 812 """ 813 814 def SetFlags(self, flags): 815 """ 816 SetFlags(flags) 817 818 Set the style flags. 819 """ 820 821 def GetFlags(self): 822 """ 823 GetFlags() -> long 824 825 Get the previously set style flags. 826 """ 827 828 def GetMetric(self, id): 829 """ 830 GetMetric(id) -> int 831 832 Get the value of a certain integer setting. 833 """ 834 835 def SetMetric(self, id, new_val): 836 """ 837 SetMetric(id, new_val) 838 839 Set the value of a certain integer setting to the value new_val. 840 """ 841 842 def SetFont(self, id, font): 843 """ 844 SetFont(id, font) 845 846 Set the value of a certain font setting to the value font. 847 """ 848 849 def GetFont(self, id): 850 """ 851 GetFont(id) -> wx.Font 852 853 Get the value of a certain font setting. 854 """ 855 856 def GetColour(self, id): 857 """ 858 GetColour(id) -> wx.Colour 859 860 Get the value of a certain colour setting. 861 """ 862 863 def SetColour(self, id, colour): 864 """ 865 SetColour(id, colour) 866 867 Set the value of a certain colour setting to the value colour. 868 """ 869 870 def GetColor(self, id): 871 """ 872 GetColor(id) -> wx.Colour 873 """ 874 875 def SetColor(self, id, color): 876 """ 877 SetColor(id, color) 878 """ 879 880 def GetColourScheme(self): 881 """ 882 GetColourScheme() -> (primary, secondary, tertiary) 883 884 Get the current colour scheme. 885 """ 886 887 def SetColourScheme(self, primary, secondary, tertiary): 888 """ 889 SetColourScheme(primary, secondary, tertiary) 890 891 Set all applicable colour settings from a few base colours. 892 """ 893 894 def DrawTabCtrlBackground(self, dc, wnd, rect): 895 """ 896 DrawTabCtrlBackground(dc, wnd, rect) 897 898 Draw the background of the tab region of a ribbon bar. 899 """ 900 901 def DrawTab(self, dc, wnd, tab): 902 """ 903 DrawTab(dc, wnd, tab) 904 905 Draw a single tab in the tab region of a ribbon bar. 906 """ 907 908 def DrawTabSeparator(self, dc, wnd, rect, visibility): 909 """ 910 DrawTabSeparator(dc, wnd, rect, visibility) 911 912 Draw a separator between two tabs in a ribbon bar. 913 """ 914 915 def DrawPageBackground(self, dc, wnd, rect): 916 """ 917 DrawPageBackground(dc, wnd, rect) 918 919 Draw the background of a ribbon page. 920 """ 921 922 def DrawScrollButton(self, dc, wnd, rect, style): 923 """ 924 DrawScrollButton(dc, wnd, rect, style) 925 926 Draw a ribbon-style scroll button. 927 """ 928 929 def DrawPanelBackground(self, dc, wnd, rect): 930 """ 931 DrawPanelBackground(dc, wnd, rect) 932 933 Draw the background and chrome for a ribbon panel. 934 """ 935 936 def DrawGalleryBackground(self, dc, wnd, rect): 937 """ 938 DrawGalleryBackground(dc, wnd, rect) 939 940 Draw the background and chrome for a wxRibbonGallery control. 941 """ 942 943 def DrawGalleryItemBackground(self, dc, wnd, rect, item): 944 """ 945 DrawGalleryItemBackground(dc, wnd, rect, item) 946 947 Draw the background of a single item in a wxRibbonGallery control. 948 """ 949 950 def DrawMinimisedPanel(self, dc, wnd, rect, bitmap): 951 """ 952 DrawMinimisedPanel(dc, wnd, rect, bitmap) 953 954 Draw a minimised ribbon panel. 955 """ 956 957 def DrawButtonBarBackground(self, dc, wnd, rect): 958 """ 959 DrawButtonBarBackground(dc, wnd, rect) 960 961 Draw the background for a wxRibbonButtonBar control. 962 """ 963 964 def DrawButtonBarButton(self, dc, wnd, rect, kind, state, label, bitmap_large, bitmap_small): 965 """ 966 DrawButtonBarButton(dc, wnd, rect, kind, state, label, bitmap_large, bitmap_small) 967 968 Draw a single button for a wxRibbonButtonBar control. 969 """ 970 971 def DrawToolBarBackground(self, dc, wnd, rect): 972 """ 973 DrawToolBarBackground(dc, wnd, rect) 974 975 Draw the background for a wxRibbonToolBar control. 976 """ 977 978 def DrawToolGroupBackground(self, dc, wnd, rect): 979 """ 980 DrawToolGroupBackground(dc, wnd, rect) 981 982 Draw the background for a group of tools on a wxRibbonToolBar control. 983 """ 984 985 def DrawTool(self, dc, wnd, rect, bitmap, kind, state): 986 """ 987 DrawTool(dc, wnd, rect, bitmap, kind, state) 988 989 Draw a single tool (for a wxRibbonToolBar control). 990 """ 991 992 def DrawToggleButton(self, dc, wnd, rect, mode): 993 """ 994 DrawToggleButton(dc, wnd, rect, mode) 995 996 Draw toggle button on wxRibbonBar. 997 """ 998 999 def DrawHelpButton(self, dc, wnd, rect): 1000 """ 1001 DrawHelpButton(dc, wnd, rect) 1002 1003 Draw help button on wxRibbonBar. 1004 """ 1005 1006 def GetBarTabWidth(self, dc, wnd, label, bitmap, ideal, small_begin_need_separator, small_must_have_separator, minimum): 1007 """ 1008 GetBarTabWidth(dc, wnd, label, bitmap, ideal, small_begin_need_separator, small_must_have_separator, minimum) 1009 1010 Calculate the ideal and minimum width (in pixels) of a tab in a ribbon 1011 bar. 1012 """ 1013 1014 def GetTabCtrlHeight(self, dc, wnd, pages): 1015 """ 1016 GetTabCtrlHeight(dc, wnd, pages) -> int 1017 1018 Calculate the height (in pixels) of the tab region of a ribbon bar. 1019 """ 1020 1021 def GetScrollButtonMinimumSize(self, dc, wnd, style): 1022 """ 1023 GetScrollButtonMinimumSize(dc, wnd, style) -> wx.Size 1024 1025 Calculate the minimum size (in pixels) of a scroll button. 1026 """ 1027 1028 def GetPanelSize(self, dc, wnd, client_size, client_offset): 1029 """ 1030 GetPanelSize(dc, wnd, client_size, client_offset) -> wx.Size 1031 1032 Calculate the size of a panel for a given client size. 1033 """ 1034 1035 def GetPanelClientSize(self, dc, wnd, size, client_offset): 1036 """ 1037 GetPanelClientSize(dc, wnd, size, client_offset) -> wx.Size 1038 1039 Calculate the client size of a panel for a given overall size. 1040 """ 1041 1042 def GetPanelExtButtonArea(self, dc, wnd, rect): 1043 """ 1044 GetPanelExtButtonArea(dc, wnd, rect) -> wx.Rect 1045 1046 Calculate the position and size of the panel extension button. 1047 """ 1048 1049 def GetGallerySize(self, dc, wnd, client_size): 1050 """ 1051 GetGallerySize(dc, wnd, client_size) -> wx.Size 1052 1053 Calculate the size of a wxRibbonGallery control for a given client 1054 size. 1055 """ 1056 1057 def GetGalleryClientSize(self, dc, wnd, size, client_offset, scroll_up_button, scroll_down_button, extension_button): 1058 """ 1059 GetGalleryClientSize(dc, wnd, size, client_offset, scroll_up_button, scroll_down_button, extension_button) -> wx.Size 1060 1061 Calculate the client size of a wxRibbonGallery control for a given 1062 size. 1063 """ 1064 1065 def GetPageBackgroundRedrawArea(self, dc, wnd, page_old_size, page_new_size): 1066 """ 1067 GetPageBackgroundRedrawArea(dc, wnd, page_old_size, page_new_size) -> wx.Rect 1068 1069 Calculate the portion of a page background which needs to be redrawn 1070 when a page is resized. 1071 """ 1072 1073 def GetButtonBarButtonSize(self, dc, wnd, kind, size, label, bitmap_size_large, bitmap_size_small, button_size, normal_region, dropdown_region): 1074 """ 1075 GetButtonBarButtonSize(dc, wnd, kind, size, label, bitmap_size_large, bitmap_size_small, button_size, normal_region, dropdown_region) -> bool 1076 1077 Calculate the size of a button within a wxRibbonButtonBar. 1078 """ 1079 1080 def GetMinimisedPanelMinimumSize(self, dc, wnd, desired_bitmap_size, expanded_panel_direction): 1081 """ 1082 GetMinimisedPanelMinimumSize(dc, wnd, desired_bitmap_size, expanded_panel_direction) -> wx.Size 1083 1084 Calculate the size of a minimised ribbon panel. 1085 """ 1086 1087 def GetToolSize(self, dc, wnd, bitmap_size, kind, is_first, is_last, dropdown_region): 1088 """ 1089 GetToolSize(dc, wnd, bitmap_size, kind, is_first, is_last, dropdown_region) -> wx.Size 1090 1091 Calculate the size of a tool within a wxRibbonToolBar. 1092 """ 1093 1094 def GetBarToggleButtonArea(self, rect): 1095 """ 1096 GetBarToggleButtonArea(rect) -> wx.Rect 1097 1098 Calculate the position and size of the ribbon's toggle button. 1099 """ 1100 1101 def GetRibbonHelpButtonArea(self, rect): 1102 """ 1103 GetRibbonHelpButtonArea(rect) -> wx.Rect 1104 1105 Calculate the position and size of the ribbon's help button. 1106 """ 1107 Flags = property(None, None) 1108# end of class RibbonArtProvider 1109 1110 1111class RibbonMSWArtProvider(RibbonArtProvider): 1112 """ 1113 RibbonMSWArtProvider(set_colour_scheme=True) 1114 """ 1115 1116 def __init__(self, set_colour_scheme=True): 1117 """ 1118 RibbonMSWArtProvider(set_colour_scheme=True) 1119 """ 1120 1121 def Clone(self): 1122 """ 1123 Clone() -> RibbonArtProvider 1124 1125 Create a new art provider which is a clone of this one. 1126 """ 1127 1128 def SetFlags(self, flags): 1129 """ 1130 SetFlags(flags) 1131 1132 Set the style flags. 1133 """ 1134 1135 def GetFlags(self): 1136 """ 1137 GetFlags() -> long 1138 1139 Get the previously set style flags. 1140 """ 1141 1142 def GetMetric(self, id): 1143 """ 1144 GetMetric(id) -> int 1145 1146 Get the value of a certain integer setting. 1147 """ 1148 1149 def SetMetric(self, id, new_val): 1150 """ 1151 SetMetric(id, new_val) 1152 1153 Set the value of a certain integer setting to the value new_val. 1154 """ 1155 1156 def SetFont(self, id, font): 1157 """ 1158 SetFont(id, font) 1159 1160 Set the value of a certain font setting to the value font. 1161 """ 1162 1163 def GetFont(self, id): 1164 """ 1165 GetFont(id) -> wx.Font 1166 1167 Get the value of a certain font setting. 1168 """ 1169 1170 def GetColour(self, id): 1171 """ 1172 GetColour(id) -> wx.Colour 1173 1174 Get the value of a certain colour setting. 1175 """ 1176 1177 def SetColour(self, id, colour): 1178 """ 1179 SetColour(id, colour) 1180 1181 Set the value of a certain colour setting to the value colour. 1182 """ 1183 1184 def GetColourScheme(self): 1185 """ 1186 GetColourScheme() -> (primary, secondary, tertiary) 1187 1188 Get the current colour scheme. 1189 """ 1190 1191 def SetColourScheme(self, primary, secondary, tertiary): 1192 """ 1193 SetColourScheme(primary, secondary, tertiary) 1194 1195 Set all applicable colour settings from a few base colours. 1196 """ 1197 1198 def GetTabCtrlHeight(self, dc, wnd, pages): 1199 """ 1200 GetTabCtrlHeight(dc, wnd, pages) -> int 1201 1202 Calculate the height (in pixels) of the tab region of a ribbon bar. 1203 """ 1204 1205 def DrawTabCtrlBackground(self, dc, wnd, rect): 1206 """ 1207 DrawTabCtrlBackground(dc, wnd, rect) 1208 1209 Draw the background of the tab region of a ribbon bar. 1210 """ 1211 1212 def DrawTab(self, dc, wnd, tab): 1213 """ 1214 DrawTab(dc, wnd, tab) 1215 1216 Draw a single tab in the tab region of a ribbon bar. 1217 """ 1218 1219 def DrawTabSeparator(self, dc, wnd, rect, visibility): 1220 """ 1221 DrawTabSeparator(dc, wnd, rect, visibility) 1222 1223 Draw a separator between two tabs in a ribbon bar. 1224 """ 1225 1226 def DrawPageBackground(self, dc, wnd, rect): 1227 """ 1228 DrawPageBackground(dc, wnd, rect) 1229 1230 Draw the background of a ribbon page. 1231 """ 1232 1233 def DrawScrollButton(self, dc, wnd, rect, style): 1234 """ 1235 DrawScrollButton(dc, wnd, rect, style) 1236 1237 Draw a ribbon-style scroll button. 1238 """ 1239 1240 def DrawPanelBackground(self, dc, wnd, rect): 1241 """ 1242 DrawPanelBackground(dc, wnd, rect) 1243 1244 Draw the background and chrome for a ribbon panel. 1245 """ 1246 1247 def DrawGalleryBackground(self, dc, wnd, rect): 1248 """ 1249 DrawGalleryBackground(dc, wnd, rect) 1250 1251 Draw the background and chrome for a wxRibbonGallery control. 1252 """ 1253 1254 def DrawGalleryItemBackground(self, dc, wnd, rect, item): 1255 """ 1256 DrawGalleryItemBackground(dc, wnd, rect, item) 1257 1258 Draw the background of a single item in a wxRibbonGallery control. 1259 """ 1260 1261 def DrawMinimisedPanel(self, dc, wnd, rect, bitmap): 1262 """ 1263 DrawMinimisedPanel(dc, wnd, rect, bitmap) 1264 1265 Draw a minimised ribbon panel. 1266 """ 1267 1268 def DrawButtonBarBackground(self, dc, wnd, rect): 1269 """ 1270 DrawButtonBarBackground(dc, wnd, rect) 1271 1272 Draw the background for a wxRibbonButtonBar control. 1273 """ 1274 1275 def DrawButtonBarButton(self, dc, wnd, rect, kind, state, label, bitmap_large, bitmap_small): 1276 """ 1277 DrawButtonBarButton(dc, wnd, rect, kind, state, label, bitmap_large, bitmap_small) 1278 1279 Draw a single button for a wxRibbonButtonBar control. 1280 """ 1281 1282 def DrawToolBarBackground(self, dc, wnd, rect): 1283 """ 1284 DrawToolBarBackground(dc, wnd, rect) 1285 1286 Draw the background for a wxRibbonToolBar control. 1287 """ 1288 1289 def DrawToolGroupBackground(self, dc, wnd, rect): 1290 """ 1291 DrawToolGroupBackground(dc, wnd, rect) 1292 1293 Draw the background for a group of tools on a wxRibbonToolBar control. 1294 """ 1295 1296 def DrawTool(self, dc, wnd, rect, bitmap, kind, state): 1297 """ 1298 DrawTool(dc, wnd, rect, bitmap, kind, state) 1299 1300 Draw a single tool (for a wxRibbonToolBar control). 1301 """ 1302 1303 def DrawToggleButton(self, dc, wnd, rect, mode): 1304 """ 1305 DrawToggleButton(dc, wnd, rect, mode) 1306 1307 Draw toggle button on wxRibbonBar. 1308 """ 1309 1310 def DrawHelpButton(self, dc, wnd, rect): 1311 """ 1312 DrawHelpButton(dc, wnd, rect) 1313 1314 Draw help button on wxRibbonBar. 1315 """ 1316 1317 def GetBarTabWidth(self, dc, wnd, label, bitmap, ideal, small_begin_need_separator, small_must_have_separator, minimum): 1318 """ 1319 GetBarTabWidth(dc, wnd, label, bitmap, ideal, small_begin_need_separator, small_must_have_separator, minimum) 1320 1321 Calculate the ideal and minimum width (in pixels) of a tab in a ribbon 1322 bar. 1323 """ 1324 1325 def GetScrollButtonMinimumSize(self, dc, wnd, style): 1326 """ 1327 GetScrollButtonMinimumSize(dc, wnd, style) -> wx.Size 1328 1329 Calculate the minimum size (in pixels) of a scroll button. 1330 """ 1331 1332 def GetPanelSize(self, dc, wnd, client_size, client_offset): 1333 """ 1334 GetPanelSize(dc, wnd, client_size, client_offset) -> wx.Size 1335 1336 Calculate the size of a panel for a given client size. 1337 """ 1338 1339 def GetPanelClientSize(self, dc, wnd, size, client_offset): 1340 """ 1341 GetPanelClientSize(dc, wnd, size, client_offset) -> wx.Size 1342 1343 Calculate the client size of a panel for a given overall size. 1344 """ 1345 1346 def GetPanelExtButtonArea(self, dc, wnd, rect): 1347 """ 1348 GetPanelExtButtonArea(dc, wnd, rect) -> wx.Rect 1349 1350 Calculate the position and size of the panel extension button. 1351 """ 1352 1353 def GetGallerySize(self, dc, wnd, client_size): 1354 """ 1355 GetGallerySize(dc, wnd, client_size) -> wx.Size 1356 1357 Calculate the size of a wxRibbonGallery control for a given client 1358 size. 1359 """ 1360 1361 def GetGalleryClientSize(self, dc, wnd, size, client_offset, scroll_up_button, scroll_down_button, extension_button): 1362 """ 1363 GetGalleryClientSize(dc, wnd, size, client_offset, scroll_up_button, scroll_down_button, extension_button) -> wx.Size 1364 1365 Calculate the client size of a wxRibbonGallery control for a given 1366 size. 1367 """ 1368 1369 def GetPageBackgroundRedrawArea(self, dc, wnd, page_old_size, page_new_size): 1370 """ 1371 GetPageBackgroundRedrawArea(dc, wnd, page_old_size, page_new_size) -> wx.Rect 1372 1373 Calculate the portion of a page background which needs to be redrawn 1374 when a page is resized. 1375 """ 1376 1377 def GetButtonBarButtonSize(self, dc, wnd, kind, size, label, bitmap_size_large, bitmap_size_small, button_size, normal_region, dropdown_region): 1378 """ 1379 GetButtonBarButtonSize(dc, wnd, kind, size, label, bitmap_size_large, bitmap_size_small, button_size, normal_region, dropdown_region) -> bool 1380 1381 Calculate the size of a button within a wxRibbonButtonBar. 1382 """ 1383 1384 def GetMinimisedPanelMinimumSize(self, dc, wnd, desired_bitmap_size, expanded_panel_direction): 1385 """ 1386 GetMinimisedPanelMinimumSize(dc, wnd, desired_bitmap_size, expanded_panel_direction) -> wx.Size 1387 1388 Calculate the size of a minimised ribbon panel. 1389 """ 1390 1391 def GetToolSize(self, dc, wnd, bitmap_size, kind, is_first, is_last, dropdown_region): 1392 """ 1393 GetToolSize(dc, wnd, bitmap_size, kind, is_first, is_last, dropdown_region) -> wx.Size 1394 1395 Calculate the size of a tool within a wxRibbonToolBar. 1396 """ 1397 1398 def GetBarToggleButtonArea(self, rect): 1399 """ 1400 GetBarToggleButtonArea(rect) -> wx.Rect 1401 1402 Calculate the position and size of the ribbon's toggle button. 1403 """ 1404 1405 def GetRibbonHelpButtonArea(self, rect): 1406 """ 1407 GetRibbonHelpButtonArea(rect) -> wx.Rect 1408 1409 Calculate the position and size of the ribbon's help button. 1410 """ 1411 Flags = property(None, None) 1412# end of class RibbonMSWArtProvider 1413 1414 1415class RibbonAUIArtProvider(RibbonMSWArtProvider): 1416 """ 1417 RibbonAUIArtProvider() 1418 """ 1419 1420 def __init__(self): 1421 """ 1422 RibbonAUIArtProvider() 1423 """ 1424 1425 def Clone(self): 1426 """ 1427 Clone() -> RibbonArtProvider 1428 1429 Create a new art provider which is a clone of this one. 1430 """ 1431 1432 def GetColour(self, id): 1433 """ 1434 GetColour(id) -> wx.Colour 1435 1436 Get the value of a certain colour setting. 1437 """ 1438 1439 def SetColour(self, id, colour): 1440 """ 1441 SetColour(id, colour) 1442 1443 Set the value of a certain colour setting to the value colour. 1444 """ 1445 1446 def SetColourScheme(self, primary, secondary, tertiary): 1447 """ 1448 SetColourScheme(primary, secondary, tertiary) 1449 1450 Set all applicable colour settings from a few base colours. 1451 """ 1452 1453 def SetFont(self, id, font): 1454 """ 1455 SetFont(id, font) 1456 1457 Set the value of a certain font setting to the value font. 1458 """ 1459 1460 def GetScrollButtonMinimumSize(self, dc, wnd, style): 1461 """ 1462 GetScrollButtonMinimumSize(dc, wnd, style) -> wx.Size 1463 1464 Calculate the minimum size (in pixels) of a scroll button. 1465 """ 1466 1467 def DrawScrollButton(self, dc, wnd, rect, style): 1468 """ 1469 DrawScrollButton(dc, wnd, rect, style) 1470 1471 Draw a ribbon-style scroll button. 1472 """ 1473 1474 def GetPanelSize(self, dc, wnd, client_size, client_offset): 1475 """ 1476 GetPanelSize(dc, wnd, client_size, client_offset) -> wx.Size 1477 1478 Calculate the size of a panel for a given client size. 1479 """ 1480 1481 def GetPanelClientSize(self, dc, wnd, size, client_offset): 1482 """ 1483 GetPanelClientSize(dc, wnd, size, client_offset) -> wx.Size 1484 1485 Calculate the client size of a panel for a given overall size. 1486 """ 1487 1488 def GetPanelExtButtonArea(self, dc, wnd, rect): 1489 """ 1490 GetPanelExtButtonArea(dc, wnd, rect) -> wx.Rect 1491 1492 Calculate the position and size of the panel extension button. 1493 """ 1494 1495 def DrawTabCtrlBackground(self, dc, wnd, rect): 1496 """ 1497 DrawTabCtrlBackground(dc, wnd, rect) 1498 1499 Draw the background of the tab region of a ribbon bar. 1500 """ 1501 1502 def GetTabCtrlHeight(self, dc, wnd, pages): 1503 """ 1504 GetTabCtrlHeight(dc, wnd, pages) -> int 1505 1506 Calculate the height (in pixels) of the tab region of a ribbon bar. 1507 """ 1508 1509 def GetBarTabWidth(self, dc, wnd, label, bitmap, ideal, small_begin_need_separator, small_must_have_separator, minimum): 1510 """ 1511 GetBarTabWidth(dc, wnd, label, bitmap, ideal, small_begin_need_separator, small_must_have_separator, minimum) 1512 1513 Calculate the ideal and minimum width (in pixels) of a tab in a ribbon 1514 bar. 1515 """ 1516 1517 def DrawTab(self, dc, wnd, tab): 1518 """ 1519 DrawTab(dc, wnd, tab) 1520 1521 Draw a single tab in the tab region of a ribbon bar. 1522 """ 1523 1524 def DrawTabSeparator(self, dc, wnd, rect, visibility): 1525 """ 1526 DrawTabSeparator(dc, wnd, rect, visibility) 1527 1528 Draw a separator between two tabs in a ribbon bar. 1529 """ 1530 1531 def DrawPageBackground(self, dc, wnd, rect): 1532 """ 1533 DrawPageBackground(dc, wnd, rect) 1534 1535 Draw the background of a ribbon page. 1536 """ 1537 1538 def DrawPanelBackground(self, dc, wnd, rect): 1539 """ 1540 DrawPanelBackground(dc, wnd, rect) 1541 1542 Draw the background and chrome for a ribbon panel. 1543 """ 1544 1545 def DrawMinimisedPanel(self, dc, wnd, rect, bitmap): 1546 """ 1547 DrawMinimisedPanel(dc, wnd, rect, bitmap) 1548 1549 Draw a minimised ribbon panel. 1550 """ 1551 1552 def DrawGalleryBackground(self, dc, wnd, rect): 1553 """ 1554 DrawGalleryBackground(dc, wnd, rect) 1555 1556 Draw the background and chrome for a wxRibbonGallery control. 1557 """ 1558 1559 def DrawGalleryItemBackground(self, dc, wnd, rect, item): 1560 """ 1561 DrawGalleryItemBackground(dc, wnd, rect, item) 1562 1563 Draw the background of a single item in a wxRibbonGallery control. 1564 """ 1565 1566 def DrawButtonBarBackground(self, dc, wnd, rect): 1567 """ 1568 DrawButtonBarBackground(dc, wnd, rect) 1569 1570 Draw the background for a wxRibbonButtonBar control. 1571 """ 1572 1573 def DrawButtonBarButton(self, dc, wnd, rect, kind, state, label, bitmap_large, bitmap_small): 1574 """ 1575 DrawButtonBarButton(dc, wnd, rect, kind, state, label, bitmap_large, bitmap_small) 1576 1577 Draw a single button for a wxRibbonButtonBar control. 1578 """ 1579 1580 def DrawToolBarBackground(self, dc, wnd, rect): 1581 """ 1582 DrawToolBarBackground(dc, wnd, rect) 1583 1584 Draw the background for a wxRibbonToolBar control. 1585 """ 1586 1587 def DrawToolGroupBackground(self, dc, wnd, rect): 1588 """ 1589 DrawToolGroupBackground(dc, wnd, rect) 1590 1591 Draw the background for a group of tools on a wxRibbonToolBar control. 1592 """ 1593 1594 def DrawTool(self, dc, wnd, rect, bitmap, kind, state): 1595 """ 1596 DrawTool(dc, wnd, rect, bitmap, kind, state) 1597 1598 Draw a single tool (for a wxRibbonToolBar control). 1599 """ 1600# end of class RibbonAUIArtProvider 1601 1602 1603if 'wxMSW' in wx.PlatformInfo: 1604 RibbonDefaultArtProvider = RibbonMSWArtProvider 1605else: 1606 RibbonDefaultArtProvider = RibbonAUIArtProvider 1607#-- end-ribbon_art --# 1608#-- begin-ribbon_buttonbar --# 1609RIBBON_BUTTONBAR_BUTTON_SMALL = 0 1610RIBBON_BUTTONBAR_BUTTON_MEDIUM = 0 1611RIBBON_BUTTONBAR_BUTTON_LARGE = 0 1612RIBBON_BUTTONBAR_BUTTON_SIZE_MASK = 0 1613RIBBON_BUTTONBAR_BUTTON_NORMAL_HOVERED = 0 1614RIBBON_BUTTONBAR_BUTTON_DROPDOWN_HOVERED = 0 1615RIBBON_BUTTONBAR_BUTTON_HOVER_MASK = 0 1616RIBBON_BUTTONBAR_BUTTON_NORMAL_ACTIVE = 0 1617RIBBON_BUTTONBAR_BUTTON_DROPDOWN_ACTIVE = 0 1618RIBBON_BUTTONBAR_BUTTON_ACTIVE_MASK = 0 1619RIBBON_BUTTONBAR_BUTTON_DISABLED = 0 1620RIBBON_BUTTONBAR_BUTTON_TOGGLED = 0 1621RIBBON_BUTTONBAR_BUTTON_STATE_MASK = 0 1622wxEVT_RIBBONBUTTONBAR_CLICKED = 0 1623wxEVT_RIBBONBUTTONBAR_DROPDOWN_CLICKED = 0 1624 1625class RibbonButtonBar(RibbonControl): 1626 """ 1627 RibbonButtonBar() 1628 RibbonButtonBar(parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0) 1629 1630 A ribbon button bar is similar to a traditional toolbar. 1631 """ 1632 1633 def __init__(self, *args, **kw): 1634 """ 1635 RibbonButtonBar() 1636 RibbonButtonBar(parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0) 1637 1638 A ribbon button bar is similar to a traditional toolbar. 1639 """ 1640 1641 def Create(self, parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0): 1642 """ 1643 Create(parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0) -> bool 1644 1645 Create a button bar in two-step button bar construction. 1646 """ 1647 1648 def AddButton(self, *args, **kw): 1649 """ 1650 AddButton(button_id, label, bitmap, help_string, kind=RIBBON_BUTTON_NORMAL) -> RibbonButtonBarButtonBase 1651 AddButton(button_id, label, bitmap, bitmap_small=wx.NullBitmap, bitmap_disabled=wx.NullBitmap, bitmap_small_disabled=wx.NullBitmap, kind=RIBBON_BUTTON_NORMAL, help_string=wx.EmptyString) -> RibbonButtonBarButtonBase 1652 1653 Add a button to the button bar (simple version). 1654 """ 1655 1656 def AddDropdownButton(self, button_id, label, bitmap, help_string=wx.EmptyString): 1657 """ 1658 AddDropdownButton(button_id, label, bitmap, help_string=wx.EmptyString) -> RibbonButtonBarButtonBase 1659 1660 Add a dropdown button to the button bar (simple version). 1661 """ 1662 1663 def AddHybridButton(self, button_id, label, bitmap, help_string=wx.EmptyString): 1664 """ 1665 AddHybridButton(button_id, label, bitmap, help_string=wx.EmptyString) -> RibbonButtonBarButtonBase 1666 1667 Add a hybrid button to the button bar (simple version). 1668 """ 1669 1670 def AddToggleButton(self, button_id, label, bitmap, help_string=wx.EmptyString): 1671 """ 1672 AddToggleButton(button_id, label, bitmap, help_string=wx.EmptyString) -> RibbonButtonBarButtonBase 1673 1674 Add a toggle button to the button bar (simple version). 1675 """ 1676 1677 def InsertButton(self, *args, **kw): 1678 """ 1679 InsertButton(pos, button_id, label, bitmap, help_string, kind=RIBBON_BUTTON_NORMAL) -> RibbonButtonBarButtonBase 1680 InsertButton(pos, button_id, label, bitmap, bitmap_small=wx.NullBitmap, bitmap_disabled=wx.NullBitmap, bitmap_small_disabled=wx.NullBitmap, kind=RIBBON_BUTTON_NORMAL, help_string=wx.EmptyString) -> RibbonButtonBarButtonBase 1681 1682 Inserts a button to the button bar (simple version) at the given 1683 position. 1684 """ 1685 1686 def InsertDropdownButton(self, pos, button_id, label, bitmap, help_string=wx.EmptyString): 1687 """ 1688 InsertDropdownButton(pos, button_id, label, bitmap, help_string=wx.EmptyString) -> RibbonButtonBarButtonBase 1689 1690 Inserts a dropdown button to the button bar (simple version) at the 1691 given position. 1692 """ 1693 1694 def InsertHybridButton(self, pos, button_id, label, bitmap, help_string=wx.EmptyString): 1695 """ 1696 InsertHybridButton(pos, button_id, label, bitmap, help_string=wx.EmptyString) -> RibbonButtonBarButtonBase 1697 1698 Inserts a hybrid button to the button bar (simple version) at the 1699 given position. 1700 """ 1701 1702 def InsertToggleButton(self, pos, button_id, label, bitmap, help_string=wx.EmptyString): 1703 """ 1704 InsertToggleButton(pos, button_id, label, bitmap, help_string=wx.EmptyString) -> RibbonButtonBarButtonBase 1705 1706 Inserts a toggle button to the button bar (simple version) at the 1707 given position. 1708 """ 1709 1710 def GetButtonCount(self): 1711 """ 1712 GetButtonCount() -> size_t 1713 1714 Returns the number of buttons in this button bar. 1715 """ 1716 1717 def SetItemClientData(self, item, data): 1718 """ 1719 SetItemClientData(item, data) 1720 1721 Set the client object associated with a button. 1722 """ 1723 1724 def GetItemClientData(self, item): 1725 """ 1726 GetItemClientData(item) -> ClientData 1727 1728 Get the client object associated with a button. 1729 """ 1730 1731 def GetItem(self, n): 1732 """ 1733 GetItem(n) -> RibbonButtonBarButtonBase 1734 1735 Returns the N-th button of the bar. 1736 """ 1737 1738 def GetItemById(self, id): 1739 """ 1740 GetItemById(id) -> RibbonButtonBarButtonBase 1741 1742 Returns the first button having a given id or NULL if none matches. 1743 """ 1744 1745 def GetItemId(self, item): 1746 """ 1747 GetItemId(item) -> int 1748 1749 Returns the id of a button. 1750 """ 1751 1752 def Realize(self): 1753 """ 1754 Realize() -> bool 1755 1756 Calculate button layouts and positions. 1757 """ 1758 1759 def ClearButtons(self): 1760 """ 1761 ClearButtons() 1762 1763 Delete all buttons from the button bar. 1764 """ 1765 1766 def DeleteButton(self, button_id): 1767 """ 1768 DeleteButton(button_id) -> bool 1769 1770 Delete a single button from the button bar. 1771 """ 1772 1773 def EnableButton(self, button_id, enable=True): 1774 """ 1775 EnableButton(button_id, enable=True) 1776 1777 Enable or disable a single button on the bar. 1778 """ 1779 1780 def ToggleButton(self, button_id, checked): 1781 """ 1782 ToggleButton(button_id, checked) 1783 1784 Set a toggle button to the checked or unchecked state. 1785 """ 1786 1787 def GetActiveItem(self): 1788 """ 1789 GetActiveItem() -> RibbonButtonBarButtonBase 1790 1791 Returns the active item of the button bar or NULL if there is none. 1792 """ 1793 1794 def GetHoveredItem(self): 1795 """ 1796 GetHoveredItem() -> RibbonButtonBarButtonBase 1797 1798 Returns the hovered item of the button bar or NULL if there is none. 1799 """ 1800 1801 def SetShowToolTipsForDisabled(self, show): 1802 """ 1803 SetShowToolTipsForDisabled(show) 1804 1805 Indicates whether tooltips are shown for disabled buttons. 1806 """ 1807 1808 def GetShowToolTipsForDisabled(self): 1809 """ 1810 GetShowToolTipsForDisabled() -> bool 1811 1812 Sets whether tooltips should be shown for disabled buttons or not. 1813 """ 1814 1815 @staticmethod 1816 def GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL): 1817 """ 1818 GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) -> wx.VisualAttributes 1819 """ 1820 ActiveItem = property(None, None) 1821 ButtonCount = property(None, None) 1822 HoveredItem = property(None, None) 1823 ShowToolTipsForDisabled = property(None, None) 1824# end of class RibbonButtonBar 1825 1826 1827class RibbonButtonBarEvent(wx.CommandEvent): 1828 """ 1829 RibbonButtonBarEvent(command_type=wx.wxEVT_NULL, win_id=0, bar=None, button=None) 1830 1831 Event used to indicate various actions relating to a button on a 1832 wxRibbonButtonBar. 1833 """ 1834 1835 def __init__(self, command_type=wx.wxEVT_NULL, win_id=0, bar=None, button=None): 1836 """ 1837 RibbonButtonBarEvent(command_type=wx.wxEVT_NULL, win_id=0, bar=None, button=None) 1838 1839 Event used to indicate various actions relating to a button on a 1840 wxRibbonButtonBar. 1841 """ 1842 1843 def GetBar(self): 1844 """ 1845 GetBar() -> RibbonButtonBar 1846 1847 Returns the bar which contains the button which the event relates to. 1848 """ 1849 1850 def SetBar(self, bar): 1851 """ 1852 SetBar(bar) 1853 1854 Sets the button bar relating to this event. 1855 """ 1856 1857 def GetButton(self): 1858 """ 1859 GetButton() -> RibbonButtonBarButtonBase 1860 1861 Returns the button which the event relates to. 1862 """ 1863 1864 def SetButton(self, bar): 1865 """ 1866 SetButton(bar) 1867 1868 Sets the button relating to this event. 1869 """ 1870 1871 def PopupMenu(self, menu): 1872 """ 1873 PopupMenu(menu) -> bool 1874 1875 Display a popup menu as a result of this (dropdown clicked) event. 1876 """ 1877 Bar = property(None, None) 1878 Button = property(None, None) 1879# end of class RibbonButtonBarEvent 1880 1881 1882EVT_RIBBONBUTTONBAR_CLICKED = wx.PyEventBinder( wxEVT_RIBBONBUTTONBAR_CLICKED, 1 ) 1883EVT_RIBBONBUTTONBAR_DROPDOWN_CLICKED = wx.PyEventBinder( wxEVT_RIBBONBUTTONBAR_DROPDOWN_CLICKED, 1 ) 1884#-- end-ribbon_buttonbar --# 1885#-- begin-ribbon_gallery --# 1886RIBBON_GALLERY_BUTTON_NORMAL = 0 1887RIBBON_GALLERY_BUTTON_HOVERED = 0 1888RIBBON_GALLERY_BUTTON_ACTIVE = 0 1889RIBBON_GALLERY_BUTTON_DISABLED = 0 1890wxEVT_RIBBONGALLERY_HOVER_CHANGED = 0 1891wxEVT_RIBBONGALLERY_SELECTED = 0 1892wxEVT_RIBBONGALLERY_CLICKED = 0 1893 1894class RibbonGallery(RibbonControl): 1895 """ 1896 RibbonGallery() 1897 RibbonGallery(parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0) 1898 1899 A ribbon gallery is like a wxListBox, but for bitmaps rather than 1900 strings. 1901 """ 1902 1903 def __init__(self, *args, **kw): 1904 """ 1905 RibbonGallery() 1906 RibbonGallery(parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0) 1907 1908 A ribbon gallery is like a wxListBox, but for bitmaps rather than 1909 strings. 1910 """ 1911 1912 def Create(self, parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0): 1913 """ 1914 Create(parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0) -> bool 1915 1916 Create a gallery in two-step gallery construction. 1917 """ 1918 1919 def Clear(self): 1920 """ 1921 Clear() 1922 1923 Remove all items from the gallery. 1924 """ 1925 1926 def IsEmpty(self): 1927 """ 1928 IsEmpty() -> bool 1929 1930 Query if the gallery has no items in it. 1931 """ 1932 1933 def GetCount(self): 1934 """ 1935 GetCount() -> unsignedint 1936 1937 Get the number of items in the gallery. 1938 """ 1939 1940 def GetItem(self, n): 1941 """ 1942 GetItem(n) -> RibbonGalleryItem 1943 1944 Get an item by index. 1945 """ 1946 1947 def Append(self, *args, **kw): 1948 """ 1949 Append(bitmap, id) -> RibbonGalleryItem 1950 Append(bitmap, id, clientData) -> RibbonGalleryItem 1951 1952 Add an item to the gallery (with no client data). 1953 """ 1954 1955 def SetItemClientData(self, item, data): 1956 """ 1957 SetItemClientData(item, data) 1958 1959 Set the client object associated with a gallery item. 1960 """ 1961 1962 def GetItemClientData(self, item): 1963 """ 1964 GetItemClientData(item) -> ClientData 1965 1966 Get the client object associated with a gallery item. 1967 """ 1968 1969 def SetSelection(self, item): 1970 """ 1971 SetSelection(item) 1972 1973 Set the selection to the given item, or removes the selection if item 1974 == NULL. 1975 """ 1976 1977 def GetSelection(self): 1978 """ 1979 GetSelection() -> RibbonGalleryItem 1980 1981 Get the currently selected item, or NULL if there is none. 1982 """ 1983 1984 def GetHoveredItem(self): 1985 """ 1986 GetHoveredItem() -> RibbonGalleryItem 1987 1988 Get the currently hovered item, or NULL if there is none. 1989 """ 1990 1991 def GetActiveItem(self): 1992 """ 1993 GetActiveItem() -> RibbonGalleryItem 1994 1995 Get the currently active item, or NULL if there is none. 1996 """ 1997 1998 def GetUpButtonState(self): 1999 """ 2000 GetUpButtonState() -> RibbonGalleryButtonState 2001 2002 Get the state of the scroll up button. 2003 """ 2004 2005 def GetDownButtonState(self): 2006 """ 2007 GetDownButtonState() -> RibbonGalleryButtonState 2008 2009 Get the state of the scroll down button. 2010 """ 2011 2012 def GetExtensionButtonState(self): 2013 """ 2014 GetExtensionButtonState() -> RibbonGalleryButtonState 2015 2016 Get the state of the "extension" button. 2017 """ 2018 2019 def IsHovered(self): 2020 """ 2021 IsHovered() -> bool 2022 2023 Query is the mouse is currently hovered over the gallery. 2024 """ 2025 2026 def ScrollLines(self, lines): 2027 """ 2028 ScrollLines(lines) -> bool 2029 2030 Scroll the gallery contents by some amount. 2031 """ 2032 2033 def ScrollPixels(self, pixels): 2034 """ 2035 ScrollPixels(pixels) -> bool 2036 2037 Scroll the gallery contents by some fine-grained amount. 2038 """ 2039 2040 def EnsureVisible(self, item): 2041 """ 2042 EnsureVisible(item) 2043 2044 Scroll the gallery to ensure that the given item is visible. 2045 """ 2046 2047 @staticmethod 2048 def GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL): 2049 """ 2050 GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) -> wx.VisualAttributes 2051 """ 2052 ActiveItem = property(None, None) 2053 Count = property(None, None) 2054 DownButtonState = property(None, None) 2055 ExtensionButtonState = property(None, None) 2056 HoveredItem = property(None, None) 2057 Selection = property(None, None) 2058 UpButtonState = property(None, None) 2059# end of class RibbonGallery 2060 2061 2062class RibbonGalleryEvent(wx.CommandEvent): 2063 """ 2064 RibbonGalleryEvent(command_type=wx.wxEVT_NULL, win_id=0, gallery=None, item=None) 2065 """ 2066 2067 def __init__(self, command_type=wx.wxEVT_NULL, win_id=0, gallery=None, item=None): 2068 """ 2069 RibbonGalleryEvent(command_type=wx.wxEVT_NULL, win_id=0, gallery=None, item=None) 2070 """ 2071 2072 def GetGallery(self): 2073 """ 2074 GetGallery() -> RibbonGallery 2075 2076 Returns the gallery which the event relates to. 2077 """ 2078 2079 def GetGalleryItem(self): 2080 """ 2081 GetGalleryItem() -> RibbonGalleryItem 2082 2083 Returns the gallery item which the event relates to, or NULL if it 2084 does not relate to an item. 2085 """ 2086 2087 def SetGallery(self, gallery): 2088 """ 2089 SetGallery(gallery) 2090 2091 Sets the gallery relating to this event. 2092 """ 2093 2094 def SetGalleryItem(self, item): 2095 """ 2096 SetGalleryItem(item) 2097 2098 Sets the gallery item relating to this event. 2099 """ 2100 Gallery = property(None, None) 2101 GalleryItem = property(None, None) 2102# end of class RibbonGalleryEvent 2103 2104 2105EVT_RIBBONGALLERY_HOVER_CHANGED = wx.PyEventBinder( wxEVT_RIBBONGALLERY_HOVER_CHANGED, 1 ) 2106EVT_RIBBONGALLERY_SELECTED = wx.PyEventBinder( wxEVT_RIBBONGALLERY_SELECTED, 1 ) 2107EVT_RIBBONGALLERY_CLICKED = wx.PyEventBinder( wxEVT_RIBBONGALLERY_CLICKED, 1 ) 2108#-- end-ribbon_gallery --# 2109#-- begin-ribbon_toolbar --# 2110wxEVT_RIBBONTOOLBAR_CLICKED = 0 2111wxEVT_RIBBONTOOLBAR_DROPDOWN_CLICKED = 0 2112 2113class RibbonToolBar(RibbonControl): 2114 """ 2115 RibbonToolBar() 2116 RibbonToolBar(parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0) 2117 2118 A ribbon tool bar is similar to a traditional toolbar which has no 2119 labels. 2120 """ 2121 2122 def __init__(self, *args, **kw): 2123 """ 2124 RibbonToolBar() 2125 RibbonToolBar(parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0) 2126 2127 A ribbon tool bar is similar to a traditional toolbar which has no 2128 labels. 2129 """ 2130 2131 def Create(self, parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0): 2132 """ 2133 Create(parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0) -> bool 2134 2135 Create a tool bar in two-step tool bar construction. 2136 """ 2137 2138 def AddTool(self, *args, **kw): 2139 """ 2140 AddTool(tool_id, bitmap, help_string, kind=RIBBON_BUTTON_NORMAL) -> RibbonToolBarToolBase 2141 AddTool(tool_id, bitmap, bitmap_disabled=wx.NullBitmap, help_string=wx.EmptyString, kind=RIBBON_BUTTON_NORMAL, clientData=None) -> RibbonToolBarToolBase 2142 2143 Add a tool to the tool bar (simple version). 2144 """ 2145 2146 def AddDropdownTool(self, tool_id, bitmap, help_string=wx.EmptyString): 2147 """ 2148 AddDropdownTool(tool_id, bitmap, help_string=wx.EmptyString) -> RibbonToolBarToolBase 2149 2150 Add a dropdown tool to the tool bar (simple version). 2151 """ 2152 2153 def AddHybridTool(self, tool_id, bitmap, help_string=wx.EmptyString): 2154 """ 2155 AddHybridTool(tool_id, bitmap, help_string=wx.EmptyString) -> RibbonToolBarToolBase 2156 2157 Add a hybrid tool to the tool bar (simple version). 2158 """ 2159 2160 def AddToggleTool(self, tool_id, bitmap, help_string): 2161 """ 2162 AddToggleTool(tool_id, bitmap, help_string) -> RibbonToolBarToolBase 2163 2164 Add a toggle tool to the tool bar (simple version). 2165 """ 2166 2167 def AddSeparator(self): 2168 """ 2169 AddSeparator() -> RibbonToolBarToolBase 2170 2171 Add a separator to the tool bar. 2172 """ 2173 2174 def InsertTool(self, *args, **kw): 2175 """ 2176 InsertTool(pos, tool_id, bitmap, help_string, kind=RIBBON_BUTTON_NORMAL) -> RibbonToolBarToolBase 2177 InsertTool(pos, tool_id, bitmap, bitmap_disabled=wx.NullBitmap, help_string=wx.EmptyString, kind=RIBBON_BUTTON_NORMAL, clientData=None) -> RibbonToolBarToolBase 2178 2179 Insert a tool to the tool bar (simple version) as the specified 2180 position. 2181 """ 2182 2183 def InsertDropdownTool(self, pos, tool_id, bitmap, help_string=wx.EmptyString): 2184 """ 2185 InsertDropdownTool(pos, tool_id, bitmap, help_string=wx.EmptyString) -> RibbonToolBarToolBase 2186 2187 Insert a dropdown tool to the tool bar (simple version) as the 2188 specified position. 2189 """ 2190 2191 def InsertHybridTool(self, pos, tool_id, bitmap, help_string=wx.EmptyString): 2192 """ 2193 InsertHybridTool(pos, tool_id, bitmap, help_string=wx.EmptyString) -> RibbonToolBarToolBase 2194 2195 Insert a hybrid tool to the tool bar (simple version) as the specified 2196 position. 2197 """ 2198 2199 def InsertToggleTool(self, pos, tool_id, bitmap, help_string=wx.EmptyString): 2200 """ 2201 InsertToggleTool(pos, tool_id, bitmap, help_string=wx.EmptyString) -> RibbonToolBarToolBase 2202 2203 Insert a toggle tool to the tool bar (simple version) as the specified 2204 position. 2205 """ 2206 2207 def InsertSeparator(self, pos): 2208 """ 2209 InsertSeparator(pos) -> RibbonToolBarToolBase 2210 2211 Insert a separator to the tool bar at the specified position. 2212 """ 2213 2214 def ClearTools(self): 2215 """ 2216 ClearTools() 2217 2218 Deletes all the tools in the toolbar. 2219 """ 2220 2221 def DeleteTool(self, tool_id): 2222 """ 2223 DeleteTool(tool_id) -> bool 2224 2225 Removes the specified tool from the toolbar and deletes it. 2226 """ 2227 2228 def DeleteToolByPos(self, pos): 2229 """ 2230 DeleteToolByPos(pos) -> bool 2231 2232 This function behaves like DeleteTool() but it deletes the tool at the 2233 specified position and not the one with the given id. 2234 """ 2235 2236 def FindById(self, tool_id): 2237 """ 2238 FindById(tool_id) -> RibbonToolBarToolBase 2239 2240 Returns a pointer to the tool opaque structure by id or NULL if no 2241 corresponding tool is found. 2242 """ 2243 2244 def GetToolByPos(self, pos): 2245 """ 2246 GetToolByPos(pos) -> RibbonToolBarToolBase 2247 2248 Return the opaque pointer corresponding to the given tool. 2249 """ 2250 2251 def GetToolId(self, tool): 2252 """ 2253 GetToolId(tool) -> int 2254 2255 Return the id assciated to the tool opaque structure. 2256 """ 2257 2258 def GetToolClientData(self, tool_id): 2259 """ 2260 GetToolClientData(tool_id) -> PyUserData 2261 2262 Get any client data associated with the tool. 2263 """ 2264 2265 def GetToolEnabled(self, tool_id): 2266 """ 2267 GetToolEnabled(tool_id) -> bool 2268 2269 Called to determine whether a tool is enabled (responds to user 2270 input). 2271 """ 2272 2273 def GetToolHelpString(self, tool_id): 2274 """ 2275 GetToolHelpString(tool_id) -> String 2276 2277 Returns the help string for the given tool. 2278 """ 2279 2280 def GetToolKind(self, tool_id): 2281 """ 2282 GetToolKind(tool_id) -> RibbonButtonKind 2283 2284 Return the kind of the given tool. 2285 """ 2286 2287 def GetToolPos(self, tool_id): 2288 """ 2289 GetToolPos(tool_id) -> int 2290 2291 Returns the tool position in the toolbar, or wxNOT_FOUND if the tool 2292 is not found. 2293 """ 2294 2295 def GetToolState(self, tool_id): 2296 """ 2297 GetToolState(tool_id) -> bool 2298 2299 Gets the on/off state of a toggle tool. 2300 """ 2301 2302 def Realize(self): 2303 """ 2304 Realize() -> bool 2305 2306 Calculate tool layouts and positions. 2307 """ 2308 2309 def SetRows(self, nMin, nMax=-1): 2310 """ 2311 SetRows(nMin, nMax=-1) 2312 2313 Set the number of rows to distribute tool groups over. 2314 """ 2315 2316 def SetToolClientData(self, tool_id, clientData): 2317 """ 2318 SetToolClientData(tool_id, clientData) 2319 2320 Sets the client data associated with the tool. 2321 """ 2322 2323 def SetToolDisabledBitmap(self, tool_id, bitmap): 2324 """ 2325 SetToolDisabledBitmap(tool_id, bitmap) 2326 2327 Sets the bitmap to be used by the tool with the given ID when the tool 2328 is in a disabled state. 2329 """ 2330 2331 def SetToolHelpString(self, tool_id, helpString): 2332 """ 2333 SetToolHelpString(tool_id, helpString) 2334 2335 Sets the help string shown in tooltip for the given tool. 2336 """ 2337 2338 def SetToolNormalBitmap(self, tool_id, bitmap): 2339 """ 2340 SetToolNormalBitmap(tool_id, bitmap) 2341 2342 Sets the bitmap to be used by the tool with the given ID. 2343 """ 2344 2345 def EnableTool(self, tool_id, enable=True): 2346 """ 2347 EnableTool(tool_id, enable=True) 2348 2349 Enable or disable a single tool on the bar. 2350 """ 2351 2352 def ToggleTool(self, tool_id, checked): 2353 """ 2354 ToggleTool(tool_id, checked) 2355 2356 Set a toggle tool to the checked or unchecked state. 2357 """ 2358 2359 @staticmethod 2360 def GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL): 2361 """ 2362 GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) -> wx.VisualAttributes 2363 """ 2364# end of class RibbonToolBar 2365 2366 2367class RibbonToolBarEvent(wx.CommandEvent): 2368 """ 2369 RibbonToolBarEvent(command_type=wx.wxEVT_NULL, win_id=0, bar=None) 2370 """ 2371 2372 def __init__(self, command_type=wx.wxEVT_NULL, win_id=0, bar=None): 2373 """ 2374 RibbonToolBarEvent(command_type=wx.wxEVT_NULL, win_id=0, bar=None) 2375 """ 2376 2377 def GetBar(self): 2378 """ 2379 GetBar() -> RibbonToolBar 2380 """ 2381 2382 def SetBar(self, bar): 2383 """ 2384 SetBar(bar) 2385 """ 2386 2387 def PopupMenu(self, menu): 2388 """ 2389 PopupMenu(menu) -> bool 2390 """ 2391 Bar = property(None, None) 2392# end of class RibbonToolBarEvent 2393 2394 2395EVT_RIBBONTOOLBAR_CLICKED = wx.PyEventBinder( wxEVT_RIBBONTOOLBAR_CLICKED, 1 ) 2396EVT_RIBBONTOOLBAR_DROPDOWN_CLICKED = wx.PyEventBinder( wxEVT_RIBBONTOOLBAR_DROPDOWN_CLICKED, 1 ) 2397#-- end-ribbon_toolbar --# 2398