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

NAME

6       wxSashEvent - Functions for wxSashEvent class
7

DESCRIPTION

9       A  sash  event is sent when the sash of a wxSashWindow has been dragged
10       by the user.
11
12       Remark: When a sash belonging to a sash window is dragged by the  user,
13       and  then  released,  this event is sent to the window, where it may be
14       processed by an event table entry in a derived class, a  plug-in  event
15       handler or an ancestor class. Note that the wxSashWindow doesn't change
16       the window's size itself. It relies on the application's event  handler
17       to  do  that.  This is because the application may have to handle other
18       consequences of the resize, or it may wish to veto it  altogether.  The
19       event  handler  should look at the drag rectangle: see getDragRect/1 to
20       see what the new size of the window would be if the resize were  to  be
21       applied.  It  should  also call getDragStatus/1 to see whether the drag
22       was OK or out of the current allowed range.
23
24       See: wxSashWindow, Overview events
25
26       This class is derived (and can use functions) from: wxCommandEvent  wx‐
27       Event
28
29       wxWidgets docs: wxSashEvent
30

EVENTS

32       Use  wxEvtHandler:connect/3 with wxSashEventType to subscribe to events
33       of this type.
34

DATA TYPES

36       wxSashEvent() = wx:wx_object()
37
38       wxSash() =
39           #wxSash{type = wxSashEvent:wxSashEventType(),
40                   edge = wx:wx_enum(),
41                   dragRect =
42                       {X :: integer(),
43                        Y :: integer(),
44                        W :: integer(),
45                        H :: integer()},
46                   dragStatus = wx:wx_enum()}
47
48       wxSashEventType() = sash_dragged
49

EXPORTS

51       getEdge(This) -> wx:wx_enum()
52
53              Types:
54
55                 This = wxSashEvent()
56
57              Returns the dragged edge.
58
59              The return value is one of wxSASH_TOP, wxSASH_RIGHT, wxSASH_BOT‐
60              TOM, wxSASH_LEFT.
61
62       getDragRect(This) ->
63                      {X :: integer(),
64                       Y :: integer(),
65                       W :: integer(),
66                       H :: integer()}
67
68              Types:
69
70                 This = wxSashEvent()
71
72              Returns the rectangle representing the new size the window would
73              be if the resize was applied.
74
75              It is up to the application to set the window size if required.
76
77       getDragStatus(This) -> wx:wx_enum()
78
79              Types:
80
81                 This = wxSashEvent()
82
83              Returns  the  status  of  the  sash:  one  of  wxSASH_STATUS_OK,
84              wxSASH_STATUS_OUT_OF_RANGE.
85
86              If  the  drag  caused the notional bounding box of the window to
87              flip over, for example, the drag will be out of rage.
88
89
90
91wxWidgets team.                     wx 2.1                      wxSashEvent(3)