Explicitly mention that wxDateTime ticks origin is in UTC.

[wxWidgets.git] / interface / wx / cursor.h

diff --git a/interface/wx/cursor.h b/interface/wx/cursor.h
index 4be8f0555ebc0209352d5654a5328ad29d2bb217..7fc019850ebdf02fd7878e92ff681e29cdb6fc1c 100644 (file)
--- a/interface/wx/cursor.h
+++ b/interface/wx/cursor.h
@@ -135,8 +135,9 @@ public:
             platforms:
             - under Windows, it defaults to @c wxBITMAP_TYPE_CUR_RESOURCE.
               Other permitted types under Windows are @c wxBITMAP_TYPE_CUR
-              (to load a cursor from a .cur cursor file) and @c wxBITMAP_TYPE_ICO
-              (to load a cursor from a .ico icon file).
+              (to load a cursor from a .cur cursor file), @c wxBITMAP_TYPE_ICO
+              (to load a cursor from a .ico icon file) and @c wxBITMAP_TYPE_ANI
+              (to load a cursor from a .ani icon file).
             - under MacOS, it defaults to @c wxBITMAP_TYPE_MACCURSOR_RESOURCE;
               when specifying a string resource name, first the color cursors 'crsr' 
               and then the black/white cursors 'CURS' in the resource chain are scanned 
@@ -179,6 +180,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);