### Interface

# Phosh DBusGnomeShell

#### Description [src]

    interface Phosh.DBusGnomeShell : GObject.Object

Abstract interface type for the D-Bus interface org.gnome.Shell.

#### Prerequisite

In order to implement DBusGnomeShell, your type must inherit from`GObject`.

#### Implementations

- PhoshDBusGnomeShellProxy
- PhoshDBusGnomeShellSkeleton
- PhoshGnomeShellManager

#### Functions

###### phosh_dbus_gnome_shell_interface_info

Gets a machine-readable description of the org.gnome.Shell D-Bus interface.

###### phosh_dbus_gnome_shell_override_properties

Overrides all `GObject` properties in the `PhoshDBusGnomeShell` interface for a concrete class. The properties are overridden in the order they are defined.

#### Instance methods

###### phosh_dbus_gnome_shell_call_grab_accelerator

Asynchronously invokes the GrabAccelerator() D-Bus method on `proxy`. 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 g_main_context_push_thread_default()). You can then call `phosh_dbus_gnome_shell_call_grab_accelerator_finish()` to get the result of the operation.

###### phosh_dbus_gnome_shell_call_grab_accelerator_finish

Finishes an operation started with phosh_dbus_gnome_shell_call_grab_accelerator().

###### phosh_dbus_gnome_shell_call_grab_accelerator_sync

Synchronously invokes the GrabAccelerator() D-Bus method on `proxy`. The calling thread is blocked until a reply is received.

###### phosh_dbus_gnome_shell_call_grab_accelerators

Asynchronously invokes the GrabAccelerators() D-Bus method on `proxy`. 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 g_main_context_push_thread_default()). You can then call `phosh_dbus_gnome_shell_call_grab_accelerators_finish()` to get the result of the operation.

###### phosh_dbus_gnome_shell_call_grab_accelerators_finish

Finishes an operation started with phosh_dbus_gnome_shell_call_grab_accelerators().

###### phosh_dbus_gnome_shell_call_grab_accelerators_sync

Synchronously invokes the GrabAccelerators() D-Bus method on `proxy`. The calling thread is blocked until a reply is received.

###### phosh_dbus_gnome_shell_call_hide_monitor_labels

Asynchronously invokes the HideMonitorLabels() D-Bus method on `proxy`. 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 g_main_context_push_thread_default()). You can then call `phosh_dbus_gnome_shell_call_hide_monitor_labels_finish()` to get the result of the operation.

###### phosh_dbus_gnome_shell_call_hide_monitor_labels_finish

Finishes an operation started with phosh_dbus_gnome_shell_call_hide_monitor_labels().

###### phosh_dbus_gnome_shell_call_hide_monitor_labels_sync

Synchronously invokes the HideMonitorLabels() D-Bus method on `proxy`. The calling thread is blocked until a reply is received.

###### phosh_dbus_gnome_shell_call_show_monitor_labels

Asynchronously invokes the ShowMonitorLabels() D-Bus method on `proxy`. 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 g_main_context_push_thread_default()). You can then call `phosh_dbus_gnome_shell_call_show_monitor_labels_finish()` to get the result of the operation.

###### phosh_dbus_gnome_shell_call_show_monitor_labels_finish

Finishes an operation started with phosh_dbus_gnome_shell_call_show_monitor_labels().

###### phosh_dbus_gnome_shell_call_show_monitor_labels_sync

Synchronously invokes the ShowMonitorLabels() D-Bus method on `proxy`. The calling thread is blocked until a reply is received.

###### phosh_dbus_gnome_shell_call_show_osd

Asynchronously invokes the ShowOSD() D-Bus method on `proxy`. 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 g_main_context_push_thread_default()). You can then call `phosh_dbus_gnome_shell_call_show_osd_finish()` to get the result of the operation.

###### phosh_dbus_gnome_shell_call_show_osd_finish

Finishes an operation started with phosh_dbus_gnome_shell_call_show_osd().

###### phosh_dbus_gnome_shell_call_show_osd_sync

Synchronously invokes the ShowOSD() D-Bus method on `proxy`. The calling thread is blocked until a reply is received.

###### phosh_dbus_gnome_shell_call_ungrab_accelerator

Asynchronously invokes the UngrabAccelerator() D-Bus method on `proxy`. 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 g_main_context_push_thread_default()). You can then call `phosh_dbus_gnome_shell_call_ungrab_accelerator_finish()` to get the result of the operation.

###### phosh_dbus_gnome_shell_call_ungrab_accelerator_finish

Finishes an operation started with phosh_dbus_gnome_shell_call_ungrab_accelerator().

###### phosh_dbus_gnome_shell_call_ungrab_accelerator_sync

Synchronously invokes the UngrabAccelerator() D-Bus method on `proxy`. The calling thread is blocked until a reply is received.

###### phosh_dbus_gnome_shell_call_ungrab_accelerators

Asynchronously invokes the UngrabAccelerators() D-Bus method on `proxy`. 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 g_main_context_push_thread_default()). You can then call `phosh_dbus_gnome_shell_call_ungrab_accelerators_finish()` to get the result of the operation.

