InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
PersistUIDList Class Reference

#include <PersistUIDList.h>

Inheritance diagram for PersistUIDList:
UIDList

Public Member Functions

 PersistUIDList (IDataBase *db)
 
void ReadWrite (IPMStream *s, ImplementationID prop)
 
void ReadWriteObject (IPMStream *s, ImplementationID prop)
 
void ReadWriteReference (IPMStream *s, ImplementationID prop)
 
- Public Member Functions inherited from UIDList
 UIDList ()
 
 UIDList (IDataBase *db)
 
 UIDList (const UIDList &copy)
 
 UIDList (UIDList &&other) noexcept
 
 UIDList (IDataBase *db, const UID singleEntry)
 
 UIDList (const IPMUnknown *object)
 
 UIDList (const UIDRef &ref)
 
 ~UIDList ()
 
UIDListoperator= (const UIDList &other)
 
UIDListoperator= (UIDList &&other) noexcept
 
bool16 operator== (const UIDList &other) const
 
bool16 operator!= (const UIDList &other) const
 
const_iterator begin () const
 
iterator begin ()
 
const_reverse_iterator rbegin () const
 
reverse_iterator rbegin ()
 
const_iterator end () const
 
iterator end ()
 
const_reverse_iterator rend () const
 
reverse_iterator rend ()
 
UID operator[] (int32 i) const
 
UIDAt (int32 i)
 
UID At (int32 i) const
 
void SetChunkSize (int32 chunk)
 
bool16 Preallocate (int32 newlen)
 
void Clear ()
 
void Insert (const UID t)
 
void Insert (const UIDList &list, int32 before)
 
void Insert (const UID t, int32 before)
 
void Append (const UID t)
 
void Append (const UID t, int32 after)
 
void Append (const UIDList &list)
 
void Remove (int32 at)
 
iterator erase (iterator i)
 
iterator erase (iterator first, iterator last)
 
void push_back (const_reference value)
 
size_type size () const
 
void Replace (int32 at, const UID t)
 
int32 Location (UID t) const
 
bool16 Contains (UID t) const
 
bool16 DoesNotContain (UID t) const
 
void AddRef ()
 
void Release ()
 
int32 ChunkSize () const
 
int32 Length () const
 
bool16 IsEmpty () const
 
UID First () const
 
UIDFirst ()
 
UID Last () const
 
UIDLast ()
 
IDataBaseGetDataBase () const
 
UIDRef GetRef (int32 at) const
 
void ReadWriteXferObject (IPMStream *stream)
 
void ReadWriteXferReference (IPMStream *stream)
 

Additional Inherited Members

- Public Types inherited from UIDList
typedef object_type data_type
 
typedef UIDListInternal::value_type value_type
 
typedef UIDListInternal::size_type size_type
 
typedef
UIDListInternal::const_reference 
const_reference
 
typedef UIDListInternal::reference reference
 
typedef
UIDListInternal::difference_type 
difference_type
 
typedef UIDListInternal::pointer pointer
 
typedef
UIDListInternal::const_pointer 
const_pointer
 
typedef index_based_iterator
< UIDList, UIDList::value_type > 
iterator
 
typedef index_based_iterator
< UIDList, UIDList::value_type
const > 
const_iterator
 
typedef std::reverse_iterator
< iterator
reverse_iterator
 
typedef std::reverse_iterator
< const_iterator
const_reverse_iterator
 

Detailed Description

Persistent list of UIDs. Same as UIDList, but provides ReadWrite capabilities for streaming.

See Also
UIDList
IPMStream

Constructor & Destructor Documentation

PersistUIDList::PersistUIDList (IDataBasedb)

Construct a new UIDList, for UIDs in the database.

Parameters
dbThe database that holds the UIDs that will be put in the list.

Member Function Documentation

void PersistUIDList::ReadWrite (IPMStreams,
ImplementationID prop 
)

For internal use only

void PersistUIDList::ReadWriteObject (IPMStreams,
ImplementationID prop 
)

Persists the list using XferObject method of the stream for each UID in the list.

Parameters
sthe source or destination stream
propthis parameter is ignored
void PersistUIDList::ReadWriteReference (IPMStreams,
ImplementationID prop 
)

Persists the list using XferReference method of the stream for each UID in the list.

Parameters
sthe source or destination stream
propthis parameter is ignored