.TH wxSetCursorEvent 3erl "wx 2.2.2.1" "wxWidgets team." "Erlang Module Definition"
.SH NAME
wxSetCursorEvent \- Functions for wxSetCursorEvent class
.SH DESCRIPTION
.LP
A \fIwxSetCursorEvent\fR\& is generated from \fIwxWindow\fR\& when the mouse cursor is about to be set as a result of mouse motion\&.
.LP
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 \fIsetCursor/2\fR\& to specify the cursor you want to be displayed\&.
.LP
See: \fIwx_misc:setCursor/1\fR\&, \fIwxWindow:setCursor/2\fR\& 
.LP
This class is derived (and can use functions) from: \fIwxEvent\fR\&
.LP
wxWidgets docs: wxSetCursorEvent
.SH "EVENTS"

.LP
Use \fIwxEvtHandler:connect/3\fR\& with \fIwxSetCursorEventType\fR\& to subscribe to events of this type\&.
.SH DATA TYPES
.nf

\fBwxSetCursorEvent()\fR\& = wx:wx_object()
.br
.fi
.nf

\fBwxSetCursor()\fR\& = 
.br
    #wxSetCursor{type = wxSetCursorEvent:wxSetCursorEventType(),
.br
                 x = integer(),
.br
                 y = integer(),
.br
                 cursor = wxCursor:wxCursor()}
.br
.fi
.nf

\fBwxSetCursorEventType()\fR\& = set_cursor
.br
.fi
.SH EXPORTS
.LP
.nf

.B
getCursor(This) -> wxCursor:wxCursor()
.br
.fi
.br
.RS
.LP
Types:

.RS 3
This = wxSetCursorEvent()
.br
.RE
.RE
.RS
.LP
Returns a reference to the cursor specified by this event\&.
.RE

.LP
.nf

.B
getX(This) -> integer()
.br
.fi
.br
.RS
.LP
Types:

.RS 3
This = wxSetCursorEvent()
.br
.RE
.RE
.RS
.LP
Returns the X coordinate of the mouse in client coordinates\&.
.RE

.LP
.nf

.B
getY(This) -> integer()
.br
.fi
.br
.RS
.LP
Types:

.RS 3
This = wxSetCursorEvent()
.br
.RE
.RE
.RS
.LP
Returns the Y coordinate of the mouse in client coordinates\&.
.RE

.LP
.nf

.B
hasCursor(This) -> boolean()
.br
.fi
.br
.RS
.LP
Types:

.RS 3
This = wxSetCursorEvent()
.br
.RE
.RE
.RS
.LP
Returns true if the cursor specified by this event is a valid cursor\&.
.LP
Remark: You cannot specify wxNullCursor with this event, as it is not considered a valid cursor\&.
.RE

.LP
.nf

.B
setCursor(This, Cursor) -> ok
.br
.fi
.br
.RS
.LP
Types:

.RS 3
This = wxSetCursorEvent()
.br
Cursor = wxCursor:wxCursor()
.br
.RE
.RE
.RS
.LP
Sets the cursor associated with this event\&.
.RE