Method

GtkTextViewget_iter_at_position

Declaration [src]

gboolean
gtk_text_view_get_iter_at_position (
  GtkTextView* text_view,
  GtkTextIter* iter,
  int* trailing,
  int x,
  int y
)

Description [src]

Retrieves the iterator pointing to the character at buffer coordinates x and y.

Buffer coordinates are coordinates for the entire buffer, not just the currently-displayed portion. If you have coordinates from an event, you have to convert those to buffer coordinates with gtk_text_view_window_to_buffer_coords().

Note that this is different from gtk_text_view_get_iter_at_location(), which returns cursor locations, i.e. positions between characters.

Parameters

iter GtkTextIter
 

A GtkTextIter

 The argument will be set by the function.
 The data is owned by the caller of the function.
trailing int*
 

If non-NULL, location to store an integer indicating where in the grapheme the user clicked. It will either be zero, or the number of characters in the grapheme. 0 represents the trailing edge of the grapheme.

 The argument will be set by the function.
 The argument can be NULL.
 The instance takes ownership of the data, and is responsible for freeing it.
x int
 

X position, in buffer coordinates.

y int
 

Y position, in buffer coordinates.

Return value

Returns: gboolean
 

TRUE if the position is over text.