File indexing completed on 2024-04-28 15:27:27

 /*
     This file is part of the KDE project
     SPDX-FileCopyrightText: 1998, 1999 Torben Weis <weis@kde.org>
     SPDX-FileCopyrightText: 2006 David Faure <faure@kde.org>
 
     SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
 #ifndef KRUN_H
 #define KRUN_H
 
 #include "kiowidgets_export.h"
 
 #include <QObject>
 #include <QString>
 #include <QUrl>
 
 #include <memory>
 
 class KService;
 class KJob;
 class QTimer;
 class KRunPrivate;
 
 namespace KIO
 {
 class Job;
 }
 
 #if KIOWIDGETS_ENABLE_DEPRECATED_SINCE(5, 71)
 /**
  * @class KRun krun.h <KRun>
  *
  * To open files with their associated applications in KDE, use KRun.
  *
  * It can execute any desktop entry, as well as any file, using
  * the default application or another application "bound" to the file type
  * (or URL protocol).
  *
  * In that example, the MIME type of the file is not known by the application,
  * so a KRun instance must be created. It will determine the MIME type by itself.
  * If the MIME type is known, or if you even know the service (application) to
  * use for this file, use one of the static methods.
  *
  * By default KRun uses auto deletion. It causes the KRun instance to delete
  * itself when the it finished its task. If you allocate the KRun
  * object on the stack you must disable auto deletion, otherwise it will crash.
  *
  * This respects the "shell_access", "openwith" and "run_desktop_files" Kiosk
  * action restrictions (see KAuthorized::authorize()).
  *
  * @short Opens files with their associated applications in KDE
  */
 class KIOWIDGETS_EXPORT KRun : public QObject
 {
     Q_OBJECT
 public:
     /**
      * @param url the URL of the file or directory to 'run'
      *
      * @param window
      *        The top-level widget of the app that invoked this object.
      *        It is used to make sure private information like passwords
      *        are properly handled per application.
      *
      * @param showProgressInfo
      *        Whether to show progress information when determining the
      *        type of the file (i.e. when using KIO::stat and KIO::mimetype)
      *        Before you set this to false to avoid a dialog box, think about
      *        a very slow FTP server...
      *        It is always better to provide progress info in such cases.
      *
      * @param asn
      *        Application startup notification id, if available (otherwise "").
      *
      * @deprecated since 5.71, use KIO::OpenUrlJob(url) (except for KRun subclasses, for now)
      * @code
      *    auto *job = new KIO::OpenUrlJob(url);
      *    job->setUiDelegate(new KIO::JobUiDelegate(KJobUiDelegate::AutoHandlingEnabled, window));
      *    job->setStartupId(asn);
      *    // methods like setRunExecutables, setSuggestedFilename, setEnableExternalBrowser, setFollowRedirections
      *    // exist in both classes
      *    job->start();
      * @endcode
      */
     KRun(const QUrl &url, QWidget *window, bool showProgressInfo = true, const QByteArray &asn = QByteArray());
 
     /**
      * Destructor. Don't call it yourself, since a KRun object auto-deletes
      * itself.
      */
     ~KRun() override;
 
     /**
      * Abort this KRun. This kills any jobs launched by it,
      * and leads to deletion if auto-deletion is on.
      * This is much safer than deleting the KRun (in case it's
      * currently showing an error dialog box, for instance)
      */
     void abort();
 
     /**
      * Returns true if the KRun instance has an error.
      * @return true when an error occurred
      * @see error()
      */
     bool hasError() const;
 
     /**
      * Returns true if the KRun instance has finished.
      * @return true if the KRun instance has finished
      * @see finished()
      */
     bool hasFinished() const;
 
     /**
      * Checks whether auto delete is activated.
      * Auto-deletion causes the KRun instance to delete itself
      * when it finished its task.
      * By default auto deletion is on.
      * @return true if auto deletion is on, false otherwise
      */
     bool autoDelete() const;
 
     /**
      * Enables or disabled auto deletion.
      * Auto deletion causes the KRun instance to delete itself
      * when it finished its task. If you allocate the KRun
      * object on the stack you must disable auto deletion.
      * By default auto deletion is on.
      * @param b true to enable auto deletion, false to disable
      */
     void setAutoDelete(bool b);
 
     /**
      * Set the preferred service for opening this URL, after
      * its MIME type will have been found by KRun. IMPORTANT: the service is
      * only used if its configuration says it can handle this MIME type.
      * This is used for instance for the X-KDE-LastOpenedWith key in
      * the recent documents list, or for the app selection in
      * KParts::BrowserOpenOrSaveQuestion.
      * @param desktopEntryName the desktopEntryName of the service, e.g. "kate".
      */
     void setPreferredService(const QString &desktopEntryName);
 
     /**
      * Sets whether executables, .desktop files or shell scripts should
      * be run by KRun. This is enabled by default.
      * @param b whether to run executable files or not.
      * @see isExecutable()
      */
     void setRunExecutables(bool b);
 
     /**
      * Sets whether KRun should follow URLs redirections.
      * This is enabled by default
      * @param b whether to follow redirections or not.
      * @since 5.55
      */
     void setFollowRedirections(bool b);
 
     /**
      * Sets whether the external webbrowser setting should be honoured.
      * This is enabled by default.
      * This should only be disabled in webbrowser applications.
      * @param b whether to enable the external browser or not.
      */
     void setEnableExternalBrowser(bool b);
 
     /**
      * Sets the file name to use in the case of downloading the file to a tempfile
      * in order to give to a non-url-aware application. Some apps rely on the extension
      * to determine the MIME type of the file. Usually the file name comes from the URL,
      * but in the case of the HTTP Content-Disposition header, we need to override the
      * file name.
      */
     void setSuggestedFileName(const QString &fileName);
 
     /**
      * Sets whether a prompt should be shown before executing scripts or desktop files.
      * If enabled, KRun uses the "kiorc" configuration file to decide whether to open the
      * file, execute it or show a prompt.
      * @since 5.4
      */
     void setShowScriptExecutionPrompt(bool showPrompt);
 
     /**
      * Suggested file name given by the server (e.g.\ HTTP content-disposition)
      */
     QString suggestedFileName() const;
 
     /**
      * Associated window, as passed to the constructor
      * @since 4.9.3
      */
     QWidget *window() const;
 
 #if KIOWIDGETS_ENABLE_DEPRECATED_SINCE(5, 6)
     /**
      * Open a list of URLs with a certain service (application).
      *
      * @param service the service to run
      * @param urls the list of URLs, can be empty (app launched
      *        without argument)
      * @param window The top-level widget of the app that invoked this object.
      * @param tempFiles if true and urls are local files, they will be deleted
      *        when the application exits.
      * @param suggestedFileName see setSuggestedFileName
      * @param asn Application startup notification id, if any (otherwise "").
      * @return @c true on success, @c false on error
      *
      * @deprecated since 5.6. Since 5.71 use ApplicationLauncherJob, otherwise runApplication instead.
      * @code
      *    auto *job = new KIO::ApplicationLauncherJob(service);
      *    job->setUrls(urls);
      *    job->setUiDelegate(new KIO::JobUiDelegate(KJobUiDelegate::AutoHandlingEnabled, window));
      *    if (tempFiles) {
      *        job->setRunFlags(KIO::ApplicationLauncherJob::DeleteTemporaryFiles);
      *    }
      *    job->setSuggestedFileName(suggestedFileName);
      *    job->setStartupId(asn);
      *    job->start();
      * @endcode
      */
     KIOWIDGETS_DEPRECATED_VERSION(5, 6, "Use KIO::ApplicationLauncherJob, see API docs for a code sample")
     static bool run(const KService &service,
                     const QList<QUrl> &urls,
                     QWidget *window,
                     bool tempFiles = false,
                     const QString &suggestedFileName = QString(),
                     const QByteArray &asn = QByteArray());
 #endif
 
 #if KIOWIDGETS_ENABLE_DEPRECATED_SINCE(5, 71)
     /**
      * Open a list of URLs with a certain service (application).
      *
      * Prefer runApplication(), unless you need to wait for the application
      * to register to D-Bus before this method returns (but that should rather
      * be done with D-Bus activation).
      *
      * @param service the service to run
      * @param urls the list of URLs, can be empty (app launched
      *        without argument)
      * @param window The top-level widget of the app that invoked this object.
      * @param tempFiles if true and urls are local files, they will be deleted
      *        when the application exits.
      * @param suggestedFileName see setSuggestedFileName
      * @param asn Application startup notification id, if any (otherwise "").
      * @return 0 on error, the process ID on success
      * @since 5.6
      * @deprecated since 5.71, use ApplicationLauncherJob instead.
      * @code
      *    auto *job = new KIO::ApplicationLauncherJob(service);
      *    job->setUrls(urls);
      *    job->setUiDelegate(new KIO::JobUiDelegate(KJobUiDelegate::AutoHandlingEnabled, window));
      *    if (tempFiles) {
      *        job->setRunFlags(KIO::ApplicationLauncherJob::DeleteTemporaryFiles);
      *    }
      *    job->setSuggestedFileName(suggestedFileName);
      *    job->setStartupId(asn);
      *    job->start();
      * @endcode
      */
     KIOWIDGETS_DEPRECATED_VERSION(5, 71, "Use KIO::ApplicationLauncherJob, see API docs for a code sample")
     static qint64 runService(const KService &service,
                              const QList<QUrl> &urls,
                              QWidget *window,
                              bool tempFiles = false,
                              const QString &suggestedFileName = QString(),
                              const QByteArray &asn = QByteArray());
 #endif
 
 #if KIOWIDGETS_ENABLE_DEPRECATED_SINCE(5, 71)
     /**
      * @see RunFlags
      */
     enum RunFlag {
         DeleteTemporaryFiles = 0x1, ///< the URLs passed to the service will be deleted when it exits (if the URLs are local files)
         RunExecutables = 0x2, ///< Whether to run URLs that are executable scripts or binaries @see isExecutableFile() @since 5.31
     };
     /**
      * Stores a combination of #RunFlag values.
      * @deprecated since 5.71, see porting instructions in the respective methods
      */
     Q_DECLARE_FLAGS(RunFlags, RunFlag)
 #endif
 
 #if KIOWIDGETS_ENABLE_DEPRECATED_SINCE(5, 71)
     /**
      * Run an application (known from its .desktop file, i.e.\ as a KService).
      *
      * If you need to wait for the application to register to D-Bus, use D-Bus activation instead.
      *
      * If you don't need the prompt for asking the user whether to add the executable bit for
      * desktop files or binaries that don't have it, you can use KIO::ApplicationLauncherJob from KIOGui directly.
      *
      * @param service the service to run
      * @param urls the list of URLs, can be empty (app launched
      *        without argument)
      * @param window The top-level widget of the app that invoked this object.
      * @param flags various flags
      * @param suggestedFileName see setSuggestedFileName
      * @param asn Application startup notification id, if any (otherwise "").
      * @return 0 on error, the process ID on success
      * @since 5.24
      *
      * @deprecated since 5.71, use ApplicationLauncherJob instead.
      * @code
      *    auto *job = new KIO::ApplicationLauncherJob(service);
      *    job->setUrls(urls);
      *    job->setUiDelegate(new KIO::JobUiDelegate(KJobUiDelegate::AutoHandlingEnabled, window));
      *    job->setSuggestedFileName(suggestedFileName);
      *    job->setRunFlags(flags);
      *    job->setStartupId(asn);
      *    job->start();
      * @endcode
      */
     KIOWIDGETS_DEPRECATED_VERSION(5, 71, "Use KIO::ApplicationLauncherJob, see API docs for a code sample")
     static qint64 runApplication(const KService &service,
                                  const QList<QUrl> &urls,
                                  QWidget *window,
                                  RunFlags flags = RunFlags(),
                                  const QString &suggestedFileName = QString(),
                                  const QByteArray &asn = QByteArray());
 #endif
 
 #if KIOWIDGETS_ENABLE_DEPRECATED_SINCE(5, 71)
     /**
      * Open a list of URLs with an executable.
      *
      * @param exec the name of the executable, for example
      *        "/usr/bin/netscape %u".
      *        Don't forget to include the %u if you know that the applications
      *        supports URLs. Otherwise, non-local urls will first be downloaded
      *        to a temp file (using kioexec).
      * @param urls  the list of URLs to open, can be empty (app launched without argument)
      * @param window The top-level widget of the app that invoked this object.
      * @param name the logical name of the application, for example
      *        "Netscape 4.06".
      * @param icon the icon which should be used by the application.
      * @param asn Application startup notification id, if any (otherwise "").
      * @return @c true on success, @c false on error
      *
      * @deprecated since 5.71, use KIO::ApplicationLauncherJob with a temporary KService
      * @code
      *    KService::Ptr service(new KService(name, exec, icon));
      *    auto *job = new KIO::ApplicationLauncherJob(service);
      *    job->setUrls(urls);
      *    job->setUiDelegate(new KDialogJobUiDelegate(KJobUiDelegate::AutoHandlingEnabled, window));
      *    job->setStartupId(asn);
      *    job->start();
      * @endcode
      */
     KIOWIDGETS_DEPRECATED_VERSION(5, 71, "Use KIO::ApplicationLauncherJob with a temporary KService, see API docs for a code sample")
     static bool run(const QString &exec,
                     const QList<QUrl> &urls,
                     QWidget *window,
                     const QString &name = QString(),
                     const QString &icon = QString(),
                     const QByteArray &asn = QByteArray());
 #endif
 
 #if KIOWIDGETS_ENABLE_DEPRECATED_SINCE(5, 31)
     /**
      * Open the given URL.
      *
      * This function is used after the MIME type
      * is found out. It will search for all services which can handle
      * the MIME type and call run() afterwards.
      * @param url the URL to open
      * @param mimetype the MIME type of the resource
      * @param window The top-level widget of the app that invoked this object.
      * @param tempFile if true and url is a local file, it will be deleted
      *        when the launched application exits.
      * @param runExecutables if false then local .desktop files,
      *        executables and shell scripts will not be run.
      *        See also isExecutable().
      * @param suggestedFileName see setSuggestedFileName
      * @param asn Application startup notification id, if any (otherwise "").
      * @return @c true on success, @c false on error
      * @deprecated since 5.31. Since 5.71 use OpenUrlJob, otherwise runUrl() with RunFlags.
      * @code
      *    auto *job = new KIO::OpenUrlJob(url, mimetype);
      *    job->setSuggestedFileName(suggestedFileName);
      *    job->setUiDelegate(new KIO::JobUiDelegate(KJobUiDelegate::AutoHandlingEnabled, window));
      *    job->setRunExecutables(runExecutables);
      *    job->setDeleteTemporaryFile(...); // depending on the old RunFlags
      *    job->setStartupId(asn);
      *    job->start();
      * @endcode
      */
     KIOWIDGETS_DEPRECATED_VERSION(5, 31, "Use KIO::OpenUrlJob, see API docs for a code sample")
     static bool runUrl(const QUrl &url,
                        const QString &mimetype,
                        QWidget *window,
                        bool tempFile = false,
                        bool runExecutables = true,
                        const QString &suggestedFileName = QString(),
                        const QByteArray &asn = QByteArray());
 #endif
 
 #if KIOWIDGETS_ENABLE_DEPRECATED_SINCE(5, 71)
     /**
      * Open the given URL.
      *
      * This function can be used after the MIME type has been found out.
      * It will search for all services which can handle the MIME type and call run() afterwards.
      *
      * @param url The URL to open.
      * @param mimetype the MIME type of the resource
      * @param window The top-level widget of the app that invoked this object.
      * @param flags Various run flags.
      * @param suggestedFileName See setSuggestedFileName()
      * @param asn Application startup notification id, if any (otherwise "").
      * @return @c true on success, @c false on error
      * @since 5.31
      * @deprecated since 5.71, use KIO::OpenUrlJob:
      * @code
      *    auto *job = new KIO::OpenUrlJob(url, mimetype);
      *    job->setUiDelegate(new KIO::JobUiDelegate(KJobUiDelegate::AutoHandlingEnabled, window));
      *    job->setRunExecutables(runExecutables);
      *    job->setDeleteTemporaryFile(...); // depending on the old RunFlags
      *    job->setSuggestedFileName(suggestedFileName);
      *    job->setStartupId(asn);
      *    job->start();
      * @endcode
      */
     KIOWIDGETS_DEPRECATED_VERSION(5, 71, "Use KIO::OpenUrlJob, see API docs for a code sample")
     static bool runUrl(const QUrl &url,
                        const QString &mimetype,
                        QWidget *window,
                        RunFlags flags,
                        const QString &suggestedFileName = QString(),
                        const QByteArray &asn = QByteArray());
 #endif
 
 #if KIOWIDGETS_ENABLE_DEPRECATED_SINCE(5, 71)
     /**
      * Run the given shell command and notifies KDE of the starting
      * of the application. If the program to be called doesn't exist,
      * an error box will be displayed.
      *
      * Use only when you know the full command line. Otherwise use the other
      * static methods, or KRun's constructor.
      *
      * @param cmd must be a shell command. You must not append "&"
      * to it, since the function will do that for you.
      * @param window The top-level widget of the app that invoked this object.
      * @param workingDirectory directory to use for relative paths, so that
      * a command like "kwrite file.txt" finds file.txt from the right place
      *
      * @return @c true on success, @c false on error
      * @deprecated since 5.71, use KIO::CommandLauncherJob
      * @code
      *    auto *job = new KIO::CommandLauncherJob(cmd);
      *    job->setUiDelegate(new KDialogJobUiDelegate(KJobUiDelegate::AutoHandlingEnabled, window));
      *    job->setWorkingDirectory(workingDirectory);
      *    job->start();
      * @endcode
      */
     KIOWIDGETS_DEPRECATED_VERSION(5, 71, "Use KIO::CommandLauncherJob, see API docs for a code sample")
     static bool runCommand(const QString &cmd, QWidget *window, const QString &workingDirectory = QString());
 #endif
 
 #if KIOWIDGETS_ENABLE_DEPRECATED_SINCE(5, 71)
     /**
      * Same as the other runCommand(), but it also takes the name of the
      * binary, to display an error message in case it couldn't find it.
      *
      * @param cmd must be a shell command. You must not append "&"
      * to it, since the function will do that for you.
      * @param execName the name of the executable
      * @param icon icon for app starting notification
      * @param window The top-level widget of the app that invoked this object.
      * @param asn Application startup notification id, if any (otherwise "").
      * @return @c true on success, @c false on error
      * @deprecated since 5.71, use KIO::CommandLauncherJob
      * @code
      *    auto *job = new KIO::CommandLauncherJob(cmd);
      *    job->setUiDelegate(new KDialogJobUiDelegate(KJobUiDelegate::AutoHandlingEnabled, window));
      *    job->setWorkingDirectory(workingDirectory);
      *    job->setExecutable(execName);
      *    job->setIcon(icon);
      *    job->setStartupId(asn);
      *    job->start();
      * @endcode
      */
     KIOWIDGETS_DEPRECATED_VERSION(5, 71, "Use KIO::CommandLauncherJob, see API docs for a code sample")
     static bool runCommand(const QString &cmd, const QString &execName, const QString &icon, QWidget *window, const QByteArray &asn = QByteArray());
 #endif
 
 #if KIOWIDGETS_ENABLE_DEPRECATED_SINCE(5, 71)
     /**
      * Overload that also takes a working directory, so that a command like
      * "kwrite file.txt" finds file.txt from the right place.
      * @param workingDirectory the working directory for the started process. The default
      *                         (if passing an empty string) is the user's document path.
      * @since 4.4
      * @deprecated since 5.71, use KIO::CommandLauncherJob instead
      * @code
      *    auto *job = new KIO::CommandLauncherJob(cmd);
      *    job->setUiDelegate(new KDialogJobUiDelegate(KJobUiDelegate::AutoHandlingEnabled, window));
      *    job->setWorkingDirectory(workingDirectory);
      *    job->setExecutable(execName);
      *    job->setIcon(icon);
      *    job->setStartupId(asn);
      *    job->start();
      * @endcode
      */
     KIOWIDGETS_DEPRECATED_VERSION(5, 71, "Use KIO::CommandLauncherJob, see API docs for a code sample")
     static bool
     runCommand(const QString &cmd, const QString &execName, const QString &icon, QWidget *window, const QByteArray &asn, const QString &workingDirectory);
 #endif
 
 #if KIOWIDGETS_ENABLE_DEPRECATED_SINCE(5, 71)
     /**
      * Display the Open-With dialog for those URLs, and run the chosen application.
      * @param lst the list of URLs to open
      * @param window The top-level widget of the app that invoked this object.
      * @param tempFiles if true and lst are local files, they will be deleted
      *        when the application exits.
      * @param suggestedFileName see setSuggestedFileName
      * @param asn Application startup notification id, if any (otherwise "").
      * @return false if the dialog was canceled
      * @deprecated since 5.71, use KIO::ApplicationLauncherJob with no service argument (or a null service)
      * @code
      *    auto *job = new KIO::ApplicationLauncherJob();
      *    job->setUrls(urls);
      *    job->setUiDelegate(new KIO::JobUiDelegate(KJobUiDelegate::AutoHandlingEnabled, window));
      *    if (tempFiles) {
      *        job->setRunFlags(KIO::ApplicationLauncherJob::DeleteTemporaryFiles);
      *    }
      *    job->setSuggestedFileName(suggestedFileName);
      *    job->setStartupId(asn);
      *    job->start();
      * @endcode
      */
     KIOWIDGETS_DEPRECATED_VERSION(5, 71, "Use KIO::ApplicationLauncherJob, see API docs for a code sample")
     static bool displayOpenWithDialog(const QList<QUrl> &lst,
                                       QWidget *window,
                                       bool tempFiles = false,
                                       const QString &suggestedFileName = QString(),
                                       const QByteArray &asn = QByteArray());
 #endif
 
 #if KIOWIDGETS_ENABLE_DEPRECATED_SINCE(4, 0)
     /**
      * Quotes a string for the shell.
      * An empty string will @em not be quoted.
      *
      * @param str the string to quote. The quoted string will be written here
      *
      * @deprecated Since 4.0, use KShell::quoteArg() instead. @em Note that this function
      *  behaves differently for empty arguments and returns the result
      *  differently.
      */
     KIOWIDGETS_DEPRECATED_VERSION(4, 0, "Use KShell::quoteArg(...)")
     static void shellQuote(QString &str);
 #endif
 
 #if KIOWIDGETS_ENABLE_DEPRECATED_SINCE(5, 0)
     /**
      * Processes a Exec= line as found in .desktop files.
      * @param _service the service to extract information from.
      * @param _urls The urls the service should open.
      * @param tempFiles if true and urls are local files, they will be deleted
      *        when the application exits.
      * @param suggestedFileName see setSuggestedFileName
      *
      * @return a list of arguments suitable for QProcess.
      * @deprecated since 5.0, use KIO::DesktopExecParser
      */
     KIOWIDGETS_DEPRECATED_VERSION(5, 0, "Use KIO::DesktopExecParser")
     static QStringList
     processDesktopExec(const KService &_service, const QList<QUrl> &_urls, bool tempFiles = false, const QString &suggestedFileName = QString());
 #endif
 
 #if KIOWIDGETS_ENABLE_DEPRECATED_SINCE(5, 0)
     /**
      * Given a full command line (e.g.\ the Exec= line from a .desktop file),
      * extract the name of the binary being run.
      * @param execLine the full command line
      * @param removePath if true, remove a (relative or absolute) path. E.g. /usr/bin/ls becomes ls.
      * @return the name of the executable to run
      * @deprecated since 5.0, use KIO::DesktopExecParser::executableName if removePath was true,
      * or KIO::DesktopExecParser::executablePath if removePath was false.
      */
     KIOWIDGETS_DEPRECATED_VERSION(5, 0, "See API docs")
     static QString binaryName(const QString &execLine, bool removePath);
 #endif
 
     /**
      * Returns whether @p mimeType refers to an executable program instead
      * of a data file.
      */
     static bool isExecutable(const QString &mimeType);
 
     /**
      * Returns whether the @p url of @p mimetype is executable.
      * To be executable the file must pass the following rules:
      * -# Must reside on the local filesystem.
      * -# Must be marked as executable for the user by the filesystem.
      * -# The MIME type must inherit application/x-executable, application/x-executable-script or application/x-sharedlib.
      * To allow a script to run when the above rules are satisfied add the entry
      * @code
      * X-KDE-IsAlso=application/x-executable-script
      * @endcode
      * to the MIME type's desktop file.
      */
     static bool isExecutableFile(const QUrl &url, const QString &mimetype);
 
     /**
      * @internal
      */
     static bool checkStartupNotify(const QString &binName, const KService *service, bool *silent_arg, QByteArray *wmclass_arg);
 
 Q_SIGNALS:
     /**
      * Emitted when the operation finished.
      * This signal is emitted in all cases of completion, whether successful or with error.
      * @see hasFinished()
      */
     void finished();
     /**
      * Emitted when the operation had an error.
      * @see hasError()
      */
     void error();
 
 protected Q_SLOTS:
     /**
      * All following protected slots are used by subclasses of KRun!
      */
 
     /**
      * This slot is called whenever the internal timer fired,
      * in order to move on to the next step.
      */
     void slotTimeout();
 
     /**
      * This slot is called when the scan job is finished.
      */
     void slotScanFinished(KJob *);
 
     /**
      * This slot is called when the scan job has found out
      * the MIME type.
      */
     void slotScanMimeType(KIO::Job *, const QString &type);
 
     /**
      * Call this from subclasses when you have determined the MIME type.
      * It will call foundMimeType, but also sets up protection against deletion during message boxes.
      * @since 4.0.2
      */
     void mimeTypeDetermined(const QString &mimeType);
 
     /**
      * This slot is called when the 'stat' job has finished.
      */
     virtual void slotStatResult(KJob *);
 
 protected:
     /**
      * All following protected methods are used by subclasses of KRun!
      */
 
     /**
      * Initializes the krun object.
      */
     virtual void init();
 
     /**
      * Start scanning a file.
      */
     virtual void scanFile();
 
     /**
      * Called if the MIME type has been detected. The function runs
      * the application associated with this MIME type.
      * Reimplement this method to implement a different behavior,
      * like opening the component for displaying the URL embedded.
      *
      * Important: call setFinished(true) once you are done!
      * Usually at the end of the foundMimeType reimplementation, but if the
      * reimplementation is asynchronous (e.g. uses KIO jobs) then
      * it can be called later instead.
      */
     virtual void foundMimeType(const QString &type);
 
     /**
      * Kills the file scanning job.
      */
     virtual void killJob();
 
     /**
      * Called when KRun detects an error during the init phase.
      *
      * The default implementation shows a message box.
      * @since 5.0
      */
     virtual void handleInitError(int kioErrorCode, const QString &errorMsg);
 
     /**
      * Called when a KIO job started by KRun gives an error.
      *
      * The default implementation shows a message box.
      */
     virtual void handleError(KJob *job);
 
     /**
      * Sets the url.
      */
     void setUrl(const QUrl &url);
 
     /**
      * Returns the url.
      */
     QUrl url() const;
 
     /**
      * Sets whether an error has occurred.
      */
     void setError(bool error);
 
     /**
      * Sets whether progress information shall be shown.
      */
     void setProgressInfo(bool progressInfo);
 
     /**
      * Returns whether progress information are shown.
      */
     bool progressInfo() const;
 
     /**
      * Marks this 'KRun' instance as finished.
      */
     void setFinished(bool finished);
 
     /**
      * Sets the job.
      */
     void setJob(KIO::Job *job);
 
     /**
      * Returns the job.
      */
     KIO::Job *job();
 
 #if KIOWIDGETS_ENABLE_DEPRECATED_SINCE(4, 4)
     /**
      * Returns the timer object.
      * @deprecated Since 4.4. setFinished(true) now takes care of the timer().start(0),
      * so this can be removed.
      */
     KIOWIDGETS_DEPRECATED_VERSION(4, 4, "See API docs")
     QTimer &timer();
 #endif
 
 #if KIOWIDGETS_ENABLE_DEPRECATED_SINCE(4, 1)
     /**
      * Indicate that the next action is to scan the file.
      * @deprecated Since 4.1. Not useful in public API
      */
     KIOWIDGETS_DEPRECATED_VERSION(4, 1, "Do not use")
     void setDoScanFile(bool scanFile);
 #endif
 
 #if KIOWIDGETS_ENABLE_DEPRECATED_SINCE(4, 1)
     /**
      * Returns whether the file shall be scanned.
      * @deprecated Since 4.1. Not useful in public API
      */
     KIOWIDGETS_DEPRECATED_VERSION(4, 1, "Do not use")
     bool doScanFile() const;
 #endif
 
 #if KIOWIDGETS_ENABLE_DEPRECATED_SINCE(4, 1)
     /**
      * Sets whether it is a directory.
      * @deprecated Since 4.1. Typo in the name, and not useful as a public method
      */
     KIOWIDGETS_DEPRECATED_VERSION(4, 1, "Do not use")
     void setIsDirecory(bool isDirectory);
 #endif
 
     /**
      * Returns whether it is a directory.
      */
     bool isDirectory() const;
 
 #if KIOWIDGETS_ENABLE_DEPRECATED_SINCE(4, 1)
     /**
      * @deprecated Since 4.1. Not useful in public API
      */
     KIOWIDGETS_DEPRECATED_VERSION(4, 1, "Do not use")
     void setInitializeNextAction(bool initialize);
 #endif
 
 #if KIOWIDGETS_ENABLE_DEPRECATED_SINCE(4, 1)
     /**
      * @deprecated Since 4.1. Not useful in public API
      */
     KIOWIDGETS_DEPRECATED_VERSION(4, 1, "Do not use")
     bool initializeNextAction() const;
 #endif
 
     /**
      * Returns whether it is a local file.
      */
     bool isLocalFile() const;
 
 private:
     friend class KRunPrivate;
     std::unique_ptr<KRunPrivate> const d;
 };
 #endif
 
 #endif