/* 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., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
**/
#ifndef __ksycocaentry_h__
#define __ksycocaentry_h__ "$Id: ksycocaentry.h,v 1.6 2000/06/12 05:47:01 waba Exp $"
#include "ksycocatype.h"
#include <qdatastream.h>
#include <qlist.h>
#include <qvaluelist.h>
#include <ksharedptr.h>
/**
* Base class for all entries.
* You can't create instance of KSycocaEntry, but it provides
* the common functionality for servicetypes and services.
*/
class 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 QValueList<Ptr> List;
public: // KDoc seems to barf on those typedefs and generates no docs after them
/**
* Default constructor
*/
KSycocaEntry(const QString &path) : mOffset(0), m_bDeleted(false), mPath(path) { }
/**
* @internal
* Restores itself from a stream.
*/
KSycocaEntry( QDataStream &_str, int offset ) :
mOffset( offset ), m_bDeleted(false)
{
_str >> mPath;
}
/**
* @return the name of this entry
*/
virtual QString name() const = 0;
/**
* @return the path of this entry
* The path can be aboslute or relative.
* The corresponding factory should know relative to what.
*/
QString 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(QDataStream &s)
{
mOffset = s.device()->at(); // store position in member variable
s << (Q_INT32) sycocaType() << mPath;
}
/**
* @internal
* Load ourselves from the database. Don't call the parent class!
*/
virtual void load(QDataStream &) = 0;
private:
int mOffset;
protected:
bool m_bDeleted;
QString mPath;
};
#endif