-rw-r--r-- | kabc/stdaddressbook.h | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/kabc/stdaddressbook.h b/kabc/stdaddressbook.h index cf130b3..3cd6363 100644 --- a/kabc/stdaddressbook.h +++ b/kabc/stdaddressbook.h | |||
@@ -25,127 +25,129 @@ Copyright (c) 2004 Ulf Schenk | |||
25 | $Id$ | 25 | $Id$ |
26 | */ | 26 | */ |
27 | 27 | ||
28 | #ifndef KABC_STDADDRESSBOOK_H | 28 | #ifndef KABC_STDADDRESSBOOK_H |
29 | #define KABC_STDADDRESSBOOK_H | 29 | #define KABC_STDADDRESSBOOK_H |
30 | 30 | ||
31 | #include "addressbook.h" | 31 | #include "addressbook.h" |
32 | 32 | ||
33 | namespace KABC { | 33 | namespace KABC { |
34 | 34 | ||
35 | /** | 35 | /** |
36 | Standard KDE address book | 36 | Standard KDE address book |
37 | 37 | ||
38 | This class provides access to the standard KDE address book shared by all | 38 | This class provides access to the standard KDE address book shared by all |
39 | applications. | 39 | applications. |
40 | 40 | ||
41 | It's implemented as a singleton. Use @ref self() to get the address book | 41 | It's implemented as a singleton. Use @ref self() to get the address book |
42 | object. On the first self() call the address book also gets loaded. | 42 | object. On the first self() call the address book also gets loaded. |
43 | 43 | ||
44 | Example: | 44 | Example: |
45 | 45 | ||
46 | <pre> | 46 | <pre> |
47 | KABC::AddressBook *ab = KABC::StdAddressBook::self(); | 47 | KABC::AddressBook *ab = KABC::StdAddressBook::self(); |
48 | 48 | ||
49 | KABC::AddressBook::Iterator it; | 49 | KABC::AddressBook::Iterator it; |
50 | for ( it = ab->begin(); it != ab->end(); ++it ) { | 50 | for ( it = ab->begin(); it != ab->end(); ++it ) { |
51 | kdDebug() << "UID=" << (*it).uid() << endl; | 51 | kdDebug() << "UID=" << (*it).uid() << endl; |
52 | 52 | ||
53 | // do some other stuff | 53 | // do some other stuff |
54 | } | 54 | } |
55 | 55 | ||
56 | KABC::StdAddressBook::save(); | 56 | KABC::StdAddressBook::save(); |
57 | </pre> | 57 | </pre> |
58 | */ | 58 | */ |
59 | class StdAddressBook : public AddressBook | 59 | class StdAddressBook : public AddressBook |
60 | { | 60 | { |
61 | public: | 61 | public: |
62 | 62 | ||
63 | /** | 63 | /** |
64 | Destructor. | 64 | Destructor. |
65 | */ | 65 | */ |
66 | ~StdAddressBook(); | 66 | ~StdAddressBook(); |
67 | 67 | ||
68 | /** | 68 | /** |
69 | Return the standard addressbook object. It also loads slow resources. | 69 | Return the standard addressbook object. It also loads slow resources. |
70 | It is the same as self(false); . | 70 | It is the same as self(false); . |
71 | */ | 71 | */ |
72 | static StdAddressBook *self(); | 72 | static StdAddressBook *self(); |
73 | static StdAddressBook *selfNoLoad(); | ||
73 | 74 | ||
74 | /** | 75 | /** |
75 | This is the same as above, but with specified | 76 | This is the same as above, but with specified |
76 | behaviour of resource loading. | 77 | behaviour of resource loading. |
77 | 78 | ||
78 | @param onlyFastResource Only resources marked as 'fast' should be loaded | 79 | @param onlyFastResource Only resources marked as 'fast' should be loaded |
79 | */ | 80 | */ |
80 | // FIXME for KDE4 return StdAddressBook and merge with the metod above -zecke | 81 | // FIXME for KDE4 return StdAddressBook and merge with the metod above -zecke |
81 | static StdAddressBook *self( bool onlyFastResources ); | 82 | static StdAddressBook *self( bool onlyFastResources ); |
82 | 83 | ||
83 | /** | 84 | /** |
84 | Save the standard address book to disk. | 85 | Save the standard address book to disk. |
85 | */ | 86 | */ |
86 | static bool save(); | 87 | static bool save(); |
87 | 88 | ||
88 | /** | 89 | /** |
89 | Call this method in your crash handler to allow the library clean up | 90 | Call this method in your crash handler to allow the library clean up |
90 | possible locks. | 91 | possible locks. |
91 | */ | 92 | */ |
92 | static void handleCrash(); | 93 | static void handleCrash(); |
93 | 94 | ||
94 | /** | 95 | /** |
95 | Returns the default file name for vcard-based addressbook | 96 | Returns the default file name for vcard-based addressbook |
96 | */ | 97 | */ |
97 | static QString fileName(); | 98 | static QString fileName(); |
98 | 99 | ||
99 | /** | 100 | /** |
100 | Returns the default directory name for vcard-based addressbook | 101 | Returns the default directory name for vcard-based addressbook |
101 | */ | 102 | */ |
102 | static QString directoryName(); | 103 | static QString directoryName(); |
103 | 104 | ||
104 | /** | 105 | /** |
105 | Set the automatic save property of the address book. | 106 | Set the automatic save property of the address book. |
106 | If @p enable is TRUE (default) the address book is saved at | 107 | If @p enable is TRUE (default) the address book is saved at |
107 | destruction time otherwise you have to call @ref save() to | 108 | destruction time otherwise you have to call @ref save() to |
108 | explicitely save it. | 109 | explicitely save it. |
109 | */ | 110 | */ |
110 | static void setAutomaticSave( bool enable ); | 111 | static void setAutomaticSave( bool enable ); |
111 | 112 | ||
112 | /** | 113 | /** |
113 | Closes the address book. Depending on @ref automaticSave() it will | 114 | Closes the address book. Depending on @ref automaticSave() it will |
114 | save the address book first. | 115 | save the address book first. |
115 | */ | 116 | */ |
116 | static void close(); | 117 | static void close(); |
117 | 118 | ||
118 | /** | 119 | /** |
119 | Returns whether the address book is saved at destruction time. | 120 | Returns whether the address book is saved at destruction time. |
120 | See also @ref setAutomaticSave(). | 121 | See also @ref setAutomaticSave(). |
121 | */ | 122 | */ |
122 | static bool automaticSave(); | 123 | static bool automaticSave(); |
123 | 124 | ||
124 | /** | 125 | /** |
125 | Returns the contact, that is associated with the owner of the | 126 | Returns the contact, that is associated with the owner of the |
126 | address book. This contact should be used by other programs | 127 | address book. This contact should be used by other programs |
127 | to access user specific data. | 128 | to access user specific data. |
128 | */ | 129 | */ |
129 | Addressee whoAmI(); | 130 | Addressee whoAmI(); |
130 | 131 | ||
131 | /** | 132 | /** |
132 | Sets the users contact. See @ref whoAmI() for more information. | 133 | Sets the users contact. See @ref whoAmI() for more information. |
133 | 134 | ||
134 | @param uid The uid of the users contact. | 135 | @param uid The uid of the users contact. |
135 | */ | 136 | */ |
136 | void setWhoAmI( const Addressee &addr ); | 137 | void setWhoAmI( const Addressee &addr ); |
137 | void init( bool onlyFastResources ); | 138 | void init( bool onlyFastResources ); |
138 | 139 | ||
139 | protected: | 140 | protected: |
140 | StdAddressBook(); | 141 | StdAddressBook(); |
142 | StdAddressBook( QString ); | ||
141 | StdAddressBook( bool onlyFastResources ); | 143 | StdAddressBook( bool onlyFastResources ); |
142 | 144 | ||
143 | 145 | ||
144 | private: | 146 | private: |
145 | static QString setTempAppDir(); | 147 | static QString setTempAppDir(); |
146 | static StdAddressBook *mSelf; | 148 | static StdAddressBook *mSelf; |
147 | static bool mAutomaticSave; | 149 | static bool mAutomaticSave; |
148 | }; | 150 | }; |
149 | 151 | ||
150 | } | 152 | } |
151 | #endif | 153 | #endif |