* A lot of changes in the documentation, now it's generated correctly
[modest] / src / widgets / modest-toolbar.h
1 /* Copyright (c) 2006, Nokia Corporation
2  * All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  * * Redistributions of source code must retain the above copyright
9  *   notice, this list of conditions and the following disclaimer.
10  * * Redistributions in binary form must reproduce the above copyright
11  *   notice, this list of conditions and the following disclaimer in the
12  *   documentation and/or other materials provided with the distribution.
13  * * Neither the name of the Nokia Corporation nor the names of its
14  *   contributors may be used to endorse or promote products derived from
15  *   this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
18  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
20  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
21  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29
30 #ifndef __MODEST_TOOLBAR_H__
31 #define __MODEST_TOOLBAR_H__
32
33 #include <gtk/gtk.h>
34 #include <modest-icon-factory.h>
35 #include <modest-icon-names.h>
36
37 G_BEGIN_DECLS
38
39 /* convenience macros */
40 #define MODEST_TYPE_TOOLBAR             (modest_toolbar_get_type())
41 #define MODEST_TOOLBAR(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_TOOLBAR,ModestToolbar))
42 #define MODEST_TOOLBAR_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_TOOLBAR,GtkToolbar))
43 #define MODEST_IS_TOOLBAR(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_TOOLBAR))
44 #define MODEST_IS_TOOLBAR_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_TOOLBAR))
45 #define MODEST_TOOLBAR_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_TOOLBAR,ModestToolbarClass))
46
47 typedef struct _ModestToolbar      ModestToolbar;
48 typedef struct _ModestToolbarClass ModestToolbarClass;
49
50 /* typedef enum _ModestToolbarButton ModestToolbarButton; */
51 typedef enum _ModestToolbarButton {
52         MODEST_TOOLBAR_BUTTON_MAIL_SEND,
53         MODEST_TOOLBAR_BUTTON_NEW_MAIL,
54         MODEST_TOOLBAR_BUTTON_REPLY,
55         MODEST_TOOLBAR_BUTTON_REPLY_ALL,
56         MODEST_TOOLBAR_BUTTON_FORWARD,
57         MODEST_TOOLBAR_BUTTON_PRINT,
58         MODEST_TOOLBAR_BUTTON_DELETE,
59         MODEST_TOOLBAR_BUTTON_NEXT,
60         MODEST_TOOLBAR_BUTTON_PREV,
61         MODEST_TOOLBAR_BUTTON_STOP,
62         MODEST_TOOLBAR_BUTTON_SEND_RECEIVE,
63
64         MODEST_TOOLBAR_SEPARATOR,
65         MODEST_TOOLBAR_BUTTON_NUM
66 } ModestToolbarButton;
67
68 struct _ModestToolbar {
69          GtkToolbar parent;
70         /* insert public members, if any */
71 };
72
73 struct _ModestToolbarClass {
74         GtkToolbarClass parent_class;
75         
76         void (* button_clicked) (ModestToolbar* obj, ModestToolbarButton button_id);
77 };
78
79 /* member functions */
80 GType        modest_toolbar_get_type    (void) G_GNUC_CONST;
81
82 ModestToolbar*   modest_toolbar_new     (const GSList *buttons);
83
84 G_END_DECLS
85
86 #endif /* __MODEST_TOOLBAR_H__ */
87