class CCL::EditTaskDescription

Overview

Edit task description. More…

#include <edittaskdescription.h>

class EditTaskDescription: public CCL::Object
{
public:
    // classes

    class Category;
    class MenuGroup;
    class Registrar;

    // construction

    EditTaskDescription (const IClassDescription& description);

    // methods

    DECLARE_CLASS (EditTaskDescription, Object);
    void assign (const IClassDescription& description);
    PROPERTY_OBJECT (UID, cid, ClassID);
    Category PROPERTY_STRING (localizedName, LocalizedName);
    Category LocalizedDescription PROPERTY_MUTABLE_CSTRING (name, Name);

    Category LocalizedDescription CommandCategory PROPERTY_MUTABLE_CSTRING (
        aliasCommandName,
        AliasCommandName
    );

    Category LocalizedDescription CommandCategory MenuGroupName PROPERTY_VARIABLE (
        int,
        menuPriority,
        MenuPriority
    );

    Category LocalizedDescription CommandCategory MenuGroupName MenuFollow PROPERTY_BOOL (
        hiddenCommand,
        HiddenCommand
    );

    const MenuGroup* getMenuGroup () const;
    const Attributes& getAttributes () const;
    MutableCString getCommandArguments () const;
    bool isHidden () const;
    bool hasOption (StringID id) const;
    virtual int compare (const Object& obj) const;
    virtual bool toString (String& string, int flags = 0) const;

    static Category* defineCategory (
        StringRef name,
        const LocalString& translation,
        StringRef description = nullptr
    );

    static MenuGroup* defineMenuGroup (
        StringID id,
        StringRef title = nullptr,
        int priority = 0
    );

    static CommandWithTitle getTaskCommandWithTitle (MetaClassRef taskClass);
};

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

Edit task description.

Methods

bool isHidden () const

hidden in menu

static Category* defineCategory (
    StringRef name,
    const LocalString& translation,
    StringRef description = nullptr
)

define task category

static MenuGroup* defineMenuGroup (
    StringID id,
    StringRef title = nullptr,
    int priority = 0
)

define menu group