Public Member Functions | List of all members
IPlotter Struct Referenceabstract

Printer information interface. More...

#include <IPlotter.h>

Public Member Functions

virtual StatusInt Initialize (PlotFileSpecR pltcfgFspec)=0
 Initializes the Plotter instance from the specified printer driver configuration file. More...
 
virtual IPlotterP Copy () const =0
 Duplicates the Plotter instance. More...
 
virtual PlotFileSpecCR GetPltcfgFspec () const =0
 Gets the printer driver configuration file specification for this Plotter instance. More...
 
virtual bool GetBool (PlotTagBool tag) const =0
 Gets a boolean value from the Plotter instance. More...
 
virtual void SetBool (PlotTagBool tag, bool value)=0
 Sets a boolean value in the Plotter instance. More...
 
virtual int GetInt (PlotTagInt tag) const =0
 Gets an integer value from the Plotter instance. More...
 
virtual void SetInt (PlotTagInt tag, int value)=0
 Sets an integer value in the Plotter instance. More...
 
virtual double GetDouble (PlotTagDbl tag) const =0
 Gets a double value from the Plotter instance. More...
 
virtual void SetDouble (PlotTagDbl tag, double value)=0
 Sets a double value in the Plotter instance. More...
 
virtual DPoint2d GetDPoint2d (PlotTagDPoint2d tag) const =0
 Gets a DPoint2d value from the Plotter instance. More...
 
virtual void SetDPoint2d (PlotTagDPoint2d tag, DPoint2dCR value)=0
 Sets a DPoint2d value in the Plotter instance. More...
 
virtual DPoint3d GetDPoint3d (PlotTagDPoint3d tag) const =0
 Gets a DPoint3d value from the Plotter instance. More...
 
virtual void SetDPoint3d (PlotTagDPoint3d tag, DPoint3dCR value)=0
 Sets a DPoint3d value in the Plotter instance. More...
 
virtual void GetString (PlotTagStr tag, WStringR value) const =0
 Gets a string value from the Plotter instance. More...
 
virtual void SetString (PlotTagStr tag, WCharCP value)=0
 Sets a string value in the Plotter instance. More...
 
virtual void * GetPointer (PlotTagPtr tag) const =0
 Gets a pointer value from the Plotter instance. More...
 
virtual void SetPointer (PlotTagPtr tag, void *value)=0
 Sets a pointer value in the Plotter instance. More...
 
virtual PlotTriState GetTriState (PlotTagTriState tag) const =0
 Gets a tristate value from the Plotter instance. More...
 
virtual void SetTriState (PlotTagTriState tag, PlotTriState value)=0
 Sets a tristate value in the Plotter instance. More...
 
virtual PlotFileSpecP GetFileSpecP (PlotTagFileSpec tag)=0
 Gets a FileSpec value from the Plotter instance. More...
 
virtual PlotFileSpecCP GetFileSpecCP (PlotTagFileSpec tag) const =0
 Gets a const FileSpec value from the Plotter instance. More...
 
virtual bool GetIsDefinedInPltcfg (PlotTagIsDefinedInPltcfg tag) const =0
 Gets a flag indicating if the specified property was defined in the printer driver configuration file. More...
 
virtual void SetIsDefinedInPltcfg (PlotTagIsDefinedInPltcfg tag, bool value)=0
 Sets a flag indicating if the specified property was defined in the printer driver configuration file. More...
 
virtual PlotUnits GetPlotterUnits () const
 Gets the plotter units. More...
 
virtual void SetPlotterUnits (PlotUnits units)
 Sets the plotter units. More...
 
virtual double ConvertUnits (double value, PlotUnits fromUnits, PlotUnits toUnits) const =0
 Converts values from one units to another. More...
 
virtual double ConvertUnits (double value, PlotUnits units, bool convertStoredToUnits) const =0
 Converts values to or from the current plotter units. More...
 
virtual int GetPenFromColorIndex (int index) const =0
 Gets the pen number corresponding to the given color table index. More...
 
virtual void SetPenFromColorIndex (int index, int pen)=0
 Sets the pen number corresponding to the given color table index. More...
 
virtual RgbaColorDef GetPenColor (int pen) const =0
 Gets the color for a particular pen number. More...
 
virtual bool GetIsPenColorDefined (int pen) const =0
 Indicates whether the particular pen color was set in the printer driver configuration file. More...
 
virtual PlotPenSetup GetPenSetup (int pen) const =0
 Gets pen characteristics for a particular pen number. More...
 
