Canvas: added some DECLARE_CLASS macros to stop it failing

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

diff --git a/docs/latex/wx/cursor.tex b/docs/latex/wx/cursor.tex
index 6358c7baf609a0d0c1fc31b5ab0b19d49bcf0a93..18556ebf01b13de819aea4b9e0da1d044697a5a0 100644 (file)
--- a/docs/latex/wx/cursor.tex
+++ b/docs/latex/wx/cursor.tex
@@ -67,6 +67,15 @@ 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 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.
+
+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.
 \func{}{wxCursor}{\param{const wxCursor\&}{ cursor}}
 
 Copy constructor. This uses reference counting so is a cheap operation.


@@ -111,6 +120,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.}


@@ -134,6 +146,8 @@ is enabled in 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\_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.}
 \end{twocollist}\twocolwidtha{5cm}
 
 Note that not all cursors are available on all platforms.}


@@ -142,12 +156,19 @@ Note that not all cursors are available on all platforms.}
 
 \pythonnote{Constructors supported by wxPython are:\par
 \indented{2cm}{\begin{twocollist}
 
 \pythonnote{Constructors supported by wxPython are:\par
 \indented{2cm}{\begin{twocollist}

-\twocolitem{\bf{wxCursor(name, flags, hotSpotX=0,
+\twocolitem{{\bf wxCursor(name, flags, hotSpotX=0,

 hotSpotY=0)}}{Constructs a cursor from a filename}
 hotSpotY=0)}}{Constructs a cursor from a filename}

-\twocolitem{\bf{wxStockCursor(id)}}{Constructs a stock cursor }
+\twocolitem{{\bf wxStockCursor(id)}}{Constructs a stock cursor }

 \end{twocollist}}
 }
 
 \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}
 \membersection{wxCursor::\destruct{wxCursor}}
 
 \func{}{\destruct{wxCursor}}{\void}


@@ -155,7 +176,7 @@ hotSpotY=0)}}{Constructs a cursor from a filename}
 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
 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}
 
 
 \membersection{wxCursor::Ok}\label{wxcursorok}