undefine _DEFINE_LIST before redefining it; also rename it to have WX prefix

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

diff --git a/docs/latex/wx/cursor.tex b/docs/latex/wx/cursor.tex
index e5c66884f6dec6bcef1d54a66eb11b97b88f91df..72f390341551b93694ea2917b8b0f6a4e5774bde 100644 (file)
--- a/docs/latex/wx/cursor.tex
+++ b/docs/latex/wx/cursor.tex
@@ -10,7 +10,7 @@ conditional compilation will probably be required (see \helpref{wxIcon}{wxicon}
 an example).
 
 A single cursor object may be used in many windows (any subwindow type).
 an example).
 
 A single cursor object may be used in many windows (any subwindow type).

-The wxWindows convention is to set the cursor for a window, as in X,
+The wxWidgets convention is to set the cursor for a window, as in X,

 rather than to set it globally as in MS Windows, although a
 global \helpref{::wxSetCursor}{wxsetcursor} is also available for MS Windows use.
 
 rather than to set it globally as in MS Windows, although a
 global \helpref{::wxSetCursor}{wxsetcursor} is also available for MS Windows use.
 


@@ -24,6 +24,10 @@ global \helpref{::wxSetCursor}{wxsetcursor} is also available for MS Windows use
 
 <wx/cursor.h>
 
 
 <wx/cursor.h>
 

+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+

 \wxheading{Predefined objects}
 
 Objects:
 \wxheading{Predefined objects}
 
 Objects:


@@ -43,7 +47,7 @@ wxCROSS\_CURSOR}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxCursor::wxCursor}\label{wxcursorconstr}
+\membersection{wxCursor::wxCursor}\label{wxcursorctor}

 
 \func{}{wxCursor}{\void}
 
 
 \func{}{wxCursor}{\void}
 


@@ -54,7 +58,7 @@ Default constructor.
  \param{wxColour*}{ fg=NULL}, \param{wxColour*}{ bg=NULL}}
 
 Constructs a cursor by passing an array of bits (Motif and GTK+ only). {\it maskBits} is used only under
  \param{wxColour*}{ fg=NULL}, \param{wxColour*}{ bg=NULL}}
 
 Constructs a cursor by passing an array of bits (Motif and GTK+ only). {\it maskBits} is used only under

-Motif and GTK+. The parameters {\it fg} and {\bg } are only present on GTK+, and force the
+Motif and GTK+. The parameters {\it fg} and {\it bg} are only present on GTK+, and force the

 cursor to use particular background and foreground colours.
 
 If either {\it hotSpotX} or {\it hotSpotY} is -1, the hotspot will be the centre of the cursor image (Motif only).
 cursor to use particular background and foreground colours.
 
 If either {\it hotSpotX} or {\it hotSpotY} is -1, the hotspot will be the centre of the cursor image (Motif only).


@@ -74,17 +78,24 @@ Constructs a cursor using a cursor identifier.
 
 \func{}{wxCursor}{\param{const wxImage\&}{ image}}
 
 
 \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.
+Constructs a cursor from a wxImage. If cursor are monochrome on the current
+platform, colors with the RGB elements all greater than 127 will be foreground,
+colors less than this background. The mask (if any) will be used to specify the
+transparent area.
+
+In wxMSW the foreground will be white and the background black. If the cursor
+is larger than 32x32 it is resized.

 
 

-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).
+In wxGTK, colour cursors and alpha channel are supported (starting from GTK+
+2.2). Otherwise the two most frequent colors will be used for foreground and
+background. In any case, the cursor will be displayed at the size of the image.
+
+In wxMac, if the cursor is larger than 16x16 it is resized and currently only
+shown as black/white (mask respected).

 
 \func{}{wxCursor}{\param{const wxCursor\&}{ cursor}}
 
 
 \func{}{wxCursor}{\param{const wxCursor\&}{ cursor}}
 

-Copy constructor. This uses reference counting so is a cheap operation.
+Copy constructor, uses \helpref{reference counting}{trefcount}.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 


@@ -225,18 +236,21 @@ wxCursor down_cursor = wxCursor(down_bits, 32, 32,
 #endif
 \end{verbatim}
 
 #endif
 \end{verbatim}
 

-\membersection{wxCursor::\destruct{wxCursor}}
+\membersection{wxCursor::\destruct{wxCursor}}\label{wxcursordtor}

 
 \func{}{\destruct{wxCursor}}{\void}
 
 
 \func{}{\destruct{wxCursor}}{\void}
 

-Destroys the cursor. A cursor can be reused for more
+Destroys the cursor.
+See \helpref{reference-counted object destruction}{refcountdestruct} for more info.
+
+A cursor can be reused for more

 than one window, and does not get destroyed when the window is
 than one window, and does not get destroyed when the window is

-destroyed. wxWindows destroys all cursors on application exit, although
+destroyed. wxWidgets destroys all cursors on application exit, although

 it is best to clean them up explicitly.
 
 it is best to clean them up explicitly.
 

-\membersection{wxCursor::Ok}\label{wxcursorok}
+\membersection{wxCursor::IsOk}\label{wxcursorisok}

 
 

-\constfunc{bool}{Ok}{\void}
+\constfunc{bool}{IsOk}{\void}

 
 Returns true if cursor data is present.
 
 
 Returns true if cursor data is present.
 


@@ -244,23 +258,5 @@ Returns true if cursor data is present.
 
 \func{wxCursor\&}{operator $=$}{\param{const wxCursor\& }{cursor}}
 
 
 \func{wxCursor\&}{operator $=$}{\param{const wxCursor\& }{cursor}}
 

-Assignment operator, using reference counting. Returns a reference
-to `this'.
-
-\membersection{wxCursor::operator $==$}\label{wxcursorequals}
-
-\func{bool}{operator $==$}{\param{const wxCursor\& }{cursor}}
-
-Equality operator. Two cursors are equal if they contain pointers
-to the same underlying cursor data. It does not compare each attribute,
-so two independently-created cursors using the same parameters will
-fail the test.
-
-\membersection{wxCursor::operator $!=$}\label{wxcursornotequals}
-
-\func{bool}{operator $!=$}{\param{const wxCursor\& }{cursor}}
-
-Inequality operator. Two cursors are not equal if they contain pointers
-to different underlying cursor data. It does not compare each attribute.
-
+Assignment operator, using \helpref{reference counting}{trefcount}.