Dialog CATDlgNotify
Usage: you must use this class as is. You should never derive it.
public class CATDlgNotify
Base class for information modal dialog windows.
note: Notify windows are always modal under Windows Operating Systems.
note: These windows are implemented as standard windows provided by the Operating Systems. As so,
the button texts ("Cancel", "Apply",...) follow the installation language of the Operatings System and not the language
selected for V6.
Constructor and Destructor Index
- o
CATDlgNotify(CATDialog*,CATString&,CATDlgStyle)
- Constructor.
- o
CATDlgNotify(CATInteractiveApplication*,CATString&,CATDlgStyle)
- Constructor.
- o
~CATDlgNotify()
- Destructor.
Method Index
- o
DisplayBlocked(CATUnicodeString&,CATUnicodeString&)
- Runs the dialog window in a modal loop.
- o
GetNfyAbortNotification()
- Returns the event notification sent when the Abort button is pressed.
- o
GetNfyCancelNotification()
- Returns the event notification sent when the Cancel button is pressed.
- o
GetNfyIgnoreNotification()
- Returns the event notification sent when the Ignore button is pressed.
- o
GetNfyNoNotification()
- Returns the event notification sent when the No button is pressed.
- o
GetNfyOKNotification()
- Returns the event notification sent when the OK button is pressed.
- o
GetNfyRetryNotification()
- Returns the event notification sent when the Retry button is pressed.
- o
GetNfyYesNotification()
- Returns the event notification sent when the Yes button is pressed.
- o
GetText()
- Gets the message displayed by the window.
- o
SetText(CATUnicodeString&)
- Sets the message displayed by the window.
Constructor and Destructor
o CATDlgNotify
| public CATDlgNotify( | | iParent, |
| const | iObjectName, |
| | iStyle | =NULL) |
-
Constructor.
- Parameters:
-
- iParent
- The parent widget.
- iObjectName
- The internal name of the popup window.
- iStyle
- The style of the popup window.
Legal values:
- CATDlgNfyInformation
- To specify an information window.
It is the default style.
- CATDlgNfyWarning
- To specify a warning window
- CATDlgNfyError
- To specify an error window
- CATDlgNfyAction
- To specify a confirmation window
- CATDlgNfyAbortRetryIgnore
- The window has Abort, Retry and Ignore buttons
- CATDlgNfyRetryCancel
- The window has Retry and Cancel buttons
- CATDlgNfyOK
- The window has an OK button
- CATDlgNfyOKCancel
- The window has OK and Cancel buttons
- CATDlgNfyYesNo
- The window has Yes and No buttons
- CATDlgNfyYesNoCancel
- The window has Yes, No and Cancel buttons
- CATDlgWndModal
- The window is modal
A button style should always be used.
o CATDlgNotify
| public CATDlgNotify( | | iParent, |
| const | iObjectName, |
| | iStyle | =NULL) |
-
Constructor.
- Parameters:
-
- iParent
- The parent application object.
- iObjectName
- The internal name of the popup window.
- iStyle
- The style of the popup window.
Legal values:
- CATDlgNfyInformation
- To specify an information window.
It is the default style.
- CATDlgNfyWarning
- To specify a warning window
- CATDlgNfyError
- To specify an error window
- CATDlgNfyAction
- To specify a confirmation window
- CATDlgNfyAbortRetryIgnore
- The window has Abort, Retry and Ignore buttons
- CATDlgNfyRetryCancel
- The window has Retry and Cancel buttons
- CATDlgNfyOK
- The window has an OK button
- CATDlgNfyOKCancel
- The window has OK and Cancel buttons
- CATDlgNfyYesNo
- The window has Yes and No buttons
- CATDlgNfyYesNoCancel
- The window has Yes, No and Cancel buttons
- CATDlgWndModal
- The window is modal
A button style should always be used.
o ~CATDlgNotify
| public virtual ~CATDlgNotify( | ) |
-
Destructor.
Methods
o DisplayBlocked
| public DisplayBlocked( | const | iMessage, |
| const | iWndTitle) |
-
Runs the dialog window in a modal loop.
- Parameters:
-
- iMessage
- the message displayed by the window.
- iWndTitle
- the title of the window.
- Returns:
- an integer identifying the button which has been pressed.
Legal values:
- 1
- The OK button has been pressed.
- 2
- The Cancel button has been pressed.
- 3
- The Yes button has been pressed.
- 4
- The No button has been pressed.
- 5
- The Retry button has been pressed.
- 6
- The Abort button has been pressed.
- 7
- The Ignore button has been pressed.
o GetNfyAbortNotification
| public GetNfyAbortNotification( | ) |
-
Returns the event notification sent when the Abort button is pressed.
o GetNfyCancelNotification
| public GetNfyCancelNotification( | ) |
-
Returns the event notification sent when the Cancel button is pressed.
o GetNfyIgnoreNotification
| public GetNfyIgnoreNotification( | ) |
-
Returns the event notification sent when the Ignore button is pressed.
o GetNfyNoNotification
| public GetNfyNoNotification( | ) |
-
Returns the event notification sent when the No button is pressed.
o GetNfyOKNotification
| public GetNfyOKNotification( | ) |
-
Returns the event notification sent when the OK button is pressed.
o GetNfyRetryNotification
| public GetNfyRetryNotification( | ) |
-
Returns the event notification sent when the Retry button is pressed.
o GetNfyYesNotification
| public GetNfyYesNotification( | ) |
-
Returns the event notification sent when the Yes button is pressed.
o GetText
-
Gets the message displayed by the window.
- Returns:
- the text of the message.
o SetText
| public SetText( | const | iText) |
-
Sets the message displayed by the window.
- Parameters:
-
- iText
- the text of the message.
This object is included in the file: CATDlgNotify.h
If needed, your Imakefile.mk should include the module: DI0PANV2
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.