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 "InsetCollapsable.h"
  17 #include "InsetCommand.h"
  18
  19
  20 namespace lyx {
  21
  22 /** Used to insert index labels
  23   */
  24 class InsetIndex : public InsetCollapsable {
  25 public:
  26         ///
  27         InsetIndex(Buffer const &);
  28 private:
  29         ///
  30         EDITABLE editable() const { return HIGHLY_EDITABLE; }
  31         ///
  32         InsetCode lyxCode() const { return INDEX_CODE; }
  33         ///
  34         docstring name() const { return from_ascii("Index"); }
  35         ///
  36         void write(std::ostream & os) const;
  37         ///
  38         int docbook(odocstream &, OutputParams const &) const;
  39         ///
  40         int latex(odocstream &, OutputParams const &) const;
  41         /// should paragraph indendation be omitted in any case?
  42         bool neverIndent() const { return true; }
  43         /// should paragraphs be forced to use the empty layout?
  44         virtual bool forcePlainLayout(idx_type = 0) const { return true; }
  45         /// should the user be allowed to customize alignment, etc.?
  46         virtual bool allowParagraphCustomization(idx_type = 0) const { return false; }
  47         ///
  48         void textString(odocstream &) const;
  49         ///
  50         void addToToc(DocIterator const &);
  51         ///
  52         Inset * clone() const { return new InsetIndex(*this); }
  53 };
  54
  55
  56 class InsetPrintIndex : public InsetCommand {
  57 public:
  58         ///
  59         InsetPrintIndex(InsetCommandParams const &);
  60
  61         ///
  62         static ParamInfo const & findInfo(std::string const &);
  63         ///
  64         static std::string defaultCommand() { return "printindex"; };
  65         ///
  66         static bool isCompatibleCommand(std::string const & s)
  67                 { return s == "printindex"; }
  68 private:
  69         /// Updates needed features for this inset.
  70         void validate(LaTeXFeatures & features) const;
  71         ///
  72         EDITABLE editable() const { return NOT_EDITABLE; }
  73         ///
  74         InsetCode lyxCode() const;
  75         ///
  76         DisplayType display() const { return AlignCenter; }
  77         ///
  78         docstring screenLabel() const;
  79         ///
  80         Inset * clone() const { return new InsetPrintIndex(*this); }
  81 };
  82
  83
  84 } // namespace lyx
  85
  86 #endif