path: root/widgets/shortcut-bar/e-shortcut-bar.h

/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */

/* 
 * Author : 
 *  Damon Chaplin <damon@gtk.org>
 *
 * Copyright 1999, Helix Code, Inc.
 *
 * This program is free software; you can redistribute it and/or 
 * modify it under the terms of the GNU General Public License as 
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 * USA
 */
#ifndef _E_SHORTCUT_BAR_H_
#define _E_SHORTCUT_BAR_H_

#include "e-group-bar.h"
#include "e-icon-bar.h"

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

/*
 * EShortcutBar displays a vertical bar with a number of Groups, each of which
 * contains any number of icons. It is used on the left of the main application
 * window so users can easily access items such as folders and files.
 */


/* This contains information on one group. */
typedef struct _EShortcutBarGroup   EShortcutBarGroup;
struct _EShortcutBarGroup
{
    /* This is the EVScrolledBar which scrolls the group. */
    GtkWidget *vscrolled_bar;

    /* This is the icon bar containing the child items. */
    GtkWidget *icon_bar;
};


#define E_SHORTCUT_BAR(obj)          GTK_CHECK_CAST (obj, e_shortcut_bar_get_type (), EShortcutBar)
#define E_SHORTCUT_BAR_CLASS(klass)  GTK_CHECK_CLASS_CAST (klass, e_shortcut_bar_get_type (), EShortcutBarClass)
#define E_IS_SHORTCUT_BAR(obj)       GTK_CHECK_TYPE (obj, e_shortcut_bar_get_type ())


typedef struct _EShortcutBar       EShortcutBar;
typedef struct _EShortcutBarClass  EShortcutBarClass;

struct _EShortcutBar
{
    EGroupBar group_bar;

    /* This is an array of EShortcutBarGroup elements. */
    GArray *groups;

    gchar *dragged_url;
    gchar *dragged_name;
};

struct _EShortcutBarClass
{
    EGroupBarClass parent_class;

    void   (*selected_item)        (EShortcutBar   *shortcut_bar,
                    GdkEvent       *event,
                    gint        group_num,
                    gint        item_num);
};


GtkType    e_shortcut_bar_get_type      (void);
GtkWidget* e_shortcut_bar_new           (void);

/* Adds a new group, returning the index. */
gint       e_shortcut_bar_add_group     (EShortcutBar    *shortcut_bar,
                         gchar       *group_name);
void       e_shortcut_bar_remove_group      (EShortcutBar    *shortcut_bar,
                         gint         group_num);

/* Sets the view type for the group. */
void       e_shortcut_bar_set_view_type     (EShortcutBar    *shortcut_bar,
                         gint         group_num,
                         EIconBarViewType view_type);

/* Adds a new item to a group, returning the index within the group. */
gint       e_shortcut_bar_add_item      (EShortcutBar    *shortcut_bar,
                         gint         group_num,
                         gchar       *item_url,
                         gchar       *item_name);

void       e_shortcut_bar_start_editing_item    (EShortcutBar    *shortcut_bar,
                         gint         group_num,
                         gint         item_num);
void       e_shortcut_bar_remove_item       (EShortcutBar    *shortcut_bar,
                         gint         group_num,
                         gint         item_num);

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* _E_SHORTCUT_BAR_H_ */