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

#include <ILibraryPrefs.h>

Inheritance diagram for ILibraryPrefs:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ILIBRARYPREFS }
 

Public Member Functions

virtual void SetLibraryPref (const PMString &key, const PMString &value)=0
 
virtual bool16 GetLibraryPref (const PMString &key, PMString &value, const PMString &defaultValue) 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

This interface is a secondary interface to the Library Boss. This interface is used to set Library preference data in the library file. The Library does not have any predefined preferences, so the Library client is free to store whatever key/value pairs that are wanted.

Member Function Documentation

virtual bool16 ILibraryPrefs::GetLibraryPref (const PMStringkey,
PMStringvalue,
const PMStringdefaultValue 
) const
pure virtual

Gets a preference value, or sets if not found.

Parameters
keyIN preference to look up
valueOUT value associated with key, if found
defaultValueIN if key not found, sets it with this value
Returns
kTrue (always)
virtual void ILibraryPrefs::SetLibraryPref (const PMStringkey,
const PMStringvalue 
)
pure virtual

Set the preference.

Parameters
keyIN key for the preference
valueIN value for the preference