wxRibbonButtonBarEvent Class Reference
[EventsRibbon User Interface]

#include <wx/ribbon/buttonbar.h>

Inheritance diagram for wxRibbonButtonBarEvent:
Inheritance graph
[legend]

Detailed Description

Event used to indicate various actions relating to a button on a wxRibbonButtonBar.

See wxRibbonButtonBar for available event types.

Library:  wxRibbon
Category:  Events, Ribbon User Interface
See also:
wxRibbonBar

Public Member Functions

 wxRibbonButtonBarEvent (wxEventType command_type=wxEVT_NULL, int win_id=0, wxRibbonButtonBar *bar=NULL)
 Constructor.
wxRibbonButtonBarGetBar ()
 Returns the bar which contains the button which the event relates to.
void SetBar (wxRibbonButtonBar *bar)
 Sets the button bar relating to this event.
bool PopupMenu (wxMenu *menu)
 Display a popup menu as a result of this (dropdown clicked) event.
 wxRibbonButtonBarEvent (wxEventType command_type=wxEVT_NULL, int win_id=0, wxRibbonGallery *gallery=NULL, wxRibbonGalleryItem *item=NULL)
 Constructor.
wxRibbonGalleryGetGallery ()
 Returns the gallery which the event relates to.
wxRibbonGalleryItem * GetGalleryItem ()
 Returns the gallery item which the event relates to, or NULL if it does not relate to an item.
void SetGallery (wxRibbonGallery *gallery)
 Sets the gallery relating to this event.
void SetGalleryItem (wxRibbonGalleryItem *item)
 Sets the gallery item relating to this event.

List of all members.


Constructor & Destructor Documentation

wxRibbonButtonBarEvent::wxRibbonButtonBarEvent ( wxEventType  command_type = wxEVT_NULL,
int  win_id = 0,
wxRibbonButtonBar bar = NULL 
)

Constructor.

wxRibbonButtonBarEvent::wxRibbonButtonBarEvent ( wxEventType  command_type = wxEVT_NULL,
int  win_id = 0,
wxRibbonGallery gallery = NULL,
wxRibbonGalleryItem *  item = NULL 
)

Constructor.


Member Function Documentation

wxRibbonButtonBar* wxRibbonButtonBarEvent::GetBar (  ) 

Returns the bar which contains the button which the event relates to.

wxRibbonGallery* wxRibbonButtonBarEvent::GetGallery (  ) 

Returns the gallery which the event relates to.

wxRibbonGalleryItem* wxRibbonButtonBarEvent::GetGalleryItem (  ) 

Returns the gallery item which the event relates to, or NULL if it does not relate to an item.

bool wxRibbonButtonBarEvent::PopupMenu ( wxMenu menu  ) 

Display a popup menu as a result of this (dropdown clicked) event.

void wxRibbonButtonBarEvent::SetBar ( wxRibbonButtonBar bar  ) 

Sets the button bar relating to this event.

void wxRibbonButtonBarEvent::SetGallery ( wxRibbonGallery gallery  ) 

Sets the gallery relating to this event.

void wxRibbonButtonBarEvent::SetGalleryItem ( wxRibbonGalleryItem *  item  ) 

Sets the gallery item relating to this event.

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines



wxWidgets logo

[ top ]