Skip to main content

The RefItem Class Reference

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

Declaration​

class RefItem { ... }

Included Headers​

#include <src/reflist.h>

Public Constructors Index​

RefItem (int id, RefList *list)

Public Member Functions Index​

voidsetText (const QCString &text)
voidsetAnchor (const QCString &anchor)
voidsetPrefix (const QCString &prefix)
voidsetName (const QCString &name)
voidsetTitle (const QCString &title)
voidsetArgs (const QCString &args)
voidsetGroup (const QCString &group)
voidsetScope (const Definition *scope)
QCStringtext () const
QCStringanchor () const
QCStringprefix () const
QCStringname () const
QCStringtitle () const
QCStringargs () const
QCStringgroup () const
intid () const
RefList *list () const
const Definition *scope () const

Private Member Attributes Index​

intm_id = 0

unique identifier for this item within its list More...

RefList *m_list

list owning this item More...

QCStringm_text

text of the item. More...

QCStringm_anchor

anchor in the list More...

QCStringm_prefix

type prefix for the name More...

QCStringm_name

name of the entity containing the reference More...

QCStringm_title

display name of the entity More...

QCStringm_args

optional arguments for the entity (if function) More...

QCStringm_group

group id used to combine item under a single header More...

const Definition *m_scope = nullptr

scope to use for references. More...

Description​

This struct represents an item in the list of references.

Definition at line 31 of file reflist.h.

Public Constructors​

RefItem()​

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

Definition at line 34 of file reflist.h.

34 RefItem(int id,RefList *list) : m_id(id), m_list(list) {}

References id, list, m_id and m_list.

Public Member Functions​

anchor()​

QCString RefItem::anchor ()
 inline

Definition at line 46 of file reflist.h.

46 QCString anchor() const { return m_anchor; }

Reference m_anchor.

Referenced by DocXRefItem::parse and setAnchor.

args()​

QCString RefItem::args ()
 inline

Definition at line 50 of file reflist.h.

50 QCString args() const { return m_args; }

Reference m_args.

Referenced by setArgs.

group()​

QCString RefItem::group ()
 inline

Definition at line 51 of file reflist.h.

51 QCString group() const { return m_group; }

Reference m_group.

Referenced by setGroup.

id()​

int RefItem::id ()
 inline

Definition at line 52 of file reflist.h.

52 int id() const { return m_id; }

Reference m_id.

Referenced by DefinitionImpl::_getXRefListId, addXRefItem and RefItem.

list()​

RefList * RefItem::list ()
 inline

Definition at line 53 of file reflist.h.

53 RefList *list() const { return m_list; }

Reference m_list.

Referenced by DefinitionImpl::_getXRefListId, addXRefItem and RefItem.

name()​

QCString RefItem::name ()
 inline

Definition at line 48 of file reflist.h.

48 QCString name() const { return m_name; }

Reference m_name.

Referenced by setName.

prefix()​

QCString RefItem::prefix ()
 inline

Definition at line 47 of file reflist.h.

47 QCString prefix() const { return m_prefix; }

Reference m_prefix.

Referenced by setPrefix.

scope()​

const Definition * RefItem::scope ()
 inline

Definition at line 54 of file reflist.h.

54 const Definition *scope() const { return m_scope; }

Reference m_scope.

Referenced by setScope.

setAnchor()​

void RefItem::setAnchor (const QCString & anchor)
 inline

Definition at line 37 of file reflist.h.

37 void setAnchor(const QCString &anchor) { 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.

41 void setArgs (const QCString &args) { m_args = args; }

References args and m_args.

setGroup()​

void RefItem::setGroup (const QCString & group)
 inline

Definition at line 42 of file reflist.h.

42 void setGroup (const QCString &group) { m_group = group; }

References group and m_group.

setName()​

void RefItem::setName (const QCString & name)
 inline

Definition at line 39 of file reflist.h.

39 void setName (const QCString &name) { m_name = name; }

References m_name and name.

setPrefix()​

void RefItem::setPrefix (const QCString & prefix)
 inline

Definition at line 38 of file reflist.h.

38 void setPrefix(const QCString &prefix) { m_prefix = prefix; }

References m_prefix and prefix.

setScope()​

void RefItem::setScope (const Definition * scope)
 inline

Definition at line 43 of file reflist.h.

43 void setScope (const Definition *scope) { m_scope = scope; }

References m_scope and scope.

setText()​

void RefItem::setText (const QCString & text)
 inline

Definition at line 36 of file reflist.h.

36 void setText (const QCString &text) { 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.

40 void setTitle (const QCString &title) { m_title = title; }

References m_title and title.

text()​

QCString RefItem::text ()
 inline

Definition at line 45 of file reflist.h.

45 QCString text() const { return m_text; }

Reference m_text.

Referenced by addXRefItem, DocXRefItem::parse and setText.

title()​

QCString RefItem::title ()
 inline

Definition at line 49 of file reflist.h.

49 QCString title() const { return m_title; }

Reference m_title.

Referenced by setTitle.

Private Member Attributes​

m_anchor​

QCString RefItem::m_anchor

anchor in the list

Definition at line 60 of file reflist.h.

60 QCString m_anchor; //!< anchor in the list

Referenced by anchor and setAnchor.

m_args​

QCString RefItem::m_args

optional arguments for the entity (if function)

Definition at line 64 of file reflist.h.

64 QCString m_args; //!< optional arguments for the entity (if function)

Referenced by args and setArgs.

m_group​

QCString RefItem::m_group

group id used to combine item under a single header

Definition at line 65 of file reflist.h.

65 QCString m_group; //!< group id used to combine item under a single header

Referenced by group and setGroup.

m_id​

int RefItem::m_id = 0

unique identifier for this item within its list

Definition at line 57 of file reflist.h.

57 int m_id = 0; //!< unique identifier for this item within its list

Referenced by id and RefItem.

m_list​

RefList* RefItem::m_list

list owning this item

Definition at line 58 of file reflist.h.

58 RefList *m_list; //!< list owning this item

Referenced by list and RefItem.

m_name​

QCString RefItem::m_name

name of the entity containing the reference

Definition at line 62 of file reflist.h.

62 QCString m_name; //!< name of the entity containing the reference

Referenced by name and setName.

m_prefix​

QCString RefItem::m_prefix

type prefix for the name

Definition at line 61 of file reflist.h.

61 QCString m_prefix; //!< type prefix for the name

Referenced by prefix and setPrefix.

m_scope​

const Definition* RefItem::m_scope = nullptr

scope to use for references.

Definition at line 66 of file reflist.h.

66 const Definition *m_scope = nullptr; //!< scope to use for references.

Referenced by scope and setScope.

m_text​

QCString RefItem::m_text

text of the item.

Definition at line 59 of file reflist.h.

59 QCString m_text; //!< text of the item.

Referenced by setText and text.

m_title​

QCString RefItem::m_title

display name of the entity

Definition at line 63 of file reflist.h.

63 QCString m_title; //!< display name of the entity

Referenced by setTitle and title.

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

Generated via doxygen2docusaurus by Doxygen 1.14.0.