ToolOtherItem Class Reference

ToolOtherItem Class Reference

#include <custcont.h>

Class Description

See also
Class ToolItem, Custom User Interface Controls.

Description:
This class is used to add any user defined or standard Windows control to a 3ds Max custom toolbar.
Data Members:
int y;

The vertical justification.

DWORD style;

The control window style.

MCHAR *className;

The class name of the control. For the 3ds Max custom controls you may use one of the following #defines:

SPINNERWINDOWCLASS

ROLLUPWINDOWCLASS

CUSTEDITWINDOWCLASS

CUSTBUTTONWINDOWCLASS

CUSTSTATUSWINDOWCLASS

CUSTTOOLBARWINDOWCLASS

CUSTIMAGEWINDOWCLASS

COLORSWATCHWINDOWCLASS

Or it may be a literal string such as:

"COMBOBOX"

See the Win32 API help under CreateWindow() for a list of the options here.

MCHAR *windowText;

The window text. This is displayed in controls that have text in them.
+ Inheritance diagram for ToolOtherItem:

Public Member Functions

 ToolOtherItem (const MCHAR *cls, int w, int h, int id, DWORD_PTR style=WS_CHILD|WS_VISIBLE, int y=CENTER_TOOL_VERTICALLY, const MCHAR *wt=NULL, DWORD hID=0, int ori=CTB_HORIZ|CTB_FLOAT)
 
- Public Member Functions inherited from ToolItem
virtual ~ToolItem ()
 

Public Attributes

int y
 
DWORD_PTR style
 
const MCHARclassName
 
const MCHARwindowText
 
- Public Attributes inherited from ToolItem
ToolItemType type
 
int id
 
DWORD helpID
 
int w
 
int h
 
int orient
 

Additional Inherited Members

- Static Public Member Functions inherited from MaxHeapOperators
static UtilExport voidoperator new (size_t size)
 Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator new[] (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate arrays of objects. More...
 
static UtilExport voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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

ToolOtherItem ( const MCHAR cls,
int  w,
int  h,
int  id,
DWORD_PTR  style = WS_CHILD|WS_VISIBLE,
int  y = CENTER_TOOL_VERTICALLY,
const MCHAR wt = NULL,
DWORD  hID = 0,
int  ori = CTB_HORIZ|CTB_FLOAT 
)
inline
Remarks
Constructor.
Parameters:
MCHAR *cls

The class name of the control. This may be one of the values listed above under data members.

int w

The width of the control.

int h

The height of the control.

int id

The ID of the control.

DWORD_PTR style=WS_CHILD|WS_VISIBLE

The style of the control window.

int y=CENTER_TOOL_VERTICALLY

The vertical justification. This is a y offset from the top of the toolbar in pixels. The default value simply centers the tool vertically.

MCHAR *wt=NULL

The window text.

DWORD hID=0

The help ID. For plug-in developers this id should be set to 0.
4030  {
4031  type = CTB_OTHER;
4032  this->y = y;
4033  this->w = w;
4034  this->h = h;
4035  this->id = id;
4036  this->helpID = hID;
4037  this->style = style;
4038  orient = ori;
4039  className = cls;
4040  windowText = wt;
4041  }
int orient
Definition: custcont.h:3699
int id
Definition: custcont.h:3696
int w
Definition: custcont.h:3698
DWORD_PTR style
Definition: custcont.h:4006
ToolItemType type
Definition: custcont.h:3695
int y
Definition: custcont.h:4005
int h
Definition: custcont.h:3698
const MCHAR * windowText
Definition: custcont.h:4008
const MCHAR * className
Definition: custcont.h:4007
DWORD helpID
Definition: custcont.h:3697
A user-defined tool type.
Definition: custcont.h:3653

Member Data Documentation

int y
DWORD_PTR style
const MCHAR* className
const MCHAR* windowText