template struct CCL::IStringDictionaryT

Overview

String dictionary interface template. More…

#include <istringdict.h>

template <typename StringRefType>
struct IStringDictionaryT: public CCL::IUnknown
{
    // methods

    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;
};

Inherited Members

public:
    // 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;

Detailed Documentation

String dictionary interface template.

Methods

virtual tbool CCL_API isCaseSensitive () const = 0

Check if dictionary keys are case-sensitive.

virtual void CCL_API setCaseSensitive (tbool state) = 0

Set case-sensitivity of dictionary keys.

virtual int CCL_API countEntries () const = 0

Get number of entries.

virtual StringRefType CCL_API getKeyAt (int index) const = 0

Get key of entry at given index.

virtual StringRefType CCL_API getValueAt (int index) const = 0

Get value of entry at given index.

virtual StringRefType CCL_API lookupValue (StringRefType key) const = 0

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

virtual void CCL_API setEntry (StringRefType key, StringRefType value) = 0

Set entry overwriting existing.

virtual void CCL_API appendEntry (StringRefType key, StringRefType value) = 0

Append entry not overwriting existing.

virtual void CCL_API removeEntry (StringRefType key) = 0

Remove entry with given key.

virtual void CCL_API removeAll () = 0

Remove all entries.