+
+/**
+ * Class for storing information about a given citation item in a given context.
+ * This is used in the label and menu string generation process.
+ */
+class CiteItem
+{
+public:
+ /// The context this citation is displayed
+ enum CiteContext{
+ Everywhere,
+ Dialog,
+ Export
+ };
+ ///
+ CiteItem() : forceUpperCase(false), Starred(false), isQualified(false),
+ context(CiteItem::Everywhere), textAfter(docstring()),
+ textBefore(docstring()), max_size(128), max_key_size(128),
+ richtext(false) {}
+ /// requests upper casing author prefixes (van -> Van)
+ bool forceUpperCase;
+ /// is starred version (full author list by default)
+ bool Starred;
+ /// is a real qualified list
+ bool isQualified;
+ /// where this to be displayed?
+ CiteItem::CiteContext context;
+ /// text after the citation
+ docstring textAfter;
+ /// text before the citation
+ docstring textBefore;
+ ///
+ typedef std::vector<std::pair<docstring, docstring>> QualifiedList;
+ /// Qualified lists's pre texts
+ QualifiedList pretexts;
+ ///
+ QualifiedList getPretexts() const { return pretexts; }
+ /// Qualified lists's post texts
+ QualifiedList posttexts;
+ ///
+ QualifiedList getPosttexts() const { return posttexts; }
+ /// the maximum display size as a label
+ size_t max_size;
+ /// the maximum size of the processed keys
+ /// (limited for performance reasons)
+ size_t max_key_size;
+ /// output richtext information?
+ bool richtext;
+};
+