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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
|
<?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-get-parameter" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ps_get_parameter</refname>
<refpurpose>Gets certain parameters</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>ps_get_parameter</methodname>
<methodparam><type>resource</type><parameter>psdoc</parameter></methodparam>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam choice="opt"><type>float</type><parameter>modifier</parameter></methodparam>
</methodsynopsis>
<para>
Gets several parameters which were directly set by
<function>ps_set_parameter</function> or indirectly by one of the other
functions. Parameters are by definition string
values. This function cannot be used to retrieve resources which were also
set by <function>ps_set_parameter</function>.
</para>
<para>
The parameter <parameter>name</parameter> can have the following values.
</para>
<para>
<variablelist>
<varlistentry>
<term><literal>fontname</literal></term>
<listitem>
<para>
The name of the currently active font or the font whose
identifier is passed in parameter <parameter>modifier</parameter>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>fontencoding</literal></term>
<listitem>
<para>
The encoding of the currently active font.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>dottedversion</literal></term>
<listitem>
<para>
The version of the underlying pslib library in the format
<major>.<minor>.<subminor>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>scope</literal></term>
<listitem>
<para>
The current drawing scope. Can be object, document, null, page,
pattern, path, template, prolog, font, glyph.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ligaturedisolvechar</literal></term>
<listitem>
<para>
The character which dissolves a ligature. If your are using a font
which contains the ligature `ff' and `|' is the char to dissolve the
ligature, then `f|f' will result in two `f' instead of the ligature `ff'.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>imageencoding</literal></term>
<listitem>
<para>
The encoding used for encoding images. Can be either
<literal>hex</literal> or <literal>85</literal>. hex encoding
uses two bytes in the postscript file each byte in the image.
85 stand for Ascii85 encoding.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>linenumbermode</literal></term>
<listitem>
<para>
Set to <literal>paragraph</literal> if lines are numbered
within a paragraph or <literal>box</literal> if they are
numbered within the surrounding box.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>linebreak</literal></term>
<listitem>
<para>
Only used if text is output with <function>ps_show_boxed</function>.
If set to <literal>true</literal> a carriage return will add a line
break.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>parbreak</literal></term>
<listitem>
<para>
Only used if text is output with <function>ps_show_boxed</function>.
If set to <literal>true</literal> a carriage return will start
a new paragraph.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>hyphenation</literal></term>
<listitem>
<para>
Only used if text is output with <function>ps_show_boxed</function>.
If set to <literal>true</literal> the paragraph will be hyphenated
if a hypen dictionary is set and exists.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>hyphendict</literal></term>
<listitem>
<para>
Filename of the dictionary used for hyphenation pattern.
</para>
</listitem>
</varlistentry>
</variablelist>
</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>name</parameter></term>
<listitem>
<para>
Name of the parameter.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>modifier</parameter></term>
<listitem>
<para>
An identifier needed if a parameter of a resource is requested,
e.g. the size of an image. In such a case the resource id is
passed.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the value of the parameter &return.falseforfailure;.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ps_set_parameter</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
-->
|
