QCompressedHelpInfo Class Reference

The QCompressedHelpInfo class provides access to the details about a compressed help file. More...

#include <qcompressedhelpinfo.h>

Collaboration diagram for QCompressedHelpInfo:

Public Member Functions
	QCompressedHelpInfo ()
	Constructs empty information about a compressed help file.
	QCompressedHelpInfo (const QCompressedHelpInfo &other)
	Constructs a copy of other.
	QCompressedHelpInfo (QCompressedHelpInfo &&other)
	Move-constructs a QCompressedHelpInfo instance, making it point to the same object that other was pointing to, so that it contains the information the other used to contain.
	~QCompressedHelpInfo ()
	Destroys the QCompressedHelpInfo.
QCompressedHelpInfo &	operator= (const QCompressedHelpInfo &other)
	Makes this QHelpCollectionDetails into a copy of other, so the two are identical, and returns a reference to this QHelpCollectionDetails.
QCompressedHelpInfo &	operator= (QCompressedHelpInfo &&other)
	Move-assigns other to this QCompressedHelpInfo instance.
void	swap (QCompressedHelpInfo &other) Q_DECL_NOTHROW
	Swaps the compressed help file other with this compressed help file.
QString	namespaceName () const
	Returns the namespace name of the compressed help file.
QString	component () const
	Returns the component of the compressed help file.
QVersionNumber	version () const
	Returns the version of the compressed help file.
bool	isNull () const
	Returns true if the info is invalid, otherwise returns false.

Static Public Member Functions
static QCompressedHelpInfo	fromCompressedHelpFile (const QString &documentationFileName)
	Returns the QCompressedHelpInfo instance for the documentationFileName of the existing qch file.

Detailed Description

The QCompressedHelpInfo class provides access to the details about a compressed help file.

Since

5.13 \inmodule QtHelp

The detailed information about the compressed help file can be fetched by calling the fromCompressedHelpFile() static method, providing the path to the compressed help file.

The class provides access to various information about a compressed help file. The namespace associated with the given compressed help file is namespaceName(), the associated component name is component() and version() provides version information.

See also

QHelpFilterEngine

Definition at line 16 of file qcompressedhelpinfo.h.

Constructor & Destructor Documentation

QCompressedHelpInfo() [1/3]

QCompressedHelpInfo::QCompressedHelpInfo

(

)

Constructs empty information about a compressed help file.

Definition at line 55 of file qcompressedhelpinfo.cpp.

QCompressedHelpInfo() [2/3]

QCompressedHelpInfo::QCompressedHelpInfo ( const QCompressedHelpInfo & other )

default

Constructs a copy of other.

QCompressedHelpInfo() [3/3]

QCompressedHelpInfo::QCompressedHelpInfo ( QCompressedHelpInfo && other )

default

Move-constructs a QCompressedHelpInfo instance, making it point to the same object that other was pointing to, so that it contains the information the other used to contain.

~QCompressedHelpInfo()

QCompressedHelpInfo::~QCompressedHelpInfo ( )

default

Destroys the QCompressedHelpInfo.

Member Function Documentation

component()

QString QCompressedHelpInfo::component

(

)

const

Returns the component of the compressed help file.

Definition at line 105 of file qcompressedhelpinfo.cpp.

fromCompressedHelpFile()

QCompressedHelpInfo QCompressedHelpInfo::fromCompressedHelpFile ( const QString & documentationFileName )

static

Returns the QCompressedHelpInfo instance for the documentationFileName of the existing qch file.

Definition at line 131 of file qcompressedhelpinfo.cpp.

isNull()

bool QCompressedHelpInfo::isNull

(

)

const

Returns true if the info is invalid, otherwise returns false.

Definition at line 122 of file qcompressedhelpinfo.cpp.

namespaceName()

QString QCompressedHelpInfo::namespaceName

(

)

const

Returns the namespace name of the compressed help file.

Definition at line 97 of file qcompressedhelpinfo.cpp.

operator=() [1/2]

QCompressedHelpInfo & QCompressedHelpInfo::operator= ( const QCompressedHelpInfo & other )

default

Makes this QHelpCollectionDetails into a copy of other, so the two are identical, and returns a reference to this QHelpCollectionDetails.

operator=() [2/2]

QCompressedHelpInfo & QCompressedHelpInfo::operator= ( QCompressedHelpInfo && other )

default

Move-assigns other to this QCompressedHelpInfo instance.

swap()

void QCompressedHelpInfo::swap ( QCompressedHelpInfo & other )

inline

Swaps the compressed help file other with this compressed help file.

This operation is very fast and never fails.

Definition at line 27 of file qcompressedhelpinfo.h.

version()

QVersionNumber QCompressedHelpInfo::version

(

)

const

Returns the version of the compressed help file.

Definition at line 113 of file qcompressedhelpinfo.cpp.

---

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

• qttools/src/assistant/help/qcompressedhelpinfo.h (82440a59b3c0e465ab3114a1dd8a46fd2e6a74cb)
• qttools/src/assistant/help/qcompressedhelpinfo.cpp (0752acfd7f881ef3661a4b694c4c4ea0433494d5)