Skip to content

Commit 2f5f137

Browse files
committed
Fix up links re change of file names and directories
Moving files from Docs/ folder to HotLabel/ folder and subfolders along with renaming of numerous files meant that internal links within documentation pages changed.
1 parent e9dbc08 commit 2f5f137

20 files changed

+105
-105
lines changed

HotLabel/2/API/EPJURLError.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# EPJURLError #
22

3-
**Project:** [Hot Label Component](HotLabelComponent.md).
3+
**Project:** [Hot Label Component](../API.md).
44

55
**Unit:** _PJHotLabel_.
66

7-
Exceptions of this class are used to report URL related errors by _[TPJHotLabel](TPJHotLabel.md)_. The exceptions are raised either when URLs fail validation or when default browsers or mail clients can't be started.
7+
Exceptions of this class are used to report URL related errors by _[TPJHotLabel](../API/TPJHotLabel.md)_. The exceptions are raised either when URLs fail validation or when default browsers or mail clients can't be started.
88

99
_EPJURLError_ inherits directly from _Exception_ and adds no new methods, properties or events.

HotLabel/2/API/TPJHotLabel-Caption.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Caption property #
22

3-
**Project:** [Hot Label Component](HotLabelComponent.md).
3+
**Project:** [Hot Label Component](../API.md).
44

55
**Unit:** _PJHotLabel_.
66

7-
**Class:** _[TPJHotLabel](TPJHotLabel.md)_
7+
**Class:** _[TPJHotLabel](../API/TPJHotLabel.md)_
88