virtual void SetPenSetup (int pen, PlotPenSetupCR penSetup)=0
 Call to set pen characteristics for a particular pen number. More...
 
virtual PlotRasterComprCR GetRasterCompression () const =0
 Gets a constant reference to the RasterCompression structure. More...
 
virtual double GetLineWidth (int weight, PlotUnits *unitsP) const =0
 Gets the line width in physical units for the specified weight. More...
 
virtual void SetLineWidth (int weight, PlotUnits units, double width)=0
 Sets the line width in physical units for the specified weight. More...
 
virtual PlotLineStyleDefCR GetLineStyle (int styleIndex) const =0
 Gets the print line style for the specified line style index. More...
 
virtual void SetLineStyle (int styleIndex, PlotLineStyleDefCR lineStyle)=0
 Sets the print line style for the specified line style index. More...
 
virtual int GetNumExtLineStyles () const =0
 Gets the number of extended line style definitions. More...
 
virtual PlotLineStyleDefP GetExtLineStyles ()=0
 Gets the array of extended line style definitions. More...
 
virtual void SetExtLineStyles (int numExtLineStyles, PlotLineStyleDefCP extLineStylesDots)=0
 Sets the array of extended line style definitions. Units must be dots. Internal use only. More...
 
virtual IPlotterFormListP Forms ()=0
 Gets the interface used to add/remove/edit/query the plotter paper sizes. More...
 
virtual IPlotterFormListCP FormsCP () const =0
 Gets the interface used to query the plotter paper sizes. More...
 
virtual IPlotFontMapListP FontMaps ()=0
 Gets the interface used to add/remove/edit the plotter hardware font maps. More...
 
virtual StatusInt SelectFormByName (WCharCP formName)=0
 Selects the specified form name. More...
 
virtual StatusInt SelectTrayByName (WCharCP trayName)=0
 Selects the specified tray name. More...
 
virtual void WriteCommand (byte const *buffer, int numBytes)=0
 Writes an arbitrary number of bytes to the plot output file. More...
 
virtual void WriteString (byte const *buffer)=0
 Writes a nul-terminated string to the plot output file. More...
 
virtual void CopyFileIntoPlotFile (WCharCP filename)=0
 Copies the contents of the specified file into the plot output file. More...
 
virtual void FlushBuffer ()=0
 Flushes the plotting buffer. More...
 
virtual PlotRasterOptionsCR GetRasterOptions () const =0
 Gets a copy of the raster options structure. More...
 
virtual void SetRasterOptions (PlotRasterOptionsCR rasterOptions)=0
 Sets the raster options in the plotter instance. More...
 
virtual IPrinterDriverBaseP GetPrinterDriver () const =0
 Gets the printer driver interface associated with this plotter instance. More...
 
virtual void SetPrinterDriver (IPrinterDriverBaseP driverP)=0
 Registers the printer driver with the print engine. More...
 
virtual DriverOutputMode GetDriverOutputMode () const =0
 Gets the current driver output mode. More...
 
virtual void SetDriverOutputMode (DriverOutputMode mode)=0
 Sets the current driver output mode. More...
 
virtual DriverCoordSysOrigin GetDriverCoordSysOrigin () const =0
 Gets the current driver coordinate system origin. More...
 
virtual void SetDriverCoordSysOrigin (DriverCoordSysOrigin origin)=0
 Sets the current driver coordinate system origin. More...
 
virtual void RoundPaperSize (PlotUnits roundingUnits, PlotUnits sizeUnits, DPoint2dP size) const =0
 Rounds the given paper size to nearest value appropriate for the specified rounding units. More...
 
virtual IPlotRasterizedParamR RasterizedParam ()=0
 Gets the interface used to modify rasterized plotting parameters. More...
 
virtual IPlotOleParamR OleParam ()=0
 Gets the interface used to modify OLE plotting parameters. More...
 
virtual PlotDestination GetPlotDestination () const =0
 Gets the plotter default plot destination. More...
 
virtual void SetPlotDestination (PlotDestination destination)=0
 Sets the plotter default plot destination. More...
 
virtual PlotHwTextMode GetHwTextMode () const =0
 Gets the hardware text mode. More...
 
virtual void SetHwTextMode (PlotHwTextMode value)=0
 Sets the hardware text mode. More...
 
virtual bool IsPrintToFile () const =0
 Indicates if the current plot destination is a file. More...
 
