Contents Up Previous Next

wxCommandEvent: wxEvent

This event class contains information about panel item command events. It is passed to wxFunction panel item callbacks. It can also be constructed by an application and used with wxSendEvent to simulate a user command in a panel item.

wxCommandEvent::clientData
wxCommandEvent::commandInt
wxCommandEvent::commandString
wxCommandEvent::extraLong
wxCommandEvent::wxCommandEvent
wxCommandEvent::Checked
wxCommandEvent::GetClientData
wxCommandEvent::GetSelection
wxCommandEvent::GetString
wxCommandEvent::IsSelection


wxCommandEvent::clientData

char * clientData

Contains a pointer to client data for listboxes and choices, if the event was a selection.


wxCommandEvent::commandInt

int commandInt

Contains an integer identifier corresponding to a listbox, choice or radiobox selection (only if the event was a selection, not a deselection), or a Boolean value representing the value of a checkbox.


wxCommandEvent::commandString

char * commandString

Contains a string corresponding to a listbox or choice selection.


wxCommandEvent::extraLong

long extraLong

Extra information. If the event comes from a listbox selection, it is a Boolean determining whether the event was a selection (TRUE) or a deselection (FALSE). A listbox deselection only occurs for multiple-selection boxes, and in this case the index and string values are indeterminate and the listbox must be examined by the application.


wxCommandEvent::wxCommandEvent

void wxCommandEvent(WXTYPE commandEventType)

Constructor. commandEventType may be one of the following:


wxCommandEvent::Checked

Bool Checked(void)

Returns TRUE or FALSE for a checkbox selection event.


wxCommandEvent::GetClientData

char * GetClientData(void)

Returns client data pointer for a listbox or choice selection event (not valid for a deselection).


wxCommandEvent::GetSelection

int GetSelection(void)

Returns item index for a listbox or choice selection event (not valid for a deselection).


wxCommandEvent::GetString

char * GetString(void)

Returns item string for a listbox or choice selection event (not valid for a deselection).


wxCommandEvent::IsSelection

Bool IsSelection(void)

For a listbox or choice event, returns TRUE if it is a selection, FALSE if it is a deselection.