Window actions
closeWidget
The closeWidget action closes the part, but the connections are maintained and the widget can be reopened.
contentsHelp
The contentsHelp action requests that the contents of the help file for the part be displayed.
deIconify
The deIconify action opens the part from the icon to the size it was before it was minimized.
Note:
The window is opened but it is not necessarily brought to the foreground and made active.
destroyPart
The destroyPart action destroys the part and its children, and releases all associated resources. You can use this action for both visual and nonvisual parts. All connections to the destroyed part are removed.
disable
The disable action makes the part unavailable for selection.
enable
The enable action makes the part available for selection.
help
The help action requests that the general help associated with the part be displayed. General help is the main help panel associated with the part. You usually access general help through a help button on a window. From the general help panel you can access other help panels (such as menu and field help).
helpForHelp
The helpForHelp action requests that help for help be displayed. The help for help panel provides instructions for using a help system. You usually access this help panel from the Help menu. It can contain information such as the structure and organization of the help library.
helpIndex
The helpIndex action requests that the help index be displayed. The help index lists key words or phrases that, when selected, link you to the help panel that explains the word or phrase.
hide
The hide action makes the part invisible.
iconify
The iconify action minimizes the part to an icon.
keysHelp
The keysHelp action requests that the keys help be displayed. The keys help panel explains the function and use of certain keyboard keys in an application.
openApplicationModalWidget
The openApplicationModalWidget action opens the window modal to the application. Modal means a user must interact with the window before continuing with an operation.
However, even though the window is modal the underlying application code can still be run. To suspend the application code, after connecting to this action, also connect to the suspendExecutionUntilRemoved action. When the window is closed, the code continues to run.
openFullApplicationModalWidget
The openFullApplicationModalWidget action opens the window modal to all applications. Modal means that a user must interact with the window before continuing an operation on any of the currently running applications.
However, even though the window is modal the underlying application code can still be run. To suspend the application code, after connecting to this action, also connect to the suspendExecutionUntilRemoved action. When the window is closed, the code continues to run.
openOwnedWidget
The openOwnedWidget action prevents the parent window from covering the dialog when the parent is selected. This action is used for dialog windows only.
openSystemModalWidget
The openSystemModalWidget action opens the window modal to the system. Modal means that a user must interact with the window before continuing with an operation.
However, even though the window is modal the underlying application code can still be run. To suspend the application code as well, after connecting to this action, also connect to the suspendExecutionUntilRemoved action. Code execution will resume when the window is closed.
openWidget
The openWidget action opens a modeless window with respect to its parent window.
resetCursor
The resetCursor resets the cursor to its state before setting it.
setFocus
The setFocus action sets input focus to the part. Focus determines whether or not keyboard input is directed to the part.
The setFocus action acts differently depending on which part is receiving the action. For example, if you connect the setFocus action to a Window part, the window comes to the foreground and is the active window. Or, if you connect the setFocus action to a Text part in a window, the cursor is moved to this field.
show
The show action makes the part visible.
showBusyCursor
The showBusyCursor action sets the current cursor to the busy cursor. Use the resetCursor action to return the cursor to its previous state.
suspendExecutionUntilRemoved
The suspendExecutionUntilRemoved action blocks the current code path from executing but enable the user to interact with the user interface. The code will resume execution when the window is closed.
If this action is used in conjunction with the openApplicationModalWidget, openFullApplicationModalWidget, openOwnedWidget, or openSystemModalWidget actions, the user interface will also become suspended, giving you full modality. Code execution will resume when the window opened with one of the actions is closed.
Last modified date: 01/29/2015