itom 1.3.0
|
Classes | |
class | HelpSystemSingleton |
Public Member Functions | |
QString | getHelpCollectionAbsFileName () const |
shortdesc | |
bool | isUpToDate () const |
RetVal | rebuildHelpIfNotUpToDate () |
shortdesc | |
Static Public Member Functions | |
static HelpSystem * | getInstance () |
Private Member Functions | |
HelpSystem (HelpSystem &) | |
RetVal | scanDocumentationFiles (QStringList &qchFiles, quint16 &checksum) |
shortdesc | |
RetVal | scanPluginQhpFiles (quint16 &checksum) |
shortdesc | |
RetVal | getCheckSumOfBuild (QDir &helpDir, QString &projectFileName, quint16 &checksum) |
shortdesc | |
RetVal | getCheckSumOfPluginBuild (quint16 &checksum) |
shortdesc | |
RetVal | rebuildHelpCollection (QStringList &qchFiles, quint16 checksum, QDir &helpDir) |
shortdesc | |
RetVal | buildPluginHelp (quint16 checksum) |
shortdesc | |
RetVal | buildSinglePluginHelp (const QString &pluginFolder, QDir &buildDir, QDir &sourceDir, QString &tocs, QString &keywords, QString &files, QPair< QString, QString > &mainFileInfo) |
shortdesc | |
RetVal | analyzeQhpFile (const QString &pluginFolder, QFile &qhpFile, QString &tocs, QString &keywords, QString &files, QStringList &filesToCopy, QPair< QString, QString > &mainFileInfo) |
shortdesc | |
QString | modifyTocs (const QString &in, const QString &hrefPrefix, QString &mainFile) |
shortdesc | |
QString | modifyKeywords (const QString &in, const QString &hrefPrefix) |
shortdesc | |
QString | modifyFiles (const QString &in, const QString &hrefPrefix, const QStringList &excludeContent, QStringList &filesToCopy) |
shortdesc | |
RetVal | modifyHrefInHtmlFile (const QString &htmlFile, const QString &prefix) |
shortdesc | |
Static Private Member Functions | |
static bool | removeDir (const QDir &directory) |
shortdesc | |
static bool | copyDir (const QDir &src, const QDir &dst) |
shortdesc | |
static bool | copyFile (const QFileInfo &srcFileInfo, QDir &dstFolder) |
shortdesc | |
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 HelpSystem * | m_pHelpSystem = NULL |
singleton nach: http://www.oop-trainer.de/Themen/Singleton.html | |
Friends | |
class | HelpSystemSingleton |
RetVal ito::HelpSystem::analyzeQhpFile | ( | const QString & | pluginFolder, |
QFile & | qhpFile, | ||
QString & | tocs, | ||
QString & | keywords, | ||
QString & | files, | ||
QStringList & | filesToCopy, | ||
QPair< QString, QString > & | mainFileInfo | ||
) | [private] |
shortdesc
longdesc
pluginFolder | |
qhpFile | |
tocs | |
keywords | |
files | |
filesToCopy | |
mainFileInfo |
RetVal ito::HelpSystem::buildPluginHelp | ( | quint16 | checksum | ) | [private] |
RetVal ito::HelpSystem::buildSinglePluginHelp | ( | const QString & | pluginFolder, |
QDir & | buildDir, | ||
QDir & | sourceDir, | ||
QString & | tocs, | ||
QString & | keywords, | ||
QString & | files, | ||
QPair< QString, QString > & | mainFileInfo | ||
) | [private] |
shortdesc
longdesc
pluginFolder | |
buildDir | |
sourceDir | |
tocs | |
keywords | |
files | |
mainFileInfo |
bool ito::HelpSystem::copyDir | ( | const QDir & | src, |
const QDir & | dst | ||
) | [static, private] |
shortdesc
longdesc
src | |
dst |
bool ito::HelpSystem::copyFile | ( | const QFileInfo & | srcFileInfo, |
QDir & | dstFolder | ||
) | [static, private] |
shortdesc
longdesc
srcFileInfo | |
dstFolder |
RetVal ito::HelpSystem::getCheckSumOfBuild | ( | QDir & | helpDir, |
QString & | projectFileName, | ||
quint16 & | checksum | ||
) | [private] |
RetVal ito::HelpSystem::getCheckSumOfPluginBuild | ( | quint16 & | checksum | ) | [private] |
QString ito::HelpSystem::getHelpCollectionAbsFileName | ( | ) | const |
shortdesc
longdesc
QString ito::HelpSystem::modifyFiles | ( | const QString & | in, |
const QString & | hrefPrefix, | ||
const QStringList & | excludeContent, | ||
QStringList & | filesToCopy | ||
) | [private] |
shortdesc
longdesc
in | |
hrefPrefix | |
excludeContent | |
filesToCopy |
RetVal ito::HelpSystem::modifyHrefInHtmlFile | ( | const QString & | htmlFile, |
const QString & | prefix | ||
) | [private] |
QString ito::HelpSystem::modifyKeywords | ( | const QString & | in, |
const QString & | hrefPrefix | ||
) | [private] |
shortdesc
longdesc
in | |
hrefPrefix |
QString ito::HelpSystem::modifyTocs | ( | const QString & | in, |
const QString & | hrefPrefix, | ||
QString & | mainFile | ||
) | [private] |
shortdesc
longdesc
in | |
hrefPrefix | |
mainFile |
RetVal ito::HelpSystem::rebuildHelpCollection | ( | QStringList & | qchFiles, |
quint16 | checksum, | ||
QDir & | helpDir | ||
) | [private] |
bool ito::HelpSystem::removeDir | ( | const QDir & | directory | ) | [static, private] |
shortdesc
longdesc
directory |
RetVal ito::HelpSystem::scanDocumentationFiles | ( | QStringList & | qchFiles, |
quint16 & | checksum | ||
) | [private] |
RetVal ito::HelpSystem::scanPluginQhpFiles | ( | quint16 & | checksum | ) | [private] |