RB.StringValueMap

Subclasses:

None

Methods

Inherited:

GObject.Object (37)

Structs:

GObject.ObjectClass (5)

class	new ()
	get (key, out)
	peek (key)
	remove (key)
	set (key, value)
	size ()
	steal_hashtable ()

Virtual Methods

Inherited:

GObject.Object (7)

Properties

None

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Name	Type	Access	Description
parent	GObject.Object	r

Class Details

class RB.StringValueMap(**kwargs)

Bases:

GObject.Object

Abstract:

No

Structure:

RB.StringValueMapClass

Simplifies the use of string:GValue maps with respect to copying of the values inserted into the map. Except for RB.StringValueMap.peek, the caller retains ownership of values passed in, and assumes ownership of all values returned.

classmethod new()

Returns:

new empty RB.StringValueMap

Return type:

RB.StringValueMap

Creates a new RB.StringValueMap

get(key, out)

Parameters:

• key (str) – key to retrieve

• out (GObject.Value) – returns a copy of the value in the map

Returns:

True if the value was found

Return type:

bool

Locates and copies the value associated with the key.

peek(key)

Parameters:

key (str) – key to retrieve

Returns:

the GObject.Value associated with the key

Return type:

GObject.Value

Locates the value associated with the key. This returns the GObject.Value stored in the map, so it cannot be modified.

remove(key)

Parameters:

key (str) – key to remove

Returns:

True if the value was found and removed

Return type:

bool

Removes a value from the map.

set(key, value)

Parameters:

• key (str) – key to set

• value (GObject.Value) – value to store

Inserts a value into the map. The value is copied.

size()

Returns:

number of entries

Return type:

int

Returns the number of entries in the map.

steal_hashtable()

Returns:

GLib.HashTable from the map

Return type:

{object: object}

Extracts and returns the underlying hash table from the map, and creates a new empty map.