pidgin/gtkwebviewtoolbar.h

   1 /*
   2  * PidginWebViewToolbar
   3  *
   4  * Pidgin is the legal property of its developers, whose names are too numerous
   5  * to list here.  Please refer to the COPYRIGHT file distributed with this
   6  * source distribution.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  21  *
  22  */
  23
  24 #ifndef _PIDGINWEBVIEWTOOLBAR_H_
  25 #define _PIDGINWEBVIEWTOOLBAR_H_
  26 /**
  27  * SECTION:gtkwebviewtoolbar
  28  * @section_id: pidgin-gtkwebviewtoolbar
  29  * @short_description: <filename>gtkwebviewtoolbar.h</filename>
  30  * @title: WebView Toolbar
  31  */
  32
  33 #include <gtk/gtk.h>
  34 #include "gtkwebview.h"
  35
  36 #define PIDGIN_DEFAULT_FONT_FACE "Helvetica 12"
  37
  38 #define PIDGIN_TYPE_WEBVIEWTOOLBAR            (pidgin_webviewtoolbar_get_type())
  39 #define PIDGIN_WEBVIEWTOOLBAR(obj)            (G_TYPE_CHECK_INSTANCE_CAST((obj), PIDGIN_TYPE_WEBVIEWTOOLBAR, PidginWebViewToolbar))
  40 #define PIDGIN_WEBVIEWTOOLBAR_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST((klass), PIDGIN_TYPE_WEBVIEWTOOLBAR, PidginWebViewToolbarClass))
  41 #define PIDGIN_IS_WEBVIEWTOOLBAR(obj)         (G_TYPE_CHECK_INSTANCE_TYPE((obj), PIDGIN_TYPE_WEBVIEWTOOLBAR))
  42 #define PIDGIN_IS_WEBVIEWTOOLBAR_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), PIDGIN_TYPE_WEBVIEWTOOLBAR))
  43 #define PIDGIN_WEBVIEWTOOLBAR_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj), PIDGIN_TYPE_WEBVIEWTOOLBAR, PidginWebViewToolbarClass))
  44
  45 typedef struct _PidginWebViewToolbar PidginWebViewToolbar;
  46 typedef struct _PidginWebViewToolbarClass PidginWebViewToolbarClass;
  47
  48 struct _PidginWebViewToolbar {
  49         GtkBox box;
  50
  51         GtkWidget *webview;
  52 };
  53
  54 struct _PidginWebViewToolbarClass {
  55         GtkBoxClass parent_class;
  56 };
  57
  58 G_BEGIN_DECLS
  59
  60 /**
  61  * pidgin_webviewtoolbar_get_type:
  62  *
  63  * Returns the GType for a PidginWebViewToolbar widget
  64  *
  65  * Returns: The GType for PidginWebViewToolbar widget
  66  */
  67 GType pidgin_webviewtoolbar_get_type(void);
  68
  69 /**
  70  * pidgin_webviewtoolbar_new:
  71  *
  72  * Create a new PidginWebViewToolbar object
  73  *
  74  * Returns: A GtkWidget corresponding to the PidginWebViewToolbar object
  75  */
  76 GtkWidget *pidgin_webviewtoolbar_new(void);
  77
  78 /**
  79  * pidgin_webviewtoolbar_attach:
  80  * @toolbar: The PidginWebViewToolbar object
  81  * @webview: The PidginWebView object
  82  *
  83  * Attach a PidginWebViewToolbar object to a PidginWebView
  84  */
  85 void pidgin_webviewtoolbar_attach(PidginWebViewToolbar *toolbar, GtkWidget *webview);
  86
  87 /**
  88  * pidgin_webviewtoolbar_switch_active_conversation:
  89  * @toolbar: The PidginWebViewToolbar object
  90  * @conv:    The new conversation
  91  *
  92  * Switch the active conversation for a PidginWebViewToolbar object
  93  */
  94 void pidgin_webviewtoolbar_switch_active_conversation(PidginWebViewToolbar *toolbar,
  95                                                    PurpleConversation *conv);
  96
  97 /**
  98  * pidgin_webviewtoolbar_activate:
  99  * @toolbar: The PidginWebViewToolbar object
 100  * @action:  The PidginWebViewAction
 101  *
 102  * Activate a PidginWebViewToolbar action
 103  */
 104 void pidgin_webviewtoolbar_activate(PidginWebViewToolbar *toolbar,
 105                                  PidginWebViewAction action);
 106
 107 /**
 108  * pidgin_webviewtoolbar_get_wide_view:
 109  * @toolbar: The PidginWebViewToolbar object
 110  *
 111  * Returns the wide toolbar variant widget for the given @toolbar.
 112  *
 113  * Returns: the wide toolbar variant.
 114  */
 115 GtkWidget *
 116 pidgin_webviewtoolbar_get_wide_view(PidginWebViewToolbar *toolbar);
 117
 118 /**
 119  * pidgin_webviewtoolbar_get_lean_view:
 120  * @toolbar: The PidginWebViewToolbar object
 121  *
 122  * Returns the lean toolbar variant widget for the given @toolbar.
 123  *
 124  * Returns: the lean toolbar variant.
 125  */
 126 GtkWidget *
 127 pidgin_webviewtoolbar_get_lean_view(PidginWebViewToolbar *toolbar);
 128
 129 G_END_DECLS
 130
 131 #endif /* _PIDGINWEBVIEWTOOLBAR_H_ */