LibEngsas
Public Attributes | List of all members
EHelpCenterSetup Struct Reference

Structure to setup up the EHelpCenter. More...

#include <ehelpcentersetup.h>

Public Attributes

QList< QDir > directories
 Directories, which should be search for qhc and qch files. More...
 
QString qhcFile
 The file, which should be loaded as qhc, to setup QtAssistant. More...
 
QString domain
 the domain used into the help file. More...
 
QString defaultPage
 Page which is opened, if no page is provided. More...
 

Detailed Description

Structure to setup up the EHelpCenter.

Member Data Documentation

QString EHelpCenterSetup::defaultPage

Page which is opened, if no page is provided.

QList<QDir> EHelpCenterSetup::directories

Directories, which should be search for qhc and qch files.

QString EHelpCenterSetup::domain

the domain used into the help file.

If empty, QString(de.%1.%2).arg(QApplication::organizationName()).arg(QApplication::applicationName()) is used.

QString EHelpCenterSetup::qhcFile

The file, which should be loaded as qhc, to setup QtAssistant.

The file given here, is loaded as qhc and all other files found in the directory, are loaded as qch (-register file.qch). The content should be without the language and ending (e.g.: File is called myhelpfile_de.qhc, than qhcFile should be myhelpfile)

Todo:
Support more than one helpfile in one directory.

The documentation for this struct was generated from the following file: