Museum

Home

Lab Overview

Retrotechnology Articles

⇒ Online Manual

Media Vault

Software Library

Restoration Projects

Artifacts Sought

VAXTPU GET_INFO(WINDOW_VARIABLE) — VMS 5.2

 GET_INFO(WINDOW_VARIABLE)

 For an overview of the GET_INFO built-in, see the HELP topic GET_INFO.
 The following strings can be used for parameter2 when parameter1 is a
 window variable:

 Parameter 2    | Return Value (Parameter 1 is a window variable)
 ---------------+-----------------------------------------------------------
 "before_bol"   | (1 or 0) - Returns 1 if cursor is to the left of the
                |            the current line's left margin; otherwise 0.
                |            The return value  has no meaning if "beyond_
                |            eob" is true.
 "beyond_eob"   | (1 or 0)   Indicates whether the cursor is located after
                |            after the end of the current buffer.
 "beyond_eol"   | (1 or 0) - Indicates whether the cursor is beyond the end
                |            of the current line.  The return value has no
                |            has no meaning if "beyond_eob" is true.
 "blink_status" | (1 or 0) - Indicates whether BLINK is one of the video
                |            attributes of the status line
 "blink_video"  | (1 or 0) - Indicates whether BLINK is one of the video
                |            attributes of the window
 "bold_status"  | (1 or 0) - Indicates  whether BOLD is one of the video
                |            attributes of the status line
 "bold_video"   | (1 or 0) - Indicates whether BOLD is one of the video
                |            attributes of the window
 "bottom"       | Integer  - The number of rows or the last visible row of
                |            the specified window or the specified window's
                |            text area.  The third parameter can be any
                |            of the following keywords:  WINDOW, TEXT,
                |            VISIBLE_WINDOW, VISIBLE_TEXT.
 "bound"        | (1 or 0) - Indicates whether the cursor is located on a
                |            character
 "buffer"       | Buffer   - The buffer associated with window
                | 0        - if none
 "current_row"  | Integer  - Row in which the cursor was most recently
                |            located
 "current       | Integer  - Column in which the cursor was mot recently
  column"       |            located
 "key_map_list" | string   - The string naming the key map list associated
                |            with the specified window.
 "left"         | Integer  - The number of the leftmost column or leftmost
                |            visible column of the specified window or the
                |            window's text area.  The third parameter can be any
                |            of the following keywords:  WINDOW, TEXT,
                |            VISIBLE_WINDOW, VISIBLE_TEXT.
 "length"       | Integer  - The number of rows or visible rows in the specified
                |            window or the specified window's text area.
                |            The third parameter can be any
                |            of the following keywords:  WINDOW, TEXT,
                |            VISIBLE_WINDOW, VISIBLE_TEXT.
 "middle_of_    | (1 or 0) - Indicates whether the cursor is in the middle
  tab"          |            of a tab. Returns 1 if insert a space will not
                |            cause white space to be added to the line; 0
                |            otherwise.  The return value has no meaning if
                |            "beyond_eob" is true
 "next"         | Window   - Next window in VAXTPU's internal list
                | 0          if last
 "no_video"     | (1 or 0) - Indicates whether the video attribute of the
 "no_video_     | (1 or 0) - Indicates whether the video attribute of the
  status"       |            window's status line is NONE
                |            window is NONE
 "original      | Integer  - Screen line number of the bottom of the window
                |            when it was created (NOT including the status
                |            line)
 "original_     | Integer  - Number of lines in the window (including the
  length"       |            status line)
 "original_     | Integer  - Screen line number of the top of the window
  top"          |            when it was created
 "pad"          | (1 or 0) - Indicates whether the window is blank-padded
                |            at the right
 "previous"     | Window   - Previous window in VAXTPU's internal list
                | 0        - if first
 "reverse_      | (1 or 0) - Indicates whether REVERSE is one of the video
  status"       |            attributes of the status line
 "right"        | Integer  - The number of the last column or the last
                |            visible column of the specified window
                |            or the window's text area. The third parameter can
                |            be any of the following keywords:  WINDOW, TEXT,
                |            VISIBLE_WINDOW, VISIBLE_TEXT.
 "scroll"       | (1 or 0) - Indicates whether scrolling is enabled for the
                |            window
 "scroll_amount"| Integer  - Number of lines to scroll
 "scroll_bar"   | Widget   - The specified scroll bar widget if it exists,
                |  or 0      0 if the widget does not exist.  The third
                |            parameter can be either of the following
                |            keywords:  HORIZONTAL or VERTICAL.
 "scroll_bar_   | (1 or 0) - Indicates whether automatic adjustment of
  auto_thumb    |            the scroll bar slider is enabled. The third
                |            parameter can be either of the following
                |            keywords:  HORIZONTAL or VERTICAL.
 "scroll        | Integer  - Bottom of the scrolling area; this is an offset
  bottom"       |            from the bottom screen line
 "scroll_top"   | Integer  - Top of the scrolling area; this is an offset
                |            from the top screen line
 "shift_amount" | Integer  - Number of columns the window is shifted to the
                |            right or the left.
 "special_      | (1 or 0) - Indicates whether SPECIAL_GRAPHICS is a video
  graphics_     |            video attribute of the window's status line
 "status_line"  | String   - Text of status line
                | 0        - if none
 "status_video" | Keyword  - If there is no video or only one video attribute
                |            for the window's status line, the appropriate
                |            video keyword is returned (NONE, BLINK, BOLD,
                |            REVERSE, UNDERLINE, or SPECIAL_GRAPHICS)
                | 1        - if there are multiple video attributes
                | 0        - if there is no status line
 "text"         | Keyword  - Indicates the keyword used with SET(TEXT...) to
                |            control text display in a window.  The keywords
                |            can be returned are BLANK_TABS, GRAPHIC_TABS,
                |            or NO_TRANSLATE
 "top"          | Integer  - The number of the first row or first visible
                |            row of the specified window or the window's
                |            text area. The third parameter can be any
                |            of the following keywords:  WINDOW, TEXT,
                |            VISIBLE_WINDOW, VISIBLE_TEXT.
 "visible"      | (1 or 0) - Indicates whether window is mapped
                |            to the screen and is not occluded
 "visible_top"  | Integer  - Screen line number of the visible top of the
                |            window
 "visible_      | Integer  - Screen line number of the visible bottom of the
   bottom"      |            window (NOT including the status line)
 "visible_      | Integer  - Visible length of the window (including the
  length        |            status line)
 "underline_    | (1 or 0) - Indicates whether UNDERLINE is one of the video
  status"       |            attributes of the status line
 "underline_    | (1 or 0) - Indicates whether UNDERLINE is one of the video
  video"        |            attributes of the window
 "video"        | Keyword  - If there is no video or only one video
                |            attribute for the window, the single video key-
                |            word is returned (NONE, BLINK, BOLD, REVERSE,
                |            or UNDERLINE)
                | 0        - if there are multiple video attributes
 "width"        | Integer  - Width of the window
 ---------------+-----------------------------------------------------------

Typewritten Software • bear@typewritten.org • Edmonds, WA 98026