RxAttribute.h

Go to the documentation of this file.

 
// Copyright (C) 2002-2022, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2022 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
#ifndef _ODRXATTRIBUTE_INCLUDED_
#define _ODRXATTRIBUTE_INCLUDED_
 
#include "OdString.h"
#include "OdArray.h"
#include "RxValue.h"
#include "RxProperty.h"
 
  //DOM-IGNORE-BEGIN
class OdRxAttributeImpl;
class OdRxAttributeCollectionImpl;
class OdRxMember;
class OdRxPropertyBase;
//DOM-IGNORE-END
 
class ODRX_ABSTRACT FIRSTDLL_EXPORT OdRxAttribute : public OdRxObject
{
public:
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdRxAttribute);
  //DOM-IGNORE-END
 
  virtual ~OdRxAttribute();
protected:
  //DOM-IGNORE-BEGIN
  OdRxAttribute(OdRxAttributeImpl*);
  friend class OdRxAttributeImpl;
  OdRxAttributeImpl* m_pImpl;
  //DOM-IGNORE-END
};
 
typedef OdSmartPtr<OdRxAttribute>OdRxAttributePtr;
 
class FIRSTDLL_EXPORT OdRxAttributeCollection
{
  //DOM-IGNORE-BEGIN
  friend class OdRxAttributeCollectionImpl;
  OdRxAttributeCollectionImpl* m_pImpl;
  //DOM-IGNORE-END
public:
  OdRxAttributeCollection();
 
  ~OdRxAttributeCollection();
  
  int count() const;
  
  const OdRxAttribute* getAt(int index) const;
  
  OdRxAttribute* getAt(int index);
 
  const OdRxAttribute* get(const OdRxClass* type) const;
 
  OdRxAttribute* get(const OdRxClass* type);
 
  OdResult add(const OdRxAttribute* attribute);
  
  OdResult override(const OdRxAttribute* attribute);
 
  OdResult remove(const OdRxAttribute* attribute);
};
 
class ODRX_ABSTRACT FIRSTDLL_EXPORT OdRxResourceLoader : public OdRxObject
{
protected:
 
  virtual OdResult subLoadString(unsigned int id, unsigned int sourceHint, OdString& result) = 0;
public:
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdRxResourceLoader);
  //DOM-IGNORE-END
 
  static OdResult loadString(const OdRxObject* pClass, unsigned int id, unsigned int sourceHint, OdString& result);
};
 
//DOM-IGNORE-BEGIN
class OdRxLocalizedNameAttributeImpl;
//DOM-IGNORE-END
 
class FIRSTDLL_EXPORT OdRxLocalizedNameAttribute : public OdRxAttribute
{
public:
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdRxLocalizedNameAttribute);
  //DOM-IGNORE-END
  
  static OdRxAttributePtr createObject(unsigned int id, unsigned int sourceHint = 0);
  
  static OdString getLocalizedName(const OdRxObject* pO);
  
  unsigned int id() const;
  
  unsigned int sourceHint() const;
protected:
  //DOM-IGNORE-BEGIN
  OdRxLocalizedNameAttribute(OdRxLocalizedNameAttributeImpl*);
  //DOM-IGNORE-END
};
 
//DOM-IGNORE-BEGIN
class OdRxAlternateLocalizedNameAttributeImpl;
//DOM-IGNORE-END
 
class FIRSTDLL_EXPORT OdRxAlternateLocalizedNameAttribute : public OdRxLocalizedNameAttribute
{
public:
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdRxAlternateLocalizedNameAttribute);
  //DOM-IGNORE-END
 
  static OdRxAttributePtr createObject(unsigned int id, unsigned int sourceHint = 0);
 
  //DOM-IGNORE-BEGIN
  OdRxAlternateLocalizedNameAttribute(OdRxAlternateLocalizedNameAttributeImpl* impl);
  //DOM-IGNORE-END
};
 
//DOM-IGNORE-BEGIN
class OdRxUiPlacementAttributeImpl;
//DOM-IGNORE-END
 
class FIRSTDLL_EXPORT OdRxUiPlacementAttribute : public OdRxAttribute
{
public:
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdRxUiPlacementAttribute);
  OdRxUiPlacementAttribute(OdRxUiPlacementAttributeImpl*);
  //DOM-IGNORE-END
 
  static OdRxAttributePtr createObject(const OdString& category, unsigned int weight);
 
  static OdString getCategory(const OdRxObject* member);
 
  static float getWeight(const OdRxObject* member);
};
 
