MaxIcon Class Reference

#include <maxicon.h>

Class Description

See also

Class InterfaceServer, Class ICustButton, Class MaxBmpFileIcon.

Description:

This abstract class represents an icon image for toolbar buttons, icons in list boxes, etc. The class is based on Win32 ImageLists. MaxIcons must provide an image list and index into the list for both large (24x24) and small (16x15 or 16x16) icons.

Inheritance diagram for MaxIcon:

Public Member Functions
virtual CoreExport	~MaxIcon ()
	Destructor. More...
virtual HIMAGELIST	GetDefaultImageList ()=0
virtual HIMAGELIST	GetSmallImageList ()=0
virtual HIMAGELIST	GetLargeImageList ()=0
virtual int	GetSmallImageIndex (bool enabledVersion=true, COLORREF backgroundColor=GetCustSysColor(COLOR_BTNFACE))=0
virtual int	GetLargeImageIndex (bool enabledVersion=true, COLORREF backgroundColor=GetCustSysColor(COLOR_BTNFACE))=0
int	GetDefaultImageIndex (bool enabledVersion=true, COLORREF backgroundColor=GetCustSysColor(COLOR_BTNFACE))
virtual bool	UsesAlphaMask ()=0
Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor. More...
virtual UtilExport BaseInterface *	GetInterface (Interface_ID id)

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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator. More...
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator. More...

Constructor & Destructor Documentation

virtual CoreExport ~MaxIcon ( )

virtual

Destructor.

Member Function Documentation

virtual HIMAGELIST GetDefaultImageList ( )

pure virtual

Remarks

Returns the handle to the image list for the size of icons that the user has chosen.

Implemented in MaxBmpFileIcon.

virtual HIMAGELIST GetSmallImageList ( )

pure virtual

Remarks

Returns the image list for small icons.

Implemented in MaxBmpFileIcon.

virtual HIMAGELIST GetLargeImageList ( )

pure virtual

Remarks

Returns the image list for large icons.

Implemented in MaxBmpFileIcon.

virtual int GetSmallImageIndex ( bool  enabledVersion = true, COLORREF  backgroundColor = GetCustSysColor(COLOR_BTNFACE)  )

pure virtual

Remarks

Returns the zero based index into the image list for the small version of this particular icon.

Parameters:

bool enabledVersion = true

Pass true to get the index of the enabled version of the icon; false to get the disabled version.

COLORREF backgroundColor = GetCustSysColor(COLOR_BTNFACE)

The background color to use for the icon.

Specifies the windows color definition. See Standard Color IDs. For a full list of windows color definitions, please refer to the Win32 API, in particular the methods GetSysColor() and SetSysColor().

Implemented in MaxBmpFileIcon.

virtual int GetLargeImageIndex ( bool  enabledVersion = true, COLORREF  backgroundColor = GetCustSysColor(COLOR_BTNFACE)  )

pure virtual

Remarks

Returns the zero based index into the image list for the large version of this particular icon.

Parameters:

bool enabledVersion = true

Pass true to get the enabled version of the icon or false to get the disabled version.

COLORREF backgroundColor = GetCustSysColor(COLOR_BTNFACE)

The background color to use for the icon.

Specifies the windows color definition. See Standard Color IDs. For a full list of windows color definitions, please refer to the Win32 API, in particular the methods GetSysColor() and SetSysColor().

Implemented in MaxBmpFileIcon.

int GetDefaultImageIndex	(	bool	enabledVersion = true,
		COLORREF	backgroundColor = GetCustSysColor(COLOR_BTNFACE)
	)

Remarks

Returns the zero based index into the image list for the default version of this particular icon.

Parameters:

bool enabledVersion = true

Pass true to get the enabled version of the icon or false to get the disabled version.

COLORREF backgroundColor = GetCustSysColor(COLOR_BTNFACE)

The background color to use for the icon.

Specifies the windows color definition. See Standard Color IDs. For a full list of windows color definitions, please refer to the Win32 API, in particular the methods GetSysColor() and SetSysColor().

virtual bool UsesAlphaMask ( )

pure virtual

Remarks

This method returns true if the icons has an alpha mask that needs to be blended with the background color and false if it doesn't use an alpha mask.

Implemented in MaxBmpFileIcon.