libopie PIM API Documentation

ORecur Class Reference

Class to handle Recurrencies.. More...

#include <orecur.h>

List of all members.

Public Types

typedef QValueList< QDateExceptionList
enum  RepeatType {
  NoRepeat = -1, Daily, Weekly, MonthlyDay,
  MonthlyDate, Yearly
}
enum  Days {
  MON = 0x01, TUE = 0x02, WED = 0x04, THU = 0x08,
  FRI = 0x10, SAT = 0x20, SUN = 0x40
}
enum  Fields {
  RType = 0, RWeekdays, RPosition, RFreq,
  RHasEndDate, EndDate, Created, Exceptions
}

Public Member Functions

 ORecur ()
 ORecur (const QMap< int, QString > &map)
 ORecur (const ORecur &)
 ~ORecur ()
ORecuroperator= (const ORecur &)
bool operator== (const ORecur &) const
bool doesRecur () const
bool doesRecur (const QDate &)
RepeatType type () const
int frequency () const
int position () const
char days () const
bool hasEndDate () const
QDate start () const
QDate endDate () const
QDateTime createdDateTime () const
bool repeatOnWeekDay (int day) const
 starting on monday=0, sunday=6 for convience

bool nextOcurrence (const QDate &FromWhereToStart, QDate &recurDate)
 FromWhereToStart is not included!!!

QString service () const
 The module this ORecur belongs to.

ExceptionListexceptions ()
int repetition () const
 the current repetition

void setType (const RepeatType &)
void setFrequency (int freq)
void setPosition (int pos)
void setDays (char c)
void setEndDate (const QDate &dt)
void setStart (const QDate &dt)
void setCreatedDateTime (const QDateTime &)
void setHasEndDate (bool b)
void setRepitition (int)
void setService (const QString &ser)
QMap< int, QStringtoMap () const
void fromMap (const QMap< int, QString > &map)
QString toString () const


Detailed Description

Class to handle Recurrencies..

Definition at line 19 of file orecur.h.


Member Typedef Documentation

typedef QValueList<QDate> ORecur::ExceptionList
 

Definition at line 21 of file orecur.h.

Referenced by exceptions(), and toMap().


Member Enumeration Documentation

enum ORecur::RepeatType
 

Enumeration values:
NoRepeat 
Daily 
Weekly 
MonthlyDay 
MonthlyDate 
Yearly 

Definition at line 22 of file orecur.h.

Referenced by type().

enum ORecur::Days
 

Enumeration values:
MON 
TUE 
WED 
THU 
FRI 
SAT 
SUN 

Definition at line 24 of file orecur.h.

enum ORecur::Fields
 

Enumeration values:
RType 
RWeekdays 
RPosition 
RFreq 
RHasEndDate 
EndDate 
Created 
Exceptions 

Definition at line 26 of file orecur.h.


Constructor & Destructor Documentation

ORecur::ORecur  ) 
 

Definition at line 34 of file orecur.cpp.

Referenced by ORecur().

ORecur::ORecur const QMap< int, QString > &  map  ) 
 

Definition at line 38 of file orecur.cpp.

References fromMap(), and ORecur().

ORecur::ORecur const ORecur  ) 
 

Definition at line 45 of file orecur.cpp.

ORecur::~ORecur  ) 
 

Definition at line 50 of file orecur.cpp.


Member Function Documentation

ORecur & ORecur::operator= const ORecur  ) 
 

Definition at line 65 of file orecur.cpp.

References data.

bool ORecur::operator== const ORecur  )  const
 

Definition at line 62 of file orecur.cpp.

bool ORecur::doesRecur  )  const
 

Definition at line 74 of file orecur.cpp.

Referenced by OTodoAccessXML::load().

bool ORecur::doesRecur const QDate  ) 
 

Definition at line 81 of file orecur.cpp.

References QDate::addDays(), and nextOcurrence().

ORecur::RepeatType ORecur::type  )  const
 

Definition at line 374 of file orecur.cpp.

