diff --git a/docs/xml/lcl/dialogs.xml b/docs/xml/lcl/dialogs.xml index d1412ac969..879499e946 100644 --- a/docs/xml/lcl/dialogs.xml +++ b/docs/xml/lcl/dialogs.xml @@ -110,80 +110,46 @@ Constants to define the types of message dialogs. - - - + - - - + - - - + - - - + - - - + Constants to define possible buttons on a dialog. - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + Set of button messages for dialogs @@ -208,7 +174,7 @@ A constant array used to convert the kind of message buttons to the kind of BitButton. - This array gives you for each possible button type in a messagebox the corresponding kind of BitButton. For instance MsgDlgBtnToBitBtnKind[mbYes] has the value of bkYes. It is the reverse of BitBtnKindToMsgDlgBtn. + This array gives you for each possible button type in a messagebox the corresponding kind of BitButton.
For instance MsgDlgBtnToBitBtnKind[mbYes] has the value of bkYes.
It is the reverse of BitBtnKindToMsgDlgBtn. @@ -218,7 +184,7 @@ Common Dialog - Common Dialog: the base type fromwhich all other dialogs are derived. Use the "Create" method to make an instance of the dialog, the "Execute" method to show it to the user and the "Free" method to release it and free the used resources. + Common Dialog: the base type from which all other dialogs are derived. Use the "Create" method to make an instance of the dialog, the "Execute" method to show it to the user and the "Close" method to release it and free the used resources. @@ -282,9 +248,7 @@ - - - + @@ -293,9 +257,7 @@ - - - + @@ -304,9 +266,7 @@ - - - + @@ -315,9 +275,7 @@ - - - + @@ -332,9 +290,7 @@ - - - + A public method of a dialog showing the appropriate dialog. @@ -385,9 +341,7 @@ - - - + @@ -497,17 +451,13 @@ - - - + Internal procedure called to execute the dialog. - - - + @@ -516,9 +466,7 @@ - - - + @@ -527,9 +475,7 @@ - - - + @@ -538,17 +484,13 @@ - - - + Public method to create a FileDialog. - - - + @@ -561,9 +503,7 @@ Public method which causes the dialog to be shown. - - - + Stringlist which stored the selected files. @@ -611,101 +551,53 @@ A set of possible options which can be used in OpenDialog - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + @@ -721,7 +613,7 @@ Open Dialog - Open Dialog: open a file in the current directory, selected by File Dialog. If the required file is not in the current directory, another directory can be selected with Select Directory + Open Dialog: open a file in the current directory, selected by File Dialog.
If the required file is not in the current directory, another directory can be selected with Select Directory @@ -759,37 +651,27 @@ A protected function which checkes if the choosen file meets all requirements. - - - + - - - + A protected method which call CheckFile for each selected file. - - - + Internal procedure called to execute the dialog. - - - + Public method to create a OpenDialog - - - + @@ -823,7 +705,7 @@ Save Dialog - Save Dialog: invoked when the application requires to save a file. If the file is already open or a filename has been specified, then the current buffer is written to that file; if no file is specified, the Save File As dialog is invoked and the buffer is saved to that file. + Save Dialog: invoked when the application requires to save a file.
If the file is already open or a filename has been specified, then the current buffer is written to that file; if no file is specified, the Save File As dialog is invoked and the buffer is saved to that file. @@ -833,13 +715,11 @@ - - - + Select Directory Dialog - Select Directory Dialog: allows the user to select a directory when the diredtory structure is displayed as a tree. + Select Directory Dialog: allows the user to select a directory when the directory structure is displayed as a tree. @@ -849,13 +729,9 @@ - - - + - - - + @@ -864,14 +740,12 @@ - - - + Colour Dialog Colour Dialog: presents a palette of colours to allow the user to select the required colour for text or graphics. - +
Call the Execute function to show the color dialog. @@ -883,9 +757,7 @@ Call the Execute function to show the color dialog. The method whoch create an instance of the TColorDialog. - - - + The caption for the color dialog. @@ -933,9 +805,7 @@ Call the Execute function to show the color dialog. - - - + @@ -958,9 +828,7 @@ Call the Execute function to show the color dialog. - - - + @@ -976,9 +844,7 @@ Call the Execute function to show the color dialog. - - - + @@ -1093,69 +959,37 @@ Call the Execute function to show the color dialog. A set of constants to set the options of a Font dialog. - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + @@ -1208,9 +1042,7 @@ Call the Execute function to show the color dialog. A private method which sets the font of the dialog. - - - + @@ -1223,9 +1055,7 @@ Call the Execute function to show the color dialog. Public method to create a FontDialog. - - - + @@ -1266,8 +1096,8 @@ Call the Execute function to show the color dialog. - A set of possible options which can be used in Find-dialogs. - A set of possible options which can be used in Find-dialogs. + A list of possible options which can be used in Find-dialogs. + A list of possible options which can be used in Find-dialogs. @@ -1328,20 +1158,22 @@ Call the Execute function to show the color dialog. Message Dialog - Message Dialog: show a message to the user and receive his response. + Show a message to the user and receive his response. -There are two versions of this function. The first version displays a dialog with the standard caption, the second version enables you to set the caption. +There are four versions of this function. The first version displays a dialog with the standard caption, the second, third and fourth versions enable you to set the caption.
+The third version allows for a Default button; the fourth version contains a help keyword instead of using context-based help. +
-function MessageDlg(const aMsg: string; DlgType: TMsgDlgType; - Buttons: TMsgDlgButtons; HelpCtx: Longint): Integer; -function MessageDlg(const aCaption, aMsg: string; DlgType: TMsgDlgType; - Buttons: TMsgDlgButtons; HelpCtx: Longint): Integer; - - Two versions of this function, ie first 'Caption' argument is optional; if omitted, caption is missing from box +If the first 'Caption' argument is missing, no caption is shown on the box.
This is the most complete and elaborate of the message dialogs, and allows the programmer considerable control over the appearance of the dialog box.
+ + The arguments defining the kind of box and its icon are types rather than integer constants, and the buttons can be specified as a set in square brackets eg [mbRetry, mbIgnore, mbAbort, mbCancel].
- The HelpCtx argument is not currently implemented and should be set to zero. + + + The HelpCtx argument allows the use of Context Help
+ The return value from the Function is the identity of the button pressed, expressed as an integer (see the definitions below, [mrNone..mrAll]). @@ -1464,13 +1296,13 @@ The MessageDlgPos function does not enable you to choose the caption of the dial Show a question to the user and get a response - QuestionDlg has the same functionality as MessageDlg except for the parameter Buttons which is of a different type. You can define your own captions and return values of this function.<br/> + QuestionDlg has the same functionality as MessageDlg except for the parameter Buttons which is of a different type. You can define your own captions and return values of this function.
Buttons is a list of TModalResult and strings. For each TModalResult a button is created. To set a custom caption, add a string after a button. The default TModalResults defined in controls.pp (mrNone..mrLast) don't need - caption. The default captions will be used. + caption. The default captions will be used. @@ -1505,20 +1337,21 @@ The strength of this functions is however that you can fill the array like: [400 Show Message - Procedure ShowMessage (const Msg: string); + Procedure ShowMessage (const Msg: string);
-{ Defined in Dialogs.pp } +{ Defined in Dialogs.pp }
The simplest message dialog: takes a simple string as argument, displays it in a stereotyped box, and waits for a mouse-click or enter-key event before returning to the calling routine or program.
- This is a modal procedure call, that is the box is displayed, receives focus, and does not relinquish focus until the OK box is clicked or otherwise selected. -Example + This is a modal procedure call, that is the box is displayed, receives focus, and does not relinquish focus until the OK box is clicked or otherwise selected.

