9bd8c4841da7ce01618496a1e636c24e573239bc
[WebKit-https.git] / WebKit / qt / Api / qwebpage.h
1 /*
2     Copyright (C) 2007 Trolltech ASA
3     Copyright (C) 2007 Staikos Computing Services Inc.
4
5     This library is free software; you can redistribute it and/or
6     modify it under the terms of the GNU Library General Public
7     License as published by the Free Software Foundation; either
8     version 2 of the License, or (at your option) any later version.
9
10     This library is distributed in the hope that it will be useful,
11     but WITHOUT ANY WARRANTY; without even the implied warranty of
12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13     Library General Public License for more details.
14
15     You should have received a copy of the GNU Library General Public License
16     along with this library; see the file COPYING.LIB.  If not, write to
17     the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18     Boston, MA 02110-1301, USA.
19
20     This class provides all functionality needed for loading images, style sheets and html
21     pages from the web. It has a memory cache for these objects.
22 */
23
24 #ifndef QWEBPAGE_H
25 #define QWEBPAGE_H
26
27 #include "qwebpagehistory.h"
28 #include "qwebsettings.h"
29 #include <qwebkitglobal.h>
30
31 #include <qwidget.h>
32 class QNetworkProxy;
33 class QUndoStack;
34 class QUrl;
35 class QWebFrame;
36 class QWebNetworkRequest;
37
38 class QWebPagePrivate;
39 class QWebFrameData;
40 class QWebNetworkInterface;
41
42 namespace WebCore {
43     class ChromeClientQt;
44     class FrameLoaderClientQt;
45     class FrameLoadRequest;
46     class EditorClientQt;
47     class ResourceHandle;
48     class HitTestResult;
49 }
50
51 class QWEBKIT_EXPORT QWebPage : public QWidget
52 {
53     Q_OBJECT
54
55     Q_PROPERTY(bool modified READ isModified)
56 public:
57     enum NavigationRequestResponse {
58         AcceptNavigationRequest,
59         IgnoreNavigationRequest
60     };
61
62     enum NavigationType {
63         NavigationTypeLinkClicked,
64         NavigationTypeFormSubmitted,
65         NavigationTypeBackForward,
66         NavigationTypeReload,
67         NavigationTypeFormResubmitted,
68         NavigationTypeOther
69     };
70
71     enum WebAction {
72         NoWebAction = - 1,
73
74         OpenLink,
75
76         OpenLinkInNewWindow,
77         OpenFrameInNewWindow,
78
79         DownloadLinkToDisk,
80         CopyLinkToClipboard,
81
82         OpenImageInNewWindow,
83         DownloadImageToDisk,
84         CopyImageToClipboard,
85
86         GoBack,
87         GoForward,
88         Stop,
89         Reload,
90
91         Cut,
92         Copy,
93         Paste,
94
95         Undo,
96         Redo,
97         MoveToNextChar,
98         MoveToPreviousChar,
99         MoveToNextWord,
100         MoveToPreviousWord,
101         MoveToNextLine,
102         MoveToPreviousLine,
103         MoveToStartOfLine,
104         MoveToEndOfLine,
105         MoveToStartOfBlock,
106         MoveToEndOfBlock,
107         MoveToStartOfDocument,
108         MoveToEndOfDocument,
109         SelectNextChar,
110         SelectPreviousChar,
111         SelectNextWord,
112         SelectPreviousWord,
113         SelectNextLine,
114         SelectPreviousLine,
115         SelectStartOfLine,
116         SelectEndOfLine,
117         SelectStartOfBlock,
118         SelectEndOfBlock,
119         SelectStartOfDocument,
120         SelectEndOfDocument,
121         DeleteStartOfWord,
122         DeleteEndOfWord,
123
124         NumWebActions = DeleteEndOfWord
125     };
126
127
128     QWebPage(QWidget *parent);
129     ~QWebPage();
130
131     void open(const QUrl &url);
132     void open(const QWebNetworkRequest &request);
133
134     QWebFrame *mainFrame() const;
135
136     QWebPageHistory *history() const;
137
138     // ### owned by webpage, returns a pointer, no setter!
139     void setSettings(const QWebSettings &settings);
140     QWebSettings settings() const;
141
142     QSize sizeHint() const;
143
144     // ### should be windowTitle
145     QString title() const;
146     QUrl url() const;
147     // ### should be QWidget::icon
148     QPixmap icon() const;
149
150     bool isModified() const;
151     QUndoStack *undoStack() const;
152     
153     void setNetworkInterface(QWebNetworkInterface *interface);
154     QWebNetworkInterface *networkInterface() const;
155
156 #ifndef QT_NO_NETWORKPROXY
157     void setNetworkProxy(const QNetworkProxy& proxy);
158     QNetworkProxy networkProxy() const;
159 #endif
160
161     // #### remove after adding editor actions
162     bool canCut() const;
163     bool canCopy() const;
164     bool canPaste() const;
165
166     quint64 totalBytes() const;
167     quint64 bytesReceived() const;
168
169     QAction *webAction(WebAction action) const;
170
171 public slots:
172     /**
173      * Stops loading of the page, if loading.
174      */
175     void stop();
176
177     // #### should these be actions?
178     void goBack();
179     void goForward();
180     void goToHistoryItem(const QWebHistoryItem &item);
181
182     // ### should be a signal: void geometryChangeRequest(const QRect &geom);
183     virtual void setWindowGeometry(const QRect& geom);
184
185     void cut();
186     void copy();
187     void paste();
188     // ### should we have execCommand() or something similar?
189
190 signals:
191     /**
192      * Signal is emitted when load is started on one of the child
193      * frames of the page. The frame on which the load started
194      * is passed.
195      */
196     void loadStarted(QWebFrame *frame);
197     /**
198      * Signal is emitted when the global progress status changes.
199      * It accumulates changes from all the child frames.
200      */
201     void loadProgressChanged(int progress);
202     /**
203      * Signal is emitted when load has been finished on one of
204      * the child frames of the page. The frame on which the
205      * load finished is passed as an argument.
206      */
207     void loadFinished(QWebFrame *frame);
208     /**
209      * Signal is emitted when the title of this page has changed.
210      * Applies only to the main frame.  Sub-frame titles do not trigger this.
211      */
212     void titleChanged(const QString& title);
213     /**
214      * Signal is emitted when the mouse is hovering over a link.
215      * The first parameter is the link url, the second is the link title
216      * if any. Method is emitter with both empty parameters when the mouse
217      * isn't hovering over any link element.
218      */
219     void hoveringOverLink(const QString &link, const QString &title);
220     /**
221      * Signal is emitted when the statusbar text is changed by the page.
222      */
223     void statusBarTextChanged(const QString& text);
224     /**
225      * Signal is emitted when an icon ("favicon") is loaded from the site.
226      */
227     void iconLoaded();
228
229     // #### doesn't give you anything without a way to actually get the selection
230     void selectionChanged();
231
232     /**
233       * Signal is emitted when the mainframe()'s initial layout is completed.
234      */
235     void initialLayoutComplete();
236
237     void addToHistory(const QUrl&);
238
239     void frameCreated(QWebFrame *frame);
240
241 protected:
242     virtual QWebPage *createWindow();
243     virtual QWebPage *createModalDialog();
244     virtual QObject *createPlugin(const QString &classid, const QUrl &url, const QStringList &paramNames, const QStringList &paramValues);
245
246     virtual void webActionTriggered(WebAction action, bool checked = false);
247
248     virtual NavigationRequestResponse navigationRequested(QWebFrame *frame, const QWebNetworkRequest &request, NavigationType type);
249     // ### what does this do?
250     virtual QString chooseFile(QWebFrame *frame, const QString& oldFile);
251     // ### can we unify the next 3 methods? 
252     virtual void javaScriptAlert(QWebFrame *frame, const QString& msg);
253     virtual bool javaScriptConfirm(QWebFrame *frame, const QString& msg);
254     virtual bool javaScriptPrompt(QWebFrame *frame, const QString& msg, const QString& defaultValue, QString* result);
255     virtual void javaScriptConsoleMessage(const QString& message, unsigned int lineNumber, const QString& sourceID);
256
257     // ### should the be here?
258     virtual QString userAgentStringForUrl(const QUrl& forUrl) const;
259
260     virtual void resizeEvent(QResizeEvent*);
261     virtual void paintEvent(QPaintEvent*);
262     virtual void mouseMoveEvent(QMouseEvent*);
263     virtual void mousePressEvent(QMouseEvent*);
264     virtual void mouseDoubleClickEvent(QMouseEvent*);
265     virtual void mouseReleaseEvent(QMouseEvent*);
266     virtual void contextMenuEvent(QContextMenuEvent*);
267     virtual void wheelEvent(QWheelEvent*);
268     virtual void keyPressEvent(QKeyEvent*);
269     virtual void keyReleaseEvent(QKeyEvent*);
270     virtual void focusInEvent(QFocusEvent*);
271     virtual void focusOutEvent(QFocusEvent*);
272     virtual bool focusNextPrevChild(bool next);
273
274     virtual void dragEnterEvent(QDragEnterEvent *);
275     virtual void dragLeaveEvent(QDragLeaveEvent *);
276     virtual void dragMoveEvent(QDragMoveEvent *);
277     virtual void dropEvent(QDropEvent *);
278
279 private:
280     Q_PRIVATE_SLOT(d, void _q_onLoadProgressChanged(int))
281     Q_PRIVATE_SLOT(d, void _q_webActionTriggered(bool checked));
282     friend class QWebFrame;
283     friend class QWebPagePrivate;
284     friend class WebCore::ChromeClientQt;
285     friend class WebCore::EditorClientQt;
286     friend class WebCore::FrameLoaderClientQt;
287     friend class WebCore::ResourceHandle;
288     QWebPagePrivate *d;
289 };
290
291
292
293 #endif