hiEncap
hiEncap(
[ g_boxSpec ]
[ t_cmd ]
[ t_title ]
)
=> w_window / nil
Description
Invokes an encapsulation session by creating and displaying an encapsulation window.
The window created has a widget type of encap and an application type of encap.
If you get the warning message related to allocation of colormap entry, you can ignore it. This message is displayed if you have set CDS_USE_PRIVATE_CMAP to true or have used a private colormap. It does not affect the encapsulation window.
Arguments
|
g_boxSpec
|
Screen coordinates specifying the lower left and upper right corners of the window, assuming 0:0 to be the lower left corner of the screen. If boxSpec is nil, either you are prompted with a rubberbanding box to enter a window size or a default size is used depending on the value of the global variable hivWinStyle. The ’default and ’interactive symbols are also acceptable values for the boxSpec argument.
|
|
t_cmd
|
SKILL function to which all input sent to the Encapsulation window is redirected. This function acts as a wrapper function to the input command line entered during the current encapsulation session.
|
|
t_title
|
String that appears in the window manager banner of the encapsulation window. If not specified, the string Encapsulation appears.
|
Values Returned
|
w_window
|
Opens an encapsulation window and returns the ID of the window.
|
|
nil
|
Cannot open a window.
|
Examples
Opens an encapsulation window and returns its windowId.
hiEncap( )
=> window:2
Related Topics
Encapsulation Window
hiSetEncapSkillCmd
Return to top
