You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
tdebase/khelpcenter/docmetainfo.h

81 lines
1.7 KiB

#ifndef DOCMETAINFO_H
#define DOCMETAINFO_H
#include <qstring.h>
#include <qstringlist.h>
#include <qvaluelist.h>
#include <qdir.h>
#include <qmap.h>
#include "docentry.h"
namespace KHC {
class HTMLSearch;
class DocEntryTraverser;
/*!
This class provides some meta information about help documents.
*/
class DocMetaInfo
{
public:
/*!
Return instance of DocMetaInfo. There can only be one instance at a time.
*/
static DocMetaInfo *self();
~DocMetaInfo();
void scanMetaInfo( bool force = false );
DocEntry *addDocEntry( const QString &fileName );
void addDocEntry( DocEntry * );
DocEntry::List docEntries();
DocEntry::List searchEntries();
void traverseEntries( DocEntryTraverser * );
void startTraverseEntries( DocEntryTraverser *traverser );
void startTraverseEntry( DocEntry *entry, DocEntryTraverser *traverser );
void endProcess( DocEntry *entry, DocEntryTraverser *traverser );
void endTraverseEntries( DocEntryTraverser * );
static QString languageName( const QString &langcode );
protected:
DocEntry *scanMetaInfoDir( const QString &filename, DocEntry *parent );
DocEntry *addDirEntry( const QDir &dir, DocEntry *parent );
void traverseEntry( DocEntry *, DocEntryTraverser * );
private:
/*!
DocMetaInfo is a singleton. Private constructor prevents direct
instantisation.
*/
DocMetaInfo();
DocEntry::List mDocEntries;
DocEntry::List mSearchEntries;
DocEntry mRootEntry;
QStringList mLanguages;
QMap<QString,QString> mLanguageNames;
HTMLSearch *mHtmlSearch;
static bool mLoaded;
static DocMetaInfo *mSelf;
};
}
#endif
// vim:ts=2:sw=2:et