virtual bool IsPrintToMetafile () const =0
 Indicates if the current plot destination is a Windows metafile. More...
 
virtual bool IsPrintToIpserver () const
 Indicates if the current plot destination is InterPlot Server. More...
 
virtual IPlotterFormP FindFormByNameSizeMatch (IPlotterFormP requestForm, PlotUnits requestUnits) const =0
 Attempts to locate the closest matching form defined for this plotter to the specified form. More...
 
virtual bool FindCompanionFile (PlotFileSpecR fileSpec)=0
 Searches for a companion file to the printer driver configuration file in the same directory as the .pltcfg file, or in MS_PLTCFG_PATH. More...
 
virtual void GetSystemPrinterName (WStringR printerName) const =0
 Selects the currently selected system printer name. More...
 
virtual StatusInt SelectSystemPrinter (WCharCP printerName)=0
 Selects the specified system printer name. More...
 
virtual StatusInt SetSystemPrinterOrientation (PlotOrientation orientation)=0
 Sets the system printer orientation. More...
 
virtual void FindBestFitForm (double requestWidthDots, double requestHeightDots, PlotUnits requestUnits, int *bestFitFormIndexP, bool *selectedFormFitsP) const =0
 Gets the form that best fits the specified width and height. More...
 
virtual PlotError GetEngineError () const =0
 Gets the current error code from the Plotter instance. More...
 
virtual void SetEngineError (PlotError value)=0
 Sets the current error code in the Plotter instance. More...
 
virtual int GetEngineLineWidth (int weight) const =0
 Gets the print engine line width for a particular weight. More...
 
virtual int GetEngineLineWidth (int pen, int weight) const =0
 Gets the line width in dots needed for a particular pen number and/or weight index. More...
 
virtual void SetEngineLineWidth (int weight, int lineWidthDots)=0
 Sets the print engine line width for a particular weight index. More...
 
virtual PlotLineStyleDefCR GetEngineLineStyle (int styleIndex) const =0
 Gets print engine line style pattern in dots for a particular index. More...
 
virtual RgbaColorDef GetEngineColorFromPen (int pen) const =0
 Gets the effective print color for the given pen number. More...
 
virtual RgbaColorDef GetEngineColorFromIndex (int colorIndex) const =0
 Gets the effective print color for the given color table index. More...
 
virtual RgbaColorDef GetEngineBackgroundColor () const =0
 Gets the print background color. More...
 

Detailed Description

Printer information interface.

Remarks
The IPlotter interface is intended for use by printer drivers, applications that hook print events, and print submittal applications that need to query printer information such as paper sizes.

The Plotter class primarily encapsulates information stored in the printer driver configuration (.pltcfg) file, but also serves as a communication channel between the printer driver and the print engine.

Typical callers do not create or initialize Plotter instances. Instead, they receive an IPlotter interface to an initialized Plotter instance via the IPrintDefinition, IPrinterDriver, or IPrintEventHandler interfaces.

Printer drivers are the only callers expected to make use of the Set methods.

Member Function Documentation

virtual double ConvertUnits ( double  value,
PlotUnits  fromUnits,
PlotUnits  toUnits 
) const
pure virtual

Converts values from one units to another.

virtual double ConvertUnits ( double  value,
PlotUnits  units,
bool  convertStoredToUnits 
) const
pure virtual

Converts values to or from the current plotter units.

virtual IPlotterP Copy ( ) const
pure virtual

Duplicates the Plotter instance.

virtual void CopyFileIntoPlotFile ( WCharCP  filename)
pure virtual

Copies the contents of the specified file into the plot output file.

virtual void FindBestFitForm ( double  requestWidthDots,
double  requestHeightDots,
PlotUnits  requestUnits,
int *  bestFitFormIndexP,
bool *  selectedFormFitsP 
) const
pure virtual

Gets the form that best fits the specified width and height.

Parameters
[in]requestWidthDotsRequested form width in dots.
[in]requestHeightDotsRequested form height in dots.
[in]requestUnitsIndicates preference for standard ANSI or ISO forms; must be PlotUnits::in or PlotUnits::mm.
[out]bestFitFormIndexPReturns index of the form that best fits the requested size.
[out]selectedFormFitsPReturns True if the selected form accomodates the requested size without clipping. May be NULL.
virtual bool FindCompanionFile ( PlotFileSpecR  fileSpec)
pure virtual

Searches for a companion file to the printer driver configuration file in the same directory as the .pltcfg file, or in MS_PLTCFG_PATH.

