summaryrefslogtreecommitdiffstats
path: root/kaddressbook/interfaces/core.h
diff options
context:
space:
mode:
authortoma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2009-11-25 17:56:58 +0000
committertoma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2009-11-25 17:56:58 +0000
commit460c52653ab0dcca6f19a4f492ed2c5e4e963ab0 (patch)
tree67208f7c145782a7e90b123b982ca78d88cc2c87 /kaddressbook/interfaces/core.h
downloadtdepim-460c52653ab0dcca6f19a4f492ed2c5e4e963ab0.tar.gz
tdepim-460c52653ab0dcca6f19a4f492ed2c5e4e963ab0.zip
Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features.
BUG:215923 git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdepim@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da
Diffstat (limited to 'kaddressbook/interfaces/core.h')
-rw-r--r--kaddressbook/interfaces/core.h203
1 files changed, 203 insertions, 0 deletions
diff --git a/kaddressbook/interfaces/core.h b/kaddressbook/interfaces/core.h
new file mode 100644
index 00000000..276b20d6
--- /dev/null
+++ b/kaddressbook/interfaces/core.h
@@ -0,0 +1,203 @@
+/*
+ This file is part of KAddressbook.
+ Copyright (c) 2003 Tobias Koenig <tokoe@kde.org>
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program; if not, write to the Free Software
+ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+
+ As a special exception, permission is given to link this program
+ with any edition of Qt, and distribute the resulting executable,
+ without including the source code for Qt in the source distribution.
+*/
+
+#ifndef KAB_CORE_H
+#define KAB_CORE_H
+
+#include <config.h> // for KDEPIM_NEW_DISTRLISTS
+
+#ifdef KDEPIM_NEW_DISTRLISTS
+#include <libkdepim/distributionlist.h>
+#endif
+
+#include <qobject.h>
+
+#include <kabc/field.h>
+#include <kcommand.h>
+#include <kxmlguiclient.h>
+#include <kdepimmacros.h>
+
+namespace KABC {
+class AddressBook;
+class Resource;
+}
+
+class QWidget;
+
+class KActionCollection;
+class KConfig;
+class KURL;
+
+namespace KAB {
+
+class SearchManager;
+
+class KDE_EXPORT Core : public QObject
+{
+ Q_OBJECT
+
+ public:
+ Core( KXMLGUIClient *client, QObject *parent, const char *name = 0 );
+
+ /**
+ Returns a pointer to the StdAddressBook of the application.
+ */
+ virtual KABC::AddressBook *addressBook() const = 0;
+
+ /**
+ Returns a pointer to the KConfig object of the application.
+ */
+ virtual KConfig *config() const = 0;
+
+ /**
+ Returns a pointer to the global KActionCollection object. So
+ other classes can register their actions easily.
+ */
+ virtual KActionCollection *actionCollection() const = 0;
+
+ /**
+ Returns a pointer to the gui client.
+ */
+ virtual KXMLGUIClient *guiClient() const { return mGUIClient; }
+
+ /**
+ Returns the current sort field.
+ */
+ virtual KABC::Field *currentSortField() const = 0;
+
+ /**
+ Returns the uid list of the currently selected contacts.
+ */
+ virtual QStringList selectedUIDs() const = 0;
+
+ /**
+ Displays a ResourceSelectDialog and returns the selected
+ resource or a null pointer if no resource was selected by
+ the user.
+ */
+ virtual KABC::Resource *requestResource( QWidget *parent ) = 0;
+
+ /**
+ Returns the parent widget.
+ */
+ virtual QWidget *widget() const = 0;
+
+ /**
+ Deletes given contacts from the address book.
+
+ @param uids The uids of the contacts, which shall be deleted.
+ */
+ virtual void deleteContacts( const QStringList &uids ) = 0;
+
+ /**
+ Deletes given contacts from the address book.
+
+ @param uids The uids of the contacts, which shall be deleted.
+ */
+ virtual void deleteDistributionLists( const QStringList &uids ) = 0;
+
+#ifdef KDEPIM_NEW_DISTRLISTS
+ /**
+ Returns all the distribution lists.
+ */
+ virtual KPIM::DistributionList::List distributionLists() const = 0;
+
+
+ /**
+ Returns the name of all the distribution lists.
+ */
+ virtual QStringList distributionListNames() const = 0;
+
+ /**
+ sets the distribution list to display. If null, the regular
+ address book is to be displayed.
+ */
+ virtual void setSelectedDistributionList( const QString &name ) = 0;
+#endif
+
+ //// This class isn't part of interfaces/, so this method here isn't really useful
+ virtual SearchManager *searchManager() const = 0;
+
+ virtual KCommandHistory *commandHistory() const = 0;
+
+ signals:
+ /**
+ Forwarded from SearchManager
+ After it is emitted, distributionListNames() might have a different result.
+ */
+ void contactsUpdated();
+
+ public slots:
+ /**
+ Is called whenever a contact is selected in the view.
+ */
+ virtual void setContactSelected( const QString &uid ) = 0;
+
+ /**
+ DCOP METHOD: Adds the given email address to address book.
+ */
+ virtual void addEmail( const QString& addr ) = 0;
+
+ /**
+ DCOP METHOD: Imports the vCard, located at the given url.
+ */
+ virtual void importVCard( const KURL& url ) = 0;
+
+ /**
+ DCOP METHOD: Imports the given vCard.
+ */
+ virtual void importVCardFromData( const QString& vCard ) = 0;
+
+ /**
+ DCOP METHOD: Opens contact editor to input a new contact.
+ */
+ virtual void newContact() = 0;
+
+ /**
+ DCOP METHOD: Opens distribution list editor to input a new distribution list.
+ */
+ virtual void newDistributionList() = 0;
+
+ /**
+ DCOP METHOD: Returns the name of the contact, that matches the given
+ phone number.
+ */
+ virtual QString getNameByPhone( const QString& phone ) = 0;
+
+ /**
+ Shows an edit dialog for the given uid.
+ */
+ virtual void editContact( const QString &uid = QString::null ) = 0;
+
+ /**
+ Shows an edit dialog for the given distribution list
+ */
+ virtual void editDistributionList( const QString &name ) = 0;
+
+ private:
+ KXMLGUIClient *mGUIClient;
+};
+
+}
+
+#endif