###### phosh_dbus_gnome_shell_call_ungrab_accelerators_finish

Finishes an operation started with phosh_dbus_gnome_shell_call_ungrab_accelerators().

###### phosh_dbus_gnome_shell_call_ungrab_accelerators_sync

Synchronously invokes the UngrabAccelerators() D-Bus method on `proxy`. The calling thread is blocked until a reply is received.

###### phosh_dbus_gnome_shell_complete_grab_accelerator

Helper function used in service implementations to finish handling invocations of the GrabAccelerator() 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.

###### phosh_dbus_gnome_shell_complete_grab_accelerators

Helper function used in service implementations to finish handling invocations of the GrabAccelerators() 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.

###### phosh_dbus_gnome_shell_complete_hide_monitor_labels

Helper function used in service implementations to finish handling invocations of the HideMonitorLabels() 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.

###### phosh_dbus_gnome_shell_complete_show_monitor_labels

Helper function used in service implementations to finish handling invocations of the ShowMonitorLabels() 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.

###### phosh_dbus_gnome_shell_complete_show_osd

Helper function used in service implementations to finish handling invocations of the ShowOSD() 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.

###### phosh_dbus_gnome_shell_complete_ungrab_accelerator

Helper function used in service implementations to finish handling invocations of the UngrabAccelerator() 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.

###### phosh_dbus_gnome_shell_complete_ungrab_accelerators

Helper function used in service implementations to finish handling invocations of the UngrabAccelerators() 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.

###### phosh_dbus_gnome_shell_dup_shell_version

Gets a copy of the “ShellVersion” D-Bus property.

###### phosh_dbus_gnome_shell_emit_accelerator_activated

Emits the “AcceleratorActivated” D-Bus signal.

###### phosh_dbus_gnome_shell_get_overview_active

Gets the value of the “OverviewActive” D-Bus property.

###### phosh_dbus_gnome_shell_get_shell_version

Gets the value of the “ShellVersion” D-Bus property.

###### phosh_dbus_gnome_shell_set_overview_active

Sets the “OverviewActive” D-Bus property to `value`.

###### phosh_dbus_gnome_shell_set_shell_version

Sets the “ShellVersion” D-Bus property to `value`.

#### Properties

###### Phosh.DBusGnomeShell:overview-active

Represents the D-Bus property “OverviewActive”.

###### Phosh.DBusGnomeShell:shell-version

Represents the D-Bus property “ShellVersion”.

#### Signals

###### Phosh.DBusGnomeShell::accelerator-activated

On the client-side, this signal is emitted whenever the D-Bus signal “AcceleratorActivated” is received.

###### Phosh.DBusGnomeShell::handle-grab-accelerator

Signal emitted when a remote caller is invoking the GrabAccelerator() D-Bus method.

###### Phosh.DBusGnomeShell::handle-grab-accelerators

Signal emitted when a remote caller is invoking the GrabAccelerators() D-Bus method.

###### Phosh.DBusGnomeShell::handle-hide-monitor-labels

Signal emitted when a remote caller is invoking the HideMonitorLabels() D-Bus method.

###### Phosh.DBusGnomeShell::handle-show-monitor-labels

Signal emitted when a remote caller is invoking the ShowMonitorLabels() D-Bus method.

###### Phosh.DBusGnomeShell::handle-show-osd

Signal emitted when a remote caller is invoking the ShowOSD() D-Bus method.

###### Phosh.DBusGnomeShell::handle-ungrab-accelerator

Signal emitted when a remote caller is invoking the UngrabAccelerator() D-Bus method.

###### Phosh.DBusGnomeShell::handle-ungrab-accelerators

Signal emitted when a remote caller is invoking the UngrabAccelerators() D-Bus method.

#### Interface structure

    struct PhoshDBusGnomeShellIface {
      GTypeInterface parent_iface;
      gboolean (* handle_grab_accelerator) (
        PhoshDBusGnomeShell* object,
        GDBusMethodInvocation* invocation,
        const gchar* arg_accelerator,
        guint arg_modeFlags,
        guint arg_grabFlags
      );
      gboolean (* handle_grab_accelerators) (
        PhoshDBusGnomeShell* object,
        GDBusMethodInvocation* invocation,
        GVariant* arg_accelerators
      );
      gboolean (* handle_hide_monitor_labels) (
        PhoshDBusGnomeShell* object,
        GDBusMethodInvocation* invocation
      );
      gboolean (* handle_show_monitor_labels) (
        PhoshDBusGnomeShell* object,
        GDBusMethodInvocation* invocation,
        GVariant* arg_params
      );
      gboolean (* handle_show_osd) (
        PhoshDBusGnomeShell* object,
        GDBusMethodInvocation* invocation,
        GVariant* arg_params
      );
      gboolean (* handle_ungrab_accelerator) (
        PhoshDBusGnomeShell* object,
        GDBusMethodInvocation* invocation,
        guint arg_action
      );
      gboolean (* handle_ungrab_accelerators) (
        PhoshDBusGnomeShell* object,
        GDBusMethodInvocation* invocation,
        GVariant* arg_action
      );
      gboolean (* get_overview_active) (
        PhoshDBusGnomeShell* object
      );
      const gchar* (* get_shell_version) (
        PhoshDBusGnomeShell* object
      );
      void (* accelerator_activated) (
        PhoshDBusGnomeShell* object,
        guint arg_action,
        GVariant* arg_parameters
      );

    }

