1wxSetCursorEvent(3)        Erlang Module Definition        wxSetCursorEvent(3)
2
3
4

NAME

6       wxSetCursorEvent - Functions for wxSetCursorEvent class
7

DESCRIPTION

9       A  wxSetCursorEvent is generated from wxWindow when the mouse cursor is
10       about to be set as a result of mouse motion.
11
12       This event gives the application the chance to perform  specific  mouse
13       cursor processing based on the current position of the mouse within the
14       window. Use setCursor/2 to specify the cursor you want to be displayed.
15
16       See: wx_misc:setCursor/1, wxWindow:setCursor/2
17
18       This class is derived (and can use functions) from: wxEvent
19
20       wxWidgets docs: wxSetCursorEvent
21

EVENTS

23       Use wxEvtHandler:connect/3 with wxSetCursorEventType  to  subscribe  to
24       events of this type.
25

DATA TYPES

27       wxSetCursorEvent() = wx:wx_object()
28
29       wxSetCursor() =
30           #wxSetCursor{type = wxSetCursorEvent:wxSetCursorEventType(),
31                        x = integer(),
32                        y = integer(),
33                        cursor = wxCursor:wxCursor()}
34
35       wxSetCursorEventType() = set_cursor
36

EXPORTS

38       getCursor(This) -> wxCursor:wxCursor()
39
40              Types:
41
42                 This = wxSetCursorEvent()
43
44              Returns a reference to the cursor specified by this event.
45
46       getX(This) -> integer()
47
48              Types:
49
50                 This = wxSetCursorEvent()
51
52              Returns the X coordinate of the mouse in client coordinates.
53
54       getY(This) -> integer()
55
56              Types:
57
58                 This = wxSetCursorEvent()
59
60              Returns the Y coordinate of the mouse in client coordinates.
61
62       hasCursor(This) -> boolean()
63
64              Types:
65
66                 This = wxSetCursorEvent()
67
68              Returns  true  if  the cursor specified by this event is a valid
69              cursor.
70
71              Remark: You cannot specify wxNullCursor with this event,  as  it
72              is not considered a valid cursor.
73
74       setCursor(This, Cursor) -> ok
75
76              Types:
77
78                 This = wxSetCursorEvent()
79                 Cursor = wxCursor:wxCursor()
80
81              Sets the cursor associated with this event.
82
83
84
85wxWidgets team.                     wx 2.1                 wxSetCursorEvent(3)