summaryrefslogtreecommitdiff
authorzecke <zecke>2002-11-15 10:53:42 (UTC)
committer zecke <zecke>2002-11-15 10:53:42 (UTC)
commitdc68676392f6ac7cced3a9b004fe72a8b408812f (patch) (side-by-side diff)
treed74a42aef53b57edb9d452806b34695c591f8252
parent5fac1f8271dc037d8d3a3a765bccc44c4734e544 (diff)
downloadopie-dc68676392f6ac7cced3a9b004fe72a8b408812f.zip
opie-dc68676392f6ac7cced3a9b004fe72a8b408812f.tar.gz
opie-dc68676392f6ac7cced3a9b004fe72a8b408812f.tar.bz2
API REVIEW added
Simon if you read that feel free to do an API REVIEW on libopie but leave out OFileSelector for now... Stefan: added an explanation for you
Diffstat (more/less context) (ignore whitespace changes)
-rw-r--r--libopie/pim/ocontact.h26
-rw-r--r--libopie2/opiepim/ocontact.h26
2 files changed, 52 insertions, 0 deletions
diff --git a/libopie/pim/ocontact.h b/libopie/pim/ocontact.h
index 81ac1c1..9643e8b 100644
--- a/libopie/pim/ocontact.h
+++ b/libopie/pim/ocontact.h
@@ -26,38 +26,53 @@
#include <qpe/recordfields.h>
#include <qdatetime.h>
#include <qstringlist.h>
#if defined(QPC_TEMPLATEDLL)
// MOC_SKIP_BEGIN
QPC_TEMPLATEEXTERN template class QPC_EXPORT QMap<int, QString>;
// MOC_SKIP_END
#endif
class ContactPrivate; // Wozu ist das gut und wo ist das decrariert ? (se)
+ /* Stefan das ist eine forward declaration
+ * dann machst du in der private section
+ * ContactPrivate *d;
+ *
+ * und wenn du bei Opie1.1 was hinzufuegen moechtest
+ * packst du es in ContactPrivate damit Opie
+ * binaer kompatibel bleibt
+ * -zecke
+ */
class QPC_EXPORT OContact : public OPimRecord
{
friend class DataSet;
public:
OContact();
OContact( const QMap<int, QString> &fromMap );
virtual ~OContact();
+ /* VCARD stuff should vanish! -zecke */
static void writeVCard( const QString &filename, const QValueList<OContact> &contacts);
static void writeVCard( const QString &filename, const OContact &c );
static QValueList<OContact> readVCard( const QString &filename );
enum journal_action { ACTION_ADD, ACTION_REMOVE, ACTION_REPLACE };
+ /*
+ * do we need to inline them
+ * if yes do we need to inline them this way?
+ * -zecke
+ */
void setTitle( const QString &v ) { replace( Qtopia::Title, v ); }
void setFirstName( const QString &v ) { replace( Qtopia::FirstName, v ); }
void setMiddleName( const QString &v ) { replace( Qtopia::MiddleName, v ); }
void setLastName( const QString &v ) { replace( Qtopia::LastName, v ); }
void setSuffix( const QString &v ) { replace( Qtopia::Suffix, v ); }
void setFileAs( const QString &v ) { replace( Qtopia::FileAs, v ); }
void setFileAs();
// default email address
void setDefaultEmail( const QString &v );
// inserts email to list and ensure's doesn't already exist
void insertEmail( const QString &v );
@@ -118,24 +133,29 @@ public:
QString title() const { return find( Qtopia::Title ); }
QString firstName() const { return find( Qtopia::FirstName ); }
QString middleName() const { return find( Qtopia::MiddleName ); }
QString lastName() const { return find( Qtopia::LastName ); }
QString suffix() const { return find( Qtopia::Suffix ); }
QString fileAs() const { return find( Qtopia::FileAs ); }
// email
QString defaultEmail() const { return find( Qtopia::DefaultEmail ); }
QStringList emailList() const;
// home
+ /*
+ * OPimAddress address(enum Location)const;
+ * would be some how nicer...
+ * -zecke
+ */
QString homeStreet() const { return find( Qtopia::HomeStreet ); }
QString homeCity() const { return find( Qtopia::HomeCity ); }
QString homeState() const { return find( Qtopia::HomeState ); }
QString homeZip() const { return find( Qtopia::HomeZip ); }
QString homeCountry() const { return find( Qtopia::HomeCountry ); }
QString homePhone() const { return find( Qtopia::HomePhone ); }
QString homeFax() const { return find( Qtopia::HomeFax ); }
QString homeMobile() const { return find( Qtopia::HomeMobile ); }
QString homeWebpage() const { return find( Qtopia::HomeWebPage ); }
/** Multi line string containing all non-empty address info in the form
* Street
* City, State Zip
@@ -187,43 +207,49 @@ public:
// { return find( Custom- + key ); }
static QStringList fields();
static QStringList trfields();
static QStringList untrfields();
QString toRichText() const;
QMap<int, QString> toMap() const;
QString field( int key ) const { return find( key ); }
// journaling...
+ /* do we still need them? Stefan your backend takes care of these -zecke */
void saveJournal( journal_action action, const QString &key = QString::null );
void save( QString &buf ) const;
+ /* we shouldn't inline this one -zecke */
void setUid( int i )
{ OPimRecord::setUid(i); replace( Qtopia::AddressUid , QString::number(i)); }
QString toShortText()const;
QString OContact::type()const;
QMap<QString,QString> OContact::toExtraMap() const;
class QString OContact::recordField(int) const;
// Why private ? (eilers,se)
QString emailSeparator() const { return " "; }
// the emails should be seperated by a comma
void setEmails( const QString &v );
QString emails() const { return find( Qtopia::Emails ); }
private:
+ /* I do not like friends ;)
+ * besides that I think we do not need them
+ * anymore -zecke
+ */
friend class AbEditor;
friend class AbTable;
friend class AddressBookAccessPrivate;
friend class XMLIO;
void insert( int key, const QString &value );
void replace( int key, const QString &value );
QString find( int key ) const;
QString displayAddress( const QString &street,
const QString &city,
const QString &state,
diff --git a/libopie2/opiepim/ocontact.h b/libopie2/opiepim/ocontact.h
index 81ac1c1..9643e8b 100644
--- a/libopie2/opiepim/ocontact.h
+++ b/libopie2/opiepim/ocontact.h
@@ -26,38 +26,53 @@
#include <qpe/recordfields.h>
#include <qdatetime.h>
#include <qstringlist.h>
#if defined(QPC_TEMPLATEDLL)
// MOC_SKIP_BEGIN
QPC_TEMPLATEEXTERN template class QPC_EXPORT QMap<int, QString>;
// MOC_SKIP_END
#endif
class ContactPrivate; // Wozu ist das gut und wo ist das decrariert ? (se)
+ /* Stefan das ist eine forward declaration
+ * dann machst du in der private section
+ * ContactPrivate *d;
+ *
+ * und wenn du bei Opie1.1 was hinzufuegen moechtest
+ * packst du es in ContactPrivate damit Opie
+ * binaer kompatibel bleibt
+ * -zecke
+ */
class QPC_EXPORT OContact : public OPimRecord
{
friend class DataSet;
public:
OContact();
OContact( const QMap<int, QString> &fromMap );
virtual ~OContact();
+ /* VCARD stuff should vanish! -zecke */
static void writeVCard( const QString &filename, const QValueList<OContact> &contacts);
static void writeVCard( const QString &filename, const OContact &c );
static QValueList<OContact> readVCard( const QString &filename );
enum journal_action { ACTION_ADD, ACTION_REMOVE, ACTION_REPLACE };
+ /*
+ * do we need to inline them
+ * if yes do we need to inline them this way?
+ * -zecke
+ */
void setTitle( const QString &v ) { replace( Qtopia::Title, v ); }
void setFirstName( const QString &v ) { replace( Qtopia::FirstName, v ); }
void setMiddleName( const QString &v ) { replace( Qtopia::MiddleName, v ); }
void setLastName( const QString &v ) { replace( Qtopia::LastName, v ); }
void setSuffix( const QString &v ) { replace( Qtopia::Suffix, v ); }
void setFileAs( const QString &v ) { replace( Qtopia::FileAs, v ); }
void setFileAs();
// default email address
void setDefaultEmail( const QString &v );
// inserts email to list and ensure's doesn't already exist
void insertEmail( const QString &v );
@@ -118,24 +133,29 @@ public:
QString title() const { return find( Qtopia::Title ); }
QString firstName() const { return find( Qtopia::FirstName ); }
QString middleName() const { return find( Qtopia::MiddleName ); }
QString lastName() const { return find( Qtopia::LastName ); }
QString suffix() const { return find( Qtopia::Suffix ); }
QString fileAs() const { return find( Qtopia::FileAs ); }
// email
QString defaultEmail() const { return find( Qtopia::DefaultEmail ); }
QStringList emailList() const;
// home
+ /*
+ * OPimAddress address(enum Location)const;
+ * would be some how nicer...
+ * -zecke
+ */
QString homeStreet() const { return find( Qtopia::HomeStreet ); }
QString homeCity() const { return find( Qtopia::HomeCity ); }
QString homeState() const { return find( Qtopia::HomeState ); }
QString homeZip() const { return find( Qtopia::HomeZip ); }
QString homeCountry() const { return find( Qtopia::HomeCountry ); }
QString homePhone() const { return find( Qtopia::HomePhone ); }
QString homeFax() const { return find( Qtopia::HomeFax ); }
QString homeMobile() const { return find( Qtopia::HomeMobile ); }
QString homeWebpage() const { return find( Qtopia::HomeWebPage ); }
/** Multi line string containing all non-empty address info in the form
* Street
* City, State Zip
@@ -187,43 +207,49 @@ public:
// { return find( Custom- + key ); }
static QStringList fields();
static QStringList trfields();
static QStringList untrfields();
QString toRichText() const;
QMap<int, QString> toMap() const;
QString field( int key ) const { return find( key ); }
// journaling...
+ /* do we still need them? Stefan your backend takes care of these -zecke */
void saveJournal( journal_action action, const QString &key = QString::null );
void save( QString &buf ) const;
+ /* we shouldn't inline this one -zecke */
void setUid( int i )
{ OPimRecord::setUid(i); replace( Qtopia::AddressUid , QString::number(i)); }
QString toShortText()const;
QString OContact::type()const;
QMap<QString,QString> OContact::toExtraMap() const;
class QString OContact::recordField(int) const;
// Why private ? (eilers,se)
QString emailSeparator() const { return " "; }
// the emails should be seperated by a comma
void setEmails( const QString &v );
QString emails() const { return find( Qtopia::Emails ); }
private:
+ /* I do not like friends ;)
+ * besides that I think we do not need them
+ * anymore -zecke
+ */
friend class AbEditor;
friend class AbTable;
friend class AddressBookAccessPrivate;
friend class XMLIO;
void insert( int key, const QString &value );
void replace( int key, const QString &value );
QString find( int key ) const;
QString displayAddress( const QString &street,
const QString &city,
const QString &state,