X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/d6764050d805a7e7575ba7126e2f78bd64db8117..1ec4e9c2b72a01a7ba7da569e0f8d04a81aaba10:/interface/wx/cursor.h diff --git a/interface/wx/cursor.h b/interface/wx/cursor.h index 7c778ab81e..67714c5a87 100644 --- a/interface/wx/cursor.h +++ b/interface/wx/cursor.h @@ -3,7 +3,7 @@ // Purpose: interface of wxCursor // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @@ -111,6 +111,10 @@ public: Bits for a mask bitmap. @onlyfor{wxgtk,wxmotif} + + @beginWxPerlOnly + In wxPerl use Wx::Cursor->newData(bits, width, height, hotSpotX = -1, hotSpotY = -1, maskBits = 0). + @endWxPerlOnly */ wxCursor(const char bits[], int width, int height, int hotSpotX = -1, int hotSpotY = -1, @@ -136,7 +140,9 @@ public: - 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 - through. + through. Note that resource forks are deprecated on OS X so this + is only available for legacy reasons and should not be used in + new code. - under GTK, it defaults to @c wxBITMAP_TYPE_XPM. See the wxCursor(const wxImage& image) ctor for more info. - under X11, it defaults to @c wxBITMAP_TYPE_XPM. @@ -172,8 +178,15 @@ public: foreground and background. In any case, the cursor will be displayed at the size of the image. - In wxMac, if the cursor is larger than 16x16 it is resized and - currently only shown as black/white (mask respected). + 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);