ps-set-info.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 96c9d88bad9a7d7d44bfb7f26c226df7ee9ddf26 Maintainer: takagi Status: ready -->
<refentry xml:id="function.ps-set-info" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ps_set_info</refname>
  <refpurpose>ドキュメントの情報を設定する</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>ps_set_info</methodname>
   <methodparam><type>resource</type><parameter>p</parameter></methodparam>
   <methodparam><type>string</type><parameter>key</parameter></methodparam>
   <methodparam><type>string</type><parameter>val</parameter></methodparam>
  </methodsynopsis>
  <para>
   ドキュメントの情報フィールドを設定します。この情報は、PostScript
   ファイルのヘッダにコメントとして表示されます。
   ドキュメントが pdf に変換された場合にも、
   このフィールドはドキュメントの情報として使用されます。
  </para>
  <para>
   通常 <literal>BoundingBox</literal> は最初のページの設定と同じ値を
   設定しておきます。 <function>ps_findfont</function>
   が事前に呼ばれていなかった場合のみ、この設定が利用されます。そのような場合、
   もしこの関数で明示的に設定していなければ BoundingBox は空白のままとなります。
  </para>
  <para>
   postscript ファイルのヘッダが既に書き込まれている場合には、
   この関数は何の意味も持ちません。この関数は、最初のページの前、
   あるいは <function>ps_findfont</function>
   が最初にコールされる前にコールされる必要があります。
  </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>key</parameter></term>
     <listitem>
      <para>
       設定する情報フィールドの名前。設定できる値は
       <literal>Keywords</literal>、<literal>Subject</literal>、
       <literal>Title</literal>、<literal>Creator</literal>、
       <literal>Author</literal>、<literal>BoundingBox</literal> および
       <literal>Orientation</literal> です。
       このうちのいくつかは、PostScript
       ビューアに対して意味を持つものであることに注意しましょう。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>value</parameter></term>
     <listitem>
      <para>
       情報フィールドの値。
       <literal>Orientation</literal> フィールドには
       <literal>Portrait</literal> あるいは <literal>Landscape</literal>
       が設定できます。<literal>BoundingBox</literal>
       は 4 つの数値からなる文字列で、最初の 2 つがページの左下角の座標を表します。
       残りの 2 つが右上角の座標です。
      </para>
      <note>
       <para>
        pslib のバージョン 0.2.6 まででは、
        <function>ps_findfont</function> が事前にコールされていない限り、
        この関数は常に BoundingBox および Orientation を上書きします。
       </para>
      </note>
     </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_findfont</function></member>
    <member><function>ps_begin_page</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
-->