File: textrect.xml

package info (click to toggle)
php-doc 20140201-1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 74,084 kB
  • ctags: 4,040
  • sloc: xml: 998,137; php: 20,812; cpp: 500; sh: 177; makefile: 63; awk: 28
file content (139 lines) | stat: -rw-r--r-- 3,649 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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 322115 $ -->
<refentry xml:id="harupage.textrect" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>HaruPage::textRect</refname>
  <refpurpose>Print the text inside the specified region</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>HaruPage::textRect</methodname>
   <methodparam><type>float</type><parameter>left</parameter></methodparam>
   <methodparam><type>float</type><parameter>top</parameter></methodparam>
   <methodparam><type>float</type><parameter>right</parameter></methodparam>
   <methodparam><type>float</type><parameter>bottom</parameter></methodparam>
   <methodparam><type>string</type><parameter>text</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>align</parameter><initializer>HaruPage::TALIGN_LEFT</initializer></methodparam>
  </methodsynopsis>
  <para>
   Prints the text inside the specified region.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>left</parameter></term>
     <listitem>
      <para>
       Left border of the text area.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>top</parameter></term>
     <listitem>
      <para>
       Top border of the text area.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>right</parameter></term>
     <listitem>
      <para>
       Right border of the text area.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>bottom</parameter></term>
     <listitem>
      <para>
       Lower border of the text area.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>text</parameter></term>
     <listitem>
      <para>
       The text to print. 
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>align</parameter></term>
     <listitem>
      <para>
       Text alignment. Must be one of the following values:
       <simplelist>
        <member>
         <constant>HaruPage::TALIGN_LEFT</constant>
        </member>
        <member>
         <constant>HaruPage::TALIGN_RIGHT</constant>
        </member>
        <member>
         <constant>HaruPage::TALIGN_CENTER</constant>
        </member>
        <member>
         <constant>HaruPage::TALIGN_JUSTIFY</constant>
        </member>
       </simplelist>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns &true; on success.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  &haru.error;
 </refsect1>
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><methodname>HaruPage::showTextNextLine</methodname></member>
    <member><methodname>HaruPage::showText</methodname></member>
    <member><methodname>HaruPage::textOut</methodname></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
-->