Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
Public Member Functions | List of all members
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 24 of file qhelpprojectdata_p.h.

Constructor & Destructor Documentation

◆ QHelpProjectData()

QHelpProjectData::QHelpProjectData ( )

Constructs a Qt help project data structure.

Definition at line 336 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 344 of file qhelpprojectdata.cpp.

Member Function Documentation

◆ customFilters()

QList< QHelpDataCustomFilter > QHelpProjectData::customFilters ( ) const

Definition at line 403 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 377 of file qhelpprojectdata.cpp.

◆ filterSections()

QList< QHelpDataFilterSection > QHelpProjectData::filterSections ( ) const

Definition at line 411 of file qhelpprojectdata.cpp.

◆ metaData()

QMap< QString, QVariant > QHelpProjectData::metaData ( ) const

Definition at line 419 of file qhelpprojectdata.cpp.

◆ namespaceName()

QString QHelpProjectData::namespaceName ( ) const

Definition at line 387 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 356 of file qhelpprojectdata.cpp.

◆ rootPath()

QString QHelpProjectData::rootPath ( ) const

Definition at line 427 of file qhelpprojectdata.cpp.

◆ virtualFolder()

QString QHelpProjectData::virtualFolder ( ) const

Definition at line 395 of file qhelpprojectdata.cpp.

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