kparts Library API Documentation

KParts::BrowserRun Class Reference

This class extends KRun to provide additional functionality for browsers: "save or open" dialog boxes "save" functionality support for HTTP POST (including saving the result to a temp file if opening a separate application) warning before launching executables off the web custom error handling (i.e. More...

#include <browserrun.h>

Inheritance diagram for KParts::BrowserRun:

KRun QObject List of all members.

Public Methods

 BrowserRun (const KURL &url, const KParts::URLArgs &args, KParts::ReadOnlyPart *part, QWidget *window, bool removeReferrer, bool trustedSource)
 BrowserRun (const KURL &url, const KParts::URLArgs &args, KParts::ReadOnlyPart *part, QWidget *window, bool removeReferrer, bool trustedSource, bool hideErrorDialog)

Protected Types

enum  NonEmbeddableResult
 NotHandled means that foundMimeType should call KRun::foundMimeType, i.e. More...


Protected Methods

virtual void scanFile ()
 Reimplemented from KRun.

virtual void init ()
 Reimplemented from KRun.

virtual void handleError (KIO::Job *job)
 Called when an error happens.

NonEmbeddableResult handleNonEmbeddable (const QString &mimeType)
 Helper for foundMimeType: call this if the mimetype couldn't be embedded.


Detailed Description

This class extends KRun to provide additional functionality for browsers: "save or open" dialog boxes "save" functionality support for HTTP POST (including saving the result to a temp file if opening a separate application) warning before launching executables off the web custom error handling (i.e.

Author:
David Faure <faure@kde.org>

Definition at line 39 of file browserrun.h.


Member Enumeration Documentation

enum KParts::BrowserRun::NonEmbeddableResult [protected]
 

NotHandled means that foundMimeType should call KRun::foundMimeType, i.e.

launch an external app.

Definition at line 114 of file browserrun.h.


Constructor & Destructor Documentation

BrowserRun::BrowserRun const KURL   url,
const KParts::URLArgs   args,
KParts::ReadOnlyPart   part,
QWidget   window,
bool    removeReferrer,
bool    trustedSource
 

Parameters:
url  the URL we're probing
args  URL args - includes data for a HTTP POST, etc.
part  the part going to open this URL - can be 0L if not created yet
window  the mainwindow - passed to KIO::Job::setWindow()
removeReferrer  if true, the "referrer" metadata from args isn't passed on
trustedSource  if false, a warning will be shown before launching an executable Always pass false for trustedSource, except for local directory views.

Definition at line 41 of file browserrun.cpp.

BrowserRun::BrowserRun const KURL   url,
const KParts::URLArgs   args,
KParts::ReadOnlyPart   part,
QWidget   window,
bool    removeReferrer,
bool    trustedSource,
bool    hideErrorDialog
 

Parameters:
url  the URL we're probing
args  URL args - includes data for a HTTP POST, etc.
part  the part going to open this URL - can be 0L if not created yet
window  the mainwindow - passed to KIO::Job::setWindow()
removeReferrer  if true, the "referrer" metadata from args isn't passed on
trustedSource  if false, a warning will be shown before launching an executable
hideErrorDialog  if true, no dialog will be shown in case of errors. Always pass false for trustedSource, except for local directory views.

Definition at line 53 of file browserrun.cpp.


Member Function Documentation

void BrowserRun::scanFile   [protected, virtual]
 

Reimplemented from KRun.

Definition at line 101 of file browserrun.cpp.

References QObject::connect(), KParts::URLArgs::contentType(), KParts::URLArgs::doPost(), QString::find(), KMimeType::findByURL(), KRun::foundMimeType(), KIO::get(), KIO::http_post(), QMap< QString, QString >::insert(), KParts::URLArgs::metaData(), KIO::mimetype(), KParts::URLArgs::postData, KURL::protocol(), KMimeType::Ptr, KParts::URLArgs::reload, QMap< QString, QString >::remove(), and KParts::ReadOnlyPart::url().

void BrowserRun::init   [protected, virtual]
 

Reimplemented from KRun.

Definition at line 69 of file browserrun.cpp.

References QFile::encodeName(), and handleError().

void BrowserRun::handleError KIO::Job   job [protected, virtual]
 

Called when an error happens.

NOTE: job could be 0L, if you passed hideErrorDialog=true. The default implementation shows a message box, but only when job != 0 .... It is strongly recommended to reimplement this method if you passed hideErrorDialog=true.

Definition at line 363 of file browserrun.cpp.

Referenced by init().

BrowserRun::NonEmbeddableResult BrowserRun::handleNonEmbeddable const QString   mimeType [protected]
 

Helper for foundMimeType: call this if the mimetype couldn't be embedded.

Definition at line 198 of file browserrun.cpp.

References QObject::connect(), KParts::URLArgs::doPost(), KIO::file_copy(), QString::findRev(), QString::fromLatin1(), QString::isEmpty(), QString::mid(), KTempFile::name(), KServiceTypeProfile::preferredService(), KIO::SimpleJob::removeOnHold(), and KURL::setPath().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kdelibs Version 3.1.0.
Documentation copyright © 1996-2002 the KDE developers.
Generated on Wed Oct 8 12:21:45 2003 by doxygen 1.2.18 written by Dimitri van Heesch, © 1997-2001