contrib/texinfo/info/indices.h

   1 /* indices.h -- Functions defined in indices.c.
   2    $Id: indices.h,v 1.6 2007/07/01 21:20:30 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, 1997, 2004, 2007 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 3 of the License, or
  12    (at your option) 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, see <http://www.gnu.org/licenses/>.
  21
  22    Written by Brian Fox (bfox@ai.mit.edu). */
  23
  24 #ifndef INFO_INDICES_H
  25 #define INFO_INDICES_H
  26
  27 /* User-visible variable controls the output of info-index-next. */
  28 extern int show_index_match;
  29
  30 extern REFERENCE **info_indices_of_window (WINDOW *window);
  31 extern REFERENCE **info_indices_of_file_buffer (FILE_BUFFER *file_buffer);
  32 extern void info_apropos (char *string);
  33
  34 /* For every menu item in DIR, search the indices of that file for STRING. */
  35 REFERENCE **apropos_in_all_indices (char *search_string, int inform);
  36
  37 /* User visible functions declared in indices.c. */
  38 extern void info_index_search (WINDOW *window, int count, unsigned char key);
  39 extern void info_next_index_match (WINDOW *window, int count, unsigned char key);
  40 extern void info_index_apropos (WINDOW *window, int count, unsigned char key);
  41 extern void do_info_index_search (WINDOW *window, int count, char *search_string);
  42 extern int index_entry_exists (WINDOW *window, char *string);
  43
  44 #endif /* not INFO_INDICES_H */