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, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  *
  20  * Author: Shaun McCance  <shaunm@gnome.org>
  21  */
  22
  23 #ifndef __YELP_APPLICATION_H__
  24 #define __YELP_APPLICATION_H__
  25
  26 #include <glib-object.h>
  27
  28 #include "yelp-uri.h"
  29 #include "yelp-bookmarks.h"
  30
  31 #define YELP_TYPE_APPLICATION            (yelp_application_get_type ())
  32 #define YELP_APPLICATION(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), YELP_TYPE_APPLICATION, YelpApplication))
  33 #define YELP_APPLICATION_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), YELP_TYPE_APPLICATION, YelpApplicationClass))
  34 #define YELP_IS_APPLICATION(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), YELP_TYPE_APPLICATION))
  35 #define YELP_IS_APPLICATION_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), YELP_TYPE_APPLICATION))
  36
  37 typedef struct _YelpApplication       YelpApplication;
  38 typedef struct _YelpApplicationClass  YelpApplicationClass;
  39
  40 struct _YelpApplication
  41 {
  42     GObject       parent;
  43 };
  44
  45 struct _YelpApplicationClass
  46 {
  47     GObjectClass  parent_class;
  48 };
  49
  50 GType             yelp_application_get_type       (void);
  51 YelpApplication*  yelp_application_new            (void);
  52 gint              yelp_application_run            (YelpApplication  *app,
  53                                                    gint              argc,
  54                                                    gchar           **argv);
  55 gboolean          yelp_application_load_uri       (YelpApplication  *app,
  56                                                    const gchar      *uri,
  57                                                    guint             timestamp,
  58                                                    GError          **error);
  59 void              yelp_application_new_window     (YelpApplication  *app,
  60                                                    const gchar      *uri);
  61 void              yelp_application_new_window_uri (YelpApplication  *app,
  62                                                    YelpUri          *uri);
  63 GtkActionGroup *  yelp_application_get_action_group     (YelpApplication   *app);
  64 void              yelp_application_add_bookmark         (YelpBookmarks     *bookmarks,
  65                                                          const gchar       *doc_uri,
  66                                                          const gchar       *page_id,
  67                                                          const gchar       *icon,
  68                                                          const gchar       *title);
  69 void              yelp_application_remove_bookmark      (YelpBookmarks     *bookmarks,
  70                                                          const gchar       *doc_uri,
  71                                                          const gchar       *page_id);
  72 gboolean          yelp_application_is_bookmarked        (YelpBookmarks     *bookmarks,
  73                                                          const gchar       *doc_uri,
  74                                                          const gchar       *page_id);
  75 void              yelp_application_update_bookmarks     (YelpApplication   *app,
  76                                                          const gchar       *doc_uri,
  77                                                          const gchar       *page_id,
  78                                                          const gchar       *icon,
  79                                                          const gchar       *title);
  80 GVariant *        yelp_application_get_bookmarks        (YelpApplication   *app,
  81                                                          const gchar       *doc_uri);
  82 void              yelp_application_add_read_later       (YelpApplication   *app,
  83                                                          const gchar       *doc_uri,
  84                                                          const gchar       *full_uri,
  85                                                          const gchar       *title);
  86 void              yelp_application_remove_read_later    (YelpApplication   *app,
  87                                                          const gchar       *doc_uri,
  88                                                          const gchar       *full_uri);
  89 GVariant *        yelp_application_get_read_later       (YelpApplication   *app,
  90                                                          const gchar       *doc_uri);
  91
  92 #endif /* __YELP_APPLICATION_H__ */