class CCL::ToolItem

Overview

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

    Name icon;
    Name Icon modeParam;

    // construction

    ToolItem (const EditToolMode& mode);

    // methods

    DECLARE_CLASS_ABSTRACT (ToolItem, Object) const;
    PROPERTY_STRING (title, Title);
    Name PROPERTY_MUTABLE_CSTRING (iconName, IconName);
    Name Icon PROPERTY_BOOL (ignoresModeIcons, IgnoresModeIcons);
    Name Icon ModeParam void addModes (const EditTool& tool);
    int getModeCount () const;
    const ToolItem* getMode (int index) const;
    IImage* getToolIcon (ITheme* theme) const;
    bool equals (const Object& obj) const;
    bool toString (String& string, int flags = 0) 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

Name PROPERTY_MUTABLE_CSTRING (iconName, IconName)

< internal tool name

Name Icon PROPERTY_BOOL (ignoresModeIcons, IgnoresModeIcons)

< icon (icon name is ignored when icon is set)

bool equals (const Object& obj) const

compares with an EditTool by name!