libnautilus-private/nautilus-sidebar.h

   1 /* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*-
   2
   3    nautilus-sidebar.h: Interface for nautilus sidebar plugins
   4
   5    Copyright (C) 2004 Red Hat Inc.
   6
   7    This program is free software; you can redistribute it and/or
   8    modify it under the terms of the GNU General Public License as
   9    published by the Free Software Foundation; either version 2 of the
  10    License, or (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15    General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public
  18    License along with this program; if not, write to the
  19    Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20    Boston, MA 02111-1307, USA.
  21
  22    Author: Alexander Larsson <alexl@redhat.com>
  23 */
  24
  25 #ifndef NAUTILUS_SIDEBAR_H
  26 #define NAUTILUS_SIDEBAR_H
  27
  28 #include <glib-object.h>
  29 #include <gtk/gtkwidget.h>
  30
  31 G_BEGIN_DECLS
  32
  33 #define NAUTILUS_TYPE_SIDEBAR           (nautilus_sidebar_get_type ())
  34 #define NAUTILUS_SIDEBAR(obj)           (G_TYPE_CHECK_INSTANCE_CAST ((obj), NAUTILUS_TYPE_SIDEBAR, NautilusSidebar))
  35 #define NAUTILUS_IS_SIDEBAR(obj)        (G_TYPE_CHECK_INSTANCE_TYPE ((obj), NAUTILUS_TYPE_SIDEBAR))
  36 #define NAUTILUS_SIDEBAR_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), NAUTILUS_TYPE_SIDEBAR, NautilusSidebarIface))
  37
  38 typedef struct _NautilusSidebar NautilusSidebar; /* dummy typedef */
  39 typedef struct _NautilusSidebarIface NautilusSidebarIface;
  40
  41 /* Must also be a GtkWidget */
  42 struct _NautilusSidebarIface
  43 {
  44         GTypeInterface g_iface;
  45
  46         /* Signals: */
  47         void           (* tab_icon_changed)       (NautilusSidebar *sidebar);
  48
  49         /* VTable: */
  50         const char *   (* get_sidebar_id)         (NautilusSidebar *sidebar);
  51         char *         (* get_tab_label)          (NautilusSidebar *sidebar);
  52         char *         (* get_tab_tooltip)        (NautilusSidebar *sidebar);
  53         GdkPixbuf *    (* get_tab_icon)           (NautilusSidebar *sidebar);
  54         void           (* is_visible_changed)     (NautilusSidebar *sidebar,
  55                                                    gboolean         is_visible);
  56
  57
  58         /* Padding for future expansion */
  59         void (*_reserved1) (void);
  60         void (*_reserved2) (void);
  61         void (*_reserved3) (void);
  62         void (*_reserved4) (void);
  63         void (*_reserved5) (void);
  64         void (*_reserved6) (void);
  65         void (*_reserved7) (void);
  66         void (*_reserved8) (void);
  67 };
  68
  69 GType             nautilus_sidebar_get_type             (void);
  70
  71 const char *nautilus_sidebar_get_sidebar_id     (NautilusSidebar *sidebar);
  72 char *      nautilus_sidebar_get_tab_label      (NautilusSidebar *sidebar);
  73 char *      nautilus_sidebar_get_tab_tooltip    (NautilusSidebar *sidebar);
  74 GdkPixbuf * nautilus_sidebar_get_tab_icon       (NautilusSidebar *sidebar);
  75 void        nautilus_sidebar_is_visible_changed (NautilusSidebar *sidebar,
  76                                                  gboolean         is_visible);
  77
  78 G_END_DECLS
  79
  80 #endif /* NAUTILUS_VIEW_H */