ATSExploreProviderParams Class Reference

ATS Explore Provider Object. More...

#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

Additional Inherited Members
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects.
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete[] (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator.
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator.
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary.
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary.
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc.

Detailed Description

ATS Explore Provider Object.

ATSExploreProviderParams describes the parameters for the IATSProvider::ExploreProvider method

See also

IATSProvider

Constructor & Destructor Documentation

ATSExploreProviderParams()

ATSExport ATSExploreProviderParams

(

)

Constructor.

~ATSExploreProviderParams()

virtual ATSExport ~ATSExploreProviderParams ( )

virtual

Destructor.

Member Function Documentation

GetTitle()

virtual ATSExport const MCHAR * GetTitle ( )

virtual

Get title.

Defines the title for the explore provider dialog

Returns

string containing the title

SetTitle()

virtual ATSExport void SetTitle ( const MCHAR *  szTitle )

virtual

Set title.

Defines the title for the explore provider dialog

Parameters

[in]

szTitle

string containing the filename

GetMultipleSelections()

virtual ATSExport bool GetMultipleSelections ( )

virtual

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

SetMultipleSelections()

virtual ATSExport void SetMultipleSelections ( bool  bMultipleSelections )

virtual

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

GetDownloadFiles()

virtual ATSExport bool GetDownloadFiles ( )

virtual

Get download files state.

Defines if the provider should automatically download the files selected

Returns

true if download should occur, false if not

SetDownloadFiles()

virtual ATSExport void SetDownloadFiles ( bool  bDownload )

virtual

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

AddFilter()

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

virtual

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"

Returns

new number of filters

NumFilters()

virtual ATSExport UINT NumFilters ( )

virtual

Number of filters.

Returns

number of filters

GetFilterName()

virtual ATSExport const MCHAR * GetFilterName ( UINT  iIndex )

virtual

Get filter name.

Parameters

[in]

iIndex

0-based index of filters

Returns

string containing filter name

GetFilterExtensions()

virtual ATSExport const MCHAR * GetFilterExtensions ( UINT  iIndex )

virtual

Get filter extensions.

Parameters

[in]

iIndex

0-based index of filters

Returns

string containing filter extensions

Member Data Documentation

mTitle

ATSString mTitle

protected

mState

DWORD mState

protected

mFilters

std::vector< ATSString > mFilters

protected

mExtensions

std::vector< ATSString > mExtensions

protected