src/insets/InsetSpecialChar.h

   1 // -*- C++ -*-
   2 /**
   3  * \file InsetSpecialChar.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Asger Alstrup Nielsen
   8  * \author Jean-Marc Lasgouttes
   9  * \author Lars Gullik Bjønnes
  10  *
  11  * Full author contact details are available in file CREDITS.
  12  */
  13
  14 #ifndef INSET_SPECIALCHAR_H
  15 #define INSET_SPECIALCHAR_H
  16
  17
  18 #include "Inset.h"
  19
  20
  21 namespace lyx {
  22
  23 class LaTeXFeatures;
  24
  25 ///  Used to insert special chars
  26 class InsetSpecialChar : public Inset {
  27 public:
  28
  29         /// The different kinds of special chars we support
  30         enum Kind {
  31                 /// Optional hyphenation point (\-)
  32                 HYPHENATION,
  33                 /// Ligature break point (\textcompwordmark)
  34                 LIGATURE_BREAK,
  35                 /// ... (\ldots)
  36                 LDOTS,
  37                 /// End of sentence punctuation (\@)
  38                 END_OF_SENTENCE,
  39                 /// Menu separator
  40                 MENU_SEPARATOR,
  41                 /// breakable slash
  42                 SLASH,
  43                 /// protected dash
  44                 NOBREAKDASH,
  45         };
  46
  47         ///
  48         InsetSpecialChar() {}
  49         ///
  50         explicit InsetSpecialChar(Kind k);
  51         ///
  52         Kind kind() const;
  53         ///
  54         void metrics(MetricsInfo &, Dimension &) const;
  55         ///
  56         void draw(PainterInfo & pi, int x, int y) const;
  57         ///
  58         void write(std::ostream &) const;
  59         /// Will not be used when lyxf3
  60         void read(Lexer & lex);
  61         ///
  62         int latex(odocstream &, OutputParams const &) const;
  63         ///
  64         int plaintext(odocstream &, OutputParams const &) const;
  65         ///
  66         int docbook(odocstream &, OutputParams const &) const;
  67         /// the string that is passed to the TOC
  68         void tocString(odocstream &) const;
  69         ///
  70         InsetCode lyxCode() const { return SPECIALCHAR_CODE; }
  71         /// We don't need \begin_inset and \end_inset
  72         bool directWrite() const { return true; }
  73         ///
  74         void validate(LaTeXFeatures &) const;
  75
  76         // should this inset be handled like a normal charater
  77         bool isChar() const;
  78         /// is this equivalent to a letter?
  79         bool isLetter() const;
  80         // should we break lines after this inset?
  81         bool isLineSeparator() const;
  82 private:
  83         Inset * clone() const { return new InsetSpecialChar(*this); };
  84
  85         /// And which kind is this?
  86         Kind kind_;
  87 };
  88
  89
  90 } // namespace lyx
  91
  92 #endif