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         void doDispatch(Cursor & cur, FuncRequest & cmd);
  44         ///
  45         bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus & status) const;
  46         ///
  47         bool isLabeled() const { return true; }
  48         ///
  49         docstring toolTip(BufferView const &, int, int) const
  50                 { return tooltip_; }
  51         ///
  52         docstring getTOCString() const;
  53         ///
  54         bool hasSettings() const { return true; }
  55         ///
  56         InsetCode lyxCode() const { return REF_CODE; }
  57         ///
  58         void latex(otexstream &, OutputParams const &) const;
  59         ///
  60         int plaintext(odocstringstream & ods, OutputParams const & op,
  61                       size_t max_length = INT_MAX) const;
  62         ///
  63         int docbook(odocstream &, OutputParams const &) const;
  64         ///
  65         docstring xhtml(XHTMLStream &, OutputParams const &) const;
  66         ///
  67         void toString(odocstream &) const;
  68         ///
  69         void forOutliner(docstring &, size_t const, bool const) const;
  70         ///
  71         void validate(LaTeXFeatures & features) const;
  72         ///
  73         void updateBuffer(ParIterator const & it, UpdateType);
  74         ///
  75         void addToToc(DocIterator const & di, bool output_active,
  76                                   UpdateType utype, TocBackend & backend) const;
  77         ///
  78         bool forceLTR() const { return true; }
  79         //@}
  80
  81         /// \name Static public methods obligated for InsetCommand derived classes
  82         //@{
  83         ///
  84         static ParamInfo const & findInfo(std::string const &);
  85         ///
  86         static std::string defaultCommand() { return "ref"; }
  87         ///
  88         static bool isCompatibleCommand(std::string const & s);
  89         //@}
  90
  91 protected:
  92         ///
  93         InsetRef(InsetRef const &);
  94
  95 private:
  96         /// \name Private functions inherited from Inset class
  97         //@{
  98         ///
  99         Inset * clone() const { return new InsetRef(*this); }
 100         //@}
 101
 102         /// \name Private functions inherited from InsetCommand class
 103         //@{
 104         ///
 105         docstring screenLabel() const;
 106         //@}
 107
 108         /// \return the label with things that need to be escaped escaped
 109         docstring getEscapedLabel(OutputParams const &) const;
 110         /// \return the command for a formatted reference to ref
 111         /// \param label we're cross-referencing
 112         /// \param argument for reference command
 113         /// \param prefix of the label (before :)
 114         docstring getFormattedCmd(docstring const & ref, docstring & label,
 115                         docstring & prefix, docstring const & caps) const;
 116
 117         ///
 118         mutable docstring screen_label_;
 119         ///
 120         mutable bool broken_;
 121         ///
 122         mutable docstring tooltip_;
 123 };
 124
 125
 126 } // namespace lyx
 127
 128 #endif // INSET_REF_H