// -*- C++ -*-
/**
* \file Painter.h
- * Copyright 1998-2002 the LyX Team
- * Read the file COPYING
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
* \author unknown
- * \author John Levon <moz@compsoc.man.ac.uk>
+ * \author John Levon
+ *
+ * Full author contact details are available in file CREDITS
*/
#ifndef PAINTER_H
class LyXFont;
namespace grfx {
- class GImage;
+ class Image;
}
/**
/// draw an image from the image cache
virtual Painter & image(int x, int y,
int w, int h,
- grfx::GImage const & image) = 0;
+ grfx::Image const & image) = 0;
/// draw a string at position x, y (y is the baseline)
virtual Painter & text(int x, int y,
virtual Painter & text(int x, int y,
char c, LyXFont const & f) = 0;
- /// draw a string and enclose it inside a rectangle
+ /**
+ * 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.
+ */
Painter & rectText(int x, int baseline,
string const & string,
LyXFont const & font,
- LColor::color back,
- LColor::color frame);
+ LColor::color back = LColor::none,
+ LColor::color frame = LColor::none);
/// draw a string and enclose it inside a button frame
Painter & buttonText(int x,