Generated from display.c with ROBODoc v3.2.3 on Tue Aug 21 10:13:17 2001

TABLE OF CONTENTS

  1. lib5250/tn5250_display_new
  2. lib5250/tn5250_display_destroy
  3. lib5250/tn5250_display_config
  4. lib5250/tn5250_display_set_session
  5. lib5250/tn5250_display_push_dbuffer
  6. lib5250/tn5250_display_restore_dbuffer
  7. lib5250/tn5250_display_set_terminal
  8. lib5250/tn5250_display_update
  9. lib5250/tn5250_display_waitevent
  10. lib5250/tn5250_display_getkey
  11. lib5250/tn5250_display_beep
  12. lib5250/tn5250_display_set_pending_insert
  13. lib5250/tn5250_display_field_at
  14. lib5250/tn5250_display_current_field
  15. lib5250/tn5250_display_next_field
  16. lib5250/tn5250_display_prev_field
  17. lib5250/tn5250_display_set_cursor_home
  18. lib5250/tn5250_display_set_cursor_field
  19. lib5250/tn5250_display_set_cursor_next_field
  20. lib5250/tn5250_display_set_cursor_prev_field
  21. lib5250/tn5250_display_interactive_addch
  22. lib5250/tn5250_display_shift_right
  23. lib5250/tn5250_display_field_adjust
  24. lib5250/tn5250_display_do_keys
  25. lib5250/tn5250_display_do_key
  26. lib5250/tn5250_display_field_pad_and_adjust
  27. lib5250/tn5250_display_kf_field_exit
  28. lib5250/tn5250_display_kf_field_plus
  29. lib5250/tn5250_display_kf_field_minus
  30. lib5250/tn5250_display_do_aidkey
  31. lib5250/tn5250_display_kf_dup
  32. lib5250/tn5250_display_indicator_set
  33. lib5250/tn5250_display_indicator_clear
  34. lib5250/tn5250_display_clear_unit
  35. lib5250/tn5250_display_clear_unit_alternate
  36. lib5250/tn5250_display_clear_format_table
  37. lib5250/tn5250_display_kf_backspace
  38. lib5250/tn5250_display_kf_left
  39. lib5250/tn5250_display_kf_right
  40. lib5250/tn5250_display_kf_up
  41. lib5250/tn5250_display_kf_down
  42. lib5250/tn5250_display_kf_insert
  43. lib5250/tn5250_display_kf_tab
  44. lib5250/tn5250_display_kf_backtab
  45. lib5250/tn5250_display_kf_end
  46. lib5250/tn5250_display_kf_home
  47. lib5250/tn5250_display_kf_delete
  48. lib5250/tn5250_display_save_msg_line
  49. lib5250/tn5250_display_set_char_map

lib5250/tn5250_display_new

NAME
    tn5250_display_new
SYNOPSIS
    ret = tn5250_display_new ();
INPUTS
    None
DESCRIPTION
    DOCUMENT ME!!!

lib5250/tn5250_display_destroy

NAME
    tn5250_display_destroy
SYNOPSIS
    tn5250_display_destroy (This);
INPUTS
    Tn5250Display *      This       - 
DESCRIPTION
    DOCUMENT ME!!!

lib5250/tn5250_display_config

NAME
    tn5250_display_config
SYNOPSIS
    tn5250_display_config (This, config);
INPUTS
    Tn5250Display *      This       - 
    Tn5250Config *       config     -
DESCRIPTION
    Applies configuration to the display.

lib5250/tn5250_display_set_session

NAME
    tn5250_display_set_session
SYNOPSIS
    tn5250_display_set_session (This, s);
INPUTS
    Tn5250Display *      This       - 
    struct _Tn5250Session * s          - 
DESCRIPTION
    DOCUMENT ME!!!

lib5250/tn5250_display_push_dbuffer

NAME
    tn5250_display_push_dbuffer
SYNOPSIS
    ret = tn5250_display_push_dbuffer (This);
INPUTS
    Tn5250Display *      This       - 
DESCRIPTION
    Create a new display buffer and assign the old one an id so we can
    later restore it.  Return the id which must be > 0.

lib5250/tn5250_display_restore_dbuffer

NAME
    tn5250_display_restore_dbuffer
SYNOPSIS
    tn5250_display_restore_dbuffer (This, id);
INPUTS
    Tn5250Display *      This       - 
    Tn5250DBuffer *      id         - 
