tdehtml_part.h

/* This file is part of the KDE project
 *
 * Copyright (C) 1998, 1999 Torben Weis <weis@kde.org>
 *                     1999-2001 Lars Knoll <knoll@kde.org>
 *                     1999-2001 Antti Koivisto <koivisto@kde.org>
 *                     2000-2001 Simon Hausmann <hausmann@kde.org>
 *                     2000-2001 Dirk Mueller <mueller@kde.org>
 *                     2000 Stefan Schimanski <1Stein@gmx.de>
 *
 * 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 __tdehtml_part_h__
#define __tdehtml_part_h__
 
#include "dom/html_document.h"
#include "dom/dom2_range.h"
 
#include <tdeparts/part.h>
#include <tdeparts/browserextension.h>
#include <tdemacros.h>
#include <kfinddialog.h>
 
#include <tqregexp.h>
 
class TDEHTMLPartPrivate;
class TDEHTMLPartBrowserExtension;
class KJSProxy;
class TDEHTMLView;
class TDEHTMLSettings;
class KJavaAppletContext;
class KJSErrorDlg;
 
namespace DOM
{
  class HTMLDocument;
  class HTMLDocumentImpl;
  class DocumentImpl;
  class HTMLTitleElementImpl;
  class HTMLElementImpl;
  class HTMLFrameElementImpl;
  class HTMLIFrameElementImpl;
  class HTMLObjectElementImpl;
  class HTMLFormElementImpl;
  class HTMLAnchorElementImpl;
  class HTMLMetaElementImpl;
  class NodeImpl;
  class Node;
  class HTMLEventListener;
  class EventListener;
}
 
namespace KJS
{
  class Interpreter;
}
 
namespace tdehtml
{
  class DocLoader;
  class RenderPart;
  class RenderPartObject;
  class ChildFrame;
  class MouseEvent;
  class MousePressEvent;
  class MouseDoubleClickEvent;
  class MouseMoveEvent;
  class MouseReleaseEvent;
  class DrawContentsEvent;
  class CachedObject;
  class RenderWidget;
  class CSSStyleSelector;
  class HTMLTokenizer;
  class Decoder;
  class XMLTokenizer;
}
 
namespace KJS {
    class Window;
    class WindowFunc;
    class ExternalFunc;
    class JSEventListener;
    class JSLazyEventListener;
    class JSNodeFilter;
    class DOMDocument;
    class SourceFile;
    class ScheduledAction;
}
 
namespace KParts
{
  class PartManager;
  class LiveConnectExtension;
}
 
namespace TDEWallet
{
  class Wallet;
}

class TDEHTML_EXPORT TDEHTMLPart : public KParts::ReadOnlyPart
{
  TQ_OBJECT
  friend class TDEHTMLView;
  friend class DOM::HTMLTitleElementImpl;
  friend class DOM::HTMLFrameElementImpl;
  friend class DOM::HTMLIFrameElementImpl;
  friend class DOM::HTMLObjectElementImpl;
  friend class DOM::HTMLAnchorElementImpl;
  friend class DOM::HTMLMetaElementImpl;
  friend class DOM::NodeImpl;
  friend class TDEHTMLRun;
  friend class DOM::HTMLFormElementImpl;
  friend class tdehtml::RenderPartObject;
  friend class KJS::Window;
  friend class KJS::ScheduledAction;
  friend class KJS::JSNodeFilter;
  friend class KJS::WindowFunc;
  friend class KJS::ExternalFunc;
  friend class KJS::JSEventListener;
  friend class KJS::JSLazyEventListener;
  friend class KJS::DOMDocument;
  friend class KJS::SourceFile;
  friend class KJSProxy;
  friend class TDEHTMLPartBrowserExtension;
  friend class DOM::DocumentImpl;
  friend class DOM::HTMLDocumentImpl;
  friend class TDEHTMLPartBrowserHostExtension;
  friend class tdehtml::HTMLTokenizer;
  friend class tdehtml::XMLTokenizer;
  friend class tdehtml::RenderWidget;
  friend class tdehtml::CSSStyleSelector;
  friend class TDEHTMLPartIface;
  friend class TDEHTMLPartFunction;
  friend class TDEHTMLPopupGUIClient;
 
  TQ_PROPERTY( bool javaScriptEnabled READ jScriptEnabled WRITE setJScriptEnabled )
  TQ_PROPERTY( bool javaEnabled READ javaEnabled WRITE setJavaEnabled )
  TQ_PROPERTY( bool autoloadImages READ autoloadImages WRITE setAutoloadImages )
  TQ_PROPERTY( bool dndEnabled READ dndEnabled WRITE setDNDEnabled )
  TQ_PROPERTY( bool pluginsEnabled READ pluginsEnabled WRITE setPluginsEnabled )
 
  /*
   *
   * Don't add setOnlyLocalReferences here. It shouldn't be accessible via DCOP.
   *
   **/
  TQ_PROPERTY( TQCString dcopObjectId READ dcopObjectId )
  TQ_PROPERTY( bool modified READ isModified )
 
public:
  enum GUIProfile { DefaultGUI, BrowserViewGUI /* ... */ };

  TDEHTMLPart( TQWidget *parentWidget = 0, const char *widgetname = 0,
             TQObject *parent = 0, const char *name = 0, GUIProfile prof = DefaultGUI );
 
  TDEHTMLPart( TDEHTMLView *view, TQObject *parent = 0, const char *name = 0, GUIProfile prof = DefaultGUI );

  virtual ~TDEHTMLPart();

  virtual bool openURL( const KURL &url );

  virtual bool closeURL();

  virtual void showError( TDEIO::Job* job );

  DOM::HTMLDocument htmlDocument() const;

  DOM::Document document() const;

   TQString documentSource() const;

  DOM::Node activeNode() const;

  KParts::BrowserExtension *browserExtension() const;
  KParts::LiveConnectExtension *liveConnectExtension( const tdehtml::RenderPart *) const;
  KParts::BrowserHostExtension *browserHostExtension() const;

  TDEHTMLView *view() const;

  void setJScriptEnabled( bool enable );

  bool jScriptEnabled() const;

  KJS::Interpreter *jScriptInterpreter();

  void setStatusMessagesEnabled( bool enable );

  bool statusMessagesEnabled() const;

  void setMetaRefreshEnabled( bool enable );

  bool metaRefreshEnabled() const;

  TQVariant executeScript( const DOM::Node &n, const TQString &script );

  void setDNDEnabled( bool b );

  bool dndEnabled() const;

  void setJavaEnabled( bool enable );

  bool javaEnabled() const;

  KJavaAppletContext *javaContext();

  KJavaAppletContext *createJavaContext();

  void setPluginsEnabled( bool enable );

  bool pluginsEnabled() const;

  void setAutoloadImages( bool enable );
  bool autoloadImages() const;

  void setOnlyLocalReferences( bool enable );

  bool onlyLocalReferences() const;

  bool isCaretMode() const;

  bool isEditable() const;

  void setCaretPosition(DOM::Node node, long offset, bool extendSelection = false);

  enum CaretDisplayPolicy {
    CaretVisible, CaretInvisible, CaretBlink
  };

  CaretDisplayPolicy caretDisplayPolicyNonFocused() const;

  void setCaretDisplayPolicyNonFocused(CaretDisplayPolicy policy);
 
#ifndef KDE_NO_COMPAT
  void enableJScript( bool e ) { setJScriptEnabled(e); }
  void enableJava( bool e ) { setJavaEnabled(e); }
  void enablePlugins( bool e ) { setPluginsEnabled(e); }
  void autoloadImages( bool e ) { setAutoloadImages(e); }
  void enableMetaRefresh( bool e ) { setMetaRefreshEnabled(e); }
  bool setCharset( const TQString &, bool ) { return true; }
 
  KURL baseURL() const;
  TQString baseTarget() const;
#endif

  KURL backgroundURL() const;

  void scheduleRedirection( int delay, const TQString &url, bool lockHistory = true );

  virtual void begin( const KURL &url = KURL(), int xOffset = 0, int yOffset = 0 );

  virtual void write( const char *str, int len = -1 );

  virtual void write( const TQString &str );

  virtual void end();
 
  /*
   * Prints the current HTML page laid out for the printer.
   *
   * (not implemented at the moment)
   */
  //    void print(TQPainter *, int pageHeight, int pageWidth);

  void paint( TQPainter *, const TQRect &, int = 0, bool * = 0 );

  bool setEncoding( const TQString &name, bool override = false );

  TQString encoding() const;

  void setUserStyleSheet( const KURL &url );

  void setUserStyleSheet( const TQString &styleSheet );
 
