gtktoolitem.h

Go to the documentation of this file.

/* gtktoolitem.c
 *
 * Copyright (C) 2002 Anders Carlsson <andersca@gnome.org>
 * Copyright (C) 2002 James Henstridge <james@daa.com.au>
 * Copyright (C) 2003 Soeren Sandmann <sandmann@daimi.au.dk>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */
 
#ifndef __GTK_TOOL_ITEM_H__
#define __GTK_TOOL_ITEM_H__
 
#if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
#error "Only <gtk/gtk.h> can be included directly."
#endif
 
#include <gtk/gtkbin.h>
#include <gtk/gtktooltips.h>
#include <gtk/gtkmenuitem.h>
#include <gtk/gtksizegroup.h>
 
G_BEGIN_DECLS
 
#define GTK_TYPE_TOOL_ITEM            (gtk_tool_item_get_type ())
#define GTK_TOOL_ITEM(o)              (G_TYPE_CHECK_INSTANCE_CAST ((o), GTK_TYPE_TOOL_ITEM, GtkToolItem))
#define GTK_TOOL_ITEM_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TOOL_ITEM, GtkToolItemClass))
#define GTK_IS_TOOL_ITEM(o)           (G_TYPE_CHECK_INSTANCE_TYPE ((o), GTK_TYPE_TOOL_ITEM))
#define GTK_IS_TOOL_ITEM_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TOOL_ITEM))
#define GTK_TOOL_ITEM_GET_CLASS(o)    (G_TYPE_INSTANCE_GET_CLASS((o), GTK_TYPE_TOOL_ITEM, GtkToolItemClass))
 
typedef struct _GtkToolItem        GtkToolItem;
typedef struct _GtkToolItemClass   GtkToolItemClass;
typedef struct _GtkToolItemPrivate GtkToolItemPrivate;
 
struct _GtkToolItem
{
  GtkBin parent;
 
  /*< private >*/
  GtkToolItemPrivate *GSEAL (priv);
};
 
struct _GtkToolItemClass
{
  GtkBinClass parent_class;
 
  /* signals */
  gboolean   (* create_menu_proxy)    (GtkToolItem *tool_item);
  void       (* toolbar_reconfigured) (GtkToolItem *tool_item);
#ifndef GTK_DISABLE_DEPRECATED
  gboolean   (* set_tooltip)          (GtkToolItem *tool_item,
                                       GtkTooltips *tooltips,
                                       const gchar *tip_text,
                                       const gchar *tip_private);
#else
  gpointer _set_tooltip;
#endif
 
  /* Padding for future expansion */
  void (* _gtk_reserved1) (void);
  void (* _gtk_reserved2) (void);
  void (* _gtk_reserved3) (void);
  void (* _gtk_reserved4) (void);
};
 
GType        gtk_tool_item_get_type (void) G_GNUC_CONST;
GtkToolItem *gtk_tool_item_new      (void);
 
void            gtk_tool_item_set_homogeneous          (GtkToolItem *tool_item,
                                                        gboolean     homogeneous);
gboolean        gtk_tool_item_get_homogeneous          (GtkToolItem *tool_item);
 
void            gtk_tool_item_set_expand               (GtkToolItem *tool_item,
                                                        gboolean     expand);
gboolean        gtk_tool_item_get_expand               (GtkToolItem *tool_item);
 
#ifndef GTK_DISABLE_DEPRECATED
void            gtk_tool_item_set_tooltip              (GtkToolItem *tool_item,
                                                        GtkTooltips *tooltips,
                                                        const gchar *tip_text,
                                                        const gchar *tip_private);
#endif /* GTK_DISABLE_DEPRECATED */
void            gtk_tool_item_set_tooltip_text         (GtkToolItem *tool_item,
                                                        const gchar *text);
void            gtk_tool_item_set_tooltip_markup       (GtkToolItem *tool_item,
                                                        const gchar *markup);
 
void            gtk_tool_item_set_use_drag_window      (GtkToolItem *tool_item,
                                                        gboolean     use_drag_window);
gboolean        gtk_tool_item_get_use_drag_window      (GtkToolItem *tool_item);
 
void            gtk_tool_item_set_visible_horizontal   (GtkToolItem *tool_item,
                                                        gboolean     visible_horizontal);
gboolean        gtk_tool_item_get_visible_horizontal   (GtkToolItem *tool_item);
 
void            gtk_tool_item_set_visible_vertical     (GtkToolItem *tool_item,
                                                        gboolean     visible_vertical);
gboolean        gtk_tool_item_get_visible_vertical     (GtkToolItem *tool_item);
 
gboolean        gtk_tool_item_get_is_important         (GtkToolItem *tool_item);
void            gtk_tool_item_set_is_important         (GtkToolItem *tool_item,
                                                        gboolean     is_important);
 
PangoEllipsizeMode gtk_tool_item_get_ellipsize_mode    (GtkToolItem *tool_item);
GtkIconSize     gtk_tool_item_get_icon_size            (GtkToolItem *tool_item);
GtkOrientation  gtk_tool_item_get_orientation          (GtkToolItem *tool_item);
GtkToolbarStyle gtk_tool_item_get_toolbar_style        (GtkToolItem *tool_item);
GtkReliefStyle  gtk_tool_item_get_relief_style         (GtkToolItem *tool_item);
gfloat          gtk_tool_item_get_text_alignment       (GtkToolItem *tool_item);
GtkOrientation  gtk_tool_item_get_text_orientation     (GtkToolItem *tool_item);
GtkSizeGroup *  gtk_tool_item_get_text_size_group      (GtkToolItem *tool_item);
 
GtkWidget *     gtk_tool_item_retrieve_proxy_menu_item (GtkToolItem *tool_item);
GtkWidget *     gtk_tool_item_get_proxy_menu_item      (GtkToolItem *tool_item,
                                                        const gchar *menu_item_id);
void            gtk_tool_item_set_proxy_menu_item      (GtkToolItem *tool_item,
                                                        const gchar *menu_item_id,
                                                        GtkWidget   *menu_item);
void            gtk_tool_item_rebuild_menu             (GtkToolItem *tool_item);
 
void            gtk_tool_item_toolbar_reconfigured     (GtkToolItem *tool_item);
 
/* private */
 
gboolean       _gtk_tool_item_create_menu_proxy        (GtkToolItem *tool_item);
 
G_END_DECLS
 
#endif /* __GTK_TOOL_ITEM_H__ */