class Core::Portable::StringParam

String value.

#include <coreparams.h>

class StringParam: public Core::Portable::Parameter
{
public:
    // typedefs

    typedef CString256 TextValue;

    // fields

    static const TypeID kTypeID =  'SPar';

    // construction

    StringParam(const ParamInfo& info, bool ownsInfo = false);

    // methods

    virtual void* castTo(TypeID typeId);
    const TextValue& getText() const;
    const TextValue& getDefaultText() const;
    void setDefaultText(CStringPtr defaultText);
    virtual bool isNumeric() const;
    virtual void toString(char* string, int size) const;
    virtual void fromString(CStringPtr string, bool edit = false);
    virtual void resetValue(bool edit = false);
    static StringParam* cast(Parameter* p);
};

Inherited Members

public:
    // typedefs

    typedef int32 TypeID;

    // enums

    enum MsgType;

    // fields

    static const TypeID kTypeID =  'Para';

    // methods

    virtual void* castTo(TypeID typeId) = 0;
    virtual void* castTo(TypeID typeId);
    virtual void* castTo(TypeID typeId);
    void setFormatter(const Formatter* formatter);
    const Formatter* getFormatter() const;
    ParamType getType() const;
    int getTag() const;
    CStringPtr getName() const;
    CStringPtr getTitle(bool shortVersion = false) const;
    bool isOwnInfo() const;
    bool isPublic() const;
    void setPublic(bool state = true);
    bool isStorable() const;
    void setStorable(bool state = true);
    bool isLinkable() const;
    void setLinkable(bool state = true);
    bool isMutable() const;
    bool isReadOnly() const;
    bool isUserFlag1() const;
    bool isUserFlag2() const;
    virtual Parameter* getOriginal();
    void setController(IParamObserver* controller);
    IParamObserver* getController() const;
    void setFeedbackNeeded(bool state);
    virtual void beginEdit();
    virtual void endEdit();
    virtual bool isEditing() const;
    virtual void performEdit();
    void addObserver(IParamObserver* observer);
    void removeObserver(IParamObserver* observer);
    void changed();
    void rangeChanged();
    virtual bool isEnabled() const;
    virtual void enable(bool state);
    virtual int getVisualState() const;
    virtual void setVisualState(int state);
    virtual bool isBipolar() const;
    virtual bool isNumeric() const = 0;
    virtual ParamValue getMin() const = 0;
    virtual ParamValue getMax() const = 0;
    virtual ParamValue getDefault() const = 0;
    virtual ParamValue getValue() const = 0;
    virtual int getPrecision() const = 0;
    virtual void setMin(ParamValue min) = 0;
    virtual void setMax(ParamValue max) = 0;
    virtual void setDefault(ParamValue value) = 0;
    virtual void setValue(ParamValue value, bool edit = false) = 0;
    virtual void resetValue(bool edit = false) = 0;
    virtual ParamValue getNormalized() const = 0;
    virtual void setNormalized(ParamValue v, bool edit = false) = 0;
    virtual void increment(int steps = 1) = 0;
    virtual void decrement(int steps = 1) = 0;
    int getIntMin() const;
    int getIntMax() const;
    int getIntDefault() const;
    void setIntMin(int min);
    void setIntMax(int max);
    void setIntDefault(int value);
    void setIntValue(int value, bool edit = false);
    int getIntValue() const;
    void setBoolValue(bool value, bool edit = false);
    bool getBoolValue() const;
    virtual void toString(char* string, int size) const = 0;
    virtual void fromString(CStringPtr string, bool edit = false) = 0;
    uint32 getHashCode() const;
    static INLINE uint32 hashName(CStringPtr name);