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

NAME

6       wxSashLayoutWindow - Functions for wxSashLayoutWindow class
7

DESCRIPTION

9       wxSashLayoutWindow  responds  to  OnCalculateLayout events generated by
10       wxLayoutAlgorithm. It allows the application to use simple accessors to
11       specify  how  the  window should be laid out, rather than having to re‐
12       spond to events.
13
14       The fact that the class derives from wxSashWindow allows sashes  to  be
15       used if required, to allow the windows to be user-resizable.
16
17       The  documentation  for  wxLayoutAlgorithm explains the purpose of this
18       class in more detail.
19
20       For the window styles see wxSashWindow.
21
22       This class handles the EVT_QUERY_LAYOUT_INFO  and  EVT_CALCULATE_LAYOUT
23       events  for you. However, if you use sashes, see wxSashWindow for rele‐
24       vant event information.  See  also  wxLayoutAlgorithm  for  information
25       about the layout events.
26
27       See: wxLayoutAlgorithm, wxSashWindow, Overview events
28
29       This class is derived (and can use functions) from: wxSashWindow wxWin‐
30       dow wxEvtHandler
31
32       wxWidgets docs: wxSashLayoutWindow
33

DATA TYPES

35       wxSashLayoutWindow() = wx:wx_object()
36

EXPORTS

38       new() -> wxSashLayoutWindow()
39
40              Default ctor.
41
42       new(Parent) -> wxSashLayoutWindow()
43
44              Types:
45
46                 Parent = wxWindow:wxWindow()
47
48       new(Parent, Options :: [Option]) -> wxSashLayoutWindow()
49
50              Types:
51
52                 Parent = wxWindow:wxWindow()
53                 Option =
54                     {id, integer()} |
55                     {pos, {X :: integer(), Y :: integer()}} |
56                     {size, {W :: integer(), H :: integer()}} |
57                     {style, integer()}
58
59              Constructs a sash layout window, which  can  be  a  child  of  a
60              frame, dialog or any other non-control window.
61
62       create(This, Parent) -> boolean()
63
64              Types:
65
66                 This = wxSashLayoutWindow()
67                 Parent = wxWindow:wxWindow()
68
69       create(This, Parent, Options :: [Option]) -> boolean()
70
71              Types:
72
73                 This = wxSashLayoutWindow()
74                 Parent = wxWindow:wxWindow()
75                 Option =
76                     {id, integer()} |
77                     {pos, {X :: integer(), Y :: integer()}} |
78                     {size, {W :: integer(), H :: integer()}} |
79                     {style, integer()}
80
81              Initializes  a  sash  layout  window,  which can be a child of a
82              frame, dialog or any other non-control window.
83
84       getAlignment(This) -> wx:wx_enum()
85
86              Types:
87
88                 This = wxSashLayoutWindow()
89
90              Returns the alignment of the window: one of wxLAYOUT_TOP, wxLAY‐
91              OUT_LEFT, wxLAYOUT_RIGHT, wxLAYOUT_BOTTOM.
92
93       getOrientation(This) -> wx:wx_enum()
94
95              Types:
96
97                 This = wxSashLayoutWindow()
98
99              Returns  the orientation of the window: one of wxLAYOUT_HORIZON‐
100              TAL, wxLAYOUT_VERTICAL.
101
102       setAlignment(This, Alignment) -> ok
103
104              Types:
105
106                 This = wxSashLayoutWindow()
107                 Alignment = wx:wx_enum()
108
109              Sets the alignment of the window (which edge  of  the  available
110              parent client area the window is attached to).
111
112              alignment is one of wxLAYOUT_TOP, wxLAYOUT_LEFT, wxLAYOUT_RIGHT,
113              wxLAYOUT_BOTTOM.
114
115       setDefaultSize(This, Size) -> ok
116
117              Types:
118
119                 This = wxSashLayoutWindow()
120                 Size = {W :: integer(), H :: integer()}
121
122              Sets the default dimensions of the window.
123
124              The dimension other than the orientation will be fixed  to  this
125              value,  and  the  orientation  dimension will be ignored and the
126              window stretched to fit the available space.
127
128       setOrientation(This, Orientation) -> ok
129
130              Types:
131
132                 This = wxSashLayoutWindow()
133                 Orientation = wx:wx_enum()
134
135              Sets the orientation of the window  (the  direction  the  window
136              will stretch in, to fill the available parent client area).
137
138              orientation is one of wxLAYOUT_HORIZONTAL, wxLAYOUT_VERTICAL.
139
140       destroy(This :: wxSashLayoutWindow()) -> ok
141
142              Destroys the object.
143
144
145
146wxWidgets team.                     wx 2.1               wxSashLayoutWindow(3)