gtktoolbar.h 5.25 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
2 3 4
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 * GtkToolbar copyright (C) Federico Mena
 *
5
 * Copyright (C) 2002 Anders Carlsson <andersca@gnome.org>
6 7
 * Copyright (C) 2002 James Henstridge <james@daa.com.au>
 * Copyright (C) 2003 Soeren Sandmann <sandmann@daimi.au.dk>
8
 *
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
Javier Jardón's avatar
Javier Jardón committed
20
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
21 22
 */

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

30 31 32
#ifndef __GTK_TOOLBAR_H__
#define __GTK_TOOLBAR_H__

33

34 35 36 37
#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
#error "Only <gtk/gtk.h> can be included directly."
#endif

38
#include <gtk/gtkcontainer.h>
39
#include <gtk/gtktoolitem.h>
40 41

G_BEGIN_DECLS
42

43

44 45 46 47 48 49
#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
50

51 52 53 54 55 56 57
/**
 * GtkToolbarSpaceStyle:
 * @GTK_TOOLBAR_SPACE_EMPTY: Use blank spacers.
 * @GTK_TOOLBAR_SPACE_LINE: Use vertical lines for spacers.
 *
 * Whether spacers are vertical lines or just blank.
 */
58 59 60 61 62 63
typedef enum
{
  GTK_TOOLBAR_SPACE_EMPTY,
  GTK_TOOLBAR_SPACE_LINE
} GtkToolbarSpaceStyle;

64 65 66
typedef struct _GtkToolbar              GtkToolbar;
typedef struct _GtkToolbarPrivate       GtkToolbarPrivate;
typedef struct _GtkToolbarClass         GtkToolbarClass;
67

68 69 70
struct _GtkToolbar
{
  GtkContainer container;
71

72
  GtkToolbarPrivate *priv;
73 74 75 76 77
};

struct _GtkToolbarClass
{
  GtkContainerClass parent_class;
78

79
  /* signals */
80
  void     (* orientation_changed) (GtkToolbar       *toolbar,
81
				    GtkOrientation    orientation);
82
  void     (* style_changed)       (GtkToolbar       *toolbar,
83 84 85 86 87
				    GtkToolbarStyle   style);
  gboolean (* popup_context_menu)  (GtkToolbar       *toolbar,
				    gint              x,
				    gint              y,
				    gint              button_number);
88

89 90 91 92
  /* Padding for future expansion */
  void (*_gtk_reserved1) (void);
  void (*_gtk_reserved2) (void);
  void (*_gtk_reserved3) (void);
93
  void (*_gtk_reserved4) (void);
94 95
};

96
GDK_AVAILABLE_IN_ALL
97
GType           gtk_toolbar_get_type                (void) G_GNUC_CONST;
98
GDK_AVAILABLE_IN_ALL
99 100
GtkWidget *     gtk_toolbar_new                     (void);

101
GDK_AVAILABLE_IN_ALL
102 103 104
void            gtk_toolbar_insert                  (GtkToolbar      *toolbar,
						     GtkToolItem     *item,
						     gint             pos);
105

106
GDK_AVAILABLE_IN_ALL
107 108
gint            gtk_toolbar_get_item_index          (GtkToolbar      *toolbar,
						     GtkToolItem     *item);
109
GDK_AVAILABLE_IN_ALL
110
gint            gtk_toolbar_get_n_items             (GtkToolbar      *toolbar);
111
GDK_AVAILABLE_IN_ALL
112 113
GtkToolItem *   gtk_toolbar_get_nth_item            (GtkToolbar      *toolbar,
						     gint             n);
114

115
GDK_AVAILABLE_IN_ALL
116
gboolean        gtk_toolbar_get_show_arrow          (GtkToolbar      *toolbar);
117
GDK_AVAILABLE_IN_ALL
118 119
void            gtk_toolbar_set_show_arrow          (GtkToolbar      *toolbar,
						     gboolean         show_arrow);
120

121
GDK_AVAILABLE_IN_ALL
122
GtkToolbarStyle gtk_toolbar_get_style               (GtkToolbar      *toolbar);
123
GDK_AVAILABLE_IN_ALL
124 125
void            gtk_toolbar_set_style               (GtkToolbar      *toolbar,
						     GtkToolbarStyle  style);
126
GDK_AVAILABLE_IN_ALL
127
void            gtk_toolbar_unset_style             (GtkToolbar      *toolbar);
128

129
GDK_AVAILABLE_IN_ALL
130
GtkIconSize     gtk_toolbar_get_icon_size           (GtkToolbar      *toolbar);
131
GDK_AVAILABLE_IN_ALL
132 133
void            gtk_toolbar_set_icon_size           (GtkToolbar      *toolbar,
                                                     GtkIconSize      icon_size);
134
GDK_AVAILABLE_IN_ALL
135 136
void            gtk_toolbar_unset_icon_size         (GtkToolbar      *toolbar);

137
GDK_AVAILABLE_IN_ALL
138
GtkReliefStyle  gtk_toolbar_get_relief_style        (GtkToolbar      *toolbar);
139
GDK_AVAILABLE_IN_ALL
140 141 142
gint            gtk_toolbar_get_drop_index          (GtkToolbar      *toolbar,
						     gint             x,
						     gint             y);
143
GDK_AVAILABLE_IN_ALL
144 145
void            gtk_toolbar_set_drop_highlight_item (GtkToolbar      *toolbar,
						     GtkToolItem     *tool_item,
146
						     gint             index_);
147

148

149
G_END_DECLS
150 151

#endif /* __GTK_TOOLBAR_H__ */