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@gnome.org>
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 #if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
33 #error "Only <gtk/gtk.h> can be included directly."
36 #ifndef __GTK_TOOLBAR_H__
37 #define __GTK_TOOLBAR_H__
40 #include <gtk/gtkcontainer.h>
41 #include <gtk/gtkenums.h>
42 #include <gtk/gtktooltips.h>
43 #include <gtk/gtktoolitem.h>
45 #ifndef GTK_DISABLE_DEPRECATED
47 /* Not needed, retained for compatibility -Yosh */
48 #include <gtk/gtkpixmap.h>
49 #include <gtk/gtksignal.h>
51 #endif /* GTK_DISABLE_DEPRECATED */
55 #define GTK_TYPE_TOOLBAR (gtk_toolbar_get_type ())
56 #define GTK_TOOLBAR(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TOOLBAR, GtkToolbar))
57 #define GTK_TOOLBAR_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TOOLBAR, GtkToolbarClass))
58 #define GTK_IS_TOOLBAR(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TOOLBAR))
59 #define GTK_IS_TOOLBAR_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TOOLBAR))
60 #define GTK_TOOLBAR_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TOOLBAR, GtkToolbarClass))
62 #ifndef GTK_DISABLE_DEPRECATED
65 GTK_TOOLBAR_CHILD_SPACE,
66 GTK_TOOLBAR_CHILD_BUTTON,
67 GTK_TOOLBAR_CHILD_TOGGLEBUTTON,
68 GTK_TOOLBAR_CHILD_RADIOBUTTON,
69 GTK_TOOLBAR_CHILD_WIDGET
70 } GtkToolbarChildType;
72 typedef struct _GtkToolbarChild GtkToolbarChild;
74 struct _GtkToolbarChild
76 GtkToolbarChildType type;
82 #endif /* GTK_DISABLE_DEPRECATED */
86 GTK_TOOLBAR_SPACE_EMPTY,
87 GTK_TOOLBAR_SPACE_LINE
88 } GtkToolbarSpaceStyle;
90 typedef struct _GtkToolbar GtkToolbar;
91 typedef struct _GtkToolbarClass GtkToolbarClass;
92 typedef struct _GtkToolbarPrivate GtkToolbarPrivate;
96 GtkContainer container;
99 gint GSEAL (num_children);
100 GList *GSEAL (children);
101 GtkOrientation GSEAL (orientation);
102 GtkToolbarStyle GSEAL (style);
103 GtkIconSize GSEAL (icon_size);
105 #ifndef GTK_DISABLE_DEPRECATED
106 GtkTooltips *GSEAL (tooltips);
108 gpointer GSEAL (_tooltips);
112 gint GSEAL (button_maxw); /* maximum width of homogeneous children */
113 gint GSEAL (button_maxh); /* maximum height of homogeneous children */
115 guint _gtk_reserved1;
116 guint _gtk_reserved2;
118 guint GSEAL (style_set) : 1;
119 guint GSEAL (icon_size_set) : 1;
122 struct _GtkToolbarClass
124 GtkContainerClass parent_class;
127 void (* orientation_changed) (GtkToolbar *toolbar,
128 GtkOrientation orientation);
129 void (* style_changed) (GtkToolbar *toolbar,
130 GtkToolbarStyle style);
131 gboolean (* popup_context_menu) (GtkToolbar *toolbar,
136 /* Padding for future expansion */
137 void (*_gtk_reserved1) (void);
138 void (*_gtk_reserved2) (void);
139 void (*_gtk_reserved3) (void);
142 GType gtk_toolbar_get_type (void) G_GNUC_CONST;
143 GtkWidget* gtk_toolbar_new (void);
144 void gtk_toolbar_insert (GtkToolbar *toolbar,
147 gint gtk_toolbar_get_item_index (GtkToolbar *toolbar,
149 gint gtk_toolbar_get_n_items (GtkToolbar *toolbar);
150 GtkToolItem * gtk_toolbar_get_nth_item (GtkToolbar *toolbar,
152 gboolean gtk_toolbar_get_show_arrow (GtkToolbar *toolbar);
153 void gtk_toolbar_set_show_arrow (GtkToolbar *toolbar,
154 gboolean show_arrow);
155 GtkOrientation gtk_toolbar_get_orientation (GtkToolbar *toolbar);
156 void gtk_toolbar_set_orientation (GtkToolbar *toolbar,
157 GtkOrientation orientation);
158 #ifndef GTK_DISABLE_DEPRECATED
159 gboolean gtk_toolbar_get_tooltips (GtkToolbar *toolbar);
160 void gtk_toolbar_set_tooltips (GtkToolbar *toolbar,
162 #endif /* GTK_DISABLE_DEPRECATED */
163 GtkToolbarStyle gtk_toolbar_get_style (GtkToolbar *toolbar);
164 void gtk_toolbar_set_style (GtkToolbar *toolbar,
165 GtkToolbarStyle style);
166 void gtk_toolbar_unset_style (GtkToolbar *toolbar);
167 GtkIconSize gtk_toolbar_get_icon_size (GtkToolbar *toolbar);
168 GtkReliefStyle gtk_toolbar_get_relief_style (GtkToolbar *toolbar);
169 gint gtk_toolbar_get_drop_index (GtkToolbar *toolbar,
172 void gtk_toolbar_set_drop_highlight_item (GtkToolbar *toolbar,
173 GtkToolItem *tool_item,
176 /* internal functions */
177 gchar * _gtk_toolbar_elide_underscores (const gchar *original);
178 void _gtk_toolbar_paint_space_line (GtkWidget *widget,
180 const GdkRectangle *area,
181 const GtkAllocation *allocation);
182 gint _gtk_toolbar_get_default_space_size (void);
185 void gtk_toolbar_set_icon_size (GtkToolbar *toolbar,
186 GtkIconSize icon_size);
187 void gtk_toolbar_unset_icon_size (GtkToolbar *toolbar);
189 #ifndef GTK_DISABLE_DEPRECATED
190 /* Simple button items */
191 GtkWidget* gtk_toolbar_append_item (GtkToolbar *toolbar,
193 const char *tooltip_text,
194 const char *tooltip_private_text,
198 GtkWidget* gtk_toolbar_prepend_item (GtkToolbar *toolbar,
200 const char *tooltip_text,
201 const char *tooltip_private_text,
205 GtkWidget* gtk_toolbar_insert_item (GtkToolbar *toolbar,
207 const char *tooltip_text,
208 const char *tooltip_private_text,
215 GtkWidget* gtk_toolbar_insert_stock (GtkToolbar *toolbar,
216 const gchar *stock_id,
217 const char *tooltip_text,
218 const char *tooltip_private_text,
224 void gtk_toolbar_append_space (GtkToolbar *toolbar);
225 void gtk_toolbar_prepend_space (GtkToolbar *toolbar);
226 void gtk_toolbar_insert_space (GtkToolbar *toolbar,
228 void gtk_toolbar_remove_space (GtkToolbar *toolbar,
230 /* Any element type */
231 GtkWidget* gtk_toolbar_append_element (GtkToolbar *toolbar,
232 GtkToolbarChildType type,
235 const char *tooltip_text,
236 const char *tooltip_private_text,
241 GtkWidget* gtk_toolbar_prepend_element (GtkToolbar *toolbar,
242 GtkToolbarChildType type,
245 const char *tooltip_text,
246 const char *tooltip_private_text,
251 GtkWidget* gtk_toolbar_insert_element (GtkToolbar *toolbar,
252 GtkToolbarChildType type,
255 const char *tooltip_text,
256 const char *tooltip_private_text,
262 /* Generic Widgets */
263 void gtk_toolbar_append_widget (GtkToolbar *toolbar,
265 const char *tooltip_text,
266 const char *tooltip_private_text);
267 void gtk_toolbar_prepend_widget (GtkToolbar *toolbar,
269 const char *tooltip_text,
270 const char *tooltip_private_text);
271 void gtk_toolbar_insert_widget (GtkToolbar *toolbar,
273 const char *tooltip_text,
274 const char *tooltip_private_text,
277 #endif /* GTK_DISABLE_DEPRECATED */
282 #endif /* __GTK_TOOLBAR_H__ */