A record of a linkable target within the documentation. More...

#include <tree.h>

Collaboration diagram for TargetRec:

Public Types
enum	TargetType { Unknown , Target , Keyword , Contents , ContentsKeyword }
	A type of a linkable target record. More...

Public Member Functions
	TargetRec (QString name, TargetRec::TargetType type, Node *node, int priority)
bool	isEmpty () const
Genus	genus () const

Public Attributes
Node *	m_node { nullptr }
QString	m_ref {}
TargetType	m_type {}
int	m_priority {}

Detailed Description

A record of a linkable target within the documentation.

Definition at line 26 of file tree.h.

Member Enumeration Documentation

◆ TargetType

enum TargetRec::TargetType

A type of a linkable target record.

\value Unknown Unknown/target not set. \value Target A location marked with a \target command. \value Keyword A location marked with a \keyword command. \value Contents A table of contents item (section title). \value ContentsKeyword A \keyword tied to a section title.

Enumerator
Unknown
Target
Keyword
Contents
ContentsKeyword

Definition at line 29 of file tree.h.

Constructor & Destructor Documentation

◆ TargetRec()

TargetRec::TargetRec	(	QString	name,
		TargetRec::TargetType	type,
		Node *	node,
		int	priority )

inline

Definition at line 31 of file tree.h.

References ContentsKeyword, Keyword, m_node, m_priority, and m_type.

Member Function Documentation

◆ genus()

Genus TargetRec::genus ( ) const

inlinenodiscard

Definition at line 44 of file tree.h.

References Node< _Tp >::genus(), and m_node.

Here is the call graph for this function:

◆ isEmpty()

bool TargetRec::isEmpty ( ) const

inlinenodiscard

Definition at line 43 of file tree.h.

Member Data Documentation

◆ m_node

Node* TargetRec::m_node { nullptr }

Definition at line 46 of file tree.h.

Referenced by TargetRec(), and genus().

◆ m_priority

int TargetRec::m_priority {}

Definition at line 49 of file tree.h.

Referenced by TargetRec().

◆ m_ref

QString TargetRec::m_ref {}

Definition at line 47 of file tree.h.

◆ m_type

TargetType TargetRec::m_type {}

Definition at line 48 of file tree.h.