<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.ps.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'function.ps-begin-page.php',
    1 => 'ps_begin_page',
    2 => '新しいページを開始する',
  ),
  'up' => 
  array (
    0 => 'ref.ps.php',
    1 => 'PS 関数',
  ),
  'prev' => 
  array (
    0 => 'function.ps-arcn.php',
    1 => 'ps_arcn',
  ),
  'next' => 
  array (
    0 => 'function.ps-begin-pattern.php',
    1 => 'ps_begin_pattern',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/ps/functions/ps-begin-page.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.ps-begin-page" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">ps_begin_page</h1>
  <p class="verinfo">(PECL ps &gt;= 1.1.0)</p><p class="refpurpose"><span class="refname">ps_begin_page</span> &mdash; <span class="dc-title">新しいページを開始する</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.ps-begin-page-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>ps_begin_page</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> <code class="parameter">$psdoc</code></span>, <span class="methodparam"><span class="type"><a href="language.types.float.php" class="type float">float</a></span> <code class="parameter">$width</code></span>, <span class="methodparam"><span class="type"><a href="language.types.float.php" class="type float">float</a></span> <code class="parameter">$height</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="para rdfs-comment">
    新しいページを開始します。<code class="parameter">width</code> や
    <code class="parameter">height</code> というパラメータを見ると
    いかにもページ単位でサイズを変えられるように思えますが、PostScript
    ではこれは不可能です。最初に <span class="function"><strong>ps_begin_page()</strong></span>
    を呼んだ際に指定されたサイズが、ドキュメント全体に適用されます。
    2 回目以降に呼ばれた場合はこのパラメータは意味を持たず、
    単に新しいページが作られるだけです。しかし、もしあなたが PostScript ドキュメントを
    PDF に変換しようと考えているのなら話は別です。
    この関数はドキュメントの各ページごとに pdfmark を設定するので、
    PDF に変換した後はページごとにサイズを変えることができます。
  </p>
  <p class="para">
   PostScript はさまざまなページサイズを知らないので、pslib
   ではドキュメントの各ページに対してバウンディングボックスを設定します。
   このサイズは PostScript ビューアによって評価され、
   ドキュメントヘッダの BoundingBox より優先されます。
   左下角が (0, 0) ではない BoundingBox を設定すると、
   予期せぬ結果を引き起こすことがあります。なぜなら、
   ページ単位のバウンディングボックスは常に左下角が (0, 0) であり、
   これが全体の設定より優先されるからです。
  </p>
  <p class="para">
    個々のページの情報はカプセル化して保存されています。どういうことかというと、
    あるページで設定した情報のほとんどは次のページに引き継がれないということです。
  </p>
  <p class="para">
    最初の <span class="function"><strong>ps_begin_page()</strong></span> 呼び出しまでに一度も
    <span class="function"><a href="function.ps-findfont.php" class="function">ps_findfont()</a></span> が呼び出されていなかった場合は、
    PostScript ドキュメントのヘッダが出力され、
    バウンディングボックスが最初のページのサイズに設定されます。
    バウンディングボックスの左下角は (0, 0) に設定されます。もしすでに
    <span class="function"><a href="function.ps-findfont.php" class="function">ps_findfont()</a></span> が呼ばれていた場合は既にヘッダが出力されてしまっており、
    ドキュメントに適切なバウンディングボックスが設定されていないことになります。
    このようなことを避けるために、<span class="function"><a href="function.ps-findfont.php" class="function">ps_findfont()</a></span> や
    <span class="function"><strong>ps_begin_page()</strong></span> を実行する前にはいつも
    <span class="function"><a href="function.ps-set-info.php" class="function">ps_set_info()</a></span> を実行し、
    <code class="literal">BoundingBox</code> や <code class="literal">Orientation</code>
    の値を設定しておくべきです。
  </p>
  <blockquote class="note"><p><strong class="note">注意</strong>: 
   <p class="para">
    pslib のバージョン 0.2.6 まででは、
    <span class="function"><a href="function.ps-set-info.php" class="function">ps_set_info()</a></span> によって事前に設定されていたり
    <span class="function"><a href="function.ps-findfont.php" class="function">ps_findfont()</a></span> が事前にコールされていない限り、
    この関数は常に BoundingBox および Orientation を上書きします。
   </p>
  </p></blockquote>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.ps-begin-page-parameters">
  <h3 class="title">パラメータ</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">psdoc</code></dt>
     <dd>
      <p class="para">
       <span class="function"><a href="function.ps-new.php" class="function">ps_new()</a></span> が返す、postscript
       ファイルのリソース ID。
      </p>
     </dd>
    
    
     <dt><code class="parameter">width</code></dt>
     <dd>
      <p class="para">
       ピクセル単位のページの幅 (例: A4 の場合は 596)。
      </p>
     </dd>
    
    
     <dt><code class="parameter">height</code></dt>
     <dd>
      <p class="para">
       ピクセル単位のページの高さ (例: A4 の場合は 842)。
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.ps-begin-page-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="para">
   成功した場合に <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> を、失敗した場合に <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> を返します。
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.ps-begin-page-seealso">
  <h3 class="title">参考</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.ps-end-page.php" class="function" rel="rdfs-seeAlso">ps_end_page()</a> - ページを終了する</span></li>
    <li><span class="function"><a href="function.ps-findfont.php" class="function" rel="rdfs-seeAlso">ps_findfont()</a> - フォントを読み込む</span></li>
    <li><span class="function"><a href="function.ps-set-info.php" class="function" rel="rdfs-seeAlso">ps_set_info()</a> - ドキュメントの情報を設定する</span></li>
   </ul>
  </p>
 </div>

</div><?php manual_footer($setup); ?>