RibbonBar

Inheritance Diagram

Inheritance diagram for: RibbonBar

Known Superclasses

• ribbon.control.RibbonControl

Control Appearance

RibbonBar

Methods Summary

__init__	Default constructor.
AddPage
CommonInit
DismissExpandedPanel	Dismiss the expanded panel of the currently active page.
DoEraseBackground
DoGetBestSize
DoMouseButtonCommon
GetAGWWindowStyleFlag	Returns the RibbonBar window style flag.
GetActivePage	Get the index of the active page.
GetDefaultBorder
GetPage	Get a page by index.
HasMultiplePages
HitTestTabs
OnEraseBackground
OnMouseDoubleClick
OnMouseLeave
OnMouseLeftDown
OnMouseLeftUp
OnMouseMiddleDown
OnMouseMiddleUp
OnMouseMove
OnMouseRightDown
OnMouseRightUp
OnPaint
OnSize
OrderPageTabInfoBySmallWidthAsc
Realize	Perform initial layout and size calculations of the bar and its children.
RecalculateMinSize
RecalculateTabSizes
RefreshTabBar
RepositionPage
ScrollTabBar
SetAGWWindowStyleFlag	Sets the window style for RibbonBar.
SetActivePage	See comments on SetActivePageByIndex and SetActivePageByPage.
SetActivePageByIndex	Set the active page by index, without triggering any events.
SetActivePageByPage	Set the active page, without triggering any events.
SetArtProvider	Set the art provider to be used be the ribbon bar.
SetTabCtrlMargins	Set the margin widths (in pixels) on the left and right sides of the tab bar region of the ribbon bar.
ShowPanels	Shows or hides the panels inside RibbonBar.

Class API

class RibbonBar(RibbonControl)

---

__init__(parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, agwStyle=RIBBON_BAR_DEFAULT_STYLE, validator=wx.DefaultValidator, name="RibbonBar")

Default constructor.

Parameters:

• parent – Pointer to a parent window;
• id – Window identifier. If wx.ID_ANY, will automatically create an identifier;
• pos – Window position. wx.DefaultPosition indicates that wxPython should generate a default position for the window;
• size – Window size. wx.DefaultSize indicates that wxPython should generate a default size for the window. If no suitable size can be found, the window will be sized to 20x20 pixels so that the window is visible but obviously not correctly sized;
• agwStyle – the AGW-specific window style. This can be a combination of the following bits:
  
  

  Window Styles	Hex Value	Description
  RIBBON_BAR_DEFAULT_STYLE	0x9	Defined as RIBBON_BAR_FLOW_HORIZONTAL | RIBBON_BAR_SHOW_PAGE_LABELS | RIBBON_BAR_SHOW_PANEL_EXT_BUTTONS
  RIBBON_BAR_FOLDBAR_STYLE	0x1e	Defined as RIBBON_BAR_FLOW_VERTICAL | RIBBON_BAR_SHOW_PAGE_ICONS | RIBBON_BAR_SHOW_PANEL_EXT_BUTTONS | RIBBON_BAR_SHOW_PANEL_MINIMISE_BUTTONS
  RIBBON_BAR_SHOW_PAGE_LABELS	0x1	Causes labels to be shown on the tabs in the ribbon bar.
  RIBBON_BAR_SHOW_PAGE_ICONS	0x2	Causes icons to be shown on the tabs in the ribbon bar.
  RIBBON_BAR_FLOW_HORIZONTAL	0x0	Causes panels within pages to stack horizontally.
  RIBBON_BAR_FLOW_VERTICAL	0x4	Causes panels within pages to stack vertically.
  RIBBON_BAR_SHOW_PANEL_EXT_BUTTONS	0x8	Causes extension buttons to be shown on panels (where the panel has such a button).
  RIBBON_BAR_SHOW_PANEL_MINIMISE_BUTTONS	0x10	Causes minimise buttons to be shown on panels (where the panel has such a button).

• validator – the window validator;
• name – the window name.

---

AddPage(page)

---

CommonInit(agwStyle)

---

DismissExpandedPanel()

Dismiss the expanded panel of the currently active page.

Calls and returns the value from RibbonPage.DismissExpandedPanel() for the currently active page, or False if there is no active page.

---

DoEraseBackground(dc)

---

DoGetBestSize()

---

DoMouseButtonCommon(event, tab_event_type)

---

GetAGWWindowStyleFlag()

Returns the RibbonBar window style flag.

See also

SetAGWWindowStyleFlag for a list of valid window styles.

---

GetActivePage()

Get the index of the active page.

In the rare case of no page being active, -1 is returned.

---

GetDefaultBorder()

---

GetPage(n)

Get a page by index.

None will be returned if the given index is out of range.

Parameters:n – MISSING DESCRIPTION.

---

HasMultiplePages()

---

HitTestTabs(position)

---

OnEraseBackground(event)

---

OnMouseDoubleClick(event)

---

OnMouseLeave(event)

---

OnMouseLeftDown(event)

---

OnMouseLeftUp(event)

---

OnMouseMiddleDown(event)

