File: ncurses-wborder.xml

package info (click to toggle)
php-doc 20100521-2
  • links: PTS, VCS
  • area: main
  • in suites: squeeze, wheezy
  • size: 59,992 kB
  • ctags: 4,085
  • sloc: xml: 796,833; php: 21,338; cpp: 500; sh: 117; makefile: 58; awk: 28
file content (137 lines) | stat: -rw-r--r-- 3,696 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<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:"~/.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
-->