itom 1.2.0
ito::HelpSystem Class Reference

List of all members.

Classes

class  HelpSystemSingleton

Public Member Functions

QString getHelpCollectionAbsFileName () const
bool isUpToDate () const
RetVal rebuildHelpIfNotUpToDate ()

Static Public Member Functions

static HelpSystemgetInstance ()

Private Member Functions

 HelpSystem (HelpSystem &)
RetVal scanDocumentationFiles (QStringList &qchFiles, quint16 &checksum)
RetVal scanPluginQhpFiles (quint16 &checksum)
RetVal getCheckSumOfBuild (QDir &helpDir, QString &projectFileName, quint16 &checksum)
RetVal getCheckSumOfPluginBuild (quint16 &checksum)
RetVal rebuildHelpCollection (QStringList &qchFiles, quint16 checksum, QDir &helpDir)
RetVal buildPluginHelp (quint16 checksum)
RetVal buildSinglePluginHelp (const QString &pluginFolder, QDir &buildDir, QDir &sourceDir, QString &tocs, QString &keywords, QString &files, QPair< QString, QString > &mainFileInfo)
RetVal analyzeQhpFile (const QString &pluginFolder, QFile &qhpFile, QString &tocs, QString &keywords, QString &files, QStringList &filesToCopy, QPair< QString, QString > &mainFileInfo)
QString modifyTocs (const QString &in, const QString &hrefPrefix, QString &mainFile)
QString modifyKeywords (const QString &in, const QString &hrefPrefix)
QString modifyFiles (const QString &in, const QString &hrefPrefix, const QStringList &excludeContent, QStringList &filesToCopy)
RetVal modifyHrefInHtmlFile (const QString &htmlFile, const QString &prefix)

Static Private Member Functions

static bool removeDir (const QDir &directory)
static bool copyDir (const QDir &src, const QDir &dst)
static bool copyFile (const QFileInfo &srcFileInfo, QDir &dstFolder)

Private Attributes

QDir m_helpDirectory
QMap< QString, quint16 > m_registeredFilesQCH
QString m_helpCollectionName
QString m_helpCollectionProject
QString m_pluginHelpCollectionName
QString m_pluginHelpCollectionProject
bool m_upToDate

Static Private Attributes

static HelpSystemm_pHelpSystem = NULL
 singleton nach: http://www.oop-trainer.de/Themen/Singleton.html

Friends

class HelpSystemSingleton

The documentation for this class was generated from the following files:
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends