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

#if defined (__PUBLISH_BUILD__)
#define PUBLISHLIB_EXPORT __declspec(dllexport)
#else
#define PUBLISHLIB_EXPORT __declspec(dllimport)
#endif



#define BEGIN_BENTLEY_DGNIMODEL_NAMESPACE      namespace Bentley { namespace DgnIModel {
#define END_BENTLEY_DGNIMODEL_NAMESPACE        }}

BEGIN_BENTLEY_DGNIMODEL_NAMESPACE
USING_NAMESPACE_BENTLEY_DGNPLATFORM

/*=================================================================================**/
struct PackageOptions;
typedef PackageOptions const& PackageOptionsCR;
typedef PackageOptions & PackageOptionsR;

struct PublishOptions;
typedef PublishOptions const& PublishOptionsCR;
typedef PublishOptions & PublishOptionsR;

struct DgnDbOptions;
typedef DgnDbOptions const& DgnDbOptionsCR;
typedef DgnDbOptions & DgnDbOptionsR;

struct PublishViewOptions;
typedef PublishViewOptions const& PublishViewOptionsCR;
typedef PublishViewOptions & PublishViewOptionsR;

typedef bvector<WString>    EmbedDocumentList;
typedef EmbedDocumentList  &EmbedDocumentListR;

/*=================================================================================**/
enum LicenseType
    {
    LICENSE_Everyone                =  0,       
    LICENSE_Password                =  1,       
    LICENSE_Certificate             =  2,       
    LICENSE_None_ProtectionDisabled = 99,       
    };

/*=================================================================================**/
enum IModelStatus
    {
    IMODEL_Success = 0,                         
    IMODEL_ImporterNotFound = 1,                
    IMODEL_ImporterNotSupported = 2,            
    IMODEL_PackageFileNotFound = 3,             
    IMODEL_MobileIModelFileExtension = 4,       
    IMODEL_AccessViolation = 5,                 
    IMODEL_Error = 99,                          
    };
/*=================================================================================**/
struct PackageOptions
    {
private:
    virtual void MakeClassAbstract() = 0;
public:
public:
    PUBLISHLIB_EXPORT bool          GetRemoveIModelsAfterPackaging() const;

    PUBLISHLIB_EXPORT void          SetRemoveIModelsAfterPackaging ( bool option );

    PUBLISHLIB_EXPORT StatusInt     SetLicenseType (LicenseType licenseType);

    PUBLISHLIB_EXPORT LicenseType   GetLicenseType () const;

    PUBLISHLIB_EXPORT void          SetCanExport (bool canExport);

    PUBLISHLIB_EXPORT bool          GetCanExport () const;

    PUBLISHLIB_EXPORT void          SetCanPrint (bool canPrint);

    PUBLISHLIB_EXPORT bool          GetCanPrint () const;

    PUBLISHLIB_EXPORT StatusInt     SetPassword (WCharCP password);

    PUBLISHLIB_EXPORT WCharCP      GetPassword () const;

    PUBLISHLIB_EXPORT StatusInt     SetCertificate (WCharCP certificateName, WCharCP recipient);

    PUBLISHLIB_EXPORT WCharCP     GetCertificateID () const;

    PUBLISHLIB_EXPORT WCharCP     GetCertificateRecipient () const;

    PUBLISHLIB_EXPORT StatusInt   SetExpiration (WCharCP expiration);

    PUBLISHLIB_EXPORT WCharCP     GetExpiration () const;

    PUBLISHLIB_EXPORT StatusInt   SetEmbedFonts (bool value);

    PUBLISHLIB_EXPORT bool        GetEmbedFonts () const;

    };

