author | zecke <zecke> | 2004-02-19 02:05:37 (UTC) |
---|---|---|
committer | zecke <zecke> | 2004-02-19 02:05:37 (UTC) |
commit | 34e732b3490bcad2cb05a1252ef5f06b3feef9ad (patch) (unidiff) | |
tree | 1114cf4d32dd0955550536f93b4054f76207c90e /libopie2 | |
parent | f98fdfa6509fd1db5ea9ee834b5808ee12c8e697 (diff) | |
download | opie-34e732b3490bcad2cb05a1252ef5f06b3feef9ad.zip opie-34e732b3490bcad2cb05a1252ef5f06b3feef9ad.tar.gz opie-34e732b3490bcad2cb05a1252ef5f06b3feef9ad.tar.bz2 |
Add notes for API fixes and BC stuff
-rw-r--r-- | libopie2/opiepim/backend/ocontactaccessbackend.h | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/libopie2/opiepim/backend/ocontactaccessbackend.h b/libopie2/opiepim/backend/ocontactaccessbackend.h index 280e05c..0eac6dc 100644 --- a/libopie2/opiepim/backend/ocontactaccessbackend.h +++ b/libopie2/opiepim/backend/ocontactaccessbackend.h | |||
@@ -6,32 +6,35 @@ | |||
6 | * Copyright (c) 2002 by Stefan Eilers (Eilers.Stefan@epost.de) | 6 | * Copyright (c) 2002 by Stefan Eilers (Eilers.Stefan@epost.de) |
7 | * Copyright (c) 2002 by Holger Freyther (zecke@handhelds.org) | 7 | * Copyright (c) 2002 by Holger Freyther (zecke@handhelds.org) |
8 | * | 8 | * |
9 | * ===================================================================== | 9 | * ===================================================================== |
10 | *This program is free software; you can redistribute it and/or | 10 | *This program is free software; you can redistribute it and/or |
11 | *modify it under the terms of the GNU Library General Public | 11 | *modify it under the terms of the GNU Library General Public |
12 | * License as published by the Free Software Foundation; | 12 | * License as published by the Free Software Foundation; |
13 | * either version 2 of the License, or (at your option) any later | 13 | * either version 2 of the License, or (at your option) any later |
14 | * version. | 14 | * version. |
15 | * ===================================================================== | 15 | * ===================================================================== |
16 | * ToDo: Define enum for query settings | 16 | * ToDo: Define enum for query settings |
17 | * ===================================================================== | 17 | * ===================================================================== |
18 | * Version: $Id$ | 18 | * Version: $Id$ |
19 | * ===================================================================== | 19 | * ===================================================================== |
20 | * History: | 20 | * History: |
21 | * $Log$ | 21 | * $Log$ |
22 | * Revision 1.7 2004/02/19 02:05:37 zecke | ||
23 | * Add notes for API fixes and BC stuff | ||
24 | * | ||
22 | * Revision 1.6 2003/08/01 12:30:16 eilers | 25 | * Revision 1.6 2003/08/01 12:30:16 eilers |
23 | * Merging changes from BRANCH_1_0 to HEAD | 26 | * Merging changes from BRANCH_1_0 to HEAD |
24 | * | 27 | * |
25 | * Revision 1.5.4.1 2003/06/30 14:34:19 eilers | 28 | * Revision 1.5.4.1 2003/06/30 14:34:19 eilers |
26 | * Patches from Zecke: | 29 | * Patches from Zecke: |
27 | * Fixing and cleaning up extraMap handling | 30 | * Fixing and cleaning up extraMap handling |
28 | * Adding d_ptr for binary compatibility in the future | 31 | * Adding d_ptr for binary compatibility in the future |
29 | * | 32 | * |
30 | * Revision 1.5 2003/04/13 18:07:10 zecke | 33 | * Revision 1.5 2003/04/13 18:07:10 zecke |
31 | * More API doc | 34 | * More API doc |
32 | * QString -> const QString& | 35 | * QString -> const QString& |
33 | * QString = 0l -> QString::null | 36 | * QString = 0l -> QString::null |
34 | * | 37 | * |
35 | * Revision 1.4 2002/11/13 14:14:51 eilers | 38 | * Revision 1.4 2002/11/13 14:14:51 eilers |
36 | * Added sorted for Contacts.. | 39 | * Added sorted for Contacts.. |
37 | * | 40 | * |
@@ -58,33 +61,39 @@ | |||
58 | #include "opimaccessbackend.h" | 61 | #include "opimaccessbackend.h" |
59 | 62 | ||
60 | #include <qregexp.h> | 63 | #include <qregexp.h> |
61 | 64 | ||
62 | /** | 65 | /** |
63 | * This class represents the interface of all Contact Backends. | 66 | * This class represents the interface of all Contact Backends. |
64 | * Derivates of this class will be used to access the contacts. | 67 | * Derivates of this class will be used to access the contacts. |
65 | * As implementation currently XML and vCard exist. This class needs to be implemented | 68 | * As implementation currently XML and vCard exist. This class needs to be implemented |
66 | * if you want to provide your own storage. | 69 | * if you want to provide your own storage. |
67 | * In all queries a list of uids is passed on instead of loading the actual record! | 70 | * In all queries a list of uids is passed on instead of loading the actual record! |
68 | * | 71 | * |
69 | * @see OContactAccessBackend_VCard | 72 | * @see OContactAccessBackend_VCard |
70 | * @see OContactAccessBackend_XML | 73 | * @see OContactAccessBackend_XML |
71 | */ | 74 | */ |
72 | class OContactAccessBackend: public OPimAccessBackend<OContact> { | 75 | class OContactAccessBackend: public OPimAccessBackend<OContact> { |
73 | public: | 76 | public: |
77 | /** | ||
78 | * @todo make non line in regard to BC guide of KDE | ||
79 | */ | ||
74 | OContactAccessBackend() {} | 80 | OContactAccessBackend() {} |
81 | /** | ||
82 | * @todo make non inline in regard to the BC guide of KDE | ||
83 | */ | ||
75 | virtual ~OContactAccessBackend() {} | 84 | virtual ~OContactAccessBackend() {} |
76 | 85 | ||
77 | 86 | ||
78 | /** | 87 | /** |
79 | * Return if database was changed externally. | 88 | * Return if database was changed externally. |
80 | * This may just make sense on file based databases like a XML-File. | 89 | * This may just make sense on file based databases like a XML-File. |
81 | * It is used to prevent to overwrite the current database content | 90 | * It is used to prevent to overwrite the current database content |
82 | * if the file was already changed by something else ! | 91 | * if the file was already changed by something else ! |
83 | * If this happens, we have to reload before save our data. | 92 | * If this happens, we have to reload before save our data. |
84 | * If we use real databases, this should be handled by the database | 93 | * If we use real databases, this should be handled by the database |
85 | * management system themselve, therefore this function should always return false in | 94 | * management system themselve, therefore this function should always return false in |
86 | * this case. It is not our problem to handle this conflict ... | 95 | * this case. It is not our problem to handle this conflict ... |
87 | * @return <i>true</i> if the database was changed and if save without reload will | 96 | * @return <i>true</i> if the database was changed and if save without reload will |
88 | * be dangerous. <i>false</i> if the database was not changed or it is save to write | 97 | * be dangerous. <i>false</i> if the database was not changed or it is save to write |
89 | * in this situation. | 98 | * in this situation. |
90 | */ | 99 | */ |