Dialogs unit

dialogs.pp contains classes, types, and routines used to implement common dialogs in an application. dialogs.pp is part of the Lazarus Component Library ( LCL).

The following components are added to the Lazarus IDE component palette:

Dialogs Tab

• TOpenDialog
• TSaveDialog
• TSelectDirectoryDialog
• TColorDialog
• TFontDialog
• TFindDialog
• TReplaceDialog
• TTaskDialog

Misc Tab

• TColorButton

Classes and records

TColorButton	class	TColorButton - a SpeedButton designed to be used with the Color dialog, allowing a color to be selected for text or graphics.
TColorDialog	class	Implements a dialog used to select a TColor value.
TCommonDialog	class	The base type from which other dialogs are derived.
TCustomCopyToClipboardDialog	class	Base class for a dialog form used during copy to clipboard operations.
TCustomPrintDialog	class	Implements the base class for TPrintDialog.
TCustomPrinterSetupDialog	class	Base class for TPrinterSetupDialog and TPageSetupDialog.
TCustomTaskDialog	class	Defines a configurable, modal task dialog at run-time.
TFileDialog	class	TFileDialog allows selection of a file from the current directory.
TFindDialog	class	TFindDialog - a dialog used for finding text within the current editor or text buffer.
TFontDialog	class	Dialog used to select a font typeface and size.
TOpenDialog	class	Implements a File / Open dialog used to select one or more files on the local file system.
TReplaceDialog	class	Implements a find and replace dialog.
TSaveDialog	class	TSaveDialog - Dialog for saving the current buffer to a file.
TSelectDirectoryDialog	class	Implements a select directory dialog.
TTaskDialog	class	Implements a configurable modal task dialog.
TTaskDialogBaseButtonItem	class	Defines the base class for a custom button displayed on a Task dialog.
TTaskDialogButtonItem	class	Implements a button definition used for a button in TCustomTaskDialog.
TTaskDialogButtons	class	Collection type used to access and maintain buttons defined for a Task dialog.
TTaskDialogButtonsEnumerator	class	Implements an enumerator for buttons defined in a Task dialog.
TTaskDialogProgressBar	class	Provides information about a progress bar displayed on a TTaskDialog instance.
TTaskDialogRadioButtonItem	class	Implements a radio button displayed on a Task dialog.

Procedures and functions

CreateMessageDialog	function	Creates a dialog form type with the specified caption, message, and buttons.
dbgs	function	Creates a formatted debugger message for one or more TOpenOption values.
DefaultInputDialog	function	Widgetset-independent implementation of an input dialog.
DefaultMessageBox	function	Widgetset-independent implementation of a message box routine.
DefaultPromptDialog	function	Widgetset-independent implementation of a prompt dialog.
DefaultQuestionDialog	function	Implements a widgetset-independent dialog similar to QuestionDlg.
DialogCopyToClipboard	procedure	Copies the content from the specified dialog to the clipboard.
ExtractColorIndexAndColor	function	Extracts the color index and color value for the specified position in a color list.
GetDialogCaption	function	Gets the resource string used as the caption for the specified dialog identifier.
GetDialogIcon	function	Gets a bitmap with the icon for the specified dialog identifier.
InputBox	function	Displays a box with specified title and prompt, and accepts user input in a text box.
InputCombo	function	Creates and executes a combo-box dialog with the specified Caption, Prompt, and list of selectable values.
InputComboEx	function	Displays an extended input combo-box dialog that allows entry of custom text values in its Items.
InputQuery	function	Use InputQuery to show a dialog box to get input from the user.
MessageDlg	function	Shows a message to the user and gets the response.
MessageDlgPos	function	An extended MessageDlg function.
MessageDlgPosHelp	function	An extended MessageDlgPos function.
PasswordBox	function	Displays a Password prompt with input masking.
PromptForFileName	function	Displays a file open or save dialog to select a file name for the operation.
QuestionDlg	function	Shows a question to the user and gets a response. Similar to MessageDlg, but allows to use custom button captions and user-specified response values.
Register	procedure	Registers components for use in the Lazarus IDE.
RegisterDialogForCopyToClipboard	procedure	Enables key preview and adds the OnKeyDown handler for the specified dialog.
SelectDirectory	function	A function that allows a user to select a directory.
ShowMessage	procedure	Displays the specified message text.
ShowMessageFmt	procedure	Shows a message assembled from a format string and an array of arguments.
ShowMessagePos	procedure	Shows a message box at a given screen position.
TaskDlg	function	Provides a wrapper function used to configure and execute a TTaskDialog instance.

