class CCL::PlugInClass

Overview

#include <pluginclass.h>

class PlugInClass: public CCL::Object
{
public:
    // fields

    StringRef name = nullptr;
    StringRef StringRef category = nullptr);
     menuPriority;

    // construction

    PlugInClass (const IClassDescription& description);

    // methods

    DECLARE_CLASS (PlugInClass, Object);
    PROPERTY_OBJECT (UID, classID, ClassID);
    Name PROPERTY_STRING (category, Category);
    Name SubCategory void assign (const IClassDescription& description);
    void parseClassName (StringRef className);
    void setCategories (const PlugInCategory& categories);
    void getPresetMetaInfo (IAttributeList& attr) const;
    IImage* getExactIcon (bool withSubCategory = true) const;
    IImage* getCategoryIcon () const;
    IImage* getIcon (bool exact = false) const;
    String getClassVendor () const;
    String getClassFolder () const;
    PROPERTY_STRING (title, Title);
    MenuPriority String makeTitleWithVendor () const;
    void setClassAttribute (StringID id, VariantRef value);
    bool getClassAttribute (Variant& value, StringID id) const;
    String getClassAttributeString (StringID id) const;
    virtual bool toString (String& string, int flags = 0) const;
    virtual bool equals (const Object& obj) const;
    virtual int compare (const Object& obj) const;
    virtual bool load (const Storage& storage);
    virtual bool save (const Storage& storage) const;
};

Inherited Members

public:
    // typedefs

    typedef CStringRef MemberID;

    // 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;
    Unknown& operator = (const Unknown&);
    unsigned int getRetainCount () const;
    virtual Object*CCL_API revealObject (const void* moduleAddress) = 0;
    virtual void CCL_API addObserver (IObserver* observer) = 0;
    virtual void CCL_API removeObserver (IObserver* observer) = 0;
    virtual void CCL_API signal (MessageRef msg) = 0;
    virtual void CCL_API deferSignal (IMessage* msg) = 0;
    static ISubject void addObserver (IUnknown* unknown, IObserver* observer);
    static void removeObserver (IUnknown* unknown, IObserver* observer);
    virtual void CCL_API notify (ISubject* subject, MessageRef msg) = 0;

    static IObserver void notify (
        IUnknown* unknown,
        ISubject* subject,
        MessageRef msg
    );

    virtual const ITypeInfo&CCL_API getTypeInfo () const = 0;
    virtual tbool CCL_API getProperty (Variant& var, MemberID propertyId) const = 0;
    virtual tbool CCL_API setProperty (MemberID propertyId, const Variant& var) = 0;
    virtual tbool CCL_API getPropertyNames (IPropertyCollector& collector) const = 0;
    virtual tbool CCL_API invokeMethod (Variant& returnValue, MessageRef msg) = 0;
    DECLARE_BASE_CLASS (Object);
    virtual void CCL_API removeObserver (IObserver* observer);
    virtual void CCL_API signal (MessageRef msg);
    virtual void CCL_API deferSignal (IMessage* msg);
    virtual void deferChanged ();
    virtual void CCL_API notify (ISubject* subject, MessageRef msg);
    virtual bool equals (const Object& obj) const;
    virtual int compare (const Object& obj) const;
    virtual bool load (const Storage& storage);
    virtual bool save (const Storage& storage) const;
    virtual bool save (const OutputStorage& storage) const;
    virtual bool toString (String& string, int flags = 0) const;
    virtual int getHashCode (int size) const;
    IUnknown* asUnknown ();
    static void addGarbageCollected (Object* obj, bool globalScope = true);
    static void deferDestruction (Object* obj);
    static const void* getModuleAddress ();

Detailed Documentation

Methods

void parseClassName (StringRef className)

UID string or “category:name”.

IImage* getIcon (bool exact = false) const

get icon from main theme

String getClassVendor () const

get class vendor from plug-in manager

String getClassFolder () const

get class folder from plug-in manager

MenuPriority String makeTitleWithVendor () const

< sorting order in menus (optional)

vendor name and title