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 (\@)
56 InsetSpecialChar() : Inset(0), kind_(HYPHENATION) {}
58 explicit InsetSpecialChar(Kind k);
62 void metrics(MetricsInfo &, Dimension &) const;
64 void drawBackground(PainterInfo & pi, int x, int y) const;
66 void draw(PainterInfo & pi, int x, int y) const;
68 void write(std::ostream &) const;
69 /// Will not be used when lyxf3
70 void read(Lexer & lex);
72 void latex(otexstream &, OutputParams const &) const;
74 int plaintext(odocstringstream & ods, OutputParams const & op,
75 size_t max_length = INT_MAX) const;
77 int docbook(odocstream &, OutputParams const &) const;
79 docstring xhtml(XHTMLStream &, OutputParams const &) const;
81 void toString(odocstream &) const;
83 bool isInToc() const { return true; }
85 void forOutliner(docstring &, size_t const, bool const) const;
87 InsetCode lyxCode() const { return SPECIALCHAR_CODE; }
88 /// We don't need \begin_inset and \end_inset
89 bool directWrite() const { return true; }
91 void validate(LaTeXFeatures &) const;
93 /// should this inset be handled like a normal character?
94 bool isChar() const { return true; }
95 /// is this equivalent to a letter?
96 bool isLetter() const;
97 /// should we break lines after this inset?
98 bool isLineSeparator() const;
100 Inset * clone() const { return new InsetSpecialChar(*this); }
102 /// And which kind is this?