Event used to indicate various actions taken with wxAuiManager.
See wxAuiManager for available event types.
See:
This class is derived, and can use functions, from:
wxWidgets docs: wxAuiManagerEvent
Events
Use wxEvtHandler:connect/3 with wxAuiManagerEventType to subscribe to events of this type.
Summary
Functions
Return: true if this event can be vetoed.
Return: The ID of the button that was clicked.
Return: The wxAuiManager this event is associated with.
Return: The pane this event is associated with.
Return: true if this event was vetoed.
Sets the ID of the button clicked that triggered this event.
Sets whether or not this event can be vetoed.
Sets the wxAuiManager this event is associated with.
Sets the pane this event is associated with.
Types
-type wxAuiManager() :: #wxAuiManager{type :: wxAuiManagerEvent:wxAuiManagerEventType(), manager :: wxAuiManager:wxAuiManager(), pane :: wxAuiPaneInfo:wxAuiPaneInfo(), button :: integer(), veto_flag :: boolean(), canveto_flag :: boolean(), dc :: wxDC:wxDC()}.
-type wxAuiManagerEvent() :: wx:wx_object().
-type wxAuiManagerEventType() ::
aui_pane_button | aui_pane_close | aui_pane_maximize | aui_pane_restore | aui_pane_activated |
aui_render | aui_find_manager.
Functions
canVeto(This :: wxAuiManagerEvent()) -> boolean()
Return: true if this event can be vetoed.
See: veto/2
getButton(This :: wxAuiManagerEvent()) -> integer()
Return: The ID of the button that was clicked.
getDC(This :: wxAuiManagerEvent()) -> wxDC:wxDC()
getManager(This :: wxAuiManagerEvent()) -> Result
Types
Result = wxAuiManager:wxAuiManager()
Return: The wxAuiManager this event is associated with.
getPane(This :: wxAuiManagerEvent()) -> Result
Types
Result = wxAuiPaneInfo:wxAuiPaneInfo()
Return: The pane this event is associated with.
getVeto(This :: wxAuiManagerEvent()) -> boolean()
Return: true if this event was vetoed.
See: veto/2
setButton(This :: wxAuiManagerEvent(), Button :: integer()) -> ok
Sets the ID of the button clicked that triggered this event.
setCanVeto(This :: wxAuiManagerEvent(), Can_veto :: boolean()) -> ok
Sets whether or not this event can be vetoed.
setDC(This :: wxAuiManagerEvent(), Pdc :: wxDC:wxDC()) -> ok
Sets the wxAuiManager this event is associated with.
Sets the pane this event is associated with.
-spec veto(This) -> ok when This :: wxAuiManagerEvent().
-spec veto(This, [Option]) -> ok when This :: wxAuiManagerEvent(), Option :: {veto, boolean()}.
Cancels the action indicated by this event if canVeto/1 is true.