任务类

成员函数文档

bool Task::autoDelete() const

如果任务将被自动删除，则返回 true。

另请参阅setAutoDelete()。

int Task::capabilities() const

返回任务的特性。它是由一个或多个 Task::Capability 标志组合而成的。

[纯虚保护] bool Task::doPause()

如果任务被暂停，则返回 true。

[纯虚保护] bool Task::doResume()

如果任务被恢复，则返回 true。

[纯虚保护] void Task::doRun()

如果任务正在运行，则返回 0。

[纯虚保护] bool Task::doStop()

如果任务被停止，则返回 true。

int Task::error() const

返回最后报告的错误代码。

[信号] void Task::error(int code, const QString &errorText)

当此类任务在执行过程中出现错误时，发出此信号。

code 参数指示在任务执行过程中找到的错误，而 errorText 是最后发生的最后一个错误的可读描述。

注意：此类的信号 error 是重载的。要使用函数指针语法连接到此信号，Qt 提供了一个方便的辅助函数，如示例所示。

connect(task, QOverload<int, const QString &>::of(&Task::error),
    [=](int code, const QString &errorText){ /* ... */ });

QString Task::errorString() const

返回最后报告的错误消息文本。

[信号] void Task::finished()

当任务完成时，发出此信号。

bool Task::isFinished() const

返回任务是否已完成。

bool Task::isPaused() const

返回任务是否被暂停。

bool Task::isRunning() const

返回任务是否已开始并正在运行。

bool Task::isStopped() const

返回任务是否被停止。

QString Task::name() const

返回任务名称。

[槽函数] void Task::pause()

暂停任务，前提是任务具有 Task::Pausable 能力。

[信号] void Task::paused()

当任务暂停时发出此信号。

int Task::progressPercent() const

返回此任务完成的百分比。

QString Task::progressText() const

返回描述此任务完成进度的字符串。

[信号] void Task::progressText(const QString &progressText)

发出此信号以报告任务的进度。参数 progressText 表示人类可读的进度形式。

注意：信号 progressText 在此类中重载。要使用函数指针语法连接到此信号，Qt提供了一种方便的助手，如下例所示

connect(task, QOverload<const QString &>::of(&Task::progressText),
    [=](const QString &progressText){ /* ... */ });

[信号] void Task::progressValue(int percent)

发出此信号以报告任务的进度。参数 percent 表示以百分比完成的进度。

[槽] void Task::resume()

如果任务已被暂停，则恢复任务。

[信号] void Task::resumed()

当任务恢复时发出此信号。

[槽] void Task::run()

开始任务。

void Task::setAutoDelete(bool autoDelete)

如果 autoDelete 为 true，则自动删除任务。

另请参阅autoDelete。

[信号] void Task::started()

当任务启动时发出此信号。

[槽] void Task::stop()

如果任务具有 Task::Stoppable 能力，则停止任务。

[信号] void Task::stopped()

当任务停止（或取消）时发出此信号。