Move Color::color enum to ColorCode.h

[lyx.git] / src / frontends / Painter.h

diff --git a/src/frontends/Painter.h b/src/frontends/Painter.h
index ceb6724ce96abf5169f5972e0e254e8ab460538d..9fc31a57e761934d2859b04fb9eee97699b1e7b4 100644 (file)
--- a/src/frontends/Painter.h
+++ b/src/frontends/Painter.h
@@ -13,12 +13,13 @@
 #ifndef PAINTER_H
 #define PAINTER_H
 
+#include "ColorCode.h"
+
 #include "support/docstring.h"
 
 namespace lyx {
 
-class LColor_color;
-class LyXFont;
+class Font;
 
 namespace graphics { class Image; }
 
@@ -43,6 +44,13 @@ 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:
@@ -59,13 +67,21 @@ public:
                line_onoffdash //< dashes with spaces
        };
 
+       /// 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.
+       };
+
        virtual ~Painter() {}
 
        /// draw a line from point to point
        virtual void line(
                int x1, int y1,
                int x2, int y2,
-               LColor_color,
+               ColorCode,
                line_style = line_solid,
                line_width = line_thin) = 0;
 
@@ -79,7 +95,7 @@ public:
                int const * xp,
                int const * yp,
                int np,
-               LColor_color,
+               ColorCode,
                line_style = line_solid,
                line_width = line_thin) = 0;
 
@@ -87,7 +103,7 @@ public:
        virtual void rectangle(
                int x, int y,
                int w, int h,
-               LColor_color,
+               ColorCode,
                line_style = line_solid,
                line_width = line_thin) = 0;
 
@@ -95,23 +111,23 @@ public:
        virtual void fillRectangle(
                int x, int y,
                int w, int h,
-               LColor_color) = 0;
+               ColorCode) = 0;
 
        /// draw an arc
        virtual void arc(
                int x, int y,
                unsigned int w, unsigned int h,
                int a1, int a2,
-               LColor_color) = 0;
+               ColorCode) = 0;
 
        /// draw a pixel
        virtual void point(
                int x, int y,
-               LColor_color) = 0;
+               ColorCode) = 0;
 
        /// draw a filled rectangle with the shape of a 3D button
        virtual void button(int x, int y,
-               int w, int h);
+               int w, int h, bool mouseHover);
 
        /// draw an image from the image cache
        virtual void image(int x, int y,
@@ -123,24 +139,16 @@ public:
        * \return the width of the drawn text.
        */
        virtual int text(int x, int y,
-               docstring const & str, LyXFont const & f) = 0;
+               docstring const & str, Font const & f) = 0;
 
        void setDrawingEnabled(bool drawing_enabled = true)
        { drawing_enabled_ = drawing_enabled; }
 
-       /**
-        * Draw a string at position x, y (y is the baseline)
-        * This is just for fast drawing
-        * \return the width of the drawn text.
-        */
-       virtual int text(int x, int y,
-               char_type const * str, size_t l, LyXFont const & f) = 0;
-
        /// draw a char at position x, y (y is the baseline)
        /**
        * \return the width of the drawn text.
        */
-       virtual int text(int x, int y, char_type c, LyXFont const & f) = 0;
+       virtual int text(int x, int y, char_type c, Font const & f) = 0;
 
        /**
         * Draw a string and enclose it inside a rectangle. If
@@ -150,17 +158,25 @@ public:
         */
        void rectText(int x, int baseline,
                docstring const & str,
-               LyXFont const & font,
-               LColor_color back,
-               LColor_color frame);
+               Font const & font,
+               ColorCode back,
+               ColorCode frame);
 
        /// draw a string and enclose it inside a button frame
-       void buttonText(int x,
-               int baseline, docstring const & s, LyXFont const & font);
+       void buttonText(int x, int baseline, docstring const & s,
+               Font const & font, bool mouseHover);
+
+       /// draw a character of a preedit string for cjk support.
+       int preeditText(int x, int y,
+               char_type c, Font const & f, preedit_style style);
 
 protected:
        /// check the font, and if set, draw an underline
-       void underline(LyXFont const & f,
+       void underline(Font const & f,
+               int x, int y, int width);
+
+       /// check the font, and if set, draw an dashed underline
+       void dashedUnderline(Font const & f,
                int x, int y, int width);
 
        /// draw a bevelled button border