Description:

Encapsulates the information given with the links that this whole project was created for. Instances represent an XLink to a doxygen Target as given by the user.

Definition at line 25 of file styles.hpp.

#include <styles.hpp>

Public Static Field Index:
static constexpr alib::String	Class = "xl-class"
	CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.
static constexpr alib::String	Code = "xl-entity"
	CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.
static constexpr alib::String	Concept = "xl-concept"
	CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.
static constexpr alib::String	Dir = "xl-dir"
	CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.
static constexpr alib::String	Doc = "xl-doc"
	CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.
static constexpr alib::String	EL = "el"
	CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.
static constexpr alib::String	ELRef = "elRef"
	CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.
static constexpr alib::String	ELUnknown = "xl-elukn"
	CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.
static constexpr alib::String	Enum = "xl-enum"
	CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.
static constexpr alib::String	EnumElem = "xl-enumelem"
	CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.
static constexpr alib::String	File = "xl-file"
	CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.
static constexpr alib::String	FileOrDir = "xl-filedir"
	CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.
static constexpr alib::String	Func = "xl-func"
	CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.
static constexpr alib::String	Indirect = "xl-indirect"
	CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.
static constexpr alib::String	Macro = "xl-macro"
	CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.
static constexpr alib::String	Namespace = "xl-ns"
	CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.
static constexpr alib::String	NsMem = "xl-in-ns"
	CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.
static constexpr alib::String	RecMem = "xl-in-rec"
	CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.
static constexpr alib::String	Record = "xl-record"
	CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.
static constexpr alib::String	SrcFile = "xl-srcfile"
	todo: only set with EL/ELRef today.
static constexpr alib::String	SrcFileLine = "xl-srcline"
	CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.
static constexpr alib::String	Struct = "xl-struct"
	CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.
static constexpr alib::String	Template = "xl-template"
	CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.
static constexpr alib::String	TemplSpec = "xl-tempspec"
	CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.
static constexpr alib::String	Typedef = "xl-typedef"
	CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.
static constexpr alib::String	Union = "xl-union"
	CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.
static constexpr alib::String	Var = "xl-var"
	CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.
static constexpr alib::String	WithDisp = "xl-display"
	CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.
static constexpr alib::String	XLEL = "xl-el"
	CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.

Public Method Index:
	Styles ()=default
	Constructor.
void	Add (const alib::String &style)
const alib::String &	Get (int idx) const
bool	IsCodeEntity () const
bool	IsDir () const
bool	IsFile () const
bool	IsVerbal () const
void	Set (const Index::Node &node, bool hasDisplayText, bool isIndirect)
int	Size () const

Protected Static Field Index:
static constexpr int	MAX_STYLES = 7
	The maximum number of styles attached by DoxygenXLinks.

Protected Field Index:
bool	isCodeEntity = false
	This set when a code entity is targeted by the XLink.
bool	isDir = false
	This set when a dir is targeted by the XLink.
bool	isFile = false
	This set when a file is targeted by the XLink.
bool	isVerbal = false
	This is set when a display text was given to the XLink.
const alib::String *	list [MAX_STYLES]
	The original source string.
int	size = 0
	The number of styles in list.

◆ DoxygenXLinks

friend class DoxygenXLinks

friend

Definition at line 26 of file styles.hpp.

Field Details:

◆ Class

alib::String dxl::Styles::Class = "xl-class"

staticconstexpr

CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.

Definition at line 71 of file styles.hpp.

◆ Code

alib::String dxl::Styles::Code = "xl-entity"

staticconstexpr

CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.

Definition at line 64 of file styles.hpp.

◆ Concept

alib::String dxl::Styles::Concept = "xl-concept"

staticconstexpr

CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.

Definition at line 68 of file styles.hpp.

◆ Dir

alib::String dxl::Styles::Dir = "xl-dir"

staticconstexpr

CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.

Definition at line 62 of file styles.hpp.

◆ Doc

alib::String dxl::Styles::Doc = "xl-doc"

staticconstexpr

CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.

