summaryrefslogtreecommitdiffabout
path: root/kaddressbook/kaddressbookview.h
Unidiff
Diffstat (limited to 'kaddressbook/kaddressbookview.h') (more/less context) (ignore whitespace changes)
-rw-r--r--kaddressbook/kaddressbookview.h6
1 files changed, 4 insertions, 2 deletions
diff --git a/kaddressbook/kaddressbookview.h b/kaddressbook/kaddressbookview.h
index 6bbb9c2..3a3f71a 100644
--- a/kaddressbook/kaddressbookview.h
+++ b/kaddressbook/kaddressbookview.h
@@ -185,128 +185,130 @@ class KAddressBookView : public QWidget
185 185
186 signals: 186 signals:
187 187
188 void printView(); 188 void printView();
189 /** 189 /**
190 This signal should be emitted by a subclass whenever an addressee 190 This signal should be emitted by a subclass whenever an addressee
191 is modified. 191 is modified.
192 */ 192 */
193 void modified(); 193 void modified();
194 194
195 /** 195 /**
196 This signal should be emitted by a subclass whenever an addressee 196 This signal should be emitted by a subclass whenever an addressee
197 is selected. Selected means that the addressee was given the focus. 197 is selected. Selected means that the addressee was given the focus.
198 Some widgets may call this 'highlighted'. The view is responsible for 198 Some widgets may call this 'highlighted'. The view is responsible for
199 emitting this signal multiple times if multiple items are selected, 199 emitting this signal multiple times if multiple items are selected,
200 with the last item selected being the last emit. 200 with the last item selected being the last emit.
201 201
202 @param uid The uid of the selected addressee. 202 @param uid The uid of the selected addressee.
203 203
204 @see KListView 204 @see KListView
205 */ 205 */
206 void selected( const QString &uid ); 206 void selected( const QString &uid );
207 void deleteRequest(); 207 void deleteRequest();
208 /** 208 /**
209 This signal should be emitted by a subclass whenever an addressee 209 This signal should be emitted by a subclass whenever an addressee
210 is executed. This is defined by the KDE system wide config, but it 210 is executed. This is defined by the KDE system wide config, but it
211 either means single or doubleclicked. 211 either means single or doubleclicked.
212 212
213 @param ui The uid of the selected addressee 213 @param ui The uid of the selected addressee
214 214
215 @see KListView 215 @see KListView
216 */ 216 */
217 void executed( const QString &uid ); 217 void executed( const QString &uid );
218 218
219 /** 219 /**
220 This signal is emitted whenever a user attempts to start a drag 220 This signal is emitted whenever a user attempts to start a drag
221 in the view. The slot connected to this signal would usually want 221 in the view. The slot connected to this signal would usually want
222 to create a QDragObject. 222 to create a QDragObject.
223 */ 223 */
224 void startDrag(); 224 void startDrag();
225 225
226 /** 226 /**
227 This signal is emitted whenever the user drops something on the 227 This signal is emitted whenever the user drops something on the
228 view. The individual view should handle checking if the item is 228 view. The individual view should handle checking if the item is
229 droppable (ie: if it is a vcard). 229 droppable (ie: if it is a vcard).
230 */ 230 */
231 void dropped( QDropEvent* ); 231 void dropped( QDropEvent* );
232 232
233 protected: 233 protected:
234
234 /** 235 /**
235 Returns a list of the addressees that should be displayed. This method 236 Returns a list of the addressees that should be displayed. This method
236 should always be used by the subclass to get a list of addressees. This 237 should always be used by the subclass to get a list of addressees. This
237 method internally takes many factors into account, including the current 238 method internally takes many factors into account, including the current
238 filter. 239 filter.
239 */ 240 */
240 KABC::Addressee::List addressees(); 241 KABC::Addressee::List addressees();
241 242
242 /** 243 /**
243 This method returns the widget that should be used as the parent for 244 This method returns the widget that should be used as the parent for
244 all view components. By using this widget as the parent and not 245 all view components. By using this widget as the parent and not
245 'this', the view subclass has the option of placing other widgets 246 'this', the view subclass has the option of placing other widgets
246 around the view (ie: search fields, etc). Do not delete this widget! 247 around the view (ie: search fields, etc). Do not delete this widget!
247 */ 248 */
248 QWidget *viewWidget(); 249 QWidget *viewWidget();
249 QRegExp getRegExp( const QString ); 250 QRegExp getRegExp( const QString );
250 251
251 private: 252 private:
252 void initGUI(); 253 void initGUI();
253 254
254 DefaultFilterType mDefaultFilterType; 255 DefaultFilterType mDefaultFilterType;
255 Filter mFilter; 256 Filter mFilter;
256 QString mDefaultFilterName; 257 QString mDefaultFilterName;
257 KABC::AddressBook *mAddressBook; 258 KABC::AddressBook *mAddressBook;
258 KABC::Field::List mFieldList; 259 KABC::Field::List mFieldList;
259 260
260 QWidget *mViewWidget; 261 QWidget *mViewWidget;
261}; 262};
262 263
263#ifndef KAB_EMBEDDED 264#ifndef KAB_EMBEDDED
264//MOC_SKIP_BEGIN 265//MOC_SKIP_BEGIN
265class ViewFactory : public KLibFactory 266class ViewFactory : public KLibFactory
266//MOC_SKIP_END 267//MOC_SKIP_END
267#else //KAB_EMBEDDED 268#else //KAB_EMBEDDED
268class ViewFactory 269class ViewFactory
269#endif //KAB_EMBEDDED 270#endif //KAB_EMBEDDED
270{ 271{
271 272
272 public: 273 public:
273 virtual KAddressBookView *view( KABC::AddressBook *ab, QWidget *parent, 274 virtual KAddressBookView *view( KABC::AddressBook *ab, QWidget *parent,
274 const char *name = 0 ) = 0; 275 const char *name = 0 ) = 0;
275 276
276 /** 277 /**
277 @return The type of the view. This is normally a small one word 278 @return The type of the view. This is normally a small one word
278 string (ie: Table, Icon, Tree, etc). 279 string (ie: Table, Icon, Tree, etc).
279 */ 280 */
280 virtual QString type() const = 0; 281 virtual QString type() const = 0;
281 282
282 /** 283 /**
283 @return The description of the view. This should be a 3 to 284 @return The description of the view. This should be a 3 to
284 4 line string (don't actually use return characters in the string) 285 4 line string (don't actually use return characters in the string)
285 describing the features offered by the view. 286 describing the features offered by the view.
286 */ 287 */
287 virtual QString description() const = 0; 288 virtual QString description() const = 0;
288 289
289 /** 290 /**
290 Creates a config dialog for the view type. The default 291 Creates a config dialog for the view type. The default
291 implementation will return a ViewConfigDialog. This default 292 implementation will return a ViewConfigDialog. This default
292 dialog will allow the user to set the visible fields only. If 293 dialog will allow the user to set the visible fields only. If
293 you need more config options (as most views will), this method 294 you need more config options (as most views will), this method
294 can be overloaded to return your sublcass of ViewConfigDialog. 295 can be overloaded to return your sublcass of ViewConfigDialog.
295 If this method is over loaded the base classes method should 296 If this method is over loaded the base classes method should
296 <B>not</B> be called. 297 <B>not</B> be called.
297 */ 298 */
298 virtual ViewConfigureWidget *configureWidget( KABC::AddressBook *ab, 299 virtual ViewConfigureWidget *configureWidget( KABC::AddressBook *ab,
299 QWidget *parent, 300 QWidget *parent,
300 const char *name = 0 ); 301 const char *name = 0 );
301 302
302 protected: 303 protected:
303 virtual QObject* createObject( QObject*, const char*, const char*, 304 virtual QObject* createObject( QObject*, const char*, const char*,
304 const QStringList & ) 305 const QStringList & )
305 { 306 {
306 return 0; 307 return 0;
307 } 308 }
309
308 310
309}; 311};
310 312
311 313
312#endif 314#endif