many wxItemContainer-related changes:

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

diff --git a/docs/latex/wx/cursor.tex b/docs/latex/wx/cursor.tex
index 1992f48e3a85de7afe4813c5316d64a5b36c881d..a6f8fceed58ab438f6199baa63a9dd1e233649a9 100644 (file)
--- a/docs/latex/wx/cursor.tex
+++ b/docs/latex/wx/cursor.tex
@@ -74,17 +74,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 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 wxMSW the foreground will be white and the background black. If the cursor
+is larger than 32x32 it is resized.
+
+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}
 


@@ -229,14 +236,17 @@ wxCursor down_cursor = wxCursor(down_bits, 32, 32,
 
 \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
 destroyed. wxWidgets destroys all cursors on application exit, although
 it is best to clean them up explicitly.
 
 than one window, and does not get destroyed when the window is
 destroyed. wxWidgets destroys all cursors on application exit, although
 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 +254,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}.