Dialog CATDlgDialog
Usage: you can derive this class.
public class CATDlgDialog
Base class for popup windows.
Role:
The dialog window is designed to enable the dialog between the end user and the application.
Is is dedicated to either :
- display views of a document,
- contain controls arranged to enable the end user to enter values, or select options to edit,
modify, or print these documents, or to globally parameterize the application.
It allows data acquisition from the user. Applications can thus request data from the user to go on executing.
In addition, a dialog window can be set to modal. In this case, the dialog is limited to this window,
and when it ends, the window disappears.
Use the dialog window as a base class when you want to create a window for a document or a dialog.
The parent of an instance of a class that derives from CATDlgDialog must be an instance of a class that derives from
or
.
Constructor and Destructor Index
- o
CATDlgDialog(CATDialog*,CATString&,CATDlgStyle)
- Constructs a CATDlgDialog.
- o
CATDlgDialog(CATDialog*,CATCommand*,CATString&,CATDlgStyle)
- Constructs a CATDlgDialog with a specified parent for the event management.
- o
CATDlgDialog(CATInteractiveApplication*,CATString&,CATDlgStyle)
- Constructs a CATDlgDialog with the application as parent.
- o
~CATDlgDialog()
-
Method Index
- o
BuildPowerInputLabel()
- Returns the PowerInput label from the active box.
- o
BuildPowerInputText()
- Returns the PowerInput text from the active box.
- o
DecodePowerInputText(CATUnicodeString&)
- Decodes a PowerInput text.
- o
GetAPPLYSensitivity()
- Returns the Apply push button sensitivity.
- o
GetAPPLYTitle()
- Returns the Apply push button title.
- o
GetCANCELSensitivity()
- Returns the Cancel push button sensitivity.
- o
GetCANCELTitle()
- Returns the Cancel push button title.
- o
GetCLOSESensitivity()
- Returns the Close push button sensitivity.
- o
GetCLOSETitle()
- Returns the CLOSE push button title.
- o
GetContextualMenu()
- Returns the contextual menu of the dialog window if any.
- o
GetDefaultButton()
- Returns the default push button.
- o
GetDiaAPPLYNotification()
- Returns the event notification sent whenever the Apply push button is pressed.
- o
GetDiaCANCELNotification()
- Returns the event notification sent whenever the Cancel push button is pressed.
- o
GetDiaCLOSENotification()
- Returns the event notification sent whenever the Close push button is pressed.
- o
GetDiaHELPNotification()
- Returns the event notification sent whenever the Help push button is pressed.
- o
GetDiaOKNotification()
- Returns the event notification sent whenever the OK push button is pressed.
- o
GetDiaPREVIEWNotification()
- Returns the event notification sent whenever the Preview push button is pressed.
- o
GetHELPSensitivity()
- Returns the Help push button sensitivity.
- o
GetHELPTitle()
- Returns the Help push button title.
- o
GetMDIActivateNotification()
- Returns the event notification sent whenever the dialog window is activated.
- o
GetMDICloseNotification()
- Returns the event notification sent whenever the dialog window is closed.
- o
GetMDIMaximizeNotification()
- Returns the event notification sent whenever the dialog window is maximized.
- o
GetMDIMinimizeNotification()
- Returns the event notification sent whenever the dialog window is minimized.
- o
GetMDINextNotification()
- Returns the event notification sent whenever the dialog window is activated as the next of the current one.
- o
GetMDIPreviousNotification()
- Returns the event notification sent whenever the dialog window is activated as the previous of the current one.
- o
GetMDIRestoreNotification()
- Returns the event notification sent whenever the dialog window is restored.
- o
GetMenuBar()
- Returns the menu bar of the dialog window if any.
- o
GetOKSensitivity()
- Returns the OK push button sensitivity.
- o
GetOKTitle()
- Returns the OK push button title.
- o
GetPREVIEWSensitivity()
- Returns the Preview push button sensitivity.
- o
GetPREVIEWTitle()
- Returns the Preview push button title.
- o
ParsePowerInputText(CATUnicodeString*,int)
- Parses power input text.
- o
PowerInputBeginTransaction()
- Method called before first field is modified.
- o
PowerInputEndTransaction()
- Method called after last field is modified.
- o
ReleasePowerInputFocus()
- Removes the dialog window controls from PowerInput.
- o
SetAPPLYSensitivity(CATULong)
- Sets the Apply push button sensitivity.
- o
SetAPPLYTitle(CATUnicodeString&)
- Sets the Apply push button title if not defined in resource file.
- o
SetCANCELSensitivity(CATULong)
- Sets the Cancel push button sensitivity.
- o
SetCANCELTitle(CATUnicodeString&)
- Sets the Cancel push button title if not defined in resource file.
- o
SetCLOSESensitivity(CATULong)
- Sets the Close push button sensitivity.
- o
SetCLOSETitle(CATUnicodeString&)
- Sets the CLOSE push button title if not defined in resource file.
- o
SetDefaultButton(int)
- Sets the default push button.
- o
SetFocusOn(CATDialog*)
- Sets the focus on the specified dialog component.
- o
SetHELPSensitivity(CATULong)
- Sets the Help push button sensitivity.
- o
SetHELPTitle(CATUnicodeString&)
- Sets the Help push button title if not defined in resource file.
- o
SetOKSensitivity(CATULong)
- Sets the OK push button sensitivity.
- o
SetOKTitle(CATUnicodeString&)
- Sets the OK push button title if not defined in resource file.
- o
SetPREVIEWSensitivity(CATULong)
- Sets the Preview push button sensitivity.
- o
SetPREVIEWTitle(CATUnicodeString&)
- Sets the Preview push button title if not defined in resource file.
- o
TakePowerInputFocus()
- Puts the dialog window controls on PowerInput.
- o
UpdatePowerInput()
- Forces regeneration of PowerInput.
Constructor and Destructor
o CATDlgDialog
| public CATDlgDialog( | | iParent, |
| const | iObjectName, |
| | iStyle | =NULL) |
-
Constructs a CATDlgDialog.
- Parameters:
-
- iParent
- The parent of the dialog.
- iObjectName
- The name of the dialog.
- iStyle
- The style of the dialog.
The style can be :
- NULL
- if no value is passed, for the default dialog window with the OK, Cancel, and Help push buttons.
- CATDlgWndModal
- for a modal dialog window ; no interaction is possible outside this window
as long as it is displayed. The cursor changes to prevent from doing anything outside of the window.
- CATDlgWndBtnOKCancel
- for a standard dialog window with the OK and Cancel push buttons.
- CATDlgWndBtnOKCancelPreview
- for a standard dialog window with the OK, Cancel and Preview push buttons.
- CATDlgWndBtnOKApplyClose
- for a standard dialog window with the OK, Apply and Close push buttons.
- CATDlgWndBtnClose
- for a standard dialog window with the Close push button.
- CATDlgWndNoButton
- for a dialog window without any push button.
- CATDlgWndSmallDecoration
- for a dialog window without any title bar.
- CATDlgWndNoDecoration
- for a dialog window without any title bar nor resizing frame.
- CATDlgWndPointerLocation
- for a dialog window created at the mouse cursor location.
- CATDlgWndAutoResize
- for a dialog window automatically resized with respect to its content's modifications.
- CATDlgWndNoResize
- for a dialog window not resizable by the end user.
The minimize and maximize buttons are not available
- CATDlgWndChildMDI
- for a dialog window located within its parent application main window.
- CATDlgWndTitleBarHelp
- 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
o CATDlgDialog
| public CATDlgDialog( | | iParent, |
| | iEventMgr, |
| const | iObjectName, |
| | iStyle | =NULL) |
-
Constructs a CATDlgDialog with a specified parent for the event management.
- Parameters:
-
- iParent
- The parent of the dialog.
- iEventMgr
- The command parent of the dialog (for the event notification management).
- iObjectName
- The name of the dialog.
- iStyle
- The style of the dialog.
The style can be :
- NULL
- if no value is passed, for the default dialog window with the OK, Cancel, and Help push buttons.
- CATDlgWndModal
- for a modal dialog window ; no interaction is possible outside this window
as long as it is displayed. The cursor changes to prevent from doing anything outside of the window.
- CATDlgWndBtnOKCancel
- for a standard dialog window with the OK and Cancel push buttons.
- CATDlgWndBtnOKCancelPreview
- for a standard dialog window with the OK, Cancel and Preview push buttons.
- CATDlgWndBtnOKApplyClose
- for a standard dialog window with the OK, Apply and Close push buttons.
- CATDlgWndBtnClose
- for a standard dialog window with the Close push button.
- CATDlgWndNoButton
- for a dialog window without any push button.
- CATDlgWndSmallDecoration
- for a dialog window without any title bar.
- CATDlgWndNoDecoration
- for a dialog window without any title bar nor resizing frame.
- CATDlgWndPointerLocation
- for a dialog window created at the mouse cursor location.
- CATDlgWndAutoResize
- for a dialog window automatically resized with respect to its content's modifications.
- CATDlgWndNoResize
- for a dialog window not resizable by the end user.
The minimize and maximize buttons are not available
- CATDlgWndChildMDI
- for a dialog window located within its parent application main window.
- CATDlgWndTitleBarHelp
- 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
o CATDlgDialog
| public CATDlgDialog( | | iParent, |
| const | iObjectName, |
| | iStyle | =NULL) |
-
Constructs a CATDlgDialog with the application as parent.
- Parameters:
-
- iParent
- The parent of the dialog.
- iObjectName
- The name of the dialog.
- iStyle
- The style of the dialog.
The style can be :
- NULL
- if no value is passed, for the default dialog window with the OK, Cancel, and Help push buttons.
- CATDlgWndModal
- for a modal dialog window ; no interaction is possible outside this window
as long as it is displayed. The cursor changes to prevent from doing anything outside of the window.
- CATDlgWndBtnOKCancel
- for a standard dialog window with the OK and Cancel push buttons.
- CATDlgWndBtnOKCancelPreview
- for a standard dialog window with the OK, Cancel and Preview push buttons.
- CATDlgWndBtnOKApplyClose
- for a standard dialog window with the OK, Apply and Close push buttons.
- CATDlgWndBtnClose
- for a standard dialog window with the Close push button.
- CATDlgWndNoButton
- for a dialog window without any push button.
- CATDlgWndSmallDecoration
- for a dialog window without any title bar.
- CATDlgWndNoDecoration
- for a dialog window without any title bar nor resizing frame.
- CATDlgWndPointerLocation
- for a dialog window created at the mouse cursor location.
- CATDlgWndAutoResize
- for a dialog window automatically resized with respect to its content's modifications.
- CATDlgWndNoResize
- for a dialog window not resizable by the end user.
The minimize and maximize buttons are not available
- CATDlgWndChildMDI
- for a dialog window located within its parent application main window.
- CATDlgWndTitleBarHelp
- 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
o ~CATDlgDialog
| public virtual ~CATDlgDialog( | ) |
-
Methods
o BuildPowerInputLabel
| public virtual BuildPowerInputLabel( | ) |
-
Returns the PowerInput label from the active box.
o BuildPowerInputText
| public virtual BuildPowerInputText( | ) |
-
Returns the PowerInput text from the active box.
o DecodePowerInputText
| public virtual DecodePowerInputText( | const | iText) |
-
Decodes a PowerInput text.
- Parameters:
-
- iText
- The text to decode.
o GetAPPLYSensitivity
| public GetAPPLYSensitivity( | ) |
-
Returns the Apply push button sensitivity.
Legal values : It can be set to either :
- CATDlgEnable
- if the push button is enabled,
- CATDlgDisable
- if the push button is disabled (grayed),
o GetAPPLYTitle
-
Returns the Apply push button title.
o GetCANCELSensitivity
| public GetCANCELSensitivity( | ) |
-
Returns the Cancel push button sensitivity.
Legal values : It can be set to either :
- CATDlgEnable
- if the push button is enabled,
- CATDlgDisable
- if the push button is disabled (grayed),
o GetCANCELTitle
-
Returns the Cancel push button title.
o GetCLOSESensitivity
| public GetCLOSESensitivity( | ) |
-
Returns the Close push button sensitivity.
Legal values : It can be set to either :
- CATDlgEnable
- if the push button is enabled,
- CATDlgDisable
- if the push button is disabled (grayed),
o GetCLOSETitle
-
Returns the CLOSE push button title.
o GetContextualMenu
| public GetContextualMenu( | ) |
-
Returns the contextual menu of the dialog window if any.
o GetDefaultButton
| public GetDefaultButton( | ) |
-
Returns the default push button.
The default push button is the one activated when the end user presses the Enter key.
Legal values :
- NULL
- : no default push button,
- CATDlgWndOK
- : the OK push button,
- CATDlgWndCANCEL
- : the Cancel push button,
- CATDlgWndPREVIEW
- : the Preview push button,
- CATDlgWndAPPLY
- : the Apply push button.
- CATDlgWndCLOSE
- : the Close push button,
- CATDlgWndHELP
- : the Help push button,
o GetDiaAPPLYNotification
| public GetDiaAPPLYNotification( | ) |
-
Returns the event notification sent whenever the Apply push button is pressed.
o GetDiaCANCELNotification
| public GetDiaCANCELNotification( | ) |
-
Returns the event notification sent whenever the Cancel push button is pressed.
o GetDiaCLOSENotification
| public GetDiaCLOSENotification( | ) |
-
Returns the event notification sent whenever the Close push button is pressed.
o GetDiaHELPNotification
| public GetDiaHELPNotification( | ) |
-
Returns the event notification sent whenever the Help push button is pressed.
o GetDiaOKNotification
| public GetDiaOKNotification( | ) |
-
Returns the event notification sent whenever the OK push button is pressed.
o GetDiaPREVIEWNotification
| public GetDiaPREVIEWNotification( | ) |
-
Returns the event notification sent whenever the Preview push button is pressed.
o GetHELPSensitivity
| public GetHELPSensitivity( | ) |
-
Returns the Help push button sensitivity.
Legal values : It can be set to either :
- CATDlgEnable
- if the push button is enabled,
- CATDlgDisable
- if the push button is disabled (grayed),
o GetHELPTitle
-
Returns the Help push button title.
o GetMDIActivateNotification
| public GetMDIActivateNotification( | ) |
-
Returns the event notification sent whenever the dialog window is activated.
o GetMDICloseNotification
| public GetMDICloseNotification( | ) |
-
Returns the event notification sent whenever the dialog window is closed.
o GetMDIMaximizeNotification
| public GetMDIMaximizeNotification( | ) |
-
Returns the event notification sent whenever the dialog window is maximized.
o GetMDIMinimizeNotification
| public GetMDIMinimizeNotification( | ) |
-
Returns the event notification sent whenever the dialog window is minimized.
o GetMDINextNotification
| public GetMDINextNotification( | ) |
-
Returns the event notification sent whenever the dialog window is activated as the next of the current one.
o GetMDIPreviousNotification
| public GetMDIPreviousNotification( | ) |
-
Returns the event notification sent whenever the dialog window is activated as the previous of the current one.
o GetMDIRestoreNotification
| public GetMDIRestoreNotification( | ) |
-
Returns the event notification sent whenever the dialog window is restored.
o GetMenuBar
-
Returns the menu bar of the dialog window if any.
o GetOKSensitivity
| public GetOKSensitivity( | ) |
-
Returns the OK push button sensitivity.
Legal values : It can be set to either :
- CATDlgEnable
- if the push button is enabled,
- CATDlgDisable
- if the push button is disabled (grayed),
o GetOKTitle
-
Returns the OK push button title.
o GetPREVIEWSensitivity
| public GetPREVIEWSensitivity( | ) |
-
Returns the Preview push button sensitivity.
Legal values : It can be set to either :
- CATDlgEnable
- if the push button is enabled,
- CATDlgDisable
- if the push button is disabled (grayed),
o GetPREVIEWTitle
-
Returns the Preview push button title.
o ParsePowerInputText
| public ParsePowerInputText( | | iFieldArray, |
| | iNbmax) |
-
Parses power input text.
- Parameters:
-
- iFieldArray
- The field string array containing the different values entered in the PowerInput (separated by comas).
- iNbmax
- The field array size.
o PowerInputBeginTransaction
| public virtual PowerInputBeginTransaction( | ) |
-
Method called before first field is modified.
o PowerInputEndTransaction
| public virtual PowerInputEndTransaction( | ) |
-
Method called after last field is modified.
o ReleasePowerInputFocus
| public ReleasePowerInputFocus( | ) |
-
Removes the dialog window controls from PowerInput.
o SetAPPLYSensitivity
| public SetAPPLYSensitivity( | | iSensitivity) |
-
Sets the Apply push button sensitivity.
- Parameters:
-
- iSensitivity
- The sensitivity to set.
Legal values : It can be set to either :
- CATDlgEnable
- to enable the push button,
- CATDlgDisable
- to disable the push button (grayed),
o SetAPPLYTitle
| public SetAPPLYTitle( | const | iTitle) |
-
Sets the Apply push button title if not defined in resource file.
- Parameters:
-
- iTitle
- The title to set.
o SetCANCELSensitivity
| public SetCANCELSensitivity( | | iSensitivity) |
-
Sets the Cancel push button sensitivity.
- Parameters:
-
- iSensitivity
- The sensitivity to set.
Legal values : It can be set to either :
- CATDlgEnable
- to enable the push button,
- CATDlgDisable
- to disable the push button (grayed),
o SetCANCELTitle
| public SetCANCELTitle( | const | iTitle) |
-
Sets the Cancel push button title if not defined in resource file.
- Parameters:
-
- iTitle
- The title to set.
o SetCLOSESensitivity
| public SetCLOSESensitivity( | | iSensitivity) |
-
Sets the Close push button sensitivity.
- Parameters:
-
- iSensitivity
- The sensitivity to set.
Legal values : It can be set to either :
- CATDlgEnable
- to enable the push button,
- CATDlgDisable
- to disable the push button (grayed),
o SetCLOSETitle
| public SetCLOSETitle( | const | iTitle) |
-
Sets the CLOSE push button title if not defined in resource file.
- Parameters:
-
- iTitle
- The title to set.
o SetDefaultButton
| public SetDefaultButton( | | iButton) |
-
Sets the default push button.
Role:
The default push button is the one activated when the end user presses the Enter key.
In the
constructor class, the default is set to CATDlgWndOK.
- Parameters:
-
- iButton
- The default push button to set.
Legal values :
- NULL
- : no default push button,
- CATDlgWndOK
- : the OK push button,
- CATDlgWndCANCEL
- : the Cancel push button,
- CATDlgWndPREVIEW
- : the Preview push button,
- CATDlgWndAPPLY
- : the Apply push button.
- CATDlgWndCLOSE
- : the Close push button,
- CATDlgWndHELP
- : the Help push button,
o SetFocusOn
| public SetFocusOn( | | iDialog) |
-
Sets the focus on the specified dialog component.
- Parameters:
-
- iDialog
- The dialog component with the focus.
By default, the first editable component has the keyboard focus.
An editable component is one of this following list :
- CATDlgEditor
- : without the style CATDlgEdtReadOnly.
- CATDlgCombo
- : with the style CATDlgCmbEntry.
- CATDlgSpinner
- : with the style CATDlgSpnEntry.
If the dialog box has more than one of editable component, the first one is positioned
at the top left most position.
The user is able to change the keyboard focus with the Tab key and/or the mouse.
o SetHELPSensitivity
| public SetHELPSensitivity( | | iSensitivity) |
-
Sets the Help push button sensitivity.
- Parameters:
-
- iSensitivity
- The sensitivity to set.
Legal values : It can be set to either :
- CATDlgEnable
- to enable the push button,
- CATDlgDisable
- to disable the push button (grayed),
o SetHELPTitle
| public SetHELPTitle( | const | iTitle) |
-
Sets the Help push button title if not defined in resource file.
- Parameters:
-
- iTitle
- The title to set.
o SetOKSensitivity
| public SetOKSensitivity( | | iSensitivity) |
-
Sets the OK push button sensitivity.
- Parameters:
-
- iSensitivity
- The sensitivity to set.
Legal values : It can be set to either :
- CATDlgEnable
- to enable the push button,
- CATDlgDisable
- to disable the push button (grayed),
o SetOKTitle
| public SetOKTitle( | const | iTitle) |
-
Sets the OK push button title if not defined in resource file.
- Parameters:
-
- iTitle
- The title to set.
o SetPREVIEWSensitivity
| public SetPREVIEWSensitivity( | | iSensitivity) |
-
Sets the Preview push button sensitivity.
- Parameters:
-
- iSensitivity
- The sensitivity to set.
Legal values : It can be set to either :
- CATDlgEnable
- to enable the push button,
- CATDlgDisable
- to disable the push button (grayed),
o SetPREVIEWTitle
| public SetPREVIEWTitle( | const | iTitle) |
-
Sets the Preview push button title if not defined in resource file.
- Parameters:
-
- iTitle
- The title to set.
o TakePowerInputFocus
| public TakePowerInputFocus( | ) |
-
Puts the dialog window controls on PowerInput.
o UpdatePowerInput
| public UpdatePowerInput( | ) |
-
Forces regeneration of PowerInput.
This object is included in the file: CATDlgDialog.h
If needed, your Imakefile.mk should include the module: DI0PANV2
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.