/*
  This file is part of KDDockWidgets.

  Copyright (C) 2018-2020 Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.com
  Author: Sérgio Martins <sergio.martins@kdab.com>

  This program is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 2 of the License, or
  (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef KD_DROPINDICATOROVERLAYINTERFACE_P_H
#define KD_DROPINDICATOROVERLAYINTERFACE_P_H

#include "docks_export.h"
#include "QWidgetAdapter.h"
#include "Frame_p.h"
#include "KDDockWidgets.h"

namespace KDDockWidgets {

class FloatingWindow;
class DropArea;

class DOCKS_EXPORT_FOR_UNIT_TESTS DropIndicatorOverlayInterface : public QWidgetAdapter
{
    Q_OBJECT
public:
    enum Type {
        TypeNone = 0,
        TypeClassic = 1,
        TypeAnimated = 2
    };
    Q_ENUM(Type)

    enum DropLocation {
        DropLocation_None = 0,
        DropLocation_Left,
        DropLocation_Top,
        DropLocation_Right,
        DropLocation_Bottom,
        DropLocation_Center,
        DropLocation_OutterLeft,
        DropLocation_OutterTop,
        DropLocation_OutterRight,
        DropLocation_OutterBottom
    };
    Q_ENUM(DropLocation)

    explicit DropIndicatorOverlayInterface(DropArea *dropArea);
    void setHoveredFrame(Frame *);
    void setWindowBeingDragged(const FloatingWindow *);
    bool isHovered() const;
    DropLocation currentDropLocation() const { return m_currentDropLocation; }
    Frame *hoveredFrame() const { return m_hoveredFrame; }
    void setCurrentDropLocation(DropIndicatorOverlayInterface::DropLocation location);

    virtual Type indicatorType() const = 0;
    virtual void hover(QPoint globalPos) = 0;

    virtual QPoint posForIndicator(DropLocation) const = 0; // Used by unit-tests only

    static KDDockWidgets::Location multisplitterLocationFor(DropLocation);

Q_SIGNALS:
    void hoveredFrameChanged(KDDockWidgets::Frame *);

private:
    void onFrameDestroyed();

protected:
    virtual void onHoveredFrameChanged(Frame *);
    virtual void updateVisibility() = 0;
    Frame *m_hoveredFrame = nullptr;
    DropLocation m_currentDropLocation = DropLocation_None;
    QPointer<const FloatingWindow> m_windowBeingDragged;
    DropArea *const m_dropArea;
};
}

#endif
