MaxCustomControls::SceneExplorerControls::ManageSceneExplorerForm Class Reference

---

Detailed Description

Form enabling the user to add, delete, load, save, and rename Scene Explorers.

Inheritance diagram for MaxCustomControls::SceneExplorerControls::ManageSceneExplorerForm:

List of all members.

Classes
class	InstanceEventArgs
	EventArgs for events pertaining to Explorer instances. More...
Public Member Functions
	ManageSceneExplorerForm ()
	Initialize a new instance of this class.
void	SetListItems (Object[] items)
	Set the items appearing in this form's list of explorers.
void	RequestActivateInstance (String aInstanceName)
	Raises the ActivateInstance event.
void	RequestDeleteInstance (String aInstanceName)
	Raises the DeleteInstance event.
void	RequestRenameInstance (String aInstanceName, String aRenameTo)
	Raises the RenameInstance event.
void	RequestSaveInstance (String aInstanceName)
	Raises the SaveInstance event.
void	RequestLoadInstance ()
	Raises the LoadInstance event.
void	RequestSetInstanceAsDefault (String aInstanceName)
	Raises the SetInstanceAsDefault event.
Protected Member Functions
virtual void	OnCheckInstanceDeletable (InstanceEventArgs e)
	Raise the CheckInstanceDeletable event.
bool	IsInstanceDeletable (String aInstanceName)
	Check whether one instance is deletable.
virtual void	OnActivateInstance (InstanceEventArgs e)
	Raises the ActivateInstance event.
virtual void	OnDeleteInstance (InstanceEventArgs e)
	Raises the DeleteInstance event.
virtual void	OnRenameInstance (InstanceEventArgs e)
	Raises the RenameInstance event.
virtual void	OnSaveInstance (InstanceEventArgs e)
	Raises the SaveInstance event.
virtual void	OnLoadInstance (EventArgs e)
	Raises the LoadInstance event.
virtual void	OnSetInstanceAsDefault (InstanceEventArgs e)
	Raises the SetInstanceAsDefault event.
override void	Dispose (bool disposing)
	Clean up any resources being used.
Properties
String	StatusText [get, set]
	Text displayed in the status bar at the bottom of this form.
Events
EventHandler< InstanceEventArgs >	ActivateInstance
	Occurs when the user double-clicks an instance name.
EventHandler< InstanceEventArgs >	CheckInstanceDeletable
	Occurs when user need to check whether one instance is deletable.
EventHandler< InstanceEventArgs >	DeleteInstance
	Occurs when the user clicks the delete button.
EventHandler< InstanceEventArgs >	RenameInstance
	Occurs when the user clicks the rename button and enters a new name.
EventHandler< InstanceEventArgs >	SaveInstance
	Occurs when the user clicks the Save button.
EventHandler< EventArgs >	LoadInstance
	Occurs when the user clicks the Load button.
EventHandler< InstanceEventArgs >	SetInstanceAsDefault
	Occurs when the user clicks the "Set as Default" butotn.

---

Constructor & Destructor Documentation

MaxCustomControls::SceneExplorerControls::ManageSceneExplorerForm::ManageSceneExplorerForm

(

)

[inline]

Initialize a new instance of this class.

---

Member Function Documentation

void MaxCustomControls::SceneExplorerControls::ManageSceneExplorerForm::SetListItems

(

Object[]

items

)

[inline]

Set the items appearing in this form's list of explorers.

Parameters:

items

Items to put in the form's list.

virtual void MaxCustomControls::SceneExplorerControls::ManageSceneExplorerForm::OnCheckInstanceDeletable

(

InstanceEventArgs

e

)

[inline, protected, virtual]

Raise the CheckInstanceDeletable event.

Parameters:

e	Data about the event, including the name of the instance affected by this event. The deletable state is to be set by the delegate.

bool MaxCustomControls::SceneExplorerControls::ManageSceneExplorerForm::IsInstanceDeletable

(

String

aInstanceName

)

[inline, protected]

Check whether one instance is deletable.

Parameters:

aInstanceName

Name of the instance to be checked.

virtual void MaxCustomControls::SceneExplorerControls::ManageSceneExplorerForm::OnActivateInstance

(

InstanceEventArgs

e

)

[inline, protected, virtual]

Raises the ActivateInstance event.

Parameters:

e	Data about the event, including the name of the instance affected by this event.

void MaxCustomControls::SceneExplorerControls::ManageSceneExplorerForm::RequestActivateInstance

(

String

aInstanceName

)

[inline]

Raises the ActivateInstance event.

Parameters:

aInstanceName

