wxErlang

Reference Manual

Version 2.0

Table of Contents

wxAuiManagerEvent

Module

wxAuiManagerEvent

Module Summary

Functions for wxAuiManagerEvent class

Description

Event used to indicate various actions taken with wxAuiManager.

See wxAuiManager for available event types.

See: wxAuiManager, wxAuiPaneInfo

This class is derived (and can use functions) from: wxEvent

wxWidgets docs: wxAuiManagerEvent

Events

Use wxEvtHandler:connect/3 with wxAuiManagerEventType to subscribe to events of this type.

Data Types

wxAuiManagerEvent() = wx:wx_object()
wxAuiManager() =
    #wxAuiManager{type =
                      wxAuiManagerEvent:wxAuiManagerEventType(),
                  manager = wxAuiManager:wxAuiManager(),
                  pane = wxAuiPaneInfo:wxAuiPaneInfo(),
                  button = integer(),
                  veto_flag = boolean(),
                  canveto_flag = boolean(),
                  dc = wxDC:wxDC()}
wxAuiManagerEventType() =
    aui_pane_button | aui_pane_close | aui_pane_maximize |
    aui_pane_restore | aui_pane_activated | aui_render |
    aui_find_manager

Exports

setManager(This, Manager) -> ok

Types

This = wxAuiManagerEvent()
Manager = wxAuiManager:wxAuiManager()

Sets the wxAuiManager this event is associated with.

getManager(This) -> wxAuiManager:wxAuiManager()

Types

This = wxAuiManagerEvent()

Return: The wxAuiManager this event is associated with.

setPane(This, Pane) -> ok

Types

This = wxAuiManagerEvent()
Pane = wxAuiPaneInfo:wxAuiPaneInfo()

Sets the pane this event is associated with.

getPane(This) -> wxAuiPaneInfo:wxAuiPaneInfo()

Types

This = wxAuiManagerEvent()

Return: The pane this event is associated with.

setButton(This, Button) -> ok

Types

This = wxAuiManagerEvent()
Button = integer()

Sets the ID of the button clicked that triggered this event.

getButton(This) -> integer()

Types

This = wxAuiManagerEvent()

Return: The ID of the button that was clicked.

setDC(This, Pdc) -> ok

Types

This = wxAuiManagerEvent()
Pdc = wxDC:wxDC()

getDC(This) -> wxDC:wxDC()

Types

This = wxAuiManagerEvent()

veto(This) -> ok

Types

This = wxAuiManagerEvent()
veto(This, Options :: [Option]) -> ok

Types

This = wxAuiManagerEvent()
Option = {veto, boolean()}

Cancels the action indicated by this event if canVeto/1 is true.

getVeto(This) -> boolean()

Types

This = wxAuiManagerEvent()

Return: true if this event was vetoed.

See: veto/2

setCanVeto(This, Can_veto) -> ok

Types

This = wxAuiManagerEvent()
Can_veto = boolean()

Sets whether or not this event can be vetoed.

canVeto(This) -> boolean()

Types

This = wxAuiManagerEvent()

Return: true if this event can be vetoed.

See: veto/2

Copyright © 2009-2021 Ericsson AB. All Rights Reserved.