src/yelp-application.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_APPLICATION_H__
  22 #define __YELP_APPLICATION_H__
  23
  24 #include <glib-object.h>
  25
  26 #include "yelp-uri.h"
  27 #include "yelp-bookmarks.h"
  28
  29 #define YELP_TYPE_APPLICATION            (yelp_application_get_type ())
  30 #define YELP_APPLICATION(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), YELP_TYPE_APPLICATION, YelpApplication))
  31 #define YELP_APPLICATION_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), YELP_TYPE_APPLICATION, YelpApplicationClass))
  32 #define YELP_IS_APPLICATION(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), YELP_TYPE_APPLICATION))
  33 #define YELP_IS_APPLICATION_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), YELP_TYPE_APPLICATION))
  34
  35 typedef struct _YelpApplication       YelpApplication;
  36 typedef struct _YelpApplicationClass  YelpApplicationClass;
  37
  38 struct _YelpApplication
  39 {
  40     GtkApplication       parent;
  41 };
  42
  43 struct _YelpApplicationClass
  44 {
  45     GtkApplicationClass  parent_class;
  46 };
  47
  48 GType             yelp_application_get_type       (void);
  49 YelpApplication*  yelp_application_new            (void);
  50 void              yelp_application_new_window     (YelpApplication  *app,
  51                                                    const gchar      *uri);
  52 void              yelp_application_new_window_uri (YelpApplication  *app,
  53                                                    YelpUri          *uri);
  54 void              yelp_application_add_bookmark         (YelpBookmarks     *bookmarks,
  55                                                          const gchar       *doc_uri,
  56                                                          const gchar       *page_id,
  57                                                          const gchar       *icon,
  58                                                          const gchar       *title);
  59 void              yelp_application_remove_bookmark      (YelpBookmarks     *bookmarks,
  60                                                          const gchar       *doc_uri,
  61                                                          const gchar       *page_id);
  62 gboolean          yelp_application_is_bookmarked        (YelpBookmarks     *bookmarks,
  63                                                          const gchar       *doc_uri,
  64                                                          const gchar       *page_id);
  65 void              yelp_application_update_bookmarks     (YelpApplication   *app,
  66                                                          const gchar       *doc_uri,
  67                                                          const gchar       *page_id,
  68                                                          const gchar       *icon,
  69                                                          const gchar       *title);
  70 GVariant *        yelp_application_get_bookmarks        (YelpApplication   *app,
  71                                                          const gchar       *doc_uri);
  72
  73 #endif /* __YELP_APPLICATION_H__ */