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

#include <IPMRealListData.h>

Inheritance diagram for IPMRealListData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IPMREALLISTDATA }
 
enum  _Placement { kBeginning = 0, kEnd = -2 }
 

Public Member Functions

virtual void AddRealNumber (const PMReal &newPMReal, int32 at=kEnd)=0
 
virtual void RemoveRealNumber (int32 index)=0
 
virtual void Clear (void)=0
 
virtual PMReal GetRealNumber (int32 index) const =0
 
virtual void SetRealNumber (int32 index, const PMReal &replacePMReal)=0
 
virtual int32 GetIndex (const PMReal &PMReal) const =0
 
virtual int32 Length (void) const =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

Data interface to store a list of PMReal values.

Member Enumeration Documentation

Specifies where the new data should be inserted.
Enumerator
kEnd 

Insert at the beginning.

Member Function Documentation

virtual void IPMRealListData::AddRealNumber (const PMRealnewPMReal,
int32 at = kEnd 
)
pure virtual

Add the new PMReal the specified position.

Parameters
newPMRealis the new PMReal to add.
atis the position to add. Either kBeginning or kEnd or a valid location in the list. If an invalid index is provided, the value will be appended at the end of the list.
virtual void IPMRealListData::Clear (void )
pure virtual

Clear the list.

virtual int32 IPMRealListData::GetIndex (const PMRealPMReal) const
pure virtual

Return the position for given PMReal .

Parameters
PMRealis PMReal.
Returns
the position for the given PMReal or -1 if it is not found.
virtual PMReal IPMRealListData::GetRealNumber (int32 index) const
pure virtual

Return the PMReal the specified position. A valid index must be provided, else this will return 0.0.

Parameters
indexis the nth position.
Returns
the nth PMReal.
virtual int32 IPMRealListData::Length (void ) const
pure virtual
Returns
the number of PMReal in the list.
virtual void IPMRealListData::RemoveRealNumber (int32 index)
pure virtual

Remove the new PMReal at specified position.

Parameters
indexspecifies the position to remove. A valid index must be provided, else this will be a no-op.
virtual void IPMRealListData::SetRealNumber (int32 index,
const PMRealreplacePMReal 
)
pure virtual

Set the PMReal for the specified position.

Parameters
indexis the nth position. A valid index must be provided, else this will be a no-op.
replacePMRealis the new PMReal.