Blindly added wxImageList::replace( int, bitmap, mask )

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

diff --git a/docs/latex/wx/dragimag.tex b/docs/latex/wx/dragimag.tex
index f71608e08c8cfb7b65e2a357795f5cdecc2bd954..e74b6db01d248d179eb8fb8aab5c04d89223889c 100644 (file)
--- a/docs/latex/wx/dragimag.tex
+++ b/docs/latex/wx/dragimag.tex
@@ -28,6 +28,14 @@ override \helpref{wxDragImage::DoDrawImage}{wxdragimagedodrawimage} and
 
 Please see {\tt samples/dragimag} for an example.
 
+%\wxheading{Notes}
+%
+%Using the native Windows implementation, you must supply an image with a mask, or
+%the image will not show when dragged. It is not clear if this is a bug
+%in Windows or in the wxDragImage implementation. You can add a mask
+%with a call to wxImage::SetMaskColour, passing RGB values not likely
+%to be in the image. [CURED by creating the ImageList with ILC_MASK]
+
 \wxheading{Derived from}
 
 \helpref{wxObject}{wxobject}
@@ -46,19 +54,19 @@ Please see {\tt samples/dragimag} for an example.
 Default constructor.
 
 \func{}{wxDragImage}{\param{const wxBitmap\& }{image}, \param{const wxCursor\& }{cursor = wxNullCursor},
- \param{const wxPoint& }{cursorHotspot = wxPoint(0, 0)}}
+ \param{const wxPoint\& }{cursorHotspot = wxPoint(0, 0)}}
 
 Constructs a drag image from a bitmap and optional cursor.
 
 \func{}{wxDragImage}{\param{const wxIcon\& }{image}, \param{const wxCursor\& }{cursor = wxNullCursor},
- \param{const wxPoint& }{cursorHotspot = wxPoint(0, 0)}}
+ \param{const wxPoint\& }{cursorHotspot = wxPoint(0, 0)}}
 
 Constructs a drag image from an icon and optional cursor.
 
 \pythonnote{This constructor is called wxDragIcon in wxPython.}
 
 \func{}{wxDragImage}{\param{const wxString\& }{text}, \param{const wxCursor\& }{cursor = wxNullCursor},
- \param{const wxPoint& }{cursorHotspot = wxPoint(0, 0)}}
+ \param{const wxPoint\& }{cursorHotspot = wxPoint(0, 0)}}
 
 Constructs a drag image from a text string and optional cursor.
 
@@ -77,7 +85,7 @@ Constructs a drag image from the text in the given tree control item, and option
 \pythonnote{This constructor is called wxDragListItem in wxPython.}
 
 \func{}{wxDragImage}{\param{const wxCursor\& }{cursor = wxNullCursor},
- \param{const wxPoint& }{cursorHotspot = wxPoint(0, 0)}}
+ \param{const wxPoint\& }{cursorHotspot = wxPoint(0, 0)}}
 
 Constructs a drag image an optional cursor. This constructor is only available for
 wxGenericDragImage, and can be used when the application
@@ -102,7 +110,7 @@ have a mask.}
 
 \membersection{wxDragImage::BeginDrag}\label{wxdragimagebegindrag}
 
-\func{bool}{BeginDrag}{\param{const wxPoint\& }{hotspot}, \param{wxWindow* }{window}, \param{bool}{ fullScreen = FALSE}, \param{wxRect*}{ rect = NULL}}
+\func{bool}{BeginDrag}{\param{const wxPoint\& }{hotspot}, \param{wxWindow* }{window}, \param{bool}{ fullScreen = false}, \param{wxRect*}{ rect = NULL}}
 
 Start dragging the image, in a window or full screen.
 
@@ -125,12 +133,12 @@ Note that this call automatically calls CaptureMouse.
 of the image.}
 
 \docparam{window}{The window that captures the mouse, and within which the dragging
-is limited unless {\it fullScreen} is TRUE.}
+is limited unless {\it fullScreen} is true.}
 
 \docparam{boundingWindow}{In the second form of the function, specifies the
 area within which the drag occurs.}
 
-\docparam{fullScreen}{If TRUE, specifies that the drag will be visible over the full
+\docparam{fullScreen}{If true, specifies that the drag will be visible over the full
 screen, or over as much of the screen as is specified by {\it rect}. Note that the mouse will
 still be captured in {\it window}.}