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 "InsetCollapsible.h"
  17 #include "InsetCommand.h"
  18
  19
  20 namespace lyx {
  21
  22 class InsetIndexParams {
  23 public:
  24         ///
  25         explicit InsetIndexParams(docstring const & b = docstring())
  26                 : index(b) {}
  27         ///
  28         void write(std::ostream & os) const;
  29         ///
  30         void read(Lexer & lex);
  31         ///
  32         docstring index;
  33 };
  34
  35
  36 /** Used to insert index labels
  37   */
  38 class InsetIndex : public InsetCollapsible {
  39 public:
  40         ///
  41         InsetIndex(Buffer *, InsetIndexParams const &);
  42         ///
  43         static std::string params2string(InsetIndexParams const &);
  44         ///
  45         static void string2params(std::string const &, InsetIndexParams &);
  46         ///
  47         int rowFlags() const override { return CanBreakBefore | CanBreakAfter; }
  48 private:
  49         ///
  50         bool hasSettings() const override;
  51         ///
  52         InsetCode lyxCode() const override { return INDEX_CODE; }
  53         ///
  54         docstring layoutName() const override { return from_ascii("Index"); }
  55         ///
  56         ColorCode labelColor() const override;
  57         ///
  58         void write(std::ostream & os) const override;
  59         ///
  60         void read(Lexer & lex) override;
  61         ///
  62         void docbook(XMLStream &, OutputParams const &) const override;
  63         ///
  64         docstring xhtml(XMLStream &, OutputParams const &) const override;
  65         ///
  66         void latex(otexstream &, OutputParams const &) const override;
  67         ///
  68         bool showInsetDialog(BufferView *) const override;
  69         ///
  70         bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const override;
  71         ///
  72         void doDispatch(Cursor & cur, FuncRequest & cmd) override;
  73         /// should paragraph indentation be omitted in any case?
  74         bool neverIndent() const override { return true; }
  75         ///
  76         void addToToc(DocIterator const & di, bool output_active,
  77                                   UpdateType utype, TocBackend & backend) const override;
  78         ///
  79         docstring toolTip(BufferView const & bv, int x, int y) const override;
  80         ///
  81         docstring const buttonLabel(BufferView const & bv) const override;
  82         /// Updates needed features for this inset.
  83         void validate(LaTeXFeatures & features) const override;
  84         ///
  85         std::string contextMenuName() const override;
  86         ///
  87         Inset * clone() const override { return new InsetIndex(*this); }
  88         /// Is the content of this inset part of the immediate text sequence?
  89         bool isPartOfTextSequence() const override { return false; }
  90
  91         ///
  92         friend class InsetIndexParams;
  93         ///
  94         InsetIndexParams params_;
  95 };
  96
  97
  98 class InsetPrintIndex : public InsetCommand {
  99 public:
 100         ///
 101         InsetPrintIndex(Buffer * buf, InsetCommandParams const &);
 102
 103         /// \name Public functions inherited from Inset class
 104         //@{
 105         ///
 106         InsetCode lyxCode() const override { return INDEX_PRINT_CODE; }
 107         ///
 108         void latex(otexstream &, OutputParams const &) const override;
 109         ///
 110         docstring xhtml(XMLStream &, OutputParams const &) const override;
 111         ///
 112         void doDispatch(Cursor & cur, FuncRequest & cmd) override;
 113         ///
 114         bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const override;
 115         ///
 116         void updateBuffer(ParIterator const & it, UpdateType, bool const deleted = false) override;
 117         ///
 118         std::string contextMenuName() const override;
 119         /// Updates needed features for this inset.
 120         void validate(LaTeXFeatures & features) const override;
 121         ///
 122         bool hasSettings() const override;
 123         ///
 124         int rowFlags() const override { return Display; }
 125         //@}
 126
 127         /// \name Static public methods obligated for InsetCommand derived classes
 128         //@{
 129         ///
 130         static ParamInfo const & findInfo(std::string const &);
 131         ///
 132         static std::string defaultCommand() { return "printindex"; }
 133         ///
 134         static bool isCompatibleCommand(std::string const & s);
 135         //@}
 136
 137 private:
 138         /// \name Private functions inherited from Inset class
 139         //@{
 140         ///
 141         Inset * clone() const override { return new InsetPrintIndex(*this); }
 142         //@}
 143
 144         /// \name Private functions inherited from InsetCommand class
 145         //@{
 146         ///
 147         docstring screenLabel() const override;
 148         //@}
 149 };
 150
 151
 152 } // namespace lyx
 153
 154 #endif