Label Current Viewport

This Subprogram Labels the currently setup Viewport.

Short Name Calling Sequence

STATUS = UILAVP(LABEL[,STYLE,PLACE,VPRTID])

Long Name Calling Sequence

STATUS = UI_LABEL_VIEWPORT(...)

Input Arguments

LABEL (Character) Viewport Label STYLE (Integer) Label Text Style (Optional) PLACE (Integer) Label Position (Optional) VPRTID (Integer) Viewport ID (Optional)

Output Arguments

None

Function Value

UI__SUCCESS ) Success UISUCC )

UI__NOT_INITIALIZED ) Package not Initialized UININI )

UI__ILLEGAL_VIEWPORT ) Illegal Viewport ID UIILVP

Note:

1. The specified Viewport must have been previously defined via a call to UI_DEFINE_VIEWPORT in the currently setup Viewport Mode (Text or Graphics).
2. This Subprogram will only affect the Text or Graphics Viewport with this ID corresponding to the currently setup Viewport Mode.
3. The Label will be displayed at the top border of the Viewport, centred.
4. If the LABEL is null (all spaces) any already existing Label will be removed from the Viewport.
5. The STYLE Argument is optional and, if present, overrides the default text style for the current Viewport. A Style of Zero is the normal (not bold, blinking, underlined etc.) and alternative styles may be specified by combining the following Style Masks (by ORing them together):-

   UISBLI ) Blinking UISTYLEBLINK )

   UISBOL ) Bold UISTYLEBOLD )

   UISREV ) Reverse Video UISTYLEREVERSE )

   UISUND ) Underlined UISTYLEUNDERLINE )

   These Parameters are defined in the Parameter Definition File described in Appendix B.3.

6. The PLACE Argument is optional and, if present, overrides the default position of the Label (being the top of the Viewport). The following placements are allowed:-

   UILNOR ) Normal (Top) UILABELNORMAL )

   UILTOP ) Top UILABELTOP )

   UILBOT ) Bottom UILABELBOTTOM )

   UILLEF ) Left UILABELLEFT )

   UILRIG ) Right UILABELRIGHT )

   These Parameters are defined in the Parameter Definition File described in Appendix B.3.

7. The Viewport Mode is defaulted to Text on initialisation of UIPACK. It may be changed by calling UI_VIEWPORT_MODE and may be determined by calling UI_INQUIRE_VIEWPORT_MODE.
8. For a Text Viewport to be made visible it must be displayed via a call to UI_DISPLAY_VIEWPORT. This may be performed either prior to, or following, this call.
9. The VPRTID Argument is optional and, if omitted, defaults to the currently setup Viewport.