Changing the API guard to HILDON_ENABLE_UNSTABLE_API.
[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 #ifdef HILDON_ENABLE_UNSTABLE_API
27
28 #ifndef __HILDON_BREAD_CRUMB_TRAIL_H__
29 #define __HILDON_BREAD_CRUMB_TRAIL_H__
30
31 #include <gtk/gtk.h>
32 #include "hildon-bread-crumb.h"
33 #include "hildon-bread-crumb-widget.h"
34
35 G_BEGIN_DECLS
36
37 typedef struct _HildonBreadCrumbTrail        HildonBreadCrumbTrail;
38 typedef struct _HildonBreadCrumbTrailClass   HildonBreadCrumbTrailClass;
39 typedef struct _HildonBreadCrumbTrailPrivate HildonBreadCrumbTrailPrivate;
40
41 #define HILDON_TYPE_BREAD_CRUMB_TRAIL                 (hildon_bread_crumb_trail_get_type ())
42 #define HILDON_BREAD_CRUMB_TRAIL(obj)                 (G_TYPE_CHECK_INSTANCE_CAST ((obj), HILDON_TYPE_BREAD_CRUMB_TRAIL, HildonBreadCrumbTrail))
43 #define HILDON_BREAD_CRUMB_TRAIL_CLASS(klass)         (G_TYPE_CHECK_CLASS_CAST ((klass), HILDON_TYPE_BREAD_CRUMB_TRAIL, HildonBreadCrumbTrailClass))
44 #define HILDON_IS_BREAD_CRUMB_TRAIL(obj)              (G_TYPE_CHECK_INSTANCE_TYPE ((obj), HILDON_TYPE_BREAD_CRUMB_TRAIL))
45 #define HILDON_IS_BREAD_CRUMB_TRAIL_CLASS(klass)      (G_TYPE_CHECK_CLASS_TYPE ((klass), HILDON_TYPE_BREAD_CRUMB_TRAIL))
46 #define HILDON_BREAD_CRUMB_TRAIL_GET_CLASS(obj)       (G_TYPE_INSTANCE_GET_CLASS ((obj), HILDON_TYPE_BREAD_CRUMB_TRAIL, HildonBreadCrumbTrailClass))
47
48 struct _HildonBreadCrumbTrail
49 {
50   GtkContainer parent;
51
52   HildonBreadCrumbTrailPrivate *priv;
53 };
54
55 struct _HildonBreadCrumbTrailClass
56 {
57   GtkContainerClass parent_class;
58
59   void (*crumb_clicked) (HildonBreadCrumbTrail *bct,
60                          gpointer id);
61 };
62
63 GType hildon_bread_crumb_trail_get_type (void) G_GNUC_CONST;
64 GtkWidget *hildon_bread_crumb_trail_new (void);
65 void hildon_bread_crumb_trail_push (HildonBreadCrumbTrail *bct, HildonBreadCrumb *item,
66                                     gpointer id, GDestroyNotify  notify);
67 void hildon_bread_crumb_trail_push_text (HildonBreadCrumbTrail *bct, const gchar *text,
68                                          gpointer id, GDestroyNotify notify);
69 void hildon_bread_crumb_trail_push_icon (HildonBreadCrumbTrail *bct,
70                                          const gchar *text,
71                                          GtkWidget *icon,
72                                          gpointer id,
73                                          GDestroyNotify destroy);
74 void hildon_bread_crumb_trail_pop (HildonBreadCrumbTrail *bct);
75 void hildon_bread_crumb_trail_clear (HildonBreadCrumbTrail *bct);
76
77 G_END_DECLS
78
79 #endif
80
81 #endif /* HILDON_ENABLE_UNSTABLE_API */