SelectionHighlightBar.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: SelectionHighlightBar
Included in API: False
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include <NDEVR/WidgetOptions.h>
#include <NDEVR/Bounds.h>
#include <NDEVR/VectorFunctions.h>
#include <QPainter>
#include <QApplication>
#include <QStylePainter>
#include <QPropertyAnimation>
#include <QWidget>
namespace NDEVR
{
    /**--------------------------------------------------------------------------------------------------
    \brief Provides a highlighted animation for selecting docked tabs using the NDEVR API Widget 
        Docking system.
    **/
    class SelectionHighlightBar : public QWidget
    {
        Q_OBJECT
        Q_PROPERTY(double animation_percent READ animationPercent WRITE setAnimationPercent)
    public:
        SelectionHighlightBar(QWidget* parent = nullptr);
        double animationPercent() const;
        void setAnimationPercent(double animation_percent);
        void moveHighlight(QWidget* widget);
        void moveHighlight(const Bounds<1, int>& bounds);
        void setVertical(bool vertical);
        Bounds<1, int> currentBounds() const;
        QSize sizeHint() const override;
    protected:
        void paintEvent(QPaintEvent*) override;
    private:
        void startAnimation();
    private:
        QPropertyAnimation* m_move_animation;
        Bounds<1, int> m_old_draw_bounds;
        Bounds<1, int> m_draw_bounds;
        enum QEasingCurve::Type m_animation_type;
        bool m_is_vertical;
        int m_speed;
        double m_animation_percent;
    };
}