InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | List of all members
IdleTimer Class Referenceabstract

#include <IIdleTask.h>

Public Member Functions

virtual uint32 operator() (IdleTimerCompletionType completionType=IdleTimerCompletionType::kDefault)=0
 
virtual void LogString (const char *)=0
 

Detailed Description

Used as a callback for long tasks so that they can pause and return control if they need to.

Member Function Documentation

virtual void IdleTimer::LogString (const char * )
pure virtual

String indicating why the task is out of time.

virtual uint32 IdleTimer::operator() (IdleTimerCompletionType completionType = IdleTimerCompletionType::kDefault)
pure virtual

Method to be called which will determine if the idle task needs to stop.

Parameters
completionType(optional parameter) - checks whether the idle task needs to stop because of a specific reason type (check IdleTimerCompletionType above for various types.) In case this optional parameter passed is not supported , it will fallback to Default value and implementation. Default value checks for all possible reasons to stop the idle task.
Returns
- The amound of time left (0 means the itdle task should stop)