cvs: phpdoc /en/reference/imagick/imagick setfont.xml
| From: | Mikko Koppanen | Date: | Wed, 03 Sep 2008 13:58:17 +0000 |
| Subject: | cvs: phpdoc /en/reference/imagick/imagick setfont.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-2132@lists.php.net to get a copy of this message | ||
mkoppanen Wed Sep 3 13:58:17 2008 UTC
Added files:
/phpdoc/en/reference/imagick/imagick setfont.xml
Log:
Added documentation for Imagick::setFont method
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imagick/imagick/setfont.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/imagick/imagick/setfont.xml
+++ phpdoc/en/reference/imagick/imagick/setfont.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xmlns="http://docbook.org/ns/docbook"
xml:id="function.imagick-setfont">
<refnamediv>
<refname>Imagick::setFont</refname>
<refpurpose>Sets the image bias for any method that convolves an image</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>Imagick::setFont</methodname>
<methodparam><type>string</type><parameter>font</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
&warn.experimental.func;
<para>
Sets object's font property. This method can be used for example to set font for
caption: pseudo-format. This method is available if Imagick is compile against
at least version 6.3.6-4 of ImageMagick.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>font</parameter></term>
<listitem>
<para>
Font name or a filename
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&imagick.return.success;
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>Imagick::setFont</function> example</title>
<para>
Example of using Imagick::setFont
</para>
<programlisting role="php">
<![CDATA[
<?php
/* Create new imagick object */
$im = new Imagick();
/* Set the font for the object */
$im->setFont("example.ttf");
/* Create new caption */
$im->newPseudoImage(100, 100, "caption:Hello");
/* Do something with the image */
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something
else</link></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:"../../../../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
-->