IRollupCallback Class Reference

class IRollupCallback : public InterfaceServer More...

#include <C:/adskgit/3dsmax/3dsmax/3dswin/src/maxsdk/include/custcont.h>

Inheritance diagram for IRollupCallback:

Public Member Functions
virtual BOOL	HandleDrop (IRollupPanel *src, IRollupPanel *targ, bool before)
virtual BOOL	GetEditObjClassID (SClass_ID &sid, Class_ID &cid)
	This method has to be implemented in order to support drag and drop for rollups, no matter if custom drop handling is used, or not.
virtual BOOL	GetEditObjContext (MSTR &context)
	This method can be implemented in order to support different contexts for drag and drop for rollups, no matter if custom drop handling is used, or not.
virtual BOOL	HandleOpenAll ()
virtual BOOL	HandleCloseAll ()
virtual void	HandleDestroy ()
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

class IRollupCallback : public InterfaceServer

Description:

This class represents the abstract interface for a rollup window callback object to assist developers in handling custom drag and drop of rollouts.

Member Function Documentation

HandleDrop()

virtual BOOL HandleDrop ( IRollupPanel * src, IRollupPanel * targ, bool before )

inlinevirtual

Remarks

Any plugin (or core component), that wants to implement a custom behavior when a rollup page is drag and dropped onto another rollout, it can do so, by registering a IRollupCallback and overwriting this method and GetEditObjClassID(). After rearranging rollup pages the HandleDrop code should call: GetIRollupSettings()->GetCatReg()->Save(); in order to save the rollout order.

Parameters:

IRollupPanel *src

A pointer to the source rollup panel.

IRollupPanel *targ

A pointer to the target rollup panel.

bool before

TRUE to insert before the panel it was dropped on; FALSE to insert after.

Returns

TRUE to indicate to the system, that it took over the drop handling, otherwise FALSE.

Default Implementation:

{ return FALSE; }

{ return FALSE; }

GetEditObjClassID()

virtual BOOL GetEditObjClassID ( SClass_ID & sid, Class_ID & cid )

inlinevirtual

This method has to be implemented in order to support drag and drop for rollups, no matter if custom drop handling is used, or not.

The order of rollup panels is stored in the RollupOrder.cfg file in the UI directory. The order is stored under a SuperClassID and ClassID (and an optional context, if available). The RollupCallback has to specify what the SuperClassID and ClassID is. E.g. for the Modify Panel it is the ClassID for the currently edited object. For the DisplayPanel it is only one ClassID, that has no real class assigned to it, since the rollouts are independent from the object being edited (DISPLAY_PANEL_ROLLUPCFG_CLASSID).

Parameters

sid[out]	The SuperClassID of the object.
cid[out]	The class ID of the object.

Returns

TRUE if drag and drop is supported, otherwise FALSE.

Note

The default implementation returns FALSE and does not touch sid and cid.

See also

GetEditObjContext, ICatRegistry

{ return FALSE; }

GetEditObjContext()

virtual BOOL GetEditObjContext ( MSTR & context )

inlinevirtual

This method can be implemented in order to support different contexts for drag and drop for rollups, no matter if custom drop handling is used, or not.

It also requires the GetEditObjClassID function to be implemented and returning TRUE as well.

The order of rollup panels is stored in the RollupOrder.cfg file in the UI directory. The order is stored under a SuperClassID and ClassID and this context string, if present. The RollupCallback has to specify what the Context is, if present.

Parameters

context[out]

A reference to a string that shall receive the current context of the object being edited. This contexts is used to store and retrieve the rollup oder and state.

Returns

TRUE, if the context should be used, otherwise FALSE.

Note

The default implementation returns FALSE and does not touch the context string.

See also

GetEditObjClassID, ICatRegistry

{ return FALSE; }

HandleOpenAll()

virtual BOOL HandleOpenAll ( )

inlinevirtual

Remarks

This method is called when the user selected the "open all" function and it currently used internally. The method will return TRUE if successful and FALSE otherwise.

Default Implementation:

{return FALSE;}

{return FALSE;}

HandleCloseAll()

virtual BOOL HandleCloseAll ( )

inlinevirtual

Remarks

This method is called when the user selected the "close all" function and it currently used internally. The method will return TRUE if successful and FALSE otherwise.

Default Implementation:

{ return FALSE;}

{ return FALSE;}

HandleDestroy()

virtual void HandleDestroy ( )

inlinevirtual

Remarks

This method is called as the RollupWindow is being destroyed.

Default Implementation:

{}

Reimplemented in RolloutFloater.

{}