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
  49 #endif /* GTK_DISABLE_DEPRECATED */
  50
  51 G_BEGIN_DECLS
  52
  53 #define GTK_TYPE_TOOLBAR            (gtk_toolbar_get_type ())
  54 #define GTK_TOOLBAR(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TOOLBAR, GtkToolbar))
  55 #define GTK_TOOLBAR_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TOOLBAR, GtkToolbarClass))
  56 #define GTK_IS_TOOLBAR(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TOOLBAR))
  57 #define GTK_IS_TOOLBAR_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TOOLBAR))
  58 #define GTK_TOOLBAR_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TOOLBAR, GtkToolbarClass))
  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 #endif /* GTK_DISABLE_DEPRECATED */
  81
  82 typedef enum
  83 {
  84   GTK_TOOLBAR_SPACE_EMPTY,
  85   GTK_TOOLBAR_SPACE_LINE
  86 } GtkToolbarSpaceStyle;
  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   /*< public >*/
  97   gint             GSEAL (num_children);
  98   GList           *GSEAL (children);
  99   GtkOrientation   GSEAL (orientation);
 100   GtkToolbarStyle  GSEAL (style);
 101   GtkIconSize      GSEAL (icon_size);
 102
 103 #ifndef GTK_DISABLE_DEPRECATED
 104   GtkTooltips     *GSEAL (tooltips);
 105 #else
 106   gpointer         GSEAL (_tooltips);
 107 #endif
 108
 109   /*< private >*/
 110   gint             GSEAL (button_maxw);         /* maximum width of homogeneous children */
 111   gint             GSEAL (button_maxh);         /* maximum height of homogeneous children */
 112
 113   guint            _gtk_reserved1;
 114   guint            _gtk_reserved2;
 115
 116   guint            GSEAL (style_set) : 1;
 117   guint            GSEAL (icon_size_set) : 1;
 118 };
 119
 120 struct _GtkToolbarClass
 121 {
 122   GtkContainerClass parent_class;
 123
 124   /* signals */
 125   void     (* orientation_changed) (GtkToolbar       *toolbar,
 126                                     GtkOrientation    orientation);
 127   void     (* style_changed)       (GtkToolbar       *toolbar,
 128                                     GtkToolbarStyle   style);
 129   gboolean (* popup_context_menu)  (GtkToolbar       *toolbar,
 130                                     gint              x,
 131                                     gint              y,
 132                                     gint              button_number);
 133
 134   /* Padding for future expansion */
 135   void (*_gtk_reserved1) (void);
 136   void (*_gtk_reserved2) (void);
 137   void (*_gtk_reserved3) (void);
 138 };
 139
 140 GType           gtk_toolbar_get_type                (void) G_GNUC_CONST;
 141 GtkWidget *     gtk_toolbar_new                     (void);
 142
 143 void            gtk_toolbar_insert                  (GtkToolbar      *toolbar,
 144                                                      GtkToolItem     *item,
 145                                                      gint             pos);
 146
 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
 153 gboolean        gtk_toolbar_get_show_arrow          (GtkToolbar      *toolbar);
 154 void            gtk_toolbar_set_show_arrow          (GtkToolbar      *toolbar,
 155                                                      gboolean         show_arrow);
 156
 157 GtkToolbarStyle gtk_toolbar_get_style               (GtkToolbar      *toolbar);
 158 void            gtk_toolbar_set_style               (GtkToolbar      *toolbar,
 159                                                      GtkToolbarStyle  style);
 160 void            gtk_toolbar_unset_style             (GtkToolbar      *toolbar);
 161
 162 GtkIconSize     gtk_toolbar_get_icon_size           (GtkToolbar      *toolbar);
 163 void            gtk_toolbar_set_icon_size           (GtkToolbar      *toolbar,
 164                                                      GtkIconSize      icon_size);
 165 void            gtk_toolbar_unset_icon_size         (GtkToolbar      *toolbar);
 166
 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
 176 /* internal functions */
 177 gchar *         _gtk_toolbar_elide_underscores      (const gchar         *original);
 178 void            _gtk_toolbar_paint_space_line       (GtkWidget           *widget,
 179                                                      GtkToolbar          *toolbar,
 180                                                      const GdkRectangle  *area,
 181                                                      const GtkAllocation *allocation);
 182 gint            _gtk_toolbar_get_default_space_size (void);
 183
 184
 185 G_END_DECLS
 186
 187 #endif /* __GTK_TOOLBAR_H__ */