lazarus/docs/xml/lcl/printers.xml
mattias d5c901ec68 lcl: docs: fixed encoding
git-svn-id: trunk@37849 -
2012-07-02 14:50:07 +00:00

1280 lines
41 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="lcl">
<!--
====================================================================
Printers
====================================================================
-->
<module name="Printers">
<short>Defines Printers to be used as output from Lazarus applications</short>
<descr/>
<!-- unresolved type reference Visibility: default -->
<element name="Classes">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="SysUtils">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="Graphics">
<short/>
<descr/>
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="TPrinter">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="EPrinter">
<short>
<var>EPrinter</var> - Exception handler for printer error</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- enumeration type Visibility: default -->
<element name="TPrinterOrientation">
<short/>
<descr/>
<seealso/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TPrinterOrientation.poPortrait">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TPrinterOrientation.poLandscape">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TPrinterOrientation.poReverseLandscape">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TPrinterOrientation.poReversePortrait">
<short/>
</element>
<!-- enumeration type Visibility: default -->
<element name="TPrinterCapability">
<short/>
<descr/>
<seealso/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TPrinterCapability.pcCopies">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TPrinterCapability.pcOrientation">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TPrinterCapability.pcCollation">
<short/>
</element>
<!-- set type Visibility: default -->
<element name="TPrinterCapabilities">
<short/>
<descr/>
<seealso/>
</element>
<!-- enumeration type Visibility: default -->
<element name="TPrinterState">
<short/>
<descr/>
<seealso/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TPrinterState.psNoDefine">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TPrinterState.psReady">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TPrinterState.psPrinting">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TPrinterState.psStopped">
<short/>
</element>
<!-- enumeration type Visibility: default -->
<element name="TPrinterType">
<short/>
<descr/>
<seealso/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TPrinterType.ptLocal">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TPrinterType.ptNetWork">
<short/>
</element>
<!-- object Visibility: default -->
<element name="TPrinterCanvas">
<short>
<var>TPrinterCanvas</var> - instance of <var>TCanvas</var> specially designed for printers</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TPrinterCanvas.fPrinter">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TPrinterCanvas.fTitle">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TPrinterCanvas.fHeight">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TPrinterCanvas.fWidth">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TPrinterCanvas.fPageNum">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TPrinterCanvas.fTopMarging">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TPrinterCanvas.fLeftMarging">
<short/>
<descr/>
<seealso/>
</element>
<!-- function Visibility: private -->
<element name="TPrinterCanvas.GetPageHeight">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TPrinterCanvas.GetPageHeight.Result">
<short/>
</element>
<!-- function Visibility: private -->
<element name="TPrinterCanvas.GetPageWidth">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TPrinterCanvas.GetPageWidth.Result">
<short/>
</element>
<!-- function Visibility: private -->
<element name="TPrinterCanvas.GetTitle">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TPrinterCanvas.GetTitle.Result">
<short/>
</element>
<!-- procedure Visibility: private -->
<element name="TPrinterCanvas.SetPageHeight">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TPrinterCanvas.SetPageHeight.AValue">
<short/>
</element>
<!-- procedure Visibility: private -->
<element name="TPrinterCanvas.SetPageWidth">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TPrinterCanvas.SetPageWidth.AValue">
<short/>
</element>
<!-- procedure Visibility: private -->
<element name="TPrinterCanvas.SetTitle">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TPrinterCanvas.SetTitle.AValue">
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TPrinterCanvas.BeginDoc">
<short>
<var>BeginDoc</var> - method to start printing a document</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: protected -->
<element name="TPrinterCanvas.NewPage">
<short>
<var>NewPage</var> - method to start printing a new page</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: protected -->
<element name="TPrinterCanvas.EndDoc">
<short>
<var>EndDoc</var> - method to finish printing a document</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- constructor Visibility: public -->
<element name="TPrinterCanvas.Create">
<short>
<var>Create</var> - constructor to make a canvas for the specified printer type, <var>APrinter</var>
</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TPrinterCanvas.Create.APrinter">
<short/>
</element>
<!-- procedure Visibility: public -->
<element name="TPrinterCanvas.Changing">
<short>
<var>Changing</var> - method for dealing with changes in printing staus</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TPrinterCanvas.Printer">
<short>The type of <var>Printer</var> for which this canvas is preparing the document</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TPrinterCanvas.Title">
<short>The <var>Title</var> of the current printer canvas</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TPrinterCanvas.PageHeight">
<short>The <var>PageHeight</var> to be used for the current canvas</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TPrinterCanvas.PageWidth">
<short>The <var>PageWidth</var> to be used for the current canvas</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TPrinterCanvas.PageNumber">
<short>
<var>PageNumber</var> - the number of the current page being prepared for printing</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TPrinterCanvas.TopMarging">
<short>
<var>TopMarging</var> - the size of the margin at the top of each page</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TPrinterCanvas.LeftMarging">
<short>
<var>LeftMarging</var> - the size of the margin at the left of each page</short>
<descr/>
<seealso/>
</element>
<!-- "class of" type Visibility: default -->
<element name="TPrinterCanvasRef">
<short>
<var>TPrinterCanvasRef</var> - class of <var>TPrinterCanvas</var>: referenced class</short>
<descr/>
<seealso/>
</element>
<!-- record type Visibility: default -->
<element name="TPaperRect">
<short>
<var>TPaperRect</var> - a record holding details of physical and working dimensions for paper</short>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: default -->
<element name="TPaperRect.PhysicalRect">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: default -->
<element name="TPaperRect.WorkRect">
<short/>
<descr/>
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="TPaperSize">
<short>
<var>TPaperSize</var> - the size of the paper to be used for the current document with the current printer</short>
<descr>
<p>
<var>TPaperSize</var> - the size of paper to be used for the current document with the current printer</p>
<p>The width and length are in points; there are 72 points per inch. </p>
</descr>
<errors/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TPaperSize.fOwnedPrinter">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TPaperSize.fSupportedPapers">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TPaperSize.fLastPrinterIndex">
<short/>
<descr/>
<seealso/>
</element>
<!-- function Visibility: private -->
<element name="TPaperSize.GetDefaultPaperName">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TPaperSize.GetDefaultPaperName.Result">
<short/>
</element>
<!-- function Visibility: private -->
<element name="TPaperSize.GetPaperName">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TPaperSize.GetPaperName.Result">
<short/>
</element>
<!-- function Visibility: private -->
<element name="TPaperSize.GetPaperRect">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TPaperSize.GetPaperRect.Result">
<short/>
</element>
<!-- function Visibility: private -->
<element name="TPaperSize.GetSupportedPapers">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TPaperSize.GetSupportedPapers.Result">
<short/>
</element>
<!-- procedure Visibility: private -->
<element name="TPaperSize.SetPaperName">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TPaperSize.SetPaperName.AName">
<short/>
</element>
<!-- function Visibility: private -->
<element name="TPaperSize.PaperRectOfName">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TPaperSize.PaperRectOfName.Result">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TPaperSize.PaperRectOfName.AName">
<short/>
</element>
<!-- constructor Visibility: public -->
<element name="TPaperSize.Create" link="#rtl.System.TObject.Create">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TPaperSize.Create.aOwner">
<short/>
</element>
<!-- destructor Visibility: public -->
<element name="TPaperSize.Destroy" link="#rtl.System.TObject.Destroy">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TPaperSize.PaperName">
<short>
<var>PaperName</var> - the name for the paper being used</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TPaperSize.DefaultPaperName">
<short>
<var>DefaultPaperName</var> - the default name for this size of paper</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TPaperSize.PaperRect">
<short>
<var>PaperRect</var> - the rectangle dimensions for this paper</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TPaperSize.SupportedPapers">
<short>
<var>SupportedPapers</var> - the list of supported papers for this pape size</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TPaperSize.PaperRectOf">
<short>
<var>PaperRectOf</var> - the Paper Rect corresponding to the given name</short>
<descr/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TPaperSize.PaperRectOf.aName">
<short/>
</element>
<!-- object Visibility: default -->
<element name="TPrinter">
<short>
<var>TPrinter</var> - class defining printer to be used in Lazarus applications</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TPrinter.fCanvas">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TPrinter.fFonts">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TPrinter.fPageNumber">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TPrinter.fPrinters">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TPrinter.fPrinterIndex">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TPrinter.fTitle">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TPrinter.fPrinting">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TPrinter.fAborted">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TPrinter.fPaperSize">
<short/>
<descr/>
<seealso/>
</element>
<!-- function Visibility: private -->
<element name="TPrinter.GetCanvas">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TPrinter.GetCanvas.Result">
<short/>
</element>
<!-- procedure Visibility: private -->
<element name="TPrinter.CheckPrinting">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TPrinter.CheckPrinting.Value">
<short/>
</element>
<!-- function Visibility: private -->
<element name="TPrinter.GetCopies">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TPrinter.GetCopies.Result">
<short/>
</element>
<!-- function Visibility: private -->
<element name="TPrinter.GetFonts">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TPrinter.GetFonts.Result">
<short/>
</element>
<!-- function Visibility: private -->
<element name="TPrinter.GetOrientation">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TPrinter.GetOrientation.Result">
<short/>
</element>
<!-- function Visibility: private -->
<element name="TPrinter.GetPageHeight">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TPrinter.GetPageHeight.Result">
<short/>
</element>
<!-- function Visibility: private -->
<element name="TPrinter.GetPageWidth">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TPrinter.GetPageWidth.Result">
<short/>
</element>
<!-- function Visibility: private -->
<element name="TPrinter.GetPaperSize">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TPrinter.GetPaperSize.Result">
<short/>
</element>
<!-- function Visibility: private -->
<element name="TPrinter.GetPrinterIndex">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TPrinter.GetPrinterIndex.Result">
<short/>
</element>
<!-- function Visibility: private -->
<element name="TPrinter.GetPrinters">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TPrinter.GetPrinters.Result">
<short/>
</element>
<!-- procedure Visibility: private -->
<element name="TPrinter.SetCopies">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TPrinter.SetCopies.AValue">
<short/>
</element>
<!-- procedure Visibility: private -->
<element name="TPrinter.SetOrientation">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TPrinter.SetOrientation.AValue">
<short/>
</element>
<!-- procedure Visibility: private -->
<element name="TPrinter.SetPrinterIndex">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TPrinter.SetPrinterIndex.AValue">
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TPrinter.SelectCurrentPrinterOrDefault">
<short>
<var>SelectCurrentPrinterOrDefault</var> method for selecting either the current printer or the default</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function Visibility: protected -->
<element name="TPrinter.GetCanvasRef">
<short>
<var>GetCanvasRef</var> - returns a reference to a printer canvas</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TPrinter.GetCanvasRef.Result">
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TPrinter.DoBeginDoc">
<short>
<var>DoBeginDoc</var> - method to begin printing the document</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: protected -->
<element name="TPrinter.DoNewPage">
<short>
<var>DoNewPage</var> - method for beginning a new page</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: protected -->
<element name="TPrinter.DoEndDoc">
<short>
<var>DoEndDoc</var> - method for finishing printing document. aAborded is True if printing has been aborted (eg by operator)</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TPrinter.DoEndDoc.aAborded">
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TPrinter.DoAbort">
<short>
<var>DoAbort</var> - method for aborting the printing</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: protected -->
<element name="TPrinter.DoResetPrintersList">
<short>
<var>DoResetPrintersList</var> - method for resetting the list of printers</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: protected -->
<element name="TPrinter.DoResetFontsList">
<short>
<var>DoResetFontsList</var> - method for resetting the list of fonts</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: protected -->
<element name="TPrinter.DoEnumPrinters">
<short>
<var>DoEnumPrinters</var> - method for producing an enumerated list of printers</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TPrinter.DoEnumPrinters.Lst">
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TPrinter.DoEnumFonts">
<short>
<var>DoEnumFonts</var> - method for producing an enumerated list of fonts</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TPrinter.DoEnumFonts.Lst">
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TPrinter.DoEnumPapers">
<short>
<var>DoEnumPapers</var> - method for producing an enumerated list of papers</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TPrinter.DoEnumPapers.Lst">
<short/>
</element>
<!-- function Visibility: protected -->
<element name="TPrinter.DoSetPrinter">
<short>
<var>DoSetPrinter</var> - returns integer corresponding to specified named printer</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TPrinter.DoSetPrinter.Result">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TPrinter.DoSetPrinter.aName">
<short/>
</element>
<!-- function Visibility: protected -->
<element name="TPrinter.DoGetCopies">
<short>
<var>DoGetCopies</var> - returns the number of copies required</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TPrinter.DoGetCopies.Result">
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TPrinter.DoSetCopies">
<short>
<var>DoSetCopies</var> - specifieds the number of copies required</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TPrinter.DoSetCopies.aValue">
<short/>
</element>
<!-- function Visibility: protected -->
<element name="TPrinter.DoGetOrientation">
<short>
<var>DoGetOrientation</var> - returns the required orientation for printing (landscape of portrait)</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TPrinter.DoGetOrientation.Result">
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TPrinter.DoSetOrientation">
<short>
<var>DoSetOrientation</var> - specifies the orientation for printing (landscape or portrait)</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TPrinter.DoSetOrientation.aValue">
<short/>
</element>
<!-- function Visibility: protected -->
<element name="TPrinter.DoGetDefaultPaperName">
<short>
<var>DoGetDefaultPaperName</var> - returns the default name for the paper</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TPrinter.DoGetDefaultPaperName.Result">
<short/>
</element>
<!-- function Visibility: protected -->
<element name="TPrinter.DoGetPaperName">
<short>
<var>DoGetPaperName</var> - returns the name of the current paper</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TPrinter.DoGetPaperName.Result">
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TPrinter.DoSetPaperName">
<short>
<var>DoSetPaperName</var> - specifies the name of the paper</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TPrinter.DoSetPaperName.aName">
<short/>
</element>
<!-- function Visibility: protected -->
<element name="TPrinter.DoGetPaperRect">
<short>
<var>DoGetPaperRect</var> - returns the dimensions of the rectangle for the named paper</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TPrinter.DoGetPaperRect.Result">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TPrinter.DoGetPaperRect.aName">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TPrinter.DoGetPaperRect.aPaperRc">
<short/>
</element>
<!-- function Visibility: protected -->
<element name="TPrinter.DoGetPrinterState">
<short>
<var>DoGetPrinterState</var> - retruns the printer state</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TPrinter.DoGetPrinterState.Result">
<short/>
</element>
<!-- function Visibility: protected -->
<element name="TPrinter.GetPrinterType">
<short>
<var>GetPrinterType</var> - returns the printer type</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TPrinter.GetPrinterType.Result">
<short/>
</element>
<!-- function Visibility: protected -->
<element name="TPrinter.GetCanPrint">
<short>
<var>GetCanPrint</var> - returns True if the printer is able to print</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TPrinter.GetCanPrint.Result">
<short/>
</element>
<!-- constructor Visibility: public -->
<element name="TPrinter.Create" link="#rtl.System.TObject.Create">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- destructor Visibility: public -->
<element name="TPrinter.Destroy" link="#rtl.System.TObject.Destroy">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: public -->
<element name="TPrinter.Abort">
<short>
<var>Abort</var> - terminate the current printing event (even if it hasn't finished)</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: public -->
<element name="TPrinter.BeginDoc">
<short>
<var>BeginDoc</var> - start printing the currently selected document</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: public -->
<element name="TPrinter.EndDoc">
<short>
<var>EndDoc</var> - finish printing the current document</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: public -->
<element name="TPrinter.NewPage">
<short>
<var>NewPage</var> - start printing on a new page</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: public -->
<element name="TPrinter.Refresh">
<short>
<var>Refresh</var> the data for printing, eg after a change </short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: public -->
<element name="TPrinter.SetPrinter">
<short>
<var>SetPrinter</var> - specify use of the named printer</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TPrinter.SetPrinter.aName">
<short/>
</element>
<!-- function Visibility: public -->
<element name="TPrinter.ExecuteSetup">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TPrinter.ExecuteSetup.Result">
<short/>
</element>
<!-- function Visibility: public -->
<element name="TPrinter.ExecuteProperties">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TPrinter.ExecuteProperties.Result">
<short/>
</element>
<!-- property Visibility: public -->
<element name="TPrinter.PrinterIndex">
<short>
<var>PrinterIndex</var> - the printer's index in the list of printers</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TPrinter.PaperSize">
<short>
<var>PaperSize</var> - the size of paper to be used for the current document</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TPrinter.Orientation">
<short>The <var>Orientation</var> - for printing the current document (landscape or portrait, normal or reversed)</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TPrinter.PrinterState">
<short>
<var>PrinterState</var> - ready, printing, stopped or undefined</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TPrinter.Copies">
<short>Number of <var>Copies</var> of the current document</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TPrinter.Printers">
<short>
<var>Printers</var> - the list of available printers for printing the current document</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TPrinter.Fonts">
<short>the list of available <var>Fonts</var> for the current printer</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TPrinter.Canvas">
<short>The <var>Canvas</var> to be used for laying out the current document ready for printing</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TPrinter.PageHeight">
<short>
<var>PageHeight</var> - for printing the current document with the defined <var>PaperSize</var>
</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TPrinter.PageWidth">
<short>The <var>PageWidth</var> for the current document with the defined <var>PaperSize</var>
</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TPrinter.PageNumber">
<short>
<var>PageNumber</var> - the number of the current page being printed</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TPrinter.Aborted">
<short>
<var>Aborted</var> - True if printing of the document has been prematurely terminated by operator command</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TPrinter.Printing">
<short>
<var>Printing</var> - True if document is in process of being printed</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TPrinter.Title">
<short>
<var>Title</var> - name for this printer</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TPrinter.PrinterType">
<short>
<var>PrinterType</var> - whether a local or network printer</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TPrinter.CanPrint">
<short>
<var>CanPrint</var> - True if printing is enabled or not disabled</short>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: default -->
<element name="Printer">
<short/>
<descr/>
<seealso/>
</element>
<element name="TPrinter.CanRenderCopies">
<short>
<var>CanRenderCopies</var> - True if the printer device can render copies</short>
<descr>
<var>CanRenderCopies</var> - True if the printer device can render copies, ie if <var>TPrinterCapability</var> includes pcCopies
</descr>
</element>
<element name="TPrinter.XDPI">
<short>
<var>XDPI</var> - number of dots per inch in X-direction</short>
</element>
<element name="TPrinter.YDPI">
<short>
<var>YDPI</var> - number of dots per inch in Y direction</short>
</element>
<element name="TPrinter.RawMode">
<short>
<var>RawMode</var> - true if printer operates in Raw Mode (as opposed to PostScript or some other page description language)</short>
<descr>
<p>
<var>RawMode</var> - true if printer operates in Raw Mode (as opposed to PostScript or some other page description language)</p>
<p>If Raw Mode is being used, text is sent directly to the printer device without formatting, and the Canvas is not used for setting up the pages</p>
</descr>
</element>
<element name="TPrinterCanvas.GetLeftMargin">
<short>
<var>GetLeftMargin</var> - returns the size of teh left margin</short>
</element>
<element name="TPrinterCanvas.GetTopMargin">
<short>
<var>GetTopMargin</var> - returns the size of the top margin</short>
</element>
<element name="TPrinterCanvas.GetBottomMargin">
<short>
<var>GetBottomMargin</var> - returns the size of the bottom margin</short>
</element>
<element name="TPrinterCanvas.GetRightMargin">
<short>
<var>GetRightMargin</var> - returns the size of the right margin</short>
</element>
<element name="TPrinterCanvas.TopMargin">
<short>The size of the <var>TopMargin</var>
</short>
</element>
<element name="TPrinterCanvas.LeftMargin">
<short>The size of the <var>LeftMargin</var>
</short>
</element>
<element name="TPrinterCanvas.BottomMargin">
<short>The size of the <var>BottomMargin</var>
</short>
</element>
<element name="TPrinterCanvas.RightMargin">
<short>the size of the <var>RightMargin</var>
</short>
</element>
<element name="TPrinter.DoInitialization">
<short>
<var>DoInitialization</var> - method for performing initialisation</short>
</element>
<element name="TPrinter.GetCanRenderCopies">
<short>
<var>GetCanRenderCopies</var> - returns True if the printer is able to render copies</short>
</element>
<element name="TPrinter.GetXDPI">
<short>
<var>GetXDPI</var> - returns the number of Dots Per Inch in the X plane</short>
</element>
<element name="TPrinter.GetYDPI">
<short>
<var>GetYDPI</var> - returns the number of Dots Per Inch in the Y plane</short>
</element>
<element name="TPrinter.CheckRawMode">
<short>
<var>CheckRawMode</var> - check whether the printer operates in Raw mode (as opposed to PostScript etc)</short>
</element>
<element name="TPrinter.RawModeChanging">
<short>
<var>RawModeChanging</var> - the raw mode is changing (eg PostScript is being invoked)</short>
</element>
<element name="TPrinter.PrinterSelected">
<short>
<var>PrinterSelected</var> - method for dealing with a printer that has been selected</short>
</element>
<element name="TPrinter.Write">
<short>
<var>Write</var> to a specified <var>Buffer</var>: <var>Count</var> contains the number of bytes for writing, <var>Written</var> contains the number that have been written. Returns True if successful</short>
</element>
</module>
<!-- Printers -->
</package>
</fpdoc-descriptions>