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

#include <IStringListData.h>

Inheritance diagram for IStringListData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ISTRINGLISTDATA }
 

Public Member Functions

virtual void SetStringList (const K2Vector< PMString > &newList)=0
 
virtual const K2Vector
< PMString > & 
GetStringList ()=0
 
virtual void Add (const PMString &inString)=0
 
virtual bool16 Contains (const PMString &inString)=0
 
virtual void Clear (void)=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 for storing a list of strings.

Member Function Documentation

virtual void IStringListData::Add (const PMStringinString)
pure virtual

Adds the input string to the list of strings.

Parameters
inString- the input string to add to the list of strings
virtual void IStringListData::Clear (void )
pure virtual

Clears the list of strings kept internally

virtual bool16 IStringListData::Contains (const PMStringinString)
pure virtual

Checks whether the given string exists in the list

Parameters
inString- the input string to check in the existing list of strings
Returns
kTrue - if the input string is present in the existing strings, kFalse otherwise
virtual const K2Vector<PMString>& IStringListData::GetStringList ()
pure virtual

Return the value of the list.

Returns
the list of strings
virtual void IStringListData::SetStringList (const K2Vector< PMString > & newList)
pure virtual

Set the value of the list of strings.

Parameters
newList- the list of strings that will be the new value