• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • kdepim
  • Sitemap
  • Contact Us
 

kpilot

PilotTodoEntry Class Reference

#include <pilotTodoEntry.h>

Inheritance diagram for PilotTodoEntry:

Inheritance graph
[legend]

List of all members.


Detailed Description

A decoded ToDo item.

Definition at line 49 of file pilotTodoEntry.h.


Public Member Functions

QString getCategoryLabel () const
int getComplete () const
QString getDescription () const
struct tm getDueDate () const
int getIndefinite () const
QString getNote () const
int getPriority () const
QString getTextRepresentation (Qt::TextFormat richText) const
PilotTodoEntry & operator= (const PilotTodoEntry &e)
PilotRecord * pack () const
 PilotTodoEntry (const PilotTodoEntry &e)
 PilotTodoEntry (PilotRecord *rec)
 PilotTodoEntry ()
void setComplete (int c)
void setDescription (const QString &)
void setDueDate (struct tm &d)
void setIndefinite (int i)
void setNote (const QString &note)
void setPriority (int p)
 ~PilotTodoEntry ()

Protected Member Functions

const char * getDescriptionP () const
const char * getNoteP () const
void setDescriptionP (const char *, int len=-1)
void setNoteP (const char *, int len=-1)

Constructor & Destructor Documentation

PilotTodoEntry::PilotTodoEntry (  ) 

Create an empty ToDo item.

All attributes are 0.

Definition at line 39 of file pilotTodoEntry.cc.

PilotTodoEntry::PilotTodoEntry ( PilotRecord *  rec  ) 

Constructor.

Create a ToDo item and fill it with data from the uninterpreted record rec. The record may be NULL, in which case the todo is empty and its category and ID are zero, as in the constructor above.

Definition at line 47 of file pilotTodoEntry.cc.

PilotTodoEntry::PilotTodoEntry ( const PilotTodoEntry &  e  ) 

Copy an existing ToDo item.

Definition at line 75 of file pilotTodoEntry.cc.

PilotTodoEntry::~PilotTodoEntry (  )  [inline]

Delete a ToDo item.

Definition at line 67 of file pilotTodoEntry.h.


Member Function Documentation

QString PilotTodoEntry::getCategoryLabel (  )  const

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

int PilotTodoEntry::getComplete (  )  const [inline]

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

Definition at line 120 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 219 of file pilotTodoEntry.cc.

const char* PilotTodoEntry::getDescriptionP (  )  const [inline, protected]

Definition at line 152 of file pilotTodoEntry.h.

struct tm PilotTodoEntry::getDueDate (  )  const [inline, read]

Accessor for the Due Date of the ToDo item.

Definition at line 81 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 93 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 264 of file pilotTodoEntry.cc.

const char* PilotTodoEntry::getNoteP (  )  const [inline, protected]

Definition at line 154 of file pilotTodoEntry.h.

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 108 of file pilotTodoEntry.h.

QString PilotTodoEntry::getTextRepresentation ( Qt::TextFormat  richText  )  const

Return a string for the ToDo item.

If

Parameters:
richText is Qt::RichText, then use qt style markup to make the string clearer when displayed.

Definition at line 113 of file pilotTodoEntry.cc.

PilotTodoEntry & PilotTodoEntry::operator= ( const PilotTodoEntry &  e  ) 

Assign an existing ToDo item to this one.

Definition at line 91 of file pilotTodoEntry.cc.

PilotRecord * PilotTodoEntry::pack (  )  const

Definition at line 165 of file pilotTodoEntry.cc.

void PilotTodoEntry::setComplete ( int  c  )  [inline]

Set whether the ToDo is done.

Definition at line 126 of file pilotTodoEntry.h.

void PilotTodoEntry::setDescription ( const QString &  desc  ) 

Set the ToDo item's description.

Definition at line 179 of file pilotTodoEntry.cc.

void PilotTodoEntry::setDescriptionP ( const char *  desc,
int  len = -1 
) [protected]

Definition at line 191 of file pilotTodoEntry.cc.

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

Set the Due Date for the ToDo item.

Definition at line 84 of file pilotTodoEntry.h.

void PilotTodoEntry::setIndefinite ( int  i  )  [inline]

Set whether the ToDo is indefinite or not.

Definition at line 99 of file pilotTodoEntry.h.

void PilotTodoEntry::setNote ( const QString &  note  ) 

Set the ToDo item's note.

Definition at line 224 of file pilotTodoEntry.cc.

void PilotTodoEntry::setNoteP ( const char *  note,
int  len = -1 
) [protected]

Definition at line 236 of file pilotTodoEntry.cc.

void PilotTodoEntry::setPriority ( int  p  )  [inline]

Set the priority of the ToDo.

Definition at line 114 of file pilotTodoEntry.h.


The documentation for this class was generated from the following files:
  • pilotTodoEntry.h
  • pilotTodoEntry.cc

kpilot

Skip menu "kpilot"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdepim

Skip menu "kdepim"
  • akonadi
  •   clients
  •   kabc
  •   kcal
  •   kcm
  • akregator
  • console
  •   kabcclient
  •   konsolekalendar
  • kaddressbook
  • kalarm
  •   lib
  • kdgantt
  • kdgantt1
  • kjots
  • kleopatra
  • kmail
  • kmobiletools
  • knode
  • knotes
  • kontact
  • kontactinterfaces
  • korganizer
  •   korgac
  • kpilot
  • ktimetracker
  • libkdepim
  • libkholidays
  • libkleo
  • libkpgp
  • maildir
Generated for kdepim by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal