KDE 4.0 API Reference KParts
KParts::BrowserRun Class Reference
#include <browserrun.h>
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.
treating errors as HTML pages)
- generation of SSL metadata depending on the previous URL shown by the part
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 134 of file browserrun.h.
Constructor & Destructor Documentation
| BrowserRun::BrowserRun | ( | const KUrl & | url, | |
| const KParts::OpenUrlArguments & | args, | |||
| const KParts::BrowserArguments & | browserArgs, | |||
| KParts::ReadOnlyPart * | part, | |||
| QWidget * | window, | |||
| bool | removeReferrer, | |||
| bool | trustedSource, | |||
| bool | hideErrorDialog = false | |||
| ) |
- Parameters:
-
url the URL we're probing
- Parameters:
-
args URL args - includes reload, metaData, etc. browserArgs browser-related args - includes data for a HTTP POST, etc. part the part going to open this URL - can be 0 if not created yet window the mainwindow - passed to KIO::Job::setWindow() removeReferrer if true, the "referrer" metadata from argsisn't passed ontrustedSource if false, a warning will be shown before launching an executable. Always pass false for trustedSource, except for local directory views.hideErrorDialog if true, no dialog will be shown in case of errors.
Definition at line 52 of file browserrun.cpp.
| BrowserRun::~BrowserRun | ( | ) | [virtual] |
Definition at line 68 of file browserrun.cpp.
Member Function Documentation
| KParts::OpenUrlArguments & KParts::BrowserRun::arguments | ( | ) |
Definition at line 531 of file browserrun.cpp.
| KParts::BrowserArguments & KParts::BrowserRun::browserArguments | ( | ) |
Definition at line 536 of file browserrun.cpp.
| KParts::ReadOnlyPart * BrowserRun::part | ( | ) | const |
Definition at line 73 of file browserrun.cpp.
| KUrl BrowserRun::url | ( | ) | const |
| bool BrowserRun::hideErrorDialog | ( | ) | const |
Definition at line 522 of file browserrun.cpp.
| QString BrowserRun::contentDisposition | ( | ) | const |
- Returns:
- Suggested disposition by the server (e.g.
HTTP content-disposition)
Definition at line 527 of file browserrun.cpp.
| bool KParts::BrowserRun::serverSuggestsSave | ( | ) | const [inline] |
Definition at line 75 of file browserrun.h.
| BrowserRun::AskSaveResult BrowserRun::askSave | ( | const KUrl & | url, | |
| KService::Ptr | offer, | |||
| const QString & | mimeType, | |||
| const QString & | suggestedFileName = QString() | |||
| ) | [static] |
Ask the user whether to save or open a url in another application.
- Parameters:
-
url the URL in question offer the application that will be used to open the URL mimeType the mimetype of the URL suggestedFileName optional file name suggested by the server
- Returns:
- Save, Open or Cancel.
Definition at line 320 of file browserrun.cpp.
| BrowserRun::AskSaveResult BrowserRun::askEmbedOrSave | ( | const KUrl & | url, | |
| const QString & | mimeType, | |||
| const QString & | suggestedFileName = QString(), |
|||
| int | flags = 0 | |||
| ) | [static] |
Similar to askSave but for the case where the current application is able to embed the url itself (instead of passing it to another app).
- Parameters:
-
url the URL in question mimeType the mimetype of the URL suggestedFileName optional filename suggested by the server flags set to AttachmentDisposition if suggested by the server
- Returns:
- Save, Open or Cancel.
Definition at line 344 of file browserrun.cpp.
Definition at line 382 of file browserrun.cpp.
| void BrowserRun::simpleSave | ( | const KUrl & | url, | |
| const QString & | suggestedFileName, | |||
| QWidget * | window = 0 | |||
| ) | [static] |
Definition at line 387 of file browserrun.cpp.
Definition at line 285 of file browserrun.cpp.
Definition at line 516 of file browserrun.cpp.
| void BrowserRun::scanFile | ( | ) | [protected, virtual] |
| void BrowserRun::init | ( | ) | [protected, virtual] |
| void BrowserRun::handleError | ( | KJob * | 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 459 of file browserrun.cpp.
| BrowserRun::NonEmbeddableResult BrowserRun::handleNonEmbeddable | ( | const QString & | mimeType | ) | [protected] |
Helper for foundMimeType: call this if the mimetype couldn't be embedded.
Definition at line 218 of file browserrun.cpp.
| void BrowserRun::slotBrowserScanFinished | ( | KJob * | job | ) | [protected, slot] |
Definition at line 170 of file browserrun.cpp.
Definition at line 193 of file browserrun.cpp.
| void BrowserRun::slotCopyToTempFileResult | ( | KJob * | job | ) | [protected, slot] |
Definition at line 503 of file browserrun.cpp.
| void BrowserRun::slotStatResult | ( | KJob * | job | ) | [protected, virtual, slot] |
The documentation for this class was generated from the following files:
