#include <RxAttribute.h>

Inheritance diagram for OdRxDescriptionAttribute:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdRxDescriptionAttribute)

	OdRxDescriptionAttribute (OdRxDescriptionAttributeImpl *)

unsigned int	id () const

unsigned int	sourceHint () const

Public Member Functions inherited from OdRxAttribute
	ODRX_DECLARE_MEMBERS (OdRxAttribute)

virtual	~OdRxAttribute ()

Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()

	OdRxObject ()

virtual	~OdRxObject ()

virtual OdRxObject *	queryX (const OdRxClass *pClass) const

virtual OdRxObject *	x (const OdRxClass *pClass) const

virtual OdRxClass *	isA () const

virtual void	addRef ()=0

virtual void	release ()=0

virtual long	numRefs () const

bool	isKindOf (const OdRxClass *pClass) const

virtual OdRxObjectPtr	clone () const

virtual void	copyFrom (const OdRxObject *pSource)

virtual OdRx::Ordering	comparedTo (const OdRxObject *pOther) const

virtual bool	isEqualTo (const OdRxObject *pOther) const

Static Public Member Functions
static OdRxAttributePtr	createObject (const OdString &description, unsigned int id=0, unsigned int sourceHint=0)

static OdString	getDescription (const OdRxObject *pO)

Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)

static OdRxClass *	desc ()

Additional Inherited Members
Protected Member Functions inherited from OdRxAttribute
	OdRxAttribute (OdRxAttributeImpl *)

Protected Attributes inherited from OdRxAttribute
OdRxAttributeImpl *	m_pImpl

Detailed Description

This attribute provides a human readable description of the member for UI.

Definition at line 374 of file RxAttribute.h.

Constructor & Destructor Documentation

◆ OdRxDescriptionAttribute()

OdRxDescriptionAttribute::OdRxDescriptionAttribute ( OdRxDescriptionAttributeImpl * )

Member Function Documentation

◆ createObject()

static OdRxAttributePtr OdRxDescriptionAttribute::createObject	(	const OdString &	description,
		unsigned int	id = `0`,
		unsigned int	sourceHint = `0`
	)

static

Constructor. Creates an attribute to store a description string resource ID and a resource ID hint.

Parameters

description	[in] Description string.
id	[in] Resource ID of the string.
sourceHint	[in] Resource ID hint.

Returns: Smart pointer to a constructed attribute object.

◆ getDescription()

static OdString OdRxDescriptionAttribute::getDescription ( const OdRxObject * pO )

static

Looks up OdRxDescriptionAttribute on the object if it is a member, (and in the object class attribute list if it is not), and uses OdRxResourceLoader to get the string from resources identified by ID and hint.

Parameters

pO	[in] Object to be queried for a description.

Returns: A description string if found; empty string otherwise.

◆ id()

unsigned int OdRxDescriptionAttribute::id ( ) const

Gets the description string resource identifier.

Returns: Description string resource identifier.

◆ ODRX_DECLARE_MEMBERS()

OdRxDescriptionAttribute::ODRX_DECLARE_MEMBERS ( OdRxDescriptionAttribute )

◆ sourceHint()

unsigned int OdRxDescriptionAttribute::sourceHint ( ) const

Gets the description string resource identifier hint.

Returns: Description string resource identifier hint. Zero if the string resource identifier hint is not set.

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

RxAttribute.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members