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
  16 #include "insetcommand.h"
  17
  18 struct LaTeXFeatures;
  19
  20 /** The reference inset
  21  */
  22 class InsetRef : public InsetCommand {
  23 public:
  24         struct type_info {
  25                 ///
  26                 string latex_name;
  27                 ///
  28                 string gui_name;
  29                 ///
  30                 string short_gui_name;
  31         };
  32         static type_info types[];
  33         ///
  34         static int getType(string const & name);
  35         ///
  36         static string const & getName(int type);
  37
  38
  39         InsetRef(InsetCommandParams const &, Buffer const &);
  40
  41         InsetRef(InsetRef const &);
  42
  43         ~InsetRef();
  44         ///
  45         virtual std::auto_ptr<InsetBase> clone() const {
  46                 return std::auto_ptr<InsetBase>(new InsetRef(*this));
  47         }
  48         ///
  49         dispatch_result localDispatch(FuncRequest const & cmd);
  50         ///
  51         string const getScreenLabel(Buffer const &) const;
  52         ///
  53         EDITABLE editable() const { return IS_EDITABLE; }
  54         ///
  55         InsetOld::Code lyxCode() const { return InsetOld::REF_CODE; }
  56         ///
  57         bool display() const { return false; }
  58         ///
  59         int latex(Buffer const &, std::ostream &,
  60                   LatexRunParams const &) const;
  61         ///
  62         int ascii(Buffer const &, std::ostream &, int linelen) const;
  63         ///
  64         int linuxdoc(Buffer const &, std::ostream &) const;
  65         ///
  66         int docbook(Buffer const &, std::ostream &, bool mixcont) const;
  67         ///
  68         void validate(LaTeXFeatures & features) const;
  69 private:
  70         ///
  71         bool isLatex;
  72 };
  73 #endif