DESCRIPTION
    Delete the current dbuffer and replace it with the one with id `id'.

lib5250/tn5250_display_set_terminal

NAME
    tn5250_display_set_terminal
SYNOPSIS
    tn5250_display_set_terminal (This, term);
INPUTS
    Tn5250Display *      This       - 
    Tn5250Terminal *     term       - 
DESCRIPTION
    Set the terminal associated with this display.

lib5250/tn5250_display_update

NAME
    tn5250_display_update
SYNOPSIS
    tn5250_display_update (This);
INPUTS
    Tn5250Display *      This       - 
DESCRIPTION
    Update the terminal's representation of the display.

lib5250/tn5250_display_waitevent

NAME
    tn5250_display_waitevent
SYNOPSIS
    ret = tn5250_display_waitevent (This);
INPUTS
    Tn5250Display *      This       - 
DESCRIPTION
    Wait for a terminal event.  Handle keystrokes while we're at it
    and don't return those to the session (what would it do with them?)

lib5250/tn5250_display_getkey

NAME
    tn5250_display_getkey
SYNOPSIS
    ret = tn5250_display_getkey (This);
INPUTS
    Tn5250Display *      This       - 
DESCRIPTION
    Get the next keystroke in the keyboard buffer.

lib5250/tn5250_display_beep

NAME
    tn5250_display_beep
SYNOPSIS
    tn5250_display_beep (This);
INPUTS
    Tn5250Display *      This       - 
DESCRIPTION
    The required beep function.

lib5250/tn5250_display_set_pending_insert

NAME
    tn5250_display_set_pending_insert
SYNOPSIS
    tn5250_display_set_pending_insert (This, y, x);
INPUTS
    Tn5250Display *      This       - 
    int                  y          - 
    int                  x          - 
DESCRIPTION
    Set the pending insert flag and the insert cursor position.

lib5250/tn5250_display_field_at

NAME
    tn5250_display_field_at
SYNOPSIS
    ret = tn5250_display_field_at (This, y, x);
INPUTS
    Tn5250Display *      This       - 
    int                  y          - 
    int                  x          - 
DESCRIPTION
    DOCUMENT ME!!!

lib5250/tn5250_display_current_field

NAME
    tn5250_display_current_field
SYNOPSIS
    ret = tn5250_display_current_field (This);
INPUTS
    Tn5250Display *      This       - 
DESCRIPTION
    Find the field currently under the cursor.  The answer might be NULL
    if there is no field under the cursor.

lib5250/tn5250_display_next_field

NAME
    tn5250_display_next_field
SYNOPSIS
    ret = tn5250_display_next_field (This);
INPUTS
    Tn5250Display *      This       - 
DESCRIPTION
    Return a pointer to the next field after the current one which is not
    a bypass field.

lib5250/tn5250_display_prev_field

NAME
    tn5250_display_prev_field
SYNOPSIS
    ret = tn5250_display_prev_field (This);
INPUTS
    Tn5250Display *      This       - 
DESCRIPTION
    Return a pointer to the first preceding field which is not a bypass
    field.

lib5250/tn5250_display_set_cursor_home

NAME
    tn5250_display_set_cursor_home
SYNOPSIS
    tn5250_display_set_cursor_home (This);
INPUTS
    Tn5250Display *      This       - 
DESCRIPTION
    Set the cursor to the home position on the current display buffer.
    The home position is:
       1) the IC position, if we have one. 
       2) the first position of the first non-bypass field, if we have on.
       3) 0,0

lib5250/tn5250_display_set_cursor_field

NAME
    tn5250_display_set_cursor_field
SYNOPSIS
    tn5250_display_set_cursor_field (This, field);
INPUTS
    Tn5250Display *      This       - 
    Tn5250Field *        field      - 
DESCRIPTION
    Set the cursor position on the current display buffer to the home
    position of the specified field.

lib5250/tn5250_display_set_cursor_next_field

NAME
    tn5250_display_set_cursor_next_field
SYNOPSIS
    tn5250_display_set_cursor_next_field (This);
INPUTS
    Tn5250Display *      This       - 
DESCRIPTION
    Move the cursor to the next non-bypass field.  This will move the
    cursor to the home position if there are no non-bypass fields.

lib5250/tn5250_display_set_cursor_prev_field

NAME
    tn5250_display_set_cursor_prev_field
SYNOPSIS
    tn5250_display_set_cursor_prev_field (This);
INPUTS
    Tn5250Display *      This       - 
DESCRIPTION
    Move the cursor to the previous non-bypass field.  This will move the
    cursor to the home position if there are no non-bypass fields.

lib5250/tn5250_display_interactive_addch

NAME
    tn5250_display_interactive_addch
SYNOPSIS
    tn5250_display_interactive_addch (This, ch);
INPUTS
    Tn5250Display *      This       - 
    unsigned char        ch         - 
DESCRIPTION
    Add a character to the display, and set the field's MDT flag.  This
    is meant to be called by the keyboard handler when the user is
    entering data.

lib5250/tn5250_display_shift_right

NAME
    tn5250_display_shift_right
SYNOPSIS
    tn5250_display_shift_right (This, field, fill);
INPUTS
    Tn5250Display *      This       - 
    Tn5250Field *        field      - 
    unsigned char        fill       - 
DESCRIPTION
    Move all the data characters in the field to the right-hand side of
    the field and left-fill the field with `fill' characters.

