FIFE::Cursor Class Reference
#include <cursor.h>
List of all members.
Detailed Description
Cursor class manages mouse cursor handling
Definition at line 84 of file cursor.h.
Constructor & Destructor Documentation
virtual FIFE::Cursor::~Cursor |
( |
|
) |
[inline, virtual] |
Destructor.
Definition at line 92 of file cursor.h.
Member Function Documentation
void FIFE::Cursor::draw |
( |
|
) |
[virtual] |
draws cursor on screen
Definition at line 106 of file cursor.cpp.
unsigned int FIFE::Cursor::getDragId |
( |
|
) |
const [inline] |
Gets the current mouse cursor pool id
Definition at line 125 of file cursor.h.
Gets the current mouse cursor type
Definition at line 121 of file cursor.h.
unsigned int FIFE::Cursor::getId |
( |
|
) |
const [inline] |
Gets the current mouse cursor pool id
Definition at line 117 of file cursor.h.
unsigned int FIFE::Cursor::getNativeId |
( |
unsigned int |
cursor_id |
) |
[protected] |
To get some consistancy between platforms, this function checks if cursor_id matches any of the values in NativeCursor, and returns the resource ID specific to the running platform. If no match is found, cursor_id is returned.
- Parameters:
-
| One | of the values in NativeCursor |
Definition at line 145 of file cursor.cpp.
Gets the current mouse cursor type
Definition at line 113 of file cursor.h.
unsigned int FIFE::Cursor::getX |
( |
|
) |
const [inline] |
Gets the current mouse x position
Definition at line 129 of file cursor.h.
unsigned int FIFE::Cursor::getY |
( |
|
) |
const [inline] |
Gets the current mouse y position
Definition at line 133 of file cursor.h.
void FIFE::Cursor::set |
( |
MouseCursorType |
ctype, |
|
|
unsigned int |
cursor_id = 0 | |
|
) |
| | |
Sets the current mouse cursor type and possible pool value
- Parameters:
-
| ctype | cursor type |
| cursor_id | Pool id to image or animation. For native cursors, this is the resource id to native cursor, or one of the values in NativeCursor |
Definition at line 71 of file cursor.cpp.
References Cursor().
void FIFE::Cursor::setDrag |
( |
MouseCursorType |
ctype, |
|
|
unsigned int |
drag_id = 0 , |
|
|
int |
drag_offset_x = 0 , |
|
|
int |
drag_offset_y = 0 | |
|
) |
| | |
Sets the current drag cursor type and pool value
- Parameters:
-
| ctype | drag cursor type |
| drag_id | pool id for the drag cursor (either image or animation) |
| drag_offset | offset of drag image shown with cursor |
Definition at line 94 of file cursor.cpp.
void FIFE::Cursor::setNativeCursor |
( |
unsigned int |
cursor_id |
) |
[protected] |
Sets the cursor to a native type.
- Parameters:
-
| cursor_id | Resource id to native cursor, or one of the values in NativeCursor |
Definition at line 233 of file cursor.cpp.
The documentation for this class was generated from the following files: