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 /// The reference inset
  21 class InsetRef : public InsetCommand {
  22 public:
  23         struct type_info {
  24                 ///
  25                 std::string latex_name;
  26                 ///
  27                 std::string gui_name;
  28                 ///
  29                 std::string short_gui_name;
  30         };
  31         static const type_info types[];
  32         ///
  33         static int getType(std::string const & name);
  34         ///
  35         static std::string const & getName(int type);
  36
  37         ///
  38         InsetRef(Buffer * buffer, InsetCommandParams const &);
  39
  40         /// \name Public functions inherited from Inset class
  41         //@{
  42         ///
  43         bool isLabeled() const { return true; }
  44         ///
  45         docstring toolTip(BufferView const &, int, int) const
  46                 { return tooltip_; }
  47         ///
  48   docstring getTOCString() const;
  49         ///
  50         bool hasSettings() const { return true; }
  51         ///
  52         InsetCode lyxCode() const { return REF_CODE; }
  53         ///
  54         DisplayType display() const { return Inline; }
  55         ///
  56         void latex(otexstream &, OutputParams const &) const;
  57         ///
  58         int plaintext(odocstringstream & ods, OutputParams const & op,
  59                       size_t max_length = INT_MAX) const;
  60         ///
  61         int docbook(odocstream &, OutputParams const &) const;
  62         ///
  63         docstring xhtml(XHTMLStream &, OutputParams const &) const;
  64         ///
  65         void toString(odocstream &) const;
  66         ///
  67         void forOutliner(docstring &, size_t) const;
  68         ///
  69         void validate(LaTeXFeatures & features) const;
  70         ///
  71         void updateBuffer(ParIterator const & it, UpdateType);
  72         ///
  73         void addToToc(DocIterator const & di, bool output_active) const;
  74         ///
  75         bool forceLTR() const { return true; }
  76         //@}
  77
  78         /// \name Static public methods obligated for InsetCommand derived classes
  79         //@{
  80         ///
  81         static ParamInfo const & findInfo(std::string const &);
  82         ///
  83         static std::string defaultCommand() { return "ref"; }
  84         ///
  85         static bool isCompatibleCommand(std::string const & s);
  86         //@}
  87
  88         //FIXME: private
  89         /// \name Private functions inherited from InsetCommand class
  90         //@{
  91         ///
  92         docstring screenLabel() const { return screen_label_; }
  93         //@}
  94
  95 protected:
  96         ///
  97         InsetRef(InsetRef const &);
  98
  99 private:
 100         /// \name Private functions inherited from Inset class
 101         //@{
 102         ///
 103         Inset * clone() const { return new InsetRef(*this); }
 104         //@}
 105
 106         /// \return the label with things that need to be escaped escaped
 107         docstring getEscapedLabel(OutputParams const &) const;
 108         /// \return the command for a formatted reference to ref
 109         /// \param label we're cross-referencing
 110         /// \param argument for reference command
 111         /// \param prefix of the label (before :)
 112         docstring getFormattedCmd(docstring const & ref, docstring & label,
 113                         docstring & prefix) const;
 114
 115         ///
 116         mutable docstring screen_label_;
 117         ///
 118         mutable docstring tooltip_;
 119 };
 120
 121
 122 } // namespace lyx
 123
 124 #endif // INSET_REF_H