MaxCustomControls::CommandSystem::ToggleFilterCommand Class Reference

---

Detailed Description

This command aims for toggling a filter.

Inheritance diagram for MaxCustomControls::CommandSystem::ToggleFilterCommand:

List of all members.

Public Member Functions
override bool	IsValid ()
	Are the operands for this Command in a valid state for it to Execute?
override void	Execute ()
	Run this command.
Static Public Member Functions
static ToggleFilterCommand	Create (String name, IFilterItem filter)
	Creates a new ToggleFilterCommand.
Protected Member Functions
override bool	IsChecked ()
	Get the internal check state.
	ToggleFilterCommand (String name, IFilterItem filter)
	The default constructor.
Properties
override string	Name [get]
	This Command's internationalized name.
IFilterItem	Filter [get]
FilterModel	FilterModel [get]

---

Constructor & Destructor Documentation

MaxCustomControls::CommandSystem::ToggleFilterCommand::ToggleFilterCommand	(	String	name,
		IFilterItem	filter
	)		[inline, protected]

The default constructor.

Parameters:

name	Internationalized name of this command.
filter	The filter of this command.

---

Member Function Documentation

static ToggleFilterCommand MaxCustomControls::CommandSystem::ToggleFilterCommand::Create	(	String	name,
		IFilterItem	filter
	)		[inline, static]

Creates a new ToggleFilterCommand.

Parameters:

name	The name of this command.
filter	The filter of this command.

Returns:

The resultant filter.

Reimplemented in MaxCustomControls::CommandSystem::InvertToggleFilterCommand.

override bool MaxCustomControls::CommandSystem::ToggleFilterCommand::IsValid

(

)

[inline]

Are the operands for this Command in a valid state for it to Execute?

Returns:

Returns true if the filter corresponding to the specified filter key exists. Returns false otherwise.

Reimplemented from MaxCustomControls::CommandSystem::StubCommand.

override void MaxCustomControls::CommandSystem::ToggleFilterCommand::Execute

(

)

[inline]

Run this command.

override bool MaxCustomControls::CommandSystem::ToggleFilterCommand::IsChecked

(

)

[inline, protected, virtual]

Get the internal check state.

Returns:

Returns true if this filter is enabled, returns false otherwise.

Implements MaxCustomControls::CommandSystem::CheckableCommand.

Reimplemented in MaxCustomControls::CommandSystem::InvertToggleFilterCommand.

---

Property Documentation

override string MaxCustomControls::CommandSystem::ToggleFilterCommand::Name [get]

This Command's internationalized name.

IFilterItem MaxCustomControls::CommandSystem::ToggleFilterCommand::Filter [get, protected]

FilterModel MaxCustomControls::CommandSystem::ToggleFilterCommand::FilterModel [get, protected]