class CCL::StringDictionary

Overview

#include <stringdictionary.h>

class StringDictionary:
    public CCL::Object,
    public CCL::IStringDictionary
{
public:
    // fields

     IStringDictionary;

    // construction

    StringDictionary (const StringDictionary& other);
    StringDictionary (const IStringDictionary& other);

    // methods

    DECLARE_CLASS (StringDictionary, Object);
    void dump () const;
    virtual tbool CCL_API isCaseSensitive () const;
    virtual void CCL_API setCaseSensitive (tbool state);
    virtual int CCL_API countEntries () const;
    virtual StringRef CCL_API getKeyAt (int index) const;
    virtual StringRef CCL_API getValueAt (int index) const;
    virtual StringRef CCL_API lookupValue (StringRef key) const;
    virtual void CCL_API setEntry (StringRef key, StringRef value);
    virtual void CCL_API appendEntry (StringRef key, StringRef value);
    virtual void CCL_API removeEntry (StringRef key);
    virtual void CCL_API removeAll ();
    virtual void CCL_API copyFrom (const IStringDictionary& dictionary);
    virtual void CCL_API convertTo (ICStringDictionary& dst, TextEncoding encoding) const;
    virtual bool equals (const Object& obj) const;
    virtual bool load (const Storage& storage);
    virtual bool save (const Storage& storage) const;
};

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 isCaseSensitive () const = 0;
    virtual void CCL_API setCaseSensitive (tbool state) = 0;
    virtual int CCL_API countEntries () const = 0;
    virtual StringRefType CCL_API getKeyAt (int index) const = 0;
    virtual StringRefType CCL_API getValueAt (int index) const = 0;
    virtual StringRefType CCL_API lookupValue (StringRefType key) const = 0;
    virtual void CCL_API setEntry (StringRefType key, StringRefType value) = 0;
    virtual void CCL_API appendEntry (StringRefType key, StringRefType value) = 0;
    virtual void CCL_API removeEntry (StringRefType key) = 0;
    virtual void CCL_API removeAll () = 0;
    virtual void CCL_API copyFrom (const IStringDictionary& dictionary) = 0;
    virtual void CCL_API convertTo (ICStringDictionary& dst, TextEncoding encoding) const = 0;

Detailed Documentation

Methods

virtual tbool CCL_API isCaseSensitive () const

Check if dictionary keys are case-sensitive.

virtual void CCL_API setCaseSensitive (tbool state)

Set case-sensitivity of dictionary keys.

virtual int CCL_API countEntries () const

Get number of entries.

virtual StringRef CCL_API getKeyAt (int index) const

Get key of entry at given index.

virtual StringRef CCL_API getValueAt (int index) const

Get value of entry at given index.

virtual StringRef CCL_API lookupValue (StringRef key) const

Lookup value by key, returns empty string if not found.

virtual void CCL_API setEntry (StringRef key, StringRef value)

Set entry overwriting existing.

virtual void CCL_API appendEntry (StringRef key, StringRef value)

Append entry not overwriting existing.

virtual void CCL_API removeEntry (StringRef key)

Remove entry with given key.

virtual void CCL_API removeAll ()

Remove all entries.

virtual void CCL_API copyFrom (const IStringDictionary& dictionary)

Copy all entries from other dictionary.

virtual void CCL_API convertTo (ICStringDictionary& dst, TextEncoding encoding) const

Convert to C-string dictionary with given text encoding.