php-doc-en/reference/cpdf/functions/cpdf-add-annotation.xml
Mehdi Achour 7218bcc708 updating protos
fixed missing params
added role to programlisting
added para arround the examples
added one example and a note about the rgb values (users notes)
WS for the See Also
using cpdf.ul; as shorthand


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@137849 c90b9560-bf6c-de11-be94-00142212c4b1
2003-08-15 14:29:05 +00:00

54 lines
1.9 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.3 -->
<refentry id="function.cpdf-add-annotation">
<refnamediv>
<refname>cpdf_add_annotation</refname>
<refpurpose>Adds annotation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>cpdf_add_annotation</methodname>
<methodparam><type>int</type><parameter>pdf_document</parameter></methodparam>
<methodparam><type>float</type><parameter>llx</parameter></methodparam>
<methodparam><type>float</type><parameter>lly</parameter></methodparam>
<methodparam><type>float</type><parameter>urx</parameter></methodparam>
<methodparam><type>float</type><parameter>ury</parameter></methodparam>
<methodparam><type>string</type><parameter>title</parameter></methodparam>
<methodparam><type>string</type><parameter>content</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam>
</methodsynopsis>
<para>
The <function>cpdf_add_annotation</function> adds a note with the
lower left corner at (<parameter>llx</parameter>,
<parameter>lly</parameter>) and the upper right corner at
(<parameter>urx</parameter>, <parameter>ury</parameter>).
&return.success;
</para>
&cpdf.ul;
</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
-->