This reference page is linked to from the following overview topics: Classes Involved in the Action System.

Detailed Description

Description:: This class is available in release 4.0 and later only.

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.

#include <maxicon.h>

Inheritance diagram for MaxIcon:

Public Member Functions
virtual CoreExport	~MaxIcon ()
	Destructor.
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

Constructor & Destructor Documentation

virtual CoreExport ~MaxIcon ( ) [virtual]

Destructor.

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]

Implemented in MaxBmpFileIcon.

virtual HIMAGELIST GetLargeImageList ( ) [pure virtual]

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.