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@gnome.org>
   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 #if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  33 #error "Only <gtk/gtk.h> can be included directly."
  34 #endif
  35
  36 #ifndef __GTK_TOOLBAR_H__
  37 #define __GTK_TOOLBAR_H__
  38
  39 #include <gdk/gdk.h>
  40 #include <gtk/gtkcontainer.h>
  41 #include <gtk/gtkenums.h>
  42 #include <gtk/gtktooltips.h>
  43
  44 #include "gtktoolitem.h"
  45
  46 #ifndef GTK_DISABLE_DEPRECATED
  47
  48 /* Not needed, retained for compatibility -Yosh */
  49 #include <gtk/gtkpixmap.h>
  50 #include <gtk/gtksignal.h>
  51
  52 #endif /* GTK_DISABLE_DEPRECATED */
  53
  54 G_BEGIN_DECLS
  55
  56 #define GTK_TYPE_TOOLBAR            (gtk_toolbar_get_type ())
  57 #define GTK_TOOLBAR(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TOOLBAR, GtkToolbar))
  58 #define GTK_TOOLBAR_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TOOLBAR, GtkToolbarClass))
  59 #define GTK_IS_TOOLBAR(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TOOLBAR))
  60 #define GTK_IS_TOOLBAR_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TOOLBAR))
  61 #define GTK_TOOLBAR_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TOOLBAR, GtkToolbarClass))
  62
  63 #ifndef GTK_DISABLE_DEPRECATED
  64 typedef enum
  65 {
  66   GTK_TOOLBAR_CHILD_SPACE,
  67   GTK_TOOLBAR_CHILD_BUTTON,
  68   GTK_TOOLBAR_CHILD_TOGGLEBUTTON,
  69   GTK_TOOLBAR_CHILD_RADIOBUTTON,
  70   GTK_TOOLBAR_CHILD_WIDGET
  71 } GtkToolbarChildType;
  72
  73 typedef struct _GtkToolbarChild      GtkToolbarChild;
  74
  75 struct _GtkToolbarChild
  76 {
  77   GtkToolbarChildType type;
  78   GtkWidget *widget;
  79   GtkWidget *icon;
  80   GtkWidget *label;
  81 };
  82
  83 #endif /* GTK_DISABLE_DEPRECATED */
  84
  85 typedef enum
  86 {
  87   GTK_TOOLBAR_SPACE_EMPTY,
  88   GTK_TOOLBAR_SPACE_LINE
  89 } GtkToolbarSpaceStyle;
  90
  91 typedef struct _GtkToolbar           GtkToolbar;
  92 typedef struct _GtkToolbarClass      GtkToolbarClass;
  93 typedef struct _GtkToolbarPrivate    GtkToolbarPrivate;
  94
  95 struct _GtkToolbar
  96 {
  97   GtkContainer container;
  98
  99   /*< public >*/
 100   gint             num_children;
 101   GList           *children;
 102   GtkOrientation   orientation;
 103   GtkToolbarStyle  style;
 104   GtkIconSize      icon_size;
 105
 106 #ifndef GTK_DISABLE_DEPRECATED
 107   GtkTooltips     *tooltips;
 108 #else
 109   gpointer         _tooltips;
 110 #endif
 111
 112   /*< private >*/
 113   gint             button_maxw;         /* maximum width of homogeneous children */
 114   gint             button_maxh;         /* maximum height of homogeneous children */
 115
 116   guint            _gtk_reserved1;
 117   guint            _gtk_reserved2;
 118
 119   guint            style_set : 1;
 120   guint            icon_size_set : 1;
 121 };
 122
 123 struct _GtkToolbarClass
 124 {
 125   GtkContainerClass parent_class;
 126
 127   /* signals */
 128   void     (* orientation_changed) (GtkToolbar       *toolbar,
 129                                     GtkOrientation    orientation);
 130   void     (* style_changed)       (GtkToolbar       *toolbar,
 131                                     GtkToolbarStyle   style);
 132   gboolean (* popup_context_menu)  (GtkToolbar       *toolbar,
 133                                     gint              x,
 134                                     gint              y,
 135                                     gint              button_number);
 136
 137   /* Padding for future expansion */
 138   void (*_gtk_reserved1) (void);
 139   void (*_gtk_reserved2) (void);
 140   void (*_gtk_reserved3) (void);
 141 };
 142
 143 GType           gtk_toolbar_get_type         (void) G_GNUC_CONST;
 144 GtkWidget*      gtk_toolbar_new                     (void);
 145 void            gtk_toolbar_insert                  (GtkToolbar      *toolbar,
 146                                                      GtkToolItem     *item,
 147                                                      gint             pos);
 148 gint            gtk_toolbar_get_item_index          (GtkToolbar      *toolbar,
 149                                                      GtkToolItem     *item);
 150 gint            gtk_toolbar_get_n_items             (GtkToolbar      *toolbar);
 151 GtkToolItem *   gtk_toolbar_get_nth_item            (GtkToolbar      *toolbar,
 152                                                      gint             n);
 153 gboolean        gtk_toolbar_get_show_arrow          (GtkToolbar      *toolbar);
 154 void            gtk_toolbar_set_show_arrow          (GtkToolbar      *toolbar,
 155                                                      gboolean         show_arrow);
 156 GtkOrientation  gtk_toolbar_get_orientation         (GtkToolbar      *toolbar);
 157 void            gtk_toolbar_set_orientation         (GtkToolbar      *toolbar,
 158                                                      GtkOrientation   orientation);
 159 gboolean        gtk_toolbar_get_tooltips            (GtkToolbar      *toolbar);
 160 void            gtk_toolbar_set_tooltips            (GtkToolbar      *toolbar,
 161                                                      gboolean         enable);
 162 GtkToolbarStyle gtk_toolbar_get_style               (GtkToolbar      *toolbar);
 163 void            gtk_toolbar_set_style               (GtkToolbar      *toolbar,
 164                                                      GtkToolbarStyle  style);
 165 void            gtk_toolbar_unset_style             (GtkToolbar      *toolbar);
 166 GtkIconSize     gtk_toolbar_get_icon_size           (GtkToolbar      *toolbar);
 167 GtkReliefStyle  gtk_toolbar_get_relief_style        (GtkToolbar      *toolbar);
 168 gint            gtk_toolbar_get_drop_index          (GtkToolbar      *toolbar,
 169                                                      gint             x,
 170                                                      gint             y);
 171 void            gtk_toolbar_set_drop_highlight_item (GtkToolbar      *toolbar,
 172                                                      GtkToolItem     *tool_item,
 173                                                      gint             index_);
 174
 175 /* internal functions */
 176 gchar *         _gtk_toolbar_elide_underscores      (const gchar         *original);
 177 void            _gtk_toolbar_paint_space_line       (GtkWidget           *widget,
 178                                                      GtkToolbar          *toolbar,
 179                                                      const GdkRectangle  *area,
 180                                                      const GtkAllocation *allocation);
 181 gint            _gtk_toolbar_get_default_space_size (void);
 182
 183
 184 void       gtk_toolbar_set_icon_size   (GtkToolbar      *toolbar,
 185                                         GtkIconSize      icon_size);
 186 void       gtk_toolbar_unset_icon_size (GtkToolbar      *toolbar);
 187
 188 #ifndef GTK_DISABLE_DEPRECATED
 189 /* Simple button items */
 190 GtkWidget* gtk_toolbar_append_item   (GtkToolbar      *toolbar,
 191                                       const char      *text,
 192                                       const char      *tooltip_text,
 193                                       const char      *tooltip_private_text,
 194                                       GtkWidget       *icon,
 195                                       GtkSignalFunc    callback,
 196                                       gpointer         user_data);
 197 GtkWidget* gtk_toolbar_prepend_item  (GtkToolbar      *toolbar,
 198                                       const char      *text,
 199                                       const char      *tooltip_text,
 200                                       const char      *tooltip_private_text,
 201                                       GtkWidget       *icon,
 202                                       GtkSignalFunc    callback,
 203                                       gpointer         user_data);
 204 GtkWidget* gtk_toolbar_insert_item   (GtkToolbar      *toolbar,
 205                                       const char      *text,
 206                                       const char      *tooltip_text,
 207                                       const char      *tooltip_private_text,
 208                                       GtkWidget       *icon,
 209                                       GtkSignalFunc    callback,
 210                                       gpointer         user_data,
 211                                       gint             position);
 212
 213 /* Stock Items */
 214 GtkWidget* gtk_toolbar_insert_stock    (GtkToolbar      *toolbar,
 215                                         const gchar     *stock_id,
 216                                         const char      *tooltip_text,
 217                                         const char      *tooltip_private_text,
 218                                         GtkSignalFunc    callback,
 219                                         gpointer         user_data,
 220                                         gint             position);
 221
 222 /* Space Items */
 223 void       gtk_toolbar_append_space    (GtkToolbar      *toolbar);
 224 void       gtk_toolbar_prepend_space   (GtkToolbar      *toolbar);
 225 void       gtk_toolbar_insert_space    (GtkToolbar      *toolbar,
 226                                         gint             position);
 227 void       gtk_toolbar_remove_space    (GtkToolbar      *toolbar,
 228                                         gint             position);
 229 /* Any element type */
 230 GtkWidget* gtk_toolbar_append_element  (GtkToolbar      *toolbar,
 231                                         GtkToolbarChildType type,
 232                                         GtkWidget       *widget,
 233                                         const char      *text,
 234                                         const char      *tooltip_text,
 235                                         const char      *tooltip_private_text,
 236                                         GtkWidget       *icon,
 237                                         GtkSignalFunc    callback,
 238                                         gpointer         user_data);
 239
 240 GtkWidget* gtk_toolbar_prepend_element (GtkToolbar      *toolbar,
 241                                         GtkToolbarChildType type,
 242                                         GtkWidget       *widget,
 243                                         const char      *text,
 244                                         const char      *tooltip_text,
 245                                         const char      *tooltip_private_text,
 246                                         GtkWidget       *icon,
 247                                         GtkSignalFunc    callback,
 248                                         gpointer         user_data);
 249
 250 GtkWidget* gtk_toolbar_insert_element  (GtkToolbar      *toolbar,
 251                                         GtkToolbarChildType type,
 252                                         GtkWidget       *widget,
 253                                         const char      *text,
 254                                         const char      *tooltip_text,
 255                                         const char      *tooltip_private_text,
 256                                         GtkWidget       *icon,
 257                                         GtkSignalFunc    callback,
 258                                         gpointer         user_data,
 259                                         gint             position);
 260
 261 /* Generic Widgets */
 262 void       gtk_toolbar_append_widget   (GtkToolbar      *toolbar,
 263                                         GtkWidget       *widget,
 264                                         const char      *tooltip_text,
 265                                         const char      *tooltip_private_text);
 266 void       gtk_toolbar_prepend_widget  (GtkToolbar      *toolbar,
 267                                         GtkWidget       *widget,
 268                                         const char      *tooltip_text,
 269                                         const char      *tooltip_private_text);
 270 void       gtk_toolbar_insert_widget   (GtkToolbar      *toolbar,
 271                                         GtkWidget       *widget,
 272                                         const char      *tooltip_text,
 273                                         const char      *tooltip_private_text,
 274                                         gint             position);
 275
 276 #endif /* GTK_DISABLE_DEPRECATED */
 277
 278
 279 G_END_DECLS
 280
 281 #endif /* __GTK_TOOLBAR_H__ */