* Full author contact details are available in file CREDITS.
*/
-#ifndef INSET_CITE_H
-#define INSET_CITE_H
-
+#ifndef INSET_CITATION_H
+#define INSET_CITATION_H
#include "InsetCommand.h"
+#include "InsetCode.h"
-#include "Biblio.h"
+#include "BiblioInfo.h"
namespace lyx {
+/////////////////////////////////////////////////////////////////////////
+//
+// InsetCitation
+//
+/////////////////////////////////////////////////////////////////////////
-/** Used to insert citations
- */
-class InsetCitation : public InsetCommand {
+/// Used to insert citations
+class InsetCitation : public InsetCommand
+{
public:
///
- InsetCitation(InsetCommandParams const &);
+ explicit InsetCitation(InsetCommandParams const &);
+ ///
+ bool isLabeled() const { return true; }
///
- docstring const getScreenLabel(Buffer const &) const;
+ docstring screenLabel() const;
///
EDITABLE editable() const { return IS_EDITABLE; }
///
- Inset::Code lyxCode() const { return Inset::CITE_CODE; }
+ InsetCode lyxCode() const { return CITE_CODE; }
///
- int latex(Buffer const &, odocstream &,
- OutputParams const &) const;
+ int latex(odocstream &, OutputParams const &) const;
///
- int plaintext(Buffer const &, odocstream &,
- OutputParams const &) const;
+ int plaintext(odocstream &, OutputParams const &) const;
///
- int docbook(Buffer const &, odocstream &,
- OutputParams const &) const;
+ int docbook(odocstream &, OutputParams const &) const;
/// the string that is passed to the TOC
- virtual int textString(Buffer const &, odocstream &,
- OutputParams const &) const;
+ void textString(odocstream &) const;
///
void validate(LaTeXFeatures &) const;
///
- void replaceContents(std::string const & from, std::string const & to);
+ void updateLabels(ParIterator const & it);
+ ///
+ void addToToc(DocIterator const &);
+ ///
+ static ParamInfo const & findInfo(std::string const &);
+ // FIXME This is the locus of the design problem we have.
+ // It really ought to do what default_cite_command() does,
+ // but to do that it needs to know what CiteEngine we are
+ // using.
+ static std::string defaultCommand() { return "cite"; }
+ ///
+ static bool isCompatibleCommand(std::string const & cmd);
+ ///
+ virtual docstring contextMenu(BufferView const & bv, int x, int y) const;
private:
- virtual std::auto_ptr<Inset> doClone() const
- {
- return std::auto_ptr<Inset>(new InsetCitation(params()));
- }
-
+ ///
+ Inset * clone() const { return new InsetCitation(*this); }
+ /// we'll eventually want to be able to get info on this from the
+ /// various CiteEngines
+ static ParamInfo param_info_;
/// This function does the donkey work of creating the pretty label
- docstring const generateLabel(Buffer const &) const;
+ docstring generateLabel() const;
+ ///
class Cache {
public:
///
- Cache() : engine(biblio::ENGINE_BASIC), params("cite") {}
+ Cache() : engine(ENGINE_BASIC), params(CITE_CODE) {}
///
- biblio::CiteEngine engine;
+ CiteEngine engine;
///
InsetCommandParams params;
///
mutable Cache cache;
};
-
} // namespace lyx
-#endif // INSET_CITE_H
+#endif // INSET_CITATION_H