class CCL::Message

Overview

Message class. More…

#include <message.h>

class Message:
    public CCL::Object,
    public CCL::IMessage
{
public:
    // fields

     IMessage;

    // construction

    Message (StringID id = nullptr);
    Message (StringID id, VariantRef arg0);
    Message (StringID id, VariantRef arg0, VariantRef arg1);
    Message (StringID id, VariantRef arg0, VariantRef arg1, VariantRef arg2);

    Message (
        StringID id,
        VariantRef arg0,
        VariantRef arg1,
        VariantRef arg2,
        VariantRef arg3
    );

    Message (StringID id, const Variant args [], int count);
    Message (MessageRef other);
    Message (const Message& other);

    // methods

    DECLARE_CLASS (Message, Object);
    void post (IObserver* observer, int delay = 0);
    void postBlocking (IObserver* observer);
    void setID (StringID id);
    void setArg (int index, VariantRef arg);
    void setArgCount (int count);
    bool appendArg (VariantRef arg);
    Message& operator << (VariantRef arg);
    virtual StringID CCL_API getID () const;
    virtual int CCL_API getArgCount () const;
    virtual VariantRef CCL_API getArg (int index) 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 ();
    virtual StringID CCL_API getID () const = 0;
    virtual int CCL_API getArgCount () const = 0;
    virtual VariantRef CCL_API getArg (int index) const = 0;
    IMessage bool operator == (CStringPtr id) const;
    bool operator != (CStringPtr id) const;
    bool operator == (StringID id) const;
    bool operator != (StringID id) const;
    const Variant& operator [] (int index) const;

Detailed Documentation

Message class.

Methods

virtual StringID CCL_API getID () const

Get message identifier.

virtual int CCL_API getArgCount () const

Get number of arguments.

virtual VariantRef CCL_API getArg (int index) const

Get argument at index.