From 9bf93a6fc834107b9f417f9a3fded44020a7b663 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Thu, 13 Dec 2007 05:49:11 +0000 Subject: [PATCH] Add docs svn path=/trunk/; revision=19167 --- ChangeLog | 4 ++ docs/reference/ChangeLog | 5 ++ docs/reference/gdk/gdk-docs.sgml | 6 +++ docs/reference/gdk/gdk-sections.txt | 13 +++++ gdk/gdkapplaunchcontext.c | 79 ++++++++++++++++++++++++++++- 5 files changed, 106 insertions(+), 1 deletion(-) diff --git a/ChangeLog b/ChangeLog index 558433b70a..00a705d6f2 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ +2007-12-12 Matthias Clasen + + * gdk/gdkapplaunchcontext.c: Add docs + 2007-12-12 Matthias Clasen * gdk/gdkapplaunchcontext.[hc]: Implement GAppLaunchContext diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index 3660615991..e9602ab5e9 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,8 @@ +2007-12-12 Matthias Clasen + + * gdk/gdk-docs.sgml: + * gdk/gdk-sections.txt: Add GdkAppLaunchContext + 2007-12-11 Mathias Hasselmann * docs/reference/gtk/tmpl/gtkdnd.sgml: diff --git a/docs/reference/gdk/gdk-docs.sgml b/docs/reference/gdk/gdk-docs.sgml index 806ec85cee..028adfff38 100644 --- a/docs/reference/gdk/gdk-docs.sgml +++ b/docs/reference/gdk/gdk-docs.sgml @@ -30,6 +30,7 @@ + ]> @@ -84,6 +85,8 @@ &gdk-Pango-Interaction; &gdk-Cairo-Interaction; &gdk-X-Window-System-Interaction; + + &gdk-AppLaunchContext; @@ -110,5 +113,8 @@ Index of new symbols in 2.12 + + Index of new symbols in 2.16 + diff --git a/docs/reference/gdk/gdk-sections.txt b/docs/reference/gdk/gdk-sections.txt index 69adf717ea..0c663f3cdc 100644 --- a/docs/reference/gdk/gdk-sections.txt +++ b/docs/reference/gdk/gdk-sections.txt @@ -1334,3 +1334,16 @@ GDK_HAVE_WCTYPE_H gdk_iswalnum gdk_iswspace + +
+gdk/gdkapplaunchcontext.h +Application launching +gdkapplaunchcontext +gdk_app_launch_context_new +gdk_app_launch_context_set_display +gdk_app_launch_context_set_screen +gdk_app_launch_context_set_desktop +gdk_app_launch_context_set_timestamp +gdk_app_launch_context_set_icon +gdk_app_launch_context_set_icon_name +
diff --git a/gdk/gdkapplaunchcontext.c b/gdk/gdkapplaunchcontext.c index d63a2fc524..06955ddb13 100644 --- a/gdk/gdkapplaunchcontext.c +++ b/gdk/gdkapplaunchcontext.c @@ -108,6 +108,16 @@ gdk_app_launch_context_init (GdkAppLaunchContext *context) context->priv->workspace = -1; } +/** + * gdk_app_launch_context_set_display: + * @context: a #GdkAppLaunchContext + * @display: a #GdkDisplay + * + * Sets the display on which applications will be launched when + * using this context. See also gdk_app_launch_context_set_screen(). + * + * Since: 2.16 + */ void gdk_app_launch_context_set_display (GdkAppLaunchContext *context, GdkDisplay *display) @@ -121,6 +131,18 @@ gdk_app_launch_context_set_display (GdkAppLaunchContext *context, if (display) context->priv->display = g_object_ref (display); } + +/** + * gdk_app_launch_context_set_screen: + * @context: a #GdkAppLaunchContext + * @screen: a #GdkScreen + * + * Sets the screen on which applications will be launched when + * using this context. See also gdk_app_launch_context_set_display(). + * If both @screen and @display are set, the @screen takes priority. + * + * Since: 2.16 + */ void gdk_app_launch_context_set_screen (GdkAppLaunchContext *context, GdkScreen *screen) @@ -135,7 +157,19 @@ gdk_app_launch_context_set_screen (GdkAppLaunchContext *context, context->priv->screen = g_object_ref (screen); } - +/** + * gdk_app_launch_context_set_desktop: + * @context: a #GdkAppLaunchContext + * @desktop: the number of a workspace, or -1 + * + * Sets the workspace on which applications will be launched when + * using this context when running under a window manager that + * supports multiple workspaces, as described in the + * Extended + * Window Manager Hints. + * + * Since: 2.16 + */ void gdk_app_launch_context_set_desktop (GdkAppLaunchContext *context, gint desktop) @@ -143,6 +177,16 @@ gdk_app_launch_context_set_desktop (GdkAppLaunchContext *context, context->priv->workspace = desktop; } +/** + * gdk_app_launch_context_set_timestamp: + * @context: a #GdkAppLaunchContext + * @timestamp: a timestamp + * + * Sets the timestamp of @context. The timestamp should ideally + * be taken from the event that triggered the launch. + * + * Since: 2.16 + */ void gdk_app_launch_context_set_timestamp (GdkAppLaunchContext *context, guint32 timestamp) @@ -150,6 +194,16 @@ gdk_app_launch_context_set_timestamp (GdkAppLaunchContext *context, context->priv->timestamp = timestamp; } +/** + * gdk_app_launch_context_set_icon: + * @context: a #GdkAppLaunchContext + * @icon: a #GIcon, or %NULL + * + * Sets the icon for applications that are launched with this + * context. See also gdk_app_launch_context_set_icon_name(). + * + * Since: 2.16 + */ void gdk_app_launch_context_set_icon (GdkAppLaunchContext *context, GIcon *icon) @@ -164,6 +218,19 @@ gdk_app_launch_context_set_icon (GdkAppLaunchContext *context, context->priv->icon = g_object_ref (icon); } +/** + * gdk_app_launch_context_set_icon_name: + * @context: a #GdkAppLaunchContext + * @icon_name: an icon name, or %NULL + * + * Sets the icon for applications that are launched with this + * context. The @icon_name will be interpreted in the same way + * as the Icon field in desktop files. + * See also gdk_app_launch_context_set_icon(). If both @icon + * and @icon_name are set, the @icon_name takes priority. + * + * Since: 2.16 + */ void gdk_app_launch_context_set_icon_name (GdkAppLaunchContext *context, const char *icon_name) @@ -172,12 +239,22 @@ gdk_app_launch_context_set_icon_name (GdkAppLaunchContext *context, context->priv->icon_name = g_strdup (icon_name); } +/** + * gdk_app_launch_context_new: + * + * Creates a new #GdkAppLaunchContext. + * + * Returns: a new #GdkAppLaunchContext + * + * Since: 2.16 + */ GdkAppLaunchContext * gdk_app_launch_context_new (void) { GdkAppLaunchContext *context; context = g_object_new (gdk_app_launch_context_get_type (), NULL); + return context; }