dbHierBrowseHelper Class Reference
[OOFILE GUI forms interface., Mac Specific]

#include <oofpphier.h>

Inheritance diagram for dbHierBrowseHelper:

[legend]Collaboration diagram for dbHierBrowseHelper:

[legend]List of all members.

---

Detailed Description

Manage a tree control linked to one or more dbView's.

Lots of abstraction of how data is mapped to each item in tree and how independent it may be at each level.

Public Member Functions
	dbHierBrowseHelper (LOutlineTable *inTable=0)
virtual	~dbHierBrowseHelper ()
virtual bool	receiveMsg (OOFmsgT msg, unsigned long senderDefined)
	The default receiveMsg behaviour is to delete yourself when the broadcaster closes.
virtual dbView *	view () const
virtual unsigned long	highlightedRecNo () const
virtual dbSelection	highlightedSelection () const
virtual void	highlightNothing () const
virtual void	highlightRecNo (unsigned long, bool bSelect=TRUE) const
virtual void	updateBrowserSelection () const
virtual void	refreshBrowser ()
void	browseViewWithTable (LOutlineTable *inTable)
void	resetTableAfterViewRestructure ()
void	deleteAllLevels ()
void	appendLevel (dbHierLevel *adoptedLevel)
dbHierBrowseHelper &	operator<< (dbHierLevel *)
dbHierLevel *	level (unsigned short) const
dbHierLevel *	lowestLevel () const
OOF_mixOutlineItem *	highlightedItem () const
bool	selectItemRecord ()
bool	itemIsAtBottom (const OOF_mixOutlineItem *theItem) const
unsigned short	deepestIndent () const
unsigned long	countNestedItemsFromLevel (oidT, unsigned short) const
dbView *	viewAtLevel (unsigned short) const
virtual void	insertItemsBelow (LOutlineItem *, OOF_mixOutlineItem *)
oidT	highlightedOID () const
unsigned long	nextCacheIndex ()
void	initCacheRow (unsigned long cacheIndex, fieldNumT numFields)
void	setCachedContents (unsigned long cacheIndex, fieldNumT fieldNum, char *adoptedStr)
const char *	getCachedContents (unsigned long cacheIndex, fieldNumT fieldNum)
void	deleteContentsCache ()
virtual void	deleteSelection (const dbSelection &inSel)
virtual dbTable *	table () const
virtual void	maybeChangeTargetLink (dbFieldLink *)
virtual void	maybeDirty (dbFieldLink *)
virtual void	subscribeTo (oofBroadcaster *)
virtual void	unsubscribe (oofBroadcaster *from=0)
void	suspendListening ()
void	resumeListening ()
Protected Member Functions
void	IncludeAllBelowItem (unsigned short inIndentLevel, oidT, dbSelection &) const
oidT	FirstOIDBelowItem (unsigned short inIndentLevel, oidT inOID) const
Protected Attributes
OOF_ExpandableLongArray	mHierLevels
LOutlineTable *	mOutlineTable
unsigned long	mNextCacheIndex
OOF_ExpandableLongArray	mContentsCache
oofBroadcaster *	mListensTo
oofBroadcaster *	mSuspendedListensTo
unsigned short	mSuspendCount

---

Constructor & Destructor Documentation

dbHierBrowseHelper::dbHierBrowseHelper (  LOutlineTable *  inTable = 0  )

dbHierBrowseHelper::~dbHierBrowseHelper (   )  [virtual]

---

Member Function Documentation

void dbHierBrowseHelper::appendLevel (  dbHierLevel *  adoptedLevel  )

void dbHierBrowseHelper::browseViewWithTable (  LOutlineTable *  inTable  )

unsigned long dbHierBrowseHelper::countNestedItemsFromLevel (  oidT  , unsigned  short )  const

unsigned short dbHierBrowseHelper::deepestIndent (   )  const [inline]

void dbHierBrowseHelper::deleteAllLevels (   )

void dbHierBrowseHelper::deleteContentsCache (   )

void dbAbstractBrowseHelper::deleteSelection (  const dbSelection &  inSel  )  [virtual, inherited]

oidT dbHierBrowseHelper::FirstOIDBelowItem (  unsigned short  inIndentLevel, oidT  inOID )  const [protected]

const char * dbHierBrowseHelper::getCachedContents (  unsigned long  cacheIndex, fieldNumT  fieldNum )

OOF_mixOutlineItem * dbHierBrowseHelper::highlightedItem (   )  const

