src/ev-sidebar.h

   1 /* ev-sidebar.h
   2  *  this file is part of evince, a gnome document viewer
   3  *
   4  * Copyright (C) 2004 Red Hat, Inc.
   5  *
   6  * Author:
   7  *   Jonathan Blandford <jrb@alum.mit.edu>
   8  *
   9  * Evince is free software; you can redistribute it and/or modify it
  10  * under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * Evince 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  * General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02110-1301  USA.
  22  *
  23  * Thursday 03 May 2007: Bastien Nocera: Add exception clause.
  24  * See license_change file for details.
  25  *
  26  */
  27
  28 #ifndef __EV_SIDEBAR_H__
  29 #define __EV_SIDEBAR_H__
  30
  31 #include <gtk/gtk.h>
  32
  33 G_BEGIN_DECLS
  34
  35 typedef struct _EvSidebar EvSidebar;
  36 typedef struct _EvSidebarClass EvSidebarClass;
  37 typedef struct _EvSidebarPrivate EvSidebarPrivate;
  38
  39 #define EV_TYPE_SIDEBAR              (ev_sidebar_get_type())
  40 #define EV_SIDEBAR(object)           (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_SIDEBAR, EvSidebar))
  41 #define EV_SIDEBAR_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_SIDEBAR, EvSidebarClass))
  42 #define EV_IS_SIDEBAR(object)        (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_SIDEBAR))
  43 #define EV_IS_SIDEBAR_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE((klass), EV_TYPE_SIDEBAR))
  44 #define EV_SIDEBAR_GET_CLASS(object) (G_TYPE_INSTANCE_GET_CLASS((object), EV_TYPE_SIDEBAR, EvSidebarClass))
  45
  46 struct _EvSidebar {
  47         GtkVBox base_instance;
  48
  49         EvSidebarPrivate *priv;
  50 };
  51
  52 struct _EvSidebarClass {
  53         GtkVBoxClass base_class;
  54
  55         void (*closed) (EvSidebar *sidebar);
  56 };
  57
  58 GType      ev_sidebar_get_type     (void);
  59 GtkWidget *ev_sidebar_new          (void);
  60 void       ev_sidebar_add_page     (EvSidebar   *ev_sidebar,
  61                                     const gchar *page_id,
  62                                     const gchar *title,
  63                                     GtkWidget   *main_widget);
  64 void       ev_sidebar_set_current_page
  65                                    (EvSidebar *ev_sidebar,
  66                                     const char *page_id);
  67 char      *ev_sidebar_get_current_page
  68                                    (EvSidebar *ev_sidebar);
  69 void        ev_sidebar_remove_page (EvSidebar   *ev_sidebar,
  70                                     const gchar *page_id);
  71
  72 G_END_DECLS
  73
  74 #endif /* __EV_SIDEBAR_H__ */
  75
  76