MaxCustomControls::FilterDescription Class Reference

---

Detailed Description

The internal filter description class for the filter of a filter-toolbar.

FilterDescription contains additional initialization info of a filter toggle button corresponding to a given filter.

List of all members.

Public Member Functions
	FilterDescription (String description, IFilterItem filter, MultiIcon icon)
	Default constructor of FilterDescription.
	FilterDescription (String description, IFilterItem filter, MultiIcon icon, bool invertDisplay)
	Default constructor of FilterDescription.
Properties
String	Description [get]
	Description of the filter.
IFilterItem	Filter [get]
	The filter this description aims for.
MultiIcon	FilterToggleButtonIcon [get]
	Icon resource of the corresponding filter toggle button for the filter.
bool	InvertDisplay [get]
	Whether the display of the enabled state of this filter should be inverted.

---

Constructor & Destructor Documentation

MaxCustomControls::FilterDescription::FilterDescription	(	String	description,
		IFilterItem	filter,
		MultiIcon	icon
	)		[inline]

Default constructor of FilterDescription.

Parameters:

description	Description of the filter.
filter	The filter.
icon	Icon resource for the corresponding filter toggle button.

MaxCustomControls::FilterDescription::FilterDescription	(	String	description,
		IFilterItem	filter,
		MultiIcon	icon,
		bool	invertDisplay
	)		[inline]

Default constructor of FilterDescription.

Parameters:

description	Description of the filter.
filter	The filter.
icon	Icon resource for the corresponding filter toggle button.
invertDisplay	Whether the display of the enabled state of this filter should be inverted.

---

Property Documentation

String MaxCustomControls::FilterDescription::Description [get]

Description of the filter.

IFilterItem MaxCustomControls::FilterDescription::Filter [get]

The filter this description aims for.

MultiIcon MaxCustomControls::FilterDescription::FilterToggleButtonIcon [get]

Icon resource of the corresponding filter toggle button for the filter.

bool MaxCustomControls::FilterDescription::InvertDisplay [get]

Whether the display of the enabled state of this filter should be inverted.