cvs: phpdoc /en/functions calendar.xml cpdf.xml /ja/functions apache.xml aspell.xml bc.xml bzip2.xml calendar.xml ccvs.xml classobj.xml com.xml
cpdf.xml cybercash.xml

From: Date: Mon, 14 Jan 2002 15:48:02 +0000
Subject: cvs: phpdoc /en/functions calendar.xml cpdf.xml /ja/functions apache.xml aspell.xml bc.xml bzip2.xml calendar.xml ccvs.xml classobj.xml com.xml
cpdf.xml cybercash.xml
Groups: php.doc 
Request: Send a blank email to phpdoc+get-969341198@lists.php.net to get a copy of this message
hirokawa Mon Jan 14 10:48:02 2002 EDT Modified files: /phpdoc/en/functions calendar.xml cpdf.xml /phpdoc/ja/functions apache.xml aspell.xml bc.xml bzip2.xml calendar.xml ccvs.xml classobj.xml com.xml cpdf.xml cybercash.xml Log: translation updated and fixed typos.

Index: phpdoc/en/functions/calendar.xml diff -u phpdoc/en/functions/calendar.xml:1.20 phpdoc/en/functions/calendar.xml:1.21 --- phpdoc/en/functions/calendar.xml:1.20 Tue Dec 18 15:33:59 2001 +++ phpdoc/en/functions/calendar.xml Mon Jan 14 10:47:58 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.20 $ --> +<!-- $Revision: 1.21 $ --> <reference id="ref.calendar"> <title>Calendar functions</title> <titleabbrev>Calendar</titleabbrev> @@ -534,7 +534,7 @@ <parameter>jday</parameter> &lt;= 2465342 ) </para> <para> - See also <function>jdtounix</function>. + See also <function>unixtojd</function>. </para> </refsect1> </refentry> Index: phpdoc/en/functions/cpdf.xml diff -u phpdoc/en/functions/cpdf.xml:1.36 phpdoc/en/functions/cpdf.xml:1.37 --- phpdoc/en/functions/cpdf.xml:1.36 Wed Jan 9 19:26:29 2002 +++ phpdoc/en/functions/cpdf.xml Mon Jan 14 10:47:59 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.36 $ --> +<!-- $Revision: 1.37 $ --> <reference id="ref.cpdf"> <title>ClibPDF functions</title> <titleabbrev>ClibPDF</titleabbrev> @@ -1752,7 +1752,7 @@ </funcprototype> </funcsynopsis> <para> - The <function>cpdf_setgray_stroke</function> function sets the current + The <function>cpdf_setgray</function> function sets the current drawing and filling color to the given gray value. </para> <para> @@ -1913,7 +1913,7 @@ </funcprototype> </funcsynopsis> <para> - The <function>cpdf_setrgbcolor_stroke</function> function sets the current + The <function>cpdf_setrgbcolor</function> function sets the current drawing and filling color to the given rgb color value. </para> <para> Index: phpdoc/ja/functions/apache.xml diff -u phpdoc/ja/functions/apache.xml:1.8 phpdoc/ja/functions/apache.xml:1.9 --- phpdoc/ja/functions/apache.xml:1.8 Wed Dec 12 15:52:43 2001 +++ phpdoc/ja/functions/apache.xml Mon Jan 14 10:48:00 2002 @@ -1,4 +1,5 @@ <?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.9 $ --> <reference id="ref.apache"> <title>Apache用関数</title> <titleabbrev>Apache</titleabbrev> @@ -14,7 +15,7 @@ <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>class <function>apache_lookup_uri</function></funcdef> + <funcdef>object <function>apache_lookup_uri</function></funcdef> <paramdef>string <parameter>filename</parameter></paramdef> </funcprototype> </funcsynopsis> @@ -141,7 +142,7 @@ <refentry id="function.getallheaders"> <refnamediv> <refname>getallheaders</refname> - <refpurpose>全てのHTTPリクエストヘッダを取り出します</refpurpose> + <refpurpose>全てのHTTPリクエストヘッダを取得する</refpurpose> </refnamediv> <refsect1> <title>説明</title> @@ -165,10 +166,12 @@ <example> <title><function>getallheaders</function>の例</title> <programlisting role="php"> +<![CDATA[ $headers = getallheaders(); -while (list($header, $value) = each ($headers)) { - echo "$header: $value&lt;br&gt;\n"; +while (list ($header, $value) = each ($headers)) { + echo "$header: $value<br />\n"; } +]]> </programlisting> </example> この例は、現在のリクエストに関して全てのリクエストヘッダを @@ -187,7 +190,7 @@ <refentry id="function.virtual"> <refnamediv> <refname>virtual</refname> - <refpurpose>Apache サブリクエストを実行します</refpurpose> + <refpurpose>Apacheサブリクエストを実行する</refpurpose> </refnamediv> <refsect1> <title>説明</title> @@ -211,6 +214,55 @@ <function>require</function>を使用する必要があります。 <function>virtual</function>は、PHPファイル自体を読みこむ 際には使用できません。 + </para> + </refsect1> + </refentry> + + <refentry id='function.apache-child-terminate'> + <refnamediv> + <refname>apache_child_terminate</refname> + <refpurpose>このリクエストの後にApacheプロセスを終了する</refpurpose> + </refnamediv> + <refsect1> + <title>説明</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>apache_child_terminate</function></funcdef> + <void/> + </funcprototype> + </funcsynopsis> + <para> + <function>apache_child_terminate</function> は、カレントのPHPリク + エストを実行しているApacheプロセスをリクエスト終了時点で終了しま + す。この関数は、メモリ消費量が大きなスクリプトを実行した後プロセ + スを使用するために使用することが可能です。これは、メモリは通常内 + 部的にのみ解放され、オペレーティングシステムに戻されないためです。 + </para> + <para> + <function>exit</function>も参照下さい。 + </para> + </refsect1> + </refentry> + + <refentry id='function.apache-setenv'> + <refnamediv> + <refname>apache_setenv</refname> + <refpurpose>Apacheサブプロセスの環境変数を設定する</refpurpose> + </refnamediv> + <refsect1> + <title>説明</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>apache_setenv</function></funcdef> + <paramdef>string <parameter>variable</parameter></paramdef> + <paramdef>string <parameter>value</parameter></paramdef> + <paramdef>bool + <parameter><optional>walk_to_top</optional></parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + <para> + &warn.undocumented.func; </para> </refsect1> </refentry> Index: phpdoc/ja/functions/aspell.xml diff -u phpdoc/ja/functions/aspell.xml:1.8 phpdoc/ja/functions/aspell.xml:1.9 --- phpdoc/ja/functions/aspell.xml:1.8 Wed Dec 12 15:52:44 2001 +++ phpdoc/ja/functions/aspell.xml Mon Jan 14 10:48:00 2002 @@ -1,6 +1,7 @@ <?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.9 $ --> <reference id="ref.aspell"> - <title>Aspell 関数</title> + <title>Aspell関数(古い拡張モジュール)</title> <titleabbrev>Aspell</titleabbrev> <partintro> @@ -27,7 +28,7 @@ <refentry id="function.aspell-new"> <refnamediv> <refname>aspell_new</refname> - <refpurpose>新しい辞書をロードする</refpurpose> + <refpurpose>新しい辞書をロードする [古い関数]</refpurpose> </refnamediv> <refsect1> <title>説明</title> @@ -35,18 +36,23 @@ <funcprototype> <funcdef>int <function>aspell_new</function></funcdef> <paramdef>string <parameter>master</parameter></paramdef> - <paramdef>string <parameter>personal</parameter></paramdef> + <paramdef>string + <parameter><optional>personal</optional></parameter> + </paramdef> </funcprototype> </funcsynopsis> <simpara> - <function>aspell_new</function> は、新規辞書をオープンし、 - 他の aspell 関数で使用される辞書リンク ID を返します。 + <function>aspell_new</function> は、新規辞書をオープンし、他の + aspell関数で使用される辞書リンクIDを返します。エラー時に&false; + を返します。 </simpara> <para> <example> <title><function>aspell_new</function></title> <programlisting role="php"> -$aspell_link=aspell_new ("english"); +<![CDATA[ +$aspell_link = aspell_new("english"); +]]> </programlisting> </example> </para> @@ -56,7 +62,7 @@ <refentry id="function.aspell-check"> <refnamediv> <refname>aspell_check</refname> - <refpurpose>単語をチェックする</refpurpose> + <refpurpose>単語をチェックする [古い関数]</refpurpose> </refnamediv> <refsect1> <title>説明</title> @@ -69,18 +75,21 @@ </funcsynopsis> <simpara> <function>aspell_check</function> は単語のスペルをチェックし、 - スペルが正しい場合には&true; 、そうでない場合は&false;を返します。 + スペルが正しい場合には&true;、そうでない場合は&false;を返します。 </simpara> <para> <example> <title><function>aspell_check</function></title> - <programlisting role="php"> -$aspell_link=aspell_new ("english"); -if (aspell_check ($aspell_link,"testt")) { + <programlisting> +<![CDATA[ +$aspell_link = aspell_new("english"); + +if (aspell_check($aspell_link, "testt")) { echo "This is a valid spelling"; } else { echo "Sorry, wrong spelling"; } +]]> </programlisting> </example> </para> @@ -98,7 +107,7 @@ <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>boolean <function>aspell_check_raw</function></funcdef> + <funcdef>bool <function>aspell_check_raw</function></funcdef> <paramdef>int <parameter>dictionary_link</parameter></paramdef> <paramdef>string <parameter>word</parameter></paramdef> </funcprototype> @@ -112,12 +121,15 @@ <example> <title><function>aspell_check_raw</function></title> <programlisting role="php"> -$aspell_link=aspell_new ("english"); -if (aspell_check_raw ($aspell_link,"test")) { +<![CDATA[ +$aspell_link = aspell_new("english"); + +if (aspell_check_raw($aspell_link, "test")) { echo "This is a valid spelling"; } else { echo "Sorry, wrong spelling"; } +]]> </programlisting> </example> </para> @@ -127,7 +139,7 @@ <refentry id="function.aspell-suggest"> <refnamediv> <refname>aspell_suggest</refname> - <refpurpose>単語スペルの修正案を示す</refpurpose> + <refpurpose>単語スペルの修正案を示す [古い関数]</refpurpose> </refnamediv> <refsect1> <title>説明</title> @@ -146,15 +158,17 @@ <example> <title><function>aspell_suggest</function></title> <programlisting role="php"> -$aspell_link=aspell_new ("english"); +<![CDATA[ +$aspell_link = aspell_new("english"); -if (!aspell_check ($aspell_link,"test")) { - $suggestions=aspell_suggest ($aspell_link,"test"); +if (!aspell_check($aspell_link, "test")) { + $suggestions = aspell_suggest($aspell_link, "test"); - for($i=0; $i &lt; count ($suggestions); $i++) { - echo "Possible spelling: " . $suggestions[$i] . "&lt;br>"; + foreach ($suggestions as $suggestion) { + echo "Possible spelling: $suggestion<br>\n"; } } +]]> </programlisting> </example> </para> Index: phpdoc/ja/functions/bc.xml diff -u phpdoc/ja/functions/bc.xml:1.8 phpdoc/ja/functions/bc.xml:1.9 --- phpdoc/ja/functions/bc.xml:1.8 Wed Dec 12 15:52:45 2001 +++ phpdoc/ja/functions/bc.xml Mon Jan 14 10:48:00 2002 @@ -1,4 +1,5 @@ <?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.9 $ --> <reference id="ref.bc"> <title>BCMath任意精度数学関数</title> <titleabbrev>BC math</titleabbrev> Index: phpdoc/ja/functions/bzip2.xml diff -u phpdoc/ja/functions/bzip2.xml:1.10 phpdoc/ja/functions/bzip2.xml:1.11 --- phpdoc/ja/functions/bzip2.xml:1.10 Mon Jan 14 04:56:35 2002 +++ phpdoc/ja/functions/bzip2.xml Mon Jan 14 10:48:00 2002 @@ -1,4 +1,5 @@ <?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.11 $ --> <reference id="ref.bzip2"> <title>Bzip2 圧縮関数</title> <titleabbrev>Bzip2</titleabbrev> Index: phpdoc/ja/functions/calendar.xml diff -u phpdoc/ja/functions/calendar.xml:1.11 phpdoc/ja/functions/calendar.xml:1.12 --- phpdoc/ja/functions/calendar.xml:1.11 Wed Dec 12 15:52:45 2001 +++ phpdoc/ja/functions/calendar.xml Mon Jan 14 10:48:00 2002 @@ -1,4 +1,5 @@ <?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.12 $ --> <reference id="ref.calendar"> <title>カレンダー関数</title> <titleabbrev>カレンダー</titleabbrev> @@ -7,7 +8,7 @@ <para> カレンダー関数は、PHPソースコードのサブディレクトリ"dl"または"ext" にあるカレンダー拡張をコンパイルした場合にのみ利用可能です。使用法 - については、dl/READMEの指示を参照下さい。 + については、READMEファイルを参照下さい。 </para> <para> カレンダー関数は、異なったカレンダーフォーマット間の変換を @@ -75,12 +76,14 @@ <example> <title>カレンダー関数</title> <programlisting role="php"> -&lt;?php +<![CDATA[ +<?php $jd = GregorianToJD (10,11,1970); -echo("$jd\n"); +echo "$jd\n"; $gregorian = JDToGregorian ($jd); -echo("$gregorian\n"); +echo "$gregorian\n"; ?> +]]> </programlisting> </example> </para> @@ -180,8 +183,6 @@ <para> このソフトウェアでは1年(紀元前3761年)に遡って全ての日々を扱うこと が出来ますが、この様な使い方は特に意味があるわけではありません。 - </para> - <para> ユダヤ暦は数千年に渡って使われていますが、当初は月の 始まりが決められていませんでいた。新しい月は新月が最初に観測 された日に始まりました。 @@ -258,37 +259,44 @@ どんなタイプの月名を返すを関数に伝えます。 <table> <title>暦モード</title> - <tgroup cols="2"> + <tgroup cols="3"> <thead> <row> <entry>モード</entry> <entry>意味</entry> + <entry>値</entry> </row> </thead> <tbody> <row> <entry>0</entry> <entry>グレゴリウス暦 - 省略形</entry> + <entry>Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec</entry> </row> <row> <entry>1</entry> <entry>グレゴリウス暦</entry> + <entry>January, February, March, April, May, June, July, August, September, October, November, December</entry> </row> <row> <entry>2</entry> <entry>ユリウス暦 - 省略形</entry> + <entry>Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec</entry> </row> <row> <entry>3</entry> <entry>ユリウス暦</entry> + <entry>January, February, March, April, May, June, July, August, September, October, November, December</entry> </row> <row> <entry>4</entry> <entry>ユダヤ暦</entry> + <entry>Tishri, Heshvan, Kislev, Tevet, Shevat, AdarI, AdarII, Nisan, Iyyar, Sivan, Tammuz, Av, Elul</entry> </row> <row> <entry>5</entry> <entry>フランス革命暦</entry> + <entry>Vendemiaire, Brumaire, Frimaire, Nivose, Pluviose, Ventose, Germinal, Floreal, Prairial, Messidor, Thermidor, Fructidor, Extra</entry> </row> </tbody> </tgroup> @@ -374,9 +382,11 @@ <example> <title><function>easter_date</function>の例</title> <programlisting role="php"> -echo date ( "M-d-Y", easter_date(1999)); /* "1999/4/04" */ -echo date ( "M-d-Y", easter_date(2000)); /* "2000/4/23" */ -echo date ( "M-d-Y", easter_date(2001)); /* "2001/4/15" */ +<![CDATA[ +echo date ("M-d-Y", easter_date(1999)); /* "Apr-04-1999" */ +echo date ("M-d-Y", easter_date(2000)); /* "Apr-23-2000" */ +echo date ("M-d-Y", easter_date(2001)); /* "Apr-15-2001" */ +]]> </programlisting> </example> </para> @@ -407,7 +417,9 @@ <refentry id="function.easter-days"> <refnamediv> <refname>easter_days</refname> - <refpurpose>指定した年において3月21日以降、復活祭までの日数を得る</refpurpose> + <refpurpose> + 指定した年において3月21日以降、復活祭までの日数を得る + </refpurpose> </refnamediv> <refsect1> <title>説明</title> @@ -428,9 +440,11 @@ <example> <title><function>easter_days</function>の例</title> <programlisting role="php"> +<![CDATA[ echo easter_days (1999); /* 14, すなわち 4月4日 */ echo easter_days (1492); /* 32, すなわち 4月22日 */ echo easter_days (1913); /* 2, すなわち 3月23日 */ +]]> </programlisting> </example> </para> @@ -482,11 +496,6 @@ <para> <function>jdtounix</function>も参照下さい。 </para> - <note> - <para> - この関数は、PHP 4RC1以降のバージョンのPHPでのみ利用可能です。 - </para> - </note> </refsect1> </refentry> @@ -511,13 +520,99 @@ の範囲外の場合は&false;を返します。 </para> <para> + <function>unixtojd</function>も参照下さい。 + </para> + </refsect1> + </refentry> + + <refentry id="function.cal-days-in-month"> + <refnamediv> + <refname>cal_days_in_month</refname> + <refpurpose> + 指定した年とカレンダについて日数を返す + calendar + </refpurpose> + </refnamediv> + <refsect1> + <title>説明</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>cal_days_in_month</function></funcdef> + <paramdef>int <parameter>calendar</parameter></paramdef> + <paramdef>int <parameter>month</parameter></paramdef> + <paramdef>int <parameter>year</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + この関数は、指定した<parameter>calendar</parameter>について + <parameter>year</parameter>年<parameter>month</parameter>月の日数 + を返します。 + </para> + <para> <function>jdtounix</function>も参照下さい。 </para> - <note> - <para> - この関数は、PHP 4RC1以降のバージョンのPHPで利用可能です。 - </para> - </note> + </refsect1> + </refentry> + + <refentry id='function.cal-to-jd'> + <refnamediv> + <refname>cal_to_jd</refname> + <refpurpose> + サポートされるカレンダからユリウス積算日に変換する + </refpurpose> + </refnamediv> + <refsect1> + <title>説明</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>cal_to_jd</function></funcdef> + <paramdef>int <parameter>calendar</parameter></paramdef> + <paramdef>int <parameter>month</parameter></paramdef> + <paramdef>int <parameter>day</parameter></paramdef> + <paramdef>int <parameter>year</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + </para> + </refsect1> + </refentry> + + <refentry id='function.cal-from-jd'> + <refnamediv> + <refname>cal_from_jd</refname> + <refpurpose> + ユリウス積算日からサポートされるカレンダに変換し、拡張情報を返す + </refpurpose> + </refnamediv> + <refsect1> + <title>説明</title> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>cal_from_jd</function></funcdef> + <paramdef>int <parameter>jd</parameter></paramdef> + <paramdef>int <parameter>calendar</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + </para> + </refsect1> + </refentry> + + <refentry id='function.cal-info'> + <refnamediv> + <refname>cal_info</refname> + <refpurpose>特定のカレンダに関する情報を返す</refpurpose> + </refnamediv> + <refsect1> + <title>説明</title> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>cal_info</function></funcdef> + <paramdef>int <parameter>calendar</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + </para> </refsect1> </refentry> Index: phpdoc/ja/functions/ccvs.xml diff -u phpdoc/ja/functions/ccvs.xml:1.3 phpdoc/ja/functions/ccvs.xml:1.4 --- phpdoc/ja/functions/ccvs.xml:1.3 Wed Dec 12 15:52:46 2001 +++ phpdoc/ja/functions/ccvs.xml Mon Jan 14 10:48:00 2002 @@ -1,4 +1,5 @@ <?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.4 $ --> <!-- CCVS Documentation by Brendan W. McAdams <brendan@plexmedia.com> Copyright (c) 2000 by the PHP Group @@ -56,19 +57,341 @@ </simpara> </partintro> - <refentry> + <refentry id="function.ccvs-init"> <refnamediv> - <refname></refname> - <refpurpose></refpurpose> + <refname>ccvs_init</refname> + <refpurpose>CCVSを初期化する</refpurpose> </refnamediv> <refsect1> - <title></title> + <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef> <function></function></funcdef> - <paramdef> <parameter></parameter></paramdef> + <funcdef>string <function>ccvs_init</function></funcdef> + <paramdef>string <parameter>name</parameter></paramdef> </funcprototype> </funcsynopsis> + <para> + &warn.undocumented.func; + </para> + </refsect1> + </refentry> + + <refentry id="function.ccvs-done"> + <refnamediv> + <refname>ccvs_done</refname> + <refpurpose>CCVSエンジンを終了し、クリアする</refpurpose> + </refnamediv> + <refsect1> + <title>説明</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>ccvs_done</function></funcdef> + <paramdef>string <parameter>sess</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + &warn.undocumented.func; + </para> + </refsect1> + </refentry> + + <refentry id="function.ccvs-new"> + <refnamediv> + <refname>ccvs_new</refname> + <refpurpose>新規に空のトランザクションを生成する</refpurpose> + </refnamediv> + <refsect1> + <title>説明</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>ccvs_new</function></funcdef> + <paramdef>string <parameter>session</parameter></paramdef> + <paramdef>string <parameter>invoice</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + &warn.undocumented.func; + </para> + </refsect1> + </refentry> + + <refentry id="function.ccvs-add"> + <refnamediv> + <refname>ccvs_add</refname> + <refpurpose>トランザクションにデータを追加する</refpurpose> + </refnamediv> + <refsect1> + <title>説明</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>ccvs_add</function></funcdef> + <paramdef>string <parameter>session</parameter></paramdef> + <paramdef>string <parameter>invoice</parameter></paramdef> + <paramdef>string <parameter>argtype</parameter></paramdef> + <paramdef>string <parameter>argval</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + &warn.undocumented.func; + </para> + </refsect1> + </refentry> + + <refentry id="function.ccvs-delete"> + <refnamediv> + <refname>ccvs_delete</refname> + <refpurpose>トランザクションを削除する</refpurpose> + </refnamediv> + <refsect1> + <title>説明</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>ccvs_delete</function></funcdef> + <paramdef>string <parameter>session</parameter></paramdef> + <paramdef>string <parameter>invoice</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + &warn.undocumented.func; + </para> + </refsect1> + </refentry> + + <refentry id="function.ccvs-auth"> + <refnamediv> + <refname>ccvs_auth</refname> + <refpurpose> + あるトランザクションにおいてクレジット認証を行う + </refpurpose> + </refnamediv> + <refsect1> + <title>説明</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>ccvs_auth</function></funcdef> + <paramdef>string <parameter>session</parameter></paramdef> + <paramdef>string <parameter>invoice</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + &warn.undocumented.func; + </para> + </refsect1> + </refentry> + + <refentry id="function.ccvs-return"> + <refnamediv> + <refname>ccvs_return</refname> + <refpurpose> + クレジットカード所有者に店側から金を伝送する + </refpurpose> + </refnamediv> + <refsect1> + <title>説明</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>ccvs_return</function></funcdef> + <paramdef>string <parameter>session</parameter></paramdef> + <paramdef>string <parameter>invoice</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + &warn.undocumented.func; + </para> + </refsect1> + </refentry> + + <refentry id="function.ccvs-reverse"> + <refnamediv> + <refname>ccvs_reverse</refname> + <refpurpose> + 処理済みの認証を完全に取り消す + </refpurpose> + </refnamediv> + <refsect1> + <title>説明</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>ccvs_reverse</function></funcdef> + <paramdef>string <parameter>session</parameter></paramdef> + <paramdef>string <parameter>invoice</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + &warn.undocumented.func; + </para> + </refsect1> + </refentry> + + <refentry id="function.ccvs-sale"> + <refnamediv> + <refname>ccvs_sale</refname> + <refpurpose> + クレジットカード所有者から店側に金を伝送する + </refpurpose> + </refnamediv> + <refsect1> + <title>説明</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>ccvs_sale</function></funcdef> + <paramdef>string <parameter>session</parameter></paramdef> + <paramdef>string <parameter>invoice</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + &warn.undocumented.func; + </para> + </refsect1> + </refentry> + + <refentry id="function.ccvs-void"> + <refnamediv> + <refname>ccvs_void</refname> + <refpurpose> + 完了したトランザクションを完全に取り消す + </refpurpose> + </refnamediv> + <refsect1> + <title>説明</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>ccvs_void</function></funcdef> + <paramdef>string <parameter>session</parameter></paramdef> + <paramdef>string <parameter>invoice</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + &warn.undocumented.func; + </para> + </refsect1> + </refentry> + + <refentry id="function.ccvs-status"> + <refnamediv> + <refname>ccvs_status</refname> + <refpurpose>送付状のステータスを確認する</refpurpose> + </refnamediv> + <refsect1> + <title>説明</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>ccvs_status</function></funcdef> + <paramdef>string <parameter>session</parameter></paramdef> + <paramdef>string <parameter>invoice</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + &warn.undocumented.func; + </para> + </refsect1> + </refentry> + + <refentry id="function.ccvs-count"> + <refnamediv> + <refname>ccvs_count</refname> + <refpurpose> + システムに保存された指定した型のトランザクション数を得る + </refpurpose> + </refnamediv> + <refsect1> + <title>説明</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>ccvs_count</function></funcdef> + <paramdef>string <parameter>session</parameter></paramdef> + <paramdef>string <parameter>type</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + &warn.undocumented.func; + </para> + </refsect1> + </refentry> + + <refentry id="function.ccvs-lookup"> + <refnamediv> + <refname>ccvs_lookup</refname> + <refpurpose> + データベース #にある特定の型の項目を探す + </refpurpose> + </refnamediv> + <refsect1> + <title>説明</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>ccvs_lookup</function></funcdef> + <paramdef>string <parameter>session</parameter></paramdef> + <paramdef>string <parameter>invoice</parameter></paramdef> + <paramdef>int <parameter>inum</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + &warn.undocumented.func; + </para> + </refsect1> + </refentry> + + <refentry id="function.ccvs-report"> + <refnamediv> + <refname>ccvs_report</refname> + <refpurpose>バックグラウン通信プロセスの状態を返す</refpurpose> + </refnamediv> + <refsect1> + <title>説明</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>ccvs_report</function></funcdef> + <paramdef>string <parameter>session</parameter></paramdef> + <paramdef>string <parameter>type</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + &warn.undocumented.func; + </para> + </refsect1> + </refentry> + + <refentry id="function.ccvs-command"> + <refnamediv> + <refname>ccvs_command</refname> + <refpurpose> + 単一のプロトコルに基づく、一般的なCCVS APIで利用できないコマンド + を実行する + </refpurpose> + </refnamediv> + <refsect1> + <title>説明</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>ccvs_command</function></funcdef> + <paramdef>string <parameter>session</parameter></paramdef> + <paramdef>string <parameter>type</parameter></paramdef> + <paramdef>string <parameter>argval</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + &warn.undocumented.func; + </para> + </refsect1> + </refentry> + + <refentry id="function.ccvs-textvalue"> + <refnamediv> + <refname>ccvs_textvalue</refname> + <refpurpose>前の関数コールに関する返り値を取得する</refpurpose> + </refnamediv> + <refsect1> + <title>説明</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>ccvs_textvalue</function></funcdef> + <paramdef>string <parameter>session</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + &warn.undocumented.func; + </para> </refsect1> </refentry> @@ -90,4 +413,7 @@ 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 --> Index: phpdoc/ja/functions/classobj.xml diff -u phpdoc/ja/functions/classobj.xml:1.13 phpdoc/ja/functions/classobj.xml:1.14 --- phpdoc/ja/functions/classobj.xml:1.13 Wed Dec 12 15:52:46 2001 +++ phpdoc/ja/functions/classobj.xml Mon Jan 14 10:48:00 2002 @@ -1,4 +1,5 @@ <?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.14 $ --> <reference id="ref.classobj"> <title>クラス/オブジェクト関数</title> <titleabbrev>クラス/オブジェクト</titleabbrev> @@ -29,7 +30,8 @@ <example> <title>classes.inc</title> <programlisting role="php"> -&lt;?php +<![CDATA[ +<?php // メンバープロパティとメソッドを有する基底クラス class Vegetable { @@ -37,17 +39,17 @@ var $edible; var $color; - function Vegetable( $edible, $color=&quot;green&quot; ) { - $this-&gt;edible = $edible; - $this-&gt;color = $color; + function Vegetable( $edible, $color="green" ) { + $this->edible = $edible; + $this->color = $color; } function is_edible() { - return $this-&gt;edible; + return $this->edible; } function what_color() { - return $this-&gt;color; + return $this->color; } } // クラスVegetableの終り @@ -59,11 +61,11 @@ var $cooked = false; function Spinach() { - $this-&gt;Vegetable( true, &quot;green&quot; ); + $this->Vegetable( true, "green" ); } function cook_it() { - $this-&gt;cooked = true; + $this->cooked = true; } function is_cooked() { @@ -72,7 +74,8 @@ } // クラスSpinachの終り -?&gt; +?> +]]> </programlisting> </example> </para> @@ -86,58 +89,60 @@ <example> <title>test_script.php</title> <programlisting role="php"> -&lt;pre&gt; -&lt;?php +<![CDATA[ +<pre> +<?php -include &quot;classes.inc&quot;; +include "classes.inc"; // ユーティリティ関数 function print_vars($obj) { $arr = get_object_vars($obj); while (list($prop, $val) = each($arr)) - echo &quot;\t$prop = $val\n&quot;; + echo "\t$prop = $val\n"; } function print_methods($obj) { $arr = get_class_methods(get_class($obj)); foreach ($arr as $method) - echo &quot;\tfunction $method()\n&quot;; + echo "\tfunction $method()\n"; } function class_parentage($obj, $class) { global $$obj; if (is_subclass_of($$obj, $class)) { - echo &quot;Object $obj belongs to class &quot;.get_class($$obj); - echo &quot; a subclass of $class\n&quot;; + echo "Object $obj belongs to class ".get_class($$obj); + echo " a subclass of $class\n"; } else { - echo &quot;Object $obj does not belong to a subclass of $class\n&quot;; + echo "Object $obj does not belong to a subclass of $class\n"; } } // 二つのオブジェクトのインスタンスを作成 -$veggie = new Vegetable(true,&quot;blue&quot;); +$veggie = new Vegetable(true,"blue"); $leafy = new Spinach(); // オブジェクトに関する情報を出力 -echo &quot;veggie: CLASS &quot;.get_class($veggie).&quot;\n&quot;; -echo &quot;leafy: CLASS &quot;.get_class($leafy); -echo &quot;, PARENT &quot;.get_parent_class($leafy).&quot;\n&quot;; +echo "veggie: CLASS ".get_class($veggie)."\n"; +echo "leafy: CLASS ".get_class($leafy); +echo " PARENT ".get_parent_class($leafy)."\n"; // veggieのプロパティを表示 -echo &quot;\nveggie: Properties\n&quot;; +echo "\nveggie: プロパティ\n"; print_vars($veggie); // そしてleafyのメソッドを表示 -echo &quot;\nleafy: Methods\n&quot;; +echo "\nleafy: メソッド\n"; print_methods($leafy); -echo &quot;\nParentage:\n&quot;; -class_parentage(&quot;leafy&quot;, &quot;Spinach&quot;); -class_parentage(&quot;leafy&quot;, &quot;Vegetable&quot;); -?&gt; -&lt;/pre&gt; +echo "\nParentage:\n"; +class_parentage("leafy", "Spinach"); +class_parentage("leafy", "Vegetable"); +?> +</pre> +]]> </programlisting> </example> </para> @@ -151,10 +156,12 @@ <para> <informalexample> <programlisting> +<![CDATA[ [...] Parentage: Object leafy does not belong to a subclass of Spinach Object leafy belongs to class spinach a subclass of Vegetable +]]> </programlisting> </informalexample> </para> @@ -247,30 +254,32 @@ そのクラスのメソッド<varname>print_info</varname>をコールします。 <informalexample> <programlisting role="php"> -&lt;?php +<![CDATA[ +<?php class Country { - var $NAME; - var $TLD; - - function Country($name, $tld) { - $this-&gt;NAME = $name; - $this-&gt;TLD = $tld; - } + var $NAME; + var $TLD; + + function Country($name, $tld) { + $this->NAME = $name; + $this->TLD = $tld; + } - function print_info($prestr=&quot;&quot;) { - echo $prestr.&quot;Country: &quot;.$this-&gt;NAME.&quot;\n&quot;; - echo $prestr.&quot;Top Level Domain: &quot;.$this-&gt;TLD.&quot;\n&quot;; - } + function print_info($prestr="") { + echo $prestr."Country: ".$this->NAME."\n"; + echo $prestr."Top Level Domain: ".$this->TLD."\n"; + } } -$cntry = new Country(&quot;Peru&quot;,&quot;pe&quot;); +$cntry = new Country("Peru","pe"); -echo &quot;* Calling the object method directly\n&quot;; -$cntry-&gt;print_info(); +echo "* Calling the object method directly\n"; +$cntry->print_info(); -echo &quot;\n* Calling the same method indirectly\n&quot;; -call_user_method (&quot;print_info&quot;, $cntry, &quot;\t&quot;); -?&gt; +echo "\n* Calling the same method indirectly\n"; +call_user_method ("print_info", $cntry, "\t"); +?> +]]> </programlisting> </informalexample> </para> @@ -321,6 +330,7 @@ </para> <simpara> <function>get_parent_class</function>、 + <function>get_type</function>、 <function>is_subclass_of</function>も参照下さい。 </simpara> </refsect1> @@ -349,7 +359,9 @@ オブジェクト自身を指定することが可能です。例えば、 <informalexample> <programlisting> +<![CDATA[ $class_methods = get_class_methods($my_class); +]]> </programlisting> </informalexample> </para> @@ -358,7 +370,8 @@ <example> <title><function>get_class_methods</function>の例</title> <programlisting role="php"> -&lt;?php +<![CDATA[ +<?php class myclass { // コンストラクタ @@ -385,7 +398,8 @@ echo "$method_name\n"; } -?&gt; +?> +]]> </programlisting> </example> </para> @@ -393,9 +407,11 @@ 上の例の出力は次のようになります。 <informalexample> <programlisting> +<![CDATA[ myclass myfunc1 myfunc2 +]]> </programlisting> </informalexample> </para> @@ -436,7 +452,8 @@ <example> <title><function>get_class_vars</function> の例</title> <programlisting role="php"> -&lt;?php +<![CDATA[ +<?php class myclass { @@ -459,7 +476,8 @@ echo "$name : $value\n"; } -?&gt; +?> +]]> </programlisting> </example> </para> @@ -467,8 +485,10 @@ この例の出力は次のようになります。 <informalexample> <programlisting> +<![CDATA[ var2 : xyz var3 : 100 +]]> </programlisting> </informalexample> </para> @@ -489,7 +509,7 @@ <funcsynopsis> <funcprototype> <funcdef>array <function>get_declared_classes</function></funcdef> - <paramdef>void</paramdef> + <void/> </funcprototype> </funcsynopsis> <para> @@ -499,10 +519,16 @@ <note> <para> PHP 4.0.1pl2では、この他に次の3つのクラスが配列の先頭に返されま - す。: <varname>stdClass</varname> (Zend/zend.cで定義)、 + す。: <varname>stdClass</varname> + (<filename>Zend/zend.c</filename>で定義)、 <varname>OverloadedTestClass</varname> - (ext/standard/basic_functions.cで定義)、<varname>Directory</varname> - (ext/standard/dir.cで定義) + (<filename>ext/standard/basic_functions.c</filename>で定義)、 + <varname>Directory</varname> + (<filename>ext/standard/dir.c</filename>で定義) + </para> + <para> + PHPにコンパイルされているライブラリの種類に依存して、他のクラス + も存在する可能性があることにも注意して下さい。 </para> </note> </refsect1> @@ -531,24 +557,25 @@ <example> <title><function>get_object_vars</function>の使用例</title> <programlisting role="php"> -&lt;?php +<![CDATA[ +<?php class Point2D { var $x, $y; var $label; function Point2D($x, $y) { - $this-&gt;x = $x; - $this-&gt;y = $y; + $this->x = $x; + $this->y = $y; } function setLabel($label) { - $this-&gt;label = $label; + $this->label = $label; } function getPoint() { - return array("x" =&gt; $this-&gt;x, - "y" =&gt; $this-&gt;y, - "label" =&gt; $this-&gt;label); + return array("x" => $this->x, + "y" => $this->y, + "label" => $this->label); } } @@ -557,20 +584,21 @@ // "$label" は宣言されていますが、未定義です。 // Array // ( -// [x] =&gt; 1.233 -// [y] =&gt; 3.445 +// [x] => 1.233 +// [y] => 3.445 // ) -$p1-&gt;setLabel("point #1"); +$p1->setLabel("point #1"); print_r(get_object_vars($p1)); // Array // ( -// [x] =&gt; 1.233 -// [y] =&gt; 3.445 -// [label] =&gt; point #1 +// [x] => 1.233 +// [y] => 3.445 +// [label] => point #1 // ) -?&gt; +?> +]]> </programlisting> </example> </para> @@ -591,12 +619,17 @@ <funcsynopsis> <funcprototype> <funcdef>string <function>get_parent_class</function></funcdef> - <paramdef>object <parameter>obj</parameter></paramdef> + <paramdef>mixed <parameter>obj</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - この関数は、<parameter>obj</parameter>がインスタンスであるクラス - の親クラスの名前を返します。 + <parameter>obj</parameter>がオブジェクトの場合、 + <parameter>obj</parameter>がインスタンスであるクラスの親クラスの + 名前を返します。 + </para> + <para> + <parameter>obj</parameter>が文字列の場合、これを名前とするクラス + の親クラスの名前を返します。この機能は、PHP 4.0.5で追加されました。 </para> <simpara> <function>get_class</function>、 Index: phpdoc/ja/functions/com.xml diff -u phpdoc/ja/functions/com.xml:1.10 phpdoc/ja/functions/com.xml:1.11 --- phpdoc/ja/functions/com.xml:1.10 Wed Dec 12 15:52:46 2001 +++ phpdoc/ja/functions/com.xml Mon Jan 14 10:48:00 2002 @@ -1,14 +1,32 @@ <?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.11 $ --> <reference id="ref.com"> <title>Windows用のCOMサポート関数</title> <titleabbrev>COM</titleabbrev> - - <partintro> + + <partintro> + <simpara> + COMは、標準化された呼び出し規約及びコンポーネントが保存されている + マシンや実行ファイルが存在するマシンの種類の実装の詳細をAPIの背後 + に隠蔽することにより、(あらゆる言語により)あらゆる言語で書かれたコー + ドを再使用することを可能とする技術です。COMは、いくつかの基本的な + オブジェクトルートを有する特別なRemote Procedure Call (RPC)機構と + 考えることができる。COMは、実装をインターフェイスから分離します。 + </simpara> + <simpara> + COMは、バージョン管理、インターフェイスからの実装の分離、実行ファ + イルの位置や記述される言語のような実装の詳細の隠蔽を推奨します。 + </simpara> + <simpara> + COM関数は、PHPのWindowsバージョンでのみ利用可能です。 + </simpara> <simpara> - 以下の関数は、Windows版のPHPでのみ利用可能です。これらの関数は、 - PHP4で追加されました。 - </simpara> - </partintro> + COMに関するより詳細な情報については、<ulink + url="&url.comspecs;">COM規約</ulink>またはDon Boxの + <ulink url="&url.yacl;"> Yet Another COM Library (YACL)</ulink>を + 参照下さい。 + </simpara> + </partintro> <refentry id="class.com"> <refnamediv> @@ -81,6 +99,7 @@ <example id="example.com1"> <title>COM の例 (1)</title> <programlisting role="php"> +<![CDATA[ // Wordを起動 $word = new COM("word.application") or die("Unable to instanciate Word"); print "Loaded Word, version {$word->Version}\n"; @@ -101,6 +120,7 @@ // オブジェクトを開放 $word->Release(); $word = null; +]]> </programlisting> </example> </para> @@ -108,6 +128,7 @@ <example id="example.com2"> <title>COM の例 (2)</title> <programlisting role="php"> +<![CDATA[ $conn = new COM("ADODB.Connection") or die("Cannot start ADO"); $conn->Open("Provider=SQLOLEDB; Data Source=localhost; Initial Catalog=database; User ID=user; Password=password"); @@ -117,7 +138,7 @@ $num_columns = $rs->Fields->Count(); echo $num_columns . "\n"; -for ($i=0; $i &lt; $num_columns; $i++) +for ($i=0; $i < $num_columns; $i++) { $fld[$i] = $rs->Fields($i); } @@ -125,7 +146,7 @@ $rowcount = 0; while (!$rs->EOF) { - for ($i=0; $i &lt; $num_columns; $i++) + for ($i=0; $i < $num_columns; $i++) { echo $fld[$i]->value . "\t"; } @@ -142,6 +163,7 @@ $rs = null; $conn = null; +]]> </programlisting> </example> </para> @@ -455,6 +477,47 @@ </funcsynopsis> <para> コンポーネントリファレンスカウンタを減らします。 + </para> + </refsect1> + </refentry> + + <refentry id='function.com-isenum'> + <refnamediv> + <refname>com_isenum</refname> + <refpurpose>IEnumVariantを取得する</refpurpose> + </refnamediv> + <refsect1> + <title>説明</title> + <funcsynopsis> + <funcprototype> + <funcdef>void <function>com_isenum</function></funcdef> + <paramdef>object <parameter>com_module</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + &warn.undocumented.func; + </para> + </refsect1> + </refentry> + + <refentry id='function.com-load-typelib'> + <refnamediv> + <refname>com_load_typelib</refname> + <refpurpose>Typelibをロードする</refpurpose> + </refnamediv> + <refsect1> + <title>説明</title> + <funcsynopsis> + <funcprototype> + <funcdef>void <function>com_load_typelib</function></funcdef> + <paramdef>string <parameter>typelib_name</parameter></paramdef> + <paramdef>int + <parameter><optional>case_insensitive</optional></parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + <para> + &warn.undocumented.func; </para> </refsect1> </refentry> Index: phpdoc/ja/functions/cpdf.xml diff -u phpdoc/ja/functions/cpdf.xml:1.18 phpdoc/ja/functions/cpdf.xml:1.19 --- phpdoc/ja/functions/cpdf.xml:1.18 Wed Dec 12 15:52:47 2001 +++ phpdoc/ja/functions/cpdf.xml Mon Jan 14 10:48:00 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="utf-8"?> - +<!-- $Revision: 1.19 $ --> <reference id="ref.cpdf"> <title>ClibPDF 関数</title> <titleabbrev>ClibPDF</titleabbrev> @@ -73,7 +73,8 @@ <example> <title>簡単な ClibPDF の例</title> <programlisting role="php"> -&lt;?php +<![CDATA[ +<?php $cpdf = cpdf_open(0); cpdf_page_init($cpdf, 1, 0, 595, 842); cpdf_add_outline($cpdf, 0, 0, 0, 1, "Page 1"); @@ -90,6 +91,7 @@ cpdf_output_buffer($cpdf); cpdf_close($cpdf); ?> +]]> </programlisting> </example> <simpara> @@ -99,8 +101,9 @@ </simpara> <example> <title>pdflib 2.0 配布ファイルからの pdfclock の例</title> - <programlisting role="php"> -&lt;?php + <programlisting> +<![CDATA[ +<?php $radius = 200; $margin = 20; $pagecount = 40; @@ -118,7 +121,7 @@ cpdf_save($pdf); cpdf_setrgbcolor($pdf, 0.0, 0.0, 1.0); - /* 1分ずつ進む */ + /* minute strokes */ cpdf_setlinewidth($pdf, 2.0); for ($alpha = 0; $alpha &lt; 360; $alpha += 6) { @@ -131,7 +134,7 @@ cpdf_restore($pdf); cpdf_save($pdf); - /* 5 分ずつ進む */ + /* 5 minute strokes */ cpdf_setlinewidth($pdf, 3.0); for ($alpha = 0; $alpha &lt; 360; $alpha += 30) { @@ -143,7 +146,7 @@ $ltime = getdate(); - /* 時針を描く */ + /* draw hour hand */ cpdf_save($pdf); cpdf_rotate($pdf, -(($ltime['minutes']/60.0) + $ltime['hours'] - 3.0) * 30.0); cpdf_moveto($pdf, -$radius/10, -$radius/20); @@ -153,7 +156,7 @@ cpdf_fill($pdf); cpdf_restore($pdf); - /* 分針を描く */ + /* draw minute hand */ cpdf_save($pdf); cpdf_rotate($pdf, -(($ltime['seconds']/60.0) + $ltime['minutes'] - 15.0) * 6.0); cpdf_moveto($pdf, -$radius/10, -$radius/20); @@ -163,7 +166,7 @@ cpdf_fill($pdf); cpdf_restore($pdf); - /* 秒針を描く */ + /* draw second hand */ cpdf_setrgbcolor($pdf, 1.0, 0.0, 0.0); cpdf_setlinewidth($pdf, 2); cpdf_save($pdf); @@ -173,7 +176,7 @@ cpdf_stroke($pdf); cpdf_restore($pdf); - /* 中心に小さな円を描く */ + /* draw little circle at center */ cpdf_circle($pdf, 0, 0, $radius/30); cpdf_fill($pdf); @@ -187,182 +190,224 @@ cpdf_output_buffer($pdf); cpdf_close($pdf); ?> +]]> </programlisting> </example> </partintro> - - <refentry id="function.cpdf-global-set-document-limits"> + + <refentry id="function.cpdf-add-annotation"> <refnamediv> - <refname>cpdf_global_set_document_limits</refname> - <refpurpose>PDFドキュメントの制限を設定する</refpurpose> + <refname>cpdf_add_annotation</refname> + <refpurpose>注記を追加する</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_global_set_document_limits</function></funcdef> - <paramdef>int <parameter>maxpages</parameter></paramdef> - <paramdef>int <parameter>maxfonts</parameter></paramdef> - <paramdef>int <parameter>maximages</parameter></paramdef> - <paramdef>int <parameter>maxannotations</parameter></paramdef> - <paramdef>int <parameter>maxobjects</parameter></paramdef> + <funcdef>void <function>cpdf_add_annotation</function></funcdef> + <paramdef>int <parameter>pdf document</parameter></paramdef> + <paramdef>float <parameter>llx</parameter></paramdef> + <paramdef>float <parameter>lly</parameter></paramdef> + <paramdef>float <parameter>urx</parameter></paramdef> + <paramdef>float <parameter>ury</parameter></paramdef> + <paramdef>string <parameter>title</parameter></paramdef> + <paramdef>string <parameter>content</parameter></paramdef> + <paramdef>int + <parameter> + <replaceable><optional>mode</optional></replaceable> + </parameter> + </paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_global_set_document_limits</function> 関数は複数の - ドキュメントの制限を設定します。この関数を使用する際には、 - <function>cpdf_open</function>の前にコールする必要があります。こ - の関数は、この後オープンする全てのドキュメントに制限を設定します。 + <function>cpdf_add_annotation</function> は、左下隅を + (<parameter>llx</parameter>, <parameter>lly</parameter>) 、右上隅 + を(<parameter>urx</parameter>, <parameter>ury</parameter>) とする + 注記を追加します。 </para> <para> - <function>cpdf_open</function>も参照下さい。 + 最後のオプションのパラメータ <parameter>mode</parameter> は単位長 + さを定義します。0 または指定しなかった場合、そのページに指定され + たデフォルトの単位が使用されます。デフォルトの単位が指定されてい + ない場合は、座標はポストスクリプトポイントで計られます。 </para> </refsect1> </refentry> - - <refentry id="function.cpdf-set-creator"> + + <refentry id="function.cpdf-add-outline"> <refnamediv> - <refname>cpdf_set_creator</refname> - <refpurpose>pdf ドキュメントの creator フィールドを設定する</refpurpose> + <refname>cpdf_add_outline</refname> + <refpurpose>現在のページにブックマークを追加する</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_set_creator</function></funcdef> - <paramdef>string <parameter>creator</parameter></paramdef> + <funcdef>void <function>cpdf_add_outline</function></funcdef> + <paramdef>int <parameter>pdf document</parameter></paramdef> + <paramdef>string <parameter>text</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_set_creator</function> 関数は、pdf ドキュメントの - creator を設定します。 - </para> - <para> - <function>cpdf_set_subject</function>, - <function>cpdf_set_title</function>, - <function>cpdf_set_keywords</function> - も参照下さい。 + <function>cpdf_add_outline</function> 関数は、テキスト + <parameter>text</parameter> により、現在のページを指すブックマー + クを設定します。 + <example> + <title>ページアウトラインの追加</title> + <programlisting role="php"> +<![CDATA[ +<?php +$cpdf = cpdf_open(0); +cpdf_page_init($cpdf, 1, 0, 595, 842); +cpdf_add_outline($cpdf, 0, 0, 0, 1, "Page 1"); +// ... +// some drawing +// ... +cpdf_finalize($cpdf); +Header("Content-type: application/pdf"); +cpdf_output_buffer($cpdf); +cpdf_close($cpdf); +?> +]]> + </programlisting> + <para> + </para> + </example> </para> </refsect1> </refentry> - <refentry id="function.cpdf-set-title"> + <refentry id="function.cpdf-arc"> <refnamediv> - <refname>cpdf_set_title</refname> - <refpurpose>pdf ドキュメントの title フィールドを設定する</refpurpose> + <refname>cpdf_arc</refname> + <refpurpose>円弧を描く</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_set_title</function></funcdef> - <paramdef>string <parameter>title</parameter></paramdef> + <funcdef>void <function>cpdf_arc</function></funcdef> + <paramdef>int <parameter>pdf document</parameter></paramdef> + <paramdef>float <parameter>x-coor</parameter></paramdef> + <paramdef>float <parameter>y-coor</parameter></paramdef> + <paramdef>float <parameter>radius</parameter></paramdef> + <paramdef>float <parameter>start</parameter></paramdef> + <paramdef>float <parameter>end</parameter></paramdef> + <paramdef>int <parameter>mode</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_set_title</function> 関数は、pdfドキュメントの - title を設定します。 + <function>cpdf_arc</function> 関数は、 + (<parameter>x-coor</parameter>, <parameter>y-coor</parameter>) + を中心として半径 <parameter>radius</parameter>、 + 角度 <parameter>start</parameter> から、角度 + <parameter>end</parameter> までの円弧を描きます。 </para> <para> - <function>cpdf_set_subject</function>, - <function>cpdf_set_creator</function>, - <function>cpdf_set_keywords</function> - も参照下さい。 + 最後のオプションのパラメータ <parameter>mode</parameter> は + 単位長さを定義します。 + 0 または指定しなかった場合、そのページに指定されたデフォルトの単位が + 使用されます。 + デフォルトの単位が指定されていない場合は、座標はポストスクリプト + ポイントで計られます。 + </para> + <para> + <function>cpdf_circle</function> も参照下さい。 </para> </refsect1> </refentry> - <refentry id="function.cpdf-set-subject"> + <refentry id="function.cpdf-begin-text"> <refnamediv> - <refname>cpdf_set_subject</refname> - <refpurpose>pdfドキュメントのsubject フィールドを設定する</refpurpose> + <refname>cpdf_begin_text</refname> + <refpurpose>テキストセクションを開始する</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_set_subject</function></funcdef> - <paramdef>string <parameter>subject</parameter></paramdef> + <funcdef>void <function>cpdf_begin_text</function></funcdef> + <paramdef>int <parameter>pdf document</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_set_subject</function> 関数は、pdf ドキュメントの - subject を設定します。 + <function>cpdf_begin_text</function> 関数はテキストセクションを + 開始します。テキストセクションは、<function>cpdf_end_text</function> + で終了する必要があります。 + <example> + <title>テキスト出力</title> + <programlisting> +<![CDATA[ +<?php +cpdf_begin_text($pdf); +cpdf_set_font($pdf, 16, "Helvetica", "WinAnsiEncoding"); +cpdf_text($pdf, 100, 100, "Some text"); +cpdf_end_text($pdf) +?> +]]> + </programlisting> + </example> </para> <para> - <function>cpdf_set_title</function>, - <function>cpdf_set_creator</function>, - <function>cpdf_set_keywords</function> も参照下さい。 + <function>cpdf_end_text</function> も参照下さい。 </para> </refsect1> </refentry> - - <refentry id="function.cpdf-set-keywords"> + + <refentry id="function.cpdf-circle"> <refnamediv> - <refname>cpdf_set_keywords</refname> - <refpurpose>pdfドキュメントのkeywords フィールドを設定する</refpurpose> + <refname>cpdf_circle</refname> + <refpurpose>円を描く</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_set_keywords</function></funcdef> - <paramdef>string <parameter>keywords</parameter></paramdef> + <funcdef>void <function>cpdf_circle</function></funcdef> + <paramdef>int <parameter>pdf document</parameter></paramdef> + <paramdef>float <parameter>x-coor</parameter></paramdef> + <paramdef>float <parameter>y-coor</parameter></paramdef> + <paramdef>float <parameter>radius</parameter></paramdef> + <paramdef>int + <parameter><optional>mode</optional></parameter> + </paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_set_keywords</function> 関数は、pdfドキュメントの - keywords を設定します。 + <function>cpdf_circle</function> 関数は、 + (<parameter>x-coor</parameter>, <parameter>y-coor</parameter>) + を中心として半径 <parameter>radius</parameter> の円を描きます。 </para> <para> - <function>cpdf_set_title</function>, - <function>cpdf_set_creator</function>, - <function>cpdf_set_subject</function>も参照下さい。 + 最後のオプションのパラメータ <parameter>mode</parameter> は + 単位長さを定義します。 + 0 または指定しなかった場合、そのページに指定されたデフォルトの単位が + 使用されます。 + デフォルトの単位が指定されていない場合は、座標はポストスクリプト + ポイントで計られます。 + </para> + <para> + <function>cpdf_arc</function> も参照下さい。 </para> </refsect1> </refentry> - <refentry id="function.cpdf-open"> + <refentry id="function.cpdf-clip"> <refnamediv> - <refname>cpdf_open</refname> - <refpurpose>新規pdfドキュメントをオープンする</refpurpose> + <refname>cpdf_clip</refname> + <refpurpose>カレントのパスを切り取る</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>int <function>cpdf_open</function></funcdef> - <paramdef>int <parameter>compression</parameter></paramdef> - <paramdef>string <parameter>filename</parameter></paramdef> + <funcdef>void <function>cpdf_clip</function></funcdef> + <paramdef>int <parameter>pdf document</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_open</function> 関数は新規pdfドキュメントをオープ - ンします。最初の引数が0 以外である場合、ドキュメントの圧縮がオン - となります。オプションの2番目のパラメータには、ドキュメントを書き - こむファイルを設定します。これを省略した場合、ドキュメントはメモ - リー上に作成され、<function>cpdf_save_to_file</function> によりファ - イルに書きこむか、 <function>cpdf_output_buffer</function> により - 標準出力に書き込むかのどちらかの処理を行うことができます。 - <note> - <simpara> - 返り値は、pdfドキュメントを書きこむ他の全ての関数の最初の引数 - として将来のバージョンの ClipPDF では必要になることでしょう。 - </simpara> - <simpara> - ClibPDF ライブラリは、stdout を表すファイル名として "-" をとり - ます。ClipPDF の stdout への出力は apache との組み合わせでは動 - 作しないため、PHP が apache モジュールとしてコンパイルされてい - る場合、この指定は動作しません。この問題は、ファイル名の指定を - スキップし、pdfドキュメントを出力するために - <function>cpdf_output_buffer</function> を使用することにより解 - 決することができます。 - </simpara> - </note> - </para> - <para> - <function>cpdf_close</function>, - <function>cpdf_output_buffer</function>も参照下さい。 + <function>cpdf_clip</function> 関数はカレントのパスに描かれたもの + を全て切り取ります。 </para> </refsect1> </refentry> @@ -393,198 +438,148 @@ </refsect1> </refentry> - <refentry id="function.cpdf-page-init"> + <refentry id="function.cpdf-closepath"> <refnamediv> - <refname>cpdf_page_init</refname> - <refpurpose>新規ページを開始する</refpurpose> + <refname>cpdf_closepath</refname> + <refpurpose>パスを閉じる</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_page_init</function></funcdef> + <funcdef>void <function>cpdf_closepath</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>int <parameter>page number</parameter></paramdef> - <paramdef>int <parameter>orientation</parameter></paramdef> - <paramdef>double <parameter>height</parameter></paramdef> - <paramdef>double <parameter>width</parameter></paramdef> - <paramdef>double <parameter>unit</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_page_init</function> 関数は、高さ - <parameter>height</parameter> 、幅 <parameter>width</parameter> - の新規ページを開始します。ページは、ページ番号 <parameter>page - number</parameter> 及び向き<parameter>orientation</parameter> を - 有しています。<parameter>orientation</parameter> は縦置きの場合に - 0、横置きの場合に 1 とします。最後のオプションのパラメータ - <parameter>unit</parameter>は、座標系の単位を指定します。この値 - は、単位当たりのポストスクリプトのポイント数とする必要があります。 - 1インチは、72ポイントに等しいので、72という値は、単位をインチに設 - 定します。デフォルト値も72です。 - </para> - <para> - <function>cpdf_set_current_page</function>も参照下さい。 + <function>cpdf_closepath</function> 関数はカレントのパスを + 閉じます。 </para> </refsect1> </refentry> - <refentry id="function.cpdf-finalize-page"> + <refentry id="function.cpdf-closepath-fill-stroke"> <refnamediv> - <refname>cpdf_finalize_page</refname> - <refpurpose>ページを終了する</refpurpose> + <refname>cpdf_closepath_fill_stroke</refname> + <refpurpose>パスを閉じ、塗りつぶし、描く</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_finalize_page</function></funcdef> + <funcdef>void <function>cpdf_closepath_fill_stroke</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>int <parameter>page number</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_finalize_page</function> 関数は、ページ番号 - <parameter>page number</parameter> のページを終了します。この関数 - は、メモリに節約する意味しかありません。ページを終了することによ - り、消費メモリは少なくなりますが、修正することはできなくなります。 + <function>cpdf_closepath_fill_stroke</function> 関数は、カレント + のパスを閉じ、内部をカレントの塗りつぶし色で塗りつぶし、カレント + のパスを描きます。 </para> <para> - <function>cpdf_page_init</function>も参照下さい。 + <function>cpdf_closepath</function>, + <function>cpdf_stroke</function>, + <function>cpdf_fill</function>, + <function>cpdf_setgray_fill</function>, + <function>cpdf_setgray</function>, + <function>cpdf_setrgbcolor_fill</function>, + <function>cpdf_setrgbcolor</function> も参照下さい。 </para> </refsect1> </refentry> - <refentry id="function.cpdf-finalize"> - <refnamediv> - <refname>cpdf_finalize</refname> - <refpurpose>ドキュメントを終了する</refpurpose> - </refnamediv> - <refsect1> - <title>説明</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_finalize</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - <function>cpdf_finalize</function> 関数はドキュメントを終了します。 - 更に <function>cpdf_close</function> をコールする必要があります。 - </para> - <para> - <function>cpdf_close</function> も参照下さい。 - </para> - </refsect1> - </refentry> - - <refentry id="function.cpdf-output-buffer"> + <refentry id="function.cpdf-closepath-stroke"> <refnamediv> - <refname>cpdf_output_buffer</refname> - <refpurpose>pdf ドキュメントをメモリバッファに出力する</refpurpose> + <refname>cpdf_closepath_stroke</refname> + <refpurpose>パスを閉じ、線をパスに沿って描く</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_output_buffer</function></funcdef> + <funcdef>void <function>cpdf_closepath_stroke</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_output_buffer</function> 関数は、pdfドキュメントを - 標準出力に出力します。ドキュメントは、メモリ上に作成されている必 - 要があります。メモリ上に作成されるのは、 - <function>cpdf_open</function> を filename パラメータを指定せずに - コールした場合です。 + <function>cpdf_closepath_stroke</function> 関数は、 + <function>cpdf_closepath</function> と + <function>cpdf_stroke</function> が合わさったものです。 + 処理語、パスをクリアします。 </para> <para> - <function>cpdf_open</function>も参照下さい。 + <function>cpdf_closepath</function>, + <function>cpdf_stroke</function> も参照下さい。 </para> </refsect1> </refentry> - <refentry id="function.cpdf-save-to-file"> + <refentry id="function.cpdf-continue-text"> <refnamediv> - <refname>cpdf_save_to_file</refname> - <refpurpose>pdf ドキュメントをファイルに書きこむ</refpurpose> + <refname>cpdf_continue_text</refname> + <refpurpose>次の行にテキストを出力する</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_save_to_file</function></funcdef> + <funcdef>void <function>cpdf_continue_text</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>string <parameter>filename</parameter></paramdef> + <paramdef>string <parameter>text</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_save_to_file</function> 関数は、メモリ上に作成され - たpdfドキュメントをファイルに出力します。この関数は、 - <function>cpdf_open</function> のパラメータとしてfilename を指定 - してオープンした場合にはコールする必要はありません。 + <function>cpdf_continue_text</function> 関数は次の行に + 文字列 <parameter>text</parameter> を出力します。 </para> <para> - <function>cpdf_output_buffer</function>, - <function>cpdf_open</function> も参照下さい。 + <function>cpdf_show_xy</function>, + <function>cpdf_text</function>, + <function>cpdf_set_leading</function>, + <function>cpdf_set_text_pos</function> も参照下さい。 </para> </refsect1> </refentry> - <refentry id="function.cpdf-set-current-page"> + <refentry id="function.cpdf-curveto"> <refnamediv> - <refname>cpdf_set_current_page</refname> - <refpurpose>カレントページを設定する</refpurpose> + <refname>cpdf_curveto</refname> + <refpurpose>曲線を描く</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_set_current_page</function></funcdef> + <funcdef>void <function>cpdf_curveto</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>int <parameter>page number</parameter></paramdef> + <paramdef>float <parameter>x1</parameter></paramdef> + <paramdef>float <parameter>y1</parameter></paramdef> + <paramdef>float <parameter>x2</parameter></paramdef> + <paramdef>float <parameter>y2</parameter></paramdef> + <paramdef>float <parameter>x3</parameter></paramdef> + <paramdef>float <parameter>y3</parameter></paramdef> + <paramdef>int <parameter>mode</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_set_current_page</function> 関数は、全ての操作を行 - うページを設定します。<function>cpdf_finalize_page</function> に - よりページを終了するまでページ間を移動することができます。 - </para> - <para> - <function>cpdf_finalize_page</function> も参照下さい。 + <function>cpdf_curveto</function> 関数は、 + (<parameter>x1</parameter>, <parameter>y1</parameter>) および + (<parameter>x2</parameter>, <parameter>y2</parameter>) を制御点として + カレントの点から + (<parameter>x3</parameter>, <parameter>y3</parameter>) にベジエ曲線を + 描きます。 </para> - </refsect1> - </refentry> - - <refentry id="function.cpdf-begin-text"> - <refnamediv> - <refname>cpdf_begin_text</refname> - <refpurpose>テキストセクションを開始する</refpurpose> - </refnamediv> - <refsect1> - <title>説明</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_begin_text</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - </funcprototype> - </funcsynopsis> <para> - <function>cpdf_begin_text</function> 関数はテキストセクションを - 開始します。テキストセクションは、<function>cpdf_end_text</function> - で終了する必要があります。 - <example> - <title>テキスト出力</title> - <programlisting role="php"> -&lt;?php cpdf_begin_text($pdf); -cpdf_set_font($pdf, 16, "Helvetica", "WinAnsiEncoding"); -cpdf_text($pdf, 100, 100, "Some text"); -cpdf_end_text($pdf) ?> - </programlisting> - </example> + 最後のオプションのパラメータ <parameter>mode</parameter> は単位長 + さを定義します。0 または指定しなかった場合、そのページに指定され + たデフォルトの単位が使用されます。デフォルトの単位が指定されてい + ない場合は、座標はポストスクリプトポイントで計られます。 </para> <para> - <function>cpdf_end_text</function> も参照下さい。 + <function>cpdf_moveto</function>, + <function>cpdf_rmoveto</function>, + <function>cpdf_rlineto</function>, + <function>cpdf_lineto</function> も参照下さい。 </para> </refsect1> </refentry> @@ -608,11 +603,15 @@ ンを終了します。 <example> <title>テキスト出力</title> - <programlisting role="php"> -&lt;?php cpdf_begin_text($pdf); + <programlisting> +<![CDATA[ +<?php +cpdf_begin_text($pdf); cpdf_set_font($pdf, 16, "Helvetica", "WinAnsiEncoding"); cpdf_text($pdf, 100, 100, "Some text"); -cpdf_end_text($pdf) ?> +cpdf_end_text($pdf) +?> +]]> </programlisting> </example> </para> @@ -622,412 +621,458 @@ </refsect1> </refentry> - <refentry id="function.cpdf-show"> + <refentry id="function.cpdf-fill"> <refnamediv> - <refname>cpdf_show</refname> - <refpurpose>現在位置にテキストを出力する</refpurpose> + <refname>cpdf_fill</refname> + <refpurpose>カレントのパスを塗りつぶす</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_show</function></funcdef> + <funcdef>void <function>cpdf_fill</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>string <parameter>text</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_show</function> 関数は、現在位置に - <parameter>text</parameter> の文字列を出力します。 + <function>cpdf_fill</function> 関数は、カレントの塗りつぶし色で + カレントのパスの内部を塗りつぶします。 </para> <para> - <function>cpdf_text</function>, - <function>cpdf_begin_text</function>, - <function>cpdf_end_text</function> も参照下さい。 + <function>cpdf_closepath</function>, + <function>cpdf_stroke</function>, + <function>cpdf_setgray_fill</function>, + <function>cpdf_setgray</function>, + <function>cpdf_setrgbcolor_fill</function>, + <function>cpdf_setrgbcolor</function> も参照下さい。 </para> </refsect1> </refentry> - <refentry id="function.cpdf-show-xy"> + <refentry id="function.cpdf-fill-stroke"> <refnamediv> - <refname>cpdf_show_xy</refname> - <refpurpose>指定位置にテキストを出力する</refpurpose> + <refname>cpdf_fill_stroke</refname> + <refpurpose>カレントのパスを塗りつぶし、描く</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_show_xy</function></funcdef> + <funcdef>void <function>cpdf_fill_stroke</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>string <parameter>text</parameter></paramdef> - <paramdef>double <parameter>x-coor</parameter></paramdef> - <paramdef>double <parameter>y-coor</parameter></paramdef> - <paramdef>int <parameter>mode</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_show_xy</function> 関数は、 - 座標 (<parameter>x-coor</parameter>, <parameter>y-coor</parameter>) - の位置に文字列 <parameter>text</parameter> を出力します。 - 最後のオプションのパラメータは単位長さを定義します。 - 0 または指定しなかった場合、そのページに指定されたデフォルトの単位が - 使用されます。 - デフォルトの単位が指定されていない場合は、座標はポストスクリプト - ポイントで計られます。 - <note> - <simpara> - 関数<function>cpdf_show_xy</function> は、オプションの - パラメータを除き <function>cpdf_text</function> と同じです。 - </simpara> - </note> + <function>cpdf_fill_stroke</function> 関数は、カレントのパスの内 + 部をカレントの塗りつぶし色で塗りつぶし、カレントのパスを描きます。 </para> <para> - <function>cpdf_text</function> も参照下さい。 + <function>cpdf_closepath</function>, + <function>cpdf_stroke</function>, + <function>cpdf_fill</function>, + <function>cpdf_setgray_fill</function>, + <function>cpdf_setgray</function>, + <function>cpdf_setrgbcolor_fill</function>, + <function>cpdf_setrgbcolor</function> + も参照下さい。 </para> </refsect1> </refentry> - <refentry id="function.cpdf-text"> + <refentry id="function.cpdf-finalize"> <refnamediv> - <refname>cpdf_text</refname> - <refpurpose>テキストをパラメータを元に出力する</refpurpose> + <refname>cpdf_finalize</refname> + <refpurpose>ドキュメントを終了する</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_text</function></funcdef> + <funcdef>void <function>cpdf_finalize</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>string <parameter>text</parameter></paramdef> - <paramdef>double <parameter>x-coor</parameter></paramdef> - <paramdef>double <parameter>y-coor</parameter></paramdef> - <paramdef>int <parameter>mode</parameter></paramdef> - <paramdef>double <parameter>orientation</parameter></paramdef> - <paramdef>int <parameter>alignmode</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_text</function> 関数は、文字列 - <parameter>text</parameter> を座標(<parameter>x-coor</parameter>, - <parameter>y-coor</parameter>)の位置に出力します。 - オプションのパラメータは、単位長さを定義します。0 または指定しな - かった場合、そのページに指定されたデフォルトの単位が使用されます。 - デフォルトの単位が指定されていない場合は、座標はポストスクリプト - ポイントで計られます。オプションのパラメータ - <parameter>orientation</parameter> はテキストの回転角を度を単位と - して表したものです。オプションのパラメータ - <parameter>alignmode</parameter>テキストの並べ方を定義します。 - 使用可能な値については、ClibPDF のドキュメントを参照下さい。 + <function>cpdf_finalize</function> 関数はドキュメントを終了します。 + 更に <function>cpdf_close</function> をコールする必要があります。 </para> <para> - <function>cpdf_show_xy</function> も参照下さい。 + <function>cpdf_close</function> も参照下さい。 </para> </refsect1> </refentry> - <refentry id="function.cpdf-set-font"> + <refentry id="function.cpdf-finalize-page"> <refnamediv> - <refname>cpdf_set_font</refname> - <refpurpose>フォントの種類とサイズを選択する</refpurpose> + <refname>cpdf_finalize_page</refname> + <refpurpose>ページを終了する</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_set_font</function></funcdef> + <funcdef>void <function>cpdf_finalize_page</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>string <parameter>font name</parameter></paramdef> - <paramdef>double <parameter>size</parameter></paramdef> - <paramdef>string <parameter>encoding</parameter></paramdef> + <paramdef>int <parameter>page number</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_set_font</function> 関数は、カレントのフォントの種 - 類とサイズ、エンコード法を設定します。現在は、標準の Postscript - フォントのみがサポートされています。最後のパラメータ - <parameter>encoding</parameter> には次の値を指定できます。 - "MacRomanEncoding", "MacExpertEncoding", - "WinAnsiEncoding","&null;" 。"&null;" は、そのフォントの組込みエンコー - ド法を意味します。詳細な情報、特にアジア用フォント(訳注:日本語 - フォントを含むCJKフォント)のサポートについては、ClibPDF のマニュ - アルを参照下さい。 + <function>cpdf_finalize_page</function> 関数は、ページ番号 + <parameter>page number</parameter> のページを終了します。この関数 + は、メモリに節約する意味しかありません。ページを終了することによ + り、消費メモリは少なくなりますが、修正することはできなくなります。 + </para> + <para> + <function>cpdf_page_init</function>も参照下さい。 </para> </refsect1> </refentry> - <refentry id="function.cpdf-set-leading"> + <refentry id="function.cpdf-global-set-document-limits"> <refnamediv> - <refname>cpdf_set_leading</refname> - <refpurpose>テキスト行の間隔を設定する</refpurpose> + <refname>cpdf_global_set_document_limits</refname> + <refpurpose>PDFドキュメントの制限を設定する</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_set leading</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>double <parameter>distance</parameter></paramdef> + <funcdef>void <function>cpdf_global_set_document_limits</function></funcdef> + <paramdef>int <parameter>maxpages</parameter></paramdef> + <paramdef>int <parameter>maxfonts</parameter></paramdef> + <paramdef>int <parameter>maximages</parameter></paramdef> + <paramdef>int <parameter>maxannotations</parameter></paramdef> + <paramdef>int <parameter>maxobjects</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_set_leading</function> 関数はテキストの行間 - 設定します。この関数は、 - <function>cpdf_continue_text</function> により - テキストを出力する場合に使用されます。 + <function>cpdf_global_set_document_limits</function> 関数は複数の + ドキュメントの制限を設定します。この関数を使用する際には、 + <function>cpdf_open</function>の前にコールする必要があります。こ + の関数は、この後オープンする全てのドキュメントに制限を設定します。 </para> <para> - <function>cpdf_continue_text</function> も参照下さい。 + <function>cpdf_open</function>も参照下さい。 </para> </refsect1> </refentry> - - <refentry id="function.cpdf-set-text-rendering"> + + <refentry id="function.cpdf-import-jpeg"> <refnamediv> - <refname>cpdf_set_text_rendering</refname> - <refpurpose>テキストのレンダリング法を定義する</refpurpose> + <refname>cpdf_import_jpeg</refname> + <refpurpose>JPEG 画像をオープンする</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_set_text_rendering</function></funcdef> + <funcdef>int <function>cpdf_import_jpeg</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>int <parameter>mode</parameter></paramdef> + <paramdef>string <parameter>file name</parameter></paramdef> + <paramdef>float <parameter>x-coor</parameter></paramdef> + <paramdef>float <parameter>y-coor</parameter></paramdef> + <paramdef>float <parameter>angle</parameter></paramdef> + <paramdef>float <parameter>width</parameter></paramdef> + <paramdef>float <parameter>height</parameter></paramdef> + <paramdef>float <parameter>x-scale</parameter></paramdef> + <paramdef>float <parameter>y-scale</parameter></paramdef> + <paramdef>int + <parameter> + <replaceable><optional>mode</optional></replaceable> + </parameter> + </paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_set_text_rendering</function> 関数はテキストのレン - ダリング法を定義します。<parameter>mode</parameter> で使用可能な - 値は、0=塗りつぶす, 1=輪郭を描く, 2=塗りつぶし輪郭を描く, 3=不可 - 視,4=塗りつぶしクリッピングパスに追加, 5=輪郭を描いてクリッピング - パスに追加,6=塗りつぶし輪郭を描いてクリッピングパスに追加, 7=クリッ - ピングパスに追加です。 + <function>cpdf_import_jpeg</function> 関数は、 + <parameter>file name</parameter> という名前のファイルに保存された + 画像をオープンします。画像のフォーマットは jpeg である必要があります。 + 画像は、カレントのページの位置 + (<parameter>x-coor</parameter>, <parameter>y-coor</parameter>) + に置かれます。 + 画像は、<parameter>angle</parameter> 度回転されます。 </para> - </refsect1> - </refentry> - - <refentry id="function.cpdf-set-horiz-scaling"> - <refnamediv> - <refname>cpdf_set_horiz_scaling</refname> - <refpurpose>テキストの水平方向の倍率を設定する</refpurpose> - </refnamediv> - <refsect1> - <title>説明</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_set_horiz_scaling</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>double <parameter>scale</parameter></paramdef> - </funcprototype> - </funcsynopsis> <para> - <function>cpdf_set_horiz_scaling</function> 関数は、水平方向の - 倍率を <parameter>scale</parameter> パーセントに設定します。 + オプションのパラメータ <parameter>mode</parameter>は、単位長さを + 定義します。0 または指定しなかった場合、そのページに指定されたデ + フォルトの単位が使用されます。デフォルトの単位が指定されていない + 場合は、座標はポストスクリプトポイントで計られます。 + </para> + <para> + <function>cpdf_place_inline_image</function> も参照下さい。 </para> </refsect1> </refentry> - <refentry id="function.cpdf-set-text-rise"> + <refentry id="function.cpdf-lineto"> <refnamediv> - <refname>cpdf_set_text_rise</refname> - <refpurpose>テキストの高さを設定する</refpurpose> + <refname>cpdf_lineto</refname> + <refpurpose>線を描く</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_set_text_rise</function></funcdef> + <funcdef>void <function>cpdf_lineto</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>double <parameter>value</parameter></paramdef> + <paramdef>float <parameter>x-coor</parameter></paramdef> + <paramdef>float <parameter>y-coor</parameter></paramdef> + <paramdef>int <parameter>mode</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_set_text_rise</function> 関数は、テキストの高さを - <parameter>value</parameter> 単位に設定します。 + <function>cpdf_lineto</function> 関数はカレントのポイントから + (<parameter>x-coor</parameter>, <parameter>y-coor</parameter>) + に線を描きます。 + </para> + <para> + 最後のオプションのパラメータ <parameter>mode</parameter> は + 単位長さを定義します。 + 0 または指定しなかった場合、そのページに指定されたデフォルトの単位が + 使用されます。 + デフォルトの単位が指定されていない場合は、座標はポストスクリプト + ポイントで計られます。 + </para> + <para> + <function>cpdf_moveto</function>, + <function>cpdf_rmoveto</function>, + <function>cpdf_curveto</function> も参照下さい。 </para> </refsect1> </refentry> - <refentry id="function.cpdf-set-text-matrix"> + <refentry id="function.cpdf-moveto"> <refnamediv> - <refname>cpdf_set_text_matrix</refname> - <refpurpose>テキスト行列を設定する</refpurpose> + <refname>cpdf_moveto</refname> + <refpurpose>カレントのポイントを設定する</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_set_text_matrix</function></funcdef> + <funcdef>void <function>cpdf_moveto</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>array <parameter>matrix</parameter></paramdef> + <paramdef>float <parameter>x-coor</parameter></paramdef> + <paramdef>float <parameter>y-coor</parameter></paramdef> + <paramdef>int <parameter>mode</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_set_text_matrix</function> 関数は、カレントのテキ - ストフォントに適用する変換を記述する行列を設定します。 + <function>cpdf_moveto</function> 関数は、カレントのポイントを + 座標 (<parameter>x-coor</parameter> ,<parameter>y-coor</parameter>) + に設定します。 + </para> + <para> + 最後のオプションのパラメータ <parameter>mode</parameter> は + 単位長さを定義します。 + 0 または指定しなかった場合、そのページに指定されたデフォルトの単位が + 使用されます。 + デフォルトの単位が指定されていない場合は、座標はポストスクリプト + ポイントで計られます。 </para> </refsect1> </refentry> - <refentry id="function.cpdf-set-text-pos"> + <refentry id="function.cpdf-newpath"> <refnamediv> - <refname>cpdf_set_text_pos</refname> - <refpurpose>テキスト位置を設定する</refpurpose> + <refname>cpdf_newpath</refname> + <refpurpose>新規パスを開始する</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_set_text_pos</function></funcdef> + <funcdef>void <function>cpdf_newpath</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>double <parameter>x-coor</parameter></paramdef> - <paramdef>double <parameter>y-coor</parameter></paramdef> - <paramdef>int <parameter>mode</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_set_text_pos</function> 関数は、 - 次に <function>cpdf_show</function> がコールされた時の - テキストの位置を設定します。 - </para> - <para> - 最後のオプションのパラメータ <parameter>mode</parameter> は - 単位長さを定義します。 - 0 または指定しなかった場合、そのページに指定されたデフォルトの単位が - 使用されます。 - デフォルトの単位が指定されていない場合は、座標はポストスクリプト - ポイントで計られます。 - </para> - <para> - <function>cpdf_show</function>, - <function>cpdf_text</function> も参照下さい。 + <function>cpdf_newpath</function> は、パラメータ + <parameter>pdf document</parameter>で指定したドキュメントにおいて + 新規のパスを開始します。 </para> </refsect1> </refentry> - - <refentry id="function.cpdf-set-char-spacing"> + + <refentry id="function.cpdf-open"> <refnamediv> - <refname>cpdf_set_char_spacing</refname> - <refpurpose>文字間隔を設定する</refpurpose> + <refname>cpdf_open</refname> + <refpurpose>新規pdfドキュメントをオープンする</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_set_char_spacing</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>double <parameter>space</parameter></paramdef> + <funcdef>int <function>cpdf_open</function></funcdef> + <paramdef>int <parameter>compression</parameter></paramdef> + <paramdef>string <parameter>filename</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_set_char_spacing</function> 関数は、文字の間隔を - 設定します。 + <function>cpdf_open</function> 関数は新規pdfドキュメントをオープ + ンします。最初の引数が0 以外である場合、ドキュメントの圧縮がオン + となります。オプションの2番目のパラメータには、ドキュメントを書き + こむファイルを設定します。これを省略した場合、ドキュメントはメモ + リー上に作成され、<function>cpdf_save_to_file</function> によりファ + イルに書きこむか、 <function>cpdf_output_buffer</function> により + 標準出力に書き込むかのどちらかの処理を行うことができます。 + <note> + <simpara> + 返り値は、pdfドキュメントを書きこむ他の全ての関数の最初の引数 + として将来のバージョンの ClipPDF では必要になることでしょう。 + </simpara> + <simpara> + ClibPDF ライブラリは、stdout を表すファイル名として "-" をとり + ます。ClipPDF の stdout への出力は apache との組み合わせでは動 + 作しないため、PHP が apache モジュールとしてコンパイルされてい + る場合、この指定は動作しません。この問題は、ファイル名の指定を + スキップし、pdfドキュメントを出力するために + <function>cpdf_output_buffer</function> を使用することにより解 + 決することができます。 + </simpara> + </note> </para> <para> - <function>cpdf_set_word_spacing</function>, - <function>cpdf_set_leading</function> も参照下さい。 + <function>cpdf_close</function>, + <function>cpdf_output_buffer</function>も参照下さい。 </para> </refsect1> </refentry> - <refentry id="function.cpdf-set-word-spacing"> + <refentry id="function.cpdf-output-buffer"> <refnamediv> - <refname>cpdf_set_word_spacing</refname> - <refpurpose>単語間の間隔を設定する</refpurpose> + <refname>cpdf_output_buffer</refname> + <refpurpose>pdf ドキュメントをメモリバッファに出力する</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_set_word_spacing</function></funcdef> + <funcdef>void <function>cpdf_output_buffer</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>double <parameter>space</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_set_word_spacing</function> 関数は、単語間の間隔を - 設定します。 + <function>cpdf_output_buffer</function> 関数は、pdfドキュメントを + 標準出力に出力します。ドキュメントは、メモリ上に作成されている必 + 要があります。メモリ上に作成されるのは、 + <function>cpdf_open</function> を filename パラメータを指定せずに + コールした場合です。 </para> <para> - <function>cpdf_set_char_spacing</function>, - <function>cpdf_set_leading</function> も参照下さい。 + <function>cpdf_open</function>も参照下さい。 </para> </refsect1> </refentry> - <refentry id="function.cpdf-continue-text"> + <refentry id="function.cpdf-page-init"> <refnamediv> - <refname>cpdf_continue_text</refname> - <refpurpose>次の行にテキストを出力する</refpurpose> + <refname>cpdf_page_init</refname> + <refpurpose>新規ページを開始する</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_continue_text</function></funcdef> + <funcdef>void <function>cpdf_page_init</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>string <parameter>text</parameter></paramdef> + <paramdef>int <parameter>page number</parameter></paramdef> + <paramdef>int <parameter>orientation</parameter></paramdef> + <paramdef>float <parameter>height</parameter></paramdef> + <paramdef>float <parameter>width</parameter></paramdef> + <paramdef>float <parameter>unit</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_continue_text</function> 関数は次の行に - 文字列 <parameter>text</parameter> を出力します。 + <function>cpdf_page_init</function> 関数は、高さ + <parameter>height</parameter> 、幅 <parameter>width</parameter> + の新規ページを開始します。ページは、ページ番号 <parameter>page + number</parameter> 及び向き<parameter>orientation</parameter> を + 有しています。<parameter>orientation</parameter> は縦置きの場合に + 0、横置きの場合に 1 とします。最後のオプションのパラメータ + <parameter>unit</parameter>は、座標系の単位を指定します。この値 + は、単位当たりのポストスクリプトのポイント数とする必要があります。 + 1インチは、72ポイントに等しいので、72という値は、単位をインチに設 + 定します。デフォルト値も72です。 </para> <para> - <function>cpdf_show_xy</function>, - <function>cpdf_text</function>, - <function>cpdf_set_leading</function>, - <function>cpdf_set_text_pos</function> も参照下さい。 + <function>cpdf_set_current_page</function>も参照下さい。 </para> </refsect1> </refentry> - <refentry id="function.cpdf-stringwidth"> + <refentry id="function.cpdf-place-inline-image"> <refnamediv> - <refname>cpdf_stringwidth</refname> - <refpurpose>カレントフォントのテキストの幅を返す</refpurpose> + <refname>cpdf_place_inline_image</refname> + <refpurpose>画像をページに置く</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>double <function>cpdf_stringwidth</function></funcdef> + <funcdef>void <function>cpdf_place_inline_image</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>string <parameter>text</parameter></paramdef> + <paramdef>int <parameter>image</parameter></paramdef> + <paramdef>float <parameter>x-coor</parameter></paramdef> + <paramdef>float <parameter>y-coor</parameter></paramdef> + <paramdef>float <parameter>angle</parameter></paramdef> + <paramdef>float <parameter>width</parameter></paramdef> + <paramdef>float <parameter>height</parameter></paramdef> + <paramdef>int + <parameter> + <replaceable><optional>mode</optional></replaceable> + </parameter> + </paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_stringwidth</function> 関数は、文字列 - <parameter>text</parameter> の幅を返します。フォントがあらかじめ - 設定されている必要があります。 + <function>cpdf_place_inline_image</function> 関数は、PHPのイメー + ジ関数で作成された画像を、ページの位置 + (<parameter>x-coor</parameter>,<parameter>y-coor</parameter>) に + 置きます。同時に画像の縮小・拡大を行うことができます。 </para> <para> - <function>cpdf_set_font</function> も参照下さい。 + オプションのパラメータ <parameter>mode</parameter>は、単位長さを + 定義します。0 または指定しなかった場合、そのページに指定されたデ + フォルトの単位が使用されます。デフォルトの単位が指定されていない + 場合は、座標はポストスクリプトポイントで計られます。 + </para> + <para> + <function>cpdf_import_jpeg</function> も参照下さい。 </para> </refsect1> </refentry> - <refentry id="function.cpdf-save"> + <refentry id="function.cpdf-rect"> <refnamediv> - <refname>cpdf_save</refname> - <refpurpose>現在の環境を保存する</refpurpose> + <refname>cpdf_rect</refname> + <refpurpose>矩形を描く</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_save</function></funcdef> + <funcdef>void <function>cpdf_rect</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> + <paramdef>float <parameter>x-coor</parameter></paramdef> + <paramdef>float <parameter>y-coor</parameter></paramdef> + <paramdef>float <parameter>width</parameter></paramdef> + <paramdef>float <parameter>height</parameter></paramdef> + <paramdef>int <parameter>mode</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_save</function> 関数は現在のフォントを保存します。 - ポストスクリプトのコマンド gsave と同様に動作します。 - 他のオブジェクトに影響を与えずにあるオブジェクトを変換または回転 - したい場合に非常に便利です。 + <function>cpdf_rect</function> 関数は、左下隅を + (<parameter>x-coor</parameter>, <parameter>y-coor</parameter>)と + する矩形を書きます。矩形の幅を <parameter>widgth</parameter> に、 + 高さを <parameter>height</parameter> に設定します。 </para> <para> - <function>cpdf_restore</function> も参照下さい。 + 最後のオプションのパラメータ <parameter>mode</parameter> は単位長 + さを定義します。0 または指定しなかった場合、そのページに指定され + たデフォルトの単位が使用されます。 + デフォルトの単位が指定されていない場合は、座標はポストスクリプト + ポイントで計られます。 </para> </refsect1> </refentry> @@ -1053,10 +1098,14 @@ したい場合に非常に便利です。 <example> <title>保存/回復</title> - <programlisting role="php"> -&lt;?php cpdf_save($pdf); + <programlisting> +<![CDATA[ +<?php +cpdf_save($pdf); // do all kinds of rotations, transformations, ... -cpdf_restore($pdf) ?> +cpdf_restore($pdf) +?> +]]> </programlisting> </example> </para> @@ -1066,55 +1115,75 @@ </refsect1> </refentry> - <refentry id="function.cpdf-translate"> + <refentry id="function.cpdf-rlineto"> <refnamediv> - <refname>cpdf_translate</refname> - <refpurpose>座標系の原点を設定する</refpurpose> + <refname>cpdf_rlineto</refname> + <refpurpose>線を描く</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_translate</function></funcdef> + <funcdef>void <function>cpdf_rlineto</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>double <parameter>x-coor</parameter></paramdef> - <paramdef>double <parameter>y-coor</parameter></paramdef> + <paramdef>float <parameter>x-coor</parameter></paramdef> + <paramdef>float <parameter>y-coor</parameter></paramdef> <paramdef>int <parameter>mode</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_translate</function> 関数は、座標系の原点を - (<parameter>x-coor</parameter>,<parameter>y-coor</parameter>) に - 設定します。 + <function>cpdf_rlineto</function> 関数はカレントのポイントから + 相対座標 (<parameter>x-coor</parameter>, + <parameter>y-coor</parameter>)に線を描きます。 </para> <para> - 最後のオプションのパラメータ <parameter>mode</parameter> は単位長 - さを定義します。0 または指定しなかった場合、そのページに指定され - たデフォルトの単位が使用されます。デフォルトの単位が指定されてい - ない場合は、座標はポストスクリプトポイントで計られます。 + 最後のオプションのパラメータ <parameter>mode</parameter> は + 単位長さを定義します。 + 0 または指定しなかった場合、そのページに指定されたデフォルトの単位が + 使用されます。 + デフォルトの単位が指定されていない場合は、座標はポストスクリプト + ポイントで計られます。 + </para> + <para> + <function>cpdf_moveto</function>, + <function>cpdf_rmoveto</function>, + <function>cpdf_curveto</function> も参照下さい。 </para> </refsect1> </refentry> - <refentry id="function.cpdf-scale"> + <refentry id="function.cpdf-rmoveto"> <refnamediv> - <refname>cpdf_scale</refname> - <refpurpose>倍率を設定する</refpurpose> + <refname>cpdf_rmoveto</refname> + <refpurpose>カレントのポイントを設定する</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_scale</function></funcdef> + <funcdef>void <function>cpdf_rmoveto</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>double <parameter>x-scale</parameter></paramdef> - <paramdef>double <parameter>y-scale</parameter></paramdef> + <paramdef>float <parameter>x-coor</parameter></paramdef> + <paramdef>float <parameter>y-coor</parameter></paramdef> + <paramdef>int <parameter>mode</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_scale</function> 関数は、両方向の倍率を - 設定します。</para> - + <function>cpdf_rmoveto</function> 関数は、カレントのポイントを + 座標 (<parameter>x-coor</parameter> ,<parameter>y-coor</parameter>) + に対して相対的に設定します。 + </para> + <para> + 最後のオプションのパラメータ <parameter>mode</parameter> は + 単位長さを定義します。 + 0 または指定しなかった場合、そのページに指定されたデフォルトの単位が + 使用されます。 + デフォルトの単位が指定されていない場合は、座標はポストスクリプト + ポイントで計られます。 + </para> + <para> + <function>cpdf_moveto</function> も参照下さい。 + </para> </refsect1> </refentry> @@ -1129,7 +1198,7 @@ <funcprototype> <funcdef>void <function>cpdf_rotate</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>double <parameter>angle</parameter></paramdef> + <paramdef>float <parameter>angle</parameter></paramdef> </funcprototype> </funcsynopsis> <para> @@ -1139,289 +1208,411 @@ </refsect1> </refentry> - <refentry id="function.cpdf-setdash"> + <refentry id='function.cpdf-rotate-text'> <refnamediv> - <refname>cpdf_setdash</refname> - <refpurpose>破線のパターンを設定する</refpurpose> + <refname>cpdf_rotate_text</refname> + <refpurpose> + テキスト回転角を設定する + </refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_setdash</function></funcdef> + <funcdef>void <function>cpdf_rotate_text</function></funcdef> + <paramdef>int <parameter>pdfdoc</parameter></paramdef> + <paramdef>float <parameter>angle</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + &warn.undocumented.func; + </para> + </refsect1> + </refentry> + + + + + + + + + + + + <refentry id="function.cpdf-save"> + <refnamediv> + <refname>cpdf_save</refname> + <refpurpose>現在の環境を保存する</refpurpose> + </refnamediv> + <refsect1> + <title>説明</title> + <funcsynopsis> + <funcprototype> + <funcdef>void <function>cpdf_save</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>double <parameter>white</parameter></paramdef> - <paramdef>double <parameter>black</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_setdash</function> 関数は、白の長さ - <parameter>white</parameter> および黒の長さ - <parameter>black</parameter> により破線のパターンを設定します。両 - 方とも0の場合は実線が描かれます。 + <function>cpdf_save</function> 関数は現在のフォントを保存します。 + ポストスクリプトのコマンド gsave と同様に動作します。 + 他のオブジェクトに影響を与えずにあるオブジェクトを変換または回転 + したい場合に非常に便利です。 + </para> + <para> + <function>cpdf_restore</function> も参照下さい。 </para> </refsect1> </refentry> - - <refentry id="function.cpdf-setflat"> + + <refentry id="function.cpdf-save-to-file"> <refnamediv> - <refname>cpdf_setflat</refname> - <refpurpose>flatness を設定する</refpurpose> + <refname>cpdf_save_to_file</refname> + <refpurpose>pdf ドキュメントをファイルに書きこむ</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_setflat</function></funcdef> + <funcdef>void <function>cpdf_save_to_file</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>double <parameter>value</parameter></paramdef> + <paramdef>string <parameter>filename</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_setflat</function> 関数は、flatness を 0から100までの - 値に設定します。 + <function>cpdf_save_to_file</function> 関数は、メモリ上に作成され + たpdfドキュメントをファイルに出力します。この関数は、 + <function>cpdf_open</function> のパラメータとしてfilename を指定 + してオープンした場合にはコールする必要はありません。 + </para> + <para> + <function>cpdf_output_buffer</function>, + <function>cpdf_open</function> も参照下さい。 + </para> + </refsect1> + </refentry> + + <refentry id="function.cpdf-scale"> + <refnamediv> + <refname>cpdf_scale</refname> + <refpurpose>倍率を設定する</refpurpose> + </refnamediv> + <refsect1> + <title>説明</title> + <funcsynopsis> + <funcprototype> + <funcdef>void <function>cpdf_scale</function></funcdef> + <paramdef>int <parameter>pdf document</parameter></paramdef> + <paramdef>float <parameter>x-scale</parameter></paramdef> + <paramdef>float <parameter>y-scale</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>cpdf_scale</function> 関数は、両方向の倍率を + 設定します。 + </para> + </refsect1> + </refentry> + + <refentry id="function.cpdf-set-char-spacing"> + <refnamediv> + <refname>cpdf_set_char_spacing</refname> + <refpurpose>文字間隔を設定する</refpurpose> + </refnamediv> + <refsect1> + <title>説明</title> + <funcsynopsis> + <funcprototype> + <funcdef>void <function>cpdf_set_char_spacing</function></funcdef> + <paramdef>int <parameter>pdf document</parameter></paramdef> + <paramdef>float <parameter>space</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>cpdf_set_char_spacing</function> 関数は、文字の間隔を + 設定します。 + </para> + <para> + <function>cpdf_set_word_spacing</function>, + <function>cpdf_set_leading</function> も参照下さい。 + </para> + </refsect1> + </refentry> + + <refentry id="function.cpdf-set-creator"> + <refnamediv> + <refname>cpdf_set_creator</refname> + <refpurpose>pdf ドキュメントの creator フィールドを設定する</refpurpose> + </refnamediv> + <refsect1> + <title>説明</title> + <funcsynopsis> + <funcprototype> + <funcdef>void <function>cpdf_set_creator</function></funcdef> + <paramdef>string <parameter>creator</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>cpdf_set_creator</function> 関数は、pdf ドキュメントの + creator を設定します。 + </para> + <para> + <function>cpdf_set_subject</function>, + <function>cpdf_set_title</function>, + <function>cpdf_set_keywords</function> + も参照下さい。 </para> </refsect1> </refentry> - <refentry id="function.cpdf-setlinejoin"> + <refentry id="function.cpdf-set-current-page"> <refnamediv> - <refname>cpdf_setlinejoin</refname> - <refpurpose>linejoin パラメータを設定するparameter</refpurpose> + <refname>cpdf_set_current_page</refname> + <refpurpose>カレントページを設定する</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_setlinejoin</function></funcdef> + <funcdef>void <function>cpdf_set_current_page</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>long <parameter>value</parameter></paramdef> + <paramdef>int <parameter>page number</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_setlinejoin</function> 関数は、linejoin - パラメータを設定します。パラメータの値は、0から2の間になります。 - 0 = miter, 1 = round, 2 = bevel + <function>cpdf_set_current_page</function> 関数は、全ての操作を行 + うページを設定します。<function>cpdf_finalize_page</function> に + よりページを終了するまでページ間を移動することができます。 + </para> + <para> + <function>cpdf_finalize_page</function> も参照下さい。 </para> </refsect1> </refentry> - <refentry id="function.cpdf-setlinecap"> + <refentry id="function.cpdf-set-font"> <refnamediv> - <refname>cpdf_setlinecap</refname> - <refpurpose>linecap パラメータを設定する</refpurpose> + <refname>cpdf_set_font</refname> + <refpurpose>フォントの種類とサイズを選択する</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_setlinecap</function></funcdef> + <funcdef>void <function>cpdf_set_font</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>int <parameter>value</parameter></paramdef> + <paramdef>string <parameter>font name</parameter></paramdef> + <paramdef>float <parameter>size</parameter></paramdef> + <paramdef>string <parameter>encoding</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_setlinecap</function> 関数は、linecap - パラメータを 0 から 2 の範囲で設定します。 - 0 = butt end, 1 = round, - 2 = projecting square + <function>cpdf_set_font</function> 関数は、カレントのフォントの種 + 類とサイズ、エンコード法を設定します。現在は、標準の Postscript + フォントのみがサポートされています。最後のパラメータ + <parameter>encoding</parameter> には次の値を指定できます。 + "MacRomanEncoding", "MacExpertEncoding", + "WinAnsiEncoding","&null;" 。"&null;" は、そのフォントの組込みエンコー + ド法を意味します。詳細な情報、特にアジア用フォント(訳注:日本語 + フォントを含むCJKフォント)のサポートについては、ClibPDF のマニュ + アルを参照下さい。 </para> </refsect1> </refentry> - <refentry id="function.cpdf-setmiterlimit"> + <refentry id="function.cpdf-set-horiz-scaling"> <refnamediv> - <refname>cpdf_setmiterlimit</refname> - <refpurpose>miter のリミットを設定する</refpurpose> + <refname>cpdf_set_horiz_scaling</refname> + <refpurpose>テキストの水平方向の倍率を設定する</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_setmiterlimit</function></funcdef> + <funcdef>void <function>cpdf_set_horiz_scaling</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>double <parameter>value</parameter></paramdef> + <paramdef>float <parameter>scale</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_setmiterlimit</function> 関数は、 - miter のリミットを1 以上の値に設定します。 + <function>cpdf_set_horiz_scaling</function> 関数は、水平方向の + 倍率を <parameter>scale</parameter> パーセントに設定します。 </para> </refsect1> </refentry> - <refentry id="function.cpdf-setlinewidth"> + <refentry id="function.cpdf-set-keywords"> <refnamediv> - <refname>cpdf_setlinewidth</refname> - <refpurpose>線幅を設定する</refpurpose> + <refname>cpdf_set_keywords</refname> + <refpurpose>pdfドキュメントのkeywords フィールドを設定する</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_setlinewidth</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>double <parameter>width</parameter></paramdef> + <funcdef>void <function>cpdf_set_keywords</function></funcdef> + <paramdef>string <parameter>keywords</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_setlinewidth</function> 関数は線幅を - <parameter>width</parameter> に設定します。 + <function>cpdf_set_keywords</function> 関数は、pdfドキュメントの + keywords を設定します。 + </para> + <para> + <function>cpdf_set_title</function>, + <function>cpdf_set_creator</function>, + <function>cpdf_set_subject</function>も参照下さい。 </para> </refsect1> </refentry> - <refentry id="function.cpdf-newpath"> + <refentry id="function.cpdf-set-leading"> <refnamediv> - <refname>cpdf_newpath</refname> - <refpurpose>新規パスを開始する</refpurpose> + <refname>cpdf_set_leading</refname> + <refpurpose>テキスト行の間隔を設定する</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_newpath</function></funcdef> + <funcdef>void <function>cpdf_set leading</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> + <paramdef>float <parameter>distance</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_newpath</function> は、パラメータ - <parameter>pdf document</parameter>で指定したドキュメントにおいて - 新規のパスを開始します。 + <function>cpdf_set_leading</function> 関数はテキストの行間 + 設定します。この関数は、 + <function>cpdf_continue_text</function> により + テキストを出力する場合に使用されます。 + </para> + <para> + <function>cpdf_continue_text</function> も参照下さい。 </para> </refsect1> </refentry> - - <refentry id="function.cpdf-moveto"> + + <refentry id="function.cpdf-set-page-animation"> <refnamediv> - <refname>cpdf_moveto</refname> - <refpurpose>カレントのポイントを設定する</refpurpose> + <refname>cpdf_set_page_animation</refname> + <refpurpose>ページ間の移行時間を設定する</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_moveto</function></funcdef> + <funcdef>void <function>cpdf_set_page_animation</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>double <parameter>x-coor</parameter></paramdef> - <paramdef>double <parameter>y-coor</parameter></paramdef> - <paramdef>int <parameter>mode</parameter></paramdef> + <paramdef>int <parameter>transition</parameter></paramdef> + <paramdef>float <parameter>duration</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_moveto</function> 関数は、カレントのポイントを - 座標 (<parameter>x-coor</parameter> ,<parameter>y-coor</parameter>) - に設定します。 + <function>cpdf_set_page_animation</function> 関数は + ページ間の移行に要する時間を設定します。 </para> <para> - 最後のオプションのパラメータ <parameter>mode</parameter> は - 単位長さを定義します。 - 0 または指定しなかった場合、そのページに指定されたデフォルトの単位が - 使用されます。 - デフォルトの単位が指定されていない場合は、座標はポストスクリプト - ポイントで計られます。 + <parameter>transition</parameter> の値は次のようにすることができます。 + <simplelist> + <member> + 0 は、何もしない, + </member> + <member> + 1 は、ページを表示する際に2行ずつスクロールする, + </member> + <member> + 2 はページを表示する際に複数行ずつスクロールする, + </member> + <member> + 3 ページの周りに箱を描く, + </member> + <member> + 4 はページを表示する際に1行ずつスクロールする, + </member> + <member> + 5 はページを描画する際に古いページを消去する + </member> + <member> + 6 は画面の一つの隅から他の隅に移動するように消すといった効果を用いる + </member> + <member> + 7 は古いページを新しいページで単純に置換する (デフォルト) + </member> + </simplelist> + </para> + <para> + <parameter>duration</parameter> の値はページ間の切り替えに要する + 秒数です。 </para> </refsect1> </refentry> - <refentry id="function.cpdf-rmoveto"> + <refentry id="function.cpdf-set-subject"> <refnamediv> - <refname>cpdf_rmoveto</refname> - <refpurpose>カレントのポイントを設定する</refpurpose> + <refname>cpdf_set_subject</refname> + <refpurpose>pdfドキュメントのsubject フィールドを設定する</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_rmoveto</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>double <parameter>x-coor</parameter></paramdef> - <paramdef>double <parameter>y-coor</parameter></paramdef> - <paramdef>int <parameter>mode</parameter></paramdef> + <funcdef>void <function>cpdf_set_subject</function></funcdef> + <paramdef>string <parameter>subject</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_rmoveto</function> 関数は、カレントのポイントを - 座標 (<parameter>x-coor</parameter> ,<parameter>y-coor</parameter>) - に対して相対的に設定します。 - </para> - <para> - 最後のオプションのパラメータ <parameter>mode</parameter> は - 単位長さを定義します。 - 0 または指定しなかった場合、そのページに指定されたデフォルトの単位が - 使用されます。 - デフォルトの単位が指定されていない場合は、座標はポストスクリプト - ポイントで計られます。 + <function>cpdf_set_subject</function> 関数は、pdf ドキュメントの + subject を設定します。 </para> <para> - <function>cpdf_moveto</function> も参照下さい。 + <function>cpdf_set_title</function>, + <function>cpdf_set_creator</function>, + <function>cpdf_set_keywords</function> も参照下さい。 </para> </refsect1> </refentry> - <refentry id="function.cpdf-curveto"> + <refentry id="function.cpdf-set-text-matrix"> <refnamediv> - <refname>cpdf_curveto</refname> - <refpurpose>曲線を描く</refpurpose> + <refname>cpdf_set_text_matrix</refname> + <refpurpose>テキスト行列を設定する</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_curveto</function></funcdef> + <funcdef>void <function>cpdf_set_text_matrix</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>double <parameter>x1</parameter></paramdef> - <paramdef>double <parameter>y1</parameter></paramdef> - <paramdef>double <parameter>x2</parameter></paramdef> - <paramdef>double <parameter>y2</parameter></paramdef> - <paramdef>double <parameter>x3</parameter></paramdef> - <paramdef>double <parameter>y3</parameter></paramdef> - <paramdef>int <parameter>mode</parameter></paramdef> + <paramdef>array <parameter>matrix</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_curveto</function> 関数は、 - (<parameter>x1</parameter>, <parameter>y1</parameter>) および - (<parameter>x2</parameter>, <parameter>y2</parameter>) を制御点として - カレントの点から - (<parameter>x3</parameter>, <parameter>y3</parameter>) にベジエ曲線を - 描きます。 - </para> - <para> - 最後のオプションのパラメータ <parameter>mode</parameter> は単位長 - さを定義します。0 または指定しなかった場合、そのページに指定され - たデフォルトの単位が使用されます。デフォルトの単位が指定されてい - ない場合は、座標はポストスクリプトポイントで計られます。 - </para> - <para> - <function>cpdf_moveto</function>, - <function>cpdf_rmoveto</function>, - <function>cpdf_rlineto</function>, - <function>cpdf_lineto</function> も参照下さい。 + <function>cpdf_set_text_matrix</function> 関数は、カレントのテキ + ストフォントに適用する変換を記述する行列を設定します。 </para> </refsect1> </refentry> - <refentry id="function.cpdf-lineto"> + <refentry id="function.cpdf-set-text-pos"> <refnamediv> - <refname>cpdf_lineto</refname> - <refpurpose>線を描く</refpurpose> + <refname>cpdf_set_text_pos</refname> + <refpurpose>テキスト位置を設定する</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_lineto</function></funcdef> + <funcdef>void <function>cpdf_set_text_pos</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>double <parameter>x-coor</parameter></paramdef> - <paramdef>double <parameter>y-coor</parameter></paramdef> + <paramdef>float <parameter>x-coor</parameter></paramdef> + <paramdef>float <parameter>y-coor</parameter></paramdef> <paramdef>int <parameter>mode</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_lineto</function> 関数はカレントのポイントから - (<parameter>x-coor</parameter>, <parameter>y-coor</parameter>) - に線を描きます。 + <function>cpdf_set_text_pos</function> 関数は、 + 次に <function>cpdf_show</function> がコールされた時の + テキストの位置を設定します。 </para> <para> 最後のオプションのパラメータ <parameter>mode</parameter> は @@ -1432,404 +1623,333 @@ ポイントで計られます。 </para> <para> - <function>cpdf_moveto</function>, - <function>cpdf_rmoveto</function>, - <function>cpdf_curveto</function> も参照下さい。 + <function>cpdf_show</function>, + <function>cpdf_text</function> も参照下さい。 </para> </refsect1> </refentry> - <refentry id="function.cpdf-rlineto"> + <refentry id="function.cpdf-set-text-rendering"> <refnamediv> - <refname>cpdf_rlineto</refname> - <refpurpose>線を描く</refpurpose> + <refname>cpdf_set_text_rendering</refname> + <refpurpose>テキストのレンダリング法を定義する</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_rlineto</function></funcdef> + <funcdef>void <function>cpdf_set_text_rendering</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>double <parameter>x-coor</parameter></paramdef> - <paramdef>double <parameter>y-coor</parameter></paramdef> <paramdef>int <parameter>mode</parameter></paramdef> </funcprototype> </funcsynopsis> - <para> - <function>cpdf_rlineto</function> 関数はカレントのポイントから - 相対座標 (<parameter>x-coor</parameter>, - <parameter>y-coor</parameter>)に線を描きます。 - </para> - <para> - 最後のオプションのパラメータ <parameter>mode</parameter> は - 単位長さを定義します。 - 0 または指定しなかった場合、そのページに指定されたデフォルトの単位が - 使用されます。 - デフォルトの単位が指定されていない場合は、座標はポストスクリプト - ポイントで計られます。 - </para> - <para> - <function>cpdf_moveto</function>, - <function>cpdf_rmoveto</function>, - <function>cpdf_curveto</function> も参照下さい。 + <para> + <function>cpdf_set_text_rendering</function> 関数はテキストのレン + ダリング法を定義します。<parameter>mode</parameter> で使用可能な + 値は、0=塗りつぶす, 1=輪郭を描く, 2=塗りつぶし輪郭を描く, 3=不可 + 視,4=塗りつぶしクリッピングパスに追加, 5=輪郭を描いてクリッピング + パスに追加,6=塗りつぶし輪郭を描いてクリッピングパスに追加, 7=クリッ + ピングパスに追加です。 </para> </refsect1> </refentry> - <refentry id="function.cpdf-circle"> + <refentry id="function.cpdf-set-text-rise"> <refnamediv> - <refname>cpdf_circle</refname> - <refpurpose>円を描く</refpurpose> + <refname>cpdf_set_text_rise</refname> + <refpurpose>テキストの高さを設定する</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_circle</function></funcdef> + <funcdef>void <function>cpdf_set_text_rise</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>double <parameter>x-coor</parameter></paramdef> - <paramdef>double <parameter>y-coor</parameter></paramdef> - <paramdef>double <parameter>radius</parameter></paramdef> - <paramdef>int <parameter>mode</parameter></paramdef> + <paramdef>float <parameter>value</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_circle</function> 関数は、 - (<parameter>x-coor</parameter>, <parameter>y-coor</parameter>) - を中心として半径 <parameter>radius</parameter> の円を描きます。 - </para> - <para> - 最後のオプションのパラメータ <parameter>mode</parameter> は - 単位長さを定義します。 - 0 または指定しなかった場合、そのページに指定されたデフォルトの単位が - 使用されます。 - デフォルトの単位が指定されていない場合は、座標はポストスクリプト - ポイントで計られます。 - </para> - <para> - <function>cpdf_arc</function> も参照下さい。 + <function>cpdf_set_text_rise</function> 関数は、テキストの高さを + <parameter>value</parameter> 単位に設定します。 </para> </refsect1> </refentry> - <refentry id="function.cpdf-arc"> + <refentry id="function.cpdf-set-title"> <refnamediv> - <refname>cpdf_arc</refname> - <refpurpose>円弧を描く</refpurpose> + <refname>cpdf_set_title</refname> + <refpurpose>pdf ドキュメントの title フィールドを設定する</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_arc</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>double <parameter>x-coor</parameter></paramdef> - <paramdef>double <parameter>y-coor</parameter></paramdef> - <paramdef>double <parameter>radius</parameter></paramdef> - <paramdef>double <parameter>start</parameter></paramdef> - <paramdef>double <parameter>end</parameter></paramdef> - <paramdef>int <parameter>mode</parameter></paramdef> + <funcdef>void <function>cpdf_set_title</function></funcdef> + <paramdef>string <parameter>title</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_arc</function> 関数は、 - (<parameter>x-coor</parameter>, <parameter>y-coor</parameter>) - を中心として半径 <parameter>radius</parameter>、 - 角度 <parameter>start</parameter> から、角度 - <parameter>end</parameter> までの円弧を描きます。 - </para> - <para> - 最後のオプションのパラメータ <parameter>mode</parameter> は - 単位長さを定義します。 - 0 または指定しなかった場合、そのページに指定されたデフォルトの単位が - 使用されます。 - デフォルトの単位が指定されていない場合は、座標はポストスクリプト - ポイントで計られます。 + <function>cpdf_set_title</function> 関数は、pdfドキュメントの + title を設定します。 </para> <para> - <function>cpdf_circle</function> も参照下さい。 + <function>cpdf_set_subject</function>, + <function>cpdf_set_creator</function>, + <function>cpdf_set_keywords</function> + も参照下さい。 </para> </refsect1> </refentry> - <refentry id="function.cpdf-rect"> + <refentry id="function.cpdf-set-word-spacing"> <refnamediv> - <refname>cpdf_rect</refname> - <refpurpose>矩形を描く</refpurpose> + <refname>cpdf_set_word_spacing</refname> + <refpurpose>単語間の間隔を設定する</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_rect</function></funcdef> + <funcdef>void <function>cpdf_set_word_spacing</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>double <parameter>x-coor</parameter></paramdef> - <paramdef>double <parameter>y-coor</parameter></paramdef> - <paramdef>double <parameter>width</parameter></paramdef> - <paramdef>double <parameter>height</parameter></paramdef> - <paramdef>int <parameter>mode</parameter></paramdef> + <paramdef>float <parameter>space</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_rect</function> 関数は、左下隅を - (<parameter>x-coor</parameter>, <parameter>y-coor</parameter>)と - する矩形を書きます。矩形の幅を <parameter>widgth</parameter> に、 - 高さを <parameter>height</parameter> に設定します。 + <function>cpdf_set_word_spacing</function> 関数は、単語間の間隔を + 設定します。 </para> <para> - 最後のオプションのパラメータ <parameter>mode</parameter> は単位長 - さを定義します。0 または指定しなかった場合、そのページに指定され - たデフォルトの単位が使用されます。 - デフォルトの単位が指定されていない場合は、座標はポストスクリプト - ポイントで計られます。 + <function>cpdf_set_char_spacing</function>, + <function>cpdf_set_leading</function> も参照下さい。 </para> </refsect1> </refentry> - <refentry id="function.cpdf-closepath"> + <refentry id="function.cpdf-setdash"> <refnamediv> - <refname>cpdf_closepath</refname> - <refpurpose>パスを閉じる</refpurpose> + <refname>cpdf_setdash</refname> + <refpurpose>破線のパターンを設定する</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_closepath</function></funcdef> + <funcdef>void <function>cpdf_setdash</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> + <paramdef>float <parameter>white</parameter></paramdef> + <paramdef>float <parameter>black</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_closepath</function> 関数はカレントのパスを - 閉じます。 + <function>cpdf_setdash</function> 関数は、白の長さ + <parameter>white</parameter> および黒の長さ + <parameter>black</parameter> により破線のパターンを設定します。両 + 方とも0の場合は実線が描かれます。 </para> </refsect1> </refentry> - - <refentry id="function.cpdf-stroke"> + + <refentry id="function.cpdf-setflat"> <refnamediv> - <refname>cpdf_stroke</refname> - <refpurpose>パスに沿って線を描く</refpurpose> + <refname>cpdf_setflat</refname> + <refpurpose>flatness を設定する</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_stroke</function></funcdef> + <funcdef>void <function>cpdf_setflat</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> + <paramdef>float <parameter>value</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_stroke</function> 関数はカレントのパスに沿って - 線を描きます。 - </para> - <para> - <function>cpdf_closepath</function>, - <function>cpdf_closepath_stroke</function> - も参照下さい。 + <function>cpdf_setflat</function> 関数は、flatness を 0から100までの + 値に設定します。 </para> </refsect1> </refentry> - <refentry id="function.cpdf-closepath-stroke"> + <refentry id="function.cpdf-setgray"> <refnamediv> - <refname>cpdf_closepath_stroke</refname> - <refpurpose>パスを閉じ、線をパスに沿って描く</refpurpose> + <refname>cpdf_setgray</refname> + <refpurpose>描画、塗りつぶし色をグレー値に設定する</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_closepath_stroke</function></funcdef> + <funcdef>void <function>cpdf_setgray</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> + <paramdef>float <parameter>gray value</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_closepath_stroke</function> 関数は、 - <function>cpdf_closepath</function> と - <function>cpdf_stroke</function> が合わさったものです。 - 処理語、パスをクリアします。 + <function>cpdf_setgray</function> 関数は、カレントの描画お + よび塗りつぶし色を指定したグレー値に設定します。 </para> <para> - <function>cpdf_closepath</function>, - <function>cpdf_stroke</function> も参照下さい。 + <function>cpdf_setrgbcolor_stroke</function>, + <function>cpdf_setrgbcolor_fill</function> も参照下さい。 </para> </refsect1> </refentry> - - <refentry id="function.cpdf-fill"> + + <refentry id="function.cpdf-setgray-fill"> <refnamediv> - <refname>cpdf_fill</refname> - <refpurpose>カレントのパスを塗りつぶす</refpurpose> + <refname>cpdf_setgray_fill</refname> + <refpurpose>塗りつぶし色をグレー値に設定する</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_fill</function></funcdef> + <funcdef>void <function>cpdf_setgray_fill</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> + <paramdef>float <parameter>value</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_fill</function> 関数は、カレントの塗りつぶし色で - カレントのパスの内部を塗りつぶします。 + <function>cpdf_setgray_fill</function> 関数は、パスを塗りつぶす色 + として指定したグレー値を設定します。 </para> <para> - <function>cpdf_closepath</function>, - <function>cpdf_stroke</function>, - <function>cpdf_setgray_fill</function>, - <function>cpdf_setgray</function>, - <function>cpdf_setrgbcolor_fill</function>, - <function>cpdf_setrgbcolor</function> も参照下さい。 + <function>cpdf_setrgbcolor_fill</function> も参照下さい。 </para> </refsect1> </refentry> - <refentry id="function.cpdf-fill-stroke"> + <refentry id="function.cpdf-setgray-stroke"> <refnamediv> - <refname>cpdf_fill_stroke</refname> - <refpurpose>カレントのパスを塗りつぶし、描く</refpurpose> + <refname>cpdf_setgray_stroke</refname> + <refpurpose>描画色をグレー値に設定する</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_fill_stroke</function></funcdef> + <funcdef>void <function>cpdf_setgray_stroke</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> + <paramdef>float <parameter>gray value</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_fill_stroke</function> 関数は、カレントのパスの内 - 部をカレントの塗りつぶし色で塗りつぶし、カレントのパスを描きます。 + <function>cpdf_setgray_stroke</function> はカレントの描画色を + 指定したグレー値に設定します。 </para> <para> - <function>cpdf_closepath</function>, - <function>cpdf_stroke</function>, - <function>cpdf_fill</function>, - <function>cpdf_setgray_fill</function>, - <function>cpdf_setgray</function>, - <function>cpdf_setrgbcolor_fill</function>, - <function>cpdf_setrgbcolor</function> - も参照下さい。 + <function>cpdf_setrgbcolor_stroke</function> も参照下さい。 </para> </refsect1> </refentry> - <refentry id="function.cpdf-closepath-fill-stroke"> + <refentry id="function.cpdf-setlinecap"> <refnamediv> - <refname>cpdf_closepath_fill_stroke</refname> - <refpurpose>パスを閉じ、塗りつぶし、描く</refpurpose> + <refname>cpdf_setlinecap</refname> + <refpurpose>linecap パラメータを設定する</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_closepath_fill_stroke</function></funcdef> + <funcdef>void <function>cpdf_setlinecap</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> + <paramdef>int <parameter>value</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_closepath_fill_stroke</function> 関数は、カレント - のパスを閉じ、内部をカレントの塗りつぶし色で塗りつぶし、カレント - のパスを描きます。 - </para> - <para> - <function>cpdf_closepath</function>, - <function>cpdf_stroke</function>, - <function>cpdf_fill</function>, - <function>cpdf_setgray_fill</function>, - <function>cpdf_setgray</function>, - <function>cpdf_setrgbcolor_fill</function>, - <function>cpdf_setrgbcolor</function> も参照下さい。 + <function>cpdf_setlinecap</function> 関数は、linecap + パラメータを 0 から 2 の範囲で設定します。 + 0 = butt end, 1 = round, + 2 = projecting square </para> </refsect1> </refentry> - <refentry id="function.cpdf-clip"> + <refentry id="function.cpdf-setlinejoin"> <refnamediv> - <refname>cpdf_clip</refname> - <refpurpose>カレントのパスを切り取る</refpurpose> + <refname>cpdf_setlinejoin</refname> + <refpurpose>linejoin パラメータを設定するparameter</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_clip</function></funcdef> + <funcdef>void <function>cpdf_setlinejoin</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> + <paramdef>long <parameter>value</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_clip</function> 関数はカレントのパスに描かれたもの - を全て切り取ります。 + <function>cpdf_setlinejoin</function> 関数は、linejoin + パラメータを設定します。パラメータの値は、0から2の間になります。 + 0 = miter, 1 = round, 2 = bevel </para> </refsect1> </refentry> - - <refentry id="function.cpdf-setgray-fill"> + + <refentry id="function.cpdf-setlinewidth"> <refnamediv> - <refname>cpdf_setgray_fill</refname> - <refpurpose>塗りつぶし色をグレー値に設定する</refpurpose> + <refname>cpdf_setlinewidth</refname> + <refpurpose>線幅を設定する</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_setgray_fill</function></funcdef> + <funcdef>void <function>cpdf_setlinewidth</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>double <parameter>value</parameter></paramdef> + <paramdef>float <parameter>width</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_setgray_fill</function> 関数は、パスを塗りつぶす色 - として指定したグレー値を設定します。 - </para> - <para> - <function>cpdf_setrgbcolor_fill</function> も参照下さい。 + <function>cpdf_setlinewidth</function> 関数は線幅を + <parameter>width</parameter> に設定します。 </para> </refsect1> </refentry> - - <refentry id="function.cpdf-setgray-stroke"> + + <refentry id="function.cpdf-setmiterlimit"> <refnamediv> - <refname>cpdf_setgray_stroke</refname> - <refpurpose>描画色をグレー値に設定する</refpurpose> + <refname>cpdf_setmiterlimit</refname> + <refpurpose>miter のリミットを設定する</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_setgray_stroke</function></funcdef> + <funcdef>void <function>cpdf_setmiterlimit</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>double <parameter>gray value</parameter></paramdef> + <paramdef>float <parameter>value</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_setgray_stroke</function> はカレントの描画色を - 指定したグレー値に設定します。 - </para> - <para> - <function>cpdf_setrgbcolor_stroke</function> も参照下さい。 + <function>cpdf_setmiterlimit</function> 関数は、 + miter のリミットを1 以上の値に設定します。 </para> </refsect1> </refentry> - - <refentry id="function.cpdf-setgray"> + + <refentry id="function.cpdf-setrgbcolor"> <refnamediv> - <refname>cpdf_setgray</refname> - <refpurpose>描画、塗りつぶし色をグレー値に設定する</refpurpose> + <refname>cpdf_setrgbcolor</refname> + <refpurpose>描画色および塗りつぶし色をRGB値に設定??</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_setgray</function></funcdef> + <funcdef>void <function>cpdf_setrgbcolor</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>double <parameter>gray value</parameter></paramdef> + <paramdef>float <parameter>red value</parameter></paramdef> + <paramdef>float <parameter>green value</parameter></paramdef> + <paramdef>float <parameter>blue value</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_setgray_stroke</function> 関数は、カレントの描画お - よび塗りつぶし色を指定したグレー値に設定します。 + <function>cpdf_setrgbcolor</function> 関数は、カレントの + 描画色および塗りつぶし色を指定したRGB値に設定します。 </para> <para> <function>cpdf_setrgbcolor_stroke</function>, @@ -1849,9 +1969,9 @@ <funcprototype> <funcdef>void <function>cpdf_setrgbcolor_fill</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>double <parameter>red value</parameter></paramdef> - <paramdef>double <parameter>green value</parameter></paramdef> - <paramdef>double <parameter>blue value</parameter></paramdef> + <paramdef>float <parameter>red value</parameter></paramdef> + <paramdef>float <parameter>green value</parameter></paramdef> + <paramdef>float <parameter>blue value</parameter></paramdef> </funcprototype> </funcsynopsis> <para> @@ -1876,9 +1996,9 @@ <funcprototype> <funcdef>void <function>cpdf_setrgbcolor_stroke</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>double <parameter>red value</parameter></paramdef> - <paramdef>double <parameter>green value</parameter></paramdef> - <paramdef>double <parameter>blue value</parameter></paramdef> + <paramdef>float <parameter>red value</parameter></paramdef> + <paramdef>float <parameter>green value</parameter></paramdef> + <paramdef>float <parameter>blue value</parameter></paramdef> </funcprototype> </funcsynopsis> <para> @@ -1892,247 +2012,259 @@ </refsect1> </refentry> - <refentry id="function.cpdf-setrgbcolor"> + <refentry id="function.cpdf-show"> <refnamediv> - <refname>cpdf_setrgbcolor</refname> - <refpurpose>描画色および塗りつぶし色をRGB値に設定??</refpurpose> + <refname>cpdf_show</refname> + <refpurpose>現在位置にテキストを出力する</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_setrgbcolor</function></funcdef> + <funcdef>void <function>cpdf_show</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>double <parameter>red value</parameter></paramdef> - <paramdef>double <parameter>green value</parameter></paramdef> - <paramdef>double <parameter>blue value</parameter></paramdef> + <paramdef>string <parameter>text</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_setrgbcolor_stroke</function> 関数は、カレントの - 描画色および塗りつぶし色を指定したRGB値に設定します。 + <function>cpdf_show</function> 関数は、現在位置に + <parameter>text</parameter> の文字列を出力します。 </para> <para> - <function>cpdf_setrgbcolor_stroke</function>, - <function>cpdf_setrgbcolor_fill</function> も参照下さい。 + <function>cpdf_text</function>, + <function>cpdf_begin_text</function>, + <function>cpdf_end_text</function> も参照下さい。 </para> </refsect1> </refentry> - - <refentry id="function.cpdf-add-outline"> + + <refentry id="function.cpdf-show-xy"> <refnamediv> - <refname>cpdf_add_outline</refname> - <refpurpose>現在のページにブックマークを追加する</refpurpose> + <refname>cpdf_show_xy</refname> + <refpurpose>指定位置にテキストを出力する</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_add_outline</function></funcdef> + <funcdef>void <function>cpdf_show_xy</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> <paramdef>string <parameter>text</parameter></paramdef> + <paramdef>float <parameter>x-coor</parameter></paramdef> + <paramdef>float <parameter>y-coor</parameter></paramdef> + <paramdef>int + <parameter><optional>mode</optional></parameter> + </paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_add_outline</function> 関数は、テキスト - <parameter>text</parameter> により、現在のページを指すブックマー - クを設定します。 - <example> - <title>ページアウトラインの追加</title> - <programlisting role="php"> -&lt;?php -$cpdf = cpdf_open(0); -cpdf_page_init($cpdf, 1, 0, 595, 842); -cpdf_add_outline($cpdf, 0, 0, 0, 1, "Page 1"); -// ... -// 何らかの描画 -// ... -cpdf_finalize($cpdf); -Header("Content-type: application/pdf"); -cpdf_output_buffer($cpdf); -cpdf_close($cpdf); -?> - </programlisting> - <para> - </para> - </example> + <function>cpdf_show_xy</function> 関数は、 + 座標 (<parameter>x-coor</parameter>, <parameter>y-coor</parameter>) + の位置に文字列 <parameter>text</parameter> を出力します。 + 最後のオプションのパラメータは単位長さを定義します。 + 0 または指定しなかった場合、そのページに指定されたデフォルトの単位が + 使用されます。 + デフォルトの単位が指定されていない場合は、座標はポストスクリプト + ポイントで計られます。 + <note> + <simpara> + 関数<function>cpdf_show_xy</function> は、オプションの + パラメータを除き <function>cpdf_text</function> と同じです。 + </simpara> + </note> + </para> + <para> + <function>cpdf_text</function> も参照下さい。 </para> </refsect1> </refentry> - <refentry id="function.cpdf-set-page-animation"> + <refentry id="function.cpdf-stringwidth"> <refnamediv> - <refname>cpdf_set_page_animation</refname> - <refpurpose>ページ間の移行時間を設定する</refpurpose> + <refname>cpdf_stringwidth</refname> + <refpurpose>カレントフォントのテキストの幅を返す</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_set_page_animation</function></funcdef> + <funcdef>float <function>cpdf_stringwidth</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>int <parameter>transition</parameter></paramdef> - <paramdef>double <parameter>duration</parameter></paramdef> + <paramdef>string <parameter>text</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_set_page_animation</function> 関数は - ページ間の移行に要する時間を設定します。 + <function>cpdf_stringwidth</function> 関数は、文字列 + <parameter>text</parameter> の幅を返します。フォントがあらかじめ + 設定されている必要があります。 </para> <para> - <parameter>transition</parameter> の値は次のようにすることができます。 - <simplelist> - <member> - 0 は、何もしない, - </member> - <member> - 1 は、ページを表示する際に2行ずつスクロールする, - </member> - <member> - 2 はページを表示する際に複数行ずつスクロールする, - </member> - <member> - 3 ページの周りに箱を描く, - </member> - <member> - 4 はページを表示する際に1行ずつスクロールする, - </member> - <member> - 5 はページを描画する際に古いページを消去する - </member> - <member> - 6 は画面の一つの隅から他の隅に移動するように消すといった効果を用いる - </member> - <member> - 7 は古いページを新しいページで単純に置換する (デフォルト) - </member> - </simplelist> + <function>cpdf_set_font</function> も参照下さい。 </para> + </refsect1> + </refentry> + + <refentry id='function.cpdf-set-font-directories'> + <refnamediv> + <refname>cpdf_set_font_directories</refname> + <refpurpose> + 外部フォントを使用した際、検索するディレクトリを設定する + </refpurpose> + </refnamediv> + <refsect1> + <title>説明</title> + <funcsynopsis> + <funcprototype> + <funcdef>void <function>cpdf_set_font_directories</function></funcdef> + <paramdef>int <parameter>pdfdoc</parameter></paramdef> + <paramdef>string <parameter>pfmdir</parameter></paramdef> + <paramdef>string <parameter>pfbdir</parameter></paramdef> + </funcprototype> + </funcsynopsis> <para> - <parameter>duration</parameter> の値はページ間の切り替えに要する - 秒数です。 + &warn.undocumented.func; </para> </refsect1> </refentry> - <refentry id="function.cpdf-import-jpeg"> + <refentry id='function.cpdf-set-font-map-file'> <refnamediv> - <refname>cpdf_import_jpeg</refname> - <refpurpose>JPEG 画像をオープンする</refpurpose> + <refname>cpdf_set_font_map_file</refname> + <refpurpose> + 外部フォントを使用している場合、フォント名をファイル名変換マップ + に設定する + </refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>int <function>cpdf_import_jpeg</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>string <parameter>file name</parameter></paramdef> - <paramdef>double <parameter>x-coor</parameter></paramdef> - <paramdef>double <parameter>y-coor</parameter></paramdef> - <paramdef>double <parameter>angle</parameter></paramdef> - <paramdef>double <parameter>width</parameter></paramdef> - <paramdef>double <parameter>height</parameter></paramdef> - <paramdef>double <parameter>x-scale</parameter></paramdef> - <paramdef>double <parameter>y-scale</parameter></paramdef> - <paramdef>int - <parameter> - <replaceable><optional>mode</optional></replaceable> - </parameter> - </paramdef> + <funcdef>void <function>cpdf_set_font_map_file</function></funcdef> + <paramdef>int <parameter>pdfdoc</parameter></paramdef> + <paramdef>string <parameter>filename</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_import_jpeg</function> 関数は、 - <parameter>file name</parameter> という名前のファイルに保存された - 画像をオープンします。画像のフォーマットは jpeg である必要があります。 - 画像は、カレントのページの位置 - (<parameter>x-coor</parameter>, <parameter>y-coor</parameter>) - に置かれます。 - 画像は、<parameter>angle</parameter> 度回転されます。 + &warn.undocumented.func; </para> + </refsect1> + </refentry> + + <refentry id='function.cpdf-set-viewer-preferences'> + <refnamediv> + <refname>cpdf_set_viewer_preferences</refname> + <refpurpose> + ドキュメントのビューワ上での表示方法を設定する + </refpurpose> + </refnamediv> + <refsect1> + <title>説明</title> + <funcsynopsis> + <funcprototype> + <funcdef>void <function>cpdf_set_viewer_preferences</function></funcdef> + <paramdef>int <parameter>pdfdoc</parameter></paramdef> + <paramdef>array <parameter>preferences</parameter></paramdef> + </funcprototype> + </funcsynopsis> <para> - オプションのパラメータ <parameter>mode</parameter>は、単位長さを - 定義します。0 または指定しなかった場合、そのページに指定されたデ - フォルトの単位が使用されます。デフォルトの単位が指定されていない - 場合は、座標はポストスクリプトポイントで計られます。 + &warn.undocumented.func; + </para> + </refsect1> + </refentry> + + <refentry id="function.cpdf-stroke"> + <refnamediv> + <refname>cpdf_stroke</refname> + <refpurpose>パスに沿って線を描く</refpurpose> + </refnamediv> + <refsect1> + <title>説明</title> + <funcsynopsis> + <funcprototype> + <funcdef>void <function>cpdf_stroke</function></funcdef> + <paramdef>int <parameter>pdf document</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>cpdf_stroke</function> 関数はカレントのパスに沿って + 線を描きます。 </para> <para> - <function>cpdf_place_inline_image</function> も参照下さい。 + <function>cpdf_closepath</function>, + <function>cpdf_closepath_stroke</function> + も参照下さい。 </para> </refsect1> </refentry> - <refentry id="function.cpdf-place-inline-image"> + <refentry id="function.cpdf-text"> <refnamediv> - <refname>cpdf_place_inline_image</refname> - <refpurpose>画像をページに置く</refpurpose> + <refname>cpdf_text</refname> + <refpurpose>テキストをパラメータを元に出力する</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_place_inline_image</function></funcdef> + <funcdef>void <function>cpdf_text</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>int <parameter>image</parameter></paramdef> - <paramdef>double <parameter>x-coor</parameter></paramdef> - <paramdef>double <parameter>y-coor</parameter></paramdef> - <paramdef>double <parameter>angle</parameter></paramdef> - <paramdef>double <parameter>width</parameter></paramdef> - <paramdef>double <parameter>height</parameter></paramdef> + <paramdef>string <parameter>text</parameter></paramdef> + <paramdef>float <parameter>x-coor</parameter></paramdef> + <paramdef>float <parameter>y-coor</parameter></paramdef> <paramdef>int - <parameter> - <replaceable><optional>mode</optional></replaceable> - </parameter> + <parameter><optional>mode</optional></parameter> + </paramdef> + <paramdef> + float <parameter><optional>orientation</optional></parameter> + </paramdef> + <paramdef> + int <parameter><optional>alignmode</optional></parameter> </paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_place_inline_image</function> 関数は、PHPのイメー - ジ関数で作成された画像を、ページの位置 - (<parameter>x-coor</parameter>,<parameter>y-coor</parameter>) に - 置きます。同時に画像の縮小・拡大を行うことができます。 + <function>cpdf_text</function> 関数は、文字列 + <parameter>text</parameter> を座標(<parameter>x-coor</parameter>, + <parameter>y-coor</parameter>)の位置に出力します。 + オプションのパラメータは、単位長さを定義します。0 または指定しな + かった場合、そのページに指定されたデフォルトの単位が使用されます。 + デフォルトの単位が指定されていない場合は、座標はポストスクリプト + ポイントで計られます。オプションのパラメータ + <parameter>orientation</parameter> はテキストの回転角を度を単位と + して表したものです。オプションのパラメータ + <parameter>alignmode</parameter>テキストの並べ方を定義します。 </para> <para> - オプションのパラメータ <parameter>mode</parameter>は、単位長さを - 定義します。0 または指定しなかった場合、そのページに指定されたデ - フォルトの単位が使用されます。デフォルトの単位が指定されていない - 場合は、座標はポストスクリプトポイントで計られます。 + 使用可能な値については、ClibPDF のドキュメントを参照下さい。 </para> <para> - <function>cpdf_import_jpeg</function> も参照下さい。 + <function>cpdf_show_xy</function> も参照下さい。 </para> </refsect1> </refentry> - <refentry id="function.cpdf-add-annotation"> + <refentry id="function.cpdf-translate"> <refnamediv> - <refname>cpdf_add_annotation</refname> - <refpurpose>注記を追加する</refpurpose> + <refname>cpdf_translate</refname> + <refpurpose>座標系の原点を設定する</refpurpose> </refnamediv> <refsect1> <title>説明</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>cpdf_add_annotation</function></funcdef> + <funcdef>void <function>cpdf_translate</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>double <parameter>llx</parameter></paramdef> - <paramdef>double <parameter>lly</parameter></paramdef> - <paramdef>double <parameter>urx</parameter></paramdef> - <paramdef>double <parameter>ury</parameter></paramdef> - <paramdef>string <parameter>title</parameter></paramdef> - <paramdef>string <parameter>content</parameter></paramdef> + <paramdef>float <parameter>x-coor</parameter></paramdef> + <paramdef>float <parameter>y-coor</parameter></paramdef> <paramdef>int - <parameter> - <replaceable><optional>mode</optional></replaceable> - </parameter> + <parameter><optional>mode</optional></parameter> </paramdef> </funcprototype> </funcsynopsis> <para> - <function>cpdf_add_annotation</function> は、左下隅を - (<parameter>llx</parameter>, <parameter>lly</parameter>) 、右上隅 - を(<parameter>urx</parameter>, <parameter>ury</parameter>) とする - 注記を追加します。 + <function>cpdf_translate</function> 関数は、座標系の原点を + (<parameter>x-coor</parameter>,<parameter>y-coor</parameter>) に + 設定します。 </para> <para> 最後のオプションのパラメータ <parameter>mode</parameter> は単位長 @@ -2143,6 +2275,35 @@ </refsect1> </refentry> + <refentry id='function.cpdf-set-action-url'> + <refnamediv> + <refname>cpdf_set_action_url</refname> + <refpurpose> + ハイパーリンクを設定する + </refpurpose> + </refnamediv> + <refsect1> + <title>説明</title> + <funcsynopsis> + <funcprototype> + <funcdef>void <function>cpdf_set_action_url</function></funcdef> + <paramdef>int <parameter>pdfdoc</parameter></paramdef> + <paramdef>float <parameter>xll</parameter></paramdef> + <paramdef>float <parameter>yll</parameter></paramdef> + <paramdef>float <parameter>xur</parameter></paramdef> + <paramdef>float <parameter>xur</parameter></paramdef> + <paramdef>string <parameter>url</parameter></paramdef> + <paramdef>int + <parameter><optional>mode</optional></parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + <para> + &warn.undocumented.func; + </para> + </refsect1> + </refentry> + </reference> <!-- Keep this comment at the end of the file Index: phpdoc/ja/functions/cybercash.xml diff -u phpdoc/ja/functions/cybercash.xml:1.6 phpdoc/ja/functions/cybercash.xml:1.7 --- phpdoc/ja/functions/cybercash.xml:1.6 Wed Dec 12 15:52:49 2001 +++ phpdoc/ja/functions/cybercash.xml Mon Jan 14 10:48:01 2002 @@ -1,4 +1,5 @@ <?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.7 $ --> <reference id="ref.cybercash"> <title>Cybercash支払関数</title> <titleabbrev>Cybercash</titleabbrev> @@ -14,10 +15,10 @@ <refentry id="function.cybercash-encr"> <refnamediv> <refname>cybercash_encr</refname> - <refpurpose></refpurpose> + <refpurpose>???</refpurpose> </refnamediv> <refsect1> - <title>Description</title> + <title>説明</title> <funcsynopsis> <funcprototype> <funcdef>array <function>cybercash_encr</function></funcdef> @@ -37,7 +38,7 @@ <refentry id="function.cybercash-decr"> <refnamediv> <refname>cybercash_decr</refname> - <refpurpose></refpurpose> + <refpurpose>???</refpurpose> </refnamediv> <refsect1> <title>説明</title>
« previous php.doc (#969341198) next »