AGW Logo

Navigation

agw_title AuiToolBarEvent

A specialized command event class for events sent by AuiToolBar.

hierarchy Inheritance Diagram

Inheritance diagram for: AuiToolBarEvent

Inheritance diagram of AuiToolBarEvent


method_summary Methods Summary

__init__Default class constructor.
AllowThis is the opposite of Veto: it explicitly allows the event to be
GetNotifyEventReturns the actual wx.NotifyEvent.
IsAllowedReturns whether the event is allowed or not.
VetoPrevents the change announced by this event from happening.

API Class API

class AuiToolBarEvent(CommandToolBarEvent)[source]

A specialized command event class for events sent by AuiToolBar.


__init__(command_type=None, win_id=0)[source]

Default class constructor.

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

Allow()[source]

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()[source]

Returns the actual wx.NotifyEvent.


IsAllowed()[source]

Returns whether the event is allowed or not.


Veto()[source]

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.

AGW

Tree

Table Of Contents

Previous topic

AuiToolBar

Next topic

AuiToolBarItem

Navigation

© Copyright 2012, Andrea Gavana. Created using Sphinx 1.2pre.