removed virtual from functions which are not; expanded wxWindow description

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

diff --git a/docs/latex/wx/cursor.tex b/docs/latex/wx/cursor.tex
index 5719407d43365f734b77ee2f547cb9504fbde428..2fa3d65d47340e8ded7f57d1723202e8d11be171 100644 (file)
--- a/docs/latex/wx/cursor.tex
+++ b/docs/latex/wx/cursor.tex
@@ -60,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.
 
 
 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.
 
 {\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.
 


@@ -67,6 +69,16 @@ icon file, to specify the cursor hotspot relative to the top left of the image.
 
 Constructs a cursor using a cursor identifier.
 
 
 Constructs a cursor using a cursor identifier.
 

+\func{}{wxCursor}{\param{const wxImage\&}{ image}}
+
+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.
+
+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.
 \func{}{wxCursor}{\param{const wxCursor\&}{ cursor}}
 
 Copy constructor. This uses reference counting so is a cheap operation.


@@ -86,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,
 \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:
 
 
 Under X, the permitted cursor types are:
 


@@ -111,6 +123,9 @@ is enabled in setup.h). Specify {\it hotSpotX} and {\it hotSpotY}.}
 \twocolwidtha{6cm}
 \begin{twocollist}\itemsep=0pt
 \twocolitem{{\bf wxCURSOR\_ARROW}}{A standard arrow cursor.}
 \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.}
 \twocolitem{{\bf wxCURSOR\_BULLSEYE}}{Bullseye cursor.}
 \twocolitem{{\bf wxCURSOR\_CHAR}}{Rectangular character cursor.}
 \twocolitem{{\bf wxCURSOR\_CROSS}}{A cross cursor.}


@@ -150,10 +165,12 @@ hotSpotY=0)}}{Constructs a cursor from a filename}
 \end{twocollist}}
 }
 
 \end{twocollist}}
 }
 

-\perlnote{Contructors supported by wxPerl are:\par
+\perlnote{Constructors supported by wxPerl are:\par

 \begin{itemize}
 \item{Wx::Cursor->new( name, type, hotSpotX = 0, hotSpotY = 0 )}
 \item{Wx::Cursor->new( id )}
 \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}
 }
 
 \end{itemize}
 }
 


@@ -170,7 +187,7 @@ it is best to clean them up explicitly.
 
 \constfunc{bool}{Ok}{\void}
 
 
 \constfunc{bool}{Ok}{\void}
 

-Returns TRUE if cursor data is present.
+Returns true if cursor data is present.

 
 \membersection{wxCursor::operator $=$}\label{wxcursorassignment}
 
 
 \membersection{wxCursor::operator $=$}\label{wxcursorassignment}