Definition at line 57 of file styles.hpp.

◆ EL

alib::String dxl::Styles::EL = "el"

staticconstexpr

CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.

Definition at line 54 of file styles.hpp.

◆ ELRef

alib::String dxl::Styles::ELRef = "elRef"

staticconstexpr

CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.

Definition at line 55 of file styles.hpp.

◆ ELUnknown

alib::String dxl::Styles::ELUnknown = "xl-elukn"

staticconstexpr

CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.

Definition at line 89 of file styles.hpp.

◆ Enum

alib::String dxl::Styles::Enum = "xl-enum"

staticconstexpr

CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.

Definition at line 73 of file styles.hpp.

◆ EnumElem

alib::String dxl::Styles::EnumElem = "xl-enumelem"

staticconstexpr

CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.

Definition at line 74 of file styles.hpp.

◆ File

alib::String dxl::Styles::File = "xl-file"

staticconstexpr

CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.

Definition at line 59 of file styles.hpp.

◆ FileOrDir

alib::String dxl::Styles::FileOrDir = "xl-filedir"

staticconstexpr

CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.

Definition at line 78 of file styles.hpp.

◆ Func

alib::String dxl::Styles::Func = "xl-func"

staticconstexpr

CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.

Definition at line 76 of file styles.hpp.

◆ Indirect

alib::String dxl::Styles::Indirect = "xl-indirect"

staticconstexpr

CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.

Definition at line 82 of file styles.hpp.

◆ isCodeEntity

bool dxl::Styles::isCodeEntity = false

protected

This set when a code entity is targeted by the XLink.

Definition at line 44 of file styles.hpp.

◆ isDir

bool dxl::Styles::isDir = false

protected

This set when a dir is targeted by the XLink.

Definition at line 47 of file styles.hpp.

◆ isFile

bool dxl::Styles::isFile = false

protected

This set when a file is targeted by the XLink.

Definition at line 50 of file styles.hpp.

◆ isVerbal

bool dxl::Styles::isVerbal = false

protected

This is set when a display text was given to the XLink.

Definition at line 41 of file styles.hpp.

◆ list

const alib::String* dxl::Styles::list[MAX_STYLES]

protected

The original source string.

Definition at line 35 of file styles.hpp.

◆ Macro

alib::String dxl::Styles::Macro = "xl-macro"

staticconstexpr

CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.

Definition at line 66 of file styles.hpp.

◆ MAX_STYLES

int dxl::Styles::MAX_STYLES = 7

staticconstexprprotected

The maximum number of styles attached by DoxygenXLinks.

Definition at line 32 of file styles.hpp.

◆ Namespace

alib::String dxl::Styles::Namespace = "xl-ns"

staticconstexpr

CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.

Definition at line 69 of file styles.hpp.

◆ NsMem

alib::String dxl::Styles::NsMem = "xl-in-ns"

staticconstexpr

CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.

Definition at line 83 of file styles.hpp.

◆ RecMem

alib::String dxl::Styles::RecMem = "xl-in-rec"

staticconstexpr

CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.

Definition at line 84 of file styles.hpp.

◆ Record

alib::String dxl::Styles::Record = "xl-record"

staticconstexpr

CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.

Definition at line 79 of file styles.hpp.

◆ size

int dxl::Styles::size = 0

protected

The number of styles in list.

Definition at line 38 of file styles.hpp.

◆ SrcFile

alib::String dxl::Styles::SrcFile = "xl-srcfile"

staticconstexpr

todo: only set with EL/ELRef today.

Definition at line 60 of file styles.hpp.

◆ SrcFileLine

alib::String dxl::Styles::SrcFileLine = "xl-srcline"

staticconstexpr

CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.

Definition at line 61 of file styles.hpp.

◆ Struct

alib::String dxl::Styles::Struct = "xl-struct"

staticconstexpr

CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.

Definition at line 70 of file styles.hpp.

◆ Template

alib::String dxl::Styles::Template = "xl-template"

staticconstexpr

CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.

Definition at line 80 of file styles.hpp.

