1999-01-14 19:35:19 +00:00
|
|
|
/* variables.h -- Description of user visible variables in Info.
|
2005-05-23 10:46:22 +00:00
|
|
|
$Id: variables.h,v 1.3 2004/04/11 17:56:46 karl Exp $
|
1997-01-11 02:12:38 +00:00
|
|
|
|
1999-01-14 19:35:19 +00:00
|
|
|
This file is part of GNU Info, a program for reading online documentation
|
1997-01-11 02:12:38 +00:00
|
|
|
stored in Info format.
|
|
|
|
|
|
2005-05-23 10:46:22 +00:00
|
|
|
Copyright (C) 1993, 1997, 2004 Free Software Foundation, Inc.
|
1997-01-11 02:12:38 +00:00
|
|
|
|
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
|
|
|
it under the terms of the GNU General Public License as published by
|
|
|
|
|
the Free Software Foundation; either version 2, or (at your option)
|
|
|
|
|
any later version.
|
|
|
|
|
|
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
|
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
|
GNU General Public License for more details.
|
|
|
|
|
|
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
|
|
|
along with this program; if not, write to the Free Software
|
|
|
|
|
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
|
|
|
|
|
|
|
|
|
Written by Brian Fox (bfox@ai.mit.edu). */
|
|
|
|
|
|
1999-01-14 19:35:19 +00:00
|
|
|
#ifndef INFO_VARIABLES_H
|
|
|
|
|
#define INFO_VARIABLES_H
|
1997-01-11 02:12:38 +00:00
|
|
|
|
|
|
|
|
/* A variable (in the Info sense) is an integer value with a user-visible
|
|
|
|
|
name. You may supply an array of strings to complete over when the
|
|
|
|
|
variable is set; in that case, the variable is set to the index of the
|
|
|
|
|
string that the user chose. If you supply a null list, the user can
|
|
|
|
|
set the variable to a numeric value. */
|
|
|
|
|
|
|
|
|
|
/* Structure describing a user visible variable. */
|
|
|
|
|
typedef struct {
|
1999-01-14 19:35:19 +00:00
|
|
|
char *name; /* Polite name. */
|
|
|
|
|
char *doc; /* Documentation string. */
|
|
|
|
|
int *value; /* Address of value. */
|
|
|
|
|
char **choices; /* Array of strings or NULL if numeric only. */
|
1997-01-11 02:12:38 +00:00
|
|
|
} VARIABLE_ALIST;
|
|
|
|
|
|
|
|
|
|
/* Read the name of an Info variable in the echo area and return the
|
|
|
|
|
address of a VARIABLE_ALIST member. A return value of NULL indicates
|
|
|
|
|
that no variable could be read. */
|
2005-05-23 10:46:22 +00:00
|
|
|
extern VARIABLE_ALIST *read_variable_name (char *prompt, WINDOW *window);
|
1997-01-11 02:12:38 +00:00
|
|
|
|
|
|
|
|
/* Make an array of REFERENCE which actually contains the names of the
|
|
|
|
|
variables available in Info. */
|
2005-05-23 10:46:22 +00:00
|
|
|
extern REFERENCE **make_variable_completions_array (void);
|
1997-01-11 02:12:38 +00:00
|
|
|
|
|
|
|
|
/* Set the value of an info variable. */
|
2005-05-23 10:46:22 +00:00
|
|
|
extern void set_variable (WINDOW *window, int count, unsigned char key);
|
|
|
|
|
extern void describe_variable (WINDOW *window, int count, unsigned char key);
|
1997-01-11 02:12:38 +00:00
|
|
|
|
|
|
|
|
/* The list of user-visible variables. */
|
|
|
|
|
extern int auto_footnotes_p;
|
|
|
|
|
extern int auto_tiling_p;
|
|
|
|
|
extern int terminal_use_visible_bell_p;
|
|
|
|
|
extern int info_error_rings_bell_p;
|
|
|
|
|
extern int gc_compressed_files;
|
|
|
|
|
extern int show_index_match;
|
|
|
|
|
extern int info_scroll_behaviour;
|
|
|
|
|
extern int window_scroll_step;
|
|
|
|
|
extern int ISO_Latin_p;
|
|
|
|
|
|
1999-01-14 19:35:19 +00:00
|
|
|
#endif /* not INFO_VARIABLES_H */
|
