RefItem Class Reference

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 QCString &text)
void	setAnchor (const QCString &anchor)
void	setPrefix (const QCString &prefix)
void	setName (const QCString &name)
void	setTitle (const QCString &title)
void	setArgs (const QCString &args)
void	setGroup (const QCString &group)
void	setScope (const Definition *scope)
QCString	text () const
QCString	anchor () const
QCString	prefix () const
QCString	name () const
QCString	title () const
QCString	args () const
QCString	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
QCString	m_text
	text of the item.
QCString	m_anchor
	anchor in the list
QCString	m_prefix
	type prefix for the name
QCString	m_name
	name of the entity containing the reference
QCString	m_title
	display name of the entity
QCString	m_args
	optional arguments for the entity (if function)
QCString	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.

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

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

Member Function Documentation

anchor()

QCString RefItem::anchor ( ) const

inline

Definition at line 46 of file reflist.h.

{ return m_anchor; }

References m_anchor.

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

args()

QCString RefItem::args ( ) const

inline

Definition at line 50 of file reflist.h.

{ return m_args;   }

References m_args.

Referenced by setArgs().

group()

QCString RefItem::group ( ) const

inline

Definition at line 51 of file reflist.h.

{ return m_group;  }

References m_group.

Referenced by setGroup().

id()

int RefItem::id ( ) const

inline

Definition at line 52 of file reflist.h.

{ return m_id;     }

References m_id.

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

list()

RefList * RefItem::list ( ) const

inline

Definition at line 53 of file reflist.h.

{ return m_list;   }

References m_list.

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

name()

QCString RefItem::name ( ) const

inline

Definition at line 48 of file reflist.h.

{ return m_name;   }

References m_name.

Referenced by setName().

prefix()

QCString RefItem::prefix ( ) const

inline

Definition at line 47 of file reflist.h.

{ return m_prefix; }

References m_prefix.

Referenced by setPrefix().

scope()

const Definition * RefItem::scope ( ) const

inline

Definition at line 54 of file reflist.h.

{ return m_scope;  }

References m_scope.

Referenced by setScope().

setAnchor()

void RefItem::setAnchor ( const QCString & anchor )

inline

Definition at line 37 of file reflist.h.

{ m_anchor = anchor; }

References anchor(), and m_anchor.

Referenced by addXRefItem().

setArgs()

void RefItem::setArgs ( const QCString & args )

inline

Definition at line 41 of file reflist.h.

{ m_args   = args;   }

References args(), and m_args.

setGroup()

void RefItem::setGroup ( const QCString & group )

inline

Definition at line 42 of file reflist.h.

{ m_group  = group;  }

References group(), and m_group.

setName()

void RefItem::setName ( const QCString & name )

inline

Definition at line 39 of file reflist.h.

{ m_name   = name;   }

References m_name, and name().

setPrefix()

void RefItem::setPrefix ( const QCString & prefix )

inline

Definition at line 38 of file reflist.h.

{ m_prefix = prefix; }

References m_prefix, and prefix().

setScope()

void RefItem::setScope ( const Definition * scope )

inline

Definition at line 43 of file reflist.h.

{ m_scope  = scope;  }

References m_scope, and scope().

setText()

void RefItem::setText ( const QCString & text )

inline

Definition at line 36 of file reflist.h.

{ m_text   = text;   }

References m_text, and text().

Referenced by addXRefItem().

setTitle()

void RefItem::setTitle ( const QCString & title )

inline

Definition at line 40 of file reflist.h.

{ m_title  = title;  }

References m_title, and title().

text()

QCString RefItem::text ( ) const

inline

Definition at line 45 of file reflist.h.

{ return m_text;   }

References m_text.

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

title()

QCString RefItem::title ( ) const

inline

Definition at line 49 of file reflist.h.

{ return m_title;  }

References m_title.

Referenced by setTitle().

Member Data Documentation

m_anchor

QCString RefItem::m_anchor

private

anchor in the list

Definition at line 60 of file reflist.h.

Referenced by anchor(), and setAnchor().

m_args

QCString 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

QCString 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

QCString 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

QCString 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

QCString RefItem::m_text

private

text of the item.

Definition at line 59 of file reflist.h.

Referenced by setText(), and text().

m_title

QCString 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