author | zecke <zecke> | 2003-04-13 18:07:10 (UTC) |
---|---|---|
committer | zecke <zecke> | 2003-04-13 18:07:10 (UTC) |
commit | 6f610544d3db6198c90105b70fab1cc84f5a1fbd (patch) (unidiff) | |
tree | 964d18f0a4cca7383a31810aa922876751c4a22c /libopie2/opiepim/backend/ocontactaccessbackend_xml.h | |
parent | 0b311079ff19798866291034663757103c6ba935 (diff) | |
download | opie-6f610544d3db6198c90105b70fab1cc84f5a1fbd.zip opie-6f610544d3db6198c90105b70fab1cc84f5a1fbd.tar.gz opie-6f610544d3db6198c90105b70fab1cc84f5a1fbd.tar.bz2 |
More API doc
QString -> const QString&
QString = 0l -> QString::null
Diffstat (limited to 'libopie2/opiepim/backend/ocontactaccessbackend_xml.h') (more/less context) (ignore whitespace changes)
-rw-r--r-- | libopie2/opiepim/backend/ocontactaccessbackend_xml.h | 46 |
1 files changed, 28 insertions, 18 deletions
diff --git a/libopie2/opiepim/backend/ocontactaccessbackend_xml.h b/libopie2/opiepim/backend/ocontactaccessbackend_xml.h index 4d6a7ef..7b5365b 100644 --- a/libopie2/opiepim/backend/ocontactaccessbackend_xml.h +++ b/libopie2/opiepim/backend/ocontactaccessbackend_xml.h | |||
@@ -19,2 +19,7 @@ | |||
19 | * $Log$ | 19 | * $Log$ |
20 | * Revision 1.14 2003/04/13 18:07:10 zecke | ||
21 | * More API doc | ||
22 | * QString -> const QString& | ||
23 | * QString = 0l -> QString::null | ||
24 | * | ||
20 | * Revision 1.13 2003/03/21 10:33:09 eilers | 25 | * Revision 1.13 2003/03/21 10:33:09 eilers |
@@ -86,8 +91,13 @@ | |||
86 | /* the default xml implementation */ | 91 | /* the default xml implementation */ |
92 | /** | ||
93 | * This class is the XML implementation of a Contact backend | ||
94 | * it does implement everything available for OContact. | ||
95 | * @see OPimAccessBackend for more information of available methods | ||
96 | */ | ||
87 | class OContactAccessBackend_XML : public OContactAccessBackend { | 97 | class OContactAccessBackend_XML : public OContactAccessBackend { |
88 | public: | 98 | public: |
89 | OContactAccessBackend_XML ( QString appname, QString filename = 0l ); | 99 | OContactAccessBackend_XML ( const QString& appname, const QString& filename = QString::null ); |
90 | 100 | ||
91 | bool save(); | 101 | bool save(); |
92 | 102 | ||
93 | bool load (); | 103 | bool load (); |
@@ -95,9 +105,9 @@ class OContactAccessBackend_XML : public OContactAccessBackend { | |||
95 | void clear (); | 105 | void clear (); |
96 | 106 | ||
97 | bool wasChangedExternally(); | 107 | bool wasChangedExternally(); |
98 | 108 | ||
99 | QArray<int> allRecords() const; | 109 | QArray<int> allRecords() const; |
100 | 110 | ||
101 | OContact find ( int uid ) const; | 111 | OContact find ( int uid ) const; |
102 | 112 | ||
103 | QArray<int> queryByExample ( const OContact &query, int settings, const QDateTime& d = QDateTime() ); | 113 | QArray<int> queryByExample ( const OContact &query, int settings, const QDateTime& d = QDateTime() ); |
@@ -105,16 +115,16 @@ class OContactAccessBackend_XML : public OContactAccessBackend { | |||
105 | QArray<int> matchRegexp( const QRegExp &r ) const; | 115 | QArray<int> matchRegexp( const QRegExp &r ) const; |
106 | 116 | ||
107 | const uint querySettings(); | 117 | const uint querySettings(); |
108 | 118 | ||
109 | bool hasQuerySettings (uint querySettings) const; | 119 | bool hasQuerySettings (uint querySettings) const; |
110 | 120 | ||
111 | // Currently only asc implemented.. | 121 | // Currently only asc implemented.. |
112 | QArray<int> sorted( bool asc, int , int , int ); | 122 | QArray<int> sorted( bool asc, int , int , int ); |
113 | bool add ( const OContact &newcontact ); | 123 | bool add ( const OContact &newcontact ); |
114 | 124 | ||
115 | bool replace ( const OContact &contact ); | 125 | bool replace ( const OContact &contact ); |
116 | 126 | ||
117 | bool remove ( int uid ); | 127 | bool remove ( int uid ); |
118 | bool reload(); | 128 | bool reload(); |
119 | 129 | ||
120 | private: | 130 | private: |
@@ -124,10 +134,10 @@ class OContactAccessBackend_XML : public OContactAccessBackend { | |||
124 | void addContact_p( const OContact &newcontact ); | 134 | void addContact_p( const OContact &newcontact ); |
125 | 135 | ||
126 | /* This function loads the xml-database and the journalfile */ | 136 | /* This function loads the xml-database and the journalfile */ |
127 | bool load( const QString filename, bool isJournal ); | 137 | bool load( const QString filename, bool isJournal ); |
128 | 138 | ||
129 | 139 | ||
130 | void updateJournal( const OContact& cnt, journal_action action ); | 140 | void updateJournal( const OContact& cnt, journal_action action ); |
131 | void removeJournal(); | 141 | void removeJournal(); |
132 | 142 | ||
133 | protected: | 143 | protected: |