summaryrefslogtreecommitdiff
path: root/libopie/pim/ocontactaccess.h
Unidiff
Diffstat (limited to 'libopie/pim/ocontactaccess.h') (more/less context) (ignore whitespace changes)
-rw-r--r--libopie/pim/ocontactaccess.h16
1 files changed, 13 insertions, 3 deletions
diff --git a/libopie/pim/ocontactaccess.h b/libopie/pim/ocontactaccess.h
index 32b2dcb..d7ceaf2 100644
--- a/libopie/pim/ocontactaccess.h
+++ b/libopie/pim/ocontactaccess.h
@@ -16,8 +16,13 @@
16 * Version: $Id$ 16 * Version: $Id$
17 * ===================================================================== 17 * =====================================================================
18 * History: 18 * History:
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
21 * Improved query by example: Search by date is possible.. First step 26 * Improved query by example: Search by date is possible.. First step
22 * for a today plugin for birthdays.. 27 * for a today plugin for birthdays..
23 * 28 *
@@ -54,19 +59,24 @@
54#include "ocontact.h" 59#include "ocontact.h"
55#include "ocontactaccessbackend.h" 60#include "ocontactaccessbackend.h"
56#include "opimaccesstemplate.h" 61#include "opimaccesstemplate.h"
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
62 */ 71 */
63class OContactAccess: public QObject, public OPimAccessTemplate<OContact> 72class OContactAccess: public QObject, public OPimAccessTemplate<OContact>
64{ 73{
65 Q_OBJECT 74 Q_OBJECT
66 75
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
70 * (i.e. "todolist") 80 * (i.e. "todolist")
71 * @param filename The name of the database file. If not set, the default one 81 * @param filename The name of the database file. If not set, the default one
72 * is used. 82 * is used.
@@ -98,9 +108,9 @@ class OContactAccess: public QObject, public OPimAccessTemplate<OContact>
98 DateMonth = 0x0080, // The month matches 108 DateMonth = 0x0080, // The month matches
99 DateDay = 0x0100, // The day matches 109 DateDay = 0x0100, // The day matches
100 }; 110 };
101 111
102 112
103 ORecordList<OContact> matchRegexp( const QRegExp &r )const; 113 ORecordList<OContact> matchRegexp( const QRegExp &r )const;
104 114
105 /** Return all Contacts in a sorted manner. 115 /** Return all Contacts in a sorted manner.
106 * @param ascending true: Sorted in acending order. 116 * @param ascending true: Sorted in acending order.