List of all members | Public Member Functions | Public Attributes
AsyncBrowseForFileTask Class Reference

An Asyncronous task that browses for a file on disk. More...

+ Inheritance diagram for AsyncBrowseForFileTask:

Public Member Functions

void cancel ()
 notify the task that it should be cancelled. More...
 

Public Attributes

bool finished
 a flag to indicate whether the task has been completed.
 
float progress
 a value between 0 and 1 to be notified of the task's progress.
 
string result
 path to file if browse was successful
 
string state
 a string to indicate the current task state (pending | running | finished | cancelled)
 
bool success
 a flag to indicate whether the task has been successful.
 

Detailed Description

An Asyncronous task that browses for a file on disk.

Member Function Documentation

void AsyncTask::cancel ( )
inherited

notify the task that it should be cancelled.

N.B.: Cancelling is also asynchronous, the task will note be cancelled immediately. If the task is cancelled in the middle of an operation (i.e. purging 1000 keygroups), the Engine is left in an indeterminate state and this is the script's responsibility to restore a valid state.