Virtual table for the D-Bus interface org.gnome.Shell.

###### Interface members

`parent_iface` |
    GTypeInterface
| The parent interface.
`handle_grab_accelerator` |
    gboolean (* handle_grab_accelerator) (
        PhoshDBusGnomeShell* object,
        GDBusMethodInvocation* invocation,
        const gchar* arg_accelerator,
        guint arg_modeFlags,
        guint arg_grabFlags
      )
| Handler for the `PhoshDBusGnomeShell::handle-grab-accelerator` signal.
`handle_grab_accelerators` |
    gboolean (* handle_grab_accelerators) (
        PhoshDBusGnomeShell* object,
        GDBusMethodInvocation* invocation,
        GVariant* arg_accelerators
      )
| Handler for the `PhoshDBusGnomeShell::handle-grab-accelerators` signal.
`handle_hide_monitor_labels` |
    gboolean (* handle_hide_monitor_labels) (
        PhoshDBusGnomeShell* object,
        GDBusMethodInvocation* invocation
      )
| Handler for the `PhoshDBusGnomeShell::handle-hide-monitor-labels` signal.
`handle_show_monitor_labels` |
    gboolean (* handle_show_monitor_labels) (
        PhoshDBusGnomeShell* object,
        GDBusMethodInvocation* invocation,
        GVariant* arg_params
      )
| Handler for the `PhoshDBusGnomeShell::handle-show-monitor-labels` signal.
`handle_show_osd` |
    gboolean (* handle_show_osd) (
        PhoshDBusGnomeShell* object,
        GDBusMethodInvocation* invocation,
        GVariant* arg_params
      )
| Handler for the `PhoshDBusGnomeShell::handle-show-osd` signal.
`handle_ungrab_accelerator` |
    gboolean (* handle_ungrab_accelerator) (
        PhoshDBusGnomeShell* object,
        GDBusMethodInvocation* invocation,
        guint arg_action
      )
| Handler for the `PhoshDBusGnomeShell::handle-ungrab-accelerator` signal.
`handle_ungrab_accelerators` |
    gboolean (* handle_ungrab_accelerators) (
        PhoshDBusGnomeShell* object,
        GDBusMethodInvocation* invocation,
        GVariant* arg_action
      )
| Handler for the `PhoshDBusGnomeShell::handle-ungrab-accelerators` signal.
`get_overview_active` |
    gboolean (* get_overview_active) (
        PhoshDBusGnomeShell* object
      )
| Getter for the `PhoshDBusGnomeShell:overview-active` property.
`get_shell_version` |
    const gchar* (* get_shell_version) (
        PhoshDBusGnomeShell* object
      )
| Getter for the `PhoshDBusGnomeShell:shell-version` property.
`accelerator_activated` |
    void (* accelerator_activated) (
        PhoshDBusGnomeShell* object,
        guint arg_action,
        GVariant* arg_parameters
      )
| Handler for the `PhoshDBusGnomeShell::accelerator-activated` signal.

#### Virtual methods

###### Phosh.DBusGnomeShell.accelerator_activated

Handler for the `PhoshDBusGnomeShell::accelerator-activated` signal.

###### Phosh.DBusGnomeShell.get_overview_active

Gets the value of the “OverviewActive” D-Bus property.

###### Phosh.DBusGnomeShell.get_shell_version

Gets the value of the “ShellVersion” D-Bus property.

###### Phosh.DBusGnomeShell.handle_grab_accelerator

Handler for the `PhoshDBusGnomeShell::handle-grab-accelerator` signal.

###### Phosh.DBusGnomeShell.handle_grab_accelerators

Handler for the `PhoshDBusGnomeShell::handle-grab-accelerators` signal.

###### Phosh.DBusGnomeShell.handle_hide_monitor_labels

Handler for the `PhoshDBusGnomeShell::handle-hide-monitor-labels` signal.

###### Phosh.DBusGnomeShell.handle_show_monitor_labels

Handler for the `PhoshDBusGnomeShell::handle-show-monitor-labels` signal.

###### Phosh.DBusGnomeShell.handle_show_osd

Handler for the `PhoshDBusGnomeShell::handle-show-osd` signal.

###### Phosh.DBusGnomeShell.handle_ungrab_accelerator

Handler for the `PhoshDBusGnomeShell::handle-ungrab-accelerator` signal.

###### Phosh.DBusGnomeShell.handle_ungrab_accelerators

Handler for the `PhoshDBusGnomeShell::handle-ungrab-accelerators` signal.