+Example
-Program LazMessage; +Program LazMessage; Uses Dialogs; begin ShowMessage ('This is a message from Lazarus') -end. +end. + @@ -1529,7 +1362,9 @@ end. Shows a message assembled from a format string and an array of arguments. This procedure is an extension to the ShowMessage + procedure. The parameters it takes are the same as the Format function. + @@ -1543,6 +1378,7 @@ end. Shows a message box at a given screen position. Shows a message box at a given screen position. + @@ -1557,19 +1393,16 @@ end. The vertical position of the messagebox. - Use InputQuery to show a dialog box to get some input from the user -

Two versions of this function which displays a prompt and expects user input of textual data;

- - -

The first includes a MaskInput boolean argument which determines whether the user input is masked out by asterisks in the text-input box (like during entry of a password), + + Use InputQuery to show a dialog box to get some input from the user + +

Two versions of this function which displays a prompt and expects user input of textual data;

+

The first includes a MaskInput boolean argument which determines whether the user input is masked out by asterisks in the text-input box (like during entry of a password), the second omits this property.

- - -

The text entered by the user is returned in the variable argument 'Value'. +

The text entered by the user is returned in the variable argument 'Value'. The function result is a boolean which returns TRUE if the OK button was pressed, or FALSE if the box was closed by any other mechanism (such as clicking the 'Close' icon on the top title bar).