Intended to be called only by printer drivers.

virtual IPlotterFormP FindFormByNameSizeMatch ( IPlotterFormP  requestForm,
PlotUnits  requestUnits 
) const
pure virtual

Attempts to locate the closest matching form defined for this plotter to the specified form.

Remarks
The first check is for identical form name and form size. If no such match exists, the best-fitting form is chosen.
virtual void FlushBuffer ( )
pure virtual

Flushes the plotting buffer.

Remarks
Normally, a plotter driver never needs to call this. As a driver calls WriteCommand, FlushBuffer is called automatically. It is also called at the end of the plot.
virtual IPlotFontMapListP FontMaps ( )
pure virtual

Gets the interface used to add/remove/edit the plotter hardware font maps.

virtual IPlotterFormListP Forms ( )
pure virtual

Gets the interface used to add/remove/edit/query the plotter paper sizes.

virtual IPlotterFormListCP FormsCP ( ) const
pure virtual

Gets the interface used to query the plotter paper sizes.

virtual bool GetBool ( PlotTagBool  tag) const
pure virtual

Gets a boolean value from the Plotter instance.

virtual double GetDouble ( PlotTagDbl  tag) const
pure virtual

Gets a double value from the Plotter instance.

virtual DPoint2d GetDPoint2d ( PlotTagDPoint2d  tag) const
pure virtual

Gets a DPoint2d value from the Plotter instance.

virtual DPoint3d GetDPoint3d ( PlotTagDPoint3d  tag) const
pure virtual

Gets a DPoint3d value from the Plotter instance.

virtual DriverCoordSysOrigin GetDriverCoordSysOrigin ( ) const
pure virtual

Gets the current driver coordinate system origin.

virtual DriverOutputMode GetDriverOutputMode ( ) const
pure virtual

Gets the current driver output mode.

virtual RgbaColorDef GetEngineBackgroundColor ( ) const
pure virtual

Gets the print background color.

Remarks
Should only be called only during print processing.
virtual RgbaColorDef GetEngineColorFromIndex ( int  colorIndex) const
pure virtual

Gets the effective print color for the given color table index.

Remarks
Should only be called only during print processing.
Parameters
[in]colorIndexColor table index (range 0-255)
virtual RgbaColorDef GetEngineColorFromPen ( int  pen) const
pure virtual

Gets the effective print color for the given pen number.

Remarks
Should only be called only during print processing.
Parameters
[in]penPen number (range 0-255)
virtual PlotError GetEngineError ( ) const
pure virtual

Gets the current error code from the Plotter instance.

Should only be called only during print processing.

virtual PlotLineStyleDefCR GetEngineLineStyle ( int  styleIndex) const
pure virtual

Gets print engine line style pattern in dots for a particular index.

Remarks
Should only be called only during print processing.
Parameters
[in]styleIndexLine style index (range 0-(MAX_LINESTYLES+NumExtLineStyles-1))
virtual int GetEngineLineWidth ( int  weight) const
pure virtual

Gets the print engine line width for a particular weight.

Remarks
The value is print width in dots. Note that the returned value is only from the base weight-to-width mapping table. The actual print width may come from the color-index-to-width table or elsewhere. Should only be called only during print processing.
Parameters
[in]weightWeight index (range 0 to 31).
virtual int GetEngineLineWidth ( int  pen,
int  weight 
) const
pure virtual

Gets the line width in dots needed for a particular pen number and/or weight index.

Remarks
If /widthMM was specified in the .pltcfg file for the specified pen number, then that width value in pixels will be returned. Otherwise the value is returned from the defined weight-to-width mapping table. Should only be called only during print processing.
Parameters
[in]penPen number (range 0 to 255).
[in]weightWeight index (range 0 to 31).
virtual PlotLineStyleDefP GetExtLineStyles ( )
pure virtual

Gets the array of extended line style definitions.

virtual PlotFileSpecCP GetFileSpecCP ( PlotTagFileSpec  tag) const
pure virtual

Gets a const FileSpec value from the Plotter instance.

virtual PlotFileSpecP GetFileSpecP ( PlotTagFileSpec  tag)
pure virtual

Gets a FileSpec value from the Plotter instance.

virtual PlotHwTextMode GetHwTextMode ( ) const
pure virtual

Gets the hardware text mode.

virtual int GetInt ( PlotTagInt  tag) const
pure virtual

Gets an integer value from the Plotter instance.

