Grl.Data¶
- Subclasses:
Methods¶
- Inherited:
- Structs:
class |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Virtual Methods¶
- Inherited:
Properties¶
None
Signals¶
- Inherited:
Fields¶
- Inherited:
Name |
Type |
Access |
Description |
---|---|---|---|
parent |
r |
Class Details¶
- class Grl.Data(**kwargs)¶
- Bases:
- Abstract:
No
- Structure:
- classmethod new()¶
- Returns:
a new data object.
- Return type:
Creates a new data object.
New in version 0.1.4.
- add_binary(key, buf, size)¶
- Parameters:
Appends a new binary value for key in self.
New in version 0.1.10.
- add_boxed(key, boxed)¶
-
Appends a new boxed value for key in self.
New in version 0.2.0.
- add_float(key, floatvalue)¶
-
Appends a new float value for key in self.
New in version 0.1.10.
- add_for_id(key_name, value)¶
- Parameters:
key_name (
str
) – name of the key to change or addvalue (
GObject.Value
) – the new value
- Returns:
- Return type:
Appends the value associated with key_name to self. This key_name is used to create a new
GObject.ParamSpec
instance, which is further used to create and register a key usingGrl.Registry.register_metadata_key
().A property key_name consists of segments consisting of ASCII letters and digits, separated by either the ‘-’ or ‘_’ character. The first character of a property key_name must be a letter. Key_names which violate these rules lead to undefined behaviour.
New in version 0.3.6.
- add_int(key, intvalue)¶
-
Appends a new int value for key in self.
New in version 0.1.10.
- add_int64(key, intvalue)¶
-
Appends a new int64 value for key in self.
New in version 0.2.12.
- Parameters:
relkeys (
Grl.RelatedKeys
) – a set of related properties with their values
Adds a new set of values into self.
All keys in prop must be related among them.
self will take the ownership of relkeys, so do not modify it.
New in version 0.1.10.
- add_string(key, strvalue)¶
-
Appends a new string value for key in self.
New in version 0.1.10.
- dup()¶
- Returns:
a new
Grl.Data
. Free it withGObject.Object.unref
.- Return type:
Makes a deep copy of self and all its contents.
New in version 0.1.10.
- get(key)¶
- Parameters:
key (
int
) – key to look up.- Returns:
a
GObject.Value
. This value should not be modified nor freed by user.- Return type:
Get the first value from self associated with key.
New in version 0.1.4.
- get_binary(key)¶
- Parameters:
key (
int
) – key to use- Returns:
buffer location associated with the key, or
None
in other case. If successful size will be set the to the buffer size.- size:
location to store the buffer size
- Return type:
Returns the first binary value associated with key from self. If key has no first value, or value is not a
float
, or key is not in data, thenNone
is returned.New in version 0.1.9.
- get_boolean(key)¶
- Parameters:
key (
int
) – key to use- Returns:
the first boolean value associated with key from self. If key has no first value, or value is not a
bool
, or key is not in the data, thenFalse
is returned- Return type:
New in version 0.2.3.
- get_boxed(key)¶
- Parameters:
key (
int
) – key to use- Returns:
the boxed instance associated with key if possible, or
None
in other cases. The caller should not change nor free the value.- Return type:
Returns the first boxed value associated with key from self. If key has no first value, that value is not of a boxed type, or key is not in self, then
None
is returned.New in version 0.2.0.
- get_float(key)¶
- Parameters:
key (
int
) – key to use- Returns:
float value associated with key, or 0 in other case.
- Return type:
Returns the first float value associated with key from self. If key has no first value, or value is not a
float
, or key is not in data, then 0 is returned.New in version 0.1.5.
- get_int(key)¶
- Parameters:
key (
int
) – key to use- Returns:
int value associated with key, or 0 in other case.
- Return type:
Returns the first int value associated with key from self. If key has no first value, or value is not a
int
, or key is not in data, then 0 is returned.New in version 0.1.4.
- get_int64(key)¶
- Parameters:
key (
int
) – key to use- Returns:
int value associated with key, or 0 in other case.
- Return type:
Returns the first int64 value associated with key from self. If key has no first value, or value is not a
int
, or key is not in data, then 0 is returned.New in version 0.2.12.
- get_keys()¶
- Returns:
an array with the keys. The content of the list should not be modified or freed. Use g_list_free() when done using the list.
- Return type:
[
int
]
Returns a list with keys contained in self.
New in version 0.1.4.
- Parameters:
- Returns:
a
Grl.RelatedKeys
. Do not free it.- Return type:
Returns a set containing the values for key and related keys at position index from self.
If user changes any of the values in the related keys, the changes will become permanent.
New in version 0.1.10.
- get_single_values_for_key(key)¶
- Parameters:
key (
int
) – a metadata key- Returns:
a
GLib.List
with values. Do not change or free the values. Free the list with #g_list_free.- Return type:
Returns all non-
None
values for key from self. This ignores related keys.New in version 0.1.13.
- get_single_values_for_key_string(key)¶
- Parameters:
key (
int
) – a metadata key- Returns:
a
GLib.List
with values. Do not change or free the strings. Free the list with #g_list_free.- Return type:
[
str
]
Returns all non-
None
values for key from self. key must have been registered as a string-type key. This ignores related keys.New in version 0.1.13.
- get_string(key)¶
- Parameters:
key (
int
) – key to use- Returns:
string associated with key, or
None
in other case. Caller should not change nor free the value.- Return type:
Returns the first string value associated with key from self. If key has no first value, or value is not string, or key is not in self, then
None
is returned.New in version 0.1.4.
- has_key(key)¶
- Parameters:
key (
int
) – key to search- Returns:
- Return type:
Checks if key is in self.
New in version 0.1.4.
- length(key)¶
-
Returns how many values key or related keys have in self: if key has no value, but a related key has, then it is counted as positive.
As example, let’s think in three related keys, K1, K2 and K3, and then thinks we have added several values for those keys, as:
(V10, V20, V30), (V11,
None
, V31), (V12,None
, V32)Therefore, when invoking
Grl.Data.length
(data, K2) it will return 3: considering K2 and the related keys (K1 and K3), there are 3 values.New in version 0.1.10.
- remove(key)¶
- Parameters:
key (
int
) – key to remove
Removes the first value for key from self. If there are other keys related to key their values will also be removed from self.
New in version 0.1.4.
- remove_nth(key, index)¶
-
Removes the value at position index for key from self. If there are other keys related to key, their values at position index will also be removed from self.
New in version 0.1.10.
- set(key, value)¶
- Parameters:
key (
int
) – key to change or addvalue (
GObject.Value
) – the new value
Sets the first value associated with key in self. If key already has a value old value is freed and the new one is set.
Also, checks that value is compliant with key specification, modifying it accordingly. For instance, if key requires a number between 0 and 10, but value is outside this range, it will be adapted accordingly.
New in version 0.1.4.
- set_binary(key, buf, size)¶
- Parameters:
Sets the first binary value associated with key in self. If key already has a first value old value is replaced by the new one.
New in version 0.1.9.
- set_boolean(key, boolvalue)¶
-
Sets the first boolean value associated with key in self. If key already has a first value, old value is replaced by the new one.
New in version 0.2.3.
- set_boxed(key, boxed)¶
-
Sets the first boxed value associated with key in self. If key already has a value, the old value is freed and the new one is set.
New in version 0.2.0.
- set_float(key, floatvalue)¶
-
Sets the first float value associated with key in self. If key already has a first value old value is replaced by the new one.
New in version 0.1.5.
- set_for_id(key_name, value)¶
- Parameters:
key_name (
str
) – name of the key to change or addvalue (
GObject.Value
) – the new value
- Returns:
- Return type:
Sets the first value associated with key_name in self. This key_name is used to create a new
GObject.ParamSpec
instance, which is further used to create and register a key usingGrl.Registry.register_metadata_key
(). If key_name already has a first value, old value is replaced by the new one.A property key_name consists of segments consisting of ASCII letters and digits, separated by either the ‘-’ or ‘_’ character. The first character of a property key_name must be a letter. Key_names which violate these rules lead to undefined behaviour.
New in version 0.3.6.
- set_int(key, intvalue)¶
-
Sets the first int value associated with key in self. If key already has a first value old value is replaced by the new one.
New in version 0.1.4.
- set_int64(key, intvalue)¶
-
Sets the first int64 value associated with key in self. If key already has a first value old value is replaced by the new one.
New in version 0.2.12.
- Parameters:
relkeys (
Grl.RelatedKeys
) – a set of related keysindex (
int
) – position to be updated, starting at 0
Updates the values at position index in self with values in relkeys.
self will take ownership of relkeys, so do not free it after invoking this function.
New in version 0.1.10.