InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ICellFocusCache Class Referenceabstract

#include <ICellFocusCache.h>

Inheritance diagram for ICellFocusCache:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ICELLFOCUSCACHE }
 

Public Member Functions

virtual int32 CountAttributes (ClassID which) const =0
 
virtual const IPMUnknownQueryAttributeN (int32 n, ClassID which, const PMIID iid) const =0
 
virtual void RowsInserted (const RowRange &rows)=0
 
virtual void ColsInserted (const ColRange &cols)=0
 
virtual void RowsDeleted (const RowRange &rows)=0
 
virtual void ColsDeleted (const ColRange &cols)=0
 
virtual void CellsMerged (const GridArea &cells)=0
 
virtual void CellsUnmerged (const GridArea &cells)=0
 
virtual void TableDeleted ()=0
 
virtual void AttributesChanged (void)=0
 
virtual void ClearCache (void)=0
 
virtual bool16 CacheIsBuilt (void) const =0
 
virtual uint32 GetTimeStamp (void) const =0
 
virtual void CopyToAttributeLists (AttributeBossList *attrList, AttributeBossList *mixedList=nil)=0
 
virtual void TableDirChange (Tables::EDirection directionRTL)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Cache of attribute stores based on an associated CellFocus

See Also
ICellFocus
ICellFocusManager

Member Function Documentation

virtual void ICellFocusCache::AttributesChanged (void )
pure virtual

Notification when the attriubtes in the cell focus change, updates the cache appropriately

virtual bool16 ICellFocusCache::CacheIsBuilt (void ) const
pure virtual

Let's you check if the cache needs building.

Returns
bool16 true if the cache needs rebuilding
virtual void ICellFocusCache::CellsMerged (const GridAreacells)
pure virtual

Notification when cells are merged in the table, updates the cache appropriately

Parameters
cellsThe GridArea of the cells merged
virtual void ICellFocusCache::CellsUnmerged (const GridAreacells)
pure virtual

Notification when cells are unmerged in the table, updates the cache appropriately

Parameters
cellsThe GridArea of the cells unmerged
virtual void ICellFocusCache::ClearCache (void )
pure virtual

Clears the existing cache

virtual void ICellFocusCache::ColsDeleted (const ColRangecols)
pure virtual

Notification when columns are deleted into the table, updates the cache appropriately

Parameters
colsThe range of columns deleted
virtual void ICellFocusCache::ColsInserted (const ColRangecols)
pure virtual

Notification when columns are inserted into the table, updates the cache appropriately

Parameters
colsThe range of columns inserted
virtual void ICellFocusCache::CopyToAttributeLists (AttributeBossListattrList,
AttributeBossListmixedList = nil 
)
pure virtual

Copies the attributes into list. If an attribute is mixed it is put into mixedList.

Parameters
attrListThe attriubte list to copy into the current one
mixedListReturns a list of attriubtes that are mixed (contain more then one attribute with different values) between the existing list and the one we just added
virtual int32 ICellFocusCache::CountAttributes (ClassID which) const
pure virtual

Returns the number of unique values the selection contains given a attribute's classID

Parameters
whichThe classID of the attribute we are asking about
Returns
int32 The count of unique values
virtual uint32 ICellFocusCache::GetTimeStamp (void ) const
pure virtual

What is the time stamp, may build the cache if not already built.

Returns
uint32 time stamp of last cache build
virtual const IPMUnknown* ICellFocusCache::QueryAttributeN (int32 n,
ClassID which,
const PMIID iid 
) const
pure virtual

Returns the nth attribute of the given classID

Parameters
nThe nth entry in that attribute's list
whichThe classID of the attribute we are querying for
iidThe interface id we are querying for
Returns
IPMUnknown The specific attribute
virtual void ICellFocusCache::RowsDeleted (const RowRangerows)
pure virtual

Notification when rows are deleted into the table, updates the cache appropriately

Parameters
rowsThe range of rows deleted
virtual void ICellFocusCache::RowsInserted (const RowRangerows)
pure virtual

Notification when rows are inserted into the table, updates the cache appropriately

Parameters
rowsThe range of rows inserted
virtual void ICellFocusCache::TableDeleted ()
pure virtual

Notification when the whole table is deleted, updates the cache appropriately

virtual void ICellFocusCache::TableDirChange (Tables::EDirection directionRTL)
pure virtual

Notification when table direction changes, updates the cache appropriately

Parameters
directionRTLnew direction