Add Pop-Up Window (QUIADDPW) API
Required Parameter Group:
| 1 | Application handle | Input | Char(8) |
| 2 | Pop-up window location | Input | Char(10) |
| 3 | Row | Input | Binary(4) |
| 4 | Column | Input | Binary(4) |
| 5 | Error code | I/O | Char(*) |
Optional Parameter Group:
| 6 | Depth | Input | Binary(4) |
Default Public Authority: *USE
Threadsafe: No
The Add Pop-Up Window (QUIADDPW) API begins the ability to display panels within a pop-up window. All subsequent panel displays for the open application remain in the pop-up window until the Remove Pop-up Window (QUIRMVPW) API is called, or until the QUIADDPW API is called again to add another pop-up window. The maximum number of pop-up windows that can be added to an open application is 20.
Authorities and Locks
None.
Required Parameter Group
- Application handle
- INPUT; CHAR(8)
The application handle assigned by the UIM and returned to the application program by the Open Display Application (QUIOPNDA) API when the application is opened.
- Pop-up window location
- INPUT; CHAR(10)
The name of a field used for field-adjacent positioning. Field-adjacent positioning places a pop-up window near a field on the underlying panel. The field name must correspond to a name specified on the NAME attribute on one of the following tags of the immediately underlying panel or pop-up window:
- Command Line (CMDLINE)
- Data Item Group (DATAGRP)
- Data Item (DATAI)
- List Column (LISTCOL)
- List Column Group (LISTGRP)
- Menu Item (MENUI)
- Option Line (OPTLINE)
One of these special values may be used to position the window:
*OFFSET The pop-up window is offset from the top left corner of the most recent underlying panel or pop-up window. *PULLDOWN The pop-up window is positioned adjacent to the previous position of the pull-down choice. If the most recent action for the most recently displayed panel was not the selection of a pull-down choice, offset positioning is used. *ROWCOL The row and column parameters indicate where the upper left corner of the pop-up window appears. Row and column positioning should be used only when displaying a pop-up window over a non-UIM panel, in conjunction with the Set Screen Image (QUISETSC) API.
- Row
- INPUT; BINARY(4)
The absolute row used when row and column positioning is requested. The value is either a positive or negative integer.
If a negative integer is provided, the last row for the pop-up window is calculated using the absolute value of the integer, relative to the bottom of the display. A pop-up window cannot begin in row one, and a minimum-depth pop-up window must fit at the specified first row.
When a negative integer is provided, the absolute location of the window is determined by the size of the first panel displayed in the pop-up window. If another panel is displayed in the same window with a smaller width or depth, the location is not recalculated based on the negative integer. If another panel is displayed in the same window with a larger width or depth, the window is changed to use offset positioning.
- Column
- INPUT; BINARY(4)
The absolute column used when row and column positioning is requested. The value is either a positive or a negative integer.
If a negative integer is provided, the last column for the pop-up window is calculated using the absolute value of the integer, relative to the right side of the display. A pop-up window cannot begin in column one, and a minimum-width pop-up window must fit at the specified first column.
When a negative integer is provided, the absolute location of the window is determined by the size of the first panel displayed in the pop-up window. If another panel is displayed in the same window with a smaller width or depth, the location is not recalculated based on the negative integer. If another panel is displayed in the same window with a larger width or depth, the window is changed to use offset positioning.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
Optional Parameter Group
- Depth
- INPUT; BINARY(4)
The depth of the pop-up window to be displayed.
If the depth is specified on a panel without a TEXT area defined, it will be ignored and the depth specified on the PANEL tag will be used. If the depth specified on the API is larger than the depth specified on the PANEL tag, the depth specified on the API will be used.
The maximum supported depth for a pop-up panel depends on what the display device can support. On a device that can only support 24 rows by 80 bytes, the maximum depth of a pop-up window is 21 lines. On a device that can support 27 rows by 132 bytes, the maximum depth of a pop-up window is 24 lines.
The minimum allowed depth is 5 lines.
The special value of 0 may be specified to indicate that the depth on the PANEL tag should be used. The default value is 0.
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF3C90 E | Literal value cannot be changed. |
| CPF6A0A E | Pop-up window depth too small. |
| CPF6A0B E | Application handle &3 not valid. |
| CPF6A0C E | Application domain error for application &1. |
| CPF6A0F E | Previous error occurred while running application &3. |
| CPF6A24 E | Parameter &1 not passed correctly. |
| CPF6A25 E | Return code length of &1 not valid. |
| CPF6A3E E | Application not open for display. |
| CPF6A81 E | Pop-up window cannot be added at this time. |
| CPF6A82 E | &4 is not a valid window location. |
| CPF6A83 E | Row or column given for positioning is not valid. |
| CPF6A85 E | Attempted to display more than &4 windows at a time. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
API introduced: V2R2
[ Back to top | User Interface Manager APIs | APIs by category ]