aboutsummaryrefslogtreecommitdiff
path: root/hildon/hildon-note.h
blob: 6e8f67faa2fb9f93babaabc23636fba5d82230bc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
/*
 * This file is a part of hildon
 *
 * Copyright (C) 2005, 2006 Nokia Corporation, all rights reserved.
 *
 * Contact: Rodrigo Novo <rodrigo.novo@nokia.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 *
 */

#ifndef                                         __HILDON_NOTE_H__
#define                                         __HILDON_NOTE_H__

#include                                        <gtk/gtk.h>

G_BEGIN_DECLS

#define                                         HILDON_TYPE_NOTE \
                                                (hildon_note_get_type())

#define                                         HILDON_NOTE(obj) \
                                                (G_TYPE_CHECK_INSTANCE_CAST (obj, \
                                                HILDON_TYPE_NOTE, HildonNote))

#define                                         HILDON_NOTE_CLASS(klass) \
                                                (G_TYPE_CHECK_CLASS_CAST ((klass), \
                                                HILDON_TYPE_NOTE, HildonNoteClass))

#define                                         HILDON_IS_NOTE(obj) \
                                                (G_TYPE_CHECK_INSTANCE_TYPE (obj, HILDON_TYPE_NOTE))

#define                                         HILDON_IS_NOTE_CLASS(klass) \
                                                (G_TYPE_CHECK_CLASS_TYPE ((klass), HILDON_TYPE_NOTE))

typedef struct                                  _HildonNote HildonNote;

typedef struct                                  _HildonNoteClass HildonNoteClass;

struct                                          _HildonNote 
{
    GtkDialog parent;
};

struct _HildonNoteClass 
{
    GtkDialogClass parent_class;
};

GType G_GNUC_CONST
hildon_note_get_type                            (void);

GtkWidget*
hildon_note_new_confirmation                    (GtkWindow *parent,
                                                 const gchar *description);

GtkWidget*
hildon_note_new_confirmation_add_buttons        (GtkWindow *parent,
                                                 const gchar *description, 
                                                 ...);

#ifndef HILDON_DISABLE_DEPRECATED
GtkWidget*
hildon_note_new_confirmation_with_icon_name     (GtkWindow *parent,
                                                 const gchar *description,
                                                 const gchar *icon_name);
#endif

GtkWidget*
hildon_note_new_cancel_with_progress_bar        (GtkWindow *parent,
                                                 const gchar *description,
                                                 GtkProgressBar *progressbar);

GtkWidget*
hildon_note_new_information                     (GtkWindow *parent,
                                                 const gchar *description);
#ifndef HILDON_DISABLE_DEPRECATED
GtkWidget*
hildon_note_new_information_with_icon_name      (GtkWindow *parent,
                                                 const gchar *description,
                                                 const gchar *icon_name);
#endif

void 
hildon_note_set_button_text                     (HildonNote *note, 
                                                 const gchar *text);

void 
hildon_note_set_button_texts                    (HildonNote *note, 
                                                 const gchar *text_ok,
                                                 const gchar *text_cancel);

/**
 * HildonNoteType:
 * @HILDON_NOTE_TYPE_CONFIRMATION: Standard confirmation note with 'Yes'
 * and 'No' buttons.
 * @HILDON_NOTE_TYPE_CONFIRMATION_BUTTON: Confirmation note with
 * custom buttons.
 * @HILDON_NOTE_TYPE_INFORMATION: Information note with an 'OK' button.
 * @HILDON_NOTE_TYPE_INFORMATION_THEME: Deprecated information note with a themed
 * icon. Equivalent to %HILDON_NOTE_TYPE_INFORMATION.
 * @HILDON_NOTE_TYPE_PROGRESSBAR: Note with a #GtkProgressBar and an 'OK' button.
 *
 * Type of a #HildonNote, defining its behavior, contents, and theming.
 */
typedef enum
{
    HILDON_NOTE_TYPE_CONFIRMATION = 0,
    HILDON_NOTE_TYPE_CONFIRMATION_BUTTON,
    HILDON_NOTE_TYPE_INFORMATION,
    HILDON_NOTE_TYPE_INFORMATION_THEME,
    HILDON_NOTE_TYPE_PROGRESSBAR
}                                               HildonNoteType;

G_END_DECLS

#endif                                          /* __HILDON_NOTE_H__ */