-
Notifications
You must be signed in to change notification settings - Fork 2.9k
/
wxSizerFlags.erl
212 lines (181 loc) · 7.9 KB
/
wxSizerFlags.erl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
%%
%% %CopyrightBegin%
%%
%% Copyright Ericsson AB 2008-2024. All Rights Reserved.
%%
%% Licensed under the Apache License, Version 2.0 (the "License");
%% you may not use this file except in compliance with the License.
%% You may obtain a copy of the License at
%%
%% http://www.apache.org/licenses/LICENSE-2.0
%%
%% Unless required by applicable law or agreed to in writing, software
%% distributed under the License is distributed on an "AS IS" BASIS,
%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
%% See the License for the specific language governing permissions and
%% limitations under the License.
%%
%% %CopyrightEnd%
%% This file is generated DO NOT EDIT
-module(wxSizerFlags).
-moduledoc """
Functions for wxSizerFlags class
Container for sizer items flags providing readable names for them.
Normally, when you add an item to a sizer via `wxSizer:add/4`, you have to
specify a lot of flags and parameters which can be unwieldy. This is where
`m:wxSizerFlags` comes in: it allows you to specify all parameters using the
named methods instead. For example, instead of
you can now write
This is more readable and also allows you to create `m:wxSizerFlags` objects
which can be reused for several sizer items.
Note that by specification, all methods of `m:wxSizerFlags` return the
`m:wxSizerFlags` object itself to allowing chaining multiple methods calls like
in the examples above.
See: `m:wxSizer`
wxWidgets docs:
[wxSizerFlags](https://docs.wxwidgets.org/3.1/classwx_sizer_flags.html)
""".
-include("wxe.hrl").
-export([align/2,border/1,border/2,border/3,center/1,centre/1,destroy/1,expand/1,
left/1,new/0,new/1,proportion/2,right/1]).
%% inherited exports
-export([parent_class/1]).
-type wxSizerFlags() :: wx:wx_object().
-export_type([wxSizerFlags/0]).
%% @hidden
-doc false.
parent_class(_Class) -> erlang:error({badtype, ?MODULE}).
%% @equiv new([])
-spec new() -> wxSizerFlags().
new() ->
new([]).
%% @doc See <a href="http://www.wxwidgets.org/manuals/2.8.12/wx_wxsizerflags.html#wxsizerflagswxsizerflags">external documentation</a>.
-doc "Creates the `m:wxSizer` with the proportion specified by `proportion`.".
-spec new([Option]) -> wxSizerFlags() when
Option :: {'proportion', integer()}.
new(Options)
when is_list(Options) ->
MOpts = fun({proportion, _proportion} = Arg) -> Arg;
(BadOpt) -> erlang:error({badoption, BadOpt}) end,
Opts = lists:map(MOpts, Options),
wxe_util:queue_cmd(Opts,?get_env(),?wxSizerFlags_new),
wxe_util:rec(?wxSizerFlags_new).
%% @doc See <a href="http://www.wxwidgets.org/manuals/2.8.12/wx_wxsizerflags.html#wxsizerflagsalign">external documentation</a>.
-doc """
Sets the alignment of this `m:wxSizerFlags` to `align`.
This method replaces the previously set alignment with the specified one.
See: `Top()` (not implemented in wx), `left/1`, `right/1`, `Bottom()` (not
implemented in wx), `centre/1`
""".
-spec align(This, Alignment) -> wxSizerFlags() when
This::wxSizerFlags(), Alignment::integer().
align(#wx_ref{type=ThisT}=This,Alignment)
when is_integer(Alignment) ->
?CLASS(ThisT,wxSizerFlags),
wxe_util:queue_cmd(This,Alignment,?get_env(),?wxSizerFlags_Align),
wxe_util:rec(?wxSizerFlags_Align).
%% @equiv border(This, [])
-spec border(This) -> wxSizerFlags() when
This::wxSizerFlags().
border(This)
when is_record(This, wx_ref) ->
border(This, []).
%% @doc See <a href="http://www.wxwidgets.org/manuals/2.8.12/wx_wxsizerflags.html#wxsizerflagsborder">external documentation</a>.
-doc """
Sets the `m:wxSizerFlags` to have a border with size as returned by
`GetDefaultBorder()` (not implemented in wx).
""".
-spec border(This, [Option]) -> wxSizerFlags() when
This::wxSizerFlags(),
Option :: {'direction', integer()}.
border(#wx_ref{type=ThisT}=This, Options)
when is_list(Options) ->
?CLASS(ThisT,wxSizerFlags),
MOpts = fun({direction, _direction} = Arg) -> Arg;
(BadOpt) -> erlang:error({badoption, BadOpt}) end,
Opts = lists:map(MOpts, Options),
wxe_util:queue_cmd(This, Opts,?get_env(),?wxSizerFlags_Border_1),
wxe_util:rec(?wxSizerFlags_Border_1).
%% @doc See <a href="http://www.wxwidgets.org/manuals/2.8.12/wx_wxsizerflags.html#wxsizerflagsborder">external documentation</a>.
-doc """
Sets the `m:wxSizerFlags` to have a border of a number of pixels specified by
`borderinpixels` with the directions specified by `direction`.
Prefer to use the overload below or `DoubleBorder()` (not implemented in wx) or
`TripleBorder()` (not implemented in wx) versions instead of hard-coding the
border value in pixels to avoid too small borders on devices with high DPI
displays.
""".
-spec border(This, Direction, Borderinpixels) -> wxSizerFlags() when
This::wxSizerFlags(), Direction::integer(), Borderinpixels::integer().
border(#wx_ref{type=ThisT}=This,Direction,Borderinpixels)
when is_integer(Direction),is_integer(Borderinpixels) ->
?CLASS(ThisT,wxSizerFlags),
wxe_util:queue_cmd(This,Direction,Borderinpixels,?get_env(),?wxSizerFlags_Border_2),
wxe_util:rec(?wxSizerFlags_Border_2).
%% @doc See <a href="http://www.wxwidgets.org/manuals/2.8.12/wx_wxsizerflags.html#wxsizerflagscenter">external documentation</a>.
-doc "See: `center/1`.".
-spec centre(This) -> wxSizerFlags() when
This::wxSizerFlags().
centre(This)
when is_record(This, wx_ref) ->
center(This).
%% @doc See <a href="http://www.wxwidgets.org/manuals/2.8.12/wx_wxsizerflags.html#wxsizerflagscenter">external documentation</a>.
-doc """
Sets the object of the `m:wxSizerFlags` to center itself in the area it is
given.
""".
-spec center(This) -> wxSizerFlags() when
This::wxSizerFlags().
center(#wx_ref{type=ThisT}=This) ->
?CLASS(ThisT,wxSizerFlags),
wxe_util:queue_cmd(This,?get_env(),?wxSizerFlags_Center),
wxe_util:rec(?wxSizerFlags_Center).
%% @doc See <a href="http://www.wxwidgets.org/manuals/2.8.12/wx_wxsizerflags.html#wxsizerflagsexpand">external documentation</a>.
-doc """
Sets the object of the `m:wxSizerFlags` to expand to fill as much area as it
can.
""".
-spec expand(This) -> wxSizerFlags() when
This::wxSizerFlags().
expand(#wx_ref{type=ThisT}=This) ->
?CLASS(ThisT,wxSizerFlags),
wxe_util:queue_cmd(This,?get_env(),?wxSizerFlags_Expand),
wxe_util:rec(?wxSizerFlags_Expand).
%% @doc See <a href="http://www.wxwidgets.org/manuals/2.8.12/wx_wxsizerflags.html#wxsizerflagsleft">external documentation</a>.
-doc """
Aligns the object to the left, similar for `Align(wxALIGN_LEFT)`.
Unlike `align/2`, this method doesn't change the vertical alignment of the item.
""".
-spec left(This) -> wxSizerFlags() when
This::wxSizerFlags().
left(#wx_ref{type=ThisT}=This) ->
?CLASS(ThisT,wxSizerFlags),
wxe_util:queue_cmd(This,?get_env(),?wxSizerFlags_Left),
wxe_util:rec(?wxSizerFlags_Left).
%% @doc See <a href="http://www.wxwidgets.org/manuals/2.8.12/wx_wxsizerflags.html#wxsizerflagsproportion">external documentation</a>.
-doc "Sets the proportion of this `m:wxSizerFlags` to `proportion`.".
-spec proportion(This, Proportion) -> wxSizerFlags() when
This::wxSizerFlags(), Proportion::integer().
proportion(#wx_ref{type=ThisT}=This,Proportion)
when is_integer(Proportion) ->
?CLASS(ThisT,wxSizerFlags),
wxe_util:queue_cmd(This,Proportion,?get_env(),?wxSizerFlags_Proportion),
wxe_util:rec(?wxSizerFlags_Proportion).
%% @doc See <a href="http://www.wxwidgets.org/manuals/2.8.12/wx_wxsizerflags.html#wxsizerflagsright">external documentation</a>.
-doc """
Aligns the object to the right, similar for `Align(wxALIGN_RIGHT)`.
Unlike `align/2`, this method doesn't change the vertical alignment of the item.
""".
-spec right(This) -> wxSizerFlags() when
This::wxSizerFlags().
right(#wx_ref{type=ThisT}=This) ->
?CLASS(ThisT,wxSizerFlags),
wxe_util:queue_cmd(This,?get_env(),?wxSizerFlags_Right),
wxe_util:rec(?wxSizerFlags_Right).
%% @doc Destroys this object, do not use object again
-doc "Destroys the object.".
-spec destroy(This::wxSizerFlags()) -> 'ok'.
destroy(Obj=#wx_ref{type=Type}) ->
?CLASS(Type,wxSizerFlags),
wxe_util:queue_cmd(Obj, ?get_env(), ?wxSizerFlags_destroy),
ok.