mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-26 22:08:55 +00:00
6a6061bbd4
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@322055 c90b9560-bf6c-de11-be94-00142212c4b1
153 lines
3.8 KiB
XML
153 lines
3.8 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="cairocontext.copypath" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>CairoContext::copyPath</refname>
|
|
<refname>cairo_copy_path</refname>
|
|
<refpurpose>Creates a copy of the current path</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<para>&style.oop; (method):</para>
|
|
<methodsynopsis>
|
|
<modifier>public</modifier> <type>CairoPath</type><methodname>CairoContext::copyPath</methodname>
|
|
<void />
|
|
</methodsynopsis>
|
|
<para>&style.procedural;:</para>
|
|
<methodsynopsis>
|
|
<type>CairoPath</type><methodname>cairo_copy_path</methodname>
|
|
<methodparam><type>CairoContext</type><parameter>context</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Creates a copy of the current path and returns it to the user as a <classname>CairoPath</classname>.
|
|
See <classname>CairoPath</classname> for hints on how to iterate over the returned data structure.
|
|
</para>
|
|
<para>
|
|
This function will always return a valid <classname>CairoPath</classname> object,
|
|
but the result will have no data, if either of the following conditions hold:
|
|
<simplelist>
|
|
<member>1. If there is insufficient memory to copy the path. In this case CairoPath->status will
|
|
be set to CAIRO_STATUS_NO_MEMORY.</member>
|
|
<member>2. If <parameter>context</parameter> is already in an error state.
|
|
In this case CairoPath->status will contain the same status that would be returned by
|
|
<function>cairo_status</function>.</member>
|
|
</simplelist>
|
|
|
|
In either case, CairoPath->status will be set to CAIRO_STATUS_NO_MEMORY
|
|
(regardless of what the error status in cr might have been).
|
|
|
|
</para>
|
|
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>context</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A valid <classname>CairoContext</classname> object created with
|
|
<methodname>CairoContext::__construct</methodname> or <function>cairo_create</function>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
A copy of the current <classname>CairoPath</classname> in the context
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>&style.oop;</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
$surface = new CairoImageSurface(CairoFormat::ARGB32, 50, 50);
|
|
|
|
$context = new CairoContext($surface);
|
|
|
|
var_dump($context->copyPath())
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
object(CairoPath)#3 (0) {
|
|
}
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
<para>
|
|
<example>
|
|
<title>&style.procedural;</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
$surface = cairo_image_surface_create(CAIRO_FORMAT_ARGB32, 50, 50);
|
|
|
|
$context = cairo_create($surface);
|
|
|
|
var_dump(cairo_copy_path($context));
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
object(CairoPath)#3 (0) {
|
|
}
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><methodname>CairoContext::closePath</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
|
|
-->
|