gtktoolbar.h 9.78 KB
Newer Older
1
2
3
4
/* GTK - The GIMP Toolkit
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 * GtkToolbar copyright (C) Federico Mena
 *
Anders Carlsson's avatar
Anders Carlsson committed
5
 * Copyright (C) 2002 Anders Carlsson <andersca@gnome.org>
6
7
8
 * Copyright (C) 2002 James Henstridge <james@daa.com.au>
 * 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
12
13
14
15
16
 * 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
17
 * Lesser General Public License for more details.
18
 *
19
 * You should have received a copy of the GNU Lesser General Public
20
21
22
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
23
24
 */

25
/*
26
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
27
28
29
30
31
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
 */

32
33
34
35
36
37
#ifndef __GTK_TOOLBAR_H__
#define __GTK_TOOLBAR_H__

#include <gdk/gdk.h>
#include <gtk/gtkcontainer.h>
#include <gtk/gtkenums.h>
Manish Singh's avatar
Manish Singh committed
38
39
#include <gtk/gtktooltips.h>

40
41
42
43
#include "gtktoolitem.h"

#ifndef GTK_DISABLE_DEPRECATED

Manish Singh's avatar
Manish Singh committed
44
/* Not needed, retained for compatibility -Yosh */
45
#include <gtk/gtkpixmap.h>
46
#include <gtk/gtksignal.h>
47

48
#endif /* GTK_DISABLE_DEPRECATED */
49

50
G_BEGIN_DECLS
51

52
53
54
55
56
57
#define GTK_TYPE_TOOLBAR            (gtk_toolbar_get_type ())
#define GTK_TOOLBAR(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TOOLBAR, GtkToolbar))
#define GTK_TOOLBAR_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TOOLBAR, GtkToolbarClass))
#define GTK_IS_TOOLBAR(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TOOLBAR))
#define GTK_IS_TOOLBAR_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TOOLBAR))
#define GTK_TOOLBAR_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TOOLBAR, GtkToolbarClass))
Tim Janik's avatar
Tim Janik committed
58

59
#ifndef GTK_DISABLE_DEPRECATED
60
typedef enum
61
62
63
{
  GTK_TOOLBAR_CHILD_SPACE,
  GTK_TOOLBAR_CHILD_BUTTON,
64
65
  GTK_TOOLBAR_CHILD_TOGGLEBUTTON,
  GTK_TOOLBAR_CHILD_RADIOBUTTON,
66
  GTK_TOOLBAR_CHILD_WIDGET
67
} GtkToolbarChildType;
68

69
typedef struct _GtkToolbarChild	     GtkToolbarChild;
70

71
72
73
74
75
76
77
78
struct _GtkToolbarChild
{
  GtkToolbarChildType type;
  GtkWidget *widget;
  GtkWidget *icon;
  GtkWidget *label;
};

79
80
#endif /* GTK_DISABLE_DEPRECATED */

81
82
83
84
85
86
87
88
89
90
typedef enum
{
  GTK_TOOLBAR_SPACE_EMPTY,
  GTK_TOOLBAR_SPACE_LINE
} GtkToolbarSpaceStyle;

typedef struct _GtkToolbar           GtkToolbar;
typedef struct _GtkToolbarClass      GtkToolbarClass;
typedef struct _GtkToolbarPrivate    GtkToolbarPrivate;

91
92
93
struct _GtkToolbar
{
  GtkContainer container;
94

95
  /*< public >*/
96
  gint             num_children;
97
98
99
  GList           *children;
  GtkOrientation   orientation;
  GtkToolbarStyle  style;
100
  GtkIconSize      icon_size;
101
  
102
  GtkTooltips     *tooltips;
103
  
104
  /*< private >*/
105
106
  gint             button_maxw;		/* maximum width of homogeneous children */
  gint             button_maxh;		/* maximum height of homogeneous children */
107
  
108
109
  guint            style_set_connection;
  guint            icon_size_connection;
110
  
111
112
  guint            style_set : 1;
  guint            icon_size_set : 1;
113
114
115
116
117
};

