gtklinkbutton.h 3.48 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
2
 * gtklinkbutton.h - an hyperlink-enabled button
3
 *
4 5 6 7 8
 * Copyright (C) 2005 Emmanuele Bassi <ebassi@gmail.com>
 * All rights reserved.
 *
 * Based on gnome-href code by:
 * 	James Henstridge <james@daa.com.au>
9
 *
10 11 12 13 14 15 16 17 18 19 20
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
Javier Jardón's avatar
Javier Jardón committed
21
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
22 23
 */

24 25 26
#ifndef __GTK_LINK_BUTTON_H__
#define __GTK_LINK_BUTTON_H__

27
#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
28 29 30
#error "Only <gtk/gtk.h> can be included directly."
#endif

31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
#include <gtk/gtkbutton.h>

G_BEGIN_DECLS

#define GTK_TYPE_LINK_BUTTON		(gtk_link_button_get_type ())
#define GTK_LINK_BUTTON(obj)		(G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_LINK_BUTTON, GtkLinkButton))
#define GTK_IS_LINK_BUTTON(obj)		(G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_LINK_BUTTON))
#define GTK_LINK_BUTTON_CLASS(klass)	(G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_LINK_BUTTON, GtkLinkButtonClass))
#define GTK_IS_LINK_BUTTON_CLASS(klass)	(G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_LINK_BUTTON))
#define GTK_LINK_BUTTON_GET_CLASS(obj)	(G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_LINK_BUTTON, GtkLinkButtonClass))

typedef struct _GtkLinkButton		GtkLinkButton;
typedef struct _GtkLinkButtonClass	GtkLinkButtonClass;
typedef struct _GtkLinkButtonPrivate	GtkLinkButtonPrivate;

46 47 48
/**
 * GtkLinkButton:
 *
49
 * The #GtkLinkButton-struct contains only
50 51
 * private data and should be accessed using the provided API.
 */
52 53
struct _GtkLinkButton
{
54
  /*< private >*/
55
  GtkButton parent_instance;
56

57
  GtkLinkButtonPrivate *priv;
58 59
};

60 61 62 63
/**
 * GtkLinkButtonClass:
 * @activate_link: class handler for the #GtkLinkButton::activate-link signal
 *
64
 * The #GtkLinkButtonClass contains only
65 66
 * private data.
 */
67 68
struct _GtkLinkButtonClass
{
69
  /*< private >*/
70
  GtkButtonClass parent_class;
71

72 73 74 75
  /*< public >*/
  gboolean (* activate_link) (GtkLinkButton *button);

  /*< private >*/
76
  /* Padding for future expansion */
77 78 79 80 81 82
  void (*_gtk_padding1) (void);
  void (*_gtk_padding2) (void);
  void (*_gtk_padding3) (void);
  void (*_gtk_padding4) (void);
};

83
GDK_AVAILABLE_IN_ALL
84 85
GType                 gtk_link_button_get_type          (void) G_GNUC_CONST;

86
GDK_AVAILABLE_IN_ALL
87
GtkWidget *           gtk_link_button_new               (const gchar   *uri);
88
GDK_AVAILABLE_IN_ALL
89 90 91
GtkWidget *           gtk_link_button_new_with_label    (const gchar   *uri,
						         const gchar   *label);

92
GDK_AVAILABLE_IN_ALL
93
const gchar *         gtk_link_button_get_uri           (GtkLinkButton *link_button);
94
GDK_AVAILABLE_IN_ALL
95 96 97
void                  gtk_link_button_set_uri           (GtkLinkButton *link_button,
						         const gchar   *uri);

98
GDK_AVAILABLE_IN_ALL
99
gboolean              gtk_link_button_get_visited       (GtkLinkButton *link_button);
100
GDK_AVAILABLE_IN_ALL
101 102 103 104
void                  gtk_link_button_set_visited       (GtkLinkButton *link_button,
                                                         gboolean       visited);


105 106 107
G_END_DECLS

#endif /* __GTK_LINK_BUTTON_H__ */