Cleaning up the documentation.
[hildon] / src / hildon-note.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.
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_NOTE_H__
26 #define                                         __HILDON_NOTE_H__
27
28 #include                                        <gtk/gtkdialog.h>
29 #include                                        <gtk/gtkprogressbar.h>
30
31 G_BEGIN_DECLS
32
33 #define                                         HILDON_TYPE_NOTE \
34                                                 (hildon_note_get_type())
35
36 #define                                         HILDON_NOTE(obj) \
37                                                 (GTK_CHECK_CAST (obj, HILDON_TYPE_NOTE, HildonNote))
38
39 #define                                         HILDON_NOTE_CLASS(klass) \
40                                                 (GTK_CHECK_CLASS_CAST ((klass), \
41                                                 HILDON_TYPE_NOTE, HildonNoteClass))
42
43 #define                                         HILDON_IS_NOTE(obj) \
44                                                 (GTK_CHECK_TYPE (obj, HILDON_TYPE_NOTE))
45
46 #define                                         HILDON_IS_NOTE_CLASS(klass) \
47                                                 (GTK_CHECK_CLASS_TYPE ((klass), HILDON_TYPE_NOTE))
48
49 typedef struct                                  _HildonNote HildonNote;
50
51 typedef struct                                  _HildonNoteClass HildonNoteClass;
52
53 struct                                          _HildonNote 
54 {
55     GtkDialog parent;
56 };
57
58 struct _HildonNoteClass 
59 {
60     GtkDialogClass parent_class;
61 };
62
63 GType G_GNUC_CONST
64 hildon_note_get_type                            (void);
65
66 GtkWidget*
67 hildon_note_new_confirmation                    (GtkWindow *parent,
68                                                  const gchar *description);
69
70 GtkWidget*
71 hildon_note_new_confirmation_add_buttons        (GtkWindow *parent,
72                                                  const gchar *description, 
73                                                  ...);
74
75 GtkWidget*
76 hildon_note_new_confirmation_with_icon_name     (GtkWindow *parent,
77                                                  const gchar *description,
78                                                  const gchar *icon_name);
79
80 GtkWidget*
81 hildon_note_new_cancel_with_progress_bar        (GtkWindow *parent,
82                                                  const gchar *description,
83                                                  GtkProgressBar *progressbar);
84
85 GtkWidget*
86 hildon_note_new_information                     (GtkWindow *parent,
87                                                  const gchar *description);
88                                        
89 GtkWidget*
90 hildon_note_new_information_with_icon_name      (GtkWindow *parent,
91                                                  const gchar *description,
92                                                  const gchar *icon_name);
93                                                        
94 void 
95 hildon_note_set_button_text                     (HildonNote *note, 
96                                                  const gchar *text);
97
98 void 
99 hildon_note_set_button_texts                    (HildonNote *note, 
100                                                  const gchar *text_ok,
101                                                  const gchar *text_cancel);
102
103 typedef enum
104 {
105     HILDON_NOTE_CONFIRMATION_TYPE = 0,
106     HILDON_NOTE_CONFIRMATION_BUTTON_TYPE,
107     HILDON_NOTE_INFORMATION_TYPE,
108     HILDON_NOTE_INFORMATION_THEME_TYPE,
109     HILDON_NOTE_PROGRESSBAR_TYPE
110 }                                               HildonNoteType;
111
112 G_END_DECLS
113
114 #endif                                          /* __HILDON_NOTE_H__ */