- - -

Omitting the MaskInput argument is equivalent to setting it FALSE.

 +

Omitting the MaskInput argument is equivalent to setting it FALSE.

+ @@ -1596,24 +1429,30 @@ The function result is a boolean which returns TRUE if the OK button was pressed When the DialogBox is shown the text in the Editbox will be Value. When ENTER is pressed or OK clicked, Value will be the text from the Editbox. - Displays a box with defined title and prompt, and expects user input in a text box -

. A default string can optionally be displayed in the text box. The user-entered or default string is returned as the function result. + + Displays a box with defined title and prompt, and expects user input in a text box + +

. A default string can optionally be displayed in the text box. The user-entered or default string is returned as the function result.

-

If the user selects the OK button, the text in the text box is returned. If the user selects the Cancel button, the default string is returned. -

 +

If the user selects the OK button, the text in the text box is returned. If the user selects the Cancel button, the default string is returned. +

+ - The result of this function is the string the user entered in the editbox or the default string + + The result of this function is the string the user entered in the editbox or the default string . - The caption for the dialogbox + + The caption for the dialogbox . - The text asking the user for his input + + The text asking the user for his input . @@ -1624,11 +1463,13 @@ The function result is a boolean which returns TRUE if the OK button was pressed Password Box - PasswordBox: a specialised form of the InputQuery. The editbox on the dialog box will mask the input. The only parameters are aCaption and aPrompt. - -Function PasswordBox(const ACaption, APrompt : String) : String; - + PasswordBox: a specialised form of the InputQuery.
The editbox on the dialog box will mask the input. The only parameters are aCaption and aPrompt.
Function PasswordBox(const ACaption, APrompt : String) : String; +
Behaves very similarly to the InputQuery function with MaskInput = TRUE; the difference is that the password that was typed in is returned as the result of the function (like InputBox). + + + + @@ -1645,7 +1486,9 @@ Function PasswordBox(const ACaption, APrompt : String) : String; A function that allows to user to select a directory. - This function wil show a dialog which allows the user to select the required directory when the directory structure is displayed as a tree.
Under Windows the caption from the resulting dialog cannot be set, but the label above the directory tree will have this value.
+ This function will show a dialog which allows the user to select the required directory when the directory structure is displayed as a tree.
+Under Windows the caption from the resulting dialog cannot be set, but the label above the directory tree will have this value.
+ There are two version of this function, the second one having the ability to indicate whether hidden folders should be shown as well. @@ -1680,6 +1523,16 @@ There are two version of this function, the second one having the ability to ind + + A dialog used for finding text within the current editor or text buffer + Opens a dialog box allowing the user to enter text for searching.
As this is the parent class for the TReplaceDialog, it contains definitions for the Replace method, but the Replace option does not actually appear when the dialog is displayed: you need to use TReplaceDialog to do that + + + + A dialog allowing the user to replace text + The dialog appears and offers boxes for the user to enter text for searching and text to replace it.
A number of buttons appear, offering the choice to replace this instance, find next, replace all + +