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 | % |¯\ /¯ /¯\ \ / |_¯ |¯\ | /\ \ /
%\ W X |_/ \_, \_/ V |__ |¯\ |__ /¯¯\ | . 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_wxdcoverlay.html">wxDCOverlay</a>.
%% @type wxDCOverlay().
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%
%% OVERVIEW
%% ––––––––
%% Connects an overlay with a drawing DC.
%%
%%
%% See Also:
%% —————————
%%
%%
%%
-module(wxDCOverlay).
-include("wxe.hrl").
-export([clear/1,destroy/1,new/2,new/6]).
%% inherited exports
-export([parent_class/1]).
-export_type([wxDCOverlay/0]).
%% @hidden
parent_class(_Class) -> erlang:error({badtype, ?MODULE}).
-type wxDCOverlay() :: wx:wx_object().
%·%% NEW %%·%
%%
%% Convenience wrapper that behaves the same using
%% the entire area of the dc.
%%
%% Return Value:
%% See Also:
%%*%%*%%
-spec new(Overlay, Dc) -> wxDCOverlay()
when
Overlay :: wxOverlay:wxOverlay(),
Dc :: wxWindowDC:wxWindowDC().
new(#wx_ref{type=OverlayT,ref=OverlayRef},
#wx_ref{type=DcT,ref=DcRef}) ->
?CLASS(OverlayT,wxOverlay),
?CLASS(DcT,wxWindowDC),
wxe_util:construct(?wxDCOverlay_new_2,
<<OverlayRef:32/?UI,DcRef:32/?UI>>).
%·%% NEW / 6 %%·%
%%
%% Connects this overlay to the corresponding drawing dc,
%% if the overlay is not initialized yet this call will do so.
%%
%% Return Value:
%% See Also:
%%*%%*%%
-spec new(Overlay, Dc, X, Y, Width, Height) -> wxDCOverlay()
when
Overlay :: wxOverlay:wxOverlay(),
Dc :: wxWindowDC:wxWindowDC(),
X :: integer(),
Y :: integer(),
Width :: integer(),
Height :: integer().
new(#wx_ref{type=OverlayT,ref=OverlayRef}, #wx_ref{type=DcT,ref=DcRef}, X, Y, Width, Height)
when
is_integer(X),
is_integer(Y),
is_integer(Width),
is_integer(Height) ->
?CLASS(OverlayT,wxOverlay),
?CLASS(DcT,wxWindowDC),
wxe_util:construct(?wxDCOverlay_new_6,
<<OverlayRef:32/?UI,DcRef:32/?UI,X:32/?UI,Y:32/?UI,Width:32/?UI,Height:32/?UI>>).
%·%% CLEAR %%·%
%%
%% Clears the layer, restoring the state at the last init.
%%
%% Return Value:
%% See Also:
%%*%%*%%
-spec clear(This) -> ok
when
This :: wxDCOverlay().
clear(#wx_ref{type=ThisT,ref=ThisRef}) ->
?CLASS(ThisT,wxDCOverlay),
wxe_util:cast(?wxDCOverlay_Clear,
<<ThisRef:32/?UI>>).
%·%% DESTROY %%·%
%%
%%
%% @doc Destroys this object, do not use object again
-spec destroy(This :: wxDCOverlay()) -> ok.
destroy(Obj=#wx_ref{type=Type}) ->
?CLASS(Type,wxDCOverlay),
wxe_util:destroy(?wxDCOverlay_destruct,Obj),
ok.
|