src/insets/InsetQuotes.h

   1 // -*- C++ -*-
   2 /**
   3  * \file InsetQuotes.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Jean-Marc Lasgouttes
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef INSET_QUOTES_H
  13 #define INSET_QUOTES_H
  14
  15
  16 #include "Inset.h"
  17
  18 #include "support/types.h"
  19
  20
  21 namespace lyx {
  22
  23 class BufferParams;
  24 class Language;
  25 class LaTeXFeatures;
  26
  27
  28 /** Quotes.
  29   Used for the various quotes. German, English, French, all either
  30   double or single **/
  31 class InsetQuotes : public Inset {
  32 public:
  33         ///
  34         enum quote_language {
  35                 ///
  36                 EnglishQ,
  37                 ///
  38                 SwedishQ,
  39                 ///
  40                 GermanQ,
  41                 ///
  42                 PolishQ,
  43                 ///
  44                 FrenchQ,
  45                 ///
  46                 DanishQ
  47         };
  48         ///
  49         enum quote_side {
  50                 ///
  51                 LeftQ,
  52                 ///
  53                 RightQ
  54         };
  55         ///
  56         enum quote_times {
  57                 ///
  58                 SingleQ,
  59                 ///
  60                 DoubleQ
  61         };
  62
  63         /** The constructor works like this:
  64           \begin{itemize}
  65             \item fls <- french single quote left
  66             \item grd <- german double quote right
  67             \item etc.
  68           \end{itemize}
  69           */
  70         explicit InsetQuotes(std::string const & str = "eld");
  71         /// Create the right quote inset after character c
  72         InsetQuotes(char_type c, BufferParams const & params);
  73         /// Direct access to inner/outer quotation marks
  74         InsetQuotes(char_type c, quote_language l, quote_times t);
  75         ///
  76         docstring name() const;
  77         ///
  78         void metrics(MetricsInfo &, Dimension &) const;
  79         ///
  80         void draw(PainterInfo & pi, int x, int y) const;
  81         ///
  82         void write(std::ostream &) const;
  83         ///
  84         void read(Lexer & lex);
  85         ///
  86         int latex(odocstream &, OutputParams const &) const;
  87         ///
  88         int plaintext(odocstream &, OutputParams const &) const;
  89         ///
  90         int docbook(odocstream &, OutputParams const &) const;
  91
  92         /// the string that is passed to the TOC
  93         void textString(odocstream &) const;
  94
  95         ///
  96         void validate(LaTeXFeatures &) const;
  97         ///
  98         InsetCode lyxCode() const { return QUOTE_CODE; }
  99         /// should this inset be handled like a normal character
 100         bool isChar() const { return true; }
 101
 102 private:
 103         ///
 104         Inset * clone() const;
 105
 106         ///
 107         quote_language language_;
 108         ///
 109         quote_side side_;
 110         ///
 111         quote_times times_;
 112
 113         /** The parameters of the constructor are the language, the
 114             side and the multiplicity of the quote.
 115          */
 116         InsetQuotes(quote_language l, quote_side s, quote_times t);
 117         /// Decide whether we need left or right quotation marks
 118         void getPosition(char_type c);
 119         ///
 120         void parseString(std::string const &);
 121         ///
 122         docstring dispString() const;
 123 };
 124
 125 } // namespace lyx
 126
 127 #endif