struct _GtkToolbarClass
{
  GtkContainerClass parent_class;
118
  
119
  /* signals */
120
  void     (* orientation_changed) (GtkToolbar       *toolbar,
Soeren Sandmann's avatar
Soeren Sandmann committed
121
				    GtkOrientation    orientation);
122
  void     (* style_changed)       (GtkToolbar       *toolbar,
Soeren Sandmann's avatar
Soeren Sandmann committed
123
124
125
126
127
				    GtkToolbarStyle   style);
  gboolean (* popup_context_menu)  (GtkToolbar       *toolbar,
				    gint              x,
				    gint              y,
				    gint              button_number);
128
  
129
130
131
132
  /* Padding for future expansion */
  void (*_gtk_reserved1) (void);
  void (*_gtk_reserved2) (void);
  void (*_gtk_reserved3) (void);
133
134
};

135
GType           gtk_toolbar_get_type         (void) G_GNUC_CONST;
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
GtkWidget*      gtk_toolbar_new                     (void);
void            gtk_toolbar_insert                  (GtkToolbar      *toolbar,
						     GtkToolItem     *item,
						     gint             pos);
gint            gtk_toolbar_get_item_index          (GtkToolbar      *toolbar,
						     GtkToolItem     *item);
gint            gtk_toolbar_get_n_items             (GtkToolbar      *toolbar);
GtkToolItem *   gtk_toolbar_get_nth_item            (GtkToolbar      *toolbar,
						     gint             n);
gboolean        gtk_toolbar_get_show_arrow          (GtkToolbar      *toolbar);
void            gtk_toolbar_set_show_arrow          (GtkToolbar      *toolbar,
						     gboolean         show_arrow);
GtkOrientation  gtk_toolbar_get_orientation         (GtkToolbar      *toolbar);
void            gtk_toolbar_set_orientation         (GtkToolbar      *toolbar,
						     GtkOrientation   orientation);
gboolean        gtk_toolbar_get_tooltips            (GtkToolbar      *toolbar);
void            gtk_toolbar_set_tooltips            (GtkToolbar      *toolbar,
						     gboolean         enable);
GtkToolbarStyle gtk_toolbar_get_style               (GtkToolbar      *toolbar);
void            gtk_toolbar_set_style               (GtkToolbar      *toolbar,
						     GtkToolbarStyle  style);
void            gtk_toolbar_unset_style             (GtkToolbar      *toolbar);
GtkIconSize     gtk_toolbar_get_icon_size           (GtkToolbar      *toolbar);
GtkReliefStyle  gtk_toolbar_get_relief_style        (GtkToolbar      *toolbar);
gint            gtk_toolbar_get_drop_index          (GtkToolbar      *toolbar,
						     gint             x,
						     gint             y);
void            gtk_toolbar_set_drop_highlight_item (GtkToolbar      *toolbar,
						     GtkToolItem     *tool_item,
165
						     gint             index_);
166

167
/* internal functions */
168
169
170
171
172
173
gchar *         _gtk_toolbar_elide_underscores      (const gchar     *original);
void            _gtk_toolbar_paint_space_line       (GtkWidget       *widget,
						     GtkToolbar      *toolbar,
						     GdkRectangle    *area,
						     GtkAllocation   *allocation);
gint            _gtk_toolbar_get_default_space_size (void);
174
void            _gtk_toolbar_rebuild_menu           (GtkToolbar      *toolbar);
175
176
177


/* deprecated */
178
#ifndef GTK_DISABLE_DEPRECATED
179
180
181
182
void       gtk_toolbar_set_icon_size   (GtkToolbar      *toolbar,
				        GtkIconSize      icon_size);
void       gtk_toolbar_unset_icon_size (GtkToolbar      *toolbar);

