struct CCL::ICommandEditor

Overview

#include <icommandeditor.h>

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

    virtual tresult CCL_API run () = 0;
    virtual void CCL_API init (const CommandDescription& command) = 0;
    virtual void CCL_API apply () = 0;
    virtual tbool CCL_API load (UrlRef path) = 0;
    virtual tbool CCL_API save (UrlRef path) const = 0;
    virtual IUnknownIterator*CCL_API newCategoryIterator () const = 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

Methods

virtual tresult CCL_API run () = 0

Run command editor modal dialog.

virtual void CCL_API init (const CommandDescription& command) = 0

Initialize editor state (non-modal usage).

virtual void CCL_API apply () = 0

Apply editor state to command table (non-modal usage).

virtual tbool CCL_API load (UrlRef path) = 0

Load commands from file.

virtual tbool CCL_API save (UrlRef path) const = 0

Save commands to file.

virtual IUnknownIterator*CCL_API newCategoryIterator () const = 0

Create iterator of ICommandCategory objects currently in editor.