LibreOffice Module sd (master) 1
Public Member Functions | Protected Member Functions | List of all members
sd::tools::AsynchronousTask Class Referenceabstract

Interface for the asynchronous execution of a task. More...

#include <AsynchronousTask.hxx>

Inheritance diagram for sd::tools::AsynchronousTask:
[legend]

Public Member Functions

virtual void RunNextStep ()=0
 Run the next step of the task. More...
 
virtual bool HasNextStep ()=0
 Return <TRUE> when there is at least one more step to execute. More...
 

Protected Member Functions

 ~AsynchronousTask ()
 

Detailed Description

Interface for the asynchronous execution of a task.

This interface allows a controller to run the task either timer based with a fixed amount of time between the steps or thread based one step right after the other.

Definition at line 29 of file AsynchronousTask.hxx.

Constructor & Destructor Documentation

◆ ~AsynchronousTask()

sd::tools::AsynchronousTask::~AsynchronousTask ( )
inlineprotected

Definition at line 44 of file AsynchronousTask.hxx.

Member Function Documentation

◆ HasNextStep()

virtual bool sd::tools::AsynchronousTask::HasNextStep ( )
pure virtual

Return <TRUE> when there is at least one more step to execute.

When the task has been executed completely then <FALSE> is returned.

Implemented in sd::TemplateScanner, and sd::sidebar::MasterPageContainerFiller.

◆ RunNextStep()

virtual void sd::tools::AsynchronousTask::RunNextStep ( )
pure virtual

Run the next step of the task.

After HasNextStep() returns false this method should ignore further calls.

Implemented in sd::TemplateScanner, and sd::sidebar::MasterPageContainerFiller.


The documentation for this class was generated from the following file: