From 6f610544d3db6198c90105b70fab1cc84f5a1fbd Mon Sep 17 00:00:00 2001 From: zecke Date: Sun, 13 Apr 2003 18:07:10 +0000 Subject: More API doc QString -> const QString& QString = 0l -> QString::null --- (limited to 'libopie') diff --git a/libopie/pim/obackendfactory.h b/libopie/pim/obackendfactory.h index 3a73210..ad6cf5a 100644 --- a/libopie/pim/obackendfactory.h +++ b/libopie/pim/obackendfactory.h @@ -16,6 +16,11 @@ * ===================================================================== * History: * $Log$ + * Revision 1.6 2003/04/13 18:07:10 zecke + * More API doc + * QString -> const QString& + * QString = 0l -> QString::null + * * Revision 1.5 2003/02/21 23:31:52 zecke * Add XML datebookresource * -clean up todoaccessxml header @@ -63,7 +68,21 @@ #include "otodoaccesssql.h" #endif - +/** + * This class is our factory. It will give us the default implementations + * of at least Todolist, Contacts and Datebook. In the future this class will + * allow users to switch the backend with ( XML->SQLite ) without the need + * to recompile.# + * This class as the whole PIM Api is making use of templates + * + * 
+ *   OTodoAccessBackend* backend = OBackEndFactory::Default("todo", QString::null );
+ *   backend->load();
+ *
+ * + * @author Stefan Eilers + * @version 0.1 + */ template class OBackendFactory { @@ -76,6 +95,11 @@ class OBackendFactory DATE }; + /** + * Returns a backend implementation for backendName + * @param backendName the type of the backend + * @param appName will be passed on to the backend + */ static T* Default( const QString backendName, const QString& appName ){ // __asm__("int3"); diff --git a/libopie/pim/ocontact.h b/libopie/pim/ocontact.h index 1fd1c75..25fa0e7 100644 --- a/libopie/pim/ocontact.h +++ b/libopie/pim/ocontact.h @@ -34,8 +34,15 @@ QPC_TEMPLATEEXTERN template class QPC_EXPORT QMap; // MOC_SKIP_END #endif -class ContactPrivate; - +class ContactPrivate; + +/** + * OContact class represents a specialised PIM Record for contacts. + * It does store all kind of persopn related information. + * + * @short Contact Container + * @author TT, Stefan Eiler, Holger Freyther + */ class QPC_EXPORT OContact : public OPimRecord { friend class DataSet; diff --git a/libopie/pim/ocontactaccess.h b/libopie/pim/ocontactaccess.h index 32b2dcb..d7ceaf2 100644 --- a/libopie/pim/ocontactaccess.h +++ b/libopie/pim/ocontactaccess.h @@ -17,6 +17,11 @@ * ===================================================================== * History: * $Log$ + * Revision 1.7 2003/04/13 18:07:10 zecke + * More API doc + * QString -> const QString& + * QString = 0l -> QString::null + * * Revision 1.6 2003/01/02 14:27:12 eilers * Improved query by example: Search by date is possible.. First step * for a today plugin for birthdays.. @@ -55,9 +60,13 @@ #include "ocontactaccessbackend.h" #include "opimaccesstemplate.h" -/** Class to access the contacts database. +/** + * Class to access the contacts database. * This is just a frontend for the real database handling which is * done by the backend. + * This class is used to access the Contacts on a system. This class as any OPIE PIM + * class is backend independent. + * @see OPimAccessTemplate */ class OContactAccess: public QObject, public OPimAccessTemplate @@ -65,7 +74,8 @@ class OContactAccess: public QObject, public OPimAccessTemplate Q_OBJECT public: - /** Create Database with contacts (addressbook). + /** + * Create Database with contacts (addressbook). * @param appname Name of application which wants access to the database * (i.e. "todolist") * @param filename The name of the database file. If not set, the default one @@ -99,7 +109,7 @@ class OContactAccess: public QObject, public OPimAccessTemplate DateDay = 0x0100, // The day matches }; - + ORecordList matchRegexp( const QRegExp &r )const; /** Return all Contacts in a sorted manner. diff --git a/libopie/pim/ocontactaccessbackend.h b/libopie/pim/ocontactaccessbackend.h index 821f5bf..ebeb42d 100644 --- a/libopie/pim/ocontactaccessbackend.h +++ b/libopie/pim/ocontactaccessbackend.h @@ -19,6 +19,11 @@ * ===================================================================== * History: * $Log$ + * Revision 1.5 2003/04/13 18:07:10 zecke + * More API doc + * QString -> const QString& + * QString = 0l -> QString::null + * * Revision 1.4 2002/11/13 14:14:51 eilers * Added sorted for Contacts.. * @@ -44,15 +49,26 @@ #include "ocontact.h" #include "opimaccessbackend.h" -#include "qregexp.h" +#include +/** + * This class represents the interface of all Contact Backends. + * Derivates of this class will be used to access the contacts. + * As implementation currently XML and vCard exist. This class needs to be implemented + * if you want to provide your own storage. + * In all queries a list of uids is passed on instead of loading the actual record! + * + * @see OContactAccessBackend_VCard + * @see OContactAccessBackend_XML + */ class OContactAccessBackend: public OPimAccessBackend { public: OContactAccessBackend() {} virtual ~OContactAccessBackend() {} - /** Return if database was changed externally. + /** + * Return if database was changed externally. * This may just make sense on file based databases like a XML-File. * It is used to prevent to overwrite the current database content * if the file was already changed by something else ! @@ -68,18 +84,24 @@ class OContactAccessBackend: public OPimAccessBackend { virtual QArray matchRegexp( const QRegExp &r ) const = 0; - /** Return all possible settings. + /** + * Return all possible settings. * @return All settings provided by the current backend * (i.e.: query_WildCards & query_IgnoreCase) */ virtual const uint querySettings() = 0; - /** Check whether settings are correct. + /** + * Check whether settings are correct. * @return true if the given settings are correct and possible. */ virtual bool hasQuerySettings (uint querySettings) const = 0; - virtual QArray sorted( bool ascending, int sortOrder, int sortFilter, int cat ) = 0; + /** + * FIXME!!! + * Returns a sorted list of records either ascendinf or descending for a giving criteria and category + */ + virtual QArray sorted( bool ascending, int sortOrder, int sortFilter, int cat ) = 0; }; #endif diff --git a/libopie/pim/ocontactaccessbackend_vcard.cpp b/libopie/pim/ocontactaccessbackend_vcard.cpp index f24523f..270bef3 100644 --- a/libopie/pim/ocontactaccessbackend_vcard.cpp +++ b/libopie/pim/ocontactaccessbackend_vcard.cpp @@ -17,6 +17,11 @@ * ===================================================================== * History: * $Log$ + * Revision 1.10 2003/04/13 18:07:10 zecke + * More API doc + * QString -> const QString& + * QString = 0l -> QString::null + * * Revision 1.9 2003/03/21 10:33:09 eilers * Merged speed optimized xml backend for contacts to main. * Added QDateTime to querybyexample. For instance, it is now possible to get @@ -76,7 +81,7 @@ #include -OContactAccessBackend_VCard::OContactAccessBackend_VCard ( QString , QString filename ): +OContactAccessBackend_VCard::OContactAccessBackend_VCard ( const QString& , const QString& filename ): m_dirty( false ), m_file( filename ) { diff --git a/libopie/pim/ocontactaccessbackend_vcard.h b/libopie/pim/ocontactaccessbackend_vcard.h index 93e2da3..712d769 100644 --- a/libopie/pim/ocontactaccessbackend_vcard.h +++ b/libopie/pim/ocontactaccessbackend_vcard.h @@ -17,6 +17,11 @@ * ===================================================================== * History: * $Log$ + * Revision 1.6 2003/04/13 18:07:10 zecke + * More API doc + * QString -> const QString& + * QString = 0l -> QString::null + * * Revision 1.5 2003/03/21 10:33:09 eilers * Merged speed optimized xml backend for contacts to main. * Added QDateTime to querybyexample. For instance, it is now possible to get @@ -47,9 +52,14 @@ class VObject; +/** + * This is the vCard 2.1 implementation of the Contact Storage + * @see OContactAccessBackend_XML + * @see OPimAccessBackend + */ class OContactAccessBackend_VCard : public OContactAccessBackend { public: - OContactAccessBackend_VCard ( QString appname, QString filename = 0l ); + OContactAccessBackend_VCard ( const QString& appname, const QString& filename = QString::null ); bool load (); bool reload(); @@ -59,7 +69,7 @@ class OContactAccessBackend_VCard : public OContactAccessBackend { bool add ( const OContact& newcontact ); bool remove ( int uid ); bool replace ( const OContact& contact ); - + OContact find ( int uid ) const; QArray allRecords() const; QArray queryByExample ( const OContact &query, int settings, const QDateTime& d = QDateTime() ); @@ -69,7 +79,7 @@ class OContactAccessBackend_VCard : public OContactAccessBackend { bool hasQuerySettings (uint querySettings) const; QArray sorted( bool ascending, int sortOrder, int sortFilter, int cat ); bool wasChangedExternally(); - + private: OContact parseVObject( VObject* obj ); VObject* createVObject( const OContact& c ); @@ -77,7 +87,7 @@ private: QDate convVCardDateToDate( const QString& datestr ); VObject *safeAddPropValue( VObject *o, const char* prop, const QString& value ); VObject *safeAddProp( VObject* o, const char* prop); - + bool m_dirty : 1; QString m_file; QMap m_map; diff --git a/libopie/pim/ocontactaccessbackend_xml.cpp b/libopie/pim/ocontactaccessbackend_xml.cpp index c5a7820..661cd51 100644 --- a/libopie/pim/ocontactaccessbackend_xml.cpp +++ b/libopie/pim/ocontactaccessbackend_xml.cpp @@ -17,6 +17,11 @@ * ===================================================================== * History: * $Log$ + * Revision 1.5 2003/04/13 18:07:10 zecke + * More API doc + * QString -> const QString& + * QString = 0l -> QString::null + * * Revision 1.4 2003/03/21 14:32:54 mickeyl * g++ compliance fix: default arguments belong into the declaration, but not the definition * @@ -93,7 +98,7 @@ #include #include #include -#include +#include #include @@ -107,7 +112,7 @@ using namespace Opie; -OContactAccessBackend_XML::OContactAccessBackend_XML ( QString appname, QString filename ): +OContactAccessBackend_XML::OContactAccessBackend_XML ( const QString& appname, const QString& filename ): m_changed( false ) { // Just m_contactlist should call delete if an entry @@ -116,32 +121,32 @@ OContactAccessBackend_XML::OContactAccessBackend_XML ( QString appname, QString m_uidToContact.setAutoDelete( false ); m_appName = appname; - + /* Set journalfile name ... */ m_journalName = getenv("HOME"); m_journalName +="/.abjournal" + appname; - + /* Expecting to access the default filename if nothing else is set */ if ( filename.isEmpty() ){ m_fileName = Global::applicationFileName( "addressbook","addressbook.xml" ); } else m_fileName = filename; - + /* Load Database now */ load (); } -bool OContactAccessBackend_XML::save() +bool OContactAccessBackend_XML::save() { - + if ( !m_changed ) return true; - + QString strNewFile = m_fileName + ".new"; QFile f( strNewFile ); if ( !f.open( IO_WriteOnly|IO_Raw ) ) return false; - + int total_written; int idx_offset = 0; QString out; @@ -174,7 +179,7 @@ bool OContactAccessBackend_XML::save() out = ""; } out += " \n\n"; - + // Write Footer cstr = out.utf8(); total_written = f.writeBlock( cstr.data(), cstr.length() ); @@ -184,7 +189,7 @@ bool OContactAccessBackend_XML::save() return false; } f.close(); - + // move the file over, I'm just going to use the system call // because, I don't feel like using QDir. if ( ::rename( strNewFile.latin1(), m_fileName.latin1() ) < 0 ) { @@ -193,19 +198,19 @@ bool OContactAccessBackend_XML::save() // remove the tmp file... QFile::remove( strNewFile ); } - + /* The journalfile should be removed now... */ removeJournal(); - + m_changed = false; return true; } -bool OContactAccessBackend_XML::load () +bool OContactAccessBackend_XML::load () { m_contactList.clear(); m_uidToContact.clear(); - + /* Load XML-File and journal if it exists */ if ( !load ( m_fileName, false ) ) return false; @@ -216,11 +221,11 @@ bool OContactAccessBackend_XML::load () * crash happened... */ load (m_journalName, true); - + return true; } -void OContactAccessBackend_XML::clear () +void OContactAccessBackend_XML::clear () { m_contactList.clear(); m_uidToContact.clear(); @@ -231,46 +236,46 @@ void OContactAccessBackend_XML::clear () bool OContactAccessBackend_XML::wasChangedExternally() { QFileInfo fi( m_fileName ); - + QDateTime lastmod = fi.lastModified (); - + return (lastmod != m_readtime); } -QArray OContactAccessBackend_XML::allRecords() const +QArray OContactAccessBackend_XML::allRecords() const { QArray uid_list( m_contactList.count() ); - - uint counter = 0; + + uint counter = 0; QListIterator it( m_contactList ); for( ; it.current(); ++it ){ uid_list[counter++] = (*it)->uid(); } - + return ( uid_list ); } OContact OContactAccessBackend_XML::find ( int uid ) const { OContact foundContact; //Create empty contact - + OContact* found = m_uidToContact.find( QString().setNum( uid ) ); if ( found ){ foundContact = *found; } - + return ( foundContact ); } -QArray OContactAccessBackend_XML::queryByExample ( const OContact &query, int settings, +QArray OContactAccessBackend_XML::queryByExample ( const OContact &query, int settings, const QDateTime& d ) { - + QArray m_currentQuery( m_contactList.count() ); QListIterator it( m_contactList ); uint arraycounter = 0; - + for( ; it.current(); ++it ){ /* Search all fields and compare them with query object. Store them into list * if all fields matches. @@ -290,26 +295,26 @@ QArray OContactAccessBackend_XML::queryByExample ( const OContact &query, i queryDate = new QDate( query.anniversary() ); checkDate = new QDate( (*it)->anniversary() ); } - + if ( queryDate->isValid() ){ if( checkDate->isValid() ){ if ( settings & OContactAccess::DateYear ){ if ( queryDate->year() != checkDate->year() ) allcorrect = false; - } + } if ( settings & OContactAccess::DateMonth ){ if ( queryDate->month() != checkDate->month() ) allcorrect = false; - } + } if ( settings & OContactAccess::DateDay ){ if ( queryDate->day() != checkDate->day() ) allcorrect = false; - } + } if ( settings & OContactAccess::DateDiff ) { QDate current; // If we get an additional date, we // will take this date instead of - // the current one.. + // the current one.. if ( !d.date().isValid() ) current = QDate::currentDate(); else @@ -317,23 +322,23 @@ QArray OContactAccessBackend_XML::queryByExample ( const OContact &query, i // We have to equalize the year, otherwise // the search will fail.. - checkDate->setYMD( current.year(), - checkDate->month(), + checkDate->setYMD( current.year(), + checkDate->month(), checkDate->day() ); if ( *checkDate < current ) - checkDate->setYMD( current.year()+1, - checkDate->month(), + checkDate->setYMD( current.year()+1, + checkDate->month(), checkDate->day() ); // Check whether the birthday/anniversary date is between // the current/given date and the maximum date // ( maximum time range ) ! - qWarning("Checking if %s is between %s and %s ! ", + qWarning("Checking if %s is between %s and %s ! ", checkDate->toString().latin1(), - current.toString().latin1(), + current.toString().latin1(), queryDate->toString().latin1() ); if ( current.daysTo( *queryDate ) >= 0 ){ - if ( !( ( *checkDate >= current ) && + if ( !( ( *checkDate >= current ) && ( *checkDate <= *queryDate ) ) ){ allcorrect = false; qWarning (" Nope!.."); @@ -345,7 +350,7 @@ QArray OContactAccessBackend_XML::queryByExample ( const OContact &query, i allcorrect = false; } } - + delete queryDate; queryDate = 0l; delete checkDate; @@ -359,9 +364,9 @@ QArray OContactAccessBackend_XML::queryByExample ( const OContact &query, i | OContactAccess::DateYear | OContactAccess::DateMonth | OContactAccess::DateDay - | OContactAccess::MatchOne + | OContactAccess::MatchOne ) ){ - + case OContactAccess::RegExp:{ QRegExp expr ( query.field(i), !(settings & OContactAccess::IgnoreCase), @@ -397,10 +402,10 @@ QArray OContactAccessBackend_XML::queryByExample ( const OContact &query, i m_currentQuery[arraycounter++] = (*it)->uid(); } } - + // Shrink to fit.. m_currentQuery.resize(arraycounter); - + return m_currentQuery; } @@ -409,16 +414,16 @@ QArray OContactAccessBackend_XML::matchRegexp( const QRegExp &r ) const QArray m_currentQuery( m_contactList.count() ); QListIterator it( m_contactList ); uint arraycounter = 0; - + for( ; it.current(); ++it ){ if ( (*it)->match( r ) ){ m_currentQuery[arraycounter++] = (*it)->uid(); } - + } // Shrink to fit.. m_currentQuery.resize(arraycounter); - + return m_currentQuery; } @@ -427,7 +432,7 @@ const uint OContactAccessBackend_XML::querySettings() return ( OContactAccess::WildCards | OContactAccess::IgnoreCase | OContactAccess::RegExp - | OContactAccess::ExactMatch + | OContactAccess::ExactMatch | OContactAccess::DateDiff | OContactAccess::DateYear | OContactAccess::DateMonth @@ -437,20 +442,20 @@ const uint OContactAccessBackend_XML::querySettings() bool OContactAccessBackend_XML::hasQuerySettings (uint querySettings) const { - /* OContactAccess::IgnoreCase, DateDiff, DateYear, DateMonth, DateDay + /* OContactAccess::IgnoreCase, DateDiff, DateYear, DateMonth, DateDay * may be added with any of the other settings. IgnoreCase should never used alone. * Wildcards, RegExp, ExactMatch should never used at the same time... */ - - if ( querySettings == OContactAccess::IgnoreCase ) + + if ( querySettings == OContactAccess::IgnoreCase ) return false; - + switch ( querySettings & ~( OContactAccess::IgnoreCase | OContactAccess::DateDiff | OContactAccess::DateYear | OContactAccess::DateMonth | OContactAccess::DateDay - ) + ) ){ case OContactAccess::RegExp: return ( true ); @@ -463,14 +468,14 @@ bool OContactAccessBackend_XML::hasQuerySettings (uint querySettings) const } } -// Currently only asc implemented.. -QArray OContactAccessBackend_XML::sorted( bool asc, int , int , int ) +// Currently only asc implemented.. +QArray OContactAccessBackend_XML::sorted( bool asc, int , int , int ) { QMap nameToUid; QStringList names; QArray m_currentQuery( m_contactList.count() ); - - // First fill map and StringList with all Names + + // First fill map and StringList with all Names // Afterwards sort namelist and use map to fill array to return.. QListIterator it( m_contactList ); for( ; it.current(); ++it ){ @@ -478,7 +483,7 @@ QArray OContactAccessBackend_XML::sorted( bool asc, int , int , int ) nameToUid.insert( (*it)->fileAs() + QString::number( (*it)->uid() ), (*it)->uid() ); } names.sort(); - + int i = 0; if ( asc ){ for ( QStringList::Iterator it = names.begin(); it != names.end(); ++it ) @@ -487,9 +492,9 @@ QArray OContactAccessBackend_XML::sorted( bool asc, int , int , int ) for ( QStringList::Iterator it = names.end(); it != names.begin(); --it ) m_currentQuery[i++] = nameToUid[ (*it) ]; } - + return m_currentQuery; - + } bool OContactAccessBackend_XML::add ( const OContact &newcontact ) @@ -497,16 +502,16 @@ bool OContactAccessBackend_XML::add ( const OContact &newcontact ) //qWarning("odefaultbackend: ACTION::ADD"); updateJournal (newcontact, ACTION_ADD); addContact_p( newcontact ); - + m_changed = true; - + return true; } bool OContactAccessBackend_XML::replace ( const OContact &contact ) { m_changed = true; - + OContact* found = m_uidToContact.find ( QString().setNum( contact.uid() ) ); if ( found ) { @@ -528,7 +533,7 @@ bool OContactAccessBackend_XML::replace ( const OContact &contact ) bool OContactAccessBackend_XML::remove ( int uid ) { m_changed = true; - + OContact* found = m_uidToContact.find ( QString().setNum( uid ) ); if ( found ) { @@ -555,9 +560,9 @@ void OContactAccessBackend_XML::addContact_p( const OContact &newcontact ) } /* This function loads the xml-database and the journalfile */ -bool OContactAccessBackend_XML::load( const QString filename, bool isJournal ) +bool OContactAccessBackend_XML::load( const QString filename, bool isJournal ) { - + /* We use the time of the last read to check if the file was * changed externally. */ @@ -565,10 +570,10 @@ bool OContactAccessBackend_XML::load( const QString filename, bool isJournal ) QFileInfo fi( filename ); m_readtime = fi.lastModified (); } - + const int JOURNALACTION = Qtopia::Notes + 1; const int JOURNALROW = JOURNALACTION + 1; - + bool foundAction = false; journal_action action = ACTION_ADD; int journalKey = 0; @@ -576,7 +581,7 @@ bool OContactAccessBackend_XML::load( const QString filename, bool isJournal ) QMap customMap; QMap::Iterator customIt; QAsciiDict dict( 47 ); - + dict.setAutoDelete( TRUE ); dict.insert( "Uid", new int(Qtopia::AddressUid) ); dict.insert( "Title", new int(Qtopia::Title) ); @@ -623,9 +628,9 @@ bool OContactAccessBackend_XML::load( const QString filename, bool isJournal ) dict.insert( "Notes", new int(Qtopia::Notes) ); dict.insert( "action", new int(JOURNALACTION) ); dict.insert( "actionrow", new int(JOURNALROW) ); - + //qWarning( "OContactDefaultBackEnd::loading %s", filename.latin1() ); - + XMLElement *root = XMLElement::load( filename ); if(root != 0l ){ // start parsing /* Parse all XML-Elements and put the data into the @@ -634,7 +639,7 @@ bool OContactAccessBackend_XML::load( const QString filename, bool isJournal ) XMLElement *element = root->firstChild(); //qWarning("OContactAccess::load tagName(): %s", root->tagName().latin1() ); element = element->firstChild(); - + /* Search Tag "Contacts" which is the parent of all Contacts */ while( element && !isJournal ){ if( element->tagName() != QString::fromLatin1("Contacts") ){ @@ -661,14 +666,14 @@ bool OContactAccessBackend_XML::load( const QString filename, bool isJournal ) // element->tagName().latin1() ); QString dummy; foundAction = false; - + XMLElement::AttributeMap aMap = element->attributes(); XMLElement::AttributeMap::Iterator it; contactMap.clear(); customMap.clear(); for( it = aMap.begin(); it != aMap.end(); ++it ){ // qWarning ("Read Attribute: %s=%s", it.key().latin1(),it.data().latin1()); - + int *find = dict[ it.key() ]; /* Unknown attributes will be stored as "Custom" elements */ if ( !find ) { @@ -677,7 +682,7 @@ bool OContactAccessBackend_XML::load( const QString filename, bool isJournal ) customMap.insert( it.key(), it.data() ); continue; } - + /* Check if special conversion is needed and add attribute * into Contact class */ @@ -705,11 +710,11 @@ bool OContactAccessBackend_XML::load( const QString filename, bool isJournal ) } /* now generate the Contact contact */ OContact contact( contactMap ); - + for (customIt = customMap.begin(); customIt != customMap.end(); ++customIt ) { contact.setCustomField( customIt.key(), customIt.data() ); } - + if (foundAction){ foundAction = false; switch ( action ) { @@ -734,7 +739,7 @@ bool OContactAccessBackend_XML::load( const QString filename, bool isJournal ) /* Add contact to list */ addContact_p (contact); } - + /* Move to next element */ element = element->nextChild(); } @@ -748,16 +753,16 @@ bool OContactAccessBackend_XML::load( const QString filename, bool isJournal ) void OContactAccessBackend_XML::updateJournal( const OContact& cnt, - journal_action action ) + journal_action action ) { QFile f( m_journalName ); bool created = !f.exists(); if ( !f.open(IO_WriteOnly|IO_Append) ) return; - + QString buf; QCString str; - + // if the file was created, we have to set the Tag "" to // get a XML-File which is readable by our parser. // This is just a cheat, but better than rewrite the parser. @@ -766,7 +771,7 @@ void OContactAccessBackend_XML::updateJournal( const OContact& cnt, QCString cstr = buf.utf8(); f.writeBlock( cstr.data(), cstr.length() ); } - + buf = " const QString& + * QString = 0l -> QString::null + * * Revision 1.13 2003/03/21 10:33:09 eilers * Merged speed optimized xml backend for contacts to main. * Added QDateTime to querybyexample. For instance, it is now possible to get @@ -84,52 +89,57 @@ #include /* the default xml implementation */ +/** + * This class is the XML implementation of a Contact backend + * it does implement everything available for OContact. + * @see OPimAccessBackend for more information of available methods + */ class OContactAccessBackend_XML : public OContactAccessBackend { public: - OContactAccessBackend_XML ( QString appname, QString filename = 0l ); - + OContactAccessBackend_XML ( const QString& appname, const QString& filename = QString::null ); + bool save(); - + bool load (); void clear (); - + bool wasChangedExternally(); - + QArray allRecords() const; - + OContact find ( int uid ) const; - + QArray queryByExample ( const OContact &query, int settings, const QDateTime& d = QDateTime() ); QArray matchRegexp( const QRegExp &r ) const; - + const uint querySettings(); - + bool hasQuerySettings (uint querySettings) const; - - // Currently only asc implemented.. + + // Currently only asc implemented.. QArray sorted( bool asc, int , int , int ); bool add ( const OContact &newcontact ); - + bool replace ( const OContact &contact ); - + bool remove ( int uid ); bool reload(); - + private: enum journal_action { ACTION_ADD, ACTION_REMOVE, ACTION_REPLACE }; void addContact_p( const OContact &newcontact ); - + /* This function loads the xml-database and the journalfile */ bool load( const QString filename, bool isJournal ); - - + + void updateJournal( const OContact& cnt, journal_action action ); void removeJournal(); - + protected: bool m_changed; QString m_journalName; diff --git a/libopie/pim/odatebookaccess.cpp b/libopie/pim/odatebookaccess.cpp index 08e61ff..a3661a3 100644 --- a/libopie/pim/odatebookaccess.cpp +++ b/libopie/pim/odatebookaccess.cpp @@ -1,6 +1,13 @@ #include "obackendfactory.h" #include "odatebookaccess.h" +/** + * Simple constructor + * It takes a ODateBookAccessBackend as parent. If it is 0 the default implementation + * will be used! + * @param back The backend to be used or 0 for the default backend + * @param ac What kind of access is intended + */ ODateBookAccess::ODateBookAccess( ODateBookAccessBackend* back, enum Access ac ) : OPimAccessTemplate( back ) { @@ -12,27 +19,48 @@ ODateBookAccess::ODateBookAccess( ODateBookAccessBackend* back, enum Access ac ) } ODateBookAccess::~ODateBookAccess() { } + +/** + * @return all events available + */ ODateBookAccess::List ODateBookAccess::rawEvents()const { QArray ints = m_backEnd->rawEvents(); List lis( ints, this ); return lis; } + +/** + * @return all repeating events + */ ODateBookAccess::List ODateBookAccess::rawRepeats()const { QArray ints = m_backEnd->rawRepeats(); List lis( ints, this ); return lis; } + +/** + * @return all non repeating events + */ ODateBookAccess::List ODateBookAccess::nonRepeats()const { QArray ints = m_backEnd->nonRepeats(); List lis( ints, this ); return lis; } + +/** + * @return dates in the time span between from and to + * @param from Include all events from... + * @param to Include all events to... + */ OEffectiveEvent::ValueList ODateBookAccess::effectiveEvents( const QDate& from, const QDate& to ) { return m_backEnd->effecticeEvents( from, to ); } +/** + * @return all events at a given datetime + */ OEffectiveEvent::ValueList ODateBookAccess::effectiveEvents( const QDateTime& start ) { return m_backEnd->effecticeEvents( start ); } diff --git a/libopie/pim/odatebookaccess.h b/libopie/pim/odatebookaccess.h index 7047039..7c7a63f 100644 --- a/libopie/pim/odatebookaccess.h +++ b/libopie/pim/odatebookaccess.h @@ -6,18 +6,27 @@ #include "oevent.h" +/** + * This is the object orientated datebook database. It'll use OBackendFactory + * to query for a backend. + * All access to the datebook should be done via this class. + * Make sure to load and save the datebook this is not part of + * destructing and creating the object + * + * @author Holger Freyther + */ class ODateBookAccess : public OPimAccessTemplate { public: ODateBookAccess( ODateBookAccessBackend* = 0l, enum Access acc = Random ); ~ODateBookAccess(); - /** return all events */ + /* return all events */ List rawEvents()const; - /** return repeating events */ + /* return repeating events */ List rawRepeats()const; - /** return non repeating events */ + /* return non repeating events */ List nonRepeats()const; OEffectiveEvent::ValueList effectiveEvents( const QDate& from, const QDate& to ); diff --git a/libopie/pim/odatebookaccessbackend.h b/libopie/pim/odatebookaccessbackend.h index eb6e8fb..86ff298 100644 --- a/libopie/pim/odatebookaccessbackend.h +++ b/libopie/pim/odatebookaccessbackend.h @@ -6,25 +6,66 @@ #include "opimaccessbackend.h" #include "oevent.h" +/** + * This class is the interface to the storage of Events. + * @see OPimAccessBackend + * + */ class ODateBookAccessBackend : public OPimAccessBackend { public: typedef int UID; + + /** + * c'tor without parameter + */ ODateBookAccessBackend(); ~ODateBookAccessBackend(); + /** + * This method should return a list of UIDs containing + * all events. No filter should be applied + * @return list of events + */ virtual QArray rawEvents()const = 0; + + /** + * This method should return a list of UIDs containing + * all repeating events. No filter should be applied + * @return list of repeating events + */ virtual QArray rawRepeats()const = 0; + + /** + * This mthod should return a list of UIDs containing all non + * repeating events. No filter should be applied + * @return list of nonrepeating events + */ virtual QArray nonRepeats() const = 0; /** - * these two methods are used if you do not implement - * effectiveEvents... + * If you do not want to implement the effectiveEvents methods below + * you need to supply it with directNonRepeats. + * This method can return empty lists if effectiveEvents is implememted */ virtual OEvent::ValueList directNonRepeats() = 0; + + /** + * Same as above but return raw repeats! + */ virtual OEvent::ValueList directRawRepeats() = 0; /* is implemented by default but you can reimplement it*/ + /** + * Effective Events are special event occuring during a time frame. This method does calcualte + * EffectiveEvents bases on the directNonRepeats and directRawRepeats. You may implement this method + * yourself + */ virtual OEffectiveEvent::ValueList effecticeEvents( const QDate& from, const QDate& to ); + + /** + * this is an overloaded member function + * @see effecticeEvents + */ virtual OEffectiveEvent::ValueList effecticeEvents( const QDateTime& start ); }; diff --git a/libopie/pim/odatebookaccessbackend_xml.h b/libopie/pim/odatebookaccessbackend_xml.h index 563c31f..7848f7c 100644 --- a/libopie/pim/odatebookaccessbackend_xml.h +++ b/libopie/pim/odatebookaccessbackend_xml.h @@ -5,6 +5,12 @@ #include "odatebookaccessbackend.h" +/** + * This is the default XML implementation for DateBoook XML storage + * It fully implements the interface + * @see ODateBookAccessBackend + * @see OPimAccessBackend + */ class ODateBookAccessBackend_XML : public ODateBookAccessBackend { public: ODateBookAccessBackend_XML( const QString& appName, diff --git a/libopie/pim/oevent.h b/libopie/pim/oevent.h index 585515c..57d32d0 100644 --- a/libopie/pim/oevent.h +++ b/libopie/pim/oevent.h @@ -30,9 +30,18 @@ struct OCalendarHelper { class OPimNotifyManager; class ORecur; + +/** + * This is the container for all Events. It encapsules all + * available information for a single Event + * @short container for events. + */ class OEvent : public OPimRecord { public: typedef QValueList ValueList; + /** + * RecordFields contain possible attributes + */ enum RecordFields { Uid = Qtopia::UID_ID, Category = Qtopia::CATEGORY_ID, @@ -49,7 +58,14 @@ public: TimeZone }; + /** + * Start with an Empty OEvent. UID == 0 means that it is empty + */ OEvent(int uid = 0); + + /** + * copy c'tor + */ OEvent( const OEvent& ); ~OEvent(); OEvent &operator=( const OEvent& ); @@ -144,7 +160,6 @@ private: /** * AN Event can span through multiple days. We split up a multiday eve */ - class OEffectiveEvent { public: typedef QValueList ValueList; -- cgit v0.9.0.2