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 #include "LString.h"
  20
  21 struct LaTeXFeatures;
  22
  23 ///  Used to insert special chars
  24 class InsetSpecialChar : public Inset {
  25 public:
  26
  27         /// The different kinds of special chars we support
  28         enum Kind {
  29                 /// Optional hyphenation point (\-)
  30                 HYPHENATION,
  31                 /// Ligature break point (\textcompwordmark)
  32                 LIGATURE_BREAK,
  33                 /// ... (\ldots)
  34                 LDOTS,
  35                 /// End of sentence punctuation (\@)
  36                 END_OF_SENTENCE,
  37                 /// Menu separator
  38                 MENU_SEPARATOR,
  39                 /// Protected Separator
  40                 PROTECTED_SEPARATOR
  41         };
  42
  43         ///
  44         InsetSpecialChar() {}
  45         ///
  46         explicit
  47         InsetSpecialChar(Kind k);
  48         ///
  49         Kind kind() const;
  50         ///
  51         int ascent(BufferView *, LyXFont const &) const;
  52         ///
  53         int descent(BufferView *, LyXFont const &) const;
  54         ///
  55         int width(BufferView *, LyXFont const &) const;
  56         ///
  57         void draw(BufferView *, LyXFont const &, int, float &) const;
  58         ///
  59         void write(Buffer const *, std::ostream &) const;
  60         /// Will not be used when lyxf3
  61         void read(Buffer const *, LyXLex & lex);
  62         ///
  63         int latex(Buffer const *, std::ostream &,
  64                   bool fragile, bool free_spc) const;
  65         ///
  66         int ascii(Buffer const *, std::ostream &, int linelen) const;
  67         ///
  68         int linuxdoc(Buffer const *, std::ostream &) const;
  69         ///
  70         int docbook(Buffer const *, std::ostream &, bool mixcont) const;
  71         ///
  72         virtual Inset * clone(Buffer const &, bool same_id = false) const;
  73         ///
  74         Inset::Code lyxCode() const { return Inset::SPECIALCHAR_CODE; }
  75         /// We don't need \begin_inset and \end_inset
  76         bool directWrite() const { return true; }
  77         ///
  78         void validate(LaTeXFeatures &) const;
  79
  80         // should this inset be handled like a normal charater
  81         bool isChar() const;
  82         /// is this equivalent to a letter?
  83         bool isLetter() const;
  84         /// is this equivalent to a space (which is BTW different from
  85         // a line separator)?
  86         bool isSpace() const;
  87         // should we break lines after this inset?
  88         bool isLineSeparator() const;
  89 private:
  90         /// And which kind is this?
  91         Kind kind_;
  92 };
  93
  94 #endif