---

OnMouseMiddleUp(event)

---

OnMouseMove(event)

---

OnMouseRightDown(event)

---

OnMouseRightUp(event)

---

OnPaint(event)

---

OnSize(event)

---

OrderPageTabInfoBySmallWidthAsc(first, second)

---

Realize()

Perform initial layout and size calculations of the bar and its children.

This must be called after all of the bar’s children have been created (and their children created, etc.) - if it is not, then windows may not be laid out or sized correctly. Also calls RibbonPage.Realize() on each child page.

Reimplemented from RibbonControl.

---

RecalculateMinSize()

---

RecalculateTabSizes()

---

RefreshTabBar()

---

RepositionPage(page)

---

ScrollTabBar(amount)

---

SetAGWWindowStyleFlag(agwStyle)

Sets the window style for RibbonBar.

Parameters:agwStyle – can be a combination of the following bits:

Window Styles	Hex Value	Description
RIBBON_BAR_DEFAULT_STYLE	0x9	Defined as RIBBON_BAR_FLOW_HORIZONTAL | RIBBON_BAR_SHOW_PAGE_LABELS | RIBBON_BAR_SHOW_PANEL_EXT_BUTTONS
RIBBON_BAR_FOLDBAR_STYLE	0x1e	Defined as RIBBON_BAR_FLOW_VERTICAL | RIBBON_BAR_SHOW_PAGE_ICONS | RIBBON_BAR_SHOW_PANEL_EXT_BUTTONS | RIBBON_BAR_SHOW_PANEL_MINIMISE_BUTTONS
RIBBON_BAR_SHOW_PAGE_LABELS	0x1	Causes labels to be shown on the tabs in the ribbon bar.
RIBBON_BAR_SHOW_PAGE_ICONS	0x2	Causes icons to be shown on the tabs in the ribbon bar.
RIBBON_BAR_FLOW_HORIZONTAL	0x0	Causes panels within pages to stack horizontally.
RIBBON_BAR_FLOW_VERTICAL	0x4	Causes panels within pages to stack vertically.
RIBBON_BAR_SHOW_PANEL_EXT_BUTTONS	0x8	Causes extension buttons to be shown on panels (where the panel has such a button).
RIBBON_BAR_SHOW_PANEL_MINIMISE_BUTTONS	0x10	Causes minimise buttons to be shown on panels (where the panel has such a button).

Note

Please note that some styles cannot be changed after the window creation and that Refresh() might need to be be called after changing the others for the change to take place immediately.

---

SetActivePage(page)

See comments on SetActivePageByIndex and SetActivePageByPage.

---

SetActivePageByIndex(page)

Set the active page by index, without triggering any events.

Parameters:page – The zero-based index of the page to activate. Returns:True if the specified page is now active, False if it could not be activated (for example because the page index is invalid).

---

SetActivePageByPage(page)

Set the active page, without triggering any events.

Parameters:page – The page to activate. Returns:True if the specified page is now active, False if it could not be activated (for example because the given page is not a child of the ribbon bar).

---

SetArtProvider(art)

Set the art provider to be used be the ribbon bar.

Also sets the art provider on all current RibbonPage children, and any RibbonPage children added in the future.

Note that unlike most other ribbon controls, the ribbon bar creates a default art provider when initialised, so an explicit call to SetArtProvider is not required if the default art provider is sufficient. Also unlike other ribbon controls, the ribbon bar takes ownership of the given pointer, and will delete it when the art provider is changed or the bar is destroyed.

If this behaviour is not desired, then clone the art provider before setting it.

Reimplemented from RibbonControl.

Parameters:art – MISSING DESCRIPTION.

---

SetTabCtrlMargins(left, right)

Set the margin widths (in pixels) on the left and right sides of the tab bar region of the ribbon bar.

These margins will be painted with the tab background, but tabs and scroll buttons will never be painted in the margins. The left margin could be used for rendering something equivalent to the “Office Button”, though this is not currently implemented. The right margin could be used for rendering a help button, and/or MDI buttons, but again, this is not currently implemented.

Parameters:

• left – MISSING DESCRIPTION;
• right – MISSING DESCRIPTION.

---

ShowPanels(show=True)

Shows or hides the panels inside RibbonBar.

Parameters:show – True to show the panels, False to hide them.

AGW

• advancedsplash
• aquabutton
• artmanager
• aui
• balloontip
• buttonpanel
• cubecolourdialog
• customtreectrl
• flatmenu
• flatnotebook
• floatspin
• fmcustomizedlg
• foldpanelbar
• fourwaysplitter
• genericmessagedialog
• gradientbutton
• hyperlink
• hypertreelist
• infobar
• knobctrl
• labelbook
• multidirdialog
• peakmeter
• persist
• piectrl
• pybusyinfo
• pycollapsiblepane
• pygauge
• pyprogress
• ribbon
• rulerctrl
• shapedbutton
• shortcuteditor
• speedmeter
• supertooltip
• thumbnailctrl
• toasterbox
• ultimatelistctrl
• xlsgrid
• zoombar

Tree