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

#include <RxAttribute.h>

Inheritance diagram for OdRxDisplayAsAttribute:
OdRxAttribute OdRxObject OdIfcRxDisplayAsAttribute

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdRxDisplayAsAttribute)
 
OdString propertyName ()
 
virtual OdString getDisplayValue (OdRxValue &value)
 
 OdRxDisplayAsAttribute (OdRxDisplayAsAttributeImpl *pImpl)
 
 OdRxDisplayAsAttribute ()
 
- 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 &property_name)
 
- 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 may be used by UI to represent properties of dereferenceable types in human readable form (instead of displaying just handle). <group OdRx_Classes>

Definition at line 627 of file RxAttribute.h.

Constructor & Destructor Documentation

◆ OdRxDisplayAsAttribute() [1/2]

OdRxDisplayAsAttribute::OdRxDisplayAsAttribute ( OdRxDisplayAsAttributeImpl *  pImpl)

◆ OdRxDisplayAsAttribute() [2/2]

OdRxDisplayAsAttribute::OdRxDisplayAsAttribute ( )

Member Function Documentation

◆ createObject()

static OdRxAttributePtr OdRxDisplayAsAttribute::createObject ( const OdString property_name)
static

Constructor.

◆ getDisplayValue()

virtual OdString OdRxDisplayAsAttribute::getDisplayValue ( OdRxValue value)
virtual

By default this function dereferences the value and retrieves the property which name is stored in the attribute. May be overloaded in custom implementations. If the value type is not a reference or the referenced object has no such property, returns an empty string.

Reimplemented in OdIfcRxDisplayAsAttribute.

◆ ODRX_DECLARE_MEMBERS()

OdRxDisplayAsAttribute::ODRX_DECLARE_MEMBERS ( OdRxDisplayAsAttribute  )

◆ propertyName()

OdString OdRxDisplayAsAttribute::propertyName ( )

The name of the property of the dereferenced object to use instead of the object id.


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