Skip to content

Commit 223f5cc

Browse files
committed
Merge branch 'about'
2 parents b996659 + d66c0d2 commit 223f5cc

30 files changed

+171
-111
lines changed

AboutBox/3.6/API.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# [About Box Component](../index.md) Programmers' Guide
2+
3+
**Applies to:** ~>3.6
4+
5+
## Introduction
6+
7+
This section of the _About Box Component_ documentation describes the API exposed by the unit to programmers.
8+
9+
## Contents
10+
11+
### Units
12+
13+
| Unit | Descriptions |
14+
|:-----|:-------------|
15+
| _PJAbout_ | The only unit in this project. Contains all the types and routines noted below. |
16+
17+
### Classes
18+
19+
| Class | Descriptions |
20+
|:------|:-------------|
21+
| [_TPJAboutBoxDlg_](./API/TPJAboutBoxDlg.md) | The About Box component. |
22+
| _TPJAboutBoxForm_ | ⛔ The form class that implements the actual about box. This class **must not** be accessed directly and is not documented here. |
23+
24+
### Enumerated Types
25+
26+
| Type | Descriptions |
27+
|:-----|:-------------|
28+
| _TPJAboutBtnPlacing_ | Determines horizontal placement of OK button in about dialog. This is the type of the [_ButtonPlacing_](./API/TPJAboutBoxDlg-ButtonPlacing.md) property. |
29+
| _TPJAboutBtnKinds_ | Determines caption of about dialog's OK button. This is the type of the [_ButtonKind_](./API/TPJAboutBoxDlg-ButtonKind.md) property. |
30+
| _TPJAboutBtnGlyphs_ | Determines what, if any, glyph is displayed on about dialog's OK button. This is the type of the [_ButtonGlyph_](./API/TPJAboutBoxDlg-ButtonGlyph.md) property. |
31+
| _TPJAboutPosition_ | Determines whether about dialog's position (centred or offset) is relative to screen, desktop or owning form. This is the type of the [_Position_](./API/TPJAboutBoxDlg-Position.md) property. |
32+
33+
### Other
34+
35+
| Item | Description |
36+
|:-----|:------------|
37+
| _Register_ | ⛔ Component registration routine, called by the Delphi IDE to register the component. **Do not call**. |
38+
39+
## Conventions
40+
41+
This documentation complies with [these conventions](../../common/conventions.md).
42+
43+
## Links
44+
45+
* [Overview](./Overview.md)

Docs/AboutBox/API/TPJAboutBoxDlg-ButtonGlyph.md renamed to AboutBox/3.6/API/TPJAboutBoxDlg-ButtonGlyph.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
**Class:** [_TPJAboutBoxDlg_](./TPJAboutBoxDlg.md)
88

