This implementation of dw::core::Iterator can be used by widgets with no contents. More...

#include <iterator.hh>

Public Member Functions
	EmptyIterator (Widget *widget, Content::Type mask, bool atEnd)

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

int	compareTo (lout::object::Comparable *other)
	Compare two objects, this and other. More...

bool	next ()
	Move iterator forward and store content it. More...

bool	prev ()
	Move iterator backward and store content it. More...

void	highlight (int start, int end, HighlightLayer layer)
	Extend highlighted region to contain part of the current content. More...

void	unhighlight (int direction, HighlightLayer layer)
	Shrink highlighted region to no longer contain the current content. More...

void	getAllocation (int start, int end, Allocation *allocation)
	Return the shape, which a part of the item, the iterator points on, allocates. More...

Public Member Functions inherited from dw::core::Iterator
bool	equals (Object *other)
	Returns, whether two objects are equal. More...

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

Widget *	getWidget ()

Content *	getContent ()

Content::Type	getMask ()

virtual void	unref ()
	Delete the iterator. More...

Iterator *	cloneIterator ()

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 int	hashValue ()
	Return a hash value for 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...

Private Member Functions
	EmptyIterator (EmptyIterator &it)

Additional Inherited Members
Static Public Member Functions inherited from dw::core::Iterator
static void	scrollTo (Iterator it1, Iterator it2, int start, int end, HPosition hpos, VPosition vpos)
	Scrolls the viewport, so that the region between it1 and it2 is seen, according to hpos and vpos. More...

Protected Member Functions inherited from dw::core::Iterator
	Iterator (Widget *widget, Content::Type mask, bool atEnd)

	Iterator (Iterator &it)

	~Iterator ()

Protected Attributes inherited from dw::core::Iterator
Content	content

Detailed Description

This implementation of dw::core::Iterator can be used by widgets with no contents.

Constructor & Destructor Documentation

dw::core::EmptyIterator::EmptyIterator ( EmptyIterator & it )

private

Referenced by clone().

dw::core::EmptyIterator::EmptyIterator	(	Widget *	widget,
		Content::Type	mask,
		bool	atEnd
	)

References dw::core::Iterator::content, dw::core::Content::END, dw::core::Content::START, and dw::core::Content::type.

Member Function Documentation

object::Object * dw::core::EmptyIterator::clone ( )

virtual

Return an exact copy of the object.

Reimplemented from lout::object::Object.

References EmptyIterator().

int dw::core::EmptyIterator::compareTo ( lout::object::Comparable * other )

virtual

Compare two objects, this and other.

Return a value < 0, when this is less than other, a value > 0, when this is greater than other, or 0, when this and other are equal.

If c1.equals(c2) (as defined in Object), c1.compareTo(c2) must be 0, but, unlike you may expect, the reversed is not necessarily true. This method returns 0, if, according to the rules for sorting, there is no difference, but there may still be differences (not relevant for sorting), which "equals" will care about.

Implements lout::object::Comparable.

References dw::core::Iterator::content, dw::core::Content::START, and dw::core::Content::type.

void dw::core::EmptyIterator::getAllocation	(	int	start,
		int	end,
		Allocation *	allocation
	)

virtual

Return the shape, which a part of the item, the iterator points on, allocates.

The parameters start and end have the same meaning as in DwIterator::highlight().

Implements dw::core::Iterator.

void dw::core::EmptyIterator::highlight	(	int	start,
		int	end,
		HighlightLayer	layer
	)

virtual

Extend highlighted region to contain part of the current content.

For text, start and end define the characters, otherwise, the shape is defined as [0, 1], i.e. for highlighting a whole dw::core::Content, pass 0 and >= 1. To unhighlight see also dw::core::Iterator::unhighlight.

Implements dw::core::Iterator.

bool dw::core::EmptyIterator::next ( )

virtual

Move iterator forward and store content it.

Returns true on success.

Implements dw::core::Iterator.

References dw::core::Iterator::content, dw::core::Content::END, and dw::core::Content::type.

bool dw::core::EmptyIterator::prev ( )

virtual

Move iterator backward and store content it.

Returns true on success.

Implements dw::core::Iterator.

References dw::core::Iterator::content, dw::core::Content::START, and dw::core::Content::type.

void dw::core::EmptyIterator::unhighlight	(	int	direction,
		HighlightLayer	layer
	)

virtual

Shrink highlighted region to no longer contain the current content.

The direction parameter indicates whether the highlighted region should be reduced from the start (direction > 0) or from the end (direction < 0). If direction is 0 all content is unhighlighted.

Implements dw::core::Iterator.

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

dw/iterator.hh
dw/iterator.cc

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation