MaxBmpFileIcon Class Reference

This reference page is linked to from the following overview topics: Icons.

---

Search for all occurrences

---

Detailed Description

See also:

Class MaxIcon, Class ICustButton.

Description:

This class is available in release 4.0 and later only.

This implementation of MaxIcon is for the icon images that are stored as ".bmp" files in 3ds Max's UI directory. This is used by the macroScript facility in MAXSrcipt to specify icons. See the MAXScript documentation for "macroScript" for the exact meaning of the filename and index and details.

#include <maxicon.h>

Inheritance diagram for MaxBmpFileIcon:

List of all members.

Public Member Functions
CoreExport	~MaxBmpFileIcon ()
	Default Destructor.
CoreExport	MaxBmpFileIcon (const MCHAR *pFilePrefix, int index)
CoreExport	MaxBmpFileIcon (SClass_ID sid, Class_ID cid)
CoreExport HIMAGELIST	GetDefaultImageList ()
CoreExport HIMAGELIST	GetSmallImageList ()
CoreExport HIMAGELIST	GetLargeImageList ()
CoreExport int	GetSmallImageIndex (bool enabledVersion=true, COLORREF backgroundColor=GetCustSysColor(COLOR_BTNFACE))
CoreExport int	GetLargeImageIndex (bool enabledVersion=true, COLORREF backgroundColor=GetCustSysColor(COLOR_BTNFACE))
CoreExport bool	UsesAlphaMask ()
CoreExport MSTR &	GetFilePrefix ()
CoreExport int	GetIndex ()
CoreExport void	SetKeepColor ()
CoreExport bool	GetKeepColor ()

---

Constructor & Destructor Documentation

CoreExport ~MaxBmpFileIcon

(

)

Default Destructor.

CoreExport MaxBmpFileIcon	(	const MCHAR *	pFilePrefix,
		int	index
	)

Remarks:

Constructor.

Parameters:

MCHAR* pFilePrefix

The file prefix to initialize with.

int index

The index of the icon.

CoreExport MaxBmpFileIcon	(	SClass_ID	sid,
		Class_ID	cid
	)

Remarks:

Constructor.

Parameters:

SClass_ID sid

The superclass ID

Class_ID cid

The class ID/

---

Member Function Documentation

CoreExport HIMAGELIST GetDefaultImageList

(

)

[virtual]

Search for all occurrences

Remarks:

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

Implements MaxIcon.

CoreExport HIMAGELIST GetSmallImageList

(

)

[virtual]

Search for all occurrences

Remarks:

Returns the image list for small icons.

Implements MaxIcon.

CoreExport HIMAGELIST GetLargeImageList

(

)

[virtual]

Search for all occurrences

Remarks:

Returns the image list for large icons.

Implements MaxIcon.

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

Search for all occurrences

Remarks:

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

Parameters:

bool enabledVersion = true

Pass true for the enalbed version of the icon; false for the disabled version.

COLORREF backgroundColor = GetCustSysColor(COLOR_BTNFACE)

The background color for use in alpha blending. The files that define these icons always have an alpha mask, and so a background color is needed to blend it with.

Implements MaxIcon.

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

Search for all occurrences

Remarks:

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

Parameters:

bool enabledVersion = true

Pass true for the enalbed version of the icon; false for the disabled version.

COLORREF backgroundColor = GetCustSysColor(COLOR_BTNFACE)

The background color for use in alpha blending. The files that define these icons always have an alpha mask, and so a background color is needed to blend it with.

Implements MaxIcon.

CoreExport bool UsesAlphaMask

(

)

[virtual]

Search for all occurrences

Remarks:

Returns true if the icon uses an alpha mask; otherwise false.

Implements MaxIcon.

CoreExport MSTR& GetFilePrefix

(

)

[inline]

Search for all occurrences

Remarks:

Returns the directory of the icon.

{ return mFilePrefix; }

CoreExport int GetIndex

(

)

[inline]

Search for all occurrences

Remarks:

Returns the index of the icon in the image file list.

{ return mIndex; }

CoreExport void SetKeepColor

(

)

[inline]

Search for all occurrences

Remarks:

Tells the icon to limit color correction.

{ mKeepColor = true; }

CoreExport bool GetKeepColor

(

)

[inline]

Search for all occurrences

Returns:

Tells the icon to limit color correction.

{ return mKeepColor; }