(LOGO.JPG) Python for OpenVMS

(go to: table of contents, index, list of vms_smg, prev: PUT_CHARS_WIDE, next: PUT_LINE)


VMS_SMG_PUT_HELP_TEXT - Output Help Text to the Display

Retrieves and outputs the help text for the specified topic in the virtual display provided.

Format:

    None = vms_smg.put_help_text (display_id, [keyboard_id], \
                  [help_topic], [help_library],              \
                  [rendition_set], [rendition_complement])
Returns:

None

Arguments:

display_id
Display identifier of the virtual display to which the help text is written.
keyboard_id
The identifier of the virtual keyboard from which to read.
help_topic
The help topic - e.g. 'DIRECTORY'.
help_library
Help library name. The default is SYS$HELP:HELPLIB.HLB.
rendition_set
Attribute specifier. Bit mask values like SMG_M_BOLD are in module 'vms_smgdef'.
rendition_complement
Attribute complement specifier. There are no symbolic names available - please see the OpenVMS documentation for details.
Examples:
>>> import vms_smg
>>> import vms_smgdef

>>> # create a new DECwindows terminal using SMG
>>> status, pasteboard_id, number_of_pasteboard_rows, \
... number_of_pasteboard_columns, type_of_terminal,   \
... device_name = vms_smg.create_pasteboard           \
...   (None, vms_smgdef.SMG_M_WORKSTATION)
>>>

>>> # create a virtual keyboard -
>>> #   use the device name from CREATE_PASTEBOARD
>>> keyboard_id, resultant_filespec = \
...     vms_smg.create_virtual_keyboard (device_name)
>>>

>>> # create virtual display
>>> status, vtdpy1 = vms_smg.create_virtual_display \
...         (15, 55, vms_smgdef.SMG_M_BORDER, None, None)
>>>

>>> # paste virtual display
>>> status = vms_smg.paste_virtual_display \
...          (vtdpy1, pasteboard_id, 2, 2, None)
>>>

>>> # output the help text
>>> vms_smg.put_help_text (vtdpy1, keyboard_id, 'SHOW', 'UAFHELP')
(Note that Python does not prompt back, yet)

Screen layout, file: VMS_SMG_059.JPG

(picture VMS_SMG_059.JPG)

----------------------------------------
Pressing <RETURN> in the DECterm created.

Screen layout, file: VMS_SMG_060.JPG

(picture VMS_SMG_060.JPG)

----------------------------------------
Entering '/EXACT' and pressing <RETURN> in the DECterm created.

Screen layout, file: VMS_SMG_061.JPG

(picture VMS_SMG_061.JPG)

----------------------------------------
Pressing <CONTROL-Z> in the DECterm created.

Screen layout, file: VMS_SMG_062.JPG

(picture VMS_SMG_062.JPG)

The Python prompt ('>>>') in the interpreter's window is back.


(go to: table of contents, index, list of vms_smg, prev: PUT_CHARS_WIDE, next: PUT_LINE)

10-SEP-2000 ZE.