RibbonGallery

Inheritance Diagram

Inheritance diagram for: RibbonGallery

Known Superclasses

• ribbon.control.RibbonControl

Control Appearance

RibbonGallery

Methods Summary

__init__	Default class constructor.
Append	Add an item to the gallery (with complex client data).
CalculateMinSize
Clear	Remove all items from the gallery.
CommonInit
DoGetBestSize
DoGetNextLargerSize
DoGetNextSmallerSize
EnsureVisible	Scroll the gallery to ensure that the given item is visible.
GetActiveItem	Get the currently active item, or None if there is none.
GetCount	Get the number of items in the gallery.
GetDefaultBorder
GetDownButtonState	Get the state of the scroll down button.
GetExtensionButtonState	Get the state of the “extension” button.
GetHoveredItem	Get the currently hovered item, or None if there is none.
GetItem	Get an item by index.
GetItemClientData	Get the client data associated with a gallery item.
GetSelection	Get the currently selected item, or None if there is none.
GetUpButtonState	Get the state of the scroll up button.
IsEmpty	Query if the gallery has no items in it.
IsHovered	Query is the mouse is currently hovered over the gallery.
IsSizingContinuous
Layout
OnEraseBackground
OnMouseDClick
OnMouseDown
OnMouseEnter
OnMouseLeave
OnMouseMove
OnMouseUp
OnPaint
OnSize
Realize
ScrollLines	Scroll the gallery contents by some amount.
SetItemClientData	Set the client data associated with a gallery item.
SetSelection	Set the selection to the given item, or removes the selection if item == None.
TestButtonHover

Class API

class RibbonGallery(RibbonControl)

---

__init__(parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, agwStyle=0, name="RibbonGallery")

Default class 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;
• name – the window name.

---

Append(bitmap, id, clientData=None)

Add an item to the gallery (with complex client data).

Parameters:

• bitmap – The bitmap to display for the item. Note that all items must have equally sized bitmaps;
• id – ID number to associate with the item. Not currently used for anything important;
• clientData – An object which contains data to associate with the item. The item takes ownership of this pointer, and will delete it when the item client data is changed to something else, or when the item is destroyed.

---

CalculateMinSize()

---

Clear()

Remove all items from the gallery.

---

CommonInit(agwStyle)

---

DoGetBestSize()

---

DoGetNextLargerSize(direction, relative_to)

---

DoGetNextSmallerSize(direction, relative_to)

---

EnsureVisible(item)

Scroll the gallery to ensure that the given item is visible.

Parameters:item – MISSING DESCRIPTION.

---

GetActiveItem()

Get the currently active item, or None if there is none.

The active item is the item being pressed by the user, and will thus become the selected item if the user releases the mouse button.

---

GetCount()

Get the number of items in the gallery.

---

GetDefaultBorder()

---

GetDownButtonState()

Get the state of the scroll down button.

---

GetExtensionButtonState()

Get the state of the “extension” button.

---

GetHoveredItem()

Get the currently hovered item, or None if there is none.

The hovered item is the item underneath the mouse cursor.

---

GetItem(n)

Get an item by index.

Parameters:n – MISSING DESCRIPTION.

---

GetItemClientData(item)

Get the client data associated with a gallery item.

Parameters:item – MISSING DESCRIPTION.

---

GetSelection()

Get the currently selected item, or None if there is none.

The selected item is set by SetSelection, or by the user clicking on an item.

---

GetUpButtonState()

Get the state of the scroll up button.

---

IsEmpty()

Query if the gallery has no items in it.

---

IsHovered()

Query is the mouse is currently hovered over the gallery.

Returns:True if the cursor is within the bounds of the gallery (not just hovering over an item), False otherwise.

---

IsSizingContinuous()

---

Layout()

---

OnEraseBackground(event)

---

OnMouseDClick(event)

---

OnMouseDown(event)

---

OnMouseEnter(event)

---

OnMouseLeave(event)

---

OnMouseMove(event)

---

OnMouseUp(event)

---

OnPaint(event)

---

OnSize(event)

---

Realize()

---

ScrollLines(lines)

Scroll the gallery contents by some amount.

Reimplemented from wx.Window.

Parameters:lines – Positive values scroll toward the end of the gallery, while negative values scroll toward the start. Returns:True if the gallery scrolled at least one pixel in the given direction, False if it did not scroll.

---

SetItemClientData(item, data)

Set the client data associated with a gallery item.

Parameters:

• item – MISSING DESCRIPTION;
• data – MISSING DESCRIPTION.

---

SetSelection(item)

Set the selection to the given item, or removes the selection if item == None.

Note that this not cause any events to be emitted.

Parameters:item – MISSING DESCRIPTION.

---

TestButtonHover(rect, pos, state)

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