public:

  void setStandardFont( const TQString &name );

  void setFixedFont( const TQString &name );

  bool gotoAnchor( const TQString &name );

  bool nextAnchor();

  bool prevAnchor();

  void setURLCursor( const TQCursor &c );

  TQCursor urlCursor() const;

  enum FindOptions
  {
    FindLinksOnly   = 1 * KFindDialog::MinimumUserOption,
    FindNoPopups    = 2 * KFindDialog::MinimumUserOption
    //FindIncremental = 4 * KFindDialog::MinimumUserOption
  };

  void findText();

  void findText( const TQString &str, long options, TQWidget *parent = 0,
                 KFindDialog *findDialog = 0 );

  void findTextBegin();

  bool findTextNext( const TQString &str, bool forward, bool caseSensitive, bool isRegExp );

  bool findTextNext();

  // KDE4 merge with default = false
  bool findTextNext( bool reverse );

  void setZoomFactor(int percent);

  int zoomFactor() const;

  virtual TQString selectedText() const;

  TQString selectedTextAsHTML() const;

  DOM::Range selection() const;

  void selection(DOM::Node &startNode, long &startOffset,
        DOM::Node &endNode, long &endOffset) const;

  void setSelection( const DOM::Range & );

  bool hasSelection() const;

  void selectAll();

  void show();

  void hide();

  KParts::PartManager *partManager();

  virtual void saveState( TQDataStream &stream );
  virtual void restoreState( TQDataStream &stream );

  DOM::Node nodeUnderMouse() const;

  DOM::Node nonSharedNodeUnderMouse() const;

  const TDEHTMLSettings *settings() const;

  TDEHTMLPart *parentPart();

  TQStringList frameNames() const;
 
  TQPtrList<KParts::ReadOnlyPart> frames() const;

  TDEHTMLPart *findFrame( const TQString &f );

  TDEHTMLPart *findFrameParent( KParts::ReadOnlyPart *callingPart, const TQString &f, tdehtml::ChildFrame **childFrame=0 );

  KParts::ReadOnlyPart *currentFrame() const;

  bool frameExists( const TQString &frameName );

  KJSProxy *framejScript(KParts::ReadOnlyPart *framePart);

  KParts::ReadOnlyPart *findFramePart( const TQString &f );
  void setJSStatusBarText( const TQString &text );

  void setJSDefaultStatusBarText( const TQString &text );

  TQString jsStatusBarText() const;

  TQString jsDefaultStatusBarText() const;

  TQString referrer() const;

  TQString pageReferrer() const;

  TQString lastModified() const;

  void preloadStyleSheet( const TQString &url, const TQString &stylesheet );

  void preloadScript( const TQString &url, const TQString &script );

  bool restored() const;
 
  // ### KDE4 remove me
  enum FormNotification { NoNotification = 0, Before, Only, Unused=255 };
  void setFormNotification(FormNotification fn);

  FormNotification formNotification() const;

  KURL toplevelURL();

  bool isModified() const;

  void setSuppressedPopupIndicator( bool enable );

  void setSuppressedPopupIndicator( bool enable, TDEHTMLPart *originPart );

  bool inProgress() const;
 
signals:
  void onURL( const TQString &url );

  void popupMenu( const TQString &url, const TQPoint &point );

  void selectionChanged();

  void nodeActivated( const DOM::Node & );

  void docCreated();

  void caretPositionChanged(const DOM::Node &node, long offset);
 

  void formSubmitNotification(const char *action, const TQString& url,
                  const TQByteArray& formData, const TQString& target,
                  const TQString& contentType, const TQString& boundary);
 
 
protected:

  KURL completeURL( const TQString &url );

  void htmlError( int errorCode, const TQString& text, const KURL& reqUrl );
 
  virtual void customEvent( TQCustomEvent *event );

  virtual void tdehtmlMousePressEvent( tdehtml::MousePressEvent *event );
  virtual void tdehtmlMouseDoubleClickEvent( tdehtml::MouseDoubleClickEvent * );
  virtual void tdehtmlMouseMoveEvent( tdehtml::MouseMoveEvent *event );
  virtual void tdehtmlMouseReleaseEvent( tdehtml::MouseReleaseEvent *event );
  virtual void tdehtmlDrawContentsEvent( tdehtml::DrawContentsEvent * );

  virtual void guiActivateEvent( KParts::GUIActivateEvent *event );

  virtual bool openFile();
 
  virtual void urlSelected( const TQString &url, int button, int state,
                            const TQString &_target, KParts::URLArgs args = KParts::URLArgs());

  virtual KParts::ReadOnlyPart *createPart( TQWidget *parentWidget, const char *widgetName,
                                            TQObject *parent, const char *name,
                                            const TQString &mimetype, TQString &serviceName,
                                            TQStringList &serviceTypes, const TQStringList &params);
 
  // This is for RenderPartObject. We want to ask the 'download plugin?'
  // question only once per mimetype
  bool pluginPageQuestionAsked( const TQString& mimetype ) const;
  void setPluginPageQuestionAsked( const TQString& mimetype );
 
  enum PageSecurity { NotCrypted, Encrypted, Mixed };
  void setPageSecurity( PageSecurity sec );

  virtual bool doOpenStream( const TQString& mimeType );

  virtual bool doWriteStream( const TQByteArray& data );

  virtual bool doCloseStream();
 
