• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdenetwork API Reference
  • KDE Home
  • Contact Us
 

kopete/libkopete

  • sources
  • kde-4.14
  • kdenetwork
  • kopete
  • libkopete
kopeteplugin.h
Go to the documentation of this file.
1 /*
2  kopeteplugin.h - Kopete Plugin API
3 
4  Copyright (c) 2001-2002 by Duncan Mac-Vicar Prett <duncan@kde.org>
5  Copyright (c) 2002-2003 by Martijn Klingens <klingens@kde.org>
6  Copyright (c) 2002-2005 by Olivier Goffart <ogoffart@kde.org>
7 
8  Copyright (c) 2002-2003 by the Kopete developers <kopete-devel@kde.org>
9 
10  *************************************************************************
11  * *
12  * This library is free software; you can redistribute it and/or *
13  * modify it under the terms of the GNU Lesser General Public *
14  * License as published by the Free Software Foundation; either *
15  * version 2 of the License, or (at your option) any later version. *
16  * *
17  *************************************************************************
18 */
19 
20 #ifndef KOPETEPLUGIN_H
21 #define KOPETEPLUGIN_H
22 
23 #include <kxmlguiclient.h>
24 #include <QtCore/QObject>
25 #include <kdemacros.h>
26 
27 #include "kopete_export.h"
28 
29 class KPluginInfo;
30 
31 namespace Kopete
32 {
33 
34 class MetaContact;
35 
84 class KOPETE_EXPORT Plugin : public QObject, public KXMLGUIClient
85 {
86  Q_OBJECT
87 
88 public:
89  Plugin( const KComponentData &instance, QObject *parent );
90  virtual ~Plugin();
91 
95  KPluginInfo pluginInfo() const;
96 
106  QString pluginIcon() const;
107 
113  QString displayName() const;
114 
119  QString pluginId() const;
120 
129  QStringList addressBookFields() const;
130 
134  QString addressBookIndexField() const;
135 
139  enum AddressBookFieldAddMode { AddOnly, MakeIndexField };
140 
152  void addAddressBookField( const QString &field, AddressBookFieldAddMode mode = AddOnly );
153 
168  virtual void aboutToUnload();
169 
183  Q_INVOKABLE bool showCloseWindowMessage();
184 
196  Q_INVOKABLE bool shouldExitOnclose();
197 
198 signals:
203  void settingsChanged();
204 
209  void readyForUnload();
210 
211 public slots:
212 
224  virtual void deserialize( MetaContact *metaContact, const QMap<QString, QString> &data );
225 
226 private:
227  class Private;
228  Private * const d;
229 };
230 
231 
232 } //END namespace Kopete
233 
234 
235 #endif
KOPETE_EXPORT
#define KOPETE_EXPORT
Definition: kopete_export.h:27
QMap
Kopete::Plugin::AddressBookFieldAddMode
AddressBookFieldAddMode
Mode for an address book field as used by addAddressBookField()
Definition: kopeteplugin.h:139
QObject
kopete_export.h
QString
QStringList
Kopete::Plugin
Base class for all plugins or protocols.
Definition: kopeteplugin.h:84
Kopete::MetaContact
Definition: kopetemetacontact.h:54
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:29:19 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

kopete/libkopete

Skip menu "kopete/libkopete"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdenetwork API Reference

Skip menu "kdenetwork API Reference"
  • kget
  • kopete
  •   kopete
  •   libkopete
  • krdc
  • krfb

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal