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         ///
  27         InsetRef(InsetCommandParams const &);
  28         ///
  29         Inset * Clone() const { return new InsetRef(params()); }
  30         ///
  31         string getScreenLabel() const;
  32         ///
  33         EDITABLE Editable() const { return IS_EDITABLE; }
  34         ///
  35         Inset::Code LyxCode() const { return Inset::REF_CODE; }
  36         ///
  37         void Edit(BufferView *, int, int, unsigned int);
  38         ///
  39         bool display() const { return false; }
  40         ///
  41         int Latex(Buffer const *, std::ostream &,
  42                   bool fragile, bool free_spc) const;
  43         ///
  44         int Ascii(Buffer const *, std::ostream &) const;
  45         ///
  46         int Linuxdoc(Buffer const *, std::ostream &) const;
  47         ///
  48         int DocBook(Buffer const *, std::ostream &) const;
  49         ///
  50         void Validate(LaTeXFeatures & features) const;
  51 private:
  52         /// This function escapes 8-bit characters
  53         string escape(string const &) const;
  54 };
  55 #endif