public slots:

  void setActiveNode( const DOM::Node &node );

  void stopAnimations();
 
  TQCString dcopObjectId() const;

  TQVariant executeScript( const TQString &script );

  void setCaretMode(bool enable);

  void setEditable(bool enable);

  void setCaretVisible(bool show);
 
  // ### KDE4 FIXME:
  //          Remove this and make the one below protected+virtual slot.
  //          Warning: this is effectively "internal".  Be careful.
  // @since 3.2
  void submitFormProxy( const char *action, const TQString &url,
                        const TQByteArray &formData,
                        const TQString &target,
                        const TQString& contentType = TQString::null,
                        const TQString& boundary = TQString::null );
 
private slots:

  void reparseConfiguration();

  void slotData( TDEIO::Job*, const TQByteArray &data );
  void slotInfoMessage( TDEIO::Job*, const TQString& msg );
  void slotRestoreData( const TQByteArray &data );
  void slotFinished( TDEIO::Job* );
  void slotFinishedParsing();
  void slotRedirect();
  void slotRedirection( TDEIO::Job*, const KURL& );
  void slotDebugScript();
  void slotDebugDOMTree();
  void slotDebugRenderTree();
  void slotStopAnimations();
  virtual void slotViewDocumentSource();
  virtual void slotViewFrameSource();
  void slotViewPageInfo();
  virtual void slotSaveBackground();
  virtual void slotSaveDocument();
  virtual void slotSaveFrame();
  virtual void slotSecurity();
  virtual void slotSetEncoding();

  virtual void slotUseStylesheet();
 
  virtual void slotFind();
  virtual void slotFindDone(); // ### remove me
  virtual void slotFindDialogDestroyed();
  void slotFindNext();
  void slotFindPrev();
  void slotFindAheadText();
  void slotFindAheadLink();
 
  void slotIncZoom();
  void slotDecZoom();
  void slotIncZoomFast();
  void slotDecZoomFast();
 
  void slotLoadImages();
  void slotWalletClosed();
  void launchWalletManager();
  void walletMenu();

  void submitFormAgain();

  void updateActions();
  void slotPartRemoved( KParts::Part *part );
  void slotActiveFrameChanged( KParts::Part *part );
  void slotChildStarted( TDEIO::Job *job );
  void slotChildCompleted();
  void slotChildCompleted( bool );
  void slotParentCompleted();
  void slotChildURLRequest( const KURL &url, const KParts::URLArgs &args );
  void slotChildDocCreated();
  void slotRequestFocus( KParts::ReadOnlyPart * );
  void slotLoaderRequestStarted( tdehtml::DocLoader*, tdehtml::CachedObject* obj);
  void slotLoaderRequestDone( tdehtml::DocLoader*, tdehtml::CachedObject *obj );
  void checkCompleted();

  void slotAutoScroll();
 
  void slotPrintFrame();
 
  void slotSelectAll();

  void slotProgressUpdate();
 
  /*
   * @internal
   */
  void slotJobPercent( TDEIO::Job*, unsigned long );
 
  /*
   * @internal
   */
  void slotJobDone( TDEIO::Job* );
 
  /*
   * @internal
   */
  void slotUserSheetStatDone( TDEIO::Job* );
 
  /*
   * @internal
   */
  void slotJobSpeed( TDEIO::Job*, unsigned long );

  void slotClearSelection();

  void slotZoomView( int );

  void slotHighlight( const TQString &, int index, int length );

  void slotAutomaticDetectionLanguage( int _id );

  void slotToggleCaretMode();

  void suppressedPopupMenu();

  void togglePopupPassivePopup();

  void showSuppressedPopups();

  void launchJSConfigDialog();

  void launchJSErrorDialog();

  void removeJSErrorExtension();

  void disableJSErrorExtension();

  void jsErrorDialogContextMenu();

  void restoreScrollPosition();
 
  void walletOpened(TDEWallet::Wallet*);
 
