tdehtmlview.h

/* This file is part of the KDE project
 
   Copyright (C) 1997 Martin Jones (mjones@kde.org)
             (C) 1998 Waldo Bastian (bastian@kde.org)
             (C) 1998, 1999 Torben Weis (weis@kde.org)
             (C) 1999 Lars Knoll (knoll@kde.org)
             (C) 1999 Antti Koivisto (koivisto@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., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
*/
 
#ifndef TDEHTMLVIEW_H
#define TDEHTMLVIEW_H
 
// qt includes and classes
#include <tqscrollview.h>
 
#include <tdelibs_export.h>
 
class TQPainter;
class TQRect;
template< typename T > class TQValueVector;
 
namespace DOM {
    class HTMLDocumentImpl;
    class DocumentImpl;
    class ElementImpl;
    class HTMLElementImpl;
    class HTMLTitleElementImpl;
    class HTMLGenericFormElementImpl;
    class HTMLFormElementImpl;
    class HTMLAnchorElementImpl;
    class HTMLInputElementImpl;
    class Range;
    class NodeImpl;
    class CSSProperty;
}
 
namespace KJS {
    class WindowFunc;
    class ExternalFunc;
}
 
namespace tdehtml {
    class RenderObject;
    class RenderCanvas;
    class RenderStyle;
    class RenderLineEdit;
    class RenderPartObject;
    class RenderWidget;
    class CSSStyleSelector;
    class LineEditWidget;
    class CaretBox;
    void applyRule(DOM::CSSProperty *prop);
}
 
class TDEHTMLPart;
class TDEHTMLViewPrivate;
 
class TDEHTML_EXPORT TDEHTMLView : public TQScrollView
{
    TQ_OBJECT
 
    friend class DOM::HTMLDocumentImpl;
    friend class DOM::HTMLTitleElementImpl;
    friend class DOM::HTMLGenericFormElementImpl;
    friend class DOM::HTMLFormElementImpl;
    friend class DOM::HTMLAnchorElementImpl;
    friend class DOM::HTMLInputElementImpl;
    friend class DOM::DocumentImpl;
    friend class TDEHTMLPart;
    friend class tdehtml::RenderCanvas;
    friend class tdehtml::RenderObject;
    friend class tdehtml::RenderLineEdit;
    friend class tdehtml::RenderPartObject;
    friend class tdehtml::RenderWidget;
    friend class tdehtml::CSSStyleSelector;
    friend class tdehtml::LineEditWidget;
    friend class KJS::WindowFunc;
    friend class KJS::ExternalFunc;
    friend void tdehtml::applyRule(DOM::CSSProperty *prop);
 
 
public:
    TDEHTMLView( TDEHTMLPart *part, TQWidget *parent, const char *name=0 );
    virtual ~TDEHTMLView();
 
    TDEHTMLPart *part() const { return m_part; }
 
    int frameWidth() const { return _width; }
 
    void setMarginWidth(int x);
 
    int marginWidth() const { return _marginWidth; }
 
    /*
     * Sets a margin in y direction.
     */
    void setMarginHeight(int y);
 
    int marginHeight() { return _marginHeight; }
 
    virtual void setVScrollBarMode ( ScrollBarMode mode );
 
    virtual void setHScrollBarMode ( ScrollBarMode mode );
 
    void print();
 
    void print( bool quick ); // KDE 4.0: merge with above
 
    void layout(); // KDE 4.0: make private
    void displayAccessKeys();
 
 
 
signals:
    void finishedLayout();
    void cleared();
    void zoomView( int );
    void hideAccessKeys();
    void repaintAccessKeys();
    void findAheadActive( bool );
//#define NO_SMOOTH_SCROLL_HACK
#ifndef NO_SMOOTH_SCROLL_HACK
public slots:
    void scrollBy(int dx, int dy);
#endif
 
protected:
    void clear();
 
    virtual void resizeEvent ( TQResizeEvent * event );
    virtual void showEvent ( TQShowEvent * );
    virtual void hideEvent ( TQHideEvent *);
    virtual bool focusNextPrevChild( bool next );
    virtual void drawContents ( TQPainter * p, int clipx, int clipy, int clipw, int cliph );
    virtual void drawContents( TQPainter* );
    virtual void viewportMousePressEvent( TQMouseEvent * );
    virtual void focusInEvent( TQFocusEvent * );
    virtual void focusOutEvent( TQFocusEvent * );
    virtual void viewportMouseDoubleClickEvent( TQMouseEvent * );
    virtual void viewportMouseMoveEvent(TQMouseEvent *);
    virtual void viewportMouseReleaseEvent(TQMouseEvent *);
    virtual void viewportResizeEvent(TQResizeEvent*);
#ifndef TQT_NO_WHEELEVENT
    virtual void viewportWheelEvent(TQWheelEvent*);
#endif
    virtual void dragEnterEvent( TQDragEnterEvent* );
    virtual void dropEvent( TQDropEvent* );
    virtual void closeEvent ( TQCloseEvent * );
    virtual bool eventFilter(TQObject *, TQEvent *);
 
    void keyPressEvent( TQKeyEvent *_ke );
    void keyReleaseEvent ( TQKeyEvent *_ke );
    void contentsContextMenuEvent ( TQContextMenuEvent *_ce );
    void doAutoScroll();
    void timerEvent ( TQTimerEvent * );
 
#ifndef NO_SMOOTH_SCROLL_HACK
    void startScrolling();
    void stopScrolling();
#ifndef TQT_NO_WHEELEVENT
    void scrollViewWheelEvent( TQWheelEvent* e );
#endif
#endif
 
protected slots:
    void slotPaletteChanged();
    void slotScrollBarMoved();
#ifndef NO_SMOOTH_SCROLL_HACK
    void scrollTick();
#else
    void scrollTick() {}; // moc cannot handle #if
#endif
 
private slots:
    void tripleClickTimeout();
    void findTimeout();
    void accessKeysTimeout();
 
