Tomboy.TaskManager.Task Class Reference

A Task is a piece of text representing a “todo” item, accompanied with a checkbox. It may have a due date and a priority and can be marked as done by crossing out the checkbox. More...

Inherits Tomboy::TaskManager::AttributedTask.

Collaboration diagram for Tomboy.TaskManager.Task:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 Task (TaskList containingList, Gtk.TextIter location, TaskTag tag)
 Initialize a new task within a list, at a certain location and with a specific tag.
 Task (TaskList containingList, Gtk.TextIter location)
 Initialize a new task within a task list.
void SetAllVisitorPolicies (bool upcom, bool upin, bool downcom, bool downin)
void AddWidgets ()
 Adds all widgets (besides calendar) to this task.
void AddPriority ()
 Makes the priority widget visible.
void UpdateWidgetTags ()
 Update the tags at the beginning of the task.
void ShowPriority ()
void HidePriority ()
void Toggle ()
void TagUpdate ()
 Updates the strikethrough tag of the task description. If the checkbox is active or removes it if it's not. Also applies the tasklist tag.
void RemoveTag (Gtk.TextTag tag)
 Removes the given Tag from this Task.
void ApplyTag (Gtk.TextTag tag)
 Applies the given Tag to this Task.
List< TaskTasksFollowing ()
 Returns a list of the Tasks that follow this task in the Buffer.
void Delete ()
 Should be called when the task is removed.
void DeleteTag ()
 Delete the Tag of this Task.
TaskList DeleteEmptyCheckBox (String name)
 Deletes this task or splits this tasklist, depending on whether we are on the last line or not. When splitting, returns newly created tasklist.
TaskList Fix ()
 Fixes this task, for example after some deletion operations.
TaskList DeleteAndSplit ()
 Deletes this task and Splits / Merges the two remaining task list parts.
bool TaskTagValid (Gtk.TextIter iter)
 Returns true if the tasktag is valid at the given iter.
TaskList Split (String name)
 Splits this TaskList, creating two TaskLists.
TaskList Split ()
 Splits with a default name for the new TaskList.
void DebugPrint ()
 Prints the Task to the Console.
override void AddDueDate (DateTime date)

Properties

bool CheckUpComplete [get, set]
bool CheckUpIncomplete [get, set]
bool SetDownComplete [get, set]
bool SetDownIncomplete [get, set]
override bool Done [get, set]
 Is this task completed? Caution: the setter does not update the buffer (strikethrough), just the attribute of the tag and the checkbox.
Priority Priority [get, set]
 The priority that is assigned to this task. Note that default must be set to 3, not 0.
int Line [get]
 The line on which this Task is located.
TaskList ContainingTaskList [get, set]
 The containing task list.
List< TaskListSubtasks [get]
 List of Subtasks of this task.
TaskTag TaskTag [get, set]
 Gets the tag attached to this task. Shortcut.
bool PriorityUnset [get]
 Returns true if the priority of this task is yet unset.
bool WasDeleted [get]
bool IsValid [get]
 Returns true if the Task is valid (including the tags etc. at the beginning).
bool IsLastTask [get]
 Returns true iff this task is the last (in means of buffer offset) one in containingtasklist.
bool LineIsEmpty [get]
 Returns true if the description line of the Task is empty.
override NoteBuffer Buffer [get]
 The Buffer containing this Task.
override Gtk.TextIter DescriptionEnd [get]
 End of the Description of this Task.
override Gtk.TextIter DescriptionStart [get]
 Start of the Description of this Task. Just after the checkbox etc.
override Gtk.TextIter End [get]

Detailed Description

A Task is a piece of text representing a “todo” item, accompanied with a checkbox. It may have a due date and a priority and can be marked as done by crossing out the checkbox.


Constructor & Destructor Documentation

Tomboy.TaskManager.Task.Task ( TaskList  containingList,
Gtk.TextIter  location,
TaskTag  tag 
)

Initialize a new task within a list, at a certain location and with a specific tag.

Tomboy.TaskManager.Task.Task ( TaskList  containingList,
Gtk.TextIter  location 
)

Initialize a new task within a task list.

Parameters:
containingList A TaskList, where the task should go.
location A Gtk.TextIter, the place in the Buffer where to add the task

Member Function Documentation

void Tomboy.TaskManager.Task.AddPriority (  ) 

Makes the priority widget visible.

void Tomboy.TaskManager.Task.AddWidgets (  ) 

Adds all widgets (besides calendar) to this task.

void Tomboy.TaskManager.Task.ApplyTag ( Gtk.TextTag  tag  ) 

Applies the given Tag to this Task.

Parameters:
tag A Gtk.TextTag
void Tomboy.TaskManager.Task.DebugPrint (  ) 

Prints the Task to the Console.

void Tomboy.TaskManager.Task.Delete (  ) 

Should be called when the task is removed.

TaskList Tomboy.TaskManager.Task.DeleteAndSplit (  ) 

Deletes this task and Splits / Merges the two remaining task list parts.

Returns:
A TaskList
TaskList Tomboy.TaskManager.Task.DeleteEmptyCheckBox ( String  name  ) 

Deletes this task or splits this tasklist, depending on whether we are on the last line or not. When splitting, returns newly created tasklist.

void Tomboy.TaskManager.Task.DeleteTag (  ) 

Delete the Tag of this Task.

TaskList Tomboy.TaskManager.Task.Fix (  ) 

Fixes this task, for example after some deletion operations.

Returns:
A TaskList, the result of splitting of the TaskList that might occur.
void Tomboy.TaskManager.Task.RemoveTag ( Gtk.TextTag  tag  ) 

Removes the given Tag from this Task.

Parameters:
tag A Gtk.TextTag
TaskList Tomboy.TaskManager.Task.Split (  ) 

Splits with a default name for the new TaskList.

Returns:
A TaskList
TaskList Tomboy.TaskManager.Task.Split ( String  name  ) 

Splits this TaskList, creating two TaskLists.

Parameters:
name A String, the name of the new TaskList
Returns:
A TaskList, the second (the new) TaskList
void Tomboy.TaskManager.Task.TagUpdate (  ) 

Updates the strikethrough tag of the task description. If the checkbox is active or removes it if it's not. Also applies the tasklist tag.

List<Task> Tomboy.TaskManager.Task.TasksFollowing (  ) 

Returns a list of the Tasks that follow this task in the Buffer.

Returns:
A List<Task>
bool Tomboy.TaskManager.Task.TaskTagValid ( Gtk.TextIter  iter  ) 

Returns true if the tasktag is valid at the given iter.

Parameters:
iter 
void Tomboy.TaskManager.Task.UpdateWidgetTags (  ) 

Update the tags at the beginning of the task.


Property Documentation

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

The Buffer containing this Task.

Reimplemented from Tomboy.TaskManager.AttributedTask.

TaskList Tomboy.TaskManager.Task.ContainingTaskList [get, set]

The containing task list.

override Gtk.TextIter Tomboy.TaskManager.Task.DescriptionEnd [get, protected]

End of the Description of this Task.

Reimplemented from Tomboy.TaskManager.AttributedTask.

override Gtk.TextIter Tomboy.TaskManager.Task.DescriptionStart [get, protected]

Start of the Description of this Task. Just after the checkbox etc.

Reimplemented from Tomboy.TaskManager.AttributedTask.

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

Is this task completed? Caution: the setter does not update the buffer (strikethrough), just the attribute of the tag and the checkbox.

Reimplemented from Tomboy.TaskManager.AttributedTask.

override Gtk.TextIter Tomboy.TaskManager.Task.End [get, protected]
Returns:
A Gtk.TextIter marking the end of the textual description of this task in the NoteBuffer.

Reimplemented from Tomboy.TaskManager.AttributedTask.

bool Tomboy.TaskManager.Task.IsLastTask [get]

Returns true iff this task is the last (in means of buffer offset) one in containingtasklist.

Returns:
A System.Boolean
bool Tomboy.TaskManager.Task.IsValid [get]

Returns true if the Task is valid (including the tags etc. at the beginning).

int Tomboy.TaskManager.Task.Line [get]

The line on which this Task is located.

bool Tomboy.TaskManager.Task.LineIsEmpty [get]

Returns true if the description line of the Task is empty.

Returns:
A System.Boolean
Priority Tomboy.TaskManager.Task.Priority [get, set]

The priority that is assigned to this task. Note that default must be set to 3, not 0.

bool Tomboy.TaskManager.Task.PriorityUnset [get]

Returns true if the priority of this task is yet unset.

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

List of Subtasks of this task.

TaskTag Tomboy.TaskManager.Task.TaskTag [get, set]

Gets the tag attached to this task. Shortcut.

bool Tomboy.TaskManager.Task.WasDeleted [get]

Returns true if the Task was deleted in the Buffer


The documentation for this class was generated from the following file:
Generated on Fri May 28 00:23:14 2010 for TaskManager by  doxygen 1.6.3