dw::core::View Class Reference

An interface to encapsulate platform dependent drawing. More...

#include <view.hh>

List of all members.

Public Member Functions
virtual void	setLayout (Layout *layout)=0
	This methods notifies the view, that it has been attached to a layout.
virtual void	setCanvasSize (int width, int ascent, int descent)=0
	Set the canvas size.
virtual void	setCursor (style::Cursor cursor)=0
	Set the cursor appearance.
virtual void	setBgColor (style::Color *color)=0
	Set the background of the view.
virtual bool	usesViewport ()=0
	Return, whether this view uses a viewport.
virtual int	getHScrollbarThickness ()=0
	Get the thickness of the horizontal scrollbar, when it is visible.
virtual int	getVScrollbarThickness ()=0
	Get the thickness of the vertical scrollbar, when it is visible.
virtual void	scrollTo (int x, int y)=0
	Scroll the vieport to the given position.
virtual void	scroll (ScrollCommand)
	Scroll the viewport as commanded.
virtual void	setViewportSize (int width, int height, int hScrollbarThickness, int vScrollbarThickness)=0
	Set the viewport size.
virtual void	startDrawing (Rectangle *area)=0
	Called before drawing.
virtual void	finishDrawing (Rectangle *area)=0
	Called after drawing.
virtual void	queueDraw (Rectangle *area)=0
	Queue a region, which is given in canvas coordinates, for drawing.
virtual void	queueDrawTotal ()=0
	Queue the total viewport for drawing.
virtual void	cancelQueueDraw ()=0
	Cancel a draw queue request.
virtual void	drawPoint (style::Color *color, style::Color::Shading shading, int x, int y)=0
virtual void	drawLine (style::Color *color, style::Color::Shading shading, int x1, int y1, int x2, int y2)=0
virtual void	drawTypedLine (style::Color *color, style::Color::Shading shading, style::LineType type, int width, int x1, int y1, int x2, int y2)=0
virtual void	drawRectangle (style::Color *color, style::Color::Shading shading, bool filled, int x, int y, int width, int height)=0
virtual void	drawArc (style::Color *color, style::Color::Shading shading, bool filled, int centerX, int centerY, int width, int height, int angle1, int angle2)=0
virtual void	drawPolygon (style::Color *color, style::Color::Shading shading, bool filled, bool convex, Point *points, int npoints)=0
virtual void	drawText (style::Font *font, style::Color *color, style::Color::Shading shading, int x, int y, const char *text, int len)=0
virtual void	drawSimpleWrappedText (style::Font *font, style::Color *color, style::Color::Shading shading, int x, int y, int w, int h, const char *text)=0
virtual void	drawImage (Imgbuf *imgbuf, int xRoot, int yRoot, int x, int y, int width, int height)=0
virtual View *	getClippingView (int x, int y, int width, int height)=0
virtual void	mergeClippingView (View *clippingView)=0

---

Detailed Description

An interface to encapsulate platform dependent drawing.

See also:

Dillo Widget Overview, Layout and Views

---

Member Function Documentation

virtual void dw::core::View::cancelQueueDraw

(

)

[pure virtual]

Cancel a draw queue request.

If dw::core::View::queueDraw or dw::core::View::queueDrawTotal have been called before, and the actual drawing was not processed yet, the actual drawing should be cancelled. Otherwise, the cancellation should be ignored.

Implemented in dw::fltk::FltkViewBase.

Referenced by dw::core::Layout::queueResize().

virtual void dw::core::View::drawArc	(	style::Color *	color,
		style::Color::Shading	shading,
		bool	filled,
		int	centerX,
		int	centerY,
		int	width,
		int	height,
		int	angle1,
		int	angle2
	)			[pure virtual]

Implemented in dw::fltk::FltkViewBase.

Referenced by dw::core::Circle::draw(), and dw::Bullet::draw().

virtual void dw::core::View::drawImage	(	Imgbuf *	imgbuf,
		int	xRoot,
		int	yRoot,
		int	x,
		int	y,
		int	width,
		int	height
	)			[pure virtual]

Implemented in dw::fltk::FltkPreview, and dw::fltk::FltkWidgetView.

Referenced by dw::Image::draw().

virtual void dw::core::View::drawLine	(	style::Color *	color,
		style::Color::Shading	shading,
		int	x1,
		int	y1,
		int	x2,
		int	y2
	)			[pure virtual]

Implemented in dw::fltk::FltkViewBase.

Referenced by dw::core::style::drawBorderBottom(), dw::core::style::drawBorderLeft(), dw::core::style::drawBorderRight(), and dw::core::style::drawBorderTop().

virtual void dw::core::View::drawPoint	(	style::Color *	color,
		style::Color::Shading	shading,
		int	x,
		int	y
	)			[pure virtual]

Implemented in dw::fltk::FltkViewBase.

virtual void dw::core::View::drawPolygon	(	style::Color *	color,
		style::Color::Shading	shading,
		bool	filled,
		bool	convex,
		Point *	points,
		int	npoints
	)			[pure virtual]

Implemented in dw::fltk::FltkViewBase.

Referenced by dw::core::Polygon::draw(), dw::core::style::drawBorderBottom(), dw::core::style::drawBorderLeft(), dw::core::style::drawBorderRight(), and dw::core::style::drawBorderTop().

virtual void dw::core::View::drawRectangle	(	style::Color *	color,
		style::Color::Shading	shading,
		bool	filled,
		int	x,
		int	y,
		int	width,
		int	height
	)			[pure virtual]

Implemented in dw::fltk::FltkViewBase.

Referenced by dw::Textblock::decorateText(), dw::core::Rectangle::draw(), dw::Bullet::draw(), dw::core::style::drawBackground(), dw::Textblock::drawSpace(), and dw::Textblock::drawText().

virtual void dw::core::View::drawSimpleWrappedText	(	style::Font *	font,
		style::Color *	color,
		style::Color::Shading	shading,
		int	x,
		int	y,
		int	w,
		int	h,
		const char *	text
	)			[pure virtual]

Implemented in dw::fltk::FltkPreview, and dw::fltk::FltkWidgetView.

Referenced by dw::Image::draw().

virtual void dw::core::View::drawText	(	style::Font *	font,
		style::Color *	color,
		style::Color::Shading	shading,
		int	x,
		int	y,
		const char *	text,
		int	len
	)			[pure virtual]

Implemented in dw::fltk::FltkPreview, and dw::fltk::FltkWidgetView.

Referenced by dw::Textblock::drawText().

virtual void dw::core::View::drawTypedLine	(	style::Color *	color,
		style::Color::Shading	shading,
		style::LineType	type,
		int	width,
		int	x1,
		int	y1,
		int	x2,
		int	y2
	)			[pure virtual]

Implemented in dw::fltk::FltkViewBase.

Referenced by dw::core::style::drawBorderBottom(), dw::core::style::drawBorderLeft(), dw::core::style::drawBorderRight(), and dw::core::style::drawBorderTop().

virtual void dw::core::View::finishDrawing

(

Rectangle *

area

)

[pure virtual]

Called after drawing.

See also:

dw::core:View::startDrawing

Implemented in dw::fltk::FltkViewBase.

Referenced by dw::core::Layout::draw().

virtual View* dw::core::View::getClippingView	(	int	x,
		int	y,
		int	width,
		int	height
	)			[pure virtual]

Implemented in dw::fltk::FltkViewBase.

Referenced by dw::Image::draw().

virtual int dw::core::View::getHScrollbarThickness

(

)

[pure virtual]

Get the thickness of the horizontal scrollbar, when it is visible.

Does not have to be implemented, when usesViewport returns false.

Implemented in dw::fltk::FltkFlatView, dw::fltk::FltkPreview, and dw::fltk::FltkViewport.

Referenced by dw::core::Layout::attachView().

virtual int dw::core::View::getVScrollbarThickness

(

)

[pure virtual]

Get the thickness of the vertical scrollbar, when it is visible.

Does not have to be implemented, when usesViewport returns false.

Implemented in dw::fltk::FltkFlatView, dw::fltk::FltkPreview, and dw::fltk::FltkViewport.

Referenced by dw::core::Layout::attachView().

virtual void dw::core::View::mergeClippingView

(

View *

clippingView

)

[pure virtual]

Implemented in dw::fltk::FltkViewBase.

Referenced by dw::Image::draw().

virtual void dw::core::View::queueDraw

(

Rectangle *

area

)

[pure virtual]

Queue a region, which is given in canvas coordinates, for drawing.

The view implementation is responsible, that this region is drawn, either immediately, or (which is more typical, since more efficient) the areas are collected, combined (as far as possible), and the drawing is later done in an idle function.

Implemented in dw::fltk::FltkViewBase.

Referenced by dw::core::Layout::queueDraw().

virtual void dw::core::View::queueDrawTotal

(

)

[pure virtual]

Queue the total viewport for drawing.

See also:

dw::core::View::queueDraw

Implemented in dw::fltk::FltkViewBase.

Referenced by dw::core::Layout::removeWidget(), and dw::core::Layout::scrollIdle().

virtual void dw::core::View::scroll

(

ScrollCommand

)

[inline, virtual]

Scroll the viewport as commanded.

Reimplemented in dw::fltk::FltkPreview, and dw::fltk::FltkViewport.

Referenced by dw::core::Layout::scroll().

virtual void dw::core::View::scrollTo	(	int	x,
		int	y
	)			[pure virtual]

Scroll the vieport to the given position.

Does not have to be implemented, when usesViewport returns false.

Implemented in dw::fltk::FltkFlatView, dw::fltk::FltkPreview, and dw::fltk::FltkViewport.

Referenced by dw::core::Layout::attachView(), and dw::core::Layout::scrollIdle().

virtual void dw::core::View::setBgColor

(

style::Color *

color

)

[pure virtual]

Set the background of the view.

Implemented in dw::fltk::FltkViewBase.

Referenced by dw::core::Layout::attachView(), and dw::core::Layout::setBgColor().

virtual void dw::core::View::setCanvasSize	(	int	width,
		int	ascent,
		int	descent
	)			[pure virtual]

Set the canvas size.

Implemented in dw::fltk::FltkFlatView, dw::fltk::FltkPreview, dw::fltk::FltkViewBase, and dw::fltk::FltkViewport.

Referenced by dw::core::Layout::attachView(), dw::core::Layout::removeWidget(), and dw::core::Layout::resizeIdle().

virtual void dw::core::View::setCursor

(

style::Cursor

cursor

)

[pure virtual]

Set the cursor appearance.

Implemented in dw::fltk::FltkViewBase.

Referenced by dw::core::Layout::attachView(), and dw::core::Layout::setCursor().

virtual void dw::core::View::setLayout

(

Layout *

layout

)

[pure virtual]

This methods notifies the view, that it has been attached to a layout.

Implemented in dw::fltk::FltkViewBase.

Referenced by dw::core::Layout::attachView(), and dw::core::Layout::detachView().

virtual void dw::core::View::setViewportSize	(	int	width,
		int	height,
		int	hScrollbarThickness,
		int	vScrollbarThickness
	)			[pure virtual]

Set the viewport size.

Does not have to be implemented, when usesViewport returns false.

This will normally imply a resize of the UI widget. Width and height are the dimensions of the new size, including the scrollbar thicknesses.

Implemented in dw::fltk::FltkFlatView, dw::fltk::FltkPreview, and dw::fltk::FltkViewport.

Referenced by dw::core::Layout::attachView(), dw::core::Layout::removeWidget(), and dw::core::Layout::resizeIdle().

virtual void dw::core::View::startDrawing

(

Rectangle *

area

)

[pure virtual]

Called before drawing.

All actual drawing operations will be enclosed into calls of dw::core:View::startDrawing and dw::core:View::finishDrawing. They may be implemented, e.g. when a backing pixmap is used, to prevent flickering. StartDrawing() will then initialize the backing pixmap, all other drawing operations will draw into it, and finishDrawing() will merge it into the window.

Implemented in dw::fltk::FltkViewBase.

Referenced by dw::core::Layout::draw().

virtual bool dw::core::View::usesViewport

(

)

[pure virtual]

Return, whether this view uses a viewport.

Implemented in dw::fltk::FltkFlatView, dw::fltk::FltkPreview, and dw::fltk::FltkViewport.

Referenced by dw::core::Layout::attachView(), dw::core::Layout::removeWidget(), dw::core::Layout::scroll(), and dw::fltk::FltkViewBase::setLayout().

---

The documentation for this class was generated from the following file:

• dw/view.hh