//DOM-IGNORE-BEGIN
class OdRxLMVAttributeImpl;
class FIRSTDLL_EXPORT OdRxLMVAttribute : public OdRxAttribute
{
public:
  ODRX_DECLARE_MEMBERS(OdRxLMVAttribute);
  OdRxLMVAttribute(OdRxLMVAttributeImpl*);
};
//DOM-IGNORE-END
 
//DOM-IGNORE-BEGIN
class OdRxDescriptionAttributeImpl;
//DOM-IGNORE-END
 
class FIRSTDLL_EXPORT OdRxDescriptionAttribute : public OdRxAttribute
{
public:
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdRxDescriptionAttribute);
  OdRxDescriptionAttribute(OdRxDescriptionAttributeImpl*);
  //DOM-IGNORE-END
 
  static OdRxAttributePtr createObject(const OdString& description, unsigned int id = 0, unsigned int sourceHint = 0);
  
  static OdString getDescription(const OdRxObject* pO);
  
  unsigned int id() const;
 
  unsigned int sourceHint() const;
};
 
typedef OdRxPropertyBasePtr (*FindPropertyCallback)(const OdRxObject* pObject, const OdString& pszPropName);
 
typedef bool(*ConvertValueCallback)(const OdRxPropertyBase* pProperty, OdRxValue& value);
 
//DOM-IGNORE-BEGIN
class OdRxRefersToAttributeImpl;
//DOM-IGNORE-END
 
class FIRSTDLL_EXPORT OdRxRefersToAttribute : public OdRxAttribute
{
public:
//DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdRxRefersToAttribute);
//DOM-IGNORE-END
 
  static OdRxAttributePtr createObject(const OdString& path);
 
  OdString path() const;
 
  static const OdRxPropertyBasePtr parseReference(const OdString& path, const OdRxObject* pObject, FindPropertyCallback find = NULL, ConvertValueCallback convert = NULL);
protected:
  //DOM-IGNORE-BEGIN
  OdRxRefersToAttribute(OdRxRefersToAttributeImpl*);
  //DOM-IGNORE-END
};
 
//DOM-IGNORE-BEGIN
class OdRxCOMAttributeImpl;
//DOM-IGNORE-END
 
class FIRSTDLL_EXPORT OdRxCOMAttribute : public OdRxAttribute
{
public:
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdRxCOMAttribute);
  //DOM-IGNORE-END
  static OdRxAttributePtr createObject(const OdString& name);
 
  OdString name() const;
protected:
  //DOM-IGNORE-BEGIN
  OdRxCOMAttribute(OdRxCOMAttributeImpl*);
  //DOM-IGNORE-END
};
 
//DOM-IGNORE-BEGIN
class OdRxFilePathAttributeImpl;
//DOM-IGNORE-END
 
class FIRSTDLL_EXPORT OdRxFilePathAttribute : public OdRxAttribute
{
public:
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdRxFilePathAttribute);
protected:
  OdRxFilePathAttribute(OdRxFilePathAttributeImpl*);
  //DOM-IGNORE-END
};
 
//DOM-IGNORE-BEGIN
class OdRxFlagsAttributeImpl;
//DOM-IGNORE-END
 
class FIRSTDLL_EXPORT OdRxFlagsAttribute : public OdRxAttribute
{
public:
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdRxFlagsAttribute);
protected:
  OdRxFlagsAttribute(OdRxFlagsAttributeImpl*);
  //DOM-IGNORE-END
};
 
//DOM-IGNORE-BEGIN
class OdRxUnitTypeAttributeImpl;
//DOM-IGNORE-END
 
class FIRSTDLL_EXPORT OdRxUnitTypeAttribute : public OdRxAttribute
{
public:
 
  enum UnitType
  {
    kUnitless = 0,
    kDistance = (0x1 << 0),
    kAngle = (0x1 << 1),
    kArea = (0x1 << 2),
    kVolume = (0x1 << 3),
    kCurrency = (0x1 << 4),
    kPercentage = (0x1 << 5),
    kAngleNotTransformed = (0x1 << 16),
  };
 
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdRxUnitTypeAttribute);
  //DOM-IGNORE-END
  
  static OdRxAttributePtr createObject(UnitType unitType);
 
  UnitType unitType() const;
