mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 18:38:55 +00:00
6e22866c37
- added examples where needed git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@208537 c90b9560-bf6c-de11-be94-00142212c4b1
147 lines
4.2 KiB
XML
147 lines
4.2 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.4 $ -->
|
|
<!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 -->
|
|
<refentry id="function.ps-add-locallink">
|
|
<refnamediv>
|
|
<refname>ps_add_locallink</refname>
|
|
<refpurpose>Adds link to a page in the same document</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>ps_add_locallink</methodname>
|
|
<methodparam><type>resource</type><parameter>psdoc</parameter></methodparam>
|
|
<methodparam><type>float</type><parameter>llx</parameter></methodparam>
|
|
<methodparam><type>float</type><parameter>lly</parameter></methodparam>
|
|
<methodparam><type>float</type><parameter>urx</parameter></methodparam>
|
|
<methodparam><type>float</type><parameter>ury</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>page</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>dest</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Places a hyperlink at the given position pointing to a page in the same
|
|
document. Clicking on the link will jump to the given page. The first page
|
|
in a document has number 1.
|
|
</para>
|
|
<para>
|
|
The hyperlink's source position is a rectangle with its lower left corner at
|
|
(<parameter>llx</parameter>, <parameter>lly</parameter>) and its upper
|
|
right corner at (<parameter>urx</parameter>, <parameter>ury</parameter>).
|
|
The rectangle has by default a thin blue border.
|
|
</para>
|
|
<para>
|
|
The hyperlink will not be visible if the document is printed or viewed but
|
|
it will show up if the document is converted to pdf by either Acrobat
|
|
Distiller™ or Ghostview.
|
|
</para>
|
|
</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>llx</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The x-coordinate of the lower left corner.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>lly</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The y-coordinate of the lower left corner.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>urx</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The x-coordinate of the upper right corner.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>ury</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The y-coordinate of the upper right corner.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>page</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The number of the page displayed when clicking on the link.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>dest</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The parameter <parameter>dest</parameter> determines how the document
|
|
is being viewed. It can be <literal>fitpage</literal>,
|
|
<literal>fitwidth</literal>, <literal>fitheight</literal>, or
|
|
<literal>fitbbox</literal>.
|
|
</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_add_launchlink</function></member>
|
|
<member><function>ps_add_pdflink</function></member>
|
|
<member><function>ps_add_weblink</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:"../../../../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
|
|
-->
|
|
|