API reference - Class QProcess

CrashExit

Signature: [static,const] QProcess_ExitStatus CrashExit

Description: Enum constant QProcess::CrashExit

Python specific notes:
The object exposes a readable attribute 'CrashExit'. This is the getter.

Crashed

Signature: [static,const] QProcess_ProcessError Crashed

Description: Enum constant QProcess::Crashed

Python specific notes:
The object exposes a readable attribute 'Crashed'. This is the getter.

FailedToStart

Signature: [static,const] QProcess_ProcessError FailedToStart

Description: Enum constant QProcess::FailedToStart

Python specific notes:
The object exposes a readable attribute 'FailedToStart'. This is the getter.

ForwardedChannels

Signature: [static,const] QProcess_ProcessChannelMode ForwardedChannels

Description: Enum constant QProcess::ForwardedChannels

Python specific notes:
The object exposes a readable attribute 'ForwardedChannels'. This is the getter.

ForwardedErrorChannel

Signature: [static,const] QProcess_ProcessChannelMode ForwardedErrorChannel

Description: Enum constant QProcess::ForwardedErrorChannel

Python specific notes:
The object exposes a readable attribute 'ForwardedErrorChannel'. This is the getter.

ForwardedInputChannel

Signature: [static,const] QProcess_InputChannelMode ForwardedInputChannel

Description: Enum constant QProcess::ForwardedInputChannel

Python specific notes:
The object exposes a readable attribute 'ForwardedInputChannel'. This is the getter.

ForwardedOutputChannel

Signature: [static,const] QProcess_ProcessChannelMode ForwardedOutputChannel

Description: Enum constant QProcess::ForwardedOutputChannel

Python specific notes:
The object exposes a readable attribute 'ForwardedOutputChannel'. This is the getter.

ManagedInputChannel

Signature: [static,const] QProcess_InputChannelMode ManagedInputChannel

Description: Enum constant QProcess::ManagedInputChannel

Python specific notes:
The object exposes a readable attribute 'ManagedInputChannel'. This is the getter.

MergedChannels

Signature: [static,const] QProcess_ProcessChannelMode MergedChannels

Description: Enum constant QProcess::MergedChannels

Python specific notes:
The object exposes a readable attribute 'MergedChannels'. This is the getter.

NormalExit

Signature: [static,const] QProcess_ExitStatus NormalExit

Description: Enum constant QProcess::NormalExit

Python specific notes:
The object exposes a readable attribute 'NormalExit'. This is the getter.

NotRunning

Signature: [static,const] QProcess_ProcessState NotRunning

Description: Enum constant QProcess::NotRunning

Python specific notes:
The object exposes a readable attribute 'NotRunning'. This is the getter.

ReadError

Signature: [static,const] QProcess_ProcessError ReadError

Description: Enum constant QProcess::ReadError

Python specific notes:
The object exposes a readable attribute 'ReadError'. This is the getter.

Running

Signature: [static,const] QProcess_ProcessState Running

Description: Enum constant QProcess::Running

Python specific notes:
The object exposes a readable attribute 'Running'. This is the getter.

SeparateChannels

Signature: [static,const] QProcess_ProcessChannelMode SeparateChannels

Description: Enum constant QProcess::SeparateChannels

Python specific notes:
The object exposes a readable attribute 'SeparateChannels'. This is the getter.

StandardError

Signature: [static,const] QProcess_ProcessChannel StandardError

Description: Enum constant QProcess::StandardError

Python specific notes:
The object exposes a readable attribute 'StandardError'. This is the getter.

StandardOutput

Signature: [static,const] QProcess_ProcessChannel StandardOutput

Description: Enum constant QProcess::StandardOutput

Python specific notes:
The object exposes a readable attribute 'StandardOutput'. This is the getter.

Starting

Signature: [static,const] QProcess_ProcessState Starting

Description: Enum constant QProcess::Starting

Python specific notes:
The object exposes a readable attribute 'Starting'. This is the getter.

Timedout

Signature: [static,const] QProcess_ProcessError Timedout

Description: Enum constant QProcess::Timedout

Python specific notes:
The object exposes a readable attribute 'Timedout'. This is the getter.

UnknownError

Signature: [static,const] QProcess_ProcessError UnknownError

Description: Enum constant QProcess::UnknownError

Python specific notes:
The object exposes a readable attribute 'UnknownError'. This is the getter.

WriteError

Signature: [static,const] QProcess_ProcessError WriteError

