Elementary Cursor: Add documentation about hot spots
authorbdilly <bdilly@7cbeb6ba-43b4-40fd-8cce-4c39aea84d33>
Tue, 1 Nov 2011 21:14:06 +0000 (21:14 +0000)
committerbdilly <bdilly@7cbeb6ba-43b4-40fd-8cce-4c39aea84d33>
Tue, 1 Nov 2011 21:14:06 +0000 (21:14 +0000)
git-svn-id: svn+ssh://svn.enlightenment.org/var/svn/e/trunk/elementary@64619 7cbeb6ba-43b4-40fd-8cce-4c39aea84d33

src/lib/Elementary.h.in

index 0489b1d..2da76c9 100644 (file)
@@ -15691,7 +15691,10 @@ extern "C" {
     * cursors, also use ones coming from Edje theming files. Both
     * globally and per widget, Elementary makes it possible for one to
     * make the cursors lookup to be held on engines only or on
-    * Elementary's theme file, too.
+    * Elementary's theme file, too. To set cursor's hot spot,
+    * two data items should be added to cursor's theme: "hot_x" and
+    * "hot_y", that are the offset from upper-left corner of the cursor
+    * (coordinates 0,0).
     *
     * @{
     */