|
|
/* This file is part of the KDE project * * Copyright (C) 1998, 1999 Torben Weis <weis@kde.org> * 1999 Lars Knoll <knoll@kde.org> * 1999 Antti Koivisto <koivisto@kde.org> * 2000 Simon Hausmann <hausmann@kde.org> * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Library General Public * License as published by the Free Software Foundation; either * version 2 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Library General Public License for more details. * * You should have received a copy of the GNU Library General Public License * along with this library; see the file COPYING.LIB. If not, write to * the Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ #ifndef __khtml_part_h__ #define __khtml_part_h__ #include "dom/html_document.h" #include "dom/dom2_range.h" #include <kparts/part.h> #include <kparts/browserextension.h> #include <qregexp.h> class KHTMLPartPrivate; class KHTMLPartBrowserExtension; class KJSProxy; class KHTMLView; namespace DOM { class HTMLDocument; class HTMLDocumentImpl; class HTMLTitleElementImpl; class HTMLFrameElementImpl; class HTMLIFrameElementImpl; class HTMLObjectElementImpl; class HTMLFormElementImpl; }; namespace khtml { class Settings; class RenderPart; class RenderPartObject; struct ChildFrame; }; namespace KJS { class Window; class WindowFunc; }; namespace KParts { class PartManager; }; /** * This class is khtml's main class. It features an almost complete * web browser, and html renderer. * * The easiest way to use this class (if you just want to display a HTML * page at some URL) is the following: * * <pre> * KURL url = "http://www.kde.org"; * KHTMLPart *w = new KHTMLPart(); * w->openURL(url); * w->view()->resize(500, 400); * w->show(); * </pre> * * By default Java and JavaScript support is disabled. You can enable it by * using the @ref enableJava() and @ref enableJScript() methods. * * Some apps want to write their HTML code directly into the widget instead of * it opening an url. You can also do that in the following way: * * <pre> * QString myHTMLCode = ...; * KHTMLPart *w = new KHTMLPart(); * w->begin(); * w->write(myHTMLCode); * ... * w->end(); * </pre> * * You can do as many calls to write as you want. But there are two @ref write() * methods, one accepting a @ref QString one accepting a char * argument. These * should not get mixed, since the method usnig the char * argument does an * additional decoding step to convert the written data to Unicode. * * @short HTML Browser Widget * @author Lars Knoll (knoll@kde.org) * @version $Id: khtml_part.h,v 1.51 2000/05/04 12:06:44 hausmann Exp $ * */ class KHTMLPart : public KParts::ReadOnlyPart { Q_OBJECT friend class KHTMLView; friend class DOM::HTMLTitleElementImpl; friend class DOM::HTMLFrameElementImpl; friend class DOM::HTMLIFrameElementImpl; friend class DOM::HTMLObjectElementImpl; friend class KHTMLRun; friend class DOM::HTMLFormElementImpl; friend class khtml::RenderPartObject; friend class KJS::WindowFunc; friend class KHTMLPartBrowserExtension; Q_PROPERTY( bool javaScriptEnabled READ jScriptEnabled WRITE enableJScript ); Q_PROPERTY( bool javaEnabled READ javaEnabled WRITE enableJava ); Q_PROPERTY( bool autoloadImages READ autoloadImages WRITE autoloadImages ); Q_PROPERTY( bool dndEnabled READ dndEnabled WRITE setDNDEnabled ); public: /** * Constructs a new KHTMLPart. * KHTML basically consists of two objects: The KHTMLPart itself, holding the document data * (DOM document), and the KHTMLView, derived from @ref QScrollview, in which the document content is * rendered in. You can specify two different parent objects for a KHTMLPart, one parent for the * KHTMLPart document and on parent for the KHTMLView. If the second @p parent argument is 0L, then * @p parentWidget is used as parent for both objects, the part and the view. */ KHTMLPart( QWidget *parentWidget = 0, const char *widgetname = 0, QObject *parent = 0, const char *name = 0 ); KHTMLPart( KHTMLView *view, QObject *parent = 0, const char *name = 0 ); /** * Destructor */ virtual ~KHTMLPart(); /** * Reimplemented from @ref KParts::ReadOnlyPart::openURL . Opens the specified url @p url . */ virtual bool openURL( const KURL &url ); /** * Stops loading the document and kills all data requests (for images, etc.) */ virtual bool closeURL(); /** * Retrieve a reference to the DOM document. */ DOM::HTMLDocument htmlDocument() const; /** * Retrieve a pointer to the @ref KParts::BrowserExtension */ KHTMLPartBrowserExtension *browserExtension() const; /** * Retrieve a pointer to the html document's view. */ KHTMLView *view() const; /** * Enable/disable Javascript support. */ void enableJScript( bool enable ); /** * Return if Javascript support is enabled/disabled. */ bool jScriptEnabled() const; KJSProxy *jScript(); void executeScript( const QString &script ); void setDNDEnabled( bool b ); bool dndEnabled() const; /** * Enable/disable Java applet support. */ void enableJava( bool enable ); /** * Return if Java applet support is enabled/disabled. */ bool javaEnabled() const; /** * should images be loaded automatically? Default is true. * (not implemented at the moment) */ void autoloadImages( bool enable ); bool autoloadImages() const; /** * Clears the widget and prepares it for new content. * If you want @ref url() to return * for example "file:/tmp/test.html", you can use the following code: * <PRE> * view->begin( KURL("file:/tmp/test.html" ) ); * </PRE> * * @param url is the url of the document to be displayed. Even if you * are generating the HTML on the fly, it may be useful to specify * a directory so that any pixmaps are found. * @param xOffset is the initial horizontal scrollbar value. Usually you don't * want to use this. * @param yOffset is the initial vertical scrollbar value. Usually you don't * want to use this. * * All child frames and the old document are removed if you call this method. */ virtual void begin( const KURL &url = KURL(), int xOffset = 0, int yOffset = 0 ); /** * Writes another part of the HTML code to the widget. You may call * this function many times in sequence. But remember: The less calls * the faster the widget is. * * The html code is send through a decoder, which decodes the stream to * unicode. * * The len parameter is needed for streams encoded in utf-16, since these * can have \0 chars in them. In case the encoding you're using isn't * utf-16, you can safely leave out the length parameter. * * Attention: Don't mix calls to write( const char *) with calls * to write( const QString & ). The result might not be what you want. */ virtual void write( const char *str, int len = -1 ); /** * Writes another part of the HTML code to the widget. You may call * this function many times in sequence. But remember: The less calls * the faster the widget is. */ virtual void write( const QString &str ); /** * Call this after your last call to @ref #write. */ virtual void end(); /* * Print current HTML page layouted for the printer. * (not implemented at the moment) */ // void print(QPainter *, int pageHeight, int pageWidth); /** * Mainly used internally. Sets the document's base URL */ void setBaseURL( const KURL &url ); /** * @return the base URL of this document * * The base url is ususally set by an <base url=...> tag in the document head. */ KURL baseURL() const; /** * Mainly used internally. Sets the document's base target. */ void setBaseTarget( const QString &target ); /** * @return the base target of this document * The base target is ususally set by an <base target=...> * tag in the document head. */ QString baseTarget() const; /** * @internal */ KURL completeURL( const QString &url, const QString &target = QString::null ); /** * @internal */ void scheduleRedirection( int delay, const KURL &url ); /** * sets the charset to use for displaying html pages. If override is true, * it will override charset specifications of the document. */ bool setCharset( const QString &name, bool override = false ); /** * set the encoding the page uses. This can be different form the charset. */ bool setEncoding( const QString &name, bool override = false ); /** * set a user defined style sheet to be used on top of the HTML 4 default style * sheet. This gives a wide range of possibilities to change the layout of the * page */ void setUserStyleSheet(const KURL &url); /** * set a user defined style sheet to be used on top of the HTML 4 default style * sheet. This gives a wide range of possibilities to change the layout of the * page */ void setUserStyleSheet(const QString &styleSheet); /** * Sets point sizes to be associated with the HTML-sizes used in * <FONT size=Html-Font-Size> * * Html-Font-Sizes range from 0 (smallest) to 6 (biggest), but you can specify up to 15 font sizes, * the bigger ones will get used, if <font size=+1> extends over 7, or if a 'font-size: larger' style * declaration gets into this region. * * They are related to the CSS font sizes by 0 == xx-small to 6 == xx-large. */ void setFontSizes(const QValueList<int> &newFontSizes ); /** * Gets point sizes to be associated with the HTML-sizes used in * <FONT size=Html-Font-Size> * * Html-Font-Sizes range from 0 (smallest) to 6 (biggest). * * They are related to the CSS font sizes by 0 == xx-small to 6 == xx-large. */ QValueList<int> fontSizes() const; /** * Resets the point sizes to be associated with the HTML-sizes used in * <FONT size=Html-Font-Size> to their default. * * Html-Font-Sizes range from 1 (smallest) to 7 (biggest). */ void resetFontSizes(); /** * Sets the standard font style. * * @param name is the font name to use for standard text. */ void setStandardFont( const QString &name ); /** * Sets the fixed font style. * * @param name is the font name to use for fixed text, e.g. * the <tt><pre></tt> tag. */ void setFixedFont( const QString &name ); /** * Find the anchor named '_name'. If the anchor is found, the widget * scrolls to the closest position. Returns TRUE if the anchor has * been found. */ bool gotoAnchor( const QString &name ); /** * Sets the cursor to use when the cursor is on a link. * (convenience function, just calls htmlWidget->setURLCursor() ) */ void setURLCursor( const QCursor &c ); /** * Returns the cursor which is used when the cursor is on a link. * (convenience function, just cals htmlWidget->urlCursor() ) */ const QCursor& urlCursor() const; /** * Initiate a text search. */ void findTextBegin(); /** * Find the next occurrance of the expression. */ bool findTextNext( const QRegExp &exp ); /** * Get the text the user has marked. */ virtual QString selectedText() const; /** * @returns the selected part of the HTML */ DOM::Range selection() const; /** * Has the user selected anything? Call @ref #selectedText to * retrieve the selected text. * * @return true if there is text selected. */ bool hasSelection() const; /** * Convenience method to show the document's view. Equivalent to widget()->show() or view()->show() . */ void show(); /** * Convenience method to hide the document's view. Equivalent to widget()->hide() or view()->hide() . */ void hide(); /** * @internal */ KParts::PartManager *partManager(); /** * Save the KHTMLPart's complete state (including child frame objects) to the provided QDataStream. * You can use this method to provide history functionality. * * This is called from the @ref saveState method of the @ref browserExtension . */ virtual void saveState( QDataStream &stream ); /** * Restore the KHTMLPart's previously saved state (including child frame objects) from the provided * QDataStream. See @ref saveState. * * This is called from the @ref restoreState method of the @ref browserExtension . */ virtual void restoreState( QDataStream &stream ); /** * @returns the Node, currently under the mouse */ DOM::Node nodeUnderMouse() const; /** * @internal */ const khtml::Settings *settings() const; /** * Returns a pointer to the parent KHTMLPart if the part is a frame in a html frameset. * (returns 0L otherwise) */ KHTMLPart *parentPart(); QStringList frameNames() const; const QList<KParts::ReadOnlyPart> frames() const; bool openURLInFrame( const KURL &url, const KParts::URLArgs &urlArgs ); signals: /** * This signal is emitted if the cursor is moved over an URL. */ void onURL( const QString &url ); /** * This signal is emitted when the user clicks the right mouse button on the document. */ void popupMenu(const QString &url, const QPoint &point); protected: /** * Internal empty reimplementation of @ref KParts::ReadOnlyPart::openFile . */ virtual bool openFile(); /** * @internal */ virtual void overURL( const QString &url ); /** * @internal */ virtual void urlSelected( const QString &url, int button = 0, int state = 0, const QString &_target = QString::null ); /** * @internal */ void processObjectRequest( khtml::ChildFrame *child, const KURL &url, const QString &mimetype ); /** * @internal */ virtual void submitForm( const char *action, const QString &url, const QCString &formData, const QString &target ); /** * @internal */ virtual void popupMenu( const QString &url ); /** * @internal */ virtual KParts::ReadOnlyPart *createPart( QWidget *parentWidget, const char *widgetName, QObject *parent, const char *name, const QString &mimetype, QString &serviceName, QStringList &serviceTypes, const QStringList ¶ms); /** * derived classes can use this hook to filter out key events from the KHTMLView. */ virtual bool keyPressHook(QKeyEvent *) { return false; } /** * derived classes can use this hook to filter out key events from the KHTMLView. */ virtual bool keyReleaseHook(QKeyEvent*) { return false; } /** * derived classes can use this hook to filter out mouse events from the KHTMLView. */ virtual bool mousePressHook( QMouseEvent *, int, int,DOM::DOMString, DOM::Node, long ){ return false; } /** * derived classes can use this hook to filter out mouse events from the KHTMLView. */ virtual bool mouseDoubleClickHook( QMouseEvent *, int, int, DOM::DOMString, DOM::Node, long ){ return false; } /** * derived classes can use this hook to filter out mouse events from the KHTMLView. */ virtual bool mouseMoveHook(QMouseEvent *, int, int, DOM::DOMString, DOM::Node, long){ return false; } /** * derived classes can use this hook to filter out mouse events from the KHTMLView. */ virtual bool mouseReleaseHook(QMouseEvent *, int, int, DOM::DOMString, DOM::Node, long){ return false; } /** * derived classes can use this hook to process paint events from the KHTMLView. */ virtual void drawContentsHook(QPainter *) {} /** * Internal. Called by the @ref BrowserExtension . */ void reparseConfiguration(); private slots: /** * @internal */ void slotData( KIO::Job*, const QByteArray &data ); /** * @internal */ void slotFinished( KIO::Job* ); /** * @internal */ void slotRedirect(); /** * @internal */ void slotRedirection(KIO::Job*, const KURL&); /** * @internal */ virtual void slotViewDocumentSource(); /** * @internal */ virtual void slotViewFrameSource(); /** * @internal */ virtual void slotSaveBackground(); /** * @internal */ virtual void slotSaveDocument(); /** * @internal */ virtual void slotSaveFrame(); /** * @internal */ virtual void slotSetEncoding(); void slotIncFontSizes(); void slotDecFontSizes(); void slotLoadImages(); /** * @internal */ void updateActions(); /** * @internal */ void slotChildStarted( KIO::Job *job ); /** * @internal */ void slotChildCompleted(); /** * @internal */ void slotChildURLRequest( const KURL &url, const KParts::URLArgs &args ); void slotSelectionChanged(); void checkCompleted(); private: void init( KHTMLView *view ); void clear(); void updateFontSize( int add ); /** * @internal */ void requestFrame( khtml::RenderPart *frame, const QString &url, const QString &frameName, const QStringList &args = QStringList() ); /** * @internal */ void requestObject( khtml::RenderPart *frame, const QString &url, const QString &serviceType, const QStringList &args = QStringList() ); /** * @internal */ void requestObject( khtml::ChildFrame *child, const KURL &url, const KParts::URLArgs &args = KParts::URLArgs() ); DOM::HTMLDocumentImpl *docImpl() const; khtml::ChildFrame *frame( const QObject *obj ); khtml::ChildFrame *recursiveFrameRequest( const KURL &url, const KParts::URLArgs &args, bool callParent = true ); KHTMLPartPrivate *d; }; /** * This is the BrowserExtension for a @ref KHTMLPart document. Please see the KParts documentation for * more information about the BrowserExtension. */ class KHTMLPartBrowserExtension : public KParts::BrowserExtension { Q_OBJECT friend class KHTMLPart; friend class KHTMLView; public: KHTMLPartBrowserExtension( KHTMLPart *parent, const char *name = 0L ); virtual int xOffset(); virtual int yOffset(); virtual void saveState( QDataStream &stream ); virtual void restoreState( QDataStream &stream ); public slots: void copy(); void reparseConfiguration(); void print(); private: KHTMLPart *m_part; }; class KHTMLPartBrowserHostExtension : public KParts::BrowserHostExtension { public: KHTMLPartBrowserHostExtension( KHTMLPart *part ); virtual ~KHTMLPartBrowserHostExtension(); virtual QStringList frameNames() const; virtual const QList<KParts::ReadOnlyPart> frames() const; virtual bool openURLInFrame( const KURL &url, const KParts::URLArgs &urlArgs ); private: KHTMLPart *m_part; }; /** * INTERNAL class. *NOT* part of the public API. */ class KHTMLPopupGUIClient : public QObject, public KXMLGUIClient { Q_OBJECT public: KHTMLPopupGUIClient( KHTMLPart *khtml, const QString &doc, const KURL &url ); virtual ~KHTMLPopupGUIClient(); static void saveURL( QWidget *parent, const QString &caption, const KURL &url ); private slots: void slotSaveLinkAs(); void slotSaveImageAs(); void slotCopyLinkLocation(); void slotReloadFrame(); private: class KHTMLPopupGUIClientPrivate; KHTMLPopupGUIClientPrivate *d; }; #endif
Generated by: root@porky.devel.redhat.com on Wed May 10 08:57:03 2000, using kdoc 2.0a35. |