lib5250/tn5250_display_field_adjust

NAME
    tn5250_display_field_adjust
SYNOPSIS
    tn5250_display_field_adjust (This, field);
INPUTS
    Tn5250Display *      This       - 
    Tn5250Field *        field      - 
DESCRIPTION
    Adjust the field data as required by the Field Format Word.  This is
    called from tn5250_display_kf_field_exit.

lib5250/tn5250_display_do_keys

NAME
    tn5250_display_do_keys
SYNOPSIS
    tn5250_display_do_keys (This);
INPUTS
    Tn5250Display *      This       - 
DESCRIPTION
    Handle keys from the terminal until we run out or are in the X SYSTEM
    state.

lib5250/tn5250_display_do_key

NAME
    tn5250_display_do_key
SYNOPSIS
    tn5250_display_do_key (This, key);
INPUTS
    Tn5250Display *      This       - 
    int                  key        - 
DESCRIPTION
    Translate a keystroke and handle it.

lib5250/tn5250_display_field_pad_and_adjust

NAME
    tn5250_display_field_pad_and_adjust
SYNOPSIS
    tn5250_display_field_pad_and_adjust(This, field);
INPUTS
    Tn5250Display *      This       - 
    Tn5250Display *      field      -
DESCRIPTION
    This nulls out the remainder of the field (after the
    cursor position) except for the +/- sign, and then right
    adjusts the field.  Does NOT do auto-enter, and does NOT
    advance to the next field.

lib5250/tn5250_display_kf_field_exit

NAME
    tn5250_display_kf_field_exit
SYNOPSIS
    tn5250_display_kf_field_exit (This);
INPUTS
    Tn5250Display *      This       - 
DESCRIPTION
    Process a field exit function.

lib5250/tn5250_display_kf_field_plus

NAME
    tn5250_display_kf_field_plus
SYNOPSIS
    tn5250_display_kf_field_plus (This);
INPUTS
    Tn5250Display *      This       - 
DESCRIPTION
    Process a field plus function.

lib5250/tn5250_display_kf_field_minus

NAME
    tn5250_display_kf_field_minus
SYNOPSIS
    tn5250_display_kf_field_minus (This);
INPUTS
    Tn5250Display *      This       - 
DESCRIPTION
    Process a field minus function.

lib5250/tn5250_display_do_aidkey

NAME
    tn5250_display_do_aidkey
SYNOPSIS
    tn5250_display_do_aidkey (This, aidcode);
INPUTS
    Tn5250Display *      This       - 
    int                  aidcode    - 
DESCRIPTION
    Handle an aid code.

lib5250/tn5250_display_kf_dup

NAME
    tn5250_display_kf_dup
SYNOPSIS
    tn5250_display_kf_dup (This);
INPUTS
    Tn5250Display *      This       - 
DESCRIPTION
    Process a DUP key function.

lib5250/tn5250_display_indicator_set

NAME
    tn5250_display_indicator_set
SYNOPSIS
    tn5250_display_indicator_set (This, inds);
INPUTS
    Tn5250Display *      This       - 
    int                  inds       - 
DESCRIPTION
    Set the specified indicators and set a flag noting that the indicators
    must be refreshed.

lib5250/tn5250_display_indicator_clear

NAME
    tn5250_display_indicator_clear
SYNOPSIS
    tn5250_display_indicator_clear (This, inds);
INPUTS
    Tn5250Display *      This       - 
    int                  inds       - 
