Method

GtkTreeViewget_tooltip_context

since: 2.12

Declaration [src]

gboolean
gtk_tree_view_get_tooltip_context (
  GtkTreeView* tree_view,
  gint* x,
  gint* y,
  gboolean keyboard_tip,
  GtkTreeModel** model,
  GtkTreePath** path,
  GtkTreeIter* iter
)

Description [src]

This function is supposed to be used in a GtkWidget::query-tooltip signal handler for GtkTreeView. 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 a tree view row at the given coordinates (TRUE) or not (FALSE) for mouse tooltips. For keyboard tooltips the row returned will be the cursor row. 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 tree_view’s bin_window if keyboard_tooltip is FALSE.

Available since: 2.12

Parameters

x

Type: gint*

The x coordinate (relative to widget coordinates).

The argument will be modified by the function.
y

Type: gint*

The y coordinate (relative to widget coordinates).

The argument will be modified by the function.
keyboard_tip

Type: gboolean

Whether this is a keyboard tooltip or not.

model

Type: GtkTreeModel

A pointer to receive a GtkTreeModel or NULL.

The argument will be set by the function.
The argument can be set to NULL by the method.
The argument can be NULL.
The returned data is owned by the instance.
path

Type: GtkTreePath

A pointer to receive a GtkTreePath or NULL.

The argument will be set by the function.
The argument can be NULL.
The caller of the method takes ownership of the returned data, and is responsible for freeing it.
iter

Type: GtkTreeIter

A pointer to receive a GtkTreeIter or NULL.

The argument will be set by the function.
The argument can be NULL.
The returned data is owned by the instance.

Return value

Type: gboolean

Whether or not the given tooltip context points to a row.