Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages
Opie::OPimBase

Opie::OPimBase Struct Reference

#include </home/clem/local/src/opie/libopie2/opiepim/core/opimtemplatebase.h>

Inheritance diagram for Opie::OPimBase:

Inheritance graph
[legend]
List of all members.

Public Types

enum  QuerySettings {
  WildCards = 0x0001, IgnoreCase = 0x0002, RegExp = 0x0004, ExactMatch = 0x0008,
  MatchOne = 0x0010, DateDiff = 0x0020, DateYear = 0x0040, DateMonth = 0x0080,
  DateDay = 0x0100, LastItem = 0xffff
}
enum  SortOrderBase {
  SortSummary = 0, SortByCategory = 1, SortByDate = 2, SortCustom = 10,
  LastSortOrderBase = 0xffff
}
enum  SortFilterBase { FilterOff = 0, FilterCategory = 1, FilterCustom = 1024, LastSortFilterBase = 0xffffffff }

Public Member Functions

 OPimBase ()
virtual ~OPimBase ()
virtual int rtti () const =0
virtual OPimRecord * record () const =0
virtual OPimRecord * record (int uid) const =0
virtual bool add (const OPimRecord &)=0
virtual bool add (const OPimRecord *)=0
virtual bool remove (int uid)=0
virtual bool remove (const OPimRecord &)=0
virtual void clear ()=0
virtual bool load ()=0
virtual bool save ()=0
virtual QArray< UID > records () const =0
virtual UIDArray matchRegexpSimple (const QRegExp &r) const =0
virtual UIDArray queryByExampleSimple (const OPimRecord *, int settings, const QDateTime &d=QDateTime()) const =0
virtual UIDArray sortedSimple (const UIDArray &uid, bool ascending, int sortOrder, int sortFilter, int cat) const =0
virtual UIDArray sortedSimple (const UIDArray &uid, bool ascending, int sortOrder, int sortFilter, const QArray< UID > &cats) const =0
virtual UIDArray sortedSimple (bool ascending, int sortOrder, int sortFilter, int cat) const =0
virtual UIDArray sortedSimple (bool ascending, int sortOrder, int sortFilter, const QArray< UID > &cats) const =0
virtual OPimOccurrence::List occurrences (const QDate &start, const QDate &end) const =0
virtual OPimOccurrence::List occurrences (const QDateTime &dt) const =0

Protected Member Functions

OPimOccurrence::List convertOccurrenceFromBackend (const OPimBackendOccurrence::List &) const

Private Attributes

OPimBasePrivate * d

Detailed Description

This is the base class for all our Interfaces to the PIM Records. It is pointer based and can be used generically for all types of Records.

Definition at line 52 of file opimtemplatebase.h.

Member Enumeration Documentation

enum Opie::OPimBase::QuerySettings
 

Constants for query. Use this constants to set the query parameters. Note: query_IgnoreCase just make sense with one of the other attributes !

See also:
queryByExample()
Enumeration values:
WildCards  Use Wildcards
IgnoreCase  Ignore the Case
RegExp  Do a Regular Expression match
ExactMatch  It needs to exactly match
MatchOne  Only one Entry must match
DateDiff  Find all entries from today until given date
DateYear  The year matches
DateMonth  The month matches
DateDay  The day matches
LastItem  The last possible name matches

Definition at line 90 of file opimtemplatebase.h.

enum Opie::OPimBase::SortFilterBase
 

Sort a list of Items with the help of the sorted() function. The Item you provide in SortOrder will be used for sorting.

See also:
OPimAccessTemplate<>::sorted()
Enumeration values:
FilterOff  Do not filter anything.
FilterCategory  Use given Categories for filter
FilterCustom  The first available custom filter defined in the specialized frontends
LastSortFilterBase 

Definition at line 136 of file opimtemplatebase.h.

enum Opie::OPimBase::SortOrderBase
 

Common Attributes for the Sort Order

Enumeration values:
SortSummary  Sort by a Summary of the records
SortByCategory  Sort by Category
SortByDate  Sort by Date
SortCustom  The First available sort number for the OPimAccessTemplates
LastSortOrderBase  make this enum 16bit large

Definition at line 116 of file opimtemplatebase.h.

Constructor & Destructor Documentation

Opie::OPimBase::OPimBase (   ) 
 

