GnomeDesktop.IdleMonitor¶
- Subclasses:
None
Methods¶
- Inherited:
- Structs:
class |
|
|
|
|
|
|
|
|
Virtual Methods¶
- Inherited:
Properties¶
None
Signals¶
- Inherited:
Fields¶
- Inherited:
Name |
Type |
Access |
Description |
---|---|---|---|
parent |
r |
Class Details¶
- class GnomeDesktop.IdleMonitor(**kwargs)¶
- Bases:
- Abstract:
No
- Structure:
- classmethod new()¶
- Returns:
a new
GnomeDesktop.IdleMonitor
that tracks the server-global idletime for all devices.- Return type:
- add_idle_watch(interval_msec, callback, *user_data)¶
- Parameters:
interval_msec (
int
) – The idletime interval, in milliseconds. It must be a strictly positive value (> 0).callback (
GnomeDesktop.IdleMonitorWatchFunc
orNone
) – The callback to call when the user has accumulated interval_msec milliseconds of idle time.user_data (
object
orNone
) – The user data to pass to the callback
- Returns:
a watch id
Adds a watch for a specific idle time. The callback will be called when the user has accumulated interval_msec milliseconds of idle time. This function will return an ID that can either be passed to
GnomeDesktop.IdleMonitor.remove_watch
(), or can be used to tell idle time watches apart if you have more than one.Also note that this function will only care about positive transitions (user’s idle time exceeding a certain time). If you want to know about when the user has become active, use
GnomeDesktop.IdleMonitor.add_user_active_watch
().- Return type:
- add_user_active_watch(callback, *user_data)¶
- Parameters:
callback (
GnomeDesktop.IdleMonitorWatchFunc
orNone
) – The callback to call when the user is active again.user_data (
object
orNone
) – The user data to pass to the callback
- Returns:
a watch id
Add a one-time watch to know when the user is active again. Note that this watch is one-time and will de-activate after the function is called, for efficiency purposes. It’s most convenient to call this when an idle watch, as added by
GnomeDesktop.IdleMonitor.add_idle_watch
(), has triggered.- Return type:
- remove_watch(id)¶
- Parameters:
id (
int
) – A watch ID
Removes an idle time watcher, previously added by
GnomeDesktop.IdleMonitor.add_idle_watch
() orGnomeDesktop.IdleMonitor.add_user_active_watch
().