DESCRIPTION
    Clear the specified indicators and set a flag noting that the indicators
    must be refreshed.

lib5250/tn5250_display_clear_unit

NAME
    tn5250_display_clear_unit
SYNOPSIS
    tn5250_display_clear_unit (This);
INPUTS
    Tn5250Display *      This       - 
DESCRIPTION
    Clear the display and set the display size to 24x80.

lib5250/tn5250_display_clear_unit_alternate

NAME
    tn5250_display_clear_unit_alternate
SYNOPSIS
    tn5250_display_clear_unit_alternate (This);
INPUTS
    Tn5250Display *      This       - 
DESCRIPTION
    Clear the display and set the display size to 27x132.

lib5250/tn5250_display_clear_format_table

NAME
    tn5250_display_clear_format_table
SYNOPSIS
    tn5250_display_clear_format_table (This);
INPUTS
    Tn5250Display *      This       - 
DESCRIPTION
    Clear the format table.

lib5250/tn5250_display_kf_backspace

NAME
    tn5250_display_kf_backspace
SYNOPSIS
    tn5250_display_kf_backspace (This);
INPUTS
    Tn5250Display *      This       - 
DESCRIPTION
    Move the cursor left one position unless on the first position of
    field, in which case we move to the last position of the previous
    field. (Or inhibit if we aren't on a field).

lib5250/tn5250_display_kf_left

NAME
    tn5250_display_kf_left
SYNOPSIS
    tn5250_display_kf_left (This);
INPUTS
    Tn5250Display *      This       - 
DESCRIPTION
    Move the cursor left.

lib5250/tn5250_display_kf_right

NAME
    tn5250_display_kf_right
SYNOPSIS
    tn5250_display_kf_right (This);
INPUTS
    Tn5250Display *      This       - 
DESCRIPTION
    Move the cursor right.

lib5250/tn5250_display_kf_up

NAME
    tn5250_display_kf_up
SYNOPSIS
    tn5250_display_kf_up (This);
INPUTS
    Tn5250Display *      This       - 
DESCRIPTION
    Move the cursor up.

lib5250/tn5250_display_kf_down

NAME
    tn5250_display_kf_down
SYNOPSIS
    tn5250_display_kf_down (This);
INPUTS
    Tn5250Display *      This       - 
DESCRIPTION
    Move the cursor down.

lib5250/tn5250_display_kf_insert

NAME
    tn5250_display_kf_insert
SYNOPSIS
    tn5250_display_kf_insert (This);
INPUTS
    Tn5250Display *      This       - 
DESCRIPTION
    Toggle the insert indicator.

lib5250/tn5250_display_kf_tab

NAME
    tn5250_display_kf_tab
SYNOPSIS
    tn5250_display_kf_tab (This);
INPUTS
    Tn5250Display *      This       - 
DESCRIPTION
    Tab function.

lib5250/tn5250_display_kf_backtab

NAME
    tn5250_display_kf_backtab
SYNOPSIS
    tn5250_display_kf_backtab (This);
INPUTS
    Tn5250Display *      This       - 
DESCRIPTION
    Backwards tab function.

lib5250/tn5250_display_kf_end

NAME
    tn5250_display_kf_end
SYNOPSIS
    tn5250_display_kf_end (This);
INPUTS
    Tn5250Display *      This       - 
DESCRIPTION
    End key function.

lib5250/tn5250_display_kf_home

NAME
    tn5250_display_kf_home
SYNOPSIS
    tn5250_display_kf_home (This);
INPUTS
    Tn5250Display *      This       - 
DESCRIPTION
    Home key function.

lib5250/tn5250_display_kf_delete

NAME
    tn5250_display_kf_delete
SYNOPSIS
    tn5250_display_kf_delete (This);
INPUTS
    Tn5250Display *      This       - 
DESCRIPTION
    Delete key function.

lib5250/tn5250_display_save_msg_line

NAME
    tn5250_display_save_msg_line
SYNOPSIS
    tn5250_display_save_msg_line (This);
INPUTS
    Tn5250Display *      This       - 
DESCRIPTION
    Save the current message line.

lib5250/tn5250_display_set_char_map

NAME
    tn5250_display_set_char_map
SYNOPSIS
    tn5250_display_set_char_map (display, "37");
INPUTS
    Tn5250Display *      display    - Pointer to the display object.
    const char *         name       - Name of translation map to use.
DESCRIPTION
    Save the current message line.