Dazzle.RecursiveFileMonitor¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` (root)
	`cancel` ()
	`get_root` ()
	`set_ignore_func` (ignore_func, *ignore_func_data)
	`start_async` (cancellable, callback, *user_data)
	`start_finish` (result)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`root`	`Gio.File`	r/w/co	The root directory to monitor

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`changed`	This event is similar to `Gio.FileMonitor` `::changed` but can be fired from any of the monitored directories in the recursive mount.

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class Dazzle.RecursiveFileMonitor(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: Dazzle.RecursiveFileMonitorClass

classmethod new(root)¶

Parameters:: root (Gio.File) –
Return type:: Dazzle.RecursiveFileMonitor

cancel()¶: Cancels the recursive file monitor.

New in version 3.28.

get_root()¶

Returns:: a Gio.File
Return type:: Gio.File

Gets the root directory used forthe file monitor.

New in version 3.28.

set_ignore_func(ignore_func, *ignore_func_data)¶

Parameters:

ignore_func (Dazzle.RecursiveIgnoreFunc) – a Dazzle.RecursiveIgnoreFunc
ignore_func_data (object or None) – closure data for ignore_func

Sets a callback function to determine if a Gio.File should be ignored from signal emission.

ignore_func will always be called from the applications main thread.

If ignore_func is None, it is set to the default which does not ignore any files or directories.

New in version 3.28.

start_async(cancellable, callback, *user_data)¶

Parameters:

cancellable (Gio.Cancellable or None) –
callback (Gio.AsyncReadyCallback or None) –
user_data (object or None) –

start_finish(result)¶

Parameters:: result (Gio.AsyncResult) –
Raises:: GLib.Error
Return type:: bool

Signal Details¶

Dazzle.RecursiveFileMonitor.signals.changed(recursive_file_monitor, file, other_file, event)¶

Signal Name:

changed

Flags:

RUN_LAST

Parameters:

recursive_file_monitor (Dazzle.RecursiveFileMonitor) – The object which received the signal
file (Gio.File) – a Gio.File
other_file (Gio.File or None) – a Gio.File for the other file when applicable
event (Gio.FileMonitorEvent) – the Gio.FileMonitorEvent event

This event is similar to Gio.FileMonitor ::changed but can be fired from any of the monitored directories in the recursive mount.

New in version 3.28.

Property Details¶

Dazzle.RecursiveFileMonitor.props.root¶

Name:: root
Type:: Gio.File
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The root directory to monitor