NameItemIter Class Reference

Abstract base classes for iterations and searches over all groups and all items in the Name gallery. More...

#include <ngiter.h>

Inheritance diagram for NameItemIter:

List of all members.

Public Types
enum	Mask { ALL_ITEMS, ALL_NAMES, HIGHLIGHTED_ITEMS, HIGHLIGHTED_NAMES }
Public Member Functions
virtual	~NameItemIter ()
	NameItemIter (Mask mask=ALL_ITEMS)
	Constructs a NameItemIter.
virtual SGNameItem *	ForEach ()
	Calls NameItemIter::Do for every item in the name gallery.
Protected Member Functions
SGNameItem *	ForEachItem (SGNameGroup *pGroup)
	Calls NameItemIter::Do for every item in the given group.
Private Member Functions
virtual BOOL	Do (SGNameItem *pItem)=0
Private Attributes
Mask	m_eMask

---

Detailed Description

Abstract base classes for iterations and searches over all groups and all items in the Name gallery.

Author:

Justin_Flude (Xara Group Ltd) <camelotdev@xara.com>

Date:

27/7/99

Definition at line 350 of file ngiter.h.

---

Member Enumeration Documentation

enum NameItemIter::Mask

Enumerator: ALL_ITEMS  ALL_NAMES  HIGHLIGHTED_ITEMS  HIGHLIGHTED_NAMES  Definition at line 356 of file ngiter.h. { ALL_ITEMS, ALL_NAMES, HIGHLIGHTED_ITEMS, HIGHLIGHTED_NAMES };

---

Constructor & Destructor Documentation

virtual NameItemIter::~NameItemIter (   )  [inline, virtual]

Definition at line 353 of file ngiter.h. { }

NameItemIter::NameItemIter (  NameItemIter::Mask  mask = ALL_ITEMS  )

Constructs a NameItemIter. Author: Justin_Flude (Xara Group Ltd) <camelotdev@xara.com> Date: 27/7/99 Parameters: mask  --- what to iterate over (ALL_ITEMS, ALL_NAMES, [INPUTS] HIGHLIGHTED_ITEMS, HIGHLIGHTED_NAMES) See also: NameGroupIter; NameIterOp Definition at line 581 of file ngiter.cpp. : m_eMask(mask) { // Empty. }

---

Member Function Documentation

virtual BOOL NameItemIter::Do (  SGNameItem *  pItem  )  [private, pure virtual]

Implemented in SelectUnionScan::Test, AllowOpScan::IsLitUsedName, ApplyScan::ApplyItems, HideScan::HideItems, HidePropScan::HideProp, CreateDisplayScan::ClearCounters, CreateDisplayScan::DelItemIfUnref, and OpExportSets::ExportHighlightedIter.

SGNameItem * NameItemIter::ForEach (   )  [virtual]

Calls NameItemIter::Do for every item in the name gallery. Author: Justin_Flude (Xara Group Ltd) <camelotdev@xara.com> Date: 27/7/99 Returns: Null if all Do() calls succeed, a pointer to the failing item if a Do() call fails. See also: NodeScan Definition at line 599 of file ngiter.cpp. { PORTNOTETRACE("other","NameItemIter::ForEach - do nothing"); #ifndef EXCLUDE_FROM_XARALX // Just the items in 'Used Names'? if (INT32(m_eMask) & 1) return ForEachItem(NameGallery::Instance()->GetUsedNames()); // Items in all the groups. SGNameGroup* pGroup = NameGallery::Instance()->GetFirstGroup(); while (pGroup != 0) { SGNameGroup* pNextGroup = (SGNameGroup*) pGroup->GetNext(); SGNameItem* pStopItem = ForEachItem(pGroup); if (pStopItem != 0) return pStopItem; pGroup = pNextGroup; } #endif // No item stopped the iteration. return NULL; }

SGNameItem * NameItemIter::ForEachItem (  SGNameGroup *  pGroup  )  [protected]

Calls NameItemIter::Do for every item in the given group. Author: Justin_Flude (Xara Group Ltd) <camelotdev@xara.com> Date: 27/7/99 Returns: Null if all Do() calls succeed, a pointer to the failing item if a Do() call fails. See also: NameIterItem::ForEach Definition at line 634 of file ngiter.cpp. { if (pGroup == 0) return 0; SGNameItem* pItem = (SGNameItem*) pGroup->GetChild(); while (pItem != 0) { // NB. careful to fetch next item in iteration before calling Do() in case // Do() deletes the item and we lose its next link. SGNameItem* pNextItem = (SGNameItem*) pItem->GetNext(); if (((INT32(m_eMask) & 2) == 0 || pItem->IsSelected()) && !Do(pItem)) return pItem; pItem = pNextItem; } return 0; }

---

Member Data Documentation

Mask NameItemIter::m_eMask [private]

Definition at line 369 of file ngiter.h.

---

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

• Kernel/ngiter.h (r1785/r751)
• Kernel/ngiter.cpp (r1785/r1282)

---