kpilot/lib

PilotTodoEntry Class Reference

#include <pilotTodoEntry.h>

Inheritance diagram for PilotTodoEntry:

PilotAppCategory PilotRecordBase List of all members.

Detailed Description

A decoded ToDo item.

Definition at line 48 of file pilotTodoEntry.h.


Public Member Functions

 PilotTodoEntry (struct ToDoAppInfo &appInfo)
 PilotTodoEntry (struct ToDoAppInfo &appInfo, PilotRecord *rec)
 PilotTodoEntry (const PilotTodoEntry &e)
 ~PilotTodoEntry ()
virtual QString getTextRepresentation (bool richText=false)
PilotTodoEntryoperator= (const PilotTodoEntry &e)
tm getDueDate () const
void setDueDate (struct tm &d)
int getIndefinite () const
void setIndefinite (int i)
int getPriority () const
void setPriority (int p)
int getComplete () const
void setComplete (int c)
QString getDescription () const
void setDescription (const QString &)
QString getNote () const
void setNote (const QString &note)
QString getCategoryLabel () const
bool setCategory (const QString &label)

Protected Member Functions

void * pack_ (void *buf, int *size)
void unpack (const void *buf, int size=0)
const char * getDescriptionP () const
void setDescriptionP (const char *, int len=-1)
const char * getNoteP () const
void setNoteP (const char *, int len=-1)

Constructor & Destructor Documentation

PilotTodoEntry::PilotTodoEntry struct ToDoAppInfo &  appInfo  ) 
 

Create an empty ToDo item.

Definition at line 45 of file pilotTodoEntry.cc.

PilotTodoEntry::PilotTodoEntry struct ToDoAppInfo &  appInfo,
PilotRecord rec
 

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

Definition at line 53 of file pilotTodoEntry.cc.

PilotTodoEntry::PilotTodoEntry const PilotTodoEntry e  ) 
 

Copy an existing ToDo item.

Definition at line 73 of file pilotTodoEntry.cc.

PilotTodoEntry::~PilotTodoEntry  )  [inline]
 

Delete a ToDo item.

Definition at line 58 of file pilotTodoEntry.h.


Member Function Documentation

QString PilotTodoEntry::getCategoryLabel  )  const
 

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

Definition at line 155 of file pilotTodoEntry.cc.

int PilotTodoEntry::getComplete  )  const [inline]
 

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

Definition at line 90 of file pilotTodoEntry.h.

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.

Definition at line 206 of file pilotTodoEntry.cc.

struct tm PilotTodoEntry::getDueDate  )  const [inline]
 

Accessor for the Due Date of the ToDo item.

Definition at line 69 of file pilotTodoEntry.h.

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.

Definition at line 77 of file pilotTodoEntry.h.

QString PilotTodoEntry::getNote  )  const
 

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

This uses the default codec.

Definition at line 239 of file pilotTodoEntry.cc.

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.

Definition at line 85 of file pilotTodoEntry.h.

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.

Reimplemented from PilotAppCategory.

Definition at line 107 of file pilotTodoEntry.cc.

PilotTodoEntry & PilotTodoEntry::operator= const PilotTodoEntry e  ) 
 

Assign an existing ToDo item to this one.

Definition at line 87 of file pilotTodoEntry.cc.

void * PilotTodoEntry::pack_ void *  buf,
int *  size
[protected, virtual]
 

Pack whatever data the interpreted record holds into the given buffer, of length size; return NULL to indicate failure, otherwise buf.

Set size to the actual size of data returned. (all of this is dictated by the pilot-link interfaces).

Subclasses must reimplement this to give a specific meaning to the binary blob.

Parameters:
buf Data buffer containing the blob.
size Size of the buffer (in bytes). As input, the maximum size of the buffer. As output, the number of bytes used.

Implements PilotAppCategory.

Definition at line 160 of file pilotTodoEntry.cc.

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.

Definition at line 115 of file pilotTodoEntry.h.

void PilotTodoEntry::setComplete int  c  )  [inline]
 

Set whether the ToDo is done.

Definition at line 92 of file pilotTodoEntry.h.

void PilotTodoEntry::setDescription const QString &   ) 
 

Set the ToDo item's description.

Definition at line 176 of file pilotTodoEntry.cc.

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

Set the Due Date for the ToDo item.

Definition at line 71 of file pilotTodoEntry.h.

void PilotTodoEntry::setIndefinite int  i  )  [inline]
 

Set whether the ToDo is indefinite or not.

Definition at line 79 of file pilotTodoEntry.h.

void PilotTodoEntry::setNote const QString &  note  ) 
 

Set the ToDo item's note.

Definition at line 211 of file pilotTodoEntry.cc.

void PilotTodoEntry::setPriority int  p  )  [inline]
 

Set the priority of the ToDo.

Definition at line 87 of file pilotTodoEntry.h.

void PilotTodoEntry::unpack const void *  buf,
int  size = 0
[inline, protected, virtual]
 

Unpack the binary blob buf of size size into some structure with meaning.

Implements PilotAppCategory.

Definition at line 121 of file pilotTodoEntry.h.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys