DropIndicatorOverlay.h

Go to the documentation of this file.

/*
  This file is part of KDDockWidgets.
 
  SPDX-FileCopyrightText: 2019 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
  Author: Sérgio Martins <sergio.martins@kdab.com>
 
  SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
 
  Contact KDAB at <info@kdab.com> for commercial licensing options.
*/
 
#ifndef KD_DROPINDICATOROVERLAY_H
#define KD_DROPINDICATOROVERLAY_H
 
#include "kddockwidgets/docks_export.h"
#include "kddockwidgets/KDDockWidgets.h"
#include "Controller.h"
 
namespace KDDockWidgets {
 
namespace Core {
 
class DropArea;
class Group;
 
 
class DOCKS_EXPORT DropIndicatorOverlay : public Controller
{
    Q_OBJECT
public:
    explicit DropIndicatorOverlay(DropArea *dropArea, View *view);
 
    explicit DropIndicatorOverlay(DropArea *dropArea);
 
    ~DropIndicatorOverlay() override;
 
    void setHoveredGroup(Group *);
    void setWindowBeingDragged(bool);
    Rect hoveredGroupRect() const;
    bool isHovered() const;
    DropLocation currentDropLocation() const;
    Group *hoveredGroup() const;
 
    virtual void setCurrentDropLocation(DropLocation);
 
    KDDockWidgets::DropLocation hover(Point globalPos);
 
    void removeHover();
 
    virtual Point posForIndicator(DropLocation) const = 0;
 
    virtual bool dropIndicatorVisible(DropLocation) const;
 
    static KDDockWidgets::Location multisplitterLocationFor(DropLocation);
 
    class Private;
    Private *dptr() const;
 
private:
    void onGroupDestroyed();
    void setHoveredGroupRect(Rect);
    Rect m_hoveredGroupRect;
    DropLocation m_currentDropLocation = DropLocation_None;
    Private *const d;
 
protected:
    virtual DropLocation hover_impl(Point globalPos) = 0;
    virtual void onHoveredGroupChanged(Group *);
    virtual void updateVisibility();
 
    Group *m_hoveredGroup = nullptr;
    DropArea *const m_dropArea;
    bool m_draggedWindowIsHovering = false;
};
 
}
 
}
 
#endif