IGenericSettingsExportCmdData Class Reference

#include <IGenericSettingsExportCmdData.h>

Inheritance diagram for IGenericSettingsExportCmdData:

Public Types
enum	{ kDefaultIID = IID_IGENERICSETTINGSEXPORTCMDDATA }

Public Member Functions
virtual IGenericSettings *	GetSettings ()=0
virtual IGenericSettingsOutputStrategy *	GetOutputStrategy ()=0
virtual const PMString &	GetDefaultFilename ()=0
virtual const PMString &	GetExportDialogTitle ()=0
virtual const PMString &	GetFileTypeString ()=0
virtual const PMString &	GetFileTypeExtension ()=0
virtual void	SetSettings (IGenericSettings *pSettings)=0
virtual void	SetStrategy (IGenericSettingsOutputStrategy *pStrategy)=0
virtual void	SetDefaultFilename (const PMString &strSrc)=0
virtual void	SetExportDialogTitle (const PMString &strSrc)=0
virtual void	SetFileTypeString (const PMString &str)=0
virtual void	SetFileTypeExtension (const PMString &str)=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

Parameter data for the GenericSettingsExportCmd which is used to write a file with the preset preferences in a human readable fashion. See ISummaryUtils::ExportHumanTextSummary.

Member Function Documentation

virtual const PMString& IGenericSettingsExportCmdData::GetDefaultFilename ( )

pure virtual

Get the default filename of the file to write.

Returns

the filename without path information.

virtual const PMString& IGenericSettingsExportCmdData::GetExportDialogTitle ( )

pure virtual

Get title of dialog used to get the file to write.

Returns

the title.

virtual const PMString& IGenericSettingsExportCmdData::GetFileTypeExtension ( )

pure virtual

Get file extension string.

Returns

the file extension string.

virtual const PMString& IGenericSettingsExportCmdData::GetFileTypeString ( )

pure virtual

Get file type string.

Returns

the file type string.

virtual IGenericSettingsOutputStrategy* IGenericSettingsExportCmdData::GetOutputStrategy ( )

pure virtual

Get the preset output strategy.

Returns

a pointer to the IGenericSettingsOutputStrategy interface. The pointer is valid as long as this object is valid.

virtual IGenericSettings* IGenericSettingsExportCmdData::GetSettings ( )

pure virtual

Get the preset preferences.

Returns

a pointer to the IGenericSettings interface. The pointer is valid as long as this object is valid.

virtual void IGenericSettingsExportCmdData::SetDefaultFilename ( const PMString &  strSrc )

pure virtual

Specify the default filename of the file to write.

Parameters

strSrc

is the filename without path information.

virtual void IGenericSettingsExportCmdData::SetExportDialogTitle ( const PMString &  strSrc )

pure virtual

Specify the title of the dialog used to get the file to write.

Parameters

strSrc

is the title.

virtual void IGenericSettingsExportCmdData::SetFileTypeExtension ( const PMString &  str )

pure virtual

Specify the file type extension.

Parameters

str	is the file type extension.

virtual void IGenericSettingsExportCmdData::SetFileTypeString ( const PMString &  str )

pure virtual

Specify the file type string.

Parameters

str	is the file type string.

virtual void IGenericSettingsExportCmdData::SetSettings ( IGenericSettings *  pSettings )

pure virtual

Specify which preset settings to write out.

Parameters

pSettings

is a pointer to the preset preferences to use.

virtual void IGenericSettingsExportCmdData::SetStrategy ( IGenericSettingsOutputStrategy *  pStrategy )

pure virtual

Specify the formatting to use when writing out the file.

Parameters

pStrategy

is a pointer to the output strategy interface.