QHelpProjectData Class Reference

The QHelpProjectData class stores all information found in a Qt help project file. More...

#include <qhelpprojectdata_p.h>

Collaboration diagram for QHelpProjectData:

Public Member Functions
	QHelpProjectData ()
	Constructs a Qt help project data structure.
	~QHelpProjectData ()
	Destroys the help project data.
bool	readData (const QString &fileName)
	Reads the file fileName and stores the help data.
QString	errorMessage () const
	Returns an error message if the reading of the Qt help project file failed.
QString	namespaceName () const
QString	virtualFolder () const
QList< QHelpDataCustomFilter >	customFilters () const
QList< QHelpDataFilterSection >	filterSections () const
QMap< QString, QVariant >	metaData () const
QString	rootPath () const

Detailed Description

The QHelpProjectData class stores all information found in a Qt help project file.

Since

4.4

The structure is filled with data by calling readData(). The specified file has to have the Qt help project file format in order to be read successfully. Possible reading errors can be retrieved by calling errorMessage().

Definition at line 25 of file qhelpprojectdata_p.h.

Constructor & Destructor Documentation

QHelpProjectData()

QHelpProjectData::QHelpProjectData

(

)

Constructs a Qt help project data structure.

Definition at line 337 of file qhelpprojectdata.cpp.

Referenced by main().

Here is the caller graph for this function:

~QHelpProjectData()

QHelpProjectData::~QHelpProjectData

(

)

Destroys the help project data.

Definition at line 345 of file qhelpprojectdata.cpp.

Member Function Documentation

customFilters()

QList< QHelpDataCustomFilter > QHelpProjectData::customFilters

(

)

const

Definition at line 404 of file qhelpprojectdata.cpp.

errorMessage()

QString QHelpProjectData::errorMessage

(

)

const

Returns an error message if the reading of the Qt help project file failed.

Otherwise, an empty QString is returned.

See also

readData()

Definition at line 378 of file qhelpprojectdata.cpp.

filterSections()

QList< QHelpDataFilterSection > QHelpProjectData::filterSections

(

)

const

Definition at line 412 of file qhelpprojectdata.cpp.

metaData()

QMap< QString, QVariant > QHelpProjectData::metaData

(

)

const

Definition at line 420 of file qhelpprojectdata.cpp.

namespaceName()

QString QHelpProjectData::namespaceName

(

)

const

Definition at line 388 of file qhelpprojectdata.cpp.

readData()

bool QHelpProjectData::readData

(

const QString &

fileName

)

Reads the file fileName and stores the help data.

The file has to have the Qt help project file format. Returns true if the file was successfully read, otherwise false.

See also

errorMessage()

Definition at line 357 of file qhelpprojectdata.cpp.

rootPath()

QString QHelpProjectData::rootPath

(

)

const

Definition at line 428 of file qhelpprojectdata.cpp.

virtualFolder()

QString QHelpProjectData::virtualFolder

(

)

const

Definition at line 396 of file qhelpprojectdata.cpp.

---

The documentation for this class was generated from the following files:

• qttools/src/assistant/qhelpgenerator/qhelpprojectdata_p.h (d389eae06e4ed465c4a3c3064634e7b03e9bf006)
• qttools/src/assistant/qhelpgenerator/qhelpprojectdata.cpp (d389eae06e4ed465c4a3c3064634e7b03e9bf006)