1wxAuiManagerEvent(3)       Erlang Module Definition       wxAuiManagerEvent(3)
2
3
4

NAME

6       wxAuiManagerEvent - Functions for wxAuiManagerEvent class
7

DESCRIPTION

9       Event used to indicate various actions taken with wxAuiManager.
10
11       See wxAuiManager for available event types.
12
13       See: wxAuiManager, wxAuiPaneInfo
14
15       This class is derived (and can use functions) from: wxEvent
16
17       wxWidgets docs: wxAuiManagerEvent
18

EVENTS

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

DATA TYPES

24       wxAuiManagerEvent() = wx:wx_object()
25
26       wxAuiManager() =
27           #wxAuiManager{type =
28                             wxAuiManagerEvent:wxAuiManagerEventType(),
29                         manager = wxAuiManager:wxAuiManager(),
30                         pane = wxAuiPaneInfo:wxAuiPaneInfo(),
31                         button = integer(),
32                         veto_flag = boolean(),
33                         canveto_flag = boolean(),
34                         dc = wxDC:wxDC()}
35
36       wxAuiManagerEventType() =
37           aui_pane_button | aui_pane_close | aui_pane_maximize |
38           aui_pane_restore | aui_pane_activated | aui_render |
39           aui_find_manager
40

EXPORTS

42       setManager(This, Manager) -> ok
43
44              Types:
45
46                 This = wxAuiManagerEvent()
47                 Manager = wxAuiManager:wxAuiManager()
48
49              Sets the wxAuiManager this event is associated with.
50
51       getManager(This) -> wxAuiManager:wxAuiManager()
52
53              Types:
54
55                 This = wxAuiManagerEvent()
56
57              Return: The wxAuiManager this event is associated with.
58
59       setPane(This, Pane) -> ok
60
61              Types:
62
63                 This = wxAuiManagerEvent()
64                 Pane = wxAuiPaneInfo:wxAuiPaneInfo()
65
66              Sets the pane this event is associated with.
67
68       getPane(This) -> wxAuiPaneInfo:wxAuiPaneInfo()
69
70              Types:
71
72                 This = wxAuiManagerEvent()
73
74              Return: The pane this event is associated with.
75
76       setButton(This, Button) -> ok
77
78              Types:
79
80                 This = wxAuiManagerEvent()
81                 Button = integer()
82
83              Sets the ID of the button clicked that triggered this event.
84
85       getButton(This) -> integer()
86
87              Types:
88
89                 This = wxAuiManagerEvent()
90
91              Return: The ID of the button that was clicked.
92
93       setDC(This, Pdc) -> ok
94
95              Types:
96
97                 This = wxAuiManagerEvent()
98                 Pdc = wxDC:wxDC()
99
100       getDC(This) -> wxDC:wxDC()
101
102              Types:
103
104                 This = wxAuiManagerEvent()
105
106       veto(This) -> ok
107
108              Types:
109
110                 This = wxAuiManagerEvent()
111
112       veto(This, Options :: [Option]) -> ok
113
114              Types:
115
116                 This = wxAuiManagerEvent()
117                 Option = {veto, boolean()}
118
119              Cancels the action indicated by this event if canVeto/1 is true.
120
121       getVeto(This) -> boolean()
122
123              Types:
124
125                 This = wxAuiManagerEvent()
126
127              Return: true if this event was vetoed.
128
129              See: veto/2
130
131       setCanVeto(This, Can_veto) -> ok
132
133              Types:
134
135                 This = wxAuiManagerEvent()
136                 Can_veto = boolean()
137
138              Sets whether or not this event can be vetoed.
139
140       canVeto(This) -> boolean()
141
142              Types:
143
144                 This = wxAuiManagerEvent()
145
146              Return: true if this event can be vetoed.
147
148              See: veto/2
149
150
151
152wxWidgets team.                     wx 2.1                wxAuiManagerEvent(3)