author | eilers <eilers> | 2005-01-03 16:44:42 (UTC) |
---|---|---|
committer | eilers <eilers> | 2005-01-03 16:44:42 (UTC) |
commit | 310c7dce0c9043f66725bc79449fe958a12ad459 (patch) (unidiff) | |
tree | 9d789c21b1fb88bdd8a1ad7470867b91c70276b2 /libopie2 | |
parent | 0b3bbec6703c021a188c865e822f536bfa3045fc (diff) | |
download | opie-310c7dce0c9043f66725bc79449fe958a12ad459.zip opie-310c7dce0c9043f66725bc79449fe958a12ad459.tar.gz opie-310c7dce0c9043f66725bc79449fe958a12ad459.tar.bz2 |
Fixing stupid API documentation error.
Moving hasQuerySettings() and querySettings up to OPimAccessTemplate to
be available for all frontends..
-rw-r--r-- | libopie2/opiepim/ChangeLog | 3 | ||||
-rw-r--r-- | libopie2/opiepim/backend/odatebookaccessbackend_sql.cpp | 1 | ||||
-rw-r--r-- | libopie2/opiepim/backend/otodoaccessbackend.cpp | 2 | ||||
-rw-r--r-- | libopie2/opiepim/backend/otodoaccessbackend.h | 2 | ||||
-rw-r--r-- | libopie2/opiepim/core/ocontactaccess.cpp | 9 | ||||
-rw-r--r-- | libopie2/opiepim/core/ocontactaccess.h | 15 | ||||
-rw-r--r-- | libopie2/opiepim/core/opimaccesstemplate.h | 43 |
7 files changed, 40 insertions, 35 deletions
diff --git a/libopie2/opiepim/ChangeLog b/libopie2/opiepim/ChangeLog index 2007744..320b189 100644 --- a/libopie2/opiepim/ChangeLog +++ b/libopie2/opiepim/ChangeLog | |||
@@ -1,6 +1,9 @@ | |||
1 | 2005-01-03 Stefan Eilers <stefan@eilers-online.net> | ||
2 | * Fixing bug in API documentation | ||
3 | * Moving hasQuerySettings() and querySettings() to OPimAccessTemplate to be available for all frontends | ||
1 | 2004-12-28 Stefan Eilers <stefan@eilers-online.net> | 4 | 2004-12-28 Stefan Eilers <stefan@eilers-online.net> |
2 | * Make improved query by example accessable via frontend | 5 | * Make improved query by example accessable via frontend |
3 | * Some API documentation improvement | 6 | * Some API documentation improvement |
4 | * Cleanup of backend api.. | 7 | * Cleanup of backend api.. |
5 | * Fixing bug #1501 | 8 | * Fixing bug #1501 |
6 | 2004-11-23 Stefan Eilers <stefan@eilers-online.net> | 9 | 2004-11-23 Stefan Eilers <stefan@eilers-online.net> |
diff --git a/libopie2/opiepim/backend/odatebookaccessbackend_sql.cpp b/libopie2/opiepim/backend/odatebookaccessbackend_sql.cpp index 41b714e..629e4da 100644 --- a/libopie2/opiepim/backend/odatebookaccessbackend_sql.cpp +++ b/libopie2/opiepim/backend/odatebookaccessbackend_sql.cpp | |||
@@ -205,12 +205,13 @@ bool ODateBookAccessBackend_SQL::save() | |||
205 | QArray<int> ODateBookAccessBackend_SQL::allRecords()const | 205 | QArray<int> ODateBookAccessBackend_SQL::allRecords()const |
206 | { | 206 | { |
207 | return m_uids; | 207 | return m_uids; |
208 | } | 208 | } |
209 | 209 | ||
210 | QArray<int> ODateBookAccessBackend_SQL::queryByExample(const OPimEvent&, int, const QDateTime& ) { | 210 | QArray<int> ODateBookAccessBackend_SQL::queryByExample(const OPimEvent&, int, const QDateTime& ) { |
211 | qDebug( "Accessing ODateBookAccessBackend_SQL::queryByExample() which is not implemented!" ); | ||
211 | return QArray<int>(); | 212 | return QArray<int>(); |
212 | } | 213 | } |
213 | 214 | ||
214 | void ODateBookAccessBackend_SQL::clear() | 215 | void ODateBookAccessBackend_SQL::clear() |
215 | { | 216 | { |
216 | QString qu = "drop table datebook;"; | 217 | QString qu = "drop table datebook;"; |
diff --git a/libopie2/opiepim/backend/otodoaccessbackend.cpp b/libopie2/opiepim/backend/otodoaccessbackend.cpp index f979976..c7ce123 100644 --- a/libopie2/opiepim/backend/otodoaccessbackend.cpp +++ b/libopie2/opiepim/backend/otodoaccessbackend.cpp | |||
@@ -51,13 +51,13 @@ bool OPimTodoAccessBackend::hasQuerySettings (uint querySettings) const | |||
51 | { | 51 | { |
52 | return false; | 52 | return false; |
53 | } | 53 | } |
54 | 54 | ||
55 | 55 | ||
56 | UIDArray OPimTodoAccessBackend::queryByExample( const UIDArray& uidlist, const OPimTodo& query, int settings, | 56 | UIDArray OPimTodoAccessBackend::queryByExample( const UIDArray& uidlist, const OPimTodo& query, int settings, |
57 | const QDateTime& endperiod )const | 57 | const QDateTime& startperiod )const |
58 | { | 58 | { |
59 | qDebug( "Accessing OPimTodoAccessBackend::queryByExample() which is not implemented!" ); | 59 | qDebug( "Accessing OPimTodoAccessBackend::queryByExample() which is not implemented!" ); |
60 | return UIDArray(); | 60 | return UIDArray(); |
61 | 61 | ||
62 | // odebug << "Using Unaccelerated OPimContactAccessBackend implementation of queryByExample!" << oendl; | 62 | // odebug << "Using Unaccelerated OPimContactAccessBackend implementation of queryByExample!" << oendl; |
63 | 63 | ||
diff --git a/libopie2/opiepim/backend/otodoaccessbackend.h b/libopie2/opiepim/backend/otodoaccessbackend.h index 870ee57..06cece3 100644 --- a/libopie2/opiepim/backend/otodoaccessbackend.h +++ b/libopie2/opiepim/backend/otodoaccessbackend.h | |||
@@ -61,13 +61,13 @@ public: | |||
61 | /** | 61 | /** |
62 | * Check whether settings are correct. | 62 | * Check whether settings are correct. |
63 | * @return <i>true</i> if the given settings are correct and possible. | 63 | * @return <i>true</i> if the given settings are correct and possible. |
64 | */ | 64 | */ |
65 | bool hasQuerySettings (uint querySettings) const; | 65 | bool hasQuerySettings (uint querySettings) const; |
66 | 66 | ||
67 | UIDArray queryByExample( const UIDArray& uidlist, const OPimTodo& query, int settings, const QDateTime& endperiod = QDateTime() )const; | 67 | UIDArray queryByExample( const UIDArray& uidlist, const OPimTodo& query, int settings, const QDateTime& startperiod = QDateTime() )const; |
68 | UIDArray sorted( const UIDArray&, bool asc, int, int, const QArray<int>& )const; | 68 | UIDArray sorted( const UIDArray&, bool asc, int, int, const QArray<int>& )const; |
69 | OPimBackendOccurrence::List occurrences( const QDate&, const QDate& )const; | 69 | OPimBackendOccurrence::List occurrences( const QDate&, const QDate& )const; |
70 | //@} | 70 | //@} |
71 | 71 | ||
72 | private: | 72 | private: |
73 | class Private; | 73 | class Private; |
diff --git a/libopie2/opiepim/core/ocontactaccess.cpp b/libopie2/opiepim/core/ocontactaccess.cpp index 9bbc820..9d18d47 100644 --- a/libopie2/opiepim/core/ocontactaccess.cpp +++ b/libopie2/opiepim/core/ocontactaccess.cpp | |||
@@ -115,21 +115,12 @@ bool OPimContactAccess::save () | |||
115 | */ | 115 | */ |
116 | QCopEnvelope e( "QPE/PIM", "addressbookUpdated()" ); | 116 | QCopEnvelope e( "QPE/PIM", "addressbookUpdated()" ); |
117 | 117 | ||
118 | return true; | 118 | return true; |
119 | } | 119 | } |
120 | 120 | ||
121 | const uint OPimContactAccess::querySettings() | ||
122 | { | ||
123 | return ( m_backEnd->querySettings() ); | ||
124 | } | ||
125 | |||
126 | bool OPimContactAccess::hasQuerySettings ( int querySettings ) const | ||
127 | { | ||
128 | return ( m_backEnd->hasQuerySettings ( querySettings ) ); | ||
129 | } | ||
130 | 121 | ||
131 | #if 0 | 122 | #if 0 |
132 | OPimRecordList<OPimContact> OPimContactAccess::sorted( bool ascending, int sortOrder, int sortFilter, int cat ) const | 123 | OPimRecordList<OPimContact> OPimContactAccess::sorted( bool ascending, int sortOrder, int sortFilter, int cat ) const |
133 | { | 124 | { |
134 | QArray<int> matchingContacts = m_backEnd -> sorted( ascending, sortOrder, sortFilter, cat ); | 125 | QArray<int> matchingContacts = m_backEnd -> sorted( ascending, sortOrder, sortFilter, cat ); |
135 | return ( OPimRecordList<OPimContact>(matchingContacts, this) ); | 126 | return ( OPimRecordList<OPimContact>(matchingContacts, this) ); |
diff --git a/libopie2/opiepim/core/ocontactaccess.h b/libopie2/opiepim/core/ocontactaccess.h index 5051321..9a2ecaf 100644 --- a/libopie2/opiepim/core/ocontactaccess.h +++ b/libopie2/opiepim/core/ocontactaccess.h | |||
@@ -113,27 +113,12 @@ class OPimContactAccess: public QObject, public OPimAccessTemplate<OPimContact> | |||
113 | */ | 113 | */ |
114 | OPimContactAccess (const QString appname, const QString filename = 0l, | 114 | OPimContactAccess (const QString appname, const QString filename = 0l, |
115 | OPimContactAccessBackend* backend = 0l, bool handlesync = true); | 115 | OPimContactAccessBackend* backend = 0l, bool handlesync = true); |
116 | ~OPimContactAccess (); | 116 | ~OPimContactAccess (); |
117 | 117 | ||
118 | 118 | ||
119 | /** | ||
120 | * Return all possible settings for queryByExample(). | ||
121 | * @return All settings provided by the current backend | ||
122 | * (i.e.: WildCards & IgnoreCase) | ||
123 | * @see QuerySettings in OPimBase for details of the parameter, queryByExample() | ||
124 | */ | ||
125 | const uint querySettings(); | ||
126 | |||
127 | /** | ||
128 | * Check whether settings are correct for queryByExample(). | ||
129 | * @return <i>true</i> if the given settings are correct and possible. | ||
130 | * @see QuerySettings in OPimBase for details of the parameter | ||
131 | */ | ||
132 | bool hasQuerySettings ( int querySettings ) const; | ||
133 | |||
134 | /** | 119 | /** |
135 | * if the resource was changed externally. | 120 | * if the resource was changed externally. |
136 | * You should use the signal instead of polling possible changes ! | 121 | * You should use the signal instead of polling possible changes ! |
137 | */ | 122 | */ |
138 | bool wasChangedExternally()const; | 123 | bool wasChangedExternally()const; |
139 | 124 | ||
diff --git a/libopie2/opiepim/core/opimaccesstemplate.h b/libopie2/opiepim/core/opimaccesstemplate.h index 3875f09..823f03d 100644 --- a/libopie2/opiepim/core/opimaccesstemplate.h +++ b/libopie2/opiepim/core/opimaccesstemplate.h | |||
@@ -84,51 +84,66 @@ public: | |||
84 | bool wasChangedExternally()const; | 84 | bool wasChangedExternally()const; |
85 | 85 | ||
86 | //@{ | 86 | //@{ |
87 | virtual List allRecords()const; | 87 | virtual List allRecords()const; |
88 | virtual List matchRegexp( const QRegExp &r ) const; | 88 | virtual List matchRegexp( const QRegExp &r ) const; |
89 | 89 | ||
90 | /** | ||
91 | * Return all possible settings for queryByExample(). | ||
92 | * @return All settings provided by the current backend | ||
93 | * (i.e.: WildCards & IgnoreCase) | ||
94 | * @see QuerySettings in OPimBase for details of the parameter, queryByExample() | ||
95 | */ | ||
96 | const uint querySettings(); | ||
97 | |||
98 | /** | ||
99 | * Check whether settings are correct for queryByExample(). | ||
100 | * @return <i>true</i> if the given settings are correct and possible. | ||
101 | * @see QuerySettings in OPimBase for details of the parameter | ||
102 | */ | ||
103 | bool hasQuerySettings ( int querySettings ) const; | ||
104 | |||
90 | /** | 105 | /** |
91 | * Query by example search interface. | 106 | * Query by example search interface. |
92 | * "Query by Example" provides a very powerful search engine. Use the query object | 107 | * "Query by Example" provides a very powerful search engine. Use the query object |
93 | * (this may be a contact, a todo or databook event) | 108 | * (this may be a contact, a todo or databook event) |
94 | * as a search mask which is converted into a query regarding the querySettings. If a time period is needed | 109 | * as a search mask which is converted into a query regarding the querySettings. If a time period is needed |
95 | * (as for OpimBase::DateDiff), you have to use the date/time in the query object and the endperiod (the last parameter). | 110 | * (as for OpimBase::DateDiff), you have to use the date/time in the query object and the startperiod (the last parameter). |
96 | * @see QuerySettings in class OPimBase | 111 | * @see QuerySettings in class OPimBase |
97 | * @param query The object which contains the query set | 112 | * @param query The object which contains the query set |
98 | * @param querySettings This parameter defines what should be searched and how the query should be interpreted | 113 | * @param querySettings This parameter defines what should be searched and how the query should be interpreted |
99 | * @param endperiod Defines the end of a period for some special queries. | 114 | * @param startperiod Defines the start of a period for some special queries. |
100 | */ | 115 | */ |
101 | virtual List queryByExample( const T& query, int querySettings, const QDateTime& endperiod = QDateTime() ); | 116 | virtual List queryByExample( const T& query, int querySettings, const QDateTime& startperiod = QDateTime() ); |
102 | 117 | ||
103 | /** | 118 | /** |
104 | * Generic query by example search interface. This is a special version which handles generic OPimRecord types. They are converted | 119 | * Generic query by example search interface. This is a special version which handles generic OPimRecord types. They are converted |
105 | * automatically into the right datatype. | 120 | * automatically into the right datatype. |
106 | * "Query by Example" provides a very powerful search engine. Use the query object (this may be a contact, a todo or databook event) | 121 | * "Query by Example" provides a very powerful search engine. Use the query object (this may be a contact, a todo or databook event) |
107 | * as a search mask which is converted into a query regarding the querySettings. If a time period is needed | 122 | * as a search mask which is converted into a query regarding the querySettings. If a time period is needed |
108 | * (as for OpimBase::DateDiff), you have to use the date/time in the query object and the endperiod (the last parameter). | 123 | * (as for OpimBase::DateDiff), you have to use the date/time in the query object and the startperiod (the last parameter). |
109 | * @see QuerySettings in class OPimBase | 124 | * @see QuerySettings in class OPimBase |
110 | * @param query The object which contains the query set | 125 | * @param query The object which contains the query set |
111 | * @param querySettings This parameter defines what should be searched and how the query should be interpreted | 126 | * @param querySettings This parameter defines what should be searched and how the query should be interpreted |
112 | * @param endperiod Defines the end of a period for some special queries. | 127 | * @param startperiod Defines the start of a period for some special queries. |
113 | */ | 128 | */ |
114 | virtual List queryByExample( const OPimRecord* query, int querySettings, const QDateTime& endperiod = QDateTime() ); | 129 | virtual List queryByExample( const OPimRecord* query, int querySettings, const QDateTime& startperiod = QDateTime() ); |
115 | /** | 130 | /** |
116 | * Incremental query by example search interface. Providing incremental search, this one provides the feature | 131 | * Incremental query by example search interface. Providing incremental search, this one provides the feature |
117 | * to search in a list of records which may be returned by an other search. | 132 | * to search in a list of records which may be returned by an other search. |
118 | * "Query by Example" provides a very powerful search engine. Use the query object (this may be a contact, a todo or databook event) | 133 | * "Query by Example" provides a very powerful search engine. Use the query object (this may be a contact, a todo or databook event) |
119 | * as a search mask which is converted into a query regarding the querySettings. If a time period is needed | 134 | * as a search mask which is converted into a query regarding the querySettings. If a time period is needed |
120 | * (as for OpimBase::DateDiff), you have to use the date/time in the query object and the endperiod (the last parameter). | 135 | * (as for OpimBase::DateDiff), you have to use the date/time in the query object and the startperiod (the last parameter). |
121 | * @see QuerySettings in class OPimBase | 136 | * @see QuerySettings in class OPimBase |
122 | * @param uidlist List of uid's which should be incorporated into the next search | 137 | * @param uidlist List of uid's which should be incorporated into the next search |
123 | * @param query The object which contains the query set | 138 | * @param query The object which contains the query set |
124 | * @param querySettings This parameter defines what should be searched and how the query should be interpreted | 139 | * @param querySettings This parameter defines what should be searched and how the query should be interpreted |
125 | * @param endperiod Defines the end of a period for some special queries. | 140 | * @param startperiod Defines the start of a period for some special queries. |
126 | */ | 141 | */ |
127 | virtual List queryByExample( const OPimAccessTemplate::List& uidlist, const T& query, int querySettings, | 142 | virtual List queryByExample( const OPimAccessTemplate::List& uidlist, const T& query, int querySettings, |
128 | const QDateTime& endperiod = QDateTime() ); | 143 | const QDateTime& startperiod = QDateTime() ); |
129 | 144 | ||
130 | virtual T find( UID uid )const; | 145 | virtual T find( UID uid )const; |
131 | virtual T find( UID uid, const QArray<int>&, | 146 | virtual T find( UID uid, const QArray<int>&, |
132 | uint current, typename OTemplateBase<T>::CacheDirection dir = OTemplateBase<T>::Forward )const; | 147 | uint current, typename OTemplateBase<T>::CacheDirection dir = OTemplateBase<T>::Forward )const; |
133 | //@} | 148 | //@} |
134 | 149 | ||
@@ -305,12 +320,22 @@ typename OPimAccessTemplate<T>::List OPimAccessTemplate<T>::matchRegexp( const Q | |||
305 | */ | 320 | */ |
306 | template <class T> | 321 | template <class T> |
307 | QArray<int> OPimAccessTemplate<T>::records()const { | 322 | QArray<int> OPimAccessTemplate<T>::records()const { |
308 | return m_backEnd->allRecords(); | 323 | return m_backEnd->allRecords(); |
309 | } | 324 | } |
310 | 325 | ||
326 | template <class T> | ||
327 | const uint OPimAccessTemplate<T>::querySettings(){ | ||
328 | return m_backEnd->querySettings(); | ||
329 | } | ||
330 | |||
331 | template <class T> | ||
332 | bool OPimAccessTemplate<T>::hasQuerySettings ( int querySettings ) const { | ||
333 | return m_backEnd->hasQuerySettings( querySettings ); | ||
334 | } | ||
335 | |||
311 | 336 | ||
312 | template <class T> | 337 | template <class T> |
313 | typename OPimAccessTemplate<T>::List | 338 | typename OPimAccessTemplate<T>::List |
314 | OPimAccessTemplate<T>::queryByExample( const T& t, int settings, const QDateTime& d ) { | 339 | OPimAccessTemplate<T>::queryByExample( const T& t, int settings, const QDateTime& d ) { |
315 | QArray<int> ints = m_backEnd->queryByExample( t, settings, d ); | 340 | QArray<int> ints = m_backEnd->queryByExample( t, settings, d ); |
316 | 341 | ||