mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-26 22:08:55 +00:00
96c9d88bad
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
142 lines
3.6 KiB
XML
142 lines
3.6 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 -->
|
|
<refentry xml:id="function.ps-begin-template" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>ps_begin_template</refname>
|
|
<refpurpose>Start a new template</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>int</type><methodname>ps_begin_template</methodname>
|
|
<methodparam><type>resource</type><parameter>psdoc</parameter></methodparam>
|
|
<methodparam><type>float</type><parameter>width</parameter></methodparam>
|
|
<methodparam><type>float</type><parameter>height</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Starts a new template. A template is called a form in the postscript
|
|
language. It is created similar to a pattern but used like an image.
|
|
Templates are often used for drawings which are placed several times
|
|
through out the document, e.g. like a company logo. All drawing functions
|
|
may be used within a template. The template will not be drawn until
|
|
it is placed by <function>ps_place_image</function>.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>psdoc</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Resource identifier of the postscript file
|
|
as returned by <function>ps_new</function>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>width</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The width of the template in pixel.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>height</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The height of the template in pixel.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.success;
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>Creating and using a template</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$ps = ps_new();
|
|
|
|
if (!ps_open_file($ps, "template.ps")) {
|
|
print "Cannot open PostScript file\n";
|
|
exit;
|
|
}
|
|
|
|
ps_set_parameter($ps, "warning", "true");
|
|
ps_set_info($ps, "Creator", "template.php");
|
|
ps_set_info($ps, "Author", "Uwe Steinmann");
|
|
ps_set_info($ps, "Title", "Template example");
|
|
|
|
$pstemplate = ps_begin_template($ps, 30.0, 30.0);
|
|
ps_moveto($ps, 0, 0);
|
|
ps_lineto($ps, 30, 30);
|
|
ps_moveto($ps, 0, 30);
|
|
ps_lineto($ps, 30, 0);
|
|
ps_stroke($ps);
|
|
ps_end_template($ps);
|
|
|
|
ps_begin_page($ps, 596, 842);
|
|
ps_place_image($ps, $pstemplate, 20.0, 20.0, 1.0);
|
|
ps_place_image($ps, $pstemplate, 50.0, 30.0, 0.5);
|
|
ps_place_image($ps, $pstemplate, 70.0, 70.0, 0.6);
|
|
ps_place_image($ps, $pstemplate, 30.0, 50.0, 1.3);
|
|
ps_end_page($ps);
|
|
|
|
ps_close($ps);
|
|
ps_delete($ps);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>ps_end_template</function></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
|
|
-->
|
|
|