bdlat_SelectionInfo Struct Reference [Component bdlat_selectioninfo]

container for selection information More...

#include <bdlat_selectioninfo.h>

List of all members.

Public Member Functions
	BSLMF_NESTED_TRAIT_DECLARATION (bdlat_SelectionInfo, bsl::is_trivially_copyable)
	BSLMF_NESTED_TRAIT_DECLARATION (bdlat_SelectionInfo, bsl::is_trivially_default_constructible)
const char *&	annotation ()
int &	formattingMode ()
int &	id ()
const char *&	name ()
int &	nameLength ()
BSLS_KEYWORD_CONSTEXPR const char *	annotation () const
BSLS_KEYWORD_CONSTEXPR int	formattingMode () const
BSLS_KEYWORD_CONSTEXPR int	id () const
BSLS_KEYWORD_CONSTEXPR const char *	name () const
BSLS_KEYWORD_CONSTEXPR int	nameLength () const
Public Attributes
int	d_id
const char *	d_name_p
int	d_nameLength
const char *	d_annotation_p
int	d_formattingMode

---

Detailed Description

This struct holds information about an selection. Its data members are public by design so that instances may be statically initialized.

See Component bdlat_selectioninfo

---

Member Function Documentation

bdlat_SelectionInfo::BSLMF_NESTED_TRAIT_DECLARATION	(	bdlat_SelectionInfo	,
		bsl::is_trivially_copyable
	)

bdlat_SelectionInfo::BSLMF_NESTED_TRAIT_DECLARATION	(	bdlat_SelectionInfo	,
		bsl::is_trivially_default_constructible
	)

const char*& bdlat_SelectionInfo::annotation

(

)

Return a reference to the modifiable annotation of this selection info object.

int& bdlat_SelectionInfo::formattingMode

(

)

Return a reference to the modifiable formatting mode of this selection info object.

int& bdlat_SelectionInfo::id

(

)

Return a reference to the modifiable id of this selection info object.

const char*& bdlat_SelectionInfo::name

(

)

Return a reference to the modifiable name of this selection info object.

int& bdlat_SelectionInfo::nameLength

(

)

Return a reference to the modifiable length of the name of this selection info object. Note that the 0-terminator is not included in the length.

BSLS_KEYWORD_CONSTEXPR const char* bdlat_SelectionInfo::annotation

(

)

const

Return the non-modifiable annotation of this selection info object.

BSLS_KEYWORD_CONSTEXPR int bdlat_SelectionInfo::formattingMode

(

)

const

Return the formatting mode of this selection info object.

BSLS_KEYWORD_CONSTEXPR int bdlat_SelectionInfo::id

(

)

const

Return the id of this selection info object.

BSLS_KEYWORD_CONSTEXPR const char* bdlat_SelectionInfo::name

(

)

const

Return the non-modifiable name of this selection info object.

BSLS_KEYWORD_CONSTEXPR int bdlat_SelectionInfo::nameLength

(

)

const

Return the length of the name of this selection info object. Note that the 0-terminator is not included in the length.

---

Member Data Documentation

int bdlat_SelectionInfo::d_id

distinct id of selection

const char* bdlat_SelectionInfo::d_name_p

name of selection

int bdlat_SelectionInfo::d_nameLength

length of selection name (0-terminator

const char* bdlat_SelectionInfo::d_annotation_p

selection annotation

int bdlat_SelectionInfo::d_formattingMode

formatting mode

---

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

• bdlat_selectioninfo.h