svn: /phpdoc/en/trunk/reference/cairo/cairocontext/ textpath.xml
| From: | Mark Skilbeck | Date: | Fri, 24 Sep 2010 17:46:22 +0000 |
| Subject: | svn: /phpdoc/en/trunk/reference/cairo/cairocontext/ textpath.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-7163@lists.php.net to get a copy of this message | ||
markskilbeck Fri, 24 Sep 2010 17:46:22 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=303752
Log:
Adding Cairo docs
Changed paths:
UU phpdoc/en/trunk/reference/cairo/cairocontext/textpath.xml
Modified: phpdoc/en/trunk/reference/cairo/cairocontext/textpath.xml
===================================================================
--- phpdoc/en/trunk/reference/cairo/cairocontext/textpath.xml 2010-09-24 16:20:05 UTC (rev 303751)
+++ phpdoc/en/trunk/reference/cairo/cairocontext/textpath.xml 2010-09-24 17:46:22 UTC (rev 303752)
@@ -7,28 +7,48 @@
<refname>cairo_text_path</refname>
<refpurpose>The textPath purpose</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
- <para>Object oriented style (method):</para>
- <methodsynopsis>
+ <para>&style.oop;</para>
+ <methodsynopsis role="oop">
<modifier>public</modifier>
<type>void</type><methodname>CairoContext::textPath</methodname>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
- </methodsynopsis>
- <para>Procedural style:</para>
- <methodsynopsis>
+ </methodsynopsis>
+ <para>&style.procedural;</para>
+ <methodsynopsis role="procedural">
<type>void</type><methodname>cairo_text_path</methodname>
<methodparam><type>CairoContext</type><parameter>context</parameter></methodparam>
<methodparam><type>string</type><parameter>text</parameter></methodparam>
</methodsynopsis>
<para>
- Description here.
+ Adds closed paths for text to the current path. The generated path, if filled,
+ achieves an effect similar to that of
<methodname>CairoContext::showText</methodname>.
</para>
+ <para>
+ Text conversion and positioning is done similar to
+ <methodname>CairoContext::showText</methodname>.
+ </para>
+ <para>
+ Like <methodname>CairoContext::showText</methodname>,
+ after this call the current point is moved to the origin of where
+ the next glyph would be placed in this same progression.
+ That is, the current point will be at the origin of the final
+ glyph offset by its advance values. This allows for chaining multiple
+ calls to to <methodname>CairoContext::showText</methodname>
+ without having to set current point in between.
+ </para>
+ <para>
+ Note: The <methodname>CairoContext::textPath</methodname> function
+ call is part of what the cairo designers call the "toy" text API.
+ It is convenient for short demos and simple programs,
+ but it is not expected to be adequate for serious text-using applications.
+ See <methodname>CairoContext::glyphPath</methodname> for the "real"
+ text path API in cairo.
+ </para>
- &warn.undocumented.func;
+ </refsect1>
- </refsect1>
-
<refsect1 role="parameters">
&reftitle.parameters;
<para>
@@ -37,7 +57,7 @@
<term><parameter>context</parameter></term>
<listitem>
<para>
- Description...
+ A <classname>CairoContext</classname> object
</para>
</listitem>
</varlistentry>
@@ -60,14 +80,14 @@
</variablelist>
</para>
</refsect1>
-
+
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Description...
</para>
</refsect1>
-
+
<refsect1 role="examples">
&reftitle.examples;
<para>
@@ -79,9 +99,9 @@
/* ... */
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
...
]]>
@@ -97,9 +117,9 @@
/* ... */
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
...
]]>
@@ -107,7 +127,7 @@
</example>
</para>
</refsect1>
-
+
<refsect1 role="seealso">
&reftitle.seealso;
<para>
@@ -116,7 +136,7 @@
</simplelist>
</para>
</refsect1>
-
+
</refentry>
<!-- Keep this comment at the end of the file
Property changes on: phpdoc/en/trunk/reference/cairo/cairocontext/textpath.xml
___________________________________________________________________
Added: svn:eol-style
+ native