API reference - Class QProcess

Notation used in Ruby API documentation

Description: Binding of QProcess

Class hierarchy: QProcess » QIODevice » QObject

Public constructors

new QProcessnew(QObject ptr parent = 0)Constructor QProcess::QProcess(QObject *parent)

Public methods

[const]boolatEndMethod bool QProcess::atEnd()
[const]long longbytesAvailableMethod qint64 QProcess::bytesAvailable()
[const]long longbytesToWriteMethod qint64 QProcess::bytesToWrite()
[const]boolcanReadLineMethod bool QProcess::canReadLine()
voidcloseMethod void QProcess::close()
voidcloseReadChannel(const QProcess_ProcessChannel channel)Method void QProcess::closeReadChannel(QProcess::ProcessChannel channel)
voidcloseWriteChannelMethod void QProcess::closeWriteChannel()
voidcreateEnsures the C++ object is created
voiddestroyExplicitly destroy the object
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[const]string[]environmentMethod QStringList QProcess::environment()
voidenvironment=(string[] environment)Method void QProcess::setEnvironment(const QStringList &environment)
[const]QProcess_ProcessErrorerrorMethod QProcess::ProcessError QProcess::error()
[const]intexitCodeMethod int QProcess::exitCode()
[const]QProcess_ExitStatusexitStatusMethod QProcess::ExitStatus QProcess::exitStatus()
[const]boolisSequentialMethod bool QProcess::isSequential()
[const]boolisSequential?Method bool QProcess::isSequential()
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
voidkillMethod void QProcess::kill()
[const]long longpidMethod Q_PID QProcess::pid()
[const]QProcess_ProcessChannelModeprocessChannelModeMethod QProcess::ProcessChannelMode QProcess::processChannelMode()
voidprocessChannelMode=(const QProcess_ProcessChannelMode mode)Method void QProcess::setProcessChannelMode(QProcess::ProcessChannelMode mode)
[const]QProcessEnvironmentprocessEnvironmentMethod QProcessEnvironment QProcess::processEnvironment()
voidprocessEnvironment=(const QProcessEnvironment environment)Method void QProcess::setProcessEnvironment(const QProcessEnvironment &environment)
stringreadAllStandardErrorMethod QByteArray QProcess::readAllStandardError()
stringreadAllStandardOutputMethod QByteArray QProcess::readAllStandardOutput()
[const]QProcess_ProcessChannelreadChannelMethod QProcess::ProcessChannel QProcess::readChannel()
voidreadChannel=(const QProcess_ProcessChannel channel)Method void QProcess::setReadChannel(QProcess::ProcessChannel channel)
[const]QProcess_ProcessChannelModereadChannelModeMethod QProcess::ProcessChannelMode QProcess::readChannelMode()
voidreadChannelMode=(const QProcess_ProcessChannelMode mode)Method void QProcess::setReadChannelMode(QProcess::ProcessChannelMode mode)
voidsetEnvironment(string[] environment)Method void QProcess::setEnvironment(const QStringList &environment)
voidsetProcessChannelMode(const QProcess_ProcessChannelMode mode)Method void QProcess::setProcessChannelMode(QProcess::ProcessChannelMode mode)
voidsetProcessEnvironment(const QProcessEnvironment environment)Method void QProcess::setProcessEnvironment(const QProcessEnvironment &environment)
voidsetReadChannel(const QProcess_ProcessChannel channel)Method void QProcess::setReadChannel(QProcess::ProcessChannel channel)
voidsetReadChannelMode(const QProcess_ProcessChannelMode mode)Method void QProcess::setReadChannelMode(QProcess::ProcessChannelMode mode)
voidsetStandardErrorFile(string fileName,
const QIODevice_QFlags_OpenModeFlag mode = QIODevice::Truncate)
Method void QProcess::setStandardErrorFile(const QString &fileName, QFlags<QIODevice::OpenModeFlag> mode)
voidsetStandardInputFile(string fileName)Method void QProcess::setStandardInputFile(const QString &fileName)
voidsetStandardOutputFile(string fileName,
const QIODevice_QFlags_OpenModeFlag mode = QIODevice::Truncate)
Method void QProcess::setStandardOutputFile(const QString &fileName, QFlags<QIODevice::OpenModeFlag> mode)
voidsetStandardOutputProcess(QProcess ptr destination)Method void QProcess::setStandardOutputProcess(QProcess *destination)
voidsetWorkingDirectory(string dir)Method void QProcess::setWorkingDirectory(const QString &dir)
voidstart(string program,
string[] arguments,
const QIODevice_QFlags_OpenModeFlag mode = QIODevice::ReadWrite)
Method void QProcess::start(const QString &program, const QStringList &arguments, QFlags<QIODevice::OpenModeFlag> mode)
voidstart(string program,
const QIODevice_QFlags_OpenModeFlag mode = QIODevice::ReadWrite)
Method void QProcess::start(const QString &program, QFlags<QIODevice::OpenModeFlag> mode)
[const]QProcess_ProcessStatestateMethod QProcess::ProcessState QProcess::state()
voidterminateMethod void QProcess::terminate()
boolwaitForBytesWritten(int msecs = 30000)Method bool QProcess::waitForBytesWritten(int msecs)
boolwaitForFinished(int msecs = 30000)Method bool QProcess::waitForFinished(int msecs)
boolwaitForReadyRead(int msecs = 30000)Method bool QProcess::waitForReadyRead(int msecs)
boolwaitForStarted(int msecs = 30000)Method bool QProcess::waitForStarted(int msecs)
[const]stringworkingDirectoryMethod QString QProcess::workingDirectory()
voidworkingDirectory=(string dir)Method void QProcess::setWorkingDirectory(const QString &dir)

Public static methods and constants

QProcess_ExitStatusCrashExitEnum constant QProcess::CrashExit
QProcess_ProcessErrorCrashedEnum constant QProcess::Crashed
QProcess_ProcessErrorFailedToStartEnum constant QProcess::FailedToStart
QProcess_ProcessChannelModeForwardedChannelsEnum constant QProcess::ForwardedChannels
QProcess_ProcessChannelModeMergedChannelsEnum constant QProcess::MergedChannels
QProcess_ExitStatusNormalExitEnum constant QProcess::NormalExit
QProcess_ProcessStateNotRunningEnum constant QProcess::NotRunning
QProcess_ProcessErrorReadErrorEnum constant QProcess::ReadError
QProcess_ProcessStateRunningEnum constant QProcess::Running
QProcess_ProcessChannelModeSeparateChannelsEnum constant QProcess::SeparateChannels
QProcess_ProcessChannelStandardErrorEnum constant QProcess::StandardError
QProcess_ProcessChannelStandardOutputEnum constant QProcess::StandardOutput
QProcess_ProcessStateStartingEnum constant QProcess::Starting
QProcess_ProcessErrorTimedoutEnum constant QProcess::Timedout
QProcess_ProcessErrorUnknownErrorEnum constant QProcess::UnknownError
QProcess_ProcessErrorWriteErrorEnum constant QProcess::WriteError
intexecute(string program,
string[] arguments)
Static method int QProcess::execute(const QString &program, const QStringList &arguments)
intexecute(string program)Static method int QProcess::execute(const QString &program)
boolstartDetached(string program,
string[] arguments,
string workingDirectory,
long long ptr pid = 0)
Static method bool QProcess::startDetached(const QString &program, const QStringList &arguments, const QString &workingDirectory, qint64 *pid)
boolstartDetached(string program,
string[] arguments)
Static method bool QProcess::startDetached(const QString &program, const QStringList &arguments)
boolstartDetached(string program)Static method bool QProcess::startDetached(const QString &program)
QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
string[]systemEnvironmentStatic method QStringList QProcess::systemEnvironment()
stringtr(string s,
string c = 0)
Static method QString QProcess::tr(const char *s, const char *c)
stringtr(string s,
string c,
int n)
Static method QString QProcess::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = 0)
Static method QString QProcess::trUtf8(const char *s, const char *c)
stringtrUtf8(string s,
string c,
int n)
Static method QString QProcess::trUtf8(const char *s, const char *c, int n)

Detailed description

[static] QProcess_ExitStatus CrashExit

Description: Enum constant QProcess::CrashExit

[static] QProcess_ProcessError Crashed

Description: Enum constant QProcess::Crashed

[static] QProcess_ProcessError FailedToStart

Description: Enum constant QProcess::FailedToStart

[static] QProcess_ProcessChannelMode ForwardedChannels

Description: Enum constant QProcess::ForwardedChannels

[static] QProcess_ProcessChannelMode MergedChannels

Description: Enum constant QProcess::MergedChannels

[static] QProcess_ExitStatus NormalExit

Description: Enum constant QProcess::NormalExit

[static] QProcess_ProcessState NotRunning

Description: Enum constant QProcess::NotRunning

[static] QProcess_ProcessError ReadError

Description: Enum constant QProcess::ReadError

[static] QProcess_ProcessState Running

Description: Enum constant QProcess::Running

[static] QProcess_ProcessChannelMode SeparateChannels

Description: Enum constant QProcess::SeparateChannels

