diff options
author | Timothy Pearson <kb9vqf@pearsoncomputing.net> | 2011-11-06 15:56:40 -0600 |
---|---|---|
committer | Timothy Pearson <kb9vqf@pearsoncomputing.net> | 2011-11-06 15:56:40 -0600 |
commit | e16866e072f94410321d70daedbcb855ea878cac (patch) | |
tree | ee3f52eabde7da1a0e6ca845fb9c2813cf1558cf /tdecore/ksycocaentry.h | |
parent | a58c20c1a7593631a1b50213c805507ebc16adaf (diff) | |
download | tdelibs-e16866e072f94410321d70daedbcb855ea878cac.tar.gz tdelibs-e16866e072f94410321d70daedbcb855ea878cac.zip |
Actually move the kde files that were renamed in the last commit
Diffstat (limited to 'tdecore/ksycocaentry.h')
-rw-r--r-- | tdecore/ksycocaentry.h | 123 |
1 files changed, 123 insertions, 0 deletions
diff --git a/tdecore/ksycocaentry.h b/tdecore/ksycocaentry.h new file mode 100644 index 000000000..5e3fa2d37 --- /dev/null +++ b/tdecore/ksycocaentry.h @@ -0,0 +1,123 @@ +/* This file is part of the KDE libraries + * Copyright (C) 1999 Waldo Bastian <bastian@kde.org> + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Library General Public + * License version 2 as published by the Free Software Foundation; + * + * This library 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 + * Library General Public License for more details. + * + * You should have received a copy of the GNU Library General Public License + * along with this library; see the file COPYING.LIB. If not, write to + * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301, USA. + **/ + +#ifndef __ksycocaentry_h__ +#define __ksycocaentry_h__ + +#include "ksycocatype.h" + +#include <tqstringlist.h> +#include <ksharedptr.h> +class TQDataStream; + +/** + * Base class for all Sycoca entries. + * + * You can't create an instance of KSycocaEntry, but it provides + * the common functionality for servicetypes and services. + * + * @internal + * @see http://developer.kde.org/documentation/library/kdeqt/trinityarch/ksycoca.html + */ +class KDECORE_EXPORT KSycocaEntry : public KShared +{ + +public: + virtual bool isType(KSycocaType t) const { return (t == KST_KSycocaEntry); } + virtual KSycocaType sycocaType() const { return KST_KSycocaEntry; } + +public: + typedef KSharedPtr<KSycocaEntry> Ptr; + typedef TQValueList<Ptr> List; +public: // KDoc seems to barf on those typedefs and generates no docs after them + /** + * Default constructor + */ + KSycocaEntry(const TQString &path) : mOffset(0), m_bDeleted(false), mPath(path) { } + + /** + * Safe demarshalling functions. + */ + static void read( TQDataStream &s, TQString &str ); + static void read( TQDataStream &s, TQStringList &list ); + + /** + * @internal + * Restores itself from a stream. + */ + KSycocaEntry( TQDataStream &_str, int offset ) : + mOffset( offset ), m_bDeleted(false) + { + read(_str, mPath); + } + + /** + * @return the name of this entry + */ + virtual TQString name() const = 0; + + /** + * @return the path of this entry + * The path can be absolute or relative. + * The corresponding factory should know relative to what. + */ + TQString entryPath() const { return mPath; } + + /** + * @return true if valid + */ + virtual bool isValid() const = 0; + + /** + * @return true if deleted + */ + virtual bool isDeleted() const { return m_bDeleted; } + + /** + * @internal + * @return the position of the entry in the sycoca file + */ + int offset() { return mOffset; } + + /** + * @internal + * Save ourselves to the database. Don't forget to call the parent class + * first if you override this function. + */ + virtual void save(TQDataStream &s) + { + mOffset = s.tqdevice()->tqat(); // store position in member variable + s << (TQ_INT32) sycocaType() << mPath; + } + + /** + * @internal + * Load ourselves from the database. Don't call the parent class! + */ + virtual void load(TQDataStream &) = 0; + +private: + int mOffset; +protected: + bool m_bDeleted; + TQString mPath; +protected: + virtual void virtual_hook( int id, void* data ); +}; + +#endif |