struct CCL::IHelpInfoBuilder

Overview

#include <ihelpmanager.h>

struct IHelpInfoBuilder: public CCL::IUnknown
{
    // enums

    enum AttrID;

    // methods

    virtual void CCL_API setAttribute (AttrID id, VariantRef value) = 0;
    virtual void CCL_API addOption (uint32 modifiers, IImage* icon, StringRef text) = 0;

    virtual void CCL_API addOption (
        uint32 modifiers,
        StringID iconName,
        StringRef text
    ) = 0;

    virtual void CCL_API setActiveOption (uint32 modifiers) = 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 void CCL_API setAttribute (AttrID id, VariantRef value) = 0

Set attribute.

virtual void CCL_API addOption (uint32 modifiers, IImage* icon, StringRef text) = 0

Add modifier option.

virtual void CCL_API addOption (
    uint32 modifiers,
    StringID iconName,
    StringRef text
) = 0

Add modifier option.

virtual void CCL_API setActiveOption (uint32 modifiers) = 0

Hilite option with given modifiers.