php-doc-en/reference/ps/functions/ps-show.xml
Daniel Egeberg 96c9d88bad Converted to utf-8
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
2010-03-28 22:10:10 +00:00

152 lines
4 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- 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
-->