3 * \file InsetSpecialChar.h
4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Asger Alstrup Nielsen
8 * \author Jean-Marc Lasgouttes
9 * \author Lars Gullik Bjønnes
11 * Full author contact details are available in file CREDITS.
14 #ifndef INSET_SPECIALCHAR_H
15 #define INSET_SPECIALCHAR_H
25 /// Used to insert special chars
26 class InsetSpecialChar : public Inset {
29 /// The different kinds of special chars we support
31 /// Optional hyphenation point (\-)
33 /// Ligature break point (\textcompwordmark)
37 /// End of sentence punctuation (\@)
51 InsetSpecialChar(Kind k);
55 void metrics(MetricsInfo &, Dimension &) const;
57 void draw(PainterInfo & pi, int x, int y) const;
59 void write(Buffer const &, std::ostream &) const;
60 /// Will not be used when lyxf3
61 void read(Buffer const &, Lexer & lex);
63 int latex(Buffer const &, odocstream &,
64 OutputParams const &) const;
66 int plaintext(Buffer const &, odocstream &,
67 OutputParams const &) const;
69 int docbook(Buffer const &, odocstream &,
70 OutputParams const &) const;
71 /// the string that is passed to the TOC
72 virtual int textString(Buffer const &, odocstream &,
73 OutputParams const &) const;
75 InsetCode lyxCode() const { return SPECIALCHAR_CODE; }
76 /// We don't need \begin_inset and \end_inset
77 bool directWrite() const { return true; }
79 void validate(LaTeXFeatures &) const;
81 // should this inset be handled like a normal charater
83 /// is this equivalent to a letter?
84 bool isLetter() const;
85 // should we break lines after this inset?
86 bool isLineSeparator() const;
88 virtual Inset * clone() const;
90 /// And which kind is this?