DockOverlay.h

Go to the documentation of this file.

#ifndef DockOverlayH
#define DockOverlayH
/*******************************************************************************
** Qt Advanced Docking System
** Copyright (C) 2017 Uwe Kindler
**
** This library is free software; you can redistribute it and/or
** modify it under the terms of the GNU Lesser General Public
** License as published by the Free Software Foundation; either
** version 2.1 of the License, or (at your option) any later version.
**
** This library 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
** Lesser General Public License for more details.
**
** You should have received a copy of the GNU Lesser General Public
** License along with this library; If not, see <http://www.gnu.org/licenses/>.
******************************************************************************/
 
 
//============================================================================
//                                   INCLUDES
//============================================================================
#include <QPointer>
#include <QHash>
#include <QRect>
#include <QFrame>
 
#include "ads_globals.h"
 
QT_FORWARD_DECLARE_CLASS(QGridLayout)
 
namespace ads
{
struct DockOverlayPrivate;
class CDockOverlayCross;
 
class ADS_EXPORT CDockOverlay : public QFrame
{
        Q_OBJECT
private:
        DockOverlayPrivate* d; //< private data class
        friend struct DockOverlayPrivate;
        friend class DockOverlayCross;
 
public:
        using Super = QFrame;
 
        enum eMode
        {
                ModeDockAreaOverlay,
                ModeContainerOverlay
        };
 
        CDockOverlay(QWidget* parent, eMode Mode = ModeDockAreaOverlay);
 
        virtual ~CDockOverlay();
 
        void setAllowedAreas(DockWidgetAreas areas);
 
        DockWidgetAreas allowedAreas() const;
 
        DockWidgetArea dropAreaUnderCursor() const;
 
        DockWidgetArea visibleDropAreaUnderCursor() const;
 
        DockWidgetArea showOverlay(QWidget* target);
 
        void hideOverlay();
 
        void enableDropPreview(bool Enable);
 
        bool dropPreviewEnabled() const;
 
        QRect dropOverlayRect() const;
 
        virtual bool event(QEvent *e) override;
 
protected:
        virtual void paintEvent(QPaintEvent *e) override;
        virtual void showEvent(QShowEvent* e) override;
        virtual void hideEvent(QHideEvent* e) override;
};
 
 
struct DockOverlayCrossPrivate;
class CDockOverlayCross : public QWidget
{
        Q_OBJECT
        Q_PROPERTY(QString iconColors READ iconColors WRITE setIconColors)
        Q_PROPERTY(QColor iconFrameColor READ iconColor WRITE setIconFrameColor)
        Q_PROPERTY(QColor iconBackgroundColor READ iconColor WRITE setIconBackgroundColor)
        Q_PROPERTY(QColor iconOverlayColor READ iconColor WRITE setIconOverlayColor)
        Q_PROPERTY(QColor iconArrowColor READ iconColor WRITE setIconArrowColor)
        Q_PROPERTY(QColor iconShadowColor READ iconColor WRITE setIconShadowColor)
 
public:
        enum eIconColor
        {
                FrameColor,
                WindowBackgroundColor,
                OverlayColor,
                ArrowColor,
                ShadowColor
        };
 
private:
        DockOverlayCrossPrivate* d;
        friend struct DockOverlayCrossPrivate;
        friend class CDockOverlay;
 
protected:
    QString iconColors() const;
 
    QColor iconColor() const {return QColor();}
    void setIconFrameColor(const QColor& Color) {setIconColor(FrameColor, Color);}
    void setIconBackgroundColor(const QColor& Color) {setIconColor(WindowBackgroundColor, Color);}
    void setIconOverlayColor(const QColor& Color) {setIconColor(OverlayColor, Color);}
    void setIconArrowColor(const QColor& Color) {setIconColor(ArrowColor, Color);}
    void setIconShadowColor(const QColor& Color) {setIconColor(ShadowColor, Color);}
 
public:
        CDockOverlayCross(CDockOverlay* overlay);
 
        virtual ~CDockOverlayCross();
 
        void setIconColor(eIconColor ColorIndex, const QColor& Color);
 
        QColor iconColor(eIconColor ColorIndex) const;
 
        DockWidgetArea cursorLocation() const;
 
        void setupOverlayCross(CDockOverlay::eMode Mode);
 
        void updateOverlayIcons();
 
        void reset();
 
        void updatePosition();
 
    void setIconColors(const QString& Colors);
 
protected:
        virtual void showEvent(QShowEvent* e) override;
        void setAreaWidgets(const QHash<DockWidgetArea, QWidget*>& widgets);
}; // CDockOverlayCross
 
} // namespace ads
#endif // DockOverlayH