CScreensaver.MuffinDisplayConfig¶

Implementations:: CScreensaver.MuffinDisplayConfigProxy, CScreensaver.MuffinDisplayConfigSkeleton

Methods¶

class	`interface_info` ()
class	`override_properties` (klass, property_id_begin)
	`call_get_current_state` (cancellable, callback, *user_data)
	`call_get_current_state_finish` (res)
	`call_get_current_state_sync` (cancellable)
	`complete_get_current_state` (invocation, serial, monitors, logical_monitors, properties)
	`emit_monitors_changed` ()

Virtual Methods¶

	`do_handle_get_current_state` (invocation)
	`do_monitors_changed` ()

Properties¶

None

Signals¶

Name	Short Description
`handle-get-current-state`	Signal emitted when a remote caller is invoking the ‘GetCurrentState() [gdbus-method-org-cinnamon-Muffin-DisplayConfig.GetCurrentState]’ D-Bus method.
`monitors-changed`	On the client-side, this signal is emitted whenever the D-Bus signal ‘“MonitorsChanged” [gdbus-signal-org-cinnamon-Muffin-DisplayConfig.MonitorsChanged]’ is received.

Fields¶

None

Class Details¶

class CScreensaver.MuffinDisplayConfig¶

Bases:: GObject.GInterface
Structure:: CScreensaver.MuffinDisplayConfigIface

Abstract interface type for the D-Bus interface ‘org.cinnamon.Muffin.DisplayConfig [gdbus-interface-org-cinnamon-Muffin-DisplayConfig.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.Muffin.DisplayConfig [gdbus-interface-org-cinnamon-Muffin-DisplayConfig.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.MuffinDisplayConfig interface for a concrete class. The properties are overridden in the order they are defined.

call_get_current_state(cancellable, callback, *user_data)¶

Parameters:

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 ‘GetCurrentState() [gdbus-method-org-cinnamon-Muffin-DisplayConfig.GetCurrentState]’ 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.MuffinDisplayConfig.call_get_current_state_finish() to get the result of the operation.

See CScreensaver.MuffinDisplayConfig.call_get_current_state_sync() for the synchronous, blocking version of this method.

call_get_current_state_finish(res)¶

Parameters:

res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to CScreensaver.MuffinDisplayConfig.call_get_current_state().

Raises:

GLib.Error

Returns:

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

out_serial:: Return location for return parameter or None to ignore.
out_monitors:: Return location for return parameter or None to ignore.
out_logical_monitors:: Return location for return parameter or None to ignore.
out_properties:: Return location for return parameter or None to ignore.

Return type:

(bool, out_serial: int, out_monitors: GLib.Variant, out_logical_monitors: GLib.Variant, out_properties: GLib.Variant)

Finishes an operation started with CScreensaver.MuffinDisplayConfig.call_get_current_state().

call_get_current_state_sync(cancellable)¶

Parameters:

cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.

Raises:

GLib.Error

Returns:

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

out_serial:: Return location for return parameter or None to ignore.
out_monitors:: Return location for return parameter or None to ignore.
out_logical_monitors:: Return location for return parameter or None to ignore.
out_properties:: Return location for return parameter or None to ignore.

Return type:

(bool, out_serial: int, out_monitors: GLib.Variant, out_logical_monitors: GLib.Variant, out_properties: GLib.Variant)

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

See CScreensaver.MuffinDisplayConfig.call_get_current_state() for the asynchronous version of this method.

complete_get_current_state(invocation, serial, monitors, logical_monitors, properties)¶

Parameters:

invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.
serial (int) – Parameter to return.
monitors (GLib.Variant) – Parameter to return.
logical_monitors (GLib.Variant) – Parameter to return.
properties (GLib.Variant) – Parameter to return.

Helper function used in service implementations to finish handling invocations of the ‘GetCurrentState() [gdbus-method-org-cinnamon-Muffin-DisplayConfig.GetCurrentState]’ 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.

emit_monitors_changed()¶: Emits the ‘“MonitorsChanged” [gdbus-signal-org-cinnamon-Muffin-DisplayConfig.MonitorsChanged]’ D-Bus signal.

do_handle_get_current_state(invocation) virtual¶

Parameters:: invocation (Gio.DBusMethodInvocation) –
Return type:: bool

do_monitors_changed() virtual¶

Signal Details¶

CScreensaver.MuffinDisplayConfig.signals.handle_get_current_state(muffin_display_config, invocation)¶

Signal Name:

handle-get-current-state

Flags:

RUN_LAST

Parameters:

muffin_display_config (CScreensaver.MuffinDisplayConfig) – The object which received the signal
invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

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 ‘GetCurrentState() [gdbus-method-org-cinnamon-Muffin-DisplayConfig.GetCurrentState]’ 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.MuffinDisplayConfig.complete_get_current_state() 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.

CScreensaver.MuffinDisplayConfig.signals.monitors_changed(muffin_display_config)¶

Signal Name:: monitors-changed
Flags:: RUN_LAST
Parameters:: muffin_display_config (CScreensaver.MuffinDisplayConfig) – The object which received the signal

On the client-side, this signal is emitted whenever the D-Bus signal ‘“MonitorsChanged” [gdbus-signal-org-cinnamon-Muffin-DisplayConfig.MonitorsChanged]’ is received.

On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal.