wxMouseEvent(3)

NAME
wxMouseEvent - See external documentation: wxMouseEvent.

DESCRIPTION

See external documentation: wxMouseEvent.

    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

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) -> boolean()

    Types:
        This = wxMouseEvent()

    See external documentation.

button(This, But) -> boolean()

    Types:
        This = wxMouseEvent()
        But = integer()

    See external documentation.

buttonDClick(This) -> boolean()

    Types:
        This = wxMouseEvent()

    Equivalent to buttonDClick(This, []).

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

    Types:
        This = wxMouseEvent()
        Option = {but, integer()}

    See external documentation.

buttonDown(This) -> boolean()

    Types:
        This = wxMouseEvent()

    Equivalent to buttonDown(This, []).

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

    Types:
        This = wxMouseEvent()
        Option = {but, integer()}

    See external documentation.

buttonUp(This) -> boolean()

    Types:
        This = wxMouseEvent()

    Equivalent to buttonUp(This, []).

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

    Types:
        This = wxMouseEvent()
        Option = {but, integer()}

    See external documentation.

cmdDown(This) -> boolean()

    Types:
        This = wxMouseEvent()

    See external documentation.

controlDown(This) -> boolean()

    Types:
        This = wxMouseEvent()

    See external documentation.

dragging(This) -> boolean()

    Types:
        This = wxMouseEvent()

    See external documentation.

entering(This) -> boolean()

    Types:
        This = wxMouseEvent()

    See external documentation.

getButton(This) -> integer()

    Types:
        This = wxMouseEvent()

    See external documentation.

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

    Types:
        This = wxMouseEvent()

    See external documentation.

getLogicalPosition(This, Dc) -> {X::integer(), Y::integer()}

    Types:
        This = wxMouseEvent()
        Dc = wxDC:wxDC()

    See external documentation.

getLinesPerAction(This) -> integer()

    Types:
        This = wxMouseEvent()

    See external documentation.

getWheelRotation(This) -> integer()

    Types:
        This = wxMouseEvent()

    See external documentation.

getWheelDelta(This) -> integer()

    Types:
        This = wxMouseEvent()

    See external documentation.

getX(This) -> integer()

    Types:
        This = wxMouseEvent()

    See external documentation.

getY(This) -> integer()

    Types:
        This = wxMouseEvent()

    See external documentation.

isButton(This) -> boolean()

    Types:
        This = wxMouseEvent()

    See external documentation.

isPageScroll(This) -> boolean()

    Types:
        This = wxMouseEvent()

    See external documentation.

leaving(This) -> boolean()

    Types:
        This = wxMouseEvent()

    See external documentation.

leftDClick(This) -> boolean()

    Types:
        This = wxMouseEvent()

    See external documentation.

leftDown(This) -> boolean()

    Types:
        This = wxMouseEvent()

    See external documentation.

leftIsDown(This) -> boolean()

    Types:
        This = wxMouseEvent()

    See external documentation.

leftUp(This) -> boolean()

    Types:
        This = wxMouseEvent()

    See external documentation.

metaDown(This) -> boolean()

    Types:
        This = wxMouseEvent()

    See external documentation.

middleDClick(This) -> boolean()

    Types:
        This = wxMouseEvent()

    See external documentation.

middleDown(This) -> boolean()

    Types:
        This = wxMouseEvent()

    See external documentation.

middleIsDown(This) -> boolean()

    Types:
        This = wxMouseEvent()

    See external documentation.

middleUp(This) -> boolean()

    Types:
        This = wxMouseEvent()

    See external documentation.

moving(This) -> boolean()

    Types:
        This = wxMouseEvent()

    See external documentation.

rightDClick(This) -> boolean()

    Types:
        This = wxMouseEvent()

    See external documentation.

rightDown(This) -> boolean()

    Types:
        This = wxMouseEvent()

    See external documentation.

rightIsDown(This) -> boolean()

    Types:
        This = wxMouseEvent()

    See external documentation.

rightUp(This) -> boolean()

    Types:
        This = wxMouseEvent()

    See external documentation.

shiftDown(This) -> boolean()

    Types:
        This = wxMouseEvent()

    See external documentation.

getWheelAxis(This) -> wx:wx_enum()

    Types:
        This = wxMouseEvent()

    See external documentation.
    Res = ?wxMOUSE_WHEEL_VERTICAL | ?wxMOUSE_WHEEL_HORIZONTAL

AUTHORS

<>