home *** CD-ROM | disk | FTP | other *** search
/ Dream 52 / Amiga_Dream_52.iso / OS2 / gnuinfo.zip / info / variables.h < prev    next >
C/C++ Source or Header  |  1997-07-15  |  3KB  |  66 lines
  1. /* variables.h -- Description of user visible variables in Info.
  2.    $Id: variables.h,v 1.3 1997/07/15 18:44:23 karl Exp $
  3.  
  4.    This file is part of GNU Info, a program for reading online documentation
  5.    stored in Info format.
  6.  
  7.    Copyright (C) 1993, 97 Free Software Foundation, Inc.
  8.  
  9.    This program is free software; you can redistribute it and/or modify
  10.    it under the terms of the GNU General Public License as published by
  11.    the Free Software Foundation; either version 2, or (at your option)
  12.    any later version.
  13.  
  14.    This program is distributed in the hope that it will be useful,
  15.    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16.    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17.    GNU General Public License for more details.
  18.  
  19.    You should have received a copy of the GNU General Public License
  20.    along with this program; if not, write to the Free Software
  21.    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  22.  
  23.    Written by Brian Fox (bfox@ai.mit.edu). */
  24.  
  25. #ifndef INFO_VARIABLES_H
  26. #define INFO_VARIABLES_H
  27.  
  28. /* A variable (in the Info sense) is an integer value with a user-visible
  29.    name.  You may supply an array of strings to complete over when the
  30.    variable is set; in that case, the variable is set to the index of the
  31.    string that the user chose.  If you supply a null list, the user can
  32.    set the variable to a numeric value. */
  33.  
  34. /* Structure describing a user visible variable. */
  35. typedef struct {
  36.   char *name;                   /* Polite name. */
  37.   char *doc;                    /* Documentation string. */
  38.   int *value;                   /* Address of value. */
  39.   char **choices;               /* Array of strings or NULL if numeric only. */
  40. } VARIABLE_ALIST;
  41.  
  42. /* Read the name of an Info variable in the echo area and return the
  43.    address of a VARIABLE_ALIST member.  A return value of NULL indicates
  44.    that no variable could be read. */
  45. extern VARIABLE_ALIST *read_variable_name ();
  46.  
  47. /* Make an array of REFERENCE which actually contains the names of the
  48.    variables available in Info. */
  49. extern REFERENCE **make_variable_completions_array ();
  50.  
  51. /* Set the value of an info variable. */
  52. extern void set_variable ();
  53.  
  54. /* The list of user-visible variables. */
  55. extern int auto_footnotes_p;
  56. extern int auto_tiling_p;
  57. extern int terminal_use_visible_bell_p;
  58. extern int info_error_rings_bell_p;
  59. extern int gc_compressed_files;
  60. extern int show_index_match;
  61. extern int info_scroll_behaviour;
  62. extern int window_scroll_step;
  63. extern int ISO_Latin_p;
  64.  
  65. #endif /* not INFO_VARIABLES_H */
  66.