INamedViewElementHandler.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/DgnPlatform.h>

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE

/*=================================================================================**/
struct     INamedViewElementHandler
{
protected:

DGNPLATFORM_EXPORT virtual NamedViewPtr                _CreateView (DgnFileR destinationFile) const = 0;

DGNPLATFORM_EXPORT virtual NamedViewPtr                _CreateView (ElementHandleCR elemHandle) const = 0;

DGNPLATFORM_EXPORT virtual NamedViewPtr                _CreateView (ViewInfoCR viewInfo, ViewPortInfoCR viewPortInfo, DgnFileR destinationFile, WCharCP viewName) const = 0;

DGNPLATFORM_EXPORT virtual bool                        _IsExpectedRootModelType (DgnModelType modelType) const = 0;

DGNPLATFORM_EXPORT virtual bool                        _IsInternalViewType () const = 0;

    // Call this method to query a translatable string that can be displayed in the UI to represent the type of named view.
DGNPLATFORM_EXPORT virtual WString                     _GetViewTypeName () const = 0;

    // Call this method to query a nontranslatable string that can be stored in dgn file.
DGNPLATFORM_EXPORT virtual WString                     _GetViewTypeNameForPersistence() const = 0;

public:
DGNPLATFORM_EXPORT  NamedViewPtr    CreateView (DgnFileR destinationFile);

DGNPLATFORM_EXPORT  NamedViewPtr    CreateView (ElementHandleCR elemHandle);

DGNPLATFORM_EXPORT  NamedViewPtr    CreateView (ViewInfoCR viewInfo, ViewPortInfoCR viewPortInfo, DgnFileR destinationFile, WCharCP viewName);

    // Call this method to query a translatable string that can be displayed in the UI to represent the type of named view.
DGNPLATFORM_EXPORT WString  GetViewTypeName () const;

    // Call this method to query a nontranslatable string that can be stored in dgn file.
DGNPLATFORM_EXPORT WString  GetViewTypeNameForPersistence () const;


}; // INamedViewElementHandler

END_BENTLEY_DGNPLATFORM_NAMESPACE