]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetCitation.h
Get rid of Qt resources
[lyx.git] / src / insets / InsetCitation.h
index e30d036caa72eca817f16c2046c510753cf50cf0..b2a738cd9e10af24a4e95ae91e55d18d0eef5b69 100644 (file)
  * 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 "InsetCode.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 &);
        ///
-       docstring screenLabel() 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;
        ///
-       EDITABLE editable() const { return IS_EDITABLE; }
+       void doDispatch(Cursor & cur, FuncRequest & cmd);
+       ///
+       bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
        ///
        InsetCode lyxCode() const { return CITE_CODE; }
        ///
-       int latex(odocstream &, OutputParams const &) const;
+       void latex(otexstream &, OutputParams const &) const;
        ///
-       int plaintext(odocstream &, OutputParams const &) const;
+       int plaintext(odocstringstream & ods, OutputParams const & op,
+                     size_t max_length = INT_MAX) const;
        ///
        int docbook(odocstream &, OutputParams const &) const;
-       /// the string that is passed to the TOC
-       void textString(odocstream &) const;
        ///
-       void validate(LaTeXFeatures &) const;
+       docstring xhtml(XHTMLStream &, OutputParams const &) const;
+       ///
+       void toString(odocstream &) const;
+       ///
+       void forOutliner(docstring &, size_t const, bool const) const;
        ///
-       void updateLabels(ParIterator const & it);
+       void updateBuffer(ParIterator const & it, UpdateType, bool const deleted = false);
        ///
-       void addToToc(ParConstIterator const &) const;
+       void addToToc(DocIterator const & di, bool output_active,
+                                 UpdateType utype, TocBackend & backend) const;
+       ///
+       std::string contextMenuName() const;
+       ///
+       bool forceLTR(OutputParams const &) const;
+       //@}
 
+       /// \name Static public methods obligated for InsetCommand derived classes
+       //@{
        ///
        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 std::string defaultCommand() { return "cite"; }
+       ///
+       static bool isCompatibleCommand(std::string const &);
+       //@}
+       ///
+       typedef std::vector<std::pair<docstring, docstring>> QualifiedList;
+       ///
+       void redoLabel() { cache.recalculate = true; }
+       ///
+       CitationStyle getCitationStyle(BufferParams const & bp, std::string const & input,
+                                      std::vector<CitationStyle> const & valid_styles) const;
+       ///
+       QualifiedList getQualifiedLists(docstring const & p) const;
        ///
-       static bool isCompatibleCommand(std::string const & cmd);
+       static bool last_literal;
+
 private:
+       /// 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;
+
+       /// \name Private functions inherited from Inset class
+       //@{
        ///
        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 generateLabel() const;
+       //@}
 
+       /// \name Private functions inherited from InsetCommand class
+       //@{
        ///
-       class Cache {
-       public:
-               ///
-               Cache() : engine(biblio::ENGINE_BASIC), params(CITE_CODE) {}
-               ///
-               biblio::CiteEngine engine;
+       docstring screenLabel() const;
+       //@}
+
+       ///
+       struct Cache {
+               Cache() : recalculate(true) {}
                ///
-               InsetCommandParams params;
+               bool recalculate;
                ///
                docstring generated_label;
                ///
@@ -90,4 +132,4 @@ private:
 
 } // namespace lyx
 
-#endif // INSET_CITE_H
+#endif // INSET_CITATION_H