File: gdkPangoLayoutGetClipRegion.Rd

package info (click to toggle)
rgtk2 2.20.36-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 33,540 kB
  • sloc: ansic: 137,163; makefile: 2; sh: 1
file content (20 lines) | stat: -rw-r--r-- 1,178 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
\alias{gdkPangoLayoutGetClipRegion}
\name{gdkPangoLayoutGetClipRegion}
\title{gdkPangoLayoutGetClipRegion}
\description{Obtains a clip region which contains the areas where the given ranges
of text would be drawn. \code{x.origin} and \code{y.origin} are the same position
you would pass to \code{\link{gdkDrawLayoutLine}}. \code{index.ranges} should contain
ranges of bytes in the layout's text.}
\usage{gdkPangoLayoutGetClipRegion(layout, x.origin, index.ranges)}
\arguments{
\item{\verb{layout}}{a \code{\link{PangoLayout}}}
\item{\verb{x.origin}}{X pixel where you intend to draw the layout with this clip}
\item{\verb{index.ranges}}{array of byte indexes into the layout, where even members of list are start indexes and odd elements are end indexes}
}
\details{Note that the regions returned correspond to logical extents of the text
ranges, not ink extents. So the drawn layout may in fact touch areas out of
the clip region.  The clip region is mainly useful for highlightling parts
of text, such as when text is selected.}
\value{[\code{\link{GdkRegion}}] a clip region containing the given ranges}
\author{Derived by RGtkGen from GTK+ documentation}
\keyword{internal}