author | zecke <zecke> | 2002-09-22 19:25:33 (UTC) |
---|---|---|
committer | zecke <zecke> | 2002-09-22 19:25:33 (UTC) |
commit | 3f194c85b5b9243ff30f1067361ef9fa5bb85a1e (patch) (unidiff) | |
tree | 909eae5d629918d579424a8ca644d6795b43faaf /libopie/pim/orecordlist.h | |
parent | 4904161b6b043e1397db4affd7930fd999ff742e (diff) | |
download | opie-3f194c85b5b9243ff30f1067361ef9fa5bb85a1e.zip opie-3f194c85b5b9243ff30f1067361ef9fa5bb85a1e.tar.gz opie-3f194c85b5b9243ff30f1067361ef9fa5bb85a1e.tar.bz2 |
Some documentation
and addition to OTodoAccess
overDue and effectiveTodos
-rw-r--r-- | libopie/pim/orecordlist.h | 40 |
1 files changed, 38 insertions, 2 deletions
diff --git a/libopie/pim/orecordlist.h b/libopie/pim/orecordlist.h index a3955b0..3b30a73 100644 --- a/libopie/pim/orecordlist.h +++ b/libopie/pim/orecordlist.h | |||
@@ -9,3 +9,9 @@ | |||
9 | 9 | ||
10 | 10 | /** | |
11 | * Our List Iterator | ||
12 | * it behaves like STL or Qt | ||
13 | * | ||
14 | * for(it = list.begin(); it != list.end(); ++it ) | ||
15 | * doSomeCoolStuff( (*it) ); | ||
16 | */ | ||
11 | template <class T = OPimRecord> | 17 | template <class T = OPimRecord> |
@@ -14,7 +20,22 @@ public: | |||
14 | typedef OTemplateBase<T> Base; | 20 | typedef OTemplateBase<T> Base; |
21 | |||
22 | /** | ||
23 | * The c'tor used internally from | ||
24 | * ORecordList | ||
25 | */ | ||
15 | ORecordListIterator( const QArray<int>, const Base* ); | 26 | ORecordListIterator( const QArray<int>, const Base* ); |
27 | |||
28 | /** | ||
29 | * The standard c'tor | ||
30 | */ | ||
16 | ORecordListIterator(); | 31 | ORecordListIterator(); |
17 | ~ORecordListIterator(); | 32 | ~ORecordListIterator(); |
33 | |||
18 | ORecordListIterator( const ORecordListIterator& ); | 34 | ORecordListIterator( const ORecordListIterator& ); |
19 | ORecordListIterator &operator=(const ORecordListIterator& ); | 35 | ORecordListIterator &operator=(const ORecordListIterator& ); |
36 | |||
37 | /** | ||
38 | * a * operator ;) | ||
39 | * use it like this T = (*it); | ||
40 | */ | ||
20 | T &operator*(); | 41 | T &operator*(); |
@@ -37,3 +58,6 @@ private: | |||
37 | }; | 58 | }; |
38 | 59 | /** | |
60 | * The recordlist used as a return type | ||
61 | * from OPimAccessTemplate | ||
62 | */ | ||
39 | template <class T = OPimRecord > | 63 | template <class T = OPimRecord > |
@@ -43,2 +67,6 @@ public: | |||
43 | typedef ORecordListIterator<T> Iterator; | 67 | typedef ORecordListIterator<T> Iterator; |
68 | |||
69 | /** | ||
70 | * c'tor | ||
71 | */ | ||
44 | ORecordList( const QArray<int>& ids, | 72 | ORecordList( const QArray<int>& ids, |
@@ -46,3 +74,11 @@ public: | |||
46 | ~ORecordList(); | 74 | ~ORecordList(); |
75 | |||
76 | /** | ||
77 | * the first iterator | ||
78 | */ | ||
47 | Iterator begin(); | 79 | Iterator begin(); |
80 | |||
81 | /** | ||
82 | * the end | ||
83 | */ | ||
48 | Iterator end(); | 84 | Iterator end(); |