IPlotHook.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 #include <Mstn\IEvent.h>
11 #include <Mstn\Plot\PlotApi.h>
12 
13 BEGIN_BENTLEY_MSTNPLATFORM_NAMESPACE
14 BEGIN_PRINT_NAMESPACE
15 
48 /*=================================================================================**/
52 bsiInterface IPlotElementParam
53 {
55 virtual ElementHandleCR GetElementHandle() const = 0;
56 
58 virtual TransformCR GetTransform (PlotTagTransform) const = 0;
59 };
60 
61 typedef bvector<IPlotElementParamCP> PlotElemParamStack;
62 typedef bvector<IPlotElementParamCP> const* PlotElemParamStackCP;
63 typedef bvector<IPlotElementParamCP> const& PlotElemParamStackCR;
64 
65 /*=================================================================================**/
69 bsiInterface IBeginPrintSetParam
70 {
72 virtual void GetPrintSetName (WStringR value) const = 0;
73 
76 virtual PlotFileSpecCP GetOutputFileSpec() const = 0;
77 
79 virtual bool GetIsPreview() const = 0;
80 
82 virtual bool GetEnableDynamicPlot() const = 0;
83 
85 virtual IPlotterCP GetPlotter() const = 0;
86 
89 virtual PlotPropertyMapCR GetPrinterDriverOptions() const = 0;
90 };
91 
92 /*=================================================================================**/
96 bsiInterface IEndPrintSetParam
97 {
99 virtual bool GetIsSuccess() const = 0;
100 
102 virtual void GetPrintSetName (WStringR value) const = 0;
103 
106 virtual PlotFileSpecCP GetOutputFileSpec() const = 0;
107 
109 virtual bool GetIsPreview() const = 0;
110 
112 virtual bool GetEnableDynamicPlot() const = 0;
113 
115 virtual IPlotterCP GetPlotter() const = 0;
116 
119 virtual PlotPropertyMapCR GetPrinterDriverOptions() const = 0;
120 };
121 
122 /*=================================================================================**/
126 bsiInterface IPrePrintSetDefinitionParam
127 {
129 virtual IPlotterCP GetPlotter() const = 0;
130 
132 virtual void GetPrintDefinitionName (WStringR value) const = 0;
133 
135 virtual void GetPrintDefinitionFullName (WStringR value) const = 0;
136 
138 virtual void GetPrintDefinitionSourceFspec (PlotFileSpecR value) const = 0;
139 
141 virtual bool GetIsPreview() const = 0;
142 
144 virtual void GetOutputFileName (WStringR value) const = 0;
145 
147 virtual void SetOutputFileName (WCharCP value) = 0;
148 };
149 
150 /*=================================================================================**/
154 bsiInterface IPrePrintDefinitionParam
155 {
157 virtual void GetPrintDefinitionName (WStringR value) const = 0;
158 
160 virtual void GetSourceFileName (WStringR value) const = 0;
161 
163 virtual bool GetIsPreview() const = 0;
164 
166 virtual bool GetIsPartOfPrintSet() const = 0;
167 
169 virtual bool GetIsWorker() const = 0;
170 };
171 
172 /*=================================================================================**/
176 bsiInterface IPlotPrePenChartParam
177 {
179 virtual IPrintEngineP GetPrintEngine() = 0;
180 };
181 
182 /*=================================================================================**/
186 bsiInterface IPlotPreElementScanParam
187 {
189 virtual IPrintEngineP GetPrintEngine() = 0;
190 
193 virtual bool IsFirstElementScan() const = 0;
194 };
195 
196 /*=================================================================================**/
200 bsiInterface IPlotPostElementScanParam
201 {
203 virtual IPrintEngineP GetPrintEngine() = 0;
204 
207 virtual bool IsFirstElementScan() const = 0;
208 };
209 
210 /*=================================================================================**/
214 bsiInterface IPlotBeginElementParam
215 {
217 virtual ElementHandleCP GetElemHandleCP() const = 0;
218 
220 virtual MSElementDescrCP GetElementDescrCP() const = 0;
221 
223 virtual PlotElemParamStackCR GetElementStack() const = 0;
224 
228 virtual ElementHandleCP GetOriginalElemHandleCP() const = 0;
229 
233 virtual ElementHandleCP GetReplacementElemHandleCP() const = 0;
234 
236 virtual bool IsElementIgnored() const = 0;
237 
239 virtual void IgnoreElement() = 0;
240 
242 virtual MSElementDescrCP ReplaceElement (MSElementDescrCP edP) = 0;
243 
245 virtual void ReplaceTextString (WCharCP textString) = 0;
246 
248 virtual void ReplaceTextFont (UInt32 fontNum) = 0;
249 
252 virtual void SetSortOrder (int sortOrder) = 0;
253 
256 virtual void SetPostStrokeLineStyleIndex (int lineStyleIndex) = 0;
257 
259 virtual void SetIsTextBoundaryColorValid (bool value) = 0;
260 
262 virtual void SetTextBoundaryColor (UInt32 color) = 0;
263 };
264 
265 /*=================================================================================**/
269 bsiInterface IPlotEndElementParam
270 {
273 virtual ElementHandleCP GetElemHandleCP() const = 0;
274 
277 virtual MSElementDescrCP GetElementDescrCP() const = 0;
278 
280 virtual PlotElemParamStackCR GetElementStack() const = 0;
281 };
282 
283 /*=================================================================================**/
287 bsiInterface IPlotPreElementOutputParam
288 {
290 virtual ElementHandleCP GetElemHandleCP() const = 0;
291 
293 virtual MSElementDescrCP GetElementDescrCP() const = 0;
294 
296 virtual PlotElemParamStackCR GetElementStack() const = 0;
297 };
298 
299 /*=================================================================================**/
303 bsiInterface IPlotPostElementOutputParam
304 {
306 virtual ElementHandleCP GetElemHandleCP() const = 0;
307 
309 virtual MSElementDescrCP GetElementDescrCP() const = 0;
310 
312 virtual PlotElemParamStackCR GetElementStack() const = 0;
313 };
314 
315 /*=================================================================================**/
319 bsiInterface IPlotResymbolizeParam
320 {
322 virtual ElementHandleCP GetElemHandleCP() const = 0;
323 
325 virtual MSElementDescrCP GetElementDescrCP() const = 0;
326 
330 virtual ElementHandleCP GetBeginElemHandleCP() const = 0;
331 
333 virtual PlotElemParamStackCR GetElementStack() const = 0;
334 
336 virtual IPlotElemDisplayParamsP DisplayParams() = 0;
337 };
338 
339 /*=================================================================================**/
343 bsiInterface IPlotGetColorTableParam
344 {
346 virtual DgnModelRefP GetModelRef() const = 0;
347 
350 virtual byte* ColorTable() = 0;
351 
354 virtual BitMaskP EligibleInvertWhiteToBlackColors() = 0;
355 
357 virtual bool GetApplyRefColorAdjustment() const = 0;
358 
360 virtual void SetApplyRefColorAdjustment (bool applyRefColorAdjustment) = 0;
361 
363 virtual bool GetUseBackgroundColorFromView() const = 0;
364 
366 virtual void SetUseBackgroundColorFromView (bool useBackgroundColorFromView) = 0;
367 };
368 
369 /*=================================================================================**/
373 bsiInterface IPlotPreModelParam
374 {
376 virtual DgnModelRefP GetModelRef() const = 0;
377 
379 virtual void SetIgnoreModel (bool ignoreModel) = 0;
380 
382 virtual bool GetIsTransientUpdate() const = 0;
383 };
384 
385 /*=================================================================================**/
389 bsiInterface IPreDynamicViewClipParam
390 {
392 virtual DgnModelRefP GetModelRef() const = 0;
393 
395 virtual void SetIgnoreClip (bool ignoreClip) = 0;
396 };
397 
398 /*=================================================================================**/
402 bsiInterface IPrintDefCollectStateParam
403 {
405 virtual DgnModelRefP GetRootModelRef() const = 0;
406 
411 virtual void SetCustomProperty (WCharCP name, WCharCP value) = 0;
412 
414 virtual PlotPropertyMapCR CustomProperties() const = 0;
415 };
416 
418 
419 /*=================================================================================**/
426 bsiInterface IPrintEventHandler2
427 {
434 virtual void PrePrintDefinition (IPrePrintDefinitionParamP param) = 0;
435 
443 virtual void PrePenChart (IPlotPrePenChartParamP param) = 0;
444 
449 virtual void PreElementScan (IPlotPreElementScanParamP param) = 0;
450 
454 virtual void PostElementScan (IPlotPostElementScanParamP param) = 0;
455 
461 virtual void GetColorTable (IPlotGetColorTableParamP param) = 0;
462 
468 virtual void OnNewModelRef (IPlotPreModelParamP param) = 0;
469 
473 virtual void PreModel (IPlotPreModelParamP param) = 0;
474 
477 virtual void PreDynamicViewClip (IPreDynamicViewClipParamP param) = 0;
478 
487 virtual void BeginElement (IPlotBeginElementParamP param) = 0;
488 
494 virtual void EndElement (IPlotEndElementParamP param) = 0;
495 
502 virtual void PreElementOutput (IPlotPreElementOutputParamP param) = 0;
503 
506 virtual void PostElementOutput (IPlotPostElementOutputParamP param) = 0;
507 
511 virtual void Resymbolize (IPlotResymbolizeParamP param) = 0;
512 
516 virtual void PostPlotFileOpen() = 0;
517 
522 virtual void PostPlotFileClosed() = 0;
523 };
524 
525 /*=================================================================================**/
534 bsiInterface IPrintSetEventHandler
535 {
544 virtual StatusInt BeginPrintSet (IBeginPrintSetParamP param) = 0;
545 
554 virtual StatusInt EndPrintSet (IEndPrintSetParamP param) = 0;
555 
564 virtual void PrePrintSetDefinition (IPrePrintSetDefinitionParamP param) = 0;
565 };
566 
567 /*=================================================================================**/
574 bsiInterface IPrintDefCreateEventHandler
575 {
582 virtual void PrintDefCollectState (IPrintDefCollectStateParamP param) = 0;
583 };
584 
586 
587 END_PRINT_NAMESPACE
588 END_BENTLEY_MSTNPLATFORM_NAMESPACE
589 
END_PRINT_NAMESPACE
#define END_PRINT_NAMESPACE
Definition: MstnTypes.h:40
Bentley::MstnPlatform::IPlotPreElementOutputParam
Parameters for the PreElementOutput print event.
Definition: IPlotHook.h:287
Bentley::MstnPlatform::IPlotPostElementScanParam
Parameters for the PostElementScan print event.
Definition: IPlotHook.h:200
END_BENTLEY_MSTNPLATFORM_NAMESPACE
#define END_BENTLEY_MSTNPLATFORM_NAMESPACE
Definition: DgnPlatform.h:30
Bentley::MstnPlatform::PlotElemParamStack
bvector< IPlotElementParamCP > PlotElemParamStack
Definition: IPlotHook.h:61
Bentley::MstnPlatform::PlotPropertyMapCR
bmap< WString, PlotPropValue > const & PlotPropertyMapCR
Definition: PlotApi.h:857
Bentley::MstnPlatform::IPrintSetEventHandler
An event handler interface for printing system events related to print sets.
Definition: IPlotHook.h:534
Bentley::MstnPlatform::PlotTagTransform
PlotTagTransform
Transform Plotter properties.
Definition: IPlotter.h:183
Bentley::MstnPlatform::IPlotPreModelParam
Parameters for the PreModel print event.
Definition: IPlotHook.h:373
bsiInterface
#define bsiInterface
Definition: basedefs.h:31
Bentley::MstnPlatform::IPrintEventHandler2
An event handler interface for more per-page printing system events.
Definition: IPlotHook.h:426
Bentley::MstnPlatform::IPlotBeginElementParam
Parameters for the BeginElement print event.
Definition: IPlotHook.h:214
Bentley::MstnPlatform::IPlotPreElementScanParam
Parameters for the PreElementScan print event.
Definition: IPlotHook.h:186
Bentley::MstnPlatform::IPlotPostElementOutputParam
Parameters for the PostElementOutput print event.
Definition: IPlotHook.h:303
BEGIN_BENTLEY_MSTNPLATFORM_NAMESPACE
#define BEGIN_BENTLEY_MSTNPLATFORM_NAMESPACE
Definition: DgnPlatform.h:29
BEGIN_PRINT_NAMESPACE
#define BEGIN_PRINT_NAMESPACE
Definition: MstnTypes.h:39
Bentley::WCharCP
wchar_t const * WCharCP
Definition: Bentley.h:224
Bentley::MstnPlatform::IPrePrintDefinitionParam
Parameters for the PrePrintDefinition print event.
Definition: IPlotHook.h:154
Bentley::MstnPlatform::IPlotGetColorTableParam
Parameters for the GetColorTable print event.
Definition: IPlotHook.h:343
Bentley::MstnPlatform::PlotElemParamStackCP
bvector< IPlotElementParamCP > const * PlotElemParamStackCP
Definition: IPlotHook.h:62
Bentley::MstnPlatform::IBeginPrintSetParam
Parameters for the BeginPrintSet print event.
Definition: IPlotHook.h:69
Bentley::MstnPlatform::IPreDynamicViewClipParam
Parameters for the PreDynamicViewClip print event.
Definition: IPlotHook.h:389
UInt32
uint32_t UInt32
Definition: Bentley.r.h:128
Bentley::MSElementDescrCP
struct DgnPlatform::MSElementDescr const * MSElementDescrCP
Definition: DgnPlatform.h:390
Bentley::MstnPlatform::IPrintDefCreateEventHandler
An event handler interface for printing system events related to the creation of print definitions...
Definition: IPlotHook.h:574
Bentley::MstnPlatform::IPrePrintSetDefinitionParam
Parameters for the PrePrintSetDefinition print event.
Definition: IPlotHook.h:126
Bentley::DgnPlatform::DgnModelRef
A DgnModelRef provides access to a model in a Bentley::DgnPlatform::DgnFile.
Definition: DgnModelRef.h:172
Bentley::ElementHandleCP
struct DgnPlatform::ElementHandle const * ElementHandleCP
Definition: DgnPlatform.h:260
Bentley::MstnPlatform::IPlotResymbolizeParam
Parameters for the Resymbolize print event.
Definition: IPlotHook.h:319
Bentley::MstnPlatform::IEndPrintSetParam
Parameters for the EndPrintSet print event.
Definition: IPlotHook.h:96
byte
unsigned char byte
Definition: Bentley.r.h:144
Bentley::BitMask
A Bitmask holds a variable-sized array of bits.
Definition: BitMask.h:53
Bentley::TransformCR
struct Transform const & TransformCR
Definition: msgeomstructs_typedefs.h:134
Bentley::StatusInt
int StatusInt
Definition: Bentley.h:222
Bentley::DgnPlatform::SeedCopyFlags::ColorTable
Bentley::MstnPlatform::IPlotElementParam
Item in the print element parameter stack.
Definition: IPlotHook.h:52
Bentley::MstnPlatform::IPlotEndElementParam
Parameters for the EndElement print event.
Definition: IPlotHook.h:269
Bentley::ElementHandleCR
struct DgnPlatform::ElementHandle const & ElementHandleCR
Definition: DgnPlatform.h:260
Bentley::MstnPlatform::IPrintDefCollectStateParam
Parameters for the PrintDefCollectState print event.
Definition: IPlotHook.h:402
Bentley::MstnPlatform::IPlotPrePenChartParam
Parameters for the PrePenChart print event.
Definition: IPlotHook.h:176
Bentley::MstnPlatform::PlotElemParamStackCR
bvector< IPlotElementParamCP > const & PlotElemParamStackCR
Definition: IPlotHook.h:63
Bentley::WString
A string class that has many of the same capabilities as std::string, plus additional functions such ...
Definition: WString.h:51
Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.