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

#include <IGenericSettingsOutput.h>

Inheritance diagram for IGenericSettingsOutputStrategy:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IGENERICSETTINGSOUTPUTSTRATEGY }
 

Public Member Functions

virtual const PMString & GetResult ()=0
 
virtual void StartSettings (IGenericSettings *pSettings)=0
 
virtual void FinishSettings (IGenericSettings *pSettings)=0
 
virtual void StartGroup (IGenericSettingsGroup *pGroup)=0
 
virtual void FinishGroup (IGenericSettingsGroup *pGroup)=0
 
virtual void RecordAttribute (IGenericSettingsAttribute *pAttr)=0
 
- 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

Format all the preferences of a preset. You implement this interface and pass it to IGenericSetting::WriteTo method. See ISummaryUtils::GenerateHumanTextSummary.

The methods are called in the order the preferences and groups were added to the IGenericSettings interface.

Member Function Documentation

virtual void IGenericSettingsOutputStrategy::FinishGroup (IGenericSettingsGroup * pGroup)
pure virtual

This is called at the end of a group.

Parameters
pGroupis a pointer to the group settings being formatted.
virtual void IGenericSettingsOutputStrategy::FinishSettings (IGenericSettings * pSettings)
pure virtual

This is called at the end.

Parameters
pSettingsis a pointer to the preset settings being formatted.
virtual const PMString& IGenericSettingsOutputStrategy::GetResult ()
pure virtual

Get the formatted results as one big string.

Returns
the formatted string.
virtual void IGenericSettingsOutputStrategy::RecordAttribute (IGenericSettingsAttribute * pAttr)
pure virtual

This is called to format one preset.

Parameters
pAttris a pointer to the preference to format.
virtual void IGenericSettingsOutputStrategy::StartGroup (IGenericSettingsGroup * pGroup)
pure virtual

This is called at the beginning of a group.

Parameters
pGroupis a pointer to the group settings being formatted.
virtual void IGenericSettingsOutputStrategy::StartSettings (IGenericSettings * pSettings)
pure virtual

This is called at the beginning.

Parameters
pSettingsis a pointer to the preset settings being formatted.