Pileus Git - ~andy/gtk/blob - gtk/gtktoolbar.h

   1 /* GTK - The GIMP Toolkit
   2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
   3  * GtkToolbar copyright (C) Federico Mena
   4  *
   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>
   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  * License as published by the Free Software Foundation; either
  12  * version 2 of the License, or (at your option) any later version.
  13  *
  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.
  18  *
  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.
  23  */
  24
  25 /*
  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/.
  30  */
  31
  32 #ifndef __GTK_TOOLBAR_H__
  33 #define __GTK_TOOLBAR_H__
  34
  35 #include <gdk/gdk.h>
  36 #include <gtk/gtkcontainer.h>
  37 #include <gtk/gtkenums.h>
  38 #include <gtk/gtktooltips.h>
  39
  40 #include "gtktoolitem.h"
  41
  42 #ifndef GTK_DISABLE_DEPRECATED
  43
  44 /* Not needed, retained for compatibility -Yosh */
  45 #include <gtk/gtkpixmap.h>
  46 #include <gtk/gtksignal.h>
  47
  48 #endif
  49
  50 G_BEGIN_DECLS
  51
  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))
  59
  60 #ifndef GTK_DISABLE_DEPRECATED
  61 typedef enum
  62 {
  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;
  69
  70 typedef struct _GtkToolbarChild      GtkToolbarChild;
  71
  72 struct _GtkToolbarChild
  73 {
  74   GtkToolbarChildType type;
  75   GtkWidget *widget;
  76   GtkWidget *icon;
  77   GtkWidget *label;
  78 };
  79
  80 typedef enum
  81 {
  82   GTK_TOOLBAR_SPACE_EMPTY,
  83   GTK_TOOLBAR_SPACE_LINE
  84 } GtkToolbarSpaceStyle;
  85
  86 #endif /* GTK_DISABLE_DEPRECATED */
  87
  88 typedef struct _GtkToolbar           GtkToolbar;
  89 typedef struct _GtkToolbarClass      GtkToolbarClass;
  90 typedef struct _GtkToolbarPrivate    GtkToolbarPrivate;
  91
  92 struct _GtkToolbar
  93 {
  94   GtkContainer container;
  95
  96   gint             num_children;
  97   GList           *children;
  98   GtkOrientation   orientation;
  99   GtkToolbarStyle  style;
 100   GtkIconSize      icon_size;
 101
 102   GtkTooltips     *tooltips;
 103
 104   gint             button_maxw;         /* maximum width of homogeneous children */
 105   gint             button_maxh;         /* maximum height of homogeneous children */
 106
 107   guint            style_set_connection;
 108   guint            icon_size_connection;
 109
 110   guint            style_set : 1;
 111   guint            icon_size_set : 1;
 112 };
 113
 114 struct _GtkToolbarClass
 115 {
 116   GtkContainerClass parent_class;
 117
 118   /* signals */
 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,
 124                                     gint              x,
 125                                     gint              y,
 126                                     gint              button_number);
 127
 128   /* Padding for future expansion */
 129   void (*_gtk_reserved1) (void);
 130   void (*_gtk_reserved2) (void);
 131   void (*_gtk_reserved3) (void);
 132 };
 133
 134 GType           gtk_toolbar_get_type         (void) G_GNUC_CONST;
 135 GtkWidget*      gtk_toolbar_new              (void);
 136 void            gtk_toolbar_insert           (GtkToolbar      *toolbar,
 137                                               GtkToolItem     *item,
 138                                               gint             pos);
 139 gint            gtk_toolbar_get_item_index   (GtkToolbar      *toolbar,
 140                                               GtkToolItem     *item);
 141 gint            gtk_toolbar_get_n_items      (GtkToolbar      *toolbar);
 142 GtkToolItem *   gtk_toolbar_get_nth_item     (GtkToolbar      *toolbar,
 143                                               gint             n);
 144 gint            gtk_toolbar_get_drop_index   (GtkToolbar      *toolbar,
 145                                               gint             x,
 146                                               gint             y);
 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,
 152                                               gboolean         enable);
 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);
 162
 163
 164
 165 /* internal function */
 166 gchar * _gtk_toolbar_elide_underscores (const gchar *original);
 167
 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);
 172
 173 /* Simple button items */
 174 GtkWidget* gtk_toolbar_append_item   (GtkToolbar      *toolbar,
 175                                       const char      *text,
 176                                       const char      *tooltip_text,
 177                                       const char      *tooltip_private_text,
 178                                       GtkWidget       *icon,
 179                                       GtkSignalFunc    callback,
 180                                       gpointer         user_data);
 181 GtkWidget* gtk_toolbar_prepend_item  (GtkToolbar      *toolbar,
 182                                       const char      *text,
 183                                       const char      *tooltip_text,
 184                                       const char      *tooltip_private_text,
 185                                       GtkWidget       *icon,
 186                                       GtkSignalFunc    callback,
 187                                       gpointer         user_data);
 188 GtkWidget* gtk_toolbar_insert_item   (GtkToolbar      *toolbar,
 189                                       const char      *text,
 190                                       const char      *tooltip_text,
 191                                       const char      *tooltip_private_text,
 192                                       GtkWidget       *icon,
 193                                       GtkSignalFunc    callback,
 194                                       gpointer         user_data,
 195                                       gint             position);
 196
 197 /* Stock Items */
 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,
 203                                         gpointer         user_data,
 204                                         gint             position);
 205
 206 /* Space Items */
 207 void       gtk_toolbar_append_space    (GtkToolbar      *toolbar);
 208 void       gtk_toolbar_prepend_space   (GtkToolbar      *toolbar);
 209 void       gtk_toolbar_insert_space    (GtkToolbar      *toolbar,
 210                                         gint             position);
 211 void       gtk_toolbar_remove_space    (GtkToolbar      *toolbar,
 212                                         gint             position);
 213 /* Any element type */
 214 GtkWidget* gtk_toolbar_append_element  (GtkToolbar      *toolbar,
 215                                         GtkToolbarChildType type,
 216                                         GtkWidget       *widget,
 217                                         const char      *text,
 218                                         const char      *tooltip_text,
 219                                         const char      *tooltip_private_text,
 220                                         GtkWidget       *icon,
 221                                         GtkSignalFunc    callback,
 222                                         gpointer         user_data);
 223
 224 GtkWidget* gtk_toolbar_prepend_element (GtkToolbar      *toolbar,
 225                                         GtkToolbarChildType type,
 226                                         GtkWidget       *widget,
 227                                         const char      *text,
 228                                         const char      *tooltip_text,
 229                                         const char      *tooltip_private_text,
 230                                         GtkWidget       *icon,
 231                                         GtkSignalFunc    callback,
 232                                         gpointer         user_data);
 233
 234 GtkWidget* gtk_toolbar_insert_element  (GtkToolbar      *toolbar,
 235                                         GtkToolbarChildType type,
 236                                         GtkWidget       *widget,
 237                                         const char      *text,
 238                                         const char      *tooltip_text,
 239                                         const char      *tooltip_private_text,
 240                                         GtkWidget       *icon,
 241                                         GtkSignalFunc    callback,
 242                                         gpointer         user_data,
 243                                         gint             position);
 244
 245 /* Generic Widgets */
 246 void       gtk_toolbar_append_widget   (GtkToolbar      *toolbar,
 247                                         GtkWidget       *widget,
 248                                         const char      *tooltip_text,
 249                                         const char      *tooltip_private_text);
 250 void       gtk_toolbar_prepend_widget  (GtkToolbar      *toolbar,
 251                                         GtkWidget       *widget,
 252                                         const char      *tooltip_text,
 253                                         const char      *tooltip_private_text);
 254 void       gtk_toolbar_insert_widget   (GtkToolbar      *toolbar,
 255                                         GtkWidget       *widget,
 256                                         const char      *tooltip_text,
 257                                         const char      *tooltip_private_text,
 258                                         gint             position);
 259
 260 #endif /* GTK_DISABLE_DEPRECATED */
 261
 262
 263 G_END_DECLS
 264
 265 #endif /* __GTK_TOOLBAR_H__ */