ToolImageItem Class Reference

ToolImageItem Class Reference

#include <custcont.h>

Class Description

See also
Class ToolItem.

Description:
This class allows a developer to use an image in the toolbar. This is used internally as part of the object snap code. All methods of this class are implemented by the system.
+ Inheritance diagram for ToolImageItem:

Public Member Functions

 ToolImageItem (int w, int h, int k, int id, int y=CENTER_TOOL_VERTICALLY, DWORD hID=0, int ori=CTB_HORIZ|CTB_FLOAT)
 
 ToolImageItem (const MSTR &iconName, int w, int h, int id, DWORD hID=0, int ori=CTB_HORIZ|CTB_FLOAT)
 
- Public Member Functions inherited from ToolItem
virtual ~ToolItem ()
 

Public Attributes

int y
 
int il_index
 
MSTR iconName
 
- 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...
 
static UtilExport voidaligned_malloc (size_t size, size_t alignment)
 Allocates memory on a specified alignment boundary. More...
 
static UtilExport voidaligned_realloc (void *ptr, size_t size, size_t alignment)
 Reallocates memory on a specified alignment boundary. More...
 
static UtilExport void aligned_free (void *ptr)
 Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...
 

Constructor & Destructor Documentation

ToolImageItem ( int  w,
int  h,
int  k,
int  id,
int  y = CENTER_TOOL_VERTICALLY,
DWORD  hID = 0,
int  ori = CTB_HORIZ|CTB_FLOAT 
)
inline
Remarks
Constructor. The data members are initialized to the values passed. The type parameter of ToolItem is set to CTB_IMAGE.
3525  {
3526  type = CTB_IMAGE;
3527  this->y = y;
3528  this->w = w;
3529  this->h = h;
3530  this->il_index = k;
3531  this->id = id;
3532  this->helpID = hID;
3533  orient = ori;
3534  }
int orient
Definition: custcont.h:3166
int id
Definition: custcont.h:3163
int w
Definition: custcont.h:3165
int il_index
Definition: custcont.h:3521
ToolItemType type
Definition: custcont.h:3162
int y
Definition: custcont.h:3520
int h
Definition: custcont.h:3165
DWORD helpID
Definition: custcont.h:3164
An image control.
Definition: custcont.h:3122
ToolImageItem ( const MSTR iconName,
int  w,
int  h,
int  id,
DWORD  hID = 0,
int  ori = CTB_HORIZ|CTB_FLOAT 
)
inline
Remarks
Constructor. The data members are initialized to the values passed. The type parameter of ToolItem is set to CTB_IMAGE.
Parameters:
const MSTR& iconName

The filename of the icon.

int w

The width of the icon.

int h

The height of the icon.

int id

The ID of the icon.

DWORD hID=0

The help ID. For plug-in developers this id should be set to 0.

int ori

The orientation of the toolbar where icon locates.
3551  {
3552  type = CTB_IMAGE;
3553  this->iconName = iconName;
3554  this->w = w;
3555  this->h = h;
3556  this->id = id;
3557  this->helpID = hID;
3558  orient = ori;
3559  }
int orient
Definition: custcont.h:3166
int id
Definition: custcont.h:3163
int w
Definition: custcont.h:3165
ToolItemType type
Definition: custcont.h:3162
MSTR iconName
Definition: custcont.h:3522
int h
Definition: custcont.h:3165
DWORD helpID
Definition: custcont.h:3164
An image control.
Definition: custcont.h:3122

Member Data Documentation

int y
int il_index
MSTR iconName