Functions¶

	`filter_new` (map_func, map_notify, *userdata)
	`filter_new_collator` (column)
	`filter_new_collator_desc` (column)
	`filter_new_for_any_column` (column, value)
	`filter_new_for_key_column` (column, key)
	`filter_new_regex` (column, regex)
	`filter_new_sort` (cmp_row, *cmp_user_data)
	`icu_error_quark` ()
	`model_reader_new` (reader_func, *userdata)
	`model_reader_new_for_int32_column` (column)
	`model_reader_new_for_string_column` (column)
	`model_reader_new_for_uint32_column` (column)
	`resource_manager_get_default` ()
	`serializable_parse` (data, type)
	`serializable_parse_external` (data)

Details¶

Dee.filter_new(map_func, map_notify, *userdata)¶

Parameters:

map_func (Dee.FilterMapFunc) – The Dee.FilterMapFunc to use for the filter
map_notify (Dee.FilterMapNotify) – The Dee.FilterMapNotify to use for the filter
userdata (object or None) – The user data to pass to map_func and map_notify

Returns:

A pointer to an uninitialized Dee.Filter struct. This struct will zeroed and configured with the filter parameters

Return type:

out_filter: Dee.Filter

Create a new Dee.Filter with the given parameters. This call will zero the out_filter struct.

Dee.filter_new_collator(column)¶

Parameters:: column (int) – The index of a column containing the strings to sort after
Returns:: A pointer to an uninitialized Dee.Filter struct. This struct will zeroed and configured with the filter parameters
Return type:: out_filter: Dee.Filter

Create a Dee.Filter that takes string values from a column in the model and builds a Dee.FilterModel with the rows sorted according to the collation rules of the current locale.

Dee.filter_new_collator_desc(column)¶

Parameters:: column (int) – The index of a column containing the strings to sort after
Returns:: A pointer to an uninitialized Dee.Filter struct. This struct will zeroed and configured with the filter parameters
Return type:: out_filter: Dee.Filter

Create a Dee.Filter that takes string values from a column in the model and builds a Dee.FilterModel with the rows sorted descending according to the collation rules of the current locale.

Dee.filter_new_for_any_column(column, value)¶

Parameters:

column (int) – The index of a column containing the string to match
value (GLib.Variant) – A GLib.Variant value columns must match exactly. The matching semantics are those of GLib.Variant.equal(). If value is floating the ownership will be transfered to the filter

Returns:

A pointer to an uninitialized Dee.Filter struct. This struct will zeroed and configured with the filter parameters

Return type:

out_filter: Dee.Filter

Create a Dee.Filter that only includes rows from the original model which match a variant value in a given column. A Dee.FilterModel created with this filter will be ordered in accordance with its parent model.

This method will work on any column, disregarding its schema, since the value comparison is done using GLib.Variant.equal(). This means you can use this filter as a convenient fallback when there is no predefined filter for your column type if raw performance is not paramount.

Dee.filter_new_for_key_column(column, key)¶

Parameters:

column (int) – The index of a column containing the string key to match
key (str) –

Returns:

A pointer to an uninitialized Dee.Filter struct. This struct will zeroed and configured with the filter parameters

Return type:

out_filter: Dee.Filter

Create a Dee.Filter that only includes rows from the original model which has an exact match on some string column. A Dee.FilterModel created with this filter will be ordered in accordance with its parent model.

Dee.filter_new_regex(column, regex)¶

Parameters:

column (int) – The index of a column containing the string to match
regex (GLib.Regex) – The regular expression column must match

Returns:

A pointer to an uninitialized Dee.Filter struct. This struct will zeroed and configured with the filter parameters

Return type:

out_filter: Dee.Filter

Create a Dee.Filter that only includes rows from the original model which match a regular expression on some string column. A Dee.FilterModel created with this filter will be ordered in accordance with its parent model.

Dee.filter_new_sort(cmp_row, *cmp_user_data)¶

Parameters:

cmp_row (Dee.CompareRowFunc) – A Dee.CompareRowFunc to use for sorting
cmp_user_data (object or None) – User data passed to cmp_row

Returns:

A pointer to an uninitialized Dee.Filter struct. This struct will zeroed and configured with the filter parameters

Return type:

out_filter: Dee.Filter

Create a new Dee.Filter sorting a model according to a Dee.CompareRowFunc.

Dee.icu_error_quark()¶

Return type:: int

Dee.model_reader_new(reader_func, *userdata)¶

Parameters:

reader_func (Dee.ModelReaderFunc) – The Dee.ModelReaderFunc to use for the reader
userdata (object or None) – The user data to pass to reader_func

Returns:

A pointer to an uninitialized Dee.ModelReader struct

Return type:

out_reader: Dee.ModelReader

Create a new Dee.ModelReader with the given parameters. This call will zero the out_reader struct.

Dee.model_reader_new_for_int32_column(column)¶

Parameters:: column (int) – The column index to read a %gint32 from
Returns:: A pointer to a Dee.ModelReader instance which will have all fields initialized appropriately
Return type:: out_reader: Dee.ModelReader

A Dee.ModelReader reading a %gint32 from a Dee.Model at a given column

Dee.model_reader_new_for_string_column(column)¶

Parameters:: column (int) – The column index to read a string from
Returns:: A pointer to a Dee.ModelReader instance which will have all fields initialized appropriately
Return type:: out_reader: Dee.ModelReader

A Dee.ModelReader reading a string from a Dee.Model at a given column

Dee.model_reader_new_for_uint32_column(column)¶

Parameters:: column (int) – The column index to read a %guint32 from
Returns:: A pointer to a Dee.ModelReader instance which will have all fields initialized appropriately
Return type:: out_reader: Dee.ModelReader

A Dee.ModelReader reading a %guint32 from a Dee.Model at a given column

Dee.resource_manager_get_default()¶

Returns:: The default resource manager for the platform. Do not unreference. If you need to keep the instance around you must manually reference it.
Return type:: Dee.ResourceManager

Get a pointer to the platform default Dee.ResourceManager.

Dee.serializable_parse(data, type)¶

Parameters:

data (GLib.Variant) – The GLib.Variant data to parse. If this is a floating reference it will be consumed
type (GObject.GType) – The GObject.GType of the class to instantiate from data

Returns:

A newly constructed GObject.Object build from data or None in case no parser has been registered for the given GObject.GType or variant signature. Free with GObject.Object.unref().

Return type:

GObject.Object

Reconstruct a Dee.Serializable from GLib.Variant data. For this function to work you need to register a parser with dee_serializable_register_parser(). Any native Dee class will do so automatically.

This method only works on data created with Dee.Serializable.serialize() and not with data from Dee.Serializable.externalize().

Since a Dee.SerializableParseFunc is not allowed to fail - by contract - it can be guaranteed that this function only returns None in case there is no known parser for type and GLib.Variant signature of data.

Dee.serializable_parse_external(data)¶

Parameters:: data (GLib.Variant) – The GLib.Variant data to parse
Returns:: A newly constructed GObject.Object build from data or None in case no parser has been registered for the given GObject.GType or variant signature. Free with GObject.Object.unref().
Return type:: GObject.Object

Reconstruct a Dee.Serializable from GLib.Variant data. For this function to work you need to register a parser with dee_serializable_register_parser(). Any native Dee class will do so automatically.

This method only works on data created with Dee.Serializable.externalize() and not with data from Dee.Serializable.serialize().

Since a Dee.SerializableParseFunc is not allowed to fail - by contract - it can be guaranteed that this function only returns None in case there is no known parser for the GObject.GType or GLib.Variant signature of data.