Reviewed by darin.
[WebKit-https.git] / WebCore / bridge / BrowserExtension.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 BROWSEREXTENSION_H_
27 #define BROWSEREXTENSION_H_
28
29 #include "PlatformString.h"
30 #include "formdata.h"
31 #include <kxmlcore/HashMap.h>
32 #include <qobject.h>
33
34 class KURL;
35 class ObjectContents;
36
37 namespace WebCore {
38
39 struct URLArgs {
40
41     QString frameName;
42     FormData postData;
43     bool reload;
44     QString serviceType;
45     int xOffset;
46     int yOffset;
47
48     URLArgs() : reload(false), xOffset(0), yOffset(0), m_doPost(false), m_lockHistory(false) { }
49     
50     QString contentType() const { return m_contentType; }
51     void setContentType(const QString &t) { m_contentType = t; }
52
53     bool doPost() const { return m_doPost; }
54     void setDoPost(bool post) { m_doPost = post; }
55     
56     bool lockHistory() const { return m_lockHistory; }
57     void setLockHistory(bool lock) { m_lockHistory = lock; }
58
59     HashMap<DOMString, DOMString>& metaData() { return m_metadata; }
60     const HashMap<DOMString, DOMString>& metaData() const { return m_metadata; }
61
62 private:
63     QString m_contentType;
64     bool m_doPost;
65     bool m_lockHistory;
66     HashMap<DOMString, DOMString> m_metadata;
67 };
68
69 struct WindowArgs {
70     int x;
71     bool xSet;
72     int y;
73     bool ySet;
74     int width;
75     bool widthSet;
76     int height;
77     bool heightSet;
78
79     bool menuBarVisible;
80     bool statusBarVisible;
81     bool toolBarVisible;
82     bool locationBarVisible;
83     bool scrollBarsVisible;
84     bool resizable;
85
86     bool fullscreen;
87     bool dialog;
88 };
89
90 class BrowserExtension : public QObject {
91 public:
92     virtual void openURLRequest(const KURL &, const URLArgs &args = URLArgs()) = 0;
93     virtual void openURLNotify() = 0;
94     
95     virtual void createNewWindow(const KURL &url, 
96                                  const URLArgs &urlArgs = URLArgs()) = 0;
97     
98     virtual void createNewWindow(const KURL &url, 
99                                  const URLArgs &urlArgs, 
100                                  const WindowArgs &winArgs, 
101                                  ObjectContents *&part) = 0;
102     
103     virtual void setIconURL(const KURL &url) = 0;
104     virtual void setTypedIconURL(const KURL &url, const QString &type) = 0;
105     
106     virtual int getHistoryLength() = 0;
107     virtual void goBackOrForward(int distance) = 0;
108     
109     void setURLArgs(const URLArgs &args) { m_args = args; }
110     URLArgs urlArgs() const { return m_args; }
111
112     virtual bool canRunModal() = 0;
113     virtual bool canRunModalNow() = 0;
114     virtual void runModal() = 0;
115
116 protected:
117     BrowserExtension() {};
118
119 private:
120     URLArgs m_args;
121 };
122
123 }
124
125 #endif