don't always erase the background ourselves as this is incompatible with XP themed...

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

diff --git a/docs/latex/wx/dragimag.tex b/docs/latex/wx/dragimag.tex
index 948a6a0478a27249c062f3594bca12a3ba5342a9..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.
 
 
 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}
 \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},
 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},
 
 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},
 
 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.
 
 
 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},
 \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
 
 Constructs a drag image an optional cursor. This constructor is only available for
 wxGenericDragImage, and can be used when the application


@@ -92,7 +100,7 @@ have a mask.}
 
 \docparam{cursor}{Optional cursor to combine with the image.}
 
 
 \docparam{cursor}{Optional cursor to combine with the image.}
 

-\docparam{hotspot}{Optional position of the hotspot in the given cursor. This parameter is deprecated.}
+\docparam{hotspot}{This parameter is deprecated.}

 
 \docparam{treeCtrl}{Tree control for constructing a tree drag image.}
 
 
 \docparam{treeCtrl}{Tree control for constructing a tree drag image.}
 


@@ -102,7 +110,7 @@ have a mask.}
 
 \membersection{wxDragImage::BeginDrag}\label{wxdragimagebegindrag}
 
 
 \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.
 
 
 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
 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{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}.}
 
 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}.}
 


@@ -183,8 +191,7 @@ Call this to move the image to a new position. The image will only be shown if
 \helpref{wxDragImage::Show}{wxdragimageshow} has been called previously (for example
 at the start of the drag).
 
 \helpref{wxDragImage::Show}{wxdragimageshow} has been called previously (for example
 at the start of the drag).
 

-{\it pt} is the position in window coordinates (or screen coordinates if no
-window was specified to BeginDrag.
+{\it pt} is the position in client coordinates (relative to the window specified in BeginDrag).

 
 You can move the image either when the image is hidden or shown, but in general dragging
 will be smoother if you move the image when it is shown.
 
 You can move the image either when the image is hidden or shown, but in general dragging
 will be smoother if you move the image when it is shown.