/* gtktoolitem.c
*
- * Copyright (C) 2002 Anders Carlsson <andersca@codefactory.se>
+ * 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>
*
* Boston, MA 02111-1307, USA.
*/
+#include "config.h"
+
+#include <string.h>
+
+#undef GTK_DISABLE_DEPRECATED /* GtkTooltips */
+
#include "gtktoolitem.h"
#include "gtkmarshalers.h"
-#include "gtktoolbar.h"
+#include "gtktoolshell.h"
#include "gtkseparatormenuitem.h"
#include "gtkintl.h"
#include "gtkmain.h"
+#include "gtkprivate.h"
+#include "gtkalias.h"
-#include <string.h>
+/**
+ * SECTION:gtktoolitem
+ * @short_description: The base class of widgets that can be added to #GtkToolShell
+ *
+ * #GtkToolItem<!-- -->s are widgets that can appear on a toolbar. To
+ * create a toolbar item that contain something else than a button, use
+ * gtk_tool_item_new(). Use gtk_container_add() to add a child
+ * widget to the tool item.
+ *
+ * For toolbar items that contain buttons, see the #GtkToolButton,
+ * #GtkToggleToolButton and #GtkRadioToolButton classes.
+ *
+ * See the #GtkToolbar class for a description of the toolbar widget, and
+ * #GtkToolShell for a description of the tool shell interface.
+ */
-#define MENU_ID "gtk-tool-item-menu-id"
+/**
+ * GtkToolItem:
+ *
+ * The GtkToolItem struct contains only private data.
+ * It should only be accessed through the functions described below.
+ */
enum {
CREATE_MENU_PROXY,
PROP_0,
PROP_VISIBLE_HORIZONTAL,
PROP_VISIBLE_VERTICAL,
+ PROP_IS_IMPORTANT
};
+#define GTK_TOOL_ITEM_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), GTK_TYPE_TOOL_ITEM, GtkToolItemPrivate))
+
struct _GtkToolItemPrivate
{
gchar *tip_text;
guint visible_vertical : 1;
guint homogeneous : 1;
guint expand : 1;
- guint pack_end : 1;
guint use_drag_window : 1;
- guint overflow_item : 1;
+ guint is_important : 1;
GdkWindow *drag_window;
GtkWidget *menu_item;
};
-static void gtk_tool_item_init (GtkToolItem *toolitem);
-static void gtk_tool_item_class_init (GtkToolItemClass *class);
static void gtk_tool_item_finalize (GObject *object);
static void gtk_tool_item_parent_set (GtkWidget *toolitem,
GtkWidget *parent);
guint prop_id,
GValue *value,
GParamSpec *pspec);
+static void gtk_tool_item_property_notify (GObject *object,
+ GParamSpec *pspec);
static void gtk_tool_item_realize (GtkWidget *widget);
static void gtk_tool_item_unrealize (GtkWidget *widget);
static void gtk_tool_item_map (GtkWidget *widget);
static gboolean gtk_tool_item_create_menu_proxy (GtkToolItem *item);
-static GObjectClass *parent_class = NULL;
-static guint toolitem_signals[LAST_SIGNAL] = { 0 };
-
-GType
-gtk_tool_item_get_type (void)
-{
- static GtkType type = 0;
+static guint toolitem_signals[LAST_SIGNAL] = { 0 };
- if (!type)
- {
- static const GTypeInfo type_info =
- {
- sizeof (GtkToolItemClass),
- (GBaseInitFunc) NULL,
- (GBaseFinalizeFunc) NULL,
- (GClassInitFunc) gtk_tool_item_class_init,
- (GClassFinalizeFunc) NULL,
- NULL,
-
- sizeof (GtkToolItem),
- 0, /* n_preallocs */
- (GInstanceInitFunc) gtk_tool_item_init,
- };
-
- type = g_type_register_static (GTK_TYPE_BIN,
- "GtkToolItem",
- &type_info, 0);
- }
- return type;
-}
+G_DEFINE_TYPE (GtkToolItem, gtk_tool_item, GTK_TYPE_BIN)
static void
gtk_tool_item_class_init (GtkToolItemClass *klass)
GObjectClass *object_class;
GtkWidgetClass *widget_class;
- parent_class = g_type_class_peek_parent (klass);
object_class = (GObjectClass *)klass;
widget_class = (GtkWidgetClass *)klass;
object_class->set_property = gtk_tool_item_set_property;
object_class->get_property = gtk_tool_item_get_property;
object_class->finalize = gtk_tool_item_finalize;
+ object_class->notify = gtk_tool_item_property_notify;
widget_class->realize = gtk_tool_item_realize;
widget_class->unrealize = gtk_tool_item_unrealize;
g_object_class_install_property (object_class,
PROP_VISIBLE_HORIZONTAL,
- g_param_spec_boolean ("visible_horizontal",
- _("Visible when horizontal"),
- _("Whether the toolbar item is visible when the toolbar is in a horizontal orientation."),
+ g_param_spec_boolean ("visible-horizontal",
+ P_("Visible when horizontal"),
+ P_("Whether the toolbar item is visible when the toolbar is in a horizontal orientation."),
TRUE,
- G_PARAM_READWRITE));
+ GTK_PARAM_READWRITE));
g_object_class_install_property (object_class,
PROP_VISIBLE_VERTICAL,
- g_param_spec_boolean ("visible_vertical",
- _("Visible when vertical"),
- _("Whether the toolbar item is visible when the toolbar is in a vertical orientation."),
+ g_param_spec_boolean ("visible-vertical",
+ P_("Visible when vertical"),
+ P_("Whether the toolbar item is visible when the toolbar is in a vertical orientation."),
TRUE,
- G_PARAM_READWRITE));
+ GTK_PARAM_READWRITE));
+ g_object_class_install_property (object_class,
+ PROP_IS_IMPORTANT,
+ g_param_spec_boolean ("is-important",
+ P_("Is important"),
+ P_("Whether the toolbar item is considered important. When TRUE, toolbar buttons show text in GTK_TOOLBAR_BOTH_HORIZ mode"),
+ FALSE,
+ GTK_PARAM_READWRITE));
+
+/**
+ * GtkToolItem::create-menu-proxy:
+ * @tool_item: the object the signal was emitted on
+ *
+ * This signal is emitted when the toolbar needs information from @tool_item
+ * about whether the item should appear in the toolbar overflow menu. In
+ * response the tool item should either
+ * <itemizedlist>
+ * <listitem>call gtk_tool_item_set_proxy_menu_item() with a %NULL
+ * pointer and return %TRUE to indicate that the item should not appear
+ * in the overflow menu
+ * </listitem>
+ * <listitem> call gtk_tool_item_set_proxy_menu_item() with a new menu
+ * item and return %TRUE, or
+ * </listitem>
+ * <listitem> return %FALSE to indicate that the signal was not
+ * handled by the item. This means that
+ * the item will not appear in the overflow menu unless a later handler
+ * installs a menu item.
+ * </listitem>
+ * </itemizedlist>
+ *
+ * The toolbar may cache the result of this signal. When the tool item changes
+ * how it will respond to this signal it must call gtk_tool_item_rebuild_menu()
+ * to invalidate the cache and ensure that the toolbar rebuilds its overflow
+ * menu.
+ *
+ * Return value: %TRUE if the signal was handled, %FALSE if not
+ **/
toolitem_signals[CREATE_MENU_PROXY] =
- g_signal_new ("create_menu_proxy",
+ g_signal_new (I_("create_menu_proxy"),
G_OBJECT_CLASS_TYPE (klass),
G_SIGNAL_RUN_LAST,
G_STRUCT_OFFSET (GtkToolItemClass, create_menu_proxy),
_gtk_boolean_handled_accumulator, NULL,
_gtk_marshal_BOOLEAN__VOID,
G_TYPE_BOOLEAN, 0);
+
+/**
+ * GtkToolItem::toolbar-reconfigured:
+ * @tool_item: the object the signal was emitted on
+ *
+ * This signal is emitted when some property of the toolbar that the
+ * item is a child of changes. For custom subclasses of #GtkToolItem,
+ * the default handler of this signal use the functions
+ * <itemizedlist>
+ * <listitem>gtk_tool_shell_get_orientation()</listitem>
+ * <listitem>gtk_tool_shell_get_style()</listitem>
+ * <listitem>gtk_tool_shell_get_icon_size()</listitem>
+ * <listitem>gtk_tool_shell_get_relief_style()</listitem>
+ * </itemizedlist>
+ * to find out what the toolbar should look like and change
+ * themselves accordingly.
+ **/
toolitem_signals[TOOLBAR_RECONFIGURED] =
- g_signal_new ("toolbar_reconfigured",
+ g_signal_new (I_("toolbar_reconfigured"),
G_OBJECT_CLASS_TYPE (klass),
G_SIGNAL_RUN_LAST,
G_STRUCT_OFFSET (GtkToolItemClass, toolbar_reconfigured),
NULL, NULL,
_gtk_marshal_VOID__VOID,
G_TYPE_NONE, 0);
+/**
+ * GtkToolItem::set-tooltip:
+ * @tool_item: the object the signal was emitted on
+ * @tooltips: the #GtkTooltips
+ * @tip_text: the tooltip text
+ * @tip_private: the tooltip private text
+ *
+ * This signal is emitted when the toolitem's tooltip changes.
+ * Application developers can use gtk_tool_item_set_tooltip() to
+ * set the item's tooltip.
+ *
+ * Return value: %TRUE if the signal was handled, %FALSE if not
+ *
+ * Deprecated: 2.12: With the new tooltip API, there is no
+ * need to use this signal anymore.
+ **/
toolitem_signals[SET_TOOLTIP] =
- g_signal_new ("set_tooltip",
+ g_signal_new (I_("set_tooltip"),
G_OBJECT_CLASS_TYPE (klass),
G_SIGNAL_RUN_LAST,
G_STRUCT_OFFSET (GtkToolItemClass, set_tooltip),
{
GtkToolItem *item = GTK_TOOL_ITEM (object);
+ g_free (item->priv->menu_item_id);
+
if (item->priv->menu_item)
g_object_unref (item->priv->menu_item);
-
- if (G_OBJECT_CLASS (parent_class)->finalize)
- G_OBJECT_CLASS (parent_class)->finalize (object);
+
+ G_OBJECT_CLASS (gtk_tool_item_parent_class)->finalize (object);
}
static void
-gtk_tool_item_parent_set (GtkWidget *toolitem,
- GtkWidget *prev_parent)
+gtk_tool_item_parent_set (GtkWidget *toolitem,
+ GtkWidget *prev_parent)
{
- gtk_tool_item_toolbar_reconfigured (GTK_TOOL_ITEM (toolitem));
+ if (GTK_WIDGET (toolitem)->parent != NULL)
+ gtk_tool_item_toolbar_reconfigured (GTK_TOOL_ITEM (toolitem));
}
static void
gtk_tool_item_set_visible_horizontal (toolitem, g_value_get_boolean (value));
break;
case PROP_VISIBLE_VERTICAL:
- gtk_tool_item_set_visible_horizontal (toolitem, g_value_get_boolean (value));
+ gtk_tool_item_set_visible_vertical (toolitem, g_value_get_boolean (value));
+ break;
+ case PROP_IS_IMPORTANT:
+ gtk_tool_item_set_is_important (toolitem, g_value_get_boolean (value));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+ break;
}
}
case PROP_VISIBLE_VERTICAL:
g_value_set_boolean (value, toolitem->priv->visible_vertical);
break;
+ case PROP_IS_IMPORTANT:
+ g_value_set_boolean (value, toolitem->priv->is_important);
+ break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+ break;
}
}
+static void
+gtk_tool_item_property_notify (GObject *object,
+ GParamSpec *pspec)
+{
+ GtkToolItem *tool_item = GTK_TOOL_ITEM (object);
+
+ if (tool_item->priv->menu_item && strcmp (pspec->name, "sensitive") == 0)
+ gtk_widget_set_sensitive (tool_item->priv->menu_item,
+ GTK_WIDGET_SENSITIVE (tool_item));
+}
+
static void
create_drag_window (GtkToolItem *toolitem)
{
destroy_drag_window (toolitem);
- GTK_WIDGET_CLASS (parent_class)->unrealize (widget);
+ GTK_WIDGET_CLASS (gtk_tool_item_parent_class)->unrealize (widget);
}
static void
GtkToolItem *toolitem;
toolitem = GTK_TOOL_ITEM (widget);
- GTK_WIDGET_CLASS (parent_class)->map (widget);
+ GTK_WIDGET_CLASS (gtk_tool_item_parent_class)->map (widget);
if (toolitem->priv->drag_window)
gdk_window_show (toolitem->priv->drag_window);
}
toolitem = GTK_TOOL_ITEM (widget);
if (toolitem->priv->drag_window)
gdk_window_hide (toolitem->priv->drag_window);
- GTK_WIDGET_CLASS (parent_class)->unmap (widget);
+ GTK_WIDGET_CLASS (gtk_tool_item_parent_class)->unmap (widget);
}
static void
GtkRequisition *requisition)
{
GtkWidget *child = GTK_BIN (widget)->child;
- gint xthickness = widget->style->xthickness;
- gint ythickness = widget->style->ythickness;
if (child && GTK_WIDGET_VISIBLE (child))
{
requisition->width = 0;
}
- requisition->width += (xthickness + GTK_CONTAINER (widget)->border_width) * 2;
- requisition->height += (ythickness + GTK_CONTAINER (widget)->border_width) * 2;
+ requisition->width += (GTK_CONTAINER (widget)->border_width) * 2;
+ requisition->height += (GTK_CONTAINER (widget)->border_width) * 2;
}
static void
static gboolean
gtk_tool_item_create_menu_proxy (GtkToolItem *item)
{
- if (!GTK_BIN (item)->child)
- {
- GtkWidget *menu_item = NULL;
-
- menu_item = gtk_separator_menu_item_new();
-
- gtk_tool_item_set_proxy_menu_item (item, MENU_ID, menu_item);
-
- return TRUE;
- }
-
return FALSE;
}
+/**
+ * gtk_tool_item_new:
+ *
+ * Creates a new #GtkToolItem
+ *
+ * Return value: the new #GtkToolItem
+ *
+ * Since: 2.4
+ **/
GtkToolItem *
gtk_tool_item_new (void)
{
return item;
}
+/**
+ * gtk_tool_item_get_icon_size:
+ * @tool_item: a #GtkToolItem:
+ *
+ * Returns the icon size used for @tool_item. Custom subclasses of
+ * #GtkToolItem should call this function to find out what size icons
+ * they should use.
+ *
+ * Return value: a #GtkIconSize indicating the icon size used for @tool_item
+ *
+ * Since: 2.4
+ **/
GtkIconSize
gtk_tool_item_get_icon_size (GtkToolItem *tool_item)
{
g_return_val_if_fail (GTK_IS_TOOL_ITEM (tool_item), GTK_ICON_SIZE_LARGE_TOOLBAR);
parent = GTK_WIDGET (tool_item)->parent;
- if (!parent || !GTK_IS_TOOLBAR (parent))
+ if (!parent || !GTK_IS_TOOL_SHELL (parent))
return GTK_ICON_SIZE_LARGE_TOOLBAR;
- return gtk_toolbar_get_icon_size (GTK_TOOLBAR (parent));
+ return gtk_tool_shell_get_icon_size (GTK_TOOL_SHELL (parent));
}
+/**
+ * gtk_tool_item_get_orientation:
+ * @tool_item: a #GtkToolItem:
+ *
+ * Returns the orientation used for @tool_item. Custom subclasses of
+ * #GtkToolItem should call this function to find out what size icons
+ * they should use.
+ *
+ * Return value: a #GtkOrientation indicating the orientation
+ * used for @tool_item
+ *
+ * Since: 2.4
+ **/
GtkOrientation
gtk_tool_item_get_orientation (GtkToolItem *tool_item)
{
g_return_val_if_fail (GTK_IS_TOOL_ITEM (tool_item), GTK_ORIENTATION_HORIZONTAL);
parent = GTK_WIDGET (tool_item)->parent;
- if (!parent || !GTK_IS_TOOLBAR (parent))
+ if (!parent || !GTK_IS_TOOL_SHELL (parent))
return GTK_ORIENTATION_HORIZONTAL;
- return gtk_toolbar_get_orientation (GTK_TOOLBAR (parent));
+ return gtk_tool_shell_get_orientation (GTK_TOOL_SHELL (parent));
}
+/**
+ * gtk_tool_item_get_toolbar_style:
+ * @tool_item: a #GtkToolItem:
+ *
+ * Returns the toolbar style used for @tool_item. Custom subclasses of
+ * #GtkToolItem should call this function in the handler of the
+ * GtkToolItem::toolbar_reconfigured signal to find out in what style
+ * the toolbar is displayed and change themselves accordingly
+ *
+ * Possibilities are:
+ * <itemizedlist>
+ * <listitem> GTK_TOOLBAR_BOTH, meaning the tool item should show
+ * both an icon and a label, stacked vertically </listitem>
+ * <listitem> GTK_TOOLBAR_ICONS, meaning the toolbar shows
+ * only icons </listitem>
+ * <listitem> GTK_TOOLBAR_TEXT, meaning the tool item should only
+ * show text</listitem>
+ * <listitem> GTK_TOOLBAR_BOTH_HORIZ, meaning the tool item should show
+ * both an icon and a label, arranged horizontally (however, note the
+ * #GtkToolButton::has_text_horizontally that makes tool buttons not
+ * show labels when the toolbar style is GTK_TOOLBAR_BOTH_HORIZ.
+ * </listitem>
+ * </itemizedlist>
+ *
+ * Return value: A #GtkToolbarStyle indicating the toolbar style used
+ * for @tool_item.
+ *
+ * Since: 2.4
+ **/
GtkToolbarStyle
gtk_tool_item_get_toolbar_style (GtkToolItem *tool_item)
{
g_return_val_if_fail (GTK_IS_TOOL_ITEM (tool_item), GTK_TOOLBAR_ICONS);
parent = GTK_WIDGET (tool_item)->parent;
- if (!parent || !GTK_IS_TOOLBAR (parent))
+ if (!parent || !GTK_IS_TOOL_SHELL (parent))
return GTK_TOOLBAR_ICONS;
- return gtk_toolbar_get_style (GTK_TOOLBAR (parent));
+ return gtk_tool_shell_get_style (GTK_TOOL_SHELL (parent));
}
+/**
+ * gtk_tool_item_get_relief_style:
+ * @tool_item: a #GtkToolItem:
+ *
+ * Returns the relief style of @tool_item. See gtk_button_set_relief_style().
+ * Custom subclasses of #GtkToolItem should call this function in the handler
+ * of the #GtkToolItem::toolbar_reconfigured signal to find out the
+ * relief style of buttons.
+ *
+ * Return value: a #GtkReliefStyle indicating the relief style used
+ * for @tool_item.
+ *
+ * Since: 2.4
+ **/
GtkReliefStyle
gtk_tool_item_get_relief_style (GtkToolItem *tool_item)
{
g_return_val_if_fail (GTK_IS_TOOL_ITEM (tool_item), GTK_RELIEF_NONE);
parent = GTK_WIDGET (tool_item)->parent;
- if (!parent || !GTK_IS_TOOLBAR (parent))
+ if (!parent || !GTK_IS_TOOL_SHELL (parent))
return GTK_RELIEF_NONE;
- return gtk_toolbar_get_relief_style (GTK_TOOLBAR (parent));
-}
-
-void
-gtk_tool_item_toolbar_reconfigured (GtkToolItem *tool_item)
-{
- g_return_if_fail (GTK_IS_TOOL_ITEM (tool_item));
-
- g_signal_emit (tool_item, toolitem_signals[TOOLBAR_RECONFIGURED], 0);
-
- gtk_widget_queue_resize (GTK_WIDGET (tool_item));
+ return gtk_tool_shell_get_relief_style (GTK_TOOL_SHELL (parent));
}
+/**
+ * gtk_tool_item_set_expand:
+ * @tool_item: a #GtkToolItem:
+ * @expand: Whether @tool_item is allocated extra space
+ *
+ * Sets whether @tool_item is allocated extra space when there
+ * is more room on the toolbar then needed for the items. The
+ * effect is that the item gets bigger when the toolbar gets bigger
+ * and smaller when the toolbar gets smaller.
+ *
+ * Since: 2.4
+ **/
void
gtk_tool_item_set_expand (GtkToolItem *tool_item,
gboolean expand)
}
}
+/**
+ * gtk_tool_item_get_expand:
+ * @tool_item: a #GtkToolItem:
+ *
+ * Returns whether @tool_item is allocated extra space.
+ * See gtk_tool_item_set_expand().
+ *
+ * Return value: %TRUE if @tool_item is allocated extra space.
+ *
+ * Since: 2.4
+ **/
gboolean
gtk_tool_item_get_expand (GtkToolItem *tool_item)
{
return tool_item->priv->expand;
}
+/**
+ * gtk_tool_item_set_homogeneous:
+ * @tool_item: a #GtkToolItem:
+ * @homogeneous: whether @tool_item is the same size as other homogeneous items
+ *
+ * Sets whether @tool_item is to be allocated the same size as other
+ * homogeneous items. The effect is that all homogeneous items will have
+ * the same width as the widest of the items.
+ *
+ * Since: 2.4
+ **/
void
-gtk_tool_item_set_pack_end (GtkToolItem *tool_item,
- gboolean pack_end)
+gtk_tool_item_set_homogeneous (GtkToolItem *tool_item,
+ gboolean homogeneous)
{
g_return_if_fail (GTK_IS_TOOL_ITEM (tool_item));
- pack_end = pack_end != FALSE;
+ homogeneous = homogeneous != FALSE;
- if (tool_item->priv->pack_end != pack_end)
+ if (tool_item->priv->homogeneous != homogeneous)
{
- tool_item->priv->pack_end = pack_end;
- gtk_widget_child_notify (GTK_WIDGET (tool_item), "pack_end");
+ tool_item->priv->homogeneous = homogeneous;
+ gtk_widget_child_notify (GTK_WIDGET (tool_item), "homogeneous");
gtk_widget_queue_resize (GTK_WIDGET (tool_item));
}
}
+/**
+ * gtk_tool_item_get_homogeneous:
+ * @tool_item: a #GtkToolItem:
+ *
+ * Returns whether @tool_item is the same size as other homogeneous
+ * items. See gtk_tool_item_set_homogeneous().
+ *
+ * Return value: %TRUE if the item is the same size as other homogeneous
+ * item.s
+ *
+ * Since: 2.4
+ **/
gboolean
-gtk_tool_item_get_pack_end (GtkToolItem *tool_item)
+gtk_tool_item_get_homogeneous (GtkToolItem *tool_item)
{
g_return_val_if_fail (GTK_IS_TOOL_ITEM (tool_item), FALSE);
- return tool_item->priv->pack_end;
+ return tool_item->priv->homogeneous;
}
+/**
+ * gtk_tool_item_get_is_important:
+ * @tool_item: a #GtkToolItem
+ *
+ * Returns whether @tool_item is considered important. See
+ * gtk_tool_item_set_is_important()
+ *
+ * Return value: %TRUE if @tool_item is considered important.
+ *
+ * Since: 2.4
+ **/
+gboolean
+gtk_tool_item_get_is_important (GtkToolItem *tool_item)
+{
+ g_return_val_if_fail (GTK_IS_TOOL_ITEM (tool_item), FALSE);
+
+ return tool_item->priv->is_important;
+}
+
+/**
+ * gtk_tool_item_set_is_important:
+ * @tool_item: a #GtkToolItem
+ * @is_important: whether the tool item should be considered important
+ *
+ * Sets whether @tool_item should be considered important. The #GtkToolButton
+ * class uses this property to determine whether to show or hide its label
+ * when the toolbar style is %GTK_TOOLBAR_BOTH_HORIZ. The result is that
+ * only tool buttons with the "is_important" property set have labels, an
+ * effect known as "priority text"
+ *
+ * Since: 2.4
+ **/
void
-gtk_tool_item_set_homogeneous (GtkToolItem *tool_item,
- gboolean homogeneous)
+gtk_tool_item_set_is_important (GtkToolItem *tool_item, gboolean is_important)
{
g_return_if_fail (GTK_IS_TOOL_ITEM (tool_item));
-
- homogeneous = homogeneous != FALSE;
- if (tool_item->priv->homogeneous != homogeneous)
+ is_important = is_important != FALSE;
+
+ if (is_important != tool_item->priv->is_important)
{
- tool_item->priv->homogeneous = homogeneous;
- gtk_widget_child_notify (GTK_WIDGET (tool_item), "homogeneous");
- gtk_widget_queue_resize (GTK_WIDGET (tool_item));
- }
-}
+ tool_item->priv->is_important = is_important;
-gboolean
-gtk_tool_item_get_homogeneous (GtkToolItem *tool_item)
-{
- g_return_val_if_fail (GTK_IS_TOOL_ITEM (tool_item), FALSE);
+ gtk_widget_queue_resize (GTK_WIDGET (tool_item));
- return tool_item->priv->homogeneous;
+ g_object_notify (G_OBJECT (tool_item), "is-important");
+ }
}
static gboolean
if (!child)
return FALSE;
- gtk_tooltips_set_tip (tooltips, child, tip_text, tip_private);
+ gtk_widget_set_tooltip_text (child, tip_text);
return TRUE;
}
+/**
+ * gtk_tool_item_set_tooltip:
+ * @tool_item: a #GtkToolItem:
+ * @tooltips: The #GtkTooltips object to be used
+ * @tip_text: text to be used as tooltip text for @tool_item
+ * @tip_private: text to be used as private tooltip text
+ *
+ * Sets the #GtkTooltips object to be used for @tool_item, the
+ * text to be displayed as tooltip on the item and the private text
+ * to be used. See gtk_tooltips_set_tip().
+ *
+ * Since: 2.4
+ *
+ * Deprecated: 2.12: Use gtk_tool_item_set_tooltip_text() instead.
+ **/
void
gtk_tool_item_set_tooltip (GtkToolItem *tool_item,
GtkTooltips *tooltips,
tooltips, tip_text, tip_private, &retval);
}
+/**
+ * gtk_tool_item_set_tooltip_text:
+ * @tool_item: a #GtkToolItem:
+ * @text: text to be used as tooltip for @tool_item
+ *
+ * Sets the text to be displayed as tooltip on the item.
+ * See gtk_widget_set_tooltip_text().
+ *
+ * Since: 2.12
+ **/
+void
+gtk_tool_item_set_tooltip_text (GtkToolItem *tool_item,
+ const gchar *text)
+{
+ GtkWidget *child;
+
+ g_return_if_fail (GTK_IS_TOOL_ITEM (tool_item));
+
+ child = GTK_BIN (tool_item)->child;
+
+ if (child)
+ gtk_widget_set_tooltip_text (child, text);
+}
+
+/**
+ * gtk_tool_item_set_tooltip_markup:
+ * @tool_item: a #GtkToolItem:
+ * @markup: markup text to be used as tooltip for @tool_item
+ *
+ * Sets the markup text to be displayed as tooltip on the item.
+ * See gtk_widget_set_tooltip_markup().
+ *
+ * Since: 2.12
+ **/
+void
+gtk_tool_item_set_tooltip_markup (GtkToolItem *tool_item,
+ const gchar *markup)
+{
+ GtkWidget *child;
+
+ g_return_if_fail (GTK_IS_TOOL_ITEM (tool_item));
+
+ child = GTK_BIN (tool_item)->child;
+
+ if (child)
+ gtk_widget_set_tooltip_markup (child, markup);
+}
+
+/**
+ * gtk_tool_item_set_use_drag_window:
+ * @tool_item: a #GtkToolItem
+ * @use_drag_window: Whether @tool_item has a drag window.
+ *
+ * Sets whether @tool_item has a drag window. When %TRUE the
+ * toolitem can be used as a drag source through gtk_drag_source_set().
+ * When @tool_item has a drag window it will intercept all events,
+ * even those that would otherwise be sent to a child of @tool_item.
+ *
+ * Since: 2.4
+ **/
void
gtk_tool_item_set_use_drag_window (GtkToolItem *toolitem,
gboolean use_drag_window)
}
}
+/**
+ * gtk_tool_item_get_use_drag_window:
+ * @tool_item: a #GtkToolItem
+ *
+ * Returns whether @tool_item has a drag window. See
+ * gtk_tool_item_set_use_drag_window().
+ *
+ * Return value: %TRUE if @tool_item uses a drag window.
+ *
+ * Since: 2.4
+ **/
gboolean
gtk_tool_item_get_use_drag_window (GtkToolItem *toolitem)
{
return toolitem->priv->use_drag_window;
}
+/**
+ * gtk_tool_item_set_visible_horizontal:
+ * @tool_item: a #GtkToolItem
+ * @visible_horizontal: Whether @tool_item is visible when in horizontal mode
+ *
+ * Sets whether @tool_item is visible when the toolbar is docked horizontally.
+ *
+ * Since: 2.4
+ **/
void
gtk_tool_item_set_visible_horizontal (GtkToolItem *toolitem,
gboolean visible_horizontal)
{
toolitem->priv->visible_horizontal = visible_horizontal;
- g_object_notify (G_OBJECT (toolitem), "visible_horizontal");
+ g_object_notify (G_OBJECT (toolitem), "visible-horizontal");
gtk_widget_queue_resize (GTK_WIDGET (toolitem));
}
}
+/**
+ * gtk_tool_item_get_visible_horizontal:
+ * @tool_item: a #GtkToolItem
+ *
+ * Returns whether the @tool_item is visible on toolbars that are
+ * docked horizontally.
+ *
+ * Return value: %TRUE if @tool_item is visible on toolbars that are
+ * docked horizontally.
+ *
+ * Since: 2.4
+ **/
gboolean
gtk_tool_item_get_visible_horizontal (GtkToolItem *toolitem)
{
return toolitem->priv->visible_horizontal;
}
+/**
+ * gtk_tool_item_set_visible_vertical:
+ * @tool_item: a #GtkToolItem
+ * @visible_vertical: whether @tool_item is visible when the toolbar
+ * is in vertical mode
+ *
+ * Sets whether @tool_item is visible when the toolbar is docked
+ * vertically. Some tool items, such as text entries, are too wide to be
+ * useful on a vertically docked toolbar. If @visible_vertical is %FALSE
+ * @tool_item will not appear on toolbars that are docked vertically.
+ *
+ * Since: 2.4
+ **/
void
gtk_tool_item_set_visible_vertical (GtkToolItem *toolitem,
gboolean visible_vertical)
{
toolitem->priv->visible_vertical = visible_vertical;
- g_object_notify (G_OBJECT (toolitem), "visible_vertical");
+ g_object_notify (G_OBJECT (toolitem), "visible-vertical");
gtk_widget_queue_resize (GTK_WIDGET (toolitem));
}
}
+/**
+ * gtk_tool_item_get_visible_vertical:
+ * @tool_item: a #GtkToolItem
+ *
+ * Returns whether @tool_item is visible when the toolbar is docked vertically.
+ * See gtk_tool_item_set_visible_vertical().
+ *
+ * Return value: Whether @tool_item is visible when the toolbar is docked vertically
+ *
+ * Since: 2.4
+ **/
gboolean
gtk_tool_item_get_visible_vertical (GtkToolItem *toolitem)
{
return toolitem->priv->visible_vertical;
}
+/**
+ * gtk_tool_item_retrieve_proxy_menu_item:
+ * @tool_item: a #GtkToolItem:
+ *
+ * Returns the #GtkMenuItem that was last set by
+ * gtk_tool_item_set_proxy_menu_item(), ie. the #GtkMenuItem
+ * that is going to appear in the overflow menu.
+ *
+ * Return value: The #GtkMenuItem that is going to appear in the
+ * overflow menu for @tool_item.
+ *
+ * Since: 2.4
+ **/
GtkWidget *
gtk_tool_item_retrieve_proxy_menu_item (GtkToolItem *tool_item)
{
g_return_val_if_fail (GTK_IS_TOOL_ITEM (tool_item), NULL);
- g_signal_emit (tool_item, toolitem_signals[CREATE_MENU_PROXY], 0, &retval);
+ g_signal_emit (tool_item, toolitem_signals[CREATE_MENU_PROXY], 0,
+ &retval);
return tool_item->priv->menu_item;
}
+/**
+ * gtk_tool_item_get_proxy_menu_item:
+ * @tool_item: a #GtkToolItem:
+ * @menu_item_id: a string used to identify the menu item
+ *
+ * If @menu_item_id matches the string passed to
+ * gtk_tool_item_set_proxy_menu_item() return the corresponding #GtkMenuItem.
+ *
+ * Custom subclasses of #GtkToolItem should use this function to update
+ * their menu item when the #GtkToolItem changes. That the
+ * @menu_item_id<!-- -->s must match ensures that a #GtkToolItem will not
+ * inadvertently change a menu item that they did not create.
+ *
+ * Return value: The #GtkMenuItem passed to
+ * gtk_tool_item_set_proxy_menu_item(), if the @menu_item_id<!-- -->s match.
+ *
+ * Since: 2.4
+ **/
GtkWidget *
gtk_tool_item_get_proxy_menu_item (GtkToolItem *tool_item,
const gchar *menu_item_id)
return NULL;
}
+/**
+ * gtk_tool_item_rebuild_menu()
+ * @tool_item: a #GtkToolItem
+ *
+ * Calling this function signals to the toolbar that the
+ * overflow menu item for @tool_item has changed. If the
+ * overflow menu is visible when this function it called,
+ * the menu will be rebuilt.
+ *
+ * The function must be called when the tool item
+ * changes what it will do in response to the "create_menu_proxy"
+ * signal.
+ *
+ * Since: 2.6
+ **/
+void
+gtk_tool_item_rebuild_menu (GtkToolItem *tool_item)
+{
+ GtkWidget *widget;
+
+ g_return_if_fail (GTK_IS_TOOL_ITEM (tool_item));
+
+ widget = GTK_WIDGET (tool_item);
+
+ if (GTK_IS_TOOL_SHELL (widget->parent))
+ gtk_tool_shell_rebuild_menu (GTK_TOOL_SHELL (widget->parent));
+}
+
+/**
+ * gtk_tool_item_set_proxy_menu_item:
+ * @tool_item: a #GtkToolItem:
+ * @menu_item_id: a string used to identify @menu_item
+ * @menu_item: a #GtkMenuItem to be used in the overflow menu
+ *
+ * Sets the #GtkMenuItem used in the toolbar overflow menu. The
+ * @menu_item_id is used to identify the caller of this function and
+ * should also be used with gtk_tool_item_get_proxy_menu_item().
+ *
+ * Since: 2.4
+ **/
void
gtk_tool_item_set_proxy_menu_item (GtkToolItem *tool_item,
const gchar *menu_item_id,
g_return_if_fail (menu_item == NULL || GTK_IS_MENU_ITEM (menu_item));
g_return_if_fail (menu_item_id != NULL);
- if (tool_item->priv->menu_item_id)
- g_free (tool_item->priv->menu_item_id);
+ g_free (tool_item->priv->menu_item_id);
tool_item->priv->menu_item_id = g_strdup (menu_item_id);
if (tool_item->priv->menu_item != menu_item)
{
if (tool_item->priv->menu_item)
- g_object_unref (G_OBJECT (tool_item->priv->menu_item));
+ g_object_unref (tool_item->priv->menu_item);
if (menu_item)
{
- g_object_ref (menu_item);
- gtk_object_sink (GTK_OBJECT (menu_item));
+ g_object_ref_sink (menu_item);
+
+ gtk_widget_set_sensitive (menu_item,
+ GTK_WIDGET_SENSITIVE (tool_item));
}
tool_item->priv->menu_item = menu_item;
}
}
-GdkWindow *
-_gtk_tool_item_get_drag_window (GtkToolItem *tool_item)
+/**
+ * gtk_tool_item_toolbar_reconfigured:
+ * @tool_item: a #GtkToolItem
+ *
+ * Emits the signal #GtkToolItem::toolbar_reconfigured on @tool_item.
+ * #GtkToolbar and other #GtkToolShell implementations use this function
+ * to notify children, when some aspect of their configuration changes.
+ *
+ * Since: 2.14
+ **/
+void
+gtk_tool_item_toolbar_reconfigured (GtkToolItem *tool_item)
{
- return tool_item->priv->drag_window;
+ /* The slightely inaccurate name "gtk_tool_item_toolbar_reconfigured" was
+ * choosen over "gtk_tool_item_tool_shell_reconfigured", since the function
+ * emits the "toolbar-reconfigured" signal, not "tool-shell-reconfigured".
+ * Its not possible to rename the signal, and emitting another name than
+ * indicated by the function name would be quite confusing. That's the
+ * price of providing stable APIs.
+ */
+ g_return_if_fail (GTK_IS_TOOL_ITEM (tool_item));
+
+ g_signal_emit (tool_item, toolitem_signals[TOOLBAR_RECONFIGURED], 0);
+
+ if (tool_item->priv->drag_window)
+ gdk_window_raise (tool_item->priv->drag_window);
+
+ gtk_widget_queue_resize (GTK_WIDGET (tool_item));
}
+
+#define __GTK_TOOL_ITEM_C__
+#include "gtkaliasdef.c"
projects / ~andy / gtk / blobdiff