struct CCL::ICommandBarModel

Overview

#include <icommandeditor.h>

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

    virtual ICommandBarItem*CCL_API getItemByID (StringRef id) const = 0;
    virtual ICommandBarItem*CCL_API getParentItem (ICommandBarItem* item) const = 0;

    virtual const ICommandBarItem*CCL_API addCommandItem (
        StringRef type,
        StringRef title,
        const ICommandBarItem* parentItem = nullptr,
        int index = -1
    ) = 0;

    virtual tbool CCL_API removeCommandItem (ICommandBarItem* item) = 0;

    virtual tbool CCL_API setItemProperty (
        const ICommandBarItem* item,
        CStringRef propertyId,
        const Variant& var
    ) = 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 ICommandBarItem*CCL_API getItemByID (StringRef id) const = 0

Get command bar item by id.

virtual ICommandBarItem*CCL_API getParentItem (ICommandBarItem* item) const = 0

Get parent of given item.

virtual const ICommandBarItem*CCL_API addCommandItem (
    StringRef type,
    StringRef title,
    const ICommandBarItem* parentItem = nullptr,
    int index = -1
) = 0

Add a command bar item.

virtual tbool CCL_API removeCommandItem (ICommandBarItem* item) = 0

Remove a command bar item.

virtual tbool CCL_API setItemProperty (
    const ICommandBarItem* item,
    CStringRef propertyId,
    const Variant& var
) = 0

Set a property of an item.

Suppoprted properties: title, icon, commandCategory, commandName.