[Scummvm-cvs-logs] SF.net SVN: scummvm:[41968] scummvm/trunk

[lordhoto at users.sourceforge.net]

Revision: 41968
          http://scummvm.svn.sourceforge.net/scummvm/?rev=41968&view=rev
Author:   lordhoto
Date:     2009-06-29 23:23:29 +0000 (Mon, 29 Jun 2009)

Log Message:
-----------
Add some more explanation to Graphics::CursorManager::showMouse and OSystem::showMouse.

Modified Paths:
--------------
    scummvm/trunk/common/system.h
    scummvm/trunk/graphics/cursorman.h

Modified: scummvm/trunk/common/system.h
===================================================================
--- scummvm/trunk/common/system.h	2009-06-29 23:14:35 UTC (rev 41967)
+++ scummvm/trunk/common/system.h	2009-06-29 23:23:29 UTC (rev 41968)
@@ -673,7 +673,18 @@
 	 */
 	//@{
 
-	/** Show or hide the mouse cursor. */
+	/**
+	 * Show or hide the mouse cursor.
+	 *
+	 * Currently the backend is not required to immediately draw the
+	 * mouse cursor on showMouse(true).
+	 *
+	 * TODO: We might want to reconsider this fact,
+	 * check Graphics::CursorManager::showMouse for some details about
+	 * this.
+	 *
+	 * @see Graphics::CursorManager::showMouse
+	 */
 	virtual bool showMouse(bool visible) = 0;
 
 	/**

Modified: scummvm/trunk/graphics/cursorman.h
===================================================================
--- scummvm/trunk/graphics/cursorman.h	2009-06-29 23:14:35 UTC (rev 41967)
+++ scummvm/trunk/graphics/cursorman.h	2009-06-29 23:23:29 UTC (rev 41968)
@@ -36,7 +36,21 @@
 	/** Query whether the mouse cursor is visible. */
 	bool isVisible();
 
-	/** Show or hide the mouse cursor. */
+	/**
+	 * Show or hide the mouse cursor.
+	 *
+	 * This function does not call OSystem::updateScreen, when visible is true.
+	 * This fact might result in a non visible mouse cursor if the caller does
+	 * not call OSystem::updateScreen itself after a showMouse(true) call.
+	 *
+	 * TODO: We might want to reconsider this behavior, it might be confusing
+	 * for the user to call OSystem::updateScreen separately, on the other
+	 * hand OSystem::updateScreen might as well display unwanted changes on
+	 * the screen. Another alternative would be to let the backend worry
+	 * about this on OSystem::showMouse call.
+	 *
+	 * @see OSystem::showMouse.
+	 */
 	bool showMouse(bool visible);
 
 	/**


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.