C++ API Library Reference  4.3.2-74-ge1d4cca
Public Functions | List of all members
ICommandFilter Class Referenceabstract

The ICommandFilter interface is used to implement command filters; these filters aggregate redundant input events within views. The default implementation is DefaultCommandFilter. Changing the default is rare.

Public Functions

virtual void FilterCommands (CSI::Collections::IList< Typeless > &commands)=0
 
Constructors and Destructors
virtual ~ICommandFilter ()
 

Usage Description

virtual void FilterCommands ( CSI::Collections::IList< Typeless > &  commands)
pure virtual

Filters the specified list of commands. Commands that do not pass the filter may be replaced with NullCommand, or they may be removed from the list, at the filter's discretion.

This method will be called by the PureWeb event loop, after the filter is installed through SetCommandFilter.

Parameters
commandsList of incoming commands to filter.