Description: Enum constant QProcess::WriteError

Python specific notes:
The object exposes a readable attribute 'WriteError'. This is the getter.

_const_cast

Signature: [const] QProcess ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

aboutToClose

Signature: [signal] void aboutToClose

Description: Signal declaration for QProcess::aboutToClose()

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'aboutToClose'. This is the getter.
The object exposes a writable attribute 'aboutToClose'. This is the setter.

arguments

Signature: [const] string[] arguments

Description: Method QStringList QProcess::arguments()

Python specific notes:
The object exposes a readable attribute 'arguments'. This is the getter.

arguments=

Signature: void arguments= (string[] arguments)

Description: Method void QProcess::setArguments(const QStringList &arguments)

Python specific notes:
The object exposes a writable attribute 'arguments'. This is the setter.

atEnd

Signature: [const] bool atEnd

Description: Method bool QProcess::atEnd()

This is a reimplementation of QIODevice::atEnd

bytesAvailable

Signature: [const] long long bytesAvailable

Description: Method qint64 QProcess::bytesAvailable()

This is a reimplementation of QIODevice::bytesAvailable

bytesToWrite

Signature: [const] long long bytesToWrite

Description: Method qint64 QProcess::bytesToWrite()

This is a reimplementation of QIODevice::bytesToWrite

bytesWritten

Signature: [signal] void bytesWritten (long long bytes)

Description: Signal declaration for QProcess::bytesWritten(qint64 bytes)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'bytesWritten'. This is the getter.
The object exposes a writable attribute 'bytesWritten'. This is the setter.

canReadLine

Signature: [const] bool canReadLine

Description: Method bool QProcess::canReadLine()

This is a reimplementation of QIODevice::canReadLine

channelBytesWritten

Signature: [signal] void channelBytesWritten (int channel, long long bytes)

Description: Signal declaration for QProcess::channelBytesWritten(int channel, qint64 bytes)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'channelBytesWritten'. This is the getter.
The object exposes a writable attribute 'channelBytesWritten'. This is the setter.

channelReadyRead

Signature: [signal] void channelReadyRead (int channel)

Description: Signal declaration for QProcess::channelReadyRead(int channel)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'channelReadyRead'. This is the getter.
The object exposes a writable attribute 'channelReadyRead'. This is the setter.

close

Signature: void close

Description: Method void QProcess::close()

This is a reimplementation of QIODevice::close

closeReadChannel

Signature: void closeReadChannel (const QProcess_ProcessChannel channel)

Description: Method void QProcess::closeReadChannel(QProcess::ProcessChannel channel)

closeWriteChannel

Signature: void closeWriteChannel

Description: Method void QProcess::closeWriteChannel()

destroyed

Signature: [signal] void destroyed (QObject ptr arg1)

Description: Signal declaration for QProcess::destroyed(QObject *)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'destroyed'. This is the getter.
The object exposes a writable attribute 'destroyed'. This is the setter.

environment

Signature: [const] string[] environment

Description: Method QStringList QProcess::environment()

Python specific notes:
The object exposes a readable attribute 'environment'. This is the getter.

environment=

Signature: void environment= (string[] environment)

Description: Method void QProcess::setEnvironment(const QStringList &environment)

Python specific notes:
The object exposes a writable attribute 'environment'. This is the setter.

error

Signature: [const] QProcess_ProcessError error

Description: Method QProcess::ProcessError QProcess::error()

errorOccurred

Signature: [signal] void errorOccurred (const QProcess_ProcessError error)

Description: Signal declaration for QProcess::errorOccurred(QProcess::ProcessError error)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'errorOccurred'. This is the getter.
The object exposes a writable attribute 'errorOccurred'. This is the setter.

error_sig

Signature: [signal] void error_sig (const QProcess_ProcessError error)

Description: Signal declaration for QProcess::error(QProcess::ProcessError error)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'error_sig'. This is the getter.
The object exposes a writable attribute 'error_sig'. This is the setter.

execute

(1) Signature: [static] int execute (string program, string[] arguments)

Description: Static method int QProcess::execute(const QString &program, const QStringList &arguments)

This method is static and can be called without an instance.

(2) Signature: [static] int execute (string command)

Description: Static method int QProcess::execute(const QString &command)

This method is static and can be called without an instance.

exitCode

Signature: [const] int exitCode

Description: Method int QProcess::exitCode()

exitStatus

Signature: [const] QProcess_ExitStatus exitStatus

Description: Method QProcess::ExitStatus QProcess::exitStatus()

finished

Signature: [signal] void finished (int exitCode, const QProcess_ExitStatus exitStatus)

Description: Signal declaration for QProcess::finished(int exitCode, QProcess::ExitStatus exitStatus)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'finished'. This is the getter.
The object exposes a writable attribute 'finished'. This is the setter.

finished_int

Signature: [signal] void finished_int (int exitCode)

Description: Signal declaration for QProcess::finished(int exitCode)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'finished_int'. This is the getter.
The object exposes a writable attribute 'finished_int'. This is the setter.

inputChannelMode

Signature: [const] QProcess_InputChannelMode inputChannelMode

Description: Method QProcess::InputChannelMode QProcess::inputChannelMode()

Python specific notes:
The object exposes a readable attribute 'inputChannelMode'. This is the getter.

inputChannelMode=

Signature: void inputChannelMode= (const QProcess_InputChannelMode mode)

Description: Method void QProcess::setInputChannelMode(QProcess::InputChannelMode mode)

Python specific notes:
The object exposes a writable attribute 'inputChannelMode'. This is the setter.

isSequential?

Signature: [const] bool isSequential?

Description: Method bool QProcess::isSequential()

This is a reimplementation of QIODevice::isSequential

kill

Signature: void kill

Description: Method void QProcess::kill()

new

Signature: [static] new QProcess new (QObject ptr parent = nullptr)

Description: Constructor QProcess::QProcess(QObject *parent)

This method creates an object of class QProcess.

Python specific notes:
This method is the default initializer of the object.

nullDevice

Signature: [static] string nullDevice

Description: Static method QString QProcess::nullDevice()

This method is static and can be called without an instance.

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QProcess::objectNameChanged(const QString &objectName)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'objectNameChanged'. This is the getter.
The object exposes a writable attribute 'objectNameChanged'. This is the setter.

open

Signature: bool open (QIODevice_QFlags_OpenModeFlag mode = QIODevice::ReadWrite)

Description: Method bool QProcess::open(QFlags<QIODevice::OpenModeFlag> mode)

This is a reimplementation of QIODevice::open

pid

Signature: [const] unsigned long pid

Description: Method Q_PID QProcess::pid()

processChannelMode

Signature: [const] QProcess_ProcessChannelMode processChannelMode

Description: Method QProcess::ProcessChannelMode QProcess::processChannelMode()

Python specific notes:
The object exposes a readable attribute 'processChannelMode'. This is the getter.

processChannelMode=

Signature: void processChannelMode= (const QProcess_ProcessChannelMode mode)

Description: Method void QProcess::setProcessChannelMode(QProcess::ProcessChannelMode mode)

Python specific notes:
The object exposes a writable attribute 'processChannelMode'. This is the setter.

processEnvironment

Signature: [const] QProcessEnvironment processEnvironment

Description: Method QProcessEnvironment QProcess::processEnvironment()

Python specific notes:
The object exposes a readable attribute 'processEnvironment'. This is the getter.

processEnvironment=

Signature: void processEnvironment= (const QProcessEnvironment environment)

Description: Method void QProcess::setProcessEnvironment(const QProcessEnvironment &environment)

Python specific notes:
The object exposes a writable attribute 'processEnvironment'. This is the setter.

processId

Signature: [const] long long processId

Description: Method qint64 QProcess::processId()

program

Signature: [const] string program

Description: Method QString QProcess::program()

Python specific notes:
The object exposes a readable attribute 'program'. This is the getter.

program=

Signature: void program= (string program)

Description: Method void QProcess::setProgram(const QString &program)

Python specific notes:
The object exposes a writable attribute 'program'. This is the setter.

readAllStandardError

Signature: bytes readAllStandardError

Description: Method QByteArray QProcess::readAllStandardError()

readAllStandardOutput

Signature: bytes readAllStandardOutput

Description: Method QByteArray QProcess::readAllStandardOutput()

readChannel

Signature: [const] QProcess_ProcessChannel readChannel

Description: Method QProcess::ProcessChannel QProcess::readChannel()

Python specific notes:
The object exposes a readable attribute 'readChannel'. This is the getter.

readChannel=

Signature: void readChannel= (const QProcess_ProcessChannel channel)

Description: Method void QProcess::setReadChannel(QProcess::ProcessChannel channel)

Python specific notes:
The object exposes a writable attribute 'readChannel'. This is the setter.

readChannelFinished

Signature: [signal] void readChannelFinished

Description: Signal declaration for QProcess::readChannelFinished()

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'readChannelFinished'. This is the getter.
The object exposes a writable attribute 'readChannelFinished'. This is the setter.

readChannelMode

Signature: [const] QProcess_ProcessChannelMode readChannelMode

Description: Method QProcess::ProcessChannelMode QProcess::readChannelMode()

Python specific notes:
The object exposes a readable attribute 'readChannelMode'. This is the getter.

readChannelMode=

Signature: void readChannelMode= (const QProcess_ProcessChannelMode mode)

Description: Method void QProcess::setReadChannelMode(QProcess::ProcessChannelMode mode)

Python specific notes:
The object exposes a writable attribute 'readChannelMode'. This is the setter.

readyRead

Signature: [signal] void readyRead

Description: Signal declaration for QProcess::readyRead()

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'readyRead'. This is the getter.
The object exposes a writable attribute 'readyRead'. This is the setter.

readyReadStandardError

Signature: [signal] void readyReadStandardError

Description: Signal declaration for QProcess::readyReadStandardError()

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'readyReadStandardError'. This is the getter.
The object exposes a writable attribute 'readyReadStandardError'. This is the setter.

readyReadStandardOutput

Signature: [signal] void readyReadStandardOutput

Description: Signal declaration for QProcess::readyReadStandardOutput()

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'readyReadStandardOutput'. This is the getter.
The object exposes a writable attribute 'readyReadStandardOutput'. This is the setter.

setArguments

Signature: void setArguments (string[] arguments)

Description: Method void QProcess::setArguments(const QStringList &arguments)

Python specific notes:
The object exposes a writable attribute 'arguments'. This is the setter.

setEnvironment

Signature: void setEnvironment (string[] environment)

Description: Method void QProcess::setEnvironment(const QStringList &environment)

Python specific notes:
The object exposes a writable attribute 'environment'. This is the setter.

setInputChannelMode

Signature: void setInputChannelMode (const QProcess_InputChannelMode mode)

Description: Method void QProcess::setInputChannelMode(QProcess::InputChannelMode mode)

Python specific notes:
The object exposes a writable attribute 'inputChannelMode'. This is the setter.

setProcessChannelMode

Signature: void setProcessChannelMode (const QProcess_ProcessChannelMode mode)

Description: Method void QProcess::setProcessChannelMode(QProcess::ProcessChannelMode mode)

Python specific notes:
The object exposes a writable attribute 'processChannelMode'. This is the setter.

setProcessEnvironment

Signature: void setProcessEnvironment (const QProcessEnvironment environment)

Description: Method void QProcess::setProcessEnvironment(const QProcessEnvironment &environment)

Python specific notes:
The object exposes a writable attribute 'processEnvironment'. This is the setter.

setProgram

Signature: void setProgram (string program)

Description: Method void QProcess::setProgram(const QString &program)

Python specific notes:
The object exposes a writable attribute 'program'. This is the setter.

setReadChannel

Signature: void setReadChannel (const QProcess_ProcessChannel channel)

Description: Method void QProcess::setReadChannel(QProcess::ProcessChannel channel)

Python specific notes:
The object exposes a writable attribute 'readChannel'. This is the setter.

setReadChannelMode

Signature: void setReadChannelMode (const QProcess_ProcessChannelMode mode)

Description: Method void QProcess::setReadChannelMode(QProcess::ProcessChannelMode mode)

Python specific notes:
The object exposes a writable attribute 'readChannelMode'. This is the setter.

setStandardErrorFile

Signature: void setStandardErrorFile (string fileName, QIODevice_QFlags_OpenModeFlag mode = QIODevice::Truncate)

Description: Method void QProcess::setStandardErrorFile(const QString &fileName, QFlags<QIODevice::OpenModeFlag> mode)

setStandardInputFile

Signature: void setStandardInputFile (string fileName)

Description: Method void QProcess::setStandardInputFile(const QString &fileName)

setStandardOutputFile

Signature: void setStandardOutputFile (string fileName, QIODevice_QFlags_OpenModeFlag mode = QIODevice::Truncate)

Description: Method void QProcess::setStandardOutputFile(const QString &fileName, QFlags<QIODevice::OpenModeFlag> mode)

setStandardOutputProcess

Signature: void setStandardOutputProcess (QProcess ptr destination)

