CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
OdRxLocalizedNameAttribute Class Reference

#include <RxAttribute.h>

Inheritance diagram for OdRxLocalizedNameAttribute:
OdRxAttribute OdRxObject OdRxAlternateLocalizedNameAttribute

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdRxLocalizedNameAttribute)
 
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 (unsigned int id, unsigned int sourceHint=0)
 
static OdString getLocalizedName (const OdRxObject *pO)
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Protected Member Functions

 OdRxLocalizedNameAttribute (OdRxLocalizedNameAttributeImpl *)
 
- Protected Member Functions inherited from OdRxAttribute
 OdRxAttribute (OdRxAttributeImpl *)
 

Additional Inherited Members

- Protected Attributes inherited from OdRxAttribute
OdRxAttributeImplm_pImpl
 

Detailed Description

<group OdRx_Classes>

Provides a human readable name of the member for UI. Uses OdRxResourceLoader to get the actual name.

Definition at line 223 of file RxAttribute.h.

Constructor & Destructor Documentation

◆ OdRxLocalizedNameAttribute()

OdRxLocalizedNameAttribute::OdRxLocalizedNameAttribute ( OdRxLocalizedNameAttributeImpl *  )
protected

Member Function Documentation

◆ createObject()

static OdRxAttributePtr OdRxLocalizedNameAttribute::createObject ( unsigned int  id,
unsigned int  sourceHint = 0 
)
static

Constructs an instance of the attribute to store a string identifier.

Parameters
id[in] ID of the string.
sourceHint[in] Resource ID hint.
Returns
Smart pointer to a constructed attribute object.

◆ getLocalizedName()

static OdString OdRxLocalizedNameAttribute::getLocalizedName ( const OdRxObject pO)
static

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

Parameters
pO[in] Object to get localized name of.
Returns
Localized name of the object if operation was successful; empty string otherwise.

◆ id()

unsigned int OdRxLocalizedNameAttribute::id ( ) const

Retrieves a name string resource identifier.

Returns
Name string resource identifier.

◆ ODRX_DECLARE_MEMBERS()

OdRxLocalizedNameAttribute::ODRX_DECLARE_MEMBERS ( OdRxLocalizedNameAttribute  )

◆ sourceHint()

unsigned int OdRxLocalizedNameAttribute::sourceHint ( ) const

Retrieves a name string resource identifier hint.

Returns
Name string resource identifier hint. Zero if a string resource identifier hint is not set.

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