class CCL::ParamContainer

Overview

ParamList extension derived from Object. More…

#include <paramcontainer.h>

class ParamContainer:
    public CCL::Object,
    public CCL::ParamList,
    public CCL::AbstractController
{
public:
    // fields

     IController;

    // methods

    template  <class T>
    T* at (int idx) const;

    template  <class T>
    T* byTag (int tag) const;

    void storeValues (Attributes& a, bool storable = false) const;
    void storeValue (Attributes& a, StringID name) const;
    void storeValue (Attributes& a, IParameter* p) const;

    void restoreValues (
        const Attributes& a,
        bool storable = false,
        bool update = false
    );

    bool restoreValue (const Attributes& a, StringID name, bool update = false);
    bool restoreValue (const Attributes& a, IParameter* p, bool update = false);
    void addParametersFrom (const ParamContainer& container);
    void setDefaultValues (bool storable = false, bool update = false);
    void enableAll (bool state);
    void storeSettings (StringRef settingsID) const;
    void storeSettingsIncrementally (StringRef settingsID) const;
    void restoreSettings (StringRef settingsID, bool update = true);
    virtual int CCL_API countParameters () const;
    virtual IParameter*CCL_API getParameterAt (int index) const;
    virtual IParameter*CCL_API findParameter (StringID name) const;
    virtual IParameter*CCL_API getParameterByTag (int tag) const;
    virtual bool load (const Storage& storage);
    virtual bool save (const Storage& storage) const;
    IParameter* byTag (int tag) const;
};

Inherited Members

public:
    // typedefs

    typedef CStringRef MemberID;
    typedef VectorIterator <IParameter*> ParamIterator;

    // classes

    class ParamArray;

    // 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 ();
    void setController (IParamObserver* controller);
    IParameter* addParam (StringID name, int tag = 0);
    IParameter* addInteger (int min, int max, StringID name, int tag = 0);
    IParameter* addFloat (double min, double max, StringID name, int tag = 0);
    IParameter* addString (StringID name, int tag = 0);
    IParameter* addList (StringID name, int tag = 0);
    IParameter* addMenu (StringID name, int tag = 0);
    IParameter* addPalette (StringID name, int tag = 0);

    IParameter* addCommand (
        StringID commandCategory,
        StringID commandName,
        StringID name,
        int tag = 0
    );

    IParameter* addScroll (StringID name, int tag = 0);
    IParameter* addColor (StringID name, int tag = 0);
    IImageProvider* addImage (StringID name, int tag = 0);
    ITextModelProvider* addTextModel (StringID name, int tag = 0);
    IAliasParameter* addAlias (StringID name, int tag = 0);
    IParameter* add (IParameter* p, int tag = 0);
    IParameter* addShared (IParameter* p);
    IParameter* addIndexedParam (StringID arrayName, IParameter* p, int tag = 0);
    IParameter* addIndexedParamShared (StringID arrayName, IParameter* p);
    IParameter* getIndexedParam (StringID arrayName, int index) const;
    int getParamArrayCount (StringID arrayName) const;
    ParamIterator* getParamArray (StringID arrayName) const;
    int count () const;
    IParameter* at (int index) const;
    int arrayCount () const;
    ParamIterator* arrayAt (int index) const;
    IParameter* byTag (int tag) const;
    IParameter* byCommand (StringID commandCategory, StringID commandName) const;
    IParameter* lookup (StringID name) const;
    bool remove (IParameter* p, bool releaseParam = false);
    bool toHead (IParameter* p);
    bool contains (IParameter* p);
    void removeAll ();
    void removeArray (StringID arrayName);
    void removeIndexedParam (StringID arrayName, int index);
    void checkCommandStates ();
    void enableCommands (bool state);
    void setFeedbackNeeded (bool state);
    virtual int CCL_API countParameters () const = 0;
    virtual IParameter*CCL_API getParameterAt (int index) const = 0;
    virtual IParameter*CCL_API findParameter (StringID name) const = 0;
    virtual IParameter*CCL_API getParameterByTag (int tag) const = 0;
    virtual IUnknown*CCL_API getObject (StringID name, UIDRef classID) = 0;
    virtual int CCL_API countParameters () const;
    virtual IParameter*CCL_API getParameterAt (int index) const;
    virtual IParameter*CCL_API findParameter (StringID name) const;
    virtual IParameter*CCL_API getParameterByTag (int tag) const;
    virtual IUnknown*CCL_API getObject (StringID name, UIDRef classID);

Detailed Documentation

ParamList extension derived from Object.

Methods

void storeValues (Attributes& a, bool storable = false) const

Store values to attributes.

void restoreValues (
    const Attributes& a,
    bool storable = false,
    bool update = false
)

Restore values from attributes.

void addParametersFrom (const ParamContainer& container)

Clone parameters from other container.

void setDefaultValues (bool storable = false, bool update = false)

Set all parameters to their default values.

void enableAll (bool state)

Enable/Disable all parameters.

void storeSettings (StringRef settingsID) const

Store parameter values to user settings.

void storeSettingsIncrementally (StringRef settingsID) const

Store parameter values to user settings.

Keeps other existing values in settings (e.g. for currently non-storable params).

void restoreSettings (StringRef settingsID, bool update = true)

Restore parameter values from user settings.

virtual int CCL_API countParameters () const

Get number of parameters.

virtual IParameter*CCL_API getParameterAt (int index) const

Get parameter by index.

virtual IParameter*CCL_API findParameter (StringID name) const

Get parameter by name.

virtual IParameter*CCL_API getParameterByTag (int tag) const

Get parameter by tag.

IParameter* byTag (int tag) const

Get parameter by tag.