/////////////////////////////////////////////////////////////////////////////
// Name: dnd.h
-// Purpose: documentation for wxTextDropTarget class
+// Purpose: interface of wxTextDropTarget
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
/**
@class wxTextDropTarget
@wxheader{dnd.h}
-
+
A predefined drop target for dealing with text data.
-
+
@library{wxcore}
@category{dnd}
-
- @seealso
- @ref overview_wxdndoverview "Drag and drop overview", wxDropSource,
- wxDropTarget, wxFileDropTarget
+
+ @see @ref overview_wxdndoverview, wxDropSource, wxDropTarget, wxFileDropTarget
*/
class wxTextDropTarget : public wxDropTarget
{
/**
Override this function to receive dropped text.
- @param x
- The x coordinate of the mouse.
-
- @param y
- The y coordinate of the mouse.
-
- @param data
- The data being dropped: a wxString.
+ @param x
+ The x coordinate of the mouse.
+ @param y
+ The y coordinate of the mouse.
+ @param data
+ The data being dropped: a wxString.
*/
virtual bool OnDropText(wxCoord x, wxCoord y,
const wxString& data);
};
+
/**
@class wxDropTarget
@wxheader{dnd.h}
-
+
This class represents a target for a drag and drop operation. A wxDataObject
can be associated with it and by default, this object will be filled with the
data from the
drag source, if the data formats supported by the data object match the drag
- source data
+ source data
format.
-
+
There are various virtual handler functions defined in this class which may be
overridden
to give visual feedback or react in a more fine-tuned way, e.g. by not
calls is
wxDropTarget::OnEnter, possibly many times wxDropTarget::OnDragOver,
wxDropTarget::OnDrop and finally wxDropTarget::OnData.
-
- See @ref overview_wxdndoverview "Drag and drop overview" and @ref
- overview_wxdataobjectoverview "wxDataObject overview"
+
+ See @ref overview_wxdndoverview and @ref overview_wxdataobjectoverview
for more information.
-
+
@library{wxcore}
@category{dnd}
-
- @seealso
- wxDropSource, wxTextDropTarget, wxFileDropTarget, wxDataFormat, wxDataObject
+
+ @see wxDropSource, wxTextDropTarget, wxFileDropTarget, wxDataFormat,
+ wxDataObject
*/
-class wxDropTarget
+class wxDropTarget
{
public:
/**
- Constructor. @e data is the data to be associated with the drop target.
+ Constructor. @a data is the data to be associated with the drop target.
*/
- wxDropTarget(wxDataObject* data = @NULL);
+ wxDropTarget(wxDataObject* data = NULL);
/**
Destructor. Deletes the associated data object, if any.
/**
This method may only be called from within OnData().
- By default, this method copies the data from the drop source to the
+ By default, this method copies the data from the drop source to the
wxDataObject associated with this drop target,
calling its wxDataObject::SetData method.
*/
wxDragResult def);
/**
- Called when the mouse is being dragged over the drop target. By default,
+ Called when the mouse is being dragged over the drop target. By default,
this calls functions return the suggested return value @e def.
- @param x
- The x coordinate of the mouse.
-
- @param y
- The y coordinate of the mouse.
-
- @param def
- Suggested value for return value. Determined by SHIFT or CONTROL key states.
+ @param x
+ The x coordinate of the mouse.
+ @param y
+ The y coordinate of the mouse.
+ @param def
+ Suggested value for return value. Determined by SHIFT or CONTROL key states.
@returns Returns the desired operation or wxDragNone. This is used for
- optical feedback from the side of the drop source,
- typically in form of changing the icon.
+ optical feedback from the side of the drop source,
+ typically in form of changing the icon.
*/
virtual wxDragResult OnDragOver(wxCoord x, wxCoord y,
wxDragResult def);
Called when the user drops a data object on the target. Return @false to veto
the operation.
- @param x
- The x coordinate of the mouse.
-
- @param y
- The y coordinate of the mouse.
+ @param x
+ The x coordinate of the mouse.
+ @param y
+ The y coordinate of the mouse.
@returns Return @true to accept the data, @false to veto the operation.
*/
Called when the mouse enters the drop target. By default, this calls
OnDragOver().
- @param x
- The x coordinate of the mouse.
-
- @param y
- The y coordinate of the mouse.
-
- @param def
- Suggested default for return value. Determined by SHIFT or CONTROL key states.
+ @param x
+ The x coordinate of the mouse.
+ @param y
+ The y coordinate of the mouse.
+ @param def
+ Suggested default for return value. Determined by SHIFT or CONTROL key
+ states.
@returns Returns the desired operation or wxDragNone. This is used for
- optical feedback from the side of the drop source,
- typically in form of changing the icon.
+ optical feedback from the side of the drop source,
+ typically in form of changing the icon.
*/
virtual wxDragResult OnEnter(wxCoord x, wxCoord y,
wxDragResult def);
virtual void OnLeave();
/**
- Sets the data wxDataObject associated with the
+ Sets the data wxDataObject associated with the
drop target and deletes any previously associated data object.
*/
void SetDataObject(wxDataObject* data);
};
+
/**
@class wxDropSource
@wxheader{dnd.h}
-
+
This class represents a source for a drag and drop operation.
-
- See @ref overview_wxdndoverview "Drag and drop overview" and @ref
- overview_wxdataobjectoverview "wxDataObject overview"
+
+ See @ref overview_wxdndoverview and @ref overview_wxdataobjectoverview
for more information.
-
+
@library{wxcore}
@category{dnd}
-
- @seealso
- wxDropTarget, wxTextDropTarget, wxFileDropTarget
+
+ @see wxDropTarget, wxTextDropTarget, wxFileDropTarget
*/
-class wxDropSource
+class wxDropSource
{
public:
//@{
/**
The constructors for wxDataObject.
-
- If you use the constructor without @e data parameter you must call
+ If you use the constructor without @a data parameter you must call
SetData() later.
-
- Note that the exact type of @e iconCopy and subsequent parameters differs
+ Note that the exact type of @a iconCopy and subsequent parameters differs
between wxMSW and wxGTK: these are cursors under Windows but icons for GTK.
- You should use the macro wxDROP_ICON in portable
+ You should use the macro wxDROP_ICON() in portable
programs instead of directly using either of these types.
- @param win
- The window which initiates the drag and drop operation.
-
- @param iconCopy
- The icon or cursor used for feedback for copy operation.
-
- @param iconMove
- The icon or cursor used for feedback for move operation.
-
- @param iconNone
- The icon or cursor used for feedback when operation can't be done.
+ @param win
+ The window which initiates the drag and drop operation.
+ @param iconCopy
+ The icon or cursor used for feedback for copy operation.
+ @param iconMove
+ The icon or cursor used for feedback for move operation.
+ @param iconNone
+ The icon or cursor used for feedback when operation can't be done.
*/
- wxDropSource(wxWindow* win = @NULL,
+ wxDropSource(wxWindow* win = NULL,
+ const wxIconOrCursor& iconCopy = wxNullIconOrCursor,
+ const wxIconOrCursor& iconMove = wxNullIconOrCursor,
+ const wxIconOrCursor& iconNone = wxNullIconOrCursor);
+ wxDropSource(wxDataObject& data, wxWindow* win = NULL,
const wxIconOrCursor& iconCopy = wxNullIconOrCursor,
const wxIconOrCursor& iconMove = wxNullIconOrCursor,
const wxIconOrCursor& iconNone = wxNullIconOrCursor);
- wxDropSource(wxDataObject& data, wxWindow* win = @NULL,
- const wxIconOrCursor& iconCopy = wxNullIconOrCursor,
- const wxIconOrCursor& iconMove = wxNullIconOrCursor,
- const wxIconOrCursor& iconNone = wxNullIconOrCursor);
//@}
/**
the drag-and-drop operation which will terminate when the user releases the
mouse.
- @param flags
- If wxDrag_AllowMove is included in the flags, data may
- be moved and not only copied (default). If wxDrag_DefaultMove is
- specified (which includes the previous flag), this is even the default
- operation
+ @param flags
+ If wxDrag_AllowMove is included in the flags, data may
+ be moved and not only copied (default). If wxDrag_DefaultMove is
+ specified (which includes the previous flag), this is even the default
+ operation
- @returns Returns the operation requested by the user, may be wxDragCopy,
- wxDragMove, wxDragLink, wxDragCancel or wxDragNone if
- an error occurred.
+ @returns Returns the operation requested by the user, may be wxDragCopy,
+ wxDragMove, wxDragLink, wxDragCancel or wxDragNone if
+ an error occurred.
*/
virtual wxDragResult DoDragDrop(int flags = wxDrag_CopyOnly);
/**
Returns the wxDataObject object that has been assigned previously.
*/
- wxDataObject * GetDataObject();
+ wxDataObject* GetDataObject();
/**
Overridable: you may give some custom UI feedback during the drag and drop
not be too
slow.
- @param effect
- The effect to implement. One of wxDragCopy, wxDragMove, wxDragLink and
+ @param effect
+ The effect to implement. One of wxDragCopy, wxDragMove, wxDragLink and
wxDragNone.
-
- @param scrolling
- @true if the window is scrolling. MSW only.
+ @param scrolling
+ @true if the window is scrolling. MSW only.
@returns Return @false if you want default feedback, or @true if you
- implement your own feedback. The return values is
- ignored under GTK.
+ implement your own feedback. The return values is
+ ignored under GTK.
*/
virtual bool GiveFeedback(wxDragResult effect);
/**
Set the icon to use for a certain drag result.
- @param res
- The drag result to set the icon for.
-
- @param cursor
- The ion to show when this drag result occurs.
+ @param res
+ The drag result to set the icon for.
+ @param cursor
+ The ion to show when this drag result occurs.
*/
void SetCursor(wxDragResult res, const wxCursor& cursor);
/**
- Sets the data wxDataObject associated with the
+ Sets the data wxDataObject associated with the
drop source. This will not delete any previously associated data.
*/
void SetData(wxDataObject& data);
};
+
/**
@class wxFileDropTarget
@wxheader{dnd.h}
-
+
This is a @ref overview_wxdroptarget "drop target" which accepts files (dragged
from File Manager or Explorer).
-
+
@library{wxcore}
@category{dnd}
-
- @seealso
- @ref overview_wxdndoverview "Drag and drop overview", wxDropSource,
- wxDropTarget, wxTextDropTarget
+
+ @see @ref overview_wxdndoverview, wxDropSource, wxDropTarget, wxTextDropTarget
*/
class wxFileDropTarget : public wxDropTarget
{
/**
Override this function to receive dropped files.
- @param x
- The x coordinate of the mouse.
-
- @param y
- The y coordinate of the mouse.
-
- @param filenames
- An array of filenames.
+ @param x
+ The x coordinate of the mouse.
+ @param y
+ The y coordinate of the mouse.
+ @param filenames
+ An array of filenames.
*/
virtual bool OnDropFiles(wxCoord x, wxCoord y,
const wxArrayString& filenames);
};
+
// ============================================================================
// Global functions/macros
// ============================================================================
This macro creates either a cursor (MSW) or an icon (elsewhere) with the given
name. Under MSW, the cursor is loaded from the resource file and the icon is
loaded from XPM file under other platforms.
-
This macro should be used with
@ref wxDropSource::wxdropsource "wxDropSource constructor".
*/
-#define wxIconOrCursor wxDROP_ICON(const char * name) /* implementation is private */
+#define wxIconOrCursor wxDROP_ICON(const char* name) /* implementation is private */
projects / wxWidgets.git / blobdiff