X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2Finsetspecialchar.h;h=26ee9612bde82ee48684161012c687a4420fce19;hb=e28331ed63062dea10d0a21b9ec12034b4b17b9a;hp=d9a737dd14e3ff97f2d95fb4acebb2025c65d1e1;hpb=6bba977f42b0cde753ac2ffd26f3f9c6b32ba0b6;p=lyx.git diff --git a/src/insets/insetspecialchar.h b/src/insets/insetspecialchar.h index d9a737dd14..26ee9612bd 100644 --- a/src/insets/insetspecialchar.h +++ b/src/insets/insetspecialchar.h @@ -1,41 +1,43 @@ // -*- C++ -*- -/* This file is part of* - * ====================================================== +/** + * \file insetspecialchar.h + * This file is part of LyX, the document processor. + * Licence details can be found in the file COPYING. * - * LyX, The Document Processor - * - * Copyright 1997 Asger Alstrup + * \author Asger Alstrup Nielsen + * \author Jean-Marc Lasgouttes + * \author Lars Gullik Bjønnes * - * ====================================================== */ + * Full author contact details are available in file CREDITS. + */ #ifndef INSET_SPECIALCHAR_H #define INSET_SPECIALCHAR_H -#ifdef __GNUG__ -#pragma interface -#endif -#include "lyxinset.h" -#include "LString.h" +#include "inset.h" + + +namespace lyx { -struct LaTeXFeatures; +class LaTeXFeatures; /// Used to insert special chars -class InsetSpecialChar : public Inset { +class InsetSpecialChar : public InsetOld { public: /// The different kinds of special chars we support enum Kind { /// Optional hyphenation point (\-) HYPHENATION, + /// Ligature break point (\textcompwordmark) + LIGATURE_BREAK, /// ... (\ldots) LDOTS, /// End of sentence punctuation (\@) END_OF_SENTENCE, /// Menu separator MENU_SEPARATOR, - /// Protected Separator - PROTECTED_SEPARATOR }; /// @@ -44,42 +46,48 @@ public: explicit InsetSpecialChar(Kind k); /// - int ascent(Painter &, LyXFont const &) const; + Kind kind() const; /// - int descent(Painter &, LyXFont const &) const; + bool metrics(MetricsInfo &, Dimension &) const; /// - int width(Painter &, LyXFont const &) const; + void draw(PainterInfo & pi, int x, int y) const; /// - void draw(Painter &, LyXFont const &, int baseline, float & x) const; - /// - void Write(Buffer const *, std::ostream &) const; + void write(Buffer const &, std::ostream &) const; /// Will not be used when lyxf3 - void Read(Buffer const *, LyXLex & lex); - /// - int Latex(Buffer const *, std::ostream &, bool fragile, bool free_spc) const; + void read(Buffer const &, LyXLex & lex); /// - int Ascii(Buffer const *, std::ostream &) const; + int latex(Buffer const &, odocstream &, + OutputParams const &) const; /// - int Linuxdoc(Buffer const *, std::ostream &) const; + int plaintext(Buffer const &, odocstream &, + OutputParams const &) const; /// - int DocBook(Buffer const *, std::ostream &) const; + int docbook(Buffer const &, odocstream &, + OutputParams const &) const; + /// the string that is passed to the TOC + virtual int textString(Buffer const &, odocstream &, + OutputParams const &) const; /// - Inset * Clone() const; - /// - Inset::Code LyxCode() const - { - return Inset::SPECIALCHAR_CODE; - } + InsetBase::Code lyxCode() const { return InsetBase::SPECIALCHAR_CODE; } /// We don't need \begin_inset and \end_inset - bool DirectWrite() const - { - return true; - }; + bool directWrite() const { return true; } /// - void Validate(LaTeXFeatures &) const; + void validate(LaTeXFeatures &) const; + + // should this inset be handled like a normal charater + bool isChar() const; + /// is this equivalent to a letter? + bool isLetter() const; + // should we break lines after this inset? + bool isLineSeparator() const; private: + virtual std::auto_ptr doClone() const; + /// And which kind is this? - Kind kind; + Kind kind_; }; + +} // namespace lyx + #endif