ScrollGesture.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: ScrollGesture
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <QObject>
class QMouseEvent;
class QPoint;
class QAbstractScrollArea;
 
namespace NDEVR
{
    class FlickableTicker;
    class ScrollGesturePrivate;
    /**--------------------------------------------------------------------------------------------------
    \brief Handles scrolling or flicking within the application.
    **/
    class NDEVR_WIDGETS_API ScrollGesture : public QObject
    {
    public:
 
        ScrollGesture(QAbstractScrollArea* target);
        virtual ~ScrollGesture();
 
        bool eventFilter(QObject *, QEvent *) override;
        void setThreshold(int threshold);
        int threshold() const;
 
        void setAcceptMouseClick(QWidget *target);
 
        bool handleMousePress(QEvent* event, QPoint location);
        bool handleMouseMove(QEvent* event, QPoint location);
        bool handleMouseRelease(QEvent* event, QPoint location);
        void setScrollOffset(QPoint point);
    private:
        void tick();
 
    private:
        ScrollGesturePrivate *d;
        QAbstractScrollArea* m_widget;
        friend class FlickableTicker;
    };
}