IModelPublisherOptions.h
Go to the documentation of this file.
1 /*--------------------------------------------------------------------------------------+
2 |
3 | Supplied under applicable software license agreement.
4 |
5 | Copyright (c) 2018 Bentley Systems, Incorporated. All rights reserved.
6 |
7 +---------------------------------------------------------------------------------------*/
8 #pragma once
9 
10 #if defined (__PUBLISH_BUILD__)
11 #define PUBLISHLIB_EXPORT __declspec(dllexport)
12 #else
13 #define PUBLISHLIB_EXPORT __declspec(dllimport)
14 #endif
15 
16 
17 
18 #define BEGIN_BENTLEY_DGNIMODEL_NAMESPACE namespace Bentley { namespace DgnIModel {
19 #define END_BENTLEY_DGNIMODEL_NAMESPACE }}
20 
23 
24 /*=================================================================================**/
32 typedef PackageOptions const& PackageOptionsCR;
34 
36 typedef PublishOptions const& PublishOptionsCR;
38 
39 struct DgnDbOptions;
40 typedef DgnDbOptions const& DgnDbOptionsCR;
42 
46 
47 typedef bvector<WString> EmbedDocumentList;
49 
50 /*=================================================================================**/
55  {
60  };
61 
62 /*=================================================================================**/
67  {
74  IMODEL_Error = 99,
75  };
76 /*=================================================================================**/
82  {
83 private:
84  virtual void MakeClassAbstract() = 0;
85 public:
86 public:
89  PUBLISHLIB_EXPORT bool GetRemoveIModelsAfterPackaging() const;
90 
93  PUBLISHLIB_EXPORT void SetRemoveIModelsAfterPackaging ( bool option );
94 
99  PUBLISHLIB_EXPORT StatusInt SetLicenseType (LicenseType licenseType);
100 
104  PUBLISHLIB_EXPORT LicenseType GetLicenseType () const;
105 
108  PUBLISHLIB_EXPORT void SetCanExport (bool canExport);
109 
112  PUBLISHLIB_EXPORT bool GetCanExport () const;
113 
116  PUBLISHLIB_EXPORT void SetCanPrint (bool canPrint);
117 
120  PUBLISHLIB_EXPORT bool GetCanPrint () const;
121 
125  PUBLISHLIB_EXPORT StatusInt SetPassword (WCharCP password);
126 
129  PUBLISHLIB_EXPORT WCharCP GetPassword () const;
130 
135  PUBLISHLIB_EXPORT StatusInt SetCertificate (WCharCP certificateName, WCharCP recipient);
136 
139  PUBLISHLIB_EXPORT WCharCP GetCertificateID () const;
140 
143  PUBLISHLIB_EXPORT WCharCP GetCertificateRecipient () const;
144 
148  PUBLISHLIB_EXPORT StatusInt SetExpiration (WCharCP expiration);
149 
152  PUBLISHLIB_EXPORT WCharCP GetExpiration () const;
153 
156  PUBLISHLIB_EXPORT StatusInt SetEmbedFonts (bool value);
157 
160  PUBLISHLIB_EXPORT bool GetEmbedFonts () const;
161 
162  };
163 
164 /*=================================================================================**/
170  {
171 private:
172  virtual void MakeClassAbstract() = 0;
173 public:
174 public:
176 
177 public:
180  PUBLISHLIB_EXPORT bool GetPublishActiveViewOnly() const;
181 
184  PUBLISHLIB_EXPORT WCharCP GetPublishSavedViewName() const;
185 
188  PUBLISHLIB_EXPORT DgnModelRefP GetActiveDgnModelRefP() const;
189 
192  PUBLISHLIB_EXPORT int GetPublishViewNumber() const;
193 
196  PUBLISHLIB_EXPORT ViewportP GetViewPort(int viewNumber) const;
197 
202  PUBLISHLIB_EXPORT StatusInt SetPublishActiveView(int viewNumber, ViewportP viewPortToPublish);
203 
208  PUBLISHLIB_EXPORT StatusInt SetPublishSavedView(WCharCP savedViewName, DgnModelRefP activeDgnModelRefPToPublish);
209  };
210 
211 /*=================================================================================**/
217  {
218 private:
219  virtual void MakeClassAbstract() = 0;
220 public:
221 public:
222 
226  PUBLISHLIB_EXPORT StatusInt SetPublishDesignLinks (bool value);
227 
230  PUBLISHLIB_EXPORT bool GetPublishDesignLinks () const;
231 
235  PUBLISHLIB_EXPORT StatusInt SetRepublishAllFiles (bool value);
236 
239  PUBLISHLIB_EXPORT bool GetRepublishAllFiles () const;
240 
244  PUBLISHLIB_EXPORT StatusInt SetPublishReferences (bool value);
245 
248  PUBLISHLIB_EXPORT bool GetPublishReferences () const;
249 
253  PUBLISHLIB_EXPORT StatusInt SetCacheVisibleEdges (bool value);
254 
257  PUBLISHLIB_EXPORT bool GetCacheVisibleEdges () const;
258 
262  PUBLISHLIB_EXPORT StatusInt SetRetainOutOfDateVECaches (bool value);
263 
266  PUBLISHLIB_EXPORT bool GetRetainOutOfDateVECaches () const;
267 
271  PUBLISHLIB_EXPORT StatusInt SetPublishDisplayedAttachmentsOnly (bool value);
272 
275  PUBLISHLIB_EXPORT bool GetPublishDisplayedAttachmentsOnly () const;
276 
279  PUBLISHLIB_EXPORT PublishViewOptionsR GetPublishViewOptionsR();
280  };
281 
282 /*=================================================================================**/
288  {
289 private:
290  virtual void MakeClassAbstract() = 0;
291 public:
292  private:
293  WString m_langCulture;
294  WString m_dgnV8Password;
295  WString m_tempFolderPath;
296  bool m_showProgressBar;
297  void* m_hInstance;
298  //MKM:NEEDS_WORK This needs to be corrected. We should not exposing the memebt to outside world.
299  public:
301  //MKM: NEEDS_WORK
302  public:
303  PUBLISHLIB_EXPORT void SetLanguageFileCulture (WCharCP inputFileCulture);
304  PUBLISHLIB_EXPORT WStringCR GetLanguageFileCulture() const;
305 
306  PUBLISHLIB_EXPORT void SetDgnV8Password(WCharCP password);
307  PUBLISHLIB_EXPORT WStringCR GetDgnV8Password() const;
308 
309  PUBLISHLIB_EXPORT void SetTempFolderPath(WCharCP password);
310  PUBLISHLIB_EXPORT WStringCR GetTempFolderPath() const;
311 
312  PUBLISHLIB_EXPORT void SetShowProgressBar(bool showProgressBar, void* hInstance = NULL);
313  PUBLISHLIB_EXPORT bool GetShowProgressBar() const;
314 
315  PUBLISHLIB_EXPORT void* GetParentWindowHandle() const { return m_hInstance; }
316  };
319  (
320  WString&,
321  WCharCP
322  );
323 
326  (
327  WString&,
328  WCharCP
329  );
330 
332 typedef void (*OnErrorCallbackEvent)
333  (
334  WCharCP
335  );
336 
339 (
340 DgnFileCR,
341 DgnFilePtr&
342 );
344 (
345 WString&
346 );
IModelStatus
Different possible error types that can be used returned by DgnDb publishing.
Definition: IModelPublisherOptions.h:66
An author grants access to a file to everyone by setting this license type in PackageOptions. Generally, it makes sense to create an Everyone license that only grants limited rights. For example, creating an everyone license that allows anyone to view the file.
Definition: IModelPublisherOptions.h:56
PackageOptions & PackageOptionsR
Definition: IModelPublisherOptions.h:33
The source package file specified does not exist.
Definition: IModelPublisherOptions.h:71
#define USING_NAMESPACE_BENTLEY_DGNPLATFORM
Definition: DgnPlatform.h:27
LicenseType
Different possible License Types that can be used in PackageOptions.
Definition: IModelPublisherOptions.h:54
#define END_BENTLEY_DGNIMODEL_NAMESPACE
Definition: IModelPublisherOptions.h:19
#define BEGIN_BENTLEY_DGNIMODEL_NAMESPACE
Definition: IModelPublisherOptions.h:18
EmbedDocumentList & EmbedDocumentListR
Definition: IModelPublisherOptions.h:48
StatusInt(* ProcessFileCallback)(DgnFileCR, DgnFilePtr &)
A callback for processing a file and substituting with another one.
Definition: IModelPublisherOptions.h:339
StatusInt(* OverrideProvenanceSourceEvent)(WString &, WCharCP)
A callback for overriding provenance source.
Definition: IModelPublisherOptions.h:319
struct Bentley::WString const & WStringCR
Definition: Bentley.h:239
PackageOptions const & PackageOptionsCR
Definition: IModelPublisherOptions.h:31
Specifies the publishing view options to apply while creating the published i-models.
Definition: IModelPublisherOptions.h:169
The DgnDb Importer cannot be found.
Definition: IModelPublisherOptions.h:69
wchar_t const * WCharCP
Definition: Bentley.h:224
DgnDb i-model successfully published.
Definition: IModelPublisherOptions.h:68
DgnDbOptions const & DgnDbOptionsCR
Definition: IModelPublisherOptions.h:39
StatusInt(* OverrideProvenanceTargetEvent)(WString &, WCharCP)
A callback for overriding provenance target.
Definition: IModelPublisherOptions.h:326
#define NULL
Definition: Bentley.h:157
An author can select a digital certificate from their personal certificate store or identify a signed...
Definition: IModelPublisherOptions.h:58
Specifies the packaging and protection options to apply to a packaged i-model.
Definition: IModelPublisherOptions.h:81
struct DgnPlatform::DgnFile const & DgnFileCR
Definition: DgnPlatform.h:206
Specifies the DgnDb options to apply while creating the published i-models.
Definition: IModelPublisherOptions.h:287
A DgnModelRef provides access to a model in a Bentley::DgnPlatform::DgnFile.
Definition: DgnModelRef.h:172
The DgnDb Importer is not supported on the current OS.
Definition: IModelPublisherOptions.h:70
Unable to create DgnDb i-model. The destination filename should be accessible. Check logfile for more...
Definition: IModelPublisherOptions.h:74
An author grants access to a file by creating a password.
Definition: IModelPublisherOptions.h:57
PublishOptions & PublishOptionsR
Definition: IModelPublisherOptions.h:37
PublishViewOptions & PublishViewOptionsR
Definition: IModelPublisherOptions.h:45
bvector< WString > EmbedDocumentList
Definition: IModelPublisherOptions.h:47
DgnDbOptions & DgnDbOptionsR
Definition: IModelPublisherOptions.h:41
int StatusInt
Definition: Bentley.h:222
No Protection.
Definition: IModelPublisherOptions.h:59
#define PUBLISHLIB_EXPORT
Definition: IModelPublisherOptions.h:13
PublishViewOptions const & PublishViewOptionsCR
Definition: IModelPublisherOptions.h:43
StatusInt(* AddProvenanceConfigMetaDataCallback)(WString &)
Definition: IModelPublisherOptions.h:344
void * GetParentWindowHandle() const
Definition: IModelPublisherOptions.h:315
PublishOptions const & PublishOptionsCR
Definition: IModelPublisherOptions.h:35
The file is read only or in use.
Definition: IModelPublisherOptions.h:73
The filename specified for the i-model does not have the .imodel extension.
Definition: IModelPublisherOptions.h:72
void(* OnErrorCallbackEvent)(WCharCP)
A callback for reporting errors during a publish or package operation.
Definition: IModelPublisherOptions.h:333
Specifies the publishing options to apply while creating the published i-models.
Definition: IModelPublisherOptions.h:216
A string class that has many of the same capabilities as std::string, plus additional functions such ...
Definition: WString.h:51
Definition: DgnViewport.h:186

Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.