This struct represents an item in the list of references. More...

#include <src/reflist.h>

Collaboration diagram for RefItem:

Public Member Functions
	RefItem (int id, RefList *list)
void	setText (const DString &text)
void	setAnchor (const DString &anchor)
void	setPrefix (const DString &prefix)
void	setName (const DString &name)
void	setTitle (const DString &title)
void	setArgs (const DString &args)
void	setGroup (const DString &group)
void	setScope (const Definition *scope)
DString	text () const
DString	anchor () const
DString	prefix () const
DString	name () const
DString	title () const
DString	args () const
DString	group () const
int	id () const
RefList *	list () const
const Definition *	scope () const

Private Attributes
int	m_id = 0
	unique identifier for this item within its list
RefList *	m_list
	list owning this item
DString	m_text
	text of the item.
DString	m_anchor
	anchor in the list
DString	m_prefix
	type prefix for the name
DString	m_name
	name of the entity containing the reference
DString	m_title
	display name of the entity
DString	m_args
	optional arguments for the entity (if function)
DString	m_group
	group id used to combine item under a single header
const Definition *	m_scope = nullptr
	scope to use for references.

Detailed Description

This struct represents an item in the list of references.

Definition at line 31 of file reflist.h.

Constructor & Destructor Documentation

◆ RefItem()

RefItem::RefItem	(	int	id,
		RefList *	list )

inline

Definition at line 34 of file reflist.h.

34: m_id(id), m_list(list) {}

RefItem::m_list

RefList * m_list

list owning this item

Definition reflist.h:58

RefItem::list

RefList * list() const

Definition reflist.h:53

RefItem::m_id

int m_id

unique identifier for this item within its list

Definition reflist.h:57

References id(), list(), m_id, and m_list.

Member Function Documentation

◆ anchor()

DString RefItem::anchor ( ) const

inline

Definition at line 46 of file reflist.h.

46{ return m_anchor; }

RefItem::m_anchor

DString m_anchor

anchor in the list

Definition reflist.h:60

References m_anchor.

Referenced by DocXRefItem::parse(), and setAnchor().

◆ args()

DString RefItem::args ( ) const

inline

Definition at line 50 of file reflist.h.

50{ return m_args; }

RefItem::m_args

DString m_args

optional arguments for the entity (if function)

Definition reflist.h:64

References m_args.

Referenced by setArgs().

◆ group()

DString RefItem::group ( ) const

inline

Definition at line 51 of file reflist.h.

51{ return m_group; }

RefItem::m_group

DString m_group

group id used to combine item under a single header

Definition reflist.h:65

References m_group.

Referenced by setGroup().

◆ id()

int RefItem::id ( ) const

inline

Definition at line 52 of file reflist.h.

52{ return m_id; }

References m_id.

Referenced by DefinitionImpl::_getXRefListId(), addXRefItemToEntry(), and RefItem().

◆ list()

RefList * RefItem::list ( ) const

inline

Definition at line 53 of file reflist.h.

53{ return m_list; }

References m_list.

Referenced by DefinitionImpl::_getXRefListId(), addXRefItemToEntry(), and RefItem().

◆ name()

DString RefItem::name ( ) const

inline

Definition at line 48 of file reflist.h.

48{ return m_name; }

RefItem::m_name

DString m_name

name of the entity containing the reference

Definition reflist.h:62

References m_name.

Referenced by setName().

◆ prefix()

DString RefItem::prefix ( ) const

inline

Definition at line 47 of file reflist.h.

47{ return m_prefix; }

RefItem::m_prefix

DString m_prefix

type prefix for the name

Definition reflist.h:61

References m_prefix.

Referenced by setPrefix().

◆ scope()

const Definition * RefItem::scope ( ) const

inline

Definition at line 54 of file reflist.h.

54{ return m_scope; }

RefItem::m_scope

const Definition * m_scope

scope to use for references.

Definition reflist.h:66

References m_scope.

Referenced by setScope().

◆ setAnchor()

void RefItem::setAnchor ( const DString & anchor )

inline

Definition at line 37 of file reflist.h.

37{ m_anchor = anchor; }

RefItem::anchor

DString anchor() const

Definition reflist.h:46

References anchor(), and m_anchor.

Referenced by addXRefItemToEntry().

◆ setArgs()

void RefItem::setArgs ( const DString & args )

inline

Definition at line 41 of file reflist.h.

