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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250 | % /\ ) ( | |¯\ /¯\ /¯ |_/ /\ |¯\ ¯|¯
%\ W X /¯¯\ \_/ | |_/ \_/ \_, | \ /¯¯\ |¯\ | . E R L
%%—————————————————————————————————————————————————————————
%%
%% Copyright Ericsson AB 2008-2013. All Rights Reserved.
%%
%%——————————————————————————————————————————————
%% Whitespace Beautified by ScriptCulture © 2018
%% Sit Back · Feet Up · Learn wxErlang
%% For use as a reference only
%% www.scriptculture.com
%% Not check-summed
%% wx 1.8 ——————————————————————————————————————
%%
%% 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.
%%%%%%%
%%%%
%%%%%
%% @doc See external documentation: <a href="http://www.wxwidgets.org/manuals/2.8.12/wx_wxauidockart.html">wxAuiDockArt</a>.
%% @type wxAuiDockArt().
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%
%% OVERVIEW
%% ––––––––
%% wxAuiDockArt is part of the wxAUI class framework.
%% Check out the wxAUI Overview.
%%
%% wxAuiDockArt is the art provider:
%% provides all drawing functionality to the wxAui dock manager.
%% This allows the dock manager to have a plugable look-and-feel.
%%
%% By default, a wxAuiManager uses an instance of this class called
%% wxAuiDefaultDockArt which provides bitmap art and a colour scheme
%% that is adapted to the major platforms' look. You can either derive
%% from that class to alter its behaviour or write a completely new dock art class.
%% Call wxAuiManager::SetArtProvider to force wxAUI to use your new dock art provider.
%%
%%
%% See Also:
%% —————————
%% wxAuiManager, wxAuiPaneInfo
%%
%%
-module(wxAuiDockArt).
-include("wxe.hrl").
-export([
getColour/2,
getFont/2,
getMetric/2,
setColour/3,
setFont/3,
setMetric/3
]).
%% inherited exports
-export([parent_class/1]).
-export_type([wxAuiDockArt/0]).
%% @hidden
parent_class(_Class) -> erlang:error({badtype, ?MODULE}).
-type wxAuiDockArt() :: wx:wx_object().
%·%% GET COLOUR %%·%
%%
%% Get the colour of a certain setting.
%%
%% id can be one of the colour values of wxAuiPaneDockArtSetting.
%%
%% Return Value:
%% See Also:
%%*%%*%%
-spec getColour(This, Id) -> wx:wx_colour4()
when
This :: wxAuiDockArt(),
Id :: integer().
getColour(#wx_ref{type=ThisT,ref=ThisRef},Id)
when
is_integer(Id) ->
?CLASS(ThisT,wxAuiDockArt),
wxe_util:call(?wxAuiDockArt_GetColour,
<<ThisRef:32/?UI,Id:32/?UI>>).
%·%% GET FONT %%·%
%%
%% Get a font setting.
%%
%% Return Value:
%% See Also:
%%*%%*%%
-spec getFont(This, Id) -> wxFont:wxFont()
when
This :: wxAuiDockArt(),
Id :: integer().
getFont(#wx_ref{type=ThisT,ref=ThisRef}, Id)
when
is_integer(Id) ->
?CLASS(ThisT,wxAuiDockArt),
wxe_util:call(?wxAuiDockArt_GetFont,
<<ThisRef:32/?UI,Id:32/?UI>>).
%·%% GET METRIC %%·%
%%
%% Get the value of a certain setting.
%%
%% id can be one of the size values of wxAuiPaneDockArtSetting.
%%
%% Return Value:
%% See Also:
%%*%%*%%
-spec getMetric(This, Id) -> integer()
when
This :: wxAuiDockArt(),
Id :: integer().
getMetric(#wx_ref{type=ThisT,ref=ThisRef}, Id)
when
is_integer(Id) ->
?CLASS(ThisT,wxAuiDockArt),
wxe_util:call(?wxAuiDockArt_GetMetric,
<<ThisRef:32/?UI,Id:32/?UI>>).
%·%% SET COLOUR %%·%
%%
%% Set a certain setting with the value colour.
%%
%% id can be one of the colour values of wxAuiPaneDockArtSetting.
%%
%% Return Value:
%% See Also:
%%*%%*%%
-spec setColour(This, Id, Colour) -> ok
when
This :: wxAuiDockArt(),
Id :: integer(),
Colour :: wx:wx_colour().
setColour(#wx_ref{type=ThisT,ref=ThisRef}, Id, Colour)
when
is_integer(Id),
tuple_size(Colour) =:= 3;
tuple_size(Colour) =:= 4 ->
?CLASS(ThisT,wxAuiDockArt),
wxe_util:cast(?wxAuiDockArt_SetColour,
<<ThisRef:32/?UI,Id:32/?UI,(wxe_util:colour_bin(Colour)):16/binary>>).
%·%% SET FONT %%·%
%%
%% Set a font setting.
%%
%% Return Value:
%% See Also:
%%*%%*%%
-spec setFont(This, Id, Font) -> ok
when
This :: wxAuiDockArt(),
Id :: integer(),
Font :: wxFont:wxFont().
setFont(#wx_ref{type=ThisT,ref=ThisRef},
Id,
#wx_ref{type=FontT,ref=FontRef})
when
is_integer(Id) ->
?CLASS(ThisT,wxAuiDockArt),
?CLASS(FontT,wxFont),
wxe_util:cast(?wxAuiDockArt_SetFont,
<<ThisRef:32/?UI,Id:32/?UI,FontRef:32/?UI>>).
%·%% SET METRIC %%·%
%%
%% Set a certain setting with the value new_val.
%%
%% id can be one of the size values of wxAuiPaneDockArtSetting.
%%
%% Return Value:
%% See Also:
%%*%%*%%
-spec setMetric(This, Id, New_val) -> ok
when
This :: wxAuiDockArt(),
Id :: integer(),
New_val :: integer().
setMetric(#wx_ref{type=ThisT,ref=ThisRef}, Id, New_val)
when
is_integer(Id),
is_integer(New_val) ->
?CLASS(ThisT,wxAuiDockArt),
wxe_util:cast(?wxAuiDockArt_SetMetric,
<<ThisRef:32/?UI,Id:32/?UI,New_val:32/?UI>>).
|