    void slotMouseScrollTimer();
 
private:
 
    void scheduleRelayout(tdehtml::RenderObject* clippedObj=0);
    void unscheduleRelayout();
 
    void scheduleRepaint(int x, int y, int w, int h, bool asap=false);
    void unscheduleRepaint();
 
    bool needsFullRepaint() const;
 
    void closeChildDialogs();
    bool dialogsAllowed();
 
    void paint(TQPainter *p, const TQRect &rc, int yOff = 0, bool *more = 0);
 
#if 0
    void paint(TQPainter *p, int width);
#endif
 
    void setMediaType( const TQString &medium );
    TQString mediaType() const;
 
    bool pagedMode() const;
 
    bool scrollTo(const TQRect &);
 
    bool focusNextPrevNode(bool next);
    bool handleAccessKey(const TQKeyEvent* ev);
    bool focusNodeWithAccessKey(TQChar c, TDEHTMLView* caller = NULL);
    TQMap< DOM::ElementImpl*, TQChar > buildFallbackAccessKeys() const;
    void displayAccessKeys( TDEHTMLView* caller, TDEHTMLView* origview, TQValueVector< TQChar >& taken, bool use_fallbacks );
 
    void useSlowRepaints();
 
    void setIgnoreWheelEvents(bool e);
 
    void init();
 
    DOM::NodeImpl *nodeUnderMouse() const;
    DOM::NodeImpl *nonSharedNodeUnderMouse() const;
 
    void restoreScrollBar();
 
    TQStringList formCompletionItems(const TQString &name) const;
    void clearCompletionHistory(const TQString& name);
    void addFormCompletionItem(const TQString &name, const TQString &value);
    void removeFormCompletionItem(const TQString &name, const TQString &value);
 
    void addNonPasswordStorableSite( const TQString& host );
    bool nonPasswordStorableSite( const TQString& host ) const;
 
    bool dispatchMouseEvent(int eventId, DOM::NodeImpl *targetNode,
                DOM::NodeImpl *targetNodeNonShared, bool cancelable,
                int detail,TQMouseEvent *_mouse, bool setUnder,
                int mouseEventType);
    bool dispatchKeyEvent( TQKeyEvent *_ke );
    bool dispatchKeyEventHelper( TQKeyEvent *_ke, bool generate_keypress );
 
    void complete( bool pendingAction );
 
#ifndef TDEHTML_NO_TYPE_AHEAD_FIND
    void findAhead(bool increase);
    void updateFindAheadTimeout();
    void startFindAhead( bool linksOnly );
#endif // TDEHTML_NO_TYPE_AHEAD_FIND
 
#ifndef TDEHTML_NO_CARET
    // -- caret-related member functions (for caretMode as well as designMode)
 
    void initCaret(bool keepSelection = false);
    bool caretOverrides() const;
    void ensureNodeHasFocus(DOM::NodeImpl *node);
    void recalcAndStoreCaretPos(tdehtml::CaretBox *hintBox = 0);
    void caretOn();
    void caretOff();
    void showCaret(bool forceRepaint = false);
    void hideCaret();
    void ensureCaretVisible();
 
    bool foldSelectionToCaret(DOM::NodeImpl *startNode, long startOffset,
                    DOM::NodeImpl *endNode, long endOffset);
 
    bool placeCaret(tdehtml::CaretBox *hintBox = 0);
 
    bool extendSelection(DOM::NodeImpl *startNode, long startOffset,
                DOM::NodeImpl *endNode, long endOffset);
 
    void updateSelection(DOM::NodeImpl *startNode, long startOffset,
            DOM::NodeImpl *endNode, long endOffset);
 
    int caretDisplayPolicyNonFocused() const;
 
    void setCaretDisplayPolicyNonFocused(int policy);
 
    // -- caret event handler
 
    void caretKeyPressEvent(TQKeyEvent *);
 
    // -- caret navigation member functions
 
    bool moveCaretTo(DOM::NodeImpl *node, long offset, bool clearSelection);
 
    enum CaretMovement { CaretByCharacter, CaretByWord };
 
    void moveCaretBy(bool next, CaretMovement cmv, int n);
 
    void moveCaretByLine(bool next, int n);
 
    void moveCaretToLineBoundary(bool end);
 
    void moveCaretToDocumentBoundary(bool end);
 
    void placeCaretOnChar(tdehtml::CaretBox *hintBox);
 
    void placeCaretOnLine(tdehtml::CaretBox *caretBox, int x, int absx, int absy);
 
    void moveCaretByPage(bool next);
 
    void moveCaretPrevWord();
 
    void moveCaretNextWord();
 
    void moveCaretPrevLine(int n = 1);
 
    void moveCaretNextLine(int n = 1);
 
    void moveCaretPrevPage();
 
    void moveCaretNextPage();
 
    void moveCaretToLineBegin();
 
    void moveCaretToLineEnd();
 
#endif // TDEHTML_NO_CARET
 
    // ------------------------------------- member variables ------------------------------------
 private:
 
    void setWidgetVisible(::tdehtml::RenderWidget*, bool visible);
 
    int _width;
    int _height;
 
    int _marginWidth;
    int _marginHeight;
 
    TDEHTMLPart *m_part;
    TDEHTMLViewPrivate *d;
 
    TQString m_medium;   // media type
};
 
#endif