Some documentation enhancements for wxRichTextCtrl

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

diff --git a/docs/latex/wx/cursor.tex b/docs/latex/wx/cursor.tex
index 2fa3d65d47340e8ded7f57d1723202e8d11be171..7a07cdd22939da19f997273b053e5ffd9665f840 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.
 


@@ -43,16 +43,19 @@ wxCROSS\_CURSOR}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

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

 
 \func{}{wxCursor}{\void}
 
 Default constructor.
 
 \func{}{wxCursor}{\param{const char}{ bits[]}, \param{int }{width},
 
 \func{}{wxCursor}{\void}
 
 Default constructor.
 
 \func{}{wxCursor}{\param{const char}{ bits[]}, \param{int }{width},

- \param{int }{ height}, \param{int }{hotSpotX=-1}, \param{int }{hotSpotY=-1}, \param{const char }{maskBits[]=NULL}}
+ \param{int }{ height}, \param{int }{hotSpotX=-1}, \param{int }{hotSpotY=-1}, \param{const char }{maskBits[]=NULL},
+ \param{wxColour*}{ fg=NULL}, \param{wxColour*}{ bg=NULL}}

 
 

-Constructs a cursor by passing an array of bits (Motif and Xt only). {\it maskBits} is used only under Motif.
+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 {\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).
 
 
 If either {\it hotSpotX} or {\it hotSpotY} is -1, the hotspot will be the centre of the cursor image (Motif only).
 


@@ -74,14 +77,14 @@ Constructs a cursor using a cursor identifier.
 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. 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 MSW the foreground will be white and the background black. If the cursor is larger than 32x32 it is resized.

 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.
 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).
+On MacOS 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}
 


@@ -174,18 +177,69 @@ hotSpotY=0)}}{Constructs a cursor from a filename}
 \end{itemize}
 }
 
 \end{itemize}
 }
 

-\membersection{wxCursor::\destruct{wxCursor}}
+\wxheading{Example}
+
+The following is an example of creating a
+cursor from 32x32 bitmap data ({\tt down\_bits}) and a mask
+({\tt down\_mask}) where 1 is black and 0 is white for
+the bits, and 1 is opaque and 0 is transparent for
+the mask. It works on Windows and GTK+.
+
+\begin{verbatim}
+static char down_bits[] = { 255, 255, 255, 255, 31,
+  255, 255, 255, 31, 255, 255, 255, 31, 255, 255, 255,
+  31, 255, 255, 255, 31, 255, 255, 255, 31, 255, 255,
+  255, 31, 255, 255, 255, 31, 255, 255, 255, 25, 243,
+  255, 255, 19, 249, 255, 255, 7, 252, 255, 255, 15, 254,
+  255, 255, 31, 255, 255, 255, 191, 255, 255, 255, 255,
+  255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
+  255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
+  255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
+  255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
+  255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
+  255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
+  255 };
+
+static char down_mask[] = { 240, 1, 0, 0, 240, 1,
+  0, 0, 240, 1, 0, 0, 240, 1, 0, 0, 240, 1, 0, 0, 240, 1,
+  0, 0, 240, 1, 0, 0, 240, 1, 0, 0, 255, 31, 0, 0, 255,
+  31, 0, 0, 254, 15, 0, 0, 252, 7, 0, 0, 248, 3, 0, 0,
+  240, 1, 0, 0, 224, 0, 0, 0, 64, 0, 0, 0, 0, 0, 0, 0, 0,
+  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+  0, 0, 0, 0, 0 };
+
+#ifdef __WXMSW__
+wxBitmap down_bitmap(down_bits, 32, 32);
+wxBitmap down_mask_bitmap(down_mask, 32, 32);
+
+down_bitmap.SetMask(new wxMask(down_mask_bitmap));
+wxImage down_image = down_bitmap.ConvertToImage();
+down_image.SetOption(wxIMAGE_OPTION_CUR_HOTSPOT_X, 6);
+down_image.SetOption(wxIMAGE_OPTION_CUR_HOTSPOT_Y, 14);
+wxCursor down_cursor = wxCursor(down_image);
+#else
+wxCursor down_cursor = wxCursor(down_bits, 32, 32,
+  6, 14, down_mask, wxWHITE, wxBLACK);
+#endif
+\end{verbatim}
+
+\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.
 


@@ -193,23 +247,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}.