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();
  28         ///
  29         virtual std::auto_ptr<InsetBase> clone() const {
  30                 return std::auto_ptr<InsetBase>(new InsetIndex(params()));
  31         }
  32         ///
  33         std::string const getScreenLabel(Buffer const &) const;
  34         ///
  35         EDITABLE editable() const { return IS_EDITABLE; }
  36         ///
  37         InsetOld::Code lyxCode() const;
  38         ///
  39         int docbook(Buffer const &, std::ostream &,
  40                     LatexRunParams const &) const;
  41 protected:
  42         ///
  43         virtual
  44         DispatchResult
  45         priv_dispatch(FuncRequest const & cmd, idx_type &, pos_type &);
  46 };
  47
  48
  49 class InsetPrintIndex : public InsetCommand {
  50 public:
  51         ///
  52         InsetPrintIndex(InsetCommandParams const &);
  53         ///
  54         ~InsetPrintIndex();
  55         ///
  56         virtual std::auto_ptr<InsetBase> clone() const {
  57                 return std::auto_ptr<InsetBase>(new InsetPrintIndex(params()));
  58         }
  59         /// Updates needed features for this inset.
  60         void validate(LaTeXFeatures & features) const;
  61         ///
  62         EDITABLE editable() const { return NOT_EDITABLE; }
  63         ///
  64         InsetOld::Code lyxCode() const;
  65         ///
  66         bool display() const { return true; }
  67         ///
  68         std::string const getScreenLabel(Buffer const &) const;
  69         ///
  70         void metrics(MetricsInfo &, Dimension &) const;
  71         ///
  72         void draw(PainterInfo & pi, int x, int y) const;
  73 private:
  74         ///
  75         mutable unsigned int center_indent_;
  76 };
  77
  78 #endif