References RepeatType.

Referenced by fromMap().

int ORecur::frequency  )  const
 

Definition at line 377 of file orecur.cpp.

int ORecur::position  )  const
 

Definition at line 380 of file orecur.cpp.

char ORecur::days  )  const
 

Definition at line 383 of file orecur.cpp.

Referenced by fromMap().

bool ORecur::hasEndDate  )  const
 

Definition at line 386 of file orecur.cpp.

Referenced by repeat().

QDate ORecur::start  )  const
 

Definition at line 392 of file orecur.cpp.

QDate ORecur::endDate  )  const
 

Definition at line 389 of file orecur.cpp.

Referenced by repeat().

QDateTime ORecur::createdDateTime  )  const
 

Definition at line 395 of file orecur.cpp.

bool ORecur::repeatOnWeekDay int  day  )  const
 

starting on monday=0, sunday=6 for convience

bool ORecur::nextOcurrence const QDate FromWhereToStart,
QDate recurDate
 

FromWhereToStart is not included!!!

Definition at line 94 of file orecur.cpp.

References QDate::addDays().

Referenced by doesRecur(), and repeat().

QString ORecur::service  )  const
 

The module this ORecur belongs to.

Definition at line 401 of file orecur.cpp.

ORecur::ExceptionList & ORecur::exceptions  ) 
 

Definition at line 404 of file orecur.cpp.

References ExceptionList.

int ORecur::repetition  )  const
 

the current repetition

Definition at line 398 of file orecur.cpp.

void ORecur::setType const RepeatType  ) 
 

Definition at line 407 of file orecur.cpp.

void ORecur::setFrequency int  freq  ) 
 

Definition at line 411 of file orecur.cpp.

void ORecur::setPosition int  pos  ) 
 

Definition at line 415 of file orecur.cpp.

void ORecur::setDays char  c  ) 
 

Definition at line 419 of file orecur.cpp.

void ORecur::setEndDate const QDate dt  ) 
 

Definition at line 423 of file orecur.cpp.

Referenced by OTodoAccessXML::load(), and repeat().

void ORecur::setStart const QDate dt  ) 
 

Definition at line 443 of file orecur.cpp.

Referenced by OTodoAccessXML::load().

void ORecur::setCreatedDateTime const QDateTime  ) 
 

Definition at line 427 of file orecur.cpp.

void ORecur::setHasEndDate bool  b  ) 
 

Definition at line 431 of file orecur.cpp.

Referenced by repeat().

void ORecur::setRepitition int   ) 
 

Definition at line 435 of file orecur.cpp.

void ORecur::setService const QString ser  ) 
 

Definition at line 439 of file orecur.cpp.

QMap< int, QString > ORecur::toMap  )  const
 

Definition at line 536 of file orecur.cpp.

References QValueList::begin(), Created, QDate::day(), QValueList::end(), EndDate, ExceptionList, Exceptions, QMap::insert(), QDate::month(), RFreq, RHasEndDate, RPosition, RType, RWeekdays, QString::sprintf(), and QDate::year().

Referenced by OEvent::toMap().

void ORecur::fromMap const QMap< int, QString > &  map  ) 
 

Definition at line 568 of file orecur.cpp.

References Created, QDateTime::date(), days(), EndDate, Exceptions, OTimeZone::fromUTCDateTime(), RFreq, RHasEndDate, RPosition, RType, RWeekdays, QStringList::split(), type(), and OTimeZone::utc().

Referenced by ORecur().

QString ORecur::toString  )  const
 

Definition at line 465 of file orecur.cpp.

References Created, EndDate, Exceptions, RFreq, RHasEndDate, RPosition, RType, and RWeekdays.

Referenced by save().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for OPIE Version 1.1.
Documentation copyright © 1997-2003 the KDE developers. 2003 OPIE developers
Generated on Tue Feb 10 20:26:25 2004 by doxygen 1.3.5 written by Dimitri van Heesch, © 1997-2001