Definition at line 46 of file opimtemplatebase.cpp.

Opie::OPimBase::~OPimBase (   )  [virtual]
 

Definition at line 47 of file opimtemplatebase.cpp.

Member Function Documentation

virtual bool Opie::OPimBase::add (  const OPimRecord *   )  [pure virtual]
 

Implemented in Opie::OPimAccessTemplate< T >, Opie::OPimAccessTemplate< OPimEvent >, Opie::OPimAccessTemplate< OPimContact >, and Opie::OPimAccessTemplate< OPimTodo >.

virtual bool Opie::OPimBase::add (  const OPimRecord &   )  [pure virtual]
 

Implemented in Opie::OPimAccessTemplate< T >, Opie::OPimAccessTemplate< OPimEvent >, Opie::OPimAccessTemplate< OPimContact >, and Opie::OPimAccessTemplate< OPimTodo >.

Referenced by Opie::OPimResolver::add().

virtual void Opie::OPimBase::clear (   )  [pure virtual]
 

Implemented in Opie::OPimAccessTemplate< T >, Opie::OPimAccessTemplate< OPimEvent >, Opie::OPimAccessTemplate< OPimContact >, and Opie::OPimAccessTemplate< OPimTodo >.

OPimOccurrence::List Opie::OPimBase::convertOccurrenceFromBackend (  const OPimBackendOccurrence::List &  lst  )  const [protected]
 

For internal use only.

Convert internal Occurrence representation to the external

Definition at line 53 of file opimtemplatebase.cpp.

References QDate::addDays(), QDateTime::addDays(), QValueList< T >::append(), Opie::OPimOccurrence::Data::backend, QValueList< T >::begin(), data, QDateTime::date(), QDateTime::daysTo(), end, QValueList< T >::end(), Opie::OPimBackendOccurrence::endDateTime(), Opie::OPimBackendOccurrence::isAllDay(), Opie::OPimBackendOccurrence::location(), Opie::OPimOccurrence::Data::location, Opie::OPimBackendOccurrence::note(), Opie::OPimOccurrence::Data::note, Opie::setPeriod(), Start, start, Opie::OPimBackendOccurrence::startDateTime(), Opie::OPimBackendOccurrence::summary(), Opie::OPimOccurrence::Data::summary, QDateTime::time(), Opie::OPimBackendOccurrence::uid(), and Opie::OPimOccurrence::Data::uid.

Referenced by Opie::OPimAccessTemplate< T >::occurrences().

virtual bool Opie::OPimBase::load (   )  [pure virtual]
 

Implemented in Opie::OPimAccessTemplate< T >, Opie::OPimAccessTemplate< OPimEvent >, Opie::OPimAccessTemplate< OPimContact >, and Opie::OPimAccessTemplate< OPimTodo >.

Referenced by Opie::OPimResolver::add().

virtual UIDArray Opie::OPimBase::matchRegexpSimple (  const QRegExp &  r  )  const [pure virtual]
 

Implemented in Opie::OPimAccessTemplate< T >, Opie::OPimAccessTemplate< OPimEvent >, Opie::OPimAccessTemplate< OPimContact >, and Opie::OPimAccessTemplate< OPimTodo >.

virtual OPimOccurrence::List Opie::OPimBase::occurrences (  const QDateTime &  dt  )  const [pure virtual]
 

Implemented in Opie::OPimAccessTemplate< T >, Opie::OPimAccessTemplate< OPimEvent >, Opie::OPimAccessTemplate< OPimContact >, and Opie::OPimAccessTemplate< OPimTodo >.

virtual OPimOccurrence::List Opie::OPimBase::occurrences (  const QDate &  start,
const QDate &  end
)  const [pure virtual]
 

Implemented in Opie::OPimAccessTemplate< T >, Opie::OPimAccessTemplate< OPimEvent >, Opie::OPimAccessTemplate< OPimContact >, and Opie::OPimAccessTemplate< OPimTodo >.

virtual UIDArray Opie::OPimBase::queryByExampleSimple (  const OPimRecord *  ,
int  settings,
const QDateTime &  d = QDateTime()
)  const [pure virtual]
 

Implemented in Opie::OPimAccessTemplate< T >, Opie::OPimAccessTemplate< OPimEvent >, Opie::OPimAccessTemplate< OPimContact >, and Opie::OPimAccessTemplate< OPimTodo >.

