InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
LnkWtchCache Class Reference
Inheritance diagram for LnkWtchCache:
CPMUnknown< ILnkWtchCache >ILnkWtchCacheIPMUnknown

Public Member Functions

 LnkWtchCache (IPMUnknown *boss)
 
virtual ~LnkWtchCache ()
 
const EntriesGet () const
 
const PMString GetName (const Entry &entry, bool16 fullName) const
 
void push_back (const Entry &entry)
 
int32 Location (const Entry &entry)
 
void MarkRemoved (const int32 pos, bool16 removed)
 
void Delete (const int32 pos)
 
void clear ()
 
void Dump () const
 
void NotifyCacheChanged ()
 
void SnapshotReadWrite (IPMStream *s, ImplementationID implID)
 
- Public Member Functions inherited from CPMUnknown< ILnkWtchCache >
IPMUnknownQueryInterface (PMIID interfaceID) const
 
void AddRef () const
 
void Release () const
 
void PreDirty (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
 
void PreDirtyNoMessage (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
 
 CPMUnknown (const CPMUnknown &)=delete
 
CPMUnknownoperator= (const CPMUnknown &)=delete
 

Additional Inherited Members

- Public Types inherited from ILnkWtchCache
enum  { kDefaultIID = IID_ILNKWTCHCACHE }
 
typedef struct ILnkWtchCache::Entry Entry
 
typedef K2Vector< EntryEntries
 
- Protected Member Functions inherited from CPMUnknown< ILnkWtchCache >
 CPMUnknown (IPMUnknown *boss)
 
- Protected Attributes inherited from CPMUnknown< ILnkWtchCache >
HelperInterface fHelperInterface
 

Detailed Description

Implements ILnkWtchCache; see ILnkWtchCache for documentation on the methods.

Constructor & Destructor Documentation

LnkWtchCache::LnkWtchCache (IPMUnknownboss)
inline

Constructor.

virtual LnkWtchCache::~LnkWtchCache ()
inlinevirtual

Destructor.

Member Function Documentation

void LnkWtchCache::clear ()
virtual

Clear all entries in the cache.

Implements ILnkWtchCache.

void LnkWtchCache::Delete (const int32 pos)
virtual

Delete the cache entry at the given index.

Parameters
posindex of entry to be cleared.

Implements ILnkWtchCache.

void LnkWtchCache::Dump () const
virtual

Dump and dump entry are debug only. Dump to traceflow

Implements ILnkWtchCache.

const Entries& LnkWtchCache::Get () const
inlinevirtual

Returns all entries in the cache.

Returns
all entries in the cache.

Implements ILnkWtchCache.

const PMString LnkWtchCache::GetName (const Entryentry,
bool16 fullName 
) const
virtual

Returns the name of the link associated with the given cache entry.

Parameters
entrythe cache entry hose name is required
fullNamekTrue to include the path, kFalse for the file name only.
Returns
the name of the link associated with the given cache entry

Implements ILnkWtchCache.

int32 LnkWtchCache::Location (const Entryentry)
virtual

Return index in cache of the given entry if found, -1 otherwise.

Parameters
entry
Returns
index in cache of the given entry if found, -1 otherwise.

Implements ILnkWtchCache.

void LnkWtchCache::MarkRemoved (const int32 pos,
bool16 removed 
)
virtual

Set the removed flag for the cache entry at the index given.

Parameters
posindex in the cache whose removed flag is to be changed.
removedkTrue to set flag , kFalse to clear

Implements ILnkWtchCache.

void LnkWtchCache::NotifyCacheChanged ()
virtual

Broadcast notification that the cache has changed.

Implements ILnkWtchCache.

void LnkWtchCache::push_back (const Entryentry)
virtual

Push an entry to into the cache.

Parameters
entry

Implements ILnkWtchCache.

void LnkWtchCache::SnapshotReadWrite (IPMStreams,
ImplementationID implID 
)

Allows the internal state of the implementation to be marshalled in and out of the snapshot.

Parameters
sIN the stream the snapshot is being written to
implIDIN implementation ID