ps-get-value.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 4754397753fd79f1c846868b66a2448babab1c54 Maintainer: takagi Status: ready -->
<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>
       で指定された ID を持つフォントの名前。
      </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> で渡された ID
       の画像の幅。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>imageheight</literal></term>
     <listitem>
      <para>
       パラメータ <parameter>modifier</parameter> で渡された ID
       の画像の高さ。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>capheight</literal></term>
     <listitem>
      <para>
       現在アクティブなフォント、
       あるいはパラメータ <parameter>modifier</parameter>
       で指定された ID を持つフォントにおける、
       大文字の M の高さ。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>ascender</literal></term>
     <listitem>
      <para>
       現在アクティブなフォント、
       あるいはパラメータ <parameter>modifier</parameter>
       で指定された ID を持つフォントの ascender
       (上に突き出している部分の長さ)。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>descender</literal></term>
     <listitem>
      <para>
       現在アクティブなフォント、
       あるいはパラメータ <parameter>modifier</parameter>
       で指定された ID を持つフォントの descender
       (下に突き出している部分の長さ)。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>italicangle</literal></term>
     <listitem>
      <para>
       現在アクティブなフォント、
       あるいはパラメータ <parameter>modifier</parameter>
       で指定された ID を持つフォントの斜体の角度。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>underlineposition</literal></term>
     <listitem>
      <para>
       現在アクティブなフォント、
       あるいはパラメータ <parameter>modifier</parameter>
       で指定された ID を持つフォントの下線の位置。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>underlinethickness</literal></term>
     <listitem>
      <para>
       現在アクティブなフォント、
       あるいはパラメータ <parameter>modifier</parameter>
       で指定された ID を持つフォントの下線の太さ。
      </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>
       文字と文字の間の空白。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>
       <function>ps_new</function> が返す、postscript
       ファイルのリソース ID。
      </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> は、値を取得しようとしている
        リソースを指定します。たとえばフォントや画像の ID が考えられます。
      </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
-->