a6daf13a8a1e35b12e0aaeec4e6a816a1aba3aaa
[hildon] / src / hildon-bread-crumb-trail.h
1 /*
2  * This file is a part of hildon
3  *
4  * Copyright (C) 2007 Nokia Corporation, all rights reserved.
5  *
6  * Contact: Michael Dominic Kostrzewa <michael.kostrzewa@nokia.com>
7  * Author: Xan Lopez <xan.lopez@nokia.com>
8  *
9  * This library is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Lesser General Public License
11  * as published by the Free Software Foundation; version 2.1 of
12  * the License, or (at your option) any later version.
13  *
14  * This library is distributed in the hope that it will be useful, but
15  * WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17  * Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public
20  * License along with this library; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
22  * 02110-1301 USA
23  *
24  */
25
26 #ifndef __HILDON_BREAD_CRUMB_TRAIL_H__
27 #define __HILDON_BREAD_CRUMB_TRAIL_H__
28
29 #include <gtk/gtk.h>
30 #include "hildon-bread-crumb.h"
31
32 G_BEGIN_DECLS
33
34 typedef struct _HildonBreadCrumbTrail        HildonBreadCrumbTrail;
35 typedef struct _HildonBreadCrumbTrailClass   HildonBreadCrumbTrailClass;
36 typedef struct _HildonBreadCrumbTrailPrivate HildonBreadCrumbTrailPrivate;
37
38 #define HILDON_TYPE_BREAD_CRUMB_TRAIL                 (hildon_bread_crumb_trail_get_type ())
39 #define HILDON_BREAD_CRUMB_TRAIL(obj)                 (G_TYPE_CHECK_INSTANCE_CAST ((obj), HILDON_TYPE_BREAD_CRUMB_TRAIL, HildonBreadCrumbTrail))
40 #define HILDON_BREAD_CRUMB_TRAIL_CLASS(klass)         (G_TYPE_CHECK_CLASS_CAST ((klass), HILDON_TYPE_BREAD_CRUMB_TRAIL, HildonBreadCrumbTrailClass))
41 #define HILDON_IS_BREAD_CRUMB_TRAIL(obj)              (G_TYPE_CHECK_INSTANCE_TYPE ((obj), HILDON_TYPE_BREAD_CRUMB_TRAIL))
42 #define HILDON_IS_BREAD_CRUMB_TRAIL_CLASS(klass)      (G_TYPE_CHECK_CLASS_TYPE ((klass), HILDON_TYPE_BREAD_CRUMB_TRAIL))
43 #define HILDON_BREAD_CRUMB_TRAIL_GET_CLASS(obj)       (G_TYPE_INSTANCE_GET_CLASS ((obj), HILDON_TYPE_BREAD_CRUMB_TRAIL, HildonBreadCrumbTrailClass))
44
45 struct _HildonBreadCrumbTrail
46 {
47   GtkContainer parent;
48
49   HildonBreadCrumbTrailPrivate *priv;
50 };
51
52 struct _HildonBreadCrumbTrailClass
53 {
54   GtkContainerClass parent_class;
55
56   void (*crumb_clicked) (HildonBreadCrumbTrail *bct,
57                          gpointer id);
58
59   /* Signals used for keybindings */
60   void (*move_parent) (HildonBreadCrumbTrail *bct);
61
62   /* Padding for future expansion */
63   void (*_hildon_bct_reserved1) (void);
64   void (*_hildon_bct_reserved2) (void);
65   void (*_hildon_bct_reserved3) (void);
66   void (*_hildon_bct_reserved4) (void);
67 };
68
69 GType hildon_bread_crumb_trail_get_type (void) G_GNUC_CONST;
70 GtkWidget *hildon_bread_crumb_trail_new (void);
71 void hildon_bread_crumb_trail_push (HildonBreadCrumbTrail *bct, HildonBreadCrumb *item,
72                                     gpointer id, GDestroyNotify destroy);
73 void hildon_bread_crumb_trail_push_text (HildonBreadCrumbTrail *bct, const gchar *text,
74                                          gpointer id, GDestroyNotify destroy);
75 void hildon_bread_crumb_trail_push_icon (HildonBreadCrumbTrail *bct,
76                                          const gchar *text,
77                                          GtkWidget *icon,
78                                          gpointer id,
79                                          GDestroyNotify destroy);
80 void hildon_bread_crumb_trail_pop (HildonBreadCrumbTrail *bct);
81 void hildon_bread_crumb_trail_clear (HildonBreadCrumbTrail *bct);
82
83 G_END_DECLS
84
85 #endif
86