X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Ffrontends%2FPainter.h;h=188fb43bd283f48d33a5e3f019a9848afd45539a;hb=56a7a6778356ad1b70eff4ae6a960f2cad414ea1;hp=9680acb2e2d10205f227767029b88e9e6a0904f5;hpb=d8ae51dbe178d6b10a56c747cfd399a4dbba8117;p=lyx.git

diff --git a/src/frontends/Painter.h b/src/frontends/Painter.h
index 9680acb2e2..188fb43bd2 100644
--- a/src/frontends/Painter.h
+++ b/src/frontends/Painter.h
@@ -13,19 +13,15 @@
 #ifndef PAINTER_H
 #define PAINTER_H
 
-#include "LColor.h"
+#include "Color.h"
 
-#include "support/types.h"
-
-#include <string>
+#include "support/strfwd.h"
 
+namespace lyx {
 
-class LyXFont;
+class FontInfo;
 
-namespace lyx {
-namespace graphics {
-	class Image;
-}
+namespace graphics { class Image; }
 
 namespace frontend {
 
@@ -48,9 +44,17 @@ namespace frontend {
  * 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
@@ -63,26 +67,19 @@ public:
 		line_onoffdash //< dashes with spaces
 	};
 
-	virtual ~Painter() {}
-
-	/// begin painting
-	virtual void start() {}
-
-	/// 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, line_width = line_thin) = 0;
 
 	/**
 	 * lines -  draw a set of lines
@@ -90,71 +87,47 @@ 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,
+		line_style = line_solid, line_width = line_thin) = 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, line_width = line_thin) = 0;
 
 	/// draw a filled rectangle
-	virtual void fillRectangle(
-		int x, int y,
-		int w, int h,
-		LColor_color) = 0;
-
-	/// draw a filled (irregular) polygon (UNUSED, could be removed)
-	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;
+	virtual void point(int x, int y, 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 button(int x, int y, int w, int h, bool mouseHover) = 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)
-	 * This is just for fast drawing
-	 */
-	virtual void 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 void text(int x, int y,
-			  lyx::char_type 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. If
@@ -162,24 +135,27 @@ 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, 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