Types

TCDWSEventCapabilities	set	Set type used to store values from the TCDWSEventCapability enumeration.
TCDWSEventCapability	enumeration	Represents events handled in a custom-drawn widgetset.
TColorDialogOption	enumeration	Represents the options which can be enabled during execution of a color dialog.
TColorDialogOptions	set	Set type used to store values from the TColorDialogOption enumeration.
TDialogResultEvent	procedure type	Specifies an event signalled when a result is returned in a dialog.
TFindOption	enumeration	A list of possible options which can be used in Find dialogs.
TFindOptions	set	Set type used to store TFindOption enumeration values.
TFontDialogOption	enumeration	An enumerated list of constants to set the options of a Font dialog.
TFontDialogOptions	set	Set type used to store font dialog options.
TInputCloseQueryEvent	procedure type	Specifies an event handler signalled when an InputQuery dialog is about to close.
TMsgDlgBtn	type	Identifies dialog button types.
TMsgDlgButtons	type	Set type used to store the buttons on a message dialog.
TMsgDlgType	type	Identifies the type or style for a message dialog.
TOpenOption	enumeration	Options which can be used in a TOpenDialog instance.
TOpenOptionEx	enumeration	Widgetset-specific open options which cannot be mapped to the standard values in TOpenOptions.
TOpenOptions	set	Set type used to store TOpenOption enumeration values.
TOpenOptionsEx	set	Set type used to store values from the TOpenOptionEx enumeration.
TPrintDialogOption	enumeration	Enumerated type with available options for a print dialog.
TPrintDialogOptions	set	A set type used for the options in a print dialog.
TPrintRange	enumeration	Enumerated type which represents page ranges used in a print dialog.
TProgressBarState	type	Alias to the TProgressBarState type in comctrls.pp.
TSelectDirOpt	enumeration	List of options available when selecting a directory.
TSelectDirOpts	set	Set type used to store directory selection options.
TTaskDialogCommonButton	enumeration	Identifier used for common buttons visible on a Task dialog.
TTaskDialogCommonButtons	set	Set type used to store values from TTaskDialogCommonButton.
TTaskDialogFlag	enumeration	Represents options that can be enabled for TTaskDialog.
TTaskDialogFlags	set	Set type used to store values from the TTaskDialogFlag enumeration.
TTaskDialogIcon	enumeration	Identifier for an icon displayed on a Task dialog.
TTaskDlgClickEvent	procedure type	Specifies an event handler signalled when a button is clicked in TCustomTaskDialog / TTaskDialog.
TTaskDlgTimerEvent	procedure type	Specifies an event handler signalled when the timer callback is enabled in a task dialog.

Constants

