-
Notifications
You must be signed in to change notification settings - Fork 73
/
ps-get-parameter.xml
202 lines (197 loc) · 7.54 KB
/
ps-get-parameter.xml
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
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: b95d28e6ec86e4a71e012737d36ebdc1cf009180 Maintainer: evvc Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.ps-get-parameter" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ps_get_parameter</refname>
<refpurpose>Получает определённые параметры</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>string</type><type>false</type></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>
Получает несколько параметров, которые были прямо установлены <function>ps_set_parameter</function>
или косвенно одной из других функций. Параметры по определению являются строковыми значениями.
Функцию нельзя использовать для получения ресурсов, которые также были установлены
с помощью <function>ps_set_parameter</function>.
</para>
<para>
Параметр <parameter>name</parameter> может иметь следующие значения:
</para>
<para>
<variablelist>
<varlistentry>
<term><literal>fontname</literal></term>
<listitem>
<para>
Имя текущего активного шрифта или шрифта, идентификатор которого передаётся
в параметре <parameter>modifier</parameter>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>fontencoding</literal></term>
<listitem>
<para>
Кодировка текущего активного шрифта.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>dottedversion</literal></term>
<listitem>
<para>
Версия базовой библиотеки pslib в формате
<major>.<minor>.<subminor>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>scope</literal></term>
<listitem>
<para>
Текущий объём чертежа. Может быть: object, document, null, page,
pattern, path, template, prolog, font, glyph.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ligaturedisolvechar</literal></term>
<listitem>
<para>
Символ, который растворяет лигатуру. Если вы используете шрифт, содержащий лигатуры `ff'
и символ для растворения лигатуры `|', тогда `f|f' приведёт к двум `f' вместо лигатуры `ff'.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>imageencoding</literal></term>
<listitem>
<para>
Кодировка, используемая для кодирования изображений. Может иметь значение <literal>hex</literal>
или <literal>85</literal>. Шестнадцатеричное кодирование использует два байта
в файле postscript на каждый байт изображения. 85 - это кодировка Ascii85.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>linenumbermode</literal></term>
<listitem>
<para>
Установите значение <literal>paragraph</literal>, если строки пронумерованы внутри абзаца
или <literal>box</literal>, если они пронумерованы в пределах окружающего поля.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>linebreak</literal></term>
<listitem>
<para>
Используется, только если текст выводится с помощью <function>ps_show_boxed</function>.
Если установлено значение &true;, возврат каретки добавит разрыв строки.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>parbreak</literal></term>
<listitem>
<para>
Используется, только если текст выводится с помощью <function>ps_show_boxed</function>.
Если установлено значение &true;, возврат каретки начнёт новый абзац.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>hyphenation</literal></term>
<listitem>
<para>
Используется, только если текст выводится с помощью <function>ps_show_boxed</function>.
Если установлено значение &true;, абзац будет расставлен через дефис,
если дефисный словарь установлен и существует.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>hyphendict</literal></term>
<listitem>
<para>
Имя файла словаря, используемого для расстановки переносов.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>psdoc</parameter></term>
<listitem>
<para>
Идентификатор ресурса файла postscript,
возвращённый функцией <function>ps_new</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
Имя параметра.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>modifier</parameter></term>
<listitem>
<para>
Идентификатор, необходимый, если запрашивается параметр ресурса,
например, размер изображения. В таком случае передаётся идентификатор ресурса.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Возвращает значение параметра&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
-->