// -*- C++ -*-
/**
* \file Painter.h
- * Copyright 1998-2002 the LyX Team
- * Read the file COPYING
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
* \author unknown
- * \author John Levon <moz@compsoc.man.ac.uk>
+ * \author John Levon
+ *
+ * Full author contact details are available in file CREDITS.
*/
#ifndef PAINTER_H
#define PAINTER_H
-#ifdef __GNUG__
-#pragma interface
-#endif
+#include "Color.h"
+
+#include "support/strfwd.h"
+
+namespace lyx {
-#include "LString.h"
-#include "LColor.h"
+class FontInfo;
-class LyXFont;
+namespace graphics { class Image; }
-namespace grfx {
- class GImage;
-}
+namespace frontend {
/**
* Painter - A painter class to encapsulate all graphics parameters and operations
* management.
*
* Note that the methods return *this for convenience.
+ *
+ * Caution: All char_type and docstring arguments of the text drawing
+ * methods of this class are no UCS4 chars or strings if the font is a
+ * symbol font. They simply denote the code points of the font instead.
+ * You have to keep this in mind when you implement the methods in a
+ * frontend. You must not pass these parameters to a unicode conversion
+ * function in particular.
*/
class Painter {
public:
+ Painter() : drawing_enabled_(true) {}
/// possible line widths
enum line_width {
line_thin, //< thin line
line_onoffdash //< dashes with spaces
};
- virtual ~Painter() {}
+ /// possible character styles of preedit string.
+ /// This is used for CJK input method support.
+ enum preedit_style {
+ preedit_default, //< when unselecting, no cursor and dashed underline.
+ preedit_selecting, //< when selecting.
+ preedit_cursor //< with cursor.
+ };
- /// begin painting
- virtual void start() {}
-
- /// end painting
- virtual void end() {}
-
- /// return the width of the work area in pixels
- virtual int paperWidth() const = 0;
- /// return the height of the work area in pixels
- virtual int paperHeight() const = 0;
+ virtual ~Painter() {}
/// draw a line from point to point
- virtual Painter & line(
- int x1, int y1,
- int x2, int y2,
- LColor::color = LColor::foreground,
- line_style = line_solid,
- line_width = line_thin) = 0;
+ virtual void line(int x1, int y1, int x2, int y2, Color,
+ line_style = line_solid, line_width = line_thin) = 0;
/**
* lines - draw a set of lines
* @param yp array of points' y co-ords
* @param np size of the points array
*/
- virtual Painter & lines(
- int const * xp,
- int const * yp,
- int np,
- LColor::color = LColor::foreground,
- line_style = line_solid,
- line_width = line_thin) = 0;
+ virtual void lines(int const * xp, int const * yp, int np, Color,
+ line_style = line_solid, line_width = line_thin) = 0;
/// draw a rectangle
- virtual Painter & rectangle(
- int x, int y,
- int w, int h,
- LColor::color = LColor::foreground,
- line_style = line_solid,
- line_width = line_thin) = 0;
-
+ virtual void rectangle(int x, int y, int w, int h, Color,
+ line_style = line_solid, line_width = line_thin) = 0;
+
/// draw a filled rectangle
- virtual Painter & fillRectangle(
- int x, int y,
- int w, int h,
- LColor::color) = 0;
-
- /// draw a filled (irregular) polygon
- virtual Painter & fillPolygon(
- int const * xp,
- int const * yp,
- int np,
- LColor::color = LColor::foreground) = 0;
+ virtual void fillRectangle(int x, int y, int w, int h, Color) = 0;
/// draw an arc
- virtual Painter & arc(
- int x, int y,
- unsigned int w, unsigned int h,
- int a1, int a2,
- LColor::color = LColor::foreground) = 0;
+ virtual void arc(int x, int y, unsigned int w, unsigned int h,
+ int a1, int a2, Color) = 0;
/// draw a pixel
- virtual Painter & point(
- int x, int y,
- LColor::color = LColor::foreground) = 0;
-
+ virtual void point(int x, int y, Color) = 0;
+
/// draw a filled rectangle with the shape of a 3D button
- virtual Painter & button(int x, int y,
- int w, int h);
+ virtual void button(int x, int y, int w, int h, bool mouseHover) = 0;
/// draw an image from the image cache
- virtual Painter & image(int x, int y,
- int w, int h,
- grfx::GImage const & image) = 0;
-
- /// draw a string at position x, y (y is the baseline)
- virtual Painter & text(int x, int y,
- string const & str, LyXFont const & f) = 0;
+ virtual void image(int x, int y, int w, int h,
+ graphics::Image const & image) = 0;
+ /// draw a string at position x, y (y is the baseline)
/**
- * Draw a string at position x, y (y is the baseline)
- * This is just for fast drawing
- */
- virtual Painter & text(int x, int y,
- char const * str, size_t l,
- LyXFont const & f) = 0;
+ * \return the width of the drawn text.
+ */
+ virtual int text(int x, int y, docstring const & str, FontInfo const & f) = 0;
+
+ void setDrawingEnabled(bool drawing_enabled)
+ { drawing_enabled_ = drawing_enabled; }
+
+ /// Indicate wether real screen drawing shall be done or not.
+ bool isDrawingEnabled() const { return drawing_enabled_; }
/// draw a char at position x, y (y is the baseline)
- virtual Painter & text(int x, int y,
- char c, LyXFont const & f) = 0;
+ /**
+ * \return the width of the drawn text.
+ */
+ virtual int text(int x, int y, char_type c, FontInfo const & f) = 0;
- /// draw a string and enclose it inside a rectangle
- Painter & rectText(int x, int baseline,
- string const & string,
- LyXFont const & font,
- LColor::color back,
- LColor::color frame);
+ /**
+ * Draw a string and enclose it inside a rectangle. If
+ * back color is specified, the background is cleared with
+ * the given color. If frame is specified, a thin frame is drawn
+ * around the text with the given color.
+ */
+ virtual void rectText(int x, int baseline, docstring const & str,
+ FontInfo const & font, Color back, Color frame) = 0;
/// draw a string and enclose it inside a button frame
- Painter & buttonText(int x,
- int baseline, string const & s,
- LyXFont const & font);
-
-protected:
- /// check the font, and if set, draw an underline
- void underline(LyXFont const & f,
- int x, int y, int width);
-
- /// draw a bevelled button border
- Painter & buttonFrame(int x, int y, int w, int h);
+ virtual void buttonText(int x, int baseline, docstring const & s,
+ FontInfo const & font, bool mouseHover) = 0;
+
+ /// draw a character of a preedit string for cjk support.
+ virtual int preeditText(int x, int y,
+ char_type c, FontInfo const & f, preedit_style style) = 0;
+
+ /// start monochrome painting mode, i.e. map every color into [min,max]
+ virtual void enterMonochromeMode(Color const & min,
+ Color const & max) = 0;
+ /// leave monochrome painting mode
+ virtual void leaveMonochromeMode() = 0;
+ /// draws a wavy line that can be used for underlining.
+ virtual void wavyHorizontalLine(int x, int y, int width, ColorCode col) = 0;
+private:
+ ///
+ bool drawing_enabled_;
};
+} // namespace frontend
+} // namespace lyx
+
#endif // PAINTER_H
projects / lyx.git / blobdiff