Table Of Contents

Previous topic

Notebook

Next topic

Object

This Page

phoenix_title NotifyEvent

This class is not used by the event handlers by itself, but is a base class for other event classes (such as BookCtrlEvent).

It (or an object of a derived class) is sent when the controls state is being changed and allows the program to NotifyEvent.Veto this change if it wants to prevent it from happening.

See also

BookCtrlEvent


class_hierarchy Inheritance Diagram

Inheritance diagram for class NotifyEvent

Inheritance diagram of NotifyEvent


sub_classes Known Subclasses

AuiToolBarEvent, BookCtrlEvent, DataViewEvent, GridEvent, GridRangeSelectEvent, GridSizeEvent, HeaderCtrlEvent, ListEvent, MediaEvent, RibbonBarEvent, RichTextEvent, SpinDoubleEvent, SpinEvent, SplitterEvent, TreeEvent, TreeListEvent, WebViewEvent, WizardEvent


method_summary Methods Summary

__init__ Constructor (used internally by wxWidgets only).
Allow This is the opposite of Veto : it explicitly allows the event to be processed.
IsAllowed Returns True if the change is allowed ( Veto hasn’t been called) or False otherwise (if it was).
Veto Prevents the change announced by this event from happening.

api Class API



class NotifyEvent(CommandEvent)

This class is not used by the event handlers by itself, but is a base class for other event classes (such as BookCtrlEvent).

Possible constructors:

NotifyEvent(eventType=wxEVT_NULL, id=0)

Methods



__init__(self, eventType=wxEVT_NULL, id=0)

Constructor (used internally by wxWidgets only).

Parameters:
  • eventType (EventType) –
  • id (int) –


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).

Return type: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.