krun.h

Go to the documentation of this file.

// -*- mode: c++; c-basic-offset: 2 -*-
/* This file is part of the KDE project
   Copyright (C) 1998, 1999 Torben Weis <weis@kde.org>
   Copyright (C) 2006 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 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 KRUN_H
#define KRUN_H

#include <kio/kio_export.h>

#include <QtCore/QObject>
#include <QtCore/QTimer>
#include <QtCore/QString>
#include <sys/types.h>
#include <kurl.h>

class KService;
class KStartupInfo;
class KJob;
namespace KIO
{
class Job;
}

class KIO_EXPORT KRun : public QObject
{
    Q_OBJECT
public:
    KRun(const KUrl& url, QWidget* window, mode_t mode = 0,
         bool isLocalFile = false, bool showProgressInfo = true,
         const QByteArray& asn = QByteArray());

    virtual ~KRun();

    void abort();

    bool hasError() const;

    bool hasFinished() const;

    bool autoDelete() const;

    void setAutoDelete(bool b);

    void setPreferredService(const QString& desktopEntryName);

    void setRunExecutables(bool b);

    void setEnableExternalBrowser(bool b);

    void setSuggestedFileName(const QString& fileName);

    QString suggestedFileName() const;

    QWidget* window() const;


    static bool run(const KService& service, const KUrl::List& urls, QWidget* window,
                    bool tempFiles = false, const QString& suggestedFileName = QString(),
                    const QByteArray& asn = QByteArray());

    static bool run(const QString& exec, const KUrl::List& urls, QWidget* window,
                    const QString& name = QString(),
                    const QString& icon = QString(),
                    const QByteArray& asn = QByteArray());

    static bool runUrl(const KUrl& url, const QString& mimetype, QWidget* window,
                       bool tempFile = false , bool runExecutables = true,
                       const QString& suggestedFileName = QString(), const QByteArray& asn = QByteArray());

    static bool runCommand(const QString &cmd, QWidget* window);

    static bool runCommand(const QString &cmd, QWidget* window, const QString& workingDirectory);
    // TODO KDE5: merge the above with 2-args runCommand, using QString()

    static bool runCommand(const QString& cmd, const QString & execName,
                           const QString & icon, QWidget* window, const QByteArray& asn = QByteArray());

    static bool runCommand(const QString& cmd, const QString & execName,
                           const QString & icon, QWidget* window,
                           const QByteArray& asn, const QString& workingDirectory);
    // TODO KDE5: merge the above with 5-args runCommand, using QString()

    static bool displayOpenWithDialog(const KUrl::List& lst, QWidget* window,
                                      bool tempFiles = false, const QString& suggestedFileName = QString(),
                                      const QByteArray& asn = QByteArray());

#ifndef KDE_NO_DEPRECATED
    static KDE_DEPRECATED void shellQuote(QString &str);
#endif

    static QStringList processDesktopExec(const KService &_service, const KUrl::List &_urls,
                                          bool tempFiles = false,
                                          const QString& suggestedFileName = QString());

    static QString binaryName(const QString & execLine, bool removePath);

    static bool isExecutable(const QString& serviceType);

    static bool isExecutableFile(const KUrl& url, const QString &mimetype);

    static bool checkStartupNotify(const QString& binName, const KService* service, bool* silent_arg,
                                   QByteArray* wmclass_arg);

Q_SIGNALS:
    void finished();
    void error();

protected Q_SLOTS:
    void slotTimeout(); // KDE5: rename to slotNextStep() or something like that

    void slotScanFinished(KJob *);

    void slotScanMimeType(KIO::Job *, const QString &type);

    void mimeTypeDetermined(const QString& mimeType);

    virtual void slotStatResult(KJob *);

protected:
    virtual void init();

    virtual void scanFile();

    virtual void foundMimeType(const QString& type);

    virtual void killJob();

    void setUrl(const KUrl &url);

    KUrl url() const;

    void setError(bool error);

    void setProgressInfo(bool progressInfo);

    bool progressInfo() const;

    void setFinished(bool finished);

    void setJob(KIO::Job *job);

    KIO::Job* job();

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED QTimer& timer();
#endif

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED void setDoScanFile(bool scanFile);
#endif

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED bool doScanFile() const;
#endif

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED void setIsDirecory(bool isDirectory);
#endif

    bool isDirectory() const;

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED void setInitializeNextAction(bool initialize);
#endif

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED bool initializeNextAction() const;
#endif

    void setIsLocalFile(bool isLocalFile);

    bool isLocalFile() const;

    void setMode(mode_t mode);

    mode_t mode() const;

private:
    class KRunPrivate;
    KRunPrivate* const d;
};

#endif