Doc: Small change to QAbstractItemDelegate::editorEvent()

    Task-number: QTBUG-2446
    Reviewed-by: Marius Bugge Monsen

1 files changed, 8 insertions, 2 deletions

diff --git a/src/gui/itemviews/qabstractitemdelegate.cpp b/src/gui/itemviews/qabstractitemdelegate.cpp
index 775bf7d..0ea6d67 100644
--- a/src/gui/itemviews/qabstractitemdelegate.cpp
+++ b/src/gui/itemviews/qabstractitemdelegate.cpp
@@ -291,8 +291,14 @@ void QAbstractItemDelegate::updateEditorGeometry(QWidget *,
 }
 
 /*!
-    Whenever an event occurs, this function is called with the \a event
-    \a model \a option and the \a index that corresponds to the item being edited.
+    When editing of an item starts, this function is called with the
+    \a event that triggered the editing, the \a model, the \a index of
+    the item, and the \a option used for rendering the item.
+
+    Mouse events are sent to editorEvent() even if they don't start
+    editing of the item. This can, for instance, be useful if you wish
+    to open a context menu when the right mouse button is pressed on
+    an item.
 
     The base implementation returns false (indicating that it has not
     handled the event).