* src/frontends/qt4/GuiSelection.C

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

diff --git a/src/frontends/Painter.h b/src/frontends/Painter.h
index 9680acb2e2d10205f227767029b88e9e6a0904f5..40f624b420f73edda88fa512b0b1e6ec22f24a5b 100644 (file)
--- a/src/frontends/Painter.h
+++ b/src/frontends/Painter.h
@@ -13,19 +13,14 @@
 #ifndef PAINTER_H
 #define PAINTER_H
 
-#include "LColor.h"
-
-#include "support/types.h"
-
-#include <string>
+#include "support/docstring.h"
 
+namespace lyx {
 
+class LColor_color;
 class LyXFont;
 
-namespace lyx {
-namespace graphics {
-       class Image;
-}
+namespace graphics { class Image; }
 
 namespace frontend {
 
@@ -48,9 +43,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
@@ -65,17 +68,6 @@ public:
 
        virtual ~Painter() {}
 
-       /// 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;
-
        /// draw a line from point to point
        virtual void line(
                int x1, int y1,
@@ -112,13 +104,6 @@ public:
                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;
-
        /// draw an arc
        virtual void arc(
                int x, int y,
@@ -133,28 +118,36 @@ public:
 
        /// 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,
                int w, int h,
-               lyx::graphics::Image const & image) = 0;
+               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;
+       /**
+       * \return the width of the drawn text.
+       */
+       virtual int text(int x, int y,
+               docstring const & str, LyXFont 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 void text(int x, int y,
-               char const * str, size_t l,
-               LyXFont const & f) = 0;
+       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)
-       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, LyXFont const & f) = 0;
 
        /**
         * Draw a string and enclose it inside a rectangle. If
@@ -162,24 +155,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,
+       void rectText(int x, int baseline,
+               docstring const & str,
                LyXFont const & font,
                LColor_color back,
                LColor_color frame);
 
        /// draw a string and enclose it inside a button frame
-       virtual void buttonText(int x,
-               int baseline, std::string const & s,
-               LyXFont const & font);
+       void buttonText(int x, int baseline, docstring const & s,
+               LyXFont const & font, bool mouseHover);
 
 protected:
        /// check the font, and if set, draw an underline
-       virtual void underline(LyXFont const & f,
+       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);
+       void buttonFrame(int x, int y, int w, int h);
+
+       /// Indicate wether real screen drawing shall be done or not.
+       bool isDrawingEnabled() const { return drawing_enabled_; }
+
+private:
+       ///
+       bool drawing_enabled_;
 };
 
 } // namespace frontend