php-doc-en/reference/cairo/cairocontext/appendpath.xml
2010-02-03 13:03:22 +00:00

143 lines
3.4 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="cairocontext.appendpath" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>CairoContext::appendPath</refname>
<refname>cairo_append_path</refname>
<refpurpose>Appends a path to current path</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style (method):</para>
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>CairoContext::appendPath</methodname>
<methodparam><type>CairoPath</type><parameter>path</parameter></methodparam>
</methodsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>void</type><methodname>cairo_append_path</methodname>
<methodparam><type>CairoContext</type><parameter>context</parameter></methodparam>
<methodparam><type>CairoPath</type><parameter>path</parameter></methodparam>
</methodsynopsis>
<para>
Appends the <parameter>path</parameter> onto the current path.
The <parameter>path</parameter> may be either the return value from one of <methodname>CairoContext::copyPath</methodname> or
<methodname>CairoContext::copyPathFlat</methodname>;
</para>
<para>
if <parameter>path</parameter> is not a valid <classname>CairoPath</classname> instance
a <classname>CairoException</classname> will be thrown
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>context</parameter></term>
<listitem>
<para>
CairoContext object
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>path</parameter></term>
<listitem>
<para>
CairoPath object
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Object oriented style</title>
<programlisting role="php">
<![CDATA[
<?php
$surface = new CairoImageSurface(CairoFormat::ARGB32, 50, 50);
$context = new CairoContext($surface);
$path = $context->copyPath();
$context->appendPath($path);
?>
]]>
</programlisting>
</example>
</para>
<para>
<example>
<title>Procedural style</title>
<programlisting role="php">
<![CDATA[
<?php
$surface = cairo_image_surface_create(CAIRO_FORMAT_ARGB32, 50, 50);
$context = cairo_create($surface);
$path = cairo_copy_path($context);
cairo_append_path($context, $path);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><classname>CairoPath</classname></member>
<member><methodname>CairoContext::copyPath</methodname></member>
<member><methodname>CairoContext::copyPathFlat</methodname></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->