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

#pragma once

DGNPLATFORM_TYPEDEFS (DgnTextSnippetPropertyMask);


BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE
struct DgnTextSnippetCategory;
struct DgnTextSnippetCategoryCollection;
typedef RefCountedPtr<DgnTextSnippet>               DgnTextSnippetPtr;
typedef RefCountedPtr<DgnTextSnippetPropertyMask>   DgnTextSnippetPropertyMaskPtr;
typedef RefCountedPtr<DgnTextSnippetCategory>       DgnTextSnippetCategoryPtr;
typedef RefCountedPtr<DgnTextSnippetCategoryCollection> DgnTextSnippetCategoryCollectionPtr;

/*---------------------------------------------------------------------------------**/

CLRPUBLIC struct DgnTextSnippet: public RefCountedBase
    {
    enum DgnTextSnippetProperty
        {
        SnippetName         = 1,
        SnippetText         = 2,
        FromActiveFile      = 3,
        SnippetCategory     = 4,
        SnippetDisplayName  = 5,
        PROPERTY_COUNT,
        };
    
    typedef DgnTextSnippetPropertyMaskPtr PropertyMaskPtr;

    public:
        DGNPLATFORM_EXPORT DgnFileR GetFile() const;

        DGNPLATFORM_EXPORT WString GetName() const;

        DGNPLATFORM_EXPORT ElementId GetID () const;

        DGNPLATFORM_EXPORT BentleyStatus SetName(WCharCP name);

        DGNPLATFORM_EXPORT WString GetDisplayName() const;

        DGNPLATFORM_EXPORT BentleyStatus SetDisplayName (WCharCP name);

        DGNPLATFORM_EXPORT TextBlockCP GetSnippetText() const;
        
        DGNPLATFORM_EXPORT BentleyStatus SetSnippetText(TextBlockCR text);

        DGNPLATFORM_EXPORT DgnTextSnippetCategoryCP GetCategory() const;

        DGNPLATFORM_EXPORT BentleyStatus SetCategory (DgnTextSnippetCategoryCP category);

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

        DGNPLATFORM_EXPORT BentleyStatus Add (DgnFileP file = NULL);

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

        DGNPLATFORM_EXPORT BentleyStatus Replace (WCharCP oldName = NULL, DgnFileP file = NULL);

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

        DGNPLATFORM_EXPORT static DgnTextSnippetPtr GetByID (ElementId id, DgnFileR file);

        DGNPLATFORM_EXPORT void CopyValues (DgnTextSnippetCR snippet);

        DGNPLATFORM_EXPORT DgnTextSnippetPropertyMaskPtr Compare (DgnTextSnippetCR snippet) const;

        //Test whether this snippet is actually saved in the file.
        DGNPLATFORM_EXPORT bool IsPersisted () const;
    
        //Upgrade schema and instance.
        DGNPLATFORM_EXPORT static void UpgradeSchemaAndInstance(DgnFileP file);
    };



/*=================================================================================**/
CLRPUBLIC struct DgnTextSnippetPropertyMask: public RefCountedBase
{
private:
    virtual void MakeClassAbstract() = 0;
public:
public:    
    
    DGNPLATFORM_EXPORT static DgnTextSnippetPropertyMaskPtr    CreatePropMask ();

    DGNPLATFORM_EXPORT bool GetPropertyFlag (DgnTextSnippet::DgnTextSnippetProperty flag) const;

    DGNPLATFORM_EXPORT void SetPropertyFlag (DgnTextSnippet::DgnTextSnippetProperty flag, bool value);
    
    DGNPLATFORM_EXPORT bool AnyBitSet () const;

    DGNPLATFORM_EXPORT void ResetFlags ();

    
}; // DgnTextSnippetPropertyMask
   
struct DgnTextSnippetCollection;
/*=================================================================================**/
struct DgnTextSnippetIterator : std::iterator<std::forward_iterator_tag, DgnTextSnippetP const>
    {

    private:
    friend struct DgnTextSnippetCollection;
    PersistentElementRefList::const_iterator    m_iter;
    mutable DgnTextSnippetPtr                   m_current;
    DgnTextSnippetCollection const*             m_parentCollection;
    void    MoveToNextLabelSnippetElement();

    DgnTextSnippetIterator (DgnTextSnippetCollection const* parentCollection, bool begin);

    public:
    
    DGNPLATFORM_EXPORT DgnTextSnippetIterator&    operator ++ ();
    
    DGNPLATFORM_EXPORT DgnTextSnippetP const& operator *() const;
    
    DGNPLATFORM_EXPORT bool             operator == (DgnTextSnippetIterator const &) const;
    
    DGNPLATFORM_EXPORT bool                 operator != (DgnTextSnippetIterator const &) const;
    };

/*=================================================================================**/
struct DgnTextSnippetCollection
    {
    friend struct DgnTextSnippetIterator;
    RefCountedPtr<DgnFile>      m_dgnFile;
    PersistentElementRefList*   GetElementList () const;
    public:
    DGNPLATFORM_EXPORT DgnTextSnippetCollection (DgnFileR file);
    
    typedef DgnTextSnippetIterator const_iterator;
    typedef const_iterator iterator;    

    DGNPLATFORM_EXPORT DgnTextSnippetIterator begin () const;

    DGNPLATFORM_EXPORT DgnTextSnippetIterator end () const;
    };

/*=================================================================================**/
CLRPUBLIC struct DgnTextSnippetCategory : public RefCountedBase
    {
public:
    DGNPLATFORM_EXPORT DgnFileR GetFile() const;

    DGNPLATFORM_EXPORT BentleyStatus SetName (WStringCR name);
    
    DGNPLATFORM_EXPORT WString GetName() const;

    DGNPLATFORM_EXPORT DgnTextSnippetCategoryPtr GetParentCategory() const;

    DGNPLATFORM_EXPORT bool IsSubCategoryExist (DgnTextSnippetCategoryPtr subCategory);

    DGNPLATFORM_EXPORT BentleyStatus AddSubCategory (DgnTextSnippetCategoryPtr subCategory);

    DGNPLATFORM_EXPORT bvector<DgnTextSnippetCategoryPtr>& GetSubCategories ();
    
    DGNPLATFORM_EXPORT BentleyStatus RemoveSubCategory (WStringCR name);

    DGNPLATFORM_EXPORT BentleyStatus    Add (DgnFileP fileIn = NULL);

    DGNPLATFORM_EXPORT BentleyStatus    Replace (DgnFileP fileIn = NULL);

    DGNPLATFORM_EXPORT BentleyStatus    Delete (DgnFileP fileIn = NULL);


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

    DGNPLATFORM_EXPORT static BentleyStatus     BuildCategoryTreeFromFile (bvector<DgnTextSnippetCategoryPtr>& categories, DgnFileR file);

    DGNPLATFORM_EXPORT static BentleyStatus     GetTextFavorites (bvector<DgnTextSnippetPtr>& snippets, DgnTextSnippetCategoryP category, DgnFileR file);

    DGNPLATFORM_EXPORT ECN::IECInstancePtr GetECInstance ();

    DGNPLATFORM_EXPORT bool IsSame (DgnTextSnippetCategoryCP);

    };


END_BENTLEY_DGNPLATFORM_NAMESPACE