struct CCL::ICommandParameter

Overview

Instead of IParamObserver::paramChanged, this parameter class generates a command message. More…

#include <iparameter.h>

struct ICommandParameter: public CCL::IUnknown
{
    // methods

    virtual StringID CCL_API getCommandCategory () const = 0;
    virtual StringID CCL_API getCommandName () const = 0;
    virtual void CCL_API setCommand (StringID category, StringID name) = 0;
    virtual tbool CCL_API checkEnabled () = 0;
};

Inherited Members

public:
    // methods

    virtual tresult CCL_API queryInterface (UIDRef iid, void** ptr) = 0;
    virtual unsigned int CCL_API retain () = 0;
    virtual unsigned int CCL_API release () = 0;

Detailed Documentation

Instead of IParamObserver::paramChanged, this parameter class generates a command message.

The associated controller has to implement ICommandHandler::interpretCommand.

Methods

virtual StringID CCL_API getCommandCategory () const = 0

Get command category.

virtual StringID CCL_API getCommandName () const = 0

Get command name.

virtual void CCL_API setCommand (StringID category, StringID name) = 0

Set command category and name.

virtual tbool CCL_API checkEnabled () = 0

Enable if command is executable.