9a35842f3fba6a51582a2c57e95482cd1a8fe11f
[WebKit.git] / WebKitQt / WebKitPart / WebKitPart.h
1 /*
2  * Copyright (C) 2006 Nikolas Zimmermann <zimmermann@kde.org>
3  *
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
16  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
19  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
22  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
23  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27
28 #ifndef WebKitPart_H
29 #define WebKitPart_H
30
31 #include <QObject>
32
33 #include <wtf/RefPtr.h>
34 #include <kparts/part.h>
35
36 namespace WebCore {
37     class Frame;
38     class FrameView;
39 }
40
41 class WebKitPartClient;
42
43 class WebKitPart : public KParts::ReadOnlyPart
44 {
45 Q_OBJECT
46
47 public:
48     enum GUIProfile {
49         DefaultGUI,
50         BrowserViewGUI
51     };
52
53     WebKitPart(QWidget* parentWidget = 0,
54                QObject* parentObject = 0,
55                GUIProfile prof = DefaultGUI);
56
57     virtual ~WebKitPart();
58
59     /**
60      * Opens the specified URL @p url.
61      *
62      * Reimplemented from KParts::ReadOnlyPart::openURL .
63      */
64     virtual bool openUrl(const KUrl&);
65
66     /**
67      * Stops loading the document and kills all data requests (for images, etc.)
68      */
69     virtual bool closeUrl();
70
71     /**
72      * Returns a pointer to the parent WebKitPart
73      * if the part is a frame in an HTML frameset.
74      *
75      * Returns 0 otherwise.
76      */
77     WebKitPart* parentPart();
78
79 private:
80     friend class WebKitPartClient;
81     
82     /**
83      * Returns pointer the current frame.
84      */
85     WebCore::Frame* frame();
86
87     /**
88      * Internal empty reimplementation of KParts::ReadOnlyPart::openFile .
89      */
90     virtual bool openFile();
91
92     /**
93      * Internal helper method
94      */
95     void initView(QWidget*, GUIProfile);
96
97 private:
98     WTF::RefPtr<WebCore::Frame> m_frame;
99     WTF::RefPtr<WebCore::FrameView> m_frameView;
100
101     WebKitPartClient* m_client;
102 };
103
104 #endif