99
```pascal
1010
property Caption: TCaption;
@@ -14,11 +14,11 @@ property Caption: TCaption;
1414

1515
This property specifies a text string that that may be displayed in the label.
1616

17-
Use _Caption_ to set the text displayed in the label. If the _[CaptionIsURL](TPJHotLabelCaptionIsURL.md)_ property is `True` then the _Caption_ and _[URL](TPJHotLabelURL.md)_ properties are equivalent, i.e. assigning a value to one will also assign the the same value to the other. This makes it easy to display the URL in the label itself. To display text on the label that is different to the URL make sure that the _[CaptionIsURL](TPJHotLabelCaptionIsURL.md)_ property is `False`.
17+
Use _Caption_ to set the text displayed in the label. If the _[CaptionIsURL](../API/TPJHotLabel-CaptionIsURL.md)_ property is `True` then the _Caption_ and _[URL](../API/TPJHotLabel-URL.md)_ properties are equivalent, i.e. assigning a value to one will also assign the the same value to the other. This makes it easy to display the URL in the label itself. To display text on the label that is different to the URL make sure that the _[CaptionIsURL](../API/TPJHotLabel-CaptionIsURL.md)_ property is `False`.
1818

19-
For reasons of backward compatibilty with earlier versions of the component the default behaviour is for the _Caption_ property to display the URL (i.e. _[CaptionIsURL](TPJHotLabelCaptionIsURL.md)_ is `True` by default).
19+
For reasons of backward compatibilty with earlier versions of the component the default behaviour is for the _Caption_ property to display the URL (i.e. _[CaptionIsURL](../API/TPJHotLabel-CaptionIsURL.md)_ is `True` by default).
2020

21-
If the _[ValidateURL](TPJHotLabelValidateURL.md)_ and _[CaptionIsURL](TPJHotLabelCaptionIsURL.md)_ properties are both `True` then any text assigned to the _Caption_ property must be a valid URL or an exception will be raised.
21+
If the _[ValidateURL](../API/TPJHotLabel-ValidateURL.md)_ and _[CaptionIsURL](../API/TPJHotLabel-CaptionIsURL.md)_ properties are both `True` then any text assigned to the _Caption_ property must be a valid URL or an exception will be raised.
2222

2323
_Caption_'s behaviour with regard to accelerator characters and the ampersand (`&`) is identical to that of _TLabel_. See Delphi help for further information.
2424

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
# CaptionIsURL property #
22

3-
**Project:** [Hot Label Component](HotLabelComponent.md).
3+
**Project:** [Hot Label Component](../API.md).
44

55
**Unit:** _PJHotLabel_.
66

7-
**Class:** _[TPJHotLabel](TPJHotLabel.md)_
7+
**Class:** _[TPJHotLabel](../API/TPJHotLabel.md)_
88

99
```pascal
1010
property CaptionIsURL: Boolean;
1111
```
1212

1313
## Description ##
1414

15-
The _CaptionIsURL_ property is used to determine whether the _[Caption](TPJHotLabelCaption.md)_ property displays the URL assigned to the _[URL](TPJHotLabelURL.md)_ property or whether it can display descriptive text.
15+
The _CaptionIsURL_ property is used to determine whether the _[Caption](../API/TPJHotLabel-Caption.md)_ property displays the URL assigned to the _[URL](../API/TPJHotLabel-URL.md)_ property or whether it can display descriptive text.
1616

17-
Set _CaptionIsURL_ to `True` to link the _[Caption](TPJHotLabelCaption.md)_ property to the _[URL](TPJHotLabelURL.md)_ property - so that assigning one property also assigns the other. This makes it easy to display a URL in the label without assigning two properties with the same value.
17+
Set _CaptionIsURL_ to `True` to link the _[Caption](../API/TPJHotLabel-Caption.md)_ property to the _[URL](../API/TPJHotLabel-URL.md)_ property - so that assigning one property also assigns the other. This makes it easy to display a URL in the label without assigning two properties with the same value.
1818

19-
Setting _CaptionIsURL_ to `False` enables any text to be assigned to the _[Caption](TPJHotLabelCaption.md)_ property. This permits descriptive text to be displayed in the label that accesses the separately stored URL when the label is clicked. **Tip:** to give the user visual feedback of the actual URL when the mouse hovers over the label set the _[HintStyle](TPJHotLabelHintStyle.md)_ property to `hsURL`.
19+
Setting _CaptionIsURL_ to `False` enables any text to be assigned to the _[Caption](../API/TPJHotLabel-Caption.md)_ property. This permits descriptive text to be displayed in the label that accesses the separately stored URL when the label is clicked. **Tip:** to give the user visual feedback of the actual URL when the mouse hovers over the label set the _[HintStyle](../API/TPJHotLabel-HintStyle.md)_ property to `hsURL`.
2020

2121
The default value of _CaptionIsURL_ is `True`.

HotLabel/2/API/TPJHotLabel-Cursor.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Cursor property #
22

3-
**Project:** [Hot Label Component](HotLabelComponent.md).
3+
**Project:** [Hot Label Component](../API.md).
44

55
**Unit:** _PJHotLabel_.
66

7-
**Class:** _[TPJHotLabel](TPJHotLabel.md)_
7+
**Class:** _[TPJHotLabel](../API/TPJHotLabel.md)_
88

99
```pascal
1010
property Cursor: TCursor;
@@ -18,6 +18,6 @@ Change the value of _Cursor_ to provide feedback to the user about what action i
1818

1919
The value of _Cursor_ is the index of the cursor in the list of cursors maintained by the global variable, _Screen_. In addition to the built-in cursors provided by _TScreen_, applications can add custom cursors to the list. See the inherited _Cursor_ property of _TControl_ for further details.
2020

21-
The _Cursor_ property of _[TPJHotLabel](TPJHotLabel.md)_ differs from the inherited property in that its default cursor is `crHandPoint` rather than `crDefault`.
21+
The _Cursor_ property of _[TPJHotLabel](../API/TPJHotLabel.md)_ differs from the inherited property in that its default cursor is `crHandPoint` rather than `crDefault`.
2222

2323
**Note:** Earlier versions of the component used a custom cursor named `crHand`. For backward compatibility this constant is defined in the _PJHotLabel_ unit to have the same value as `crHandPoint`.

HotLabel/2/API/TPJHotLabel-Font.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Font property #
22

