DgnTextStyle.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
#include "DgnTextStyleProperties.r.h"
#include "ElementHandle.h"
#include "DgnFile.h"


#include <Bentley/RefCounted.h>
#include "DgnFontManager.h"

DGNPLATFORM_TYPEDEFS (TextStylePropertyMask)
DGNPLATFORM_TYPEDEFS (DgnTextStyleAppData)

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE
typedef RefCountedPtr<DgnTextStyle>             DgnTextStylePtr;
typedef RefCountedPtr<TextStylePropertyMask>    TextStylePropertyMaskPtr;
/*=================================================================================**/
struct     ITextStyleTransactionListener
{
    virtual void   _OnTextStyleChange (DgnTextStyleCP before, DgnTextStyleCP after, StyleEventType type, StyleEventSource source, void* sender) = 0;
};

/*=================================================================================**/
struct     TextStyleEvents : ITextStyleTransactionListener
{
};

/*=================================================================================**/
CLRPUBLIC struct TextStylePropertyMask: public RefCountedBase
{
private:
    virtual void MakeClassAbstract() = 0;
public:
public:    
    DGNPLATFORM_EXPORT TextStylePropertyMask (TextStylePropertyMaskCR mask);

    DGNPLATFORM_EXPORT static TextStylePropertyMaskPtr    CreatePropMask ();

    DGNPLATFORM_EXPORT bool GetPropertyFlag (TextStyleProperty flag) const;

    DGNPLATFORM_EXPORT bool SetPropertyFlag (TextStyleProperty flag, bool value);
    
    DGNPLATFORM_EXPORT bool AnyBitSet () const;

    DGNPLATFORM_EXPORT void ResetFlags ();

    
}; // TextStylePropertyMask

/*=================================================================================**/
CLRPUBLIC struct DgnTextStyle : public RefCountedBase
{
private:
    virtual void MakeClassAbstract() = 0;
public:
public:
    typedef TextStylePropertyMaskPtr PropertyMaskPtr;
    DGNPLATFORM_EXPORT WStringCR GetName () const;

    DGNPLATFORM_EXPORT ElementId GetID () const;

    DGNPLATFORM_EXPORT DgnFileR GetFile () const;
    
    DGNPLATFORM_EXPORT TextStylePropertyMaskPtr Compare (DgnTextStyleCR style) const;

    DGNPLATFORM_EXPORT BentleyStatus    GetProperty (TextStyleProperty type, bool& value) const;

    DGNPLATFORM_EXPORT BentleyStatus    GetProperty (TextStyleProperty type, UInt32& value) const;

    DGNPLATFORM_EXPORT BentleyStatus    GetProperty (TextStyleProperty type, Int32& value) const;

    DGNPLATFORM_EXPORT BentleyStatus    GetProperty (TextStyleProperty type, double& value) const;

    DGNPLATFORM_EXPORT BentleyStatus    GetProperty (TextStyleProperty type, DPoint2d& value) const;

    DGNPLATFORM_EXPORT BentleyStatus    GetProperty (TextStyleProperty type, DgnFontCP& value) const;

    DGNPLATFORM_EXPORT BentleyStatus    SetProperty (TextStyleProperty type, bool value);

    DGNPLATFORM_EXPORT BentleyStatus    SetProperty (TextStyleProperty type, UInt32 value);

    DGNPLATFORM_EXPORT BentleyStatus    SetProperty (TextStyleProperty type, Int32 value);

    DGNPLATFORM_EXPORT BentleyStatus    SetProperty (TextStyleProperty type, double value);

    DGNPLATFORM_EXPORT BentleyStatus    SetProperty (TextStyleProperty type, DPoint2dCR value);

    DGNPLATFORM_EXPORT BentleyStatus    SetProperty (TextStyleProperty type, DgnFontCP value);

    DGNPLATFORM_EXPORT BentleyStatus    SetName (WCharCP name);

    DGNPLATFORM_EXPORT void             SetID (ElementId id);
    
    DGNPLATFORM_EXPORT static DgnTextStylePtr GetByID (ElementId styleID, DgnFileR file);

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

    DGNPLATFORM_EXPORT static bool            ExistsByName (WCharCP name, DgnFileR file);

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

    DGNPLATFORM_EXPORT BentleyStatus Add (DgnFileP file = NULL);

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

    DGNPLATFORM_EXPORT bool HasDependants () const;

    DGNPLATFORM_EXPORT static BentleyStatus RemapDependents (WCharCP destStyle, WCharCP sourceStyle, DgnFileR file);

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

    DGNPLATFORM_EXPORT  DgnTextStylePtr Copy () const;

    DGNPLATFORM_EXPORT void CopyValues (DgnTextStyleCR style);

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

    DGNPLATFORM_EXPORT static DgnTextStylePtr GetSettings (DgnFileR file);

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

    MSCORE_EXPORT static DgnTextStylePtr GetActive();

    MSCORE_EXPORT static StatusInt SetActive (DgnTextStyleCR style);

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

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

    MSCORE_EXPORT static void       AddListener (TextStyleEvents& listener);

    MSCORE_EXPORT static void       DropListener (TextStyleEvents& listener);

}; // DgnTextStyle

struct TextStyleCollection;
/*=================================================================================**/
struct TextStyleIterator : std::iterator<std::forward_iterator_tag, DgnTextStyleP const>
    {

    private:
    ChildElemIter           m_elemIter;
    mutable DgnTextStylePtr m_current;
    
    DGNPLATFORM_EXPORT TextStyleIterator (DgnFileP file);
    bool IsValid (){return m_elemIter.IsValid();}
    public:
    
    DGNPLATFORM_EXPORT TextStyleIterator&    operator ++ ();
    
    DGNPLATFORM_EXPORT DgnTextStyleP const& operator *() const;
    
    DGNPLATFORM_EXPORT bool                 operator == (TextStyleIterator const &) const;
    
    DGNPLATFORM_EXPORT bool                 operator != (TextStyleIterator const &) const;
    };

/*=================================================================================**/
struct TextStyleCollection
    {
    RefCountedPtr<DgnFile> m_dgnFile;

    public:
    
    DGNPLATFORM_EXPORT TextStyleCollection (DgnFileR file);
    
    typedef TextStyleIterator const_iterator;
    typedef const_iterator iterator;    

    DGNPLATFORM_EXPORT TextStyleIterator begin () const;

    DGNPLATFORM_EXPORT TextStyleIterator end () const;
    };



END_BENTLEY_DGNPLATFORM_NAMESPACE