src/insets/insetindex.h

   1 // -*- C++ -*-
   2 /**
   3  * \file insetindex.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Lars Gullik Bjønnes
   8  *
   9  * Full author contact details are available in file CREDITS
  10  */
  11
  12 #ifndef INSET_INDEX_H
  13 #define INSET_INDEX_H
  14
  15
  16 #include "insetcommand.h"
  17
  18 struct LaTeXFeatures;
  19
  20 /** Used to insert index labels
  21   */
  22 class InsetIndex : public InsetCommand {
  23 public:
  24         ///
  25         InsetIndex(InsetCommandParams const &);
  26         ///
  27         //InsetIndex(InsetCommandParams const &, bool same_id);
  28         ///
  29         ~InsetIndex();
  30         ///
  31         virtual Inset * clone(Buffer const &) const {
  32                 return new InsetIndex(params());
  33         }
  34         ///
  35         //virtual Inset * clone(Buffer const &, bool same_id) const {
  36         //      return new InsetIndex(params(), same_id);
  37         //}
  38         ///
  39         dispatch_result localDispatch(FuncRequest const & cmd);
  40         ///
  41         string const getScreenLabel(Buffer const *) const;
  42         ///
  43         EDITABLE editable() const { return IS_EDITABLE; }
  44         ///
  45         Inset::Code lyxCode() const;
  46         ///
  47         int docbook(Buffer const *, std::ostream &, bool mixcont) const;
  48 };
  49
  50
  51 class InsetPrintIndex : public InsetCommand {
  52 public:
  53         ///
  54         InsetPrintIndex(InsetCommandParams const &);
  55         ///
  56         //InsetPrintIndex(InsetCommandParams const &, bool same_id);
  57         ///
  58         ~InsetPrintIndex();
  59         ///
  60         Inset * clone(Buffer const &) const {
  61                 return new InsetPrintIndex(params());
  62         }
  63         ///
  64         //Inset * clone(Buffer const &, bool same_id) const {
  65         //      return new InsetPrintIndex(params(), same_id);
  66         //}
  67         ///
  68         //dispatch_result localDispatch(FuncRequest const & cmd);
  69         /// Updates needed features for this inset.
  70         void validate(LaTeXFeatures & features) const;
  71         ///
  72         EDITABLE editable() const { return NOT_EDITABLE; }
  73         ///
  74         bool display() const { return true; }
  75         ///
  76         Inset::Code lyxCode() const;
  77         ///
  78         string const getScreenLabel(Buffer const *) const;
  79         ///
  80         virtual bool needFullRow() const { return true; }
  81 };
  82
  83 #endif