CATDlgDialog description

Quick Reference

Abstract

The purpose of this article is to list the detailed properties of the widget CATDlgDialog in Interactive Dialog Designer.

Requirements
Framework Dialog
Module DI0PANV2

CATDlgDialog

Properties Supported Values Default Value Description
Accelerator The accelerator of the dialog object as a CATUnicodeString instance.
ApplyBtnEnabled true Sets whether the Apply push button is enabled.
ApplyBtnTitle The Apply push button title.
AutoResize false Set to true for a dialog window automatically resized with respect to its content's modifications.
CancelBtnEnabled true Sets whether the Cancel push button is enabled.
CancelBtnTitle The Cancel push button title.
CloseBtnEnabled true Sets whether the Close push button is enabled.
CreateOnPointer false Set to true for a dialog window created at the mouse cursor location.
Decoration Default
NoTitleBar
NoTitleNoBorder
Default Title bar and borders appearance.
DefaultButton None
OKButton
CancelButton
PreviewButton
ApplyButton
CloseButton
HelpButton
OKButton The default push button is the one activated when the end user presses the Enter key.
Enabled true Sets whether the widget is enabled.
Height -1 Sets the height of the dialog box.
Help The help message displayed in the message area of the status bar.
HelpBtnEnabled true Sets whether the Help push button is enabled.
HelpBtnTitle The Help push button title.
IconFocussed The name of the icon when the dialog object is on focus
IconNormal The name of the icon in its default state
IconSelected The name of the icon when the dialog object is selected
LayoutType Grid
Tabulation
Grid Sets the layout manager for the container
LongHelp The message is displayed in a box when the What's This command is used.
MDIChild false Set to true for a dialog window located within its parent application main window.
ModalDialog false If set to true,no interaction is possible outside this window as long as it is displayed.
NoButtons false Set to true for a dialog window without any push button.
NotResizable false Set to true for a dialog window not resizable by the end user. The minimize and maximize buttons are not available.
OKBtnEnabled true Sets whether the OK push button is enabled.
OKBtnTitle The OK push button title.
PreviewBtnEnabled true Sets whether the Preview push button is enabled.
PreviewBtnTitle The Preview push button title.
ShortHelp The short help message (or tooltip) of the dialog object.
Title Title or text content of the widget.
TitleBarHelpButton false Set to true for a dialog window with the help button located in the title bar, as a question mark. This is possible with Windows only and has no effect with UNIX.
UseApplyButton false Set to true to force the dialog box to show a Apply button. This option is ignored if UseOKCancelPreviewButtons, UseCloseButton or NoButtons is set to true.
UseCancelButton false Set to true to force the dialog box to show a Cancel button. This option is ignored if UseOKCancelPreviewButtons, UseCloseButton or NoButtons is set to true.
UseCloseButton false Set to true for a standard dialog window with the Close push button. This options excludes other dialog buttons.
UseHelpButton false Set to true to force the dialog box to show a Help button. This option is ignored if UseOKCancelPreviewButtons, UseCloseButton or NoButtons is set to true.
UseOKApplyCloseButtons false Set to true to use the OK, Apply and Close buttons in the dialog box. This options excludes other dialog buttons.
UseOKButton false Set to true to force the dialog box to show a OK button. This option is ignored if UseOKCancelPreviewButtons, UseCloseButton or NoButtons is set to true.
UseOKCancelPreviewButtons false Set to true to use the OK, Cancel and Preview buttons in the dialog box. This options excludes other dialog buttons.
Visible true Sets whether the widget is visible.
Width -1 Sets the width of the dialog box.
Callbacks Description
ApplyBtnPushed Event notification sent whenever the Apply push button is pressed.
CancelBtnPushed Event notification sent whenever the Cancel push button is pressed.
CloseBtnPushed Event notification sent whenever the Close push button is pressed.
DragButton Sent whenever a mouse drag mechanism starts on a button.
DragCancel Sent whenever a mouse drag mechanism stops.
DragDrop Sent whenever a mouse drop happens. This notification is sent by the target of the drag&drop operation.
DragDropEnd Sent whenever a mouse drop happens.This notification is sent by the source of the drag&drop operation.
DragEnter Sent whenever a mouse drag enters the window.
DragLeave Sent whenever a mouse drag leaves the window.
DragOver Sent whenever a mouse drag rolls over the window.
DragStart Sent whenever a mouse drag mechanism begins.
HelpBtnPushed Event notification sent whenever the Help push button is pressed.
HelpRequested Sent whenever the object is selected using the What's This command.
MDIActivated Event notification sent whenever the dialog window is activated.
MDIClosed Event notification sent whenever the dialog window is closed.
MDIMaximized Event notification sent whenever the dialog window is maximized.
MDIMinimized Event notification sent whenever the dialog window is minimized.
MDINext Event notification sent whenever the dialog window is activated as the next of the current one.
MDIPrevious Event notification sent whenever the dialog window is activated as the previous of the current one.
MDIRestored Event notification sent whenever the dialog window is restored.
OKBtnPushed Event notification sent whenever the OK push button is pressed.
PreviewBtnPushed Event notification sent whenever the Preview push button is pressed.
Resized Sent whenever the object is resized.
VisibilityChanged Sent whenever the object visibility is modified.

History

Version: 1 [Jul 2007] Document created