Package wx :: Class CommandEvent
[frames | no frames]

Type CommandEvent

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

Known Subclasses:
ChildFocusEvent, ContextMenuEvent, DateEvent, DynamicSashSplitEvent, DynamicSashUnifyEvent, FindDialogEvent, GridEditorCreatedEvent, HelpEvent, NotifyEvent, PyCommandEvent, SashEvent, ScrollEvent, StyledTextEvent, TextUrlEvent, UpdateUIEvent, 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)
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.
  SetExtraLong(self, extraLong)
  SetInt(self, i)
  SetString(self, s)

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

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)

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

IsSelection(self)

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

Generated by Epydoc 2.1.20040428.rpd on Tue Apr 26 14:23:10 2005 http://epydoc.sf.net