src/mathed/InsetMathRef.h

   1 // -*- C++ -*-
   2 /**
   3  * \file InsetMathRef.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author André Pönitz
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef REF_INSET_H
  13 #define REF_INSET_H
  14
  15
  16 #include "CommandInset.h"
  17
  18
  19 namespace lyx {
  20 class Buffer;
  21
  22 // for \ref
  23 class InsetMathRef : public CommandInset {
  24 public:
  25         ///
  26         InsetMathRef(Buffer * buf);
  27         ///
  28         explicit InsetMathRef(Buffer * buf, docstring const & data);
  29         ///
  30         //void write(WriteStream & os) const;
  31         ///
  32         void infoize(odocstream & os) const;
  33         ///
  34         docstring const screenLabel() const;
  35         ///
  36         void validate(LaTeXFeatures & features) const;
  37         ///
  38         virtual InsetMathRef * asRefInset() { return this; }
  39
  40         /// docbook output
  41         int docbook(odocstream & os, OutputParams const &) const;
  42         /// generate something that will be understood by the Dialogs.
  43         std::string const createDialogStr(std::string const & name) const;
  44
  45         struct ref_type_info {
  46                 ///
  47                 docstring latex_name;
  48                 ///
  49                 docstring gui_name;
  50                 ///
  51                 docstring short_gui_name;
  52         };
  53         static ref_type_info types[];
  54         ///
  55         static int getType(docstring const & name);
  56         ///
  57         static docstring const & getName(int type);
  58         ///
  59         InsetCode lyxCode() const { return MATH_REF_CODE; }
  60
  61 protected:
  62         ///
  63         virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
  64         ///
  65         bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
  66 private:
  67         ///
  68         virtual Inset * clone() const;
  69 };
  70
  71
  72
  73 } // namespace lyx
  74 #endif