gnome-shell/src/shell-screenshot.h

/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
#ifndef __SHELL_SCREENSHOT_H__
#define __SHELL_SCREENSHOT_H__

/**
 * SECTION:shell-screenshot
 * @short_description: Grabs screenshots of areas and/or windows
 *
 * The #ShellScreenshot object is used to take screenshots of screen
 * areas or windows and write them out as png files.
 *
 */

typedef struct _ShellScreenshot         ShellScreenshot;
typedef struct _ShellScreenshotPrivate  ShellScreenshotPrivate;
typedef struct _ShellScreenshotClass    ShellScreenshotClass;

#define SHELL_TYPE_SCREENSHOT              (shell_screenshot_get_type ())
#define SHELL_SCREENSHOT(object)           (G_TYPE_CHECK_INSTANCE_CAST ((object), SHELL_TYPE_SCREENSHOT, ShellScreenshot))
#define SHELL_SCREENSHOT_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), SHELL_TYPE_SCREENSHOT, ShellScreenshotClass))
#define SHELL_IS_SCREENSHOT(object)        (G_TYPE_CHECK_INSTANCE_TYPE ((object), SHELL_TYPE_SCREENSHOT))
#define SHELL_IS_SCREENSHOT_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), SHELL_TYPE_SCREENSHOT))
#define SHELL_SCREENSHOT_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), SHELL_TYPE_SCREENSHOT, ShellScreenshotClass))

GType shell_screenshot_get_type (void) G_GNUC_CONST;

ShellScreenshot *shell_screenshot_new (void);

typedef void (*ShellScreenshotCallback)  (ShellScreenshot *screenshot,
                                          gboolean success,
                                          cairo_rectangle_int_t *screenshot_area,
                                          const gchar *filename_used);

void    shell_screenshot_screenshot_area      (ShellScreenshot *screenshot,
                                                int x,
                                                int y,
                                                int width,
                                                int height,
                                                const char *filename,
                                                ShellScreenshotCallback callback);

void    shell_screenshot_screenshot_window    (ShellScreenshot *screenshot,
                                                gboolean include_frame,
                                                gboolean include_cursor,
                                                const char *filename,
                                                ShellScreenshotCallback callback);

void    shell_screenshot_screenshot           (ShellScreenshot *screenshot,
                                                gboolean include_cursor,
                                                const char *filename,
                                                ShellScreenshotCallback callback);

#endif /* ___SHELL_SCREENSHOT_H__ */