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
  16 #include "inset.h"
  17 #include "LString.h"
  18
  19 class LyXLex;
  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 Inset {
  30 public:
  31         ///
  32         InsetLatexAccent();
  33         ///
  34         explicit
  35         InsetLatexAccent(string const & string);
  36         ///
  37         void dimension(BufferView *, LyXFont const &, Dimension &) const;
  38         ///
  39         void draw(BufferView *, LyXFont const &, int, float &) const;
  40         ///
  41         int lbearing(LyXFont const & font) const;
  42         ///
  43         int rbearing(LyXFont const & font) const;
  44         ///
  45         bool displayISO8859_9(BufferView *, LyXFont const & font,
  46                               int baseline, float & x) const;
  47         ///
  48         void write(Buffer const *, std::ostream &) const;
  49         ///
  50         void read(Buffer const *, LyXLex & lex);
  51         ///
  52         int latex(Buffer const *, std::ostream &,
  53                   bool fragile, bool free_spc) const;
  54         ///
  55         int ascii(Buffer const *, std::ostream &, int linelen) const;
  56         ///
  57         int linuxdoc(Buffer const *, std::ostream &) const;
  58         ///
  59         int docbook(Buffer const *, std::ostream &, bool mixcont) const;
  60         ///
  61         bool directWrite() const;
  62         ///
  63         virtual Inset * clone(Buffer const &, bool same_id = false) const;
  64         ///
  65         Inset::Code lyxCode()const;
  66         ///
  67         inline bool canDisplay();
  68         // should this inset be handled like a normal charater
  69         bool isChar() const { return true; }
  70
  71         /// all the accent types
  72         enum ACCENT_TYPES{
  73                 ///
  74                 ACUTE, // 0
  75                 ///
  76                 GRAVE,
  77                 ///
  78                 MACRON,
  79                 ///
  80                 TILDE,
  81                 ///
  82                 UNDERBAR,
  83                 ///
  84                 CEDILLA, // 5
  85                 ///
  86                 UNDERDOT,
  87                 ///
  88                 CIRCLE,
  89                 ///
  90                 TIE,
  91                 ///
  92                 BREVE,
  93                 ///
  94                 CARON, // 10
  95                 ///
  96                 SPECIAL_CARON,
  97                 ///
  98                 HUNGARIAN_UMLAUT,
  99                 ///
 100                 UMLAUT,
 101                 ///
 102                 DOT,
 103                 ///
 104                 CIRCUMFLEX, // 15
 105                 ///
 106                 OGONEK,
 107                 ///
 108                 DOT_LESS_I,
 109                 ///
 110                 DOT_LESS_J, // 18
 111                 ///
 112                 lSLASH,
 113                 ///
 114                 LSLASH
 115         };
 116 private:
 117         friend std::ostream & operator<<(std::ostream &, ACCENT_TYPES);
 118         /// Check if we know the modifier and can display it ok on screen.
 119         void checkContents();
 120         ///
 121         string contents;
 122         /// can display as proper char
 123         bool  candisp;
 124         /// modifier type
 125         ACCENT_TYPES  modtype;
 126
 127         /// remove dot from 'i' and 'j' or transform l, L into lslash, LSLaSH
 128         bool  remdot;
 129         /// add something to ascent - accent at the top
 130         bool  plusasc;
 131         /// add something to descent - underlined char
 132         bool  plusdesc;
 133         /// international char
 134         mutable char  ic;
 135 };
 136
 137
 138 bool InsetLatexAccent::canDisplay()
 139 {
 140         return candisp;
 141 }
 142
 143 #endif