Qtilities::CoreGui::TaskManagerGui Class Reference

A class providing static member functions to acccess and create GUIs related to task management. More...

#include <TaskManagerGui.h>

List of all members.

Public Types
enum	TaskLogInitialization { TaskLogLazyInitialization = 1, TaskLogActiveInitialization = 2 }
	The possible ways that TaskManagerGui can assign logger engines to tasks registered in the global object pool. More...

Public Slots
AbstractLoggerEngine *	assignLoggerEngineToTask (ITask *task, WidgetLoggerEngine::MessageDisplaysFlag message_displays_flag=WidgetLoggerEngine::NoMessageDisplays)
	Slot which will check if obj is a task and assign a logger engine to it if needed.

Public Member Functions
void	disableTaskProgressUpdating ()
	Disables updating of task progress bars throughout the application.
void	enableTaskProgressUpdating ()
	Enables updating of task progress bars throughout the application.
TaskLogInitialization	getTaskLogInitializationMode () const
	Gets the task log initialization used by TaskManagerGui.
WidgetLoggerEngine::MessageDisplaysFlag	getWidgetLoggerEngineDisplaysFlag () const
	Gets the WidgetLoggerEngine::MessageDisplaysFlag used when assigning logger engines to tasks.
void	setTaskLogInitializationMode (TaskLogInitialization log_initialization_mode)
	Sets the task log initialization used by TaskManagerGui.
void	setWidgetLoggerEngineDisplaysFlag (WidgetLoggerEngine::MessageDisplaysFlag message_display_flags)
	Sets the WidgetLoggerEngine::MessageDisplaysFlag used when assigning logger engines to tasks.
SingleTaskWidget *	singleTaskWidget (int task_id)
	Creates a SingleTaskWidget for the given task.
bool	taskProgressUpdatingEnabled () const
	Gets if updating of task progress bars throughout the application is enabled.

---

Detailed Description

A class providing static member functions to acccess and create GUIs related to task management.

See the Tasking article for more information on tasking.

See also:

Qtilities::Core::TaskManager

---

Member Enumeration Documentation

enum Qtilities::CoreGui::TaskManagerGui::TaskLogInitialization

The possible ways that TaskManagerGui can assign logger engines to tasks registered in the global object pool.

The default is TaskLogLazyInitialization.

Enumerator:

TaskLogLazyInitialization	Assign task logger engines only when the task is started the first time, not when the task is registered in the global object pool.
TaskLogActiveInitialization	Assign task logger engines only when the task is registered in the global object pool.

---

Member Function Documentation

AbstractLoggerEngine * TaskManagerGui::assignLoggerEngineToTask ( ITask *  task, WidgetLoggerEngine::MessageDisplaysFlag  message_displays_flag = WidgetLoggerEngine::NoMessageDisplays  )

slot

Slot which will check if obj is a task and assign a logger engine to it if needed.

Parameters:

task	The task on which the logger engine must be assigned.
message_displays_flag	The message displays flag that should be used when assigning the engine. By default WidgetLoggerEngine::NoMessageDisplays in which case the flag specified by the task (if any) will be used. If the task does not specify anything the flags set through setWidgetLoggerEngineDisplaysFlag() will be used.

Returns:

The logger engine which has been assigned to the task.

void TaskManagerGui::disableTaskProgressUpdating

(

)

Disables updating of task progress bars throughout the application.

Enabled by default.

This function was added in Qtilities v1.1.

void TaskManagerGui::enableTaskProgressUpdating

(

)

Enables updating of task progress bars throughout the application.

Enabled by default.

This function was added in Qtilities v1.1.

TaskManagerGui::TaskLogInitialization TaskManagerGui::getTaskLogInitializationMode

(

)

const

Gets the task log initialization used by TaskManagerGui.

See also:

setTaskLogInitializationMode

This function was added in Qtilities v1.1.

WidgetLoggerEngine::MessageDisplaysFlag TaskManagerGui::getWidgetLoggerEngineDisplaysFlag

(

)

const

Gets the WidgetLoggerEngine::MessageDisplaysFlag used when assigning logger engines to tasks.

The default is WidgetLoggerEngine::DefaultTaskDisplays.

See also:

setWidgetLoggerEngineDisplaysFlag

This function was added in Qtilities v1.2.

void TaskManagerGui::setTaskLogInitializationMode

(

TaskLogInitialization

log_initialization_mode

)

Sets the task log initialization used by TaskManagerGui.

See also:

getTaskLogInitializationMode

This function was added in Qtilities v1.1.

void TaskManagerGui::setWidgetLoggerEngineDisplaysFlag

(

WidgetLoggerEngine::MessageDisplaysFlag

message_display_flags

)

Sets the WidgetLoggerEngine::MessageDisplaysFlag used when assigning logger engines to tasks.

See also:

getWidgetLoggerEngineDisplaysFlag

This function was added in Qtilities v1.2.

SingleTaskWidget * TaskManagerGui::singleTaskWidget

(

int

task_id

)

Creates a SingleTaskWidget for the given task.

Parameters:

task_id

The task ID for which a widget must be produced.

bool TaskManagerGui::taskProgressUpdatingEnabled

(

)

const

Gets if updating of task progress bars throughout the application is enabled.

Enabled by default.

This function was added in Qtilities v1.1.