Back to index

tetex-bin  3.0
echo-area.h
Go to the documentation of this file.
00001 /* echo-area.h -- Functions used in reading information from the echo area.
00002    $Id: echo-area.h,v 1.4 2004/08/07 22:03:08 karl Exp $
00003 
00004    This file is part of GNU Info, a program for reading online documentation
00005    stored in Info format.
00006 
00007    Copyright (C) 1993, 1997, 2004 Free Software Foundation, Inc.
00008 
00009    This program is free software; you can redistribute it and/or modify
00010    it under the terms of the GNU General Public License as published by
00011    the Free Software Foundation; either version 2, or (at your option)
00012    any later version.
00013 
00014    This program is distributed in the hope that it will be useful,
00015    but WITHOUT ANY WARRANTY; without even the implied warranty of
00016    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00017    GNU General Public License for more details.
00018 
00019    You should have received a copy of the GNU General Public License
00020    along with this program; if not, write to the Free Software
00021    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
00022 
00023    Written by Brian Fox (bfox@ai.mit.edu). */
00024 
00025 #ifndef INFO_ECHO_AREA_H
00026 #define INFO_ECHO_AREA_H
00027 
00028 #define EA_MAX_INPUT 256
00029 
00030 extern int echo_area_is_active, info_aborted_echo_area;
00031 
00032 /* Non-zero means that the last command executed while reading input
00033    killed some text. */
00034 extern int echo_area_last_command_was_kill;
00035 
00036 extern void inform_in_echo_area (const char *message);
00037 extern void echo_area_inform_of_deleted_window (WINDOW *window);
00038 extern void echo_area_prep_read (void);
00039 extern VFunction *ea_last_executed_command;
00040 extern char * info_read_completing_internal (WINDOW *window, char *prompt,
00041     REFERENCE **completions, int force);
00042 
00043 /* Read a line of text in the echo area.  Return a malloc ()'ed string,
00044    or NULL if the user aborted out of this read.  WINDOW is the currently
00045    active window, so that we can restore it when we need to.  PROMPT, if
00046    non-null, is a prompt to print before reading the line. */
00047 extern char *info_read_in_echo_area (WINDOW *window, char *prompt);
00048 
00049 /* Read a line in the echo area with completion over COMPLETIONS.
00050    Takes arguments of WINDOW, PROMPT, and COMPLETIONS, a REFERENCE **. */
00051 char *info_read_completing_in_echo_area (WINDOW *window,
00052     char *prompt, REFERENCE **completions);
00053 
00054 /* Read a line in the echo area allowing completion over COMPLETIONS, but
00055    not requiring it.  Takes arguments of WINDOW, PROMPT, and COMPLETIONS,
00056    a REFERENCE **. */
00057 extern char *info_read_maybe_completing (WINDOW *window,
00058     char *prompt, REFERENCE **completions);
00059 
00060 extern void ea_insert (WINDOW *window, int count, unsigned char key);
00061 extern void ea_quoted_insert (WINDOW *window, int count, unsigned char key);
00062 extern void ea_beg_of_line (WINDOW *window, int count, unsigned char key);
00063 extern void ea_backward (WINDOW *window, int count, unsigned char key);
00064 extern void ea_delete (WINDOW *window, int count, unsigned char key);
00065 extern void ea_end_of_line (WINDOW *window, int count, unsigned char key);
00066 extern void ea_forward (WINDOW *window, int count, unsigned char key);
00067 extern void ea_abort (WINDOW *window, int count, unsigned char key);
00068 extern void ea_rubout (WINDOW *window, int count, unsigned char key);
00069 extern void ea_complete (WINDOW *window, int count, unsigned char key);
00070 extern void ea_newline (WINDOW *window, int count, unsigned char key);
00071 extern void ea_kill_line (WINDOW *window, int count, unsigned char key);
00072 extern void ea_backward_kill_line (WINDOW *window, int count, unsigned char key);
00073 extern void ea_transpose_chars (WINDOW *window, int count, unsigned char key);
00074 extern void ea_yank (WINDOW *window, int count, unsigned char key);
00075 extern void ea_tab_insert (WINDOW *window, int count, unsigned char key);
00076 extern void ea_possible_completions (WINDOW *window, int count, unsigned char key);
00077 extern void ea_backward_word (WINDOW *window, int count, unsigned char key);
00078 extern void ea_kill_word (WINDOW *window, int count, unsigned char key);
00079 extern void ea_forward_word (WINDOW *window, int count, unsigned char key);
00080 extern void ea_yank_pop (WINDOW *window, int count, unsigned char key);
00081 extern void ea_backward_kill_word (WINDOW *window, int count, unsigned char key);
00082 extern void ea_scroll_completions_window (WINDOW *window, int count,
00083     unsigned char key);
00084 
00085 #endif /* not INFO_ECHO_AREA_H */