<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.newt-get-screen-size" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>newt_get_screen_size</refname>
  <refpurpose>Fills in the passed references with the current size of the
  terminal</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>void</type><methodname>newt_get_screen_size</methodname>
   <methodparam><type>int</type><parameter role="reference">cols</parameter></methodparam>
   <methodparam><type>int</type><parameter role="reference">rows</parameter></methodparam>
  </methodsynopsis>
  <para>
   Fills in the passed references with the current size of the terminal.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>cols</parameter></term>
     <listitem>
      <para>
       Number of columns in the terminal
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>rows</parameter></term>
     <listitem>
      <para>
       Number of rows in the terminal
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.void;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>A <function>newt_get_screen_size</function> example</title>
    <para>
     This code prints out the screen size of your terminal.
    </para>
    <programlisting role="php">
<![CDATA[
<?php
 newt_init();
 newt_get_screen_size (&$cols, &$rows);
 newt_finished();

 print "Your terminal size is: {$cols}x{$rows}\n";
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Your terminal size is: 138x47
]]>
    </screen>
   </example>
  </para>
 </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->