virtual OPimRecord* Opie::OPimBase::record (  int  uid  )  const [pure virtual]
 

Implemented in Opie::OTemplateBase< T >, Opie::OTemplateBase< OPimEvent >, Opie::OTemplateBase< OPimContact >, and Opie::OTemplateBase< OPimTodo >.

virtual OPimRecord* Opie::OPimBase::record (   )  const [pure virtual]
 

Implemented in Opie::OTemplateBase< T >, Opie::OTemplateBase< OPimEvent >, Opie::OTemplateBase< OPimContact >, and Opie::OTemplateBase< OPimTodo >.

Referenced by Opie::OPimOccurrence::internalToRecord(), Opie::OPimResolver::record(), and Opie::OPimOccurrence::record().

virtual QArray<UID> Opie::OPimBase::records (   )  const [pure virtual]
 

Implemented in Opie::OPimAccessTemplate< T >, Opie::OPimAccessTemplate< OPimEvent >, Opie::OPimAccessTemplate< OPimContact >, and Opie::OPimAccessTemplate< OPimTodo >.

Referenced by Converter::start_conversion().

virtual bool Opie::OPimBase::remove (  const OPimRecord &   )  [pure virtual]
 

Implemented in Opie::OPimAccessTemplate< T >, Opie::OPimAccessTemplate< OPimEvent >, Opie::OPimAccessTemplate< OPimContact >, and Opie::OPimAccessTemplate< OPimTodo >.

virtual bool Opie::OPimBase::remove (  int  uid  )  [pure virtual]
 

virtual int Opie::OPimBase::rtti (   )  const [pure virtual]
 

return the rtti

Implemented in Opie::OPimContactAccess, Opie::ODateBookAccess, and Opie::OPimTodoAccess.

Referenced by Opie::OPimAccessTemplate< T >::add().

virtual bool Opie::OPimBase::save (   )  [pure virtual]
 

Implemented in Opie::OPimContactAccess, Opie::OPimAccessTemplate< T >, Opie::OPimAccessTemplate< OPimEvent >, Opie::OPimAccessTemplate< OPimContact >, and Opie::OPimAccessTemplate< OPimTodo >.

Referenced by Opie::OPimResolver::add().

virtual UIDArray Opie::OPimBase::sortedSimple (  bool  ascending,
int  sortOrder,
int  sortFilter,
const QArray< UID > &  cats
)  const [pure virtual]
 

virtual UIDArray Opie::OPimBase::sortedSimple (  bool  ascending,
int  sortOrder,
int  sortFilter,
int  cat
)  const [pure virtual]
 

Implemented in Opie::OPimAccessTemplate< T >, Opie::OPimAccessTemplate< OPimEvent >, Opie::OPimAccessTemplate< OPimContact >, and Opie::OPimAccessTemplate< OPimTodo >.

virtual UIDArray Opie::OPimBase::sortedSimple (  const UIDArray &  uid,
bool  ascending,
int  sortOrder,
int  sortFilter,
const QArray< UID > &  cats
)  const [pure virtual]
 

virtual UIDArray Opie::OPimBase::sortedSimple (  const UIDArray &  uid,
bool  ascending,
int  sortOrder,
int  sortFilter,
int  cat
)  const [pure virtual]
 

Implemented in Opie::OPimAccessTemplate< T >, Opie::OPimAccessTemplate< OPimEvent >, Opie::OPimAccessTemplate< OPimContact >, and Opie::OPimAccessTemplate< OPimTodo >.

Member Data Documentation

OPimBasePrivate* Opie::OPimBase::d [private]
 

Reimplemented in Opie::OPimContactAccess, Opie::ODateBookAccess, Opie::OPimAccessTemplate< T >, Opie::OTemplateBase< T >, Opie::OPimTodoAccess, Opie::OPimAccessTemplate< OPimEvent >, Opie::OPimAccessTemplate< OPimContact >, Opie::OPimAccessTemplate< OPimTodo >, Opie::OTemplateBase< OPimEvent >, Opie::OTemplateBase< OPimContact >, and Opie::OTemplateBase< OPimTodo >.

Definition at line 164 of file opimtemplatebase.h.

The documentation for this struct was generated from the following files:
Generated on Sat Nov 5 18:00:02 2005 for OPIE by  doxygen 1.4.2