docs: fix typos
[platform/upstream/glib.git] / gio / gnotification.h
1 /*
2  * Copyright © 2013 Lars Uebernickel
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General
15  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
16  *
17  * Authors: Lars Uebernickel <lars@uebernic.de>
18  */
19
20 #ifndef __G_NOTIFICATION_H__
21 #define __G_NOTIFICATION_H__
22
23 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
24 #error "Only <gio/gio.h> can be included directly."
25 #endif
26
27 #include <gio/giotypes.h>
28
29 G_BEGIN_DECLS
30
31 #define G_TYPE_NOTIFICATION         (g_notification_get_type ())
32 #define G_NOTIFICATION(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_NOTIFICATION, GNotification))
33 #define G_IS_NOTIFICATION(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_NOTIFICATION))
34
35 GLIB_AVAILABLE_IN_2_40
36 GType                   g_notification_get_type                         (void) G_GNUC_CONST;
37
38 GLIB_AVAILABLE_IN_2_40
39 GNotification *         g_notification_new                              (const gchar *title);
40
41 GLIB_AVAILABLE_IN_2_40
42 void                    g_notification_set_title                        (GNotification *notification,
43                                                                          const gchar   *title);
44
45 GLIB_AVAILABLE_IN_2_40
46 void                    g_notification_set_body                         (GNotification *notification,
47                                                                          const gchar   *body);
48
49 GLIB_AVAILABLE_IN_2_40
50 void                    g_notification_set_icon                         (GNotification *notification,
51                                                                          GIcon         *icon);
52
53 GLIB_AVAILABLE_IN_2_40
54 void                    g_notification_set_urgent                       (GNotification *notification,
55                                                                          gboolean       urgent);
56
57 GLIB_AVAILABLE_IN_2_40
58 void                    g_notification_add_button                       (GNotification *notification,
59                                                                          const gchar   *label,
60                                                                          const gchar   *detailed_action);
61
62 GLIB_AVAILABLE_IN_2_40
63 void                    g_notification_add_button_with_target           (GNotification *notification,
64                                                                          const gchar   *label,
65                                                                          const gchar   *action,
66                                                                          const gchar   *target_format,
67                                                                          ...);
68
69 GLIB_AVAILABLE_IN_2_40
70 void                    g_notification_add_button_with_target_value     (GNotification *notification,
71                                                                          const gchar   *label,
72                                                                          const gchar   *action,
73                                                                          GVariant      *target);
74
75 GLIB_AVAILABLE_IN_2_40
76 void                    g_notification_set_default_action               (GNotification *notification,
77                                                                          const gchar   *detailed_action);
78
79 GLIB_AVAILABLE_IN_2_40
80 void                    g_notification_set_default_action_and_target    (GNotification *notification,
81                                                                          const gchar   *action,
82                                                                          const gchar   *target_format,
83                                                                          ...);
84
85 GLIB_AVAILABLE_IN_2_40
86 void                 g_notification_set_default_action_and_target_value (GNotification *notification,
87                                                                          const gchar   *action,
88                                                                          GVariant      *target);
89
90 G_END_DECLS
91
92 #endif