lyx_mirror/src/insets/InsetRef.h
Richard Heck b83564d82c Inset::textString --> Inset::tocString
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@27378 a592a061-630c-0410-9148-cb99ea01b6c8
2008-11-10 22:45:14 +00:00

86 lines
1.7 KiB
C++

// -*- C++ -*-
/**
* \file InsetRef.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author José Matos
*
* Full author contact details are available in file CREDITS.
*/
#ifndef INSET_REF_H
#define INSET_REF_H
#include "InsetCommand.h"
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[];
///
static int getType(std::string const & name);
///
static std::string const & getName(int type);
InsetRef(Buffer const & buffer, InsetCommandParams const &);
///
bool isLabeled() const { return true; }
///
docstring screenLabel() const;
///
EDITABLE editable() const { return IS_EDITABLE; }
///
InsetCode lyxCode() const { return REF_CODE; }
///
DisplayType display() const { return Inline; }
///
int latex(odocstream &, OutputParams const &) const;
///
int plaintext(odocstream &, OutputParams const &) const;
///
int docbook(odocstream &, OutputParams const &) const;
/// the string that is passed to the TOC
void tocString(odocstream &) const;
///
void validate(LaTeXFeatures & features) const;
///
static ParamInfo const & findInfo(std::string const &);
///
static std::string defaultCommand() { return "ref"; };
///
static bool isCompatibleCommand(std::string const & s);
///
void updateLabels(ParIterator const & it);
///
void addToToc(DocIterator const &);
protected:
///
InsetRef(InsetRef const &);
private:
///
Inset * clone() const { return new InsetRef(*this); }
///
bool isLatex;
///
mutable docstring screen_label_;
};
} // namespace lyx
#endif