minor doc update
[hildon] / hildon-widgets / hildon-note.h
1 /*
2  * This file is part of hildon-libs
3  *
4  * Copyright (C) 2005 Nokia Corporation.
5  *
6  * Contact: Luc Pionchon <luc.pionchon@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; either 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 #ifndef __HILDON_NOTE_H__
25 #define __HILDON_NOTE_H__
26
27 #include <gtk/gtkdialog.h>
28 #include <gtk/gtkprogressbar.h>
29
30 G_BEGIN_DECLS
31 #define HILDON_TYPE_NOTE ( hildon_note_get_type() )
32 #define HILDON_NOTE(obj) \
33   (GTK_CHECK_CAST (obj, HILDON_TYPE_NOTE, HildonNote))
34 #define HILDON_NOTE_CLASS(klass) \
35   (GTK_CHECK_CLASS_CAST ((klass), HILDON_TYPE_NOTE, HildonNoteClass))
36 #define HILDON_IS_NOTE(obj) (GTK_CHECK_TYPE (obj, HILDON_TYPE_NOTE))
37 #define HILDON_IS_NOTE_CLASS(klass) \
38   (GTK_CHECK_CLASS_TYPE ((klass), HILDON_TYPE_NOTE))
39 typedef struct _HildonNote HildonNote;
40 typedef struct _HildonNoteClass HildonNoteClass;
41
42 typedef enum
43 {
44     HILDON_NOTE_CONFIRMATION_TYPE = 0,
45     HILDON_NOTE_CONFIRMATION_BUTTON_TYPE,
46     HILDON_NOTE_INFORMATION_TYPE,
47     HILDON_NOTE_INFORMATION_THEME_TYPE,
48     HILDON_NOTE_PROGRESSBAR_TYPE
49 } HildonNoteType;
50
51 struct _HildonNote {
52     GtkDialog parent;
53 };
54
55 struct _HildonNoteClass {
56     GtkDialogClass parent_class;
57 };
58
59 GtkWidget *hildon_note_new_confirmation(GtkWindow * parent,
60                                         const gchar * description);
61
62 GtkWidget *hildon_note_new_confirmation_add_buttons(GtkWindow * parent,
63                                                     const gchar *
64                                                     description, ...);
65 #ifndef HILDON_DISABLE_DEPRECATED
66 GtkWidget *hildon_note_new_confirmation_with_icon_stock(GtkWindow * parent,
67                                                         const gchar *
68                                                         description,
69                                                         const gchar *
70                                                         stock_id);
71 #endif /* HILDON_DISABLE_DEPRECATED */
72
73 GtkWidget *hildon_note_new_confirmation_with_icon_name(GtkWindow * parent,
74                                                         const gchar *
75                                                         description,
76                                                         const gchar *
77                                                         icon_name);
78
79
80 GtkWidget *hildon_note_new_cancel_with_progress_bar(GtkWindow * parent,
81                                                     const gchar *
82                                                     description,
83                                                     GtkProgressBar *
84                                                     progressbar);
85
86 GtkWidget *hildon_note_new_information(GtkWindow * parent,
87                                        const gchar * description);
88                                        
89 GtkWidget *hildon_note_new_information_with_icon_name(GtkWindow * parent,
90                                                        const gchar *
91                                                        description,
92                                                        const gchar *
93                                                        icon_name);
94 #ifndef HILDON_DISABLE_DEPRECATED
95 GtkWidget *hildon_note_new_information_with_icon_stock(GtkWindow * parent,
96                                                        const gchar *
97                                                        description,
98                                                        const gchar *
99                                                        stock_id);
100                                                        
101 GtkWidget *hildon_note_new_information_with_icon_theme(GtkWindow * parent,
102                                                        const gchar *
103                                                        description,
104                                                        const gchar *
105                                                        icon);
106 #endif /* HILDON_DISABLE_DEPRECATED */
107                                                        
108 void hildon_note_set_button_text(HildonNote * note, const gchar * text);
109
110 void hildon_note_set_button_texts(HildonNote * note, const gchar * textOk,
111                                  const gchar * textCancel);
112
113 GType hildon_note_get_type(void) G_GNUC_CONST;
114 GType hildon_note_type_get_type(void) G_GNUC_CONST;
115
116 G_END_DECLS
117 #endif /* __HILDON_NOTE_H__ */