protected:
  //DOM-IGNORE-BEGIN
  OdRxUnitTypeAttribute(OdRxUnitTypeAttributeImpl*);
  //DOM-IGNORE-END
};
 
//DOM-IGNORE-BEGIN
class OdRxUseDialogForReferredCollectionAttributeImpl;
 
class FIRSTDLL_EXPORT OdRxUseDialogForReferredCollectionAttribute : public OdRxAttribute
{
public:
  ODRX_DECLARE_MEMBERS(OdRxUseDialogForReferredCollectionAttribute);
protected:
  OdRxUseDialogForReferredCollectionAttribute(OdRxUseDialogForReferredCollectionAttributeImpl*);
};
 
class OdRxUiCascadingContextMenuAttributeImpl;
class FIRSTDLL_EXPORT OdRxUiCascadingContextMenuAttribute : public OdRxAttribute
{
public:
  ODRX_DECLARE_MEMBERS(OdRxUiCascadingContextMenuAttribute);
protected:
  OdRxUiCascadingContextMenuAttribute(OdRxUiCascadingContextMenuAttributeImpl*);
};
//DOM-IGNORE-END
 
//DOM-IGNORE-BEGIN
class OdRxCumulativeAttributeImpl;
//DOM-IGNORE-END
 
class FIRSTDLL_EXPORT OdRxCumulativeAttribute : public OdRxAttribute
{
public:
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdRxCumulativeAttribute);
  //DOM-IGNORE-END
 
  static OdRxAttributePtr createObject(const OdString& type);
 
  OdString type() const;
protected:
  //DOM-IGNORE-BEGIN
  OdRxCumulativeAttribute(OdRxCumulativeAttributeImpl*);
  //DOM-IGNORE-END
};
 
//DOM-IGNORE-BEGIN
class OdRxAffinityAttributeImpl;
//DOM-IGNORE-END
 
class FIRSTDLL_EXPORT OdRxAffinityAttribute : public OdRxAttribute
{
public:
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdRxAffinityAttribute);
  //DOM-IGNORE-END
 
  static OdRxAttributePtr createObject(const OdString& name);
 
  OdString name() const;
protected:
  //DOM-IGNORE-BEGIN
  OdRxAffinityAttribute(OdRxAffinityAttributeImpl*);
  //DOM-IGNORE-END
};
 
//DOM-IGNORE-BEGIN
class OdRxTypePromotionAttributeImpl;
//DOM-IGNORE-END
 
class FIRSTDLL_EXPORT OdRxTypePromotionAttribute : public OdRxAttribute
{
public:
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdRxTypePromotionAttribute);
  //DOM-IGNORE-END
 
  static OdRxAttributePtr createObject(const OdString& properties);
 
  OdString properties() const;
protected:
  //DOM-IGNORE-BEGIN
  OdRxTypePromotionAttribute(OdRxTypePromotionAttributeImpl*);
  //DOM-IGNORE-END
};
 
//DOM-IGNORE-BEGIN
class OdRxUnionTypeAttributeImpl;
//DOM-IGNORE-END
 
class FIRSTDLL_EXPORT OdRxUnionTypeAttribute : public OdRxAttribute
{
public:
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdRxUnionTypeAttribute);
  //DOM-IGNORE-END
 
  static OdRxAttributePtr createObject(const OdString& typenames);
 
  OdString typenames() const;
protected:
  //DOM-IGNORE-BEGIN
  OdRxUnionTypeAttribute(OdRxUnionTypeAttributeImpl*);
  //DOM-IGNORE-END
};
 
//DOM-IGNORE-BEGIN
class OdRxDefaultValueAttributeImpl;
//DOM-IGNORE-END
 
class FIRSTDLL_EXPORT OdRxDefaultValueAttribute : public OdRxAttribute
{
public:
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdRxDefaultValueAttribute);
  //DOM-IGNORE-END
 
  static OdRxAttributePtr createObject(const OdRxValue& value);
 
  const OdRxValue& value() const;
