ScrollPane.h

Go to the documentation of this file.

/*
 *   Copyright (C) 2007, 2008, 2009, 2010 Ivan Cukic <ivan.cukic(at)kde.org>
 *
 *   This program is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU Lesser/Library General Public License version 2,
 *   or (at your option) any later version, as published by the Free
 *   Software Foundation
 *
 *   This program 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/Library General Public License for more details
 *
 *   You should have received a copy of the GNU Lesser/Library General Public
 *   License along with this program; if not, write to the
 *   Free Software Foundation, Inc.,
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */

#ifndef LANCELOT_SCROLL_PANE_H
#define LANCELOT_SCROLL_PANE_H

#include <lancelot/lancelot_export.h>
#include <lancelot/widgets/Panel.h>

namespace Lancelot
{

class ScrollPane;

class LANCELOT_EXPORT Scrollable {
public:
    Scrollable();

    virtual ~Scrollable();

    virtual QSizeF sizeFor(QSizeF viewportSize) const = 0;

    virtual void viewportChanged(QRectF viewport) = 0;

    virtual qreal scrollUnit(Qt::Orientation direction) const = 0;

    virtual void setScrollPane(ScrollPane * pane);

    virtual ScrollPane * scrollPane() const;

private:
    class Private;
    Private * const d;
};

class LANCELOT_EXPORT ScrollPane: public Lancelot::Widget {
    Q_OBJECT

    Q_PROPERTY(QPointF scrollPosition READ scrollPosition WRITE setScrollPosition)
    Q_PROPERTY(QSizeF contentsSize READ contentsSize)
    Q_PROPERTY(QRectF viewportGeometry READ viewportGeometry)

    // @puck L_WIDGET
    // @puck L_INCLUDE(lancelot/widgets/ScrollPane.h)

public:
    enum Flag {
        ClipScrollable = 1,
        HoverShowScrollbars = 2
    };
    Q_DECLARE_FLAGS(Flags, Flag)

    
    ScrollPane(QGraphicsItem * parent = 0);

    virtual ~ScrollPane();

    void setScrollableWidget(Scrollable * widget);

    QSizeF maximumViewportSize() const;

    QSizeF currentViewportSize() const;

    void setFlag(Flag flag);

    void clearFlag(Flag flag);

    Flags flags() const;

    void setFlags(Flags flags);

    void setFlip(Plasma::Flip flip);

    void scrollTo(QRectF rect);

    QSizeF contentsSize() const;

    void setScrollPosition(const QPointF &position);

    QPointF scrollPosition() const;

    QRectF viewportGeometry() const;


protected:
    L_Override void hoverEnterEvent(QGraphicsSceneHoverEvent * event);
    L_Override void hoverLeaveEvent(QGraphicsSceneHoverEvent * event);
    L_Override void resizeEvent(QGraphicsSceneResizeEvent * event);

public Q_SLOTS:
    void scrollableWidgetSizeUpdateNeeded();

    void scrollHorizontal(int value);

    void scrollVertical(int value);

private:
    class Private;
    Private * const d;
};

} // namespace Lancelot

Q_DECLARE_OPERATORS_FOR_FLAGS(Lancelot::ScrollPane::Flags)

#endif // LANCELOT_SCROLL_PANE_H