private:
 
  KJSErrorDlg *jsErrorExtension();
 
  enum StatusBarPriority { BarDefaultText, BarHoverText, BarOverrideText };
  void setStatusBarText( const TQString& text, StatusBarPriority p);
 
  bool restoreURL( const KURL &url );
  void resetFromScript();
  void emitSelectionChanged();
  // Returns whether callingHtmlPart may access this part
  bool checkFrameAccess(TDEHTMLPart *callingHtmlPart);
  bool openURLInFrame( const KURL &url, const KParts::URLArgs &urlArgs );
  bool urlSelectedIntern( const TQString &url, int button, int state,
                          const TQString &_target, KParts::URLArgs args = KParts::URLArgs());
  void startAutoScroll();
  void stopAutoScroll();
  void overURL( const TQString &url, const TQString &target, bool shiftPressed = false );
  void resetHoverText(); // Undo overURL and reset HoverText
 
  bool processObjectRequest( tdehtml::ChildFrame *child, const KURL &url, const TQString &mimetype );
 
  TDEWallet::Wallet* wallet();
 
  void openWallet(DOM::HTMLFormElementImpl*);
  void saveToWallet(const TQString& key, const TQMap<TQString,TQString>& data);
  void dequeueWallet(DOM::HTMLFormElementImpl*);
  
  void enableFindAheadActions(bool);

  // ### KDE4 FIXME:
  //          It is desirable to be able to filter form submissions as well.
  //          For instance, forms can have a target and an inheriting class
  //          might want to filter based on the target.  Make this protected
  //          and virtual, or provide a better solution.
  //          See the web_module for the sidebar for an example where this is
  //          necessary.
  void submitForm( const char *action, const TQString &url, const TQByteArray &formData,
                   const TQString &target, const TQString& contentType = TQString::null,
                   const TQString& boundary = TQString::null );
 
  void popupMenu( const TQString &url );
 
  void init( TDEHTMLView *view, GUIProfile prof );
 
 
  void clear();
 
  bool scheduleScript( const DOM::Node &n, const TQString& script);
 
  TQVariant crossFrameExecuteScript(const TQString& target, const TQString& script);
  TQVariant executeScheduledScript();
 
  bool requestFrame( tdehtml::RenderPart *frame, const TQString &url, const TQString &frameName,
                     const TQStringList &args = TQStringList(), bool isIFrame = false );

  TQString requestFrameName();
 
  bool requestObject( tdehtml::RenderPart *frame, const TQString &url, const TQString &serviceType,
                      const TQStringList &args = TQStringList() );
 
  bool requestObject( tdehtml::ChildFrame *child, const KURL &url, const KParts::URLArgs &args = KParts::URLArgs() );
 
  DOM::EventListener *createHTMLEventListener( TQString code, TQString name, DOM::NodeImpl *node );
 
  DOM::HTMLDocumentImpl *docImpl() const;
  DOM::DocumentImpl *xmlDocImpl() const;
  tdehtml::ChildFrame *frame( const TQObject *obj );
 
  tdehtml::ChildFrame *recursiveFrameRequest( TDEHTMLPart *callingHtmlPart, const KURL &url, const KParts::URLArgs &args, bool callParent = true );
 
  bool checkLinkSecurity( const KURL &linkURL,const TQString &message = TQString::null, const TQString &button = TQString::null );
  TQVariant executeScript( const TQString& filename, int baseLine, const DOM::Node &n, const TQString& script );
 
  KJSProxy *jScript();
 
  TDEHTMLPart *opener();
  long cacheId() const;
  void setOpener( TDEHTMLPart *_opener );
  bool openedByJS();
  void setOpenedByJS( bool _openedByJS );
 
  void checkEmitLoadEvent();
  void emitLoadEvent();
 
  bool initFindNode( bool selection, bool reverse, bool fromCursor );
 
  void extendSelection( DOM::NodeImpl* node, long offset, DOM::Node& selectionNode, long& selectionOffset, bool right, bool paragraph );
  void extendSelectionTo(int x, int y, int absX, int absY, const DOM::Node &innerNode);
  bool isExtendingSelection() const;
  tdehtml::Decoder *createDecoder();
  TQString defaultEncoding() const;

  TQString defaultExtension() const;

  void zoomIn(const int stepping[], int count);
  void zoomOut(const int stepping[], int count);
 
  void emitCaretPositionChanged(const DOM::Node &node, long offset);
 
  void setDebugScript( bool enable );
 
  void runAdFilter();
 
  TDEHTMLPartPrivate *d;
  friend class TDEHTMLPartPrivate;
};
 
 
#endif