archived-doc-ru/reference/ps/functions/ps-get-value.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 4754397753fd79f1c846868b66a2448babab1c54 Maintainer: evvc Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.ps-get-value" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ps_get_value</refname>
  <refpurpose>Получает определённые значения</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>float</type><methodname>ps_get_value</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_value</function>.
   Значения по определению являются значениями с плавающей точкой.
  </para>
  <para>
   Параметр <parameter>name</parameter> может иметь следующие значения:
  </para>
  <para>
   <variablelist>
    <varlistentry>
     <term><literal>fontsize</literal></term>
     <listitem>
      <para>
       Размер текущего активного шрифта или шрифта, идентификатор которого
       передаётся в параметре <parameter>modifier</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>font</literal></term>
     <listitem>
      <para>
       Текущий активный шрифт.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>imagewidth</literal></term>
     <listitem>
      <para>
       Ширина изображения, идентификатор которого передаётся
       в параметре <parameter>modifier</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>imageheight</literal></term>
     <listitem>
      <para>
       Высота изображения, идентификатор которого передаётся
       в параметре <parameter>modifier</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>capheight</literal></term>
     <listitem>
      <para>
       Высота заглавной буквы M активного шрифта или шрифта,
       идентификатор которого передаётся в параметре <parameter>modifier</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>ascender</literal></term>
     <listitem>
      <para>
       Верхний элемент активного шрифта или шрифта,
       идентификатор которого передаётся в параметре <parameter>modifier</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>descender</literal></term>
     <listitem>
      <para>
       Нисходящий элемент активного шрифта или шрифта,
       идентификатор которого передаётся в параметре <parameter>modifier</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>italicangle</literal></term>
     <listitem>
      <para>
       Курсив активного шрифта или шрифта,
       идентификатор которого передаётся в параметре <parameter>modifier</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>underlineposition</literal></term>
     <listitem>
      <para>
       Подчёркивание активного шрифта или шрифта,
       идентификатор которого передаётся в параметре <parameter>modifier</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>underlinethickness</literal></term>
     <listitem>
      <para>
       Толщина подчёркивания активного шрифта или шрифта,
       идентификатор которого передаётся в параметре <parameter>modifier</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>textx</literal></term>
     <listitem>
      <para>
       Текущая позиция по оси X для вывода текста.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>texty</literal></term>
     <listitem>
      <para>
       Текущая позиция по оси Y для вывода текста.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>textrendering</literal></term>
     <listitem>
      <para>
       Текущий режим отрисовки текста.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>textrise</literal></term>
     <listitem>
      <para>
       Пространство, на которое текст поднимается над базовой линией.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>leading</literal></term>
     <listitem>
      <para>
       Расстояние между строками текста в точках.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>wordspacing</literal></term>
     <listitem>
      <para>
       Расстояние между словами, кратное ширине символа пробела.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>charspacing</literal></term>
     <listitem>
      <para>
       Пробел между символами. Если charspacing не равно 0.0,
       лигатуры всегда будут растворяться.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>hyphenminchars</literal></term>
     <listitem>
      <para>
       Минимальное количество символов в конце слова.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>parindent</literal></term>
     <listitem>
      <para>
       Отступ первой n строки абзаца.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>numindentlines</literal></term>
     <listitem>
      <para>
       Номер строки в абзаце для отступа, если parindent не равно 0,0.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>parskip</literal></term>
     <listitem>
      <para>
       Расстояние между абзацами.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>linenumberspace</literal></term>
     <listitem>
      <para>
       Общее пространство перед каждой строкой для номера строки.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>linenumbersep</literal></term>
     <listitem>
      <para>
       Пробел между строкой и номером строки.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>major</literal></term>
     <listitem>
      <para>
       Мажорная версия pslib.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>minor</literal></term>
     <listitem>
      <para>
       Минорная версия pslib.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>subminor</literal>, <literal>revision</literal></term>
     <listitem>
      <para>
       Патч-версия pslib.
      </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>
       Параметр <parameter>modifier</parameter> указывает ресурс, для которого должно быть получено значение.
       Это может быть идентификатор шрифта или изображения.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Возвращает значение параметра или &false;.
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>ps_set_value</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
-->