IVertToolbar Class Reference

#include <custcont.h>

Inheritance diagram for IVertToolbar:

Public Member Functions
virtual void	SetImage (HIMAGELIST hImage)=0
virtual void	AddTool (ToolItem &entry, int pos=-1)=0
void	AddTool (ToolItem &&entry, int pos=-1)
	This overload was added to allow passing temporary variable to AddTool.
virtual void	DeleteTools (int start, int num=-1)=0
virtual void	SetBottomBorder (BOOL on)=0
virtual void	SetTopBorder (BOOL on)=0
virtual ICustButton *	GetICustButton (int id)=0
virtual ICustStatus *	GetICustStatus (int id)=0
virtual HWND	GetItemHwnd (int id)=0
virtual void	Enable (BOOL onOff=TRUE)
Public Member Functions inherited from ICustomControl
virtual HWND	GetHwnd ()=0
virtual void	Enable (BOOL onOff=TRUE)=0
virtual void	Disable ()=0
virtual BOOL	IsEnabled ()=0
virtual void	Enable2 (BOOL onOff=TRUE)=0
virtual INT_PTR	Execute (int cmd, ULONG_PTR arg1=0, ULONG_PTR arg2=0, ULONG_PTR arg3=0)
virtual void	SetTooltip (bool bEnable, const MCHAR *text)=0
	Sets a tooltip for the custom control.
CoreExport void	UpdateEnableState (Animatable *anim, int subNum)
	Helper function to disable or enable this UI control based on whether the Animatable associated with it is keyframable or not (locked parameter or scripted parameters are not keyframable).
Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor.
virtual UtilExport BaseInterface *	GetInterface (Interface_ID id)
template<class InterfaceType >
InterfaceType *	GetTypedInterface ()

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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator.
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator.
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary.
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary.
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc.

Detailed Description

See also

Class ICustomControl.

Description:

This control allows the creation of vertical toolbars containing buttons (push, check, and fly-offs), status fields, separators (spacers), and other Windows or user defined controls. The standard size for 3ds Max toolbar button icons is 16x15 or 16x16 pixels.

All methods of this class are implemented by the system.

To initialize the pointer to the control call:
IVertToolbar GetIVertToolbar(HWND hCtrl); To release the control call:
void ReleaseIVertToolbar(IVertToolbar *ict); The value to use in the Class field of the Custom Control Properties dialog is: VertToolbar

Member Function Documentation

SetImage()

virtual void SetImage ( HIMAGELIST  hImage )

pure virtual

Remarks

This method establishes the image list used to display images in the toolbar.

Parameters:

HIMAGELIST hImage

The image list. An image list is a collection of same-sized images, each of which can be referred to by an index. Image lists are used to efficiently manage large sets of icons or bitmaps in Windows. All images in an image list are contained in a single, wide bitmap in screen device format. An image list may also include a monochrome bitmap that contains masks used to draw images transparently (icon style). The Windows API provides image list functions, which enable you to draw images, create and destroy image lists, add and remove images, replace images, and merge images.

AddTool() [1/2]

virtual void AddTool ( ToolItem &  entry, int  pos = -1  )

pure virtual

Remarks

The developer calls this method once for each item in the toolbar. The items appear in the toolbar from left to right in the order that they were added using this method. (Note that this method adds tools to the custom toolbar and not the 3ds Max toolbar).

Parameters:

const ToolItem& entry

Describes the of item to add to the toolbar.

int pos=-1

Controls where the added tool is inserted. The default of -1 indicates the control will be added at the right end of the toolbar.

AddTool() [2/2]

void AddTool ( ToolItem &&  entry, int  pos = -1  )

inline

This overload was added to allow passing temporary variable to AddTool.

{ AddTool(entry, pos); }

DeleteTools()

virtual void DeleteTools ( int  start, int  num = -1  )

pure virtual

Remarks

This method is used to delete tools from the toolbar.

Parameters:

int start

Specifies which tool is the first to be deleted.

int num=-1

Specifies the number of tools to delete. If this parameter is -1 (the default) it deletes 'start' through count-1 tools.

SetBottomBorder()

virtual void SetBottomBorder ( BOOL  on )

pure virtual

Remarks

Passing TRUE to this method draws a border beneath the toolbar.

Parameters:

BOOL on

TRUE to draw the border; FALSE for no border.

SetTopBorder()

virtual void SetTopBorder ( BOOL  on )

pure virtual

Remarks

Passing TRUE to this method draws a border above the toolbar.

Parameters:

BOOL on

TRUE to draw the border; FALSE for no border.

GetICustButton()

virtual ICustButton * GetICustButton ( int  id )

pure virtual

Remarks

This method is used to return a pointer to one of the toolbar's buttons. Using this pointer you can call methods on the button. If you use this method, you must release the control after you are finished with it.

Parameters:

int id

Specifies the id of the toolbar button.

Returns

A pointer to one of the toolbar's buttons.

GetICustStatus()

virtual ICustStatus * GetICustStatus ( int  id )

pure virtual

Remarks

This method is used to return a pointer to one of the toolbars status controls. Using this pointer you can call methods on the status control. If you use this method, you must release the control after you are finished with it.

Parameters:

int id

Specifies the id of the toolbar button.

Returns

A pointer to one of the toolbars status controls

GetItemHwnd()

virtual HWND GetItemHwnd ( int  id )

pure virtual

Remarks

Returns the handle to the toolbar item whose ID is passed.

Parameters:

int id

Specifies the id of the toolbar button.

Enable()

virtual void Enable ( BOOL  onOff = TRUE )

inlinevirtual

Remarks

This method is used to enable the control so it may be operated by the user.

Parameters

onOff

TRUE to enable; FALSE to disable.

Implements ICustomControl.

{};