File: ps-show.xml

package info (click to toggle)
php-doc 20100521-2
  • links: PTS, VCS
  • area: main
  • in suites: squeeze, wheezy
  • size: 59,992 kB
  • ctags: 4,085
  • sloc: xml: 796,833; php: 21,338; cpp: 500; sh: 117; makefile: 58; awk: 28
file content (152 lines) | stat: -rw-r--r-- 4,121 bytes parent folder | download | duplicates (2)
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
140
141
142
143
144
145
146
147
148
149
150
151
152
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 -->
<refentry xml:id="function.ps-show" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ps_show</refname>
  <refpurpose>Output text</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>ps_show</methodname>
   <methodparam><type>resource</type><parameter>psdoc</parameter></methodparam>
   <methodparam><type>string</type><parameter>text</parameter></methodparam>
  </methodsynopsis>
  <para>
   Output a text at the current text position. The text position can be set
   by storing the x and y coordinates into the values <literal>textx</literal>
   and <literal>texty</literal> with the function
   <function>ps_set_value</function>. The function will issue an
   error if a font was not set before with <function>ps_setfont</function>.
  </para>
  <para>
   <function>ps_show</function> evaluates the following parameters and values
   as set by <function>ps_set_parameter</function> and
   <function>ps_set_value</function>.
  </para>
  <variablelist>
   <varlistentry>
    <term>charspacing (value)</term>
    <listitem>
     <para>
      Distance between two consecutive glyphs. If this value is unequal to
      zero then all ligatures will be resolved. Values less than zero are
      allowed.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term>kerning (parameter)</term>
    <listitem>
     <para>
      Setting this parameter to "false" will turn off kerning. Kerning is
      turned on by default.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term>ligatures (parameter)</term>
    <listitem>
     <para>
      Setting this parameter to "false" will turn off the use of ligatures. 
      Ligatures are turned on by default.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term>underline (parameter)</term>
    <listitem>
     <para>
      Setting this parameter to "true" will turn on underlining. Underlining
      is turned off by default.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term>overline (parameter)</term>
    <listitem>
     <para>
      Setting this parameter to "true" will turn on overlining. Overlining is
      turned off by default.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term>strikeout (parameter)</term>
    <listitem> 
     <para>
      Setting this parameter to "true" will turn on striking out. Striking out
      is turned off by default.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>psdoc</parameter></term>
     <listitem>
      <para>
       Resource identifier of the postscript file
       as returned by <function>ps_new</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>text</parameter></term>
     <listitem>
      <para>
       The text to be output.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>ps_continue_text</function></member>
    <member><function>ps_show_xy</function></member>
    <member><function>ps_setfont</function></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
-->