protected:
  //DOM-IGNORE-BEGIN
  OdRxDefaultValueAttribute(OdRxDefaultValueAttributeImpl*);
  //DOM-IGNORE-END
};
 
//DOM-IGNORE-BEGIN
class OdRxHierarchyLevelAttributeImpl;
//DOM-IGNORE-END
 
class FIRSTDLL_EXPORT OdRxHierarchyLevelAttribute : public OdRxAttribute
{
public:
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdRxHierarchyLevelAttribute);
  //DOM-IGNORE-END
 
  static OdRxAttributePtr createObject(const OdString& value);
 
  OdString defaultValue();
 
  virtual OdString value(OdRxValue& value);
 
  //DOM-IGNORE-BEGIN
  OdRxHierarchyLevelAttribute(OdRxHierarchyLevelAttributeImpl*);
  OdRxHierarchyLevelAttribute();
  //DOM-IGNORE-END
};
 
//DOM-IGNORE-BEGIN
class OdRxDisplayAsAttributeImpl;
//DOM-IGNORE-END
 
class FIRSTDLL_EXPORT OdRxDisplayAsAttribute : public OdRxAttribute
{
public:
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdRxDisplayAsAttribute);
  //DOM-IGNORE-END
 
  static OdRxAttributePtr createObject(const OdString& property_name);
 
  OdString propertyName();
 
  virtual OdString getDisplayValue(OdRxValue& value, bool useDynamicProperties = true);
 
  //DOM-IGNORE-BEGIN
  OdRxDisplayAsAttribute(OdRxDisplayAsAttributeImpl* pImpl);
  OdRxDisplayAsAttribute();
  //DOM-IGNORE-END
};
 
//DOM-IGNORE-BEGIN
class OdRxDynamicAttributeImpl;
//DOM-IGNORE-END
 
class FIRSTDLL_EXPORT OdRxDynamicAttribute : public OdRxAttribute
{
public:
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdRxDynamicAttribute);
  //DOM-IGNORE-END
 
  static OdRxAttributePtr createObject(const OdString& name, const OdRxValue& value);
 
  OdString getName() const;
 
  const OdRxValue& getValue() const;
 
  OdRxValue& getValue();
 
protected:
  //DOM-IGNORE-BEGIN
  OdRxDynamicAttribute(OdRxDynamicAttributeImpl*);
  //DOM-IGNORE-END
};
 
typedef OdSmartPtr<OdRxDynamicAttribute> OdRxDynamicAttributePtr;
 
//DOM-IGNORE-BEGIN
class OdRxDynamicCollectionAttributeImpl;
//DOM-IGNORE-END
 
class FIRSTDLL_EXPORT OdRxDynamicCollectionAttribute : public OdRxAttribute
{
public:
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdRxDynamicCollectionAttribute);
  //DOM-IGNORE-END
  //static OdRxAttributePtr createObject();
 
  int count() const;
 
  const OdRxDynamicAttribute* getAt(int index) const;
 
  OdRxDynamicAttribute* getAt(int index);
 
  const OdRxDynamicAttribute* getByName(const OdString name, bool caseSensitive) const;
 
  OdRxDynamicAttribute* getByName(const OdString name, bool caseSensitive);
 
  OdResult add(const OdRxDynamicAttribute* attribute);
 
  OdResult remove(const OdRxDynamicAttribute* attribute);
 
protected:
  //DOM-IGNORE-BEGIN
  OdRxDynamicCollectionAttribute(OdRxDynamicCollectionAttributeImpl*);
  //DOM-IGNORE-END
};
 
typedef OdSmartPtr<OdRxDynamicCollectionAttribute> OdRxDynamicCollectionAttributePtr;
 
//DOM-IGNORE-BEGIN
class OdRxGenerateDynamicPropertiesAttributeImpl;
//DOM-IGNORE-END
 
class OdRxGenerateDynamicPropertiesAttribute : public OdRxAttribute
{
public:
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdRxGenerateDynamicPropertiesAttribute);
  //DOM-IGNORE-END
 
  OdRxGenerateDynamicPropertiesAttribute();
protected:
  //DOM-IGNORE-BEGIN
  OdRxGenerateDynamicPropertiesAttribute(OdRxGenerateDynamicPropertiesAttributeImpl*);
  //DOM-IGNORE-END
};
 
#endif