Detailed Description

ATS Explore Provider Object.

ATSExploreProviderParams describes the parameters for the IATSProvider::ExploreProvider method

See also:: IATSProvider

#include <IATSProvider.h>

Inheritance diagram for ATSExploreProviderParams:

Public Member Functions
ATSExport	ATSExploreProviderParams ()
	Constructor.
virtual ATSExport	~ATSExploreProviderParams ()
	Destructor.
virtual ATSExport const MCHAR *	GetTitle ()
	Get title.
virtual ATSExport void	SetTitle (const MCHAR *szTitle)
	Set title.
virtual ATSExport bool	GetMultipleSelections ()
	Get multiple selections state.
virtual ATSExport void	SetMultipleSelections (bool bMultipleSelections)
	Set multiple selections state.
virtual ATSExport bool	GetDownloadFiles ()
	Get download files state.
virtual ATSExport void	SetDownloadFiles (bool bDownload)
	Set download files state.
virtual ATSExport UINT	AddFilter (const MCHAR szName, const MCHAR szExtensions)
	Add filter for explorer dialog.
virtual ATSExport UINT	NumFilters ()
	Number of filters.
virtual ATSExport const MCHAR *	GetFilterName (UINT iIndex)
	Get filter name.
virtual ATSExport const MCHAR *	GetFilterExtensions (UINT iIndex)
	Get filter extensions.
Protected Attributes
ATSString	mTitle
DWORD	mState
std::vector< ATSString >	mFilters
std::vector< ATSString >	mExtensions

Constructor & Destructor Documentation

ATSExport ATSExploreProviderParams ( )

Constructor.

virtual ATSExport ~ATSExploreProviderParams ( ) [virtual]

Destructor.

Member Function Documentation

virtual ATSExport const MCHAR* GetTitle ( ) [virtual]

Search for all occurrences

Get title.

Defines the title for the explore provider dialog

Returns:: string containing the title

virtual ATSExport void SetTitle ( const MCHAR * szTitle ) [virtual]

Search for all occurrences

Set title.

Defines the title for the explore provider dialog

Parameters:

[in] szTitle string containing the filename

virtual ATSExport bool GetMultipleSelections ( ) [virtual]

Search for all occurrences

Get multiple selections state.

Defines if multiple selections should be allowed within the explorer dialog

Returns:: true if multiple selections are allowed, false if not

virtual ATSExport void SetMultipleSelections ( bool bMultipleSelections ) [virtual]

Search for all occurrences

Set multiple selections state.

Defines if multiple selections should be allowed within the explorer dialog

Parameters:

[in] bMultipleSelections true if multiple selections are allowed, false if not

virtual ATSExport bool GetDownloadFiles ( ) [virtual]

Search for all occurrences

Get download files state.

Defines if the provider should automatically download the files selected

Returns:: true if download should occur, false if not

virtual ATSExport void SetDownloadFiles ( bool bDownload ) [virtual]

Search for all occurrences

Set download files state.

Defines if the provider should automatically download the files selected

Parameters:

[in] bDownload true if download should occur, false if not

virtual ATSExport UINT AddFilter	(	const MCHAR *	szName,
		const MCHAR *	szExtensions
	)		`[virtual]`

Search for all occurrences

Add filter for explorer dialog.

A filter defines the "Type of File" that should be available for selection and/or display. Some examples: For all files: AddFilter( "All files (*.*)", "*.*" ); For jpeg files: AddFilter( "JPEG (*.jpg,*.jpeg)", "*.jpg;*.jpeg" );

Parameters:

[in]	szName	name of filter as it should be displayed in the dialog. Example: "Add files (.)"
[in]	szExtensions	List of extensions. Example: ".jpg;.jpeg"