summaryrefslogtreecommitdiffabout
path: root/kaddressbook/extensionwidget.h
blob: fc91f21302df32a19cda73a45ab869dc65b66a7e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
/*                                                                      
    This file is part of KAddressBook.                                  
    Copyright (c) 2002 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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 EXTENSIONWIDGET_H
#define EXTENSIONWIDGET_H

#include <qwidget.h>

#include <kabc/addressbook.h>
#ifndef KAB_EMBEDDED
#include <klibloader.h>
#endif //KAB_EMBEDDED

class ConfigureWidget;
class KABCore;

class ExtensionWidget : public QWidget
{
  Q_OBJECT
  
  public:
    ExtensionWidget( KABCore *core, QWidget *parent, const char *name = 0 );
    ~ExtensionWidget();

    /**
      @return A pointer to the core object
    */
    KABCore *core() const;

    /**
      Returns whether there are selected contacts in the view.
     */
    bool contactsSelected() const;

    /**
      Returns a list of contacts that are selected in the view.
      Use @ref addresseesSelected() to test if there exists selected
      contacts.
     */
    KABC::Addressee::List selectedContacts();

    /**
      This method is called whenever the selection in the view changed.
     */
    virtual void contactsSelectionChanged();

    /**
      This method should be reimplemented and return the i18ned title of this
      widget.
     */
    virtual QString title() const;

    /**
      This method should be reimplemented and return a unique identifier.
     */
    virtual QString identifier() const;

  signals:
    void modified( const KABC::Addressee::List &list );

  private:
    KABCore *mCore;

    class ExtensionWidgetPrivate;
    ExtensionWidgetPrivate *d;
};

#ifndef KAB_EMBEDDED
//MOC_SKIP_BEGIN
class ExtensionFactory : public KLibFactory
//MOC_SKIP_END
#else //KAB_EMBEDDED
class ExtensionFactory
#endif //KAB_EMBEDDED
{
  public:
    virtual ExtensionWidget *extension( KABCore *core, QWidget *parent,
                                        const char *name = 0 ) = 0;

    virtual ConfigureWidget *configureWidget( QWidget *parent,
                                              const char *name = 0 );

    virtual bool configureWidgetAvailable() { return false; }

    /**
      This method should return the same identifier like the config
      widget.
     */
    virtual QString identifier() const = 0;

  protected:
    virtual QObject* createObject( QObject*, const char*, const char*,
                                   const QStringList & )
    {
      return 0;
    }
};

#endif