IC8 Python API:RLPy RDialogCallback
Contents
Description
This class is used to monitor dialog related events, i.e. hide, show, close, etc. A dialog callback class must be made that inherits from RDialogCallback, then the internal callback functions can be overwritten. This dialog callback instance can then be registered to a dialog window or dock widget with RLPy.REventCallback.RegisterEventCallback() and a registration id will returned. This id can be used later, to unregister the callback function that it belongs to. The corresponding callback function will be called when a dialog is shown, hidden, or closed. RDialogCallback can not be created as a local variable, otherwise the application will crash. Errors in the callback function can also cause the application to crash without warning, therefore, one should consider using Python's try except for fool-proof implementation.
Constructor & Destructor
__init__ (self)
Initializes a new dialog callback instance.
Member Functions
OnDialogClose (self)
This event is called when this dialog is about to be closed and return whether it is truly closed as confirmed by the application. When a dialog's close button is pressed, OnDialogHide will be called first, followed by OnDialogClose.
OnDialogHide (self)
This event is called when this dialog is hidden. When a dialog's close button is pressed, OnDialogHide will be called first, followed by OnDialogClose. When a docakable window is docked within the main window, OnDialogHide will be callsed first, followed by OnDialogShow.
OnDialogShow (self)
This event is called when this dialog is shown. Initialization protocals is most suited for execution at this time. When dockable window is docked within the main window, OnDialogHide will be called first, followed by OnDialogShow.
Properties
thisown
Indicates whether this SWIG proxy owns the underlying C++ object.
