libkdepim Library API Documentation

resourceabc.h

00001 /*
00002     This file is part of KAddressBook.
00003     Copyright (c) 2004 Bo Thorsen <bo@sonofthor.dk>
00004 
00005     This program is free software; you can redistribute it and/or modify
00006     it under the terms of the GNU General Public License as published by
00007     the Free Software Foundation; either version 2 of the License, or
00008     (at your option) any later version.
00009 
00010     This program is distributed in the hope that it will be useful,
00011     but WITHOUT ANY WARRANTY; without even the implied warranty of
00012     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
00013     GNU General Public License for more details.
00014 
00015     You should have received a copy of the GNU General Public License
00016     along with this program; if not, write to the Free Software
00017     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
00018 
00019     As a special exception, permission is given to link this program
00020     with any edition of Qt, and distribute the resulting executable,
00021     without including the source code for Qt in the source distribution.
00022 */
00023 
00024 #ifndef RESOURCEABC_H
00025 #define RESOURCEABC_H
00026 
00027 #include <kabc/resource.h>
00028 #include <qmap.h>
00029 
00030 // This is here because it can't go to kdelibs/kabc yet, but ultimately
00031 // it should probably go there (maybe redesigned to have a real object
00032 // for subresources).
00033 
00034 namespace KPIM {
00035 
00042 class ResourceABC : public KABC::Resource
00043 {
00044   Q_OBJECT
00045 
00046 public:
00047   ResourceABC( const KConfig* );
00048   virtual ~ResourceABC();
00049 
00056   virtual QMap<QString, QString> uidToResourceMap() const = 0;
00057 
00063   virtual QStringList subresources() const { return QStringList(); }
00064 
00068   virtual bool subresourceActive( const QString& ) const { return true; }
00069 
00073   virtual int subresourceCompletionWeight( const QString& ) const = 0;
00074 
00078   virtual QString subresourceLabel( const QString& ) const = 0;
00079 
00081   virtual bool removeSubresource( const QString& ) = 0;
00082 
00085   virtual bool addSubresource( const QString& label, const QString& parent ) = 0;
00086 
00088   virtual bool canHaveSubresources() const { return false; }
00089 
00090 public slots:
00094   virtual void setSubresourceActive( const QString &, bool active ) = 0;
00095 
00099   virtual void setSubresourceCompletionWeight( const QString&, int weight ) = 0;
00100 
00101 signals:
00105   void signalSubresourceAdded( KPIM::ResourceABC *, const QString &type,
00106                                const QString &subResource );
00107 
00111   void signalSubresourceRemoved( KPIM::ResourceABC *, const QString &type,
00112                                  const QString &subResource );
00113 
00114 };
00115 
00116 }
00117 
00118 #endif // RESOURCEABC_H
KDE Logo
This file is part of the documentation for libkdepim Library Version 3.3.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Aug 23 18:19:46 2007 by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2003