TextDragAndDropTarget Class Referenceabstract

Components derived from this class can have text dropped onto them by an external application. More...

Public Member Functions

virtual ~TextDragAndDropTarget ()
 Destructor. More...
 
virtual bool isInterestedInTextDrag (const String &text)=0
 Callback to check whether this target is interested in the set of text being offered. More...
 
virtual void textDragEnter (const String &text, int x, int y)
 Callback to indicate that some text is being dragged over this component. More...
 
virtual void textDragMove (const String &text, int x, int y)
 Callback to indicate that the user is dragging some text over this component. More...
 
virtual void textDragExit (const String &text)
 Callback to indicate that the mouse has moved away from this component. More...
 
virtual void textDropped (const String &text, int x, int y)=0
 Callback to indicate that the user has dropped the text onto this component. More...
 

Detailed Description

Components derived from this class can have text dropped onto them by an external application.

See also
DragAndDropContainer

Constructor & Destructor Documentation

◆ ~TextDragAndDropTarget()

virtual TextDragAndDropTarget::~TextDragAndDropTarget ( )
virtual

Destructor.

Member Function Documentation

◆ isInterestedInTextDrag()

virtual bool TextDragAndDropTarget::isInterestedInTextDrag ( const String text)
pure virtual

Callback to check whether this target is interested in the set of text being offered.

Note that this will be called repeatedly when the user is dragging the mouse around over your component, so don't do anything time-consuming in here!

Parameters
textthe text that the user is dragging
Returns
true if this component wants to receive the other callbacks regarging this type of object; if it returns false, no other callbacks will be made.

◆ textDragEnter()

virtual void TextDragAndDropTarget::textDragEnter ( const String text,
int  x,
int  y 
)
virtual

Callback to indicate that some text is being dragged over this component.

This gets called when the user moves the mouse into this component while dragging.

Use this callback as a trigger to make your component repaint itself to give the user feedback about whether the text can be dropped here or not.

Parameters
textthe text that the user is dragging
xthe mouse x position, relative to this component
ythe mouse y position, relative to this component

◆ textDragMove()

virtual void TextDragAndDropTarget::textDragMove ( const String text,
int  x,
int  y 
)
virtual

Callback to indicate that the user is dragging some text over this component.

This gets called when the user moves the mouse over this component while dragging. Normally overriding itemDragEnter() and itemDragExit() are enough, but this lets you know what happens in-between.

Parameters
textthe text that the user is dragging
xthe mouse x position, relative to this component
ythe mouse y position, relative to this component

◆ textDragExit()

virtual void TextDragAndDropTarget::textDragExit ( const String text)
virtual

Callback to indicate that the mouse has moved away from this component.

This gets called when the user moves the mouse out of this component while dragging the text.

If you've used textDragEnter() to repaint your component and give feedback, use this as a signal to repaint it in its normal state.

Parameters
textthe text that the user is dragging

◆ textDropped()

virtual void TextDragAndDropTarget::textDropped ( const String text,
int  x,
int  y 
)
pure virtual

Callback to indicate that the user has dropped the text onto this component.

When the user drops the text, this get called, and you can use the text in whatever way is appropriate.

Note that after this is called, the textDragExit method may not be called, so you should clean up in here if there's anything you need to do when the drag finishes.

Parameters
textthe text that the user is dragging
xthe mouse x position, relative to this component
ythe mouse y position, relative to this component

The documentation for this class was generated from the following file: