dw::core::ui::Embed Class Reference

A widget for embedding UI widgets. More...

#include <ui.hh>

List of all members.

Public Member Functions
	Embed (Resource *resource)
	~Embed ()
void	setWidth (int width)
void	setAscent (int ascent)
void	setDescent (int descent)
void	setDisplayed (bool displayed)
void	setEnabled (bool enabled)
void	draw (View *view, Rectangle *area)
Iterator *	iterator (Content::Type mask, bool atEnd)
	Return an iterator for this widget.
void	setStyle (style::Style *style)
	Change the style of a widget.
void	setUsesHints ()
Resource *	getResource ()
Static Public Attributes
static int	CLASS_ID = -1
Protected Member Functions
void	sizeRequestImpl (Requisition *requisition)
	See Sizes of Dillo Widgets.
void	getExtremesImpl (Extremes *extremes)
	See Sizes of Dillo Widgets.
void	sizeAllocateImpl (Allocation *allocation)
	See Sizes of Dillo Widgets.
void	enterNotifyImpl (core::EventCrossing *event)
void	leaveNotifyImpl (core::EventCrossing *event)
bool	buttonPressImpl (core::EventButton *event)
Private Attributes
Resource *	resource
Friends
class	Resource

---

Detailed Description

A widget for embedding UI widgets.

See also:

dw::core::ui

---

Constructor & Destructor Documentation

dw::core::ui::Embed::Embed

(

Resource *

resource

)

References CLASS_ID, lout::identity::IdentifiableObject::registerName(), and dw::core::ui::Resource::setEmbed().

dw::core::ui::Embed::~Embed

(

)

References resource.

---

Member Function Documentation

bool dw::core::ui::Embed::buttonPressImpl

(

core::EventButton *

event

)

[protected, virtual]

Reimplemented from dw::core::Widget.

References dw::core::EventButton::button, dw::core::ui::Resource::emitClicked(), and resource.

void dw::core::ui::Embed::draw	(	View *	view,
		Rectangle *	area
	)			[virtual]

Area is given in widget coordinates.

Implements dw::core::Widget.

References dw::core::ui::Resource::draw(), dw::core::Widget::drawWidgetBox(), and resource.

void dw::core::ui::Embed::enterNotifyImpl

(

core::EventCrossing *

event

)

[protected, virtual]

Reimplemented from dw::core::Widget.

References dw::core::ui::Resource::emitEnter(), and resource.

void dw::core::ui::Embed::getExtremesImpl

(

Extremes *

extremes

)

[protected, virtual]

See Sizes of Dillo Widgets.

Reimplemented from dw::core::Widget.

References dw::core::ui::Resource::getExtremes(), and resource.

Resource* dw::core::ui::Embed::getResource

(

)

[inline]

References resource.

Iterator * dw::core::ui::Embed::iterator	(	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.

Implements dw::core::Widget.

References dw::core::ui::Resource::iterator(), and resource.

void dw::core::ui::Embed::leaveNotifyImpl

(

core::EventCrossing *

event

)

[protected, virtual]

Reimplemented from dw::core::Widget.

References dw::core::ui::Resource::emitLeave(), and resource.

void dw::core::ui::Embed::setAscent

(

int

ascent

)

[virtual]

Reimplemented from dw::core::Widget.

References resource, and dw::core::ui::Resource::setAscent().

void dw::core::ui::Embed::setDescent

(

int

descent

)

[virtual]

Reimplemented from dw::core::Widget.

References resource, and dw::core::ui::Resource::setDescent().

void dw::core::ui::Embed::setDisplayed

(

bool

displayed

)

References resource, and dw::core::ui::Resource::setDisplayed().

void dw::core::ui::Embed::setEnabled

(

bool

enabled

)

References resource, and dw::core::ui::Resource::setEnabled().

void dw::core::ui::Embed::setStyle

(

style::Style *

style

)

[virtual]

Change the style of a widget.

The old style is automatically unreferred, the new is referred. If this call causes the widget to change its size, dw::core::Widget::queueResize is called.

Reimplemented from dw::core::Widget.

References resource, and dw::core::ui::Resource::setStyle().

void dw::core::ui::Embed::setUsesHints

(

)

[inline]

References dw::core::Widget::setFlags(), and dw::core::Widget::USES_HINTS.

Referenced by dw::core::ui::ComplexButtonResource::setEmbed().

void dw::core::ui::Embed::setWidth

(

int

width

)

[virtual]

Reimplemented from dw::core::Widget.

References resource, and dw::core::ui::Resource::setWidth().

void dw::core::ui::Embed::sizeAllocateImpl

(

Allocation *

allocation

)

[protected, virtual]

See Sizes of Dillo Widgets.

Reimplemented from dw::core::Widget.

References resource, and dw::core::ui::Resource::sizeAllocate().

void dw::core::ui::Embed::sizeRequestImpl

(

Requisition *

requisition

)

[protected, virtual]

See Sizes of Dillo Widgets.

Implements dw::core::Widget.

References resource, and dw::core::ui::Resource::sizeRequest().

---

Friends And Related Function Documentation

friend class Resource [friend]

---

Member Data Documentation

int dw::core::ui::Embed::CLASS_ID = -1 [static]

Reimplemented from dw::core::Widget.

Referenced by Embed().

Resource* dw::core::ui::Embed::resource [private]

Referenced by buttonPressImpl(), draw(), enterNotifyImpl(), getExtremesImpl(), getResource(), iterator(), leaveNotifyImpl(), setAscent(), setDescent(), setDisplayed(), setEnabled(), setStyle(), setWidth(), sizeAllocateImpl(), sizeRequestImpl(), and ~Embed().

---

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

• dw/ui.hh
• dw/ui.cc