← Back to branch summary

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

« back to all changes in this revision

Viewing changes to man/pango-Cairo-Rendering.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:
man/pango-Cairo-Rendering.Rd
7
7
\description{Rendering with the Cairo backend}
8
8
\section{Methods and Functions}{
9
9
\code{\link{pangoCairoFontMapGetDefault}()}\cr
 
10
\code{\link{pangoCairoFontMapSetDefault}(fontmap)}\cr
10
11
\code{\link{pangoCairoFontMapNew}()}\cr
11
12
\code{\link{pangoCairoFontMapNewForFontType}(fonttype)}\cr
12
13
\code{\link{pangoCairoFontMapGetFontType}(object)}\cr
13
14
\code{\link{pangoCairoFontMapSetResolution}(object, dpi)}\cr
14
15
\code{\link{pangoCairoFontMapGetResolution}(object)}\cr
15
16
\code{\link{pangoCairoFontMapCreateContext}(object)}\cr
 
17
\code{\link{pangoCairoFontMapCreateContext}(object)}\cr
16
18
\code{\link{pangoCairoFontGetScaledFont}(object)}\cr
17
19
\code{\link{pangoCairoContextSetResolution}(context, dpi)}\cr
18
20
\code{\link{pangoCairoContextGetResolution}(context)}\cr
20
22
\code{\link{pangoCairoContextGetFontOptions}(context)}\cr
21
23
\code{\link{pangoCairoContextSetShapeRenderer}(object, func, data)}\cr
22
24
\code{\link{pangoCairoContextGetShapeRenderer}(object)}\cr
 
25
\code{\link{pangoCairoCreateContext}(cr)}\cr
23
26
\code{\link{pangoCairoUpdateContext}(cr, context)}\cr
24
27
\code{\link{pangoCairoCreateLayout}(cr)}\cr
25
28
\code{\link{pangoCairoUpdateLayout}(cr, layout)}\cr
26
29
\code{\link{pangoCairoShowGlyphString}(cr, font, glyphs)}\cr
 
30
\code{\link{pangoCairoShowGlyphItem}(cr, text, glyph.item)}\cr
27
31
\code{\link{pangoCairoShowLayoutLine}(cr, line)}\cr
28
32
\code{\link{pangoCairoShowLayout}(cr, layout)}\cr
29
33
\code{\link{pangoCairoShowErrorUnderline}(cr, x, y, width, height)}\cr
32
36
\code{\link{pangoCairoLayoutPath}(cr, layout)}\cr
33
37
\code{\link{pangoCairoErrorUnderlinePath}(cr, x, y, width, height)}\cr
34
38
}
35
 
\section{Hierarchy}{\preformatted{GInterface
36
 
   +----PangoCairoFontMap}}
 
39
\section{Hierarchy}{\preformatted{
 
40
GInterface
 
41
   +----PangoCairoFont
 
42
GInterface
 
43
   +----PangoCairoFontMap
 
44
}}
37
45
\section{Detailed Description}{The Cairo library (\url{http://cairographics.org}) is a
38
46
vector graphics library with a powerful rendering model. It has such
39
47
features as anti-aliased primitives, alpha-compositing, and
42
50
windowing systems. The functions in this section allow using Pango
43
51
to render to Cairo surfaces.
44
52
  
45
 
Using Pango with Cairo is straightforward. A \verb{\link{PangoContext}} created
 
53
Using Pango with Cairo is straightforward. A \code{\link{PangoContext}} created
46
54
with \code{\link{pangoCairoFontMapCreateContext}} can be used on any
47
55
Cairo context (cairo_t), but needs to be updated to match the
48
56
current transformation matrix and target surface of the Cairo context
49
57
using \code{\link{pangoCairoUpdateContext}}. The convenience functions
50
58
\code{\link{pangoCairoCreateLayout}} and \code{\link{pangoCairoUpdateLayout}} handle
51
59
the common case where the program doesn't need to manipulate the
52
 
properties of the \verb{\link{PangoContext}}.
 
60
properties of the \code{\link{PangoContext}}.
53
61
  
54
62
When you get the metrics of a layout or of a piece of a layout using
55
63
functions such as \code{\link{pangoLayoutGetExtents}}, the reported metrics
129
137
}  }
130
138
\section{Structures}{\describe{
131
139
\item{\verb{PangoCairoFont}}{
132
 
\verb{\link{PangoCairoFont}} is an interface exported by fonts for
 
140
\code{\link{PangoCairoFont}} is an interface exported by fonts for
133
141
use with Cairo. The actual type of the font will depend
134
 
on the particular font technology Cairo was compiled to use.  
135
 
 
136
 
  Since  1.18
 
142
on the particular font technology Cairo was compiled to use.
 
143
  Since 1.18
137
144
 
138
145
}
139
146
\item{\verb{PangoCairoFontMap}}{
140
 
\verb{\link{PangoCairoFontMap}} is an interface exported by font maps for
 
147
\code{\link{PangoCairoFontMap}} is an interface exported by font maps for
141
148
use with Cairo. The actual type of the font map will depend
142
 
on the particular font technology Cairo was compiled to use.  
143
 
 
144
 
  Since  1.10
 
149
on the particular font technology Cairo was compiled to use.
 
150
  Since 1.10
145
151
 
146
152
}
147
153
}}
150
156
with Pango's Cairo renderer.
151
157
 
152
158
\describe{
153
 
\item{\code{cr}}{[\verb{\link{Cairo}}] a Cairo context with current point set to where the shape should
 
159
\item{\code{cr}}{a Cairo context with current point set to where the shape should
154
160
     be rendered}
155
 
\item{\code{attr}}{[\verb{\link{PangoAttrShape}}] the \code{PANGO_ATTR_SHAPE} to render}
156
 
\item{\code{do.path}}{[logical] whether only the shape path should be appended to current
 
161
\item{\code{attr}}{the \code{PANGO_ATTR_SHAPE} to render}
 
162
\item{\code{do.path}}{whether only the shape path should be appended to current
157
163
          path of \code{cr} and no filling/stroking done.  This will be set
158
164
          to \code{TRUE} when called from \code{\link{pangoCairoLayoutPath}} and
159
165
          \code{\link{pangoCairoLayoutLinePath}} rendering functions.}
160
 
\item{\code{data}}{[R object] user data passed to \code{\link{pangoCairoContextSetShapeRenderer}}}
 
166
\item{\code{data}}{user data passed to \code{\link{pangoCairoContextSetShapeRenderer}}}
161
167
}
162
168
 
163
169
 
164
170
}}}
165
 
\references{\url{http://developer.gnome.org/doc/API/2.0/pango/pango-Cairo-Rendering.html}}
 
171
\references{\url{http://library.gnome.org/devel//pango/pango-Cairo-Rendering.html}}
166
172
\author{Derived by RGtkGen from GTK+ documentation}
167
173
\keyword{internal}