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