class CCL::PlugInSnapshots

Overview

#include <pluginclass.h>

class PlugInSnapshots:
    public CCL::Object,
    public CCL::Singleton,
    public CCL::IPlugInSnapshots
{
public:
    // classes

    class SnapshotItem;
    class SnapshotPackage;

    // fields

    static const String kFolderName;
    static const String kFileName;
     IPlugInSnapshots;

    // methods

    int addDefaultLocations ();
    int addUserLocations ();
    void addSkinSnapshot (UIDRef cid, StringID imageName);
    virtual int CCL_API addLocation (UrlRef path, tbool deep = true);
    virtual tbool CCL_API addSnapshotFile (UrlRef path);
    virtual void CCL_API removeLocation (UrlRef path);
    virtual tbool CCL_API hasLocation (UrlRef path) const;
    static String getTranslatedTitle ();
    static IUrlFilter* createBackupFilter ();
    static void getAppLocation (IUrl& path);
    static void getUserLocation (IUrl& path);
};

Inherited Members

public:
    // typedefs

    typedef CStringRef MemberID;

    // fields

    StringID which = kDefault) const = 0;

    // 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 ();
    static T& instance ();
    static T* peekInstance ();
    static Object* __createSingleton ();
    DECLARE_STRINGID_MEMBER (kDefault);
    virtual tbool CCL_API hasUserSnapshot (UIDRef cid) const = 0;
    virtual tbool CCL_API setUserSnapshot (UIDRef cid, IImage* image) = 0;

    virtual tbool CCL_API setDefaultSnapshot (
        UrlRef snapshotFile,
        UIDRef cid,
        UrlRef imageFile1x,
        UrlRef imageFile2x
    ) = 0;

    virtual tbool CCL_API getSnapshotDescription (
        String& description,
        UIDRef cid,
        StringID which = kDefault
    ) const = 0;

    virtual tbool CCL_API isHighlight (UIDRef cid) const = 0;
    virtual int CCL_API addLocation (UrlRef path, tbool deep = true) = 0;
    virtual tbool CCL_API addSnapshotFile (UrlRef path) = 0;
    virtual void CCL_API removeLocation (UrlRef path) = 0;
    virtual tbool CCL_API hasLocation (UrlRef path) const = 0;

Detailed Documentation

Fields

static const String kFolderName

snapshot folder name

static const String kFileName

name of snapshot JSON file

Methods

virtual int CCL_API addLocation (UrlRef path, tbool deep = true)

Add snapshot location.

virtual tbool CCL_API addSnapshotFile (UrlRef path)

Add snapshot json file location.

virtual void CCL_API removeLocation (UrlRef path)

Remove snapshot location.

virtual tbool CCL_API hasLocation (UrlRef path) const

Check if given snapshot location has been added.