5d8d2127adc0cd9d91b64e5fa2cdb6d737dfd67a
[hildon] / src / hildon-banner.h
1 /*
2  * This file is a part of hildon
3  *
4  * Copyright (C) 2005, 2006 Nokia Corporation, all rights reserved.
5  *
6  * Contact: Michael Dominic Kostrzewa <michael.kostrzewa@nokia.com>
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public License
10  * as published by the Free Software Foundation; version 2.1 of
11  * the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful, but
14  * WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with this library; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
21  * 02110-1301 USA
22  *
23  */
24
25 #ifndef                                         __HILDON_BANNER_H__
26 #define                                         __HILDON_BANNER_H__
27
28 #include                                        <gtk/gtk.h>
29
30 G_BEGIN_DECLS 
31
32 #define                                         HILDON_TYPE_BANNER \
33                                                 (hildon_banner_get_type())
34
35 #define                                         HILDON_BANNER(obj) \
36                                                 (G_TYPE_CHECK_INSTANCE_CAST((obj), \
37                                                 HILDON_TYPE_BANNER, HildonBanner))
38
39 #define                                         HILDON_IS_BANNER(obj) \
40                                                 (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
41                                                 HILDON_TYPE_BANNER))
42
43 typedef struct                                  _HildonBanner HildonBanner;
44
45 typedef struct                                  _HildonBannerClass HildonBannerClass;
46
47 struct                                          _HildonBanner
48 {
49    GtkWindow parent;
50 };
51
52 struct                                          _HildonBannerClass
53 {
54    GtkWindowClass parent_class;
55 };
56
57 GType G_GNUC_CONST
58 hildon_banner_get_type                          (void);
59
60 GtkWidget* 
61 hildon_banner_show_information                  (GtkWidget *widget, 
62                                                  const gchar *icon_name,
63                                                  const gchar *text);
64
65 GtkWidget*
66 hildon_banner_show_informationf                 (GtkWidget *widget, 
67                                                  const gchar *icon_name,
68                                                  const gchar *format, 
69                                                  ...);
70
71 GtkWidget*       
72 hildon_banner_show_information_with_markup      (GtkWidget *widget, 
73                                                  const gchar *icon_name,
74                                                  const gchar *markup);
75
76 GtkWidget*
77 hildon_banner_show_animation                    (GtkWidget *widget, 
78                                                  const gchar *animation_name,
79                                                  const gchar *text);
80
81 GtkWidget*
82 hildon_banner_show_progress                     (GtkWidget *widget, 
83                                                  GtkProgressBar *bar,
84                                                  const gchar *text);
85
86 void      
87 hildon_banner_set_text                          (HildonBanner *self,
88                                                  const gchar *text);
89
90 void      
91 hildon_banner_set_markup                        (HildonBanner *self,
92                                                  const gchar *markup);
93
94 void     
95 hildon_banner_set_fraction                      (HildonBanner *self,
96                                                  gdouble fraction);
97
98 void     
99 hildon_banner_set_icon                          (HildonBanner *self,
100                                                  const gchar *icon_name);
101
102 void     
103 hildon_banner_set_icon_from_file                (HildonBanner *self,
104                                                  const gchar *icon_file);
105
106 void
107 hildon_banner_set_timeout                       (HildonBanner *self,
108                                                  guint timeout);
109
110 G_END_DECLS
111
112 #endif                                          /* __HILDON_BANNER_H__ */