From: Adi Shavit <adishavit@gmail.com>
Date: Thu, 16 Jan 2014 09:25:57 +0000 (+0200)
Subject: Updated docs.
X-Git-Tag: accepted/tizen/6.0/unified/20201030.111113~3561^2~2
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=8802d62cc5afd16987947ff4c0334e528141a4a4;p=platform%2Fupstream%2Fopencv.git

Updated docs.
---

diff --git a/modules/highgui/doc/user_interface.rst b/modules/highgui/doc/user_interface.rst
index 8b655a1..58b040b 100644
--- a/modules/highgui/doc/user_interface.rst
+++ b/modules/highgui/doc/user_interface.rst
@@ -208,6 +208,24 @@ Sets mouse handler for the specified window
     :param userdata: The optional parameter passed to the callback.
 
 
+getMouseWheelDelta
+------------------
+Gets the mouse-wheel motion delta, when handling mouse-wheel events EVENT_MOUSEWHEEL and EVENT_MOUSEHWHEEL.
+
+.. ocv:function:: int getMouseWheelDelta(int flags)
+
+.. ocv:cfunction:: CV_GET_WHEEL_DELTA(flags)
+
+    :param flags: The mouse callback flags parameter.
+
+
+For EVENT_MOUSEWHEEL positive and negative values mean forward and backward scrolling, respectively.
+For EVENT_MOUSEHWHEEL, where available, positive and negative values mean right and left scrolling, respectively.
+
+.. note::
+
+    Mouse-wheel event are currently available only on Windows. On Windows Units are usually multiples of 120.
+
 setTrackbarPos
 ------------------
 Sets the trackbar position.