Some work on GTK focus handling and events.

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

diff --git a/docs/latex/wx/cursor.tex b/docs/latex/wx/cursor.tex
index 59c61db2ebe31144d22c610a6749a1cd2644ea7f..44e28edc18709000bb68d74d52ec9bda0ead9acf 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
@@ -33,29 +49,34 @@ global \helpref{::wxSetCursor}{wxsetcursor} is also available for MS Windows use
 
 Default constructor.
 
-\func{}{wxCursor}{\param{const char}{ bits[]}, \param{const int }{width},
- \param{const int }{ height}, \param{const int }{hotSpotX=-1}, \param{const int }{hotSpotY=-1}, \param{const char }{maskBits[]=NULL}}
+\func{}{wxCursor}{\param{const char}{ bits[]}, \param{int }{width},
+ \param{int }{ height}, \param{int }{hotSpotX=-1}, \param{int }{hotSpotY=-1}, \param{const char }{maskBits[]=NULL}}
 
 Constructs a cursor by passing an array of bits (Motif and Xt only). {\it maskBits} is used only under Motif.
 
 If either {\it hotSpotX} or {\it hotSpotY} is -1, the hotspot will be the centre of the cursor image (Motif only).
 
-\func{}{wxCursor}{\param{const wxString\& }{cursorName}, \param{const long }{type}, \param{const int }{hotSpotX=0}, \param{const int }{hotSpotY=0}}
+\func{}{wxCursor}{\param{const wxString\& }{cursorName}, \param{long }{type}, \param{int }{hotSpotX=0}, \param{int }{hotSpotY=0}}
 
 Constructs a cursor by passing a string resource name or filename.
 
 {\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.
 
-\func{}{wxCursor}{\param{const int}{ cursorId}}
+\func{}{wxCursor}{\param{int}{ cursorId}}
 
 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 monochome, 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.
+
+\func{}{wxCursor}{\param{const wxCursor\&}{ cursor}}
 
 Copy constructor. This uses reference counting so is a cheap operation.
 
@@ -88,10 +109,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:
@@ -122,12 +143,29 @@ 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{Contructors supported by wxPerl are:\par
+\begin{itemize}
+\item{Wx::Cursor->new( name, type, hotSpotX = 0, hotSpotY = 0 )}
+\item{Wx::Cursor->new( id )}
+\end{itemize}
+}
+
 \membersection{wxCursor::\destruct{wxCursor}}
 
 \func{}{\destruct{wxCursor}}{\void}
@@ -135,7 +173,7 @@ 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}