wxTipWindow is now a wxPopupTransientWindow instead of a wxFrame.

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

diff --git a/docs/latex/wx/cursor.tex b/docs/latex/wx/cursor.tex
index ebe20a980308aa76c5f863368126c55b80b7ea0b..5719407d43365f734b77ee2f547cb9504fbde428 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}
 
 \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
 \wxheading{See also}
 
 \helpref{wxBitmap}{wxbitmap}, \helpref{wxIcon}{wxicon}, \helpref{wxWindow::SetCursor}{wxwindowsetcursor},\rtfsp


@@ -55,10 +71,6 @@ Constructs a cursor using a cursor identifier.
 
 Copy constructor. This uses reference counting so is a cheap operation.
 
 
 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.
-

 \wxheading{Parameters}
 
 \docparam{bits}{An array of bits.}
 \wxheading{Parameters}
 
 \docparam{bits}{An array of bits.}


@@ -88,10 +100,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
 \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
 \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:
 \end{twocollist}}
 
 \docparam{cursorId}{A stock cursor identifier. May be one of:


@@ -122,12 +134,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\_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.}
 
 \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}
 \membersection{wxCursor::\destruct{wxCursor}}
 
 \func{}{\destruct{wxCursor}}{\void}


@@ -135,7 +164,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
 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}