struct CCL::IClassDescription

Overview

#include <ipluginmanager.h>

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

    virtual UIDRef CCL_API getClassID () const = 0;
    virtual int CCL_API getClassFlags () const = 0;
    virtual StringRef CCL_API getCategory () const = 0;
    virtual StringRef CCL_API getName () const = 0;
    virtual StringRef CCL_API getSubCategory () const = 0;
    virtual StringRef CCL_API getDescription () const = 0;
    virtual void CCL_API clone (IClassDescription*&) const = 0;
    virtual const IVersionDescription&CCL_API getModuleVersion () const = 0;
    virtual tbool CCL_API getClassAttribute (Variant& value, StringID id) const = 0;
    virtual tbool CCL_API getClassAttributes (IAttributeList& a) const = 0;
    virtual void CCL_API getLocalizedName (String& name) const = 0;
    virtual void CCL_API getLocalizedDescription (String& description) const = 0;
    virtual void CCL_API getLocalizedSubCategory (String& subCategory) const = 0;
    virtual void CCL_API getClassUrl (IUrl& url) const = 0;
    virtual StringID CCL_API getCodeResourceType () 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 UIDRef CCL_API getClassID () const = 0

Get unique class identifier.

virtual int CCL_API getClassFlags () const = 0

Get class flags.

virtual StringRef CCL_API getCategory () const = 0

Get class category.

virtual StringRef CCL_API getName () const = 0

Get class name.

virtual StringRef CCL_API getSubCategory () const = 0

Get subcategory.

virtual StringRef CCL_API getDescription () const = 0

Get description.

virtual void CCL_API clone (IClassDescription*&) const = 0

Clone object.

virtual const IVersionDescription&CCL_API getModuleVersion () const = 0

Get version of module this class resides in.

virtual tbool CCL_API getClassAttribute (Variant& value, StringID id) const = 0

Get class attribute by identifier (current language).

virtual tbool CCL_API getClassAttributes (IAttributeList& a) const = 0

Copy all class attributes (current language).

virtual void CCL_API getLocalizedName (String& name) const = 0

Get a possibly localized class name.

virtual void CCL_API getLocalizedDescription (String& description) const = 0

Get a possibly localized class description.

virtual void CCL_API getLocalizedSubCategory (String& subCategory) const = 0

Get a possibly localized subcategory.

virtual void CCL_API getClassUrl (IUrl& url) const = 0

Make class URL for this class.

virtual StringID CCL_API getCodeResourceType () const = 0

Get type of code resource (native, script).