%% %% %CopyrightBegin% %% %% Copyright Ericsson AB 2008-2012. 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: wxMouseEvent. %%
Use {@link wxEvtHandler:connect/3.} with EventType:
%%
left_down, left_up, middle_down, middle_up, right_down, right_up, motion, enter_window, leave_window, left_dclick, middle_dclick, right_dclick, mousewheel
%% See also the message variant {@link wxEvtHandler:wxMouse(). #wxMouse{}} event record type. %% %%

This class is derived (and can use functions) from: %%
{@link wxEvent} %%

%% @type wxMouseEvent(). 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(wxMouseEvent). -include("wxe.hrl"). -export([altDown/1,button/2,buttonDClick/1,buttonDClick/2,buttonDown/1,buttonDown/2, buttonUp/1,buttonUp/2,cmdDown/1,controlDown/1,dragging/1,entering/1, getButton/1,getLinesPerAction/1,getLogicalPosition/2,getPosition/1, getWheelDelta/1,getWheelRotation/1,getX/1,getY/1,isButton/1,isPageScroll/1, leaving/1,leftDClick/1,leftDown/1,leftIsDown/1,leftUp/1,metaDown/1, middleDClick/1,middleDown/1,middleIsDown/1,middleUp/1,moving/1,rightDClick/1, rightDown/1,rightIsDown/1,rightUp/1,shiftDown/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([wxMouseEvent/0]). %% @hidden parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -type wxMouseEvent() :: wx:wx_object(). %% @doc See external documentation. -spec altDown(This) -> boolean() when This::wxMouseEvent(). altDown(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_AltDown, <>). %% @doc See external documentation. -spec button(This, But) -> boolean() when This::wxMouseEvent(), But::integer(). button(#wx_ref{type=ThisT,ref=ThisRef},But) when is_integer(But) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_Button, <>). %% @equiv buttonDClick(This, []) -spec buttonDClick(This) -> boolean() when This::wxMouseEvent(). buttonDClick(This) when is_record(This, wx_ref) -> buttonDClick(This, []). %% @doc See external documentation. -spec buttonDClick(This, [Option]) -> boolean() when This::wxMouseEvent(), Option :: {but, integer()}. buttonDClick(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxMouseEvent), MOpts = fun({but, But}, Acc) -> [<<1:32/?UI,But:32/?UI>>|Acc]; (BadOpt, _) -> erlang:error({badoption, BadOpt}) end, BinOpt = list_to_binary(lists:foldl(MOpts, [<<0:32>>], Options)), wxe_util:call(?wxMouseEvent_ButtonDClick, <>). %% @equiv buttonDown(This, []) -spec buttonDown(This) -> boolean() when This::wxMouseEvent(). buttonDown(This) when is_record(This, wx_ref) -> buttonDown(This, []). %% @doc See external documentation. -spec buttonDown(This, [Option]) -> boolean() when This::wxMouseEvent(), Option :: {but, integer()}. buttonDown(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxMouseEvent), MOpts = fun({but, But}, Acc) -> [<<1:32/?UI,But:32/?UI>>|Acc]; (BadOpt, _) -> erlang:error({badoption, BadOpt}) end, BinOpt = list_to_binary(lists:foldl(MOpts, [<<0:32>>], Options)), wxe_util:call(?wxMouseEvent_ButtonDown, <>). %% @equiv buttonUp(This, []) -spec buttonUp(This) -> boolean() when This::wxMouseEvent(). buttonUp(This) when is_record(This, wx_ref) -> buttonUp(This, []). %% @doc See external documentation. -spec buttonUp(This, [Option]) -> boolean() when This::wxMouseEvent(), Option :: {but, integer()}. buttonUp(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxMouseEvent), MOpts = fun({but, But}, Acc) -> [<<1:32/?UI,But:32/?UI>>|Acc]; (BadOpt, _) -> erlang:error({badoption, BadOpt}) end, BinOpt = list_to_binary(lists:foldl(MOpts, [<<0:32>>], Options)), wxe_util:call(?wxMouseEvent_ButtonUp, <>). %% @doc See external documentation. -spec cmdDown(This) -> boolean() when This::wxMouseEvent(). cmdDown(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_CmdDown, <>). %% @doc See external documentation. -spec controlDown(This) -> boolean() when This::wxMouseEvent(). controlDown(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_ControlDown, <>). %% @doc See external documentation. -spec dragging(This) -> boolean() when This::wxMouseEvent(). dragging(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_Dragging, <>). %% @doc See external documentation. -spec entering(This) -> boolean() when This::wxMouseEvent(). entering(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_Entering, <>). %% @doc See external documentation. -spec getButton(This) -> integer() when This::wxMouseEvent(). getButton(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_GetButton, <>). %% @doc See external documentation. -spec getPosition(This) -> {X::integer(), Y::integer()} when This::wxMouseEvent(). getPosition(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_GetPosition, <>). %% @doc See external documentation. -spec getLogicalPosition(This, Dc) -> {X::integer(), Y::integer()} when This::wxMouseEvent(), Dc::wxDC:wxDC(). getLogicalPosition(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=DcT,ref=DcRef}) -> ?CLASS(ThisT,wxMouseEvent), ?CLASS(DcT,wxDC), wxe_util:call(?wxMouseEvent_GetLogicalPosition, <>). %% @doc See external documentation. -spec getLinesPerAction(This) -> integer() when This::wxMouseEvent(). getLinesPerAction(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_GetLinesPerAction, <>). %% @doc See external documentation. -spec getWheelRotation(This) -> integer() when This::wxMouseEvent(). getWheelRotation(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_GetWheelRotation, <>). %% @doc See external documentation. -spec getWheelDelta(This) -> integer() when This::wxMouseEvent(). getWheelDelta(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_GetWheelDelta, <>). %% @doc See external documentation. -spec getX(This) -> integer() when This::wxMouseEvent(). getX(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_GetX, <>). %% @doc See external documentation. -spec getY(This) -> integer() when This::wxMouseEvent(). getY(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_GetY, <>). %% @doc See external documentation. -spec isButton(This) -> boolean() when This::wxMouseEvent(). isButton(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_IsButton, <>). %% @doc See external documentation. -spec isPageScroll(This) -> boolean() when This::wxMouseEvent(). isPageScroll(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_IsPageScroll, <>). %% @doc See external documentation. -spec leaving(This) -> boolean() when This::wxMouseEvent(). leaving(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_Leaving, <>). %% @doc See external documentation. -spec leftDClick(This) -> boolean() when This::wxMouseEvent(). leftDClick(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_LeftDClick, <>). %% @doc See external documentation. -spec leftDown(This) -> boolean() when This::wxMouseEvent(). leftDown(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_LeftDown, <>). %% @doc See external documentation. -spec leftIsDown(This) -> boolean() when This::wxMouseEvent(). leftIsDown(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_LeftIsDown, <>). %% @doc See external documentation. -spec leftUp(This) -> boolean() when This::wxMouseEvent(). leftUp(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_LeftUp, <>). %% @doc See external documentation. -spec metaDown(This) -> boolean() when This::wxMouseEvent(). metaDown(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_MetaDown, <>). %% @doc See external documentation. -spec middleDClick(This) -> boolean() when This::wxMouseEvent(). middleDClick(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_MiddleDClick, <>). %% @doc See external documentation. -spec middleDown(This) -> boolean() when This::wxMouseEvent(). middleDown(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_MiddleDown, <>). %% @doc See external documentation. -spec middleIsDown(This) -> boolean() when This::wxMouseEvent(). middleIsDown(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_MiddleIsDown, <>). %% @doc See external documentation. -spec middleUp(This) -> boolean() when This::wxMouseEvent(). middleUp(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_MiddleUp, <>). %% @doc See external documentation. -spec moving(This) -> boolean() when This::wxMouseEvent(). moving(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_Moving, <>). %% @doc See external documentation. -spec rightDClick(This) -> boolean() when This::wxMouseEvent(). rightDClick(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_RightDClick, <>). %% @doc See external documentation. -spec rightDown(This) -> boolean() when This::wxMouseEvent(). rightDown(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_RightDown, <>). %% @doc See external documentation. -spec rightIsDown(This) -> boolean() when This::wxMouseEvent(). rightIsDown(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_RightIsDown, <>). %% @doc See external documentation. -spec rightUp(This) -> boolean() when This::wxMouseEvent(). rightUp(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_RightUp, <>). %% @doc See external documentation. -spec shiftDown(This) -> boolean() when This::wxMouseEvent(). shiftDown(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_ShiftDown, <>). %% 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).