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

#include <RxAttribute.h>

Inheritance diagram for OdRxResourceLoader:
OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdRxResourceLoader)
 
- 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 OdResult loadString (const OdRxObject *pClass, unsigned int id, unsigned int sourceHint, OdString &result)
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Protected Member Functions

virtual OdResult subLoadString (unsigned int id, unsigned int sourceHint, OdString &result)=0
 

Detailed Description

<group OdRx_Classes>

Protocol extension to handle loading strings from resources. (E.g. for localization.)

Definition at line 177 of file RxAttribute.h.

Member Function Documentation

◆ loadString()

static OdResult OdRxResourceLoader::loadString ( const OdRxObject pClass,
unsigned int  id,
unsigned int  sourceHint,
OdString result 
)
static

Load the string identified by the ID and a hint. Queries the class for OdRxResourceLoader and calls subLoadString() to do the actual loading.

Parameters
pClass[in] Class to be queried.
id[in] Resource ID of the string.
sourceHint[in] Resource ID hint.
result[out] Loaded string.
Returns
Result of the subLoadString() call for the queried class or eNotImplemented if the subLoadString() is not implemented in the queried class.

◆ ODRX_DECLARE_MEMBERS()

OdRxResourceLoader::ODRX_DECLARE_MEMBERS ( OdRxResourceLoader  )

◆ subLoadString()

virtual OdResult OdRxResourceLoader::subLoadString ( unsigned int  id,
unsigned int  sourceHint,
OdString result 
)
protectedpure virtual

Loads the string identified by the ID and a hint. Implementation is up to the application.

Parameters
id[in] Resource ID of the string.
sourceHint[in] Resource ID hint.
result[out] Loaded string.
Returns
Result of the operation. Depends on implementation.

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