class CCL::FilePromise

Overview

#include <objectconverter.h>

class FilePromise:
    public CCL::Object,
    public CCL::IFilePromise
{
public:
    // classes

    template <class PromiseClass>
    class Exporter;

    // methods

    virtual tbool CCL_API getTitle (String& title) const;
    virtual tbool CCL_API getFileName (String& fileName) const;
    virtual tbool CCL_API getFileType (FileType& fileType) const;
    virtual tbool CCL_API getFileSize (int64& fileSize) const;
    virtual tbool CCL_API getFileTime (DateTime& fileTime) const;
    virtual tbool CCL_API getMetaInfo (IAttributeList& a) const;
    virtual tbool CCL_API isAsync () const;

    virtual tresult CCL_API createFile (
        UrlRef destPath,
        IProgressNotify* progress = nullptr
    );

    CLASS_INTERFACE2 (IFileDescriptor, IFilePromise, Object);
};

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 tbool CCL_API getTitle (String& title) const = 0;
    virtual tbool CCL_API getFileName (String& fileName) const = 0;
    virtual tbool CCL_API getFileType (FileType& fileType) const = 0;
    virtual tbool CCL_API getFileSize (int64& fileSize) const = 0;
    virtual tbool CCL_API getFileTime (DateTime& fileTime) const = 0;
    virtual tbool CCL_API getMetaInfo (IAttributeList& a) const = 0;
    DECLARE_STRINGID_MEMBER (kFileCreatorName);
    virtual tbool CCL_API isAsync () const = 0;

    virtual tresult CCL_API createFile (
        UrlRef destPath,
        IProgressNotify* progress = nullptr
    ) = 0;

Detailed Documentation

Methods

virtual tbool CCL_API getTitle (String& title) const

Get beautified title for display.

virtual tbool CCL_API getFileName (String& fileName) const

Get file name.

virtual tbool CCL_API getFileType (FileType& fileType) const

Get fully qualified file type.

virtual tbool CCL_API getFileSize (int64& fileSize) const

Get file size.

virtual tbool CCL_API getFileTime (DateTime& fileTime) const

Get file time (last modified).

virtual tbool CCL_API getMetaInfo (IAttributeList& a) const

Get associated meta information (optional).

virtual tbool CCL_API isAsync () const

Check if file is created asynchronously.

In this case the file is not guaranteed to exist after createFile().

virtual tresult CCL_API createFile (
    UrlRef destPath,
    IProgressNotify* progress = nullptr
)

Create the file.