183
/* Simple button items */
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
GtkWidget* gtk_toolbar_append_item   (GtkToolbar      *toolbar,
				      const char      *text,
				      const char      *tooltip_text,
				      const char      *tooltip_private_text,
				      GtkWidget       *icon,
				      GtkSignalFunc    callback,
				      gpointer         user_data);
GtkWidget* gtk_toolbar_prepend_item  (GtkToolbar      *toolbar,
				      const char      *text,
				      const char      *tooltip_text,
				      const char      *tooltip_private_text,
				      GtkWidget       *icon,
				      GtkSignalFunc    callback,
				      gpointer         user_data);
GtkWidget* gtk_toolbar_insert_item   (GtkToolbar      *toolbar,
				      const char      *text,
				      const char      *tooltip_text,
				      const char      *tooltip_private_text,
				      GtkWidget       *icon,
				      GtkSignalFunc    callback,
				      gpointer         user_data,
				      gint             position);
206

207
208
209
210
211
212
213
214
215
/* Stock Items */
GtkWidget* gtk_toolbar_insert_stock    (GtkToolbar      *toolbar,
					const gchar     *stock_id,
					const char      *tooltip_text,
					const char      *tooltip_private_text,
					GtkSignalFunc    callback,
					gpointer         user_data,
					gint             position);

216
/* Space Items */
217
218
219
220
void       gtk_toolbar_append_space    (GtkToolbar      *toolbar);
void       gtk_toolbar_prepend_space   (GtkToolbar      *toolbar);
void       gtk_toolbar_insert_space    (GtkToolbar      *toolbar,
					gint             position);
Havoc Pennington's avatar
Havoc Pennington committed
221
222
void       gtk_toolbar_remove_space    (GtkToolbar      *toolbar,
                                        gint             position);
223
/* Any element type */
224
GtkWidget* gtk_toolbar_append_element  (GtkToolbar      *toolbar,
225
226
227
228
229
230
231
232
233
					GtkToolbarChildType type,
					GtkWidget       *widget,
					const char      *text,
					const char      *tooltip_text,
					const char      *tooltip_private_text,
					GtkWidget       *icon,
					GtkSignalFunc    callback,
					gpointer         user_data);

234
GtkWidget* gtk_toolbar_prepend_element (GtkToolbar      *toolbar,
235
236
237
238
239
240
241
242
243
					GtkToolbarChildType type,
					GtkWidget       *widget,
					const char      *text,
					const char      *tooltip_text,
					const char      *tooltip_private_text,
					GtkWidget       *icon,
					GtkSignalFunc    callback,
					gpointer         user_data);

244
GtkWidget* gtk_toolbar_insert_element  (GtkToolbar      *toolbar,
245
246
247
248
249
250
251
252
253
254
255
					GtkToolbarChildType type,
					GtkWidget       *widget,
					const char      *text,
					const char      *tooltip_text,
					const char      *tooltip_private_text,
					GtkWidget       *icon,
					GtkSignalFunc    callback,
					gpointer         user_data,
					gint             position);

/* Generic Widgets */
256
void       gtk_toolbar_append_widget   (GtkToolbar      *toolbar,
257
					GtkWidget       *widget,
258
259
					const char      *tooltip_text,
					const char      *tooltip_private_text);
260
void       gtk_toolbar_prepend_widget  (GtkToolbar      *toolbar,
261
					GtkWidget       *widget,
262
263
					const char      *tooltip_text,
					const char	*tooltip_private_text);
264
265
void       gtk_toolbar_insert_widget   (GtkToolbar      *toolbar,
					GtkWidget       *widget,
266
					const char      *tooltip_text,
267
					const char      *tooltip_private_text,
268
					gint             position);
269

270
271
272
273
#endif /* GTK_DISABLE_DEPRECATED */


G_END_DECLS
274
275

#endif /* __GTK_TOOLBAR_H__ */