3-
**Project:** [Hot Label Component](HotLabelComponent.md).
3+
**Project:** [Hot Label Component](../API.md).
44

55
**Unit:** _PJHotLabel_.
66

7-
**Class:** _[TPJHotLabel](TPJHotLabel.md)_
7+
**Class:** _[TPJHotLabel](../API/TPJHotLabel.md)_
88

99
```pascal
1010
property Font: TFont;
@@ -14,12 +14,12 @@ property Font: TFont;
1414

1515
_Font_ controls the attributes font used to display the label when it is not highlighted.
1616

17-
<sup>[v2.2]</sup> At run-time the _Font_ property is only displayed if the _[Visited](TPJHotLabelVisited.md)_<sup>[v2.2]</sup> property is `False`, otherwise the label's display font is that specified by the _[VisitedFont](TPJHotLabelVisitedFont.md)_<sup>[v2.2]</sup> property.
17+
<sup>[v2.2]</sup> At run-time the _Font_ property is only displayed if the _[Visited](../API/TPJHotLabel-Visited.md)_<sup>[v2.2]</sup> property is `False`, otherwise the label's display font is that specified by the _[VisitedFont](../API/TPJHotLabel-VisitedFont.md)_<sup>[v2.2]</sup> property.
1818

1919
To change to a new font, specify a new _TFont_ object. To modify a font, change the value of the _Color_, _Height_, _Name_, _Pitch_, _Size_, or _Style_ of the _TFont_ object.
2020

21-
The default value of _[TPJHotLabel](TPJHotLabel.md)_'s _Font_ property is different from that of the inherited property: the font _Color_ defaults to `clNavy` and the font _Style_ defaults to `[fsUnderline]`. The other attributes are those of the parent control when the component was first dropped on the form.
21+
The default value of _[TPJHotLabel](../API/TPJHotLabel.md)_'s _Font_ property is different from that of the inherited property: the font _Color_ defaults to `clNavy` and the font _Style_ defaults to `[fsUnderline]`. The other attributes are those of the parent control when the component was first dropped on the form.
2222

23-
Since the default font attributes are likely to be different to those of the inherited _Font_ property the _[ParentFont](TPJHotLabelParentFont.md)_ property defaults to `False` rather than `True` in the ancestor property. This means that any change to the parent control's font will not be echoed in this component.
23+
Since the default font attributes are likely to be different to those of the inherited _Font_ property the _[ParentFont](../API/TPJHotLabel-ParentFont.md)_ property defaults to `False` rather than `True` in the ancestor property. This means that any change to the parent control's font will not be echoed in this component.
2424

2525
Note that _Font_ is always used as the component's display font at design time.
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# HighlightFont property #
22

3-
**Project:** [Hot Label Component](HotLabelComponent.md).
3+
**Project:** [Hot Label Component](../API.md).
44

55
**Unit:** _PJHotLabel_.
66

7-
**Class:** _[TPJHotLabel](TPJHotLabel.md)_
7+
**Class:** _[TPJHotLabel](../API/TPJHotLabel.md)_
88

99
```pascal
1010
property HighlightFont: TFont;
@@ -14,8 +14,8 @@ property HighlightFont: TFont;
1414

1515
This property controls the appearance of the label when the mouse passes over it.
1616

17-
A _[TPJHotLabel](TPJHotLabel.md)_ can highlight its text when the mouse passes over the control. The font that is used to highlight the text is determined by the _HighlightFont_ property. The property defaults to the same font as the _[Font](TPJHotLabelFont.md)_ property but with the colour changed to `clRed`.
17+
A _[TPJHotLabel](../API/TPJHotLabel.md)_ can highlight its text when the mouse passes over the control. The font that is used to highlight the text is determined by the _HighlightFont_ property. The property defaults to the same font as the _[Font](../API/TPJHotLabel-Font.md)_ property but with the colour changed to `clRed`.
1818