9+
**Applies to:** ~>3.6
10+
911
```pascal
1012
property ButtonGlyph: TPJAboutBtnGlyphs;
1113
@@ -19,7 +21,7 @@ type TPJAboutBtnGlyphs = (
1921
The About box contains one button which is used to close the dialog box. The button can display a glyph (bitmap) to indicate its use. This property is used to determine which (if any) glyph to display. Valid values for the property and their meanings are as follows:
2022

2123
| Value | Meaning |
22-
|-----------|-------------|
24+
|:----------|:------------|
2325
| _abgOK_ | A green check mark appears on the button face. |
2426
| _abgCancel_ | A red cross appears on the button face. |
2527
| _abgIgnore_ | A green man walking away appears on the button face. |

Docs/AboutBox/API/TPJAboutBoxDlg-ButtonHeight.md renamed to AboutBox/3.6/API/TPJAboutBoxDlg-ButtonHeight.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
**Class:** [_TPJAboutBoxDlg_](./TPJAboutBoxDlg.md)
88

9+
**Applies to:** ~>3.6
10+
911
```pascal
1012
property ButtonHeight: Integer;
1113
```

Docs/AboutBox/API/TPJAboutBoxDlg-ButtonKind.md renamed to AboutBox/3.6/API/TPJAboutBoxDlg-ButtonKind.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
**Class:** [_TPJAboutBoxDlg_](./TPJAboutBoxDlg.md)
88

9+
**Applies to:** ~>3.6
10+
911
```pascal
1012
property ButtonKind: TPJAboutBtnKinds;
1113
@@ -19,7 +21,7 @@ type TPJAboutBtnKinds = (
1921
The About box contains one button which is used to close the dialog box. The button can display different text to indicate its use. The _ButtonKind_ property is used to determine which text to display. Valid values for the property and their meanings are as follows:
2022

2123
| Value | Text |
22-
|-----------|----------|
24+
|:----------|:---------|
2325
| _abkOK_ | `OK` |
2426
| _abkDone_ | `Done` |
2527
| _abkClose_ | `Close` |

Docs/AboutBox/API/TPJAboutBoxDlg-ButtonPlacing.md renamed to AboutBox/3.6/API/TPJAboutBoxDlg-ButtonPlacing.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
**Class:** [_TPJAboutBoxDlg_](./TPJAboutBoxDlg.md)
88

9+
**Applies to:** ~>3.6
10+
911
```pascal
1012
property ButtonPlacing: TPJAboutBtnPlacing;
1113
@@ -17,7 +19,7 @@ type TPJAboutBtnPlacing = (abpLeft, abpCentre, abpRight);
1719
The About box contains one button which is used to close the dialog box. The button is positioned at the bottom of the dialog box, but can be aligned left, centre or right. The _ButtonPlacing_ property is used to determine which position the button occupies. Valid values for the property and their meanings are as follows:
1820

1921
| Value | Meaning |
20-
|-----------|-------------|
22+
|:----------|:------------|
2123
| _abpLeft_ | Display the button at the bottom left of the dialog box. |
2224
| _abpCentre_ | Display the button at the bottom centre of the dialog box. |
2325
| _abpRight_ | Display the button at the bottom right of the dialog box. |

Docs/AboutBox/API/TPJAboutBoxDlg-ButtonWidth.md renamed to AboutBox/3.6/API/TPJAboutBoxDlg-ButtonWidth.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
**Class:** [_TPJAboutBoxDlg_](./TPJAboutBoxDlg.md)
88

9+
**Applies to:** ~>3.6
10+
911
```pascal
1012
property ButtonWidth: Integer;
1113
```

Docs/AboutBox/API/TPJAboutBoxDlg-CentreDlg.md renamed to AboutBox/3.6/API/TPJAboutBoxDlg-CentreDlg.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
**Class:** [_TPJAboutBoxDlg_](./TPJAboutBoxDlg.md)
88

9+
**Applies to:** ~>3.6
10+
911
```pascal
1012
property CentreDlg: Boolean;
1113
```

Docs/AboutBox/API/TPJAboutBoxDlg-Copyright.md renamed to AboutBox/3.6/API/TPJAboutBoxDlg-Copyright.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
**Class:** [_TPJAboutBoxDlg_](./TPJAboutBoxDlg.md)
88

9+
**Applies to:** ~>3.6
10+
911
```pascal
1012
property Copyright: string;
1113
```

Docs/AboutBox/API/TPJAboutBoxDlg-DlgLeft.md renamed to AboutBox/3.6/API/TPJAboutBoxDlg-DlgLeft.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
**Class:** [_TPJAboutBoxDlg_](./TPJAboutBoxDlg.md)
88

9+
**Applies to:** ~>3.6
10+
911
```pascal
1012
property DlgLeft: Integer;
1113
```

Docs/AboutBox/API/TPJAboutBoxDlg-DlgTop.md renamed to AboutBox/3.6/API/TPJAboutBoxDlg-DlgTop.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
**Class:** [_TPJAboutBoxDlg_](./TPJAboutBoxDlg.md)
88

9+
**Applies to:** ~>3.6
10+
911
```pascal
1012
property DlgTop: Integer;
1113
```

0 commit comments

Comments
 (0)