juce_DragAndDropTarget.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2022 - Raw Material Software Limited
 
   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 7 End-User License
   Agreement and JUCE Privacy Policy.
 
   End User License Agreement: www.juce.com/juce-7-licence
   Privacy Policy: www.juce.com/juce-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
{
 
//==============================================================================
class JUCE_API  DragAndDropTarget
{
public:
    virtual ~DragAndDropTarget() = default;
 
    //==============================================================================
    class JUCE_API  SourceDetails
    {
    public:
        SourceDetails (const var& description,
                       Component* sourceComponent,
                       Point<int> localPosition) noexcept;

        var description;

        WeakReference<Component> sourceComponent;

        Point<int> localPosition;
    };
 
    //==============================================================================
    virtual bool isInterestedInDragSource (const SourceDetails& dragSourceDetails) = 0;

    virtual void itemDragEnter (const SourceDetails& dragSourceDetails);

    virtual void itemDragMove (const SourceDetails& dragSourceDetails);

    virtual void itemDragExit (const SourceDetails& dragSourceDetails);

    virtual void itemDropped (const SourceDetails& dragSourceDetails) = 0;

    virtual bool shouldDrawDragImageWhenOver();
};
 
} // namespace juce