virtual bool GetIsDefinedInPltcfg ( PlotTagIsDefinedInPltcfg  tag) const
pure virtual

Gets a flag indicating if the specified property was defined in the printer driver configuration file.

virtual bool GetIsPenColorDefined ( int  pen) const
pure virtual

Indicates whether the particular pen color was set in the printer driver configuration file.

Parameters
[in]penPen number (range 0-255), where 0=background pen
virtual PlotLineStyleDefCR GetLineStyle ( int  styleIndex) const
pure virtual

Gets the print line style for the specified line style index.

param styleIndex[in] Line style index (range 0-7).

virtual double GetLineWidth ( int  weight,
PlotUnits unitsP 
) const
pure virtual

Gets the line width in physical units for the specified weight.

Parameters
[in]weight(range 0-31).
[out]unitsPUnits for physical width.
virtual int GetNumExtLineStyles ( ) const
pure virtual

Gets the number of extended line style definitions.

virtual RgbaColorDef GetPenColor ( int  pen) const
pure virtual

Gets the color for a particular pen number.

Parameters
[in]penPen number (range 0-255), where 0=background pen
virtual int GetPenFromColorIndex ( int  index) const
pure virtual

Gets the pen number corresponding to the given color table index.

virtual PlotPenSetup GetPenSetup ( int  pen) const
pure virtual

Gets pen characteristics for a particular pen number.

Parameters
[in]penPen number (range 0-255), where 0=background pen
virtual PlotDestination GetPlotDestination ( ) const
pure virtual

Gets the plotter default plot destination.

virtual PlotUnits GetPlotterUnits ( ) const
virtual

Gets the plotter units.

virtual PlotFileSpecCR GetPltcfgFspec ( ) const
pure virtual

Gets the printer driver configuration file specification for this Plotter instance.

virtual void* GetPointer ( PlotTagPtr  tag) const
pure virtual

Gets a pointer value from the Plotter instance.

virtual IPrinterDriverBaseP GetPrinterDriver ( ) const
pure virtual

Gets the printer driver interface associated with this plotter instance.

virtual PlotRasterComprCR GetRasterCompression ( ) const
pure virtual

Gets a constant reference to the RasterCompression structure.

virtual PlotRasterOptionsCR GetRasterOptions ( ) const
pure virtual

Gets a copy of the raster options structure.

virtual void GetString ( PlotTagStr  tag,
WStringR  value 
) const
pure virtual

Gets a string value from the Plotter instance.

virtual void GetSystemPrinterName ( WStringR  printerName) const
pure virtual

Selects the currently selected system printer name.

virtual PlotTriState GetTriState ( PlotTagTriState  tag) const
pure virtual

Gets a tristate value from the Plotter instance.

virtual StatusInt Initialize ( PlotFileSpecR  pltcfgFspec)
pure virtual

Initializes the Plotter instance from the specified printer driver configuration file.

virtual bool IsPrintToFile ( ) const
pure virtual

Indicates if the current plot destination is a file.

virtual bool IsPrintToIpserver ( ) const
virtual

Indicates if the current plot destination is InterPlot Server.

virtual bool IsPrintToMetafile ( ) const
pure virtual

Indicates if the current plot destination is a Windows metafile.

virtual IPlotOleParamR OleParam ( )
pure virtual

Gets the interface used to modify OLE plotting parameters.

virtual IPlotRasterizedParamR RasterizedParam ( )
pure virtual

Gets the interface used to modify rasterized plotting parameters.

virtual void RoundPaperSize ( PlotUnits  roundingUnits,
PlotUnits  sizeUnits,
DPoint2dP  size 
) const
pure virtual

Rounds the given paper size to nearest value appropriate for the specified rounding units.

virtual StatusInt SelectFormByName ( WCharCP  formName)
pure virtual

Selects the specified form name.

virtual StatusInt SelectSystemPrinter ( WCharCP  printerName)
pure virtual

Selects the specified system printer name.

virtual StatusInt SelectTrayByName ( WCharCP  trayName)
pure virtual

Selects the specified tray name.

virtual void SetBool ( PlotTagBool  tag,
bool  value 
)
pure virtual

Sets a boolean value in the Plotter instance.

virtual void SetDouble ( PlotTagDbl  tag,
double  value 
)
pure virtual

Sets a double value in the Plotter instance.

virtual void SetDPoint2d ( PlotTagDPoint2d  tag,
DPoint2dCR  value 
)
pure virtual

Sets a DPoint2d value in the Plotter instance.

virtual void SetDPoint3d ( PlotTagDPoint3d  tag,
DPoint3dCR  value 
)
pure virtual

Sets a DPoint3d value in the Plotter instance.

virtual void SetDriverCoordSysOrigin ( DriverCoordSysOrigin  origin)
pure virtual

Sets the current driver coordinate system origin.

virtual void SetDriverOutputMode ( DriverOutputMode  mode)
pure virtual

Sets the current driver output mode.

virtual void SetEngineError ( PlotError  value)
pure virtual

Sets the current error code in the Plotter instance.

Should only be called only during print processing.

virtual void SetEngineLineWidth ( int  weight,
int  lineWidthDots 
)
pure virtual

Sets the print engine line width for a particular weight index.

Remarks
Should only be called only during print processing. Note that the return value is only from the base weight-to-width mapping table. The actual print width may come from the color-index-to-width table or elsewhere. Should only be called only during print processing.
Parameters
[in]weightWeight index (range 0 to 31)
[in]lineWidthDotsNew print width in dots.
virtual void SetExtLineStyles ( int  numExtLineStyles,
PlotLineStyleDefCP  extLineStylesDots 
)
pure virtual

Sets the array of extended line style definitions. Units must be dots. Internal use only.

virtual void SetHwTextMode ( PlotHwTextMode  value)
pure virtual

Sets the hardware text mode.

virtual void SetInt ( PlotTagInt  tag,
int  value 
)
pure virtual

Sets an integer value in the Plotter instance.

virtual void SetIsDefinedInPltcfg ( PlotTagIsDefinedInPltcfg  tag,
bool  value 
)
pure virtual

Sets a flag indicating if the specified property was defined in the printer driver configuration file.

virtual void SetLineStyle ( int  styleIndex,
PlotLineStyleDefCR  lineStyle 
)
pure virtual

Sets the print line style for the specified line style index.

Remarks
This value is converted into pixels by the print engine at the time of print processing, taking into account the paper size line style scale factor. Should be called prior to starting the print engine. param styleIndex[in] Line style index (range 0-7). param lineStyle[in] New line style definition.
virtual void SetLineWidth ( int  weight,
PlotUnits  units,
double  width 
)
pure virtual

Sets the line width in physical units for the specified weight.

Remarks
This value is converted into pixels by the print engine at the time of print processing, taking into account the paper size line width scale factor. Should be called prior to starting the print engine.
Parameters
[in]weight(range 0-31).
[in]unitsUnits for physical width.
[in]widthNew physical width.
virtual void SetPenFromColorIndex ( int  index,
int  pen 
)
pure virtual

Sets the pen number corresponding to the given color table index.

virtual void SetPenSetup ( int  pen,
PlotPenSetupCR  penSetup 
)
pure virtual

Call to set pen characteristics for a particular pen number.

Parameters
[in]penPen number (range 0-255), where 0=background pen
[in]penSetupInput pen setup structure.
virtual void SetPlotDestination ( PlotDestination  destination)
pure virtual

Sets the plotter default plot destination.

virtual void SetPlotterUnits ( PlotUnits  units)
virtual

Sets the plotter units.

virtual void SetPointer ( PlotTagPtr  tag,
void *  value 
)
pure virtual

Sets a pointer value in the Plotter instance.

virtual void SetPrinterDriver ( IPrinterDriverBaseP  driverP)
pure virtual

Registers the printer driver with the print engine.

virtual void SetRasterOptions ( PlotRasterOptionsCR  rasterOptions)
pure virtual

Sets the raster options in the plotter instance.

virtual void SetString ( PlotTagStr  tag,
WCharCP  value 
)
pure virtual

Sets a string value in the Plotter instance.

virtual StatusInt SetSystemPrinterOrientation ( PlotOrientation  orientation)
pure virtual

Sets the system printer orientation.

virtual void SetTriState ( PlotTagTriState  tag,
PlotTriState  value 
)
pure virtual

Sets a tristate value in the Plotter instance.

virtual void WriteCommand ( byte const *  buffer,
int  numBytes 
)
pure virtual

Writes an arbitrary number of bytes to the plot output file.

Parameters
[in]bufferBuffer to be written to plot output file.
[in]numBytesNumber of bytes in buffer.
virtual void WriteString ( byte const *  buffer)
pure virtual

Writes a nul-terminated string to the plot output file.

Parameters
[in]bufferNul-terminated string to be written to plot output file.

The documentation for this struct was generated from the following file:

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