added some documentation for QGraphicsSystemCursor

1 files changed, 43 insertions, 1 deletions

diff --git a/src/gui/painting/qgraphicssystemcursor.cpp b/src/gui/painting/qgraphicssystemcursor.cpp
index 022dc64c70..3fc836d359 100644
--- a/src/gui/painting/qgraphicssystemcursor.cpp
+++ b/src/gui/painting/qgraphicssystemcursor.cpp
@@ -39,7 +39,6 @@
 **
 ****************************************************************************/
 #include "qgraphicssystemcursor.h"
-//#include "qlighthousegraphicsscreen.h"
 
 #include <QWidget>
 #include <QPainter>
@@ -52,6 +51,49 @@ QT_BEGIN_NAMESPACE
 
 QPointer<QGraphicsSystemCursor> QGraphicsSystemCursor::instance = 0;
 
+/*!
+    \class QGraphicsSystemCursor
+
+    \brief The QGraphicsSystemCursor class provides information about
+    pointer device events (movement, buttons), and requests to change
+    the currently displayed cursor.
+
+    Note that QGraphicsSystemCursor does not include any graphics for
+    display. An application that sets a QCursor may provide its own
+    graphics.
+
+    \sa QGraphicsSystemCursorImage
+*/
+
+/*!
+    \fn virtual void pointerEvent(const QMouseEvent & event)
+
+    This method is called by Qt whenever a QMouseEvent is generated by the
+    underlying pointer input. \a event is a reference to the QMouseEvent in
+    question. A default do-nothing implementation is provided.
+
+    \sa QApplicationPrivate::handleMouseEvent()
+*/
+
+/*!
+    \fn virtual void changeCursor(QCursor * widgetCursor, QWidget * widget)
+
+    \brief This method is called by Qt whenever the cursor graphic should be changed.
+
+    Implementation of this method is mandatory for a subclass of QGraphicsSystemCursor.
+
+    \a widgetCursor is a pointer to the QCursor that should be displayed.
+
+    \a widget is a pointer to the widget currently displayed at QCursor::pos(). Note
+    that this may be 0 if the current position is not occupied by a displayed widget.
+
+    \sa QApplicationPrivate::handleMouseEvent(), QCursor::pos()
+*/
+
+/*!
+    Constructs a QGraphicsSystemCursor
+
+*/
 QGraphicsSystemCursor::QGraphicsSystemCursor(QGraphicsSystemScreen *scr )
         : screen(scr)
 {