diff --git a/docs/xml/lcl/dialogs.xml b/docs/xml/lcl/dialogs.xml index bb438a999c..bc5e8eefc1 100644 --- a/docs/xml/lcl/dialogs.xml +++ b/docs/xml/lcl/dialogs.xml @@ -54,6 +54,7 @@ The following components are added to the Lazarus IDE component palette: + @@ -72,143 +73,229 @@ The following components are added to the Lazarus IDE component palette: + - + -Identifies a dialog type or style. +Identifies the type or style for a message dialog.

-TMsgDlgType is an alias to the TMsgDlgType type in -uitypes.pas. +TMsgDlgType is an alias to the TMsgDlgType enumerated +type in the RTL system.uitypes.pp unit. TMsgDlgType defines a +type of dialog implemented in a message box. Values in the enumeration +determine the caption, icon, string literals, and buttons displayed in various +dialog types. +

+

+Values from the enumeration can be represented using the descriptive modal +dialog type constants, such as: mtWarning, mtError, mtInformation, +mtConfirmation, and mtCustom. +

+

+Values from TMsgDlgType are used in several routines, such as: +MessageDlg, MessageDlgPos, MessageDlgPosHelp, +CreateMessageDialog, QuestionDlg, and +LazMessageDlg.

-UITypes.TMsgDlgType + + + + + + + + + + + +LazMessageDlg
+ Identifies dialog button types.

TMsgDlgBtn is an alias to the TMsgDlgBtn type in -uitypes.pas. +system.uitypes.pp. TMsgDlgBtn is an enumeration type with values +that define the buttons that can be displayed in a message dialog. TMsgDlgBtn +values also determine the modal result returned from the dialog when the +corresponding button is clicked. +

+

+Values from the enumeration can be represented using the descriptive message +button constants, such as: mbYes, mbNo, mbOK, mbCancel, mbAbort, mbRetry, +mbIgnore, mbAll, mbNoToAll, mbYesToAll, mbHelp, and mbClose. +

+

+Values in the enumeration are used in various routines, such as: +MessageDlg, MessageDlgPos, MessageDlgPosHelp, +CreateMessageDialog, QuestionDlg, and +LazMessageDlg.

-UITypes.TMsgDlgBtn + + + + + + + + + + + + + + + + + + +LazMessageDlg
+ -Set with button messages for dialogs. + +Set type used to store the buttons on a message dialog. +

-TMsgDlgButtons is an alias to the TMsgDlgButtons type -in uitypes.pas. +TMsgDlgButtons is an alias to the TMsgDlgButtons type in +system.uitypes.pp. TMsgDlgButtons is a set type used to store +zero or more values from the TMsgDlgBtn enumeration. TMsgDlgButtons is passed +as an argument to routines like: MessageDlg, +MessageDlgPos, MessageDlgPosHelp, +CreateMessageDialog, QuestionDlg, and +LazMessageDlg.

- -UITypes.TMsgDlgButtons + + +
-Alias to the TMsgDlgType enumeration value in uitypes. +Alias to the TMsgDlgType enumeration value in system.uitypes.pp. -Alias to the TMsgDlgType enumeration value in uitypes. +Alias to the TMsgDlgType enumeration value in system.uitypes.pp. -Alias to the TMsgDlgType enumeration value in uitypes. +Alias to the TMsgDlgType enumeration value in system.uitypes.pp. -Alias to the TMsgDlgType enumeration value in uitypes. +Alias to the TMsgDlgType enumeration value in system.uitypes.pp. -Alias to the TMsgDlgType enumeration value in uitypes. +Alias to the TMsgDlgType enumeration value in system.uitypes.pp. -Alias to the TMsgDlgBtn enumeration value in uitypes. +Alias to the TMsgDlgBtn enumeration value in system.uitypes.pp. -Alias to the TMsgDlgBtn enumeration value in uitypes. +Alias to the TMsgDlgBtn enumeration value in system.uitypes.pp. -Alias to the TMsgDlgBtn enumeration value in uitypes. +Alias to the TMsgDlgBtn enumeration value in system.uitypes.pp. -Alias to the TMsgDlgBtn enumeration value in uitypes. +Alias to the TMsgDlgBtn enumeration value in system.uitypes.pp. -Alias to the TMsgDlgBtn enumeration value in uitypes. +Alias to the TMsgDlgBtn enumeration value in system.uitypes.pp. -Alias to the TMsgDlgBtn enumeration value in uitypes. +Alias to the TMsgDlgBtn enumeration value in system.uitypes.pp. -Alias to the TMsgDlgBtn enumeration value in uitypes. +Alias to the TMsgDlgBtn enumeration value in system.uitypes.pp. -Alias to the TMsgDlgBtn enumeration value in uitypes. +Alias to the TMsgDlgBtn enumeration value in system.uitypes.pp. -Alias to the TMsgDlgBtn enumeration value in uitypes. +Alias to the TMsgDlgBtn enumeration value in system.uitypes.pp. -Alias to the TMsgDlgBtn enumeration value in uitypes. +Alias to the TMsgDlgBtn enumeration value in system.uitypes.pp. -Alias to the TMsgDlgBtn enumeration value in uitypes. +Alias to the TMsgDlgBtn enumeration value in system.uitypes.pp. -Alias to the TMsgDlgBtn enumeration value in uitypes. +Alias to the TMsgDlgBtn enumeration value in system.uitypes.pp. A set constant with Yes, No, Cancel buttons. +

A set constant used to show Yes, No, and Cancel buttons on a message dialog. +

@@ -216,7 +303,9 @@ A set constant used to show Yes, No, and Cancel buttons on a message dialog. A set constant with Yes, No buttons. +

A set constant used to show Yes and No buttons on a message dialog. +

@@ -225,8 +314,11 @@ A set constant used to show Yes and No buttons on a message dialog. A set constant to show an OK and a Cancel button on a message dialog. -A set constant to show an OK and a Cancel button on a message -dialog. + +

+A set constant to show an OK and a Cancel button on a message dialog. +

+
@@ -235,7 +327,9 @@ dialog. A set constant to show an Abort, Retry , Ignore buttons on a message dialog. +

A set constant to show an Abort, Retry and Ignore buttons on a message dialog. +

@@ -598,20 +692,26 @@ deprecated THandle type in the property.
-UserChoice - the value selected by the user. + +Contains the modal result value selected by the user. +

-UserChoice is an name property which contains the modal -result value returned for the dialog. It uses modal result constants like -mrOk, mrCancel, et. al. as defined in the UITypes unit. Its -value is updated by methods in the widgetset class when they display and -process the dialog for the platform. +UserChoice is an Integer property which contains the +modal result value returned for the dialog. It uses values from the modal +result constants like mrOk, mrCancel, et. al. as defined in this unit and in +the system.uitypes.pp unit. Its value is updated by methods in +the widgetset class when they display and process the dialog for the platform.

-TModalResult + +