wxErlang

wxSizeEvent.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
%         (`  | '¯/ |_¯ |_¯ \ / |_¯ |\ | ¯|¯ 
%\  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_wxsizeevent.html">wxSizeEvent</a>.
%% <dl><dt>Use {@link wxEvtHandler:connect/3.} with EventType:</dt>
%% <dd><em>size</em></dd></dl>
%% See also the message variant {@link wxEvtHandler:wxSize(). #wxSize{}} event record type.
%%
%% <p>This class is derived (and can use functions) from:
%% <br />{@link wxEvent}
%% </p>
%% @type wxSizeEvent().  
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%   
%%   OVERVIEW
%%   ––––––––
%%   A size event holds information about size change events.
%%   
%%   The EVT_SIZE handler function will be called when 
%%   the window has been resized.
%%   
%%   You may wish to use this for frames to resize 
%%   their child windows as appropriate.
%%   
%%   Note that the size passed is of the whole window: 
%%   call wxWindow::GetClientSize for the area which may 
%%   be used by the application.
%%   
%%   When a window is resized, usually only a small part 
%%   of the window is damaged and you may only need to 
%%   repaint that area. However, if your drawing depends 
%%   on the size of the window, you may need to clear 
%%   the DC explicitly and repaint the whole window. 
%%   In which case, you may need to call wxWindow::Refresh 
%%   to invalidate the entire window.
%%   
%%   
%%   EVENT TABLE MACROS
%%   ——————————————————
%%   To process a size event, use this event handler macro 
%%   to direct input to a member function that takes 
%%   a wxSizeEvent argument.
%%   
%%      EVT_SIZE(func)    Process a wxEVT_SIZE event. 
%%   
%%   
%%   See Also:
%%   —————————
%%   wxSize
%%   
%%   
-module(wxSizeEvent).
-include("wxe.hrl").
-export([getSize/1]).

%% 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([wxSizeEvent/0]).
%% @hidden
parent_class(wxEvent) -> true;
parent_class(_Class) -> erlang:error({badtype, ?MODULE}).


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




           %·%% GET SIZE %%·%

%%   
%%    Returns the entire size of the window generating the size change event.
%%   
%% Return Value:
%% See Also:
%%*%%*%%
          -spec getSize(This) -> {W :: integer(), H :: integer()}
           when
           This :: wxSizeEvent().

           getSize(#wx_ref{type=ThisT,ref=ThisRef}) ->
                                                     ?CLASS(ThisT,wxSizeEvent),
                                       wxe_util:call(?wxSizeEvent_GetSize,
                                       <<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).