gtktoolbutton.h 4.43 KB
Newer Older
1 2
/* gtktoolbutton.h
 *
3
 * Copyright (C) 2002 Anders Carlsson <andersca@gnome.org>
4 5 6 7 8 9 10 11 12 13 14 15 16 17
 * Copyright (C) 2002 James Henstridge <james@daa.com.au>
 * Copyright (C) 2003 Soeren Sandmann <sandmann@daimi.au.dk>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
Javier Jardón's avatar
Javier Jardón committed
18
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
19 20
 */

21 22 23
#ifndef __GTK_TOOL_BUTTON_H__
#define __GTK_TOOL_BUTTON_H__

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

28
#include <gtk/gtktoolitem.h>
29 30 31 32 33 34 35

G_BEGIN_DECLS

#define GTK_TYPE_TOOL_BUTTON            (gtk_tool_button_get_type ())
#define GTK_TOOL_BUTTON(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TOOL_BUTTON, GtkToolButton))
#define GTK_TOOL_BUTTON_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TOOL_BUTTON, GtkToolButtonClass))
#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 38 39 40 41 42 43 44 45 46
#define GTK_TOOL_BUTTON_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj), GTK_TYPE_TOOL_BUTTON, GtkToolButtonClass))

typedef struct _GtkToolButton        GtkToolButton;
typedef struct _GtkToolButtonClass   GtkToolButtonClass;
typedef struct _GtkToolButtonPrivate GtkToolButtonPrivate;

struct _GtkToolButton
{
  GtkToolItem parent;

47
  /*< private >*/
48
  GtkToolButtonPrivate *priv;
49 50
};

51 52 53 54 55 56 57
/**
 * GtkToolButtonClass:
 * @parent_class: The parent class.
 * @button_type: 
 * @clicked: Signal emitted when the tool button is clicked with the
 *    mouse or activated with the keyboard.
 */
58 59 60
struct _GtkToolButtonClass
{
  GtkToolItemClass parent_class;
61

62 63
  GType button_type;

64 65
  /*< public >*/

66 67
  /* signal */
  void       (* clicked)             (GtkToolButton    *tool_item);
68

69 70
  /*< private >*/

71 72 73 74 75
  /* Padding for future expansion */
  void (* _gtk_reserved1) (void);
  void (* _gtk_reserved2) (void);
  void (* _gtk_reserved3) (void);
  void (* _gtk_reserved4) (void);
76 77
};

78
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
79
GType        gtk_tool_button_get_type       (void) G_GNUC_CONST;
80
GDK_AVAILABLE_IN_ALL
81 82
GtkToolItem *gtk_tool_button_new            (GtkWidget   *icon_widget,
					     const gchar *label);
83
GDK_DEPRECATED_IN_3_10_FOR(gtk_tool_button_new)
84 85
GtkToolItem *gtk_tool_button_new_from_stock (const gchar *stock_id);

86
GDK_AVAILABLE_IN_ALL
87 88
void                  gtk_tool_button_set_label         (GtkToolButton *button,
							 const gchar   *label);
89
GDK_AVAILABLE_IN_ALL
90
const gchar *         gtk_tool_button_get_label         (GtkToolButton *button);
91
GDK_AVAILABLE_IN_ALL
92 93
void                  gtk_tool_button_set_use_underline (GtkToolButton *button,
							 gboolean       use_underline);
94
GDK_AVAILABLE_IN_ALL
95
gboolean              gtk_tool_button_get_use_underline (GtkToolButton *button);
96
GDK_DEPRECATED_IN_3_10_FOR(gtk_tool_button_set_icon_name)
97
void                  gtk_tool_button_set_stock_id      (GtkToolButton *button,
98
							 const gchar   *stock_id);
99
GDK_DEPRECATED_IN_3_10_FOR(gtk_tool_button_get_icon_name)
100
const gchar *         gtk_tool_button_get_stock_id      (GtkToolButton *button);
101
GDK_AVAILABLE_IN_ALL
102 103
void                  gtk_tool_button_set_icon_name     (GtkToolButton *button,
							 const gchar   *icon_name);
104
GDK_AVAILABLE_IN_ALL
105
const gchar *         gtk_tool_button_get_icon_name     (GtkToolButton *button);
106
GDK_AVAILABLE_IN_ALL
107
void                  gtk_tool_button_set_icon_widget   (GtkToolButton *button,
108
							 GtkWidget     *icon_widget);
109
GDK_AVAILABLE_IN_ALL
110
GtkWidget *           gtk_tool_button_get_icon_widget   (GtkToolButton *button);
111
GDK_AVAILABLE_IN_ALL
112 113
void                  gtk_tool_button_set_label_widget  (GtkToolButton *button,
							 GtkWidget     *label_widget);
114
GDK_AVAILABLE_IN_ALL
115
GtkWidget *           gtk_tool_button_get_label_widget  (GtkToolButton *button);
116

117

118 119 120
/* internal function */
GtkWidget *_gtk_tool_button_get_button (GtkToolButton *button);

121 122 123
G_END_DECLS

#endif /* __GTK_TOOL_BUTTON_H__ */