[cairo-commit] pycairo/doc/reference context.rst, 1.4, 1.5 text.rst, 1.3, 1.4
Steve Chaplin
commit at pdx.freedesktop.org
Sun Jun 21 04:53:03 PDT 2009
Committed by: stevech1097
Update of /cvs/cairo/pycairo/doc/reference
In directory kemper:/tmp/cvs-serv2554/doc/reference
Modified Files:
context.rst text.rst
Log Message:
'SC'
Index: context.rst
===================================================================
RCS file: /cvs/cairo/pycairo/doc/reference/context.rst,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- context.rst 21 Jun 2009 06:23:18 -0000 1.4
+++ context.rst 21 Jun 2009 11:53:00 -0000 1.5
@@ -1297,9 +1297,9 @@
:param text: text
:type text: str or unicode
- A drawing operator that generates the shape from a string of text (which
- is converted to UTF-8 as required), rendered according to the current
- font_face, font_size (font_matrix), and font_options.
+ A drawing operator that generates the shape from a string of text,
+ rendered according to the current font_face, font_size (font_matrix),
+ and font_options.
This function first computes a set of glyphs for the string of text. The
first glyph is placed so that its origin is at the current point. The
@@ -1393,12 +1393,11 @@
:returns: x_bearing, y_bearing, width, height, x_advance, y_advance
:rtype: 6-tuple of float
- Gets the extents for a string of text (text is automatically encoded to
- UTF-8 if required). The extents describe a user-space rectangle that
- encloses the "inked" portion of the text, (as it would be drawn by
- :meth:`Context.show_text`). Additionally, the x_advance and y_advance
- values indicate the amount by which the current point would be advanced
- by :meth:`Context.show_text`.
+ Gets the extents for a string of text. The extents describe a user-space
+ rectangle that encloses the "inked" portion of the text, (as it would be
+ drawn by :meth:`Context.show_text`). Additionally, the x_advance and
+ y_advance values indicate the amount by which the current point would be
+ advanced by :meth:`Context.show_text`.
Note that whitespace characters do not directly contribute to the size
of the rectangle (extents.width and extents.height). They do contribute
Index: text.rst
===================================================================
RCS file: /cvs/cairo/pycairo/doc/reference/text.rst,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -d -r1.3 -r1.4
--- text.rst 21 Jun 2009 06:23:18 -0000 1.3
+++ text.rst 21 Jun 2009 11:53:00 -0000 1.4
@@ -53,8 +53,8 @@
.. class:: ToyFontFace(family[, slant[, weight]])
- :param family: a font family name, encoded in UTF-8
- :type family: str
+ :param family: a font family name
+ :type family: str or unicode
:param slant: the :ref:`FONT_SLANT <constants_FONT_SLANT>` of the font,
defaults to :data:`cairo.FONT_SLANT_NORMAL`.
:param weight: the :ref:`FONT_WEIGHT <constants_FONT_WEIGHT>` of the font,
@@ -62,7 +62,7 @@
:returns: a new *ToyFontFace*
Creates a *ToyFontFace* from a triplet of family, slant, and weight. These
- font faces are used in implementation of the the cairo_t "toy" font API.
+ font faces are used in implementation of the the "toy" font API.
If family is the zero-length string "", the platform-specific default
family is assumed. The default family then can be queried using
@@ -75,11 +75,9 @@
.. method:: get_family()
- :returns: the family name
+ :returns: the family name of a toy font
:rtype: str
- Gets the familly name of a toy font.
-
.. versionadded:: 1.8.4
.. method:: get_slant()
@@ -161,16 +159,18 @@
Not implemented in pycairo (yet)
- .. method:: text_extents()
+ .. method:: text_extents(text)
- :param utf8: text (str or unicode), encoded in UTF-8
- :returns: (x_bearing, y_bearing, width, height, x_advance, y_advance), a tuple of float values.
+ :param text: text
+ :type text: str or unicode
+ :returns: (x_bearing, y_bearing, width, height, x_advance, y_advance)
+ :rtype: 6-tuple of float
Gets the extents for a string of text. The extents describe a user-space
rectangle that encloses the "inked" portion of the text drawn at the
- origin (0,0) (as it would be drawn by :meth:`Context.show_text` if the cairo
- graphics state were set to the same font_face, font_matrix, ctm, and
- font_options as *ScaledFont*). Additionally, the x_advance and
+ origin (0,0) (as it would be drawn by :meth:`Context.show_text` if the
+ cairo graphics state were set to the same font_face, font_matrix, ctm,
+ and font_options as *ScaledFont*). Additionally, the x_advance and
y_advance values indicate the amount by which the current point would be
advanced by :meth:`Context.show_text`.
More information about the cairo-commit
mailing list