mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-28 23:08:55 +00:00

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@166268 c90b9560-bf6c-de11-be94-00142212c4b1
61 lines
2.5 KiB
XML
61 lines
2.5 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.6 $ -->
|
|
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
|
|
<refentry id="function.pdf-show-boxed">
|
|
<refnamediv>
|
|
<refname>pdf_show_boxed</refname>
|
|
<refpurpose>Output text in a box</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>int</type><methodname>pdf_show_boxed</methodname>
|
|
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>text</parameter></methodparam>
|
|
<methodparam><type>float</type><parameter>left</parameter></methodparam>
|
|
<methodparam><type>float</type><parameter>top</parameter></methodparam>
|
|
<methodparam><type>float</type><parameter>width</parameter></methodparam>
|
|
<methodparam><type>float</type><parameter>height</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>mode</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>feature</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Format <parameter>text</parameter> in the current font and size into the
|
|
supplied text box according to the requested formatting
|
|
<parameter>mode</parameter>, which must be one of <literal>left</literal>,
|
|
<literal>right</literal>, <literal>center</literal>, <literal>justify</literal>
|
|
or <literal>fulljustify</literal>.
|
|
If <parameter>width</parameter> and <parameter>height</parameter> are 0,
|
|
only a single line is placed at the point (<parameter>left</parameter>,
|
|
<parameter>top</parameter>) in the requested <parameter>mode</parameter>.
|
|
Parameter <parameter>feature</parameter> was optional before PHP 5.
|
|
</para>
|
|
<para>
|
|
Returns the number of characters that did not fit in the specified
|
|
box. Returns 0 if all characters fit or the
|
|
<parameter>width</parameter> and <parameter>height</parameter>
|
|
parameters were set to 0 for single-line formatting.
|
|
</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
|
|
-->
|