Back to index

tetex-bin  3.0
variables.h
Go to the documentation of this file.
00001 /* variables.h -- Description of user visible variables in Info.
00002    $Id: variables.h,v 1.3 2004/04/11 17:56:46 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_VARIABLES_H
00026 #define INFO_VARIABLES_H
00027 
00028 /* A variable (in the Info sense) is an integer value with a user-visible
00029    name.  You may supply an array of strings to complete over when the
00030    variable is set; in that case, the variable is set to the index of the
00031    string that the user chose.  If you supply a null list, the user can
00032    set the variable to a numeric value. */
00033 
00034 /* Structure describing a user visible variable. */
00035 typedef struct {
00036   char *name;                   /* Polite name. */
00037   char *doc;                    /* Documentation string. */
00038   int *value;                   /* Address of value. */
00039   char **choices;               /* Array of strings or NULL if numeric only. */
00040 } VARIABLE_ALIST;
00041 
00042 /* Read the name of an Info variable in the echo area and return the
00043    address of a VARIABLE_ALIST member.  A return value of NULL indicates
00044    that no variable could be read. */
00045 extern VARIABLE_ALIST *read_variable_name (char *prompt, WINDOW *window);
00046 
00047 /* Make an array of REFERENCE which actually contains the names of the
00048    variables available in Info. */
00049 extern REFERENCE **make_variable_completions_array (void);
00050 
00051 /* Set the value of an info variable. */
00052 extern void set_variable (WINDOW *window, int count, unsigned char key);
00053 extern void describe_variable (WINDOW *window, int count, unsigned char key);
00054 
00055 /* The list of user-visible variables. */
00056 extern int auto_footnotes_p;
00057 extern int auto_tiling_p;
00058 extern int terminal_use_visible_bell_p;
00059 extern int info_error_rings_bell_p;
00060 extern int gc_compressed_files;
00061 extern int show_index_match;
00062 extern int info_scroll_behaviour;
00063 extern int window_scroll_step;
00064 extern int ISO_Latin_p;
00065 
00066 #endif /* not INFO_VARIABLES_H */