src/insets/insetindex.h

   1 // -*- C++ -*-
   2 /* This file is part of*
   3  * ======================================================
   4  *
   5  *           LyX, The Document Processor
   6  *
   7  *          Copyright 1995 Matthias Ettrich
   8  *          Copyright 1996-2000 the LyX Team.
   9  *
  10  * ====================================================== */
  11
  12 #ifndef INSET_INDEX_H
  13 #define INSET_INDEX_H
  14
  15 #ifdef __GNUG__
  16 #pragma interface
  17 #endif
  18
  19 #include "insetcommand.h"
  20
  21 class Buffer;
  22 struct LaTeXFeatures;
  23
  24 // Created by Lgb 970227
  25
  26
  27 /** Used to insert index labels
  28   */
  29 class InsetIndex: public InsetCommand {
  30 public:
  31         ///
  32         InsetIndex() : InsetCommand("index") {}
  33         ///
  34         explicit
  35         InsetIndex(string const & key);
  36         ///
  37         ~InsetIndex();
  38         ///
  39         Inset * Clone() const { return new InsetIndex(contents);}
  40         ///
  41         void Edit(BufferView *, int, int, unsigned int);
  42         ///
  43         EDITABLE Editable() const
  44         {
  45                 return IS_EDITABLE;
  46         }
  47         ///
  48         string getScreenLabel() const;
  49 };
  50
  51
  52 class InsetPrintIndex : public InsetCommand {
  53 public:
  54         ///
  55         InsetPrintIndex();
  56         ///
  57         InsetPrintIndex(Buffer *);
  58         ///
  59         ~InsetPrintIndex();
  60         /// Updates needed features for this inset.
  61         void Validate(LaTeXFeatures & features) const;
  62         ///
  63         void Edit(BufferView *, int, int, unsigned int) {}
  64         ///
  65         EDITABLE Editable() const{
  66                 return IS_EDITABLE;
  67         }
  68         /// WHY is clone missing? (Lgb)
  69         ///
  70         bool display() const { return true; }
  71         ///
  72         Inset::Code LyxCode() const;
  73         ///
  74         string getScreenLabel() const;
  75 private:
  76         ///
  77         Buffer * owner;
  78 };
  79
  80 // this was shifted here rather than a separate
  81 // file because its little and only need by
  82 // insetindex.C and lyx_gui_misc.C ARRae 981020
  83 struct FD_index_form {
  84         FL_FORM * index_form;
  85         FL_OBJECT * key;
  86 };
  87
  88 extern FD_index_form * index_form;
  89 #endif