class CCL::ObjectConverter

Overview

Converter singleton. More…

#include <objectconverter.h>

class ObjectConverter:
    public CCL::Object,
    public CCL::IObjectConverter,
    public CCL::Singleton
{
public:
    // fields

    CLASS_INTERFACES (Object) protected LinkedList <IImportFilter*> importers;
    LinkedList <IExportFilter*> exporters;

    // methods

    virtual void CCL_API registerFilter (IConvertFilter* filter);
    virtual void CCL_API unregisterFilter (IConvertFilter* filter);
    virtual void CCL_API registerImporter (IImportFilter* filter);
    virtual void CCL_API unregisterImporter (IImportFilter* filter);
    virtual void CCL_API registerExporter (IExportFilter* filter);
    virtual void CCL_API unregisterExporter (IExportFilter* filter);
    virtual tbool CCL_API canConvert (IUnknown* object, UIDRef cid = kNullUID) const;
    virtual IUnknown*CCL_API convert (IUnknown* object, UIDRef cid = kNullUID) const;

    virtual tbool CCL_API canImport (
        IStream& stream,
        TypeID type,
        UIDRef cid = kNullUID
    ) const;

    IUnknown*CCL_API IUnknown* importText (
        const void* text,
        unsigned int byteSize,
        bool isUnicode = false
    );

    virtual tbool CCL_API makeFilePromises (
        IUnknownList& filePromises,
        IUnknown* object,
        IUnknown* context
    ) const;

    const LinkedList <IExportFilter*>& getExporters () const;
    Object* tryXmlImport (IStream& stream);
    virtual StringID CCL_API getIdentity () const;
    virtual tbool CCL_API getFileType (FileType& fileType) const;

    template  <class Iface>
    static Iface* toInterface (IUnknown* object);

    template  <class Class>
    static Class* toClass (IUnknown* object);

    template  <class Iface>
    static bool canConvertToInterface (IUnknown* object);

    template  <class Class>
    static bool canConvertToClass (IUnknown* object);
};

Inherited Members

public:
    // typedefs

    typedef CStringRef MemberID;
    typedef CStringRef TypeID;

    // fields

    IUnknown* CCL_API;

    // 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 tbool CCL_API canConvert (IUnknown* object, UIDRef cid = kNullUID) const = 0;
    virtual IUnknown*CCL_API convert (IUnknown* object, UIDRef cid = kNullUID) const = 0;

    virtual tbool CCL_API canImport (
        IStream& stream,
        TypeID type,
        UIDRef cid = kNullUID
    ) const = 0;

    virtual StringID CCL_API getIdentity () const = 0;
    virtual tbool CCL_API getFileType (FileType& fileType) const = 0;

    virtual tbool CCL_API makeFilePromises (
        IUnknownList& filePromises,
        IUnknown* object,
        IUnknown* context
    ) const = 0;

    virtual void CCL_API registerFilter (IConvertFilter* filter) = 0;
    virtual void CCL_API unregisterFilter (IConvertFilter* filter) = 0;
    virtual void CCL_API registerImporter (IImportFilter* filter) = 0;
    virtual void CCL_API unregisterImporter (IImportFilter* filter) = 0;
    virtual void CCL_API registerExporter (IExportFilter* filter) = 0;
    virtual void CCL_API unregisterExporter (IExportFilter* filter) = 0;
    static T& instance ();
    static T* peekInstance ();
    static Object* __createSingleton ();

Detailed Documentation

Converter singleton.

<>

Methods

virtual void CCL_API registerFilter (IConvertFilter* filter)

Register conversion filter.

The filter will be shared!

virtual void CCL_API unregisterFilter (IConvertFilter* filter)

Unregister conversion filter.

virtual void CCL_API registerImporter (IImportFilter* filter)

Register import filter.

The filter will be shared!

virtual void CCL_API unregisterImporter (IImportFilter* filter)

Unregister import filter.

virtual void CCL_API registerExporter (IExportFilter* filter)

Register export filter.

The filter will be shared!

virtual void CCL_API unregisterExporter (IExportFilter* filter)

Unregister exporter filter.

virtual tbool CCL_API canConvert (IUnknown* object, UIDRef cid = kNullUID) const

Check if object can be converted to given type.

virtual IUnknown*CCL_API convert (IUnknown* object, UIDRef cid = kNullUID) const

Convert object to given type.

In case of success, the new object is owned by the caller.

virtual tbool CCL_API canImport (
    IStream& stream,
    TypeID type,
    UIDRef cid = kNullUID
) const

Check if object of given type can be created from data stream.

virtual tbool CCL_API makeFilePromises (
    IUnknownList& filePromises,
    IUnknown* object,
    IUnknown* context
) const

Create list of IFilePromise instances for given object.

virtual StringID CCL_API getIdentity () const

Get identity for alternative filter comparison (optional).

virtual tbool CCL_API getFileType (FileType& fileType) const

Get type of file promises created by this filter (optional).