From c5a1d3a3d981d6ecf14053b16190d8ba09274ff8 Mon Sep 17 00:00:00 2001 From: kirkpatc Date: Fri, 9 May 2008 11:20:33 +0000 Subject: [PATCH] FPDoc - some minor edits to TCustomForm in Forms.xml git-svn-id: trunk@15082 - --- docs/xml/lcl/forms.xml | 37 ++++++++++++++++++++++++------------- 1 file changed, 24 insertions(+), 13 deletions(-) diff --git a/docs/xml/lcl/forms.xml b/docs/xml/lcl/forms.xml index 60e82a5abb..3b4efa72ed 100644 --- a/docs/xml/lcl/forms.xml +++ b/docs/xml/lcl/forms.xml @@ -2923,9 +2923,9 @@ biHelp - When you click this button a Question Cursor appears and the help routi - Asks every visible control to ExecuteAction the action ExeAction. + Asks every visible control to Execute the specified action ExeAction. -

DoExecuteAction asks every visible control to ExecuteAction the action ExeAction. If some control executes it and returns true, then the traversal of visible components is stopped. All child controls (and its childs etc) are queried too.

+

DoExecuteAction asks every visible control to Execute the specified action ExeAction. If some control executes it and returns true, then the traversal of visible components is stopped. All child controls (and its children etc) are queried too.

For example you have

TForm TPanel @@ -3293,7 +3293,8 @@ biHelp - When you click this button a Question Cursor appears and the help routi - + + IsShortcut - if True, the specified Key and Message are active as a shortcut @@ -6503,7 +6504,8 @@ biHelp - When you click this button a Question Cursor appears and the help routi Create Form or any other kind of component Note: The name is confusing and only kept for Delphi compatibility.
-It can actually create any kind of component

+It can actually create any kind of component
+
Creates a Component instance, sets the pointer to the component variable and loads the component.
@@ -6775,9 +6777,11 @@ It also writes details of the exception to the appropriate place for debugging.< Result - Result: integer value returned by the function to signify which box was selected

+ Result: integer value returned by the function to signify which box was selected
+
-Can be one of the following values:

+Can be one of the following values:
+
IDOK
@@ -6814,9 +6818,11 @@ Can be one of the following values:

Flags: longint - an integer constructed by adding together various constants to define the contents and behaviour of the box, for example
MB_ABORTRETRYIGNORE + MR_ICONQUESTION will cause the application to display a query (?) icon in a box with three buttons:
-ABORT RETRY IGNORE.

+ABORT RETRY IGNORE.
+
-The following button constants are available:

+The following button constants are available:
+
MB_OK
@@ -6828,9 +6834,11 @@ The following button constants are available:

MB_YESNO
- MB_RETRYCANCEL

+ MB_RETRYCANCEL
+
-And the following icon constants:

+And the following icon constants:
+
MB_ICONHAND
@@ -6846,7 +6854,8 @@ And the following icon constants:

MB_ICONSTOP = MB_ICONHAND
- MB_ICONINFORMATION = MB_ICONASTERICK

+ MB_ICONINFORMATION = MB_ICONASTERICK
+
These constants are declared on the LCLType unit. @@ -7608,7 +7617,8 @@ These constants are declared on the LCLType unit. The hint associated with the main application - A hint is a small pop-up mesage that appears briefly while the mouse hovers over a specified area of the screen. It usually displays useful information about how to use an object or what data should be entered, etc

+ A hint is a small pop-up mesage that appears briefly while the mouse hovers over a specified area of the screen. It usually displays useful information about how to use an object or what data should be entered, etc
+
Reads or writes a flag to determine the hint associated with the application @@ -7665,7 +7675,8 @@ Does Esc perform the cancel action?
Does F1 - activate a Help system?

+ activate a Help system?
+
Navigation Options is a set, so can take zero or more of the available values