X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4cc4bfafe5a31cb96f35b3ec9b19fa2b0b3a4eef..bddd07670f86fcfd1419bac3785a18829900f163:/interface/cursor.h diff --git a/interface/cursor.h b/interface/cursor.h index 6395cecb98..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 @@ -28,17 +28,10 @@ @category{gdi} @stdobjects - Objects: - wxNullCursor - Pointers: - wxSTANDARD_CURSOR + ::Objects:, ::wxNullCursor, ::Pointers:, ::wxSTANDARD_CURSOR, + ::wxHOURGLASS_CURSOR, ::wxCROSS_CURSOR, - wxHOURGLASS_CURSOR - - wxCROSS_CURSOR - - @seealso - wxBitmap, wxIcon, wxWindow::SetCursor, ::wxSetCursor + @see wxBitmap, wxIcon, wxWindow::SetCursor, ::wxSetCursor */ class wxCursor : public wxBitmap { @@ -46,7 +39,7 @@ public: //@{ /** Copy constructor, uses @ref overview_trefcount "reference counting". - + @param bits An array of bits. @param maskBits @@ -65,370 +58,370 @@ public: 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. @@ -460,10 +453,45 @@ public: /** Returns @true if cursor data is present. */ - bool IsOk(); + 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; + +