Phoenix Logo

phoenix_title wx.lib.agw.aui.auibar.CommandToolBarEvent

A specialized command event class for events sent by AuiToolBar.


class_hierarchy Class Hierarchy

Inheritance diagram for class CommandToolBarEvent:


super_classes Known Superclasses

wx.PyCommandEvent


method_summary Methods Summary

__init__ Default class constructor.
GetClickPoint Returns the point where the user clicked with the mouse.
GetItemRect Returns the AuiToolBarItem rectangle.
GetToolId Returns the AuiToolBarItem identifier.
IsDropDownClicked Returns whether the drop down menu has been clicked.
SetClickPoint Sets the clicking point.
SetDropDownClicked Sets whether the drop down menu has been clicked.
SetItemRect Sets the AuiToolBarItem rectangle.
SetToolId Sets the AuiToolBarItem identifier.

api Class API



class CommandToolBarEvent(wx.PyCommandEvent)

A specialized command event class for events sent by AuiToolBar.


Methods



__init__(self, command_type, win_id)

Default class constructor.

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


GetClickPoint(self)

Returns the point where the user clicked with the mouse.



GetItemRect(self)

Returns the AuiToolBarItem rectangle.



GetToolId(self)

Returns the AuiToolBarItem identifier.



IsDropDownClicked(self)

Returns whether the drop down menu has been clicked.



SetClickPoint(self, p)

Sets the clicking point.

Parameters:p (wx.Point) – the location of the mouse click.


SetDropDownClicked(self, c)

Sets whether the drop down menu has been clicked.

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


SetItemRect(self, r)

Sets the AuiToolBarItem rectangle.

Parameters:r (wx.Rect) – the toolbar item rectangle.


SetToolId(self, id)

Sets the AuiToolBarItem identifier.

Parameters:id (integer) – the toolbar item identifier.