itom 1.3.0
ito::HelpSystem Class Reference

List of all members.

Classes

class  HelpSystemSingleton

Public Member Functions

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

Static Public Member Functions

static HelpSystemgetInstance ()

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 HelpSystemm_pHelpSystem = NULL
 singleton nach: http://www.oop-trainer.de/Themen/Singleton.html

Friends

class HelpSystemSingleton

Member Function Documentation

RetVal ito::HelpSystem::analyzeQhpFile ( const QString &  pluginFolder,
QFile &  qhpFile,
QString &  tocs,
QString &  keywords,
QString &  files,
QStringList &  filesToCopy,
QPair< QString, QString > &  mainFileInfo 
) [private]

shortdesc

longdesc

Parameters:
pluginFolder
qhpFile
tocs
keywords
files
filesToCopy
mainFileInfo
Returns:
RetVal
RetVal ito::HelpSystem::buildPluginHelp ( quint16  checksum) [private]

shortdesc

longdesc

Parameters:
checksum
Returns:
RetVal
RetVal ito::HelpSystem::buildSinglePluginHelp ( const QString &  pluginFolder,
QDir &  buildDir,
QDir &  sourceDir,
QString &  tocs,
QString &  keywords,
QString &  files,
QPair< QString, QString > &  mainFileInfo 
) [private]

shortdesc

longdesc

Parameters:
pluginFolder
buildDir
sourceDir
tocs
keywords
files
mainFileInfo
Returns:
RetVal
bool ito::HelpSystem::copyDir ( const QDir &  src,
const QDir &  dst 
) [static, private]

shortdesc

longdesc

Parameters:
src
dst
Returns:
bool
bool ito::HelpSystem::copyFile ( const QFileInfo &  srcFileInfo,
QDir &  dstFolder 
) [static, private]

shortdesc

longdesc

Parameters:
srcFileInfo
dstFolder
Returns:
bool
RetVal ito::HelpSystem::getCheckSumOfBuild ( QDir &  helpDir,
QString &  projectFileName,
quint16 &  checksum 
) [private]

shortdesc

longdesc

Parameters:
helpDir
projectFileName
checksum
Returns:
RetVal
RetVal ito::HelpSystem::getCheckSumOfPluginBuild ( quint16 &  checksum) [private]

shortdesc

longdesc

Parameters:
checksum
Returns:
RetVal
QString ito::HelpSystem::getHelpCollectionAbsFileName ( ) const

shortdesc

longdesc

Returns:
QString
QString ito::HelpSystem::modifyFiles ( const QString &  in,
const QString &  hrefPrefix,
const QStringList &  excludeContent,
QStringList &  filesToCopy 
) [private]

shortdesc

longdesc

Parameters:
in
hrefPrefix
excludeContent
filesToCopy
Returns:
QString
RetVal ito::HelpSystem::modifyHrefInHtmlFile ( const QString &  htmlFile,
const QString &  prefix 
) [private]

shortdesc

longdesc

Parameters:
htmlFile
prefix
Returns:
RetVal
QString ito::HelpSystem::modifyKeywords ( const QString &  in,
const QString &  hrefPrefix 
) [private]

shortdesc

longdesc

Parameters:
in
hrefPrefix
Returns:
QString
QString ito::HelpSystem::modifyTocs ( const QString &  in,
const QString &  hrefPrefix,
QString &  mainFile 
) [private]

shortdesc

longdesc

Parameters:
in
hrefPrefix
mainFile
Returns:
QString
RetVal ito::HelpSystem::rebuildHelpCollection ( QStringList &  qchFiles,
quint16  checksum,
QDir &  helpDir 
) [private]

shortdesc

longdesc

Parameters:
qchFiles
checksum
helpDir
Returns:
RetVal
RetVal ito::HelpSystem::rebuildHelpIfNotUpToDate ( )

shortdesc

longdesc

Returns:
RetVal
bool ito::HelpSystem::removeDir ( const QDir &  directory) [static, private]

shortdesc

longdesc

Parameters:
directory
Returns:
bool
RetVal ito::HelpSystem::scanDocumentationFiles ( QStringList &  qchFiles,
quint16 &  checksum 
) [private]

shortdesc

longdesc

Parameters:
qchFiles
checksum
Returns:
RetVal
RetVal ito::HelpSystem::scanPluginQhpFiles ( quint16 &  checksum) [private]

shortdesc

longdesc

Parameters:
checksum
Returns:
RetVal

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