From: Tobias Gläßer <tobi.web@gmx.de>
Date: Tue, 20 Jul 2004 19:41:29 +0000 (+0000)
Subject: added comments
X-Git-Url: https://git.verplant.org/?a=commitdiff_plain;ds=sidebyside;h=107229850b95120c161024677894a1faec3f4ef9;p=supertux.git

added comments

SVN-Revision: 1602
---

diff --git a/lib/gui/mousecursor.h b/lib/gui/mousecursor.h
index 8ff45e640..30c9ae640 100644
--- a/lib/gui/mousecursor.h
+++ b/lib/gui/mousecursor.h
@@ -35,17 +35,34 @@ enum {
   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:
+  /// 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();
+  /// Get MouseCursor state.
+  /** (MC_NORMAL, MC_CLICK, MC_LINK or MC_HIDE) */
   int state();
+  /// Set MouseCursor state.
+  /** (MC_NORMAL, MC_CLICK, MC_LINK or MC_HIDE) */
   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);
+  
+  /// Draw MouseCursor on screen.
   void draw(DrawingContext& context);
     
+  /// Return the current cursor.
   static MouseCursor* current() { return current_; };
+  /// Set current cursor.
   static void set_current(MouseCursor* pcursor) {  current_ = pcursor; };
     
 private: