/****************************************************************************

**

** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the Qt3Support module of the Qt Toolkit.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

** Alternatively, this file may be used under the terms of the GNU Lesser

** General Public License version 2.1 as published by the Free Software

** Foundation and appearing in the file LICENSE.LGPL included in the

** packaging of this file.  Please review the following information to

** ensure the GNU Lesser General Public License version 2.1 requirements

** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

#ifndef Q3SCROLLVIEW_H

#define Q3SCROLLVIEW_H

#include <Qt3Support/q3frame.h>

#include <QtGui/qscrollbar.h>

QT_BEGIN_HEADER

QT_BEGIN_NAMESPACE

QT_MODULE(Qt3SupportLight)

class Q3ScrollViewData;

class Q_COMPAT_EXPORT Q3ScrollView : public Q3Frame

{

    Q_OBJECT

    Q_ENUMS( ResizePolicy ScrollBarMode )

    Q_PROPERTY( ResizePolicy resizePolicy READ resizePolicy WRITE setResizePolicy )

    Q_PROPERTY( ScrollBarMode vScrollBarMode READ vScrollBarMode WRITE setVScrollBarMode )

    Q_PROPERTY( ScrollBarMode hScrollBarMode READ hScrollBarMode WRITE setHScrollBarMode )

    Q_PROPERTY( int visibleWidth READ visibleWidth )

    Q_PROPERTY( int visibleHeight READ visibleHeight )

    Q_PROPERTY( int contentsWidth READ contentsWidth )

    Q_PROPERTY( int contentsHeight READ contentsHeight )

    Q_PROPERTY( int contentsX READ contentsX )

    Q_PROPERTY( int contentsY READ contentsY )

    Q_PROPERTY( bool dragAutoScroll READ dragAutoScroll WRITE setDragAutoScroll )

public:

    Q3ScrollView(QWidget* parent=0, const char* name=0, Qt::WindowFlags f=0);

    ~Q3ScrollView();

    enum ResizePolicy { Default, Manual, AutoOne, AutoOneFit };

    virtual void setResizePolicy( ResizePolicy );

    ResizePolicy resizePolicy() const;

    void styleChange( QStyle & );

    void removeChild(QWidget* child);

    virtual void addChild( QWidget* child, int x=0, int y=0 );

    virtual void moveChild( QWidget* child, int x, int y );

    int childX(QWidget* child);

    int childY(QWidget* child);

    bool childIsVisible(QWidget* child) { return child->isVisible(); } // obsolete functions

    void showChild(QWidget* child, bool yes=true) { child->setVisible(yes); }

    enum ScrollBarMode { Auto, AlwaysOff, AlwaysOn };

    ScrollBarMode vScrollBarMode() const;

    virtual void  setVScrollBarMode( ScrollBarMode );

    ScrollBarMode hScrollBarMode() const;

    virtual void  setHScrollBarMode( ScrollBarMode );

    QWidget*     cornerWidget() const;

    virtual void setCornerWidget(QWidget*);

    // ### 4.0: Consider providing a factory function for scrollbars

    //          (e.g. make the two following functions virtual)

    QScrollBar*  horizontalScrollBar() const;

    QScrollBar*  verticalScrollBar() const;

    QWidget*	 viewport() const;

    QWidget*	 clipper() const;

    int		visibleWidth() const;

    int		visibleHeight() const;

    int		contentsWidth() const;

    int		contentsHeight() const;

    int		contentsX() const;

    int		contentsY() const;

    void	resize( int w, int h );

    void	resize( const QSize& );

    void	setVisible(bool visible);

    void	updateContents( int x, int y, int w, int h );

    void	updateContents( const QRect& r );

    void 	updateContents();

    void	repaintContents( int x, int y, int w, int h, bool erase=true );

    void	repaintContents( const QRect& r, bool erase=true );

    void 	repaintContents( bool erase=true );

    void	contentsToViewport( int x, int y, int& vx, int& vy ) const;

    void	viewportToContents( int vx, int vy, int& x, int& y ) const;

    QPoint	contentsToViewport( const QPoint& ) const;

    QPoint	viewportToContents( const QPoint& ) const;

    void	enableClipper( bool y );

    void	setStaticBackground( bool y );

    bool	hasStaticBackground() const;

    QSize	viewportSize( int, int ) const;

    QSize	sizeHint() const;

    QSize	minimumSizeHint() const;

    void	removeChild(QObject* child);

    bool	isHorizontalSliderPressed();

    bool	isVerticalSliderPressed();

    virtual void setDragAutoScroll( bool b );

    bool	 dragAutoScroll() const;

Q_SIGNALS:

    void	contentsMoving(int x, int y);

    void	horizontalSliderPressed();

    void	horizontalSliderReleased();

    void	verticalSliderPressed();

    void	verticalSliderReleased();

public Q_SLOTS:

    virtual void resizeContents( int w, int h );

    void	scrollBy( int dx, int dy );

    virtual void setContentsPos( int x, int y );

    void	ensureVisible(int x, int y);

    void	ensureVisible(int x, int y, int xmargin, int ymargin);

    void	center(int x, int y);

    void	center(int x, int y, float xmargin, float ymargin);

    void	updateScrollBars(); // ### virtual in 4.0

    void	setEnabled( bool enable );

protected:

    virtual void drawContents(QPainter*, int cx, int cy, int cw, int ch);

    virtual void drawContentsOffset(QPainter*, int ox, int oy,

		    int cx, int cy, int cw, int ch);

    virtual void contentsMousePressEvent( QMouseEvent* );

    virtual void contentsMouseReleaseEvent( QMouseEvent* );

    virtual void contentsMouseDoubleClickEvent( QMouseEvent* );

    virtual void contentsMouseMoveEvent( QMouseEvent* );

    virtual void contentsDragEnterEvent( QDragEnterEvent * );

    virtual void contentsDragMoveEvent( QDragMoveEvent * );

    virtual void contentsDragLeaveEvent( QDragLeaveEvent * );

    virtual void contentsDropEvent( QDropEvent * );

    virtual void contentsWheelEvent( QWheelEvent * );

    virtual void contentsContextMenuEvent( QContextMenuEvent * );

    virtual void viewportPaintEvent( QPaintEvent* );

    virtual void viewportResizeEvent( QResizeEvent* );

    virtual void viewportMousePressEvent( QMouseEvent* );

    virtual void viewportMouseReleaseEvent( QMouseEvent* );

    virtual void viewportMouseDoubleClickEvent( QMouseEvent* );

    virtual void viewportMouseMoveEvent( QMouseEvent* );

    virtual void viewportDragEnterEvent( QDragEnterEvent * );

    virtual void viewportDragMoveEvent( QDragMoveEvent * );

    virtual void viewportDragLeaveEvent( QDragLeaveEvent * );

    virtual void viewportDropEvent( QDropEvent * );

    virtual void viewportWheelEvent( QWheelEvent * );

    virtual void viewportContextMenuEvent( QContextMenuEvent * );

    void	frameChanged();

public:

    virtual void setMargins(int left, int top, int right, int bottom);

    int leftMargin() const;

    int topMargin() const;

    int rightMargin() const;

    int bottomMargin() const;

protected:

    bool focusNextPrevChild( bool next );

    virtual void setHBarGeometry(QScrollBar& hbar, int x, int y, int w, int h);

    virtual void setVBarGeometry(QScrollBar& vbar, int x, int y, int w, int h);

    void resizeEvent(QResizeEvent*);

    void  mousePressEvent( QMouseEvent * );

    void  mouseReleaseEvent( QMouseEvent * );

    void  mouseDoubleClickEvent( QMouseEvent * );

    void  mouseMoveEvent( QMouseEvent * );

    void  wheelEvent( QWheelEvent * );

    void contextMenuEvent( QContextMenuEvent * );

    bool eventFilter( QObject *, QEvent *e );

    void setCachedSizeHint( const QSize &sh ) const;

    QSize cachedSizeHint() const;

    void fontChange( const QFont & );

private:

    void drawContents( QPainter* );

    void moveContents(int x, int y);

    Q3ScrollViewData* d;

private Q_SLOTS:

    void hslide(int);

    void vslide(int);

    void hbarIsPressed();

    void hbarIsReleased();

    void vbarIsPressed();

    void vbarIsReleased();

    void doDragAutoScroll();

    void startDragAutoScroll();

    void stopDragAutoScroll();

private: // Disabled copy constructor and operator=

    Q_DISABLE_COPY(Q3ScrollView)

    void changeFrameRect(const QRect&);

public:

    void disableSizeHintCaching();

};

QT_END_NAMESPACE

QT_END_HEADER

#endif // Q3SCROLLVIEW_H