◆ TemplSpec

alib::String dxl::Styles::TemplSpec = "xl-tempspec"

staticconstexpr

CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.

Definition at line 81 of file styles.hpp.

◆ Typedef

alib::String dxl::Styles::Typedef = "xl-typedef"

staticconstexpr

CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.

Definition at line 67 of file styles.hpp.

◆ Union

alib::String dxl::Styles::Union = "xl-union"

staticconstexpr

CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.

Definition at line 72 of file styles.hpp.

◆ Var

alib::String dxl::Styles::Var = "xl-var"

staticconstexpr

CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.

Definition at line 75 of file styles.hpp.

◆ WithDisp

alib::String dxl::Styles::WithDisp = "xl-display"

staticconstexpr

CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.

Definition at line 85 of file styles.hpp.

◆ XLEL

alib::String dxl::Styles::XLEL = "xl-el"

staticconstexpr

CSS class name. See user manual chapter 2. CSS Link Styles for HTML Output.

Definition at line 88 of file styles.hpp.

Method Details:

◆ Add()

void dxl::Styles::Add ( const alib::String & style )

inline

Adds the given style class string to this list of styles.

Parameters

style The target node.

Definition at line 118 of file styles.hpp.

◆ Get()

const alib::String & dxl::Styles::Get ( int idx ) const

inline

Receives a style-class string.

Parameters

idx	The index requested

Returns: The class with the given idx.

Definition at line 113 of file styles.hpp.

◆ IsCodeEntity()

bool dxl::Styles::IsCodeEntity ( ) const

inline

Returns: true if a code entity is targeted by the XLink, false otherwise.

Definition at line 102 of file styles.hpp.

◆ IsDir()

bool dxl::Styles::IsDir ( ) const

inline

Returns: true if a directory is targeted by the XLink, false otherwise.

Definition at line 105 of file styles.hpp.

◆ IsFile()

bool dxl::Styles::IsFile ( ) const

inline

Returns: true if a file is targeted by the XLink, false otherwise.

Definition at line 108 of file styles.hpp.

◆ IsVerbal()

bool dxl::Styles::IsVerbal ( ) const

inline

Returns: true if a display text was given to the XLink, false otherwise.

Definition at line 99 of file styles.hpp.

◆ Set()

void dxl::Styles::Set	(	const Index::Node &	node,
		bool	hasDisplayText,
		bool	isIndirect )

Sets the styles from the given parameters.

Note: Additional styles are defined and set with the method DoxygenXLinks::GetELDecoration.

Parameters

node	The target-node to set the styles for.
hasDisplayText	Denotes whether a dedicated display text was given to the XLink.
isIndirect	Denotes whether a type-definition or an inherited member was resolved.

Definition at line 18 of file styles.cpp.

◆ Size()

int dxl::Styles::Size ( ) const

inline

Receives the number of style-classes set.

Returns: The number of style-classes set.

Definition at line 96 of file styles.hpp.

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

Description:

Public Static Field Index:

Public Method Index:

Protected Static Field Index:

Protected Field Index:

Friends And Related Entity Details:

◆ DoxygenXLinks

Field Details:

◆ Class

◆ Code

◆ Concept

◆ Dir

◆ Doc

◆ EL

◆ ELRef

◆ ELUnknown

◆ Enum

◆ EnumElem

◆ File

◆ FileOrDir

◆ Func

◆ Indirect

◆ isCodeEntity

◆ isDir

◆ isFile

◆ isVerbal

◆ list

◆ Macro

◆ MAX_STYLES

◆ Namespace

◆ NsMem

◆ RecMem

◆ Record

◆ size

◆ SrcFile

◆ SrcFileLine

◆ Struct

◆ Template

◆ TemplSpec

◆ Typedef

◆ Union

◆ Var

◆ WithDisp

◆ XLEL

Method Details:

◆ Add()

◆ Get()

◆ IsCodeEntity()

◆ IsDir()

◆ IsFile()

◆ IsVerbal()

◆ Set()

◆ Size()