dw::core::EmptyIterator Class Reference

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.
int	compareTo (lout::object::Comparable *other)
	Compare two objects, this and other.
bool	next ()
	Move iterator forward and store content it.
bool	prev ()
	Move iterator backward and store content it.
void	highlight (int start, int end, HighlightLayer layer)
	Extend highlighted region to contain part of the current content.
void	unhighlight (int direction, HighlightLayer layer)
	Shrink highlighted region to no longer contain the current content.
void	getAllocation (int start, int end, Allocation *allocation)
	Return the shape, which a part of the item, the iterator points on, allocates.
Public Member Functions inherited from dw::core::Iterator
bool	equals (Object *other)
	Returns, whether two objects are equal.
void	intoStringBuffer (lout::misc::StringBuffer *sb)
	Store a textual representation of the object in a misc::StringBuffer.
Widget *	getWidget ()
Content *	getContent ()
Content::Type	getMask ()
virtual void	unref ()
	Delete the iterator.
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.
virtual int	hashValue ()
	Return a hash value for the object.
const char *	toString ()
	Use object::Object::intoStringBuffer to return a textual representation of the object.
virtual size_t	sizeOf ()
	Return the number of bytes, this object totally uses.

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.
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.

Definition at line 96 of file iterator.hh.

Constructor & Destructor Documentation

EmptyIterator() [1/2]

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

private

Definition at line 217 of file iterator.cc.

EmptyIterator() [2/2]

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

Definition at line 211 of file iterator.cc.

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

Member Function Documentation

clone()

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

virtual

Return an exact copy of the object.

Reimplemented from lout::object::Object.

Definition at line 221 of file iterator.cc.

compareTo()

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.

Definition at line 226 of file iterator.cc.

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

getAllocation()

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.

Definition at line 258 of file iterator.cc.

highlight()

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.

Definition at line 250 of file iterator.cc.

next()

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

virtual

Move iterator forward and store content it.

Returns true on success.

Implements dw::core::Iterator.

Definition at line 238 of file iterator.cc.

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

prev()

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

virtual

Move iterator backward and store content it.

Returns true on success.

Implements dw::core::Iterator.

Definition at line 244 of file iterator.cc.

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

unhighlight()

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.

Definition at line 254 of file iterator.cc.

---

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

• dw/iterator.hh
• dw/iterator.cc