wxMouseEvent(3)

MODULE
wxMouseEvent - See external documentation: wxMouseEvent.

DESCRIPTION

See external documentation: wxMouseEvent <http://www.wxwidgets.org/manuals/stable/wx_wxmouseevent.html>.

    Use 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, nc_left_down, nc_left_up, nc_middle_down, nc_middle_up, nc_right_down, nc_right_up, nc_motion, nc_enter_window, nc_leave_window, nc_left_dclick, nc_middle_dclick, nc_right_dclick

See also the message variant #wxMouse{} event record type.

This class is derived (and can use functions) from:
wxEvent

DATA TYPES

    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.

EXPORTS

altDown(This::wxMouseEvent()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxmouseevent.html#wxmouseeventaltdown>.

button(This::wxMouseEvent(), But::integer()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxmouseevent.html#wxmouseeventbutton>.

buttonDClick(This::wxMouseEvent()) -> bool()

    Equivalent to buttonDClick(This, []).

buttonDClick(This::wxMouseEvent(), Options::[Option]) -> bool()

    Types
        Option = {but, integer()}

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxmouseevent.html#wxmouseeventbuttondclick>.

buttonDown(This::wxMouseEvent()) -> bool()

    Equivalent to buttonDown(This, []).

buttonDown(This::wxMouseEvent(), Options::[Option]) -> bool()

    Types
        Option = {but, integer()}

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxmouseevent.html#wxmouseeventbuttondown>.

buttonUp(This::wxMouseEvent()) -> bool()

    Equivalent to buttonUp(This, []).

buttonUp(This::wxMouseEvent(), Options::[Option]) -> bool()

    Types
        Option = {but, integer()}

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxmouseevent.html#wxmouseeventbuttonup>.

cmdDown(This::wxMouseEvent()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxmouseevent.html#wxmouseeventcmddown>.

controlDown(This::wxMouseEvent()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxmouseevent.html#wxmouseeventcontroldown>.

dragging(This::wxMouseEvent()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxmouseevent.html#wxmouseeventdragging>.

entering(This::wxMouseEvent()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxmouseevent.html#wxmouseevententering>.

getButton(This::wxMouseEvent()) -> integer()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxmouseevent.html#wxmouseeventgetbutton>.

getPosition(This::wxMouseEvent()) -> {X::integer(), Y::integer()}

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxmouseevent.html#wxmouseeventgetposition>.

getLogicalPosition(This::wxMouseEvent(), Dc::wxDC() (see module wxDC)) -> {X::integer(), Y::integer()}

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxmouseevent.html#wxmouseeventgetlogicalposition>.

getLinesPerAction(This::wxMouseEvent()) -> integer()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxmouseevent.html#wxmouseeventgetlinesperaction>.

getWheelRotation(This::wxMouseEvent()) -> integer()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxmouseevent.html#wxmouseeventgetwheelrotation>.

getWheelDelta(This::wxMouseEvent()) -> integer()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxmouseevent.html#wxmouseeventgetwheeldelta>.

getX(This::wxMouseEvent()) -> integer()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxmouseevent.html#wxmouseeventgetx>.

getY(This::wxMouseEvent()) -> integer()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxmouseevent.html#wxmouseeventgety>.

isButton(This::wxMouseEvent()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxmouseevent.html#wxmouseeventisbutton>.

isPageScroll(This::wxMouseEvent()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxmouseevent.html#wxmouseeventispagescroll>.

leaving(This::wxMouseEvent()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxmouseevent.html#wxmouseeventleaving>.

leftDClick(This::wxMouseEvent()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxmouseevent.html#wxmouseeventleftdclick>.

leftDown(This::wxMouseEvent()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxmouseevent.html#wxmouseeventleftdown>.

leftIsDown(This::wxMouseEvent()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxmouseevent.html#wxmouseeventleftisdown>.

leftUp(This::wxMouseEvent()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxmouseevent.html#wxmouseeventleftup>.

metaDown(This::wxMouseEvent()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxmouseevent.html#wxmouseeventmetadown>.

middleDClick(This::wxMouseEvent()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxmouseevent.html#wxmouseeventmiddledclick>.

middleDown(This::wxMouseEvent()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxmouseevent.html#wxmouseeventmiddledown>.

middleIsDown(This::wxMouseEvent()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxmouseevent.html#wxmouseeventmiddleisdown>.

middleUp(This::wxMouseEvent()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxmouseevent.html#wxmouseeventmiddleup>.

moving(This::wxMouseEvent()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxmouseevent.html#wxmouseeventmoving>.

rightDClick(This::wxMouseEvent()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxmouseevent.html#wxmouseeventrightdclick>.

rightDown(This::wxMouseEvent()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxmouseevent.html#wxmouseeventrightdown>.

rightIsDown(This::wxMouseEvent()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxmouseevent.html#wxmouseeventrightisdown>.

rightUp(This::wxMouseEvent()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxmouseevent.html#wxmouseeventrightup>.

shiftDown(This::wxMouseEvent()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxmouseevent.html#wxmouseeventshiftdown>.