X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/23324ae1c7938ba904770fc456d3c07764b9c5e9..fdd4a8974abc0914e2dd561f6b2875467dbd6827:/interface/cursor.h

diff --git a/interface/cursor.h b/interface/cursor.h
index 390252858e..b4fca7a39b 100644
--- a/interface/cursor.h
+++ b/interface/cursor.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        cursor.h
-// Purpose:     documentation for wxCursor class
+// Purpose:     interface of wxCursor
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -9,7 +9,7 @@
 /**
     @class wxCursor
     @wxheader{cursor.h}
-    
+
     A cursor is a small bitmap usually used for denoting where the mouse
     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
@@ -18,27 +18,20 @@
     object are catered for, and this is an occasion where
     conditional compilation will probably be required (see wxIcon for
     an example).
-    
+
     A single cursor object may be used in many windows (any subwindow type).
     The wxWidgets convention is to set the cursor for a window, as in X,
     rather than to set it globally as in MS Windows, although a
     global ::wxSetCursor is also available for MS Windows use.
-    
+
     @library{wxcore}
     @category{gdi}
-    
+
     @stdobjects
-    Objects:
-    wxNullCursor
-    Pointers:
-    wxSTANDARD_CURSOR
-    
-    wxHOURGLASS_CURSOR
-    
-    wxCROSS_CURSOR
-    
-    @seealso
-    wxBitmap, wxIcon, wxWindow::SetCursor, ::wxSetCursor
+    ::Objects:, ::wxNullCursor, ::Pointers:, ::wxSTANDARD_CURSOR,
+    ::wxHOURGLASS_CURSOR, ::wxCROSS_CURSOR,
+
+    @see wxBitmap, wxIcon, wxWindow::SetCursor, ::wxSetCursor
 */
 class wxCursor : public wxBitmap
 {
@@ -46,223 +39,410 @@ public:
     //@{
     /**
         Copy constructor, uses @ref overview_trefcount "reference counting".
-        
-        @param bits 
-        An array of bits.
-        
-        @param maskBits 
-        Bits for a mask bitmap.
-        
-        @param width 
-        Cursor width.
-        
-        @param height 
-        Cursor height.
-        
-        @param hotSpotX 
-        Hotspot x coordinate.
-        
-        @param hotSpotY 
-        Hotspot y coordinate.
-        
-        @param type 
-        Icon type to load. Under Motif, type defaults to wxBITMAP_TYPE_XBM. Under
+
+        @param bits
+            An array of bits.
+        @param maskBits
+            Bits for a mask bitmap.
+        @param width
+            Cursor width.
+        @param height
+            Cursor height.
+        @param hotSpotX
+            Hotspot x coordinate.
+        @param hotSpotY
+            Hotspot y coordinate.
+        @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
+            it defaults to wxBITMAP_TYPE_CUR_RESOURCE. Under MacOS, it defaults to
         wxBITMAP_TYPE_MACCURSOR_RESOURCE.
-        
-        Under X, the permitted cursor types are:
-        
-        
-        wxBITMAP_TYPE_XBM
-        
-        
-        Load an X bitmap file.
-        
-        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 hotSpotX and hotSpotY.
-        
-        @param cursorId 
-        A stock cursor identifier. May be one of:
-        
-        
-        wxCURSOR_ARROW
-        
-        
-        A standard arrow cursor.
-        
-        wxCURSOR_RIGHT_ARROW
-        
-        
-        A standard arrow cursor
-        pointing to the right.
-        
-        wxCURSOR_BLANK
-        
-        
-        Transparent cursor.
-        
-        wxCURSOR_BULLSEYE
-        
-        
-        Bullseye cursor.
-        
-        wxCURSOR_CHAR
-        
-        
-        Rectangular character cursor.
-        
-        wxCURSOR_CROSS
-        
-        
-        A cross cursor.
-        
-        wxCURSOR_HAND
-        
-        
-        A hand cursor.
-        
-        wxCURSOR_IBEAM
-        
-        
-        An I-beam cursor (vertical line).
-        
-        wxCURSOR_LEFT_BUTTON
-        
-        
-        Represents a mouse with the left button depressed.
-        
-        wxCURSOR_MAGNIFIER
-        
-        
-        A magnifier icon.
-        
-        wxCURSOR_MIDDLE_BUTTON
-        
-        
-        Represents a mouse with the middle button depressed.
-        
-        wxCURSOR_NO_ENTRY
-        
-        
-        A no-entry sign cursor.
-        
-        wxCURSOR_PAINT_BRUSH
-        
-        
-        A paintbrush cursor.
-        
-        wxCURSOR_PENCIL
-        
-        
-        A pencil cursor.
-        
-        wxCURSOR_POINT_LEFT
-        
-        
-        A cursor that points left.
-        
-        wxCURSOR_POINT_RIGHT
-        
-        
-        A cursor that points right.
-        
-        wxCURSOR_QUESTION_ARROW
-        
-        
-        An arrow and question mark.
-        
-        wxCURSOR_RIGHT_BUTTON
-        
-        
-        Represents a mouse with the right button depressed.
-        
-        wxCURSOR_SIZENESW
-        
-        
-        A sizing cursor pointing NE-SW.
-        
-        wxCURSOR_SIZENS
-        
-        
-        A sizing cursor pointing N-S.
-        
-        wxCURSOR_SIZENWSE
-        
-        
-        A sizing cursor pointing NW-SE.
-        
-        wxCURSOR_SIZEWE
-        
-        
-        A sizing cursor pointing W-E.
-        
-        wxCURSOR_SIZING
-        
-        
-        A general sizing cursor.
-        
-        wxCURSOR_SPRAYCAN
-        
-        
-        A spraycan cursor.
-        
-        wxCURSOR_WAIT
-        
-        
-        A wait cursor.
-        
-        wxCURSOR_WATCH
-        
-        
-        A watch cursor.
-        
-        wxCURSOR_ARROWWAIT
-        
-        
-        A cursor with both an arrow and
-        an hourglass, (windows.)
-        
-        Note that not all cursors are available on all platforms.
-        
-        @param cursor 
-        Pointer or reference to a cursor to copy.
+            Under X, the permitted cursor types are:
+
+
+
+
+
+
+
+            wxBITMAP_TYPE_XBM
+
+
+
+
+            Load an X bitmap file.
+
+
+
+
+
+            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 hotSpotX and hotSpotY.
+        @param cursorId
+            A stock cursor identifier. May be one of:
+
+
+
+
+
+
+
+            wxCURSOR_ARROW
+
+
+
+
+            A standard arrow cursor.
+
+
+
+
+
+            wxCURSOR_RIGHT_ARROW
+
+
+
+
+            A standard arrow cursor
+            pointing to the right.
+
+
+
+
+
+            wxCURSOR_BLANK
+
+
+
+
+            Transparent cursor.
+
+
+
+
+
+            wxCURSOR_BULLSEYE
+
+
+
+
+            Bullseye cursor.
+
+
+
+
+
+            wxCURSOR_CHAR
+
+
+
+
+            Rectangular character cursor.
+
+
+
+
+
+            wxCURSOR_CROSS
+
+
+
+
+            A cross cursor.
+
+
+
+
+
+            wxCURSOR_HAND
+
+
+
+
+            A hand cursor.
+
+
+
+
+
+            wxCURSOR_IBEAM
+
+
+
+
+            An I-beam cursor (vertical line).
+
+
+
+
+
+            wxCURSOR_LEFT_BUTTON
+
+
+
+
+            Represents a mouse with the left button depressed.
+
+
+
+
+
+            wxCURSOR_MAGNIFIER
+
+
+
+
+            A magnifier icon.
+
+
+
+
+
+            wxCURSOR_MIDDLE_BUTTON
+
+
+
+
+            Represents a mouse with the middle button depressed.
+
+
+
+
+
+            wxCURSOR_NO_ENTRY
+
+
+
+
+            A no-entry sign cursor.
+
+
+
+
+
+            wxCURSOR_PAINT_BRUSH
+
+
+
+
+            A paintbrush cursor.
+
+
+
+
+
+            wxCURSOR_PENCIL
+
+
+
+
+            A pencil cursor.
+
+
+
+
+
+            wxCURSOR_POINT_LEFT
+
+
+
+
+            A cursor that points left.
+
+
+
+
+
+            wxCURSOR_POINT_RIGHT
+
+
+
+
+            A cursor that points right.
+
+
+
+
+
+            wxCURSOR_QUESTION_ARROW
+
+
+
+
+            An arrow and question mark.
+
+
+
+
+
+            wxCURSOR_RIGHT_BUTTON
+
+
+
+
+            Represents a mouse with the right button depressed.
+
+
+
+
+
+            wxCURSOR_SIZENESW
+
+
+
+
+            A sizing cursor pointing NE-SW.
+
+
+
+
+
+            wxCURSOR_SIZENS
+
+
+
+
+            A sizing cursor pointing N-S.
+
+
+
+
+
+            wxCURSOR_SIZENWSE
+
+
+
+
+            A sizing cursor pointing NW-SE.
+
+
+
+
+
+            wxCURSOR_SIZEWE
+
+
+
+
+            A sizing cursor pointing W-E.
+
+
+
+
+
+            wxCURSOR_SIZING
+
+
+
+
+            A general sizing cursor.
+
+
+
+
+
+            wxCURSOR_SPRAYCAN
+
+
+
+
+            A spraycan cursor.
+
+
+
+
+
+            wxCURSOR_WAIT
+
+
+
+
+            A wait cursor.
+
+
+
+
+
+            wxCURSOR_WATCH
+
+
+
+
+            A watch cursor.
+
+
+
+
+
+            wxCURSOR_ARROWWAIT
+
+
+
+
+            A cursor with both an arrow and
+            an hourglass, (windows.)
+
+
+
+
+
+            Note that not all cursors are available on all platforms.
+        @param cursor
+            Pointer or reference to a cursor to copy.
     */
     wxCursor();
-        wxCursor(const char bits[], int width, int height,
-                 int hotSpotX=-1, int hotSpotY=-1,
-                 const char maskBits[]=@NULL,
-                 wxColour* fg=@NULL,
-                 wxColour* bg=@NULL);
-        wxCursor(const wxString& cursorName, long type,
-                 int hotSpotX=0, int hotSpotY=0);
-        wxCursor(int cursorId);
-        wxCursor(const wxImage& image);
-        wxCursor(const wxCursor& cursor);
+    wxCursor(const char bits[], int width, int height,
+             int hotSpotX = -1, int hotSpotY = -1,
+             const char maskBits[] = NULL,
+             wxColour* fg = NULL,
+             wxColour* bg = NULL);
+    wxCursor(const wxString& cursorName, long type,
+             int hotSpotX = 0, int hotSpotY = 0);
+    wxCursor(int cursorId);
+    wxCursor(const wxImage& image);
+    wxCursor(const wxCursor& cursor);
     //@}
 
     /**
         Destroys the cursor.
         See @ref overview_refcountdestruct "reference-counted object destruction" for
         more info.
-        
         A cursor can be reused for more
         than one window, and does not get destroyed when the window is
         destroyed. wxWidgets destroys all cursors on application exit, although
@@ -273,10 +453,45 @@ public:
     /**
         Returns @true if cursor data is present.
     */
-#define bool IsOk()     /* implementation is private */
+    bool IsOk() const;
 
     /**
         Assignment operator, using @ref overview_trefcount "reference counting".
     */
     wxCursor operator =(const wxCursor& cursor);
 };
+
+
+/**
+    FIXME
+*/
+wxCursor Objects:
+;
+
+/**
+    FIXME
+*/
+wxCursor wxNullCursor;
+
+/**
+    FIXME
+*/
+wxCursor Pointers:
+;
+
+/**
+    FIXME
+*/
+wxCursor wxSTANDARD_CURSOR;
+
+/**
+    FIXME
+*/
+wxCursor wxHOURGLASS_CURSOR;
+
+/**
+    FIXME
+*/
+wxCursor wxCROSS_CURSOR;
+
+