QSDK 1.1 Documentation

Q::VariantMap Struct Reference
[Messaging, Scripting]

A dictionary of Variant objects. More...

#include <Q/gamedev.h>

Inheritance diagram for Q::VariantMap:

List of all members.

Public Types
typedef Com::Ptr< VariantMap >	PTR
Public Member Functions
virtual unsigned int	size () const=0
virtual Utils::Result	empty ()=0
virtual Utils::Result	add (Variant *key, Variant *value)=0
virtual Utils::Result	get (Variant *key, Variant **value) const=0
virtual Utils::Result	remove (Variant *)=0
virtual Utils::Result	getValues (VariantCollection *keys, VariantCollection *values) const=0
Static Public Member Functions
PTR	create ()
Static Public Attributes
Com::UUID	IID
Com::UUID	CLSID

---

Detailed Description

A dictionary of Variant objects.

Dictionary of Variant objects.

See also:

Variant

---

Member Typedef Documentation

typedef Com::Ptr<VariantMap> Q::VariantMap::PTR

A COM pointer to an object of this class

---

Member Function Documentation

virtual Utils::Result Q::VariantMap::add (  Variant *  key, Variant *  value )  [pure virtual]

Add an entry to the map. If the key is already an entry in the map, the specified value replaces the former value. Note: The equality used to match keys is the Variant structural equality. Warning: the key cannot be nil. If it is, the method returns Utils::InvalidArgument.

VariantMap::PTR Q::VariantMap::create (   )  [inline, static]

Create a Variant map

virtual Utils::Result Q::VariantMap::empty (   )  [pure virtual]

Clear the map from all its contents.

virtual Utils::Result Q::VariantMap::get (  Variant *  key, Variant **  value )  const [pure virtual]

If the key is an entry in the map, the value associated to it gets passed into value and the method returns Utils::Success. Otherwise the method returns ENotFound. Note: The reference count of the Variant value will be increased by one after - the caller should release this reference using Com::Unknown::release.

virtual Utils::Result Q::VariantMap::getValues (  VariantCollection *  keys, VariantCollection *  values )  const [pure virtual]

If the parameter keys is not nil, the keys of the map are added into it. If the parameter values is not nil, the values of the map are added into it. The association between the keys and their value is preserved: the index of each key relates to the index of their values.

virtual Utils::Result Q::VariantMap::remove (  Variant *   )  [pure virtual]

Remove key if it is an entry in the map. Otherwise, the method returns ENotFound.

virtual unsigned int Q::VariantMap::size (   )  const [pure virtual]

The size.

---

Member Data Documentation

Com::UUID Q::VariantMap::CLSID [static]

COM CLSID 54ca28a7-8b5a-4fee-83d4-ba7151c88ef2

Com::UUID Q::VariantMap::IID [static]

COM IID 53ef469d-bb3c-4f85-9d4c-5967f1342018 Reimplemented from Com::Unknown.

		Qube Software Limited © 2000-2004