You've already forked lazarus-ccr
b6cbe7c8aa
git-svn-id: https://svn.code.sf.net/p/lazarus-ccr/svn@8649 8e941d3f-bd1b-0410-a28a-d453659cc2b4
24 lines
4.9 KiB
XML
24 lines
4.9 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<fpdoc-descriptions><package name="GridPrinterPkg"><module name="GridPrnPreviewForm"><element name="TGridPrintPreviewZoomMode"><short>Enumeration of options how the preview bitmap can be scaled by means of the <var>Zoom</var> factor.</short><descr><ul><li><var>zmCustom</var> - The current value of the Zoom factor is applied directly.</li><li><var>zmFitWidth</var> - The Zoom factor is adjusted so that the page fits horizontally into the preview window.</li><li><var>zmFitHeight</var> - The Zoom factor is adjusted such that the page fits vertically into the preview window.</li>
|
|
</ul>
|
|
</descr><seealso><link id="TGridPrintPreviewDialog"/>
|
|
</seealso>
|
|
</element><element name="TGridPrintPreviewOption"><short>Enumeration of options for the user to enable/disable features in the preview form.</short><descr><ul><li><var>ppoNavigationBtns</var> - Enables/disables page navigation in the preview.</li><li><var>ppoNavigationEdit</var> - Shows/hides the edit control in the preview toolbar with which the user can navigate to a specific page of the preview.</li><li><var>ppoZoomBtns</var> - Enables/disables zooming in the preview.</li><li><var>ppoPageOrientationBtns</var> - Enables/disables selection of page orientation.</li><li><var>ppoMarginsBtn</var> - Enables/disables page margin selection in the preview</li><li><var>ppoHeaderFooterBtn</var> - Enables/disables the possibility to set up the header and footer in a dialog.</li><li><var>ppoPrintOrderBtns</var> - Enables/disables the possibility to define the order of pages when the entire print-out does not fit onto a single page of paper.</li><li><var>ppoCenterBtns</var> - Shows/hides the buttons to center the grid on the printed page.</li><li><var>ppoScalePrinterBtn</var> - Shows/hides the button to scale the printer output manually or to force a given count of pages onto a single sheet.</li><li><var>ppoPageSetupBtn</var> - Shows/hides a toolbar button with a dropdown menu containing options to control the page layout (page orientation, margin selection, etc).</li><li><var>ppoPageNumberInfo</var> - Shows/hides the display of page number and total page count in the preview form.</li><li><var>ppoZoomLevelInfo</var> - Shows/hides the display of the preview zoom level (percentage) in the preview form.</li>
|
|
</ul>
|
|
</descr>
|
|
</element><element name="TGridPrintPreviewOptions"><short>Set of options for the user to enable/disable features in the preview dialog</short><descr><ul><li><var>ppoNavigationBtns</var> - Enables/disables page navigation in the preview.</li><li><var>ppoNavigationEdit</var> - Shows/hides the edit control in the preview toolbar with which the user can navigate to a specific page of the preview.</li><li><var>ppoZoomBtns</var> - Enables/disables zooming in the preview.</li><li><var>ppoPageOrientationBtns</var> - Enables/disables selection of page orientation.</li><li><var>ppoMarginsBtn</var> - Enables/disables page margin selection in the preview</li><li><var>ppoHeaderFooterBtn</var> - Enables/disables the possibility to set up the header and footer in a dialog.</li><li><var>ppoPrintOrderBtns</var> - Enables/disables the possibility to define the order of pages when the entire print-out does not fit onto a single page of paper.</li><li><var>ppoCenterBtns</var> - Shows/hides the buttons to center the grid on the printed page.</li><li><var>ppoScalePrinterBtn</var> - Shows/hides the button to scale the printer output manually or to force a given count of pages onto a single sheet.</li><li><var>ppoPageSetupBtn</var> - Shows/hides a toolbar button with a dropdown menu containing options to control the page layout (page orientation, margin selection, etc).</li><li><var>ppoPageNumberInfo</var> - Shows/hides the display of page number and total page count in the preview form.</li><li><var>ppoZoomLevelInfo</var> - Shows/hides the display of the preview zoom level (percentage) in the preview form.</li>
|
|
</ul>
|
|
</descr>
|
|
</element><element name="TGridPrintPreviewForm"><short>Form class created by the <var>TGridPrintPreviewDialog</var> to display the preview of the grid to be printed by the <var>TGridPrinter</var>.</short>
|
|
</element><element name="InRange"><short>Helper function which returns true when X1 is in the range between X2-Delta and X2+Delta</short>
|
|
</element><element name="EnsureRange"><descr>Helper function which returns
|
|
<ul><li><var>X</var> if it is in the range between <var>X1</var> and <var>X2</var>,</li><li><var>X1</var> if <var>X</var> is less than <var>X1</var>, or</li><li><var>X2</var> if <var>X</var> is greater than <var>X2</var>
|
|
</li>
|
|
</ul>
|
|
</descr>
|
|
</element><element name="MarkAsChecked"><short>Helper function which appends a checkmark to the given menu caption string if <var>AEnable</var> is true. Meant to better show the checked state of menu items having icons.</short>
|
|
</element>
|
|
</module>
|
|
</package>
|
|
</fpdoc-descriptions>
|