From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Tue, 3 Jan 2012 00:40:27 +0000 (+0000)
Subject: Document wxIMAGE_OPTION_CUR_HOTSPOT_[XY] in wxCursor ctor.
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/bb65ca31d7a500c90d93b4808ea3fe35c1a1ff1b

Document wxIMAGE_OPTION_CUR_HOTSPOT_[XY] in wxCursor ctor.

These options were already mentioned in wxCursor documentation but not
prominently enough, so mention them explicitly in the documentation of
wxCursor ctor from wxImage.

Closes #13820.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70247 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---

diff --git a/interface/wx/cursor.h b/interface/wx/cursor.h
index 4be8f0555e..67714c5a87 100644
--- a/interface/wx/cursor.h
+++ b/interface/wx/cursor.h
@@ -179,6 +179,14 @@ public:
         at the size of the image.
 
         Under wxMac (Cocoa), large cursors are supported.
+
+        Notice that the @a image can define the cursor hot spot. To set it you
+        need to use wxImage::SetOption() with @c wxIMAGE_OPTION_CUR_HOTSPOT_X
+        or @c wxIMAGE_OPTION_CUR_HOTSPOT_Y, e.g.
+        @code
+            image.SetOption(wxIMAGE_OPTION_CUR_HOTSPOT_X, hotSpotX);
+            image.SetOption(wxIMAGE_OPTION_CUR_HOTSPOT_X, hotSpotY);
+        @endcode
     */
     wxCursor(const wxImage& image);