/*=================================================================================**/
struct PublishViewOptions
    {
private:
    virtual void MakeClassAbstract() = 0;
public:
public:
    PublishViewOptions();

public:
    PUBLISHLIB_EXPORT bool          GetPublishActiveViewOnly() const;

    PUBLISHLIB_EXPORT WCharCP     GetPublishSavedViewName() const;

    PUBLISHLIB_EXPORT DgnModelRefP  GetActiveDgnModelRefP() const;

    PUBLISHLIB_EXPORT int          GetPublishViewNumber() const;

    PUBLISHLIB_EXPORT ViewportP    GetViewPort(int viewNumber) const;

    PUBLISHLIB_EXPORT StatusInt     SetPublishActiveView(int viewNumber, ViewportP viewPortToPublish);

    PUBLISHLIB_EXPORT StatusInt     SetPublishSavedView(WCharCP savedViewName, DgnModelRefP activeDgnModelRefPToPublish);
    };

/*=================================================================================**/
struct PublishOptions
    {
private:
    virtual void MakeClassAbstract() = 0;
public:
public:

    PUBLISHLIB_EXPORT StatusInt     SetPublishDesignLinks  (bool value);

    PUBLISHLIB_EXPORT bool          GetPublishDesignLinks  () const;

    PUBLISHLIB_EXPORT StatusInt     SetRepublishAllFiles   (bool value);

    PUBLISHLIB_EXPORT bool          GetRepublishAllFiles   () const;

    PUBLISHLIB_EXPORT StatusInt     SetPublishReferences   (bool value);

    PUBLISHLIB_EXPORT bool          GetPublishReferences   () const;

    PUBLISHLIB_EXPORT StatusInt     SetCacheVisibleEdges   (bool value);

    PUBLISHLIB_EXPORT bool          GetCacheVisibleEdges   () const;

    PUBLISHLIB_EXPORT StatusInt     SetRetainOutOfDateVECaches   (bool value);

    PUBLISHLIB_EXPORT bool          GetRetainOutOfDateVECaches   () const;

    PUBLISHLIB_EXPORT StatusInt     SetPublishDisplayedAttachmentsOnly  (bool value);

    PUBLISHLIB_EXPORT bool          GetPublishDisplayedAttachmentsOnly   () const;

    PUBLISHLIB_EXPORT PublishViewOptionsR       GetPublishViewOptionsR();
    };

/*=================================================================================**/
struct DgnDbOptions
    {
private:
    virtual void MakeClassAbstract() = 0;
public:
    private:
        WString                         m_langCulture;
        WString                         m_dgnV8Password;
        WString                         m_tempFolderPath;
        bool                            m_showProgressBar;
        void*                           m_hInstance;
        //MKM:NEEDS_WORK This needs to be corrected. We should not exposing the memebt to outside world.
    public:
        PUBLISHLIB_EXPORT DgnDbOptions();
        //MKM: NEEDS_WORK
    public:
        PUBLISHLIB_EXPORT void                       SetLanguageFileCulture (WCharCP inputFileCulture);
        PUBLISHLIB_EXPORT WStringCR                  GetLanguageFileCulture() const;

        PUBLISHLIB_EXPORT void                       SetDgnV8Password(WCharCP password);
        PUBLISHLIB_EXPORT WStringCR                  GetDgnV8Password() const;

        PUBLISHLIB_EXPORT void                       SetTempFolderPath(WCharCP password);
        PUBLISHLIB_EXPORT WStringCR                  GetTempFolderPath() const;

        PUBLISHLIB_EXPORT void                       SetShowProgressBar(bool showProgressBar, void* hInstance = NULL);
        PUBLISHLIB_EXPORT bool                       GetShowProgressBar() const;

        PUBLISHLIB_EXPORT void*                      GetParentWindowHandle() const { return m_hInstance; }
    };
typedef StatusInt     ( *OverrideProvenanceSourceEvent )
    (
    WString&,                 
    WCharCP                   
    );

typedef StatusInt     ( *OverrideProvenanceTargetEvent)
    (
    WString&,                
    WCharCP                  
    );

typedef void     (*OnErrorCallbackEvent)
    (
    WCharCP                 
    );

typedef StatusInt  (*ProcessFileCallback)
(
DgnFileCR,        
DgnFilePtr&      
);
typedef StatusInt(*AddProvenanceConfigMetaDataCallback)
(
WString&
);
END_BENTLEY_DGNIMODEL_NAMESPACE