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

Type NotifyEvent

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

Known Subclasses:
BookCtrlBaseEvent, GridEvent, GridRangeSelectEvent, GridSizeEvent, ListEvent, MediaEvent, SpinEvent, SplitterEvent, TreeEvent, WizardEvent

An instance of this class (or one of its derived classes) is sent from a control when the control's state is being changed and the control allows that change to be prevented from happening. The event handler can call Veto or Allow to tell the control what to do.


Method Summary
NotifyEvent __init__(self, commandType, winid)
An instance of this class (or one of its derived classes) is sent from a control when the control's state is being changed and the control allows that change to be prevented from happening.
  __repr__(self)
  Allow(self)
This is the opposite of Veto: it explicitly allows the event to be processed.
bool IsAllowed(self)
Returns true if the change is allowed (Veto hasn't been called) or false otherwise (if it was).
  Veto(self)
Prevents the change announced by this event from happening.
    Inherited from CommandEvent
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)

An instance of this class (or one of its derived classes) is sent from a control when the control's state is being changed and the control allows that change to be prevented from happening. The event handler can call Veto or Allow to tell the control what to do.

Parameters:
commandType
           (type=wxEventType)

winid
           (type=int)

Returns:
NotifyEvent
Overrides:
wx.CommandEvent.__init__

Allow(self)

This is the opposite of Veto: it explicitly allows the event to be processed. For most events it is not necessary to call this method as the events are allowed anyhow but some are forbidden by default (this will be mentioned in the corresponding event description).

IsAllowed(self)

Returns true if the change is allowed (Veto hasn't been called) or false otherwise (if it was).

Returns:
bool

Veto(self)

Prevents the change announced by this event from happening.

It is in general a good idea to notify the user about the reasons for vetoing the change because otherwise the applications behaviour (which just refuses to do what the user wants) might be quite surprising.


Generated by Epydoc 2.1.20050511.rpd on Sat Jun 16 16:43:28 2007 http://epydoc.sf.net