diff options
author | Erlang/OTP <[email protected]> | 2009-11-20 14:54:40 +0000 |
---|---|---|
committer | Erlang/OTP <[email protected]> | 2009-11-20 14:54:40 +0000 |
commit | 84adefa331c4159d432d22840663c38f155cd4c1 (patch) | |
tree | bff9a9c66adda4df2106dfd0e5c053ab182a12bd /lib/wx/src/gen/wxCloseEvent.erl | |
download | otp-84adefa331c4159d432d22840663c38f155cd4c1.tar.gz otp-84adefa331c4159d432d22840663c38f155cd4c1.tar.bz2 otp-84adefa331c4159d432d22840663c38f155cd4c1.zip |
The R13B03 release.OTP_R13B03
Diffstat (limited to 'lib/wx/src/gen/wxCloseEvent.erl')
-rw-r--r-- | lib/wx/src/gen/wxCloseEvent.erl | 110 |
1 files changed, 110 insertions, 0 deletions
diff --git a/lib/wx/src/gen/wxCloseEvent.erl b/lib/wx/src/gen/wxCloseEvent.erl new file mode 100644 index 0000000000..e8e25a448c --- /dev/null +++ b/lib/wx/src/gen/wxCloseEvent.erl @@ -0,0 +1,110 @@ +%% +%% %CopyrightBegin% +%% +%% Copyright Ericsson AB 2008-2009. All Rights Reserved. +%% +%% The contents of this file are subject to the Erlang Public License, +%% Version 1.1, (the "License"); you may not use this file except in +%% compliance with the License. You should have received a copy of the +%% Erlang Public License along with this software. If not, it can be +%% retrieved online at http://www.erlang.org/. +%% +%% Software distributed under the License is distributed on an "AS IS" +%% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See +%% the License for the specific language governing rights and limitations +%% under the License. +%% +%% %CopyrightEnd% +%% This file is generated DO NOT EDIT + +%% @doc See external documentation: <a href="http://www.wxwidgets.org/manuals/stable/wx_wxcloseevent.html">wxCloseEvent</a>. +%% <dl><dt>Use {@link wxEvtHandler:connect/3.} with EventType:</dt> +%% <dd><em>close_window</em>, <em>end_session</em>, <em>query_end_session</em></dd></dl> +%% See also the message variant {@link wxEvtHandler:wxClose(). #wxClose{}} event record type. +%% +%% <p>This class is derived (and can use functions) from: +%% <br />{@link wxEvent} +%% </p> +%% @type wxCloseEvent(). An object reference, The representation is internal +%% and can be changed without notice. It can't be used for comparsion +%% stored on disc or distributed for use on other nodes. + +-module(wxCloseEvent). +-include("wxe.hrl"). +-export([canVeto/1,getLoggingOff/1,setCanVeto/2,setLoggingOff/2,veto/1,veto/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]). + +%% @hidden +parent_class(wxEvent) -> true; +parent_class(_Class) -> erlang:error({badtype, ?MODULE}). + +%% @spec (This::wxCloseEvent()) -> bool() +%% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxcloseevent.html#wxcloseeventcanveto">external documentation</a>. +canVeto(#wx_ref{type=ThisT,ref=ThisRef}) -> + ?CLASS(ThisT,wxCloseEvent), + wxe_util:call(?wxCloseEvent_CanVeto, + <<ThisRef:32/?UI>>). + +%% @spec (This::wxCloseEvent()) -> bool() +%% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxcloseevent.html#wxcloseeventgetloggingoff">external documentation</a>. +getLoggingOff(#wx_ref{type=ThisT,ref=ThisRef}) -> + ?CLASS(ThisT,wxCloseEvent), + wxe_util:call(?wxCloseEvent_GetLoggingOff, + <<ThisRef:32/?UI>>). + +%% @spec (This::wxCloseEvent(), CanVeto::bool()) -> ok +%% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxcloseevent.html#wxcloseeventsetcanveto">external documentation</a>. +setCanVeto(#wx_ref{type=ThisT,ref=ThisRef},CanVeto) + when is_boolean(CanVeto) -> + ?CLASS(ThisT,wxCloseEvent), + wxe_util:cast(?wxCloseEvent_SetCanVeto, + <<ThisRef:32/?UI,(wxe_util:from_bool(CanVeto)):32/?UI>>). + +%% @spec (This::wxCloseEvent(), LogOff::bool()) -> ok +%% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxcloseevent.html#wxcloseeventsetloggingoff">external documentation</a>. +setLoggingOff(#wx_ref{type=ThisT,ref=ThisRef},LogOff) + when is_boolean(LogOff) -> + ?CLASS(ThisT,wxCloseEvent), + wxe_util:cast(?wxCloseEvent_SetLoggingOff, + <<ThisRef:32/?UI,(wxe_util:from_bool(LogOff)):32/?UI>>). + +%% @spec (This::wxCloseEvent()) -> ok +%% @equiv veto(This, []) +veto(This) + when is_record(This, wx_ref) -> + veto(This, []). + +%% @spec (This::wxCloseEvent(), [Option]) -> ok +%% Option = {veto, bool()} +%% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxcloseevent.html#wxcloseeventveto">external documentation</a>. +veto(#wx_ref{type=ThisT,ref=ThisRef}, Options) + when is_list(Options) -> + ?CLASS(ThisT,wxCloseEvent), + MOpts = fun({veto, Veto}, Acc) -> [<<1:32/?UI,(wxe_util:from_bool(Veto)):32/?UI>>|Acc]; + (BadOpt, _) -> erlang:error({badoption, BadOpt}) end, + BinOpt = list_to_binary(lists:foldl(MOpts, [<<0:32>>], Options)), + wxe_util:cast(?wxCloseEvent_Veto, + <<ThisRef:32/?UI, 0:32,BinOpt/binary>>). + + %% 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). |