19-
Note that the highlighting only takes place when the _[HighlightURL](TPJHotLabelHighlightURL.md)_ property is `True`.
19+
Note that the highlighting only takes place when the _[HighlightURL](../API/TPJHotLabel-HighlightURL.md)_ property is `True`.
2020

21-
It is recommended that only the colour and certain styles of the font are altered and the font size and name remain unchanged so that the label does not grow and shrink when the cursor passes over it. See the [highlighting example](HotLabelExample1.md) for details of two suitable designs.
21+
It is recommended that only the colour and certain styles of the font are altered and the font size and name remain unchanged so that the label does not grow and shrink when the cursor passes over it. See the [highlighting example](../Examples/Example1.md) for details of two suitable designs.

HotLabel/2/API/TPJHotLabel-HighlightURL.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# HighlightURL property #
22

3-
**Project:** [Hot Label Component](HotLabelComponent.md).
3+
**Project:** [Hot Label Component](../API.md).
44

55
**Unit:** _PJHotLabel_.
66

7-
**Class:** _[TPJHotLabel](TPJHotLabel.md)_
7+
**Class:** _[TPJHotLabel](../API/TPJHotLabel.md)_
88

99
```pascal
1010
property HighlightURL: Boolean;

HotLabel/2/API/TPJHotLabel-Hint.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Hint property #
22

3-
**Project:** [Hot Label Component](HotLabelComponent.md).
3+
**Project:** [Hot Label Component](../API.md).
44

55
**Unit:** _PJHotLabel_.
66

7-
**Class:** _[TPJHotLabel](TPJHotLabel.md)_
7+
**Class:** _[TPJHotLabel](../API/TPJHotLabel.md)_
88

99
```pascal
1010
property Hint: string;
@@ -14,4 +14,4 @@ property Hint: string;
1414

1515
_Hint_ contains a text string that can appear when the user moves the mouse over the control.
1616

17-
With one exception, the _Hint_ property of _[TPJHotLabel](TPJHotLabel.md)_ operates in the same way as the inherited property. The exception is that the _[HintStyle](TPJHotLabelHintStyle.md)_ property can change the source of the hint's text. The hint text can be taken from the _[URL](TPJHotLabelURL.md)_ property or a custom value can be supplied by handling the _[OnCustomHint](TPJHotLabelOnCustomHint.md)_ event. If the _[URL](TPJHotLabelURL.md)_ property value is used _Hint_ is ignored. If custom hints are used, the value of the _Hint_ property is supplied to the event handler for modification.
17+
With one exception, the _Hint_ property of _[TPJHotLabel](../API/TPJHotLabel.md)_ operates in the same way as the inherited property. The exception is that the _[HintStyle](../API/TPJHotLabel-HintStyle.md)_ property can change the source of the hint's text. The hint text can be taken from the _[URL](../API/TPJHotLabel-URL.md)_ property or a custom value can be supplied by handling the _[OnCustomHint](../API/TPJHotLabel-OnCustomHint.md)_ event. If the _[URL](../API/TPJHotLabel-URL.md)_ property value is used _Hint_ is ignored. If custom hints are used, the value of the _Hint_ property is supplied to the event handler for modification.

HotLabel/2/API/TPJHotLabel-HintStyle.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# HintStyle property #
22

3-
**Project:** [Hot Label Component](HotLabelComponent.md).
3+
**Project:** [Hot Label Component](../API.md).
44

55
**Unit:** _PJHotLabel_.
66

7-
**Class:** _[TPJHotLabel](TPJHotLabel.md)_
7+
**Class:** _[TPJHotLabel](../API/TPJHotLabel.md)_
88

