|
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...
|
|
Printer information interface.
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.