sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

new documentation by David Costa

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@150245 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Nuno Lopes 2004-02-01 12:25:39 +00:00
parent 60744c5cd8
commit 3b4e248e64
5 changed files with 87 additions and 57 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

43
reference/ncurses/functions/ncurses-border.xml
View file

@ -1,28 +1,37 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 -->
<refentry id="function.ncurses-border">
<refnamediv>
<refname>ncurses_border</refname>
<refpurpose>Draw a border around the screen using attributed characters </refpurpose>
<refpurpose>Draw a border around the screen using attributed characters</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>ncurses_border</methodname>
<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>
&warn.undocumented.func;
</para>
<methodsynopsis>
<type>int</type><methodname>ncurses_border</methodname>
<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;
<simpara>
<function>ncurses_border</function> draws the specified lines and
corners around the main window. Each parameter expects 0 to draw
a line and 1 to skip it. The corners are top left, top right,
bottom left and bottom right.
</simpara>
<simpara>
Use <function>ncurses_wborder</function> for borders around subwindows!
</simpara>
<simpara>
See also <function>ncurses_wborder</function>.
</simpara>
</refsect1>
</refentry>

21
reference/ncurses/functions/ncurses-getmaxyx.xml
View file

@ -1,12 +1,9 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.ncurses-getmaxyx">
<refnamediv>
<refname>ncurses_getmaxyx</refname>
<refpurpose>
Returns the size of a window
</refpurpose>
<refpurpose>Returns the size of a window</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@ -16,9 +13,15 @@
<methodparam><type>int</type><parameter>&amp;y</parameter></methodparam>
<methodparam><type>int</type><parameter>&amp;x</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
</para>
&warn.experimental.func;
<simpara>
<function>ncurses_getmaxyx</function> puts the horizontal and
vertical size of the window <parameter>window</parameter>
into the given variables <parameter>&amp;y</parameter> and
<parameter>&amp;x</parameter>. Variables must be passed
as reference, so they are updated when the user changes terminal
size.
</simpara>
</refsect1>
</refentry>

21
reference/ncurses/functions/ncurses-init.xml
View file

@ -1,21 +1,22 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 -->
<refentry id="function.ncurses-init">
<refnamediv>
<refname>ncurses_init</refname>
<refpurpose>Initialize ncurses </refpurpose>
<refpurpose>Initialize ncurses</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>ncurses_init</methodname>
<void/>
</methodsynopsis>
&warn.experimental.func;
<para>
&warn.undocumented.func;
</para>
<methodsynopsis>
<type>int</type><methodname>ncurses_init</methodname>
<void/>
</methodsynopsis>
&warn.experimental.func;
<simpara>
<function>ncurses_init</function> initializes the ncurses
interface and must be used before any other ncurses function.
</simpara>
</refsect1>
</refentry>

34
reference/ncurses/functions/ncurses-newwin.xml
View file

@ -1,24 +1,32 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 -->
<refentry id="function.ncurses-newwin">
<refnamediv>
<refname>ncurses_newwin</refname>
<refpurpose>Create a new window </refpurpose>
<refpurpose>Create a new window</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>ncurses_newwin</methodname>
<methodparam><type>int</type><parameter>rows</parameter></methodparam>
<methodparam><type>int</type><parameter>cols</parameter></methodparam>
<methodparam><type>int</type><parameter>y</parameter></methodparam>
<methodparam><type>int</type><parameter>x</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
&warn.undocumented.func;
</para>
<methodsynopsis>
<type>resource</type><methodname>ncurses_newwin</methodname>
<methodparam><type>int</type><parameter>rows</parameter></methodparam>
<methodparam><type>int</type><parameter>cols</parameter></methodparam>
<methodparam><type>int</type><parameter>y</parameter></methodparam>
<methodparam><type>int</type><parameter>x</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<simpara>
<function>ncurses_newwin</function> creates a new window
to draw elements in. Windows can be positioned using
<parameter>x</parameter>, <parameter>y</parameter>,
<parameter>rows</parameter> and <parameter>cols</parameter>.
When creating additional windows,
remember to use <function>ncurses_getmaxyx</function> to check for
available space, as terminal size is individual and may vary.
The return value is a resource ID used to differ between multiple
windows.
</simpara>
</refsect1>
</refentry>

25
reference/ncurses/functions/ncurses-wborder.xml
View file

@ -1,12 +1,10 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<refentry id="function.ncurses-wborder">
<refnamediv>
<refname>ncurses_wborder</refname>
<refpurpose>
Draws a border around the window using attributed characters
</refpurpose>
<refpurpose>Draws a border around the window using attributed characters</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@ -22,9 +20,20 @@
<methodparam><type>int</type><parameter>bl_corner</parameter></methodparam>
<methodparam><type>int</type><parameter>br_corner</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
</para>
&warn.experimental.func;
<simpara>
<function>ncurses_wborder</function> draws the specified lines and
corners around the passed window <parameter>window</parameter>. Each
parameter expects 0 to draw a line and 1 to skip it. The corners are
top left, top right, bottom left and bottom right.
</simpara>
<simpara>
Use <function>ncurses_border</function> for borders around the main
window.
</simpara>
<simpara>
See also <function>ncurses_border</function>.
</simpara>
</refsect1>
</refentry>