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_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/gtktoolitem.h>
  42
  43 G_BEGIN_DECLS
  44
  45
  46 #define GTK_TYPE_TOOLBAR            (gtk_toolbar_get_type ())
  47 #define GTK_TOOLBAR(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TOOLBAR, GtkToolbar))
  48 #define GTK_TOOLBAR_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TOOLBAR, GtkToolbarClass))
  49 #define GTK_IS_TOOLBAR(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TOOLBAR))
  50 #define GTK_IS_TOOLBAR_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TOOLBAR))
  51 #define GTK_TOOLBAR_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TOOLBAR, GtkToolbarClass))
  52
  53 typedef enum
  54 {
  55   GTK_TOOLBAR_SPACE_EMPTY,
  56   GTK_TOOLBAR_SPACE_LINE
  57 } GtkToolbarSpaceStyle;
  58
  59 typedef struct _GtkToolbar           GtkToolbar;
  60 typedef struct _GtkToolbarClass      GtkToolbarClass;
  61 typedef struct _GtkToolbarPrivate    GtkToolbarPrivate;
  62
  63 struct _GtkToolbar
  64 {
  65   GtkContainer container;
  66
  67   /*< public >*/
  68   gint             GSEAL (num_children);
  69   GList           *GSEAL (children);
  70   GtkOrientation   GSEAL (orientation);
  71   GtkToolbarStyle  GSEAL (style);
  72   GtkIconSize      GSEAL (icon_size);
  73
  74   /*< private >*/
  75   gint             GSEAL (button_maxw);         /* maximum width of homogeneous children */
  76   gint             GSEAL (button_maxh);         /* maximum height of homogeneous children */
  77
  78   guint            _gtk_reserved1;
  79   guint            _gtk_reserved2;
  80
  81   guint            GSEAL (style_set) : 1;
  82   guint            GSEAL (icon_size_set) : 1;
  83 };
  84
  85 struct _GtkToolbarClass
  86 {
  87   GtkContainerClass parent_class;
  88
  89   /* signals */
  90   void     (* orientation_changed) (GtkToolbar       *toolbar,
  91                                     GtkOrientation    orientation);
  92   void     (* style_changed)       (GtkToolbar       *toolbar,
  93                                     GtkToolbarStyle   style);
  94   gboolean (* popup_context_menu)  (GtkToolbar       *toolbar,
  95                                     gint              x,
  96                                     gint              y,
  97                                     gint              button_number);
  98
  99   /* Padding for future expansion */
 100   void (*_gtk_reserved1) (void);
 101   void (*_gtk_reserved2) (void);
 102   void (*_gtk_reserved3) (void);
 103 };
 104
 105 GType           gtk_toolbar_get_type                (void) G_GNUC_CONST;
 106 GtkWidget *     gtk_toolbar_new                     (void);
 107
 108 void            gtk_toolbar_insert                  (GtkToolbar      *toolbar,
 109                                                      GtkToolItem     *item,
 110                                                      gint             pos);
 111
 112 gint            gtk_toolbar_get_item_index          (GtkToolbar      *toolbar,
 113                                                      GtkToolItem     *item);
 114 gint            gtk_toolbar_get_n_items             (GtkToolbar      *toolbar);
 115 GtkToolItem *   gtk_toolbar_get_nth_item            (GtkToolbar      *toolbar,
 116                                                      gint             n);
 117
 118 gboolean        gtk_toolbar_get_show_arrow          (GtkToolbar      *toolbar);
 119 void            gtk_toolbar_set_show_arrow          (GtkToolbar      *toolbar,
 120                                                      gboolean         show_arrow);
 121
 122 GtkToolbarStyle gtk_toolbar_get_style               (GtkToolbar      *toolbar);
 123 void            gtk_toolbar_set_style               (GtkToolbar      *toolbar,
 124                                                      GtkToolbarStyle  style);
 125 void            gtk_toolbar_unset_style             (GtkToolbar      *toolbar);
 126
 127 GtkIconSize     gtk_toolbar_get_icon_size           (GtkToolbar      *toolbar);
 128 void            gtk_toolbar_set_icon_size           (GtkToolbar      *toolbar,
 129                                                      GtkIconSize      icon_size);
 130 void            gtk_toolbar_unset_icon_size         (GtkToolbar      *toolbar);
 131
 132 GtkReliefStyle  gtk_toolbar_get_relief_style        (GtkToolbar      *toolbar);
 133 gint            gtk_toolbar_get_drop_index          (GtkToolbar      *toolbar,
 134                                                      gint             x,
 135                                                      gint             y);
 136 void            gtk_toolbar_set_drop_highlight_item (GtkToolbar      *toolbar,
 137                                                      GtkToolItem     *tool_item,
 138                                                      gint             index_);
 139
 140
 141 /* internal functions */
 142 gchar *         _gtk_toolbar_elide_underscores      (const gchar         *original);
 143 void            _gtk_toolbar_paint_space_line       (GtkWidget           *widget,
 144                                                      GtkToolbar          *toolbar,
 145                                                      const GdkRectangle  *area,
 146                                                      const GtkAllocation *allocation);
 147 gint            _gtk_toolbar_get_default_space_size (void);
 148
 149
 150 G_END_DECLS
 151
 152 #endif /* __GTK_TOOLBAR_H__ */