File: ps-add-launchlink.xml

package info (click to toggle)
php-doc 20061001-1
  • links: PTS
  • area: non-free
  • in suites: etch, etch-m68k
  • size: 45,764 kB
  • ctags: 1,611
  • sloc: xml: 502,485; php: 7,645; cpp: 500; makefile: 297; perl: 161; sh: 141; awk: 28
file content (131 lines) | stat: -rw-r--r-- 3,705 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
<?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-launchlink">
 <refnamediv>
  <refname>ps_add_launchlink</refname>
  <refpurpose>Adds link which launches file</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>ps_add_launchlink</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>string</type><parameter>filename</parameter></methodparam>
  </methodsynopsis>
  <para>
   Places a hyperlink at the given position pointing to a file program
   which is being started when clicked on. The hyperlink's source position
   is a rectangle
   with its lower left corner at (llx, lly) and its upper right corner at
   (urx, ury). 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&trade; 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>filename</parameter></term>
     <listitem>
      <para>
       The path of the program to be started, when the link is clicked on.
      </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_locallink</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
-->