diff options
author | Timothy Pearson <kb9vqf@pearsoncomputing.net> | 2011-11-06 15:57:02 -0600 |
---|---|---|
committer | Timothy Pearson <kb9vqf@pearsoncomputing.net> | 2011-11-06 15:57:02 -0600 |
commit | 2c2fbd828ca474671bb9e03681b30b115d8d6035 (patch) | |
tree | 526a9da418f8d3d7ccf515c37048d3dfc80f2843 /libtdepim/resourceabc.h | |
parent | f0610eece3676b6fe99f42cf4ef2b19a39a5c4e8 (diff) | |
download | tdepim-2c2fbd828ca474671bb9e03681b30b115d8d6035.tar.gz tdepim-2c2fbd828ca474671bb9e03681b30b115d8d6035.zip |
Actually move the kde files that were renamed in the last commit
Diffstat (limited to 'libtdepim/resourceabc.h')
-rw-r--r-- | libtdepim/resourceabc.h | 116 |
1 files changed, 116 insertions, 0 deletions
diff --git a/libtdepim/resourceabc.h b/libtdepim/resourceabc.h new file mode 100644 index 000000000..b6ef3ec98 --- /dev/null +++ b/libtdepim/resourceabc.h @@ -0,0 +1,116 @@ +/* + This file is part of libtdepim. + + Copyright (c) 2004 Bo Thorsen <bo@sonofthor.dk> + + 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 TQt, and distribute the resulting executable, + without including the source code for TQt in the source distribution. +*/ + +#ifndef RESOURCEABC_H +#define RESOURCEABC_H + +#include <kabc/resource.h> +#include <tqmap.h> +#include <tdepimmacros.h> + +// This is here because it can't go to kdelibs/kabc yet, but ultimately +// it should probably go there (maybe redesigned to have a real object +// for subresources). + +namespace KPIM { + +/** + * This class is the implementation of subfolder resources for KABC. + * More methods will be added to give KAddressBook the possibility to + * handle subresources. + */ + +class KDE_EXPORT ResourceABC : public KABC::Resource +{ + Q_OBJECT + TQ_OBJECT + +public: + ResourceABC( const KConfig* ); + virtual ~ResourceABC(); + + /** + * Get the UID to subresource map. This is necessary to implement + * the search order. + * The returned map has the UID as key and the resource it's in as + * the data. + */ + virtual TQMap<TQString, TQString> uidToResourceMap() const = 0; + + /** + * If this resource has subresources, return a TQStringList of them. + * In most cases, resources do not have subresources, so this is + * by default just empty. + */ + virtual TQStringList subresources() const { return TQStringList(); } + + /** + * Is this subresource active or not? + */ + virtual bool subresourceActive( const TQString& ) const { return true; } + + /** + * Is the given subresource writable? + */ + virtual bool subresourceWritable( const TQString& ) const = 0; + + /** + * Completion weight for a given subresource + */ + virtual int subresourceCompletionWeight( const TQString& ) const = 0; + + /** + * Label for a given subresource + */ + virtual TQString subresourceLabel( const TQString& ) const = 0; + +public slots: + /** + * (De-)activate a subresource. + */ + virtual void setSubresourceActive( const TQString &, bool active ) = 0; + + /** + * Set completion weight for a given subresource + */ + virtual void setSubresourceCompletionWeight( const TQString&, int weight ) = 0; + +signals: + /** + * This signal is emitted when a subresource is added. + */ + void signalSubresourceAdded( KPIM::ResourceABC *, const TQString &type, + const TQString &subResource ); + + /** + * This signal is emitted when a subresource is removed. + */ + void signalSubresourceRemoved( KPIM::ResourceABC *, const TQString &type, + const TQString &subResource ); + +}; + +} + +#endif // RESOURCEABC_H |