src/insets/insetlatexaccent.h

   1 // -*- C++ -*-
   2 /**
   3  * \file insetlatexaccent.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Lars Gullik Bjønnes
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef INSET_LATEX_ACCENT_H
  13 #define INSET_LATEX_ACCENT_H
  14
  15 #include "inset.h"
  16 #include "support/types.h"
  17
  18 class Dimension;
  19
  20
  21 /** Insertion of accents
  22
  23   Proper handling of accented characters.
  24   This is class is supposed to handle all LaTeX accents, it
  25   is also possible that the class will change a bit so that
  26   it also can handle other special characters (e.g. Hstroke)
  27   Initiated by Ivan Schreter, later modified by Lgb.
  28   */
  29 class InsetLatexAccent : public InsetOld {
  30 public:
  31         ///
  32         InsetLatexAccent();
  33         ///
  34         explicit InsetLatexAccent(std::string const & str);
  35         ///
  36         void metrics(MetricsInfo &, Dimension &) const;
  37         ///
  38         void draw(PainterInfo & pi, int x, int y) const;
  39         ///
  40         int lbearing(LyXFont const & font) const;
  41         ///
  42         int rbearing(LyXFont const & font) const;
  43         ///
  44         bool displayISO8859_9(PainterInfo & pi, int x, int y) const;
  45         ///
  46         void write(Buffer const &, std::ostream &) const;
  47         ///
  48         void read(Buffer const &, LyXLex & lex);
  49         ///
  50         int latex(Buffer const &, std::ostream &,
  51                   OutputParams const &) const;
  52         ///
  53         int plaintext(Buffer const &, std::ostream &,
  54                   OutputParams const &) const;
  55         ///
  56         int docbook(Buffer const &, std::ostream &,
  57                     OutputParams const &) const;
  58         /// the string that is passed to the TOC
  59         virtual int textString(Buffer const &, std::ostream & os,
  60                 OutputParams const &) const;
  61         ///
  62         bool directWrite() const;
  63         ///
  64         InsetBase::Code lyxCode()const;
  65         ///
  66         inline bool canDisplay();
  67         // should this inset be handled like a normal charater
  68         bool isChar() const { return true; }
  69
  70         /// is this equivalent to a letter?
  71         virtual bool isLetter() const { return candisp; }
  72
  73         /// all the accent types
  74         enum ACCENT_TYPES{
  75                 ///
  76                 ACUTE, // 0
  77                 ///
  78                 GRAVE,
  79                 ///
  80                 MACRON,
  81                 ///
  82                 TILDE,
  83                 ///
  84                 UNDERBAR,
  85                 ///
  86                 CEDILLA, // 5
  87                 ///
  88                 UNDERDOT,
  89                 ///
  90                 CIRCLE,
  91                 ///
  92                 TIE,
  93                 ///
  94                 BREVE,
  95                 ///
  96                 CARON, // 10
  97                 ///
  98                 SPECIAL_CARON,
  99                 ///
 100                 HUNGARIAN_UMLAUT,
 101                 ///
 102                 UMLAUT,
 103                 ///
 104                 DOT,
 105                 ///
 106                 CIRCUMFLEX, // 15
 107                 ///
 108                 OGONEK,
 109                 ///
 110                 DOT_LESS_I,
 111                 ///
 112                 DOT_LESS_J, // 18
 113                 ///
 114                 lSLASH,
 115                 ///
 116                 LSLASH
 117         };
 118 private:
 119         friend std::ostream & operator<<(std::ostream &, ACCENT_TYPES);
 120
 121         virtual std::auto_ptr<InsetBase> doClone() const;
 122
 123         /// Check if we know the modifier and can display it ok on screen.
 124         void checkContents();
 125         ///
 126         void drawAccent(PainterInfo const & pi, int x, int y, lyx::char_type accent) const;
 127         ///
 128         std::string contents;
 129         /// can display as proper char
 130         bool  candisp;
 131         /// modifier type
 132         ACCENT_TYPES  modtype;
 133
 134         /// remove dot from 'i' and 'j' or transform l, L into lslash, LSLaSH
 135         bool  remdot;
 136         /// add something to ascent - accent at the top
 137         bool  plusasc;
 138         /// add something to descent - underlined char
 139         bool  plusdesc;
 140         /// international char
 141         mutable char  ic;
 142 };
 143
 144
 145 bool InsetLatexAccent::canDisplay()
 146 {
 147         return candisp;
 148 }
 149
 150 #endif