ITextEdit.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 <DgnPlatform/TextBlock/TextBlockAPI.h>
#include <Bentley/bvector.h>
#include <DgnPlatform\ScanCriteria.h>
#include <DgnPlatform\ElementAgenda.h>

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE

typedef RefCountedPtr<ITextPartId> ITextPartIdPtr;

typedef RefCountedPtr<ITextQueryOptions> ITextQueryOptionsPtr;

typedef RefCountedPtr<ITextEditRestrictions> ITextEditRestrictionsPtr;

typedef bvector<ITextPartIdPtr> T_ITextPartIdPtrVector;

typedef T_ITextPartIdPtrVector* T_ITextPartIdPtrVectorP;

typedef T_ITextPartIdPtrVector& T_ITextPartIdPtrVectorR;

typedef T_ITextPartIdPtrVector const * T_ITextPartIdPtrVectorCP;

typedef T_ITextPartIdPtrVector const & T_ITextPartIdPtrVectorCR;

//=======================================================================================
// This class exists so that handlers can have their own private way of describing the text within them, and guarantees whatever they hand out is reference counted.
// @bsiclass                                                     Bentley Systems
//=======================================================================================
CLRPUBLIC struct ITextPartId : public RefCountedBase
    {
private:
    virtual void MakeClassAbstract() = 0;
public:

    }; // ITextPartId

//=======================================================================================
//  @remark Required library : DgnPlatform<ApiNumber>.lib  i.e. DgnPlatform5.lib
// @bsiclass                                                     Bentley Systems
//=======================================================================================
struct ITextQueryOptions : public RefCountedBase, public NonCopyableClass
    {
private:
    virtual void MakeClassAbstract() = 0;
public:

    public: DGNPLATFORM_EXPORT bool ShouldIncludeEmptyParts () const;
    
    public: DGNPLATFORM_EXPORT void SetShouldIncludeEmptyParts (bool);
    
    public: DGNPLATFORM_EXPORT bool ShouldRequireFieldSupport () const;
    
    public: DGNPLATFORM_EXPORT void SetShouldRequireFieldSupport (bool);
    
    public: DGNPLATFORM_EXPORT static ITextQueryOptionsPtr CreateDefault ();

    }; // ITextQueryOptions

//=======================================================================================
// Element handlers implement this interface to expose formatted text in a read-only fashion. The handler will return one or more generic reference counted objects known as ITextPartId; these have no meaning to users of the API other than to feed them back into this interface. The general workflow is to query the handler for its ITextPartId(s), and then ask for a TextBlock representing a specific ITextPartId. Some element handlers implement ITextEdit instead (a sub-class of this class) to indicate that they also support text write operations. Some element handlers expose multiple pieces of text (e.g. dimenions); text elements (see ITextQuery::IsTextElement) will only ever expose a single piece of text. Regardless of whether the element returns a single ITextPartId or not, you must still ask for a ITextPartId, and provide one for all operations.
//  @remark Required library : DgnPlatform<ApiNumber>.lib  i.e. DgnPlatform5.lib
// @bsiclass                                                     Bentley Systems
//=======================================================================================
CLRPUBLIC struct EXPORT_VTABLE_ATTRIBUTE ITextQuery
    {
private:
    DECLARE_KEY_METHOD

private:
    virtual void MakeClassAbstract() = 0;
public:
    
    public: DGNPLATFORM_EXPORT bool IsTextElement (ElementHandleCR) const;
    
    public: DGNPLATFORM_EXPORT bool DoesSupportFields (ElementHandleCR) const;
    
    public: DGNPLATFORM_EXPORT ITextPartIdPtr GetTextPartId (ElementHandleCR, HitPathCR) const;
    
    public: DGNPLATFORM_EXPORT void GetTextPartIds (ElementHandleCR, ITextQueryOptionsCR, T_ITextPartIdPtrVectorR) const;

    public: DGNPLATFORM_EXPORT TextBlockPtr GetTextPart (ElementHandleCR, ITextPartIdCR) const;
    
    }; // ITextQuery

//=======================================================================================
//  @remark Required library : DgnPlatform<ApiNumber>.lib  i.e. DgnPlatform5.lib
// @bsiclass                                                     Bentley Systems
//=======================================================================================
CLRPUBLIC struct ITextEditRestrictions : public RefCountedBase, public NonCopyableClass
    {
private:
    virtual void MakeClassAbstract() = 0;
public:

    DGNPLATFORM_EXPORT bool GetPreventStyleNone() const;

    DGNPLATFORM_EXPORT void SetPreventStyleNone(bool);

    DGNPLATFORM_EXPORT static ITextEditRestrictionsPtr CreateDefault();

    }; // ITextEditRestrictions

//=======================================================================================
// Element handlers implement this interface to expose formatted text in a read/write fashion. This interface cannot be used to create text, but merely to replace. Additionally, this interface is not responsible for deleting elements when asked to replace with a blank TextBlock; check the return status if this a potential case for you, and manually delete. As an extension to ITextQuery, the handler will return one or more generic reference counted objects known as ITextPartId; these have no meaning to users of the API other than to feed them back into this interface. The general workflow is to query the handler for its ITextPartId(s), ask for a TextBlock representing a specific ITextPartId, modify it, and then replace that same ITextPartId with your modified TextBlock. Regardless of whether the element returns a single ITextPartId or not, you must still ask for a ITextPartId, and provide one for all operations.
// @bsiclass                                                     Bentley Systems
//=======================================================================================
CLRPUBLIC struct EXPORT_VTABLE_ATTRIBUTE ITextEdit : public ITextQuery
    {
    //=======================================================================================
    // Describes the outcome of the ITextEdit::ReplaceText method.
    //  @remark Required library : DgnPlatform<ApiNumber>.lib  i.e. DgnPlatform5.lib
    // @bsiclass                                                     Bentley Systems
    //=======================================================================================
    public: enum ReplaceStatus
        {
        ReplaceStatus_Success   = 0,    
        ReplaceStatus_Error     = 1,    
        ReplaceStatus_Delete    = 2     
        
        }; // ReplaceStatus
    
private:
    virtual void MakeClassAbstract() = 0;
public:

    public: DGNPLATFORM_EXPORT ITextEditRestrictionsPtr GetTextPartEditRestrictions(ElementHandleCR, ITextPartIdCR) const;
               
    public: DGNPLATFORM_EXPORT ReplaceStatus ReplaceTextPart (EditElementHandleR, ITextPartIdCR, TextBlockCR);

    }; // ITextEdit

END_BENTLEY_DGNPLATFORM_NAMESPACE