DetailingSymbolStyle.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

DGNPLATFORM_TYPEDEFS (DetailingSymbolSettings)
DGNPLATFORM_TYPEDEFS (IDetailingSymbol)
DGNPLATFORM_TYPEDEFS (DetailingSymbolStyle)
DGNPLATFORM_REF_COUNTED_PTR (DetailingSymbolStyle)

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE

//=======================================================================================
//=======================================================================================


/*=================================================================================**/
struct DetailingSymbolStyle : XDataTreeNode 

{
public:

    DGNPLATFORM_EXPORT BentleyStatus                        ScheduleApplyToElement (EditElementHandleR element);

    DGNPLATFORM_EXPORT BentleyStatus                        ScheduleRemoveFromElement (EditElementHandleR styleElem);

    DGNPLATFORM_EXPORT static DetailingSymbolStylePtr       Create (WCharCP name, DgnFileR file);

    DGNPLATFORM_EXPORT static DetailingSymbolStylePtr       Create (WCharCP name, DgnFileR file, int sortPriority, bool allowChildNodes, DgnPlatform::ElementId parentId, DgnPlatform::ElementId elemID, XDataTreeOwner& owner);

    DGNPLATFORM_EXPORT static DetailingSymbolStylePtr       GetByName (WCharCP name, DgnFileR file);

    DGNPLATFORM_EXPORT static DetailingSymbolStylePtr       GetFromElement (ElementRefP elementRef);

    DGNPLATFORM_EXPORT static DetailingSymbolStylePtr       GetByID (DgnPlatform::ElementId elemID, DgnFileR file);

    DGNPLATFORM_EXPORT static BentleyStatus                 Delete (WCharCP name, DgnFileR file);

    DGNPLATFORM_EXPORT DetailingSymbolStylePtr              CopyToFile (DgnFileR file);

    DGNPLATFORM_EXPORT DetailingSymbolStylePtr              Copy () const;
    DGNPLATFORM_EXPORT BentleyStatus                        CopyValues (DetailingSymbolStyleCR source);

    DGNPLATFORM_EXPORT WCharCP                              GetName () const;

    DGNPLATFORM_EXPORT ElementId                            GetID () const;

    DGNPLATFORM_EXPORT DgnFileP                             GetFile () const;

    DGNPLATFORM_EXPORT StatusInt                            Write ();

    DGNPLATFORM_EXPORT BentleyStatus                        SetName (WCharCP newName);//rename

    //DGNPLATFORM_EXPORT bool                                 IsValid () const;
    //For applysymbology related methods like modifylevel and others we need to have Host Admin stuff, with default implementation in dgnplatform if no host is available.

    DGNPLATFORM_EXPORT BentleyStatus                        ApplySymbology (IDetailingSymbol* symbolDef) const;

    DGNPLATFORM_EXPORT BentleyStatus                        ApplySymbology (EditElementHandleR ehandle) const;

    DGNPLATFORM_EXPORT bool                                 Validate (WString* errMessage, bvector<std::pair<WString, WString>>* detailMessage) ;//const {return false;}

    DGNPLATFORM_EXPORT bool                                 IsStyleInUse ();

    DGNPLATFORM_EXPORT int                                  UpdateStyleUsers ();

    DGNPLATFORM_EXPORT static void                          AddTransactionListener (IDetailingSymbolStyleTransactionListener& obj);

    DGNPLATFORM_EXPORT static void                          DropTransactionListener (IDetailingSymbolStyleTransactionListener& obj);

    DGNPLATFORM_EXPORT static void                          OnDetailingSymbolStyleTransactionEvent (DetailingSymbolStyleCP styleBefore, DetailingSymbolStyleCP styleAfter, StyleEventType eventType, StyleEventSource source);

    MSCORE_EXPORT   static void                             AddListener (DetailingSymbolStyleEvents& handler);

    MSCORE_EXPORT   static void                             DropListener (DetailingSymbolStyleEvents& handler);

    DGNPLATFORM_EXPORT   static DetailingSymbolStylePtr          GetSettings (DgnFileR file);

    DGNPLATFORM_EXPORT  static BentleyStatus                    ReplaceSettings (DetailingSymbolStylePtr style, DgnFileR file);

    DGNPLATFORM_EXPORT static bvector<DetailingSymbolStylePtr>    BuildList (DgnFileR file);

    MSCORE_EXPORT static bvector<DetailingSymbolStylePtr>           BuildList (StyleIteratorMode mode);

    MSCORE_EXPORT       static DetailingSymbolStylePtr          GetActive ();

    MSCORE_EXPORT  static BentleyStatus                    SetActive (DetailingSymbolStylePtr style);

    MSCORE_EXPORT   BentleyStatus                           UpdateFromDgnlib ();

    MSCORE_EXPORT   static DetailingSymbolStylePtr          GetByName (WCharCP name, StyleIteratorMode mode);

    //MSCORE_EXPORT   static BentleyStatus                    UpdateDgnlib ();

    MSCORE_EXPORT   static BentleyStatus                    UpdateStylesFromDgnlib ();

    MSCORE_EXPORT   static StatusInt                        EnsureActiveStyle (bool getFromDgnlibIfNotPresent);

    MSCORE_EXPORT   static StatusInt                        EnsureActiveStyleInFile (DgnFileP file, bool getFromDgnlibIfNotPresent);
};

struct DetailingSymbolStyleCollection;
/*=================================================================================**/
struct DetailingSymbolStyleIterator : std::iterator<std::forward_iterator_tag, DetailingSymbolStyleP const>
{

public:
    DGNPLATFORM_EXPORT DetailingSymbolStyleIterator ();
    
    DGNPLATFORM_EXPORT DetailingSymbolStyleIterator&     operator ++();
    
    DGNPLATFORM_EXPORT DetailingSymbolStyleP const& operator *() const;
    
    DGNPLATFORM_EXPORT bool            operator == (DetailingSymbolStyleIterator const &) const;
    
    DGNPLATFORM_EXPORT bool            operator != (DetailingSymbolStyleIterator const &) const;

    DGNPLATFORM_EXPORT bool             IsValid () const;
};

/*=================================================================================**/
struct DetailingSymbolStyleCollection
{
public:
    
    DGNPLATFORM_EXPORT DetailingSymbolStyleCollection (DgnFileR file);
    
    typedef DetailingSymbolStyleIterator const_iterator;
    typedef const_iterator iterator;    

    DGNPLATFORM_EXPORT DetailingSymbolStyleIterator begin () const;

    DGNPLATFORM_EXPORT DetailingSymbolStyleIterator end () const;
};


END_BENTLEY_DGNPLATFORM_NAMESPACE