php-doc-en/reference/ncurses/functions/ncurses-wborder.xml
Hannes Magnusson c030e2adf7 Upgrade to DocBook5:
- All id attributes are now xml:id
 - Add docbook namespace to all root elements
 - Replace <ulink /> with <link xlink:href />
 - Minor markup fixes here and there


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@238160 c90b9560-bf6c-de11-be94-00142212c4b1
2007-06-20 22:25:43 +00:00

137 lines
3.6 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.ncurses-wborder" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ncurses_wborder</refname>
<refpurpose>Draws a border around the window using attributed characters</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>ncurses_wborder</methodname>
<methodparam><type>resource</type><parameter>window</parameter></methodparam>
<methodparam><type>int</type><parameter>left</parameter></methodparam>
<methodparam><type>int</type><parameter>right</parameter></methodparam>
<methodparam><type>int</type><parameter>top</parameter></methodparam>
<methodparam><type>int</type><parameter>bottom</parameter></methodparam>
<methodparam><type>int</type><parameter>tl_corner</parameter></methodparam>
<methodparam><type>int</type><parameter>tr_corner</parameter></methodparam>
<methodparam><type>int</type><parameter>bl_corner</parameter></methodparam>
<methodparam><type>int</type><parameter>br_corner</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
Draws the specified lines and corners around the passed
<parameter>window</parameter>.
</para>
<para>
Use <function>ncurses_border</function> for borders around the main
window.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
Each parameter expects 0 to draw a line and 1 to skip it.
<variablelist>
<varlistentry>
<term><parameter>window</parameter></term>
<listitem>
<para>
The window on which we operate
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>left</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>right</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>top</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>bottom</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>tl_corner</parameter></term>
<listitem>
<para>
Top left corner
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>tr_corner</parameter></term>
<listitem>
<para>
Top right corner
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>bl_corner</parameter></term>
<listitem>
<para>
Bottom left corner
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>br_corner</parameter></term>
<listitem>
<para>
Bottom right corner
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ncurses_border</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../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
-->