QHelpDataContentItem Class Reference

The QHelpDataContentItem class provides an item which represents a topic or section of the contents. More...

#include <qhelpdatainterface_p.h>

Collaboration diagram for QHelpDataContentItem:

Public Member Functions
	QHelpDataContentItem (QHelpDataContentItem *parent, const QString &title, const QString &reference)
	Constructs a new content item with parent as parent item.
	~QHelpDataContentItem ()
	Destructs the item and its children.
QString	title () const
	Returns the title of the item.
QString	reference () const
	Returns the file reference of the item.
QList< QHelpDataContentItem * >	children () const
	Returns a list of all its child items.

Detailed Description

The QHelpDataContentItem class provides an item which represents a topic or section of the contents.

Since

4.4

Every item holds several pieces of information, most notably the title which can later be displayed in a contents overview. The reference is used to store a relative file link to the corresponding section in the documentation.

Definition at line 24 of file qhelpdatainterface_p.h.

Constructor & Destructor Documentation

QHelpDataContentItem()

QHelpDataContentItem::QHelpDataContentItem	(	QHelpDataContentItem *	parent,
		const QString &	title,
		const QString &	reference )

Constructs a new content item with parent as parent item.

The constucted item has the title title and links to the location specified by reference.

Definition at line 26 of file qhelpdatainterface.cpp.

~QHelpDataContentItem()

QHelpDataContentItem::~QHelpDataContentItem

(

)

Destructs the item and its children.

Definition at line 37 of file qhelpdatainterface.cpp.

Member Function Documentation

children()

QList< QHelpDataContentItem * > QHelpDataContentItem::children

(

)

const

Returns a list of all its child items.

Definition at line 61 of file qhelpdatainterface.cpp.

reference()

QString QHelpDataContentItem::reference

(

)

const

Returns the file reference of the item.

Definition at line 53 of file qhelpdatainterface.cpp.

title()

QString QHelpDataContentItem::title

(

)

const

Returns the title of the item.

Definition at line 45 of file qhelpdatainterface.cpp.

---

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

• qttools/src/assistant/qhelpgenerator/qhelpdatainterface_p.h (67d10ced1f702de3a582da47fa657a724aa6a2bf)
• qttools/src/assistant/qhelpgenerator/qhelpdatainterface.cpp (67d10ced1f702de3a582da47fa657a724aa6a2bf)