oidT dbHierBrowseHelper::highlightedOID (   )  const

unsigned long dbHierBrowseHelper::highlightedRecNo (   )  const [virtual]

Implements dbAbstractBrowseHelper.

dbSelection dbHierBrowseHelper::highlightedSelection (   )  const [virtual]

Implements dbAbstractBrowseHelper.

void dbHierBrowseHelper::highlightNothing (   )  const [virtual]

Implements dbAbstractBrowseHelper.

void dbHierBrowseHelper::highlightRecNo (  unsigned  long, bool  bSelect = TRUE )  const [virtual]

Implements dbAbstractBrowseHelper.

void dbHierBrowseHelper::IncludeAllBelowItem (  unsigned short  inIndentLevel, oidT  , dbSelection &  )  const [protected]

void dbHierBrowseHelper::initCacheRow (  unsigned long  cacheIndex, fieldNumT  numFields )

void dbHierBrowseHelper::insertItemsBelow (  LOutlineItem *  , OOF_mixOutlineItem *  )  [virtual]

bool dbHierBrowseHelper::itemIsAtBottom (  const OOF_mixOutlineItem *  theItem  )  const [inline]

dbHierLevel * dbHierBrowseHelper::level (  unsigned  short  )  const [inline]

dbHierLevel * dbHierBrowseHelper::lowestLevel (   )  const [inline]

void dbHelper::maybeChangeTargetLink (  dbFieldLink *   )  [virtual, inherited]

Reimplemented in dbAbstractEditHelper.

void dbHelper::maybeDirty (  dbFieldLink *   )  [virtual, inherited]

Reimplemented in dbAbstractEditHelper, and OOF_mixRepAbstractCellEditor.

unsigned long dbHierBrowseHelper::nextCacheIndex (   )

dbHierBrowseHelper & dbHierBrowseHelper::operator<< (  dbHierLevel *   )  [inline]

bool dbHierBrowseHelper::receiveMsg (  OOFmsgT  msg, unsigned long  senderDefined )  [virtual]

The default receiveMsg behaviour is to delete yourself when the broadcaster closes. In many user subclasses oofSingleListener is a mixin and you have a class owned elsewhere, not self-deleting. Warning: If a subclass is not self-deleting it MUST override receiveMsg handling of the msg OOFmsg_BroadcasterClosing to prevent runtime error. However it is still important to set mListensTo=0 otherwise when you finally get around to deleting your oofSingleListener, it will try to update a deleted oofBroadcaster and cause a crash. Reimplemented from dbAbstractBrowseHelper.

void dbHierBrowseHelper::refreshBrowser (   )  [virtual]

Implements dbAbstractBrowseHelper.

void dbHierBrowseHelper::resetTableAfterViewRestructure (   )

void oofSingleListener::resumeListening (   )  [inherited]

bool dbHierBrowseHelper::selectItemRecord (   )

void dbHierBrowseHelper::setCachedContents (  unsigned long  cacheIndex, fieldNumT  fieldNum, char *  adoptedStr )

void oofSingleListener::subscribeTo (  oofBroadcaster *   )  [virtual, inherited]

Reimplemented from oofReceiver.

void oofSingleListener::suspendListening (   )  [inherited]

dbTable * dbAbstractBrowseHelper::table (   )  const [virtual, inherited]

Reimplemented from dbHelper.

void oofSingleListener::unsubscribe (  oofBroadcaster *  from = 0  )  [virtual, inherited]

Reimplemented from oofReceiver.

void dbHierBrowseHelper::updateBrowserSelection (   )  const [virtual]

Implements dbAbstractBrowseHelper.

dbView * dbHierBrowseHelper::view (   )  const [virtual]

Implements dbAbstractBrowseHelper.

dbView * dbHierBrowseHelper::viewAtLevel (  unsigned  short  )  const

---

Member Data Documentation

OOF_ExpandableLongArray dbHierBrowseHelper::mContentsCache [protected]

OOF_ExpandableLongArray dbHierBrowseHelper::mHierLevels [protected]

oofBroadcaster* oofSingleListener::mListensTo [protected, inherited]

unsigned long dbHierBrowseHelper::mNextCacheIndex [protected]

LOutlineTable* dbHierBrowseHelper::mOutlineTable [protected]

unsigned short oofSingleListener::mSuspendCount [protected, inherited]

oofBroadcaster* oofSingleListener::mSuspendedListensTo [protected, inherited]

---

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

• oofpphier.h
• oofpphier.cpp

---