~ubuntu-branches/ubuntu/trusty/rgtk2/trusty

« back to all changes in this revision

Viewing changes to man/cairoShowTextGlyphs.Rd

  • Committer: Bazaar Package Importer
  • Author(s): Dirk Eddelbuettel
  • Date: 2010-11-03 11:35:46 UTC
  • mfrom: (1.3.7 upstream)
  • Revision ID: james.westby@ubuntu.com-20101103113546-a7fi7jdxdebp0tw1
Tags: 2.20.1-1
* New upstream release

* debian/control: Set (Build-)Depends: to current R version
* debian/control: Set Standards-Version: to current version 

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
\alias{cairoShowTextGlyphs}
 
2
\name{cairoShowTextGlyphs}
 
3
\title{cairoShowTextGlyphs}
 
4
\description{This operation has rendering effects similar to \code{\link{cairoShowGlyphs}}
 
5
but, if the target surface supports it, uses the provided text and
 
6
cluster mapping to embed the text for the glyphs shown in the output.
 
7
If the target does not support the extended attributes, this function
 
8
acts like the basic \code{\link{cairoShowGlyphs}} as if it had been passed
 
9
\code{glyphs} and \code{num.glyphs}.}
 
10
\usage{cairoShowTextGlyphs(cr, utf8, glyphs, clusters, cluster.flags)}
 
11
\arguments{
 
12
\item{\verb{cr}}{[\code{\link{Cairo}}]  a cairo context}
 
13
\item{\verb{utf8}}{[char]  a string of text encoded in UTF-8}
 
14
\item{\verb{glyphs}}{[\code{\link{CairoGlyph}}]  list of glyphs to show}
 
15
\item{\verb{clusters}}{[\code{\link{CairoTextCluster}}]  list of cluster mapping information}
 
16
\item{\verb{cluster.flags}}{[\code{\link{CairoTextClusterFlags}}]  cluster mapping flags}
 
17
}
 
18
\details{The mapping between \code{utf8} and \code{glyphs} is provided by a list of
 
19
\dfn{clusters}.  Each cluster covers a number of
 
20
text bytes and glyphs, and neighboring clusters cover neighboring
 
21
areas of \code{utf8} and \code{glyphs}.  The clusters should collectively cover \code{utf8}
 
22
and \code{glyphs} in entirety.
 
23
  
 
24
The first cluster always covers bytes from the beginning of \code{utf8}.
 
25
If \code{cluster.flags} do not have the \code{CAIRO_TEXT_CLUSTER_FLAG_BACKWARD}
 
26
set, the first cluster also covers the beginning
 
27
of \code{glyphs}, otherwise it covers the end of the \code{glyphs} list and
 
28
following clusters move backward.
 
29
  
 
30
See \code{\link{CairoTextCluster}} for constraints on valid clusters.  
 
31
  Since 1.8}
 
32
\author{Derived by RGtkGen from GTK+ documentation}
 
33
\keyword{internal}