DropOverlay.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: Widgets
File: DropOverlay
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
class QGridLayout;
 
#include <NDEVR/RibbonArea.h>
#include <QFrame>
namespace NDEVR
{
    class DropOverlayCross;
    /**--------------------------------------------------------------------------------------------------
    \brief Paints a translucent rectangle over another widget. The geometry of the rectangle is based 
        on the mouse location. Used with the NDEVR API Widget Docking system to show where a dock
        can be placed.
    **/
    class DropOverlay : public QFrame
    {
        Q_OBJECT
        friend class DropOverlayCross;
    public:
        DropOverlay(QWidget* parent);
        virtual ~DropOverlay();
        void setAreaWidgets(const QHash<DropArea, QWidget*>& widgets);
        DropArea cursorLocation() const;
        DropArea showDropOverlay(QWidget* target, QWidget* payload);
        void showDropOverlay(QWidget* target, const QRect& targetAreaRect);
        void hideDropOverlay();
    protected:
        virtual void paintEvent(QPaintEvent* e) override;
        virtual void showEvent(QShowEvent* e) override;
        virtual void hideEvent(QHideEvent* e) override;
        virtual void resizeEvent(QResizeEvent* e) override;
        virtual void moveEvent(QMoveEvent* e) override;
    private:
        DropOverlayCross* _cross;
        QWidget* m_payload = nullptr;
        bool _fullAreaDrop;
        QWidget* _target;
        QRect _targetRect;
        DropArea _lastLocation;
    };
     /**--------------------------------------------------------------------------------------------------
     \brief Shows a cross with 5 different drop area possibilities.
    **/
    class DropOverlayCross : public QWidget
    {
        Q_OBJECT
        friend class DropOverlay;
    public:
        DropOverlayCross(DropOverlay* overlay);
        virtual ~DropOverlayCross();
        void setAreaWidgets(const QHash<DropArea, QWidget*>& widgets);
        DropArea cursorLocation() const;
    protected:
        virtual void showEvent(QShowEvent* e);
    private:
        void reset();
    private:
        DropOverlay* _overlay;
        QHash<DropArea, QWidget*> _widgets;
        QGridLayout* _grid;
    };
}