// -*- C++ -*-
-/* This file is part of*
- * ======================================================
+/**
+ * \file insetref.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
- * LyX, The Document Processor
- *
- * Copyright 1997 LyX Team (this file was created this year)
- *
- * ====================================================== */
+ * \author José Matos
+ *
+ * Full author contact details are available in file CREDITS.
+ */
#ifndef INSET_REF_H
#define INSET_REF_H
-#ifdef __GNUG__
-#pragma interface
-#endif
-
#include "insetcommand.h"
-struct LaTeXFeatures;
-/** The reference inset
- */
+namespace lyx {
+
+
+/// The reference inset
class InsetRef : public InsetCommand {
public:
+ struct type_info {
+ ///
+ std::string latex_name;
+ ///
+ std::string gui_name;
+ ///
+ std::string short_gui_name;
+ };
+ static type_info types[];
///
- InsetRef(InsetCommandParams const &, Buffer const &);
+ static int getType(std::string const & name);
///
- Inset * Clone(Buffer const & buffer) const {
- return new InsetRef(params(), buffer);
- }
+ static std::string const & getName(int type);
+
+
+ InsetRef(InsetCommandParams const &, Buffer const &);
+
///
- string const getScreenLabel() const;
+ docstring const getScreenLabel(Buffer const &) const;
///
- EDITABLE Editable() const { return IS_EDITABLE; }
+ EDITABLE editable() const { return IS_EDITABLE; }
///
- Inset::Code LyxCode() const { return Inset::REF_CODE; }
+ Code lyxCode() const { return REF_CODE; }
///
- void Edit(BufferView *, int, int, unsigned int);
- ///
bool display() const { return false; }
///
- int Latex(Buffer const *, std::ostream &,
- bool fragile, bool free_spc) const;
+ int latex(Buffer const &, odocstream &, OutputParams const &) const;
///
- int Ascii(Buffer const *, std::ostream &, int linelen) const;
+ int plaintext(Buffer const &, odocstream &, OutputParams const &) const;
///
- int Linuxdoc(Buffer const *, std::ostream &) const;
+ int docbook(Buffer const &, odocstream &, OutputParams const &) const;
+ /// the string that is passed to the TOC
+ virtual int textString(Buffer const &, odocstream &,
+ OutputParams const &) const;
///
- int DocBook(Buffer const *, std::ostream &) const;
+ void validate(LaTeXFeatures & features) const;
+protected:
+ InsetRef(InsetRef const &);
+
///
- void Validate(LaTeXFeatures & features) const;
+ virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
private:
- /// This function escapes 8-bit characters
- string const escape(string const &) const;
+ virtual std::auto_ptr<InsetBase> doClone() const {
+ return std::auto_ptr<InsetBase>(new InsetRef(*this));
+ }
///
bool isLatex;
};
+
+} // namespace lyx
+
#endif