InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | List of all members
IUIDListControlData Class Referenceabstract

#include <IUIDListControlData.h>

Inheritance diagram for IUIDListControlData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IUIDLISTCONTROLDATA }
 
list position constants
enum  { kBeginning___ = 0, kEnd___ = -2, kInvalidUIDIndex___ = -1 }
 

draw action constants

enum  { kNoDrawOrInval___ = 0, kForceDraw___ = 1, kDoInval___ = 2, kDefaultDrawAction___ = kForceDraw___ }
 
virtual void SetDataBase___ (IDataBase *db)=0
 
virtual IDataBase * GetDataBase___ () const =0
 
virtual void AddUID___ (const UID &newUID, int32 drawAction, bool16 notifyOfChange=kTrue)=0
 
virtual void RemoveUID___ (UID uid, int32 drawAction, bool16 notifyOfChange=kTrue)=0
 
virtual void Clear___ (int32 drawAction, bool16 notifyOfChange=kTrue)=0
 
virtual UID GetUID___ (int32 index) const =0
 
virtual int32 GetIndex___ (const UID &uid) const =0
 
virtual int32 Length___ () const =0
 
virtual void Sort___ (bool16 bReverse=kFalse)=0
 
virtual void Replace___ (int32 at, const UID &uid)=0
 

Additional Inherited Members

- Public Member Functions inherited from IPMUnknown
virtual IPMUnknown * QueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Control Data Interface for a list of UIDs, currently part of the kPagesPanelWidgetBoss.

Member Enumeration Documentation

anonymous enum
Enumerator
kBeginning___ 

at the beginning of the list

kEnd___ 

at the end of the list

kInvalidUIDIndex___ 

not found in the list

anonymous enum
Enumerator
kNoDrawOrInval___ 

do nothing

kForceDraw___ 

force widget to redraw immediately

kDoInval___ 

inval the widget

Member Function Documentation

virtual void IUIDListControlData::AddUID___ (const UID & newUID,
int32 drawAction,
bool16 notifyOfChange = kTrue 
)
pure virtual

Add a UID to the list.

Parameters
newUIDIN the UID to add
drawActionIN draw action to apply to the associated widget
virtual void IUIDListControlData::Clear___ (int32 drawAction,
bool16 notifyOfChange = kTrue 
)
pure virtual

Clear the list (remove all the UIDs).

Parameters
drawActionIN draw action to apply to the associated widget
virtual IDataBase* IUIDListControlData::GetDataBase___ () const
pure virtual

Get the database that the UID's are from.

virtual int32 IUIDListControlData::GetIndex___ (const UID & uid) const
pure virtual

Get the index for the given UID.

virtual UID IUIDListControlData::GetUID___ (int32 index) const
pure virtual

Get the UID value at a given index in the list.

virtual int32 IUIDListControlData::Length___ () const
pure virtual

How many UIDs are in the list?

virtual void IUIDListControlData::RemoveUID___ (UID uid,
int32 drawAction,
bool16 notifyOfChange = kTrue 
)
pure virtual

Remove a UID from the list.

Parameters
uidIN the UID to remove
drawActionIN draw action to apply to the associated widget
virtual void IUIDListControlData::Replace___ (int32 at,
const UID & uid 
)
pure virtual

Replace the value at the location with another UID.

virtual void IUIDListControlData::SetDataBase___ (IDataBase * db)
pure virtual

Set the database that the UID's are from.

virtual void IUIDListControlData::Sort___ (bool16 bReverse = kFalse)
pure virtual

Sort UIDs into order they appear in PageList or MasterSpreadList. If bReverse is set, sort in opposite order.