Displays an instance of dw::core::Imgbuf. More...

#include <image.hh>

Public Member Functions
	Image (const char *altText)

	~Image ()

virtual bool	getAdjustMinWidth ()

core::Iterator *	iterator (core::Content::Type mask, bool atEnd)
	Return an iterator for this widget. More...

core::Imgbuf *	getBuffer ()

void	setBuffer (core::Imgbuf *buffer, bool resize=false)
	Called, when an image buffer is attached. More...

void	drawRow (int row)
	Called, when data from a row is available and has been copied into the image buffer. More...

void	finish ()
	Called, when all image data has been retrieved. More...

void	fatal ()
	Called, when there are problems with the retrieval of image data. More...

void	setIsMap ()
	Sets image as server side image map. More...

void	setUseMap (ImageMapsList list, Object key)
	Sets image as client side image map. More...

void	forceMapRedraw ()

Public Member Functions inherited from dw::core::Widget
void	setDeleteCallback (DW_Callback_t func, void *data)

	Widget ()

	~Widget ()

bool	resizeQueued ()

bool	extremesQueued ()

bool	needsResize ()

bool	needsAllocate ()

bool	allocateQueued ()

bool	extremesChanged ()

bool	wasAllocated ()

void	setParent (Widget *parent)

void	setQuasiParent (Widget *quasiParent)

void	setGenerator (Widget *generator)

style::Style *	getStyle ()

Allocation *	getAllocation ()

bool	inAllocation (int x, int y)

int	boxOffsetX ()

int	boxRestWidth ()

int	boxDiffWidth ()

int	boxOffsetY ()

int	boxRestHeight ()

int	boxDiffHeight ()

virtual int	numSizeRequestReferences ()
	See Sizes of Dillo Widgets (or Size requisitions depending on positions). More...

virtual Widget *	sizeRequestReference (int index)
	See Sizes of Dillo Widgets (or Size requisitions depending on positions). More...

virtual int	numGetExtremesReferences ()
	See Sizes of Dillo Widgets (or Size requisitions depending on positions). More...

virtual Widget *	getExtremesReference (int index)
	See Sizes of Dillo Widgets (or Size requisitions depending on positions). More...

void	sizeRequest (Requisition requisition, int numPos=0, Widget references=NULL, int x=NULL, int *y=NULL)
	This method is a wrapper for Widget::sizeRequestImpl(); it calls the latter only when needed. More...

void	getExtremes (Extremes extremes, int numPos=0, Widget references=NULL, int x=NULL, int *y=NULL)
	Wrapper for Widget::getExtremesImpl(). More...

void	sizeAllocate (Allocation *allocation)
	Wrapper for Widget::sizeAllocateImpl, calls the latter only when needed. More...

void	calcExtraSpace (int numPos, Widget *references, int x, int *y)
	Calculates dw::core::Widget::extraSpace. More...

int	getAvailWidth (bool forceValue)

int	getAvailHeight (bool forceValue)

void	correctRequisition (Requisition requisition, void(splitHeightFun)(int, int , int ), bool allowDecreaseWidth, bool allowDecreaseHeight)

void	correctExtremes (Extremes *extremes, bool useAdjustmentWidth)

int	calcWidth (style::Length cssValue, int refWidth, Widget *refWidget, int limitMinWidth, bool forceValue)

void	calcFinalWidth (style::Style style, int refWidth, Widget refWidget, int limitMinWidth, bool forceValue, int *finalWidth)

int	calcHeight (style::Length cssValue, bool usePercentage, int refHeight, Widget *refWidget, bool forceValue)

virtual int	applyPerWidth (int containerWidth, style::Length perWidth)

virtual int	applyPerHeight (int containerHeight, style::Length perHeight)

int	getMinWidth (Extremes *extremes, bool forceValue)
	Used to evaluate Widget::adjustMinWidth. More...

virtual bool	isBlockLevel ()

virtual bool	isPossibleContainer ()

void	containerSizeChanged ()

bool	intersects (Widget refWidget, Rectangle area, Rectangle *intersection)
	Calculates the intersection of the visible allocation (i. e. the intersection with the visible parent allocation) and "area" (in widget coordinates referring to "refWidget"), returned in intersection (in widget coordinates). More...

void	drawInterruption (View view, Rectangle area, DrawingContext *context)

virtual Widget *	getWidgetAtPoint (int x, int y, GettingWidgetAtPointContext *context)

Widget *	getWidgetAtPointInterrupted (int x, int y, GettingWidgetAtPointContext *context)

bool	buttonPress (EventButton *event)

bool	buttonRelease (EventButton *event)

bool	motionNotify (EventMotion *event)

void	enterNotify (EventCrossing *event)

void	leaveNotify (EventCrossing *event)

virtual void	setStyle (style::Style *style)
	Change the style of a widget. More...

void	setBgColor (style::Color *bgColor)
	Set the background "behind" the widget, if it is not the background of the parent widget, e.g. the background of a table row. More...

style::Color *	getBgColor ()
	Get the actual background of a widget. More...

void	drawBox (View view, style::Style style, Rectangle *area, int x, int y, int width, int height, bool inverse)
	Draw borders and background of a widget part, which allocation is given by (x, y, width, height) (widget coordinates). More...

void	drawWidgetBox (View view, Rectangle area, bool inverse)
	Draw borders and background of a widget. More...

void	drawSelected (View view, Rectangle area)

void	setButtonSensitive (bool buttonSensitive)

bool	isButtonSensitive ()

Widget *	getParent ()

Widget *	getContainer ()

Widget *	getTopLevel ()
	Get the widget at the root of the tree, this widget is part from. More...

int	getLevel ()
	Get the level of the widget within the tree. More...

int	getGeneratorLevel ()
	Get the level of the widget within the tree, regarting the generators, not the parents. More...

Widget *	getNearestCommonAncestor (Widget *otherWidget)
	Get the widget with the highest level, which is a direct ancestor of widget1 and widget2. More...

WidgetReference *	getWidgetReference ()

void	setWidgetReference (WidgetReference *widgetReference)

Widget *	getGenerator ()

Layout *	getLayout ()

void	scrollTo (HPosition hpos, VPosition vpos, int x, int y, int width, int height)

void	getMarginArea (int xMar, int yMar, int widthMar, int heightMar)

void	getBorderArea (int xBor, int yBor, int widthBor, int heightBor)

void	getPaddingArea (int xPad, int yPad, int widthPad, int heightPad)
	Return the padding area (content plus padding). More...

virtual void	removeChild (Widget *child)

Public Member Functions inherited from lout::identity::IdentifiableObject
	IdentifiableObject ()

void	intoStringBuffer (misc::StringBuffer *sb)
	Store a textual representation of the object in a misc::StringBuffer. More...

int	getClassId ()
	Returns the class identifier. More...

const char *	getClassName ()
	Return the name, under which the class of this object was registered. More...

bool	instanceOf (int otherClassId)
	Returns, whether this class is an instance of the class, given by otherClassId, or of a sub class of this class. More...

Public Member Functions inherited from lout::object::Object
virtual	~Object ()
	The destructor is defined as virtual (but not abstract), so that destruction of Object's works properly. More...

virtual bool	equals (Object *other)
	Returns, whether two objects are equal. More...

virtual int	hashValue ()
	Return a hash value for the object. More...

virtual Object *	clone ()
	Return an exact copy of the object. More...

const char *	toString ()
	Use object::Object::intoStringBuffer to return a textual representation of the object. More...

virtual size_t	sizeOf ()
	Return the number of bytes, this object totally uses. More...

Public Member Functions inherited from dw::core::ImgRenderer
virtual	~ImgRenderer ()

Static Public Attributes
static int	CLASS_ID = -1

Static Public Attributes inherited from dw::core::Widget
static int	CLASS_ID = -1

Protected Member Functions
void	sizeRequestSimpl (core::Requisition *requisition)
	Simple variant, to be implemented by widgets with sizes not depending on positions. More...

void	getExtremesSimpl (core::Extremes *extremes)
	Simple variant, to be implemented by widgets with extremes not depending on positions. More...

void	sizeAllocateImpl (core::Allocation *allocation)
	See Sizes of Dillo Widgets. More...

void	containerSizeChangedForChildren ()

void	draw (core::View view, core::Rectangle area, core::DrawingContext *context)

bool	buttonPressImpl (core::EventButton *event)

bool	buttonReleaseImpl (core::EventButton *event)

void	enterNotifyImpl (core::EventCrossing *event)

void	leaveNotifyImpl (core::EventCrossing *event)

bool	motionNotifyImpl (core::EventMotion *event)

int	contentX (core::MousePositionEvent *event)

int	contentY (core::MousePositionEvent *event)

Protected Member Functions inherited from dw::core::Widget
int	getHeight ()

int	getContentWidth ()

int	getContentHeight ()

StackingContextMgr *	getNextStackingContextMgr ()

void	printFlag (Flags f)

void	setFlags (Flags f)

void	unsetFlags (Flags f)

void	queueDraw ()

void	queueDrawArea (int x, int y, int width, int height)

void	queueResize (int ref, bool extremesChanged)

virtual void	sizeRequestImpl (Requisition requisition, int numPos, Widget references, int x, int *y)
	See Sizes of Dillo Widgets. More...

virtual void	getExtremesImpl (Extremes extremes, int numPos, Widget references, int x, int *y)
	See Sizes of Dillo Widgets. More...

virtual void	calcExtraSpaceImpl (int numPos, Widget *references, int x, int *y)
	The actual implementation for calculating dw::core::Widget::extraSpace. More...

virtual void	resizeDrawImpl ()
	Called after sizeAllocateImpl() to redraw necessary areas. By default the whole widget is redrawn. More...

virtual void	markSizeChange (int ref)
	See Sizes of Dillo Widgets. More...

virtual void	markExtremesChange (int ref)
	See Sizes of Dillo Widgets. More...

virtual int	getAvailWidthOfChild (Widget *child, bool forceValue)

virtual int	getAvailHeightOfChild (Widget *child, bool forceValue)

virtual void	correctRequisitionOfChild (Widget child, Requisition requisition, void(splitHeightFun)(int, int , int *), bool allowDecreaseWidth, bool allowDecreaseHeight)

void	correctReqWidthOfChild (Widget child, Requisition requisition, bool allowDecreaseWidth)

void	correctReqHeightOfChild (Widget child, Requisition requisition, void(splitHeightFun)(int, int , int *), bool allowDecreaseHeight)

virtual void	correctExtremesOfChild (Widget child, Extremes extremes, bool useAdjustmentWidth)

virtual bool	affectedByContainerSizeChange ()

virtual bool	affectsSizeChangeContainerChild (Widget *child)

virtual bool	usesAvailWidth ()
	Must be implemengted by a method returning true, when getAvailWidth() is called. More...

virtual bool	usesAvailHeight ()
	Must be implemengted by a method returning true, when getAvailHeight() is called. More...

virtual void	notifySetAsTopLevel ()
	This method is called after a widget has been set as the top of a widget tree. More...

virtual void	notifySetParent ()
	This method is called after a widget has been added to a parent. More...

char *	addAnchor (const char *name)

char *	addAnchor (const char *name, int y)

void	changeAnchor (char *name, int y)

void	removeAnchor (char *name)

void	setCursor (style::Cursor cursor)

bool	selectionHandleEvent (SelectionState::EventType eventType, Iterator it, int charPos, int linkNo, MousePositionEvent event)

Protected Member Functions inherited from lout::identity::IdentifiableObject
void	registerName (const char className, int classId)
	This method must be called in the constructor for the sub class. See class comment for details. More...

Private Attributes
char *	altText

core::Imgbuf *	buffer

int	bufWidth

int	bufHeight

int	altTextWidth

bool	clicking

int	currLink

ImageMapsList *	mapList

Object *	mapKey

bool	isMap

Additional Inherited Members
Static Public Member Functions inherited from dw::core::Widget
static void	setAdjustMinWidth (bool adjustMinWidth)

static void	adjustHeight (int *height, bool allowDecreaseHeight, int ascent, int descent)

Public Attributes inherited from dw::core::Widget
int	parentRef
	This value is defined by the parent widget, and used for incremential resizing. More...

Protected Types inherited from dw::core::Widget
enum	Flags { RESIZE_QUEUED = 1 << 0, EXTREMES_QUEUED = 1 << 1, NEEDS_RESIZE = 1 << 2, NEEDS_ALLOCATE = 1 << 3, ALLOCATE_QUEUED = 1 << 4, EXTREMES_CHANGED = 1 << 5, WAS_ALLOCATED = 1 << 6 }

Protected Attributes inherited from dw::core::Widget
WidgetImgRenderer *	widgetImgRenderer

Allocation	allocation
	The current allocation: size and position, always relative to the canvas. More...

Layout *	layout

style::Box	extraSpace
	Space around the margin box. Allocation is extraSpace + margin + border + padding + contents. More...

StackingContextMgr *	stackingContextMgr
	Set iff this widget constitutes a stacking context, as defined by CSS. More...

Widget *	stackingContextWidget
	The bottom-most ancestor (or this) for which stackingContextMgr is set. More...

Detailed Description

Displays an instance of dw::core::Imgbuf.

The dw::core::Imgbuf is automatically scaled, when needed, but dw::Image does not keep a reference on the root buffer.

Signals

For image maps, dw::Image uses the signals defined in dw::core::Layout::LinkReceiver. For client side image maps, -1 is passed for the coordinates, for server side image maps, the respective coordinates are used. See section "Image Maps" below.

Image Maps

Client Side Image Maps

You must first create a list of image maps (dw::ImageMapList), which can be used for multiple images. The caller is responsible for freeing the dw::ImageMapList.

Adding a map is done by dw::ImageMapsList::startNewMap. The key is an instance of a sub class of object::Object. In the context of HTML, this is a URL, which defines this map globally, by combining the URL of the document, this map is defined in, with the value of the attribute "name" of the <MAP> element, as a fragment.

dw::ImageMapsList::addShapeToCurrentMap adds a shape to the current map. The link argument is a number, which is later passed to the dw::core::Layout::LinkReceiver.

This map list is then, together with the key for the image, passed to dw::Image::setUseMap. For HTML, a URL with the value of the "ismap" attribute of <IMG> should be used.

dw::Image will search the correct map, when needed. If it is not found at this time, but later defined, it will be found and used later. This is the case, when an HTML <MAP> is defined below the <IMG> in the document.

Currently, only maps defined in the same document as the image may be used, since the dw::ImageMapsList is stored in the HTML link block, and contains only the image maps defined in the document.

Server Side Image Maps

To use images for server side image maps, you must call dw::Image::setIsMap, and the dw::Image::style must contain a valid link (dw::core::style::Style::x_link). After this, motions and clicks are delegated to dw::core::Layout::LinkReceiver.

See also: Images and Backgrounds in Dw

Constructor & Destructor Documentation

dw::Image::Image ( const char * altText )

References DBG_OBJ_CREATE, and DBG_OBJ_SET_NUM.

dw::Image::~Image ( )

References DBG_OBJ_DELETE.

Member Function Documentation

bool dw::Image::buttonPressImpl ( core::EventButton * event )

protectedvirtual

Reimplemented from dw::core::Widget.

References dw::core::EventButton::button, and layout.

bool dw::Image::buttonReleaseImpl ( core::EventButton * event )

protectedvirtual

Reimplemented from dw::core::Widget.

References layout.

void dw::Image::containerSizeChangedForChildren ( )

protectedvirtual

Reimplemented from dw::core::Widget.

References DBG_OBJ_ENTER0, and DBG_OBJ_LEAVE.

int dw::Image::contentX ( core::MousePositionEvent * event )

protected

References lout::misc::max(), and lout::misc::min().

int dw::Image::contentY ( core::MousePositionEvent * event )

protected

References lout::misc::max(), and lout::misc::min().

void dw::Image::draw	(	core::View *	view,
		core::Rectangle *	area,
		core::DrawingContext *	context
	)

protectedvirtual

Area is given in widget coordinates.

TODO: draw selection

Implements dw::core::Widget.

References dw::core::View::drawImage(), dw::core::View::drawSimpleWrappedText(), dw::core::View::getClippingView(), dw::core::Rectangle::height, dw::core::Rectangle::intersectsWith(), layout, dw::core::View::mergeClippingView(), dw::core::style::Color::SHADING_NORMAL, dw::core::Rectangle::width, dw::core::Rectangle::x, and dw::core::Rectangle::y.

void dw::Image::drawRow ( int row )

virtual

Called, when data from a row is available and has been copied into the image buffer.

The implementation will typically queue the respective area for drawing.

Implements dw::core::ImgRenderer.

References dw::core::Rectangle::height, dw::core::Rectangle::width, dw::core::Rectangle::x, and dw::core::Rectangle::y.

Referenced by imageDrawTimeout().

void dw::Image::enterNotifyImpl ( core::EventCrossing * event )

protectedvirtual

Reimplemented from dw::core::Widget.

References layout.

void dw::Image::fatal ( )

virtual

Called, when there are problems with the retrieval of image data.

The implementation may use this to indicate an error.

Implements dw::core::ImgRenderer.

void dw::Image::finish ( )

virtual

Called, when all image data has been retrieved.

The implementation may use this instead of "drawRow" for drawing, to limit the number of draws.

Implements dw::core::ImgRenderer.

void dw::Image::forceMapRedraw ( )

inline

References dw::core::Widget::queueDraw().

virtual bool dw::Image::getAdjustMinWidth ( )

inlinevirtual

Reimplemented from dw::core::Widget.

core::Imgbuf* dw::Image::getBuffer ( )

inline

References buffer.

void dw::Image::getExtremesSimpl ( core::Extremes * extremes )

protectedvirtual

Simple variant, to be implemented by widgets with extremes not depending on positions.

Reimplemented from dw::core::Widget.

References dw::core::Extremes::adjustmentWidth, dw::core::style::isPerLength(), layout, dw::core::Extremes::maxWidth, dw::core::Extremes::maxWidthIntrinsic, lout::misc::min(), dw::core::Extremes::minWidth, and dw::core::Extremes::minWidthIntrinsic.

core::Iterator * dw::Image::iterator	(	core::Content::Type	mask,
		bool	atEnd
	)

virtual

Return an iterator for this widget.

mask can narrow the types returned by the iterator, this can enhance performance quite much, e.g. when only searching for child widgets.

With atEnd == false, the iterator starts before the beginning, i.e. the first call of dw::core::Iterator::next will let the iterator point on the first piece of contents. Likewise, With atEnd == true, the iterator starts after the last piece of contents, call dw::core::Iterator::prev in this case.

Bug:: Not implemented.

Implements dw::core::Widget.

void dw::Image::leaveNotifyImpl ( core::EventCrossing * event )

protectedvirtual

Reimplemented from dw::core::Widget.

References layout.

bool dw::Image::motionNotifyImpl ( core::EventMotion * event )

protectedvirtual

Reimplemented from dw::core::Widget.

References dw::core::style::CURSOR_POINTER, and layout.

void dw::Image::setBuffer	(	core::Imgbuf *	buffer,
		bool	resize = `false`
	)

virtual

Called, when an image buffer is attached.

This is typically the case when all meta data (size, depth) has been read.

Implements dw::core::ImgRenderer.

References DBG_OBJ_ASSOC_CHILD, DBG_OBJ_SET_NUM, dw::core::Imgbuf::getRootHeight(), dw::core::Imgbuf::getRootWidth(), dw::core::Imgbuf::getScaledBuf(), dw::core::Imgbuf::ref(), and dw::core::Imgbuf::unref().

Referenced by imageInitTimeout().

void dw::Image::setIsMap ( )

Sets image as server side image map.

void dw::Image::setUseMap	(	ImageMapsList *	list,
		Object *	key
	)

Sets image as client side image map.

"list" is not owned by the image, the caller has to free it. "key" is owned by the image, if it is used by the caller afterwards, a copy should be passed.

void dw::Image::sizeAllocateImpl ( core::Allocation * allocation )

protectedvirtual

See Sizes of Dillo Widgets.

Reimplemented from dw::core::Widget.

References dw::core::Allocation::ascent, DBG_OBJ_ASSOC_CHILD, DBG_OBJ_ENTER, DBG_OBJ_LEAVE, DBG_OBJ_MSG, DBG_OBJ_SET_NUM, dw::core::Allocation::descent, dw::core::Imgbuf::getScaledBuf(), dw::core::Imgbuf::unref(), dw::core::Allocation::width, dw::core::Allocation::x, and dw::core::Allocation::y.

void dw::Image::sizeRequestSimpl ( core::Requisition * requisition )

protectedvirtual

Simple variant, to be implemented by widgets with sizes not depending on positions.

Reimplemented from dw::core::Widget.

References dw::core::Requisition::ascent, DBG_OBJ_ENTER0, DBG_OBJ_LEAVE, DBG_OBJ_MSGF, dw::core::Requisition::descent, layout, dw::core::style::LENGTH_AUTO, dw::core::splitHeightPreserveDescent(), and dw::core::Requisition::width.

Member Data Documentation

char* dw::Image::altText

private

int dw::Image::altTextWidth

private

core::Imgbuf* dw::Image::buffer

private

Referenced by getBuffer().

int dw::Image::bufHeight

private

int dw::Image::bufWidth

private

int dw::Image::CLASS_ID = -1

static

bool dw::Image::clicking

private

int dw::Image::currLink

private

bool dw::Image::isMap

private

Object* dw::Image::mapKey

private

ImageMapsList* dw::Image::mapList

private

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

dw/image.hh
dw/image.cc

Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Signals

Image Maps

Client Side Image Maps

Server Side Image Maps

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation