RGtk2 (version 2.20.31)

gtkTextViewScrollToIter: gtkTextViewScrollToIter

Description

Scrolls text.view so that iter is on the screen in the position indicated by xalign and yalign. An alignment of 0.0 indicates left or top, 1.0 indicates right or bottom, 0.5 means center. If use.align is FALSE, the text scrolls the minimal distance to get the mark onscreen, possibly not scrolling at all. The effective screen for purposes of this function is reduced by a margin of size within.margin.

Usage

gtkTextViewScrollToIter(object, iter, within.margin, use.align = FALSE,  xalign = 0.5, yalign = 0.5)

Arguments

object

a GtkTextView

iter

a GtkTextIter

within.margin

margin as a [0.0,0.5) fraction of screen size

use.align

whether to use alignment arguments (if FALSE, just get the mark onscreen)

xalign

horizontal alignment of mark within visible area

yalign

vertical alignment of mark within visible area

Value

TRUE if scrolling occurred

Details

Note that this function uses the currently-computed height of the lines in the text buffer. Line heights are computed in an idle handler; so this function may not have the desired effect if it's called before the height computations. To avoid oddness, consider using gtkTextViewScrollToMark which saves a point to be scrolled to after line validation.