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/core | |
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
-rw-r--r-- | libopie2/opiepim/core/ocontactaccess.h | 16 | ||||
-rw-r--r-- | libopie2/opiepim/core/odatebookaccess.cpp | 28 | ||||
-rw-r--r-- | libopie2/opiepim/core/odatebookaccess.h | 15 |
3 files changed, 53 insertions, 6 deletions
diff --git a/libopie2/opiepim/core/ocontactaccess.h b/libopie2/opiepim/core/ocontactaccess.h index 32b2dcb..d7ceaf2 100644 --- a/libopie2/opiepim/core/ocontactaccess.h +++ b/libopie2/opiepim/core/ocontactaccess.h | |||
@@ -19,2 +19,7 @@ | |||
19 | * $Log$ | 19 | * $Log$ |
20 | * Revision 1.7 2003/04/13 18:07:10 zecke | ||
21 | * More API doc | ||
22 | * QString -> const QString& | ||
23 | * QString = 0l -> QString::null | ||
24 | * | ||
20 | * Revision 1.6 2003/01/02 14:27:12 eilers | 25 | * Revision 1.6 2003/01/02 14:27:12 eilers |
@@ -57,5 +62,9 @@ | |||
57 | 62 | ||
58 | /** Class to access the contacts database. | 63 | /** |
64 | * Class to access the contacts database. | ||
59 | * This is just a frontend for the real database handling which is | 65 | * This is just a frontend for the real database handling which is |
60 | * done by the backend. | 66 | * done by the backend. |
67 | * This class is used to access the Contacts on a system. This class as any OPIE PIM | ||
68 | * class is backend independent. | ||
69 | |||
61 | * @see OPimAccessTemplate | 70 | * @see OPimAccessTemplate |
@@ -67,3 +76,4 @@ class OContactAccess: public QObject, public OPimAccessTemplate<OContact> | |||
67 | public: | 76 | public: |
68 | /** Create Database with contacts (addressbook). | 77 | /** |
78 | * Create Database with contacts (addressbook). | ||
69 | * @param appname Name of application which wants access to the database | 79 | * @param appname Name of application which wants access to the database |
@@ -101,3 +111,3 @@ class OContactAccess: public QObject, public OPimAccessTemplate<OContact> | |||
101 | 111 | ||
102 | 112 | ||
103 | ORecordList<OContact> matchRegexp( const QRegExp &r )const; | 113 | ORecordList<OContact> matchRegexp( const QRegExp &r )const; |
diff --git a/libopie2/opiepim/core/odatebookaccess.cpp b/libopie2/opiepim/core/odatebookaccess.cpp index 08e61ff..a3661a3 100644 --- a/libopie2/opiepim/core/odatebookaccess.cpp +++ b/libopie2/opiepim/core/odatebookaccess.cpp | |||
@@ -3,2 +3,9 @@ | |||
3 | 3 | ||
4 | /** | ||
5 | * Simple constructor | ||
6 | * It takes a ODateBookAccessBackend as parent. If it is 0 the default implementation | ||
7 | * will be used! | ||
8 | * @param back The backend to be used or 0 for the default backend | ||
9 | * @param ac What kind of access is intended | ||
10 | */ | ||
4 | ODateBookAccess::ODateBookAccess( ODateBookAccessBackend* back, enum Access ac ) | 11 | ODateBookAccess::ODateBookAccess( ODateBookAccessBackend* back, enum Access ac ) |
@@ -14,2 +21,6 @@ ODateBookAccess::~ODateBookAccess() { | |||
14 | } | 21 | } |
22 | |||
23 | /** | ||
24 | * @return all events available | ||
25 | */ | ||
15 | ODateBookAccess::List ODateBookAccess::rawEvents()const { | 26 | ODateBookAccess::List ODateBookAccess::rawEvents()const { |
@@ -20,2 +31,6 @@ ODateBookAccess::List ODateBookAccess::rawEvents()const { | |||
20 | } | 31 | } |
32 | |||
33 | /** | ||
34 | * @return all repeating events | ||
35 | */ | ||
21 | ODateBookAccess::List ODateBookAccess::rawRepeats()const { | 36 | ODateBookAccess::List ODateBookAccess::rawRepeats()const { |
@@ -26,2 +41,6 @@ ODateBookAccess::List ODateBookAccess::rawRepeats()const { | |||
26 | } | 41 | } |
42 | |||
43 | /** | ||
44 | * @return all non repeating events | ||
45 | */ | ||
27 | ODateBookAccess::List ODateBookAccess::nonRepeats()const { | 46 | ODateBookAccess::List ODateBookAccess::nonRepeats()const { |
@@ -32,2 +51,8 @@ ODateBookAccess::List ODateBookAccess::nonRepeats()const { | |||
32 | } | 51 | } |
52 | |||
53 | /** | ||
54 | * @return dates in the time span between from and to | ||
55 | * @param from Include all events from... | ||
56 | * @param to Include all events to... | ||
57 | */ | ||
33 | OEffectiveEvent::ValueList ODateBookAccess::effectiveEvents( const QDate& from, const QDate& to ) { | 58 | OEffectiveEvent::ValueList ODateBookAccess::effectiveEvents( const QDate& from, const QDate& to ) { |
@@ -35,2 +60,5 @@ OEffectiveEvent::ValueList ODateBookAccess::effectiveEvents( const QDate& from, | |||
35 | } | 60 | } |
61 | /** | ||
62 | * @return all events at a given datetime | ||
63 | */ | ||
36 | OEffectiveEvent::ValueList ODateBookAccess::effectiveEvents( const QDateTime& start ) { | 64 | OEffectiveEvent::ValueList ODateBookAccess::effectiveEvents( const QDateTime& start ) { |
diff --git a/libopie2/opiepim/core/odatebookaccess.h b/libopie2/opiepim/core/odatebookaccess.h index 7047039..7c7a63f 100644 --- a/libopie2/opiepim/core/odatebookaccess.h +++ b/libopie2/opiepim/core/odatebookaccess.h | |||
@@ -8,2 +8,11 @@ | |||
8 | 8 | ||
9 | /** | ||
10 | * This is the object orientated datebook database. It'll use OBackendFactory | ||
11 | * to query for a backend. | ||
12 | * All access to the datebook should be done via this class. | ||
13 | * Make sure to load and save the datebook this is not part of | ||
14 | * destructing and creating the object | ||
15 | * | ||
16 | * @author Holger Freyther | ||
17 | */ | ||
9 | class ODateBookAccess : public OPimAccessTemplate<OEvent> { | 18 | class ODateBookAccess : public OPimAccessTemplate<OEvent> { |
@@ -13,9 +22,9 @@ public: | |||
13 | 22 | ||
14 | /** return all events */ | 23 | /* return all events */ |
15 | List rawEvents()const; | 24 | List rawEvents()const; |
16 | 25 | ||
17 | /** return repeating events */ | 26 | /* return repeating events */ |
18 | List rawRepeats()const; | 27 | List rawRepeats()const; |
19 | 28 | ||
20 | /** return non repeating events */ | 29 | /* return non repeating events */ |
21 | List nonRepeats()const; | 30 | List nonRepeats()const; |