1 /*
2  * e-shell-sidebar.h
3  *
4  * This program is free software; you can redistribute it and/or modify it
5  * under the terms of the GNU Lesser General Public License as published by
6  * the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful, but
9  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
10  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
11  * for more details.
12  *
13  * You should have received a copy of the GNU Lesser General Public License
14  * along with this program; if not, see <http://www.gnu.org/licenses/>.
15  *
16  *
17  * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
18  *
19  */
20 
21 #ifndef E_SHELL_SIDEBAR_H
22 #define E_SHELL_SIDEBAR_H
23 
24 #include <shell/e-shell-common.h>
25 
26 /* Standard GObject macros */
27 #define E_TYPE_SHELL_SIDEBAR \
28 	(e_shell_sidebar_get_type ())
29 #define E_SHELL_SIDEBAR(obj) \
30 	(G_TYPE_CHECK_INSTANCE_CAST \
31 	((obj), E_TYPE_SHELL_SIDEBAR, EShellSidebar))
32 #define E_SHELL_SIDEBAR_CLASS(cls) \
33 	(G_TYPE_CHECK_CLASS_CAST \
34 	((cls), E_TYPE_SHELL_SIDEBAR, EShellSidebarClass))
35 #define E_IS_SHELL_SIDEBAR(obj) \
36 	(G_TYPE_CHECK_INSTANCE_TYPE \
37 	((obj), E_TYPE_SHELL_SIDEBAR))
38 #define E_IS_SHELL_SIDEBAR_CLASS(cls) \
39 	(G_TYPE_CHECK_CLASS_TYPE \
40 	((obj), E_TYPE_SHELL_SIDEBAR))
41 #define E_SHELL_SIDEBAR_GET_CLASS(obj) \
42 	(G_TYPE_INSTANCE_GET_CLASS \
43 	((obj), E_TYPE_SHELL_SIDEBAR, EShellSidebarClass))
44 
45 G_BEGIN_DECLS
46 
47 /* Avoid including <e-shell-view.h>, because it includes us! */
48 struct _EShellView;
49 
50 typedef struct _EShellSidebar EShellSidebar;
51 typedef struct _EShellSidebarClass EShellSidebarClass;
52 typedef struct _EShellSidebarPrivate EShellSidebarPrivate;
53 
54 /**
55  * EShellSidebar:
56  *
57  * Contains only private data that should be read and manipulated using the
58  * functions below.
59  **/
60 struct _EShellSidebar {
61 	GtkBin parent;
62 	EShellSidebarPrivate *priv;
63 };
64 
65 struct _EShellSidebarClass {
66 	GtkBinClass parent_class;
67 
68 	guint32		(*check_state)		(EShellSidebar *shell_sidebar);
69 };
70 
71 GType		e_shell_sidebar_get_type	(void);
72 GtkWidget *	e_shell_sidebar_new		(struct _EShellView *shell_view);
73 guint32		e_shell_sidebar_check_state	(EShellSidebar *shell_sidebar);
74 struct _EShellView *
75 		e_shell_sidebar_get_shell_view	(EShellSidebar *shell_sidebar);
76 GtkWidget *	e_shell_sidebar_get_image_widget(EShellSidebar *shell_sidebar);
77 const gchar *	e_shell_sidebar_get_icon_name	(EShellSidebar *shell_sidebar);
78 void		e_shell_sidebar_set_icon_name	(EShellSidebar *shell_sidebar,
79 						 const gchar *icon_name);
80 const gchar *	e_shell_sidebar_get_primary_text
81 						(EShellSidebar *shell_sidebar);
82 void		e_shell_sidebar_set_primary_text
83 						(EShellSidebar *shell_sidebar,
84 						 const gchar *primary_text);
85 const gchar *	e_shell_sidebar_get_secondary_text
86 						(EShellSidebar *shell_sidebar);
87 void		e_shell_sidebar_set_secondary_text
88 						(EShellSidebar *shell_sidebar,
89 						 const gchar *secondary_text);
90 
91 G_END_DECLS
92 
93 #endif /* E_SHELL_SIDEBAR_H */
94