HildonBreadCrumbTrail

HildonBreadCrumbTrail — Widget used to represent a specific path in a hierarchical tree. Stability: Unstable

Synopsis


#include <hildon/hildon.h>

                    HildonBreadCrumbTrail;
GtkWidget*          hildon_bread_crumb_trail_new        (void);
void                hildon_bread_crumb_trail_push       (HildonBreadCrumbTrail *bct,
                                                         HildonBreadCrumb *item,
                                                         gpointer id,
                                                         GDestroyNotify destroy);
void                hildon_bread_crumb_trail_push_text  (HildonBreadCrumbTrail *bct,
                                                         const gchar *text,
                                                         gpointer id,
                                                         GDestroyNotify destroy);
void                hildon_bread_crumb_trail_push_icon  (HildonBreadCrumbTrail *bct,
                                                         const gchar *text,
                                                         GtkWidget *icon,
                                                         gpointer id,
                                                         GDestroyNotify destroy);
void                hildon_bread_crumb_trail_pop        (HildonBreadCrumbTrail *bct);
void                hildon_bread_crumb_trail_clear      (HildonBreadCrumbTrail *bct);

Description

HildonBreadCrumbTrail is a GTK widget used to represent the currently active path in some kind of hierarchical structure (file system, media library, structured document, etc).

It has built-in support for text and icon bread crumbs, but the trail only requires a very simple interface to be implemented for its children and thus new types of items can be implemented if needed. See HildonBreadCrumb for more details.

HildonBreadCrumbTrail is deprecated since hildon 2.2. You should instead use HildonStackableWindow to represent hierarchical structure in applications.

Details

HildonBreadCrumbTrail

typedef struct {
  GtkContainer parent;

  HildonBreadCrumbTrailPrivate *priv;
} HildonBreadCrumbTrail;

Warning

HildonBreadCrumbTrail is deprecated and should not be used in newly-written code.

hildon_bread_crumb_trail_new ()

GtkWidget*          hildon_bread_crumb_trail_new        (void);

Warning

hildon_bread_crumb_trail_new is deprecated and should not be used in newly-written code.

Creates a new HildonBreadCrumbTrail widget.

Returns :

a GtkWidget pointer of newly created bread crumb trail widget

Stability Level: Unstable

hildon_bread_crumb_trail_push ()

void                hildon_bread_crumb_trail_push       (HildonBreadCrumbTrail *bct,
                                                         HildonBreadCrumb *item,
                                                         gpointer id,
                                                         GDestroyNotify destroy);

Warning

hildon_bread_crumb_trail_push is deprecated and should not be used in newly-written code.

Adds a new bread crumb to the end of the trail.

`bct` :	pointer to HildonBreadCrumbTrail
`item` :	the HildonBreadCrumb to be added to the trail
`id` :	optional id for the bread crumb
`destroy` :	GDestroyNotify callback to be called when the bread crumb is destroyed

Stability Level: Unstable

hildon_bread_crumb_trail_push_text ()

void                hildon_bread_crumb_trail_push_text  (HildonBreadCrumbTrail *bct,
                                                         const gchar *text,
                                                         gpointer id,
                                                         GDestroyNotify destroy);

Warning

hildon_bread_crumb_trail_push_text is deprecated and should not be used in newly-written code.

Adds a new bread crumb to the end of the trail containing the specified text.

`bct` :	pointer to HildonBreadCrumbTrail
`text` :	content of the new bread crumb
`id` :	optional id for the bread crumb
`destroy` :	GDestroyNotify callback to be called when the bread crumb is destroyed

Stability Level: Unstable

hildon_bread_crumb_trail_push_icon ()

void                hildon_bread_crumb_trail_push_icon  (HildonBreadCrumbTrail *bct,
                                                         const gchar *text,
                                                         GtkWidget *icon,
                                                         gpointer id,
                                                         GDestroyNotify destroy);

Warning

hildon_bread_crumb_trail_push_icon is deprecated and should not be used in newly-written code.

Adds a new bread crumb to the end of the trail containing the specified text and icon.

`bct` :	pointer to HildonBreadCrumbTrail
`text` :	content of the new bread crumb
`icon` :	a widget to set as the icon in the bread crumb
`id` :	optional id for the bread crumb
`destroy` :	GDestroyNotify callback to be called when the bread crumb is destroyed

Stability Level: Unstable

hildon_bread_crumb_trail_pop ()

void                hildon_bread_crumb_trail_pop        (HildonBreadCrumbTrail *bct);

Warning

hildon_bread_crumb_trail_pop is deprecated and should not be used in newly-written code.

Removes the last bread crumb from the trail.

bct : pointer to HildonBreadCrumbTrail

Stability Level: Unstable

hildon_bread_crumb_trail_clear ()

void                hildon_bread_crumb_trail_clear      (HildonBreadCrumbTrail *bct);

Warning

hildon_bread_crumb_trail_clear is deprecated and should not be used in newly-written code.

Removes all the bread crumbs from the bread crumb trail.

bct : pointer to HildonBreadCrumbTrail

Stability Level: Unstable

			Hildon Reference Manual
Top \| Description