### Interface

# Phosh DBusScreenshot

#### Description [src]

    interface Phosh.DBusScreenshot : GObject.Object

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

#### Prerequisite

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

#### Implementations

- PhoshDBusScreenshotProxy
- PhoshDBusScreenshotSkeleton
- PhoshScreenshotManager

#### Functions

###### phosh_dbus_screenshot_interface_info

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

###### phosh_dbus_screenshot_override_properties

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

#### Instance methods

###### phosh_dbus_screenshot_call_flash_area

Asynchronously invokes the FlashArea() 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_screenshot_call_flash_area_finish()` to get the result of the operation.

###### phosh_dbus_screenshot_call_flash_area_finish

Finishes an operation started with phosh_dbus_screenshot_call_flash_area().

###### phosh_dbus_screenshot_call_flash_area_sync

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

###### phosh_dbus_screenshot_call_pick_color

Asynchronously invokes the PickColor() 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_screenshot_call_pick_color_finish()` to get the result of the operation.

###### phosh_dbus_screenshot_call_pick_color_finish

Finishes an operation started with phosh_dbus_screenshot_call_pick_color().

###### phosh_dbus_screenshot_call_pick_color_sync

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

###### phosh_dbus_screenshot_call_screenshot

Asynchronously invokes the Screenshot() 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_screenshot_call_screenshot_finish()` to get the result of the operation.

###### phosh_dbus_screenshot_call_screenshot_area

Asynchronously invokes the ScreenshotArea() 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_screenshot_call_screenshot_area_finish()` to get the result of the operation.

###### phosh_dbus_screenshot_call_screenshot_area_finish

Finishes an operation started with phosh_dbus_screenshot_call_screenshot_area().

###### phosh_dbus_screenshot_call_screenshot_area_sync

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

###### phosh_dbus_screenshot_call_screenshot_finish

Finishes an operation started with phosh_dbus_screenshot_call_screenshot().

###### phosh_dbus_screenshot_call_screenshot_sync

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

###### phosh_dbus_screenshot_call_screenshot_window

Asynchronously invokes the ScreenshotWindow() 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_screenshot_call_screenshot_window_finish()` to get the result of the operation.

###### phosh_dbus_screenshot_call_screenshot_window_finish

Finishes an operation started with phosh_dbus_screenshot_call_screenshot_window().

###### phosh_dbus_screenshot_call_screenshot_window_sync

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

###### phosh_dbus_screenshot_call_select_area

Asynchronously invokes the SelectArea() 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_screenshot_call_select_area_finish()` to get the result of the operation.

###### phosh_dbus_screenshot_call_select_area_finish

Finishes an operation started with phosh_dbus_screenshot_call_select_area().

###### phosh_dbus_screenshot_call_select_area_sync

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

###### phosh_dbus_screenshot_complete_flash_area

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

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

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

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

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

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

#### Signals

###### Phosh.DBusScreenshot::handle-flash-area

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

###### Phosh.DBusScreenshot::handle-pick-color

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

###### Phosh.DBusScreenshot::handle-screenshot

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

###### Phosh.DBusScreenshot::handle-screenshot-area

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

###### Phosh.DBusScreenshot::handle-screenshot-window

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

###### Phosh.DBusScreenshot::handle-select-area

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

#### Interface structure

    struct PhoshDBusScreenshotIface {
      GTypeInterface parent_iface;
      gboolean (* handle_flash_area) (
        PhoshDBusScreenshot* object,
        GDBusMethodInvocation* invocation,
        gint arg_x,
        gint arg_y,
        gint arg_width,
        gint arg_height
      );
      gboolean (* handle_pick_color) (
        PhoshDBusScreenshot* object,
        GDBusMethodInvocation* invocation
      );
      gboolean (* handle_screenshot) (
        PhoshDBusScreenshot* object,
        GDBusMethodInvocation* invocation,
        gboolean arg_include_cursor,
        gboolean arg_flash,
        const gchar* arg_filename
      );
      gboolean (* handle_screenshot_area) (
        PhoshDBusScreenshot* object,
        GDBusMethodInvocation* invocation,
        gint arg_x,
        gint arg_y,
        gint arg_width,
        gint arg_height,
        gboolean arg_flash,
        const gchar* arg_filename
      );
      gboolean (* handle_screenshot_window) (
        PhoshDBusScreenshot* object,
        GDBusMethodInvocation* invocation,
        gboolean arg_include_frame,
        gboolean arg_include_cursor,
        gboolean arg_flash,
        const gchar* arg_filename
      );
      gboolean (* handle_select_area) (
        PhoshDBusScreenshot* object,
        GDBusMethodInvocation* invocation
      );

    }

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

###### Interface members

`parent_iface`

    GTypeInterface

| The parent interface.

`handle_flash_area`

    gboolean (* handle_flash_area) (
        PhoshDBusScreenshot* object,
        GDBusMethodInvocation* invocation,
        gint arg_x,
        gint arg_y,
        gint arg_width,
        gint arg_height
      )

| Handler for the `PhoshDBusScreenshot::handle-flash-area` signal.

`handle_pick_color`

    gboolean (* handle_pick_color) (
        PhoshDBusScreenshot* object,
        GDBusMethodInvocation* invocation
      )

| Handler for the `PhoshDBusScreenshot::handle-pick-color` signal.

`handle_screenshot`

    gboolean (* handle_screenshot) (
        PhoshDBusScreenshot* object,
        GDBusMethodInvocation* invocation,
        gboolean arg_include_cursor,
        gboolean arg_flash,
        const gchar* arg_filename
      )

| Handler for the `PhoshDBusScreenshot::handle-screenshot` signal.

`handle_screenshot_area`

    gboolean (* handle_screenshot_area) (
        PhoshDBusScreenshot* object,
        GDBusMethodInvocation* invocation,
        gint arg_x,
        gint arg_y,
        gint arg_width,
        gint arg_height,
        gboolean arg_flash,
        const gchar* arg_filename
      )

| Handler for the `PhoshDBusScreenshot::handle-screenshot-area` signal.

`handle_screenshot_window`

    gboolean (* handle_screenshot_window) (
        PhoshDBusScreenshot* object,
        GDBusMethodInvocation* invocation,
        gboolean arg_include_frame,
        gboolean arg_include_cursor,
        gboolean arg_flash,
        const gchar* arg_filename
      )

| Handler for the `PhoshDBusScreenshot::handle-screenshot-window` signal.

`handle_select_area`

    gboolean (* handle_select_area) (
        PhoshDBusScreenshot* object,
        GDBusMethodInvocation* invocation
      )

| Handler for the `PhoshDBusScreenshot::handle-select-area` signal.

#### Virtual methods

###### Phosh.DBusScreenshot.handle_flash_area

Handler for the `PhoshDBusScreenshot::handle-flash-area` signal.

###### Phosh.DBusScreenshot.handle_pick_color

Handler for the `PhoshDBusScreenshot::handle-pick-color` signal.

###### Phosh.DBusScreenshot.handle_screenshot

Handler for the `PhoshDBusScreenshot::handle-screenshot` signal.

###### Phosh.DBusScreenshot.handle_screenshot_area

Handler for the `PhoshDBusScreenshot::handle-screenshot-area` signal.

###### Phosh.DBusScreenshot.handle_screenshot_window

Handler for the `PhoshDBusScreenshot::handle-screenshot-window` signal.

###### Phosh.DBusScreenshot.handle_select_area

Handler for the `PhoshDBusScreenshot::handle-select-area` signal.