Progress info. More...

#include <stdbool.h>

Include dependency graph for progress_info.h:

Typedefs
typedef struct ProgressInfo	ProgressInfo

Enumerations
enum	ProgressStatus { PROGRESS_STATUS_PENDING_START , PROGRESS_STATUS_PENDING_CANCELLATION , PROGRESS_STATUS_RUNNING , PROGRESS_STATUS_COMPLETED }

enum	ProgressCompletionType { PROGRESS_COMPLETED_CANCELLED , PROGRESS_COMPLETED_HAS_WARNING , PROGRESS_COMPLETED_HAS_ERROR , PROGRESS_COMPLETED_SUCCESS }

Functions
ProgressInfo *	progress_info_new (void)

ProgressStatus	progress_info_get_status (ProgressInfo *self)

ProgressCompletionType	progress_info_get_completion_type (ProgressInfo *self)

void	progress_info_request_cancellation (ProgressInfo *self)
	To be called by the task caller.

void	progress_info_mark_completed (ProgressInfo self, ProgressCompletionType type, const char msg)
	To be called by the task itself.

char *	progress_info_get_message (ProgressInfo *self)
	Returns a newly allocated string.

void	progress_info_get_progress (ProgressInfo self, double progress, char **str)
	To be called by the task caller.

void	progress_info_update_progress (ProgressInfo self, double progress, const char msg)
	To be called by the task itself.

bool	progress_info_pending_cancellation (ProgressInfo *self)

void	progress_info_free (ProgressInfo *self)

Detailed Description

Progress info.

Definition in file progress_info.h.

Typedefs