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