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

NAME

6       wxSplitterEvent - Functions for wxSplitterEvent class
7

DESCRIPTION

9       This class represents the events generated by a splitter control.
10
11       Also  there is only one event class, the data associated to the differ‐
12       ent events is not the same and so not all  accessor  functions  may  be
13       called  for each event. The documentation mentions the kind of event(s)
14       for which the given accessor function makes sense: calling it for other
15       types  of events will result in assert failure (in debug mode) and will
16       return meaningless results.
17
18       See: wxSplitterWindow, Overview events
19
20       This class is derived (and can use functions) from:  wxNotifyEvent  wx‐
21       CommandEvent wxEvent
22
23       wxWidgets docs: wxSplitterEvent
24

EVENTS

26       Use  wxEvtHandler:connect/3  with  wxSplitterEventType  to subscribe to
27       events of this type.
28

DATA TYPES

30       wxSplitterEvent() = wx:wx_object()
31
32       wxSplitter() =
33           #wxSplitter{type = wxSplitterEvent:wxSplitterEventType()}
34
35       wxSplitterEventType() =
36           command_splitter_sash_pos_changed |
37           command_splitter_sash_pos_changing |
38           command_splitter_doubleclicked | command_splitter_unsplit
39

EXPORTS

41       getSashPosition(This) -> integer()
42
43              Types:
44
45                 This = wxSplitterEvent()
46
47              Returns the new sash position.
48
49              May   only   be    called    while    processing    wxEVT_SPLIT‐
50              TER_SASH_POS_CHANGING     and    wxEVT_SPLITTER_SASH_POS_CHANGED
51              events.
52
53       getX(This) -> integer()
54
55              Types:
56
57                 This = wxSplitterEvent()
58
59              Returns the x coordinate of the double-click point.
60
61              May only be called while processing wxEVT_SPLITTER_DOUBLECLICKED
62              events.
63
64       getY(This) -> integer()
65
66              Types:
67
68                 This = wxSplitterEvent()
69
70              Returns the y coordinate of the double-click point.
71
72              May only be called while processing wxEVT_SPLITTER_DOUBLECLICKED
73              events.
74
75       getWindowBeingRemoved(This) -> wxWindow:wxWindow()
76
77              Types:
78
79                 This = wxSplitterEvent()
80
81              Returns a pointer to the window being removed  when  a  splitter
82              window is unsplit.
83
84              May  only  be  called  while  processing  wxEVT_SPLITTER_UNSPLIT
85              events.
86
87       setSashPosition(This, Pos) -> ok
88
89              Types:
90
91                 This = wxSplitterEvent()
92                 Pos = integer()
93
94              In the case of wxEVT_SPLITTER_SASH_POS_CHANGED events, sets  the
95              new sash position.
96
97              In the case of wxEVT_SPLITTER_SASH_POS_CHANGING events, sets the
98              new tracking bar position so  visual  feedback  during  dragging
99              will represent that change that will actually take place. Set to
100              -1 from the event handler code to prevent repositioning.
101
102              May   only   be    called    while    processing    wxEVT_SPLIT‐
103              TER_SASH_POS_CHANGING     and    wxEVT_SPLITTER_SASH_POS_CHANGED
104              events.
105
106
107
108wxWidgets team.                    wx 2.1.4                 wxSplitterEvent(3)