Qtopia Home - Classes - Hierachy - Annotated - Functions - Qt Embedded |

# PimTask Class Reference
[qpepim module]

The PimTask class holds the data of a todo entry. More...

`#include <qtopia/pim/task.h>`

Inherits PimRecord.

List of all member functions.

## Public Members

- enum TaskStatus { NotStarted = 0, InProgress, Completed, Waiting, Deferred }
- enum PriorityValue { VeryHigh = 1, High, Normal, Low, VeryLow }
- PimTask ()
- virtual ~PimTask ()
- void setPriority ( PriorityValue priority )
- PriorityValue priority () const
- void setDescription ( const QString & description )
- QString description () const
- void setDueDate ( const QDate & date )
- void clearDueDate ()
- const QDate & dueDate () const
- bool hasDueDate () const
- const QDate & startedDate () const
- void setStartedDate ( const QDate & date )
- bool hasStartedDate () const
- const QDate & completedDate () const
- void setCompletedDate ( const QDate & date )
- TaskStatus status () const
- void setStatus ( TaskStatus s )
- bool isCompleted () const
- void setCompleted ( bool b )
- uint percentCompleted () const
- void setPercentCompleted ( uint percent )
- QString notes () const
- void setNotes ( const QString & s )
- bool match ( const QRegExp & r ) const
- QString toRichText () const

## Static Public Members

- void writeVCalendar ( const QString & filename, const QValueList<PimTask> & tasks )
- void writeVCalendar ( const QString & filename, const PimTask & task )
- QValueList<PimTask> readVCalendar ( const QString & filename )

## Detailed Description

The PimTask class holds the data of a todo entry.

This data includes the priority of the task, a description, an optional due date, and whether the task is completed or not.

See also Qtopia PIM Library.

## Member Type Documentation

### PimTask::PriorityValue

These enums describe the current priority() of the Task.

The values are:

- `PimTask::VeryHigh`
- `PimTask::High`
- `PimTask::Normal`
- `PimTask::Low`
- `PimTask::VeryLow`

### PimTask::TaskStatus

These enums describe the current status() of the Task.

The values are:

- `PimTask::NotStarted`
- `PimTask::InProgress`
- `PimTask::Completed`
- `PimTask::Waiting`
- `PimTask::Deferred`

## Member Function Documentation

### PimTask::PimTask ()

Creates a new, empty task.

### PimTask::~PimTask ()`[virtual]`

Destroys the task

### void PimTask::clearDueDate ()

Clears the due date of the task.

See also setDueDate().

### const QDate & PimTask::completedDate () const

Returns the date the task was completed. If the task is not completed, the returned date is undefined.

See also isCompleted() and setCompletedDate().

### QString PimTask::description () const

Returns the description of the task.

See also setDescription().

### const QDate & PimTask::dueDate () const

Returns the due date of the task.

See also setDueDate() and clearDueDate().

### bool PimTask::hasDueDate () const

Returns TRUE if there is a due date set for the task. Otherwise returns FALSE.

See also dueDate(), setDueDate() and clearDueDate().

### bool PimTask::hasStartedDate () const

Returns TRUE if the task has a started date.

See also startedDate() and setStartedDate().

### bool PimTask::isCompleted () const

Returns TRUE if the task is completed. Otherwise returns FALSE.

See also setCompleted().

### bool PimTask::match ( const QRegExp & r ) const

Returns TRUE if the part of task matches r. Otherwise returns FALSE.

### QString PimTask::notes () const

Returns any notes for the task.

See also setNotes().

### uint PimTask::percentCompleted () const

Returns an int indicating the percent completed of the task. For completed tasks, this function will always return 100.

See also setPercentCompleted() and status().

### PriorityValue PimTask::priority () const

Returns the priority of the task.

See also setPriority().

### QValueList<PimTask> PimTask::readVCalendar ( const QString & filename )`[static]`

Reads the file specified by filename as a list of vCalendar objects and returns the list of near equivalent tasks.

See also writeVCalendar().

### void PimTask::setCompleted ( bool b )

If b is TRUE marks the task as completed. Otherwise marks the task as uncompleted.

See also isCompleted().

### void PimTask::setCompletedDate ( const QDate & date )

Sets the tasks completed date to date.

See also isCompleted() and completedDate().

### void PimTask::setDescription ( const QString & description )

Sets the description of the task to description.

See also description().

### void PimTask::setDueDate ( const QDate & date )

Sets the due date of the task to date.

See also clearDueDate() and dueDate().

### void PimTask::setNotes ( const QString & s )

Sets the notes of the task to s.

See also notes().

### void PimTask::setPercentCompleted ( uint percent )

Sets the tasks percent completed field to percent. if percent is greater than 99 this function will also set the status to Completed.

See also percentCompleted() and status().

### void PimTask::setPriority ( PriorityValue priority )

Sets the priority of the task to priority.

See also priority().

### void PimTask::setStartedDate ( const QDate & date )

Sets the tasks to have started on date.

See also hasStartedDate() and startedDate().

### void PimTask::setStatus ( TaskStatus s )

Sets the TaskStatus of the task to s.

See also status().

### const QDate & PimTask::startedDate () const

Returns the date the task was started. If the task has not yet been started, the returned date is undefined.

See also hasStartedDate() and setStartedDate().

### TaskStatus PimTask::status () const

Returns the TaskStatus of the task.

See also setStatus().

### QString PimTask::toRichText () const

Returns a rich text formatted QString of the PimTask.

### void PimTask::writeVCalendar ( const QString & filename, const QValueList<PimTask> & tasks )`[static]`

Write the list of tasks as vCalendar objects to the file specified by filename.

See also readVCalendar().

### void PimTask::writeVCalendar ( const QString & filename, const PimTask & task )`[static]`

Write the task as a vCalendar to the file specified by filename.

See also readVCalendar().

This file is part of the Qtopia platform, copyright © 1995-2004 Trolltech, all rights reserved.