99
```pascal
1010
type
@@ -19,9 +19,9 @@ The _HintStyle_ property determines how the text displayed in the component's po
1919

2020
| **Style** | **Notes** |
2121
|:----------|:----------|
22-
| `hsNormal` | The pop-up hint displays as normal - i.e. the hint's text is taken from the _[Hint](TPJHotLabelHint.md)_ property. |
23-
| `hsURL` | The pop-up hint displays the _[URL](TPJHotLabelURL.md)_ property value. The _[Hint](TPJHotLabelHint.md)_ property is ignored. |
24-
| `hsCustom` | The user can specify a custom hint by handling the _[OnCustomHint](TPJHotLabelOnCustomHint.md)_ event. See the _[OnCustomHint](TPJHotLabelOnCustomHint.md)_ topic for details of how the hint is set in the event handler. If the _[OnCustomHint](TPJHotLabelOnCustomHint.md)_ event is not handled then the hint's text comes from the _[Hint](TPJHotLabelHint.md)_ property as normal. |
22+
| `hsNormal` | The pop-up hint displays as normal - i.e. the hint's text is taken from the _[Hint](../API/TPJHotLabel-Hint.md)_ property. |
23+
| `hsURL` | The pop-up hint displays the _[URL](../API/TPJHotLabel-URL.md)_ property value. The _[Hint](../API/TPJHotLabel-Hint.md)_ property is ignored. |
24+
| `hsCustom` | The user can specify a custom hint by handling the _[OnCustomHint](../API/TPJHotLabel-OnCustomHint.md)_ event. See the _[OnCustomHint](../API/TPJHotLabel-OnCustomHint.md)_ topic for details of how the hint is set in the event handler. If the _[OnCustomHint](../API/TPJHotLabel-OnCustomHint.md)_ event is not handled then the hint's text comes from the _[Hint](../API/TPJHotLabel-Hint.md)_ property as normal. |
2525

2626
Note that no pop-up hint will display unless hints are enabled. This is done by ensuring the inherited _ShowHint_ property is `True`.
2727

HotLabel/2/API/TPJHotLabel-OnCustomHint.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# OnCustomHint event #
22

3-
**Project:** [Hot Label Component](HotLabelComponent.md).
3+
**Project:** [Hot Label Component](../API.md).
44

55
**Unit:** _PJHotLabel_.
66

7-
**Class:** _[TPJHotLabel](TPJHotLabel.md)_
7+
**Class:** _[TPJHotLabel](../API/TPJHotLabel.md)_
88

99
```pascal
1010
type
@@ -19,8 +19,8 @@ property OnCustomHint: TPJHLCustomHintEvent;
1919

2020
_OnCustomHint_ is an event that enables the user to specify a custom hint to be displayed by the component.
2121

22-
This event is triggered only when the _[HintStyle](TPJHotLabelHintStyle.md)_ property is set to `hsCustom` and a hint is about to be displayed. Handling the event enables the user to specify the text that is displayed in the pop-up hint. The event handler is passed the current _[Hint](TPJHotLabelHint.md)_ property value in the _HintStr_ parameter. Specify the hint text by setting _HintStr_ to the required value.
22+
This event is triggered only when the _[HintStyle](../API/TPJHotLabel-HintStyle.md)_ property is set to `hsCustom` and a hint is about to be displayed. Handling the event enables the user to specify the text that is displayed in the pop-up hint. The event handler is passed the current _[Hint](../API/TPJHotLabel-Hint.md)_ property value in the _HintStr_ parameter. Specify the hint text by setting _HintStr_ to the required value.
2323

24-
If _[HintStyle](TPJHotLabelHintStyle.md)_ is `hsCustom` and the event is not handled then the value of the _[Hint](TPJHotLabelHint.md)_ property is displayed as normal.
24+
If _[HintStyle](../API/TPJHotLabel-HintStyle.md)_ is `hsCustom` and the event is not handled then the value of the _[Hint](../API/TPJHotLabel-Hint.md)_ property is displayed as normal.
2525

26-
See the [Using the OnCustomHint event](HotLabelExample2.md) example for one possible use of the _OnCustomHint_ event.
26+
See the [Using the OnCustomHint event](../Examples/Example2.md) example for one possible use of the _OnCustomHint_ event.

0 commit comments

Comments
 (0)