src/rowpainter.h

   1 // -*- C++ -*-
   2 /**
   3  * \file rowpainter.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author various
   8  * \author John Levon
   9  * \author André Pönitz
  10  *
  11  * Full author contact details are available in file CREDITS.
  12  */
  13
  14 #ifndef ROWPAINTER_H
  15 #define ROWPAINTER_H
  16
  17 #include "Changes.h"
  18
  19 #include "support/types.h"
  20
  21 namespace lyx {
  22
  23 class Bidi;
  24 class BufferView;
  25 class Font;
  26 class FontInfo;
  27 class Inset;
  28 class Language;
  29 class PainterInfo;
  30 class Paragraph;
  31 class ParagraphList;
  32 class ParagraphMetrics;
  33 class Row;
  34 class Text;
  35 class TextMetrics;
  36
  37 namespace frontend { class Painter; }
  38
  39 /**
  40  * A class used for painting an individual row of text.
  41  * FIXME: get rid of that class.
  42  */
  43 class RowPainter {
  44 public:
  45         /// initialise and run painter
  46         RowPainter(PainterInfo & pi, Text const & text,
  47                 pit_type pit, Row const & row, Bidi & bidi, int x, int y);
  48
  49         /// paint various parts
  50         /// FIXME: transfer to TextMetrics
  51         void paintAppendix();
  52         void paintDepthBar();
  53         void paintChangeBar();
  54         void paintFirst();
  55         void paintLast();
  56         void paintText();
  57         void paintOnlyInsets();
  58         void paintSelection();
  59
  60 private:
  61         void paintForeignMark(double orig_x, Language const * lang, int desc = 0);
  62         void paintMisspelledMark(double orig_x, bool changed);
  63         void paintHebrewComposeChar(pos_type & vpos, FontInfo const & font);
  64         void paintArabicComposeChar(pos_type & vpos, FontInfo const & font);
  65         void paintChars(pos_type & vpos, FontInfo const & font,
  66                         bool hebrew, bool arabic);
  67         int paintAppendixStart(int y);
  68         void paintFromPos(pos_type & vpos, bool changed);
  69         void paintInset(Inset const * inset, pos_type const pos);
  70         void paintInlineCompletion(Font const & font);
  71
  72         /// return left margin
  73         int leftMargin() const;
  74
  75         /// return the label font for this row
  76         FontInfo labelFont() const;
  77
  78         /// contains painting related information.
  79         PainterInfo & pi_;
  80
  81         /// Text for the row
  82         Text const & text_;
  83         TextMetrics & text_metrics_;
  84         ParagraphList const & pars_;
  85
  86         /// The row to paint
  87         Row const & row_;
  88
  89         /// Row's paragraph
  90         pit_type const pit_;
  91         Paragraph const & par_;
  92         ParagraphMetrics const & pm_;
  93
  94         /// bidi cache, comes from outside the rowpainter because
  95         /// rowpainters are normally created in a for loop and there only
  96         /// one of them is active at a time.
  97         Bidi & bidi_;
  98
  99         /// row changed? (change tracking)
 100         Change const change_;
 101
 102         // Looks ugly - is
 103         double const xo_;
 104         int const yo_;    // current baseline
 105         double x_;
 106         int width_;
 107         float solid_line_thickness_;
 108         int solid_line_offset_;
 109         float dotted_line_thickness_;
 110         int dotted_line_offset_;
 111 };
 112
 113 } // namespace lyx
 114
 115 #endif // ROWPAINTER_H