wxMenuEvent Class Reference
[Events]

#include <wx/event.h>

Inheritance diagram for wxMenuEvent:
Inheritance graph
[legend]

Detailed Description

This class is used for a variety of menu-related events.

Note that these do not include menu command events, which are handled using wxCommandEvent objects.

The default handler for wxEVT_MENU_HIGHLIGHT displays help text in the first field of the status bar.

Events using this class

The following event handler macros redirect the events to member function handlers 'func' with prototypes like:

void handlerFuncName(wxMenuEvent& event)

Event macros:

Library:  wxCore
Category:  Events
See also:
wxCommandEvent, Events and Event Handling

Public Member Functions

 wxMenuEvent (wxEventType id=wxEVT_NULL, int id=0, wxMenu *menu=NULL)
 Constructor.
wxMenuGetMenu () const
 Returns the menu which is being opened or closed.
int GetMenuId () const
 Returns the menu identifier associated with the event.
bool IsPopup () const
 Returns true if the menu which is being opened or closed is a popup menu, false if it is a normal one.

List of all members.


Constructor & Destructor Documentation

wxMenuEvent::wxMenuEvent ( wxEventType  id = wxEVT_NULL,
int  id = 0,
wxMenu menu = NULL 
)

Constructor.


Member Function Documentation

wxMenu* wxMenuEvent::GetMenu (  )  const

Returns the menu which is being opened or closed.

This method should only be used with the OPEN and CLOSE events and even for them the returned pointer may be NULL in some ports.

int wxMenuEvent::GetMenuId (  )  const

Returns the menu identifier associated with the event.

This method should be only used with the HIGHLIGHT events.

bool wxMenuEvent::IsPopup (  )  const

Returns true if the menu which is being opened or closed is a popup menu, false if it is a normal one.

This method should only be used with the OPEN and CLOSE events.

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines



wxWidgets logo

[ top ]