Diffstat (limited to 'libopie2/opiepim/backend/ocontactaccessbackend.h') (more/less context) (show whitespace changes)
-rw-r--r-- | libopie2/opiepim/backend/ocontactaccessbackend.h | 82 |
1 files changed, 34 insertions, 48 deletions
diff --git a/libopie2/opiepim/backend/ocontactaccessbackend.h b/libopie2/opiepim/backend/ocontactaccessbackend.h index 0eac6dc..6113cea 100644 --- a/libopie2/opiepim/backend/ocontactaccessbackend.h +++ b/libopie2/opiepim/backend/ocontactaccessbackend.h | |||
@@ -1,88 +1,71 @@ | |||
1 | /* | ||
2 | This file is part of the Opie Project | ||
3 | Copyright (C) The Main Author <main-author@whereever.org> | ||
4 | =. Copyright (C) The Opie Team <opie-devel@handhelds.org> | ||
5 | .=l. | ||
6 | .>+-= | ||
7 | _;:, .> :=|. This program is free software; you can | ||
8 | .> <`_, > . <= redistribute it and/or modify it under | ||
9 | :`=1 )Y*s>-.-- : the terms of the GNU Library General Public | ||
10 | .="- .-=="i, .._ License as published by the Free Software | ||
11 | - . .-<_> .<> Foundation; either version 2 of the License, | ||
12 | ._= =} : or (at your option) any later version. | ||
13 | .%`+i> _;_. | ||
14 | .i_,=:_. -<s. This program is distributed in the hope that | ||
15 | + . -:. = it will be useful, but WITHOUT ANY WARRANTY; | ||
16 | : .. .:, . . . without even the implied warranty of | ||
17 | =_ + =;=|` MERCHANTABILITY or FITNESS FOR A | ||
18 | _.=:. : :=>`: PARTICULAR PURPOSE. See the GNU | ||
19 | ..}^=.= = ; Library General Public License for more | ||
20 | ++= -. .` .: details. | ||
21 | : = ...= . :.=- | ||
22 | -. .:....=;==+<; You should have received a copy of the GNU | ||
23 | -_. . . )=. = Library General Public License along with | ||
24 | -- :-=` this library; see the file COPYING.LIB. | ||
25 | If not, write to the Free Software Foundation, | ||
26 | Inc., 59 Temple Place - Suite 330, | ||
27 | Boston, MA 02111-1307, USA. | ||
28 | */ | ||
1 | /** | 29 | /** |
2 | * The class responsible for managing a backend. | 30 | * The class responsible for managing a backend. |
3 | * The implementation of this abstract class contains | 31 | * The implementation of this abstract class contains |
4 | * the complete database handling. | 32 | * the complete database handling. |
5 | * | 33 | * |
6 | * Copyright (c) 2002 by Stefan Eilers (Eilers.Stefan@epost.de) | 34 | * Copyright (c) 2002 by Stefan Eilers (Eilers.Stefan@epost.de) |
7 | * Copyright (c) 2002 by Holger Freyther (zecke@handhelds.org) | 35 | * Copyright (c) 2002 by Holger Freyther (zecke@handhelds.org) |
8 | * | 36 | * |
9 | * ===================================================================== | ||
10 | *This program is free software; you can redistribute it and/or | ||
11 | *modify it under the terms of the GNU Library General Public | ||
12 | * License as published by the Free Software Foundation; | ||
13 | * either version 2 of the License, or (at your option) any later | ||
14 | * version. | ||
15 | * ===================================================================== | ||
16 | * ToDo: Define enum for query settings | ||
17 | * ===================================================================== | ||
18 | * Version: $Id$ | ||
19 | * ===================================================================== | ||
20 | * History: | ||
21 | * $Log$ | ||
22 | * Revision 1.7 2004/02/19 02:05:37 zecke | ||
23 | * Add notes for API fixes and BC stuff | ||
24 | * | ||
25 | * Revision 1.6 2003/08/01 12:30:16 eilers | ||
26 | * Merging changes from BRANCH_1_0 to HEAD | ||
27 | * | ||
28 | * Revision 1.5.4.1 2003/06/30 14:34:19 eilers | ||
29 | * Patches from Zecke: | ||
30 | * Fixing and cleaning up extraMap handling | ||
31 | * Adding d_ptr for binary compatibility in the future | ||
32 | * | ||
33 | * Revision 1.5 2003/04/13 18:07:10 zecke | ||
34 | * More API doc | ||
35 | * QString -> const QString& | ||
36 | * QString = 0l -> QString::null | ||
37 | * | ||
38 | * Revision 1.4 2002/11/13 14:14:51 eilers | ||
39 | * Added sorted for Contacts.. | ||
40 | * | ||
41 | * Revision 1.3 2002/11/01 15:10:42 eilers | ||
42 | * Added regExp-search in database for all fields in a contact. | ||
43 | * | ||
44 | * Revision 1.2 2002/10/07 17:34:24 eilers | ||
45 | * added OBackendFactory for advanced backend access | ||
46 | * | ||
47 | * Revision 1.1 2002/09/27 17:11:44 eilers | ||
48 | * Added API for accessing the Contact-Database ! It is compiling, but | ||
49 | * please do not expect that anything is working ! | ||
50 | * I will debug that stuff in the next time .. | ||
51 | * Please read README_COMPILE for compiling ! | ||
52 | * | ||
53 | * ===================================================================== | ||
54 | * | ||
55 | */ | 37 | */ |
56 | 38 | ||
57 | #ifndef _OCONTACTACCESSBACKEND_H_ | 39 | #ifndef _OCONTACTACCESSBACKEND_H_ |
58 | #define _OCONTACTACCESSBACKEND_H_ | 40 | #define _OCONTACTACCESSBACKEND_H_ |
59 | 41 | ||
60 | #include "ocontact.h" | 42 | #include <opie2/ocontact.h> |
61 | #include "opimaccessbackend.h" | 43 | #include <opie2/opimaccessbackend.h> |
62 | 44 | ||
63 | #include <qregexp.h> | 45 | #include <qregexp.h> |
64 | 46 | ||
47 | namespace Opie { | ||
65 | /** | 48 | /** |
66 | * This class represents the interface of all Contact Backends. | 49 | * This class represents the interface of all Contact Backends. |
67 | * Derivates of this class will be used to access the contacts. | 50 | * Derivates of this class will be used to access the contacts. |
68 | * As implementation currently XML and vCard exist. This class needs to be implemented | 51 | * As implementation currently XML and vCard exist. This class needs to be implemented |
69 | * if you want to provide your own storage. | 52 | * if you want to provide your own storage. |
70 | * In all queries a list of uids is passed on instead of loading the actual record! | 53 | * In all queries a list of uids is passed on instead of loading the actual record! |
71 | * | 54 | * |
72 | * @see OContactAccessBackend_VCard | 55 | * @see OContactAccessBackend_VCard |
73 | * @see OContactAccessBackend_XML | 56 | * @see OContactAccessBackend_XML |
74 | */ | 57 | */ |
75 | class OContactAccessBackend: public OPimAccessBackend<OContact> { | 58 | class OContactAccessBackend: public OPimAccessBackend<OContact> { |
76 | public: | 59 | public: |
77 | /** | 60 | /** |
78 | * @todo make non line in regard to BC guide of KDE | 61 | * @todo make non line in regard to BC guide of KDE |
79 | */ | 62 | */ |
80 | OContactAccessBackend() {} | 63 | OContactAccessBackend() {} |
81 | /** | 64 | /** |
82 | * @todo make non inline in regard to the BC guide of KDE | 65 | * @todo make non inline in regard to the BC guide of KDE |
83 | */ | 66 | */ |
84 | virtual ~OContactAccessBackend() {} | 67 | virtual ~OContactAccessBackend() {} |
85 | 68 | ||
86 | 69 | ||
87 | /** | 70 | /** |
88 | * Return if database was changed externally. | 71 | * Return if database was changed externally. |
@@ -104,25 +87,28 @@ class OContactAccessBackend: public OPimAccessBackend<OContact> { | |||
104 | /** | 87 | /** |
105 | * Return all possible settings. | 88 | * Return all possible settings. |
106 | * @return All settings provided by the current backend | 89 | * @return All settings provided by the current backend |
107 | * (i.e.: query_WildCards & query_IgnoreCase) | 90 | * (i.e.: query_WildCards & query_IgnoreCase) |
108 | */ | 91 | */ |
109 | virtual const uint querySettings() = 0; | 92 | virtual const uint querySettings() = 0; |
110 | 93 | ||
111 | /** | 94 | /** |
112 | * Check whether settings are correct. | 95 | * Check whether settings are correct. |
113 | * @return <i>true</i> if the given settings are correct and possible. | 96 | * @return <i>true</i> if the given settings are correct and possible. |
114 | */ | 97 | */ |
115 | virtual bool hasQuerySettings (uint querySettings) const = 0; | 98 | virtual bool hasQuerySettings (uint querySettings) const = 0; |
116 | 99 | ||
117 | /** | 100 | /** |
118 | * FIXME!!! | 101 | * FIXME!!! |
119 | * Returns a sorted list of records either ascendinf or descending for a giving criteria and category | 102 | * Returns a sorted list of records either ascendinf or descending for a giving criteria and category |
120 | */ | 103 | */ |
121 | virtual QArray<int> sorted( bool ascending, int sortOrder, int sortFilter, int cat ) = 0; | 104 | virtual QArray<int> sorted( bool ascending, int sortOrder, int sortFilter, int cat ) = 0; |
122 | 105 | ||
123 | 106 | ||
124 | private: | 107 | private: |
125 | class Private; | 108 | class Private; |
126 | Private *d; | 109 | Private *d; |
127 | }; | 110 | }; |
111 | |||
112 | } | ||
113 | |||
128 | #endif | 114 | #endif |