Skip to content
This repository was archived by the owner on Dec 27, 2025. It is now read-only.

Commit 2d20b9a

Browse files
committed
Update some document files
1 parent 60e6ef9 commit 2d20b9a

6 files changed

Lines changed: 40 additions & 12 deletions

File tree

Docs/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
Content
2+
=======
3+
The `PrintPreview` unit provides the following components:
4+
5+
- **[TPrintPreview](TPrintPreview.md)** \
6+
Generates, displays, manages, and prints pages.
7+
8+
- **[TThumbnailPreview](TThumbnailPreview.md)** \
9+
Displays the list of pages generated by a [TPrintPreview](TPrintPreview.md) component as thumbnails.
10+
11+
- **[TPaperPreview](TPaperPreview.md)** \
12+
Represents a sheet of paper.
13+
14+
In addition, the unit defines some [utility procedures and functions](Globals.md).

Docs/TPaperPreview.Events.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ In addition to the standard events of Delphi's `TCustomControl` control, the [TP
77
`TPaperPaintEvent = procedure(Sender: TObject; Canvas: TCanvas; const Rect: TRect) of object` \
88
Occurs when the content of paper needs to be painted.
99

10-
Because the control caches the last paint, you need to call one of the `Invalidate` or `Repaint` methods to enforce occurrence of this event.
10+
Because the control caches the last paint, an application needs to call one of the `Invalidate` or `Repaint` methods to enforce the occurrence of this event.

Docs/TPrintPreview.Events.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,15 @@ In addition to the standard events of Delphi's `TScrollBox` control, the [TPrint
55

66
- **`OnAnnotation: TPreviewPageDrawEvent`** \
77
`TPreviewPageDrawEvent = procedure(Sender: TObject; PageNo: Integer; Canvas: TCanvas) of object ` \
8-
When `Annotation` property is `true`, occurs after a page is displayed. The items drawn on the provided canvas will appear over the preview page, but do not appear on print.
8+
Occurs after a page is displayed if the `Annotation` property is `true`.
9+
10+
The items drawn on the provided canvas will appear over the preview page, but do not appear on print.
911

1012
- **`OnBackground: TPreviewPageDrawEvent`** \
1113
`TPreviewPageDrawEvent = procedure(Sender: TObject; PageNo: Integer; Canvas: TCanvas) of object` \
12-
When `Background` property is `true`, occurs just before a page being displayed. The items drawn on the provided canvas will appear under the preview page, but do not appear on print.
14+
Occurs just before a page being displayed if the `Background` property is `true`.
15+
16+
The items drawn on the provided canvas will appear under the preview page, but do not appear on print.
1317

1418
- **`OnBeginDoc: TNotifyEvent`** \
1519
Occurs when `BeginDoc` method is called.
@@ -43,12 +47,16 @@ In addition to the standard events of Delphi's `TScrollBox` control, the [TPrint
4347

4448
- **`OnProgress: TPreviewProgressEvent`** \
4549
`TPreviewProgressEvent = procedure(Sender: TObject; Done, Total: Integer) of object` \
46-
Occurs periodically during the print and save as PDF/TIFF operations. You can check the value of `State` property to determine which operation is generating this event.
50+
Occurs periodically during the print and save as PDF/TIFF operations.
51+
52+
An application can check the value of the `State` property to determine which operation is in progress.
4753

4854
- **`OnPageProcessing: TPreviewPageProcessingEvent`** \
4955
`TPreviewPageProcessingEvent = procedure(Sender: TObject; PageNo: Integer; var Choice: TPageProcessingChoice) of object` \
5056
`TPageProcessingChoice = (pcAccept, pcIgnore, pcCancelAll)` \
51-
Occurs just before processing a page during the print and save as PDF/TIFF operations. You can check the value of `State` property to determine which operation is generating this event.
57+
Occurs just before processing a page during the print and save as PDF/TIFF operations.
58+
59+
An application can check the value of the `State` property to determine which operation is in progress.
5260

5361
The `Choice` parameter can be set to one of the following values:
5462

@@ -60,8 +68,12 @@ In addition to the standard events of Delphi's `TScrollBox` control, the [TPrint
6068

6169
- **`OnPrintAnnotation: TPreviewPageDrawEvent`** \
6270
`TPreviewPageDrawEvent = procedure(Sender: TObject; PageNo: Integer; Canvas: TCanvas) of object` \
63-
When `Annotation` property is `true`, occurs after a page is printed. The items drawn on the provided canvas will place over the printed page.
71+
Occurs after a page is printed if the `Annotation` property is `true`.
72+
73+
The items drawn on the provided canvas will place over the printed page.
6474

6575
- **`OnPrintBackground: TPreviewPageDrawEvent`** \
6676
`TPreviewPageDrawEvent = procedure(Sender: TObject; PageNo: Integer; Canvas: TCanvas) of object` \
67-
When Background property is `true`, occurs just before a page being printed. The items drawn on the provided canvas will place under the printed page.
77+
Occurs just before a page being printed if the `Background` property is `true`.
78+
79+
The items drawn on the provided canvas will place under the printed page.

Docs/TPrintPreview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Here are the key features of the [TPrintPreview](TPrintPreview.md) control:
2020
- allows inserting, replacing, editing, deleting, and reordering of pages freely at any time
2121
- can save pages as PDF document by using [Synopse PDF Engine](https://github.com/synopse/SynPDF) or [dsPDF Library](https://torry.net/authorsmore.php?id=2851)
2222
- can save pages as multi-frame TIFF image.
23-
- has a complete set of events
23+
- has a complete set of properties and events
2424

2525
See:
2626
- [Properties](TPrintPreview.Properties.md)

Docs/TThumbnailPreview.Events.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,14 @@ In addition to the standard events of Delphi's `TCustomListView` control, the [T
2121

2222
- **`OnPageInfoTip: TPageInfoTipEvent`** \
2323
`TPageInfoTipEvent = procedure(Sender: TObject; PageNo: Integer; var InfoTip: String) of object` \
24-
Occurs when the mouse pointer moves over a thumbnail. The event handler can use the `InfoTip` parameter to specify a text to be shown over the thumbnail.
24+
Occurs when the mouse pointer moves over a thumbnail.
25+
26+
The event handler can use the `InfoTip` parameter to specify a text to be shown over the thumbnail.
2527

2628
- **`OnPageSelect: TPageNotifyEvent`** \
2729
`TPageNotifyEvent = procedure(Sender: TObject; PageNo: Integer) of object` \
2830
Occurs when a page gets selected.
2931

3032
- **`OnPageUnselect: TPageNotifyEvent`** \
3133
`TPageNotifyEvent = procedure(Sender: TObject; PageNo: Integer) of object` \
32-
Occurs when a selected page becomes deselected.
34+
Occurs when a selected page gets deselected.

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ The print preview components consist of three visual components for low level pr
1313
![TThumbnailPreview](Images/preview2.png)
1414

1515
- **[TPaperPreview](Docs/TPaperPreview.md)** \
16-
This control represents a sheet of paper that can be painted by a custom event handler.
16+
This control represents a sheet of paper that an application can draw directly on its canvas.
1717

1818
![TPaperPreview](Images/preview3.png)
1919

20-
All the print preview components are fully customizable and have a comprehensive set of events.
20+
All the print preview components are fully customizable and have a comprehensive set of properties and events.
2121

2222
Installation
2323
============

0 commit comments

Comments
 (0)