summaryrefslogtreecommitdiff
path: root/libopie2/opiepim/core/ocontactaccess.h
authoreilers <eilers>2004-12-20 14:14:07 (UTC)
committer eilers <eilers>2004-12-20 14:14:07 (UTC)
commit18e47153532d016d878f47e0ce11cb1a9716218e (patch) (side-by-side diff)
tree52eb6c25258fda0b2f295a29809c4603f5e17b0b /libopie2/opiepim/core/ocontactaccess.h
parent876e48baa20213d8265041cfac3034fe92cb0590 (diff)
downloadopie-18e47153532d016d878f47e0ce11cb1a9716218e.zip
opie-18e47153532d016d878f47e0ce11cb1a9716218e.tar.gz
opie-18e47153532d016d878f47e0ce11cb1a9716218e.tar.bz2
Recovery of the following Changes:
* Implement fast and full featured version of sorted() for addressbook * Implement generic queryByExample for all Addressboook backends. It allows incremental search. * Update of API Documentation
Diffstat (limited to 'libopie2/opiepim/core/ocontactaccess.h') (more/less context) (ignore whitespace changes)
-rw-r--r--libopie2/opiepim/core/ocontactaccess.h37
1 files changed, 29 insertions, 8 deletions
diff --git a/libopie2/opiepim/core/ocontactaccess.h b/libopie2/opiepim/core/ocontactaccess.h
index 691ece2..bd85b4e 100644
--- a/libopie2/opiepim/core/ocontactaccess.h
+++ b/libopie2/opiepim/core/ocontactaccess.h
@@ -60,21 +60,38 @@ class OPimContactAccess: public QObject, public OPimAccessTemplate<OPimContact>
Q_OBJECT
public:
+ /**
+ * Filter for sorted()
+ * @see SortFilterBase in OPimBase
+ */
enum SortFilter {
- DoNotShowNoneChildren = FilterCustom<<1,
- DoNotShowNoneAnniversary = FilterCustom<<2,
- DoNotShowNoneBirthday = FilterCustom<<3,
- DoNotShowNoHomeAddress = FilterCustom<<4,
- DoNotShowNoBusinessAddress = FilterCustom<<5
+ /** Don't return entries who don't have children */
+ DoNotShowWithoutChildren = FilterCustom<<1,
+ /** Don't return entries who don't have an anniversary */
+ DoNotShowWithoutAnniversary = FilterCustom<<2,
+ /** Don't return entries who don't have a birthday */
+ DoNotShowWithoutBirthday = FilterCustom<<3,
+ /** Don't return entries who don't have a home address */
+ DoNotShowWithoutHomeAddress = FilterCustom<<4,
+ /** Don't return entries who don't have a business address */
+ DoNotShowWithoutBusinessAddress = FilterCustom<<5,
+ /** Don't return entries which hava any category */
+ DoNotShowWithCategory = FilterCustom << 6
};
+ /**
+ * Sort order for sorted()
+ * @see SortOrderBase in OPimBase
+ */
enum SortOrder {
SortTitle = SortCustom,
SortFirstName,
SortMiddleName,
+ SortLastName,
SortSuffix,
SortEmail,
SortNickname,
+ SortFileAsName,
SortAnniversary,
SortBirthday,
SortGender
@@ -99,14 +116,18 @@ class OPimContactAccess: public QObject, public OPimAccessTemplate<OPimContact>
~OPimContactAccess ();
- /** Return all possible settings.
+ /**
+ * Return all possible settings for queryByExample().
* @return All settings provided by the current backend
- * (i.e.: query_WildCards & query_IgnoreCase)
+ * (i.e.: WildCards & IgnoreCase)
+ * @see QuerySettings in OPimBase for details of the parameter
*/
const uint querySettings();
- /** Check whether settings are correct.
+ /**
+ * Check whether settings are correct for queryByExample().
* @return <i>true</i> if the given settings are correct and possible.
+ * @see QuerySettings in OPimBase for details of the parameter
*/
bool hasQuerySettings ( int querySettings ) const;