projects
/
supertux.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
added comments
[supertux.git]
/
lib
/
gui
/
mousecursor.h
diff --git
a/lib/gui/mousecursor.h
b/lib/gui/mousecursor.h
index
8ff45e6
..
30c9ae6
100644
(file)
--- a/
lib/gui/mousecursor.h
+++ b/
lib/gui/mousecursor.h
@@
-35,17
+35,34
@@
enum {
MC_HIDE
};
MC_HIDE
};
+/// Mouse cursor.
+/** Used to create mouse cursors.
+ The mouse cursors can be animated
+ and can be used in four different states.
+ (MC_NORMAL, MC_CLICK, MC_LINK or MC_HIDE) */
class MouseCursor
{
public:
class MouseCursor
{
public:
+ /// Constructor of MouseCursor.
+ /** Expects an imagefile for the cursor and the number of animation frames it contains. */
MouseCursor(std::string cursor_file, int frames);
~MouseCursor();
MouseCursor(std::string cursor_file, int frames);
~MouseCursor();
+ /// Get MouseCursor state.
+ /** (MC_NORMAL, MC_CLICK, MC_LINK or MC_HIDE) */
int state();
int state();
+ /// Set MouseCursor state.
+ /** (MC_NORMAL, MC_CLICK, MC_LINK or MC_HIDE) */
void set_state(int nstate);
void set_state(int nstate);
+ /// Define the middle of a MouseCursor.
+ /** Useful for cross mouse cursor images in example. */
void set_mid(int x, int y);
void set_mid(int x, int y);
+
+ /// Draw MouseCursor on screen.
void draw(DrawingContext& context);
void draw(DrawingContext& context);
+ /// Return the current cursor.
static MouseCursor* current() { return current_; };
static MouseCursor* current() { return current_; };
+ /// Set current cursor.
static void set_current(MouseCursor* pcursor) { current_ = pcursor; };
private:
static void set_current(MouseCursor* pcursor) { current_ = pcursor; };
private: