Detailed Description

An adapter for the ICuiDockableContent interface that provides default implementations of many of the interface methods.

This is an adapter class. A client only need to satisfy the ICuiDockableContent interface for their class to be loaded by the managed assembly loading process. However, this class is easier to use.

See also:: ICuiDockableContent

Inheritance diagram for MaxCustomControls::CuiDockableContentAdapter:

[legend]

List of all members.

Public Member Functions
	CuiDockableContentAdapter ()
	Constructor - initializes the DestroyOnClose property to true.
abstract object	CreateDockableContent ()
	This method is called by the managed assembly loading process process when it is ready to create and show the managed user control.
virtual void	SetContentDockMode (object dockableContent, DockStates.Dock dockMode)
	This is a callback function that 3ds Max calls when the CUI frame is docked or floated from the main application frame.
void	RaiseResettingConfiguration ()
	Raises the ResettingConfiguration event.
void	RaiseSavingConfiguration (String aFilename)
	Raises the SavingConfiguration event with the passed in file name.
void	RaiseLoadingConfiguration (String aFilename)
	Raises the LoadingConfiguration event with the passed in file name.
Protected Member Functions
virtual void	OnResettingConfiguration (EventArgs args)
	Raises the ResettingConfiguration event with the passed in parameters.
virtual void	OnSavingConfiguration (CuiDockableContentConfigEventArgs args)
	Raises the SavingConfiguration event with the passed in parameters.
virtual void	OnLoadingConfiguration (CuiDockableContentConfigEventArgs args)
	Raises the LoadingConfiguration event with the passed in parameters.
Properties
abstract string	WindowTitle `[get]`
	The name that the CUIFrame should assume.
abstract Type	ContentType `[get]`
	The Type of the user control that is created by this action.
virtual bool	InvalidateOnMoved `[get]`
	Return true if moving the CUIFrame should Invalidate the user control and force a repaint.
virtual bool	DestroyOnClose `[get, set]`
	Return true if, when the CUIFrame dialog is closed, it should call DestroyWindow() on itself.
virtual DockStates.Dock	DockingModes `[get]`
	The dock modes that this control supports.
abstract string	ActionText `[get]`
	The name of the action - to be used when browsing a list of actions.
abstract string	Category `[get]`
	The name of the category to which this action should belong.
abstract string	InternalActionText `[get]`
	This is internal text that is not used in the user interface anywhere, but is used to uniquely identify the action.
abstract string	InternalCategory `[get]`
	This is internal text that is not used in the user interface anywhere, but is used to uniquely identify the action category.
abstract string	ButtonText `[get]`
	The text that will be used if the action is instantiated in a toolbar button.
virtual string	MenuText `[get]`
	The text that will be used if the action is instantiated in the application menu or a quad-menu.
virtual bool	IsVisible `[get]`
	Marks whether this action should appear in a menu.
virtual bool	IsEnabled `[get]`
	Marks when this action should be available for use.
virtual bool	IsChecked `[get]`
	Implement this method if the action is "checked" (which means that the UI will show the button as pressed, or the menu item as checked.)
Events
EventHandler< EventArgs >	ResettingConfiguration
	This should be raised when this component is asked to reset its configuration to factory defaults.
EventHandler < CuiDockableContentConfigEventArgs >	SavingConfiguration
	This should be raised when this component is currently saving out its current state.
EventHandler < CuiDockableContentConfigEventArgs >	LoadingConfiguration
	This should be raised when this component is currently loading in a persisted state.

Constructor & Destructor Documentation

MaxCustomControls::CuiDockableContentAdapter::CuiDockableContentAdapter ( ) [inline]

Constructor - initializes the DestroyOnClose property to true.

Member Function Documentation

abstract object MaxCustomControls::CuiDockableContentAdapter::CreateDockableContent ( ) [pure virtual]

This method is called by the managed assembly loading process process when it is ready to create and show the managed user control.

Returns:: An instance of the Control to create and place as the root object in a CUIFrame.

Implements MaxCustomControls::ICuiDockableContent.

virtual void MaxCustomControls::CuiDockableContentAdapter::SetContentDockMode	(	object	dockableContent,
		DockStates.Dock	dockMode
	)		`[inline, virtual]`

This is a callback function that 3ds Max calls when the CUI frame is docked or floated from the main application frame.

By default, this fucntion does nothing. Implement this method to notify content of docking changes.

Parameters:

dockableContent	An instance of a Control returned by CreateDockableContent().
dockMode	The new dock state of the CUIFrame.

See also:: CreateDockableContent()

void MaxCustomControls::CuiDockableContentAdapter::RaiseResettingConfiguration ( ) [inline]

Raises the ResettingConfiguration event.

virtual void MaxCustomControls::CuiDockableContentAdapter::OnResettingConfiguration ( EventArgs args ) [inline, protected, virtual]

Raises the ResettingConfiguration event with the passed in parameters.

Parameters:

args	normally EventArgs.Empty

void MaxCustomControls::CuiDockableContentAdapter::RaiseSavingConfiguration ( String aFilename ) [inline]

Raises the SavingConfiguration event with the passed in file name.

Parameters:

aFilename The full path of the file where the configuration is being saved.

virtual void MaxCustomControls::CuiDockableContentAdapter::OnSavingConfiguration ( CuiDockableContentConfigEventArgs args ) [inline, protected, virtual]

Raises the SavingConfiguration event with the passed in parameters.

Parameters:

args	EventArgs that store the target filename

void MaxCustomControls::CuiDockableContentAdapter::RaiseLoadingConfiguration ( String aFilename ) [inline]

Raises the LoadingConfiguration event with the passed in file name.

Parameters:

aFilename The full path of the file where the configuration is being loaded from.

virtual void MaxCustomControls::CuiDockableContentAdapter::OnLoadingConfiguration ( CuiDockableContentConfigEventArgs args ) [inline, protected, virtual]

Raises the LoadingConfiguration event with the passed in parameters.

Parameters:

args	EventArgs that store the target filename

Property Documentation

abstract string MaxCustomControls::CuiDockableContentAdapter::WindowTitle [get]

The name that the CUIFrame should assume.

This property should be localizable.

See also:: ICuiDockableContent

Implements MaxCustomControls::ICuiDockableContent.

abstract Type MaxCustomControls::CuiDockableContentAdapter::ContentType [get]

The Type of the user control that is created by this action.

See also:: ICuiDockableContent

Implements MaxCustomControls::ICuiDockableContent.

virtual bool MaxCustomControls::CuiDockableContentAdapter::InvalidateOnMoved [get]

Return true if moving the CUIFrame should Invalidate the user control and force a repaint.

See also:: ICuiDockableContent

Implements MaxCustomControls::ICuiDockableContent.

virtual bool MaxCustomControls::CuiDockableContentAdapter::DestroyOnClose [get, set]

Return true if, when the CUIFrame dialog is closed, it should call DestroyWindow() on itself.

Alternatively, if false is returned here, the window will simply be closed, but not destroyed. This would be useful if the content is expensive to create.

The default implementation does destroy the content on close.

See also:: ICuiDockableContent

Implements MaxCustomControls::ICuiDockableContent.

virtual DockStates.Dock MaxCustomControls::CuiDockableContentAdapter::DockingModes [get]

The dock modes that this control supports.

By default, this property is implemented to only return the Top docking position as a possible dock mode.

Implements MaxCustomControls::ICuiDockableContent.

abstract string MaxCustomControls::CuiDockableContentAdapter::ActionText [get]

The name of the action - to be used when browsing a list of actions.

Required for ICuiAction.

See also:: ICuiAction

Implements MaxCustomControls::ICuiAction.

abstract string MaxCustomControls::CuiDockableContentAdapter::Category [get]

The name of the category to which this action should belong.

Required for ICuiAction.

See also:: ICuiAction

Implements MaxCustomControls::ICuiAction.

abstract string MaxCustomControls::CuiDockableContentAdapter::InternalActionText [get]

This is internal text that is not used in the user interface anywhere, but is used to uniquely identify the action.

This text should be identical across all localized versions of the product.

Required for ICuiAction.

See also:: ICuiAction

Implements MaxCustomControls::ICuiAction.

abstract string MaxCustomControls::CuiDockableContentAdapter::InternalCategory [get]

This is internal text that is not used in the user interface anywhere, but is used to uniquely identify the action category.

This text should be identical across all localized versions of the product.

Required for ICuiAction.

See also:: ICuiAction

Implements MaxCustomControls::ICuiAction.

abstract string MaxCustomControls::CuiDockableContentAdapter::ButtonText [get]

The text that will be used if the action is instantiated in a toolbar button.

By default implementation is to forward ActionText as the result.

Implements MaxCustomControls::ICuiAction.

virtual string MaxCustomControls::CuiDockableContentAdapter::MenuText [get]

The text that will be used if the action is instantiated in the application menu or a quad-menu.

By default implementation is to forward ActionText as the result.

Implements MaxCustomControls::ICuiAction.

virtual bool MaxCustomControls::CuiDockableContentAdapter::IsVisible [get]

Marks whether this action should appear in a menu.

This condition is evaluated whenever a menu is shown - meaning the result can be dynamic.

By default implementation is to return true.

Implements MaxCustomControls::ICuiAction.

virtual bool MaxCustomControls::CuiDockableContentAdapter::IsEnabled [get]

Marks when this action should be available for use.

This condition is evaluated whenever a menu is shown - meaning the result can be dynamic. If False, an item will appear "grayed out".

By default implementation is to return true.

Implements MaxCustomControls::ICuiAction.

virtual bool MaxCustomControls::CuiDockableContentAdapter::IsChecked [get]

Implement this method if the action is "checked" (which means that the UI will show the button as pressed, or the menu item as checked.)

By default implementation is to return false.

Implements MaxCustomControls::ICuiAction.

Event Documentation

EventHandler<EventArgs> MaxCustomControls::CuiDockableContentAdapter::ResettingConfiguration

This should be raised when this component is asked to reset its configuration to factory defaults.

Implements MaxCustomControls::ICuiDockableContent.

EventHandler<CuiDockableContentConfigEventArgs> MaxCustomControls::CuiDockableContentAdapter::SavingConfiguration

This should be raised when this component is currently saving out its current state.

Implements MaxCustomControls::ICuiDockableContent.

EventHandler<CuiDockableContentConfigEventArgs> MaxCustomControls::CuiDockableContentAdapter::LoadingConfiguration

This should be raised when this component is currently loading in a persisted state.

Implements MaxCustomControls::ICuiDockableContent.

MaxCustomControls::CuiDockableContentAdapter Class Reference

Detailed Description

Public Member Functions

Protected Member Functions

Properties

Events

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation

Event Documentation