Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

wxSetCursorEvent (3erl)

Name

wxSetCursorEvent - Functions for wxSetCursorEvent class

Synopsis

Please see following description for synopsis

Description

wxSetCursorEvent(3)        Erlang Module Definition        wxSetCursorEvent(3)



NAME
       wxSetCursorEvent - Functions for wxSetCursorEvent class

DESCRIPTION
       A  wxSetCursorEvent is generated from wxWindow when the mouse cursor is
       about to be set as a result of mouse motion.

       This event gives the application the chance to perform  specific  mouse
       cursor processing based on the current position of the mouse within the
       window. Use setCursor/2 to specify the cursor you want to be displayed.

       See: wx_misc:setCursor/1, wxWindow:setCursor/2

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

       wxWidgets docs: wxSetCursorEvent

EVENTS
       Use wxEvtHandler:connect/3 with wxSetCursorEventType  to  subscribe  to
       events of this type.

DATA TYPES
       wxSetCursorEvent() = wx:wx_object()

       wxSetCursor() =
           #wxSetCursor{type = wxSetCursorEvent:wxSetCursorEventType(),
                        x = integer(),
                        y = integer(),
                        cursor = wxCursor:wxCursor()}

       wxSetCursorEventType() = set_cursor

EXPORTS
       getCursor(This) -> wxCursor:wxCursor()

              Types:

                 This = wxSetCursorEvent()

              Returns a reference to the cursor specified by this event.

       getX(This) -> integer()

              Types:

                 This = wxSetCursorEvent()

              Returns the X coordinate of the mouse in client coordinates.

       getY(This) -> integer()

              Types:

                 This = wxSetCursorEvent()

              Returns the Y coordinate of the mouse in client coordinates.

       hasCursor(This) -> boolean()

              Types:

                 This = wxSetCursorEvent()

              Returns  true  if  the cursor specified by this event is a valid
              cursor.

              Remark: You cannot specify wxNullCursor with this event,  as  it
              is not considered a valid cursor.

       setCursor(This, Cursor) -> ok

              Types:

                 This = wxSetCursorEvent()
                 Cursor = wxCursor:wxCursor()

              Sets the cursor associated with this event.



wxWidgets team.                    wx 2.1.1                wxSetCursorEvent(3)