41{ m_args = args; }

RefItem::args

DString args() const

Definition reflist.h:50

References args(), and m_args.

◆ setGroup()

void RefItem::setGroup ( const DString & group )

inline

Definition at line 42 of file reflist.h.

42{ m_group = group; }

RefItem::group

DString group() const

Definition reflist.h:51

References group(), and m_group.

◆ setName()

void RefItem::setName ( const DString & name )

inline

Definition at line 39 of file reflist.h.

39{ m_name = name; }

RefItem::name

DString name() const

Definition reflist.h:48

References m_name, and name().

◆ setPrefix()

void RefItem::setPrefix ( const DString & prefix )

inline

Definition at line 38 of file reflist.h.

38{ m_prefix = prefix; }

RefItem::prefix

DString prefix() const

Definition reflist.h:47

References m_prefix, and prefix().

◆ setScope()

void RefItem::setScope ( const Definition * scope )

inline

Definition at line 43 of file reflist.h.

43{ m_scope = scope; }

RefItem::scope

const Definition * scope() const

Definition reflist.h:54

References m_scope, and scope().

◆ setText()

void RefItem::setText ( const DString & text )

inline

Definition at line 36 of file reflist.h.

36{ m_text = text; }

RefItem::text

DString text() const

Definition reflist.h:45

RefItem::m_text

DString m_text

text of the item.

Definition reflist.h:59

References m_text, and text().

Referenced by addXRefItemToEntry().

◆ setTitle()

void RefItem::setTitle ( const DString & title )

inline

Definition at line 40 of file reflist.h.

40{ m_title = title; }

RefItem::title

DString title() const

Definition reflist.h:49

RefItem::m_title

DString m_title

display name of the entity

Definition reflist.h:63

References m_title, and title().

◆ text()

DString RefItem::text ( ) const

inline

Definition at line 45 of file reflist.h.

45{ return m_text; }

References m_text.

Referenced by addXRefItemToEntry(), DocXRefItem::parse(), and setText().

◆ title()

DString RefItem::title ( ) const

inline

Definition at line 49 of file reflist.h.

49{ return m_title; }

References m_title.

Referenced by setTitle().

Member Data Documentation

◆ m_anchor

DString RefItem::m_anchor

private

anchor in the list

Definition at line 60 of file reflist.h.

Referenced by anchor(), and setAnchor().

◆ m_args

DString RefItem::m_args

private

optional arguments for the entity (if function)

Definition at line 64 of file reflist.h.

Referenced by args(), and setArgs().

◆ m_group

DString RefItem::m_group

private

group id used to combine item under a single header

Definition at line 65 of file reflist.h.

Referenced by group(), and setGroup().

◆ m_id

int RefItem::m_id = 0

private

unique identifier for this item within its list

Definition at line 57 of file reflist.h.

Referenced by id(), and RefItem().

◆ m_list

RefList* RefItem::m_list

private

list owning this item

Definition at line 58 of file reflist.h.

Referenced by list(), and RefItem().

◆ m_name

DString RefItem::m_name

private

name of the entity containing the reference

Definition at line 62 of file reflist.h.

Referenced by name(), and setName().

◆ m_prefix

DString RefItem::m_prefix

private

type prefix for the name

Definition at line 61 of file reflist.h.

Referenced by prefix(), and setPrefix().

◆ m_scope

const Definition* RefItem::m_scope = nullptr

private

scope to use for references.

Definition at line 66 of file reflist.h.

Referenced by scope(), and setScope().

◆ m_text

DString RefItem::m_text

private

text of the item.

Definition at line 59 of file reflist.h.

Referenced by setText(), and text().

◆ m_title

DString RefItem::m_title

private

display name of the entity

Definition at line 63 of file reflist.h.

Referenced by setTitle(), and title().

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

src/reflist.h

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ RefItem()

Member Function Documentation

◆ anchor()

◆ args()

◆ group()

◆ id()

◆ list()

◆ name()

◆ prefix()

◆ scope()

◆ setAnchor()

◆ setArgs()

◆ setGroup()

◆ setName()

◆ setPrefix()

◆ setScope()

◆ setText()

◆ setTitle()

◆ text()

◆ title()

Member Data Documentation

◆ m_anchor

◆ m_args

◆ m_group

◆ m_id

◆ m_list

◆ m_name

◆ m_prefix

◆ m_scope

◆ m_text

◆ m_title