org.gnome.Shell.Screenshot
org.gnome.Shell.Screenshot
org.gnome.Shell.Screenshot Screenshot interface

## Methods

    Screenshot       (IN  b include_cursor,
                      IN  b flash,
                      IN  s filename,
                      OUT b success,
                      OUT s filename_used);
    ScreenshotWindow (IN  b include_frame,
                      IN  b include_cursor,
                      IN  b flash,
                      IN  s filename,
                      OUT b success,
                      OUT s filename_used);
    ScreenshotArea   (IN  i x,
                      IN  i y,
                      IN  i width,
                      IN  i height,
                      IN  b flash,
                      IN  s filename,
                      OUT b success,
                      OUT s filename_used);
    FlashArea        (IN  i x,
                      IN  i y,
                      IN  i width,
                      IN  i height);
    SelectArea       (OUT i x,
                      OUT i y,
                      OUT i width,
                      OUT i height);

## Description

The interface used to capture pictures of the screen contents.

## Method Details

### The Screenshot() method

    Screenshot (IN  b include_cursor,
                IN  b flash,
                IN  s filename,
                OUT b success,
                OUT s filename_used);

Takes a screenshot of the whole screen and saves it in filename as png image, it returns a boolean indicating whether the operation was successful or not. filename can either be an absolute path or a basename, in which case the screenshot will be saved in the $XDG_PICTURES_DIR or the home directory if it doesn't exist. The filename used to save the screenshot will be returned in filename_used.

`IN b include_cursor`:

  Whether to include the cursor image or not

`IN b flash`:

  Whether to flash the screen or not

`IN s filename`:

  The filename for the screenshot

`OUT b success`:

  whether the screenshot was captured

`OUT s filename_used`:

  the file where the screenshot was saved

org.gnome.Shell.Screenshot.Screenshot()

### The ScreenshotWindow() method

    ScreenshotWindow (IN  b include_frame,
                      IN  b include_cursor,
                      IN  b flash,
                      IN  s filename,
                      OUT b success,
                      OUT s filename_used);

Takes a screenshot of the focused window (optionally omitting the frame) and saves it in filename as png image, it returns a boolean indicating whether the operation was successful or not. filename can either be an absolute path or a basename, in which case the screenshot will be saved in the $XDG_PICTURES_DIR or the home directory if it doesn't exist. The filename used to save the screenshot will be returned in filename_used.

`IN b include_frame`:

  Whether to include the frame or not

`IN b include_cursor`:

  Whether to include the cursor image or not

`IN b flash`:

  Whether to flash the window area or not

`IN s filename`:

  The filename for the screenshot

`OUT b success`:

  whether the screenshot was captured

`OUT s filename_used`:

  the file where the screenshot was saved

org.gnome.Shell.Screenshot.ScreenshotWindow()

### The ScreenshotArea() method

    ScreenshotArea (IN  i x,
                    IN  i y,
                    IN  i width,
                    IN  i height,
                    IN  b flash,
                    IN  s filename,
                    OUT b success,
                    OUT s filename_used);

Takes a screenshot of the passed in area and saves it in filename as png image, it returns a boolean indicating whether the operation was successful or not. filename can either be an absolute path or a basename, in which case the screenshot will be saved in the $XDG_PICTURES_DIR or the home directory if it doesn't exist. The filename used to save the screenshot will be returned in filename_used.

`IN i x`:

  the X coordinate of the area to capture

`IN i y`:

  the Y coordinate of the area to capture

`IN i width`:

  the width of the area to capture

`IN i height`:

  the height of the area to capture

`IN b flash`:

  whether to flash the area or not

`IN s filename`:

  the filename for the screenshot

`OUT b success`:

  whether the screenshot was captured

`OUT s filename_used`:

  the file where the screenshot was saved

org.gnome.Shell.Screenshot.ScreenshotArea()

### The FlashArea() method

    FlashArea (IN  i x,
               IN  i y,
               IN  i width,
               IN  i height);

Renders a flash spot effect in the specified rectangle of the screen.

`IN i x`:

  the X coordinate of the area to flash

`IN i y`:

  the Y coordinate of the area to flash

`IN i width`:

  the width of the area to flash

`IN i height`:

  the height of the area to flash

org.gnome.Shell.Screenshot.FlashArea()

### The SelectArea() method

    SelectArea (OUT i x,
                OUT i y,
                OUT i width,
                OUT i height);

Interactively allows the user to select a rectangular area of the screen, and returns its coordinates.

`OUT i x`:

  the X coordinate of the selected area

`OUT i y`:

  the Y coordinate of the selected area

`OUT i width`:

  the width of the selected area

`OUT i height`:

  the height of the selected area

org.gnome.Shell.Screenshot.SelectArea()