1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
3 * GtkToolbar copyright (C) Federico Mena
5 * Copyright (C) 2002 Anders Carlsson <andersca@codefactory.se>
6 * Copyright (C) 2002 James Henstridge <james@daa.com.au>
7 * Copyright (C) 2003 Soeren Sandmann <sandmann@daimi.au.dk>
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public
11 * License as published by the Free Software Foundation; either
12 * version 2 of the License, or (at your option) any later version.
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this library; if not, write to the
21 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 * Boston, MA 02111-1307, USA.
26 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
27 * file for a list of people on the GTK+ Team. See the ChangeLog
28 * files for a list of changes. These files are distributed with
29 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
32 #ifndef __GTK_TOOLBAR_H__
33 #define __GTK_TOOLBAR_H__
36 #include <gtk/gtkcontainer.h>
37 #include <gtk/gtkenums.h>
38 #include <gtk/gtktooltips.h>
40 #include "gtktoolitem.h"
42 #ifndef GTK_DISABLE_DEPRECATED
44 /* Not needed, retained for compatibility -Yosh */
45 #include <gtk/gtkpixmap.h>
46 #include <gtk/gtksignal.h>
52 #define GTK_TYPE_TOOLBAR (gtk_toolbar_get_type ())
53 #define GTK_TOOLBAR(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TOOLBAR, GtkToolbar))
54 #define GTK_TOOLBAR_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TOOLBAR, GtkToolbarClass))
55 #define GTK_IS_TOOLBAR(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TOOLBAR))
56 #define GTK_IS_TOOLBAR_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TOOLBAR))
57 #define GTK_TOOLBAR_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TOOLBAR, GtkToolbarClass))
58 #define GTK_TOOLBAR_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), GTK_TYPE_TOOLBAR, GtkToolbarPrivate))
60 #ifndef GTK_DISABLE_DEPRECATED
63 GTK_TOOLBAR_CHILD_SPACE,
64 GTK_TOOLBAR_CHILD_BUTTON,
65 GTK_TOOLBAR_CHILD_TOGGLEBUTTON,
66 GTK_TOOLBAR_CHILD_RADIOBUTTON,
67 GTK_TOOLBAR_CHILD_WIDGET
68 } GtkToolbarChildType;
70 typedef struct _GtkToolbarChild GtkToolbarChild;
72 struct _GtkToolbarChild
74 GtkToolbarChildType type;
82 GTK_TOOLBAR_SPACE_EMPTY,
83 GTK_TOOLBAR_SPACE_LINE
84 } GtkToolbarSpaceStyle;
86 #endif /* GTK_DISABLE_DEPRECATED */
88 typedef struct _GtkToolbar GtkToolbar;
89 typedef struct _GtkToolbarClass GtkToolbarClass;
90 typedef struct _GtkToolbarPrivate GtkToolbarPrivate;
94 GtkContainer container;
98 GtkOrientation orientation;
99 GtkToolbarStyle style;
100 GtkIconSize icon_size;
102 GtkTooltips *tooltips;
104 gint button_maxw; /* maximum width of homogeneous children */
105 gint button_maxh; /* maximum height of homogeneous children */
107 guint style_set_connection;
108 guint icon_size_connection;
111 guint icon_size_set : 1;
114 struct _GtkToolbarClass
116 GtkContainerClass parent_class;
119 void (* orientation_changed) (GtkToolbar *toolbar,
120 GtkOrientation orientation);
121 void (* style_changed) (GtkToolbar *toolbar,
122 GtkToolbarStyle style);
123 gboolean (* popup_context_menu) (GtkToolbar *toolbar,
128 /* Padding for future expansion */
129 void (*_gtk_reserved1) (void);
130 void (*_gtk_reserved2) (void);
131 void (*_gtk_reserved3) (void);
134 GType gtk_toolbar_get_type (void) G_GNUC_CONST;
135 GtkWidget* gtk_toolbar_new (void);
136 void gtk_toolbar_insert (GtkToolbar *toolbar,
139 gint gtk_toolbar_get_item_index (GtkToolbar *toolbar,
141 gint gtk_toolbar_get_n_items (GtkToolbar *toolbar);
142 GtkToolItem * gtk_toolbar_get_nth_item (GtkToolbar *toolbar,
144 gint gtk_toolbar_get_drop_index (GtkToolbar *toolbar,
147 void gtk_toolbar_set_show_arrow (GtkToolbar *toolbar,
148 gboolean show_arrow);
149 void gtk_toolbar_set_orientation (GtkToolbar *toolbar,
150 GtkOrientation orientation);
151 void gtk_toolbar_set_tooltips (GtkToolbar *toolbar,
153 gboolean gtk_toolbar_get_show_arrow (GtkToolbar *toolbar);
154 GtkOrientation gtk_toolbar_get_orientation (GtkToolbar *toolbar);
155 GtkToolbarStyle gtk_toolbar_get_style (GtkToolbar *toolbar);
156 GtkIconSize gtk_toolbar_get_icon_size (GtkToolbar *toolbar);
157 gboolean gtk_toolbar_get_tooltips (GtkToolbar *toolbar);
158 GtkReliefStyle gtk_toolbar_get_relief_style (GtkToolbar *toolbar);
159 void gtk_toolbar_set_style (GtkToolbar *toolbar,
160 GtkToolbarStyle style);
161 void gtk_toolbar_unset_style (GtkToolbar *toolbar);
165 /* internal function */
166 gchar * _gtk_toolbar_elide_underscores (const gchar *original);
168 #ifndef GTK_DISABLE_DEPRECATED
169 void gtk_toolbar_set_icon_size (GtkToolbar *toolbar,
170 GtkIconSize icon_size);
171 void gtk_toolbar_unset_icon_size (GtkToolbar *toolbar);
173 /* Simple button items */
174 GtkWidget* gtk_toolbar_append_item (GtkToolbar *toolbar,
176 const char *tooltip_text,
177 const char *tooltip_private_text,
179 GtkSignalFunc callback,
181 GtkWidget* gtk_toolbar_prepend_item (GtkToolbar *toolbar,
183 const char *tooltip_text,
184 const char *tooltip_private_text,
186 GtkSignalFunc callback,
188 GtkWidget* gtk_toolbar_insert_item (GtkToolbar *toolbar,
190 const char *tooltip_text,
191 const char *tooltip_private_text,
193 GtkSignalFunc callback,
198 GtkWidget* gtk_toolbar_insert_stock (GtkToolbar *toolbar,
199 const gchar *stock_id,
200 const char *tooltip_text,
201 const char *tooltip_private_text,
202 GtkSignalFunc callback,
207 void gtk_toolbar_append_space (GtkToolbar *toolbar);
208 void gtk_toolbar_prepend_space (GtkToolbar *toolbar);
209 void gtk_toolbar_insert_space (GtkToolbar *toolbar,
211 void gtk_toolbar_remove_space (GtkToolbar *toolbar,
213 /* Any element type */
214 GtkWidget* gtk_toolbar_append_element (GtkToolbar *toolbar,
215 GtkToolbarChildType type,
218 const char *tooltip_text,
219 const char *tooltip_private_text,
221 GtkSignalFunc callback,
224 GtkWidget* gtk_toolbar_prepend_element (GtkToolbar *toolbar,
225 GtkToolbarChildType type,
228 const char *tooltip_text,
229 const char *tooltip_private_text,
231 GtkSignalFunc callback,
234 GtkWidget* gtk_toolbar_insert_element (GtkToolbar *toolbar,
235 GtkToolbarChildType type,
238 const char *tooltip_text,
239 const char *tooltip_private_text,
241 GtkSignalFunc callback,
245 /* Generic Widgets */
246 void gtk_toolbar_append_widget (GtkToolbar *toolbar,
248 const char *tooltip_text,
249 const char *tooltip_private_text);
250 void gtk_toolbar_prepend_widget (GtkToolbar *toolbar,
252 const char *tooltip_text,
253 const char *tooltip_private_text);
254 void gtk_toolbar_insert_widget (GtkToolbar *toolbar,
256 const char *tooltip_text,
257 const char *tooltip_private_text,
260 #endif /* GTK_DISABLE_DEPRECATED */
265 #endif /* __GTK_TOOLBAR_H__ */