108 lines
4.5 KiB
C++
108 lines
4.5 KiB
C++
/*
|
|
==============================================================================
|
|
|
|
This file is part of the JUCE library.
|
|
Copyright (c) 2017 - ROLI Ltd.
|
|
|
|
JUCE is an open source library subject to commercial or open-source
|
|
licensing.
|
|
|
|
By using JUCE, you agree to the terms of both the JUCE 5 End-User License
|
|
Agreement and JUCE 5 Privacy Policy (both updated and effective as of the
|
|
27th April 2017).
|
|
|
|
End User License Agreement: www.juce.com/juce-5-licence
|
|
Privacy Policy: www.juce.com/juce-5-privacy-policy
|
|
|
|
Or: You may also use this code under the terms of the GPL v3 (see
|
|
www.gnu.org/licenses).
|
|
|
|
JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
|
|
EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
|
|
DISCLAIMED.
|
|
|
|
==============================================================================
|
|
*/
|
|
|
|
namespace juce
|
|
{
|
|
|
|
/**
|
|
Components derived from this class can have files dropped onto them by an external application.
|
|
|
|
@see DragAndDropContainer
|
|
|
|
@tags{GUI}
|
|
*/
|
|
class JUCE_API FileDragAndDropTarget
|
|
{
|
|
public:
|
|
/** Destructor. */
|
|
virtual ~FileDragAndDropTarget() {}
|
|
|
|
/** Callback to check whether this target is interested in the set of files 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, like opening the files to have a look
|
|
inside them!
|
|
|
|
@param files the set of (absolute) pathnames of the files 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.
|
|
*/
|
|
virtual bool isInterestedInFileDrag (const StringArray& files) = 0;
|
|
|
|
/** Callback to indicate that some files are 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 files can be dropped here or not.
|
|
|
|
@param files the set of (absolute) pathnames of the files that the user is dragging
|
|
@param x the mouse x position, relative to this component
|
|
@param y the mouse y position, relative to this component
|
|
*/
|
|
virtual void fileDragEnter (const StringArray& files, int x, int y);
|
|
|
|
/** Callback to indicate that the user is dragging some files 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.
|
|
|
|
@param files the set of (absolute) pathnames of the files that the user is dragging
|
|
@param x the mouse x position, relative to this component
|
|
@param y the mouse y position, relative to this component
|
|
*/
|
|
virtual void fileDragMove (const StringArray& files, int x, int y);
|
|
|
|
/** 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 files.
|
|
|
|
If you've used fileDragEnter() to repaint your component and give feedback, use this
|
|
as a signal to repaint it in its normal state.
|
|
|
|
@param files the set of (absolute) pathnames of the files that the user is dragging
|
|
*/
|
|
virtual void fileDragExit (const StringArray& files);
|
|
|
|
/** Callback to indicate that the user has dropped the files onto this component.
|
|
|
|
When the user drops the files, this get called, and you can use the files in whatever
|
|
way is appropriate.
|
|
|
|
Note that after this is called, the fileDragExit method may not be called, so you should
|
|
clean up in here if there's anything you need to do when the drag finishes.
|
|
|
|
@param files the set of (absolute) pathnames of the files that the user is dragging
|
|
@param x the mouse x position, relative to this component
|
|
@param y the mouse y position, relative to this component
|
|
*/
|
|
virtual void filesDropped (const StringArray& files, int x, int y) = 0;
|
|
};
|
|
|
|
} // namespace juce
|