Navigation

Phoenix Logo

phoenix_title wx.lib.agw.flatnotebook.FlatNotebookEvent

This events will be sent when a EVT_FLATNOTEBOOK_PAGE_CHANGED, EVT_FLATNOTEBOOK_PAGE_CHANGING, EVT_FLATNOTEBOOK_PAGE_CLOSING, EVT_FLATNOTEBOOK_PAGE_CLOSED and EVT_FLATNOTEBOOK_PAGE_CONTEXT_MENU is mapped in the parent.


class_hierarchy Class Hierarchy

Inheritance diagram for class FlatNotebookEvent:


super_classes Known Superclasses

wx.PyCommandEvent


method_summary Methods Summary

__init__ Default class constructor.
Allow This is the opposite of Veto: it explicitly allows the event to be processed.
GetNotifyEvent Returns the actual NotifyEvent.
GetOldSelection Returns the page that was selected before the change, -1 if none was selected.
GetSelection Returns the currently selected page, or -1 if none was selected.
IsAllowed Returns True if the change is allowed ( Veto hasn’t been called) or
SetOldSelection Sets the id of the page selected before the change.
SetSelection Sets the event selection.
Veto Prevents the change announced by this event from happening.

api Class API


class FlatNotebookEvent(wx.PyCommandEvent)

This events will be sent when a EVT_FLATNOTEBOOK_PAGE_CHANGED, EVT_FLATNOTEBOOK_PAGE_CHANGING, EVT_FLATNOTEBOOK_PAGE_CLOSING, EVT_FLATNOTEBOOK_PAGE_CLOSED and EVT_FLATNOTEBOOK_PAGE_CONTEXT_MENU is mapped in the parent.


Methods


__init__(self, eventType, eventId=1, nSel=-1, nOldSel=-1)

Default class constructor.

Parameters:
  • eventType – the event type;
  • eventId – the event identifier;
  • nSel – the current selection;
  • nOldSel – the old selection.

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.


GetOldSelection(self)

Returns the page that was selected before the change, -1 if none was selected.


GetSelection(self)

Returns the currently selected page, or -1 if none was selected.


IsAllowed(self)

Returns True if the change is allowed ( Veto hasn’t been called) or False otherwise (if it was).


SetOldSelection(self, nOldSel)

Sets the id of the page selected before the change.

Parameters:nOldSel – an integer specifying the old selection.

SetSelection(self, nSel)

Sets the event selection.

Parameters:nSel – an integer specifying the new selection.

Veto(self)

Prevents the change announced by this event from happening.

Note

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.