/usr/include/kparts/browserrun.h is in kdelibs5-dev 4:4.14.16-0ubuntu3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 | /* This file is part of the KDE project
*
* Copyright (C) 2002 David Faure <faure@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 version 2, as published by the Free Software Foundation.
*
* 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 kparts_browserrun_h
#define kparts_browserrun_h
#include <krun.h>
#include <kservice.h>
#include <kparts/browserextension.h>
namespace KParts {
/**
* 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
* @author David Faure <faure@kde.org>
*/
class KPARTS_EXPORT BrowserRun : public KRun
{
Q_OBJECT
public:
/**
* @param url the URL we're probing
* @param args URL args - includes reload, metaData, etc.
* @param browserArgs browser-related args - includes data for a HTTP POST, etc.
* @param part the part going to open this URL - can be 0 if not created yet
* @param window the mainwindow - passed to KIO::Job::setWindow()
* @param removeReferrer if true, the "referrer" metadata from @p args isn't passed on
* @param trustedSource if false, a warning will be shown before launching an executable.
Always pass false for @p trustedSource, except for local directory views.
* @param hideErrorDialog if true, no dialog will be shown in case of errors.
*/
BrowserRun( const KUrl& url,
const KParts::OpenUrlArguments& args,
const KParts::BrowserArguments& browserArgs,
KParts::ReadOnlyPart *part,
QWidget *window,
bool removeReferrer, bool trustedSource, bool hideErrorDialog = false );
virtual ~BrowserRun();
KParts::OpenUrlArguments& arguments();
KParts::BrowserArguments& browserArguments();
KParts::ReadOnlyPart* part() const;
KUrl url() const;
bool hideErrorDialog() const;
/**
* @return Suggested disposition by the server (e.g. HTTP content-disposition)
*/
QString contentDisposition() const;
/**
* @return Wheter the returned disposition suggests saving or opening inline
*/
bool serverSuggestsSave() const;
enum AskSaveResult { Save, Open, Cancel };
/**
* Ask the user whether to save or open a url in another application.
* @param url the URL in question
* @param offer the application that will be used to open the URL
* @param mimeType the mimetype of the URL
* @param suggestedFileName optional file name suggested by the server
* @return Save, Open or Cancel.
* @deprecated use BrowserOpenOrSaveQuestion
* @code
* BrowserOpenOrSaveQuestion dlg(parent, url, mimeType, suggestedFileName);
* const BrowserOpenOrSaveQuestion::Result res = dlg.askOpenOrSave();
* @endcode
*/
#ifndef KDE_NO_DEPRECATED
static KDE_DEPRECATED AskSaveResult askSave( const KUrl & url, KService::Ptr offer, const QString& mimeType, const QString & suggestedFileName = QString() );
#endif
enum AskEmbedOrSaveFlags { InlineDisposition = 0, AttachmentDisposition = 1 };
/**
* 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).
* @param url the URL in question
* @param mimeType the mimetype of the URL
* @param suggestedFileName optional filename suggested by the server
* @param flags set to AttachmentDisposition if suggested by the server
* @return Save, Open or Cancel.
* @deprecated use BrowserOpenOrSaveQuestion
* @code
* BrowserOpenOrSaveQuestion dlg(parent, url, mimeType, suggestedFileName);
* const BrowserOpenOrSaveQuestion::Result res = dlg.askEmbedOrSave(flags);
* // Important: returns Embed now, not Open!
* @endcode
*/
#ifndef KDE_NO_DEPRECATED
static KDE_DEPRECATED AskSaveResult askEmbedOrSave( const KUrl & url, const QString& mimeType, const QString & suggestedFileName = QString(), int flags = 0 );
#endif
// virtual so that KHTML can implement differently (HTML cache)
virtual void save( const KUrl & url, const QString & suggestedFileName );
// static so that it can be called from other classes
static void simpleSave( const KUrl & url, const QString & suggestedFileName,
QWidget* window =0 ); // KDE5: remove
/**
* If kget integration is enabled, passes the url to kget.
* Otherwise, asks the user for a destination url, and calls saveUrlUsingKIO.
* @since 4.4
*/
static void saveUrl(const KUrl & url, const QString & suggestedFileName,
QWidget* window, const KParts::OpenUrlArguments& args);
/**
* Starts the KIO file copy job to download @p srcUrl into @p destUrl.
* @since 4.4
*/
static void saveUrlUsingKIO(const KUrl & srcUrl, const KUrl& destUrl,
QWidget* window, const QMap<QString, QString> &metaData);
static bool allowExecution( const QString &mimeType, const KUrl &url );
static bool isTextExecutable( const QString &mimeType );
/**
* KDE webbrowsing kparts support error urls to display errors in-line in the browser component.
* This helper method creates the error URL from its parameters.
* @param error the KIO error code (or KIO::ERR_SLAVE_DEFINED if not from KIO)
* @param errorText the text of the error message
* @param initialUrl the URL that we were trying to open (as a string, so that this can
* support invalid URLs as well)
* @since 4.6
*/
static KUrl makeErrorUrl(int error, const QString& errorText, const QString& initialUrl);
protected:
/**
* Reimplemented from KRun
*/
virtual void scanFile();
/**
* Reimplemented from KRun
*/
virtual void init();
/**
* Called when an error happens.
* NOTE: @p 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.
*/
virtual void handleError( KJob * job );
/**
* NotHandled means that foundMimeType should call KRun::foundMimeType,
* i.e. launch an external app.
*/
enum NonEmbeddableResult { Handled, NotHandled, Delayed };
/**
* Helper for foundMimeType: call this if the mimetype couldn't be embedded
*/
NonEmbeddableResult handleNonEmbeddable( const QString& mimeType ); // TODO KDE5: remove, and add =0 to the other overload
/**
* Helper for foundMimeType: call this if the mimetype couldn't be embedded
* @param mimeType the mimetype found for the URL
* @param pSelectedService Output variable: pointer to a KService::Ptr, which will be set
* to the service selected in the BrowserOpenOrSaveQuestion dialog, if any.
*
* How to handle this properly: if pSelectedService is non-zero, then the dialog will show
* additional "open with" buttons. In your code, you should write:
* @code
if (selectedService) {
KRun::setPreferredService(selectedService->desktopEntryName()); // not necessary since 4.9.3
KRun::foundMimeType(mimeType);
} else { // the user requested an open-with dialog
KRun::displayOpenWithDialog(url(), m_window, false, suggestedFileName());
setFinished(true);
}
* @endcode
*
* @since 4.5
*/
NonEmbeddableResult handleNonEmbeddable(const QString& mimeType, KService::Ptr* pSelectedService);
protected Q_SLOTS:
void slotBrowserScanFinished(KJob *job);
void slotBrowserMimetype(KIO::Job *job, const QString &type);
void slotCopyToTempFileResult(KJob *job);
virtual void slotStatResult( KJob *job );
private:
void redirectToError( int error, const QString& errorText );
class BrowserRunPrivate;
BrowserRunPrivate* const d;
};
}
#endif
|