Navigation

Phoenix Logo

phoenix_title wx.lib.agw.aui.auibook.AuiNotebookEvent

A specialized command event class for events sent by AuiNotebook.


class_hierarchy Class Hierarchy

Inheritance diagram for class AuiNotebookEvent:

method_summary Methods Summary

__init__ Default class constructor.
Allow This is the opposite of Veto it explicitly allows the event to be
GetNotifyEvent Returns the actual NotifyEvent.
IsAllowed Returns whether the event is allowed or not.
Veto Prevents the change announced by this event from happening.

api Class API


class AuiNotebookEvent(CommandNotebookEvent)

A specialized command event class for events sent by AuiNotebook.


Methods


__init__(self, command_type=None, win_id=0)

Default class constructor.

Parameters:
  • command_type – the event kind or an instance of PyCommandEvent.
  • win_id (integer) – the window identification number.

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


GetNotifyEvent(self)

Returns the actual NotifyEvent.


IsAllowed(self)

Returns whether the event is allowed or not.


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.