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

OPimRecord Class Reference

#include </home/clem/local/src/opie/noncore/unsupported/libopie/pim/opimrecord.h>

Inheritance diagram for OPimRecord:

Inheritance graph
[legend]
Collaboration diagram for OPimRecord:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 OPimRecord (int uid=0)
 ~OPimRecord ()
 OPimRecord (const OPimRecord &rec)
OPimRecord & operator= (const OPimRecord &)
QStringList categoryNames (const QString &appname) const
void setCategoryNames (const QStringList &)
void addCategoryName (const QString &)
virtual bool isEmpty () const
virtual QString toRichText () const =0
virtual QString toShortText () const =0
virtual QString type () const =0
virtual bool match (const QString &regexp) const
int lastHitField () const
virtual QMap< int, QString > toMap () const =0
QMap< QString, QString > toExtraMap () const
void setExtraMap (const QMap< QString, QString > &)
virtual QString recordField (int) const =0
OPimXRefManager & xrefmanager ()
virtual void setUid (int uid)
virtual bool loadFromStream (QDataStream &)
virtual bool saveToStream (QDataStream &stream) const

Static Public Member Functions

static int rtti ()

Protected Member Functions

void setLastHitField (int lastHit) const
Qtopia::UidGen & uidGen ()

Protected Attributes

int m_lastHit

Private Member Functions

void flush (const OPimXRefPartner &, QDataStream &stream) const
OPimXRefPartner partner (QDataStream &)

Private Attributes

OPimRecordPrivate * d
OPimXRefManager m_xrefman

Static Private Attributes

static Qtopia::UidGen m_uidGen

Detailed Description

This is the base class for all PIM Records

Definition at line 23 of file opimrecord.h.

Constructor & Destructor Documentation

OPimRecord::OPimRecord (  int  uid = 0  ) 
 

c'tor uid of 0 isEmpty uid of 1 will be assigned a new one

Definition at line 11 of file opimrecord.cpp.

References m_lastHit, and setUid().

OPimRecord::~OPimRecord (   ) 
 

Definition at line 17 of file opimrecord.cpp.

OPimRecord::OPimRecord (  const OPimRecord &  rec  ) 
 

copy c'tor

Definition at line 19 of file opimrecord.cpp.

Member Function Documentation

void OPimRecord::addCategoryName (  const QString &   ) 
 

addCategoryName adds a name to the internal category list

Definition at line 52 of file opimrecord.cpp.

References categoryFileName(), and Categories::load().

QStringList OPimRecord::categoryNames (  const QString &  appname  )  const
 

category names resolved

Definition at line 37 of file opimrecord.cpp.

References Qtopia::Record::categories(), categoryFileName(), i, Categories::label(), list, and Categories::load().

Referenced by OTodo::toRichText(), OEvent::toRichText(), and OContact::toRichText().

void OPimRecord::flush (  const OPimXRefPartner &  ,
QDataStream &  stream
)  const [private]
 

Definition at line 150 of file opimrecord.cpp.

Referenced by saveToStream(), and Opie::OPimRecord::saveToStream().

bool OPimRecord::isEmpty (   )  const [virtual]
 

if a Record isEmpty it's empty if it's 0

Definition at line 58 of file opimrecord.cpp.

References Qtopia::Record::uid().

Referenced by OEvent::fromMap(), OEvent::toMap(), OTodo::toRichText(), OEvent::toRichText(), and OContact::toRichText().

int OPimRecord::lastHitField (   )  const
 

if implemented this function returns which item has been last hit by the match() function. or -1 if not implemented or no hit has occured

Definition at line 174 of file opimrecord.cpp.

References m_lastHit.

bool OPimRecord::loadFromStream (  QDataStream &   )  [virtual]
 

some marshalling and de marshalling code saves the OPimRecord to and from a DataStream

Reimplemented in OEvent.

Definition at line 100 of file opimrecord.cpp.

References OPimXRefManager::add(), i, m_xrefman, OPimXRef::One, partner(), Qtopia::Record::setCategories(), OPimXRef::setPartner(), setUid(), and OPimXRef::Two.

Referenced by OPimMainWindow::record().

virtual bool OPimRecord::match (  const QString &  regexp  )  const [inline, virtual]
 

matches the Records the regular expression?

Definition at line 83 of file opimrecord.h.

References Qtopia::Record::match(), and setLastHitField().

OPimRecord & OPimRecord::operator= (  const OPimRecord &   ) 
 

copy operator

Definition at line 25 of file opimrecord.cpp.

References m_lastHit, m_xrefman, and Qtopia::Record::operator=().

Referenced by OTodo::operator=(), OEvent::operator=(), Opie::OPimTodo::operator=(), and Opie::OPimEvent::operator=().

OPimXRefPartner OPimRecord::partner (  QDataStream &   )  [private]
 

Definition at line 155 of file opimrecord.cpp.

References i, OPimXRefPartner::setField(), OPimXRefPartner::setService(), OPimXRefPartner::setUid(), and str.