[static] QProcess_ProcessChannel StandardError

Description: Enum constant QProcess::StandardError

[static] QProcess_ProcessChannel StandardOutput

Description: Enum constant QProcess::StandardOutput

[static] QProcess_ProcessState Starting

Description: Enum constant QProcess::Starting

[static] QProcess_ProcessError Timedout

Description: Enum constant QProcess::Timedout

[static] QProcess_ProcessError UnknownError

Description: Enum constant QProcess::UnknownError

[static] QProcess_ProcessError WriteError

Description: Enum constant QProcess::WriteError

[const] bool atEnd

Description: Method bool QProcess::atEnd()

This is a reimplementation of QIODevice::atEnd

[const] long long bytesAvailable

Description: Method qint64 QProcess::bytesAvailable()

This is a reimplementation of QIODevice::bytesAvailable

[const] long long bytesToWrite

Description: Method qint64 QProcess::bytesToWrite()

This is a reimplementation of QIODevice::bytesToWrite

[const] bool canReadLine

Description: Method bool QProcess::canReadLine()

This is a reimplementation of QIODevice::canReadLine

void close

Description: Method void QProcess::close()

This is a reimplementation of QIODevice::close

void closeReadChannel(const QProcess_ProcessChannel channel)

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

void closeWriteChannel

Description: Method void QProcess::closeWriteChannel()

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.

void destroy

Description: Explicitly destroy the object

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

[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.

[const] string[] environment

Description: Method QStringList QProcess::environment()

void environment=(string[] environment)

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

[const] QProcess_ProcessError error

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

[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.

[static] int execute(string program)

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

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

[const] int exitCode

Description: Method int QProcess::exitCode()

[const] QProcess_ExitStatus exitStatus

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

[const] bool isSequential

Description: Method bool QProcess::isSequential()

This is a reimplementation of QIODevice::isSequential

[const] bool isSequential?

Description: Method bool QProcess::isSequential()

This is a reimplementation of QIODevice::isSequential

[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.

void kill

Description: Method void QProcess::kill()

[static] new QProcess new(QObject ptr parent = 0)

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

This method creates an object of class QProcess.

[const] long long pid

Description: Method Q_PID QProcess::pid()

[const] QProcess_ProcessChannelMode processChannelMode

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

void processChannelMode=(const QProcess_ProcessChannelMode mode)

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

[const] QProcessEnvironment processEnvironment

Description: Method QProcessEnvironment QProcess::processEnvironment()

void processEnvironment=(const QProcessEnvironment environment)

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

string readAllStandardError

Description: Method QByteArray QProcess::readAllStandardError()

string readAllStandardOutput

Description: Method QByteArray QProcess::readAllStandardOutput()

[const] QProcess_ProcessChannel readChannel

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

void readChannel=(const QProcess_ProcessChannel channel)

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

[const] QProcess_ProcessChannelMode readChannelMode

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

void readChannelMode=(const QProcess_ProcessChannelMode mode)

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

void setEnvironment(string[] environment)

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

void setProcessChannelMode(const QProcess_ProcessChannelMode mode)

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

void setProcessEnvironment(const QProcessEnvironment environment)

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

void setReadChannel(const QProcess_ProcessChannel channel)

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

void setReadChannelMode(const QProcess_ProcessChannelMode mode)

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

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

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

void setStandardInputFile(string fileName)

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

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

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

void setStandardOutputProcess(QProcess ptr destination)

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

void setWorkingDirectory(string dir)

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

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

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

void start(string program,const QIODevice_QFlags_OpenModeFlag mode = QIODevice::ReadWrite)

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

[static] bool startDetached(string program,string[] arguments,string workingDirectory,long long ptr pid = 0)

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.

[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.

[static] bool startDetached(string program)

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

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

[const] QProcess_ProcessState state

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

[static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

[static] string[] systemEnvironment

Description: Static method QStringList QProcess::systemEnvironment()

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

void terminate

Description: Method void QProcess::terminate()

[static] string tr(string s,string c = 0)

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

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

[static] string tr(string s,string c,int n)

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.

[static] string trUtf8(string s,string c = 0)

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

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

[static] string trUtf8(string s,string c,int n)

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.

bool waitForBytesWritten(int msecs = 30000)

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

This is a reimplementation of QIODevice::waitForBytesWritten

bool waitForFinished(int msecs = 30000)

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

bool waitForReadyRead(int msecs = 30000)

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

This is a reimplementation of QIODevice::waitForReadyRead

bool waitForStarted(int msecs = 30000)

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

[const] string workingDirectory

Description: Method QString QProcess::workingDirectory()

void workingDirectory=(string dir)

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