BitBtnKindToMsgDlgBtn	constant	A constant array used to convert the kind of BitButton to the kind of message buttons.
cInputQueryEditSizePercents	constant	Input Query Edit size as a percentage of the monitor width.
cInputQueryEditSizePixels	constant	Input Query Edit size in pixels.
cInputQuerySpacingSize	constant	Spacing between the controls on an Input Query dialog.
DefaultColorDialogOptions	constant	Specifies the default options enabled in TColorDialog.
DefaultOpenDialogOptions	constant	Set constant with the default Open Dialog options used in TOpenDialog.
mbAbort	constant	Alias to the TMsgDlgBtn enumeration value in system.uitypes.pp.
mbAbortRetryIgnore	constant	A set constant to show an Abort, Retry , Ignore buttons on a message dialog.
mbAll	constant	Alias to the TMsgDlgBtn enumeration value in system.uitypes.pp.
mbCancel	constant	Alias to the TMsgDlgBtn enumeration value in system.uitypes.pp.
mbClose	constant	Alias to the TMsgDlgBtn enumeration value in system.uitypes.pp.
mbHelp	constant	Alias to the TMsgDlgBtn enumeration value in system.uitypes.pp.
mbIgnore	constant	Alias to the TMsgDlgBtn enumeration value in system.uitypes.pp.
mbNo	constant	Alias to the TMsgDlgBtn enumeration value in system.uitypes.pp.
mbNoToAll	constant	Alias to the TMsgDlgBtn enumeration value in system.uitypes.pp.
mbOK	constant	Alias to the TMsgDlgBtn enumeration value in system.uitypes.pp.
mbOKCancel	constant	A set constant to show an OK and a Cancel button on a message dialog.
mbRetry	constant	Alias to the TMsgDlgBtn enumeration value in system.uitypes.pp.
mbYes	constant	Alias to the TMsgDlgBtn enumeration value in system.uitypes.pp.
mbYesNo	constant	A set constant with Yes, No buttons.
mbYesNoCancel	constant	A set constant with Yes, No, Cancel buttons.
mbYesToAll	constant	Alias to the TMsgDlgBtn enumeration value in system.uitypes.pp.
MsgDlgBtnToBitBtnKind	constant	A constant array used to convert the kind of message buttons to the kind of BitButton.
mtConfirmation	constant	Alias to the TMsgDlgType enumeration value in system.uitypes.pp.
mtCustom	constant	Alias to the TMsgDlgType enumeration value in system.uitypes.pp.
mtError	constant	Alias to the TMsgDlgType enumeration value in system.uitypes.pp.
mtInformation	constant	Alias to the TMsgDlgType enumeration value in system.uitypes.pp.
mtWarning	constant	Alias to the TMsgDlgType enumeration value in system.uitypes.pp.
ofExNoPlacesBar	constant	Mapped to the ofHidePinnedPlaces option in TOpenOptionEx. Maintains code compatibility with older Delphi versions.
PB_DEFMAX	constant	Numeric constant which defines the default value for the Max property in a progress bar.
PB_DEFMIN	constant	Numeric constant which defines the default value for the Min property in a progress bar.
PBST_ERROR	constant	Numeric constant used in the Task Dialog API to represent pbsError from the TProgressBarState enumeration.
PBST_NORMAL	constant	Numeric constant used in the Task Dialog API to represent pbsNormal from the TProgressBarState enumeration.
PBST_PAUSED	constant	Numeric constant used in the Task Dialog API to represent pbsPaused from the TProgressBarState enumeration.
TaskDialogFirstButtonIndex	constant	Lowest index value for a button identifier used on a task dialog instance.
TaskDialogFirstRadioButtonIndex	constant	Lowest index value for a radio button used on a TTaskDialog instance.
TDE_CONTENT	constant	Numeric constant which identifies the text in the main content area on a task dialog.
TDE_EXPANDED_INFORMATION	constant	Numeric constant which identifies the expandable text for a task dialog.
TDE_FOOTER	constant	Numeric constant which identifies the footer text for a task dialog.
TDE_MAIN_INSTRUCTION	constant	Numeric constant which identifies the title in the main content areas on a task dialog.

Variables

MinimumDialogButtonHeight	variable	Minimum height for a button on a dialog.
MinimumDialogButtonWidth	variable	Minimum width for a button on a dialog.

Uses

• Types
• TypInfo
• Classes
• SysUtils
• System.UITypes
• LMessages
• LResources
• LCLIntf
• InterfaceBase
• LCLStrConsts
• LCLType
• Forms
• Controls
• Themes
• Graphics
• Buttons
• ButtonPanel
• StdCtrls
• ExtCtrls
• LCLClasses
• Clipbrd
• Menus
• ComCtrls
• DialogRes
• GraphType
• FileUtil
• LazFileUtils
• LazStringUtils
• LazLoggerBase