AGW Logo

Navigation

agw_title CommandToolBarEvent

A specialized command event class for events sent by AuiToolBar.

hierarchy Inheritance Diagram

Inheritance diagram for: CommandToolBarEvent

Inheritance diagram of CommandToolBarEvent


subclasses Known Subclasses


method_summary Methods Summary

__init__Default class constructor.
GetClickPointReturns the point where the user clicked with the mouse.
GetItemRectReturns the AuiToolBarItem rectangle.
GetToolIdReturns the AuiToolBarItem identifier.
IsDropDownClickedReturns whether the drop down menu has been clicked.
SetClickPointSets the clicking point.
SetDropDownClickedSets whether the drop down menu has been clicked.
SetItemRectSets the AuiToolBarItem rectangle.
SetToolIdSets the AuiToolBarItem identifier.

API Class API

class CommandToolBarEvent(wx.PyCommandEvent)[source]

A specialized command event class for events sent by AuiToolBar.


__init__(command_type, win_id)[source]

Default class constructor.

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

GetClickPoint()[source]

Returns the point where the user clicked with the mouse.


GetItemRect()[source]

Returns the AuiToolBarItem rectangle.


GetToolId()[source]

Returns the AuiToolBarItem identifier.


IsDropDownClicked()[source]

Returns whether the drop down menu has been clicked.


SetClickPoint(p)[source]

Sets the clicking point.

Parameters:p – a wx.Point object.

SetDropDownClicked(c)[source]

Sets whether the drop down menu has been clicked.

Parameters:c – True to set the drop down as clicked, False otherwise.

SetItemRect(r)[source]

Sets the AuiToolBarItem rectangle.

Parameters:r – an instance of wx.Rect.

SetToolId(id)[source]

Sets the AuiToolBarItem identifier.

Parameters:id – the toolbar item identifier.

AGW

Tree

Table Of Contents

Previous topic

AuiToolBarItem

Next topic

ToolbarCommandCapture

Navigation

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