~ubuntu-branches/ubuntu/saucy/kopete/saucy-proposed

« back to all changes in this revision

Viewing changes to libkopete/kabcpersistence.h

  • Committer: Package Import Robot
  • Author(s): Jonathan Riddell
  • Date: 2013-06-21 02:22:39 UTC
  • Revision ID: package-import@ubuntu.com-20130621022239-63l3zc8p0nf26pt6
Tags: upstream-4.10.80
ImportĀ upstreamĀ versionĀ 4.10.80

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
/*
 
2
    addressbooklink.h - Manages operations involving the KDE Address Book
 
3
 
 
4
    Copyright (c) 2005 Will Stephenson <wstephenson@kde.org>
 
5
 
 
6
    Kopete    (c) 2002-2004 by the Kopete developers  <kopete-devel@kde.org>
 
7
 
 
8
    *************************************************************************
 
9
    *                                                                       *
 
10
    * This library is free software; you can redistribute it and/or         *
 
11
    * modify it under the terms of the GNU Lesser General Public            *
 
12
    * License as published by the Free Software Foundation; either          *
 
13
    * version 2 of the License, or (at your option) any later version.      *
 
14
    *                                                                       *
 
15
    *************************************************************************
 
16
*/
 
17
 
 
18
#ifndef KABCPERSISTENCE_H
 
19
#define KABCPERSISTENCE_H
 
20
 
 
21
#include "kopete_export.h"
 
22
 
 
23
// Goal is to have all the address book modifying code in one place
 
24
// Currently in 
 
25
// *) Add Contact Wizard
 
26
// *) KopeteMetaContact
 
27
// *) KopeteAddrBookExport
 
28
// *) KABC Export Wizard - TODO - think about sequence of events when adding addressees AND writing their IM data. - Extra save should be unnecessary because we are sharing a kabc instance
 
29
// *) Select addressbook entry
 
30
 
 
31
namespace KABC
 
32
{
 
33
        class AddressBook;
 
34
        class Resource;
 
35
}
 
36
 
 
37
namespace Kopete
 
38
{
 
39
 
 
40
        class MetaContact;
 
41
        
 
42
class KOPETE_EXPORT KABCPersistence : public QObject
 
43
{
 
44
        Q_OBJECT
 
45
        public:
 
46
                /**
 
47
                 * \brief Retrieve the instance of AccountManager.
 
48
                 *
 
49
                 * The account manager is a singleton class of which only a single
 
50
                 * instance will exist. If no manager exists yet this function will
 
51
                 * create one for you.
 
52
                 *
 
53
                 * \return the instance of the AccountManager
 
54
                 */
 
55
                static KABCPersistence* self();
 
56
                
 
57
                explicit KABCPersistence( QObject * parent = 0, const char * name = 0 );
 
58
                ~KABCPersistence();
 
59
                /**
 
60
                 * @brief Access Kopete's KDE address book instance
 
61
                 */
 
62
                static KABC::AddressBook* addressBook();
 
63
                /**
 
64
                 * @brief Change the KABC data associated with this metacontact
 
65
                 *
 
66
                 * The KABC exposed data changed, so change it in KABC.
 
67
                 * Replaces Kopete::MetaContact::updateKABC()
 
68
                 */
 
69
                void write( MetaContact * mc );
 
70
 
 
71
                /**
 
72
                 * @brief Remove any KABC data for this meta contact
 
73
                 */
 
74
                void removeKABC( MetaContact * mc );
 
75
        
 
76
                /**
 
77
                 * Check for any new addresses added to this contact's KABC entry
 
78
                 * and prompt if they should be added in Kopete too.
 
79
                 * @return whether any contacts were added from KABC.
 
80
                 */
 
81
                bool syncWithKABC( MetaContact * mc );
 
82
                
 
83
                /**
 
84
                 * Request an address book write, will be delayed to bundle any others happening around the same time
 
85
                 */
 
86
                void writeAddressBook( KABC::Resource * res );
 
87
        protected:
 
88
 
 
89
                static void splitField( const QString &str, QString &app, QString &name, QString &value );
 
90
        protected slots:
 
91
                /**
 
92
                 * Perform a delayed address book write
 
93
                 */
 
94
                void slotWriteAddressBook();
 
95
        private:
 
96
                class Private;
 
97
                Private * const d;
 
98
};
 
99
 
 
100
} // end namespace Kopete
 
101
 
 
102
#endif // KABCPERSISTENCE_H