Document "raw control" use with accelerators.

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

diff --git a/interface/wx/cursor.h b/interface/wx/cursor.h
index ec30445c895f5570776096ccf31a4d76ac1b19c4..67714c5a877c4e5b141b24e0351f6932c89946b3 100644 (file)
--- a/interface/wx/cursor.h
+++ b/interface/wx/cursor.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxCursor
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxCursor
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /**
 /////////////////////////////////////////////////////////////////////////////
 
 /**


@@ -13,7 +13,7 @@
     pointer is, with a picture that might indicate the interpretation of a
     mouse click. As with icons, cursors in X and MS Windows are created in a
     different manner. Therefore, separate cursors will be created for the
     pointer is, with a picture that might indicate the interpretation of a
     mouse click. As with icons, cursors in X and MS Windows are created in a
     different manner. Therefore, separate cursors will be created for the

-    different environments.  Platform-specific methods for creating a wxCursor
+    different environments. Platform-specific methods for creating a wxCursor

     object are catered for, and this is an occasion where conditional
     compilation will probably be required (see wxIcon for an example).
 
     object are catered for, and this is an occasion where conditional
     compilation will probably be required (see wxIcon for an example).
 


@@ -26,8 +26,8 @@
 
     The following is an example of creating a cursor from 32x32 bitmap data
     (down_bits) and a mask (down_mask) where 1 is black and 0 is white for the
 
     The following is an example of creating a cursor from 32x32 bitmap data
     (down_bits) and a mask (down_mask) where 1 is black and 0 is white for the

-    bits, and 1 is opaque and 0 is transparent for the mask. It works on
-    Windows and GTK+.
+    bits, and 1 is opaque and 0 is transparent for the mask.
+    It works on Windows and GTK+.

 
     @code
     static char down_bits[] = { 255, 255, 255, 255, 31,
 
     @code
     static char down_bits[] = { 255, 255, 255, 255, 31,


@@ -63,7 +63,7 @@
         down_image.SetOption(wxIMAGE_OPTION_CUR_HOTSPOT_X, 6);
         down_image.SetOption(wxIMAGE_OPTION_CUR_HOTSPOT_Y, 14);
         wxCursor down_cursor = wxCursor(down_image);
         down_image.SetOption(wxIMAGE_OPTION_CUR_HOTSPOT_X, 6);
         down_image.SetOption(wxIMAGE_OPTION_CUR_HOTSPOT_Y, 14);
         wxCursor down_cursor = wxCursor(down_image);

-    #else
+    #elif defined(__WXGTK__) or defined(__WXMOTIF__)

         wxCursor down_cursor = wxCursor(down_bits, 32, 32, 6, 14,
                                         down_mask, wxWHITE, wxBLACK);
     #endif
         wxCursor down_cursor = wxCursor(down_bits, 32, 32, 6, 14,
                                         down_mask, wxWHITE, wxBLACK);
     #endif


@@ -78,77 +78,84 @@
     - ::wxHOURGLASS_CURSOR
     - ::wxCROSS_CURSOR
 
     - ::wxHOURGLASS_CURSOR
     - ::wxCROSS_CURSOR
 

-    @see wxBitmap, wxIcon, wxWindow::SetCursor(), wxSetCursor(),
-         ::wxStockCursor
+    @see wxBitmap, wxIcon, wxWindow::SetCursor(), wxSetCursor(), ::wxStockCursor

 */
 */

