#include <custcont.h>

Inheritance diagram for IRollupWindow:

Public Member Functions
virtual void	Show ()=0

virtual void	Hide ()=0

virtual void	Show (int index)=0

virtual void	Hide (int index)=0

virtual HWND	GetPanelDlg (int index)=0

virtual int	GetPanelIndex (HWND hWnd)=0

virtual int	GetPanelIndex (QWidget &qtWidget)=0
	Returns the index of a rollup page that was created from a Qt widget. More...

virtual void	SetPanelTitle (int index, const MCHAR *title)=0

virtual MSTR	GetPanelTitle (int index) const =0
	Gets the title text displayed in the rollup page whose index is passed. More...

virtual int	AppendRollup (HINSTANCE hInst, const MCHAR dlgTemplate, DLGPROC dlgProc, const MCHAR title, LPARAM param=0, DWORD flags=0, int category=ROLLUP_CAT_STANDARD)=0

virtual int	AppendRollup (HINSTANCE hInst, DLGTEMPLATE dlgTemplate, DLGPROC dlgProc, const MCHAR title, LPARAM param=0, DWORD flags=0, int category=ROLLUP_CAT_STANDARD)=0

virtual int	AppendRollup (QWidget &qtWidget, const MCHAR *title, DWORD rollupFlags, int category)=0
	Adds a rollup page that hosts a Qt dialog. More...

virtual int	ReplaceRollup (int index, HINSTANCE hInst, const MCHAR dlgTemplate, DLGPROC dlgProc, const MCHAR title, LPARAM param=0, DWORD flags=0, int category=ROLLUP_CAT_STANDARD)=0

virtual int	ReplaceRollup (int index, HINSTANCE hInst, DLGTEMPLATE dlgTemplate, DLGPROC dlgProc, const MCHAR title, LPARAM param=0, DWORD flags=0, int category=ROLLUP_CAT_STANDARD)=0

virtual void	DeleteRollup (int index, int count)=0

virtual void	SetPageDlgHeight (int index, int height)=0

virtual int	GetPageDlgHeight (int index) const =0
	Get the height of a rollup dialog. More...

virtual void	SaveState (RollupState *hState)=0

virtual void	RestoreState (RollupState *hState)=0

virtual void	DlgMouseMessage (HWND hDlg, UINT message, WPARAM wParam, LPARAM lParam)=0

virtual int	GetNumPanels ()=0

virtual BOOL	IsPanelOpen (int index)=0

virtual void	SetPanelOpen (int index, BOOL isOpen, BOOL ignoreFlags=TRUE)=0

virtual int	GetScrollPos ()=0

virtual void	SetScrollPos (int spos)=0

virtual void	MoveRollupPanelFrom (IRollupWindow *from, HWND hPanel, BOOL top)=0

virtual int	GetPanelHeight (int index)=0

virtual int	GetScrollHeight ()=0

virtual void	UpdateLayout ()=0

virtual IRollupPanel *	GetPanel (HWND hWnd)=0

virtual void	RegisterRollupCallback (IRollupCallback *callb)=0

virtual void	UnRegisterRollupCallback (IRollupCallback *callb)=0

virtual void	RegisterRCMenuItem (IRollupRCMenuItem *item)=0

virtual void	UnRegisterRCMenuItem (IRollupRCMenuItem *item)=0

virtual void	ResetCategories (bool update=true)=0

virtual void	SetBorderless (BOOL borderless)=0
	Sets a rollup window to borderless, or bordered. More...

virtual BOOL	GetBorderless ()=0
	Returns TRUE if the rollup window is borderless, FALSE otherwise. More...

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. More...

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). More...

Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...

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. More...

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. More...

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. 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 void *	operator 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 void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary. More...

static UtilExport void *	aligned_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...

Detailed Description

See also: Class ICustomControl, Class IRollupPanel, Custom User Interface Controls, Class Interface.

Description:: This control is used to access existing rollup pages or if you are creating a dialog box which will not be used in the command panel. This control may be used to add a container area for rollup pages to be added to the dialog, and provides a scroll bar just like the command panel itself.

Note that this is a special case. Normally, adding rollup pages to the command panel is done using the simple AddRollupPage() method of the Interface class. This control is only used when you want to have a scrolling region for rollup pages in a dialog box.

To initialize the pointer to the control call:

IRollupWindow *GetIRollup(HWND hCtrl);

To release the control call:

void ReleaseIRollup(IRollupWindow *irw);

The value to use in the Class field of the Custom Control Properties dialog is: RollupWindow

Member Function Documentation

◆ Show() [1/2]

virtual void Show ( )

pure virtual

Remarks: This causes all the rollup windows to be visible.

◆ Hide() [1/2]

virtual void Hide ( )

pure virtual

Remarks: This causes all the rollup windows to become invisible.

◆ Show() [2/2]

virtual void Show ( int index )

pure virtual

Remarks: This will make the rollup window whose index is passed visible.

Parameters:: int index

The index of the rollup to show.

◆ Hide() [2/2]

virtual void Hide ( int index )

pure virtual

Remarks: This will make the rollup window whose index is passed invisible.

Parameters:: int index

The index of the rollup to hide.

◆ GetPanelDlg()

virtual HWND GetPanelDlg ( int index )

pure virtual

Remarks: Returns the handle of the rollup page whose index is passed.

Parameters:: int index

The index of the rollup whose handle is to be returned.

◆ GetPanelIndex() [1/2]

virtual int GetPanelIndex ( HWND hWnd )

pure virtual

Remarks: Returns an index to the rollup page given its handle.

Parameters:: HWND hWnd

The handle of the rollup.

◆ GetPanelIndex() [2/2]

virtual int GetPanelIndex ( QWidget & qtWidget )

pure virtual

Returns the index of a rollup page that was created from a Qt widget.

See also: int AppendRollup(QWidget& qtWidget, const MCHAR *title, DWORD rollupFlags, int category)

◆ SetPanelTitle()

virtual void SetPanelTitle	(	int	index,
		const MCHAR *	title
	)

pure virtual

Remarks: This method sets the title text displayed in the rollup page whose index is passed.

Parameters:: int index

Specifies the rollup whose title is to be set.

MCHAR *title

The title string.

◆ GetPanelTitle()

virtual MSTR GetPanelTitle ( int index ) const

pure virtual

Gets the title text displayed in the rollup page whose index is passed.

Parameters

[in] index Specifies the rollup whose title is to be returned.

Returns: The title of the specified rollup.

See also: SetPanelTitle

◆ AppendRollup() [1/3]

virtual int AppendRollup	(	HINSTANCE	hInst,
		const MCHAR *	dlgTemplate,
		DLGPROC	dlgProc,
		const MCHAR *	title,
		LPARAM	param = `0`,
		DWORD	flags = `0`,
		int	category = `ROLLUP_CAT_STANDARD`
	)

pure virtual

Remarks: This method is used to add a rollup page.

Parameters:: HINSTANCE hInst

The DLL instance handle of the plug-in.

MCHAR *dlgTemplate

The dialog template for the rollup page.

DLGPROC dlgProc

The dialog proc to handle the message sent to the rollup page.

MCHAR *title

The title displayed in the title bar.

LPARAM param=0

Any specific data to pass along may be stored here.

DWORD flags=0

Append rollup page flags:

APPENDROLL_CLOSED

Starts the page in the rolled up state.

int category = ROLLUP_CAT_STANDARD

The category parameter provides flexibility with regard to where a particular rollup should be displayed in the UI. RollupPanels with lower category fields will be displayed before RollupPanels with higher category fields. For RollupPanels with equal category value the one that was added first will be displayed first. Although it is possible to pass any int value as category there exist currently 5 different category defines: ROLLUP_CAT_SYSTEM, ROLLUP_CAT_STANDARD, and ROLLUP_CAT_CUSTATTRIB.

When using ROLLUP_SAVECAT, the rollup page will make the provided category sticky, meaning it will not read the category from the RollupOrder.cfg file, but rather save the category field that was passed as argument in the CatRegistry and in the RollupOrder.cfg file.

The method will take the category of the replaced rollup in case the flags argument contains ROLLUP_USEREPLACEDCAT. This is mainly done, so that this system works with param maps as well.

Returns: The index of the new page is returned.

◆ AppendRollup() [2/3]

virtual int AppendRollup	(	HINSTANCE	hInst,
		DLGTEMPLATE *	dlgTemplate,
		DLGPROC	dlgProc,
		const MCHAR *	title,
		LPARAM	param = `0`,
		DWORD	flags = `0`,
		int	category = `ROLLUP_CAT_STANDARD`
	)

pure virtual

Remarks: This method is used to add a rollup page, but is currently not used.

Parameters:: HINSTANCE hInst

The DLL instance handle of the plug-in.

DLGTEMPLATE *dlgTemplate

The dialog template for the rollup page.

DLGPROC dlgProc

The dialog proc to handle the message sent to the rollup page.

MCHAR *title

The title displayed in the title bar.

LPARAM param=0

Any specific data to pass along may be stored here.

DWORD flags=0

Append rollup page flags:

APPENDROLL_CLOSED

Starts the page in the rolled up state.

int category = ROLLUP_CAT_STANDARD

The category parameter provides flexibility with regard to where a particular rollup should be displayed in the UI. RollupPanels with lower category fields will be displayed before RollupPanels with higher category fields. For RollupPanels with equal category value the one that was added first will be displayed first. Although it is possible to pass any int value as category there exist currently 5 different category defines: ROLLUP_CAT_SYSTEM, ROLLUP_CAT_STANDARD, and ROLLUP_CAT_CUSTATTRIB.

When using ROLLUP_SAVECAT, the rollup page will make the provided category sticky, meaning it will not read the category from the RollupOrder.cfg file, but rather save the category field that was passed as argument in the CatRegistry and in the RollupOrder.cfg file.

The method will take the category of the replaced rollup in case the flags argument contains ROLLUP_USEREPLACEDCAT. This is mainly done, so that this system works with param maps as well.

Returns: The index of the new page is returned.

◆ AppendRollup() [3/3]

virtual int AppendRollup	(	QWidget &	qtWidget,
		const MCHAR *	title,
		DWORD	rollupFlags,
		int	category
	)

pure virtual

Adds a rollup page that hosts a Qt dialog.

Parameters

qtWidget	the Qt widget that will be hosted in the rollup. This QWidget becomes the ownership of the system; it will be deleted by the system once no longer needed.
title	The title string, displayed at the top of the rollup.
rollupFlags	Optional rollup flags, such as APPENDROLL_CLOSED, DONTAUTOCLOSE, ROLLUP_SAVECAT, etc.
category	The category controls the ordering of the rollups, with lower values being inserted before rollups of higher category.

Returns: The index of the new rollup.

◆ ReplaceRollup() [1/2]

virtual int ReplaceRollup	(	int	index,
		HINSTANCE	hInst,
		const MCHAR *	dlgTemplate,
		DLGPROC	dlgProc,
		const MCHAR *	title,
		LPARAM	param = `0`,
		DWORD	flags = `0`,
		int	category = `ROLLUP_CAT_STANDARD`
	)

pure virtual

Remarks: This method is used to replace the rollup page whose index is passed.

Parameters:: int index

Specifies the rollup whose to be replaced.

HINSTANCE hInst

The DLL instance handle of the plug-in.

MCHAR *dlgTemplate

The dialog template for the rollup page.

DLGPROC dlgProc

The dialog proc to handle the message sent to the rollup page.

MCHAR *title

The title displayed in the title bar.

LPARAM param=0

Any specific data to pass along may be stored here.

DWORD flags=0

Append rollup page flags:

APPENDROLL_CLOSED

Starts the page in the rolled up state.

Returns: The index of the replacement page is returned.

◆ ReplaceRollup() [2/2]

virtual int ReplaceRollup	(	int	index,
		HINSTANCE	hInst,
		DLGTEMPLATE *	dlgTemplate,
		DLGPROC	dlgProc,
		const MCHAR *	title,
		LPARAM	param = `0`,
		DWORD	flags = `0`,
		int	category = `ROLLUP_CAT_STANDARD`
	)

pure virtual

Remarks: This method is used to replace the rollup page whose index is passed, but is currently not used.

Parameters:: int index

Specifies the rollup whose to be replaced.

HINSTANCE hInst

The DLL instance handle of the plug-in.

DLGTEMPLATE *dlgTemplate

The dialog template for the rollup page.

DLGPROC dlgProc

The dialog proc to handle the message sent to the rollup page.

MCHAR *title

The title displayed in the title bar.

LPARAM param=0

Any specific data to pass along may be stored here.

DWORD flags=0

Append rollup page flags:

APPENDROLL_CLOSED

Starts the page in the rolled up state.

int category = ROLLUP_CAT_STANDARD

The category parameter provides flexibility with regard to where a particular rollup should be displayed in the UI. RollupPanels with lower category fields will be displayed before RollupPanels with higher category fields. For RollupPanels with equal category value the one that was added first will be displayed first. Although it is possible to pass any int value as category there exist currently 5 different category defines: ROLLUP_CAT_SYSTEM, ROLLUP_CAT_STANDARD, and ROLLUP_CAT_CUSTATTRIB.

When using ROLLUP_SAVECAT, the rollup page will make the provided category sticky, meaning it will not read the category from the RollupOrder.cfg file, but rather save the category field that was passed as argument in the CatRegistry and in the RollupOrder.cfg file.

The method will take the category of the replaced rollup in case the flags argument contains ROLLUP_USEREPLACEDCAT. This is mainly done, so that this system works with param maps as well.

Returns: The index of the replacement page is returned.

◆ DeleteRollup()

virtual void DeleteRollup	(	int	index,
		int	count
	)

pure virtual

Remarks: This method deletes the rollup pages starting at the index passed. The count parameter controls how many pages are deleted.

Parameters:: int index

The starting index.

int count

The number of pages.

◆ SetPageDlgHeight()

virtual void SetPageDlgHeight	(	int	index,
		int	height
	)

pure virtual

Remarks: This method is used to change the height of a rollup page.

Parameters:: int index

The index of the rollup to change.

int height

The new height of the dialog in pixels.

◆ GetPageDlgHeight()

virtual int GetPageDlgHeight ( int index ) const

pure virtual

Get the height of a rollup dialog.

Parameters

[in] index The index of the rollup to change.

Returns: The height of the dialog inside the rollup page

See also: SetPageDlgHeight

◆ SaveState()

virtual void SaveState ( RollupState * hState )

pure virtual

Remarks: This method saves the state of the rollup (the position of the scroll bars, which pages are open, etc...).

Parameters:: RollupState *hState

Pointer to storage for the rollup state. Note: typedef void RollupState;

◆ RestoreState()

virtual void RestoreState ( RollupState * hState )

pure virtual

Remarks: This methods restores a saved state.

Parameters:: RollupState *hState

Pointer to storage for the rollup state. Note: typedef void RollupState;

◆ DlgMouseMessage()

virtual void DlgMouseMessage	(	HWND	hDlg,
		UINT	message,
		WPARAM	wParam,
		LPARAM	lParam
	)

pure virtual

Remarks: Passing WM_LBUTTONDOWN, WM_MOUSEMOVE, and WM_LBUTTONUP to this function allows hand cursor scrolling with unused areas in the dialog.

Parameters:: HWND hDlg

The handle of the dialog.

UINT message

The message to pass along: WM_LBUTTONDOWN, WM_MOUSEMOVE, or WM_LBUTTONUP.

WPARAM wParam

LPARAM lParam

These are passed as part of the message sent in. Pass them along to this method.

◆ GetNumPanels()

virtual int GetNumPanels ( )

pure virtual

Remarks: This method returns the number of panels used in the rollup.

◆ IsPanelOpen()

virtual BOOL IsPanelOpen ( int index )

pure virtual

Remarks: This method return TRUE if the rollup page whose index is passed is open and FALSE if it is closed.

◆ SetPanelOpen()

virtual void SetPanelOpen	(	int	index,
		BOOL	isOpen,
		BOOL	ignoreFlags = `TRUE`
	)

pure virtual

Remarks: This causes the page whose index is passed to either open or close. If isOpen is passed a value of TRUE, the page is opened.

Parameters:: int index

The page to open or close.

BOOL isOpen

If TRUE, the page is opened, if FALSE it is closed.

BOOL ignoreFlags = TRUE

The method would close the panel if the DONTAUTOCLOSE flag is not set on the rollup. This flag indicates if it should be closed anyway, even if the flag is set.

◆ GetScrollPos()

virtual int GetScrollPos ( )

pure virtual

Remarks: This method returns the scroll position of the window.

◆ SetScrollPos()

virtual void SetScrollPos ( int spos )

pure virtual

Remarks: This method sets the scroll position of the window.

Parameters:: int spos

The scroll position to set.

◆ MoveRollupPanelFrom()

virtual void MoveRollupPanelFrom	(	IRollupWindow *	from,
		HWND	hPanel,
		BOOL	top
	)

pure virtual

Remarks: This methods moves a RollupPanel to another RollupWindow. It either inserts it at the top, or appends it at the end (depending on the top parameter)

Parameters:: IRollupWindow *from

A pointer to the rollup window you are moving from.

HWND hPanel

The handle to the destination panel.

BOOL top

TRUE to insert at the top; FALSE to append at the end.

◆ GetPanelHeight()

virtual int GetPanelHeight ( int index )

pure virtual

Remarks: Returns the height of the specified RollupPanel.

Parameters:: int index

The zero based index of the rollup panel.

◆ GetScrollHeight()

virtual int GetScrollHeight ( )

pure virtual

Remarks: Returns the height of a RollupWindow, that it is longer than the visible area

◆ UpdateLayout()

virtual void UpdateLayout ( )

pure virtual

Remarks: This method is used internally

◆ GetPanel()

virtual IRollupPanel* GetPanel ( HWND hWnd )

pure virtual

Remarks: Returns a pointer to the rollup panel for the specified window handle. An IRollupPanel describes the properties of a single rollup.

Parameters:: HWND hWnd

The window handle to get the rollup for.

◆ RegisterRollupCallback()

virtual void RegisterRollupCallback ( IRollupCallback * callb )

pure virtual

Remarks: This method allows you to register a rollup callback function to handle any custom handling for dragging and dropping rollouts.

Parameters:: IRollupCallback *callb

A pointer to the callback function you wish to register.

◆ UnRegisterRollupCallback()

virtual void UnRegisterRollupCallback ( IRollupCallback * callb )

pure virtual

Remarks: This method allows you to unregister a rollup callback function.

Parameters:: IRollupCallback *callb

A pointer to the callback function you wish to unregister.

◆ RegisterRCMenuItem()

virtual void RegisterRCMenuItem ( IRollupRCMenuItem * item )

pure virtual

Remarks: This method allows you to register a rollup right-click menu item which will be added to the list of items. For rollups that support Drag and Drop this is used to register a ResetCategories RightClickMenu. Reset Categories will get rid of all the changes that have been made through drag and drop and restore the default.

Parameters:: IRollupRCMenuItem *item

A pointer to the right-click menu item you wish to register.

◆ UnRegisterRCMenuItem()

virtual void UnRegisterRCMenuItem ( IRollupRCMenuItem * item )

pure virtual

Remarks: This method allows you to unregister a rollup right-click menu item.

Parameters:: IRollupRCMenuItem *item

A pointer to the right-click menu item you wish to unregister.

◆ ResetCategories()

virtual void ResetCategories ( bool update = true )

pure virtual

Remarks: This method will reset the category information on all the panels in the rollup window. The plugin will have to be reloaded (EndEditParams, BeginEditparams) in order to show this in the UI.

Parameters:: bool update = true

TRUE to update the layout, otherwise FALSE. Leave this on TRUE.

◆ SetBorderless()

virtual void SetBorderless ( BOOL borderless )

pure virtual

Sets a rollup window to borderless, or bordered.

A borderless rollup window has no outer line, making it appear inset. By default, rollup windows have a border (are not borderless).

Parameters

[in] borderless Pass TRUE for borderless, FALSE for bordered

◆ GetBorderless()

virtual BOOL GetBorderless ( )

pure virtual

Returns TRUE if the rollup window is borderless, FALSE otherwise.

A borderless rollup window has no outer line, making it appear inset. By default, rollup windows have a border (are not borderless).

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Show() [1/2]

◆ Hide() [1/2]

◆ Show() [2/2]

◆ Hide() [2/2]

◆ GetPanelDlg()

◆ GetPanelIndex() [1/2]

◆ GetPanelIndex() [2/2]

◆ SetPanelTitle()

◆ GetPanelTitle()

◆ AppendRollup() [1/3]

◆ AppendRollup() [2/3]

◆ AppendRollup() [3/3]

◆ ReplaceRollup() [1/2]

◆ ReplaceRollup() [2/2]

◆ DeleteRollup()

◆ SetPageDlgHeight()

◆ GetPageDlgHeight()

◆ SaveState()

◆ RestoreState()

◆ DlgMouseMessage()

◆ GetNumPanels()

◆ IsPanelOpen()

◆ SetPanelOpen()

◆ GetScrollPos()

◆ SetScrollPos()

◆ MoveRollupPanelFrom()

◆ GetPanelHeight()

◆ GetScrollHeight()

◆ UpdateLayout()

◆ GetPanel()

◆ RegisterRollupCallback()

◆ UnRegisterRollupCallback()

◆ RegisterRCMenuItem()

◆ UnRegisterRCMenuItem()

◆ ResetCategories()

◆ SetBorderless()

◆ GetBorderless()