kpilot/lib

PilotDateEntry Class Reference

#include <pilotDateEntry.h>

Inheritance diagram for PilotDateEntry:

PilotRecordBase List of all members.

Detailed Description

This class is a wrapper for pilot-link's datebook entries (struct Appointment).

Definition at line 49 of file pilotDateEntry.h.


Public Member Functions

 PilotDateEntry (struct AppointmentAppInfo &appInfo)
 PilotDateEntry (struct AppointmentAppInfo &appInfo, PilotRecord *rec)
 PilotDateEntry (const PilotDateEntry &e)
 ~PilotDateEntry ()
PilotDateEntryoperator= (const PilotDateEntry &e)
QString getTextRepresentation (bool richText=false)
bool doesFloat () const
bool isEvent () const
void setFloats (bool f)
tm getEventStart () const
tm * getEventStart_p () const
void setEventStart (struct tm &start)
QDateTime dtStart () const
tm getEventEnd () const
tm * getEventEnd_p () const
void setEventEnd (struct tm &end)
QDateTime dtEnd () const
bool isAlarmEnabled () const
void setAlarmEnabled (bool b)
int getAdvance () const
void setAdvance (int advance)
int getAdvanceUnits () const
void setAdvanceUnits (int units)
unsigned int alarmLeadTime () const
QDateTime dtAlarm () const
repeatTypes getRepeatType () const
void setRepeatType (repeatTypes r)
int getRepeatForever () const
void setRepeatForever (int f=1)
tm getRepeatEnd () const
void setRepeatEnd (struct tm tm)
QDateTime dtRepeatEnd () const
int getRepeatFrequency () const
void setRepeatFrequency (int f)
DayOfMonthType getRepeatDay () const
void setRepeatDay (DayOfMonthType rd)
const int * getRepeatDays () const
void setRepeatDays (int *rd)
void setRepeatDays (QBitArray rba)
int getExceptionCount () const
void setExceptionCount (int e)
tm * getExceptions () const
void setExceptions (struct tm *e)
void setDescription (const QString &)
QString getDescription () const
void setNote (const QString &)
QString getNote () const
void setLocation (const QString &)
QString getLocation () const
bool isMultiDay () const
QString getCategoryLabel () const
bool setCategory (const QString &label)
PilotRecordpack () const
const AppointmentAppInfo & appInfo ()

Protected Member Functions

void setDescriptionP (const char *desc, int l=-1)
const char * getDescriptionP () const
void setNoteP (const char *note, int l=-1)
const char * getNoteP () const

Constructor & Destructor Documentation

PilotDateEntry::PilotDateEntry ( struct AppointmentAppInfo &  appInfo  ) 

Constructor.

Sets the appinfo structure and zeroes out the appointment.

Definition at line 42 of file pilotDateEntry.cc.

PilotDateEntry::PilotDateEntry ( struct AppointmentAppInfo &  appInfo,
PilotRecord rec 
)

Constructor.

Interprets the given record as an appointment.

Definition at line 49 of file pilotDateEntry.cc.

PilotDateEntry::PilotDateEntry ( const PilotDateEntry e  ) 

Copy constructor.

Definition at line 97 of file pilotDateEntry.cc.

PilotDateEntry::~PilotDateEntry (  )  [inline]

Destructor.

Definition at line 62 of file pilotDateEntry.h.


Member Function Documentation

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

Assignment operator.

Definition at line 114 of file pilotDateEntry.cc.

QString PilotDateEntry::getTextRepresentation ( bool  richText = false  ) 

Create a textual representation (human-readable) of this appointment.

If richText is true, then the text representation uses qt style tags as well.

Definition at line 144 of file pilotDateEntry.cc.

bool PilotDateEntry::doesFloat (  )  const [inline]

Is this appointment a "floating" appointment?

Floating appointments are those that have a day assigned, but no time in that day (birthday appointments are like that). You can think of these as "events", which don't have a time associated with them for a given day, as opposed to a regular "appointment", which does normally have a time associated with it.

Definition at line 84 of file pilotDateEntry.h.

bool PilotDateEntry::isEvent (  )  const [inline]

Is this a non-time-related event as opposed to an appointment that has a time associated with it?.

Definition at line 92 of file pilotDateEntry.h.

void PilotDateEntry::setFloats ( bool  f  )  [inline]

Sets this appointment's floating status.

Floating appointments are those that have a day assigned, but no time in that day (birthday appointments are like that). You can think of these as "events", which don't have a time associated with them for a given day, as opposed to a regular "appointment", which does normally have a time associated with it.

Definition at line 105 of file pilotDateEntry.h.

struct tm PilotDateEntry::getEventStart (  )  const [inline]

Get the start time of this appointment.

See dtStart() for caveats.

Definition at line 111 of file pilotDateEntry.h.

struct tm* PilotDateEntry::getEventStart_p (  )  const [inline]

Get a pointer to the start time of this appointment.

See dtStart() for caveats.

Definition at line 114 of file pilotDateEntry.h.

void PilotDateEntry::setEventStart ( struct tm &  start  )  [inline]

Sets the start time of this appointment.

Definition at line 120 of file pilotDateEntry.h.

QDateTime PilotDateEntry::dtStart (  )  const

Get the start time of this appointment.

For floating appointments, the time is undefined (perhaps 1 minute past midnight).

Floating appointments are those that have a day assigned, but no time in that day (birthday appointments are like that).

Definition at line 266 of file pilotDateEntry.cc.

struct tm PilotDateEntry::getEventEnd (  )  const [inline]

Get the end time of this appointment.

See dtEnd() for caveats.

Definition at line 134 of file pilotDateEntry.h.

struct tm* PilotDateEntry::getEventEnd_p (  )  const [inline]

Get a pointer to the end time of this appointment.

See dtEnd() for caveats.

Definition at line 140 of file pilotDateEntry.h.

void PilotDateEntry::setEventEnd ( struct tm &  end  )  [inline]

Set the end time of this appointment.

Definition at line 146 of file pilotDateEntry.h.

QDateTime PilotDateEntry::dtEnd (  )  const

Get the end time of this appointment.

For floating appointments, the time is undefined (perhaps 1 minute past midnight).

Floating appointments are those that have a day assigned, but no time in that day (birthday appointments are like that).

Definition at line 272 of file pilotDateEntry.cc.

bool PilotDateEntry::isAlarmEnabled (  )  const [inline]

Does this appointment have an alarm set? On the Pilot, an event may have an alarm (or not).

If it has one, it is also enabled and causes the Pilot to beep (or whatever is set in the system preferences).

Definition at line 163 of file pilotDateEntry.h.

void PilotDateEntry::setAlarmEnabled ( bool  b  )  [inline]

Set whether this appointment has an alarm.

Definition at line 169 of file pilotDateEntry.h.

int PilotDateEntry::getAdvance (  )  const [inline]

Get the numeric part of "alarm: __ (v) minutes" on the pilot -- you set the alarm time in two parts, a number and a unit type to use; unit types are minutes, hours, days and the number is whatever you like.

If alarms are not enabled for this appointment, returns garbage.

See also:
alarmLeadTime()

dtAlarm()

Definition at line 183 of file pilotDateEntry.h.

void PilotDateEntry::setAdvance ( int  advance  )  [inline]

Set the numeric part of the alarm setting.

See getAdvance for details.

Definition at line 189 of file pilotDateEntry.h.

int PilotDateEntry::getAdvanceUnits (  )  const [inline]

Returns the units part of the alarm time.

See getAdvance .

Definition at line 195 of file pilotDateEntry.h.

void PilotDateEntry::setAdvanceUnits ( int  units  )  [inline]

Sets the unites part of the alarm time.

See getAdvance .

Definition at line 201 of file pilotDateEntry.h.

unsigned int PilotDateEntry::alarmLeadTime (  )  const

Returns the number of seconds "lead time" the alarm should sound before the actual appointment.

This interprets the advance number and units. The value is always positive, 0 if no alarms are enabled.

Definition at line 284 of file pilotDateEntry.cc.

QDateTime PilotDateEntry::dtAlarm (  )  const [inline]

Returns the absolute date and time that the alarm should sound for this appointment.

Definition at line 215 of file pilotDateEntry.h.

QDateTime PilotDateEntry::dtRepeatEnd (  )  const

Returns the date and time that the repeat ends.

If there is no repeat, returns an invalid date and time.

Definition at line 278 of file pilotDateEntry.cc.

void PilotDateEntry::setDescription ( const QString &   ) 

Sets the description of the appointment.

This is the short string entered in the day view on the handheld, and it is called the summary in libkcal.

Definition at line 443 of file pilotDateEntry.cc.

QString PilotDateEntry::getDescription (  )  const

Gets the description of the appointment.

See setDescription for meaning.

Definition at line 457 of file pilotDateEntry.cc.

void PilotDateEntry::setNote ( const QString &   ) 

Sets the note for the appointment.

The note is the long text entry that is possible - but clumsy - on the handheld. It is called the description in libkcal.

Definition at line 389 of file pilotDateEntry.cc.

QString PilotDateEntry::getNote (  )  const

Gets the note for this appointment.

See setNote for meaning.

Definition at line 449 of file pilotDateEntry.cc.

void PilotDateEntry::setLocation ( const QString &   ) 

Sets the location for the appointment.

For now it will be placed within the notes on the handheld. It will be placed on one line and starts with: Location: {location}. Everything on that line will be counted as location. TODO: Make distinguish between handhelds that support the location field and the ones that don't. (Shouldn't this be done in the pilot-link lib?)

Definition at line 395 of file pilotDateEntry.cc.

QString PilotDateEntry::getLocation (  )  const

Gets the location for this appointment.

See setNote for meaning.

Definition at line 421 of file pilotDateEntry.cc.

const AppointmentAppInfo& PilotDateEntry::appInfo (  )  [inline]

Returns:
A reference to the appinfo block of the database holding this entry.

Definition at line 371 of file pilotDateEntry.h.


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