KDE PIM / Developers / API Docs / kpilot

PilotTodoEntry Class Reference

A decoded ToDo item. More...

#include <pilotTodoEntry.h>

Inherits PilotAppCategory.

List of all members.

Public Member Functions

Protected Member Functions


Detailed Description

A decoded ToDo item.


Constructor & Destructor Documentation

PilotTodoEntry::PilotTodoEntry struct ToDoAppInfo &  appInfo  ) 
 

Create an empty ToDo item.

PilotTodoEntry::PilotTodoEntry struct ToDoAppInfo &  appInfo,
PilotRecord rec
 

Create a ToDo item and fill it with data from the uninterpreted record.

Parameters:
rec. 

PilotTodoEntry::PilotTodoEntry const PilotTodoEntry e  ) 
 

Copy an existing ToDo item.

PilotTodoEntry::~PilotTodoEntry  )  [inline]
 

Delete a ToDo item.


Member Function Documentation

QString PilotTodoEntry::getTextRepresentation bool  richText = false  )  [virtual]
 

Return a string for the ToDo item.

If

Parameters:
richText is true, then use <qt> style markup to make the string clearer when displayed.

PilotTodoEntry & PilotTodoEntry::operator= const PilotTodoEntry e  ) 
 

Assign an existing ToDo item to this one.

struct tm PilotTodoEntry::getDueDate  )  const [inline]
 

Accessor for the Due Date of the ToDo item.

void PilotTodoEntry::setDueDate struct tm &  d  )  [inline]
 

Set the Due Date for the ToDo item.

int PilotTodoEntry::getIndefinite  )  const [inline]
 

Return the indefinite status of the ToDo (? that is, whether it had a Due Date that is relevant or not).

Return values are 0 (not indefinite) or non-0.

void PilotTodoEntry::setIndefinite int  i  )  [inline]
 

Set whether the ToDo is indefinite or not.

int PilotTodoEntry::getPriority  )  const [inline]
 

Return the priority of the ToDo item.

The priority ranges from 1-5 on the handheld, so this needs to be mapped (perhaps) onto KOrganizer's priority levels.

void PilotTodoEntry::setPriority int  p  )  [inline]
 

Set the priority of the ToDo.

int PilotTodoEntry::getComplete  )  const [inline]
 

Return whether the ToDo is complete (done, finished) or not.

void PilotTodoEntry::setComplete int  c  )  [inline]
 

Set whether the ToDo is done.

QString PilotTodoEntry::getDescription  )  const
 

Get the ToDo item's description (which is the title shown on the handheld, and the item's Title in KDE).

This uses the default codec.

void PilotTodoEntry::setDescription const QString &   ) 
 

Set the ToDo item's description.

QString PilotTodoEntry::getNote  )  const
 

Get the ToDo item's note (the longer text, not immediately accessible on the handheld).

This uses the default codec.

void PilotTodoEntry::setNote const QString &  note  ) 
 

Set the ToDo item's note.

QString PilotTodoEntry::getCategoryLabel  )  const
 

Returns the label for the category this ToDo item is in.

bool PilotTodoEntry::setCategory const QString &  label  )  [inline]
 

If the label already exists, uses the id; if not, adds the label to the category list.

Returns:
false if category labels are full.

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