src/insets/InsetRef.h

   1 // -*- C++ -*-
   2 /**
   3  * \file InsetRef.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author José Matos
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef INSET_REF_H
  13 #define INSET_REF_H
  14
  15 #include "InsetCommand.h"
  16
  17
  18 namespace lyx {
  19
  20
  21 /// The reference inset
  22 class InsetRef : public InsetCommand {
  23 public:
  24         struct type_info {
  25                 ///
  26                 std::string latex_name;
  27                 ///
  28                 std::string gui_name;
  29                 ///
  30                 std::string short_gui_name;
  31         };
  32         static type_info types[];
  33         ///
  34         static int getType(std::string const & name);
  35         ///
  36         static std::string const & getName(int type);
  37
  38
  39         InsetRef(Buffer const & buffer, InsetCommandParams const &);
  40
  41         ///
  42         bool isLabeled() const { return true; }
  43         ///
  44         docstring screenLabel() const;
  45         ///
  46         EDITABLE editable() const { return IS_EDITABLE; }
  47         ///
  48         InsetCode lyxCode() const { return REF_CODE; }
  49         ///
  50         DisplayType display() const { return Inline; }
  51         ///
  52         int latex(odocstream &, OutputParams const &) const;
  53         ///
  54         int plaintext(odocstream &, OutputParams const &) const;
  55         ///
  56         int docbook(odocstream &, OutputParams const &) const;
  57         /// the string that is passed to the TOC
  58         void textString(odocstream &) const;
  59         ///
  60         void validate(LaTeXFeatures & features) const;
  61         ///
  62         static ParamInfo const & findInfo(std::string const &);
  63         ///
  64         static std::string defaultCommand() { return "ref"; };
  65         ///
  66         static bool isCompatibleCommand(std::string const & s);
  67         ///
  68         void updateLabels(ParIterator const & it);
  69         ///
  70         void addToToc(ParConstIterator const &) const;
  71 protected:
  72         ///
  73         InsetRef(InsetRef const &);
  74 private:
  75         ///
  76         Inset * clone() const { return new InsetRef(*this); }
  77         ///
  78         bool isLatex;
  79         ///
  80         mutable docstring screen_label_;
  81 };
  82
  83 } // namespace lyx
  84
  85 #endif