wx.CommandEvent

Package wx :: Class CommandEvent

Type CommandEvent

object --+        
         |        
    Object --+    
             |    
         Event --+
                 |
                CommandEvent

Known Subclasses:: ChildFocusEvent, ContextMenuEvent, DateEvent, DynamicSashSplitEvent, DynamicSashUnifyEvent, FindDialogEvent, GridEditorCreatedEvent, HelpEvent, NotifyEvent, PyCommandEvent, SashEvent, ScrollEvent, StyledTextEvent, TextUrlEvent, UpdateUIEvent, WebKitStateChangedEvent, WindowCreateEvent, WindowDestroyEvent

This event class contains information about command events, which originate from a variety of simple controls, as well as menus and toolbars.

Method Summary
CommandEvent	`__init__(self, commandType, winid)` This event class contains information about command events, which originate from a variety of simple controls, as well as menus and toolbars.
	`__repr__(self)`
bool	`Checked(self)` This method can be used with checkbox and menu events: for the checkboxes, the method returns true for a selection event and false for a deselection one.
Event	`Clone(self)`
PyObject	`GetClientData(self)` Returns the client data object for a listbox or choice selection event, (if any.)
PyObject	`GetClientObject(self)` Returns the client data object for a listbox or choice selection event, (if any.)
long	`GetExtraLong(self)` Returns extra information dependant on the event objects type.
long	`GetInt(self)` Returns the 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.
int	`GetSelection(self)` Returns item index for a listbox or choice selection event (not valid for a deselection).
String	`GetString(self)` Returns item string for a listbox or choice selection event (not valid for a deselection).
bool	`IsChecked(self)` This method can be used with checkbox and menu events: for the checkboxes, the method returns true for a selection event and false for a deselection one.
bool	`IsSelection(self)` For a listbox or similar event, returns true if it is a selection, false if it is a deselection.
	`SetClientData(self, clientData)` Associate the given client data with the item at position n.
	`SetClientObject(self, clientData)` Associate the given client data with the item at position n.
	`SetExtraLong(self, extraLong)`
	`SetInt(self, i)`
	`SetString(self, s)`
Inherited from Event
	`__del__(self)`
Object	`GetEventObject(self)` Returns the object (usually a window) associated with the event, if any.
wxEventType	`GetEventType(self)` Returns the identifier of the given event type, such as `wxEVT_COMMAND_BUTTON_CLICKED`.
int	`GetId(self)` Returns the identifier associated with this event, such as a button command id.
bool	`GetSkipped(self)` Returns true if the event handler should be skipped, false otherwise.
long	`GetTimestamp(self)`
bool	`IsCommandEvent(self)` Returns true if the event is or is derived from `wx.CommandEvent` else it returns false.
	`ResumePropagation(self, propagationLevel)` Resume the event propagation by restoring the propagation level.
	`SetEventObject(self, obj)` Sets the originating object, or in other words, obj is normally the object that is sending the event.
	`SetEventType(self, typ)` Sets the specific type of the event.
	`SetId(self, Id)` Set's the ID for the event.
	`SetTimestamp(self, ts)`
bool	`ShouldPropagate(self)` Test if this event should be propagated to the parent window or not, i.e.
	`Skip(self, skip)` Called by an event handler, it controls whether additional event handlers bound to this event will be called after the current event handler returns.
int	`StopPropagation(self)` Stop the event from propagating to its parent window.
Inherited from Object
	`Destroy(self)` Deletes the C++ object this Python object is a proxy for.
String	`GetClassName(self)` Returns the class name of the C++ class using wxRTTI.
Inherited from object
	`__delattr__(...)` x.__delattr__('name') <==> del x.name
	`__getattribute__(...)` x.__getattribute__('name') <==> x.name
	`__hash__(x)` Return hash(x)...
	`__new__(T, S, ...)` Return a new object with type S, a subtype of T...
	`__reduce__(...)` helper for pickle
	`__reduce_ex__(...)` helper for pickle
	`__setattr__(...)` x.__setattr__('name', value) <==> x.name = value
	`__str__(x)` Return str(x)...

Method Details

init(self, commandType=wxEVT_NULL, winid=0)
(Constructor)

This event class contains information about command events, which originate from a variety of simple controls, as well as menus and toolbars.

Parameters:: commandType
(type=wxEventType); winid
(type=int)

Returns:: CommandEvent

Overrides:: wx.Event.__init__

Checked(self)

This method can be used with checkbox and menu events: for the checkboxes, the method returns true for a selection event and false for a deselection one. For the menu events, this method indicates if the menu item just has become checked or unchecked (and thus only makes sense for checkable menu items).

Returns:: bool

GetClientData(self)

Returns the client data object for a listbox or choice selection event, (if any.)

Returns:: PyObject

GetClientObject(self)

Returns the client data object for a listbox or choice selection event, (if any.)

Returns:: PyObject

GetExtraLong(self)

Returns extra information dependant on the event objects type. 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.

Returns:: long

GetInt(self)

Returns the 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.

Returns:: long

GetSelection(self)

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

Returns:: int

GetString(self)

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

Returns:: String

IsChecked(self)

Returns:: bool

IsSelection(self)

For a listbox or similar event, returns true if it is a selection, false if it is a deselection.

Returns:: bool

SetClientData(self, clientData)

Associate the given client data with the item at position n.

Parameters:: clientData
(type=PyObject)

SetClientObject(self, clientData)