Referenced by loadFromStream(), and Opie::OPimRecord::loadFromStream().

virtual QString OPimRecord::recordField (  int   )  const [pure virtual]
 

the name for a recordField

Implemented in OContact, OEvent, and OTodo.

Referenced by Opie::OPimTodo::recordField().

int OPimRecord::rtti (   )  [static]
 

Reimplemented in OContact, OEvent, and OTodo.

Definition at line 88 of file opimrecord.cpp.

Referenced by OPimResolver::add().

bool OPimRecord::saveToStream (  QDataStream &  stream  )  const [virtual]
 

UIDs

Categories

Reimplemented in OEvent.

Definition at line 127 of file opimrecord.cpp.

References Qtopia::Record::categories(), flush(), i, OPimXRefManager::list(), m_xrefman, OPimXRef::One, OPimXRef::Two, and Qtopia::Record::uid().

Referenced by OPimResolver::add().

void OPimRecord::setCategoryNames (  const QStringList &   ) 
 

set category names they will be resolved

Definition at line 49 of file opimrecord.cpp.

void OPimRecord::setExtraMap (  const QMap< QString, QString > &   ) 
 

Definition at line 180 of file opimrecord.cpp.

References Qtopia::Record::customMap.

Referenced by OContactAccessBackend_SQL::find().

void OPimRecord::setLastHitField (  int  lastHit  )  const [protected]
 

Definition at line 171 of file opimrecord.cpp.

References m_lastHit.

Referenced by OTodo::match(), OEvent::match(), OContact::match(), and match().

void OPimRecord::setUid (  int  uid  )  [virtual]
 

set the uid

Reimplemented from Qtopia::Record.

Reimplemented in OContact.

Definition at line 76 of file opimrecord.cpp.

References Qtopia::Record::setUid(), and uidGen().

Referenced by eventByVObj(), ODateBookAccessBackend_XML::finalizeRecord(), OTodoAccessXML::find(), OEvent::fromMap(), OTodoAccessXML::load(), loadFromStream(), Opie::OPimRecord::loadFromStream(), OPimRecord(), ODateBookAccessBackend_XML::setField(), OContact::setUid(), Opie::OPimContact::setUid(), Datebook::MainWindow::slotNewFromTemplate(), and OTodoAccessXML::todo().

QMap< QString, QString > OPimRecord::toExtraMap (   )  const
 

key value representation of extra items

Definition at line 177 of file opimrecord.cpp.

References Qtopia::Record::customMap.

Referenced by ODateBookAccessBackend_SQL::add(), and OTodoAccessXML::toString().

virtual QMap<int, QString> OPimRecord::toMap (   )  const [pure virtual]
 

converts the internal structure to a map

Implemented in OContact, OEvent, and OTodo.

virtual QString OPimRecord::toRichText (   )  const [pure virtual]
 

toRichText summary

Implemented in OContact, OEvent, and OTodo.

virtual QString OPimRecord::toShortText (   )  const [pure virtual]
 

a small one line summary

Implemented in OContact, OEvent, and OTodo.

virtual QString OPimRecord::type (   )  const [pure virtual]
 

the name of the Record

Implemented in OContact, OEvent, and OTodo.

Qtopia::UidGen & OPimRecord::uidGen (   )  [protected, virtual]
 

Implements Qtopia::Record.

Definition at line 82 of file opimrecord.cpp.

References m_uidGen.

Referenced by OContact::OContact(), setUid(), and Opie::OPimRecord::setUid().

OPimXRefManager & OPimRecord::xrefmanager (   ) 
 

returns a reference of the Cross Reference Manager Partner 'One' is THIS PIM RECORD! 'Two' is the Partner where we link to

Definition at line 85 of file opimrecord.cpp.

References m_xrefman.

Member Data Documentation

OPimRecordPrivate* OPimRecord::d [private]
 

Reimplemented from Qtopia::Record.

Reimplemented in OContact, and OTodo.

Definition at line 146 of file opimrecord.h.

int OPimRecord::m_lastHit [mutable, protected]
 

Definition at line 140 of file opimrecord.h.

Referenced by lastHitField(), Opie::OPimRecord::lastHitField(), operator=(), Opie::OPimRecord::operator=(), OPimRecord(), setLastHitField(), and Opie::OPimRecord::setLastHitField().

Qtopia::UidGen OPimRecord::m_uidGen [static, private]
 

Referenced by uidGen(), and Opie::OPimRecord::uidGen().

OPimXRefManager OPimRecord::m_xrefman [private]
 

Definition at line 148 of file opimrecord.h.

Referenced by loadFromStream(), Opie::OPimRecord::loadFromStream(), operator=(), Opie::OPimRecord::operator=(), saveToStream(), Opie::OPimRecord::saveToStream(), xrefmanager(), and Opie::OPimRecord::xrefmanager().

The documentation for this class was generated from the following files:
Generated on Sat Nov 5 17:43:15 2005 for OPIE by  doxygen 1.4.2