X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Ffrontends%2FPainter.h;h=b4843e67646f1ace0c85bddd90c9ed658a9135dc;hb=50060053e36b3e9dfe03bc33ed3abac1eacc54b0;hp=1578c224e5bcc6f0d5a82f1d98ff900e5e607e09;hpb=06f9f0ea08ddcf13e99ea02cff21471aa2020c9e;p=lyx.git diff --git a/src/frontends/Painter.h b/src/frontends/Painter.h index 1578c224e5..b4843e6764 100644 --- a/src/frontends/Painter.h +++ b/src/frontends/Painter.h @@ -1,178 +1,198 @@ // -*- C++ -*- -/* This file is part of - * ====================================================== +/** + * \file Painter.h + * This file is part of LyX, the document processor. + * Licence details can be found in the file COPYING. * - * LyX, The Document Processor + * \author unknown + * \author John Levon * - * Copyright 1998-2001 The LyX Team - * - *======================================================*/ - -#ifndef PAINTERBASE_H -#define PAINTERBASE_H + * Full author contact details are available in file CREDITS. + */ -#ifdef __GNUG__ -#pragma interface -#endif +#ifndef PAINTER_H +#define PAINTER_H -#include "LString.h" -#include "LColor.h" +#include "support/strfwd.h" +#include "support/types.h" -class WorkArea; -class LyXFont; -namespace grfx { - class GImage; -} +namespace lyx { -/** A painter class to encapsulate all graphics parameters and operations +class Font; +class FontInfo; - Every graphics operation in LyX should be made by this class. It will - be initialized and managed by the Screen class, and will be passed - as a parameter to inset. +namespace graphics { class Image; } - It hides low level windows system parameters so insets and other - clients don't have to worry about them and we can control graphics and - GUI toolkit dependent drawing functions inside this single class. +namespace frontend { +/** + * Painter - A painter class to encapsulate all graphics parameters and operations + * + * Every graphics operation in LyX should be made by this class. The + * painter is used for drawing on the WorkArea, and is passed around + * during draw operations. + * + * It hides low level windows system parameters so insets and other + * clients don't have to worry about them and we can control graphics and + * GUI toolkit dependent drawing functions inside this single class. + * + * 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, does the copy onto the actual WorkArea widget take place. + * + * 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 PainterBase { +class Painter { public: - /// - enum line_width { - /// - line_thin, - /// - line_thick - }; + Painter(double pixel_ratio) : drawing_enabled_(true), pixel_ratio_(pixel_ratio) {} - /// + static const int thin_line; + + /// possible line styles enum line_style { - /// - line_solid, - /// - line_doubledash, - /// - line_onoffdash + line_solid, //< solid line + line_solid_aliased, //< solid line, no anti-aliasing (used as a + // workaround to painting issues) + line_onoffdash //< dashes with spaces }; - /// - explicit PainterBase(WorkArea & wa) : owner(wa) {} - - /// - virtual ~PainterBase() {} - - /* Screen geometry */ - /// - int paperMargin() const; - /// - int paperWidth() const; - /// - int paperHeight() const; - - /// Draw a line from point to point - virtual PainterBase & line( - int x1, int y1, int x2, int y2, - LColor::color = LColor::foreground, - enum line_style = line_solid, - enum line_width = line_thin) = 0; - - /** Draw the lines between the lines in xp and yp. - xp and yp are arrays of points, and np is the - number of them. */ - virtual PainterBase & lines( - int const * xp, int const * yp, int np, - LColor::color = LColor::foreground, - enum line_style = line_solid, - enum line_width = line_thin) = 0; - - /// Here xp and yp are arrays of points - virtual PainterBase & fillPolygon( - int const * xp, int const * yp, - int np, - LColor::color = LColor::foreground) = 0; - - /// Draw lines from x1,y1 to x2,y2. They are arrays - virtual PainterBase & segments( - int const * x1, int const * y1, - int const * x2, int const * y2, int ns, - LColor::color = LColor::foreground, - enum line_style = line_solid, - enum line_width = line_thin) = 0; - - /// Draw a rectangle - virtual PainterBase & rectangle( - int x, int y, int w, int h, - LColor::color = LColor::foreground, - enum line_style = line_solid, - enum line_width = line_thin) = 0; - - /// Draw a circle, d is the diameter, not the radious - virtual PainterBase & circle( - int x, int y, unsigned int d, - LColor::color = LColor::foreground); - - /// Draw an ellipse - virtual PainterBase & ellipse( - int x, int y, - unsigned int w, unsigned int h, - LColor::color = LColor::foreground); - - /// Draw an arc - virtual PainterBase & arc( - int x, int y, - unsigned int w, unsigned int h, - int a1, int a2, - LColor::color = LColor::foreground) = 0; - - /// Draw a pixel - virtual PainterBase & point( - int x, int y, - LColor::color = LColor::foreground) = 0; - - /// Fill a rectangle - virtual PainterBase & fillRectangle( - int x, int y, int w, int h, - LColor::color) = 0; - - /// A filled rectangle with the shape of a 3D button - virtual PainterBase & button(int x, int y, int w, int h); - - /// - virtual PainterBase & buttonFrame(int x, int y, int w, int h); - - - // For the figure inset - virtual PainterBase & 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 PainterBase & text(int x, int y, - 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 PainterBase & text(int x, int y, char const * str, size_t l, - LyXFont const & f) = 0; - - /// Draw a char at position x, y (y is the baseline) - virtual PainterBase & text(int x, int y, char c, LyXFont const & f)=0; + /// possible fill styles + enum fill_style { + fill_none, + fill_oddeven, + fill_winding + }; - /** Draws a string and encloses it inside a rectangle. */ - PainterBase & rectText(int x, int baseline, - string const & string, - LyXFont const & font, - LColor::color back, - LColor::color frame); + /// 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. + }; - /** Draw a string and encloses it inside a button frame. */ - PainterBase & buttonText(int x, int baseline, string const & s, - LyXFont const & font); -protected: + virtual ~Painter() {} + + /// draw a line from point to point + 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 + * @param xp array of points' x co-ords + * @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, 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, 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, Color) = 0; + + /// draw an arc + 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, Color) = 0; + + /// draw a filled rectangle with the shape of a 3D button + 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, + graphics::Image const & image) = 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 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, docstring const & str, Font const & f, + double wordspacing, double textwidth) = 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; + + 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_; } + + double pixelRatio() const { return pixel_ratio_; } + + /// draw the underbar, strikeout, 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 + * 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 + 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: /// - WorkArea & owner; + bool drawing_enabled_; + /// Ratio between physical pixels and device-independent pixels + double pixel_ratio_; }; -// VERY temporary -#include "xforms/XPainter.h" - -#endif +} // namespace frontend +} // namespace lyx + +#endif // PAINTER_H