src/insets/insetref.h

   1 // -*- C++ -*-
   2 /* This file is part of*
   3  * ======================================================
   4  *
   5  *           LyX, The Document Processor
   6  *
   7  *          Copyright 1997 LyX Team (this file was created this year)
   8  *
   9  * ====================================================== */
  10
  11 #ifndef INSET_REF_H
  12 #define INSET_REF_H
  13
  14 #ifdef __GNUG__
  15 #pragma interface
  16 #endif
  17
  18 #include "insetcommand.h"
  19
  20 struct LaTeXFeatures;
  21
  22 /** The reference inset
  23  */
  24 class InsetRef : public InsetCommand {
  25 public:
  26         struct type_info {
  27                 ///
  28                 string latex_name;
  29                 ///
  30                 string gui_name;
  31                 ///
  32                 string short_gui_name;
  33         };
  34         static type_info types[];
  35         ///
  36         static int getType(string const & name);
  37         ///
  38         static string const & getName(int type);
  39
  40         ///
  41         InsetRef(InsetCommandParams const &, Buffer const &);
  42         ///
  43         Inset * Clone(Buffer const & buffer) const {
  44                 return new InsetRef(params(), buffer);
  45         }
  46         ///
  47         string const getScreenLabel() const;
  48         ///
  49         EDITABLE Editable() const { return IS_EDITABLE; }
  50         ///
  51         Inset::Code LyxCode() const { return Inset::REF_CODE; }
  52         ///
  53         void Edit(BufferView *, int, int, unsigned int);
  54         ///
  55         bool display() const { return false; }
  56         ///
  57         int Latex(Buffer const *, std::ostream &,
  58                   bool fragile, bool free_spc) const;
  59         ///
  60         int Ascii(Buffer const *, std::ostream &, int linelen) const;
  61         ///
  62         int Linuxdoc(Buffer const *, std::ostream &) const;
  63         ///
  64         int DocBook(Buffer const *, std::ostream &) const;
  65         ///
  66         void Validate(LaTeXFeatures & features) const;
  67 private:
  68         /// This function escapes 8-bit characters
  69         string const escape(string const &) const;
  70         ///
  71         bool isLatex;
  72 };
  73 #endif