libyelp/yelp-bookmarks.h

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * Copyright (C) 2010 Shaun McCance <shaunm@gnome.org>
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License as
   7  * published by the Free Software Foundation; either version 2 of the
   8  * License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public
  16  * License along with this program; if not, see <http://www.gnu.org/licenses/>.
  17  *
  18  * Author: Shaun McCance <shaunm@gnome.org>
  19  */
  20
  21 #ifndef __YELP_BOOKMARKS_H__
  22 #define __YELP_BOOKMARKS_H__
  23
  24 #include <glib-object.h>
  25
  26 G_BEGIN_DECLS
  27
  28 #define YELP_TYPE_BOOKMARKS               (yelp_bookmarks_get_type ())
  29 #define YELP_BOOKMARKS(obj)               (G_TYPE_CHECK_INSTANCE_CAST ((obj), YELP_TYPE_BOOKMARKS, YelpBookmarks))
  30 #define YELP_IS_BOOKMARKS(obj)            (G_TYPE_CHECK_INSTANCE_TYPE ((obj), YELP_TYPE_BOOKMARKS))
  31 #define YELP_BOOKMARKS_GET_INTERFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), YELP_TYPE_BOOKMARKS, YelpBookmarksInterface))
  32
  33 typedef struct _YelpBookmarks           YelpBookmarks;
  34 typedef struct _YelpBookmarksInterface  YelpBookmarksInterface;
  35
  36 struct _YelpBookmarksInterface
  37 {
  38     GTypeInterface g_iface;
  39
  40     /* Signals */
  41     void      (* bookmarks_changed)     (YelpBookmarks *bookmarks);
  42
  43     /* Virtual Table */
  44     void      (* add_bookmark)          (YelpBookmarks *bookmarks,
  45                                          const gchar   *doc_uri,
  46                                          const gchar   *page_id,
  47                                          const gchar   *icon,
  48                                          const gchar   *title);
  49     void      (* remove_bookmark)       (YelpBookmarks *bookmarks,
  50                                          const gchar   *doc_uri,
  51                                          const gchar   *page_id);
  52     gboolean  (* is_bookmarked)         (YelpBookmarks *bookmarks,
  53                                          const gchar   *doc_uri,
  54                                          const gchar   *page_id);
  55 };
  56
  57 GType    yelp_bookmarks_get_type        (void);
  58 void     yelp_bookmarks_add_bookmark    (YelpBookmarks *bookmarks,
  59                                          const gchar   *doc_uri,
  60                                          const gchar   *page_id,
  61                                          const gchar   *icon,
  62                                          const gchar   *title);
  63 void     yelp_bookmarks_remove_bookmark  (YelpBookmarks *bookmarks,
  64                                           const gchar   *doc_uri,
  65                                           const gchar   *page_id);
  66 gboolean yelp_bookmarks_is_bookmarked    (YelpBookmarks *bookmarks,
  67                                           const gchar   *doc_uri,
  68                                           const gchar   *page_id);
  69
  70 G_END_DECLS
  71
  72 #endif /* __YELP_BOOKMARKS_H__ */