Back to index

tetex-bin  3.0
indices.h
Go to the documentation of this file.
00001 /* indices.h -- Functions defined in indices.c.
00002    $Id: indices.h,v 1.3 2004/04/11 17:56:45 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_INDICES_H
00026 #define INFO_INDICES_H
00027 
00028 /* User-visible variable controls the output of info-index-next. */
00029 extern int show_index_match;
00030 
00031 extern REFERENCE **info_indices_of_window (WINDOW *window);
00032 extern REFERENCE **info_indices_of_file_buffer (FILE_BUFFER *file_buffer);
00033 extern void info_apropos (char *string);
00034 
00035 /* For every menu item in DIR, search the indices of that file for STRING. */
00036 REFERENCE **apropos_in_all_indices (char *search_string, int inform);
00037 
00038 /* User visible functions declared in indices.c. */
00039 extern void info_index_search (WINDOW *window, int count, unsigned char key);
00040 extern void info_next_index_match (WINDOW *window, int count, unsigned char key);
00041 extern void info_index_apropos (WINDOW *window, int count, unsigned char key);
00042 extern void do_info_index_search (WINDOW *window, int count, char *search_string);
00043 extern int index_entry_exists (WINDOW *window, char *string);
00044 
00045 #endif /* not INFO_INDICES_H */