Tomboy.TaskManager.TaskList Class Reference

A task list is a collection of tasks grouped together. It may have a title and a due date. More...

Inherits Tomboy::TaskManager::AttributedTask.

Collaboration diagram for Tomboy.TaskManager.TaskList:

[legend]

List of all members.

Public Member Functions
	TaskList (Note note, List< Task > tasks, String name, Gtk.TextIter start)
	Creates a new tasklists including all the given tasks.
	TaskList (Note note, Gtk.TextIter start, TaskListTag tag)
	Creates a new task list with existing tags.
	TaskList (Note note)
	Sets up the TaskList at cursor position.
List< Task >	RemoveDeletedTasks ()
	Remove deleted Tasks.
bool	LockEnd ()
	Locks the end of a tasklist.
bool	StartDeleted ()
	Returns true if the start of the TaskList was deleted.
bool	WasDeleted ()
	Returns true if the TaskList was deleted.
TaskList	FixWithin (int line)
	Fix the TaskList, for example after heavy deletion operations.
void	FixTitle ()
	Fix the title after merging or deleting operations.
void	Delete ()
	Delete all the metadata of the Tasklist.
void	DebugPrint ()
	Print the structure of the TaskList to the console, only if debugging!
void	TransferTasksTo (TaskList tasklist)
	Transfer all the tasks to another tasklist, used for merging.
void	PlaceCursorAtEnd ()
	Places the cursor at the end of the TaskList.
void	AddTask (Gtk.TextIter position)
	Creates a new Task and add it to the `Tasks` list.
void	AddFinishedTask (Task task)
	Add an existing task to this list.
void	AddTask (Gtk.TextIter position, TaskTag tag)
	Add a new task to this tasklist.
Properties
string	Name [get, set]
	Name of this task list.
override bool	Done [get, set]
	Describes what to do when tasklist is marked as done.
List< Task >	Tasks [get, set]
	Tasks for ITask interface.
int	LastTaskLine [get]
	Returns the last line where a Task is on.
override TextIter	DescriptionStart [get]
	Beginning of the description, for TaskLists the same as Start.
override TextIter	DescriptionEnd [get]
	End of the description, basically end of first line.
override TextIter	End [get]
	End of the Tasklist, including all tasks.
override NoteBuffer	Buffer [get]
	The Buffer containing this TaskList.
List< Task >	SuperTasks [get]
	Method that looks for all linking tasks Use this method sparingly, as it loads all un-loaded notes and does an exhaustive search, including the forward-parsing in the tasks themselfs.

---

Detailed Description

A task list is a collection of tasks grouped together. It may have a title and a due date.

---

Constructor & Destructor Documentation

Tomboy.TaskManager.TaskList.TaskList	(	Note	note,
		List< Task >	tasks,
		String	name,
		Gtk.TextIter	start
	)

Creates a new tasklists including all the given tasks.

Parameters:

tasks

A List<Task>

Tomboy.TaskManager.TaskList.TaskList	(	Note	note,
		Gtk.TextIter	start,
		TaskListTag	tag
	)

Creates a new task list with existing tags.

Tomboy.TaskManager.TaskList.TaskList

(

Note

note

)

Sets up the TaskList at cursor position.

Parameters:

note

Note where the TaskLists is located.

---

Member Function Documentation

void Tomboy.TaskManager.TaskList.AddFinishedTask

(

Task

task

)

Add an existing task to this list.

Parameters:

task

A Task to add.

void Tomboy.TaskManager.TaskList.AddTask	(	Gtk.TextIter	position,
		TaskTag	tag
	)

Add a new task to this tasklist.

Parameters:

	position	A Gtk.TextIter, where to insert the task
	tag	A TaskTag, what tag to give the new task

void Tomboy.TaskManager.TaskList.AddTask

(

Gtk.TextIter

position

)

Creates a new Task and add it to the `Tasks` list.

Parameters:

at

Gtk.TextMark Where to add the task in the Buffer.

void Tomboy.TaskManager.TaskList.DebugPrint

(

)

Print the structure of the TaskList to the console, only if debugging!

void Tomboy.TaskManager.TaskList.Delete

(

)

Delete all the metadata of the Tasklist.

void Tomboy.TaskManager.TaskList.FixTitle

(

)

Fix the title after merging or deleting operations.

TaskList Tomboy.TaskManager.TaskList.FixWithin

(

int

line

)

Fix the TaskList, for example after heavy deletion operations.

Parameters:

line

A System.Int32, the line on which fixing is needed.

Returns:

Returns the new TaskList if splitting was required.

bool Tomboy.TaskManager.TaskList.LockEnd

(

)

Locks the end of a tasklist.

Returns:

A System.Boolean, true if a newline was inserted

void Tomboy.TaskManager.TaskList.PlaceCursorAtEnd

(

)

Places the cursor at the end of the TaskList.

List<Task> Tomboy.TaskManager.TaskList.RemoveDeletedTasks

(

)

Remove deleted Tasks.

Returns:

Returns the invalid tasks as List<Task>

bool Tomboy.TaskManager.TaskList.StartDeleted

(

)

Returns true if the start of the TaskList was deleted.

void Tomboy.TaskManager.TaskList.TransferTasksTo

(

TaskList

tasklist

)

Transfer all the tasks to another tasklist, used for merging.

Parameters:

tasklist

The other TaskList tasklist to send the tasks to

bool Tomboy.TaskManager.TaskList.WasDeleted

(

)

Returns true if the TaskList was deleted.

---

Property Documentation

override NoteBuffer Tomboy.TaskManager.TaskList.Buffer [get, protected]

The Buffer containing this TaskList.

Reimplemented from Tomboy.TaskManager.AttributedTask.

override TextIter Tomboy.TaskManager.TaskList.DescriptionEnd [get, protected]

End of the description, basically end of first line.

Reimplemented from Tomboy.TaskManager.AttributedTask.

override TextIter Tomboy.TaskManager.TaskList.DescriptionStart [get, protected]

Beginning of the description, for TaskLists the same as Start.

Reimplemented from Tomboy.TaskManager.AttributedTask.

override bool Tomboy.TaskManager.TaskList.Done [get, set]

Describes what to do when tasklist is marked as done.

Reimplemented from Tomboy.TaskManager.AttributedTask.

override TextIter Tomboy.TaskManager.TaskList.End [get, protected]

End of the Tasklist, including all tasks.

Reimplemented from Tomboy.TaskManager.AttributedTask.

int Tomboy.TaskManager.TaskList.LastTaskLine [get]

Returns the last line where a Task is on.

string Tomboy.TaskManager.TaskList.Name [get, set]

Name of this task list.

List<Task> Tomboy.TaskManager.TaskList.SuperTasks [get]

Method that looks for all linking tasks Use this method sparingly, as it loads all un-loaded notes and does an exhaustive search, including the forward-parsing in the tasks themselfs.

List<Task> Tomboy.TaskManager.TaskList.Tasks [get, set]

Tasks for ITask interface.

---

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

• TaskList.cs