X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Ffrontends%2FPainter.h;h=17253b2f44dae76fb7d5eebcb55f01bd5d28eb51;hb=8d451794032b5eb0a4e4579a4d794511878ee783;hp=1fb8a74a965046d5d23e27614da2d5b70b83e76c;hpb=db2c1d5917ca2ffe6e44c07a0ac2a2a7b8d1da85;p=lyx.git

diff --git a/src/frontends/Painter.h b/src/frontends/Painter.h
index 1fb8a74a96..17253b2f44 100644
--- a/src/frontends/Painter.h
+++ b/src/frontends/Painter.h
@@ -13,18 +13,17 @@
 #ifndef PAINTER_H
 #define PAINTER_H
 
-#include <string>
+#include "support/strfwd.h"
+#include "support/types.h"
 
+namespace lyx {
 
-class LColor_color;
-class LyXFont;
+class Font;
+class FontInfo;
 
-namespace lyx {
-namespace graphics {
-	class Image;
-}
-}
+namespace graphics { class Image; }
 
+namespace frontend {
 
 /**
  * Painter - A painter class to encapsulate all graphics parameters and operations
@@ -39,47 +38,49 @@ namespace graphics {
  *
  * The intention for a toolkit is that it uses these methods to paint
  * onto a backing pixmap. Only when expose events arrive via the event
- * queue (perhaps generated via Screen::expose), does the copy onto
- * the actual WorkArea widget take place. Paints are wrapped in (possibly
- * recursive) calls to start() and end() to facilitate the backing pixmap
- * management.
+ * queue, does the copy onto the actual WorkArea widget take place.
  *
- * 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:
-	/// possible line widths
-	enum line_width {
-		line_thin, //< thin line
-		line_thick //< thick line
-	};
+	Painter(double pixel_ratio) : pixel_ratio_(pixel_ratio) {}
+
+	static const int thin_line;
 
 	/// possible line styles
 	enum line_style {
 		line_solid, //< solid line
+		line_solid_aliased, //< solid line, no anti-aliasing (used as a
+		                    // workaround to painting issues)
 		line_onoffdash //< dashes with spaces
 	};
 
-	virtual ~Painter() {}
-
-	/// begin painting
-	virtual void start() {}
+	/// possible fill styles
+	enum fill_style {
+		fill_none,
+		fill_oddeven,
+		fill_winding
+	};
 
-	/// end painting
-	virtual void end() {}
+	/// 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.
+	};
 
-	/// 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 void line(
-		int x1, int y1,
-		int x2, int y2,
-		LColor_color,
-		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, int line_width = thin_line) = 0;
 
 	/**
 	 * lines -  draw a set of lines
@@ -87,71 +88,72 @@ public:
 	 * @param yp array of points' y co-ords
 	 * @param np size of the points array
 	 */
-	virtual void lines(
-		int const * xp,
-		int const * yp,
-		int np,
-		LColor_color,
-		line_style = line_solid,
-		line_width = line_thin) = 0;
+	virtual void lines(int const * xp, int const * yp, int np, Color,
+		fill_style = fill_none, line_style = line_solid,
+		int line_width = thin_line) = 0;
+
+	/**
+	 * path -  draw a path with bezier curves
+	 * @param xp array of points' x co-ords
+	 * @param yp array of points' y co-ords
+	 * @param c1x array of first control points' x co-ords
+	 * @param c1y array of first control points' y co-ords
+	 * @param c2x array of second control points' x co-ords
+	 * @param c2y array of second control points' y co-ords
+	 * @param np size of the points array
+	 */
+	virtual void path(int const * xp, int const * yp,
+		int const * c1x, int const * c1y,
+		int const * c2x, int const * c2y,
+		int np, Color,
+		fill_style = fill_none, line_style = line_solid,
+		int line_width = thin_line) = 0;
 
 	/// draw a rectangle
-	virtual void rectangle(
-		int x, int y,
-		int w, int h,
-		LColor_color,
-		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, int line_width = thin_line) = 0;
 
 	/// draw a filled rectangle
-	virtual void fillRectangle(
-		int x, int y,
-		int w, int h,
-		LColor_color) = 0;
-
-	/// draw a filled (irregular) polygon
-	virtual void fillPolygon(
-		int const * xp,
-		int const * yp,
-		int np,
-		LColor_color) = 0;
+	virtual void fillRectangle(int x, int y, int w, int h, Color) = 0;
 
 	/// draw an arc
-	virtual void arc(
-		int x, int y,
-		unsigned int w, unsigned int h,
-		int a1, int a2,
-		LColor_color) = 0;
+	virtual void arc(int x, int y, unsigned int w, unsigned int h,
+		int a1, int a2, Color) = 0;
 
 	/// draw a pixel
-	virtual void point(
-		int x, int y,
-		LColor_color) = 0;
-
-	/// draw a filled rectangle with the shape of a 3D button
-	virtual void button(int x, int y,
-		int w, int h);
+	virtual void point(int x, int y, Color) = 0;
 
 	/// draw an image from the image cache
-	virtual void image(int x, int y,
-		int w, int h,
-		lyx::graphics::Image const & image) = 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)
-	virtual void text(int x, int y,
-		std::string const & str, LyXFont const & f) = 0;
+	/// draw a string at position x, y (y is the baseline).
+	virtual void text(int x, int y, docstring const & str, FontInfo const & f) = 0;
 
-	/**
-	 * Draw a string at position x, y (y is the baseline)
-	 * This is just for fast drawing
+	/// draw a char at position x, y (y is the baseline)
+	virtual void text(int x, int y, char_type c, FontInfo const & f) = 0;
+
+	/** draw a string at position x, y (y is the baseline). The
+	 * text direction is enforced by the \c Font.
 	 */
-	virtual void text(int x, int y,
-		char const * str, size_t l,
-		LyXFont const & f) = 0;
+	virtual void text(int x, int y, docstring const & str, Font const & f,
+                      double wordspacing, double textwidth) = 0;
 
-	/// draw a char at position x, y (y is the baseline)
-	virtual void text(int x, int y,
-		char c, LyXFont const & f) = 0;
+	/** draw a string at position x, y (y is the baseline), but
+	 * make sure that the part between \c from and \c to is in
+	 * \c other color. The text direction is enforced by the \c Font.
+	 */
+	virtual void text(int x, int y, docstring const & str, Font const & f,
+	                  Color other, size_type from, size_type to,
+                      double wordspacing, double textwidth) = 0;
+
+	// Returns true if the painter does not actually paint.
+	virtual bool isNull() const = 0;
+
+	double pixelRatio() const { return pixel_ratio_; }
+
+	/// draw the underbar, strikeout, xout, uuline and uwave font attributes
+	virtual void textDecoration(FontInfo const & f, int x, int y, int width) = 0;
 
 	/**
 	 * Draw a string and enclose it inside a rectangle. If
@@ -159,24 +161,30 @@ public:
 	 * 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,
-		std::string const & str,
-		LyXFont const & font,
-		LColor_color back,
-		LColor_color frame);
+	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
-	virtual void buttonText(int x,
-		int baseline, std::string const & s,
-		LyXFont const & font);
-
-protected:
-	/// check the font, and if set, draw an underline
-	virtual void underline(LyXFont const & f,
-		int x, int y, int width);
-
-	/// draw a bevelled button border
-	virtual void buttonFrame(int x, int y, int w, int h);
+	virtual void buttonText(int x, int baseline, docstring const & s,
+		FontInfo const & font, Color back, Color frame, int offset) = 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:
+	/// Ratio between physical pixels and device-independent pixels
+	double pixel_ratio_;
 };
 
+} // namespace frontend
+} // namespace lyx
+
 #endif // PAINTER_H