MaxBmpFileIcon Class Reference

#include <maxicon.h>

Class Description

See also

Class MaxIcon, Class ICustButton.

Description:

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.

Inheritance diagram for MaxBmpFileIcon:

Public Member Functions
CoreExport	~MaxBmpFileIcon ()
	Default Destructor. More...
CoreExport	MaxBmpFileIcon (const MCHAR *pFilePrefix, int index)
CoreExport	MaxBmpFileIcon (const MCHAR *iconName)
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 const MSTR &	GetIconName () const
CoreExport void	SetKeepColor ()
CoreExport bool	GetKeepColor ()
CoreExport MSTR	GetIconPath ()
	/return Returns the full path of a Bmp icon file. More...
Public Member Functions inherited from MaxIcon
virtual CoreExport	~MaxIcon ()
	Destructor. More...
int	GetDefaultImageIndex (bool enabledVersion=true, COLORREF backgroundColor=GetCustSysColor(COLOR_BTNFACE))
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

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

(

const MCHAR *

iconName

)

Remarks

Constructor. Creates a MaxBmpFileIcon which refers to a multi-resolution icon.

Parameters

iconName

The name of the icon.

See also

QIcon MaxSDK::LoadMaxMultiResIcon( const QString& iconName )

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

Remarks

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

Implements MaxIcon.

CoreExport HIMAGELIST GetSmallImageList ( )

virtual

Remarks

Returns the image list for small icons.

Implements MaxIcon.

CoreExport HIMAGELIST GetLargeImageList ( )

virtual

Remarks

Returns the image list for large icons.

Implements MaxIcon.

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

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 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

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

Remarks

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

Implements MaxIcon.

CoreExport MSTR& GetFilePrefix ( )

inline

Remarks

Returns the directory of the icon.

{ return mFilePrefix; }

CoreExport int GetIndex ( )

inline

Remarks

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

{ return mIndex; }

CoreExport const MSTR& GetIconName

(

)

const

Remarks

Returns the name of the multi-resolution icon.

See also

QIcon MaxSDK::LoadMaxMultiResIcon( const QString& iconName )

CoreExport void SetKeepColor ( )

inline

Remarks

Tells the icon to limit color correction.

{ mKeepColor = true; }

CoreExport bool GetKeepColor ( )

inline

Returns

Tells the icon to limit color correction.

{ return mKeepColor; }

CoreExport MSTR GetIconPath

(

)

/return Returns the full path of a Bmp icon file.