* Licence details can be found in the file COPYING.
*
* \author Angus Leeming
- * \author Herbert Voß
+ * \author Herbert Voß
*
* 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 "BiblioInfo.h"
-
+#include "Citation.h"
namespace lyx {
+/////////////////////////////////////////////////////////////////////////
+//
+// InsetCitation
+//
+/////////////////////////////////////////////////////////////////////////
-/** Used to insert citations
- */
-class InsetCitation : public InsetCommand {
+/// Used to insert citations
+class InsetCitation : public InsetCommand
+{
public:
///
- InsetCitation(InsetCommandParams const &);
+ InsetCitation(Buffer * buf, InsetCommandParams const &);
+ ///
+ ~InsetCitation();
+
+ ///
+ bool addKey(std::string const & key);
+
+ /// \name Public functions inherited from Inset class
+ //@{
+ ///
+ bool isLabeled() const { return true; }
+ ///
+ bool hasSettings() const { return true; }
+ ///
+ docstring toolTip(BufferView const & bv, int x, int y) const;
+ ///
+ void doDispatch(Cursor & cur, FuncRequest & cmd);
+ ///
+ bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
+ ///
+ InsetCode lyxCode() const { return CITE_CODE; }
///
- docstring const getScreenLabel(Buffer const &) const;
+ void latex(otexstream &, OutputParams const &) const;
///
- EDITABLE editable() const { return IS_EDITABLE; }
+ int plaintext(odocstringstream & ods, OutputParams const & op,
+ size_t max_length = INT_MAX) const;
///
- Inset::Code lyxCode() const { return Inset::CITE_CODE; }
+ int docbook(odocstream &, OutputParams const &) const;
///
- int latex(Buffer const &, odocstream &,
- OutputParams const &) const;
+ docstring xhtml(XHTMLStream &, OutputParams const &) const;
///
- int plaintext(Buffer const &, odocstream &,
- OutputParams const &) const;
+ void toString(odocstream &) 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;
+ void forOutliner(docstring &, size_t const, bool const) const;
///
- void validate(LaTeXFeatures &) const;
+ void validate(LaTeXFeatures &) const {}
///
- void replaceContents(std::string const & from, std::string const & to);
+ void updateBuffer(ParIterator const & it, UpdateType);
+ ///
+ void addToToc(DocIterator const & di, bool output_active,
+ UpdateType utype) const;
+ ///
+ std::string contextMenuName() const;
+ //@}
+
+ /// \name Static public methods obligated for InsetCommand derived classes
+ //@{
+ ///
+ static ParamInfo const & findInfo(std::string const &);
+ ///
+ static std::string defaultCommand() { return "cite"; }
+ ///
+ static bool isCompatibleCommand(std::string const &);
+ //@}
+ ///
+ CitationStyle getCitationStyle(BufferParams const & bp, std::string const & input,
+ std::vector<CitationStyle> const & valid_styles) const;
private:
- virtual Inset * clone() const
- {
- return new InsetCitation(params());
- }
+ /// tries to make a pretty label and makes a basic one if not
+ docstring generateLabel(bool for_xhtml = false) const;
+ /// makes a pretty label
+ docstring complexLabel(bool for_xhtml = false) const;
+ /// makes a very basic label, in case we can't make a pretty one
+ docstring basicLabel(bool for_xhtml = false) const;
- /// This function does the donkey work of creating the pretty label
- docstring const generateLabel(Buffer const &) const;
+ /// \name Private functions inherited from Inset class
+ //@{
+ ///
+ Inset * clone() const { return new InsetCitation(*this); }
+ //@}
- class Cache {
- public:
- ///
- Cache() : engine(biblio::ENGINE_BASIC), params("citation") {}
- ///
- biblio::CiteEngine engine;
+ /// \name Private functions inherited from InsetCommand class
+ //@{
+ ///
+ docstring screenLabel() const;
+ //@}
+
+ /// we'll eventually want to be able to get info on this from the
+ /// various CiteEngines
+ static ParamInfo param_info_;
+
+ ///
+ struct Cache {
+ Cache() : recalculate(true) {}
///
- InsetCommandParams params;
+ bool recalculate;
///
docstring generated_label;
///
} // namespace lyx
-#endif // INSET_CITE_H
+#endif // INSET_CITATION_H