Generated from display.c with ROBODoc v3.2.3 on Tue Aug 21 10:13:17 2001
TABLE OF CONTENTS
- lib5250/tn5250_display_new
- lib5250/tn5250_display_destroy
- lib5250/tn5250_display_config
- lib5250/tn5250_display_set_session
- lib5250/tn5250_display_push_dbuffer
- lib5250/tn5250_display_restore_dbuffer
- lib5250/tn5250_display_set_terminal
- lib5250/tn5250_display_update
- lib5250/tn5250_display_waitevent
- lib5250/tn5250_display_getkey
- lib5250/tn5250_display_beep
- lib5250/tn5250_display_set_pending_insert
- lib5250/tn5250_display_field_at
- lib5250/tn5250_display_current_field
- lib5250/tn5250_display_next_field
- lib5250/tn5250_display_prev_field
- lib5250/tn5250_display_set_cursor_home
- lib5250/tn5250_display_set_cursor_field
- lib5250/tn5250_display_set_cursor_next_field
- lib5250/tn5250_display_set_cursor_prev_field
- lib5250/tn5250_display_interactive_addch
- lib5250/tn5250_display_shift_right
- lib5250/tn5250_display_field_adjust
- lib5250/tn5250_display_do_keys
- lib5250/tn5250_display_do_key
- lib5250/tn5250_display_field_pad_and_adjust
- lib5250/tn5250_display_kf_field_exit
- lib5250/tn5250_display_kf_field_plus
- lib5250/tn5250_display_kf_field_minus
- lib5250/tn5250_display_do_aidkey
- lib5250/tn5250_display_kf_dup
- lib5250/tn5250_display_indicator_set
- lib5250/tn5250_display_indicator_clear
- lib5250/tn5250_display_clear_unit
- lib5250/tn5250_display_clear_unit_alternate
- lib5250/tn5250_display_clear_format_table
- lib5250/tn5250_display_kf_backspace
- lib5250/tn5250_display_kf_left
- lib5250/tn5250_display_kf_right
- lib5250/tn5250_display_kf_up
- lib5250/tn5250_display_kf_down
- lib5250/tn5250_display_kf_insert
- lib5250/tn5250_display_kf_tab
- lib5250/tn5250_display_kf_backtab
- lib5250/tn5250_display_kf_end
- lib5250/tn5250_display_kf_home
- lib5250/tn5250_display_kf_delete
- lib5250/tn5250_display_save_msg_line
- lib5250/tn5250_display_set_char_map
NAME
tn5250_display_new
SYNOPSIS
ret = tn5250_display_new ();
INPUTS
None
DESCRIPTION
DOCUMENT ME!!!
NAME
tn5250_display_destroy
SYNOPSIS
tn5250_display_destroy (This);
INPUTS
Tn5250Display * This -
DESCRIPTION
DOCUMENT ME!!!
NAME
tn5250_display_config
SYNOPSIS
tn5250_display_config (This, config);
INPUTS
Tn5250Display * This -
Tn5250Config * config -
DESCRIPTION
Applies configuration to the display.
NAME
tn5250_display_set_session
SYNOPSIS
tn5250_display_set_session (This, s);
INPUTS
Tn5250Display * This -
struct _Tn5250Session * s -
DESCRIPTION
DOCUMENT ME!!!
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.
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'.
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.
NAME
tn5250_display_update
SYNOPSIS
tn5250_display_update (This);
INPUTS
Tn5250Display * This -
DESCRIPTION
Update the terminal's representation of the display.
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?)
NAME
tn5250_display_getkey
SYNOPSIS
ret = tn5250_display_getkey (This);
INPUTS
Tn5250Display * This -
DESCRIPTION
Get the next keystroke in the keyboard buffer.
NAME
tn5250_display_beep
SYNOPSIS
tn5250_display_beep (This);
INPUTS
Tn5250Display * This -
DESCRIPTION
The required beep function.
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.
NAME
tn5250_display_field_at
SYNOPSIS
ret = tn5250_display_field_at (This, y, x);
INPUTS
Tn5250Display * This -
int y -
int x -
DESCRIPTION
DOCUMENT ME!!!
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.
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.
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.
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
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.
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.
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.
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.
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.
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.
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.
NAME
tn5250_display_do_key
SYNOPSIS
tn5250_display_do_key (This, key);
INPUTS
Tn5250Display * This -
int key -
DESCRIPTION
Translate a keystroke and handle it.
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.
NAME
tn5250_display_kf_field_exit
SYNOPSIS
tn5250_display_kf_field_exit (This);
INPUTS
Tn5250Display * This -
DESCRIPTION
Process a field exit function.
NAME
tn5250_display_kf_field_plus
SYNOPSIS
tn5250_display_kf_field_plus (This);
INPUTS
Tn5250Display * This -
DESCRIPTION
Process a field plus function.
NAME
tn5250_display_kf_field_minus
SYNOPSIS
tn5250_display_kf_field_minus (This);
INPUTS
Tn5250Display * This -
DESCRIPTION
Process a field minus function.
NAME
tn5250_display_do_aidkey
SYNOPSIS
tn5250_display_do_aidkey (This, aidcode);
INPUTS
Tn5250Display * This -
int aidcode -
DESCRIPTION
Handle an aid code.
NAME
tn5250_display_kf_dup
SYNOPSIS
tn5250_display_kf_dup (This);
INPUTS
Tn5250Display * This -
DESCRIPTION
Process a DUP key function.
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.
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.
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.
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.
NAME
tn5250_display_clear_format_table
SYNOPSIS
tn5250_display_clear_format_table (This);
INPUTS
Tn5250Display * This -
DESCRIPTION
Clear the format table.
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).
NAME
tn5250_display_kf_left
SYNOPSIS
tn5250_display_kf_left (This);
INPUTS
Tn5250Display * This -
DESCRIPTION
Move the cursor left.
NAME
tn5250_display_kf_right
SYNOPSIS
tn5250_display_kf_right (This);
INPUTS
Tn5250Display * This -
DESCRIPTION
Move the cursor right.
NAME
tn5250_display_kf_up
SYNOPSIS
tn5250_display_kf_up (This);
INPUTS
Tn5250Display * This -
DESCRIPTION
Move the cursor up.
NAME
tn5250_display_kf_down
SYNOPSIS
tn5250_display_kf_down (This);
INPUTS
Tn5250Display * This -
DESCRIPTION
Move the cursor down.
NAME
tn5250_display_kf_insert
SYNOPSIS
tn5250_display_kf_insert (This);
INPUTS
Tn5250Display * This -
DESCRIPTION
Toggle the insert indicator.
NAME
tn5250_display_kf_tab
SYNOPSIS
tn5250_display_kf_tab (This);
INPUTS
Tn5250Display * This -
DESCRIPTION
Tab function.
NAME
tn5250_display_kf_backtab
SYNOPSIS
tn5250_display_kf_backtab (This);
INPUTS
Tn5250Display * This -
DESCRIPTION
Backwards tab function.
NAME
tn5250_display_kf_end
SYNOPSIS
tn5250_display_kf_end (This);
INPUTS
Tn5250Display * This -
DESCRIPTION
End key function.
NAME
tn5250_display_kf_home
SYNOPSIS
tn5250_display_kf_home (This);
INPUTS
Tn5250Display * This -
DESCRIPTION
Home key function.
NAME
tn5250_display_kf_delete
SYNOPSIS
tn5250_display_kf_delete (This);
INPUTS
Tn5250Display * This -
DESCRIPTION
Delete key function.
NAME
tn5250_display_save_msg_line
SYNOPSIS
tn5250_display_save_msg_line (This);
INPUTS
Tn5250Display * This -
DESCRIPTION
Save the current message line.
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.