1/* gtktoolbutton.h
2 *
3 * Copyright (C) 2002 Anders Carlsson <andersca@gnome.org>
4 * Copyright (C) 2002 James Henstridge <james@daa.com.au>
5 * Copyright (C) 2003 Soeren Sandmann <sandmann@daimi.au.dk>
6 *
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
11 *
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
19 */
20
21#ifndef __GTK_TOOL_BUTTON_H__
22#define __GTK_TOOL_BUTTON_H__
23
24#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
25#error "Only <gtk/gtk.h> can be included directly."
26#endif
27
28#include <gtk/gtktoolitem.h>
29
30G_BEGIN_DECLS
31
32#define GTK_TYPE_TOOL_BUTTON (gtk_tool_button_get_type ())
33#define GTK_TOOL_BUTTON(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TOOL_BUTTON, GtkToolButton))
34#define GTK_TOOL_BUTTON_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TOOL_BUTTON, GtkToolButtonClass))
35#define GTK_IS_TOOL_BUTTON(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TOOL_BUTTON))
36#define GTK_IS_TOOL_BUTTON_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TOOL_BUTTON))
37#define GTK_TOOL_BUTTON_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), GTK_TYPE_TOOL_BUTTON, GtkToolButtonClass))
38
39typedef struct _GtkToolButton GtkToolButton;
40typedef struct _GtkToolButtonClass GtkToolButtonClass;
41typedef struct _GtkToolButtonPrivate GtkToolButtonPrivate;
42
43struct _GtkToolButton
44{
45 GtkToolItem parent;
46
47 /*< private >*/
48 GtkToolButtonPrivate *priv;
49};
50
51/**
52 * GtkToolButtonClass:
53 * @parent_class: The parent class.
54 * @button_type:
55 * @clicked: Signal emitted when the tool button is clicked with the
56 * mouse or activated with the keyboard.
57 */
58struct _GtkToolButtonClass
59{
60 GtkToolItemClass parent_class;
61
62 GType button_type;
63
64 /*< public >*/
65
66 /* signal */
67 void (* clicked) (GtkToolButton *tool_item);
68
69 /*< private >*/
70
71 /* Padding for future expansion */
72 void (* _gtk_reserved1) (void);
73 void (* _gtk_reserved2) (void);
74 void (* _gtk_reserved3) (void);
75 void (* _gtk_reserved4) (void);
76};
77
78GDK_AVAILABLE_IN_ALL
79GType gtk_tool_button_get_type (void) G_GNUC_CONST;
80GDK_AVAILABLE_IN_ALL
81GtkToolItem *gtk_tool_button_new (GtkWidget *icon_widget,
82 const gchar *label);
83GDK_DEPRECATED_IN_3_10_FOR(gtk_tool_button_new)
84GtkToolItem *gtk_tool_button_new_from_stock (const gchar *stock_id);
85
86GDK_AVAILABLE_IN_ALL
87void gtk_tool_button_set_label (GtkToolButton *button,
88 const gchar *label);
89GDK_AVAILABLE_IN_ALL
90const gchar * gtk_tool_button_get_label (GtkToolButton *button);
91GDK_AVAILABLE_IN_ALL
92void gtk_tool_button_set_use_underline (GtkToolButton *button,
93 gboolean use_underline);
94GDK_AVAILABLE_IN_ALL
95gboolean gtk_tool_button_get_use_underline (GtkToolButton *button);
96GDK_DEPRECATED_IN_3_10_FOR(gtk_tool_button_set_icon_name)
97void gtk_tool_button_set_stock_id (GtkToolButton *button,
98 const gchar *stock_id);
99GDK_DEPRECATED_IN_3_10_FOR(gtk_tool_button_get_icon_name)
100const gchar * gtk_tool_button_get_stock_id (GtkToolButton *button);
101GDK_AVAILABLE_IN_ALL
102void gtk_tool_button_set_icon_name (GtkToolButton *button,
103 const gchar *icon_name);
104GDK_AVAILABLE_IN_ALL
105const gchar * gtk_tool_button_get_icon_name (GtkToolButton *button);
106GDK_AVAILABLE_IN_ALL
107void gtk_tool_button_set_icon_widget (GtkToolButton *button,
108 GtkWidget *icon_widget);
109GDK_AVAILABLE_IN_ALL
110GtkWidget * gtk_tool_button_get_icon_widget (GtkToolButton *button);
111GDK_AVAILABLE_IN_ALL
112void gtk_tool_button_set_label_widget (GtkToolButton *button,
113 GtkWidget *label_widget);
114GDK_AVAILABLE_IN_ALL
115GtkWidget * gtk_tool_button_get_label_widget (GtkToolButton *button);
116
117
118/* internal function */
119GtkWidget *_gtk_tool_button_get_button (GtkToolButton *button);
120
121G_END_DECLS
122
123#endif /* __GTK_TOOL_BUTTON_H__ */
124