RGtk2 (version 2.20.31)

gtkTreeViewGetTooltipContext: gtkTreeViewGetTooltipContext

Description

This function is supposed to be used in a "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.

Usage

gtkTreeViewGetTooltipContext(object, x, y, keyboard.tip)

Arguments

object

a GtkTreeView

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

Value

A list containing the following elements:

retval

[logical] whether or not the given tooltip context points to a row.

model

a pointer to receive a GtkTreeModel or NULL. [ allow-none ]

path

a pointer to receive a GtkTreePath or NULL. [ allow-none ]

iter

a pointer to receive a GtkTreeIter or NULL. [ allow-none ]

Details

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. Since 2.12