gnu/dist/texinfo/info/indices.h

   1 /*      $NetBSD$        */
   2
   3 /* indices.h -- Functions defined in indices.c.
   4    Id: indices.h,v 1.3 2004/04/11 17:56:45 karl Exp
   5
   6    This file is part of GNU Info, a program for reading online documentation
   7    stored in Info format.
   8
   9    Copyright (C) 1993, 1997, 2004 Free Software Foundation, Inc.
  10
  11    This program is free software; you can redistribute it and/or modify
  12    it under the terms of the GNU General Public License as published by
  13    the Free Software Foundation; either version 2, or (at your option)
  14    any later version.
  15
  16    This program is distributed in the hope that it will be useful,
  17    but WITHOUT ANY WARRANTY; without even the implied warranty of
  18    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19    GNU General Public License for more details.
  20
  21    You should have received a copy of the GNU General Public License
  22    along with this program; if not, write to the Free Software
  23    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  24
  25    Written by Brian Fox (bfox@ai.mit.edu). */
  26
  27 #ifndef INFO_INDICES_H
  28 #define INFO_INDICES_H
  29
  30 /* User-visible variable controls the output of info-index-next. */
  31 extern int show_index_match;
  32
  33 extern REFERENCE **info_indices_of_window (WINDOW *window);
  34 extern REFERENCE **info_indices_of_file_buffer (FILE_BUFFER *file_buffer);
  35 extern void info_apropos (char *string);
  36
  37 /* For every menu item in DIR, search the indices of that file for STRING. */
  38 REFERENCE **apropos_in_all_indices (char *search_string, int inform);
  39
  40 /* User visible functions declared in indices.c. */
  41 extern void info_index_search (WINDOW *window, int count, unsigned char key);
  42 extern void info_next_index_match (WINDOW *window, int count, unsigned char key);
  43 extern void info_index_apropos (WINDOW *window, int count, unsigned char key);
  44 extern void do_info_index_search (WINDOW *window, int count, char *search_string);
  45 extern int index_entry_exists (WINDOW *window, char *string);
  46
  47 #endif /* not INFO_INDICES_H */