EDataServer.SourceRegistryWatcher

g EDataServer.SourceRegistryWatcher EDataServer.SourceRegistryWatcher GObject.Object GObject.Object GObject.Object->EDataServer.SourceRegistryWatcher

Subclasses:None

Methods

Inherited:GObject.Object (37)
Structs:GObject.ObjectClass (5)
class new (registry, extension_name)
  get_extension_name ()
  get_registry ()
  reclaim ()

Virtual Methods

Inherited:GObject.Object (7)
  do_appeared (source)
  do_disappeared (source)
  do_filter (source)

Properties

Name Type Flags Short Description
extension-name str r/w/co  
registry EDataServer.SourceRegistry r/w/co Data source registry

Signals

Inherited:GObject.Object (1)
Name Short Description
appeared A signal emitted when the source is enabled or added and it had been considered for inclusion with the ESourceRegistryWatcher::filter signal.
disappeared A signal emitted when the source is disabled or removed and it had been considered for inclusion with the ESourceRegistryWatcher::filter signal earlier.
filter A filter signal which verifies whether the source can be considered for inclusion in the watcher or not.

Fields

Inherited:GObject.Object (1)
Name Type Access Description
parent GObject.Object r  

Class Details

class EDataServer.SourceRegistryWatcher(**kwargs)
Bases:GObject.Object
Abstract:No
Structure:EDataServer.SourceRegistryWatcherClass

Contains only private data that should be read and manipulated using the functions below.

classmethod new(registry, extension_name)
Parameters:
Returns:

an EDataServer.SourceRegistryWatcher

Return type:

EDataServer.SourceRegistryWatcher

Creates a new EDataServer.SourceRegistryWatcher instance.

The extension_name can be used as a complementary filter to EDataServer.SourceRegistryWatcher ::filter signal.

New in version 3.26.

get_extension_name()
Returns:The extension name passed to EDataServer.SourceRegistryWatcher.new().
Return type:str or None

New in version 3.26.

get_registry()
Returns:an EDataServer.SourceRegistry
Return type:EDataServer.SourceRegistry

Returns the EDataServer.SourceRegistry passed to EDataServer.SourceRegistryWatcher.new().

New in version 3.26.

reclaim()

Reclaims all available sources satisfying the EDataServer.SourceRegistryWatcher ::filter signal. It doesn’t notify about disappeared sources, it notifies only on those appeared.

New in version 3.26.

do_appeared(source) virtual
Parameters:source (EDataServer.Source) –
do_disappeared(source) virtual
Parameters:source (EDataServer.Source) –
do_filter(source) virtual
Parameters:source (EDataServer.Source) –
Return type:bool

Signal Details

EDataServer.SourceRegistryWatcher.signals.appeared(source_registry_watcher, source)
Signal Name:

appeared

Flags:

RUN_LAST

Parameters:

A signal emitted when the source is enabled or added and it had been considered for inclusion with the ESourceRegistryWatcher::filter signal.

New in version 3.26.

EDataServer.SourceRegistryWatcher.signals.disappeared(source_registry_watcher, source)
Signal Name:

disappeared

Flags:

RUN_LAST

Parameters:

A signal emitted when the source is disabled or removed and it had been considered for inclusion with the ESourceRegistryWatcher::filter signal earlier.

New in version 3.26.

EDataServer.SourceRegistryWatcher.signals.filter(source_registry_watcher, source)
Signal Name:

filter

Flags:

RUN_LAST, ACTION

Parameters:
Returns:

True, when the source can be included, False otherwise.

Return type:

bool

A filter signal which verifies whether the source can be considered for inclusion in the watcher or not. If none is set then all the sources are included.

New in version 3.26.

Property Details

EDataServer.SourceRegistryWatcher.props.extension_name
Name:extension-name
Type:str
Default Value:None
Flags:READABLE, WRITABLE, CONSTRUCT_ONLY

Optional extension name, to consider sources with only. It can be None, to check for all sources. This is a complementary filter to EDataServer.SourceRegistryWatcher ::filter signal.

New in version 3.26.

EDataServer.SourceRegistryWatcher.props.registry
Name:registry
Type:EDataServer.SourceRegistry
Default Value:None
Flags:READABLE, WRITABLE, CONSTRUCT_ONLY

The EDataServer.SourceRegistry manages EDataServer.Source instances.

New in version 3.26.