Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > 89346381d9fb64d9ee8827de5f073355 > files > 64

php-pear-HTML_Progress2-2.4.1-3mdv2010.0.noarch.rpm

<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
    <title>
      Graphical Handler
    </title>
    <link rel="stylesheet" href="book.css" type="text/css" />
    <meta name="generator" content="DocBook XSL Stylesheets V1.69.1" />
    <link rel="start" href="index.html" title="HTML_Progress2 Manual" />
    <link rel="up" href="ch19.html" title=
    "Chapter&nbsp;19.&nbsp;API - Application Programming Interface" />
    <link rel="prev" href="re17.html" title=
    "HTML_Progress2::getPercentComplete" />
    <link rel="next" href="re18.html" title="HTML_Progress2::getOrientation" />
    <style type="text/css">
/*<![CDATA[*/
    body {
    background-color: white;
    color: black;
    }
    :link { color: #0000FF }
    :visited { color: #840084 }
    :active { color: #0000FF }
    h2.c1 {clear: both}
    /*]]>*/
    </style>
  </head>
  <body>
    <table class="progress2Header">
      <tr>
        <td>
          <img src="img/pear_progress2.gif" align="left" alt=
          "PEAR Progress2 logo" />
          <h1>
            HTML_Progress2 : The Definitive Guide
          </h1>
          <div class="navheader">
            <table width="100%" summary="Navigation header">
              <tr>
                <th colspan="3" align="center">
                  Graphical Handler
                </th>
              </tr>
              <tr>
                <td width="20%" align="left">
                  <a accesskey="p" href="re17.html">Prev</a>&nbsp;
                </td>
                <th width="60%" align="center">
                  Chapter&nbsp;19.&nbsp;API - Application Programming Interface
                </th>
                <td width="20%" align="right">
                  &nbsp;<a accesskey="n" href="re18.html">Next</a>
                </td>
              </tr>
            </table>
          </div>
        </td>
      </tr>
    </table>
    <div class="sect1" lang="en" xml:lang="en">
      <div class="titlepage">
        <h2 class="title c1">
          <a name="reference.api.graph" id="reference.api.graph"></a>Graphical
          Handler
        </h2>
      </div>
      <div class="toc">
        <dl>
          <dt>
            <span class="sect2"><a href=
            "ch19s04.html#reference.api.graph.orientation">Orientation</a></span>
          </dt>
          <dt>
            <span class="sect2"><a href=
            "ch19s04.html#reference.api.graph.fill">Fill option</a></span>
          </dt>
          <dt>
            <span class="sect2"><a href=
            "ch19s04.html#reference.api.graph.cell">Cells</a></span>
          </dt>
          <dt>
            <span class="sect2"><a href=
            "ch19s04.html#reference.api.graph.border">Border</a></span>
          </dt>
          <dt>
            <span class="sect2"><a href=
            "ch19s04.html#reference.api.graph.frame">Frame</a></span>
          </dt>
          <dt>
            <span class="sect2"><a href=
            "ch19s04.html#reference.api.graph.label">Labels</a></span>
          </dt>
          <dt>
            <span class="sect2"><a href=
            "ch19s04.html#reference.api.graph.bg">Background color and
            size</a></span>
          </dt>
          <dt>
            <span class="sect2"><a href=
            "ch19s04.html#reference.api.graph.js">JavaScript handler</a></span>
          </dt>
          <dt>
            <span class="sect2"><a href=
            "ch19s04.html#reference.api.graph.circle">Circle/Ellipse</a></span>
          </dt>
        </dl>
      </div>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <h3 class="title">
            <a name="reference.api.graph.orientation" id=
            "reference.api.graph.orientation"></a>Orientation
          </h3>
        </div>
        <div class="toc">
          <dl>
            <dt>
              <span class="refentrytitle"><a href="re18.html"><code class=
              "function">HTML_Progress2::getOrientation</code></a></span>
              <span class="refpurpose">- Returns orientation of the progress
              bar</span>
            </dt>
            <dt>
              <span class="refentrytitle"><a href="re19.html"><code class=
              "function">HTML_Progress2::setOrientation</code></a></span>
              <span class="refpurpose">- Sets orientation of the progress
              bar</span>
            </dt>
          </dl>
        </div>
        <p>
          <code class="methodname">getOrientation()</code> and <code class=
          "methodname">setOrientation()</code> methods provides reading and
          setting of the progress meter's orientation property.
        </p>
      </div>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <h3 class="title">
            <a name="reference.api.graph.fill" id=
            "reference.api.graph.fill"></a>Fill option
          </h3>
        </div>
        <div class="toc">
          <dl>
            <dt>
              <span class="refentrytitle"><a href="re20.html"><code class=
              "function">HTML_Progress2::getFillWay</code></a></span>
              <span class="refpurpose">- Returns fill option of the progress
              meter</span>
            </dt>
            <dt>
              <span class="refentrytitle"><a href="re21.html"><code class=
              "function">HTML_Progress2::setFillWay</code></a></span>
              <span class="refpurpose">- Sets fill option of the progress
              meter</span>
            </dt>
          </dl>
        </div>
        <p>
          <code class="methodname">getFillWay()</code> and <code class=
          "methodname">setFillWay()</code> methods provides reading and setting
          of the progress meter's fill property.
        </p>
      </div>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <h3 class="title">
            <a name="reference.api.graph.cell" id=
            "reference.api.graph.cell"></a>Cells
          </h3>
        </div>
        <div class="toc">
          <dl>
            <dt>
              <span class="refentrytitle"><a href="re22.html"><code class=
              "function">HTML_Progress2::getCellCount</code></a></span>
              <span class="refpurpose">- Returns count of cell in the progress
              meter</span>
            </dt>
            <dt>
              <span class="refentrytitle"><a href="re23.html"><code class=
              "function">HTML_Progress2::setCellCount</code></a></span>
              <span class="refpurpose">- count of cell in the progress
              meter</span>
            </dt>
            <dt>
              <span class="refentrytitle"><a href="re24.html"><code class=
              "function">HTML_Progress2::getCellAttributes</code></a></span>
              <span class="refpurpose">- Returns cell attributes values</span>
            </dt>
            <dt>
              <span class="refentrytitle"><a href="re25.html"><code class=
              "function">HTML_Progress2::setCellAttributes</code></a></span>
              <span class="refpurpose">- Sets cell attributes values</span>
            </dt>
            <dt>
              <span class="refentrytitle"><a href="re26.html"><code class=
              "function">HTML_Progress2::getCellCoordinates</code></a></span>
              <span class="refpurpose">- Returns coordinates of each cell for a
              polygonal progress meter</span>
            </dt>
            <dt>
              <span class="refentrytitle"><a href="re27.html"><code class=
              "function">HTML_Progress2::setCellCoordinates</code></a></span>
              <span class="refpurpose">- Sets coordinates of each cell for a
              polygonal progress meter</span>
            </dt>
          </dl>
        </div>
        <p>
          <code class="methodname">getCellCount()</code> and <code class=
          "methodname">setCellCount()</code> methods provides reading and
          setting of the progress meter's cell count property.
        </p>
        <p>
          <code class="methodname">getCellAttributes()</code> and <code class=
          "methodname">setCellAttributes()</code> methods provides reading and
          setting of the progress meter's cells properties.
        </p>
        <p>
          <code class="methodname">getCellCoordinates()</code> and <code class=
          "methodname">setCellCoordinates()</code> methods provides reading and
          setting of the progress meter's cells coordinates properties, that
          defined a polygonal progress meter (square, rectangle, ...).
        </p>
      </div>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <h3 class="title">
            <a name="reference.api.graph.border" id=
            "reference.api.graph.border"></a>Border
          </h3>
        </div>
        <div class="toc">
          <dl>
            <dt>
              <span class="refentrytitle"><a href="re28.html"><code class=
              "function">HTML_Progress2::getBorderAttributes</code></a></span>
              <span class="refpurpose">- Returns progress bar's border
              attributes values</span>
            </dt>
            <dt>
              <span class="refentrytitle"><a href="re29.html"><code class=
              "function">HTML_Progress2::setBorderAttributes</code></a></span>
              <span class="refpurpose">- Sets the progress bar's border
              attributes</span>
            </dt>
            <dt>
              <span class="refentrytitle"><a href="re30.html"><code class=
              "function">HTML_Progress2::isBorderPainted</code></a></span>
              <span class="refpurpose">- Determines whether the progress bar
              border is painted or not</span>
            </dt>
            <dt>
              <span class="refentrytitle"><a href="re31.html"><code class=
              "function">HTML_Progress2::setBorderPainted</code></a></span>
              <span class="refpurpose">- Decides to paint or not a border to
              the progress bar.</span>
            </dt>
          </dl>
        </div>
        <p>
          <code class="methodname">getBorderAttributes()</code> and
          <code class="methodname">setBorderAttributes()</code> methods
          provides reading and setting of the progress meter's border property.
        </p>
      </div>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <h3 class="title">
            <a name="reference.api.graph.frame" id=
            "reference.api.graph.frame"></a>Frame
          </h3>
        </div>
        <div class="toc">
          <dl>
            <dt>
              <span class="refentrytitle"><a href="re32.html"><code class=
              "function">HTML_Progress2::getFrameAttributes</code></a></span>
              <span class="refpurpose">- Returns frame attributes values</span>
            </dt>
            <dt>
              <span class="refentrytitle"><a href="re33.html"><code class=
              "function">HTML_Progress2::setFrameAttributes</code></a></span>
              <span class="refpurpose">- Build a frame around the progress
              bar</span>
            </dt>
          </dl>
        </div>
        <p>
          <code class="methodname">getFrameAttributes()</code> and <code class=
          "methodname">setFrameAttributes()</code> methods provides reading and
          setting of the progress meter's frame properties.
        </p>
      </div>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <h3 class="title">
            <a name="reference.api.graph.label" id=
            "reference.api.graph.label"></a>Labels
          </h3>
        </div>
        <div class="toc">
          <dl>
            <dt>
              <span class="refentrytitle"><a href="re34.html"><code class=
              "function">HTML_Progress2::getLabelAttributes</code></a></span>
              <span class="refpurpose">- Returns attributes values of an
              existing label</span>
            </dt>
            <dt>
              <span class="refentrytitle"><a href="re35.html"><code class=
              "function">HTML_Progress2::setLabelAttributes</code></a></span>
              <span class="refpurpose">- Sets label attributes.</span>
            </dt>
            <dt>
              <span class="refentrytitle"><a href="re36.html"><code class=
              "function">HTML_Progress2::addLabel</code></a></span>
              <span class="refpurpose">- Add a new label to the progress
              meter</span>
            </dt>
            <dt>
              <span class="refentrytitle"><a href="re37.html"><code class=
              "function">HTML_Progress2::removeLabel</code></a></span>
              <span class="refpurpose">- Removes a label to the progress
              meter</span>
            </dt>
          </dl>
        </div>
        <p>
          <code class="methodname">getLabelAttributes()</code> and <code class=
          "methodname">setLabelAttributes()</code> methods provides reading and
          setting of the progress meter's label(s) items.
        </p>
        <p>
          <code class="methodname">addLabel()</code> and <code class=
          "methodname">removeLabel()</code> methods provides ability to add and
          remove unlimited progress meter's label(s) items.
        </p>
      </div>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <h3 class="title">
            <a name="reference.api.graph.bg" id=
            "reference.api.graph.bg"></a>Background color and size
          </h3>
        </div>
        <div class="toc">
          <dl>
            <dt>
              <span class="refentrytitle"><a href="re38.html"><code class=
              "function">HTML_Progress2::getProgressAttributes</code></a></span>
              <span class="refpurpose">- Returns the progress background
              attributes values</span>
            </dt>
            <dt>
              <span class="refentrytitle"><a href="re39.html"><code class=
              "function">HTML_Progress2::setProgressAttributes</code></a></span>
              <span class="refpurpose">- Sets the progress background
              attributes values</span>
            </dt>
          </dl>
        </div>
        <p>
          <code class="methodname">getProgressAttributes()</code> and
          <code class="methodname">setProgressAttributes()</code> methods
          provides reading and setting of progress meter's background color and
          size properties.
        </p>
      </div>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <h3 class="title">
            <a name="reference.api.graph.js" id=
            "reference.api.graph.js"></a>JavaScript handler
          </h3>
        </div>
        <div class="toc">
          <dl>
            <dt>
              <span class="refentrytitle"><a href="re40.html"><code class=
              "function">HTML_Progress2::getScript</code></a></span>
              <span class="refpurpose">- Returns javascript progress meter
              handler</span>
            </dt>
            <dt>
              <span class="refentrytitle"><a href="re41.html"><code class=
              "function">HTML_Progress2::setScript</code></a></span>
              <span class="refpurpose">- Sets the javascript progress meter
              handler</span>
            </dt>
          </dl>
        </div>
        <p>
          <code class="methodname">getScript()</code> and <code class=
          "methodname">setScript()</code> methods provides reading and setting
          of the progress meter's javascript source code, that will handle
          display refresh.
        </p>
      </div>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <h3 class="title">
            <a name="reference.api.graph.circle" id=
            "reference.api.graph.circle"></a>Circle/Ellipse
          </h3>
        </div>
        <div class="toc">
          <dl>
            <dt>
              <span class="refentrytitle"><a href="re42.html"><code class=
              "function">HTML_Progress2::drawCircleSegments</code></a></span>
              <span class="refpurpose">- Draw all circle segment
              pictures</span>
            </dt>
          </dl>
        </div>
        <p>
          <code class="methodname">drawCircleSegments()</code> method provides
          building of all circle/ellipse segment PNG pictures.
        </p>
      </div>
    </div>
    <table class="progress2Footer">
      <tr>
        <td align="left">
          HTML_Progress2 : The Definitive Guide
        </td>
        <td align="right">
          v 2.4.0 : April 20, 2007
        </td>
      </tr>
    </table>
    <div class="navfooter">
      <hr />
      <table width="100%" summary="Navigation footer">
        <tr>
          <td width="40%" align="left">
            <a accesskey="p" href="re17.html">Prev</a>&nbsp;
          </td>
          <td width="20%" align="center">
            <a accesskey="u" href="ch19.html">Up</a>
          </td>
          <td width="40%" align="right">
            &nbsp;<a accesskey="n" href="re18.html">Next</a>
          </td>
        </tr>
        <tr>
          <td width="40%" align="left" valign="top">
            <code class=
            "function">HTML_Progress2::getPercentComplete</code>&nbsp;
          </td>
          <td width="20%" align="center">
            <a accesskey="h" href="index.html">Home</a>
          </td>
          <td width="40%" align="right" valign="top">
            &nbsp;<code class="function">HTML_Progress2::getOrientation</code>
          </td>
        </tr>
      </table>
    </div>
  </body>
</html>