wxRibbonGallery

Implements methods from the following classes

• wxRibbonControl

Methods

• wxRibbonGallery
  Default constructor.
• Append
  Add an item to the gallery (with no client data).
• Clear
  Remove all items from the gallery.
• Create
  Create a gallery in two-step gallery construction.
• EnsureVisible
  Scroll the gallery to ensure that the given item is visible.
• GetActiveItem
  Get the currently active item, or NULL if there is none.
• GetCount
  Get the number of items in the gallery.
• GetDownButtonState
  Get the state of the scroll down button.
• GetExtensionButtonState
  Get the state of the "extension" button.
• GetHoveredItem
  Get the currently hovered item, or NULL if there is none.
• GetItem
  Get an item by index.
• GetItemClientData
  Get the client data associated with a gallery item.
• GetItemClientObject
  Get the client object associated with a gallery item.
• GetSelection
  Get the currently selected item, or NULL 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.
• ScrollLines
  Scroll the gallery contents by some amount.
• ScrollPixels
  Scroll the gallery contents by some fine-grained amount.
• SetItemClientData
  Set the client data associated with a gallery item.
• SetItemClientObject
  Set the client object associated with a gallery item.
• SetSelection
  Set the selection to the given item, or removes the selection if item == NULL.

Static Methods

wxRibbonGallery

wxRibbonGallery ( )

Default constructor.
wxRibbonGallery ( wxWindow &$parent, integer $id=wxID_ANY, wxPoint $pos=wxDefaultPosition, wxSize $size=wxDefaultSize, integer $style )

Construct a ribbon gallery with the given parameters.

Append

wxRibbonGalleryItem& Append ( wxBitmap $bitmap, integer $id )

Add an item to the gallery (with no client data).
wxRibbonGalleryItem& Append ( wxBitmap $bitmap, integer $id, )

Add an item to the gallery (with simple client data).
wxRibbonGalleryItem& Append ( wxBitmap $bitmap, integer $id, wxClientData &$clientData )

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

Clear

Clear ( )

Remove all items from the gallery.

Create

bool Create ( wxWindow &$parent, integer $id=wxID_ANY, wxPoint $pos=wxDefaultPosition, wxSize $size=wxDefaultSize, integer $style )

Create a gallery in two-step gallery construction.

EnsureVisible

EnsureVisible ( wxRibbonGalleryItem $item )

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

GetActiveItem

wxRibbonGalleryItem& GetActiveItem ( )

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

GetCount

integer GetCount ( )

Get the number of items in the gallery.

GetDownButtonState

wxRibbonGalleryButtonState GetDownButtonState ( )

Get the state of the scroll down button.

GetExtensionButtonState

wxRibbonGalleryButtonState GetExtensionButtonState ( )

Get the state of the "extension" button.

GetHoveredItem

wxRibbonGalleryItem& GetHoveredItem ( )

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

GetItem

wxRibbonGalleryItem& GetItem ( integer $n )

Get an item by index.

GetItemClientData

GetItemClientData ( wxRibbonGalleryItem $item )

Get the client data associated with a gallery item.

GetItemClientObject

wxClientData& GetItemClientObject ( wxRibbonGalleryItem $item )

Get the client object associated with a gallery item.

GetSelection

wxRibbonGalleryItem& GetSelection ( )

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

GetUpButtonState

wxRibbonGalleryButtonState GetUpButtonState ( )

Get the state of the scroll up button.

IsEmpty

bool IsEmpty ( )

Query if the gallery has no items in it.

IsHovered

bool IsHovered ( )

Query is the mouse is currently hovered over the gallery.

ScrollLines

bool ScrollLines ( integer $lines )

Scroll the gallery contents by some amount.

ScrollPixels

bool ScrollPixels ( integer $pixels )

Scroll the gallery contents by some fine-grained amount.

SetItemClientData

SetItemClientData ( wxRibbonGalleryItem &$item, )

Set the client data associated with a gallery item.

SetItemClientObject

SetItemClientObject ( wxRibbonGalleryItem &$item, wxClientData &$data )

Set the client object associated with a gallery item.

SetSelection

SetSelection ( wxRibbonGalleryItem &$item )

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