IDOMGlyphIDEnumerator Class Reference

DOM GlyphID Enumerator. More...

#include <idomglyph.h>

Inheritance diagram for IDOMGlyphIDEnumerator:

Public Member Functions
virtual void	add (IDOMGlyph::GlyphID glyphID)=0
	Adds a glyph to the end of the list.
virtual IDOMGlyph::GlyphID	getGlyphID ()=0
	Returns the ID of the glyph at the current point in the list.
virtual bool	beginEnumeration ()=0
	Moves the current list point to the start of the list.
virtual bool	endEnumeration ()=0
	Indicates whether or not the end of the list has been reached.
virtual bool	nextEnumerationItem ()=0
	Moves the current list position on to the next item in the list, unless the end of the list has been reached.
Public Member Functions inherited from IEDLObject
virtual const CClassID &	getClassID () const =0
	Returns class ID of IEDLObject.
virtual bool	init (CClassParams *pData)
	The init() method is called to perform any post-construction initialization of an IEDLObject that has been created by the EDL class factory, before it is actually returned by the factory.
virtual bool	clone (IEDLObjectPtr &ptrObject, IEDLClassFactory *pFactory)
	Create a copy of EDLObject.
Public Member Functions inherited from IRCObject
virtual void	addRef () const =0
	Increases the reference count of the actual object pointed to. This would take place during an assignment or copying.
virtual bool	decRef () const =0
	Decreases the reference count of the actual object pointed to. When the reference count falls to Zero, it deletes the actual object pointed to.
virtual int32	getRefCount () const =0
	Retrieve the current reference count of the actual object pointed to.

Static Public Member Functions
static const CClassID &	classID ()
	Retrieves the class id of IDOMGlyphIDEnumerator.

Additional Inherited Members
Protected Member Functions inherited from IRCObject
virtual	~IRCObject ()
	Virtual destructor.

Detailed Description

DOM GlyphID Enumerator.

The IDOMGlyphIDEnumerator provides a generalized interface to a list of glyphs by ID. The list is designed to be read from beginning to end in sequence. Glyphs can only be added to the end of the list.

Member Function Documentation

add()

virtual void IDOMGlyphIDEnumerator::add ( IDOMGlyph::GlyphID glyphID )

pure virtual

Adds a glyph to the end of the list.

Parameters

glyphID

The glyph ID to add to the end of the list.

beginEnumeration()

virtual bool IDOMGlyphIDEnumerator::beginEnumeration ( )

pure virtual

Moves the current list point to the start of the list.

Returns

bool True on success, false otherwise.

classID()

static const CClassID & IDOMGlyphIDEnumerator::classID ( )

inlinestatic

Retrieves the class id of IDOMGlyphIDEnumerator.

Returns

CClassID Class id of IDOMGlyphIDEnumerator.

endEnumeration()

virtual bool IDOMGlyphIDEnumerator::endEnumeration ( )

pure virtual

Indicates whether or not the end of the list has been reached.

Returns

bool True if the end of the list has been reached, false otherwise.

getGlyphID()

virtual IDOMGlyph::GlyphID IDOMGlyphIDEnumerator::getGlyphID ( )

pure virtual

Returns the ID of the glyph at the current point in the list.

Returns

IDOMGlyph::GlyphID The ID of the glyph at the current position in the list.

nextEnumerationItem()

virtual bool IDOMGlyphIDEnumerator::nextEnumerationItem ( )

pure virtual

Moves the current list position on to the next item in the list, unless the end of the list has been reached.

Returns

bool True if the current list position was successfully advanced. In the case where the end of the list had already been reached prior to the call, the current list position remains on the last item and the function returns false.

---

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

• idomglyph.h