File: pdf-show-boxed.xml

package info (click to toggle)
phpdoc 20050512-1
  • links: PTS
  • area: non-free
  • in suites: sarge
  • size: 36,592 kB
  • ctags: 1,501
  • sloc: xml: 376,768; php: 6,708; cpp: 500; makefile: 293; perl: 161; sh: 151; awk: 28
file content (61 lines) | stat: -rw-r--r-- 2,527 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
<?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
-->