-class wxCursor : public wxBitmap
+class wxCursor : public wxGDIObject

 {
 public:
     /**
         Default constructor.
     */
     wxCursor();
 {
 public:
     /**
         Default constructor.
     */
     wxCursor();

+

     /**
     /**

-        Constructs a cursor by passing an array of bits (Motif and GTK+ only).
-        @a maskBits is used only under Motif and GTK+. The parameters @a fg and
-        @a bg are only present on GTK+, and force the cursor to use particular
-        background and foreground colours.
+        Constructs a cursor by passing an array of bits (XBM data).
+
+        The parameters @a fg and @a bg have an effect only on GTK+, and force
+        the cursor to use particular background and foreground colours.

 
         If either @a hotSpotX or @a hotSpotY is -1, the hotspot will be the
         centre of the cursor image (Motif only).
 
         @param bits
 
         If either @a hotSpotX or @a hotSpotY is -1, the hotspot will be the
         centre of the cursor image (Motif only).
 
         @param bits

-            An array of bits.
-        @param maskBits
-            Bits for a mask bitmap.
+            An array of XBM data bits.

         @param width
             Cursor width.
         @param height
             Cursor height.
         @param hotSpotX
         @param width
             Cursor width.
         @param height
             Cursor height.
         @param hotSpotX

-            Hotspot x coordinate.
+            Hotspot x coordinate (relative to the top left of the image).

         @param hotSpotY
         @param hotSpotY

-            Hotspot y coordinate.
+            Hotspot y coordinate (relative to the top left of the image).
+        @param maskBits
+            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,
     */
     wxCursor(const char bits[], int width, int height,
              int hotSpotX = -1, int hotSpotY = -1,

-             const char maskBits[] = NULL,
-             wxColour* fg = NULL, wxColour* bg = NULL);
+             const char maskBits[] = NULL);
+

     /**
         Constructs a cursor by passing a string resource name or filename.
 
     /**
         Constructs a cursor by passing a string resource name or filename.
 

-        On MacOS 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.
-
-        @a hotSpotX and @a hotSpotY are currently only used under Windows when
-        loading from an icon file, to specify the cursor hotspot relative to
-        the top left of the image.
+        The arguments @a hotSpotX and @a hotSpotY are only used when there's no
+        hotspot info in the resource/image-file to load (e.g. when using
+        @c wxBITMAP_TYPE_ICO under wxMSW or @c wxBITMAP_TYPE_XPM under wxGTK).

 
 

+        @param cursorName
+            The name of the resource or the image file to load.

         @param type
         @param type

-            Icon type to load. Under Motif, type defaults to wxBITMAP_TYPE_XBM.
-            Under Windows, it defaults to wxBITMAP_TYPE_CUR_RESOURCE. Under
-            MacOS, it defaults to wxBITMAP_TYPE_MACCURSOR_RESOURCE.
-            Under X, the permitted cursor types are:
-            <ul>
-            <li>wxBITMAP_TYPE_XBM - Load an X bitmap file.</li>
-            </ul>
-            Under Windows, the permitted types are:
-            - wxBITMAP_TYPE_CUR - Load a cursor from a .cur cursor file (only
-                                  if USE_RESOURCE_LOADING_IN_MSW is enabled in
-                                  setup.h).
-            - wxBITMAP_TYPE_CUR_RESOURCE - Load a Windows resource (as
-                                           specified in the .rc file).
-            - wxBITMAP_TYPE_ICO - Load a cursor from a .ico icon file (only if
-                                  USE_RESOURCE_LOADING_IN_MSW is enabled in
-                                  setup.h). Specify @a hotSpotX and @a hotSpotY.
+            Icon type to load. It defaults to @c wxCURSOR_DEFAULT_TYPE,
+            which is a @#define associated to different values on different
+            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).
+            - 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. 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.
+            - under Motif, it defaults to @c wxBITMAP_TYPE_XBM.

         @param hotSpotX
         @param hotSpotX

-            Hotspot x coordinate.
+            Hotspot x coordinate (relative to the top left of the image).

         @param hotSpotY
         @param hotSpotY

-            Hotspot y coordinate.
+            Hotspot y coordinate (relative to the top left of the image).

     */
     */

-    wxCursor(const wxString& cursorName, long type,
+    wxCursor(const wxString& cursorName,
+             wxBitmapType type = wxCURSOR_DEFAULT_TYPE,

              int hotSpotX = 0, int hotSpotY = 0);
              int hotSpotX = 0, int hotSpotY = 0);

+

     /**
         Constructs a cursor using a cursor identifier.
 
     /**
         Constructs a cursor using a cursor identifier.
 


@@ -156,24 +163,33 @@ public:
             A stock cursor identifier. See ::wxStockCursor.
     */
     wxCursor(wxStockCursor cursorId);
             A stock cursor identifier. See ::wxStockCursor.
     */
     wxCursor(wxStockCursor cursorId);

+

     /**
         Constructs a cursor from a wxImage. If cursor are monochrome on the
         current platform, colors with the RGB elements all greater than 127
         will be foreground, colors less than this background. The mask (if any)
         will be used to specify the transparent area.
 
     /**
         Constructs a cursor from a wxImage. If cursor are monochrome on the
         current platform, colors with the RGB elements all greater than 127
         will be foreground, colors less than this background. The mask (if any)
         will be used to specify the transparent area.
 

-        In wxMSW the foreground will be white and the background black. If the
-        cursor is larger than 32x32 it is resized.
+        In wxMSW the foreground will be white and the background black.
+        If the cursor is larger than 32x32 it is resized.

 
         In wxGTK, colour cursors and alpha channel are supported (starting from
         GTK+ 2.2). Otherwise the two most frequent colors will be used for
 
         In wxGTK, colour cursors and alpha channel are supported (starting from
         GTK+ 2.2). Otherwise the two most frequent colors will be used for

-        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).
+        foreground and background. In any case, the cursor will be displayed
+        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);
     */
     wxCursor(const wxImage& image);

+

     /**
         Copy constructor, uses @ref overview_refcount "reference counting".
 
     /**
         Copy constructor, uses @ref overview_refcount "reference counting".
 


@@ -196,12 +212,12 @@ public:
     /**
         Returns @true if cursor data is present.
     */
     /**
         Returns @true if cursor data is present.
     */

-    bool IsOk() const;
+    virtual bool IsOk() const;

 
     /**
         Assignment operator, using @ref overview_refcount "reference counting".
     */
 
     /**
         Assignment operator, using @ref overview_refcount "reference counting".
     */

-    wxCursor operator =(const wxCursor& cursor);
+    wxCursor& operator =(const wxCursor& cursor);

 };
 
 
 };