RibbonPage

Inheritance Diagram

Inheritance diagram for: RibbonPage

Known Superclasses

• ribbon.control.RibbonControl

Control Appearance

RibbonPage

Methods Summary

__init__	Default class constructor.
AdjustRectToIncludeScrollButtons	Expand a rectangle of the page to include external scroll buttons (if any).
CollapsePanels
CommonInit
DismissExpandedPanel	Dismiss the current externally expanded panel, if there is one.
DoGetBestSize
DoSetSize
ExpandPanels
GetDefaultBorder
GetIcon	Get the icon used for the page in the ribbon bar tab area (only displayed if the
GetMajorAxis	Get the direction in which ribbon panels are stacked within the page.
GetMinSize
HideScrollButtons
Layout
OnEraseBackground
OnPaint
OnSize
Realize	Perform a full re-layout of all panels on the page.
RemoveChild
ScrollLines	Scroll the page by some amount up / down / left / right.
ScrollPixels	Scroll the page by a set number of pixels up / down / left / right.
SetArtProvider	Set the art provider to be used.
SetSizeWithScrollButtonAdjustment	Set the size of the page and the external scroll buttons (if any).
Show
ShowScrollButtons

Class API

class RibbonPage(RibbonControl)

---

__init__(parent, id=wx.ID_ANY, label="", icon=wx.NullBitmap, style=0)

Default class constructor.

Parameters:

• parent – Pointer to a parent window;
• id – Window identifier. If wx.ID_ANY, will automatically create an identifier;
• label – Label of the new button;
• icon – the icon used for the page in the ribbon bar tab area;
• style – Window style.

---

AdjustRectToIncludeScrollButtons(rect)

Expand a rectangle of the page to include external scroll buttons (if any).

When no scroll buttons are shown, has no effect.

Parameters:rect – The rectangle to adjust. The width and height will not be reduced, and the x and y will not be increased.

---

CollapsePanels(direction, minimum_amount)

---

CommonInit(label, icon)

---

DismissExpandedPanel()

Dismiss the current externally expanded panel, if there is one.

When a ribbon panel automatically minimises, it can be externally expanded into a floating window. When the user clicks a button in such a panel, the panel should generally re-minimise. Event handlers for buttons on ribbon panels should call this method to achieve this behaviour.

Returns:True if a panel was minimised, False otherwise.

---

DoGetBestSize()

---

DoSetSize(x, y, width, height, sizeFlags=wx.SIZE_AUTO)

---

ExpandPanels(direction, maximum_amount)

---

GetDefaultBorder()

---

GetIcon()

Get the icon used for the page in the ribbon bar tab area (only displayed if the ribbon bar is actually showing icons).

---

GetMajorAxis()

Get the direction in which ribbon panels are stacked within the page.

This is controlled by the style of the containing RibbonBar, meaning that all pages within a bar will have the same major axis. As well as being the direction in which panels are stacked, it is also the axis in which scrolling will occur (when required).

Returns:wx.HORIZONTAL or wx.VERTICAL (never wx.BOTH).

---

GetMinSize()

---

HideScrollButtons()

---

Layout()

---

OnEraseBackground(event)

---

OnPaint(event)

---

OnSize(event)

---

Realize()

Perform a full re-layout of all panels on the page.

Should be called after panels are added to the page, or the sizing behaviour of a panel on the page changes (i.e. due to children being added to it). Usually called automatically when RibbonBar.Realize() is called. Will invoke RibbonPanel.Realize() for all child panels.

Reimplemented from RibbonControl.

---

RemoveChild(child)

---

ScrollLines(lines)

Scroll the page by some amount up / down / left / right.

When the page’s children are too big to fit in the onscreen area given to the page, scroll buttons will appear, and the page can be programatically scrolled. Positive values of will scroll right or down, while negative values will scroll up or left (depending on the direction in which panels are stacked). A line is equivalent to a constant number of pixels.

Reimplemented from wx.Window.

Parameters:lines – MISSING DESCRIPTION. Returns:True if the page scrolled at least one pixel in the given direction, False if it did not scroll.

See also

GetMajorAxis, ScrollPixels

---

ScrollPixels(pixels)

Scroll the page by a set number of pixels up / down / left / right.

When the page’s children are too big to fit in the onscreen area given to the page, scroll buttons will appear, and the page can be programatically scrolled. Positive values of will scroll right or down, while negative values will scroll up or left (depending on the direction in which panels are stacked).

Parameters:pixels – MISSING DESCRIPTION. Returns:True if the page scrolled at least one pixel in the given direction, False if it did not scroll.

See also

GetMajorAxis, ScrollLines

---

SetArtProvider(art)

Set the art provider to be used.

Normally called automatically by RibbonBar when the page is created, or the art provider changed on the bar. The new art provider will be propagated to the children of the page.

Reimplemented from RibbonControl.

Parameters:art – MISSING DESCRIPTION.

---

SetSizeWithScrollButtonAdjustment(x, y, width, height)

Set the size of the page and the external scroll buttons (if any).

When a page is too small to display all of its children, scroll buttons will appear (and if the page is sized up enough, they will disappear again). Slightly counter-intuively, these buttons are created as siblings of the page rather than children of the page (to achieve correct cropping and paint ordering of the children and the buttons).

When there are no scroll buttons, this function behaves the same as SetSize, however when there are scroll buttons, it positions them at the edges of the given area, and then calls SetSize with the remaining area. This is provided as a separate function to SetSize rather than within the implementation of SetSize, as iteracting algorithms may not expect SetSize to also set the size of siblings.

Parameters:

• x – MISSING DESCRIPTION;
• y – MISSING DESCRIPTION;
• width – MISSING DESCRIPTION;
• height – MISSING DESCRIPTION.

---

Show(show=True)

---

ShowScrollButtons()

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