CFx SDK Documentation  2022 SP0
Public Member Functions | Static Public Member Functions | List of all members
OdRxDescriptionAttribute Class Reference

#include <RxAttribute.h>

Inheritance diagram for OdRxDescriptionAttribute:
OdRxAttribute OdRxObject

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 OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () 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 Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Additional Inherited Members

- Protected Member Functions inherited from OdRxAttribute
 OdRxAttribute (OdRxAttributeImpl *)
 
- Protected Attributes inherited from OdRxAttribute
OdRxAttributeImplm_pImpl
 

Detailed Description

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

<group OdRx_Classes>

Definition at line 270 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

Create an attribute to store description string resource id and resource hint.

◆ id()

unsigned int OdRxDescriptionAttribute::id ( ) const

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.

Description string resource identifier.

◆ ODRX_DECLARE_MEMBERS()

OdRxDescriptionAttribute::ODRX_DECLARE_MEMBERS ( OdRxDescriptionAttribute  )

◆ sourceHint()

unsigned int OdRxDescriptionAttribute::sourceHint ( ) const

Description string resource identifier hint. (Zero if not set.)


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