Description: Method void QProcess::setStandardOutputProcess(QProcess *destination)

setWorkingDirectory

Signature: void setWorkingDirectory (string dir)

Description: Method void QProcess::setWorkingDirectory(const QString &dir)

Python specific notes:
The object exposes a writable attribute 'workingDirectory'. This is the setter.

start

(1) Signature: void start (string program, string[] arguments, QIODevice_QFlags_OpenModeFlag mode = QIODevice::ReadWrite)

Description: Method void QProcess::start(const QString &program, const QStringList &arguments, QFlags<QIODevice::OpenModeFlag> mode)

(2) Signature: void start (string command, QIODevice_QFlags_OpenModeFlag mode = QIODevice::ReadWrite)

Description: Method void QProcess::start(const QString &command, QFlags<QIODevice::OpenModeFlag> mode)

(3) Signature: void start (QIODevice_QFlags_OpenModeFlag mode = QIODevice::ReadWrite)

Description: Method void QProcess::start(QFlags<QIODevice::OpenModeFlag> mode)

startDetached

(1) Signature: bool startDetached (long long ptr pid = nullptr)

Description: Method bool QProcess::startDetached(qint64 *pid)

Python specific notes:
This instance method is available as '_inst_startDetached' in Python.

(2) Signature: [static] bool startDetached (string program, string[] arguments, string workingDirectory, long long ptr pid = nullptr)

Description: Static method bool QProcess::startDetached(const QString &program, const QStringList &arguments, const QString &workingDirectory, qint64 *pid)

This method is static and can be called without an instance.

Python specific notes:
This class method is available as '_class_startDetached' in Python.

(3) Signature: [static] bool startDetached (string program, string[] arguments)

Description: Static method bool QProcess::startDetached(const QString &program, const QStringList &arguments)

This method is static and can be called without an instance.

Python specific notes:
This class method is available as '_class_startDetached' in Python.

(4) Signature: [static] bool startDetached (string command)

Description: Static method bool QProcess::startDetached(const QString &command)

This method is static and can be called without an instance.

Python specific notes:
This class method is available as '_class_startDetached' in Python.

started

Signature: [signal] void started

Description: Signal declaration for QProcess::started()

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'started'. This is the getter.
The object exposes a writable attribute 'started'. This is the setter.

state

Signature: [const] QProcess_ProcessState state

Description: Method QProcess::ProcessState QProcess::state()

stateChanged

Signature: [signal] void stateChanged (const QProcess_ProcessState state)

Description: Signal declaration for QProcess::stateChanged(QProcess::ProcessState state)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'stateChanged'. This is the getter.
The object exposes a writable attribute 'stateChanged'. This is the setter.

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

systemEnvironment

Signature: [static] string[] systemEnvironment

Description: Static method QStringList QProcess::systemEnvironment()

This method is static and can be called without an instance.

terminate

Signature: void terminate

Description: Method void QProcess::terminate()

tr

Signature: [static] string tr (string s, string c = nullptr, int n = -1)

Description: Static method QString QProcess::tr(const char *s, const char *c, int n)

This method is static and can be called without an instance.

trUtf8

Signature: [static] string trUtf8 (string s, string c = nullptr, int n = -1)

Description: Static method QString QProcess::trUtf8(const char *s, const char *c, int n)

This method is static and can be called without an instance.

waitForBytesWritten

Signature: bool waitForBytesWritten (int msecs = 30000)

Description: Method bool QProcess::waitForBytesWritten(int msecs)

This is a reimplementation of QIODevice::waitForBytesWritten

waitForFinished

Signature: bool waitForFinished (int msecs = 30000)

Description: Method bool QProcess::waitForFinished(int msecs)

waitForReadyRead

Signature: bool waitForReadyRead (int msecs = 30000)

Description: Method bool QProcess::waitForReadyRead(int msecs)

This is a reimplementation of QIODevice::waitForReadyRead

waitForStarted

Signature: bool waitForStarted (int msecs = 30000)

Description: Method bool QProcess::waitForStarted(int msecs)

workingDirectory

Signature: [const] string workingDirectory

Description: Method QString QProcess::workingDirectory()

Python specific notes:
The object exposes a readable attribute 'workingDirectory'. This is the getter.

workingDirectory=

Signature: void workingDirectory= (string dir)

Description: Method void QProcess::setWorkingDirectory(const QString &dir)

Python specific notes:
The object exposes a writable attribute 'workingDirectory'. This is the setter.