Callbacks

	CounterForeachFunc (counter, *user_data)
	DirectoryModelVisibleFunc (self, directory, file_info, *user_data)
	ListModelFilterFunc (object, *user_data)
	RecursiveIgnoreFunc (file, *user_data)
	ShortcutChordTableForeach (chord, chord_data, *user_data)
	StackListCreateWidgetFunc (item, *user_data)
	SuggestionPositionFunc (entry, area, is_absolute, *user_data)
	TaskCacheCallback (self, key, task, *user_data)
	TreeFilterFunc (tree, node, *user_data)
	TreeFindFunc (tree, node, child, *user_data)
	TreeNodeCompareFunc (a, b, *user_data)
	TrieTraverseFunc (dzl_trie, key, value, *user_data)

Details

Dazzle.CounterForeachFunc(counter, *user_data)

Parameters:

• counter (Dazzle.Counter) – the counter.
• user_data (object or None) – data supplied to Dazzle.CounterArena.foreach().

Function prototype for callbacks provided to Dazzle.CounterArena.foreach().

Dazzle.DirectoryModelVisibleFunc(self, directory, file_info, *user_data)

Parameters:

• self (Dazzle.DirectoryModel) –
• directory (Gio.File) –
• file_info (Gio.FileInfo) –
• user_data (object or None) –

Return type:

bool

Dazzle.ListModelFilterFunc(object, *user_data)

Parameters:

• object (GObject.Object) –
• user_data (object or None) –

Return type:

bool

Dazzle.RecursiveIgnoreFunc(file, *user_data)

Parameters:

• file (Gio.File) –
• user_data (object or None) –

Return type:

bool

Dazzle.ShortcutChordTableForeach(chord, chord_data, *user_data)

Parameters:

• chord (Dazzle.ShortcutChord) –
• chord_data (object or None) –
• user_data (object or None) –

Dazzle.StackListCreateWidgetFunc(item, *user_data)

Parameters:

• item (GObject.Object) – the item from the model for which to create a widget for
• user_data (object or None) – user data from Dazzle.StackList.push()

Returns:

a Gtk.Widget that represents item

Return type:

Gtk.Widget

Called for stack lists that are bound to a Gio.ListModel with Dazzle.StackList.push() for each item that gets added to the model.

Dazzle.SuggestionPositionFunc(entry, area, is_absolute, *user_data)

Parameters:

• entry (Dazzle.SuggestionEntry) – a Dazzle.SuggestionEntry
• area (Gdk.Rectangle) – location to place the popover
• is_absolute (bool) – If the area is in absolute coordinates
• user_data (object or None) – closure data

Returns:

area:location to place the popover is_absolute:If the area is in absolute coordinates

Return type:

(area: Gdk.Rectangle, is_absolute: bool)

Positions the popover in the coordinates defined by area.

If is_absolute is set to True, then absolute coordinates are used. Otherwise, the position is expected to be relative to entry.

New in version 3.26.

Dazzle.TaskCacheCallback(self, key, task, *user_data)

Parameters:

• self (Dazzle.TaskCache) – An Dazzle.TaskCache.
• key (object or None) – the key to fetch
• task (Gio.Task) – the task to be completed
• user_data (object or None) – user_data registered at initialization.

Dazzle.TaskCacheCallback is the prototype for a function to be executed to populate an item in the cache.

This function will be executed when a fault (cache miss) occurs from a caller requesting an item from the cache.

The callee may complete the operation asynchronously, but MUST return either a GObject.Object using Gio.Task.return_pointer() or a GLib.Error using Gio.Task.return_error() or g_task_return_new_error().

Dazzle.TreeFilterFunc(tree, node, *user_data)

Parameters:

• tree (Dazzle.Tree) –
• node (Dazzle.TreeNode) –
• user_data (object or None) –

Returns:

True if node should be visible.

Return type:

bool

Callback to check if node should be visible.

Dazzle.TreeFindFunc(tree, node, child, *user_data)

Parameters:

• tree (Dazzle.Tree) –
• node (Dazzle.TreeNode) –
• child (Dazzle.TreeNode) –
• user_data (object or None) –

Returns:

True if child matched

Return type:

bool

Callback to check child, a child of node, matches a lookup request. Returns True if child matches, False if not.

Dazzle.TreeNodeCompareFunc(a, b, *user_data)

Parameters:

• a (Dazzle.TreeNode) –
• b (Dazzle.TreeNode) –
• user_data (object or None) –

Return type:

int

Dazzle.TrieTraverseFunc(dzl_trie, key, value, *user_data)

Parameters:

• dzl_trie (Dazzle.Trie) –
• key (str) –
• value (object or None) –
• user_data (object or None) –

Return type:

bool