Name of the explorer instance affected by this event.

virtual void MaxCustomControls::SceneExplorerControls::ManageSceneExplorerForm::OnDeleteInstance

(

InstanceEventArgs

e

)

[inline, protected, virtual]

Raises the DeleteInstance event.

Parameters:

e	Data about the event, including the name of the instance affected by this event.

void MaxCustomControls::SceneExplorerControls::ManageSceneExplorerForm::RequestDeleteInstance

(

String

aInstanceName

)

[inline]

Raises the DeleteInstance event.

Parameters:

aInstanceName

Name of the explorer instance affected by this event.

virtual void MaxCustomControls::SceneExplorerControls::ManageSceneExplorerForm::OnRenameInstance

(

InstanceEventArgs

e

)

[inline, protected, virtual]

Raises the RenameInstance event.

Parameters:

e	Data about the event, including the name of the instance affected by this event and its new name.

void MaxCustomControls::SceneExplorerControls::ManageSceneExplorerForm::RequestRenameInstance	(	String	aInstanceName,
		String	aRenameTo
	)		[inline]

Raises the RenameInstance event.

Parameters:

aInstanceName	Name of the explorer instance affected by this event.
aRenameTo

virtual void MaxCustomControls::SceneExplorerControls::ManageSceneExplorerForm::OnSaveInstance

(

InstanceEventArgs

e

)

[inline, protected, virtual]

Raises the SaveInstance event.

Parameters:

e	Data about the event, including the name of the instance affected by this event.

void MaxCustomControls::SceneExplorerControls::ManageSceneExplorerForm::RequestSaveInstance

(

String

aInstanceName

)

[inline]

Raises the SaveInstance event.

Parameters:

aInstanceName

Name of the explorer instance affected by this event.

virtual void MaxCustomControls::SceneExplorerControls::ManageSceneExplorerForm::OnLoadInstance

(

EventArgs

e

)

[inline, protected, virtual]

Raises the LoadInstance event.

Parameters:

e	Data about this event. Usually EventArgs.Empty.

void MaxCustomControls::SceneExplorerControls::ManageSceneExplorerForm::RequestLoadInstance

(

)

[inline]

Raises the LoadInstance event.

virtual void MaxCustomControls::SceneExplorerControls::ManageSceneExplorerForm::OnSetInstanceAsDefault

(

InstanceEventArgs

e

)

[inline, protected, virtual]

Raises the SetInstanceAsDefault event.

Parameters:

e	Data about the event, including the name of the instance affected by this event.

void MaxCustomControls::SceneExplorerControls::ManageSceneExplorerForm::RequestSetInstanceAsDefault

(

String

aInstanceName

)

[inline]

Raises the SetInstanceAsDefault event.

Parameters:

aInstanceName

Name of the explorer instance affected by this event.

override void MaxCustomControls::SceneExplorerControls::ManageSceneExplorerForm::Dispose

(

bool

disposing

)

[inline, protected]

Clean up any resources being used.

Parameters:

disposing

true if managed resources should be disposed; otherwise, false.

Reimplemented from MaxCustomControls::MaxForm.

---

Property Documentation

String MaxCustomControls::SceneExplorerControls::ManageSceneExplorerForm::StatusText [get, set]

Text displayed in the status bar at the bottom of this form.

---

Event Documentation

EventHandler<InstanceEventArgs> MaxCustomControls::SceneExplorerControls::ManageSceneExplorerForm::ActivateInstance

Occurs when the user double-clicks an instance name.

EventHandler<InstanceEventArgs> MaxCustomControls::SceneExplorerControls::ManageSceneExplorerForm::CheckInstanceDeletable

Occurs when user need to check whether one instance is deletable.

EventHandler<InstanceEventArgs> MaxCustomControls::SceneExplorerControls::ManageSceneExplorerForm::DeleteInstance

Occurs when the user clicks the delete button.

EventHandler<InstanceEventArgs> MaxCustomControls::SceneExplorerControls::ManageSceneExplorerForm::RenameInstance

Occurs when the user clicks the rename button and enters a new name.

EventHandler<InstanceEventArgs> MaxCustomControls::SceneExplorerControls::ManageSceneExplorerForm::SaveInstance

Occurs when the user clicks the Save button.

EventHandler<EventArgs> MaxCustomControls::SceneExplorerControls::ManageSceneExplorerForm::LoadInstance

Occurs when the user clicks the Load button.

EventHandler<InstanceEventArgs> MaxCustomControls::SceneExplorerControls::ManageSceneExplorerForm::SetInstanceAsDefault

Occurs when the user clicks the "Set as Default" butotn.