CScreensaver.KeybindingHandler¶

Implementations:: CScreensaver.KeybindingHandlerProxy, CScreensaver.KeybindingHandlerSkeleton

Methods¶

class	`interface_info` ()
class	`override_properties` (klass, property_id_begin)
	`call_handle_keybinding` (arg_type, cancellable, callback, *user_data)
	`call_handle_keybinding_finish` (res)
	`call_handle_keybinding_sync` (arg_type, cancellable)
	`complete_handle_keybinding` (invocation)

Virtual Methods¶

do_handle_handle_keybinding (invocation, arg_type)

Properties¶

None

Signals¶

Name	Short Description
`handle-handle-keybinding`	Signal emitted when a remote caller is invoking the ‘HandleKeybinding() [gdbus-method-org-cinnamon-SettingsDaemon-KeybindingHandler.HandleKeybinding]’ D-Bus method.

Fields¶

None

Class Details¶

class CScreensaver.KeybindingHandler¶

Bases:: GObject.GInterface
Structure:: CScreensaver.KeybindingHandlerIface

Abstract interface type for the D-Bus interface ‘org.cinnamon.SettingsDaemon.KeybindingHandler [gdbus-interface-org-cinnamon-SettingsDaemon-KeybindingHandler.top_of_page]’.

classmethod interface_info()¶

Returns:: A Gio.DBusInterfaceInfo. Do not free.
Return type:: Gio.DBusInterfaceInfo

Gets a machine-readable description of the ‘org.cinnamon.SettingsDaemon.KeybindingHandler [gdbus-interface-org-cinnamon-SettingsDaemon-KeybindingHandler.top_of_page]’ D-Bus interface.

classmethod override_properties(klass, property_id_begin)¶

Parameters:

klass (GObject.ObjectClass) – The class structure for a GObject.Object derived class.
property_id_begin (int) – The property id to assign to the first overridden property.

Returns:

The last property id.

Return type:

int

Overrides all GObject.Object properties in the CScreensaver.KeybindingHandler interface for a concrete class. The properties are overridden in the order they are defined.

call_handle_keybinding(arg_type, cancellable, callback, *user_data)¶

Parameters:

arg_type (int) – Argument to pass with the method invocation.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None.
user_data (object or None) – User data to pass to callback.

Asynchronously invokes the ‘HandleKeybinding() [gdbus-method-org-cinnamon-SettingsDaemon-KeybindingHandler.HandleKeybinding]’ D-Bus method on self. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see GLib.MainContext.push_thread_default()). You can then call CScreensaver.KeybindingHandler.call_handle_keybinding_finish() to get the result of the operation.

See CScreensaver.KeybindingHandler.call_handle_keybinding_sync() for the synchronous, blocking version of this method.

call_handle_keybinding_finish(res)¶

Parameters:: res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to CScreensaver.KeybindingHandler.call_handle_keybinding().
Raises:: GLib.Error
Returns:: True if the call succeeded, False if error is set.
Return type:: bool

Finishes an operation started with CScreensaver.KeybindingHandler.call_handle_keybinding().

call_handle_keybinding_sync(arg_type, cancellable)¶

Parameters:

arg_type (int) – Argument to pass with the method invocation.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.

Raises:

GLib.Error

Returns:

True if the call succeeded, False if error is set.

Return type:

bool

Synchronously invokes the ‘HandleKeybinding() [gdbus-method-org-cinnamon-SettingsDaemon-KeybindingHandler.HandleKeybinding]’ D-Bus method on self. The calling thread is blocked until a reply is received.

See CScreensaver.KeybindingHandler.call_handle_keybinding() for the asynchronous version of this method.

complete_handle_keybinding(invocation)¶

Parameters:: invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

Helper function used in service implementations to finish handling invocations of the ‘HandleKeybinding() [gdbus-method-org-cinnamon-SettingsDaemon-KeybindingHandler.HandleKeybinding]’ D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

This method will free invocation, you cannot use it afterwards.

do_handle_handle_keybinding(invocation, arg_type) virtual¶

Parameters:

invocation (Gio.DBusMethodInvocation) –
arg_type (int) –

Return type:

bool

Signal Details¶

CScreensaver.KeybindingHandler.signals.handle_handle_keybinding(keybinding_handler, invocation, arg_type)¶

Signal Name:

handle-handle-keybinding

Flags:

RUN_LAST

Parameters:

keybinding_handler (CScreensaver.KeybindingHandler) – The object which received the signal
invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.
arg_type (int) – Argument passed by remote caller.

Returns:

Gio.DBUS_METHOD_INVOCATION_HANDLED or True if the invocation was handled, Gio.DBUS_METHOD_INVOCATION_UNHANDLED or False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the ‘HandleKeybinding() [gdbus-method-org-cinnamon-SettingsDaemon-KeybindingHandler.HandleKeybinding]’ D-Bus method.

If a signal handler returns True, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call CScreensaver.KeybindingHandler.complete_handle_keybinding() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the Gio.DBusError.UNKNOWN_METHOD error is returned.