src/Citation.h

   1 // -*- C++ -*-
   2 /**
   3  * \file Citation.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Herbert Voß
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef CITATION_H
  13 #define CITATION_H
  14
  15 #include <string>
  16
  17 namespace lyx {
  18
  19 class Buffer;
  20
  21
  22 enum CiteEngineType {
  23         ENGINE_TYPE_AUTHORYEAR = 1,
  24         ENGINE_TYPE_NUMERICAL = 2,
  25         ENGINE_TYPE_DEFAULT = 3,
  26 };
  27
  28
  29 class CitationStyle
  30 {
  31 public:
  32         ///
  33         CitationStyle() : name("cite"), cmd("cite"), forceUpperCase(false),
  34                 fullAuthorList(false), textAfter(false), textBefore(false) {}
  35
  36         /// the LyX name
  37         std::string name;
  38         /// the LaTeX command (might differ from the LyX name)
  39         std::string cmd;
  40         /// upper casing author prefixes (van -> Van)
  41         bool forceUpperCase;
  42         /// expanding the full author list
  43         bool fullAuthorList;
  44         /// supports text after the citation
  45         bool textAfter;
  46         /// supports text before the citation
  47         bool textBefore;
  48 };
  49
  50 } // namespace lyx
  51
  52 #endif