khtmlview.h   [plain text]

/* This file is part of the KDE project

   Copyright (C) 1997 Martin Jones (
             (C) 1998 Waldo Bastian (
             (C) 1998, 1999 Torben Weis (
             (C) 1999 Lars Knoll (
             (C) 1999 Antti Koivisto (
   Copyright (C) 2003 Apple Computer, Inc.

   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
   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_H
#define KHTML_H

// qt includes and classes
#include <qscrollview.h>

class QPainter;
class QRect;

namespace DOM {
    class HTMLDocumentImpl;
    class DocumentImpl;
    class ElementImpl;
    class HTMLElementImpl;
    class HTMLTitleElementImpl;
    class HTMLGenericFormElementImpl;
    class HTMLFormElementImpl;
    class HTMLAnchorElementImpl;
    class Range;
    class NodeImpl;
    class CSSProperty;

namespace khtml {
    class RenderObject;
    class RenderBox;
    class RenderCanvas;
    class RenderStyle;
    class RenderLineEdit;
    class RenderPartObject;
    class RenderWidget;
    class CSSStyleSelector;
    void applyRule(DOM::CSSProperty *prop);

class KHTMLPart;
class KHTMLViewPrivate;

 * Renders and displays HTML in a @ref QScrollView.
 * Suitable for use as an application's main view.
class KHTMLView : public QScrollView

    friend class DOM::HTMLDocumentImpl;
    friend class DOM::HTMLTitleElementImpl;
    friend class DOM::HTMLGenericFormElementImpl;
    friend class DOM::HTMLFormElementImpl;
    friend class DOM::HTMLAnchorElementImpl;
    friend class DOM::DocumentImpl;
    friend class KHTMLPart;
    friend class khtml::RenderCanvas;
    friend class khtml::RenderObject;
    friend class khtml::RenderBox;
    friend class khtml::RenderLineEdit;
    friend class khtml::RenderPartObject;
    friend class khtml::RenderWidget;
    friend class khtml::CSSStyleSelector;
    friend void khtml::applyRule(DOM::CSSProperty *prop);
    friend class KWQKHTMLPart;

     * Constructs a KHTMLView.
    KHTMLView( KHTMLPart *part, QWidget *parent, const char *name=0 );
    virtual ~KHTMLView();

     * Returns a pointer to the KHTMLPart that is
     * rendering the page.
    KHTMLPart *part() const { return m_part; }

    int frameWidth() const { return _width; }

     * Sets a margin in x direction.
    void setMarginWidth(int x);

     * Returns the margin width.
     * A return value of -1 means the default value will be used.
    int marginWidth() const { return _marginWidth; }

     * Sets a margin in y direction.
    void setMarginHeight(int y);

     * Returns the margin height.
     * A return value of -1 means the default value will be used.
    int marginHeight() { return _marginHeight; }

     * Sets verticals scrollbar mode. Reimplemented for internal reasons.
    virtual void setVScrollBarMode ( ScrollBarMode mode );

     * Sets horizontal scrollbar mode. Reimplemented for internal reasons.
    virtual void setHScrollBarMode ( ScrollBarMode mode );

     * Prints the HTML document.
    void print();

     * ensure the display is up to date
    void layout();

    void cleared();

    void clear();

    void clearPart();
    virtual void resizeEvent ( QResizeEvent * event );
    virtual void showEvent ( QShowEvent * );
    virtual void hideEvent ( QHideEvent *);
    virtual bool focusNextPrevChild( bool next );
    virtual void drawContents ( QPainter * p, int clipx, int clipy, int clipw, int cliph );
    virtual void drawContents( QPainter* );

    virtual void viewportMousePressEvent( QMouseEvent * );
    virtual void focusOutEvent( QFocusEvent * );
    virtual void viewportMouseDoubleClickEvent( QMouseEvent * );
    virtual void viewportMouseMoveEvent(QMouseEvent *);
    virtual void viewportMouseReleaseEvent(QMouseEvent *);
    virtual void viewportWheelEvent(QWheelEvent*);
    virtual void dragEnterEvent( QDragEnterEvent* );
    virtual void dropEvent( QDropEvent* );

    void keyPressEvent( QKeyEvent *_ke );
    void keyReleaseEvent ( QKeyEvent *_ke );
    void contentsContextMenuEvent ( QContextMenuEvent *_ce );
    void doAutoScroll();

    void timerEvent ( QTimerEvent * );

    QWidget *topLevelWidget() const;
    QPoint mapToGlobal(const QPoint &) const;
    void adjustViewSize();

    void ref() { ++_refCount; }
    void deref() { if (!--_refCount) delete this; }
protected slots:
    void slotPaletteChanged();
    void slotScrollBarMoved();


    void resetCursor();

    void scheduleRelayout(khtml::RenderObject* clippedObj=0);
    void unscheduleRelayout();

    void scheduleRepaint(int x, int y, int w, int h);
    void unscheduleRepaint();
     * Paints the HTML document to a QPainter.
     * The document will be scaled to match the width of
     * rc and clipped to fit in the height.
     * yOff determines the vertical offset in the document to start with.
     * more, if nonzero will be set to true if the documents extends
     * beyond the rc or false if everything below yOff was painted.
    void paint(QPainter *p, const QRect &rc, int yOff = 0, bool *more = 0);

     * Get/set the CSS Media Type.
     * Media type is set to "screen" for on-screen rendering and "print"
     * during printing. Other media types lack the proper support in the
     * renderer and are not activated. The DOM tree and the parser itself,
     * however, properly handle other media types. To make them actually work
     * you only need to enable the media type in the view and if necessary
     * add the media type dependent changes to the renderer.
    void setMediaType( const QString &medium );
    QString mediaType() const;

    bool scrollTo(const QRect &);

    void focusNextPrevNode(bool next);

    void useSlowRepaints();

    void setIgnoreWheelEvents(bool e);

    void init();

    DOM::NodeImpl *nodeUnderMouse() const;

    void restoreScrollBar();

    QStringList formCompletionItems(const QString &name) const;
    void addFormCompletionItem(const QString &name, const QString &value);

    bool dispatchMouseEvent(int eventId, DOM::NodeImpl *targetNode, bool cancelable,
			    int detail,QMouseEvent *_mouse, bool setUnder,
			    int mouseEventType);

    void complete();

    // Returns the clipped object we will repaint when we perform our scheduled layout.
    khtml::RenderObject* layoutObject() { return m_layoutObject; }

    // ------------------------------------- member variables ------------------------------------
    unsigned _refCount;

    int _width;
    int _height;

    int _marginWidth;
    int _marginHeight;

    KHTMLPart *m_part;
    KHTMLViewPrivate *d;

    QString m_medium;   // media type
    // An overflow: hidden clipped object.  If this is set, a scheduled layout will only repaint
    // the object's clipped area, and it will not do a full repaint.
    khtml::RenderObject* m_layoutObject;