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

NAME

6       wxSashWindow - Functions for wxSashWindow class
7

DESCRIPTION

9       wxSashWindow  allows  any  of  its  edges  to  have a sash which can be
10       dragged to resize the window. The actual content window will be created
11       by the application as a child of wxSashWindow.
12
13       The  window  (or  an  ancestor)  will be notified of a drag via a wxSa‐
14       shEvent notification.
15
16       Styles
17
18       This class supports the following styles:
19
20       See: wxSashEvent, wxSashLayoutWindow, Overview events
21
22       This class is derived  (and  can  use  functions)  from:  wxWindow  wx‐
23       EvtHandler
24
25       wxWidgets docs: wxSashWindow
26

EVENTS

28       Event types emitted from this class: sash_dragged
29

DATA TYPES

31       wxSashWindow() = wx:wx_object()
32

EXPORTS

34       new() -> wxSashWindow()
35
36              Default ctor.
37
38       new(Parent) -> wxSashWindow()
39
40              Types:
41
42                 Parent = wxWindow:wxWindow()
43
44       new(Parent, Options :: [Option]) -> wxSashWindow()
45
46              Types:
47
48                 Parent = wxWindow:wxWindow()
49                 Option =
50                     {id, integer()} |
51                     {pos, {X :: integer(), Y :: integer()}} |
52                     {size, {W :: integer(), H :: integer()}} |
53                     {style, integer()}
54
55              Constructs  a sash window, which can be a child of a frame, dia‐
56              log or any other non-control window.
57
58       destroy(This :: wxSashWindow()) -> ok
59
60              Destructor.
61
62       getSashVisible(This, Edge) -> boolean()
63
64              Types:
65
66                 This = wxSashWindow()
67                 Edge = wx:wx_enum()
68
69              Returns true if a sash is visible on the given edge, false  oth‐
70              erwise.
71
72              See: setSashVisible/3
73
74       getMaximumSizeX(This) -> integer()
75
76              Types:
77
78                 This = wxSashWindow()
79
80              Gets the maximum window size in the x direction.
81
82       getMaximumSizeY(This) -> integer()
83
84              Types:
85
86                 This = wxSashWindow()
87
88              Gets the maximum window size in the y direction.
89
90       getMinimumSizeX(This) -> integer()
91
92              Types:
93
94                 This = wxSashWindow()
95
96              Gets the minimum window size in the x direction.
97
98       getMinimumSizeY(This) -> integer()
99
100              Types:
101
102                 This = wxSashWindow()
103
104              Gets the minimum window size in the y direction.
105
106       setMaximumSizeX(This, Min) -> ok
107
108              Types:
109
110                 This = wxSashWindow()
111                 Min = integer()
112
113              Sets the maximum window size in the x direction.
114
115       setMaximumSizeY(This, Min) -> ok
116
117              Types:
118
119                 This = wxSashWindow()
120                 Min = integer()
121
122              Sets the maximum window size in the y direction.
123
124       setMinimumSizeX(This, Min) -> ok
125
126              Types:
127
128                 This = wxSashWindow()
129                 Min = integer()
130
131              Sets the minimum window size in the x direction.
132
133       setMinimumSizeY(This, Min) -> ok
134
135              Types:
136
137                 This = wxSashWindow()
138                 Min = integer()
139
140              Sets the minimum window size in the y direction.
141
142       setSashVisible(This, Edge, Visible) -> ok
143
144              Types:
145
146                 This = wxSashWindow()
147                 Edge = wx:wx_enum()
148                 Visible = boolean()
149
150              Call this function to make a sash visible or invisible on a par‐
151              ticular edge.
152
153              See: getSashVisible/2
154
155
156
157wxWidgets team.                     wx 2.1                     wxSashWindow(3)