Pileus Git - ~andy/gtk/blob - gtk/gtklinkbutton.h

   1 /* GTK - The GIMP Toolkit
   2  * gtklinkbutton.h - an hyperlink-enabled button
   3  *
   4  * Copyright (C) 2005 Emmanuele Bassi <ebassi@gmail.com>
   5  * All rights reserved.
   6  *
   7  * Based on gnome-href code by:
   8  *      James Henstridge <james@daa.com.au>
   9  *
  10  * This library is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Library General Public
  12  * License as published by the Free Software Foundation; either
  13  * version 2 of the License, or (at your option) any later version.
  14  *
  15  * This library is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Library General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Library General Public
  21  * License along with this library. If not, see <http://www.gnu.org/licenses/>.
  22  */
  23
  24 #ifndef __GTK_LINK_BUTTON_H__
  25 #define __GTK_LINK_BUTTON_H__
  26
  27 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  28 #error "Only <gtk/gtk.h> can be included directly."
  29 #endif
  30
  31 #include <gtk/gtkbutton.h>
  32
  33 G_BEGIN_DECLS
  34
  35 #define GTK_TYPE_LINK_BUTTON            (gtk_link_button_get_type ())
  36 #define GTK_LINK_BUTTON(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_LINK_BUTTON, GtkLinkButton))
  37 #define GTK_IS_LINK_BUTTON(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_LINK_BUTTON))
  38 #define GTK_LINK_BUTTON_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_LINK_BUTTON, GtkLinkButtonClass))
  39 #define GTK_IS_LINK_BUTTON_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_LINK_BUTTON))
  40 #define GTK_LINK_BUTTON_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_LINK_BUTTON, GtkLinkButtonClass))
  41
  42 typedef struct _GtkLinkButton           GtkLinkButton;
  43 typedef struct _GtkLinkButtonClass      GtkLinkButtonClass;
  44 typedef struct _GtkLinkButtonPrivate    GtkLinkButtonPrivate;
  45
  46 /**
  47  * GtkLinkButton:
  48  *
  49  * The <structname>GtkLinkButton</structname> structure contains only
  50  * private data and should be accessed using the provided API.
  51  */
  52 struct _GtkLinkButton
  53 {
  54   /*< private >*/
  55   GtkButton parent_instance;
  56
  57   GtkLinkButtonPrivate *priv;
  58 };
  59
  60 /**
  61  * GtkLinkButtonClass:
  62  * @activate_link: class handler for the #GtkLinkButton::activate-link signal
  63  *
  64  * The <structname>GtkLinkButtonClass</structname> structure contains only
  65  * private data.
  66  */
  67 struct _GtkLinkButtonClass
  68 {
  69   /*< private >*/
  70   GtkButtonClass parent_class;
  71
  72   /*< public >*/
  73   gboolean (* activate_link) (GtkLinkButton *button);
  74
  75   /*< private >*/
  76   /* Padding for future expansion */
  77   void (*_gtk_padding1) (void);
  78   void (*_gtk_padding2) (void);
  79   void (*_gtk_padding3) (void);
  80   void (*_gtk_padding4) (void);
  81 };
  82
  83 GType                 gtk_link_button_get_type          (void) G_GNUC_CONST;
  84
  85 GtkWidget *           gtk_link_button_new               (const gchar   *uri);
  86 GtkWidget *           gtk_link_button_new_with_label    (const gchar   *uri,
  87                                                          const gchar   *label);
  88
  89 const gchar *         gtk_link_button_get_uri           (GtkLinkButton *link_button);
  90 void                  gtk_link_button_set_uri           (GtkLinkButton *link_button,
  91                                                          const gchar   *uri);
  92
  93 gboolean              gtk_link_button_get_visited       (GtkLinkButton *link_button);
  94 void                  gtk_link_button_set_visited       (GtkLinkButton *link_button,
  95                                                          gboolean       visited);
  96
  97
  98 G_END_DECLS
  99
 100 #endif /* __GTK_LINK_BUTTON_H__ */