Method XbpWindow():setModalState() Foundation
Defines the window as modal or non-modal.
:setModalState( <nStatus> ) --> lSuccess
Constant | Description |
---|---|
XBP_DISP_MODELESS | Window is not modal |
XBP_DISP_APPMODAL | Window is modal application wide |
XBP_DISP_SYSMODAL *) | Window is modal system wide |
|
This method returns the value .T. (true) if the window status could be set, otherwise .F. (false) is returned.
The method :setModalState() sets the "modality" of a window. The user can leave a non-modal window at any time simply by clicking the mouse in another window. A modal window, however, must be closed before another windows can be activated. The method :getModalState() can be used to determine the current modality of a window.
For example, to create modal XbpDialog window, AppDesktop() is normally used as parent while SetAppWindow() is the owner. This disables the application window until the modal state is reset to XBP_DISP_MODELESS.
If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.