class CCL::CustomizedMenuParam

Overview

A menu parameter that allows to customize the menu type. More…

#include <params.h>

class CustomizedMenuParam:
    public CCL::MenuParam,
    public CCL::IParameterMenuCustomize
{
public:
    // fields

     IParameterMenuCustomize;

    // construction

    CustomizedMenuParam (
        StringID name = nullptr,
        StringID menuType = MenuPresentation::kTree
    );

    // methods

    void setMenuType (StringID type);
    virtual StringID CCL_API getMenuType () const;
    virtual tbool CCL_API buildMenu (IMenu& menu, IParameterMenuBuilder& builder);
    virtual tbool CCL_API onMenuKeyDown (const KeyEvent& event);
};

Inherited Members

public:
    // typedefs

    typedef CStringRef MemberID;

    // enums

    enum Flags;
    enum Type;

    // fields

     IParameter;
    int max = 100;
    int StringID name = nullptr);
     IListParameter;
     IMenuExtension;

    // 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 getName () const = 0;
    virtual void CCL_API setName (StringID name) = 0;
    virtual tbool CCL_API isEnabled () const = 0;
    virtual void CCL_API enable (tbool state) = 0;
    virtual tbool CCL_API getState (int mask) const = 0;
    virtual void CCL_API setState (int mask, tbool state) = 0;
    virtual int CCL_API getVisualState () const = 0;
    virtual void CCL_API setVisualState (int state) = 0;
    virtual void CCL_API connect (IParamObserver* controller, int tag) = 0;
    virtual int CCL_API getTag () const = 0;
    virtual IUnknown*CCL_API getController () const = 0;
    virtual void CCL_API performUpdate () = 0;
    virtual void CCL_API beginEdit () = 0;
    virtual void CCL_API endEdit () = 0;
    virtual IParameter*CCL_API getOriginal () = 0;
    virtual IUnknown*CCL_API createIdentity () = 0;
    virtual Variant CCL_API getValue () const = 0;
    virtual void CCL_API setValue (VariantRef value, tbool update = false) = 0;
    virtual Variant CCL_API getMin () const = 0;
    virtual Variant CCL_API getMax () const = 0;
    virtual void CCL_API setMin (VariantRef min) = 0;
    virtual void CCL_API setMax (VariantRef max) = 0;
    virtual Variant CCL_API getDefaultValue () const = 0;
    virtual void CCL_API setDefaultValue (VariantRef value) = 0;
    virtual Variant CCL_API boundValue (VariantRef value) const = 0;
    virtual tbool CCL_API canIncrement () const = 0;
    virtual int CCL_API getPrecision () const = 0;
    virtual tbool CCL_API setPrecision (int precision) = 0;
    virtual void CCL_API increment () = 0;
    virtual void CCL_API decrement () = 0;
    virtual void CCL_API takeValue (const IParameter& param, tbool update = false) = 0;
    virtual float CCL_API getNormalized () const = 0;
    virtual void CCL_API setNormalized (float value, tbool update = false) = 0;
    virtual float CCL_API getValueNormalized (VariantRef value) const = 0;
    virtual Variant CCL_API getValuePlain (float valueNormalized) const = 0;
    virtual IParamCurve*CCL_API getCurve () const = 0;
    virtual void CCL_API setCurve (IParamCurve* curve) = 0;
    virtual IFormatter*CCL_API getFormatter () const = 0;
    virtual void CCL_API setFormatter (IFormatter* formatter) = 0;
    virtual void CCL_API getString (String& string, VariantRef value) const = 0;
    virtual void CCL_API toString (String& string) const = 0;
    virtual void CCL_API fromString (StringRef string, tbool update = false) = 0;
    IParameter bool isSignalFirst () const;
    void setSignalFirst (bool state = true);
    bool isSignalAlways () const;
    void setSignalAlways (bool state = true);
    bool isBipolar () const;
    void setBipolar (bool state = true);
    bool isReverse () const;
    void setReverse (bool state = true);
    bool isOutOfRange () const;
    void setOutOfRange (bool state = true);
    bool isWrapAround () const;
    void setWrapAround (bool state = true);
    bool isStorable () const;
    void setStorable (bool state = true);
    bool isStoreListValue () const;
    void setStoreListValue (bool state = true);
    bool isGroupable () const;
    void setGroupable (bool state = true);
    bool isPublic () const;
    void setPublic (bool state = true);
    bool isMutable () const;
    void setMutable (bool state = true);
    bool isReadOnly () const;
    void setReadOnly (bool state = true);
    void setFeedbackNeeded (bool state);
    void setPriorityChange ();
    bool isPriorityChange () const;
    void setCanUndo (bool state = true);
    bool canUndo () const;
    double getIncrement () const;
    void setIncrement (double increment);
    DECLARE_CLASS (Parameter, Object);
    int CCL_API getType () const;
    virtual StringID CCL_API getName () const;
    virtual void CCL_API setName (StringID name);
    virtual tbool CCL_API isEnabled () const;
    virtual void CCL_API enable (tbool state);
    virtual tbool CCL_API getState (int mask) const;
    virtual void CCL_API setState (int mask, tbool state);
    virtual int CCL_API getVisualState () const;
    virtual void CCL_API setVisualState (int state);
    virtual void CCL_API connect (IParamObserver* controller, int tag);
    virtual int CCL_API getTag () const;
    virtual IUnknown*CCL_API getController () const;
    virtual void CCL_API performUpdate ();
    virtual void CCL_API beginEdit ();
    virtual void CCL_API endEdit ();
    virtual IParameter*CCL_API getOriginal ();
    virtual IUnknown*CCL_API createIdentity ();
    virtual Variant CCL_API getValue () const;
    virtual void CCL_API setValue (VariantRef value, tbool update = false);
    virtual Variant CCL_API getMin () const;
    virtual Variant CCL_API getMax () const;
    virtual void CCL_API setMin (VariantRef min);
    virtual void CCL_API setMax (VariantRef max);
    virtual Variant CCL_API getDefaultValue () const;
    virtual void CCL_API setDefaultValue (VariantRef value);
    virtual Variant CCL_API boundValue (VariantRef value) const;
    virtual tbool CCL_API canIncrement () const;
    virtual int CCL_API getPrecision () const;
    virtual tbool CCL_API setPrecision (int precision);
    virtual void CCL_API increment ();
    virtual void CCL_API decrement ();
    virtual void CCL_API takeValue (const IParameter& param, tbool update = false);
    virtual float CCL_API getNormalized () const;
    virtual void CCL_API setNormalized (float value, tbool update = false);
    virtual float CCL_API getValueNormalized (VariantRef value) const;
    virtual Variant CCL_API getValuePlain (float valueNormalized) const;
    virtual IParamCurve*CCL_API getCurve () const;
    virtual void CCL_API setCurve (IParamCurve* curve);
    virtual IFormatter*CCL_API getFormatter () const;
    virtual void CCL_API setFormatter (IFormatter* formatter);
    virtual void CCL_API getString (String& string, VariantRef value) const;
    virtual void CCL_API toString (String& string) const;
    virtual void CCL_API fromString (StringRef string, tbool update = false);
    void rangeChanged ();
    virtual void CCL_API signal (MessageRef msg = Message (kChanged));
    virtual void deferChanged ();
    static Parameter* createInstance (StringID className);
    static IUnknown* createIdentity (IParameter* This);

    static void restoreValue (
        IParameter* This,
        VariantRef value,
        bool update = false
    );

    virtual DECLARE_CLASS (IntParam, Parameter) = 0;
    int CCL_API getType () const;
    virtual Variant CCL_API getValue () const;
    virtual void CCL_API setValue (VariantRef value, tbool update = false);
    virtual Variant CCL_API getMin () const;
    virtual Variant CCL_API getMax () const;
    virtual void CCL_API setMin (VariantRef min);
    virtual void CCL_API setMax (VariantRef max);
    virtual Variant CCL_API getDefaultValue () const;
    virtual void CCL_API setDefaultValue (VariantRef value);
    virtual int CCL_API getPrecision () const;
    virtual void CCL_API getString (String& string, VariantRef value) const;
    virtual void CCL_API fromString (StringRef string, tbool update = false);
    virtual Variant CCL_API boundValue (VariantRef value) const;
    virtual float CCL_API getValueNormalized (VariantRef value) const;
    virtual Variant CCL_API getValuePlain (float valueNormalized) const;
    virtual void CCL_API appendString (StringRef string, int index = -1) = 0;
    virtual void CCL_API appendValue (VariantRef value, int index = -1) = 0;

    virtual void CCL_API appendValue (
        VariantRef value,
        StringRef string,
        int index = -1
    ) = 0;

    virtual int CCL_API getValueIndex (VariantRef value) const = 0;
    virtual Variant CCL_API getValueAt (int index) const = 0;
    virtual tbool CCL_API setValueAt (int index, VariantRef value) = 0;
    virtual Variant CCL_API getSelectedValue () const = 0;
    virtual tbool CCL_API selectValue (VariantRef value, tbool update = false) = 0;
    virtual void CCL_API removeAt (int index) = 0;
    virtual void CCL_API removeAll () = 0;
    virtual tbool CCL_API isEmpty () const = 0;
    virtual int CCL_API getNearestValueIndex (VariantRef value) const = 0;

    virtual tbool CCL_API selectNearestValue (
        VariantRef value,
        tbool update = false
    ) = 0;

    DECLARE_CLASS (ListParam, IntParam);
    void appendObject (Object* object, int index = -1);
    int getObjectIndex (const Object* object) const;
    int getObjectIndex (const Object& object) const;
    int getObjectCount () const;
    bool contains (const Object& object) const;

    template  <class T>
    T* getObject (int index) const;

    template  <class Lambda>
    Object* findObject (const Lambda& recognize) const;

    Object* getSelectedObject () const;
    bool selectObject (Object* object, tbool update = false);
    virtual void CCL_API appendString (StringRef string, int index = -1);
    virtual void CCL_API appendValue (VariantRef value, int index = -1);

    virtual void CCL_API appendValue (
        VariantRef value,
        StringRef string,
        int index = -1
    );

    virtual int CCL_API getValueIndex (VariantRef value) const;
    virtual Variant CCL_API getValueAt (int index) const;
    virtual tbool CCL_API setValueAt (int index, VariantRef value);
    virtual Variant CCL_API getSelectedValue () const;
    virtual tbool CCL_API selectValue (VariantRef value, tbool update = false);
    virtual void CCL_API removeAt (int index);
    virtual void CCL_API removeAll ();
    virtual tbool CCL_API isEmpty () const;
    virtual int CCL_API getNearestValueIndex (VariantRef value) const;

    virtual tbool CCL_API selectNearestValue (
        VariantRef value,
        tbool update = false
    );

    int CCL_API getType () const;
    virtual void CCL_API setMax (VariantRef max);
    virtual void CCL_API increment ();
    virtual void CCL_API decrement ();
    virtual void CCL_API getString (String& string, VariantRef value) const;
    virtual void CCL_API fromString (StringRef string, tbool update = false);
    virtual void CCL_API extendMenu (IMenu& menu, StringID name) = 0;
    DECLARE_CLASS (MenuParam, ListParam);
    virtual void CCL_API extendMenu (IMenu& menu, StringID name);
    virtual StringID CCL_API getMenuType () const = 0;
    virtual tbool CCL_API buildMenu (IMenu& menu, IParameterMenuBuilder& builder) = 0;
    virtual tbool CCL_API onMenuKeyDown (const KeyEvent& event) = 0;

Detailed Documentation

A menu parameter that allows to customize the menu type.

Methods

virtual StringID CCL_API getMenuType () const

Return type of menu presentation (see MenuPresentation identifiers).

virtual tbool CCL_API buildMenu (IMenu& menu, IParameterMenuBuilder& builder)

Build popup menu for this parameter.

virtual tbool CCL_API onMenuKeyDown (const KeyEvent& event)

Handle keyboard input in parameter menu popup.