DetailSymbolStyleUtils.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------+
|
|   Supplied under applicable software license agreement.
|
|   Copyright (c) 2018 Bentley Systems, Incorporated. All rights reserved.
|
+---------------------------------------------------------------------------------------*/
#pragma once

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE

enum class DSStyleStatus
    {    
    Success                           = BSISUCCESS, // 0
    BadArg                            = 1,
    NoReferencedDetailSymbolStyle     = 2,
    ElementNotADetailingSymbol        = 3,
    ElementNotValid                   = 4,
    InvalidSymbolType                 = 5,
    InvalidDataTreeOwner              = 6,
    UnableToCreateNewStyleNode        = 7,
    Error                             = BSIERROR, // 0x8000
    };

/*=================================================================================**/
struct DetailSymbolStyleUtils
{
public:

    DGNPLATFORM_EXPORT static DSStyleStatus     RemoveStyleReferenceFromElement (ElementRefP elemRef);

    DGNPLATFORM_EXPORT static DSStyleStatus     ScheduleStyleReferenceRemoval (EditElementHandleR graphicElemHandle);

    DGNPLATFORM_EXPORT static DSStyleStatus     GetPathForReferencedStyle (WChar* pathBuf, size_t bufChars, ElementRefP elemRef);

    DGNPLATFORM_EXPORT static DSStyleStatus     GetPathForStyle (WChar* pathBuf, size_t bufChars, DgnPlatform::ElementId detailSymbolStyleID, DgnModelRefP modelRef);

    DGNPLATFORM_EXPORT static DSStyleStatus     GetStyleIDFromPath (DgnPlatform::ElementId* pDetailSymbolStyleID, WCharCP wPath, DgnFileP dgnFileP);

    DGNPLATFORM_EXPORT static DSStyleStatus     GetReferencedStyle (WChar* detailSymbolStylePath, size_t numPathChars, DgnPlatform::ElementId* pElementID, ElementRefP elementRef);

    DGNPLATFORM_EXPORT static DSStyleStatus     GetReferencedStyleID (DgnPlatform::ElementId* pDetailSymbolStyleID, ElementRefP elemRef);

    DGNPLATFORM_EXPORT static ElementId         GetReferencedStyleIDFromHandle (ElementHandleCR graphicElemHandle);

    DGNPLATFORM_EXPORT static DSStyleStatus     SetReferencedStyleID (ElementRefP elementRef, DgnPlatform::ElementId detailSymbolStyleID);

    DGNPLATFORM_EXPORT static DSStyleStatus     ScheduleStyleReferenceAttachment (EditElementHandleR graphicElemHandle, bool& detailSymbolStyleAddedToFile, DetailingSymbolStyle& detailSymbolStyleNode);
    
    DGNPLATFORM_EXPORT  static BentleyStatus  CreateXAttributeDataForStyle (DataExternalizer& , DetailingSymbolStyle& detailSymbolStyle, DgnFileP dgnFileP);

    DGNPLATFORM_EXPORT  static BentleyStatus  GetStyleNameFromXAttributeData (WStringR styleName, void const* data, int size, DgnFileP dgnFileP);

    DGNPLATFORM_EXPORT  static BentleyStatus  CreateXAttributeDataForStyle (DataExternalizer& sink, WCharCP styleName, DgnFileP dgnFileP);

    DGNPLATFORM_EXPORT static DSStyleStatus  GetReferencedStylePath (WString& templatePath, ElementRefP elementRef);

    DGNPLATFORM_EXPORT static DSStyleStatus  GetReferencedStyleInfo (ElementHandleCR ehandle, DetailingSymbolType& symbolType, WStringR stylePath, WStringR styleClassName);

    DGNPLATFORM_EXPORT static WString        GetStyleClassName (DetailingSymbolType symbolType);
};


END_BENTLEY_ECOBJECT_NAMESPACE