fix text scrolling in GTK2 (patch 703988)

[wxWidgets.git] / docs / latex / wx / cursor.tex

diff --git a/docs/latex/wx/cursor.tex b/docs/latex/wx/cursor.tex
index ebe20a980308aa76c5f863368126c55b80b7ea0b..2fa3d65d47340e8ded7f57d1723202e8d11be171 100644 (file)
--- a/docs/latex/wx/cursor.tex
+++ b/docs/latex/wx/cursor.tex
@@ -20,6 +20,22 @@ global \helpref{::wxSetCursor}{wxsetcursor} is also available for MS Windows use
 \helpref{wxGDIObject}{wxgdiobject}\\
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/cursor.h>
+
+\wxheading{Predefined objects}
+
+Objects:
+
+{\bf wxNullCursor}
+
+Pointers:
+
+{\bf wxSTANDARD\_CURSOR\\
+wxHOURGLASS\_CURSOR\\
+wxCROSS\_CURSOR}
+
 \wxheading{See also}
 
 \helpref{wxBitmap}{wxbitmap}, \helpref{wxIcon}{wxicon}, \helpref{wxWindow::SetCursor}{wxwindowsetcursor},\rtfsp
@@ -44,6 +60,8 @@ If either {\it hotSpotX} or {\it hotSpotY} is -1, the hotspot will be the centre
 
 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.
+
 {\it hotSpotX} and {\it 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.
 
@@ -51,11 +69,17 @@ icon file, to specify the cursor hotspot relative to the top left of the image.
 
 Constructs a cursor using a cursor identifier.
 
-\func{}{wxCursor}{\param{const wxCursor\&}{ cursor}}
+\func{}{wxCursor}{\param{const wxImage\&}{ image}}
 
-Copy constructor. This uses reference counting so is a cheap operation.
+Constructs a cursor from a wxImage. The cursor is monochrome, colors with the RGB elements all greater
+than 127 will be foreground, colors less than this background. The mask (if any) will be used as transparent.
 
-\func{}{wxCursor}{\param{const wxCursor*}{ cursor}}
+In MSW the foreground will be white and the background black. The cursor is resized to 32x32
+In GTK, the two most frequent colors will be used for foreground and background. The cursor will be displayed
+at the size of the image.
+On MacOS the cursor is resized to 16x16 and currently only shown as black/white (mask respected).
+
+\func{}{wxCursor}{\param{const wxCursor\&}{ cursor}}
 
 Copy constructor. This uses reference counting so is a cheap operation.
 
@@ -74,7 +98,7 @@ Copy constructor. This uses reference counting so is a cheap operation.
 \docparam{hotSpotY}{Hotspot y coordinate.}
 
 \docparam{type}{Icon type to load. Under Motif, {\it type} defaults to {\bf wxBITMAP\_TYPE\_XBM}. Under Windows,
-it defaults to {\bf wxBITMAP\_TYPE\_CUR\_RESOURCE}.
+it defaults to {\bf wxBITMAP\_TYPE\_CUR\_RESOURCE}. Under MacOS, it defaults to {\bf wxBITMAP\_TYPE\_MACCURSOR\_RESOURCE}.
 
 Under X, the permitted cursor types are:
 
@@ -88,10 +112,10 @@ Under Windows, the permitted types are:
 \twocolwidtha{6cm}
 \begin{twocollist}\itemsep=0pt
 \twocolitem{\windowstyle{wxBITMAP\_TYPE\_CUR}}{Load a cursor from a .cur cursor file (only if USE\_RESOURCE\_LOADING\_IN\_MSW
-is enabled in wx\_setup.h).}
+is enabled in setup.h).}
 \twocolitem{\windowstyle{wxBITMAP\_TYPE\_CUR\_RESOURCE}}{Load a Windows resource (as specified in the .rc file).}
 \twocolitem{\windowstyle{wxBITMAP\_TYPE\_ICO}}{Load a cursor from a .ico icon file (only if USE\_RESOURCE\_LOADING\_IN\_MSW
-is enabled in wx\_setup.h). Specify {\it hotSpotX} and {\it hotSpotY}.}
+is enabled in setup.h). Specify {\it hotSpotX} and {\it hotSpotY}.}
 \end{twocollist}}
 
 \docparam{cursorId}{A stock cursor identifier. May be one of:
@@ -99,6 +123,9 @@ is enabled in wx\_setup.h). Specify {\it hotSpotX} and {\it hotSpotY}.}
 \twocolwidtha{6cm}
 \begin{twocollist}\itemsep=0pt
 \twocolitem{{\bf wxCURSOR\_ARROW}}{A standard arrow cursor.}
+\twocolitem{{\bf wxCURSOR\_RIGHT\_ARROW}}{A standard arrow cursor
+pointing to the right.}
+\twocolitem{{\bf wxCURSOR\_BLANK}}{Transparent cursor.}
 \twocolitem{{\bf wxCURSOR\_BULLSEYE}}{Bullseye cursor.}
 \twocolitem{{\bf wxCURSOR\_CHAR}}{Rectangular character cursor.}
 \twocolitem{{\bf wxCURSOR\_CROSS}}{A cross cursor.}
@@ -122,12 +149,31 @@ is enabled in wx\_setup.h). Specify {\it hotSpotX} and {\it hotSpotY}.}
 \twocolitem{{\bf wxCURSOR\_SPRAYCAN}}{A spraycan cursor.}
 \twocolitem{{\bf wxCURSOR\_WAIT}}{A wait cursor.}
 \twocolitem{{\bf wxCURSOR\_WATCH}}{A watch cursor.}
+\twocolitem{{\bf wxCURSOR\_ARROWWAIT}}{A cursor with both an arrow and
+an hourglass, (windows.)}
 \end{twocollist}\twocolwidtha{5cm}
 
 Note that not all cursors are available on all platforms.}
 
 \docparam{cursor}{Pointer or reference to a cursor to copy.}
 
+\pythonnote{Constructors supported by wxPython are:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{{\bf wxCursor(name, flags, hotSpotX=0,
+hotSpotY=0)}}{Constructs a cursor from a filename}
+\twocolitem{{\bf wxStockCursor(id)}}{Constructs a stock cursor }
+\end{twocollist}}
+}
+
+\perlnote{Constructors supported by wxPerl are:\par
+\begin{itemize}
+\item{Wx::Cursor->new( name, type, hotSpotX = 0, hotSpotY = 0 )}
+\item{Wx::Cursor->new( id )}
+\item{Wx::Cursor->new( image )}
+\item{Wx::Cursor->newData( bits, width, height, hotSpotX = -1, hotSpotY = -1, maskBits = 0 )}
+\end{itemize}
+}
+
 \membersection{wxCursor::\destruct{wxCursor}}
 
 \func{}{\destruct{wxCursor}}{\void}
@@ -135,13 +181,13 @@ Note that not all cursors are available on all platforms.}
 Destroys the cursor. A cursor can be reused for more
 than one window, and does not get destroyed when the window is
 destroyed. wxWindows destroys all cursors on application exit, although
-it's best to clean them up explicitly.
+it is best to clean them up explicitly.
 
 \membersection{wxCursor::Ok}\label{wxcursorok}
 
 \constfunc{bool}{Ok}{\void}
 
-Returns TRUE if cursor data is present.
+Returns true if cursor data is present.
 
 \membersection{wxCursor::operator $=$}\label{wxcursorassignment}