diff options
| author | Claudio Saavedra <csaavedra@igalia.com> | 2009-10-23 18:02:53 +0300 |
|---|---|---|
| committer | Claudio Saavedra <csaavedra@igalia.com> | 2009-10-23 18:05:26 +0300 |
| commit | 5ceea092b7335cc40fe043eef5889f67d5c30f5f (patch) | |
| tree | d7219e80a14bc77a200341d74c4acb8248639357 | |
| parent | 401c407cc5e28ede55df733bccc1f05139f54ad1 (diff) | |
Improve the documentation for hildon_gtk_window_take_screenshot()
Mention the fact that it's a Maemo 5 feature, what's the purpose
of the screenshot, and how to use it.
| -rw-r--r-- | hildon/hildon-gtk.c | 19 |
1 files changed, 17 insertions, 2 deletions
diff --git a/hildon/hildon-gtk.c b/hildon/hildon-gtk.c index f67f830..5b2f8cc 100644 --- a/hildon/hildon-gtk.c +++ b/hildon/hildon-gtk.c @@ -456,8 +456,23 @@ hildon_gtk_window_enable_zoom_keys (GtkWindow *window, * @window: a #GtkWindow * @take: %TRUE to take a screenshot, %FALSE to destroy the existing one. * - * Tells the window manager to take a screenshot of @window, or to - * destroy the existing one. @window must be mapped. + * Tells the window manager to create a screenshot of @window and save + * it, or to destroy the existing one. If @take is %TRUE but the + * screenshot is already available, the window manager will not create + * it again. + * + * You should only call this method when @window is already mapped. + * + * In Maemo 5 this screenshot, if existent, will be used by the window + * manager in subsequent launches of the application that created + * it. The window manager will remove this screenshot automatically + * whenever the theme, locale, or the time changes; also when a backup + * is restored. If your application changes its appearance between + * runs and you want to force the existent screenshot to be removed, + * set @take to %FALSE. + * + * Since: 2.2 + * **/ void hildon_gtk_window_take_screenshot (GtkWindow *window, |