Detailed Description

This class describes the properties of a 3ds Max custom toolbar button.

Each one of these items represents a UI widget on a Toolbar in 3dsmax user interface.

See also:: Class ToolItem, Class MAXBmpFileIcon, Custom Controls.

#include <custcont.h>

Inheritance diagram for ToolButtonItem:

Public Member Functions
Constructors
	ToolButtonItem (ToolItemType t, int iOE, int iIE, int iOD, int iID, int iW, int iH, int wd, int ht, int ID, DWORD hID=0, MCHAR *lbl=NULL, int or=CTB_HORIZ\|CTB_VERT\|CTB_FLOAT)
	Constructor.
	ToolButtonItem (ToolItemType t, MaxBmpFileIcon pIcon, int iW, int iH, int wd, int ht, int ID, DWORD hID=0, MCHAR lbl=NULL, int or=CTB_HORIZ\|CTB_VERT\|CTB_FLOAT)
	Constructor.
	ToolButtonItem (ToolItemType t, MaxBmpFileIcon pIcon, MaxBmpFileIcon pInIcon, int iW, int iH, int wd, int ht, int ID, DWORD hID=0, MCHAR *lbl=NULL, int or=CTB_HORIZ\|CTB_VERT\|CTB_FLOAT)
	Constructor.
Public Attributes
ImageList Members
int	iOutEn
	The following four data members (iOutEn, iInEn, iOutDis, iInDis) are indices into the image list.
int	iInEn
	In Enabled.
int	iOutDis
	Out Disabled.
int	iInDis
	In Disabled.
Dimensions
int	iw
	The width of the button image.
int	ih
	The height of the button image.
Pointer Members
MCHAR *	label
	The label describing the tool button item.
MaxBmpFileIcon *	mpIcon
	A pointer to the icon image associated with the button.
MaxBmpFileIcon *	mpInIcon
	A pointer to the pressed (or in) icon image associated with the button.

Constructor & Destructor Documentation

ToolButtonItem	(	ToolItemType	t,
		int	iOE,
		int	iIE,
		int	iOD,
		int	iID,
		int	iW,
		int	iH,
		int	wd,
		int	ht,
		int	ID,
		DWORD	hID = `0`,
		MCHAR *	lbl = `NULL`,
		int	or = `CTB_HORIZ\|CTB_VERT\|CTB_FLOAT`
	)		`[inline]`

Constructor.

Parameters:

ToolItemType	t - See tooItemTypes.
int	iOE - The Out&Enabled index.
int	iIE - The In&Enabled index.
int	iOD - The Out&Disabled index.
int	iID - The In&Disabled index.
int	iW - The image width (size of the bitmap in the ImageList).
int	iH - The image height (size of the bitmap in the ImageList).
int	wd - The width of the button.
int	ht - The height of the button.
int	ID - The ID of the control.
DWORD	hID=0 - The help ID. For plug-in developers this id should be set to 0.
MCHAR	*lbl = NULL - The label of the button.
int	or = CTB_HORIZ\|CTB_VERT\|CTB_FLOAT - The allowable orientation of the item. This may be one or more of the following: CTB_HORIZ - Horizontal, CTB_VERT - Vertical CTB_FLOAT - Floating (not docked)

            { 
                type = t; 
                orient = or;
                iOutEn = iOE; iInEn = iIE; iOutDis = iOD; iInDis = iID;
                iw = iW; ih = iH; w = wd; h = ht; id = ID; helpID = hID;
                label = lbl;
                mpIcon = mpInIcon = NULL;
            }

ToolButtonItem	(	ToolItemType	t,
		MaxBmpFileIcon *	pIcon,
		int	iW,
		int	iH,
		int	wd,
		int	ht,
		int	ID,
		DWORD	hID = `0`,
		MCHAR *	lbl = `NULL`,
		int	or = `CTB_HORIZ\|CTB_VERT\|CTB_FLOAT`
	)		`[inline]`

Constructor.

Parameters:

ToolItemType	t - See Tool Item Types.
MaxBmpFileIcon*	pIcon - A pointer to the icon associated with the button.
int	iW - The image width (size of the bitmap in the ImageList).
int	iH - The image height (size of the bitmap in the ImageList).
int	wd - The width of the button.
int	ht - The height of the button.
int	ID - The ID of the control.
DWORD	hID=0 - The help ID. For plug-in developers this id should be set to 0.
MCHAR	*lbl = NULL - The label of the button.
int	or = CTB_HORIZ\|CTB_VERT\|CTB_FLOAT - The orientation of the button item.

            { 
                type = t; 
                orient = or;
                mpIcon = pIcon;
                mpInIcon = NULL;
                iOutEn = iInEn = iOutDis = iInDis = -1;
                iw = iW; ih = iH; w = wd; h = ht; id = ID; helpID = hID;
                label = lbl;
            }

ToolButtonItem	(	ToolItemType	t,
		MaxBmpFileIcon *	pIcon,
		MaxBmpFileIcon *	pInIcon,
		int	iW,
		int	iH,
		int	wd,
		int	ht,
		int	ID,
		DWORD	hID = `0`,
		MCHAR *	lbl = `NULL`,
		int	or = `CTB_HORIZ\|CTB_VERT\|CTB_FLOAT`
	)		`[inline]`

Constructor.

Parameters:

ToolItemType	t - See ToolItemTypes.
MaxBmpFileIcon*	pIcon - A pointer to the icon associated with the button.
MaxBmpFileIcon*	pInIcon - A pointer to the in icon associated with the button.
int	iW - The image width (size of the bitmap in the ImageList).
int	iH - The image height (size of the bitmap in the ImageList).
int	wd - The width of the button.
int	ht - The height of the button.
int	ID - The ID of the control.
DWORD	hID=0 - The help ID. For plug-in developers this id should be set to 0.
MCHAR	*lbl = NULL - The label of the button.
int	or = CTB_HORIZ\|CTB_VERT\|CTB_FLOAT - The orientation of the button item.

            { 
                type = t; 
                orient = or;
                mpIcon = pIcon;
                mpInIcon = pInIcon;
                iOutEn = iInEn = iOutDis = iInDis = -1;
                iw = iW; ih = iH; w = wd; h = ht; id = ID; helpID = hID;
                label = lbl;
            }

Member Data Documentation

int iOutEn

Search for all occurrences

The following four data members (iOutEn, iInEn, iOutDis, iInDis) are indices into the image list.

They indicate which images to use for each of the four possible button states. You may specify a unique image for each one of these states by passing a different index for each state. Or you may supply a single image to be used for all the states by specifying the same index four times. Out Enabled

int iInEn

Search for all occurrences

In Enabled.

int iOutDis

Search for all occurrences

Out Disabled.

int iInDis

Search for all occurrences

In Disabled.

int iw

Search for all occurrences

The width of the button image.