KIO::CommandLauncherJob

KIO::CommandLauncherJob Class Reference

#include <KIO/CommandLauncherJob>

Inheritance diagram for KIO::CommandLauncherJob:

Public Member Functions

 CommandLauncherJob (const QString &command, QObject *parent=nullptr)
 
 CommandLauncherJob (const QString &executable, const QStringList &args, QObject *parent=nullptr)
 
 ~CommandLauncherJob () override
 
qint64 pid () const
 
void setDesktopName (const QString &desktopName)
 
void setExecutable (const QString &executable)
 
void setIcon (const QString &iconName)
 
void setStartupId (const QByteArray &startupId)
 
void setWorkingDirectory (const QString &workingDirectory)
 
void start () override
 
- Public Member Functions inherited from KJob
 KJob (QObject *parent=nullptr)
 
Capabilities capabilities () const
 
int error () const
 
virtual QString errorString () const
 
QString errorText () const
 
bool exec ()
 
bool isAutoDelete () const
 
bool isSuspended () const
 
unsigned long percent () const
 
Q_SCRIPTABLE qulonglong processedAmount (Unit unit) const
 
void setAutoDelete (bool autodelete)
 
void setUiDelegate (KJobUiDelegate *delegate)
 
Q_SCRIPTABLE qulonglong totalAmount (Unit unit) const
 
KJobUiDelegateuiDelegate () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Additional Inherited Members

- Public Types inherited from KJob
typedef QFlags< CapabilityCapabilities
 
enum  Capability
 
- Properties inherited from QObject
 objectName
 
- Signals inherited from KJob
void description (KJob *job, const QString &title, const QPair< QString, QString > &field1=QPair< QString, QString >(), const QPair< QString, QString > &field2=QPair< QString, QString >())
 
void finished (KJob *job)
 
void infoMessage (KJob *job, const QString &plain, const QString &rich=QString())
 
void percent (KJob *job, unsigned long percent)
 
void processedAmount (KJob *job, KJob::Unit unit, qulonglong amount)
 
void processedSize (KJob *job, qulonglong size)
 
void result (KJob *job)
 
void resumed (KJob *job)
 
void speed (KJob *job, unsigned long speed)
 
void suspended (KJob *job)
 
void totalAmount (KJob *job, KJob::Unit unit, qulonglong amount)
 
void totalSize (KJob *job, qulonglong size)
 
void warning (KJob *job, const QString &plain, const QString &rich=QString())
 
- Public Slots inherited from KJob
bool kill (KillVerbosity verbosity=Quietly)
 
bool resume ()
 
bool suspend ()
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from KJob
 Killable
 
 NoCapabilities
 
 Suspendable
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Protected Member Functions inherited from KJob
virtual bool doKill ()
 
virtual bool doResume ()
 
virtual bool doSuspend ()
 
void emitPercent (qulonglong processedAmount, qulonglong totalAmount)
 
void emitResult ()
 
void emitSpeed (unsigned long speed)
 
void setCapabilities (Capabilities capabilities)
 
void setError (int errorCode)
 
void setErrorText (const QString &errorText)
 
void setPercent (unsigned long percentage)
 
void setProcessedAmount (Unit unit, qulonglong amount)
 
void setTotalAmount (Unit unit, qulonglong amount)
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Detailed Description

CommandLauncherJob runs a command and watches it while running.

It creates a startup notification and finishes it on success or on error (for the taskbar). It also emits an error message if necessary (e.g. "program not found").

The job finishes when the application is successfully started. At that point you can query the PID.

For error handling, either connect to the result() signal, or for a simple messagebox on error, you can do

Since
5.69

Definition at line 54 of file commandlauncherjob.h.

Constructor & Destructor Documentation

KIO::CommandLauncherJob::CommandLauncherJob ( const QString command,
QObject parent = nullptr 
)
explicit

Creates a CommandLauncherJob.

Parameters
commandthe shell command to run
parentthe parent QObject

Please consider also calling setDesktopName(), or setExecutable() and setIcon() for better startup notification.

Definition at line 41 of file commandlauncherjob.cpp.

KIO::CommandLauncherJob::CommandLauncherJob ( const QString executable,
const QStringList args,
QObject parent = nullptr 
)
explicit

Creates a CommandLauncherJob.

Parameters
executablethe name of the executable
argsthe commandline arguments to pass to the executable
parentthe parent QObject

Please consider also calling setDesktopName(), or setExecutable() and setIcon() for better startup notification.

Definition at line 47 of file commandlauncherjob.cpp.

KIO::CommandLauncherJob::~CommandLauncherJob ( )
override

Destructor.

Note that jobs auto-delete themselves after emitting result

Definition at line 54 of file commandlauncherjob.cpp.

Member Function Documentation

qint64 KIO::CommandLauncherJob::pid ( ) const
Returns
the PID of the application that was started

Available after the job emits result().

Definition at line 126 of file commandlauncherjob.cpp.

void KIO::CommandLauncherJob::setDesktopName ( const QString desktopName)

Set the name of the desktop file (e.g. "org.kde.dolphin", the extension is optional).

This is an alternative solution for setIcon() and setExecutable(), i.e. the icon will be taken from the desktop file, and the executable inferred from the "Exec" line.

Definition at line 70 of file commandlauncherjob.cpp.

void KIO::CommandLauncherJob::setExecutable ( const QString executable)

Sets the name of the executable, used in the startup notification (see KStartupInfoData::setBin()).

Parameters
executableexecutable name, with or without a path

Alternatively, use setDesktopName().

Definition at line 60 of file commandlauncherjob.cpp.

void KIO::CommandLauncherJob::setIcon ( const QString iconName)

Sets the icon for the startup notification.

Parameters
iconNamename of the icon, to be loaded from the current icon theme

Alternatively, use setDesktopName().

Definition at line 65 of file commandlauncherjob.cpp.

void KIO::CommandLauncherJob::setStartupId ( const QByteArray startupId)

Sets the startup notification id of the command launch.

Parameters
startupIdstartup notification id, if any (otherwise "").

Definition at line 75 of file commandlauncherjob.cpp.

void KIO::CommandLauncherJob::setWorkingDirectory ( const QString workingDirectory)

Sets the working directory from which to run the command.

Parameters
workingDirectorypath of a local directory

Definition at line 80 of file commandlauncherjob.cpp.

void KIO::CommandLauncherJob::start ( )
overridevirtual

Starts the job.

You must call this, after having done all the setters.

Implements KJob.

Definition at line 85 of file commandlauncherjob.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Wed May 27 2020 23:03:12 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.