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 class WebKitPartBrowserExtension;
  43
  44 class WebKitPart : public KParts::ReadOnlyPart
  45 {
  46 Q_OBJECT
  47
  48 public:
  49     enum GUIProfile {
  50         DefaultGUI,
  51         BrowserViewGUI
  52     };
  53
  54     WebKitPart(QWidget* parentWidget = 0,
  55                QObject* parentObject = 0,
  56                GUIProfile prof = DefaultGUI);
  57
  58     virtual ~WebKitPart();
  59
  60     /**
  61      * Opens the specified URL @p url.
  62      *
  63      * Reimplemented from KParts::ReadOnlyPart::openURL .
  64      */
  65     virtual bool openUrl(const KUrl&);
  66
  67     /**
  68      * Stops loading the document and kills all data requests (for images, etc.)
  69      */
  70     virtual bool closeUrl();
  71
  72     /**
  73      * Returns a pointer to the parent WebKitPart
  74      * if the part is a frame in an HTML frameset.
  75      *
  76      * Returns 0 otherwise.
  77      */
  78     WebKitPart* parentPart();
  79
  80 private:
  81     friend class WebKitPartClient;
  82
  83     /**
  84      * Returns pointer the current frame.
  85      */
  86     WebCore::Frame* frame();
  87
  88     /**
  89      * Internal empty reimplementation of KParts::ReadOnlyPart::openFile .
  90      */
  91     virtual bool openFile();
  92
  93     /**
  94      * Internal helper method
  95      */
  96     void initView(QWidget*, GUIProfile);
  97
  98 private:
  99     WTF::RefPtr<WebCore::Frame> m_frame;
 100     WTF::RefPtr<WebCore::FrameView> m_frameView;
 101
 102     WebKitPartClient* m_client;
 103     WebKitPartBrowserExtension* m_extension;
 104 };
 105
 106 #endif