Commit 7b2e82f5 authored by Matthias Clasen's avatar Matthias Clasen

Add new convenience api for tooltips on icon views

svn path=/trunk/; revision=18501
parent 38037481
2007-07-19 Matthias Clasen <mclasen@redhat.com>
* gtk/gtk.symbols:
* gtk/gtkiconview.h:
* gtk/gtkiconview.c (gtk_icon_view_get_tooltip_context):
(gtk_icon_view_[sg]et_tooltip_column: Add more convenience
API parallel to the treeview convenience API.
2007-07-19 Matthias Clasen <mclasen@redhat.com>
* gtk/gtktextview.c (gtk_text_view_compat_move_focus):
......
......@@ -1888,6 +1888,9 @@ gtk_icon_view_get_dest_item_at_pos
gtk_icon_view_create_drag_icon
gtk_icon_view_set_tooltip_item
gtk_icon_view_set_tooltip_cell
gtk_icon_view_get_tooltip_context
gtk_icon_view_set_tooltip_column
gtk_icon_view_get_tooltip_column
#endif
#endif
......
......@@ -158,6 +158,8 @@ struct _GtkIconViewPrivate
gint pixbuf_cell;
gint text_cell;
gint tooltip_column;
/* Drag-and-drop. */
GdkModifierType start_button_mask;
gint pressed_button;
......@@ -218,7 +220,8 @@ enum
PROP_ROW_SPACING,
PROP_COLUMN_SPACING,
PROP_MARGIN,
PROP_REORDERABLE
PROP_REORDERABLE,
PROP_TOOLTIP_COLUMN
};
/* GObject vfuncs */
......@@ -746,6 +749,18 @@ gtk_icon_view_class_init (GtkIconViewClass *klass)
FALSE,
G_PARAM_READWRITE));
g_object_class_install_property (gobject_class,
PROP_TOOLTIP_COLUMN,
g_param_spec_int ("tooltip-column",
P_("Tooltip Column"),
P_("The column in the model containing the tooltip texts for the items"),
-1,
G_MAXINT,
-1,
GTK_PARAM_READWRITE));
/* Style properties */
gtk_widget_class_install_style_property (widget_class,
g_param_spec_boxed ("selection-box-color",
......@@ -950,6 +965,7 @@ gtk_icon_view_init (GtkIconView *icon_view)
icon_view->priv->pixbuf_column = -1;
icon_view->priv->text_cell = -1;
icon_view->priv->pixbuf_cell = -1;
icon_view->priv->tooltip_column = -1;
GTK_WIDGET_SET_FLAGS (icon_view, GTK_CAN_FOCUS);
......@@ -1074,6 +1090,10 @@ gtk_icon_view_set_property (GObject *object,
gtk_icon_view_set_reorderable (icon_view, g_value_get_boolean (value));
break;
case PROP_TOOLTIP_COLUMN:
gtk_icon_view_set_tooltip_column (icon_view, g_value_get_int (value));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
......@@ -1131,6 +1151,9 @@ gtk_icon_view_get_property (GObject *object,
case PROP_REORDERABLE:
g_value_set_boolean (value, icon_view->priv->reorderable);
break;
case PROP_TOOLTIP_COLUMN:
g_value_set_int (value, icon_view->priv->tooltip_column);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
......@@ -4685,6 +4708,7 @@ gtk_icon_view_set_tooltip_cell (GtkIconView *icon_view,
GdkRectangle rect;
GtkIconViewItem *item = NULL;
GtkIconViewCellInfo *info = NULL;
gint x, y;
g_return_if_fail (GTK_IS_ICON_VIEW (icon_view));
g_return_if_fail (GTK_IS_TOOLTIP (tooltip));
......@@ -4712,8 +4736,6 @@ gtk_icon_view_set_tooltip_cell (GtkIconView *icon_view,
if (icon_view->priv->bin_window)
{
gint x, y;
gdk_window_get_position (icon_view->priv->bin_window, &x, &y);
rect.x += x;
rect.y += y;
......@@ -4722,6 +4744,186 @@ gtk_icon_view_set_tooltip_cell (GtkIconView *icon_view,
gtk_tooltip_set_tip_area (tooltip, &rect);
}
/**
* gtk_icon_view_get_tooltip_context:
* @icon_view: an #GtkIconView
* @x: the x coordinate (relative to widget coordinates)
* @y: the y coordinate (relative to widget coordinates)
* @keyboard_tip: whether this is a keyboard tooltip or not
* @model: a pointer to receive a #GtkTreeModel or %NULL
* @path: a pointer to receive a #GtkTreePath or %NULL
* @iter: a pointer to receive a #GtkTreeIter or %NULL
*
* This function is supposed to be used in a #GtkWidget::query-tooltip
* signal handler for #GtkIconView. The @x, @y and @keyboard_tip values
* which are received in the signal handler, should be passed to this
* function without modification.
*
* The return value indicates whether there is an icon view item at the given
* coordinates (%TRUE) or not (%FALSE) for mouse tooltips. For keyboard
* tooltips the item returned will be the cursor item. When %TRUE, then any of
* @model, @path and @iter which have been provided will be set to point to
* that row and the corresponding model. @x and @y will always be converted
* to be relative to @icon_view's bin_window if @keyboard_tooltip is %FALSE.
*
* Return value: whether or not the given tooltip context points to a item
*
* Since: 2.12
*/
gboolean
gtk_icon_view_get_tooltip_context (GtkIconView *icon_view,
gint *x,
gint *y,
gboolean keyboard_tip,
GtkTreeModel **model,
GtkTreePath **path,
GtkTreeIter *iter)
{
GtkTreePath *tmppath = NULL;
g_return_val_if_fail (GTK_IS_ICON_VIEW (icon_view), FALSE);
g_return_val_if_fail (x != NULL, FALSE);
g_return_val_if_fail (y != NULL, FALSE);
if (keyboard_tip)
{
gtk_icon_view_get_cursor (icon_view, &tmppath, NULL);
if (!tmppath)
return FALSE;
}
else
{
gtk_icon_view_convert_widget_to_bin_window_coords (icon_view, *x, *y,
x, y);
if (!gtk_icon_view_get_item_at_pos (icon_view, *x, *y, &tmppath, NULL))
return FALSE;
}
if (model)
*model = gtk_icon_view_get_model (icon_view);
if (iter)
gtk_tree_model_get_iter (gtk_icon_view_get_model (icon_view),
iter, tmppath);
if (path)
*path = tmppath;
else
gtk_tree_path_free (tmppath);
return TRUE;
}
static gboolean
gtk_icon_view_set_tooltip_query_cb (GtkWidget *widget,
gint x,
gint y,
gboolean keyboard_tip,
GtkTooltip *tooltip,
gpointer data)
{
gchar *str;
GtkTreeIter iter;
GtkTreePath *path;
GtkTreeModel *model;
GtkIconView *icon_view = GTK_ICON_VIEW (widget);
if (!gtk_icon_view_get_tooltip_context (GTK_ICON_VIEW (widget),
&x, &y,
keyboard_tip,
&model, &path, &iter))
{
g_print ("no tooltip context\n");
return FALSE;
}
gtk_tree_model_get (model, &iter, icon_view->priv->tooltip_column, &str, -1);
if (!str)
{
g_print ("no data in column %d\n", icon_view->priv->tooltip_column);
gtk_tree_path_free (path);
return FALSE;
}
gtk_tooltip_set_markup (tooltip, str);
gtk_icon_view_set_tooltip_item (icon_view, tooltip, path);
gtk_tree_path_free (path);
g_free (str);
return TRUE;
}
/**
* gtk_icon_view_set_tooltip_column:
* @icon_view: a #GtkIconView
*
* @column: an integer, which is a valid column number for @icon_view's model
*
* If you only plan to have simple (text-only) tooltips on full items, you
* can use this function to have #GtkIconView handle these automatically
* for you. @column should be set to the column in @icon_view's model
* containing the tooltip texts, or -1 to disable this feature.
*
* When enabled, #GtkWidget::has-tooltip will be set to %TRUE and
* @icon_view will connect a #GtkWidget::query-tooltip signal handler.
*
* Since: 2.12
*/
void
gtk_icon_view_set_tooltip_column (GtkIconView *icon_view,
gint column)
{
g_return_if_fail (GTK_IS_ICON_VIEW (icon_view));
if (column == icon_view->priv->tooltip_column)
return;
if (column == -1)
{
g_signal_handlers_disconnect_by_func (icon_view,
gtk_icon_view_set_tooltip_query_cb,
NULL);
gtk_widget_set_has_tooltip (GTK_WIDGET (icon_view), FALSE);
}
else
{
if (icon_view->priv->tooltip_column == -1)
{
g_signal_connect (icon_view, "query-tooltip",
G_CALLBACK (gtk_icon_view_set_tooltip_query_cb), NULL);
gtk_widget_set_has_tooltip (GTK_WIDGET (icon_view), TRUE);
}
}
icon_view->priv->tooltip_column = column;
g_object_notify (G_OBJECT (icon_view), "tooltip-column");
}
/**
* gtk_icon_view_get_tooltip_column:
* @icon_view: a #GtkIconView
*
* Returns the column of @icon_view's model which is being used for
* displaying tooltips on @icon_view's rows.
*
* Return value: the index of the tooltip column that is currently being
* used, or -1 if this is disabled.
*
* Since 2.12
*/
gint
gtk_icon_view_get_tooltip_column (GtkIconView *icon_view)
{
g_return_val_if_fail (GTK_IS_ICON_VIEW (icon_view), 0);
return icon_view->priv->tooltip_column;
}
/**
* gtk_icon_view_get_visible_range:
* @icon_view: A #GtkIconView
......
......@@ -210,6 +210,16 @@ void gtk_icon_view_set_tooltip_cell (GtkIconView *
GtkTooltip *tooltip,
GtkTreePath *path,
GtkCellRenderer *cell);
gboolean gtk_icon_view_get_tooltip_context (GtkIconView *icon_view,
gint *x,
gint *y,
gboolean keyboard_tip,
GtkTreeModel **model,
GtkTreePath **path,
GtkTreeIter *iter);
void gtk_icon_view_set_tooltip_column (GtkIconView *icon_view,
gint column);
gint gtk_icon_view_get_tooltip_column (GtkIconView *icon_view);
G_END_DECLS
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment