src/MetricsInfo.h

   1 // -*- C++ -*-
   2 /**
   3  * \file MetricsInfo.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author André Pönitz
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef METRICSINFO_H
  13 #define METRICSINFO_H
  14
  15 #include "Font.h"
  16 #include "support/docstring.h"
  17 #include <string>
  18
  19 class BufferView;
  20
  21 namespace lyx {
  22
  23 namespace frontend { class Painter; }
  24
  25
  26 /// Standard Sizes (mode styles)
  27 enum Styles {
  28         ///
  29         LM_ST_DISPLAY = 0,
  30         ///
  31         LM_ST_TEXT,
  32         ///
  33         LM_ST_SCRIPT,
  34         ///
  35         LM_ST_SCRIPTSCRIPT
  36 };
  37
  38
  39 //
  40 // This is the part common to MetricsInfo and PainterInfo
  41 //
  42 class MetricsBase {
  43 public:
  44         ///
  45         MetricsBase();
  46         ///
  47         MetricsBase(BufferView * bv, Font const & font, int textwidth);
  48
  49         /// the current view
  50         BufferView * bv;
  51         /// current font
  52         Font font;
  53         /// current math style (display/text/script/..)
  54         Styles style;
  55         /// name of current font - mathed specific
  56         std::string fontname;
  57         /// This is the width available in pixels
  58         int textwidth;
  59 };
  60
  61
  62 //
  63 // This contains a MetricsBase and information that's only relevant during
  64 // the first phase of the two-phase draw
  65 //
  66 class MetricsInfo {
  67 public:
  68         ///
  69         MetricsInfo();
  70         ///
  71         MetricsInfo(BufferView * bv, Font const & font, int textwidth);
  72
  73         ///
  74         MetricsBase base;
  75 };
  76
  77
  78 //
  79 // This contains a MetricsBase and information that's only relevant during
  80 // the second phase of the two-phase draw
  81 //
  82 class PainterInfo {
  83 public:
  84         ///
  85         PainterInfo(BufferView * bv, frontend::Painter & pain);
  86         ///
  87         void draw(int x, int y, char_type c);
  88         ///
  89         void draw(int x, int y, docstring const & str);
  90
  91         ///
  92         MetricsBase base;
  93         ///
  94         frontend::Painter & pain;
  95         /// Whether the text at this point is right-to-left (for InsetNewline)
  96         bool ltr_pos;
  97         /// Whether the parent is deleted (change tracking)
  98         bool erased_;
  99         ///
 100         bool full_repaint;
 101         ///
 102         int background_color;
 103 };
 104
 105 class TextMetricsInfo {};
 106
 107 enum ScreenUpdateStrategy {
 108         NoScreenUpdate,
 109         SingleParUpdate,
 110         FullScreenUpdate,
 111         DecorationUpdate
 112 };
 113
 114 class ViewMetricsInfo
 115 {
 116 public:
 117         ViewMetricsInfo()
 118                         : p1(0), p2(0), y1(0), y2(0),
 119                         update_strategy(FullScreenUpdate), size(0)
 120                 {}
 121         ViewMetricsInfo(pit_type p1, pit_type p2, int y1, int y2,
 122                         ScreenUpdateStrategy updatestrategy, pit_type size)
 123                         : p1(p1), p2(p2), y1(y1), y2(y2),
 124                         update_strategy(updatestrategy), size(size)
 125                 {}
 126
 127         pit_type p1;
 128         pit_type p2;
 129         int y1;
 130         int y2;
 131         ScreenUpdateStrategy update_strategy;
 132         pit_type size;
 133 };
 134
 135
 136 // Generic base for temporarily changing things.
 137 // The original state gets restored when the Changer is destructed.
 138
 139 template <class Struct, class Temp = Struct>
 140 class Changer {
 141 public:
 142         ///
 143         Changer(Struct & orig) : orig_(orig) {}
 144 protected:
 145         ///
 146         Struct & orig_;
 147         ///
 148         Temp save_;
 149 };
 150
 151
 152
 153 // temporarily change some aspect of a font
 154 class FontChanger : public Changer<Font> {
 155 public:
 156         ///
 157         FontChanger(Font & orig, docstring const & font);
 158         FontChanger(MetricsBase & mb, char const * const font);
 159         ///
 160         ~FontChanger();
 161 };
 162
 163
 164 // temporarily change a full font
 165 class FontSetChanger : public Changer<MetricsBase> {
 166 public:
 167         ///
 168         FontSetChanger(MetricsBase & mb, docstring const & font);
 169         FontSetChanger(MetricsBase & mb, char const * const font);
 170         ///
 171         ~FontSetChanger();
 172 };
 173
 174
 175 // temporarily change the style
 176 class StyleChanger : public Changer<MetricsBase> {
 177 public:
 178         ///
 179         StyleChanger(MetricsBase & mb, Styles style);
 180         ///
 181         ~StyleChanger();
 182 };
 183
 184
 185 // temporarily change the style to script style
 186 class ScriptChanger : public StyleChanger {
 187 public:
 188         ///
 189         ScriptChanger(MetricsBase & mb);
 190 };
 191
 192
 193 // temporarily change the style suitable for use in fractions
 194 class FracChanger : public StyleChanger {
 195 public:
 196         ///
 197         FracChanger(MetricsBase & mb);
 198 };
 199
 200
 201 // temporarily change the style suitable for use in tabulars and arrays
 202 class ArrayChanger : public StyleChanger {
 203 public:
 204         ///
 205         ArrayChanger(MetricsBase & mb);
 206 };
 207
 208
 209
 210 // temporarily change the shape of a font
 211 class ShapeChanger : public Changer<Font, Font::FONT_SHAPE> {
 212 public:
 213         ///
 214         ShapeChanger(Font & font, Font::FONT_SHAPE shape);
 215         ///
 216         ~ShapeChanger();
 217 };
 218
 219
 220 // temporarily change the available text width
 221 class WidthChanger : public Changer<MetricsBase>
 222 {
 223 public:
 224         ///
 225         WidthChanger(MetricsBase & mb, int width);
 226         ///
 227         ~WidthChanger();
 228 };
 229
 230
 231 // temporarily change the used color
 232 class ColorChanger : public Changer<Font, std::string> {
 233 public:
 234         ///
 235         ColorChanger(Font & font, std::string const & color);
 236         ///
 237         ~ColorChanger();
 238 };
 239
 240 } // namespace lyx
 241
 242 #endif