452d02011f3fc7f4b12e067dbb5df4faa29488a8
[WebKit-https.git] / WebCore / kwq / KWQScrollView.h
1 /*
2  * Copyright (C) 2003 Apple Computer, Inc.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef QSCROLLVIEW_H_
27 #define QSCROLLVIEW_H_
28
29 #include "KWQFrame.h"
30
31 #ifdef __OBJC__
32 @class NSView;
33 #else
34 class NSView;
35 #endif
36
37 class QScrollView : public QFrame {
38 public:
39     enum ScrollBarMode { Auto, AlwaysOff, AlwaysOn };
40
41     QScrollView(QWidget *parent = 0, const char *name = 0, int flags = 0) { }
42
43     QWidget *viewport() const;
44     int visibleWidth() const;
45     int visibleHeight() const;
46     int contentsWidth() const;
47     int contentsHeight() const;
48     int contentsX() const;
49     int contentsY() const;
50     void scrollBy(int dx, int dy);
51
52     void setContentsPos(int x, int y);
53     void setContentsPosRecursive(int,int);
54
55     virtual void setVScrollBarMode(ScrollBarMode vMode);
56     virtual void setHScrollBarMode(ScrollBarMode hMode);
57
58     // The following method is not defined in Qt, but we provide it so that we can
59     // set the mode for both scrollbars at once.
60     virtual void setScrollBarsMode(ScrollBarMode mode);
61
62     // This method is also not defined in Qt.  It gives us a means of blocking painting on our
63     // scrollbars until the first layout has occurred.
64     void suppressScrollBars(bool suppressed, bool repaintOnUnsuppress=false);
65     
66     ScrollBarMode vScrollBarMode() const;
67     ScrollBarMode hScrollBarMode() const;
68
69     bool hasVerticalScrollBar() const;
70     bool hasHorizontalScrollBar() const;
71     
72     void addChild(QWidget *child, int x = 0, int y = 0);
73     void removeChild(QWidget *child);
74     int childX(QWidget *child);
75     int childY(QWidget *child);
76
77     virtual void resizeContents(int w, int h);
78     void updateContents(int x, int y, int w, int h, bool now=false);
79     void updateContents(const QRect &r, bool now=false);
80     void repaintContents(int x, int y, int w, int h, bool erase = true);
81     QPoint contentsToViewport(const QPoint &);
82     void contentsToViewport(int x, int y, int& vx, int& vy);
83     void viewportToContents(int vx, int vy, int& x, int& y);
84
85     QWidget *clipper() const { return 0; }
86     void enableClipper(bool) { }
87
88     void setStaticBackground(bool);
89
90     void resizeEvent(QResizeEvent *);
91
92     void ensureVisible(int,int);
93     void ensureVisible(int,int,int,int);
94     void ensureRectVisibleCentered(const QRect &r);
95         
96     NSView *getDocumentView() const;
97 };
98
99 #endif