wxErlang

wxShowEvent.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
%            (` | | /¯\ \  / |_¯ \ / |_¯ |\ | ¯|¯              
%\      W X \_) |¯| \_/  VV  |__  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_wxshowevent.html">wxShowEvent</a>.
%% <dl><dt>Use {@link wxEvtHandler:connect/3.} with EventType:</dt>
%% <dd><em>show</em></dd></dl>
%% See also the message variant {@link wxEvtHandler:wxShow(). #wxShow{}} event record type.
%%
%% <p>This class is derived (and can use functions) from:
%% <br />{@link wxEvent}
%% </p>
%% @type wxShowEvent().  
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%   
%%   OVERVIEW
%%   ––––––––
%%   
%%   An event being sent when the window is shown or hidden.
%%   
%%   The event is triggered by calls to wxWindow::Show(), and 
%%   any user action showing a previously hidden window or vice versa 
%%   (if allowed by the current platform and/or window manager). 
%%   
%%   Notice that the event is not triggered when the application is 
%%   iconized (minimized) or restored under wxMSW.
%%   
%%   ——Availability:  only available for the wxMSW, wxGTK ports.
%%   
%%   
%%   EVENT MACRO LIST
%%   ————————————————
%%   The following event handler macros redirect the events 
%%   to member function handlers 'func' with prototypes like: 
%%   
%%   
%%       EVT_SHOW(func)    Process a wxEVT_SHOW event.
%%   
%% 
%%   See Also:
%%   —————————
%%   
%%   
%%   
-module(wxShowEvent).
-include("wxe.hrl").
-export([getShow/1,setShow/2]).

%% inherited exports
-export([getId/1,getSkipped/1,getTimestamp/1,isCommandEvent/1,parent_class/1,
  resumePropagation/2,shouldPropagate/1,skip/1,skip/2,stopPropagation/1]).

-export_type([wxShowEvent/0]).




%% @hidden
parent_class(wxEvent) -> true;
parent_class(_Class) -> erlang:error({badtype, ?MODULE}).

-type wxShowEvent()  ::  wx:wx_object().




           %·%% SET SHOW %%·%

%%   
%%   Set whether the windows was shown or hidden. 
%%   
%% Return Value:
%% See Also:
%%*%%*%%
          -spec setShow(This, Show) -> ok
           when
           This :: wxShowEvent(), 
           Show :: boolean().

setShow(#wx_ref{type=ThisT,ref=ThisRef}, Show)
           when 
           is_boolean(Show) ->
                             ?CLASS(ThisT,wxShowEvent),
               wxe_util:cast(?wxShowEvent_SetShow,
               <<ThisRef:32/?UI,(wxe_util:from_bool(Show)):32/?UI>>).





           %·%% GET SHOW %%·%

%%   
%%   Return true if the window has been shown, false if it has been hidden.   
%%
%%   Note: — Deprecated:
%%       This function is deprecated in favour of IsShown(). - does nto exist in this version.
%%    
%%   
%% Return Value:
%% See Also:
%%*%%*%%
          -spec getShow(This) -> boolean()
           when
           This :: wxShowEvent().

getShow(#wx_ref{type=ThisT, ref=ThisRef}) ->
                                           ?CLASS(ThisT,wxShowEvent),
                             wxe_util:call(?wxShowEvent_GetShow,
                             <<ThisRef:32/?UI>>).

 



%% From wxEvent




%% @hidden
stopPropagation(This) -> wxEvent:stopPropagation(This).
%% @hidden
skip(This, Options) -> wxEvent:skip(This, Options).
%% @hidden
skip(This) -> wxEvent:skip(This).
%% @hidden
shouldPropagate(This) -> wxEvent:shouldPropagate(This).
%% @hidden
resumePropagation(This,PropagationLevel) -> wxEvent:resumePropagation(This,PropagationLevel).
%% @hidden
isCommandEvent(This) -> wxEvent:isCommandEvent(This).
%% @hidden
getTimestamp(This) -> wxEvent:getTimestamp(This).
%% @hidden
getSkipped(This) -> wxEvent:getSkipped(This).
%% @hidden
getId(This) -> wxEvent:getId(This).