ScrollView.h

Go to the documentation of this file.

/*
 * Copyright (C) 2012 by
 *   MetraLabs GmbH (MLAB), GERMANY
 * and
 *   Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
 * All rights reserved.
 *
 * Contact: info@mira-project.org
 *
 * Commercial Usage:
 *   Licensees holding valid commercial licenses may use this file in
 *   accordance with the commercial license agreement provided with the
 *   software or, alternatively, in accordance with the terms contained in
 *   a written agreement between you and MLAB or NICR.
 *
 * GNU General Public License Usage:
 *   Alternatively, this file may be used under the terms of the GNU
 *   General Public License version 3.0 as published by the Free Software
 *   Foundation and appearing in the file LICENSE.GPL3 included in the
 *   packaging of this file. Please review the following information to
 *   ensure the GNU General Public License version 3.0 requirements will be
 *   met: http://www.gnu.org/copyleft/gpl.html.
 *   Alternatively you may (at your option) use any later version of the GNU
 *   General Public License if such license has been publicly approved by
 *   MLAB and NICR (or its successors, if any).
 *
 * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
 * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
 * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
 * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
 */

#ifndef _MIRA_SCROLLVIEW_H_
#define _MIRA_SCROLLVIEW_H_

#include <QAbstractScrollArea>

#include <widgets/GuiWidgetsExports.h>

namespace mira {


class MIRA_GUI_WIDGETS_EXPORT ScrollView : public QAbstractScrollArea
{
    Q_OBJECT
public:

    ScrollView(QWidget* parent);

    int contentsX()      const { return mContentsRect.x(); }
    int contentsY()      const { return mContentsRect.y(); }
    int contentsHeight() const { return mContentsRect.height(); }
    int contentsWidth()  const { return mContentsRect.width(); }

    void setContentsPos(int x, int y);
    void resizeContents(int width, int height);

    void ensureVisible(int x, int y, int marginX = 50, int marginY = 50);

    QPoint viewportToContents(const QPoint& pos) const;
    QPoint contentsToViewport(const QPoint& pos) const;

signals:

    void contentsMoving(int x, int y);

protected:

    void updateScrollBars();
    virtual void scrollContentsBy(int dX, int dY);

    virtual void resizeEvent(QResizeEvent* resizeEvent);
    virtual void paintEvent(QPaintEvent* paintEvent);
    virtual void wheelEvent(QWheelEvent* wheelEvent);

    virtual void drawContents(QPainter* painter, const QRect& rect) = 0;

    virtual void updateContents(const QRect& rect);
    virtual void updateContents();

    QRect mContentsRect;
};


}

#endif