OPimRecord Class Reference

This is the base class for all PIM Records. More...

#include <opimrecord.h>

Inheritance diagram for OPimRecord:

[legend]Collaboration diagram for OPimRecord:


Public Member Functions
	OPimRecord (int uid=0)
	c'tor uid of 0 isEmpty uid of 1 will be assigned a new one
	~OPimRecord ()
	OPimRecord (const OPimRecord &rec)
	copy c'tor
OPimRecord &	operator= (const OPimRecord &)
	copy operator
QStringList	categoryNames (const QString &appname) const
	category names resolved
void	setCategoryNames (const QStringList &)
	set category names they will be resolved
void	addCategoryName (const QString &)
	addCategoryName adds a name to the internal category list
virtual bool	isEmpty () const
	if a Record isEmpty it's empty if it's 0
virtual QString	toRichText () const=0
	toRichText summary
virtual QString	toShortText () const=0
	a small one line summary
virtual QString	type () const=0
	the name of the Record
virtual bool	match (const QString &regexp) const
	matches the Records the regular expression?
int	lastHitField () const
	if implemented this function returns which item has been last hit by the match() function.
virtual QMap< int, QString >	toMap () const=0
	converts the internal structure to a map
QMap< QString, QString >	toExtraMap () const
	key value representation of extra items
void	setExtraMap (const QMap< QString, QString > &)
virtual QString	recordField (int) const=0
	the name for a recordField
OPimXRefManager &	xrefmanager ()
	returns a reference of the Cross Reference Manager Partner 'One' is THIS PIM RECORD! 'Two' is the Partner where we link to
virtual void	setUid (int uid)
	set the uid
virtual bool	loadFromStream (QDataStream &)
	some marshalling and de marshalling code saves the OPimRecord to and from a DataStream
virtual bool	saveToStream (QDataStream &stream) const
Static Public Member Functions
int	rtti ()
Protected Member Functions
void	setLastHitField (int lastHit) const
Qtopia::UidGen &	uidGen ()
Protected Attributes
int	m_lastHit

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

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=(), and OEvent::operator=().

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

category names resolved

Definition at line 37 of file opimrecord.cpp.
References Qtopia::Record::categories(), QArray::count(), Categories::label(), and Categories::load().
Referenced by OTodo::toRichText(), and OContact::toRichText().

void OPimRecord::setCategoryNames ( const QStringList & )

set category names they will be resolved

Definition at line 49 of file opimrecord.cpp.

void OPimRecord::addCategoryName ( const QString & )

addCategoryName adds a name to the internal category list

Definition at line 52 of file opimrecord.cpp.
References Categories::load().

bool OPimRecord::isEmpty ( ) const [virtual]

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

Definition at line 58 of file opimrecord.cpp.
Referenced by OEvent::fromMap().

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.

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().

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.

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

converts the internal structure to a map

Implemented in OContact, OEvent, and OTodo.

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

key value representation of extra items

Definition at line 177 of file opimrecord.cpp.
Referenced by ODateBookAccessBackend_SQL::add().

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

Definition at line 180 of file opimrecord.cpp.
Referenced by OContactAccessBackend_SQL::find().

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

the name for a recordField

Implemented in OContact, OEvent, and OTodo.

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.

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(), OTodoAccessXML::find(), OEvent::fromMap(), OTodoAccessXML::load(), loadFromStream(), OPimRecord(), and OContact::setUid().

int OPimRecord::rtti ( ) [static]

Reimplemented in OContact, OEvent, and OTodo.
Definition at line 88 of file opimrecord.cpp.
Referenced by OPimResolver::add(), and OPimAccessTemplate< T >::add().

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

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

Categories
Reimplemented in OEvent.
Definition at line 100 of file opimrecord.cpp.
References OPimXRefManager::add(), Qtopia::Record::setCategories(), OPimXRef::setPartner(), and setUid().

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

Reimplemented in OEvent.
Definition at line 127 of file opimrecord.cpp.
Referenced by OPimResolver::add().

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

Definition at line 171 of file opimrecord.cpp.
Referenced by match(), and OContact::match().

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

Implements Qtopia::Record.
Definition at line 82 of file opimrecord.cpp.
Referenced by OContact::OContact(), and setUid().

Member Data Documentation

int OPimRecord::m_lastHit [mutable, protected]

Definition at line 140 of file opimrecord.h.
Referenced by operator=(), and OPimRecord().

The documentation for this class was generated from the following files:

libopie PIM API Documentation

OPimRecord Class Reference

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation