1*4a1a9510SRong-En Fan<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
2*4a1a9510SRong-En Fan<HTML
3*4a1a9510SRong-En Fan><HEAD
4*4a1a9510SRong-En Fan><TITLE
5*4a1a9510SRong-En Fan> NCURSES Programming HOWTO </TITLE
6*4a1a9510SRong-En Fan><META
7*4a1a9510SRong-En FanNAME="GENERATOR"
8*4a1a9510SRong-En FanCONTENT="Modular DocBook HTML Stylesheet Version 1.79"></HEAD
9*4a1a9510SRong-En Fan><BODY
10*4a1a9510SRong-En FanCLASS="ARTICLE"
11*4a1a9510SRong-En FanBGCOLOR="#FFFFFF"
12*4a1a9510SRong-En FanTEXT="#000000"
13*4a1a9510SRong-En FanLINK="#0000FF"
14*4a1a9510SRong-En FanVLINK="#840084"
15*4a1a9510SRong-En FanALINK="#0000FF"
16*4a1a9510SRong-En Fan><DIV
17*4a1a9510SRong-En FanCLASS="ARTICLE"
18*4a1a9510SRong-En Fan><DIV
19*4a1a9510SRong-En FanCLASS="TITLEPAGE"
20*4a1a9510SRong-En Fan><H1
21*4a1a9510SRong-En FanCLASS="TITLE"
22*4a1a9510SRong-En Fan><A
23*4a1a9510SRong-En FanNAME="AEN2"
24*4a1a9510SRong-En Fan>NCURSES Programming HOWTO</A
25*4a1a9510SRong-En Fan></H1
26*4a1a9510SRong-En Fan><H3
27*4a1a9510SRong-En FanCLASS="AUTHOR"
28*4a1a9510SRong-En Fan><A
29*4a1a9510SRong-En FanNAME="AEN4"
30*4a1a9510SRong-En Fan> Pradeep   Padala </A
31*4a1a9510SRong-En Fan></H3
32*4a1a9510SRong-En Fan><DIV
33*4a1a9510SRong-En FanCLASS="AFFILIATION"
34*4a1a9510SRong-En Fan><DIV
35*4a1a9510SRong-En FanCLASS="ADDRESS"
36*4a1a9510SRong-En Fan><P
37*4a1a9510SRong-En FanCLASS="ADDRESS"
38*4a1a9510SRong-En Fan><CODE
39*4a1a9510SRong-En FanCLASS="EMAIL"
40*4a1a9510SRong-En Fan>&#60;<A
41*4a1a9510SRong-En FanHREF="mailto:[email protected]"
42*4a1a9510SRong-En Fan>[email protected]</A
43*4a1a9510SRong-En Fan>&#62;</CODE
44*4a1a9510SRong-En Fan></P
45*4a1a9510SRong-En Fan></DIV
46*4a1a9510SRong-En Fan></DIV
47*4a1a9510SRong-En Fan><P
48*4a1a9510SRong-En FanCLASS="PUBDATE"
49*4a1a9510SRong-En Fan>v1.9, 2005-06-20<BR></P
50*4a1a9510SRong-En Fan><DIV
51*4a1a9510SRong-En FanCLASS="REVHISTORY"
52*4a1a9510SRong-En Fan><TABLE
53*4a1a9510SRong-En FanWIDTH="100%"
54*4a1a9510SRong-En FanBORDER="0"
55*4a1a9510SRong-En Fan><TR
56*4a1a9510SRong-En Fan><TH
57*4a1a9510SRong-En FanALIGN="LEFT"
58*4a1a9510SRong-En FanVALIGN="TOP"
59*4a1a9510SRong-En FanCOLSPAN="3"
60*4a1a9510SRong-En Fan><B
61*4a1a9510SRong-En Fan>Revision History</B
62*4a1a9510SRong-En Fan></TH
63*4a1a9510SRong-En Fan></TR
64*4a1a9510SRong-En Fan><TR
65*4a1a9510SRong-En Fan><TD
66*4a1a9510SRong-En FanALIGN="LEFT"
67*4a1a9510SRong-En Fan>Revision 1.9</TD
68*4a1a9510SRong-En Fan><TD
69*4a1a9510SRong-En FanALIGN="LEFT"
70*4a1a9510SRong-En Fan>2005-06-20</TD
71*4a1a9510SRong-En Fan><TD
72*4a1a9510SRong-En FanALIGN="LEFT"
73*4a1a9510SRong-En Fan>Revised by: ppadala</TD
74*4a1a9510SRong-En Fan></TR
75*4a1a9510SRong-En Fan><TR
76*4a1a9510SRong-En Fan><TD
77*4a1a9510SRong-En FanALIGN="LEFT"
78*4a1a9510SRong-En FanCOLSPAN="3"
79*4a1a9510SRong-En Fan>The license has been changed to the MIT-style license used
80*4a1a9510SRong-En Fan        by NCURSES. Note that the programs are also re-licensed under this.</TD
81*4a1a9510SRong-En Fan></TR
82*4a1a9510SRong-En Fan><TR
83*4a1a9510SRong-En Fan><TD
84*4a1a9510SRong-En FanALIGN="LEFT"
85*4a1a9510SRong-En Fan>Revision 1.8</TD
86*4a1a9510SRong-En Fan><TD
87*4a1a9510SRong-En FanALIGN="LEFT"
88*4a1a9510SRong-En Fan>2005-06-17</TD
89*4a1a9510SRong-En Fan><TD
90*4a1a9510SRong-En FanALIGN="LEFT"
91*4a1a9510SRong-En Fan>Revised by: ppadala</TD
92*4a1a9510SRong-En Fan></TR
93*4a1a9510SRong-En Fan><TR
94*4a1a9510SRong-En Fan><TD
95*4a1a9510SRong-En FanALIGN="LEFT"
96*4a1a9510SRong-En FanCOLSPAN="3"
97*4a1a9510SRong-En Fan>Lots of updates. Added references and perl examples.
98*4a1a9510SRong-En Fan        Changes to examples. Many grammatical and stylistic changes to the
99*4a1a9510SRong-En Fan        content. Changes to NCURSES history.</TD
100*4a1a9510SRong-En Fan></TR
101*4a1a9510SRong-En Fan><TR
102*4a1a9510SRong-En Fan><TD
103*4a1a9510SRong-En FanALIGN="LEFT"
104*4a1a9510SRong-En Fan>Revision 1.7.1</TD
105*4a1a9510SRong-En Fan><TD
106*4a1a9510SRong-En FanALIGN="LEFT"
107*4a1a9510SRong-En Fan>2002-06-25</TD
108*4a1a9510SRong-En Fan><TD
109*4a1a9510SRong-En FanALIGN="LEFT"
110*4a1a9510SRong-En Fan>Revised by: ppadala</TD
111*4a1a9510SRong-En Fan></TR
112*4a1a9510SRong-En Fan><TR
113*4a1a9510SRong-En Fan><TD
114*4a1a9510SRong-En FanALIGN="LEFT"
115*4a1a9510SRong-En FanCOLSPAN="3"
116*4a1a9510SRong-En Fan>Added a README file for building and instructions
117*4a1a9510SRong-En Fan        for building from source.</TD
118*4a1a9510SRong-En Fan></TR
119*4a1a9510SRong-En Fan><TR
120*4a1a9510SRong-En Fan><TD
121*4a1a9510SRong-En FanALIGN="LEFT"
122*4a1a9510SRong-En Fan>Revision 1.7</TD
123*4a1a9510SRong-En Fan><TD
124*4a1a9510SRong-En FanALIGN="LEFT"
125*4a1a9510SRong-En Fan>2002-06-25</TD
126*4a1a9510SRong-En Fan><TD
127*4a1a9510SRong-En FanALIGN="LEFT"
128*4a1a9510SRong-En Fan>Revised by: ppadala</TD
129*4a1a9510SRong-En Fan></TR
130*4a1a9510SRong-En Fan><TR
131*4a1a9510SRong-En Fan><TD
132*4a1a9510SRong-En FanALIGN="LEFT"
133*4a1a9510SRong-En FanCOLSPAN="3"
134*4a1a9510SRong-En Fan>Added "Other formats" section and made a lot of fancy
135*4a1a9510SRong-En Fan        changes to the programs. Inlining of programs is gone.</TD
136*4a1a9510SRong-En Fan></TR
137*4a1a9510SRong-En Fan><TR
138*4a1a9510SRong-En Fan><TD
139*4a1a9510SRong-En FanALIGN="LEFT"
140*4a1a9510SRong-En Fan>Revision 1.6.1</TD
141*4a1a9510SRong-En Fan><TD
142*4a1a9510SRong-En FanALIGN="LEFT"
143*4a1a9510SRong-En Fan>2002-02-24</TD
144*4a1a9510SRong-En Fan><TD
145*4a1a9510SRong-En FanALIGN="LEFT"
146*4a1a9510SRong-En Fan>Revised by: ppadala</TD
147*4a1a9510SRong-En Fan></TR
148*4a1a9510SRong-En Fan><TR
149*4a1a9510SRong-En Fan><TD
150*4a1a9510SRong-En FanALIGN="LEFT"
151*4a1a9510SRong-En FanCOLSPAN="3"
152*4a1a9510SRong-En Fan>Removed the old Changelog section, cleaned the makefiles</TD
153*4a1a9510SRong-En Fan></TR
154*4a1a9510SRong-En Fan><TR
155*4a1a9510SRong-En Fan><TD
156*4a1a9510SRong-En FanALIGN="LEFT"
157*4a1a9510SRong-En Fan>Revision 1.6</TD
158*4a1a9510SRong-En Fan><TD
159*4a1a9510SRong-En FanALIGN="LEFT"
160*4a1a9510SRong-En Fan>2002-02-16</TD
161*4a1a9510SRong-En Fan><TD
162*4a1a9510SRong-En FanALIGN="LEFT"
163*4a1a9510SRong-En Fan>Revised by: ppadala</TD
164*4a1a9510SRong-En Fan></TR
165*4a1a9510SRong-En Fan><TR
166*4a1a9510SRong-En Fan><TD
167*4a1a9510SRong-En FanALIGN="LEFT"
168*4a1a9510SRong-En FanCOLSPAN="3"
169*4a1a9510SRong-En Fan>Corrected a lot of spelling mistakes, added ACS variables
170*4a1a9510SRong-En Fan        section</TD
171*4a1a9510SRong-En Fan></TR
172*4a1a9510SRong-En Fan><TR
173*4a1a9510SRong-En Fan><TD
174*4a1a9510SRong-En FanALIGN="LEFT"
175*4a1a9510SRong-En Fan>Revision 1.5</TD
176*4a1a9510SRong-En Fan><TD
177*4a1a9510SRong-En FanALIGN="LEFT"
178*4a1a9510SRong-En Fan>2002-01-05</TD
179*4a1a9510SRong-En Fan><TD
180*4a1a9510SRong-En FanALIGN="LEFT"
181*4a1a9510SRong-En Fan>Revised by: ppadala</TD
182*4a1a9510SRong-En Fan></TR
183*4a1a9510SRong-En Fan><TR
184*4a1a9510SRong-En Fan><TD
185*4a1a9510SRong-En FanALIGN="LEFT"
186*4a1a9510SRong-En FanCOLSPAN="3"
187*4a1a9510SRong-En Fan>Changed structure to present proper TOC</TD
188*4a1a9510SRong-En Fan></TR
189*4a1a9510SRong-En Fan><TR
190*4a1a9510SRong-En Fan><TD
191*4a1a9510SRong-En FanALIGN="LEFT"
192*4a1a9510SRong-En Fan>Revision 1.3.1</TD
193*4a1a9510SRong-En Fan><TD
194*4a1a9510SRong-En FanALIGN="LEFT"
195*4a1a9510SRong-En Fan>2001-07-26</TD
196*4a1a9510SRong-En Fan><TD
197*4a1a9510SRong-En FanALIGN="LEFT"
198*4a1a9510SRong-En Fan>Revised by: ppadala</TD
199*4a1a9510SRong-En Fan></TR
200*4a1a9510SRong-En Fan><TR
201*4a1a9510SRong-En Fan><TD
202*4a1a9510SRong-En FanALIGN="LEFT"
203*4a1a9510SRong-En FanCOLSPAN="3"
204*4a1a9510SRong-En Fan>Corrected maintainers paragraph, Corrected stable release number</TD
205*4a1a9510SRong-En Fan></TR
206*4a1a9510SRong-En Fan><TR
207*4a1a9510SRong-En Fan><TD
208*4a1a9510SRong-En FanALIGN="LEFT"
209*4a1a9510SRong-En Fan>Revision 1.3</TD
210*4a1a9510SRong-En Fan><TD
211*4a1a9510SRong-En FanALIGN="LEFT"
212*4a1a9510SRong-En Fan>2001-07-24</TD
213*4a1a9510SRong-En Fan><TD
214*4a1a9510SRong-En FanALIGN="LEFT"
215*4a1a9510SRong-En Fan>Revised by: ppadala</TD
216*4a1a9510SRong-En Fan></TR
217*4a1a9510SRong-En Fan><TR
218*4a1a9510SRong-En Fan><TD
219*4a1a9510SRong-En FanALIGN="LEFT"
220*4a1a9510SRong-En FanCOLSPAN="3"
221*4a1a9510SRong-En Fan>Added copyright notices to main document (LDP license)
222*4a1a9510SRong-En Fan        and programs (GPL), Corrected
223*4a1a9510SRong-En Fan        printw_example.</TD
224*4a1a9510SRong-En Fan></TR
225*4a1a9510SRong-En Fan><TR
226*4a1a9510SRong-En Fan><TD
227*4a1a9510SRong-En FanALIGN="LEFT"
228*4a1a9510SRong-En Fan>Revision 1.2</TD
229*4a1a9510SRong-En Fan><TD
230*4a1a9510SRong-En FanALIGN="LEFT"
231*4a1a9510SRong-En Fan>2001-06-05</TD
232*4a1a9510SRong-En Fan><TD
233*4a1a9510SRong-En FanALIGN="LEFT"
234*4a1a9510SRong-En Fan>Revised by: ppadala</TD
235*4a1a9510SRong-En Fan></TR
236*4a1a9510SRong-En Fan><TR
237*4a1a9510SRong-En Fan><TD
238*4a1a9510SRong-En FanALIGN="LEFT"
239*4a1a9510SRong-En FanCOLSPAN="3"
240*4a1a9510SRong-En Fan>Incorporated ravi's changes. Mainly to introduction, menu,
241*4a1a9510SRong-En Fan        form, justforfun sections</TD
242*4a1a9510SRong-En Fan></TR
243*4a1a9510SRong-En Fan><TR
244*4a1a9510SRong-En Fan><TD
245*4a1a9510SRong-En FanALIGN="LEFT"
246*4a1a9510SRong-En Fan>Revision 1.1</TD
247*4a1a9510SRong-En Fan><TD
248*4a1a9510SRong-En FanALIGN="LEFT"
249*4a1a9510SRong-En Fan>2001-05-22</TD
250*4a1a9510SRong-En Fan><TD
251*4a1a9510SRong-En FanALIGN="LEFT"
252*4a1a9510SRong-En Fan>Revised by: ppadala</TD
253*4a1a9510SRong-En Fan></TR
254*4a1a9510SRong-En Fan><TR
255*4a1a9510SRong-En Fan><TD
256*4a1a9510SRong-En FanALIGN="LEFT"
257*4a1a9510SRong-En FanCOLSPAN="3"
258*4a1a9510SRong-En Fan>Added "a word about window" section, Added scanw_example.</TD
259*4a1a9510SRong-En Fan></TR
260*4a1a9510SRong-En Fan></TABLE
261*4a1a9510SRong-En Fan></DIV
262*4a1a9510SRong-En Fan><DIV
263*4a1a9510SRong-En Fan><DIV
264*4a1a9510SRong-En FanCLASS="ABSTRACT"
265*4a1a9510SRong-En Fan><P
266*4a1a9510SRong-En Fan></P
267*4a1a9510SRong-En Fan><A
268*4a1a9510SRong-En FanNAME="AEN67"
269*4a1a9510SRong-En Fan></A
270*4a1a9510SRong-En Fan><P
271*4a1a9510SRong-En Fan>    <SPAN
272*4a1a9510SRong-En FanCLASS="emphasis"
273*4a1a9510SRong-En Fan><I
274*4a1a9510SRong-En FanCLASS="EMPHASIS"
275*4a1a9510SRong-En Fan>This document is intended to be an "All in One" guide for programming with
276*4a1a9510SRong-En Fanncurses and its sister libraries. We graduate from a simple "Hello World"
277*4a1a9510SRong-En Fanprogram to more complex form manipulation. No prior experience in ncurses is
278*4a1a9510SRong-En Fanassumed. Send comments to <A
279*4a1a9510SRong-En FanHREF="mailto:[email protected]"
280*4a1a9510SRong-En FanTARGET="_top"
281*4a1a9510SRong-En Fan>this address</A
282*4a1a9510SRong-En Fan>
283*4a1a9510SRong-En Fan    </I
284*4a1a9510SRong-En Fan></SPAN
285*4a1a9510SRong-En Fan>
286*4a1a9510SRong-En Fan    </P
287*4a1a9510SRong-En Fan><P
288*4a1a9510SRong-En Fan></P
289*4a1a9510SRong-En Fan></DIV
290*4a1a9510SRong-En Fan></DIV
291*4a1a9510SRong-En Fan><HR></DIV
292*4a1a9510SRong-En Fan><DIV
293*4a1a9510SRong-En FanCLASS="TOC"
294*4a1a9510SRong-En Fan><DL
295*4a1a9510SRong-En Fan><DT
296*4a1a9510SRong-En Fan><B
297*4a1a9510SRong-En Fan>Table of Contents</B
298*4a1a9510SRong-En Fan></DT
299*4a1a9510SRong-En Fan><DT
300*4a1a9510SRong-En Fan>1. <A
301*4a1a9510SRong-En FanHREF="#INTRO"
302*4a1a9510SRong-En Fan>Introduction</A
303*4a1a9510SRong-En Fan></DT
304*4a1a9510SRong-En Fan><DD
305*4a1a9510SRong-En Fan><DL
306*4a1a9510SRong-En Fan><DT
307*4a1a9510SRong-En Fan>1.1. <A
308*4a1a9510SRong-En FanHREF="#WHATIS"
309*4a1a9510SRong-En Fan>What is NCURSES?</A
310*4a1a9510SRong-En Fan></DT
311*4a1a9510SRong-En Fan><DT
312*4a1a9510SRong-En Fan>1.2. <A
313*4a1a9510SRong-En FanHREF="#WHATCANWEDO"
314*4a1a9510SRong-En Fan>What we can do with NCURSES</A
315*4a1a9510SRong-En Fan></DT
316*4a1a9510SRong-En Fan><DT
317*4a1a9510SRong-En Fan>1.3. <A
318*4a1a9510SRong-En FanHREF="#WHERETOGETIT"
319*4a1a9510SRong-En Fan>Where to get it</A
320*4a1a9510SRong-En Fan></DT
321*4a1a9510SRong-En Fan><DT
322*4a1a9510SRong-En Fan>1.4. <A
323*4a1a9510SRong-En FanHREF="#PURPOSE"
324*4a1a9510SRong-En Fan>Purpose/Scope of the document</A
325*4a1a9510SRong-En Fan></DT
326*4a1a9510SRong-En Fan><DT
327*4a1a9510SRong-En Fan>1.5. <A
328*4a1a9510SRong-En FanHREF="#ABOUTPROGRAMS"
329*4a1a9510SRong-En Fan>About the Programs</A
330*4a1a9510SRong-En Fan></DT
331*4a1a9510SRong-En Fan><DT
332*4a1a9510SRong-En Fan>1.6. <A
333*4a1a9510SRong-En FanHREF="#OTHERFORMATS"
334*4a1a9510SRong-En Fan>Other Formats of the document</A
335*4a1a9510SRong-En Fan></DT
336*4a1a9510SRong-En Fan><DD
337*4a1a9510SRong-En Fan><DL
338*4a1a9510SRong-En Fan><DT
339*4a1a9510SRong-En Fan>1.6.1. <A
340*4a1a9510SRong-En FanHREF="#LISTFORMATS"
341*4a1a9510SRong-En Fan>Readily available formats from tldp.org</A
342*4a1a9510SRong-En Fan></DT
343*4a1a9510SRong-En Fan><DT
344*4a1a9510SRong-En Fan>1.6.2. <A
345*4a1a9510SRong-En FanHREF="#BUILDSOURCE"
346*4a1a9510SRong-En Fan>Building from source</A
347*4a1a9510SRong-En Fan></DT
348*4a1a9510SRong-En Fan></DL
349*4a1a9510SRong-En Fan></DD
350*4a1a9510SRong-En Fan><DT
351*4a1a9510SRong-En Fan>1.7. <A
352*4a1a9510SRong-En FanHREF="#CREDITS"
353*4a1a9510SRong-En Fan>Credits</A
354*4a1a9510SRong-En Fan></DT
355*4a1a9510SRong-En Fan><DT
356*4a1a9510SRong-En Fan>1.8. <A
357*4a1a9510SRong-En FanHREF="#WISHLIST"
358*4a1a9510SRong-En Fan>Wish List</A
359*4a1a9510SRong-En Fan></DT
360*4a1a9510SRong-En Fan><DT
361*4a1a9510SRong-En Fan>1.9. <A
362*4a1a9510SRong-En FanHREF="#COPYRIGHT"
363*4a1a9510SRong-En Fan>Copyright</A
364*4a1a9510SRong-En Fan></DT
365*4a1a9510SRong-En Fan></DL
366*4a1a9510SRong-En Fan></DD
367*4a1a9510SRong-En Fan><DT
368*4a1a9510SRong-En Fan>2. <A
369*4a1a9510SRong-En FanHREF="#HELLOWORLD"
370*4a1a9510SRong-En Fan>Hello World !!!</A
371*4a1a9510SRong-En Fan></DT
372*4a1a9510SRong-En Fan><DD
373*4a1a9510SRong-En Fan><DL
374*4a1a9510SRong-En Fan><DT
375*4a1a9510SRong-En Fan>2.1. <A
376*4a1a9510SRong-En FanHREF="#COMPILECURSES"
377*4a1a9510SRong-En Fan>Compiling With the NCURSES Library</A
378*4a1a9510SRong-En Fan></DT
379*4a1a9510SRong-En Fan><DT
380*4a1a9510SRong-En Fan>2.2. <A
381*4a1a9510SRong-En FanHREF="#DISSECTION"
382*4a1a9510SRong-En Fan>Dissection</A
383*4a1a9510SRong-En Fan></DT
384*4a1a9510SRong-En Fan><DD
385*4a1a9510SRong-En Fan><DL
386*4a1a9510SRong-En Fan><DT
387*4a1a9510SRong-En Fan>2.2.1. <A
388*4a1a9510SRong-En FanHREF="#ABOUT-INITSCR"
389*4a1a9510SRong-En Fan>About initscr()</A
390*4a1a9510SRong-En Fan></DT
391*4a1a9510SRong-En Fan><DT
392*4a1a9510SRong-En Fan>2.2.2. <A
393*4a1a9510SRong-En FanHREF="#MYST-REFRESH"
394*4a1a9510SRong-En Fan>The mysterious refresh()</A
395*4a1a9510SRong-En Fan></DT
396*4a1a9510SRong-En Fan><DT
397*4a1a9510SRong-En Fan>2.2.3. <A
398*4a1a9510SRong-En FanHREF="#ABOUT-ENDWIN"
399*4a1a9510SRong-En Fan>About endwin()</A
400*4a1a9510SRong-En Fan></DT
401*4a1a9510SRong-En Fan></DL
402*4a1a9510SRong-En Fan></DD
403*4a1a9510SRong-En Fan></DL
404*4a1a9510SRong-En Fan></DD
405*4a1a9510SRong-En Fan><DT
406*4a1a9510SRong-En Fan>3. <A
407*4a1a9510SRong-En FanHREF="#GORY"
408*4a1a9510SRong-En Fan>The Gory Details</A
409*4a1a9510SRong-En Fan></DT
410*4a1a9510SRong-En Fan><DT
411*4a1a9510SRong-En Fan>4. <A
412*4a1a9510SRong-En FanHREF="#INIT"
413*4a1a9510SRong-En Fan>Initialization</A
414*4a1a9510SRong-En Fan></DT
415*4a1a9510SRong-En Fan><DD
416*4a1a9510SRong-En Fan><DL
417*4a1a9510SRong-En Fan><DT
418*4a1a9510SRong-En Fan>4.1. <A
419*4a1a9510SRong-En FanHREF="#ABOUTINIT"
420*4a1a9510SRong-En Fan>Initialization functions</A
421*4a1a9510SRong-En Fan></DT
422*4a1a9510SRong-En Fan><DT
423*4a1a9510SRong-En Fan>4.2. <A
424*4a1a9510SRong-En FanHREF="#RAWCBREAK"
425*4a1a9510SRong-En Fan>raw() and cbreak()</A
426*4a1a9510SRong-En Fan></DT
427*4a1a9510SRong-En Fan><DT
428*4a1a9510SRong-En Fan>4.3. <A
429*4a1a9510SRong-En FanHREF="#ECHONOECHO"
430*4a1a9510SRong-En Fan>echo() and noecho()</A
431*4a1a9510SRong-En Fan></DT
432*4a1a9510SRong-En Fan><DT
433*4a1a9510SRong-En Fan>4.4. <A
434*4a1a9510SRong-En FanHREF="#KEYPAD"
435*4a1a9510SRong-En Fan>keypad()</A
436*4a1a9510SRong-En Fan></DT
437*4a1a9510SRong-En Fan><DT
438*4a1a9510SRong-En Fan>4.5. <A
439*4a1a9510SRong-En FanHREF="#HALFDELAY"
440*4a1a9510SRong-En Fan>halfdelay()</A
441*4a1a9510SRong-En Fan></DT
442*4a1a9510SRong-En Fan><DT
443*4a1a9510SRong-En Fan>4.6. <A
444*4a1a9510SRong-En FanHREF="#MISCINIT"
445*4a1a9510SRong-En Fan>Miscellaneous Initialization functions</A
446*4a1a9510SRong-En Fan></DT
447*4a1a9510SRong-En Fan><DT
448*4a1a9510SRong-En Fan>4.7. <A
449*4a1a9510SRong-En FanHREF="#INITEX"
450*4a1a9510SRong-En Fan>An Example</A
451*4a1a9510SRong-En Fan></DT
452*4a1a9510SRong-En Fan></DL
453*4a1a9510SRong-En Fan></DD
454*4a1a9510SRong-En Fan><DT
455*4a1a9510SRong-En Fan>5. <A
456*4a1a9510SRong-En FanHREF="#AWORDWINDOWS"
457*4a1a9510SRong-En Fan>A Word about Windows</A
458*4a1a9510SRong-En Fan></DT
459*4a1a9510SRong-En Fan><DT
460*4a1a9510SRong-En Fan>6. <A
461*4a1a9510SRong-En FanHREF="#PRINTW"
462*4a1a9510SRong-En Fan>Output functions</A
463*4a1a9510SRong-En Fan></DT
464*4a1a9510SRong-En Fan><DD
465*4a1a9510SRong-En Fan><DL
466*4a1a9510SRong-En Fan><DT
467*4a1a9510SRong-En Fan>6.1. <A
468*4a1a9510SRong-En FanHREF="#ADDCHCLASS"
469*4a1a9510SRong-En Fan>addch() class of functions</A
470*4a1a9510SRong-En Fan></DT
471*4a1a9510SRong-En Fan><DT
472*4a1a9510SRong-En Fan>6.2. <A
473*4a1a9510SRong-En FanHREF="#AEN298"
474*4a1a9510SRong-En Fan>mvaddch(), waddch() and mvwaddch()</A
475*4a1a9510SRong-En Fan></DT
476*4a1a9510SRong-En Fan><DT
477*4a1a9510SRong-En Fan>6.3. <A
478*4a1a9510SRong-En FanHREF="#PRINTWCLASS"
479*4a1a9510SRong-En Fan>printw() class of functions</A
480*4a1a9510SRong-En Fan></DT
481*4a1a9510SRong-En Fan><DD
482*4a1a9510SRong-En Fan><DL
483*4a1a9510SRong-En Fan><DT
484*4a1a9510SRong-En Fan>6.3.1. <A
485*4a1a9510SRong-En FanHREF="#PRINTWMVPRINTW"
486*4a1a9510SRong-En Fan>printw() and mvprintw</A
487*4a1a9510SRong-En Fan></DT
488*4a1a9510SRong-En Fan><DT
489*4a1a9510SRong-En Fan>6.3.2. <A
490*4a1a9510SRong-En FanHREF="#WPRINTWMVWPRINTW"
491*4a1a9510SRong-En Fan>wprintw() and mvwprintw</A
492*4a1a9510SRong-En Fan></DT
493*4a1a9510SRong-En Fan><DT
494*4a1a9510SRong-En Fan>6.3.3. <A
495*4a1a9510SRong-En FanHREF="#VWPRINTW"
496*4a1a9510SRong-En Fan>vwprintw()</A
497*4a1a9510SRong-En Fan></DT
498*4a1a9510SRong-En Fan><DT
499*4a1a9510SRong-En Fan>6.3.4. <A
500*4a1a9510SRong-En FanHREF="#SIMPLEPRINTWEX"
501*4a1a9510SRong-En Fan>A Simple printw example</A
502*4a1a9510SRong-En Fan></DT
503*4a1a9510SRong-En Fan></DL
504*4a1a9510SRong-En Fan></DD
505*4a1a9510SRong-En Fan><DT
506*4a1a9510SRong-En Fan>6.4. <A
507*4a1a9510SRong-En FanHREF="#ADDSTRCLASS"
508*4a1a9510SRong-En Fan>addstr() class of functions</A
509*4a1a9510SRong-En Fan></DT
510*4a1a9510SRong-En Fan><DT
511*4a1a9510SRong-En Fan>6.5. <A
512*4a1a9510SRong-En FanHREF="#ACAUTION"
513*4a1a9510SRong-En Fan>A word of caution</A
514*4a1a9510SRong-En Fan></DT
515*4a1a9510SRong-En Fan></DL
516*4a1a9510SRong-En Fan></DD
517*4a1a9510SRong-En Fan><DT
518*4a1a9510SRong-En Fan>7. <A
519*4a1a9510SRong-En FanHREF="#SCANW"
520*4a1a9510SRong-En Fan>Input functions</A
521*4a1a9510SRong-En Fan></DT
522*4a1a9510SRong-En Fan><DD
523*4a1a9510SRong-En Fan><DL
524*4a1a9510SRong-En Fan><DT
525*4a1a9510SRong-En Fan>7.1. <A
526*4a1a9510SRong-En FanHREF="#GETCHCLASS"
527*4a1a9510SRong-En Fan>getch() class of functions</A
528*4a1a9510SRong-En Fan></DT
529*4a1a9510SRong-En Fan><DT
530*4a1a9510SRong-En Fan>7.2. <A
531*4a1a9510SRong-En FanHREF="#SCANWCLASS"
532*4a1a9510SRong-En Fan>scanw() class of functions</A
533*4a1a9510SRong-En Fan></DT
534*4a1a9510SRong-En Fan><DD
535*4a1a9510SRong-En Fan><DL
536*4a1a9510SRong-En Fan><DT
537*4a1a9510SRong-En Fan>7.2.1. <A
538*4a1a9510SRong-En FanHREF="#SCANWMVSCANW"
539*4a1a9510SRong-En Fan>scanw() and mvscanw</A
540*4a1a9510SRong-En Fan></DT
541*4a1a9510SRong-En Fan><DT
542*4a1a9510SRong-En Fan>7.2.2. <A
543*4a1a9510SRong-En FanHREF="#WSCANWMVWSCANW"
544*4a1a9510SRong-En Fan>wscanw() and mvwscanw()</A
545*4a1a9510SRong-En Fan></DT
546*4a1a9510SRong-En Fan><DT
547*4a1a9510SRong-En Fan>7.2.3. <A
548*4a1a9510SRong-En FanHREF="#VWSCANW"
549*4a1a9510SRong-En Fan>vwscanw()</A
550*4a1a9510SRong-En Fan></DT
551*4a1a9510SRong-En Fan></DL
552*4a1a9510SRong-En Fan></DD
553*4a1a9510SRong-En Fan><DT
554*4a1a9510SRong-En Fan>7.3. <A
555*4a1a9510SRong-En FanHREF="#GETSTRCLASS"
556*4a1a9510SRong-En Fan>getstr() class of functions</A
557*4a1a9510SRong-En Fan></DT
558*4a1a9510SRong-En Fan><DT
559*4a1a9510SRong-En Fan>7.4. <A
560*4a1a9510SRong-En FanHREF="#GETSTREX"
561*4a1a9510SRong-En Fan>Some examples</A
562*4a1a9510SRong-En Fan></DT
563*4a1a9510SRong-En Fan></DL
564*4a1a9510SRong-En Fan></DD
565*4a1a9510SRong-En Fan><DT
566*4a1a9510SRong-En Fan>8. <A
567*4a1a9510SRong-En FanHREF="#ATTRIB"
568*4a1a9510SRong-En Fan>Attributes</A
569*4a1a9510SRong-En Fan></DT
570*4a1a9510SRong-En Fan><DD
571*4a1a9510SRong-En Fan><DL
572*4a1a9510SRong-En Fan><DT
573*4a1a9510SRong-En Fan>8.1. <A
574*4a1a9510SRong-En FanHREF="#ATTRIBDETAILS"
575*4a1a9510SRong-En Fan>The details</A
576*4a1a9510SRong-En Fan></DT
577*4a1a9510SRong-En Fan><DT
578*4a1a9510SRong-En Fan>8.2. <A
579*4a1a9510SRong-En FanHREF="#ATTRONVSATTRSET"
580*4a1a9510SRong-En Fan>attron() vs attrset()</A
581*4a1a9510SRong-En Fan></DT
582*4a1a9510SRong-En Fan><DT
583*4a1a9510SRong-En Fan>8.3. <A
584*4a1a9510SRong-En FanHREF="#ATTR_GET"
585*4a1a9510SRong-En Fan>attr_get()</A
586*4a1a9510SRong-En Fan></DT
587*4a1a9510SRong-En Fan><DT
588*4a1a9510SRong-En Fan>8.4. <A
589*4a1a9510SRong-En FanHREF="#ATTR_FUNCS"
590*4a1a9510SRong-En Fan>attr_ functions</A
591*4a1a9510SRong-En Fan></DT
592*4a1a9510SRong-En Fan><DT
593*4a1a9510SRong-En Fan>8.5. <A
594*4a1a9510SRong-En FanHREF="#WATTRFUNCS"
595*4a1a9510SRong-En Fan>wattr functions</A
596*4a1a9510SRong-En Fan></DT
597*4a1a9510SRong-En Fan><DT
598*4a1a9510SRong-En Fan>8.6. <A
599*4a1a9510SRong-En FanHREF="#CHGAT"
600*4a1a9510SRong-En Fan>chgat() functions</A
601*4a1a9510SRong-En Fan></DT
602*4a1a9510SRong-En Fan></DL
603*4a1a9510SRong-En Fan></DD
604*4a1a9510SRong-En Fan><DT
605*4a1a9510SRong-En Fan>9. <A
606*4a1a9510SRong-En FanHREF="#WINDOWS"
607*4a1a9510SRong-En Fan>Windows</A
608*4a1a9510SRong-En Fan></DT
609*4a1a9510SRong-En Fan><DD
610*4a1a9510SRong-En Fan><DL
611*4a1a9510SRong-En Fan><DT
612*4a1a9510SRong-En Fan>9.1. <A
613*4a1a9510SRong-En FanHREF="#WINDOWBASICS"
614*4a1a9510SRong-En Fan>The basics</A
615*4a1a9510SRong-En Fan></DT
616*4a1a9510SRong-En Fan><DT
617*4a1a9510SRong-En Fan>9.2. <A
618*4a1a9510SRong-En FanHREF="#LETBEWINDOW"
619*4a1a9510SRong-En Fan>Let there be a Window !!!</A
620*4a1a9510SRong-En Fan></DT
621*4a1a9510SRong-En Fan><DT
622*4a1a9510SRong-En Fan>9.3. <A
623*4a1a9510SRong-En FanHREF="#BORDEREXEXPL"
624*4a1a9510SRong-En Fan>Explanation</A
625*4a1a9510SRong-En Fan></DT
626*4a1a9510SRong-En Fan><DT
627*4a1a9510SRong-En Fan>9.4. <A
628*4a1a9510SRong-En FanHREF="#OTHERSTUFF"
629*4a1a9510SRong-En Fan>The other stuff in the example</A
630*4a1a9510SRong-En Fan></DT
631*4a1a9510SRong-En Fan><DT
632*4a1a9510SRong-En Fan>9.5. <A
633*4a1a9510SRong-En FanHREF="#OTHERBORDERFUNCS"
634*4a1a9510SRong-En Fan>Other Border functions</A
635*4a1a9510SRong-En Fan></DT
636*4a1a9510SRong-En Fan></DL
637*4a1a9510SRong-En Fan></DD
638*4a1a9510SRong-En Fan><DT
639*4a1a9510SRong-En Fan>10. <A
640*4a1a9510SRong-En FanHREF="#COLOR"
641*4a1a9510SRong-En Fan>Colors</A
642*4a1a9510SRong-En Fan></DT
643*4a1a9510SRong-En Fan><DD
644*4a1a9510SRong-En Fan><DL
645*4a1a9510SRong-En Fan><DT
646*4a1a9510SRong-En Fan>10.1. <A
647*4a1a9510SRong-En FanHREF="#COLORBASICS"
648*4a1a9510SRong-En Fan>The basics</A
649*4a1a9510SRong-En Fan></DT
650*4a1a9510SRong-En Fan><DT
651*4a1a9510SRong-En Fan>10.2. <A
652*4a1a9510SRong-En FanHREF="#CHANGECOLORDEFS"
653*4a1a9510SRong-En Fan>Changing Color Definitions</A
654*4a1a9510SRong-En Fan></DT
655*4a1a9510SRong-En Fan><DT
656*4a1a9510SRong-En Fan>10.3. <A
657*4a1a9510SRong-En FanHREF="#COLORCONTENT"
658*4a1a9510SRong-En Fan>Color Content</A
659*4a1a9510SRong-En Fan></DT
660*4a1a9510SRong-En Fan></DL
661*4a1a9510SRong-En Fan></DD
662*4a1a9510SRong-En Fan><DT
663*4a1a9510SRong-En Fan>11. <A
664*4a1a9510SRong-En FanHREF="#KEYS"
665*4a1a9510SRong-En Fan>Interfacing with the key board</A
666*4a1a9510SRong-En Fan></DT
667*4a1a9510SRong-En Fan><DD
668*4a1a9510SRong-En Fan><DL
669*4a1a9510SRong-En Fan><DT
670*4a1a9510SRong-En Fan>11.1. <A
671*4a1a9510SRong-En FanHREF="#KEYSBASICS"
672*4a1a9510SRong-En Fan>The Basics</A
673*4a1a9510SRong-En Fan></DT
674*4a1a9510SRong-En Fan><DT
675*4a1a9510SRong-En Fan>11.2. <A
676*4a1a9510SRong-En FanHREF="#SIMPLEKEYEX"
677*4a1a9510SRong-En Fan>A Simple Key Usage example</A
678*4a1a9510SRong-En Fan></DT
679*4a1a9510SRong-En Fan></DL
680*4a1a9510SRong-En Fan></DD
681*4a1a9510SRong-En Fan><DT
682*4a1a9510SRong-En Fan>12. <A
683*4a1a9510SRong-En FanHREF="#MOUSE"
684*4a1a9510SRong-En Fan>Interfacing with the mouse</A
685*4a1a9510SRong-En Fan></DT
686*4a1a9510SRong-En Fan><DD
687*4a1a9510SRong-En Fan><DL
688*4a1a9510SRong-En Fan><DT
689*4a1a9510SRong-En Fan>12.1. <A
690*4a1a9510SRong-En FanHREF="#MOUSEBASICS"
691*4a1a9510SRong-En Fan>The Basics</A
692*4a1a9510SRong-En Fan></DT
693*4a1a9510SRong-En Fan><DT
694*4a1a9510SRong-En Fan>12.2. <A
695*4a1a9510SRong-En FanHREF="#GETTINGEVENTS"
696*4a1a9510SRong-En Fan>Getting the events</A
697*4a1a9510SRong-En Fan></DT
698*4a1a9510SRong-En Fan><DT
699*4a1a9510SRong-En Fan>12.3. <A
700*4a1a9510SRong-En FanHREF="#MOUSETOGETHER"
701*4a1a9510SRong-En Fan>Putting it all Together</A
702*4a1a9510SRong-En Fan></DT
703*4a1a9510SRong-En Fan><DT
704*4a1a9510SRong-En Fan>12.4. <A
705*4a1a9510SRong-En FanHREF="#MISCMOUSEFUNCS"
706*4a1a9510SRong-En Fan>Miscellaneous Functions</A
707*4a1a9510SRong-En Fan></DT
708*4a1a9510SRong-En Fan></DL
709*4a1a9510SRong-En Fan></DD
710*4a1a9510SRong-En Fan><DT
711*4a1a9510SRong-En Fan>13. <A
712*4a1a9510SRong-En FanHREF="#SCREEN"
713*4a1a9510SRong-En Fan>Screen Manipulation</A
714*4a1a9510SRong-En Fan></DT
715*4a1a9510SRong-En Fan><DD
716*4a1a9510SRong-En Fan><DL
717*4a1a9510SRong-En Fan><DT
718*4a1a9510SRong-En Fan>13.1. <A
719*4a1a9510SRong-En FanHREF="#GETYX"
720*4a1a9510SRong-En Fan>getyx() functions</A
721*4a1a9510SRong-En Fan></DT
722*4a1a9510SRong-En Fan><DT
723*4a1a9510SRong-En Fan>13.2. <A
724*4a1a9510SRong-En FanHREF="#SCREENDUMP"
725*4a1a9510SRong-En Fan>Screen Dumping</A
726*4a1a9510SRong-En Fan></DT
727*4a1a9510SRong-En Fan><DT
728*4a1a9510SRong-En Fan>13.3. <A
729*4a1a9510SRong-En FanHREF="#WINDOWDUMP"
730*4a1a9510SRong-En Fan>Window Dumping</A
731*4a1a9510SRong-En Fan></DT
732*4a1a9510SRong-En Fan></DL
733*4a1a9510SRong-En Fan></DD
734*4a1a9510SRong-En Fan><DT
735*4a1a9510SRong-En Fan>14. <A
736*4a1a9510SRong-En FanHREF="#MISC"
737*4a1a9510SRong-En Fan>Miscellaneous features</A
738*4a1a9510SRong-En Fan></DT
739*4a1a9510SRong-En Fan><DD
740*4a1a9510SRong-En Fan><DL
741*4a1a9510SRong-En Fan><DT
742*4a1a9510SRong-En Fan>14.1. <A
743*4a1a9510SRong-En FanHREF="#CURSSET"
744*4a1a9510SRong-En Fan>curs_set()</A
745*4a1a9510SRong-En Fan></DT
746*4a1a9510SRong-En Fan><DT
747*4a1a9510SRong-En Fan>14.2. <A
748*4a1a9510SRong-En FanHREF="#TEMPLEAVE"
749*4a1a9510SRong-En Fan>Temporarily Leaving Curses mode</A
750*4a1a9510SRong-En Fan></DT
751*4a1a9510SRong-En Fan><DT
752*4a1a9510SRong-En Fan>14.3. <A
753*4a1a9510SRong-En FanHREF="#ACSVARS"
754*4a1a9510SRong-En Fan>ACS_ variables</A
755*4a1a9510SRong-En Fan></DT
756*4a1a9510SRong-En Fan></DL
757*4a1a9510SRong-En Fan></DD
758*4a1a9510SRong-En Fan><DT
759*4a1a9510SRong-En Fan>15. <A
760*4a1a9510SRong-En FanHREF="#OTHERLIB"
761*4a1a9510SRong-En Fan>Other libraries</A
762*4a1a9510SRong-En Fan></DT
763*4a1a9510SRong-En Fan><DT
764*4a1a9510SRong-En Fan>16. <A
765*4a1a9510SRong-En FanHREF="#PANELS"
766*4a1a9510SRong-En Fan>Panel Library</A
767*4a1a9510SRong-En Fan></DT
768*4a1a9510SRong-En Fan><DD
769*4a1a9510SRong-En Fan><DL
770*4a1a9510SRong-En Fan><DT
771*4a1a9510SRong-En Fan>16.1. <A
772*4a1a9510SRong-En FanHREF="#PANELBASICS"
773*4a1a9510SRong-En Fan>The Basics</A
774*4a1a9510SRong-En Fan></DT
775*4a1a9510SRong-En Fan><DT
776*4a1a9510SRong-En Fan>16.2. <A
777*4a1a9510SRong-En FanHREF="#COMPILEPANELS"
778*4a1a9510SRong-En Fan>Compiling With the Panels Library</A
779*4a1a9510SRong-En Fan></DT
780*4a1a9510SRong-En Fan><DT
781*4a1a9510SRong-En Fan>16.3. <A
782*4a1a9510SRong-En FanHREF="#PANELBROWSING"
783*4a1a9510SRong-En Fan>Panel Window Browsing</A
784*4a1a9510SRong-En Fan></DT
785*4a1a9510SRong-En Fan><DT
786*4a1a9510SRong-En Fan>16.4. <A
787*4a1a9510SRong-En FanHREF="#USERPTRUSING"
788*4a1a9510SRong-En Fan>Using User Pointers</A
789*4a1a9510SRong-En Fan></DT
790*4a1a9510SRong-En Fan><DT
791*4a1a9510SRong-En Fan>16.5. <A
792*4a1a9510SRong-En FanHREF="#PANELMOVERESIZE"
793*4a1a9510SRong-En Fan>Moving and Resizing Panels</A
794*4a1a9510SRong-En Fan></DT
795*4a1a9510SRong-En Fan><DT
796*4a1a9510SRong-En Fan>16.6. <A
797*4a1a9510SRong-En FanHREF="#PANELSHOWHIDE"
798*4a1a9510SRong-En Fan>Hiding and Showing Panels</A
799*4a1a9510SRong-En Fan></DT
800*4a1a9510SRong-En Fan><DT
801*4a1a9510SRong-En Fan>16.7. <A
802*4a1a9510SRong-En FanHREF="#PANELABOVE"
803*4a1a9510SRong-En Fan>panel_above() and panel_below() Functions</A
804*4a1a9510SRong-En Fan></DT
805*4a1a9510SRong-En Fan></DL
806*4a1a9510SRong-En Fan></DD
807*4a1a9510SRong-En Fan><DT
808*4a1a9510SRong-En Fan>17. <A
809*4a1a9510SRong-En FanHREF="#MENUS"
810*4a1a9510SRong-En Fan>Menus Library</A
811*4a1a9510SRong-En Fan></DT
812*4a1a9510SRong-En Fan><DD
813*4a1a9510SRong-En Fan><DL
814*4a1a9510SRong-En Fan><DT
815*4a1a9510SRong-En Fan>17.1. <A
816*4a1a9510SRong-En FanHREF="#MENUBASICS"
817*4a1a9510SRong-En Fan>The Basics</A
818*4a1a9510SRong-En Fan></DT
819*4a1a9510SRong-En Fan><DT
820*4a1a9510SRong-En Fan>17.2. <A
821*4a1a9510SRong-En FanHREF="#COMPILEMENUS"
822*4a1a9510SRong-En Fan>Compiling With the Menu Library</A
823*4a1a9510SRong-En Fan></DT
824*4a1a9510SRong-En Fan><DT
825*4a1a9510SRong-En Fan>17.3. <A
826*4a1a9510SRong-En FanHREF="#MENUDRIVER"
827*4a1a9510SRong-En Fan>Menu Driver: The work horse of the menu system</A
828*4a1a9510SRong-En Fan></DT
829*4a1a9510SRong-En Fan><DT
830*4a1a9510SRong-En Fan>17.4. <A
831*4a1a9510SRong-En FanHREF="#MENUWINDOWS"
832*4a1a9510SRong-En Fan>Menu Windows</A
833*4a1a9510SRong-En Fan></DT
834*4a1a9510SRong-En Fan><DT
835*4a1a9510SRong-En Fan>17.5. <A
836*4a1a9510SRong-En FanHREF="#SCROLLMENUS"
837*4a1a9510SRong-En Fan>Scrolling Menus</A
838*4a1a9510SRong-En Fan></DT
839*4a1a9510SRong-En Fan><DT
840*4a1a9510SRong-En Fan>17.6. <A
841*4a1a9510SRong-En FanHREF="#MULTICOLUMN"
842*4a1a9510SRong-En Fan>Multi Columnar Menus</A
843*4a1a9510SRong-En Fan></DT
844*4a1a9510SRong-En Fan><DT
845*4a1a9510SRong-En Fan>17.7. <A
846*4a1a9510SRong-En FanHREF="#MULTIVALUEMENUS"
847*4a1a9510SRong-En Fan>Multi Valued Menus</A
848*4a1a9510SRong-En Fan></DT
849*4a1a9510SRong-En Fan><DT
850*4a1a9510SRong-En Fan>17.8. <A
851*4a1a9510SRong-En FanHREF="#MENUOPT"
852*4a1a9510SRong-En Fan>Menu Options</A
853*4a1a9510SRong-En Fan></DT
854*4a1a9510SRong-En Fan><DT
855*4a1a9510SRong-En Fan>17.9. <A
856*4a1a9510SRong-En FanHREF="#MENUUSERPTR"
857*4a1a9510SRong-En Fan>The useful User Pointer</A
858*4a1a9510SRong-En Fan></DT
859*4a1a9510SRong-En Fan></DL
860*4a1a9510SRong-En Fan></DD
861*4a1a9510SRong-En Fan><DT
862*4a1a9510SRong-En Fan>18. <A
863*4a1a9510SRong-En FanHREF="#FORMS"
864*4a1a9510SRong-En Fan>Forms Library</A
865*4a1a9510SRong-En Fan></DT
866*4a1a9510SRong-En Fan><DD
867*4a1a9510SRong-En Fan><DL
868*4a1a9510SRong-En Fan><DT
869*4a1a9510SRong-En Fan>18.1. <A
870*4a1a9510SRong-En FanHREF="#FORMBASICS"
871*4a1a9510SRong-En Fan>The Basics</A
872*4a1a9510SRong-En Fan></DT
873*4a1a9510SRong-En Fan><DT
874*4a1a9510SRong-En Fan>18.2. <A
875*4a1a9510SRong-En FanHREF="#COMPILEFORMS"
876*4a1a9510SRong-En Fan>Compiling With the Forms Library</A
877*4a1a9510SRong-En Fan></DT
878*4a1a9510SRong-En Fan><DT
879*4a1a9510SRong-En Fan>18.3. <A
880*4a1a9510SRong-En FanHREF="#PLAYFIELDS"
881*4a1a9510SRong-En Fan>Playing with Fields</A
882*4a1a9510SRong-En Fan></DT
883*4a1a9510SRong-En Fan><DD
884*4a1a9510SRong-En Fan><DL
885*4a1a9510SRong-En Fan><DT
886*4a1a9510SRong-En Fan>18.3.1. <A
887*4a1a9510SRong-En FanHREF="#FETCHINFO"
888*4a1a9510SRong-En Fan>Fetching Size and Location of Field</A
889*4a1a9510SRong-En Fan></DT
890*4a1a9510SRong-En Fan><DT
891*4a1a9510SRong-En Fan>18.3.2. <A
892*4a1a9510SRong-En FanHREF="#MOVEFIELD"
893*4a1a9510SRong-En Fan>Moving the field</A
894*4a1a9510SRong-En Fan></DT
895*4a1a9510SRong-En Fan><DT
896*4a1a9510SRong-En Fan>18.3.3. <A
897*4a1a9510SRong-En FanHREF="#JUSTIFYFIELD"
898*4a1a9510SRong-En Fan>Field Justification</A
899*4a1a9510SRong-En Fan></DT
900*4a1a9510SRong-En Fan><DT
901*4a1a9510SRong-En Fan>18.3.4. <A
902*4a1a9510SRong-En FanHREF="#FIELDDISPATTRIB"
903*4a1a9510SRong-En Fan>Field Display Attributes</A
904*4a1a9510SRong-En Fan></DT
905*4a1a9510SRong-En Fan><DT
906*4a1a9510SRong-En Fan>18.3.5. <A
907*4a1a9510SRong-En FanHREF="#FIELDOPTIONBITS"
908*4a1a9510SRong-En Fan>Field Option Bits</A
909*4a1a9510SRong-En Fan></DT
910*4a1a9510SRong-En Fan><DT
911*4a1a9510SRong-En Fan>18.3.6. <A
912*4a1a9510SRong-En FanHREF="#FIELDSTATUS"
913*4a1a9510SRong-En Fan>Field Status</A
914*4a1a9510SRong-En Fan></DT
915*4a1a9510SRong-En Fan><DT
916*4a1a9510SRong-En Fan>18.3.7. <A
917*4a1a9510SRong-En FanHREF="#FIELDUSERPTR"
918*4a1a9510SRong-En Fan>Field User Pointer</A
919*4a1a9510SRong-En Fan></DT
920*4a1a9510SRong-En Fan><DT
921*4a1a9510SRong-En Fan>18.3.8. <A
922*4a1a9510SRong-En FanHREF="#VARIABLESIZEFIELDS"
923*4a1a9510SRong-En Fan>Variable-Sized Fields</A
924*4a1a9510SRong-En Fan></DT
925*4a1a9510SRong-En Fan></DL
926*4a1a9510SRong-En Fan></DD
927*4a1a9510SRong-En Fan><DT
928*4a1a9510SRong-En Fan>18.4. <A
929*4a1a9510SRong-En FanHREF="#FORMWINDOWS"
930*4a1a9510SRong-En Fan>Form Windows</A
931*4a1a9510SRong-En Fan></DT
932*4a1a9510SRong-En Fan><DT
933*4a1a9510SRong-En Fan>18.5. <A
934*4a1a9510SRong-En FanHREF="#FILEDVALIDATE"
935*4a1a9510SRong-En Fan>Field Validation</A
936*4a1a9510SRong-En Fan></DT
937*4a1a9510SRong-En Fan><DT
938*4a1a9510SRong-En Fan>18.6. <A
939*4a1a9510SRong-En FanHREF="#FORMDRIVER"
940*4a1a9510SRong-En Fan>Form Driver: The work horse of the forms system</A
941*4a1a9510SRong-En Fan></DT
942*4a1a9510SRong-En Fan><DD
943*4a1a9510SRong-En Fan><DL
944*4a1a9510SRong-En Fan><DT
945*4a1a9510SRong-En Fan>18.6.1. <A
946*4a1a9510SRong-En FanHREF="#PAGENAVREQ"
947*4a1a9510SRong-En Fan>Page Navigation Requests</A
948*4a1a9510SRong-En Fan></DT
949*4a1a9510SRong-En Fan><DT
950*4a1a9510SRong-En Fan>18.6.2. <A
951*4a1a9510SRong-En FanHREF="#INTERFIELDNAVREQ"
952*4a1a9510SRong-En Fan>Inter-Field Navigation Requests</A
953*4a1a9510SRong-En Fan></DT
954*4a1a9510SRong-En Fan><DT
955*4a1a9510SRong-En Fan>18.6.3. <A
956*4a1a9510SRong-En FanHREF="#INTRAFIELDNAVREQ"
957*4a1a9510SRong-En Fan>Intra-Field Navigation Requests</A
958*4a1a9510SRong-En Fan></DT
959*4a1a9510SRong-En Fan><DT
960*4a1a9510SRong-En Fan>18.6.4. <A
961*4a1a9510SRong-En FanHREF="#SCROLLREQ"
962*4a1a9510SRong-En Fan>Scrolling Requests</A
963*4a1a9510SRong-En Fan></DT
964*4a1a9510SRong-En Fan><DT
965*4a1a9510SRong-En Fan>18.6.5. <A
966*4a1a9510SRong-En FanHREF="#EDITREQ"
967*4a1a9510SRong-En Fan>Editing Requests</A
968*4a1a9510SRong-En Fan></DT
969*4a1a9510SRong-En Fan><DT
970*4a1a9510SRong-En Fan>18.6.6. <A
971*4a1a9510SRong-En FanHREF="#ORDERREQ"
972*4a1a9510SRong-En Fan>Order Requests</A
973*4a1a9510SRong-En Fan></DT
974*4a1a9510SRong-En Fan><DT
975*4a1a9510SRong-En Fan>18.6.7. <A
976*4a1a9510SRong-En FanHREF="#APPLICCOMMANDS"
977*4a1a9510SRong-En Fan>Application Commands</A
978*4a1a9510SRong-En Fan></DT
979*4a1a9510SRong-En Fan></DL
980*4a1a9510SRong-En Fan></DD
981*4a1a9510SRong-En Fan></DL
982*4a1a9510SRong-En Fan></DD
983*4a1a9510SRong-En Fan><DT
984*4a1a9510SRong-En Fan>19. <A
985*4a1a9510SRong-En FanHREF="#TOOLS"
986*4a1a9510SRong-En Fan>Tools and Widget Libraries</A
987*4a1a9510SRong-En Fan></DT
988*4a1a9510SRong-En Fan><DD
989*4a1a9510SRong-En Fan><DL
990*4a1a9510SRong-En Fan><DT
991*4a1a9510SRong-En Fan>19.1. <A
992*4a1a9510SRong-En FanHREF="#CDK"
993*4a1a9510SRong-En Fan>CDK (Curses Development Kit)</A
994*4a1a9510SRong-En Fan></DT
995*4a1a9510SRong-En Fan><DD
996*4a1a9510SRong-En Fan><DL
997*4a1a9510SRong-En Fan><DT
998*4a1a9510SRong-En Fan>19.1.1. <A
999*4a1a9510SRong-En FanHREF="#WIDGETLIST"
1000*4a1a9510SRong-En Fan>Widget List</A
1001*4a1a9510SRong-En Fan></DT
1002*4a1a9510SRong-En Fan><DT
1003*4a1a9510SRong-En Fan>19.1.2. <A
1004*4a1a9510SRong-En FanHREF="#CDKATTRACT"
1005*4a1a9510SRong-En Fan>Some Attractive Features</A
1006*4a1a9510SRong-En Fan></DT
1007*4a1a9510SRong-En Fan><DT
1008*4a1a9510SRong-En Fan>19.1.3. <A
1009*4a1a9510SRong-En FanHREF="#CDKCONCLUSION"
1010*4a1a9510SRong-En Fan>Conclusion</A
1011*4a1a9510SRong-En Fan></DT
1012*4a1a9510SRong-En Fan></DL
1013*4a1a9510SRong-En Fan></DD
1014*4a1a9510SRong-En Fan><DT
1015*4a1a9510SRong-En Fan>19.2. <A
1016*4a1a9510SRong-En FanHREF="#DIALOG"
1017*4a1a9510SRong-En Fan>The dialog</A
1018*4a1a9510SRong-En Fan></DT
1019*4a1a9510SRong-En Fan><DT
1020*4a1a9510SRong-En Fan>19.3. <A
1021*4a1a9510SRong-En FanHREF="#PERLCURSES"
1022*4a1a9510SRong-En Fan>Perl Curses Modules CURSES::FORM and CURSES::WIDGETS</A
1023*4a1a9510SRong-En Fan></DT
1024*4a1a9510SRong-En Fan></DL
1025*4a1a9510SRong-En Fan></DD
1026*4a1a9510SRong-En Fan><DT
1027*4a1a9510SRong-En Fan>20. <A
1028*4a1a9510SRong-En FanHREF="#JUSTFORFUN"
1029*4a1a9510SRong-En Fan>Just For Fun !!!</A
1030*4a1a9510SRong-En Fan></DT
1031*4a1a9510SRong-En Fan><DD
1032*4a1a9510SRong-En Fan><DL
1033*4a1a9510SRong-En Fan><DT
1034*4a1a9510SRong-En Fan>20.1. <A
1035*4a1a9510SRong-En FanHREF="#GAMEOFLIFE"
1036*4a1a9510SRong-En Fan>The Game of Life</A
1037*4a1a9510SRong-En Fan></DT
1038*4a1a9510SRong-En Fan><DT
1039*4a1a9510SRong-En Fan>20.2. <A
1040*4a1a9510SRong-En FanHREF="#MAGIC"
1041*4a1a9510SRong-En Fan>Magic Square</A
1042*4a1a9510SRong-En Fan></DT
1043*4a1a9510SRong-En Fan><DT
1044*4a1a9510SRong-En Fan>20.3. <A
1045*4a1a9510SRong-En FanHREF="#HANOI"
1046*4a1a9510SRong-En Fan>Towers of Hanoi</A
1047*4a1a9510SRong-En Fan></DT
1048*4a1a9510SRong-En Fan><DT
1049*4a1a9510SRong-En Fan>20.4. <A
1050*4a1a9510SRong-En FanHREF="#QUEENS"
1051*4a1a9510SRong-En Fan>Queens Puzzle</A
1052*4a1a9510SRong-En Fan></DT
1053*4a1a9510SRong-En Fan><DT
1054*4a1a9510SRong-En Fan>20.5. <A
1055*4a1a9510SRong-En FanHREF="#SHUFFLE"
1056*4a1a9510SRong-En Fan>Shuffle</A
1057*4a1a9510SRong-En Fan></DT
1058*4a1a9510SRong-En Fan><DT
1059*4a1a9510SRong-En Fan>20.6. <A
1060*4a1a9510SRong-En FanHREF="#TT"
1061*4a1a9510SRong-En Fan>Typing Tutor</A
1062*4a1a9510SRong-En Fan></DT
1063*4a1a9510SRong-En Fan></DL
1064*4a1a9510SRong-En Fan></DD
1065*4a1a9510SRong-En Fan><DT
1066*4a1a9510SRong-En Fan>21. <A
1067*4a1a9510SRong-En FanHREF="#REF"
1068*4a1a9510SRong-En Fan>References</A
1069*4a1a9510SRong-En Fan></DT
1070*4a1a9510SRong-En Fan></DL
1071*4a1a9510SRong-En Fan></DIV
1072*4a1a9510SRong-En Fan><DIV
1073*4a1a9510SRong-En FanCLASS="SECT1"
1074*4a1a9510SRong-En Fan><H2
1075*4a1a9510SRong-En FanCLASS="SECT1"
1076*4a1a9510SRong-En Fan><A
1077*4a1a9510SRong-En FanNAME="INTRO"
1078*4a1a9510SRong-En Fan>1. Introduction</A
1079*4a1a9510SRong-En Fan></H2
1080*4a1a9510SRong-En Fan><P
1081*4a1a9510SRong-En Fan>In the olden days of teletype terminals, terminals were away from computers and
1082*4a1a9510SRong-En Fanwere connected to them through serial cables. The terminals could be configured
1083*4a1a9510SRong-En Fanby sending a series of bytes. All the capabilities (such as
1084*4a1a9510SRong-En Fanmoving the cursor to a new location, erasing part of the screen, scrolling the
1085*4a1a9510SRong-En Fanscreen, changing modes etc.) of terminals could be accessed through these
1086*4a1a9510SRong-En Fanseries of bytes. These control seeuqnces are usually called escape sequences,
1087*4a1a9510SRong-En Fanbecause they start
1088*4a1a9510SRong-En Fanwith an escape(0x1B) character. Even today, with proper emulation, we can send
1089*4a1a9510SRong-En Fanescape sequences to the emulator and achieve the same effect on a terminal
1090*4a1a9510SRong-En Fanwindow.</P
1091*4a1a9510SRong-En Fan><P
1092*4a1a9510SRong-En Fan>Suppose you wanted to print a line in color. Try typing this on your console.</P
1093*4a1a9510SRong-En Fan><PRE
1094*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
1095*4a1a9510SRong-En Fan>echo "^[[0;31;40mIn Color"</PRE
1096*4a1a9510SRong-En Fan><P
1097*4a1a9510SRong-En Fan>The first character is an escape character, which looks like two characters ^
1098*4a1a9510SRong-En Fanand [. To be able to print it, you have to press CTRL+V and then the ESC key.
1099*4a1a9510SRong-En FanAll the others are normal printable characters. You should be able to see the
1100*4a1a9510SRong-En Fanstring "In Color" in red. It stays that way and to revert back to the original
1101*4a1a9510SRong-En Fanmode type this.</P
1102*4a1a9510SRong-En Fan><PRE
1103*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
1104*4a1a9510SRong-En Fan>echo "^[[0;37;40m"</PRE
1105*4a1a9510SRong-En Fan><P
1106*4a1a9510SRong-En Fan>Now, what do these magic characters mean? Difficult to comprehend? They might
1107*4a1a9510SRong-En Faneven be different for different terminals. So the designers of UNIX invented a
1108*4a1a9510SRong-En Fanmechanism named <TT
1109*4a1a9510SRong-En FanCLASS="LITERAL"
1110*4a1a9510SRong-En Fan>termcap</TT
1111*4a1a9510SRong-En Fan>. It is a file that
1112*4a1a9510SRong-En Fanlists all the capabilities of a particular terminal, along with the escape
1113*4a1a9510SRong-En Fansequences needed to achieve a particular effect. In the later years, this was
1114*4a1a9510SRong-En Fanreplaced by <TT
1115*4a1a9510SRong-En FanCLASS="LITERAL"
1116*4a1a9510SRong-En Fan>terminfo</TT
1117*4a1a9510SRong-En Fan>. Without delving too
1118*4a1a9510SRong-En Fanmuch into details, this mechanism allows application
1119*4a1a9510SRong-En Fanprograms to query the terminfo database and obtain the control characters to be
1120*4a1a9510SRong-En Fansent to a terminal or terminal emulator.</P
1121*4a1a9510SRong-En Fan><DIV
1122*4a1a9510SRong-En FanCLASS="SECT2"
1123*4a1a9510SRong-En Fan><HR><H3
1124*4a1a9510SRong-En FanCLASS="SECT2"
1125*4a1a9510SRong-En Fan><A
1126*4a1a9510SRong-En FanNAME="WHATIS"
1127*4a1a9510SRong-En Fan>1.1. What is NCURSES?</A
1128*4a1a9510SRong-En Fan></H3
1129*4a1a9510SRong-En Fan><P
1130*4a1a9510SRong-En Fan>
1131*4a1a9510SRong-En FanYou might be wondering, what the import of all this technical gibberish is.  In
1132*4a1a9510SRong-En Fanthe above scenario, every application program is supposed to query the terminfo
1133*4a1a9510SRong-En Fanand perform the necessary stuff (sending control characters etc.).  It soon became
1134*4a1a9510SRong-En Fandifficult to manage this complexity and this gave birth to 'CURSES'.  Curses is
1135*4a1a9510SRong-En Fana pun on the name "cursor optimization". The Curses library forms a wrapper
1136*4a1a9510SRong-En Fanover working with raw terminal codes, and provides highly flexible and
1137*4a1a9510SRong-En Fanefficient API (Application Programming Interface). It provides functions to
1138*4a1a9510SRong-En Fanmove the cursor, create windows, produce colors, play with mouse etc.  The
1139*4a1a9510SRong-En Fanapplication programs need not worry about the underlying terminal capabilities.</P
1140*4a1a9510SRong-En Fan><P
1141*4a1a9510SRong-En Fan>So what is NCURSES? NCURSES is a clone of the original System V Release 4.0
1142*4a1a9510SRong-En Fan(SVr4) curses. It is a freely distributable library, fully compatible with
1143*4a1a9510SRong-En Fanolder version of curses.  In short, it is a library of functions that manages
1144*4a1a9510SRong-En Fanan application's display on character-cell terminals.  In the remainder of the
1145*4a1a9510SRong-En Fandocument, the terms curses and ncurses are used interchangeably.  </P
1146*4a1a9510SRong-En Fan><P
1147*4a1a9510SRong-En Fan>A detailed history of NCURSES can be found in the NEWS file from the source
1148*4a1a9510SRong-En Fandistribution. The current package is maintained by
1149*4a1a9510SRong-En Fan<A
1150*4a1a9510SRong-En FanHREF="mailto:[email protected]"
1151*4a1a9510SRong-En FanTARGET="_top"
1152*4a1a9510SRong-En Fan>Thomas Dickey</A
1153*4a1a9510SRong-En Fan>.
1154*4a1a9510SRong-En FanYou can contact the maintainers at <A
1155*4a1a9510SRong-En FanHREF="mailto:[email protected]"
1156*4a1a9510SRong-En FanTARGET="_top"
1157*4a1a9510SRong-En Fan>[email protected]</A
1158*4a1a9510SRong-En Fan>.</P
1159*4a1a9510SRong-En Fan></DIV
1160*4a1a9510SRong-En Fan><DIV
1161*4a1a9510SRong-En FanCLASS="SECT2"
1162*4a1a9510SRong-En Fan><HR><H3
1163*4a1a9510SRong-En FanCLASS="SECT2"
1164*4a1a9510SRong-En Fan><A
1165*4a1a9510SRong-En FanNAME="WHATCANWEDO"
1166*4a1a9510SRong-En Fan>1.2. What we can do with NCURSES</A
1167*4a1a9510SRong-En Fan></H3
1168*4a1a9510SRong-En Fan><P
1169*4a1a9510SRong-En Fan>NCURSES not only creates a wrapper over terminal capabilities, but also gives a
1170*4a1a9510SRong-En Fanrobust framework to create nice looking UI (User Interface)s in text mode.  It
1171*4a1a9510SRong-En Fanprovides functions to create windows etc.  Its sister libraries panel, menu and
1172*4a1a9510SRong-En Fanform provide an extension to the basic curses library. These libraries usually
1173*4a1a9510SRong-En Fancome along with curses. One can create applications that contain multiple
1174*4a1a9510SRong-En Fanwindows, menus, panels and forms. Windows can be managed independently, can
1175*4a1a9510SRong-En Fanprovide 'scrollability' and even can be hidden.</P
1176*4a1a9510SRong-En Fan><P
1177*4a1a9510SRong-En Fan>
1178*4a1a9510SRong-En FanMenus provide the user with an easy command selection option.  Forms allow the
1179*4a1a9510SRong-En Fancreation of easy-to-use data entry and display windows.  Panels extend the
1180*4a1a9510SRong-En Fancapabilities of ncurses to deal with overlapping and stacked windows.</P
1181*4a1a9510SRong-En Fan><P
1182*4a1a9510SRong-En Fan>These are just some of the basic things we can do with ncurses. As we move
1183*4a1a9510SRong-En Fanalong, We will see all the capabilities of these libraries. </P
1184*4a1a9510SRong-En Fan></DIV
1185*4a1a9510SRong-En Fan><DIV
1186*4a1a9510SRong-En FanCLASS="SECT2"
1187*4a1a9510SRong-En Fan><HR><H3
1188*4a1a9510SRong-En FanCLASS="SECT2"
1189*4a1a9510SRong-En Fan><A
1190*4a1a9510SRong-En FanNAME="WHERETOGETIT"
1191*4a1a9510SRong-En Fan>1.3. Where to get it</A
1192*4a1a9510SRong-En Fan></H3
1193*4a1a9510SRong-En Fan><P
1194*4a1a9510SRong-En Fan>All right, now that you know what you can do with ncurses, you must be rearing
1195*4a1a9510SRong-En Fanto get started. NCURSES is usually shipped with your installation. In case
1196*4a1a9510SRong-En Fanyou don't have the library or want to compile it on your own, read on.</P
1197*4a1a9510SRong-En Fan><P
1198*4a1a9510SRong-En Fan><SPAN
1199*4a1a9510SRong-En FanCLASS="emphasis"
1200*4a1a9510SRong-En Fan><I
1201*4a1a9510SRong-En FanCLASS="EMPHASIS"
1202*4a1a9510SRong-En Fan>Compiling the package</I
1203*4a1a9510SRong-En Fan></SPAN
1204*4a1a9510SRong-En Fan> </P
1205*4a1a9510SRong-En Fan><P
1206*4a1a9510SRong-En Fan>NCURSES can be obtained from <A
1207*4a1a9510SRong-En FanHREF="ftp://ftp.gnu.org/pub/gnu/ncurses/ncurses.tar.gz"
1208*4a1a9510SRong-En FanTARGET="_top"
1209*4a1a9510SRong-En Fan>ftp://ftp.gnu.org/pub/gnu/ncurses/ncurses.tar.gz</A
1210*4a1a9510SRong-En Fan> or any of the ftp
1211*4a1a9510SRong-En Fansites mentioned in <A
1212*4a1a9510SRong-En FanHREF="http://www.gnu.org/order/ftp.html"
1213*4a1a9510SRong-En FanTARGET="_top"
1214*4a1a9510SRong-En Fan>http://www.gnu.org/order/ftp.html</A
1215*4a1a9510SRong-En Fan>. </P
1216*4a1a9510SRong-En Fan><P
1217*4a1a9510SRong-En Fan>Read the README and INSTALL files for details on to how to install it. It
1218*4a1a9510SRong-En Fanusually involves the following operations.</P
1219*4a1a9510SRong-En Fan><PRE
1220*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
1221*4a1a9510SRong-En Fan>    tar zxvf ncurses&lt;version&gt;.tar.gz  # unzip and untar the archive
1222*4a1a9510SRong-En Fan    cd ncurses&lt;version&gt;               # cd to the directory
1223*4a1a9510SRong-En Fan    ./configure                             # configure the build according to your
1224*4a1a9510SRong-En Fan                                            # environment
1225*4a1a9510SRong-En Fan    make                                    # make it
1226*4a1a9510SRong-En Fan    su root                                 # become root
1227*4a1a9510SRong-En Fan    make install                            # install it</PRE
1228*4a1a9510SRong-En Fan><P
1229*4a1a9510SRong-En Fan><SPAN
1230*4a1a9510SRong-En FanCLASS="emphasis"
1231*4a1a9510SRong-En Fan><I
1232*4a1a9510SRong-En FanCLASS="EMPHASIS"
1233*4a1a9510SRong-En Fan>Using the RPM </I
1234*4a1a9510SRong-En Fan></SPAN
1235*4a1a9510SRong-En Fan></P
1236*4a1a9510SRong-En Fan><P
1237*4a1a9510SRong-En Fan>NCURSES RPM can be found and downloaded from <A
1238*4a1a9510SRong-En FanHREF="http://rpmfind.net"
1239*4a1a9510SRong-En FanTARGET="_top"
1240*4a1a9510SRong-En Fan>http://rpmfind.net </A
1241*4a1a9510SRong-En Fan>. The RPM can be installed with the following
1242*4a1a9510SRong-En Fancommand after becoming root.</P
1243*4a1a9510SRong-En Fan><PRE
1244*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
1245*4a1a9510SRong-En Fan>    rpm -i &lt;downloaded rpm&gt;</PRE
1246*4a1a9510SRong-En Fan></DIV
1247*4a1a9510SRong-En Fan><DIV
1248*4a1a9510SRong-En FanCLASS="SECT2"
1249*4a1a9510SRong-En Fan><HR><H3
1250*4a1a9510SRong-En FanCLASS="SECT2"
1251*4a1a9510SRong-En Fan><A
1252*4a1a9510SRong-En FanNAME="PURPOSE"
1253*4a1a9510SRong-En Fan>1.4. Purpose/Scope of the document</A
1254*4a1a9510SRong-En Fan></H3
1255*4a1a9510SRong-En Fan><P
1256*4a1a9510SRong-En Fan>This document is intended to be a "All in One" guide for programming with
1257*4a1a9510SRong-En Fanncurses and its sister libraries. We graduate from a simple "Hello World"
1258*4a1a9510SRong-En Fanprogram to more complex form manipulation. No prior experience in ncurses is
1259*4a1a9510SRong-En Fanassumed. The writing is informal, but a lot of detail is provided for
1260*4a1a9510SRong-En Faneach of the examples.</P
1261*4a1a9510SRong-En Fan></DIV
1262*4a1a9510SRong-En Fan><DIV
1263*4a1a9510SRong-En FanCLASS="SECT2"
1264*4a1a9510SRong-En Fan><HR><H3
1265*4a1a9510SRong-En FanCLASS="SECT2"
1266*4a1a9510SRong-En Fan><A
1267*4a1a9510SRong-En FanNAME="ABOUTPROGRAMS"
1268*4a1a9510SRong-En Fan>1.5. About the Programs</A
1269*4a1a9510SRong-En Fan></H3
1270*4a1a9510SRong-En Fan><P
1271*4a1a9510SRong-En Fan>All the programs in the document are available in zipped form
1272*4a1a9510SRong-En Fan<A
1273*4a1a9510SRong-En FanHREF="http://www.tldp.org/HOWTO/NCURSES-Programming-HOWTO/ncurses_programs.tar.gz"
1274*4a1a9510SRong-En FanTARGET="_top"
1275*4a1a9510SRong-En Fan>here</A
1276*4a1a9510SRong-En Fan>. Unzip and untar it. The directory structure looks like this.</P
1277*4a1a9510SRong-En Fan><PRE
1278*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
1279*4a1a9510SRong-En Fan>ncurses
1280*4a1a9510SRong-En Fan   |
1281*4a1a9510SRong-En Fan   |----&gt; JustForFun     -- just for fun programs
1282*4a1a9510SRong-En Fan   |----&gt; basics         -- basic programs
1283*4a1a9510SRong-En Fan   |----&gt; demo           -- output files go into this directory after make
1284*4a1a9510SRong-En Fan   |          |
1285*4a1a9510SRong-En Fan   |          |----&gt; exe -- exe files of all example programs
1286*4a1a9510SRong-En Fan   |----&gt; forms          -- programs related to form library
1287*4a1a9510SRong-En Fan   |----&gt; menus          -- programs related to menus library
1288*4a1a9510SRong-En Fan   |----&gt; panels         -- programs related to panels library
1289*4a1a9510SRong-En Fan   |----&gt; perl           -- perl equivalents of the examples (contributed
1290*4a1a9510SRong-En Fan   |                            by Anuradha Ratnaweera)
1291*4a1a9510SRong-En Fan   |----&gt; Makefile       -- the top level Makefile
1292*4a1a9510SRong-En Fan   |----&gt; README         -- the top level README file. contains instructions
1293*4a1a9510SRong-En Fan   |----&gt; COPYING        -- copyright notice</PRE
1294*4a1a9510SRong-En Fan><P
1295*4a1a9510SRong-En Fan>The individual directories contain the following files.</P
1296*4a1a9510SRong-En Fan><PRE
1297*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
1298*4a1a9510SRong-En Fan>Description of files in each directory
1299*4a1a9510SRong-En Fan--------------------------------------
1300*4a1a9510SRong-En FanJustForFun
1301*4a1a9510SRong-En Fan    |
1302*4a1a9510SRong-En Fan    |----&gt; hanoi.c   -- The Towers of Hanoi Solver
1303*4a1a9510SRong-En Fan    |----&gt; life.c    -- The Game of Life demo
1304*4a1a9510SRong-En Fan    |----&gt; magic.c   -- An Odd Order Magic Square builder
1305*4a1a9510SRong-En Fan    |----&gt; queens.c  -- The famous N-Queens Solver
1306*4a1a9510SRong-En Fan    |----&gt; shuffle.c -- A fun game, if you have time to kill
1307*4a1a9510SRong-En Fan    |----&gt; tt.c      -- A very trivial typing tutor
1308*4a1a9510SRong-En Fan
1309*4a1a9510SRong-En Fan  basics
1310*4a1a9510SRong-En Fan    |
1311*4a1a9510SRong-En Fan    |----&gt; acs_vars.c            -- ACS_ variables example
1312*4a1a9510SRong-En Fan    |----&gt; hello_world.c         -- Simple "Hello World" Program
1313*4a1a9510SRong-En Fan    |----&gt; init_func_example.c   -- Initialization functions example
1314*4a1a9510SRong-En Fan    |----&gt; key_code.c            -- Shows the scan code of the key pressed
1315*4a1a9510SRong-En Fan    |----&gt; mouse_menu.c          -- A menu accessible by mouse
1316*4a1a9510SRong-En Fan    |----&gt; other_border.c        -- Shows usage of other border functions apa
1317*4a1a9510SRong-En Fan    |                               -- rt from box()
1318*4a1a9510SRong-En Fan    |----&gt; printw_example.c      -- A very simple printw() example
1319*4a1a9510SRong-En Fan    |----&gt; scanw_example.c       -- A very simple getstr() example
1320*4a1a9510SRong-En Fan    |----&gt; simple_attr.c         -- A program that can print a c file with
1321*4a1a9510SRong-En Fan    |                               -- comments in attribute
1322*4a1a9510SRong-En Fan    |----&gt; simple_color.c        -- A simple example demonstrating colors
1323*4a1a9510SRong-En Fan    |----&gt; simple_key.c          -- A menu accessible with keyboard UP, DOWN
1324*4a1a9510SRong-En Fan    |                               -- arrows
1325*4a1a9510SRong-En Fan    |----&gt; temp_leave.c          -- Demonstrates temporarily leaving curses mode
1326*4a1a9510SRong-En Fan    |----&gt; win_border.c          -- Shows Creation of windows and borders
1327*4a1a9510SRong-En Fan    |----&gt; with_chgat.c          -- chgat() usage example
1328*4a1a9510SRong-En Fan
1329*4a1a9510SRong-En Fan  forms
1330*4a1a9510SRong-En Fan    |
1331*4a1a9510SRong-En Fan    |----&gt; form_attrib.c     -- Usage of field attributes
1332*4a1a9510SRong-En Fan    |----&gt; form_options.c    -- Usage of field options
1333*4a1a9510SRong-En Fan    |----&gt; form_simple.c     -- A simple form example
1334*4a1a9510SRong-En Fan    |----&gt; form_win.c        -- Demo of windows associated with forms
1335*4a1a9510SRong-En Fan
1336*4a1a9510SRong-En Fan  menus
1337*4a1a9510SRong-En Fan    |
1338*4a1a9510SRong-En Fan    |----&gt; menu_attrib.c     -- Usage of menu attributes
1339*4a1a9510SRong-En Fan    |----&gt; menu_item_data.c  -- Usage of item_name() etc.. functions
1340*4a1a9510SRong-En Fan    |----&gt; menu_multi_column.c    -- Creates multi columnar menus
1341*4a1a9510SRong-En Fan    |----&gt; menu_scroll.c     -- Demonstrates scrolling capability of menus
1342*4a1a9510SRong-En Fan    |----&gt; menu_simple.c     -- A simple menu accessed by arrow keys
1343*4a1a9510SRong-En Fan    |----&gt; menu_toggle.c     -- Creates multi valued menus and explains
1344*4a1a9510SRong-En Fan    |                           -- REQ_TOGGLE_ITEM
1345*4a1a9510SRong-En Fan    |----&gt; menu_userptr.c    -- Usage of user pointer
1346*4a1a9510SRong-En Fan    |----&gt; menu_win.c        -- Demo of windows associated with menus
1347*4a1a9510SRong-En Fan
1348*4a1a9510SRong-En Fan  panels
1349*4a1a9510SRong-En Fan    |
1350*4a1a9510SRong-En Fan    |----&gt; panel_browse.c    -- Panel browsing through tab. Usage of user
1351*4a1a9510SRong-En Fan    |                           -- pointer
1352*4a1a9510SRong-En Fan    |----&gt; panel_hide.c      -- Hiding and Un hiding of panels
1353*4a1a9510SRong-En Fan    |----&gt; panel_resize.c    -- Moving and resizing of panels
1354*4a1a9510SRong-En Fan    |----&gt; panel_simple.c    -- A simple panel example
1355*4a1a9510SRong-En Fan
1356*4a1a9510SRong-En Fan  perl
1357*4a1a9510SRong-En Fan    |----&gt; 01-10.pl          -- Perl equivalents of first ten example programs</PRE
1358*4a1a9510SRong-En Fan><P
1359*4a1a9510SRong-En Fan>There is a top level Makefile included in the main directory. It builds all the
1360*4a1a9510SRong-En Fanfiles and puts the ready-to-use exes in demo/exe directory. You can also
1361*4a1a9510SRong-En Fando selective make by going into the corresponding directory. Each directory
1362*4a1a9510SRong-En Fancontains a README file explaining the purpose of each c file in the directory.</P
1363*4a1a9510SRong-En Fan><P
1364*4a1a9510SRong-En Fan>For every example, I have included path name for the file relative to the
1365*4a1a9510SRong-En Fanexamples directory. </P
1366*4a1a9510SRong-En Fan><P
1367*4a1a9510SRong-En Fan> If you prefer browsing individual programs, point your browser to
1368*4a1a9510SRong-En Fan<A
1369*4a1a9510SRong-En FanHREF="http://tldp.org/HOWTO/NCURSES-Programming-HOWTO/ncurses_programs/"
1370*4a1a9510SRong-En FanTARGET="_top"
1371*4a1a9510SRong-En Fan>http://tldp.org/HOWTO/NCURSES-Programming-HOWTO/ncurses_programs/</A
1372*4a1a9510SRong-En Fan></P
1373*4a1a9510SRong-En Fan><P
1374*4a1a9510SRong-En Fan>All the programs are released under the same license that is used by ncurses
1375*4a1a9510SRong-En Fan(MIT-style). This gives you the ability to do pretty much anything other than
1376*4a1a9510SRong-En Fanclaiming them as yours. Feel free to use them in your programs as appropriate.</P
1377*4a1a9510SRong-En Fan></DIV
1378*4a1a9510SRong-En Fan><DIV
1379*4a1a9510SRong-En FanCLASS="SECT2"
1380*4a1a9510SRong-En Fan><HR><H3
1381*4a1a9510SRong-En FanCLASS="SECT2"
1382*4a1a9510SRong-En Fan><A
1383*4a1a9510SRong-En FanNAME="OTHERFORMATS"
1384*4a1a9510SRong-En Fan>1.6. Other Formats of the document</A
1385*4a1a9510SRong-En Fan></H3
1386*4a1a9510SRong-En Fan><P
1387*4a1a9510SRong-En Fan>This howto is also availabe in various other formats on the tldp.org site.
1388*4a1a9510SRong-En FanHere are the links to other formats of this document.</P
1389*4a1a9510SRong-En Fan><DIV
1390*4a1a9510SRong-En FanCLASS="SECT3"
1391*4a1a9510SRong-En Fan><HR><H4
1392*4a1a9510SRong-En FanCLASS="SECT3"
1393*4a1a9510SRong-En Fan><A
1394*4a1a9510SRong-En FanNAME="LISTFORMATS"
1395*4a1a9510SRong-En Fan>1.6.1. Readily available formats from tldp.org</A
1396*4a1a9510SRong-En Fan></H4
1397*4a1a9510SRong-En Fan><P
1398*4a1a9510SRong-En Fan></P
1399*4a1a9510SRong-En Fan><UL
1400*4a1a9510SRong-En Fan><LI
1401*4a1a9510SRong-En Fan><P
1402*4a1a9510SRong-En Fan><A
1403*4a1a9510SRong-En FanHREF="http://www.ibiblio.org/pub/Linux/docs/HOWTO/other-formats/pdf/NCURSES-Programming-HOWTO.pdf"
1404*4a1a9510SRong-En FanTARGET="_top"
1405*4a1a9510SRong-En Fan>Acrobat PDF Format</A
1406*4a1a9510SRong-En Fan></P
1407*4a1a9510SRong-En Fan></LI
1408*4a1a9510SRong-En Fan><LI
1409*4a1a9510SRong-En Fan><P
1410*4a1a9510SRong-En Fan><A
1411*4a1a9510SRong-En FanHREF="http://www.ibiblio.org/pub/Linux/docs/HOWTO/other-formats/ps/NCURSES-Programming-HOWTO.ps.gz"
1412*4a1a9510SRong-En FanTARGET="_top"
1413*4a1a9510SRong-En Fan>PostScript Format</A
1414*4a1a9510SRong-En Fan></P
1415*4a1a9510SRong-En Fan></LI
1416*4a1a9510SRong-En Fan><LI
1417*4a1a9510SRong-En Fan><P
1418*4a1a9510SRong-En Fan><A
1419*4a1a9510SRong-En FanHREF="http://www.ibiblio.org/pub/Linux/docs/HOWTO/other-formats/html/NCURSES-Programming-HOWTO-html.tar.gz"
1420*4a1a9510SRong-En FanTARGET="_top"
1421*4a1a9510SRong-En Fan>In Multiple HTML pages</A
1422*4a1a9510SRong-En Fan></P
1423*4a1a9510SRong-En Fan></LI
1424*4a1a9510SRong-En Fan><LI
1425*4a1a9510SRong-En Fan><P
1426*4a1a9510SRong-En Fan><A
1427*4a1a9510SRong-En FanHREF="http://www.ibiblio.org/pub/Linux/docs/HOWTO/other-formats/html_single/NCURSES-Programming-HOWTO.html"
1428*4a1a9510SRong-En FanTARGET="_top"
1429*4a1a9510SRong-En Fan>In One big HTML format</A
1430*4a1a9510SRong-En Fan></P
1431*4a1a9510SRong-En Fan></LI
1432*4a1a9510SRong-En Fan></UL
1433*4a1a9510SRong-En Fan></DIV
1434*4a1a9510SRong-En Fan><DIV
1435*4a1a9510SRong-En FanCLASS="SECT3"
1436*4a1a9510SRong-En Fan><HR><H4
1437*4a1a9510SRong-En FanCLASS="SECT3"
1438*4a1a9510SRong-En Fan><A
1439*4a1a9510SRong-En FanNAME="BUILDSOURCE"
1440*4a1a9510SRong-En Fan>1.6.2. Building from source</A
1441*4a1a9510SRong-En Fan></H4
1442*4a1a9510SRong-En Fan><P
1443*4a1a9510SRong-En Fan>If above links are broken or if you want to experiment with sgml read on.
1444*4a1a9510SRong-En Fan<PRE
1445*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
1446*4a1a9510SRong-En Fan>&#13;    Get both the source and the tar,gzipped programs, available at
1447*4a1a9510SRong-En Fan        http://cvsview.tldp.org/index.cgi/LDP/howto/docbook/
1448*4a1a9510SRong-En Fan        NCURSES-HOWTO/NCURSES-Programming-HOWTO.sgml
1449*4a1a9510SRong-En Fan        http://cvsview.tldp.org/index.cgi/LDP/howto/docbook/
1450*4a1a9510SRong-En Fan        NCURSES-HOWTO/ncurses_programs.tar.gz
1451*4a1a9510SRong-En Fan
1452*4a1a9510SRong-En Fan    Unzip ncurses_programs.tar.gz with
1453*4a1a9510SRong-En Fan    tar zxvf ncurses_programs.tar.gz
1454*4a1a9510SRong-En Fan
1455*4a1a9510SRong-En Fan    Use jade to create various formats. For example if you just want to create
1456*4a1a9510SRong-En Fan    the multiple html files, you would use
1457*4a1a9510SRong-En Fan        jade -t sgml -i html -d &lt;path to docbook html stylesheet&gt;
1458*4a1a9510SRong-En Fan        NCURSES-Programming-HOWTO.sgml
1459*4a1a9510SRong-En Fan    to get pdf, first create a single html file of the HOWTO with
1460*4a1a9510SRong-En Fan        jade -t sgml -i html -d &lt;path to docbook html stylesheet&gt; -V nochunks
1461*4a1a9510SRong-En Fan        NCURSES-Programming-HOWTO.sgml &gt; NCURSES-ONE-BIG-FILE.html
1462*4a1a9510SRong-En Fan    then use htmldoc to get pdf file with
1463*4a1a9510SRong-En Fan        htmldoc --size universal -t pdf --firstpage p1 -f &lt;output file name.pdf&gt;
1464*4a1a9510SRong-En Fan        NCURSES-ONE-BIG-FILE.html
1465*4a1a9510SRong-En Fan    for ps, you would use
1466*4a1a9510SRong-En Fan        htmldoc --size universal -t ps --firstpage p1 -f &lt;output file name.ps&gt;
1467*4a1a9510SRong-En Fan        NCURSES-ONE-BIG-FILE.html</PRE
1468*4a1a9510SRong-En Fan></P
1469*4a1a9510SRong-En Fan><P
1470*4a1a9510SRong-En Fan>See <A
1471*4a1a9510SRong-En FanHREF="http://www.tldp.org/LDP/LDP-Author-Guide/"
1472*4a1a9510SRong-En FanTARGET="_top"
1473*4a1a9510SRong-En Fan>LDP Author guide</A
1474*4a1a9510SRong-En Fan> for more details. If all else failes, mail me at
1475*4a1a9510SRong-En Fan<A
1476*4a1a9510SRong-En FanHREF="[email protected]"
1477*4a1a9510SRong-En FanTARGET="_top"
1478*4a1a9510SRong-En Fan>[email protected]</A
1479*4a1a9510SRong-En Fan></P
1480*4a1a9510SRong-En Fan></DIV
1481*4a1a9510SRong-En Fan></DIV
1482*4a1a9510SRong-En Fan><DIV
1483*4a1a9510SRong-En FanCLASS="SECT2"
1484*4a1a9510SRong-En Fan><HR><H3
1485*4a1a9510SRong-En FanCLASS="SECT2"
1486*4a1a9510SRong-En Fan><A
1487*4a1a9510SRong-En FanNAME="CREDITS"
1488*4a1a9510SRong-En Fan>1.7. Credits</A
1489*4a1a9510SRong-En Fan></H3
1490*4a1a9510SRong-En Fan><P
1491*4a1a9510SRong-En Fan>I thank <A
1492*4a1a9510SRong-En FanHREF="mailto:[email protected]"
1493*4a1a9510SRong-En FanTARGET="_top"
1494*4a1a9510SRong-En Fan>Sharath</A
1495*4a1a9510SRong-En Fan> and Emre Akbas for
1496*4a1a9510SRong-En Fanhelping me with few sections. The introduction was initially written by sharath.
1497*4a1a9510SRong-En FanI rewrote it with few excerpts taken from his initial work. Emre helped in
1498*4a1a9510SRong-En Fanwriting printw and scanw sections.</P
1499*4a1a9510SRong-En Fan><P
1500*4a1a9510SRong-En Fan>Perl equivalents of the example programs are contributed by <A
1501*4a1a9510SRong-En FanHREF="mailto:[email protected]"
1502*4a1a9510SRong-En FanTARGET="_top"
1503*4a1a9510SRong-En Fan>Anuradha Ratnaweera</A
1504*4a1a9510SRong-En Fan>. </P
1505*4a1a9510SRong-En Fan><P
1506*4a1a9510SRong-En Fan>Then comes <A
1507*4a1a9510SRong-En FanHREF="mailto:[email protected]"
1508*4a1a9510SRong-En FanTARGET="_top"
1509*4a1a9510SRong-En Fan>Ravi Parimi</A
1510*4a1a9510SRong-En Fan>, my
1511*4a1a9510SRong-En Fandearest friend, who has been on this project before even one line was written.
1512*4a1a9510SRong-En FanHe constantly bombarded me with suggestions and patiently reviewed the whole
1513*4a1a9510SRong-En Fantext.  He also checked each program on Linux and Solaris. </P
1514*4a1a9510SRong-En Fan></DIV
1515*4a1a9510SRong-En Fan><DIV
1516*4a1a9510SRong-En FanCLASS="SECT2"
1517*4a1a9510SRong-En Fan><HR><H3
1518*4a1a9510SRong-En FanCLASS="SECT2"
1519*4a1a9510SRong-En Fan><A
1520*4a1a9510SRong-En FanNAME="WISHLIST"
1521*4a1a9510SRong-En Fan>1.8. Wish List</A
1522*4a1a9510SRong-En Fan></H3
1523*4a1a9510SRong-En Fan><P
1524*4a1a9510SRong-En Fan>This is the wish list, in the order of priority. If you have a wish or you want
1525*4a1a9510SRong-En Fanto work on completing the wish, mail <A
1526*4a1a9510SRong-En FanHREF="mailto:[email protected]"
1527*4a1a9510SRong-En FanTARGET="_top"
1528*4a1a9510SRong-En Fan>me</A
1529*4a1a9510SRong-En Fan>. </P
1530*4a1a9510SRong-En Fan><P
1531*4a1a9510SRong-En Fan></P
1532*4a1a9510SRong-En Fan><UL
1533*4a1a9510SRong-En Fan><LI
1534*4a1a9510SRong-En Fan><P
1535*4a1a9510SRong-En Fan>Add examples to last parts of forms section.</P
1536*4a1a9510SRong-En Fan></LI
1537*4a1a9510SRong-En Fan><LI
1538*4a1a9510SRong-En Fan><P
1539*4a1a9510SRong-En Fan>Prepare a Demo showing all the programs and allow the user to browse through
1540*4a1a9510SRong-En Fandescription of each program. Let the user compile and see the program in action.
1541*4a1a9510SRong-En FanA dialog based interface is preferred.</P
1542*4a1a9510SRong-En Fan></LI
1543*4a1a9510SRong-En Fan><LI
1544*4a1a9510SRong-En Fan><P
1545*4a1a9510SRong-En Fan>Add debug info. _tracef, _tracemouse stuff.</P
1546*4a1a9510SRong-En Fan></LI
1547*4a1a9510SRong-En Fan><LI
1548*4a1a9510SRong-En Fan><P
1549*4a1a9510SRong-En Fan>Accessing termcap, terminfo using functions provided by ncurses
1550*4a1a9510SRong-En Fanpackage.</P
1551*4a1a9510SRong-En Fan></LI
1552*4a1a9510SRong-En Fan><LI
1553*4a1a9510SRong-En Fan><P
1554*4a1a9510SRong-En Fan>Working on two terminals simultaneously.</P
1555*4a1a9510SRong-En Fan></LI
1556*4a1a9510SRong-En Fan><LI
1557*4a1a9510SRong-En Fan><P
1558*4a1a9510SRong-En Fan>Add more stuff to miscellaneous section.</P
1559*4a1a9510SRong-En Fan></LI
1560*4a1a9510SRong-En Fan></UL
1561*4a1a9510SRong-En Fan></DIV
1562*4a1a9510SRong-En Fan><DIV
1563*4a1a9510SRong-En FanCLASS="SECT2"
1564*4a1a9510SRong-En Fan><HR><H3
1565*4a1a9510SRong-En FanCLASS="SECT2"
1566*4a1a9510SRong-En Fan><A
1567*4a1a9510SRong-En FanNAME="COPYRIGHT"
1568*4a1a9510SRong-En Fan>1.9. Copyright</A
1569*4a1a9510SRong-En Fan></H3
1570*4a1a9510SRong-En Fan><P
1571*4a1a9510SRong-En Fan>Copyright &copy; 2001 by Pradeep Padala. </P
1572*4a1a9510SRong-En Fan><P
1573*4a1a9510SRong-En Fan>Permission is hereby granted, free of charge, to any person obtaining a copy
1574*4a1a9510SRong-En Fanof this software and associated documentation files (the "Software"), to deal
1575*4a1a9510SRong-En Fanin the Software without restriction, including without limitation the rights
1576*4a1a9510SRong-En Fanto use, copy, modify, merge, publish, distribute, distribute with
1577*4a1a9510SRong-En Fanmodifications, sublicense, and/or sell copies of the Software, and to permit
1578*4a1a9510SRong-En Fanpersons to whom the Software is furnished to do so, subject to the following
1579*4a1a9510SRong-En Fanconditions:</P
1580*4a1a9510SRong-En Fan><P
1581*4a1a9510SRong-En Fan>The above copyright notice and this permission notice shall be included in all
1582*4a1a9510SRong-En Fancopies or substantial portions of the Software.</P
1583*4a1a9510SRong-En Fan><P
1584*4a1a9510SRong-En Fan>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
1585*4a1a9510SRong-En FanIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
1586*4a1a9510SRong-En FanFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
1587*4a1a9510SRong-En FanABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
1588*4a1a9510SRong-En FanWHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
1589*4a1a9510SRong-En FanIN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</P
1590*4a1a9510SRong-En Fan><P
1591*4a1a9510SRong-En Fan>Except as contained in this notice, the name(s) of the above copyright holders
1592*4a1a9510SRong-En Fanshall not be used in advertising or otherwise to promote the sale, use or
1593*4a1a9510SRong-En Fanother dealings in this Software without prior written authorization. </P
1594*4a1a9510SRong-En Fan></DIV
1595*4a1a9510SRong-En Fan></DIV
1596*4a1a9510SRong-En Fan><DIV
1597*4a1a9510SRong-En FanCLASS="SECT1"
1598*4a1a9510SRong-En Fan><HR><H2
1599*4a1a9510SRong-En FanCLASS="SECT1"
1600*4a1a9510SRong-En Fan><A
1601*4a1a9510SRong-En FanNAME="HELLOWORLD"
1602*4a1a9510SRong-En Fan>2. Hello World !!!</A
1603*4a1a9510SRong-En Fan></H2
1604*4a1a9510SRong-En Fan><P
1605*4a1a9510SRong-En Fan>Welcome to the world of curses. Before we plunge into the library and look into
1606*4a1a9510SRong-En Fanits various features, let's write a simple program and say
1607*4a1a9510SRong-En Fanhello to the world. </P
1608*4a1a9510SRong-En Fan><DIV
1609*4a1a9510SRong-En FanCLASS="SECT2"
1610*4a1a9510SRong-En Fan><HR><H3
1611*4a1a9510SRong-En FanCLASS="SECT2"
1612*4a1a9510SRong-En Fan><A
1613*4a1a9510SRong-En FanNAME="COMPILECURSES"
1614*4a1a9510SRong-En Fan>2.1. Compiling With the NCURSES Library</A
1615*4a1a9510SRong-En Fan></H3
1616*4a1a9510SRong-En Fan><P
1617*4a1a9510SRong-En Fan>To use ncurses library functions, you have to include ncurses.h in your
1618*4a1a9510SRong-En Fanprograms. To link the
1619*4a1a9510SRong-En Fanprogram with ncurses the flag -lncurses should be added.</P
1620*4a1a9510SRong-En Fan><PRE
1621*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
1622*4a1a9510SRong-En Fan>    #include &lt;ncurses.h&gt;
1623*4a1a9510SRong-En Fan    .
1624*4a1a9510SRong-En Fan    .
1625*4a1a9510SRong-En Fan    .
1626*4a1a9510SRong-En Fan
1627*4a1a9510SRong-En Fan    compile and link: gcc &lt;program file&gt; -lncurses</PRE
1628*4a1a9510SRong-En Fan><DIV
1629*4a1a9510SRong-En FanCLASS="EXAMPLE"
1630*4a1a9510SRong-En Fan><A
1631*4a1a9510SRong-En FanNAME="BHW"
1632*4a1a9510SRong-En Fan></A
1633*4a1a9510SRong-En Fan><P
1634*4a1a9510SRong-En Fan><B
1635*4a1a9510SRong-En Fan>Example 1.  The Hello World !!! Program </B
1636*4a1a9510SRong-En Fan></P
1637*4a1a9510SRong-En Fan><PRE
1638*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
1639*4a1a9510SRong-En Fan><SPAN
1640*4a1a9510SRong-En FanCLASS="INLINEMEDIAOBJECT"
1641*4a1a9510SRong-En Fan>#include &#60;ncurses.h&#62;
1642*4a1a9510SRong-En Fan
1643*4a1a9510SRong-En Fanint main()
1644*4a1a9510SRong-En Fan{
1645*4a1a9510SRong-En Fan	initscr();			/* Start curses mode 		  */
1646*4a1a9510SRong-En Fan	printw("Hello World !!!");	/* Print Hello World		  */
1647*4a1a9510SRong-En Fan	refresh();			/* Print it on to the real screen */
1648*4a1a9510SRong-En Fan	getch();			/* Wait for user input */
1649*4a1a9510SRong-En Fan	endwin();			/* End curses mode		  */
1650*4a1a9510SRong-En Fan
1651*4a1a9510SRong-En Fan	return 0;
1652*4a1a9510SRong-En Fan}</SPAN
1653*4a1a9510SRong-En Fan></PRE
1654*4a1a9510SRong-En Fan></DIV
1655*4a1a9510SRong-En Fan></DIV
1656*4a1a9510SRong-En Fan><DIV
1657*4a1a9510SRong-En FanCLASS="SECT2"
1658*4a1a9510SRong-En Fan><HR><H3
1659*4a1a9510SRong-En FanCLASS="SECT2"
1660*4a1a9510SRong-En Fan><A
1661*4a1a9510SRong-En FanNAME="DISSECTION"
1662*4a1a9510SRong-En Fan>2.2. Dissection</A
1663*4a1a9510SRong-En Fan></H3
1664*4a1a9510SRong-En Fan><P
1665*4a1a9510SRong-En Fan>
1666*4a1a9510SRong-En FanThe above program prints "Hello World !!!" to the screen and exits. This
1667*4a1a9510SRong-En Fanprogram shows how to initialize curses and do screen manipulation and
1668*4a1a9510SRong-En Fanend curses mode. Let's dissect it line by line. </P
1669*4a1a9510SRong-En Fan><DIV
1670*4a1a9510SRong-En FanCLASS="SECT3"
1671*4a1a9510SRong-En Fan><HR><H4
1672*4a1a9510SRong-En FanCLASS="SECT3"
1673*4a1a9510SRong-En Fan><A
1674*4a1a9510SRong-En FanNAME="ABOUT-INITSCR"
1675*4a1a9510SRong-En Fan>2.2.1. About initscr()</A
1676*4a1a9510SRong-En Fan></H4
1677*4a1a9510SRong-En Fan><P
1678*4a1a9510SRong-En Fan>The function initscr() initializes the terminal in curses mode.  In some
1679*4a1a9510SRong-En Fanimplementations, it clears the screen and presents a blank screen. To do any
1680*4a1a9510SRong-En Fanscreen manipulation using curses package this has to be called first. This
1681*4a1a9510SRong-En Fanfunction initializes the curses system and allocates memory for our present
1682*4a1a9510SRong-En Fanwindow (called <TT
1683*4a1a9510SRong-En FanCLASS="LITERAL"
1684*4a1a9510SRong-En Fan>stdscr</TT
1685*4a1a9510SRong-En Fan>) and some other data-structures. Under extreme
1686*4a1a9510SRong-En Fancases this function might fail due to insufficient memory to allocate memory
1687*4a1a9510SRong-En Fanfor curses library's data structures. </P
1688*4a1a9510SRong-En Fan><P
1689*4a1a9510SRong-En Fan>
1690*4a1a9510SRong-En FanAfter this is done, we can do a variety of initializations to customize
1691*4a1a9510SRong-En Fanour curses settings. These details will be explained <A
1692*4a1a9510SRong-En FanHREF="#INIT"
1693*4a1a9510SRong-En Fan>later </A
1694*4a1a9510SRong-En Fan>.</P
1695*4a1a9510SRong-En Fan></DIV
1696*4a1a9510SRong-En Fan><DIV
1697*4a1a9510SRong-En FanCLASS="SECT3"
1698*4a1a9510SRong-En Fan><HR><H4
1699*4a1a9510SRong-En FanCLASS="SECT3"
1700*4a1a9510SRong-En Fan><A
1701*4a1a9510SRong-En FanNAME="MYST-REFRESH"
1702*4a1a9510SRong-En Fan>2.2.2. The mysterious refresh()</A
1703*4a1a9510SRong-En Fan></H4
1704*4a1a9510SRong-En Fan><P
1705*4a1a9510SRong-En Fan>The next line printw prints the string "Hello World !!!" on to the screen. This
1706*4a1a9510SRong-En Fanfunction is analogous to normal printf in all respects except that it prints
1707*4a1a9510SRong-En Fanthe data on a window called stdscr at the current (y,x) co-ordinates. Since our
1708*4a1a9510SRong-En Fanpresent co-ordinates are at 0,0 the string is printed at the left hand corner
1709*4a1a9510SRong-En Fanof the window.</P
1710*4a1a9510SRong-En Fan><P
1711*4a1a9510SRong-En Fan>This brings us to that mysterious refresh(). Well, when we called printw
1712*4a1a9510SRong-En Fanthe data is actually written to an imaginary window, which is not updated
1713*4a1a9510SRong-En Fanon the screen yet. The job of printw is to update a few flags
1714*4a1a9510SRong-En Fanand data structures and write the data to a buffer corresponding to stdscr.
1715*4a1a9510SRong-En FanIn order to show it on the screen, we need to call refresh() and tell the
1716*4a1a9510SRong-En Fancurses system to dump the contents on the screen.</P
1717*4a1a9510SRong-En Fan><P
1718*4a1a9510SRong-En Fan>The philosophy behind all this is to allow the programmer to do multiple updates
1719*4a1a9510SRong-En Fanon the imaginary screen or windows and do a refresh once all his screen update
1720*4a1a9510SRong-En Fanis done. refresh() checks the window and updates only the portion which has been
1721*4a1a9510SRong-En Fanchanged. This improves performance and offers greater flexibility too. But, it is
1722*4a1a9510SRong-En Fansometimes frustrating to beginners. A common mistake committed by beginners is
1723*4a1a9510SRong-En Fanto forget to call refresh() after they did some update through printw() class of
1724*4a1a9510SRong-En Fanfunctions. I still forget to add it sometimes :-) </P
1725*4a1a9510SRong-En Fan></DIV
1726*4a1a9510SRong-En Fan><DIV
1727*4a1a9510SRong-En FanCLASS="SECT3"
1728*4a1a9510SRong-En Fan><HR><H4
1729*4a1a9510SRong-En FanCLASS="SECT3"
1730*4a1a9510SRong-En Fan><A
1731*4a1a9510SRong-En FanNAME="ABOUT-ENDWIN"
1732*4a1a9510SRong-En Fan>2.2.3. About endwin()</A
1733*4a1a9510SRong-En Fan></H4
1734*4a1a9510SRong-En Fan><P
1735*4a1a9510SRong-En Fan>And finally don't forget to end the curses mode. Otherwise your terminal might
1736*4a1a9510SRong-En Fanbehave strangely after the program quits. endwin() frees the memory taken by
1737*4a1a9510SRong-En Fancurses sub-system and its data structures and puts the terminal in normal
1738*4a1a9510SRong-En Fanmode. This function must be called after you are done with the curses mode. </P
1739*4a1a9510SRong-En Fan></DIV
1740*4a1a9510SRong-En Fan></DIV
1741*4a1a9510SRong-En Fan></DIV
1742*4a1a9510SRong-En Fan><DIV
1743*4a1a9510SRong-En FanCLASS="SECT1"
1744*4a1a9510SRong-En Fan><HR><H2
1745*4a1a9510SRong-En FanCLASS="SECT1"
1746*4a1a9510SRong-En Fan><A
1747*4a1a9510SRong-En FanNAME="GORY"
1748*4a1a9510SRong-En Fan>3. The Gory Details</A
1749*4a1a9510SRong-En Fan></H2
1750*4a1a9510SRong-En Fan><P
1751*4a1a9510SRong-En Fan>Now that we have seen how to write a simple curses program let's get into the
1752*4a1a9510SRong-En Fandetails. There are many functions that help customize what you see on screen and
1753*4a1a9510SRong-En Fanmany features which can be put to full use. </P
1754*4a1a9510SRong-En Fan><P
1755*4a1a9510SRong-En Fan>Here we go...</P
1756*4a1a9510SRong-En Fan></DIV
1757*4a1a9510SRong-En Fan><DIV
1758*4a1a9510SRong-En FanCLASS="SECT1"
1759*4a1a9510SRong-En Fan><HR><H2
1760*4a1a9510SRong-En FanCLASS="SECT1"
1761*4a1a9510SRong-En Fan><A
1762*4a1a9510SRong-En FanNAME="INIT"
1763*4a1a9510SRong-En Fan>4. Initialization</A
1764*4a1a9510SRong-En Fan></H2
1765*4a1a9510SRong-En Fan><P
1766*4a1a9510SRong-En Fan>We now know that to initialize curses system the function initscr() has to be
1767*4a1a9510SRong-En Fancalled.  There are functions which can be called after this initialization to
1768*4a1a9510SRong-En Fancustomize our curses session. We may ask the curses system to set the terminal
1769*4a1a9510SRong-En Fanin raw mode or initialize color or initialize the mouse etc.. Let's discuss some
1770*4a1a9510SRong-En Fanof the functions that are normally called immediately after initscr();</P
1771*4a1a9510SRong-En Fan><DIV
1772*4a1a9510SRong-En FanCLASS="SECT2"
1773*4a1a9510SRong-En Fan><HR><H3
1774*4a1a9510SRong-En FanCLASS="SECT2"
1775*4a1a9510SRong-En Fan><A
1776*4a1a9510SRong-En FanNAME="ABOUTINIT"
1777*4a1a9510SRong-En Fan>4.1. Initialization functions</A
1778*4a1a9510SRong-En Fan></H3
1779*4a1a9510SRong-En Fan><P
1780*4a1a9510SRong-En Fan> </P
1781*4a1a9510SRong-En Fan></DIV
1782*4a1a9510SRong-En Fan><DIV
1783*4a1a9510SRong-En FanCLASS="SECT2"
1784*4a1a9510SRong-En Fan><HR><H3
1785*4a1a9510SRong-En FanCLASS="SECT2"
1786*4a1a9510SRong-En Fan><A
1787*4a1a9510SRong-En FanNAME="RAWCBREAK"
1788*4a1a9510SRong-En Fan>4.2. raw() and cbreak()</A
1789*4a1a9510SRong-En Fan></H3
1790*4a1a9510SRong-En Fan><P
1791*4a1a9510SRong-En Fan>Normally the terminal driver buffers the characters a user types until a new
1792*4a1a9510SRong-En Fanline or carriage return is encountered. But most programs require that the
1793*4a1a9510SRong-En Fancharacters be available as soon as the user types them. The above two functions
1794*4a1a9510SRong-En Fanare used to disable line buffering. The difference between these two functions
1795*4a1a9510SRong-En Fanis in the way control characters like suspend (CTRL-Z), interrupt and quit
1796*4a1a9510SRong-En Fan(CTRL-C) are passed to the program. In the raw() mode these characters are
1797*4a1a9510SRong-En Fandirectly passed to the program without generating a signal. In the
1798*4a1a9510SRong-En Fan<TT
1799*4a1a9510SRong-En FanCLASS="LITERAL"
1800*4a1a9510SRong-En Fan>cbreak()</TT
1801*4a1a9510SRong-En Fan> mode these control characters are
1802*4a1a9510SRong-En Faninterpreted as any other character by the terminal driver. I personally prefer
1803*4a1a9510SRong-En Fanto use raw() as I can exercise greater control over what the user does.</P
1804*4a1a9510SRong-En Fan></DIV
1805*4a1a9510SRong-En Fan><DIV
1806*4a1a9510SRong-En FanCLASS="SECT2"
1807*4a1a9510SRong-En Fan><HR><H3
1808*4a1a9510SRong-En FanCLASS="SECT2"
1809*4a1a9510SRong-En Fan><A
1810*4a1a9510SRong-En FanNAME="ECHONOECHO"
1811*4a1a9510SRong-En Fan>4.3. echo() and noecho()</A
1812*4a1a9510SRong-En Fan></H3
1813*4a1a9510SRong-En Fan><P
1814*4a1a9510SRong-En Fan>
1815*4a1a9510SRong-En FanThese functions control the echoing of characters typed by the user to the
1816*4a1a9510SRong-En Fanterminal. <TT
1817*4a1a9510SRong-En FanCLASS="LITERAL"
1818*4a1a9510SRong-En Fan>noecho()</TT
1819*4a1a9510SRong-En Fan> switches off echoing. The
1820*4a1a9510SRong-En Fanreason you might want to do this is to gain more control over echoing or to
1821*4a1a9510SRong-En Fansuppress unnecessary echoing while taking input from the user through the
1822*4a1a9510SRong-En Fangetch() etc. functions. Most of the interactive programs call
1823*4a1a9510SRong-En Fan<TT
1824*4a1a9510SRong-En FanCLASS="LITERAL"
1825*4a1a9510SRong-En Fan>noecho()</TT
1826*4a1a9510SRong-En Fan> at initialization and do the echoing
1827*4a1a9510SRong-En Fanof characters in a controlled manner. It gives the programmer the flexibility
1828*4a1a9510SRong-En Fanof echoing characters at any place in the window without updating current (y,x)
1829*4a1a9510SRong-En Fanco-ordinates. </P
1830*4a1a9510SRong-En Fan></DIV
1831*4a1a9510SRong-En Fan><DIV
1832*4a1a9510SRong-En FanCLASS="SECT2"
1833*4a1a9510SRong-En Fan><HR><H3
1834*4a1a9510SRong-En FanCLASS="SECT2"
1835*4a1a9510SRong-En Fan><A
1836*4a1a9510SRong-En FanNAME="KEYPAD"
1837*4a1a9510SRong-En Fan>4.4. keypad()</A
1838*4a1a9510SRong-En Fan></H3
1839*4a1a9510SRong-En Fan><P
1840*4a1a9510SRong-En Fan>This is my favorite initialization function. It enables the reading of function
1841*4a1a9510SRong-En Fankeys like F1, F2, arrow keys etc. Almost every interactive program enables this,
1842*4a1a9510SRong-En Fanas arrow keys are a major part of any User Interface. Do
1843*4a1a9510SRong-En Fan<TT
1844*4a1a9510SRong-En FanCLASS="LITERAL"
1845*4a1a9510SRong-En Fan>keypad(stdscr, TRUE) </TT
1846*4a1a9510SRong-En Fan> to enable this feature
1847*4a1a9510SRong-En Fanfor the regular screen (stdscr). You will learn more about key management in
1848*4a1a9510SRong-En Fanlater sections of this document.</P
1849*4a1a9510SRong-En Fan></DIV
1850*4a1a9510SRong-En Fan><DIV
1851*4a1a9510SRong-En FanCLASS="SECT2"
1852*4a1a9510SRong-En Fan><HR><H3
1853*4a1a9510SRong-En FanCLASS="SECT2"
1854*4a1a9510SRong-En Fan><A
1855*4a1a9510SRong-En FanNAME="HALFDELAY"
1856*4a1a9510SRong-En Fan>4.5. halfdelay()</A
1857*4a1a9510SRong-En Fan></H3
1858*4a1a9510SRong-En Fan><P
1859*4a1a9510SRong-En Fan>This function, though not used very often, is a useful one at times.
1860*4a1a9510SRong-En Fanhalfdelay()is called to enable the half-delay mode, which is similar to the
1861*4a1a9510SRong-En Fancbreak() mode in that characters typed are immediately available to program.
1862*4a1a9510SRong-En FanHowever, it waits for 'X' tenths of a second for input and then returns ERR, if
1863*4a1a9510SRong-En Fanno input is available. 'X' is the timeout value passed to the function
1864*4a1a9510SRong-En Fanhalfdelay(). This function is useful when you want to ask the user for input,
1865*4a1a9510SRong-En Fanand if he doesn't respond with in certain time, we can do some thing else. One
1866*4a1a9510SRong-En Fanpossible example is a timeout at the password prompt. </P
1867*4a1a9510SRong-En Fan></DIV
1868*4a1a9510SRong-En Fan><DIV
1869*4a1a9510SRong-En FanCLASS="SECT2"
1870*4a1a9510SRong-En Fan><HR><H3
1871*4a1a9510SRong-En FanCLASS="SECT2"
1872*4a1a9510SRong-En Fan><A
1873*4a1a9510SRong-En FanNAME="MISCINIT"
1874*4a1a9510SRong-En Fan>4.6. Miscellaneous Initialization functions</A
1875*4a1a9510SRong-En Fan></H3
1876*4a1a9510SRong-En Fan><P
1877*4a1a9510SRong-En Fan>There are few more functions which are called at initialization to
1878*4a1a9510SRong-En Fancustomize curses behavior. They are not used as extensively as those mentioned
1879*4a1a9510SRong-En Fanabove. Some of them are explained where appropriate.</P
1880*4a1a9510SRong-En Fan></DIV
1881*4a1a9510SRong-En Fan><DIV
1882*4a1a9510SRong-En FanCLASS="SECT2"
1883*4a1a9510SRong-En Fan><HR><H3
1884*4a1a9510SRong-En FanCLASS="SECT2"
1885*4a1a9510SRong-En Fan><A
1886*4a1a9510SRong-En FanNAME="INITEX"
1887*4a1a9510SRong-En Fan>4.7. An Example</A
1888*4a1a9510SRong-En Fan></H3
1889*4a1a9510SRong-En Fan><P
1890*4a1a9510SRong-En Fan>Let's write a program which will clarify the usage of these functions.</P
1891*4a1a9510SRong-En Fan><DIV
1892*4a1a9510SRong-En FanCLASS="EXAMPLE"
1893*4a1a9510SRong-En Fan><A
1894*4a1a9510SRong-En FanNAME="BINFU"
1895*4a1a9510SRong-En Fan></A
1896*4a1a9510SRong-En Fan><P
1897*4a1a9510SRong-En Fan><B
1898*4a1a9510SRong-En Fan>Example 2.  Initialization Function Usage example </B
1899*4a1a9510SRong-En Fan></P
1900*4a1a9510SRong-En Fan><PRE
1901*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
1902*4a1a9510SRong-En Fan><SPAN
1903*4a1a9510SRong-En FanCLASS="INLINEMEDIAOBJECT"
1904*4a1a9510SRong-En Fan>#include &#60;ncurses.h&#62;
1905*4a1a9510SRong-En Fan
1906*4a1a9510SRong-En Fanint main()
1907*4a1a9510SRong-En Fan{	int ch;
1908*4a1a9510SRong-En Fan
1909*4a1a9510SRong-En Fan	initscr();			/* Start curses mode 		*/
1910*4a1a9510SRong-En Fan	raw();				/* Line buffering disabled	*/
1911*4a1a9510SRong-En Fan	keypad(stdscr, TRUE);		/* We get F1, F2 etc..		*/
1912*4a1a9510SRong-En Fan	noecho();			/* Don't echo() while we do getch */
1913*4a1a9510SRong-En Fan
1914*4a1a9510SRong-En Fan    	printw("Type any character to see it in bold\n");
1915*4a1a9510SRong-En Fan	ch = getch();			/* If raw() hadn't been called
1916*4a1a9510SRong-En Fan					 * we have to press enter before it
1917*4a1a9510SRong-En Fan					 * gets to the program 		*/
1918*4a1a9510SRong-En Fan	if(ch == KEY_F(1))		/* Without keypad enabled this will */
1919*4a1a9510SRong-En Fan		printw("F1 Key pressed");/*  not get to us either	*/
1920*4a1a9510SRong-En Fan					/* Without noecho() some ugly escape
1921*4a1a9510SRong-En Fan					 * charachters might have been printed
1922*4a1a9510SRong-En Fan					 * on screen			*/
1923*4a1a9510SRong-En Fan	else
1924*4a1a9510SRong-En Fan	{	printw("The pressed key is ");
1925*4a1a9510SRong-En Fan		attron(A_BOLD);
1926*4a1a9510SRong-En Fan		printw("%c", ch);
1927*4a1a9510SRong-En Fan		attroff(A_BOLD);
1928*4a1a9510SRong-En Fan	}
1929*4a1a9510SRong-En Fan	refresh();			/* Print it on to the real screen */
1930*4a1a9510SRong-En Fan    	getch();			/* Wait for user input */
1931*4a1a9510SRong-En Fan	endwin();			/* End curses mode		  */
1932*4a1a9510SRong-En Fan
1933*4a1a9510SRong-En Fan	return 0;
1934*4a1a9510SRong-En Fan}</SPAN
1935*4a1a9510SRong-En Fan></PRE
1936*4a1a9510SRong-En Fan></DIV
1937*4a1a9510SRong-En Fan><P
1938*4a1a9510SRong-En Fan>This program is self-explanatory. But I used functions which aren't explained
1939*4a1a9510SRong-En Fanyet. The function <TT
1940*4a1a9510SRong-En FanCLASS="LITERAL"
1941*4a1a9510SRong-En Fan>getch()</TT
1942*4a1a9510SRong-En Fan> is used to get a
1943*4a1a9510SRong-En Fancharacter from user. It is equivalent to normal
1944*4a1a9510SRong-En Fan<TT
1945*4a1a9510SRong-En FanCLASS="LITERAL"
1946*4a1a9510SRong-En Fan>getchar()</TT
1947*4a1a9510SRong-En Fan> except that we can disable the line
1948*4a1a9510SRong-En Fanbuffering to avoid &lt;enter&gt; after input. Look for more about
1949*4a1a9510SRong-En Fan<TT
1950*4a1a9510SRong-En FanCLASS="LITERAL"
1951*4a1a9510SRong-En Fan>getch()</TT
1952*4a1a9510SRong-En Fan>and reading keys in the <A
1953*4a1a9510SRong-En FanHREF="#KEYS"
1954*4a1a9510SRong-En Fan> key management section </A
1955*4a1a9510SRong-En Fan>. The functions attron and attroff
1956*4a1a9510SRong-En Fanare used to switch some attributes on and off respectively.  In the example I
1957*4a1a9510SRong-En Fanused them to print the character in bold. These functions are explained in detail
1958*4a1a9510SRong-En Fanlater.</P
1959*4a1a9510SRong-En Fan></DIV
1960*4a1a9510SRong-En Fan></DIV
1961*4a1a9510SRong-En Fan><DIV
1962*4a1a9510SRong-En FanCLASS="SECT1"
1963*4a1a9510SRong-En Fan><HR><H2
1964*4a1a9510SRong-En FanCLASS="SECT1"
1965*4a1a9510SRong-En Fan><A
1966*4a1a9510SRong-En FanNAME="AWORDWINDOWS"
1967*4a1a9510SRong-En Fan>5. A Word about Windows</A
1968*4a1a9510SRong-En Fan></H2
1969*4a1a9510SRong-En Fan><P
1970*4a1a9510SRong-En Fan>
1971*4a1a9510SRong-En FanBefore we plunge into the myriad ncurses functions, let me clear few things
1972*4a1a9510SRong-En Fanabout windows. Windows are explained in detail in following <A
1973*4a1a9510SRong-En FanHREF="#WINDOWS"
1974*4a1a9510SRong-En Fan> sections </A
1975*4a1a9510SRong-En Fan></P
1976*4a1a9510SRong-En Fan><P
1977*4a1a9510SRong-En Fan>A Window is an imaginary screen defined by curses system. A window does not mean
1978*4a1a9510SRong-En Fana bordered window which you usually see on Win9X platforms. When curses is
1979*4a1a9510SRong-En Faninitialized, it creates a default window named
1980*4a1a9510SRong-En Fan<TT
1981*4a1a9510SRong-En FanCLASS="LITERAL"
1982*4a1a9510SRong-En Fan>stdscr</TT
1983*4a1a9510SRong-En Fan> which represents your 80x25 (or the size
1984*4a1a9510SRong-En Fanof window in which you are running) screen.  If you are doing simple tasks like
1985*4a1a9510SRong-En Fanprinting few strings, reading input etc., you can safely use this single window
1986*4a1a9510SRong-En Fanfor all of your purposes. You can also create windows and call functions which
1987*4a1a9510SRong-En Fanexplicitly work on the specified window.</P
1988*4a1a9510SRong-En Fan><P
1989*4a1a9510SRong-En Fan>For example, if you call</P
1990*4a1a9510SRong-En Fan><PRE
1991*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
1992*4a1a9510SRong-En Fan>    printw("Hi There !!!");
1993*4a1a9510SRong-En Fan    refresh();</PRE
1994*4a1a9510SRong-En Fan><P
1995*4a1a9510SRong-En Fan>It prints the string on stdscr at the present cursor position. Similarly the
1996*4a1a9510SRong-En Fancall to refresh(), works on stdscr only. </P
1997*4a1a9510SRong-En Fan><P
1998*4a1a9510SRong-En Fan>Say you have created <A
1999*4a1a9510SRong-En FanHREF="#WINDOWS"
2000*4a1a9510SRong-En Fan>windows</A
2001*4a1a9510SRong-En Fan> then you have to
2002*4a1a9510SRong-En Fancall a function with a 'w' added to the usual function.</P
2003*4a1a9510SRong-En Fan><PRE
2004*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
2005*4a1a9510SRong-En Fan>    wprintw(win, "Hi There !!!");
2006*4a1a9510SRong-En Fan    wrefresh(win);</PRE
2007*4a1a9510SRong-En Fan><P
2008*4a1a9510SRong-En Fan>As you will see in the rest of the document, naming of functions follow the
2009*4a1a9510SRong-En Fansame convention. For each function there usually are three more functions.</P
2010*4a1a9510SRong-En Fan><PRE
2011*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
2012*4a1a9510SRong-En Fan>    printw(string);        /* Print on stdscr at present cursor position */
2013*4a1a9510SRong-En Fan    mvprintw(y, x, string);/* Move to (y, x) then print string     */
2014*4a1a9510SRong-En Fan    wprintw(win, string);  /* Print on window win at present cursor position */
2015*4a1a9510SRong-En Fan                           /* in the window */
2016*4a1a9510SRong-En Fan    mvwprintw(win, y, x, string);   /* Move to (y, x) relative to window */
2017*4a1a9510SRong-En Fan                                    /* co-ordinates and then print         */</PRE
2018*4a1a9510SRong-En Fan><P
2019*4a1a9510SRong-En Fan>Usually the w-less functions are macros which expand to corresponding w-function
2020*4a1a9510SRong-En Fanwith stdscr as the window parameter.</P
2021*4a1a9510SRong-En Fan></DIV
2022*4a1a9510SRong-En Fan><DIV
2023*4a1a9510SRong-En FanCLASS="SECT1"
2024*4a1a9510SRong-En Fan><HR><H2
2025*4a1a9510SRong-En FanCLASS="SECT1"
2026*4a1a9510SRong-En Fan><A
2027*4a1a9510SRong-En FanNAME="PRINTW"
2028*4a1a9510SRong-En Fan>6. Output functions</A
2029*4a1a9510SRong-En Fan></H2
2030*4a1a9510SRong-En Fan><P
2031*4a1a9510SRong-En Fan>I guess you can't wait any more to see some action. Back to our odyssey of
2032*4a1a9510SRong-En Fancurses functions. Now that curses is initialized, let's interact with
2033*4a1a9510SRong-En Fanworld.</P
2034*4a1a9510SRong-En Fan><P
2035*4a1a9510SRong-En Fan>There are three classes of functions which you can use to do output on screen.
2036*4a1a9510SRong-En Fan<P
2037*4a1a9510SRong-En Fan></P
2038*4a1a9510SRong-En Fan><OL
2039*4a1a9510SRong-En FanTYPE="1"
2040*4a1a9510SRong-En Fan><LI
2041*4a1a9510SRong-En Fan><P
2042*4a1a9510SRong-En Fan>addch() class: Print single character with attributes </P
2043*4a1a9510SRong-En Fan></LI
2044*4a1a9510SRong-En Fan><LI
2045*4a1a9510SRong-En Fan><P
2046*4a1a9510SRong-En Fan>printw() class: Print formatted output similar to printf()</P
2047*4a1a9510SRong-En Fan></LI
2048*4a1a9510SRong-En Fan><LI
2049*4a1a9510SRong-En Fan><P
2050*4a1a9510SRong-En Fan>addstr() class: Print strings</P
2051*4a1a9510SRong-En Fan></LI
2052*4a1a9510SRong-En Fan></OL
2053*4a1a9510SRong-En Fan></P
2054*4a1a9510SRong-En Fan><P
2055*4a1a9510SRong-En Fan>These functions can be used interchangeably and it's a matter of style as to
2056*4a1a9510SRong-En Fanwhich class is used. Let's see each one in detail.</P
2057*4a1a9510SRong-En Fan><DIV
2058*4a1a9510SRong-En FanCLASS="SECT2"
2059*4a1a9510SRong-En Fan><HR><H3
2060*4a1a9510SRong-En FanCLASS="SECT2"
2061*4a1a9510SRong-En Fan><A
2062*4a1a9510SRong-En FanNAME="ADDCHCLASS"
2063*4a1a9510SRong-En Fan>6.1. addch() class of functions</A
2064*4a1a9510SRong-En Fan></H3
2065*4a1a9510SRong-En Fan><P
2066*4a1a9510SRong-En Fan>These functions put a single character into the current cursor location and
2067*4a1a9510SRong-En Fanadvance the position of the cursor. You can give the character to be printed but
2068*4a1a9510SRong-En Fanthey usually are used to print a character with some attributes.  Attributes are
2069*4a1a9510SRong-En Fanexplained in detail in later <A
2070*4a1a9510SRong-En FanHREF="#ATTRIB"
2071*4a1a9510SRong-En Fan> sections </A
2072*4a1a9510SRong-En Fan> of the
2073*4a1a9510SRong-En Fandocument. If a character is associated with an attribute(bold, reverse video
2074*4a1a9510SRong-En Fanetc.), when curses prints the character, it is printed in that attribute.</P
2075*4a1a9510SRong-En Fan><P
2076*4a1a9510SRong-En Fan>In order to combine a character with some attributes, you have two options:</P
2077*4a1a9510SRong-En Fan><P
2078*4a1a9510SRong-En Fan></P
2079*4a1a9510SRong-En Fan><UL
2080*4a1a9510SRong-En Fan><LI
2081*4a1a9510SRong-En Fan><P
2082*4a1a9510SRong-En Fan>By OR'ing a single character with the desired attribute macros. These attribute
2083*4a1a9510SRong-En Fanmacros could be found in the header file
2084*4a1a9510SRong-En Fan<TT
2085*4a1a9510SRong-En FanCLASS="LITERAL"
2086*4a1a9510SRong-En Fan>ncurses.h</TT
2087*4a1a9510SRong-En Fan>. For example, you want to print a
2088*4a1a9510SRong-En Fancharacter ch(of type char) bold and underlined, you would call addch() as below.
2089*4a1a9510SRong-En Fan<PRE
2090*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
2091*4a1a9510SRong-En Fan>    addch(ch | A_BOLD | A_UNDERLINE);</PRE
2092*4a1a9510SRong-En Fan></P
2093*4a1a9510SRong-En Fan></LI
2094*4a1a9510SRong-En Fan><LI
2095*4a1a9510SRong-En Fan><P
2096*4a1a9510SRong-En Fan>By using functions like <TT
2097*4a1a9510SRong-En FanCLASS="LITERAL"
2098*4a1a9510SRong-En Fan>attrset(),attron(),attroff()</TT
2099*4a1a9510SRong-En Fan>. These functions are explained in the <A
2100*4a1a9510SRong-En FanHREF="#ATTRIB"
2101*4a1a9510SRong-En Fan>Attributes</A
2102*4a1a9510SRong-En Fan> section. Briefly, they manipulate the current attributes of
2103*4a1a9510SRong-En Fanthe given window. Once set, the character printed in the window are associated
2104*4a1a9510SRong-En Fanwith the attributes until it is turned off.</P
2105*4a1a9510SRong-En Fan></LI
2106*4a1a9510SRong-En Fan></UL
2107*4a1a9510SRong-En Fan><P
2108*4a1a9510SRong-En Fan>Additionally, <TT
2109*4a1a9510SRong-En FanCLASS="LITERAL"
2110*4a1a9510SRong-En Fan>curses</TT
2111*4a1a9510SRong-En Fan> provides some special
2112*4a1a9510SRong-En Fancharacters for character-based graphics. You can draw tables, horizontal or
2113*4a1a9510SRong-En Fanvertical lines, etc. You can find all avaliable characters in the header file
2114*4a1a9510SRong-En Fan<TT
2115*4a1a9510SRong-En FanCLASS="LITERAL"
2116*4a1a9510SRong-En Fan>ncurses.h</TT
2117*4a1a9510SRong-En Fan>.  Try looking for macros beginning
2118*4a1a9510SRong-En Fanwith <TT
2119*4a1a9510SRong-En FanCLASS="LITERAL"
2120*4a1a9510SRong-En Fan>ACS_</TT
2121*4a1a9510SRong-En Fan> in this file. </P
2122*4a1a9510SRong-En Fan></DIV
2123*4a1a9510SRong-En Fan><DIV
2124*4a1a9510SRong-En FanCLASS="SECT2"
2125*4a1a9510SRong-En Fan><HR><H3
2126*4a1a9510SRong-En FanCLASS="SECT2"
2127*4a1a9510SRong-En Fan><A
2128*4a1a9510SRong-En FanNAME="AEN298"
2129*4a1a9510SRong-En Fan>6.2. mvaddch(), waddch() and mvwaddch()</A
2130*4a1a9510SRong-En Fan></H3
2131*4a1a9510SRong-En Fan><P
2132*4a1a9510SRong-En Fan><TT
2133*4a1a9510SRong-En FanCLASS="LITERAL"
2134*4a1a9510SRong-En Fan>mvaddch()</TT
2135*4a1a9510SRong-En Fan> is used to move the cursor to a
2136*4a1a9510SRong-En Fangiven point, and then print. Thus, the calls:
2137*4a1a9510SRong-En Fan<PRE
2138*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
2139*4a1a9510SRong-En Fan>    move(row,col);    /* moves the cursor to row<SPAN
2140*4a1a9510SRong-En FanCLASS="emphasis"
2141*4a1a9510SRong-En Fan><I
2142*4a1a9510SRong-En FanCLASS="EMPHASIS"
2143*4a1a9510SRong-En Fan>th</I
2144*4a1a9510SRong-En Fan></SPAN
2145*4a1a9510SRong-En Fan> row and col<SPAN
2146*4a1a9510SRong-En FanCLASS="emphasis"
2147*4a1a9510SRong-En Fan><I
2148*4a1a9510SRong-En FanCLASS="EMPHASIS"
2149*4a1a9510SRong-En Fan>th</I
2150*4a1a9510SRong-En Fan></SPAN
2151*4a1a9510SRong-En Fan> column */
2152*4a1a9510SRong-En Fan    addch(ch);</PRE
2153*4a1a9510SRong-En Fan>
2154*4a1a9510SRong-En Fancan be replaced by
2155*4a1a9510SRong-En Fan<PRE
2156*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
2157*4a1a9510SRong-En Fan>    mvaddch(row,col,ch);</PRE
2158*4a1a9510SRong-En Fan></P
2159*4a1a9510SRong-En Fan><P
2160*4a1a9510SRong-En Fan><TT
2161*4a1a9510SRong-En FanCLASS="LITERAL"
2162*4a1a9510SRong-En Fan>waddch()</TT
2163*4a1a9510SRong-En Fan> is similar to
2164*4a1a9510SRong-En Fan<TT
2165*4a1a9510SRong-En FanCLASS="LITERAL"
2166*4a1a9510SRong-En Fan>addch()</TT
2167*4a1a9510SRong-En Fan>, except that it adds a character into
2168*4a1a9510SRong-En Fanthe given window. (Note that <TT
2169*4a1a9510SRong-En FanCLASS="LITERAL"
2170*4a1a9510SRong-En Fan>addch()</TT
2171*4a1a9510SRong-En Fan> adds a
2172*4a1a9510SRong-En Fancharacter into the window <TT
2173*4a1a9510SRong-En FanCLASS="LITERAL"
2174*4a1a9510SRong-En Fan>stdscr</TT
2175*4a1a9510SRong-En Fan>.)</P
2176*4a1a9510SRong-En Fan><P
2177*4a1a9510SRong-En Fan>In a similar fashion <TT
2178*4a1a9510SRong-En FanCLASS="LITERAL"
2179*4a1a9510SRong-En Fan>mvwaddch()</TT
2180*4a1a9510SRong-En Fan> function is
2181*4a1a9510SRong-En Fanused to add a character into the given window at the given coordinates.</P
2182*4a1a9510SRong-En Fan><P
2183*4a1a9510SRong-En Fan>Now, we are familiar with the basic output function
2184*4a1a9510SRong-En Fan<TT
2185*4a1a9510SRong-En FanCLASS="LITERAL"
2186*4a1a9510SRong-En Fan>addch()</TT
2187*4a1a9510SRong-En Fan>. But, if we want to print a string, it
2188*4a1a9510SRong-En Fanwould be very annoying to print it character by character. Fortunately,
2189*4a1a9510SRong-En Fan<TT
2190*4a1a9510SRong-En FanCLASS="LITERAL"
2191*4a1a9510SRong-En Fan>ncurses</TT
2192*4a1a9510SRong-En Fan> provides <TT
2193*4a1a9510SRong-En FanCLASS="LITERAL"
2194*4a1a9510SRong-En Fan>printf</TT
2195*4a1a9510SRong-En Fan><SPAN
2196*4a1a9510SRong-En FanCLASS="emphasis"
2197*4a1a9510SRong-En Fan><I
2198*4a1a9510SRong-En FanCLASS="EMPHASIS"
2199*4a1a9510SRong-En Fan>-like</I
2200*4a1a9510SRong-En Fan></SPAN
2201*4a1a9510SRong-En Fan> or
2202*4a1a9510SRong-En Fan<TT
2203*4a1a9510SRong-En FanCLASS="LITERAL"
2204*4a1a9510SRong-En Fan>puts</TT
2205*4a1a9510SRong-En Fan><SPAN
2206*4a1a9510SRong-En FanCLASS="emphasis"
2207*4a1a9510SRong-En Fan><I
2208*4a1a9510SRong-En FanCLASS="EMPHASIS"
2209*4a1a9510SRong-En Fan>-like</I
2210*4a1a9510SRong-En Fan></SPAN
2211*4a1a9510SRong-En Fan> functions.</P
2212*4a1a9510SRong-En Fan></DIV
2213*4a1a9510SRong-En Fan><DIV
2214*4a1a9510SRong-En FanCLASS="SECT2"
2215*4a1a9510SRong-En Fan><HR><H3
2216*4a1a9510SRong-En FanCLASS="SECT2"
2217*4a1a9510SRong-En Fan><A
2218*4a1a9510SRong-En FanNAME="PRINTWCLASS"
2219*4a1a9510SRong-En Fan>6.3. printw() class of functions</A
2220*4a1a9510SRong-En Fan></H3
2221*4a1a9510SRong-En Fan><P
2222*4a1a9510SRong-En Fan>These functions are similar to <TT
2223*4a1a9510SRong-En FanCLASS="LITERAL"
2224*4a1a9510SRong-En Fan>printf()</TT
2225*4a1a9510SRong-En Fan> with
2226*4a1a9510SRong-En Fanthe added capability of printing at any position on the screen. </P
2227*4a1a9510SRong-En Fan><DIV
2228*4a1a9510SRong-En FanCLASS="SECT3"
2229*4a1a9510SRong-En Fan><HR><H4
2230*4a1a9510SRong-En FanCLASS="SECT3"
2231*4a1a9510SRong-En Fan><A
2232*4a1a9510SRong-En FanNAME="PRINTWMVPRINTW"
2233*4a1a9510SRong-En Fan>6.3.1. printw() and mvprintw</A
2234*4a1a9510SRong-En Fan></H4
2235*4a1a9510SRong-En Fan><P
2236*4a1a9510SRong-En Fan>These two functions work much like <TT
2237*4a1a9510SRong-En FanCLASS="LITERAL"
2238*4a1a9510SRong-En Fan>printf()</TT
2239*4a1a9510SRong-En Fan>.
2240*4a1a9510SRong-En Fan<TT
2241*4a1a9510SRong-En FanCLASS="LITERAL"
2242*4a1a9510SRong-En Fan>mvprintw()</TT
2243*4a1a9510SRong-En Fan> can be used to move the cursor to a
2244*4a1a9510SRong-En Fanposition and then print. If you want to move the cursor first and then print
2245*4a1a9510SRong-En Fanusing <TT
2246*4a1a9510SRong-En FanCLASS="LITERAL"
2247*4a1a9510SRong-En Fan>printw()</TT
2248*4a1a9510SRong-En Fan> function, use
2249*4a1a9510SRong-En Fan<TT
2250*4a1a9510SRong-En FanCLASS="LITERAL"
2251*4a1a9510SRong-En Fan>move() </TT
2252*4a1a9510SRong-En Fan> first and then use
2253*4a1a9510SRong-En Fan<TT
2254*4a1a9510SRong-En FanCLASS="LITERAL"
2255*4a1a9510SRong-En Fan>printw()</TT
2256*4a1a9510SRong-En Fan> though I see no point why one should
2257*4a1a9510SRong-En Fanavoid using <TT
2258*4a1a9510SRong-En FanCLASS="LITERAL"
2259*4a1a9510SRong-En Fan>mvprintw()</TT
2260*4a1a9510SRong-En Fan>, you have the
2261*4a1a9510SRong-En Fanflexibility to manipulate. </P
2262*4a1a9510SRong-En Fan></DIV
2263*4a1a9510SRong-En Fan><DIV
2264*4a1a9510SRong-En FanCLASS="SECT3"
2265*4a1a9510SRong-En Fan><HR><H4
2266*4a1a9510SRong-En FanCLASS="SECT3"
2267*4a1a9510SRong-En Fan><A
2268*4a1a9510SRong-En FanNAME="WPRINTWMVWPRINTW"
2269*4a1a9510SRong-En Fan>6.3.2. wprintw() and mvwprintw</A
2270*4a1a9510SRong-En Fan></H4
2271*4a1a9510SRong-En Fan><P
2272*4a1a9510SRong-En Fan>These two functions are similar to above two except that they print in the
2273*4a1a9510SRong-En Fancorresponding window given as argument. </P
2274*4a1a9510SRong-En Fan></DIV
2275*4a1a9510SRong-En Fan><DIV
2276*4a1a9510SRong-En FanCLASS="SECT3"
2277*4a1a9510SRong-En Fan><HR><H4
2278*4a1a9510SRong-En FanCLASS="SECT3"
2279*4a1a9510SRong-En Fan><A
2280*4a1a9510SRong-En FanNAME="VWPRINTW"
2281*4a1a9510SRong-En Fan>6.3.3. vwprintw()</A
2282*4a1a9510SRong-En Fan></H4
2283*4a1a9510SRong-En Fan><P
2284*4a1a9510SRong-En Fan>This function is similar to <TT
2285*4a1a9510SRong-En FanCLASS="LITERAL"
2286*4a1a9510SRong-En Fan>vprintf()</TT
2287*4a1a9510SRong-En Fan>. This can
2288*4a1a9510SRong-En Fanbe used when variable number of arguments are to be printed.</P
2289*4a1a9510SRong-En Fan></DIV
2290*4a1a9510SRong-En Fan><DIV
2291*4a1a9510SRong-En FanCLASS="SECT3"
2292*4a1a9510SRong-En Fan><HR><H4
2293*4a1a9510SRong-En FanCLASS="SECT3"
2294*4a1a9510SRong-En Fan><A
2295*4a1a9510SRong-En FanNAME="SIMPLEPRINTWEX"
2296*4a1a9510SRong-En Fan>6.3.4. A Simple printw example</A
2297*4a1a9510SRong-En Fan></H4
2298*4a1a9510SRong-En Fan><DIV
2299*4a1a9510SRong-En FanCLASS="EXAMPLE"
2300*4a1a9510SRong-En Fan><A
2301*4a1a9510SRong-En FanNAME="BPREX"
2302*4a1a9510SRong-En Fan></A
2303*4a1a9510SRong-En Fan><P
2304*4a1a9510SRong-En Fan><B
2305*4a1a9510SRong-En Fan>Example 3.  A Simple printw example </B
2306*4a1a9510SRong-En Fan></P
2307*4a1a9510SRong-En Fan><PRE
2308*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
2309*4a1a9510SRong-En Fan><SPAN
2310*4a1a9510SRong-En FanCLASS="INLINEMEDIAOBJECT"
2311*4a1a9510SRong-En Fan>#include &#60;ncurses.h&#62;			/* ncurses.h includes stdio.h */
2312*4a1a9510SRong-En Fan#include &#60;string.h&#62;
2313*4a1a9510SRong-En Fan
2314*4a1a9510SRong-En Fanint main()
2315*4a1a9510SRong-En Fan{
2316*4a1a9510SRong-En Fan char mesg[]="Just a string";		/* message to be appeared on the screen */
2317*4a1a9510SRong-En Fan int row,col;				/* to store the number of rows and *
2318*4a1a9510SRong-En Fan					 * the number of colums of the screen */
2319*4a1a9510SRong-En Fan initscr();				/* start the curses mode */
2320*4a1a9510SRong-En Fan getmaxyx(stdscr,row,col);		/* get the number of rows and columns */
2321*4a1a9510SRong-En Fan mvprintw(row/2,(col-strlen(mesg))/2,"%s",mesg);
2322*4a1a9510SRong-En Fan                                	/* print the message at the center of the screen */
2323*4a1a9510SRong-En Fan mvprintw(row-2,0,"This screen has %d rows and %d columns\n",row,col);
2324*4a1a9510SRong-En Fan printw("Try resizing your window(if possible) and then run this program again");
2325*4a1a9510SRong-En Fan refresh();
2326*4a1a9510SRong-En Fan getch();
2327*4a1a9510SRong-En Fan endwin();
2328*4a1a9510SRong-En Fan
2329*4a1a9510SRong-En Fan return 0;
2330*4a1a9510SRong-En Fan}</SPAN
2331*4a1a9510SRong-En Fan></PRE
2332*4a1a9510SRong-En Fan></DIV
2333*4a1a9510SRong-En Fan><P
2334*4a1a9510SRong-En Fan>Above program demonstrates how easy it is to use <TT
2335*4a1a9510SRong-En FanCLASS="LITERAL"
2336*4a1a9510SRong-En Fan>printw</TT
2337*4a1a9510SRong-En Fan>. You just feed the coordinates and the message to be appeared
2338*4a1a9510SRong-En Fanon the screen, then it does what you want.</P
2339*4a1a9510SRong-En Fan><P
2340*4a1a9510SRong-En Fan>The above program introduces us to a new function
2341*4a1a9510SRong-En Fan<TT
2342*4a1a9510SRong-En FanCLASS="LITERAL"
2343*4a1a9510SRong-En Fan>getmaxyx()</TT
2344*4a1a9510SRong-En Fan>, a macro defined in
2345*4a1a9510SRong-En Fan<TT
2346*4a1a9510SRong-En FanCLASS="LITERAL"
2347*4a1a9510SRong-En Fan>ncurses.h</TT
2348*4a1a9510SRong-En Fan>. It gives the number of columns and
2349*4a1a9510SRong-En Fanthe number of rows in a given window.
2350*4a1a9510SRong-En Fan<TT
2351*4a1a9510SRong-En FanCLASS="LITERAL"
2352*4a1a9510SRong-En Fan>getmaxyx()</TT
2353*4a1a9510SRong-En Fan> does this by updating the variables
2354*4a1a9510SRong-En Fangiven to it. Since <TT
2355*4a1a9510SRong-En FanCLASS="LITERAL"
2356*4a1a9510SRong-En Fan>getmaxyx()</TT
2357*4a1a9510SRong-En Fan> is not a function
2358*4a1a9510SRong-En Fanwe don't pass pointers to it, we just give two integer variables. </P
2359*4a1a9510SRong-En Fan></DIV
2360*4a1a9510SRong-En Fan></DIV
2361*4a1a9510SRong-En Fan><DIV
2362*4a1a9510SRong-En FanCLASS="SECT2"
2363*4a1a9510SRong-En Fan><HR><H3
2364*4a1a9510SRong-En FanCLASS="SECT2"
2365*4a1a9510SRong-En Fan><A
2366*4a1a9510SRong-En FanNAME="ADDSTRCLASS"
2367*4a1a9510SRong-En Fan>6.4. addstr() class of functions</A
2368*4a1a9510SRong-En Fan></H3
2369*4a1a9510SRong-En Fan><P
2370*4a1a9510SRong-En Fan><TT
2371*4a1a9510SRong-En FanCLASS="LITERAL"
2372*4a1a9510SRong-En Fan>addstr()</TT
2373*4a1a9510SRong-En Fan> is used to put a character string into
2374*4a1a9510SRong-En Fana given window. This function is similar to calling
2375*4a1a9510SRong-En Fan<TT
2376*4a1a9510SRong-En FanCLASS="LITERAL"
2377*4a1a9510SRong-En Fan>addch()</TT
2378*4a1a9510SRong-En Fan> once for each character in a given
2379*4a1a9510SRong-En Fanstring. This is true for all output functions. There are other functions from
2380*4a1a9510SRong-En Fanthis family such as <TT
2381*4a1a9510SRong-En FanCLASS="LITERAL"
2382*4a1a9510SRong-En Fan>mvaddstr(),mvwaddstr()</TT
2383*4a1a9510SRong-En Fan> and
2384*4a1a9510SRong-En Fan<TT
2385*4a1a9510SRong-En FanCLASS="LITERAL"
2386*4a1a9510SRong-En Fan>waddstr()</TT
2387*4a1a9510SRong-En Fan>, which obey the naming convention of
2388*4a1a9510SRong-En Fancurses.(e.g. mvaddstr() is similar to the respective calls move() and then
2389*4a1a9510SRong-En Fanaddstr().) Another function of this family is addnstr(), which takes an integer
2390*4a1a9510SRong-En Fanparameter(say n) additionally. This function puts at most n characters into the
2391*4a1a9510SRong-En Fanscreen. If n is negative, then the entire string will be added. </P
2392*4a1a9510SRong-En Fan></DIV
2393*4a1a9510SRong-En Fan><DIV
2394*4a1a9510SRong-En FanCLASS="SECT2"
2395*4a1a9510SRong-En Fan><HR><H3
2396*4a1a9510SRong-En FanCLASS="SECT2"
2397*4a1a9510SRong-En Fan><A
2398*4a1a9510SRong-En FanNAME="ACAUTION"
2399*4a1a9510SRong-En Fan>6.5. A word of caution</A
2400*4a1a9510SRong-En Fan></H3
2401*4a1a9510SRong-En Fan><P
2402*4a1a9510SRong-En Fan>All these functions take y co-ordinate first and then x in their arguments.
2403*4a1a9510SRong-En FanA common mistake by beginners is to pass x,y in that order. If you are
2404*4a1a9510SRong-En Fandoing too many manipulations of (y,x) co-ordinates, think of dividing the
2405*4a1a9510SRong-En Fanscreen into windows and manipulate each one separately. Windows are explained
2406*4a1a9510SRong-En Fanin the <A
2407*4a1a9510SRong-En FanHREF="#WINDOWS"
2408*4a1a9510SRong-En Fan> windows </A
2409*4a1a9510SRong-En Fan> section.</P
2410*4a1a9510SRong-En Fan></DIV
2411*4a1a9510SRong-En Fan></DIV
2412*4a1a9510SRong-En Fan><DIV
2413*4a1a9510SRong-En FanCLASS="SECT1"
2414*4a1a9510SRong-En Fan><HR><H2
2415*4a1a9510SRong-En FanCLASS="SECT1"
2416*4a1a9510SRong-En Fan><A
2417*4a1a9510SRong-En FanNAME="SCANW"
2418*4a1a9510SRong-En Fan>7. Input functions</A
2419*4a1a9510SRong-En Fan></H2
2420*4a1a9510SRong-En Fan><P
2421*4a1a9510SRong-En Fan>Well, printing without taking input, is boring. Let's see functions which
2422*4a1a9510SRong-En Fanallow us to get input from user. These functions also can be divided into
2423*4a1a9510SRong-En Fanthree categories.</P
2424*4a1a9510SRong-En Fan><P
2425*4a1a9510SRong-En Fan></P
2426*4a1a9510SRong-En Fan><OL
2427*4a1a9510SRong-En FanTYPE="1"
2428*4a1a9510SRong-En Fan><LI
2429*4a1a9510SRong-En Fan><P
2430*4a1a9510SRong-En Fan>getch() class: Get a character</P
2431*4a1a9510SRong-En Fan></LI
2432*4a1a9510SRong-En Fan><LI
2433*4a1a9510SRong-En Fan><P
2434*4a1a9510SRong-En Fan>scanw() class: Get formatted input</P
2435*4a1a9510SRong-En Fan></LI
2436*4a1a9510SRong-En Fan><LI
2437*4a1a9510SRong-En Fan><P
2438*4a1a9510SRong-En Fan>getstr() class: Get strings</P
2439*4a1a9510SRong-En Fan></LI
2440*4a1a9510SRong-En Fan></OL
2441*4a1a9510SRong-En Fan><DIV
2442*4a1a9510SRong-En FanCLASS="SECT2"
2443*4a1a9510SRong-En Fan><HR><H3
2444*4a1a9510SRong-En FanCLASS="SECT2"
2445*4a1a9510SRong-En Fan><A
2446*4a1a9510SRong-En FanNAME="GETCHCLASS"
2447*4a1a9510SRong-En Fan>7.1. getch() class of functions</A
2448*4a1a9510SRong-En Fan></H3
2449*4a1a9510SRong-En Fan><P
2450*4a1a9510SRong-En Fan>These functions read a single character from the terminal. But there are several
2451*4a1a9510SRong-En Fansubtle facts to consider. For example if you don't use the function cbreak(),
2452*4a1a9510SRong-En Fancurses will not read your input characters contiguously but will begin read them
2453*4a1a9510SRong-En Fanonly after a new line or an EOF is encountered. In order to avoid this, the
2454*4a1a9510SRong-En Fancbreak() function must used so that characters are immediately available to your
2455*4a1a9510SRong-En Fanprogram. Another widely used function is noecho(). As the name suggests, when
2456*4a1a9510SRong-En Fanthis function is set (used), the characters that are keyed in by the user will
2457*4a1a9510SRong-En Fannot show up on the screen. The two functions cbreak() and noecho() are typical
2458*4a1a9510SRong-En Fanexamples of key management.  Functions of this genre are explained in the
2459*4a1a9510SRong-En Fan<A
2460*4a1a9510SRong-En FanHREF="#KEYS"
2461*4a1a9510SRong-En Fan>key management section </A
2462*4a1a9510SRong-En Fan>.</P
2463*4a1a9510SRong-En Fan></DIV
2464*4a1a9510SRong-En Fan><DIV
2465*4a1a9510SRong-En FanCLASS="SECT2"
2466*4a1a9510SRong-En Fan><HR><H3
2467*4a1a9510SRong-En FanCLASS="SECT2"
2468*4a1a9510SRong-En Fan><A
2469*4a1a9510SRong-En FanNAME="SCANWCLASS"
2470*4a1a9510SRong-En Fan>7.2. scanw() class of functions</A
2471*4a1a9510SRong-En Fan></H3
2472*4a1a9510SRong-En Fan><P
2473*4a1a9510SRong-En Fan>These functions are similar to <TT
2474*4a1a9510SRong-En FanCLASS="LITERAL"
2475*4a1a9510SRong-En Fan>scanf()</TT
2476*4a1a9510SRong-En Fan> with the
2477*4a1a9510SRong-En Fanadded capability of getting the input from any location on the screen.</P
2478*4a1a9510SRong-En Fan><DIV
2479*4a1a9510SRong-En FanCLASS="SECT3"
2480*4a1a9510SRong-En Fan><HR><H4
2481*4a1a9510SRong-En FanCLASS="SECT3"
2482*4a1a9510SRong-En Fan><A
2483*4a1a9510SRong-En FanNAME="SCANWMVSCANW"
2484*4a1a9510SRong-En Fan>7.2.1. scanw() and mvscanw</A
2485*4a1a9510SRong-En Fan></H4
2486*4a1a9510SRong-En Fan><P
2487*4a1a9510SRong-En Fan>The usage of these functions is similar to that of
2488*4a1a9510SRong-En Fan<TT
2489*4a1a9510SRong-En FanCLASS="LITERAL"
2490*4a1a9510SRong-En Fan>sscanf()</TT
2491*4a1a9510SRong-En Fan>, where the line to be scanned is
2492*4a1a9510SRong-En Fanprovided by <TT
2493*4a1a9510SRong-En FanCLASS="LITERAL"
2494*4a1a9510SRong-En Fan>wgetstr()</TT
2495*4a1a9510SRong-En Fan> function. That is, these
2496*4a1a9510SRong-En Fanfunctions call to <TT
2497*4a1a9510SRong-En FanCLASS="LITERAL"
2498*4a1a9510SRong-En Fan>wgetstr()</TT
2499*4a1a9510SRong-En Fan> function(explained
2500*4a1a9510SRong-En Fanbelow) and uses the resulting line for a scan. </P
2501*4a1a9510SRong-En Fan></DIV
2502*4a1a9510SRong-En Fan><DIV
2503*4a1a9510SRong-En FanCLASS="SECT3"
2504*4a1a9510SRong-En Fan><HR><H4
2505*4a1a9510SRong-En FanCLASS="SECT3"
2506*4a1a9510SRong-En Fan><A
2507*4a1a9510SRong-En FanNAME="WSCANWMVWSCANW"
2508*4a1a9510SRong-En Fan>7.2.2. wscanw() and mvwscanw()</A
2509*4a1a9510SRong-En Fan></H4
2510*4a1a9510SRong-En Fan><P
2511*4a1a9510SRong-En Fan>These are similar to above two functions except that they read from a window,
2512*4a1a9510SRong-En Fanwhich is supplied as one of the arguments to these functions. </P
2513*4a1a9510SRong-En Fan></DIV
2514*4a1a9510SRong-En Fan><DIV
2515*4a1a9510SRong-En FanCLASS="SECT3"
2516*4a1a9510SRong-En Fan><HR><H4
2517*4a1a9510SRong-En FanCLASS="SECT3"
2518*4a1a9510SRong-En Fan><A
2519*4a1a9510SRong-En FanNAME="VWSCANW"
2520*4a1a9510SRong-En Fan>7.2.3. vwscanw()</A
2521*4a1a9510SRong-En Fan></H4
2522*4a1a9510SRong-En Fan><P
2523*4a1a9510SRong-En Fan>This function is similar to <TT
2524*4a1a9510SRong-En FanCLASS="LITERAL"
2525*4a1a9510SRong-En Fan>vscanf()</TT
2526*4a1a9510SRong-En Fan>. This can
2527*4a1a9510SRong-En Fanbe used when a variable number of arguments are to be scanned.</P
2528*4a1a9510SRong-En Fan></DIV
2529*4a1a9510SRong-En Fan></DIV
2530*4a1a9510SRong-En Fan><DIV
2531*4a1a9510SRong-En FanCLASS="SECT2"
2532*4a1a9510SRong-En Fan><HR><H3
2533*4a1a9510SRong-En FanCLASS="SECT2"
2534*4a1a9510SRong-En Fan><A
2535*4a1a9510SRong-En FanNAME="GETSTRCLASS"
2536*4a1a9510SRong-En Fan>7.3. getstr() class of functions</A
2537*4a1a9510SRong-En Fan></H3
2538*4a1a9510SRong-En Fan><P
2539*4a1a9510SRong-En Fan>These functions are used to get strings from the terminal. In essence, this
2540*4a1a9510SRong-En Fanfunction performs the same task as would be achieved by a series of calls to
2541*4a1a9510SRong-En Fan<TT
2542*4a1a9510SRong-En FanCLASS="LITERAL"
2543*4a1a9510SRong-En Fan>getch()</TT
2544*4a1a9510SRong-En Fan> until a newline, carriage return, or
2545*4a1a9510SRong-En Fanend-of-file is received. The resulting string of characters are pointed to by
2546*4a1a9510SRong-En Fan<TT
2547*4a1a9510SRong-En FanCLASS="LITERAL"
2548*4a1a9510SRong-En Fan>str</TT
2549*4a1a9510SRong-En Fan>, which is a character pointer provided by
2550*4a1a9510SRong-En Fanthe user.</P
2551*4a1a9510SRong-En Fan></DIV
2552*4a1a9510SRong-En Fan><DIV
2553*4a1a9510SRong-En FanCLASS="SECT2"
2554*4a1a9510SRong-En Fan><HR><H3
2555*4a1a9510SRong-En FanCLASS="SECT2"
2556*4a1a9510SRong-En Fan><A
2557*4a1a9510SRong-En FanNAME="GETSTREX"
2558*4a1a9510SRong-En Fan>7.4. Some examples</A
2559*4a1a9510SRong-En Fan></H3
2560*4a1a9510SRong-En Fan><DIV
2561*4a1a9510SRong-En FanCLASS="EXAMPLE"
2562*4a1a9510SRong-En Fan><A
2563*4a1a9510SRong-En FanNAME="BSCEX"
2564*4a1a9510SRong-En Fan></A
2565*4a1a9510SRong-En Fan><P
2566*4a1a9510SRong-En Fan><B
2567*4a1a9510SRong-En Fan>Example 4.  A Simple scanw example </B
2568*4a1a9510SRong-En Fan></P
2569*4a1a9510SRong-En Fan><PRE
2570*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
2571*4a1a9510SRong-En Fan><SPAN
2572*4a1a9510SRong-En FanCLASS="INLINEMEDIAOBJECT"
2573*4a1a9510SRong-En Fan>#include &#60;ncurses.h&#62;			/* ncurses.h includes stdio.h */
2574*4a1a9510SRong-En Fan#include &#60;string.h&#62;
2575*4a1a9510SRong-En Fan
2576*4a1a9510SRong-En Fanint main()
2577*4a1a9510SRong-En Fan{
2578*4a1a9510SRong-En Fan char mesg[]="Enter a string: ";		/* message to be appeared on the screen */
2579*4a1a9510SRong-En Fan char str[80];
2580*4a1a9510SRong-En Fan int row,col;				/* to store the number of rows and *
2581*4a1a9510SRong-En Fan					 * the number of colums of the screen */
2582*4a1a9510SRong-En Fan initscr();				/* start the curses mode */
2583*4a1a9510SRong-En Fan getmaxyx(stdscr,row,col);		/* get the number of rows and columns */
2584*4a1a9510SRong-En Fan mvprintw(row/2,(col-strlen(mesg))/2,"%s",mesg);
2585*4a1a9510SRong-En Fan                     		/* print the message at the center of the screen */
2586*4a1a9510SRong-En Fan getstr(str);
2587*4a1a9510SRong-En Fan mvprintw(LINES - 2, 0, "You Entered: %s", str);
2588*4a1a9510SRong-En Fan getch();
2589*4a1a9510SRong-En Fan endwin();
2590*4a1a9510SRong-En Fan
2591*4a1a9510SRong-En Fan return 0;
2592*4a1a9510SRong-En Fan}</SPAN
2593*4a1a9510SRong-En Fan></PRE
2594*4a1a9510SRong-En Fan></DIV
2595*4a1a9510SRong-En Fan></DIV
2596*4a1a9510SRong-En Fan></DIV
2597*4a1a9510SRong-En Fan><DIV
2598*4a1a9510SRong-En FanCLASS="SECT1"
2599*4a1a9510SRong-En Fan><HR><H2
2600*4a1a9510SRong-En FanCLASS="SECT1"
2601*4a1a9510SRong-En Fan><A
2602*4a1a9510SRong-En FanNAME="ATTRIB"
2603*4a1a9510SRong-En Fan>8. Attributes</A
2604*4a1a9510SRong-En Fan></H2
2605*4a1a9510SRong-En Fan><P
2606*4a1a9510SRong-En Fan>We have seen an example of how attributes can be used to print characters with
2607*4a1a9510SRong-En Fansome special effects. Attributes, when set prudently, can present information in
2608*4a1a9510SRong-En Fanan easy, understandable manner. The following program takes a C file as input
2609*4a1a9510SRong-En Fanand prints the file with comments in bold. Scan through the code. </P
2610*4a1a9510SRong-En Fan><DIV
2611*4a1a9510SRong-En FanCLASS="EXAMPLE"
2612*4a1a9510SRong-En Fan><A
2613*4a1a9510SRong-En FanNAME="BSIAT"
2614*4a1a9510SRong-En Fan></A
2615*4a1a9510SRong-En Fan><P
2616*4a1a9510SRong-En Fan><B
2617*4a1a9510SRong-En Fan>Example 5.  A Simple Attributes example </B
2618*4a1a9510SRong-En Fan></P
2619*4a1a9510SRong-En Fan><PRE
2620*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
2621*4a1a9510SRong-En Fan><SPAN
2622*4a1a9510SRong-En FanCLASS="INLINEMEDIAOBJECT"
2623*4a1a9510SRong-En Fan>/* pager functionality by Joseph Spainhour" &#60;[email protected]&#62; */
2624*4a1a9510SRong-En Fan#include &#60;ncurses.h&#62;
2625*4a1a9510SRong-En Fan#include &#60;stdlib.h&#62;
2626*4a1a9510SRong-En Fan
2627*4a1a9510SRong-En Fanint main(int argc, char *argv[])
2628*4a1a9510SRong-En Fan{
2629*4a1a9510SRong-En Fan  int ch, prev, row, col;
2630*4a1a9510SRong-En Fan  prev = EOF;
2631*4a1a9510SRong-En Fan  FILE *fp;
2632*4a1a9510SRong-En Fan  int y, x;
2633*4a1a9510SRong-En Fan
2634*4a1a9510SRong-En Fan  if(argc != 2)
2635*4a1a9510SRong-En Fan  {
2636*4a1a9510SRong-En Fan    printf("Usage: %s &#60;a c file name&#62;\n", argv[0]);
2637*4a1a9510SRong-En Fan    exit(1);
2638*4a1a9510SRong-En Fan  }
2639*4a1a9510SRong-En Fan  fp = fopen(argv[1], "r");
2640*4a1a9510SRong-En Fan  if(fp == NULL)
2641*4a1a9510SRong-En Fan  {
2642*4a1a9510SRong-En Fan    perror("Cannot open input file");
2643*4a1a9510SRong-En Fan    exit(1);
2644*4a1a9510SRong-En Fan  }
2645*4a1a9510SRong-En Fan  initscr();				/* Start curses mode */
2646*4a1a9510SRong-En Fan  getmaxyx(stdscr, row, col);		/* find the boundaries of the screeen */
2647*4a1a9510SRong-En Fan  while((ch = fgetc(fp)) != EOF)	/* read the file till we reach the end */
2648*4a1a9510SRong-En Fan  {
2649*4a1a9510SRong-En Fan    getyx(stdscr, y, x);		/* get the current curser position */
2650*4a1a9510SRong-En Fan    if(y == (row - 1))			/* are we are at the end of the screen */
2651*4a1a9510SRong-En Fan    {
2652*4a1a9510SRong-En Fan      printw("&#60;-Press Any Key-&#62;");	/* tell the user to press a key */
2653*4a1a9510SRong-En Fan      getch();
2654*4a1a9510SRong-En Fan      clear();				/* clear the screen */
2655*4a1a9510SRong-En Fan      move(0, 0);			/* start at the beginning of the screen */
2656*4a1a9510SRong-En Fan    }
2657*4a1a9510SRong-En Fan    if(prev == '/' &#38;&#38; ch == '*')    	/* If it is / and * then only
2658*4a1a9510SRong-En Fan                                     	 * switch bold on */
2659*4a1a9510SRong-En Fan    {
2660*4a1a9510SRong-En Fan      attron(A_BOLD);			/* cut bold on */
2661*4a1a9510SRong-En Fan      getyx(stdscr, y, x);		/* get the current curser position */
2662*4a1a9510SRong-En Fan      move(y, x - 1);			/* back up one space */
2663*4a1a9510SRong-En Fan      printw("%c%c", '/', ch); 		/* The actual printing is done here */
2664*4a1a9510SRong-En Fan    }
2665*4a1a9510SRong-En Fan    else
2666*4a1a9510SRong-En Fan      printw("%c", ch);
2667*4a1a9510SRong-En Fan    refresh();
2668*4a1a9510SRong-En Fan    if(prev == '*' &#38;&#38; ch == '/')
2669*4a1a9510SRong-En Fan      attroff(A_BOLD);        		/* Switch it off once we got *
2670*4a1a9510SRong-En Fan                                 	 * and then / */
2671*4a1a9510SRong-En Fan    prev = ch;
2672*4a1a9510SRong-En Fan  }
2673*4a1a9510SRong-En Fan  endwin();                       	/* End curses mode */
2674*4a1a9510SRong-En Fan  fclose(fp);
2675*4a1a9510SRong-En Fan  return 0;
2676*4a1a9510SRong-En Fan}</SPAN
2677*4a1a9510SRong-En Fan></PRE
2678*4a1a9510SRong-En Fan></DIV
2679*4a1a9510SRong-En Fan><P
2680*4a1a9510SRong-En Fan>
2681*4a1a9510SRong-En FanDon't worry about all those initialization and other crap. Concentrate on
2682*4a1a9510SRong-En Fanthe while loop. It reads each character in the file and searches for the
2683*4a1a9510SRong-En Fanpattern /*. Once it spots the pattern, it switches the BOLD attribute on with
2684*4a1a9510SRong-En Fan<TT
2685*4a1a9510SRong-En FanCLASS="LITERAL"
2686*4a1a9510SRong-En Fan> attron()</TT
2687*4a1a9510SRong-En Fan> . When we get the pattern */ it is
2688*4a1a9510SRong-En Fanswitched off by <TT
2689*4a1a9510SRong-En FanCLASS="LITERAL"
2690*4a1a9510SRong-En Fan> attroff()</TT
2691*4a1a9510SRong-En Fan> .</P
2692*4a1a9510SRong-En Fan><P
2693*4a1a9510SRong-En Fan>
2694*4a1a9510SRong-En FanThe above program also introduces us to two useful functions
2695*4a1a9510SRong-En Fan<TT
2696*4a1a9510SRong-En FanCLASS="LITERAL"
2697*4a1a9510SRong-En Fan>getyx() </TT
2698*4a1a9510SRong-En Fan> and
2699*4a1a9510SRong-En Fan<TT
2700*4a1a9510SRong-En FanCLASS="LITERAL"
2701*4a1a9510SRong-En Fan>move()</TT
2702*4a1a9510SRong-En Fan>. The first function gets the
2703*4a1a9510SRong-En Fanco-ordinates of the present cursor into the variables y, x. Since getyx() is a
2704*4a1a9510SRong-En Fanmacro we don't have to pass pointers to variables. The function
2705*4a1a9510SRong-En Fan<TT
2706*4a1a9510SRong-En FanCLASS="LITERAL"
2707*4a1a9510SRong-En Fan>move()</TT
2708*4a1a9510SRong-En Fan> moves the cursor to the co-ordinates
2709*4a1a9510SRong-En Fangiven to it. </P
2710*4a1a9510SRong-En Fan><P
2711*4a1a9510SRong-En Fan>
2712*4a1a9510SRong-En FanThe above program is really a simple one which doesn't do much. On these lines
2713*4a1a9510SRong-En Fanone could write a more useful program which reads a C file, parses it and prints
2714*4a1a9510SRong-En Fanit in different colors. One could even extend it to other languages as well.</P
2715*4a1a9510SRong-En Fan><DIV
2716*4a1a9510SRong-En FanCLASS="SECT2"
2717*4a1a9510SRong-En Fan><HR><H3
2718*4a1a9510SRong-En FanCLASS="SECT2"
2719*4a1a9510SRong-En Fan><A
2720*4a1a9510SRong-En FanNAME="ATTRIBDETAILS"
2721*4a1a9510SRong-En Fan>8.1. The details</A
2722*4a1a9510SRong-En Fan></H3
2723*4a1a9510SRong-En Fan><P
2724*4a1a9510SRong-En Fan>Let's get into more details of attributes. The functions <TT
2725*4a1a9510SRong-En FanCLASS="LITERAL"
2726*4a1a9510SRong-En Fan>attron(), attroff(), attrset() </TT
2727*4a1a9510SRong-En Fan>, and their sister functions
2728*4a1a9510SRong-En Fan<TT
2729*4a1a9510SRong-En FanCLASS="LITERAL"
2730*4a1a9510SRong-En Fan> attr_get()</TT
2731*4a1a9510SRong-En Fan> etc..  can be used to switch
2732*4a1a9510SRong-En Fanattributes on/off , get attributes and produce a colorful display.</P
2733*4a1a9510SRong-En Fan><P
2734*4a1a9510SRong-En Fan>The functions attron and attroff take a bit-mask of attributes and switch them
2735*4a1a9510SRong-En Fanon or off, respectively. The following video attributes, which are defined in
2736*4a1a9510SRong-En Fan&lt;curses.h&gt; can be passed to these functions. </P
2737*4a1a9510SRong-En Fan><PRE
2738*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
2739*4a1a9510SRong-En Fan>
2740*4a1a9510SRong-En Fan    A_NORMAL        Normal display (no highlight)
2741*4a1a9510SRong-En Fan    A_STANDOUT      Best highlighting mode of the terminal.
2742*4a1a9510SRong-En Fan    A_UNDERLINE     Underlining
2743*4a1a9510SRong-En Fan    A_REVERSE       Reverse video
2744*4a1a9510SRong-En Fan    A_BLINK         Blinking
2745*4a1a9510SRong-En Fan    A_DIM           Half bright
2746*4a1a9510SRong-En Fan    A_BOLD          Extra bright or bold
2747*4a1a9510SRong-En Fan    A_PROTECT       Protected mode
2748*4a1a9510SRong-En Fan    A_INVIS         Invisible or blank mode
2749*4a1a9510SRong-En Fan    A_ALTCHARSET    Alternate character set
2750*4a1a9510SRong-En Fan    A_CHARTEXT      Bit-mask to extract a character
2751*4a1a9510SRong-En Fan    COLOR_PAIR(n)   Color-pair number n
2752*4a1a9510SRong-En Fan    </PRE
2753*4a1a9510SRong-En Fan><P
2754*4a1a9510SRong-En Fan>
2755*4a1a9510SRong-En FanThe last one is the most colorful one :-) Colors are explained in the
2756*4a1a9510SRong-En Fan<A
2757*4a1a9510SRong-En FanHREF="#color"
2758*4a1a9510SRong-En FanTARGET="_top"
2759*4a1a9510SRong-En Fan>next sections</A
2760*4a1a9510SRong-En Fan>.</P
2761*4a1a9510SRong-En Fan><P
2762*4a1a9510SRong-En Fan>We can OR(|) any number of above attributes to get a combined effect. If you
2763*4a1a9510SRong-En Fanwanted reverse video with blinking characters you can use</P
2764*4a1a9510SRong-En Fan><PRE
2765*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
2766*4a1a9510SRong-En Fan>    attron(A_REVERSE | A_BLINK);</PRE
2767*4a1a9510SRong-En Fan></DIV
2768*4a1a9510SRong-En Fan><DIV
2769*4a1a9510SRong-En FanCLASS="SECT2"
2770*4a1a9510SRong-En Fan><HR><H3
2771*4a1a9510SRong-En FanCLASS="SECT2"
2772*4a1a9510SRong-En Fan><A
2773*4a1a9510SRong-En FanNAME="ATTRONVSATTRSET"
2774*4a1a9510SRong-En Fan>8.2. attron() vs attrset()</A
2775*4a1a9510SRong-En Fan></H3
2776*4a1a9510SRong-En Fan><P
2777*4a1a9510SRong-En Fan>Then what is the difference between attron() and attrset()? attrset sets the
2778*4a1a9510SRong-En Fanattributes of window whereas attron just switches on the attribute given to it.
2779*4a1a9510SRong-En FanSo attrset() fully overrides whatever attributes the window previously had and
2780*4a1a9510SRong-En Fansets it to the new attribute(s). Similarly attroff() just switches off the
2781*4a1a9510SRong-En Fanattribute(s) given to it as an argument. This gives us the flexibility of
2782*4a1a9510SRong-En Fanmanaging attributes easily.But if you use them carelessly you may loose track of
2783*4a1a9510SRong-En Fanwhat attributes the window has and garble the display. This is especially true
2784*4a1a9510SRong-En Fanwhile managing menus with colors and highlighting. So decide on a consistent
2785*4a1a9510SRong-En Fanpolicy and stick to it. You can always use <TT
2786*4a1a9510SRong-En FanCLASS="LITERAL"
2787*4a1a9510SRong-En Fan> standend()</TT
2788*4a1a9510SRong-En Fan> which is equivalent to <TT
2789*4a1a9510SRong-En FanCLASS="LITERAL"
2790*4a1a9510SRong-En Fan> attrset(A_NORMAL)</TT
2791*4a1a9510SRong-En Fan> which turns off all attributes and brings you to normal mode.</P
2792*4a1a9510SRong-En Fan></DIV
2793*4a1a9510SRong-En Fan><DIV
2794*4a1a9510SRong-En FanCLASS="SECT2"
2795*4a1a9510SRong-En Fan><HR><H3
2796*4a1a9510SRong-En FanCLASS="SECT2"
2797*4a1a9510SRong-En Fan><A
2798*4a1a9510SRong-En FanNAME="ATTR_GET"
2799*4a1a9510SRong-En Fan>8.3. attr_get()</A
2800*4a1a9510SRong-En Fan></H3
2801*4a1a9510SRong-En Fan><P
2802*4a1a9510SRong-En Fan>&#13;The function attr_get() gets the current attributes and color pair of the
2803*4a1a9510SRong-En Fanwindow. Though we might not use this as often as the above functions, this is
2804*4a1a9510SRong-En Fanuseful in scanning areas of screen. Say we wanted to do some complex update on
2805*4a1a9510SRong-En Fanscreen and we are not sure what attribute each character is associated with.
2806*4a1a9510SRong-En FanThen this function can be used with either attrset or attron to produce the
2807*4a1a9510SRong-En Fandesired effect.&#13;</P
2808*4a1a9510SRong-En Fan></DIV
2809*4a1a9510SRong-En Fan><DIV
2810*4a1a9510SRong-En FanCLASS="SECT2"
2811*4a1a9510SRong-En Fan><HR><H3
2812*4a1a9510SRong-En FanCLASS="SECT2"
2813*4a1a9510SRong-En Fan><A
2814*4a1a9510SRong-En FanNAME="ATTR_FUNCS"
2815*4a1a9510SRong-En Fan>8.4. attr_ functions</A
2816*4a1a9510SRong-En Fan></H3
2817*4a1a9510SRong-En Fan><P
2818*4a1a9510SRong-En Fan>There are series of functions like attr_set(), attr_on etc.. These are similar
2819*4a1a9510SRong-En Fanto above functions except that they take parameters of type
2820*4a1a9510SRong-En Fan<TT
2821*4a1a9510SRong-En FanCLASS="LITERAL"
2822*4a1a9510SRong-En Fan>attr_t</TT
2823*4a1a9510SRong-En Fan>.</P
2824*4a1a9510SRong-En Fan></DIV
2825*4a1a9510SRong-En Fan><DIV
2826*4a1a9510SRong-En FanCLASS="SECT2"
2827*4a1a9510SRong-En Fan><HR><H3
2828*4a1a9510SRong-En FanCLASS="SECT2"
2829*4a1a9510SRong-En Fan><A
2830*4a1a9510SRong-En FanNAME="WATTRFUNCS"
2831*4a1a9510SRong-En Fan>8.5. wattr functions</A
2832*4a1a9510SRong-En Fan></H3
2833*4a1a9510SRong-En Fan><P
2834*4a1a9510SRong-En Fan>For each of the above functions we have a corresponding function with 'w' which
2835*4a1a9510SRong-En Fanoperates on a particular window. The above functions operate on stdscr. </P
2836*4a1a9510SRong-En Fan></DIV
2837*4a1a9510SRong-En Fan><DIV
2838*4a1a9510SRong-En FanCLASS="SECT2"
2839*4a1a9510SRong-En Fan><HR><H3
2840*4a1a9510SRong-En FanCLASS="SECT2"
2841*4a1a9510SRong-En Fan><A
2842*4a1a9510SRong-En FanNAME="CHGAT"
2843*4a1a9510SRong-En Fan>8.6. chgat() functions</A
2844*4a1a9510SRong-En Fan></H3
2845*4a1a9510SRong-En Fan><P
2846*4a1a9510SRong-En Fan>The function chgat() is listed in the end of the man page curs_attr. It actually
2847*4a1a9510SRong-En Fanis a useful one. This function can be used to set attributes for a group of
2848*4a1a9510SRong-En Fancharacters without moving. I mean it !!! without moving the cursor :-) It
2849*4a1a9510SRong-En Fanchanges the attributes of a given number of characters starting at the current
2850*4a1a9510SRong-En Fancursor location.</P
2851*4a1a9510SRong-En Fan><P
2852*4a1a9510SRong-En Fan>We can give -1 as the character count to update till end of line. If you want to
2853*4a1a9510SRong-En Fanchange attributes of characters from current position to end of line, just use
2854*4a1a9510SRong-En Fanthis.</P
2855*4a1a9510SRong-En Fan><PRE
2856*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
2857*4a1a9510SRong-En Fan>    chgat(-1, A_REVERSE, 0, NULL);</PRE
2858*4a1a9510SRong-En Fan><P
2859*4a1a9510SRong-En Fan>
2860*4a1a9510SRong-En FanThis function is useful when changing attributes for characters that are
2861*4a1a9510SRong-En Fanalready on the screen. Move to the character from which you want to change and
2862*4a1a9510SRong-En Fanchange the attribute. </P
2863*4a1a9510SRong-En Fan><P
2864*4a1a9510SRong-En Fan>Other functions wchgat(), mvchgat(), wchgat() behave similarly except that the w
2865*4a1a9510SRong-En Fanfunctions operate on the particular window. The mv functions first move the
2866*4a1a9510SRong-En Fancursor then perform the work given to them. Actually chgat is a macro which is
2867*4a1a9510SRong-En Fanreplaced by a wchgat() with stdscr as the window. Most of the "w-less" functions
2868*4a1a9510SRong-En Fanare macros.</P
2869*4a1a9510SRong-En Fan><DIV
2870*4a1a9510SRong-En FanCLASS="EXAMPLE"
2871*4a1a9510SRong-En Fan><A
2872*4a1a9510SRong-En FanNAME="BWICH"
2873*4a1a9510SRong-En Fan></A
2874*4a1a9510SRong-En Fan><P
2875*4a1a9510SRong-En Fan><B
2876*4a1a9510SRong-En Fan>Example 6.  Chgat() Usage example </B
2877*4a1a9510SRong-En Fan></P
2878*4a1a9510SRong-En Fan><PRE
2879*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
2880*4a1a9510SRong-En Fan><SPAN
2881*4a1a9510SRong-En FanCLASS="INLINEMEDIAOBJECT"
2882*4a1a9510SRong-En Fan>#include &#60;ncurses.h&#62;
2883*4a1a9510SRong-En Fan
2884*4a1a9510SRong-En Fanint main(int argc, char *argv[])
2885*4a1a9510SRong-En Fan{	initscr();			/* Start curses mode 		*/
2886*4a1a9510SRong-En Fan	start_color();			/* Start color functionality	*/
2887*4a1a9510SRong-En Fan
2888*4a1a9510SRong-En Fan	init_pair(1, COLOR_CYAN, COLOR_BLACK);
2889*4a1a9510SRong-En Fan	printw("A Big string which i didn't care to type fully ");
2890*4a1a9510SRong-En Fan	mvchgat(0, 0, -1, A_BLINK, 1, NULL);
2891*4a1a9510SRong-En Fan	/*
2892*4a1a9510SRong-En Fan	 * First two parameters specify the position at which to start
2893*4a1a9510SRong-En Fan	 * Third parameter number of characters to update. -1 means till
2894*4a1a9510SRong-En Fan	 * end of line
2895*4a1a9510SRong-En Fan	 * Forth parameter is the normal attribute you wanted to give
2896*4a1a9510SRong-En Fan	 * to the charcter
2897*4a1a9510SRong-En Fan	 * Fifth is the color index. It is the index given during init_pair()
2898*4a1a9510SRong-En Fan	 * use 0 if you didn't want color
2899*4a1a9510SRong-En Fan	 * Sixth one is always NULL
2900*4a1a9510SRong-En Fan	 */
2901*4a1a9510SRong-En Fan	refresh();
2902*4a1a9510SRong-En Fan    	getch();
2903*4a1a9510SRong-En Fan	endwin();			/* End curses mode		  */
2904*4a1a9510SRong-En Fan	return 0;
2905*4a1a9510SRong-En Fan}</SPAN
2906*4a1a9510SRong-En Fan></PRE
2907*4a1a9510SRong-En Fan></DIV
2908*4a1a9510SRong-En Fan><P
2909*4a1a9510SRong-En Fan>This example also introduces us to the color world of curses. Colors will be
2910*4a1a9510SRong-En Fanexplained in detail later. Use 0 for no color.</P
2911*4a1a9510SRong-En Fan></DIV
2912*4a1a9510SRong-En Fan></DIV
2913*4a1a9510SRong-En Fan><DIV
2914*4a1a9510SRong-En FanCLASS="SECT1"
2915*4a1a9510SRong-En Fan><HR><H2
2916*4a1a9510SRong-En FanCLASS="SECT1"
2917*4a1a9510SRong-En Fan><A
2918*4a1a9510SRong-En FanNAME="WINDOWS"
2919*4a1a9510SRong-En Fan>9. Windows</A
2920*4a1a9510SRong-En Fan></H2
2921*4a1a9510SRong-En Fan><P
2922*4a1a9510SRong-En Fan>Windows form the most important concept in curses. You have seen the standard
2923*4a1a9510SRong-En Fanwindow stdscr above where all the functions implicitly operated on this window.
2924*4a1a9510SRong-En FanNow to make design even a simplest GUI, you need to resort to windows.  The main
2925*4a1a9510SRong-En Fanreason you may want to use windows is to manipulate parts of the screen
2926*4a1a9510SRong-En Fanseparately, for better efficiency, by updating only the windows that need to be
2927*4a1a9510SRong-En Fanchanged and for a better design. I would say the last reason is the most
2928*4a1a9510SRong-En Fanimportant in going for windows. You should always strive for a better and
2929*4a1a9510SRong-En Faneasy-to-manage design in your programs. If you are writing big, complex GUIs
2930*4a1a9510SRong-En Fanthis is of pivotal importance before you start doing anything.</P
2931*4a1a9510SRong-En Fan><DIV
2932*4a1a9510SRong-En FanCLASS="SECT2"
2933*4a1a9510SRong-En Fan><HR><H3
2934*4a1a9510SRong-En FanCLASS="SECT2"
2935*4a1a9510SRong-En Fan><A
2936*4a1a9510SRong-En FanNAME="WINDOWBASICS"
2937*4a1a9510SRong-En Fan>9.1. The basics</A
2938*4a1a9510SRong-En Fan></H3
2939*4a1a9510SRong-En Fan><P
2940*4a1a9510SRong-En Fan>A Window can be created by calling the function
2941*4a1a9510SRong-En Fan<TT
2942*4a1a9510SRong-En FanCLASS="LITERAL"
2943*4a1a9510SRong-En Fan>newwin()</TT
2944*4a1a9510SRong-En Fan>. It doesn't create any thing on the
2945*4a1a9510SRong-En Fanscreen actually. It allocates memory for a structure to manipulate the window
2946*4a1a9510SRong-En Fanand updates the structure with data regarding the window like it's size, beginy,
2947*4a1a9510SRong-En Fanbeginx etc.. Hence in curses, a window is just an abstraction of an imaginary
2948*4a1a9510SRong-En Fanwindow, which can be manipulated independent of other parts of screen. The
2949*4a1a9510SRong-En Fanfunction newwin() returns a pointer to structure WINDOW, which can be passed to
2950*4a1a9510SRong-En Fanwindow related functions like wprintw() etc.. Finally the window can be
2951*4a1a9510SRong-En Fandestroyed with delwin(). It will deallocate the memory associated with the
2952*4a1a9510SRong-En Fanwindow structure.</P
2953*4a1a9510SRong-En Fan></DIV
2954*4a1a9510SRong-En Fan><DIV
2955*4a1a9510SRong-En FanCLASS="SECT2"
2956*4a1a9510SRong-En Fan><HR><H3
2957*4a1a9510SRong-En FanCLASS="SECT2"
2958*4a1a9510SRong-En Fan><A
2959*4a1a9510SRong-En FanNAME="LETBEWINDOW"
2960*4a1a9510SRong-En Fan>9.2. Let there be a Window !!!</A
2961*4a1a9510SRong-En Fan></H3
2962*4a1a9510SRong-En Fan><P
2963*4a1a9510SRong-En Fan>What fun is it, if a window is created and we can't see it. So the fun part
2964*4a1a9510SRong-En Fanbegins by displaying the window. The function
2965*4a1a9510SRong-En Fan<TT
2966*4a1a9510SRong-En FanCLASS="LITERAL"
2967*4a1a9510SRong-En Fan>box()</TT
2968*4a1a9510SRong-En Fan> can be used to draw a border around the
2969*4a1a9510SRong-En Fanwindow. Let's explore these functions in more detail in this example.</P
2970*4a1a9510SRong-En Fan><DIV
2971*4a1a9510SRong-En FanCLASS="EXAMPLE"
2972*4a1a9510SRong-En Fan><A
2973*4a1a9510SRong-En FanNAME="BWIBO"
2974*4a1a9510SRong-En Fan></A
2975*4a1a9510SRong-En Fan><P
2976*4a1a9510SRong-En Fan><B
2977*4a1a9510SRong-En Fan>Example 7. Window Border example </B
2978*4a1a9510SRong-En Fan></P
2979*4a1a9510SRong-En Fan><PRE
2980*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
2981*4a1a9510SRong-En Fan><SPAN
2982*4a1a9510SRong-En FanCLASS="INLINEMEDIAOBJECT"
2983*4a1a9510SRong-En Fan>#include &#60;ncurses.h&#62;
2984*4a1a9510SRong-En Fan
2985*4a1a9510SRong-En Fan
2986*4a1a9510SRong-En FanWINDOW *create_newwin(int height, int width, int starty, int startx);
2987*4a1a9510SRong-En Fanvoid destroy_win(WINDOW *local_win);
2988*4a1a9510SRong-En Fan
2989*4a1a9510SRong-En Fanint main(int argc, char *argv[])
2990*4a1a9510SRong-En Fan{	WINDOW *my_win;
2991*4a1a9510SRong-En Fan	int startx, starty, width, height;
2992*4a1a9510SRong-En Fan	int ch;
2993*4a1a9510SRong-En Fan
2994*4a1a9510SRong-En Fan	initscr();			/* Start curses mode 		*/
2995*4a1a9510SRong-En Fan	cbreak();			/* Line buffering disabled, Pass on
2996*4a1a9510SRong-En Fan					 * everty thing to me 		*/
2997*4a1a9510SRong-En Fan	keypad(stdscr, TRUE);		/* I need that nifty F1 	*/
2998*4a1a9510SRong-En Fan
2999*4a1a9510SRong-En Fan	height = 3;
3000*4a1a9510SRong-En Fan	width = 10;
3001*4a1a9510SRong-En Fan	starty = (LINES - height) / 2;	/* Calculating for a center placement */
3002*4a1a9510SRong-En Fan	startx = (COLS - width) / 2;	/* of the window		*/
3003*4a1a9510SRong-En Fan	printw("Press F1 to exit");
3004*4a1a9510SRong-En Fan	refresh();
3005*4a1a9510SRong-En Fan	my_win = create_newwin(height, width, starty, startx);
3006*4a1a9510SRong-En Fan
3007*4a1a9510SRong-En Fan	while((ch = getch()) != KEY_F(1))
3008*4a1a9510SRong-En Fan	{	switch(ch)
3009*4a1a9510SRong-En Fan		{	case KEY_LEFT:
3010*4a1a9510SRong-En Fan				destroy_win(my_win);
3011*4a1a9510SRong-En Fan				my_win = create_newwin(height, width, starty,--startx);
3012*4a1a9510SRong-En Fan				break;
3013*4a1a9510SRong-En Fan			case KEY_RIGHT:
3014*4a1a9510SRong-En Fan				destroy_win(my_win);
3015*4a1a9510SRong-En Fan				my_win = create_newwin(height, width, starty,++startx);
3016*4a1a9510SRong-En Fan				break;
3017*4a1a9510SRong-En Fan			case KEY_UP:
3018*4a1a9510SRong-En Fan				destroy_win(my_win);
3019*4a1a9510SRong-En Fan				my_win = create_newwin(height, width, --starty,startx);
3020*4a1a9510SRong-En Fan				break;
3021*4a1a9510SRong-En Fan			case KEY_DOWN:
3022*4a1a9510SRong-En Fan				destroy_win(my_win);
3023*4a1a9510SRong-En Fan				my_win = create_newwin(height, width, ++starty,startx);
3024*4a1a9510SRong-En Fan				break;
3025*4a1a9510SRong-En Fan		}
3026*4a1a9510SRong-En Fan	}
3027*4a1a9510SRong-En Fan
3028*4a1a9510SRong-En Fan	endwin();			/* End curses mode		  */
3029*4a1a9510SRong-En Fan	return 0;
3030*4a1a9510SRong-En Fan}
3031*4a1a9510SRong-En Fan
3032*4a1a9510SRong-En FanWINDOW *create_newwin(int height, int width, int starty, int startx)
3033*4a1a9510SRong-En Fan{	WINDOW *local_win;
3034*4a1a9510SRong-En Fan
3035*4a1a9510SRong-En Fan	local_win = newwin(height, width, starty, startx);
3036*4a1a9510SRong-En Fan	box(local_win, 0 , 0);		/* 0, 0 gives default characters
3037*4a1a9510SRong-En Fan					 * for the vertical and horizontal
3038*4a1a9510SRong-En Fan					 * lines			*/
3039*4a1a9510SRong-En Fan	wrefresh(local_win);		/* Show that box 		*/
3040*4a1a9510SRong-En Fan
3041*4a1a9510SRong-En Fan	return local_win;
3042*4a1a9510SRong-En Fan}
3043*4a1a9510SRong-En Fan
3044*4a1a9510SRong-En Fanvoid destroy_win(WINDOW *local_win)
3045*4a1a9510SRong-En Fan{
3046*4a1a9510SRong-En Fan	/* box(local_win, ' ', ' '); : This won't produce the desired
3047*4a1a9510SRong-En Fan	 * result of erasing the window. It will leave it's four corners
3048*4a1a9510SRong-En Fan	 * and so an ugly remnant of window.
3049*4a1a9510SRong-En Fan	 */
3050*4a1a9510SRong-En Fan	wborder(local_win, ' ', ' ', ' ',' ',' ',' ',' ',' ');
3051*4a1a9510SRong-En Fan	/* The parameters taken are
3052*4a1a9510SRong-En Fan	 * 1. win: the window on which to operate
3053*4a1a9510SRong-En Fan	 * 2. ls: character to be used for the left side of the window
3054*4a1a9510SRong-En Fan	 * 3. rs: character to be used for the right side of the window
3055*4a1a9510SRong-En Fan	 * 4. ts: character to be used for the top side of the window
3056*4a1a9510SRong-En Fan	 * 5. bs: character to be used for the bottom side of the window
3057*4a1a9510SRong-En Fan	 * 6. tl: character to be used for the top left corner of the window
3058*4a1a9510SRong-En Fan	 * 7. tr: character to be used for the top right corner of the window
3059*4a1a9510SRong-En Fan	 * 8. bl: character to be used for the bottom left corner of the window
3060*4a1a9510SRong-En Fan	 * 9. br: character to be used for the bottom right corner of the window
3061*4a1a9510SRong-En Fan	 */
3062*4a1a9510SRong-En Fan	wrefresh(local_win);
3063*4a1a9510SRong-En Fan	delwin(local_win);
3064*4a1a9510SRong-En Fan}</SPAN
3065*4a1a9510SRong-En Fan></PRE
3066*4a1a9510SRong-En Fan></DIV
3067*4a1a9510SRong-En Fan></DIV
3068*4a1a9510SRong-En Fan><DIV
3069*4a1a9510SRong-En FanCLASS="SECT2"
3070*4a1a9510SRong-En Fan><HR><H3
3071*4a1a9510SRong-En FanCLASS="SECT2"
3072*4a1a9510SRong-En Fan><A
3073*4a1a9510SRong-En FanNAME="BORDEREXEXPL"
3074*4a1a9510SRong-En Fan>9.3. Explanation</A
3075*4a1a9510SRong-En Fan></H3
3076*4a1a9510SRong-En Fan><P
3077*4a1a9510SRong-En Fan>Don't scream. I know it's a big example. But I have to explain some important
3078*4a1a9510SRong-En Fanthings here :-). This program creates a rectangular window that can be moved
3079*4a1a9510SRong-En Fanwith left, right, up, down arrow keys. It repeatedly creates and destroys
3080*4a1a9510SRong-En Fanwindows as user press a key. Don't go beyond the screen limits. Checking for
3081*4a1a9510SRong-En Fanthose limits is left as an exercise for the reader. Let's dissect it by line by line.</P
3082*4a1a9510SRong-En Fan><P
3083*4a1a9510SRong-En Fan>The <TT
3084*4a1a9510SRong-En FanCLASS="LITERAL"
3085*4a1a9510SRong-En Fan>create_newwin()</TT
3086*4a1a9510SRong-En Fan> function creates a window
3087*4a1a9510SRong-En Fanwith <TT
3088*4a1a9510SRong-En FanCLASS="LITERAL"
3089*4a1a9510SRong-En Fan>newwin() </TT
3090*4a1a9510SRong-En Fan> and displays a border around it
3091*4a1a9510SRong-En Fanwith box. The function <TT
3092*4a1a9510SRong-En FanCLASS="LITERAL"
3093*4a1a9510SRong-En Fan> destroy_win()</TT
3094*4a1a9510SRong-En Fan> first
3095*4a1a9510SRong-En Fanerases the window from screen by painting a border with ' ' character and then
3096*4a1a9510SRong-En Fancalling <TT
3097*4a1a9510SRong-En FanCLASS="LITERAL"
3098*4a1a9510SRong-En Fan>delwin()</TT
3099*4a1a9510SRong-En Fan> to deallocate memory related
3100*4a1a9510SRong-En Fanto it. Depending on the key the user presses, starty or startx is changed and a
3101*4a1a9510SRong-En Fannew window is created.</P
3102*4a1a9510SRong-En Fan><P
3103*4a1a9510SRong-En Fan>In the destroy_win, as you can see, I used wborder instead of box. The reason is
3104*4a1a9510SRong-En Fanwritten in the comments (You missed it. I know. Read the code :-)). wborder
3105*4a1a9510SRong-En Fandraws a border around the window with the characters given to it as the 4 corner
3106*4a1a9510SRong-En Fanpoints and the 4 lines. To put it clearly, if you have called wborder as below:
3107*4a1a9510SRong-En Fan<PRE
3108*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
3109*4a1a9510SRong-En Fan>    wborder(win, '|', '|', '-', '-', '+', '+', '+', '+');</PRE
3110*4a1a9510SRong-En Fan></P
3111*4a1a9510SRong-En Fan><P
3112*4a1a9510SRong-En Fan>it produces some thing like </P
3113*4a1a9510SRong-En Fan><PRE
3114*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
3115*4a1a9510SRong-En Fan>    +------------+
3116*4a1a9510SRong-En Fan    |            |
3117*4a1a9510SRong-En Fan    |            |
3118*4a1a9510SRong-En Fan    |            |
3119*4a1a9510SRong-En Fan    |            |
3120*4a1a9510SRong-En Fan    |            |
3121*4a1a9510SRong-En Fan    |            |
3122*4a1a9510SRong-En Fan    +------------+</PRE
3123*4a1a9510SRong-En Fan></DIV
3124*4a1a9510SRong-En Fan><DIV
3125*4a1a9510SRong-En FanCLASS="SECT2"
3126*4a1a9510SRong-En Fan><HR><H3
3127*4a1a9510SRong-En FanCLASS="SECT2"
3128*4a1a9510SRong-En Fan><A
3129*4a1a9510SRong-En FanNAME="OTHERSTUFF"
3130*4a1a9510SRong-En Fan>9.4. The other stuff in the example</A
3131*4a1a9510SRong-En Fan></H3
3132*4a1a9510SRong-En Fan><P
3133*4a1a9510SRong-En Fan>You can also see in the above examples, that I have used the variables COLS,
3134*4a1a9510SRong-En FanLINES which are initialized to the screen sizes after initscr(). They can be
3135*4a1a9510SRong-En Fanuseful in finding screen dimensions and finding the center co-ordinate of the
3136*4a1a9510SRong-En Fanscreen as above. The function <TT
3137*4a1a9510SRong-En FanCLASS="LITERAL"
3138*4a1a9510SRong-En Fan>getch()</TT
3139*4a1a9510SRong-En Fan> as usual
3140*4a1a9510SRong-En Fangets the key from keyboard and according to the key it does the corresponding
3141*4a1a9510SRong-En Fanwork. This type of switch- case is very common in any GUI based programs.</P
3142*4a1a9510SRong-En Fan></DIV
3143*4a1a9510SRong-En Fan><DIV
3144*4a1a9510SRong-En FanCLASS="SECT2"
3145*4a1a9510SRong-En Fan><HR><H3
3146*4a1a9510SRong-En FanCLASS="SECT2"
3147*4a1a9510SRong-En Fan><A
3148*4a1a9510SRong-En FanNAME="OTHERBORDERFUNCS"
3149*4a1a9510SRong-En Fan>9.5. Other Border functions</A
3150*4a1a9510SRong-En Fan></H3
3151*4a1a9510SRong-En Fan><P
3152*4a1a9510SRong-En Fan>Above program is grossly inefficient in that with each press of a key, a window
3153*4a1a9510SRong-En Fanis destroyed and another is created. So let's write a more efficient program
3154*4a1a9510SRong-En Fanwhich uses other border related functions.</P
3155*4a1a9510SRong-En Fan><P
3156*4a1a9510SRong-En Fan>The following program uses <TT
3157*4a1a9510SRong-En FanCLASS="LITERAL"
3158*4a1a9510SRong-En Fan>mvhline()</TT
3159*4a1a9510SRong-En Fan> and
3160*4a1a9510SRong-En Fan<TT
3161*4a1a9510SRong-En FanCLASS="LITERAL"
3162*4a1a9510SRong-En Fan>mvvline()</TT
3163*4a1a9510SRong-En Fan> to achieve similar effect. These two
3164*4a1a9510SRong-En Fanfunctions are simple. They create a horizontal or vertical line of the specified
3165*4a1a9510SRong-En Fanlength at the specified position.</P
3166*4a1a9510SRong-En Fan><DIV
3167*4a1a9510SRong-En FanCLASS="EXAMPLE"
3168*4a1a9510SRong-En Fan><A
3169*4a1a9510SRong-En FanNAME="BOTBO"
3170*4a1a9510SRong-En Fan></A
3171*4a1a9510SRong-En Fan><P
3172*4a1a9510SRong-En Fan><B
3173*4a1a9510SRong-En Fan>Example 8.  More border functions</B
3174*4a1a9510SRong-En Fan></P
3175*4a1a9510SRong-En Fan><PRE
3176*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
3177*4a1a9510SRong-En Fan><SPAN
3178*4a1a9510SRong-En FanCLASS="INLINEMEDIAOBJECT"
3179*4a1a9510SRong-En Fan>#include &#60;ncurses.h&#62;
3180*4a1a9510SRong-En Fan
3181*4a1a9510SRong-En Fantypedef struct _win_border_struct {
3182*4a1a9510SRong-En Fan	chtype 	ls, rs, ts, bs,
3183*4a1a9510SRong-En Fan	 	tl, tr, bl, br;
3184*4a1a9510SRong-En Fan}WIN_BORDER;
3185*4a1a9510SRong-En Fan
3186*4a1a9510SRong-En Fantypedef struct _WIN_struct {
3187*4a1a9510SRong-En Fan
3188*4a1a9510SRong-En Fan	int startx, starty;
3189*4a1a9510SRong-En Fan	int height, width;
3190*4a1a9510SRong-En Fan	WIN_BORDER border;
3191*4a1a9510SRong-En Fan}WIN;
3192*4a1a9510SRong-En Fan
3193*4a1a9510SRong-En Fanvoid init_win_params(WIN *p_win);
3194*4a1a9510SRong-En Fanvoid print_win_params(WIN *p_win);
3195*4a1a9510SRong-En Fanvoid create_box(WIN *win, bool flag);
3196*4a1a9510SRong-En Fan
3197*4a1a9510SRong-En Fanint main(int argc, char *argv[])
3198*4a1a9510SRong-En Fan{	WIN win;
3199*4a1a9510SRong-En Fan	int ch;
3200*4a1a9510SRong-En Fan
3201*4a1a9510SRong-En Fan	initscr();			/* Start curses mode 		*/
3202*4a1a9510SRong-En Fan	start_color();			/* Start the color functionality */
3203*4a1a9510SRong-En Fan	cbreak();			/* Line buffering disabled, Pass on
3204*4a1a9510SRong-En Fan					 * everty thing to me 		*/
3205*4a1a9510SRong-En Fan	keypad(stdscr, TRUE);		/* I need that nifty F1 	*/
3206*4a1a9510SRong-En Fan	noecho();
3207*4a1a9510SRong-En Fan	init_pair(1, COLOR_CYAN, COLOR_BLACK);
3208*4a1a9510SRong-En Fan
3209*4a1a9510SRong-En Fan	/* Initialize the window parameters */
3210*4a1a9510SRong-En Fan	init_win_params(&#38;win);
3211*4a1a9510SRong-En Fan	print_win_params(&#38;win);
3212*4a1a9510SRong-En Fan
3213*4a1a9510SRong-En Fan	attron(COLOR_PAIR(1));
3214*4a1a9510SRong-En Fan	printw("Press F1 to exit");
3215*4a1a9510SRong-En Fan	refresh();
3216*4a1a9510SRong-En Fan	attroff(COLOR_PAIR(1));
3217*4a1a9510SRong-En Fan
3218*4a1a9510SRong-En Fan	create_box(&#38;win, TRUE);
3219*4a1a9510SRong-En Fan	while((ch = getch()) != KEY_F(1))
3220*4a1a9510SRong-En Fan	{	switch(ch)
3221*4a1a9510SRong-En Fan		{	case KEY_LEFT:
3222*4a1a9510SRong-En Fan				create_box(&#38;win, FALSE);
3223*4a1a9510SRong-En Fan				--win.startx;
3224*4a1a9510SRong-En Fan				create_box(&#38;win, TRUE);
3225*4a1a9510SRong-En Fan				break;
3226*4a1a9510SRong-En Fan			case KEY_RIGHT:
3227*4a1a9510SRong-En Fan				create_box(&#38;win, FALSE);
3228*4a1a9510SRong-En Fan				++win.startx;
3229*4a1a9510SRong-En Fan				create_box(&#38;win, TRUE);
3230*4a1a9510SRong-En Fan				break;
3231*4a1a9510SRong-En Fan			case KEY_UP:
3232*4a1a9510SRong-En Fan				create_box(&#38;win, FALSE);
3233*4a1a9510SRong-En Fan				--win.starty;
3234*4a1a9510SRong-En Fan				create_box(&#38;win, TRUE);
3235*4a1a9510SRong-En Fan				break;
3236*4a1a9510SRong-En Fan			case KEY_DOWN:
3237*4a1a9510SRong-En Fan				create_box(&#38;win, FALSE);
3238*4a1a9510SRong-En Fan				++win.starty;
3239*4a1a9510SRong-En Fan				create_box(&#38;win, TRUE);
3240*4a1a9510SRong-En Fan				break;
3241*4a1a9510SRong-En Fan		}
3242*4a1a9510SRong-En Fan	}
3243*4a1a9510SRong-En Fan	endwin();			/* End curses mode		  */
3244*4a1a9510SRong-En Fan	return 0;
3245*4a1a9510SRong-En Fan}
3246*4a1a9510SRong-En Fanvoid init_win_params(WIN *p_win)
3247*4a1a9510SRong-En Fan{
3248*4a1a9510SRong-En Fan	p_win-&#62;height = 3;
3249*4a1a9510SRong-En Fan	p_win-&#62;width = 10;
3250*4a1a9510SRong-En Fan	p_win-&#62;starty = (LINES - p_win-&#62;height)/2;
3251*4a1a9510SRong-En Fan	p_win-&#62;startx = (COLS - p_win-&#62;width)/2;
3252*4a1a9510SRong-En Fan
3253*4a1a9510SRong-En Fan	p_win-&#62;border.ls = '|';
3254*4a1a9510SRong-En Fan	p_win-&#62;border.rs = '|';
3255*4a1a9510SRong-En Fan	p_win-&#62;border.ts = '-';
3256*4a1a9510SRong-En Fan	p_win-&#62;border.bs = '-';
3257*4a1a9510SRong-En Fan	p_win-&#62;border.tl = '+';
3258*4a1a9510SRong-En Fan	p_win-&#62;border.tr = '+';
3259*4a1a9510SRong-En Fan	p_win-&#62;border.bl = '+';
3260*4a1a9510SRong-En Fan	p_win-&#62;border.br = '+';
3261*4a1a9510SRong-En Fan
3262*4a1a9510SRong-En Fan}
3263*4a1a9510SRong-En Fanvoid print_win_params(WIN *p_win)
3264*4a1a9510SRong-En Fan{
3265*4a1a9510SRong-En Fan#ifdef _DEBUG
3266*4a1a9510SRong-En Fan	mvprintw(25, 0, "%d %d %d %d", p_win-&#62;startx, p_win-&#62;starty,
3267*4a1a9510SRong-En Fan				p_win-&#62;width, p_win-&#62;height);
3268*4a1a9510SRong-En Fan	refresh();
3269*4a1a9510SRong-En Fan#endif
3270*4a1a9510SRong-En Fan}
3271*4a1a9510SRong-En Fanvoid create_box(WIN *p_win, bool flag)
3272*4a1a9510SRong-En Fan{	int i, j;
3273*4a1a9510SRong-En Fan	int x, y, w, h;
3274*4a1a9510SRong-En Fan
3275*4a1a9510SRong-En Fan	x = p_win-&#62;startx;
3276*4a1a9510SRong-En Fan	y = p_win-&#62;starty;
3277*4a1a9510SRong-En Fan	w = p_win-&#62;width;
3278*4a1a9510SRong-En Fan	h = p_win-&#62;height;
3279*4a1a9510SRong-En Fan
3280*4a1a9510SRong-En Fan	if(flag == TRUE)
3281*4a1a9510SRong-En Fan	{	mvaddch(y, x, p_win-&#62;border.tl);
3282*4a1a9510SRong-En Fan		mvaddch(y, x + w, p_win-&#62;border.tr);
3283*4a1a9510SRong-En Fan		mvaddch(y + h, x, p_win-&#62;border.bl);
3284*4a1a9510SRong-En Fan		mvaddch(y + h, x + w, p_win-&#62;border.br);
3285*4a1a9510SRong-En Fan		mvhline(y, x + 1, p_win-&#62;border.ts, w - 1);
3286*4a1a9510SRong-En Fan		mvhline(y + h, x + 1, p_win-&#62;border.bs, w - 1);
3287*4a1a9510SRong-En Fan		mvvline(y + 1, x, p_win-&#62;border.ls, h - 1);
3288*4a1a9510SRong-En Fan		mvvline(y + 1, x + w, p_win-&#62;border.rs, h - 1);
3289*4a1a9510SRong-En Fan
3290*4a1a9510SRong-En Fan	}
3291*4a1a9510SRong-En Fan	else
3292*4a1a9510SRong-En Fan		for(j = y; j &#60;= y + h; ++j)
3293*4a1a9510SRong-En Fan			for(i = x; i &#60;= x + w; ++i)
3294*4a1a9510SRong-En Fan				mvaddch(j, i, ' ');
3295*4a1a9510SRong-En Fan
3296*4a1a9510SRong-En Fan	refresh();
3297*4a1a9510SRong-En Fan
3298*4a1a9510SRong-En Fan}</SPAN
3299*4a1a9510SRong-En Fan></PRE
3300*4a1a9510SRong-En Fan></DIV
3301*4a1a9510SRong-En Fan></DIV
3302*4a1a9510SRong-En Fan></DIV
3303*4a1a9510SRong-En Fan><DIV
3304*4a1a9510SRong-En FanCLASS="SECT1"
3305*4a1a9510SRong-En Fan><HR><H2
3306*4a1a9510SRong-En FanCLASS="SECT1"
3307*4a1a9510SRong-En Fan><A
3308*4a1a9510SRong-En FanNAME="COLOR"
3309*4a1a9510SRong-En Fan>10. Colors</A
3310*4a1a9510SRong-En Fan></H2
3311*4a1a9510SRong-En Fan><DIV
3312*4a1a9510SRong-En FanCLASS="SECT2"
3313*4a1a9510SRong-En Fan><H3
3314*4a1a9510SRong-En FanCLASS="SECT2"
3315*4a1a9510SRong-En Fan><A
3316*4a1a9510SRong-En FanNAME="COLORBASICS"
3317*4a1a9510SRong-En Fan>10.1. The basics</A
3318*4a1a9510SRong-En Fan></H3
3319*4a1a9510SRong-En Fan><P
3320*4a1a9510SRong-En Fan>Life seems dull with no colors. Curses has a nice mechanism to handle colors.
3321*4a1a9510SRong-En FanLet's get into the thick of the things with a small program.</P
3322*4a1a9510SRong-En Fan><DIV
3323*4a1a9510SRong-En FanCLASS="EXAMPLE"
3324*4a1a9510SRong-En Fan><A
3325*4a1a9510SRong-En FanNAME="BSICO"
3326*4a1a9510SRong-En Fan></A
3327*4a1a9510SRong-En Fan><P
3328*4a1a9510SRong-En Fan><B
3329*4a1a9510SRong-En Fan>Example 9.  A Simple Color example </B
3330*4a1a9510SRong-En Fan></P
3331*4a1a9510SRong-En Fan><PRE
3332*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
3333*4a1a9510SRong-En Fan><SPAN
3334*4a1a9510SRong-En FanCLASS="INLINEMEDIAOBJECT"
3335*4a1a9510SRong-En Fan>#include &#60;ncurses.h&#62;
3336*4a1a9510SRong-En Fan
3337*4a1a9510SRong-En Fanvoid print_in_middle(WINDOW *win, int starty, int startx, int width, char *string);
3338*4a1a9510SRong-En Fanint main(int argc, char *argv[])
3339*4a1a9510SRong-En Fan{	initscr();			/* Start curses mode 		*/
3340*4a1a9510SRong-En Fan	if(has_colors() == FALSE)
3341*4a1a9510SRong-En Fan	{	endwin();
3342*4a1a9510SRong-En Fan		printf("Your terminal does not support color\n");
3343*4a1a9510SRong-En Fan		exit(1);
3344*4a1a9510SRong-En Fan	}
3345*4a1a9510SRong-En Fan	start_color();			/* Start color 			*/
3346*4a1a9510SRong-En Fan	init_pair(1, COLOR_RED, COLOR_BLACK);
3347*4a1a9510SRong-En Fan
3348*4a1a9510SRong-En Fan	attron(COLOR_PAIR(1));
3349*4a1a9510SRong-En Fan	print_in_middle(stdscr, LINES / 2, 0, 0, "Viola !!! In color ...");
3350*4a1a9510SRong-En Fan	attroff(COLOR_PAIR(1));
3351*4a1a9510SRong-En Fan    	getch();
3352*4a1a9510SRong-En Fan	endwin();
3353*4a1a9510SRong-En Fan}
3354*4a1a9510SRong-En Fanvoid print_in_middle(WINDOW *win, int starty, int startx, int width, char *string)
3355*4a1a9510SRong-En Fan{	int length, x, y;
3356*4a1a9510SRong-En Fan	float temp;
3357*4a1a9510SRong-En Fan
3358*4a1a9510SRong-En Fan	if(win == NULL)
3359*4a1a9510SRong-En Fan		win = stdscr;
3360*4a1a9510SRong-En Fan	getyx(win, y, x);
3361*4a1a9510SRong-En Fan	if(startx != 0)
3362*4a1a9510SRong-En Fan		x = startx;
3363*4a1a9510SRong-En Fan	if(starty != 0)
3364*4a1a9510SRong-En Fan		y = starty;
3365*4a1a9510SRong-En Fan	if(width == 0)
3366*4a1a9510SRong-En Fan		width = 80;
3367*4a1a9510SRong-En Fan
3368*4a1a9510SRong-En Fan	length = strlen(string);
3369*4a1a9510SRong-En Fan	temp = (width - length)/ 2;
3370*4a1a9510SRong-En Fan	x = startx + (int)temp;
3371*4a1a9510SRong-En Fan	mvwprintw(win, y, x, "%s", string);
3372*4a1a9510SRong-En Fan	refresh();
3373*4a1a9510SRong-En Fan}
3374*4a1a9510SRong-En Fan</SPAN
3375*4a1a9510SRong-En Fan></PRE
3376*4a1a9510SRong-En Fan></DIV
3377*4a1a9510SRong-En Fan><P
3378*4a1a9510SRong-En Fan>As you can see, to start using color, you should first call the function
3379*4a1a9510SRong-En Fan<TT
3380*4a1a9510SRong-En FanCLASS="LITERAL"
3381*4a1a9510SRong-En Fan> start_color()</TT
3382*4a1a9510SRong-En Fan>. After that, you can use color
3383*4a1a9510SRong-En Fancapabilities of your terminals using various functions. To find out whether a
3384*4a1a9510SRong-En Fanterminal has color capabilities or not, you can use
3385*4a1a9510SRong-En Fan<TT
3386*4a1a9510SRong-En FanCLASS="LITERAL"
3387*4a1a9510SRong-En Fan>has_colors()</TT
3388*4a1a9510SRong-En Fan> function, which returns FALSE if
3389*4a1a9510SRong-En Fanthe terminal does not support color. </P
3390*4a1a9510SRong-En Fan><P
3391*4a1a9510SRong-En Fan>Curses initializes all the colors supported by terminal when start_color() is
3392*4a1a9510SRong-En Fancalled. These can be accessed by the define constants like
3393*4a1a9510SRong-En Fan<TT
3394*4a1a9510SRong-En FanCLASS="LITERAL"
3395*4a1a9510SRong-En Fan>COLOR_BLACK </TT
3396*4a1a9510SRong-En Fan> etc. Now to actually start using
3397*4a1a9510SRong-En Fancolors, you have to define pairs. Colors are always used in pairs. That means
3398*4a1a9510SRong-En Fanyou have to use the function <TT
3399*4a1a9510SRong-En FanCLASS="LITERAL"
3400*4a1a9510SRong-En Fan>init_pair() </TT
3401*4a1a9510SRong-En Fan> to
3402*4a1a9510SRong-En Fandefine the foreground and background for the pair number you give.  After that
3403*4a1a9510SRong-En Fanthat pair number can be used as a normal attribute with <TT
3404*4a1a9510SRong-En FanCLASS="LITERAL"
3405*4a1a9510SRong-En Fan>COLOR_PAIR()</TT
3406*4a1a9510SRong-En Fan>function. This may seem to be cumbersome at first.
3407*4a1a9510SRong-En FanBut this elegant solution allows us to manage color pairs very easily. To
3408*4a1a9510SRong-En Fanappreciate it, you have to look into the the source code of "dialog", a utility
3409*4a1a9510SRong-En Fanfor displaying dialog boxes from shell scripts. The developers have defined
3410*4a1a9510SRong-En Fanforeground and background combinations for all the colors they might need and
3411*4a1a9510SRong-En Faninitialized at the beginning. This makes it very easy to set attributes just by
3412*4a1a9510SRong-En Fanaccessing a pair which we already have defined as a constant.</P
3413*4a1a9510SRong-En Fan><P
3414*4a1a9510SRong-En Fan>The following colors are defined in <TT
3415*4a1a9510SRong-En FanCLASS="LITERAL"
3416*4a1a9510SRong-En Fan>curses.h</TT
3417*4a1a9510SRong-En Fan>.
3418*4a1a9510SRong-En FanYou can use these as parameters for various color functions.
3419*4a1a9510SRong-En Fan<PRE
3420*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
3421*4a1a9510SRong-En Fan>        COLOR_BLACK   0
3422*4a1a9510SRong-En Fan        COLOR_RED     1
3423*4a1a9510SRong-En Fan        COLOR_GREEN   2
3424*4a1a9510SRong-En Fan        COLOR_YELLOW  3
3425*4a1a9510SRong-En Fan        COLOR_BLUE    4
3426*4a1a9510SRong-En Fan        COLOR_MAGENTA 5
3427*4a1a9510SRong-En Fan        COLOR_CYAN    6
3428*4a1a9510SRong-En Fan        COLOR_WHITE   7</PRE
3429*4a1a9510SRong-En Fan></P
3430*4a1a9510SRong-En Fan></DIV
3431*4a1a9510SRong-En Fan><DIV
3432*4a1a9510SRong-En FanCLASS="SECT2"
3433*4a1a9510SRong-En Fan><HR><H3
3434*4a1a9510SRong-En FanCLASS="SECT2"
3435*4a1a9510SRong-En Fan><A
3436*4a1a9510SRong-En FanNAME="CHANGECOLORDEFS"
3437*4a1a9510SRong-En Fan>10.2. Changing Color Definitions</A
3438*4a1a9510SRong-En Fan></H3
3439*4a1a9510SRong-En Fan><P
3440*4a1a9510SRong-En Fan>The function <TT
3441*4a1a9510SRong-En FanCLASS="LITERAL"
3442*4a1a9510SRong-En Fan>init_color()</TT
3443*4a1a9510SRong-En Fan>can be used to change
3444*4a1a9510SRong-En Fanthe rgb values for the colors defined by curses initially. Say you wanted to
3445*4a1a9510SRong-En Fanlighten the intensity of red color by a minuscule. Then you can use this
3446*4a1a9510SRong-En Fanfunction as</P
3447*4a1a9510SRong-En Fan><PRE
3448*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
3449*4a1a9510SRong-En Fan>    init_color(COLOR_RED, 700, 0, 0);
3450*4a1a9510SRong-En Fan    /* param 1     : color name
3451*4a1a9510SRong-En Fan     * param 2, 3, 4 : rgb content min = 0, max = 1000 */</PRE
3452*4a1a9510SRong-En Fan><P
3453*4a1a9510SRong-En Fan>If your terminal cannot change the color definitions, the function returns ERR.
3454*4a1a9510SRong-En FanThe function <TT
3455*4a1a9510SRong-En FanCLASS="LITERAL"
3456*4a1a9510SRong-En Fan>can_change_color()</TT
3457*4a1a9510SRong-En Fan> can be used to
3458*4a1a9510SRong-En Fanfind out whether the terminal has the capability of changing color content or
3459*4a1a9510SRong-En Fannot.  The rgb content is scaled from 0 to 1000. Initially RED color is defined
3460*4a1a9510SRong-En Fanwith content 1000(r), 0(g), 0(b). </P
3461*4a1a9510SRong-En Fan></DIV
3462*4a1a9510SRong-En Fan><DIV
3463*4a1a9510SRong-En FanCLASS="SECT2"
3464*4a1a9510SRong-En Fan><HR><H3
3465*4a1a9510SRong-En FanCLASS="SECT2"
3466*4a1a9510SRong-En Fan><A
3467*4a1a9510SRong-En FanNAME="COLORCONTENT"
3468*4a1a9510SRong-En Fan>10.3. Color Content</A
3469*4a1a9510SRong-En Fan></H3
3470*4a1a9510SRong-En Fan><P
3471*4a1a9510SRong-En Fan>The functions <TT
3472*4a1a9510SRong-En FanCLASS="LITERAL"
3473*4a1a9510SRong-En Fan>color_content()</TT
3474*4a1a9510SRong-En Fan> and
3475*4a1a9510SRong-En Fan<TT
3476*4a1a9510SRong-En FanCLASS="LITERAL"
3477*4a1a9510SRong-En Fan>pair_content()</TT
3478*4a1a9510SRong-En Fan> can be used to find the color
3479*4a1a9510SRong-En Fancontent and foreground, background combination for the pair. </P
3480*4a1a9510SRong-En Fan></DIV
3481*4a1a9510SRong-En Fan></DIV
3482*4a1a9510SRong-En Fan><DIV
3483*4a1a9510SRong-En FanCLASS="SECT1"
3484*4a1a9510SRong-En Fan><HR><H2
3485*4a1a9510SRong-En FanCLASS="SECT1"
3486*4a1a9510SRong-En Fan><A
3487*4a1a9510SRong-En FanNAME="KEYS"
3488*4a1a9510SRong-En Fan>11. Interfacing with the key board</A
3489*4a1a9510SRong-En Fan></H2
3490*4a1a9510SRong-En Fan><DIV
3491*4a1a9510SRong-En FanCLASS="SECT2"
3492*4a1a9510SRong-En Fan><H3
3493*4a1a9510SRong-En FanCLASS="SECT2"
3494*4a1a9510SRong-En Fan><A
3495*4a1a9510SRong-En FanNAME="KEYSBASICS"
3496*4a1a9510SRong-En Fan>11.1. The Basics</A
3497*4a1a9510SRong-En Fan></H3
3498*4a1a9510SRong-En Fan><P
3499*4a1a9510SRong-En Fan>No GUI is complete without a strong user interface and to interact with the
3500*4a1a9510SRong-En Fanuser, a curses program should be sensitive to key presses or the mouse actions
3501*4a1a9510SRong-En Fandone by the user. Let's deal with the keys first.</P
3502*4a1a9510SRong-En Fan><P
3503*4a1a9510SRong-En Fan>As you have seen in almost all of the above examples, it's very easy to get key
3504*4a1a9510SRong-En Faninput from the user. A simple way of getting key presses is to use
3505*4a1a9510SRong-En Fan<TT
3506*4a1a9510SRong-En FanCLASS="LITERAL"
3507*4a1a9510SRong-En Fan>getch()</TT
3508*4a1a9510SRong-En Fan> function. The cbreak mode should be
3509*4a1a9510SRong-En Fanenabled to read keys when you are interested in reading individual key hits
3510*4a1a9510SRong-En Fanrather than complete lines of text (which usually end with a carriage return).
3511*4a1a9510SRong-En Fankeypad should be enabled to get the Functions keys, arrow keys etc.  See the
3512*4a1a9510SRong-En Faninitialization section for details.</P
3513*4a1a9510SRong-En Fan><P
3514*4a1a9510SRong-En Fan><TT
3515*4a1a9510SRong-En FanCLASS="LITERAL"
3516*4a1a9510SRong-En Fan>getch()</TT
3517*4a1a9510SRong-En Fan> returns an integer corresponding to the
3518*4a1a9510SRong-En Fankey pressed. If it is a normal character, the integer value will be equivalent
3519*4a1a9510SRong-En Fanto the character. Otherwise it returns a number which can be matched with the
3520*4a1a9510SRong-En Fanconstants defined in <TT
3521*4a1a9510SRong-En FanCLASS="LITERAL"
3522*4a1a9510SRong-En Fan>curses.h</TT
3523*4a1a9510SRong-En Fan>.  For example if
3524*4a1a9510SRong-En Fanthe user presses F1, the integer returned is 265. This can be checked using the
3525*4a1a9510SRong-En Fanmacro KEY_F() defined in curses.h. This makes reading keys portable and easy to
3526*4a1a9510SRong-En Fanmanage.</P
3527*4a1a9510SRong-En Fan><P
3528*4a1a9510SRong-En Fan>For example, if you call getch() like this</P
3529*4a1a9510SRong-En Fan><PRE
3530*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
3531*4a1a9510SRong-En Fan>    int ch;
3532*4a1a9510SRong-En Fan
3533*4a1a9510SRong-En Fan    ch = getch();</PRE
3534*4a1a9510SRong-En Fan><P
3535*4a1a9510SRong-En Fan>getch() will wait for the user to press a key, (unless you specified a timeout)
3536*4a1a9510SRong-En Fanand when user presses a key, the corresponding integer is returned. Then you can
3537*4a1a9510SRong-En Fancheck the value returned with the constants defined in curses.h to match against
3538*4a1a9510SRong-En Fanthe keys you want.</P
3539*4a1a9510SRong-En Fan><P
3540*4a1a9510SRong-En Fan>The following code piece will do that job.</P
3541*4a1a9510SRong-En Fan><PRE
3542*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
3543*4a1a9510SRong-En Fan>    if(ch == KEY_LEFT)
3544*4a1a9510SRong-En Fan        printw("Left arrow is pressed\n");</PRE
3545*4a1a9510SRong-En Fan><P
3546*4a1a9510SRong-En Fan>Let's write a small program which creates a menu which can be navigated by up
3547*4a1a9510SRong-En Fanand down arrows.</P
3548*4a1a9510SRong-En Fan></DIV
3549*4a1a9510SRong-En Fan><DIV
3550*4a1a9510SRong-En FanCLASS="SECT2"
3551*4a1a9510SRong-En Fan><HR><H3
3552*4a1a9510SRong-En FanCLASS="SECT2"
3553*4a1a9510SRong-En Fan><A
3554*4a1a9510SRong-En FanNAME="SIMPLEKEYEX"
3555*4a1a9510SRong-En Fan>11.2. A Simple Key Usage example</A
3556*4a1a9510SRong-En Fan></H3
3557*4a1a9510SRong-En Fan><DIV
3558*4a1a9510SRong-En FanCLASS="EXAMPLE"
3559*4a1a9510SRong-En Fan><A
3560*4a1a9510SRong-En FanNAME="BSIKE"
3561*4a1a9510SRong-En Fan></A
3562*4a1a9510SRong-En Fan><P
3563*4a1a9510SRong-En Fan><B
3564*4a1a9510SRong-En Fan>Example 10.  A Simple Key Usage example </B
3565*4a1a9510SRong-En Fan></P
3566*4a1a9510SRong-En Fan><PRE
3567*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
3568*4a1a9510SRong-En Fan><SPAN
3569*4a1a9510SRong-En FanCLASS="INLINEMEDIAOBJECT"
3570*4a1a9510SRong-En Fan>#include &#60;stdio.h&#62;
3571*4a1a9510SRong-En Fan#include &#60;ncurses.h&#62;
3572*4a1a9510SRong-En Fan
3573*4a1a9510SRong-En Fan#define WIDTH 30
3574*4a1a9510SRong-En Fan#define HEIGHT 10
3575*4a1a9510SRong-En Fan
3576*4a1a9510SRong-En Fanint startx = 0;
3577*4a1a9510SRong-En Fanint starty = 0;
3578*4a1a9510SRong-En Fan
3579*4a1a9510SRong-En Fanchar *choices[] = {
3580*4a1a9510SRong-En Fan			"Choice 1",
3581*4a1a9510SRong-En Fan			"Choice 2",
3582*4a1a9510SRong-En Fan			"Choice 3",
3583*4a1a9510SRong-En Fan			"Choice 4",
3584*4a1a9510SRong-En Fan			"Exit",
3585*4a1a9510SRong-En Fan		  };
3586*4a1a9510SRong-En Fanint n_choices = sizeof(choices) / sizeof(char *);
3587*4a1a9510SRong-En Fanvoid print_menu(WINDOW *menu_win, int highlight);
3588*4a1a9510SRong-En Fan
3589*4a1a9510SRong-En Fanint main()
3590*4a1a9510SRong-En Fan{	WINDOW *menu_win;
3591*4a1a9510SRong-En Fan	int highlight = 1;
3592*4a1a9510SRong-En Fan	int choice = 0;
3593*4a1a9510SRong-En Fan	int c;
3594*4a1a9510SRong-En Fan
3595*4a1a9510SRong-En Fan	initscr();
3596*4a1a9510SRong-En Fan	clear();
3597*4a1a9510SRong-En Fan	noecho();
3598*4a1a9510SRong-En Fan	cbreak();	/* Line buffering disabled. pass on everything */
3599*4a1a9510SRong-En Fan	startx = (80 - WIDTH) / 2;
3600*4a1a9510SRong-En Fan	starty = (24 - HEIGHT) / 2;
3601*4a1a9510SRong-En Fan
3602*4a1a9510SRong-En Fan	menu_win = newwin(HEIGHT, WIDTH, starty, startx);
3603*4a1a9510SRong-En Fan	keypad(menu_win, TRUE);
3604*4a1a9510SRong-En Fan	mvprintw(0, 0, "Use arrow keys to go up and down, Press enter to select a choice");
3605*4a1a9510SRong-En Fan	refresh();
3606*4a1a9510SRong-En Fan	print_menu(menu_win, highlight);
3607*4a1a9510SRong-En Fan	while(1)
3608*4a1a9510SRong-En Fan	{	c = wgetch(menu_win);
3609*4a1a9510SRong-En Fan		switch(c)
3610*4a1a9510SRong-En Fan		{	case KEY_UP:
3611*4a1a9510SRong-En Fan				if(highlight == 1)
3612*4a1a9510SRong-En Fan					highlight = n_choices;
3613*4a1a9510SRong-En Fan				else
3614*4a1a9510SRong-En Fan					--highlight;
3615*4a1a9510SRong-En Fan				break;
3616*4a1a9510SRong-En Fan			case KEY_DOWN:
3617*4a1a9510SRong-En Fan				if(highlight == n_choices)
3618*4a1a9510SRong-En Fan					highlight = 1;
3619*4a1a9510SRong-En Fan				else
3620*4a1a9510SRong-En Fan					++highlight;
3621*4a1a9510SRong-En Fan				break;
3622*4a1a9510SRong-En Fan			case 10:
3623*4a1a9510SRong-En Fan				choice = highlight;
3624*4a1a9510SRong-En Fan				break;
3625*4a1a9510SRong-En Fan			default:
3626*4a1a9510SRong-En Fan				mvprintw(24, 0, "Charcter pressed is = %3d Hopefully it can be printed as '%c'", c, c);
3627*4a1a9510SRong-En Fan				refresh();
3628*4a1a9510SRong-En Fan				break;
3629*4a1a9510SRong-En Fan		}
3630*4a1a9510SRong-En Fan		print_menu(menu_win, highlight);
3631*4a1a9510SRong-En Fan		if(choice != 0)	/* User did a choice come out of the infinite loop */
3632*4a1a9510SRong-En Fan			break;
3633*4a1a9510SRong-En Fan	}
3634*4a1a9510SRong-En Fan	mvprintw(23, 0, "You chose choice %d with choice string %s\n", choice, choices[choice - 1]);
3635*4a1a9510SRong-En Fan	clrtoeol();
3636*4a1a9510SRong-En Fan	refresh();
3637*4a1a9510SRong-En Fan	endwin();
3638*4a1a9510SRong-En Fan	return 0;
3639*4a1a9510SRong-En Fan}
3640*4a1a9510SRong-En Fan
3641*4a1a9510SRong-En Fan
3642*4a1a9510SRong-En Fanvoid print_menu(WINDOW *menu_win, int highlight)
3643*4a1a9510SRong-En Fan{
3644*4a1a9510SRong-En Fan	int x, y, i;
3645*4a1a9510SRong-En Fan
3646*4a1a9510SRong-En Fan	x = 2;
3647*4a1a9510SRong-En Fan	y = 2;
3648*4a1a9510SRong-En Fan	box(menu_win, 0, 0);
3649*4a1a9510SRong-En Fan	for(i = 0; i &#60; n_choices; ++i)
3650*4a1a9510SRong-En Fan	{	if(highlight == i + 1) /* High light the present choice */
3651*4a1a9510SRong-En Fan		{	wattron(menu_win, A_REVERSE);
3652*4a1a9510SRong-En Fan			mvwprintw(menu_win, y, x, "%s", choices[i]);
3653*4a1a9510SRong-En Fan			wattroff(menu_win, A_REVERSE);
3654*4a1a9510SRong-En Fan		}
3655*4a1a9510SRong-En Fan		else
3656*4a1a9510SRong-En Fan			mvwprintw(menu_win, y, x, "%s", choices[i]);
3657*4a1a9510SRong-En Fan		++y;
3658*4a1a9510SRong-En Fan	}
3659*4a1a9510SRong-En Fan	wrefresh(menu_win);
3660*4a1a9510SRong-En Fan}
3661*4a1a9510SRong-En Fan</SPAN
3662*4a1a9510SRong-En Fan></PRE
3663*4a1a9510SRong-En Fan></DIV
3664*4a1a9510SRong-En Fan></DIV
3665*4a1a9510SRong-En Fan></DIV
3666*4a1a9510SRong-En Fan><DIV
3667*4a1a9510SRong-En FanCLASS="SECT1"
3668*4a1a9510SRong-En Fan><HR><H2
3669*4a1a9510SRong-En FanCLASS="SECT1"
3670*4a1a9510SRong-En Fan><A
3671*4a1a9510SRong-En FanNAME="MOUSE"
3672*4a1a9510SRong-En Fan>12. Interfacing with the mouse</A
3673*4a1a9510SRong-En Fan></H2
3674*4a1a9510SRong-En Fan><P
3675*4a1a9510SRong-En Fan>Now that you have seen how to get keys, lets do the same thing from mouse.
3676*4a1a9510SRong-En FanUsually each UI allows the user to interact with both keyboard and mouse. </P
3677*4a1a9510SRong-En Fan><DIV
3678*4a1a9510SRong-En FanCLASS="SECT2"
3679*4a1a9510SRong-En Fan><HR><H3
3680*4a1a9510SRong-En FanCLASS="SECT2"
3681*4a1a9510SRong-En Fan><A
3682*4a1a9510SRong-En FanNAME="MOUSEBASICS"
3683*4a1a9510SRong-En Fan>12.1. The Basics</A
3684*4a1a9510SRong-En Fan></H3
3685*4a1a9510SRong-En Fan><P
3686*4a1a9510SRong-En Fan>Before you do any thing else, the events you want to receive have to be enabled
3687*4a1a9510SRong-En Fanwith <TT
3688*4a1a9510SRong-En FanCLASS="LITERAL"
3689*4a1a9510SRong-En Fan>mousemask()</TT
3690*4a1a9510SRong-En Fan>.</P
3691*4a1a9510SRong-En Fan><PRE
3692*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
3693*4a1a9510SRong-En Fan>    mousemask(  mmask_t newmask,    /* The events you want to listen to */
3694*4a1a9510SRong-En Fan                mmask_t *oldmask)    /* The old events mask                */</PRE
3695*4a1a9510SRong-En Fan><P
3696*4a1a9510SRong-En Fan>The first parameter to above function is a bit mask of events you would like to
3697*4a1a9510SRong-En Fanlisten. By default, all the events are turned off. The bit mask <TT
3698*4a1a9510SRong-En FanCLASS="LITERAL"
3699*4a1a9510SRong-En Fan> ALL_MOUSE_EVENTS</TT
3700*4a1a9510SRong-En Fan> can be used to get all the events.</P
3701*4a1a9510SRong-En Fan><P
3702*4a1a9510SRong-En Fan>The following are all the event masks:</P
3703*4a1a9510SRong-En Fan><PRE
3704*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
3705*4a1a9510SRong-En Fan>    Name            Description
3706*4a1a9510SRong-En Fan       ---------------------------------------------------------------------
3707*4a1a9510SRong-En Fan       BUTTON1_PRESSED          mouse button 1 down
3708*4a1a9510SRong-En Fan       BUTTON1_RELEASED         mouse button 1 up
3709*4a1a9510SRong-En Fan       BUTTON1_CLICKED          mouse button 1 clicked
3710*4a1a9510SRong-En Fan       BUTTON1_DOUBLE_CLICKED   mouse button 1 double clicked
3711*4a1a9510SRong-En Fan       BUTTON1_TRIPLE_CLICKED   mouse button 1 triple clicked
3712*4a1a9510SRong-En Fan       BUTTON2_PRESSED          mouse button 2 down
3713*4a1a9510SRong-En Fan       BUTTON2_RELEASED         mouse button 2 up
3714*4a1a9510SRong-En Fan       BUTTON2_CLICKED          mouse button 2 clicked
3715*4a1a9510SRong-En Fan       BUTTON2_DOUBLE_CLICKED   mouse button 2 double clicked
3716*4a1a9510SRong-En Fan       BUTTON2_TRIPLE_CLICKED   mouse button 2 triple clicked
3717*4a1a9510SRong-En Fan       BUTTON3_PRESSED          mouse button 3 down
3718*4a1a9510SRong-En Fan       BUTTON3_RELEASED         mouse button 3 up
3719*4a1a9510SRong-En Fan       BUTTON3_CLICKED          mouse button 3 clicked
3720*4a1a9510SRong-En Fan       BUTTON3_DOUBLE_CLICKED   mouse button 3 double clicked
3721*4a1a9510SRong-En Fan       BUTTON3_TRIPLE_CLICKED   mouse button 3 triple clicked
3722*4a1a9510SRong-En Fan       BUTTON4_PRESSED          mouse button 4 down
3723*4a1a9510SRong-En Fan       BUTTON4_RELEASED         mouse button 4 up
3724*4a1a9510SRong-En Fan       BUTTON4_CLICKED          mouse button 4 clicked
3725*4a1a9510SRong-En Fan       BUTTON4_DOUBLE_CLICKED   mouse button 4 double clicked
3726*4a1a9510SRong-En Fan       BUTTON4_TRIPLE_CLICKED   mouse button 4 triple clicked
3727*4a1a9510SRong-En Fan       BUTTON_SHIFT             shift was down during button state change
3728*4a1a9510SRong-En Fan       BUTTON_CTRL              control was down during button state change
3729*4a1a9510SRong-En Fan       BUTTON_ALT               alt was down during button state change
3730*4a1a9510SRong-En Fan       ALL_MOUSE_EVENTS         report all button state changes
3731*4a1a9510SRong-En Fan       REPORT_MOUSE_POSITION    report mouse movement</PRE
3732*4a1a9510SRong-En Fan></DIV
3733*4a1a9510SRong-En Fan><DIV
3734*4a1a9510SRong-En FanCLASS="SECT2"
3735*4a1a9510SRong-En Fan><HR><H3
3736*4a1a9510SRong-En FanCLASS="SECT2"
3737*4a1a9510SRong-En Fan><A
3738*4a1a9510SRong-En FanNAME="GETTINGEVENTS"
3739*4a1a9510SRong-En Fan>12.2. Getting the events</A
3740*4a1a9510SRong-En Fan></H3
3741*4a1a9510SRong-En Fan><P
3742*4a1a9510SRong-En Fan>Once a class of mouse events have been enabled, getch() class of functions
3743*4a1a9510SRong-En Fanreturn KEY_MOUSE every time some mouse event happens. Then the mouse event can
3744*4a1a9510SRong-En Fanbe retrieved with <TT
3745*4a1a9510SRong-En FanCLASS="LITERAL"
3746*4a1a9510SRong-En Fan>getmouse()</TT
3747*4a1a9510SRong-En Fan>.</P
3748*4a1a9510SRong-En Fan><P
3749*4a1a9510SRong-En Fan>The code approximately looks like this:</P
3750*4a1a9510SRong-En Fan><PRE
3751*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
3752*4a1a9510SRong-En Fan>    MEVENT event;
3753*4a1a9510SRong-En Fan
3754*4a1a9510SRong-En Fan    ch = getch();
3755*4a1a9510SRong-En Fan    if(ch == KEY_MOUSE)
3756*4a1a9510SRong-En Fan        if(getmouse(&amp;event) == OK)
3757*4a1a9510SRong-En Fan            .    /* Do some thing with the event */
3758*4a1a9510SRong-En Fan            .
3759*4a1a9510SRong-En Fan            .</PRE
3760*4a1a9510SRong-En Fan><P
3761*4a1a9510SRong-En Fan>
3762*4a1a9510SRong-En Fangetmouse() returns the event into the pointer given to it. It's a structure
3763*4a1a9510SRong-En Fanwhich contains</P
3764*4a1a9510SRong-En Fan><PRE
3765*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
3766*4a1a9510SRong-En Fan>    typedef struct
3767*4a1a9510SRong-En Fan    {
3768*4a1a9510SRong-En Fan        short id;         /* ID to distinguish multiple devices */
3769*4a1a9510SRong-En Fan        int x, y, z;      /* event coordinates */
3770*4a1a9510SRong-En Fan        mmask_t bstate;   /* button state bits */
3771*4a1a9510SRong-En Fan    }    </PRE
3772*4a1a9510SRong-En Fan><P
3773*4a1a9510SRong-En Fan>The <TT
3774*4a1a9510SRong-En FanCLASS="LITERAL"
3775*4a1a9510SRong-En Fan>bstate</TT
3776*4a1a9510SRong-En Fan> is the main variable we are
3777*4a1a9510SRong-En Faninterested in. It tells the button state of the mouse.</P
3778*4a1a9510SRong-En Fan><P
3779*4a1a9510SRong-En Fan>Then with a code snippet like the following, we can find out what happened.</P
3780*4a1a9510SRong-En Fan><PRE
3781*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
3782*4a1a9510SRong-En Fan>    if(event.bstate &amp; BUTTON1_PRESSED)
3783*4a1a9510SRong-En Fan        printw("Left Button Pressed");</PRE
3784*4a1a9510SRong-En Fan></DIV
3785*4a1a9510SRong-En Fan><DIV
3786*4a1a9510SRong-En FanCLASS="SECT2"
3787*4a1a9510SRong-En Fan><HR><H3
3788*4a1a9510SRong-En FanCLASS="SECT2"
3789*4a1a9510SRong-En Fan><A
3790*4a1a9510SRong-En FanNAME="MOUSETOGETHER"
3791*4a1a9510SRong-En Fan>12.3. Putting it all Together</A
3792*4a1a9510SRong-En Fan></H3
3793*4a1a9510SRong-En Fan><P
3794*4a1a9510SRong-En Fan>That's pretty much interfacing with mouse. Let's create the same menu and enable
3795*4a1a9510SRong-En Fanmouse interaction. To make things simpler, key handling is removed.</P
3796*4a1a9510SRong-En Fan><DIV
3797*4a1a9510SRong-En FanCLASS="EXAMPLE"
3798*4a1a9510SRong-En Fan><A
3799*4a1a9510SRong-En FanNAME="BMOME"
3800*4a1a9510SRong-En Fan></A
3801*4a1a9510SRong-En Fan><P
3802*4a1a9510SRong-En Fan><B
3803*4a1a9510SRong-En Fan>Example 11.  Access the menu with mouse !!! </B
3804*4a1a9510SRong-En Fan></P
3805*4a1a9510SRong-En Fan><PRE
3806*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
3807*4a1a9510SRong-En Fan><SPAN
3808*4a1a9510SRong-En FanCLASS="INLINEMEDIAOBJECT"
3809*4a1a9510SRong-En Fan>#include &#60;ncurses.h&#62;
3810*4a1a9510SRong-En Fan
3811*4a1a9510SRong-En Fan#define WIDTH 30
3812*4a1a9510SRong-En Fan#define HEIGHT 10
3813*4a1a9510SRong-En Fan
3814*4a1a9510SRong-En Fanint startx = 0;
3815*4a1a9510SRong-En Fanint starty = 0;
3816*4a1a9510SRong-En Fan
3817*4a1a9510SRong-En Fanchar *choices[] = { 	"Choice 1",
3818*4a1a9510SRong-En Fan			"Choice 2",
3819*4a1a9510SRong-En Fan			"Choice 3",
3820*4a1a9510SRong-En Fan			"Choice 4",
3821*4a1a9510SRong-En Fan			"Exit",
3822*4a1a9510SRong-En Fan		  };
3823*4a1a9510SRong-En Fan
3824*4a1a9510SRong-En Fanint n_choices = sizeof(choices) / sizeof(char *);
3825*4a1a9510SRong-En Fan
3826*4a1a9510SRong-En Fanvoid print_menu(WINDOW *menu_win, int highlight);
3827*4a1a9510SRong-En Fanvoid report_choice(int mouse_x, int mouse_y, int *p_choice);
3828*4a1a9510SRong-En Fan
3829*4a1a9510SRong-En Fanint main()
3830*4a1a9510SRong-En Fan{	int c, choice = 0;
3831*4a1a9510SRong-En Fan	WINDOW *menu_win;
3832*4a1a9510SRong-En Fan	MEVENT event;
3833*4a1a9510SRong-En Fan
3834*4a1a9510SRong-En Fan	/* Initialize curses */
3835*4a1a9510SRong-En Fan	initscr();
3836*4a1a9510SRong-En Fan	clear();
3837*4a1a9510SRong-En Fan	noecho();
3838*4a1a9510SRong-En Fan	cbreak();	//Line buffering disabled. pass on everything
3839*4a1a9510SRong-En Fan
3840*4a1a9510SRong-En Fan	/* Try to put the window in the middle of screen */
3841*4a1a9510SRong-En Fan	startx = (80 - WIDTH) / 2;
3842*4a1a9510SRong-En Fan	starty = (24 - HEIGHT) / 2;
3843*4a1a9510SRong-En Fan
3844*4a1a9510SRong-En Fan	attron(A_REVERSE);
3845*4a1a9510SRong-En Fan	mvprintw(23, 1, "Click on Exit to quit (Works best in a virtual console)");
3846*4a1a9510SRong-En Fan	refresh();
3847*4a1a9510SRong-En Fan	attroff(A_REVERSE);
3848*4a1a9510SRong-En Fan
3849*4a1a9510SRong-En Fan	/* Print the menu for the first time */
3850*4a1a9510SRong-En Fan	menu_win = newwin(HEIGHT, WIDTH, starty, startx);
3851*4a1a9510SRong-En Fan	print_menu(menu_win, 1);
3852*4a1a9510SRong-En Fan	/* Get all the mouse events */
3853*4a1a9510SRong-En Fan	mousemask(ALL_MOUSE_EVENTS, NULL);
3854*4a1a9510SRong-En Fan
3855*4a1a9510SRong-En Fan	while(1)
3856*4a1a9510SRong-En Fan	{	c = wgetch(menu_win);
3857*4a1a9510SRong-En Fan		switch(c)
3858*4a1a9510SRong-En Fan		{	case KEY_MOUSE:
3859*4a1a9510SRong-En Fan			if(getmouse(&#38;event) == OK)
3860*4a1a9510SRong-En Fan			{	/* When the user clicks left mouse button */
3861*4a1a9510SRong-En Fan				if(event.bstate &#38; BUTTON1_PRESSED)
3862*4a1a9510SRong-En Fan				{	report_choice(event.x + 1, event.y + 1, &#38;choice);
3863*4a1a9510SRong-En Fan					if(choice == -1) //Exit chosen
3864*4a1a9510SRong-En Fan						goto end;
3865*4a1a9510SRong-En Fan					mvprintw(22, 1, "Choice made is : %d String Chosen is \"%10s\"", choice, choices[choice - 1]);
3866*4a1a9510SRong-En Fan					refresh();
3867*4a1a9510SRong-En Fan				}
3868*4a1a9510SRong-En Fan			}
3869*4a1a9510SRong-En Fan			print_menu(menu_win, choice);
3870*4a1a9510SRong-En Fan			break;
3871*4a1a9510SRong-En Fan		}
3872*4a1a9510SRong-En Fan	}
3873*4a1a9510SRong-En Fanend:
3874*4a1a9510SRong-En Fan	endwin();
3875*4a1a9510SRong-En Fan	return 0;
3876*4a1a9510SRong-En Fan}
3877*4a1a9510SRong-En Fan
3878*4a1a9510SRong-En Fan
3879*4a1a9510SRong-En Fanvoid print_menu(WINDOW *menu_win, int highlight)
3880*4a1a9510SRong-En Fan{
3881*4a1a9510SRong-En Fan	int x, y, i;
3882*4a1a9510SRong-En Fan
3883*4a1a9510SRong-En Fan	x = 2;
3884*4a1a9510SRong-En Fan	y = 2;
3885*4a1a9510SRong-En Fan	box(menu_win, 0, 0);
3886*4a1a9510SRong-En Fan	for(i = 0; i &#60; n_choices; ++i)
3887*4a1a9510SRong-En Fan	{	if(highlight == i + 1)
3888*4a1a9510SRong-En Fan		{	wattron(menu_win, A_REVERSE);
3889*4a1a9510SRong-En Fan			mvwprintw(menu_win, y, x, "%s", choices[i]);
3890*4a1a9510SRong-En Fan			wattroff(menu_win, A_REVERSE);
3891*4a1a9510SRong-En Fan		}
3892*4a1a9510SRong-En Fan		else
3893*4a1a9510SRong-En Fan			mvwprintw(menu_win, y, x, "%s", choices[i]);
3894*4a1a9510SRong-En Fan		++y;
3895*4a1a9510SRong-En Fan	}
3896*4a1a9510SRong-En Fan	wrefresh(menu_win);
3897*4a1a9510SRong-En Fan}
3898*4a1a9510SRong-En Fan
3899*4a1a9510SRong-En Fan/* Report the choice according to mouse position */
3900*4a1a9510SRong-En Fanvoid report_choice(int mouse_x, int mouse_y, int *p_choice)
3901*4a1a9510SRong-En Fan{	int i,j, choice;
3902*4a1a9510SRong-En Fan
3903*4a1a9510SRong-En Fan	i = startx + 2;
3904*4a1a9510SRong-En Fan	j = starty + 3;
3905*4a1a9510SRong-En Fan
3906*4a1a9510SRong-En Fan	for(choice = 0; choice &#60; n_choices; ++choice)
3907*4a1a9510SRong-En Fan		if(mouse_y == j + choice &#38;&#38; mouse_x &#62;= i &#38;&#38; mouse_x &#60;= i + strlen(choices[choice]))
3908*4a1a9510SRong-En Fan		{	if(choice == n_choices - 1)
3909*4a1a9510SRong-En Fan				*p_choice = -1;
3910*4a1a9510SRong-En Fan			else
3911*4a1a9510SRong-En Fan				*p_choice = choice + 1;
3912*4a1a9510SRong-En Fan			break;
3913*4a1a9510SRong-En Fan		}
3914*4a1a9510SRong-En Fan}</SPAN
3915*4a1a9510SRong-En Fan></PRE
3916*4a1a9510SRong-En Fan></DIV
3917*4a1a9510SRong-En Fan></DIV
3918*4a1a9510SRong-En Fan><DIV
3919*4a1a9510SRong-En FanCLASS="SECT2"
3920*4a1a9510SRong-En Fan><HR><H3
3921*4a1a9510SRong-En FanCLASS="SECT2"
3922*4a1a9510SRong-En Fan><A
3923*4a1a9510SRong-En FanNAME="MISCMOUSEFUNCS"
3924*4a1a9510SRong-En Fan>12.4. Miscellaneous Functions</A
3925*4a1a9510SRong-En Fan></H3
3926*4a1a9510SRong-En Fan><P
3927*4a1a9510SRong-En Fan>The functions mouse_trafo() and wmouse_trafo() can be used to convert to mouse
3928*4a1a9510SRong-En Fanco-ordinates to screen relative co-ordinates. See curs_mouse(3X) man page for details.</P
3929*4a1a9510SRong-En Fan><P
3930*4a1a9510SRong-En Fan>The  mouseinterval  function sets the maximum time (in thousands of a
3931*4a1a9510SRong-En Fansecond) that can elapse between press and release events in order for
3932*4a1a9510SRong-En Fanthem to be recognized as a click.  This function returns the previous
3933*4a1a9510SRong-En Faninterval value.  The default is one fifth of a second.</P
3934*4a1a9510SRong-En Fan></DIV
3935*4a1a9510SRong-En Fan></DIV
3936*4a1a9510SRong-En Fan><DIV
3937*4a1a9510SRong-En FanCLASS="SECT1"
3938*4a1a9510SRong-En Fan><HR><H2
3939*4a1a9510SRong-En FanCLASS="SECT1"
3940*4a1a9510SRong-En Fan><A
3941*4a1a9510SRong-En FanNAME="SCREEN"
3942*4a1a9510SRong-En Fan>13. Screen Manipulation</A
3943*4a1a9510SRong-En Fan></H2
3944*4a1a9510SRong-En Fan><P
3945*4a1a9510SRong-En Fan>In this section, we will look into some functions, which allow us to manage the
3946*4a1a9510SRong-En Fanscreen efficiently and to write some fancy programs. This is especially
3947*4a1a9510SRong-En Fanimportant in writing games. </P
3948*4a1a9510SRong-En Fan><DIV
3949*4a1a9510SRong-En FanCLASS="SECT2"
3950*4a1a9510SRong-En Fan><HR><H3
3951*4a1a9510SRong-En FanCLASS="SECT2"
3952*4a1a9510SRong-En Fan><A
3953*4a1a9510SRong-En FanNAME="GETYX"
3954*4a1a9510SRong-En Fan>13.1. getyx() functions</A
3955*4a1a9510SRong-En Fan></H3
3956*4a1a9510SRong-En Fan><P
3957*4a1a9510SRong-En Fan>&#13;The function <TT
3958*4a1a9510SRong-En FanCLASS="LITERAL"
3959*4a1a9510SRong-En Fan>getyx()</TT
3960*4a1a9510SRong-En Fan> can be used to find out
3961*4a1a9510SRong-En Fanthe present cursor co-ordinates. It will fill the values of x and y co-ordinates
3962*4a1a9510SRong-En Fanin the arguments given to it. Since getyx() is a macro you don't have to pass
3963*4a1a9510SRong-En Fanthe address of the variables. It can be called as</P
3964*4a1a9510SRong-En Fan><PRE
3965*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
3966*4a1a9510SRong-En Fan>    getyx(win, y, x);
3967*4a1a9510SRong-En Fan    /* win: window pointer
3968*4a1a9510SRong-En Fan     *   y, x: y, x co-ordinates will be put into this variables
3969*4a1a9510SRong-En Fan     */</PRE
3970*4a1a9510SRong-En Fan><P
3971*4a1a9510SRong-En Fan>The function getparyx() gets the beginning co-ordinates of the sub window
3972*4a1a9510SRong-En Fanrelative to the main window. This is some times useful to update a sub window.
3973*4a1a9510SRong-En FanWhen designing fancy stuff like writing multiple menus, it becomes difficult to
3974*4a1a9510SRong-En Fanstore the menu positions, their first option co-ordinates etc. A simple solution
3975*4a1a9510SRong-En Fanto this problem, is to create menus in sub windows and later find the starting
3976*4a1a9510SRong-En Fanco-ordinates of the menus by using getparyx().</P
3977*4a1a9510SRong-En Fan><P
3978*4a1a9510SRong-En Fan>The functions getbegyx() and getmaxyx() store current window's beginning and
3979*4a1a9510SRong-En Fanmaximum co-ordinates. These functions are useful in the same way as above in
3980*4a1a9510SRong-En Fanmanaging the windows and sub windows effectively.</P
3981*4a1a9510SRong-En Fan></DIV
3982*4a1a9510SRong-En Fan><DIV
3983*4a1a9510SRong-En FanCLASS="SECT2"
3984*4a1a9510SRong-En Fan><HR><H3
3985*4a1a9510SRong-En FanCLASS="SECT2"
3986*4a1a9510SRong-En Fan><A
3987*4a1a9510SRong-En FanNAME="SCREENDUMP"
3988*4a1a9510SRong-En Fan>13.2. Screen Dumping</A
3989*4a1a9510SRong-En Fan></H3
3990*4a1a9510SRong-En Fan><P
3991*4a1a9510SRong-En Fan>While writing games, some times it becomes necessary to store the state of the
3992*4a1a9510SRong-En Fanscreen and restore it back to the same state. The function scr_dump() can be
3993*4a1a9510SRong-En Fanused to dump the screen contents to a file given as an argument. Later it can be
3994*4a1a9510SRong-En Fanrestored by scr_restore function. These two simple functions can be used
3995*4a1a9510SRong-En Faneffectively to maintain a fast moving game with changing scenarios. </P
3996*4a1a9510SRong-En Fan></DIV
3997*4a1a9510SRong-En Fan><DIV
3998*4a1a9510SRong-En FanCLASS="SECT2"
3999*4a1a9510SRong-En Fan><HR><H3
4000*4a1a9510SRong-En FanCLASS="SECT2"
4001*4a1a9510SRong-En Fan><A
4002*4a1a9510SRong-En FanNAME="WINDOWDUMP"
4003*4a1a9510SRong-En Fan>13.3. Window Dumping</A
4004*4a1a9510SRong-En Fan></H3
4005*4a1a9510SRong-En Fan><P
4006*4a1a9510SRong-En Fan>To store and restore windows, the functions
4007*4a1a9510SRong-En Fan<TT
4008*4a1a9510SRong-En FanCLASS="LITERAL"
4009*4a1a9510SRong-En Fan>putwin()</TT
4010*4a1a9510SRong-En Fan> and <TT
4011*4a1a9510SRong-En FanCLASS="LITERAL"
4012*4a1a9510SRong-En Fan>getwin()</TT
4013*4a1a9510SRong-En Fan> can be used. <TT
4014*4a1a9510SRong-En FanCLASS="LITERAL"
4015*4a1a9510SRong-En Fan>putwin()</TT
4016*4a1a9510SRong-En Fan> puts
4017*4a1a9510SRong-En Fanthe present window state into a file, which can be later restored by
4018*4a1a9510SRong-En Fan<TT
4019*4a1a9510SRong-En FanCLASS="LITERAL"
4020*4a1a9510SRong-En Fan>getwin()</TT
4021*4a1a9510SRong-En Fan>.</P
4022*4a1a9510SRong-En Fan><P
4023*4a1a9510SRong-En Fan>
4024*4a1a9510SRong-En FanThe function <TT
4025*4a1a9510SRong-En FanCLASS="LITERAL"
4026*4a1a9510SRong-En Fan>copywin()</TT
4027*4a1a9510SRong-En Fan> can be used to copy a
4028*4a1a9510SRong-En Fanwindow completely onto another window. It takes the source and destination
4029*4a1a9510SRong-En Fanwindows as parameters and according to the rectangle specified, it copies the
4030*4a1a9510SRong-En Fanrectangular region from source to destination window.  It's last parameter
4031*4a1a9510SRong-En Fanspecifies whether to overwrite or just overlay the contents on to the
4032*4a1a9510SRong-En Fandestination window. If this argument is true, then the copying is
4033*4a1a9510SRong-En Fannon-destructive.</P
4034*4a1a9510SRong-En Fan></DIV
4035*4a1a9510SRong-En Fan></DIV
4036*4a1a9510SRong-En Fan><DIV
4037*4a1a9510SRong-En FanCLASS="SECT1"
4038*4a1a9510SRong-En Fan><HR><H2
4039*4a1a9510SRong-En FanCLASS="SECT1"
4040*4a1a9510SRong-En Fan><A
4041*4a1a9510SRong-En FanNAME="MISC"
4042*4a1a9510SRong-En Fan>14. Miscellaneous features</A
4043*4a1a9510SRong-En Fan></H2
4044*4a1a9510SRong-En Fan><P
4045*4a1a9510SRong-En Fan>Now you know enough features to write a good curses program, with all bells and
4046*4a1a9510SRong-En Fanwhistles. There are some miscellaneous functions which are useful in various
4047*4a1a9510SRong-En Fancases.  Let's go headlong into some of those.</P
4048*4a1a9510SRong-En Fan><DIV
4049*4a1a9510SRong-En FanCLASS="SECT2"
4050*4a1a9510SRong-En Fan><HR><H3
4051*4a1a9510SRong-En FanCLASS="SECT2"
4052*4a1a9510SRong-En Fan><A
4053*4a1a9510SRong-En FanNAME="CURSSET"
4054*4a1a9510SRong-En Fan>14.1. curs_set()</A
4055*4a1a9510SRong-En Fan></H3
4056*4a1a9510SRong-En Fan><P
4057*4a1a9510SRong-En Fan>This function can be used to make the cursor invisible. The parameter to this
4058*4a1a9510SRong-En Fanfunction should be </P
4059*4a1a9510SRong-En Fan><PRE
4060*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
4061*4a1a9510SRong-En Fan>    0 : invisible      or
4062*4a1a9510SRong-En Fan    1 : normal    or
4063*4a1a9510SRong-En Fan    2 : very visible.</PRE
4064*4a1a9510SRong-En Fan></DIV
4065*4a1a9510SRong-En Fan><DIV
4066*4a1a9510SRong-En FanCLASS="SECT2"
4067*4a1a9510SRong-En Fan><HR><H3
4068*4a1a9510SRong-En FanCLASS="SECT2"
4069*4a1a9510SRong-En Fan><A
4070*4a1a9510SRong-En FanNAME="TEMPLEAVE"
4071*4a1a9510SRong-En Fan>14.2. Temporarily Leaving Curses mode</A
4072*4a1a9510SRong-En Fan></H3
4073*4a1a9510SRong-En Fan><P
4074*4a1a9510SRong-En Fan>Some times you may want to get back to cooked mode (normal line buffering mode)
4075*4a1a9510SRong-En Fantemporarily. In such a case you will first need to save the tty modes with a
4076*4a1a9510SRong-En Fancall to <TT
4077*4a1a9510SRong-En FanCLASS="LITERAL"
4078*4a1a9510SRong-En Fan>def_prog_mode()</TT
4079*4a1a9510SRong-En Fan> and then call
4080*4a1a9510SRong-En Fan<TT
4081*4a1a9510SRong-En FanCLASS="LITERAL"
4082*4a1a9510SRong-En Fan>endwin()</TT
4083*4a1a9510SRong-En Fan> to end the curses mode. This will
4084*4a1a9510SRong-En Fanleave you in the original tty mode. To get back to curses once you are done,
4085*4a1a9510SRong-En Fancall <TT
4086*4a1a9510SRong-En FanCLASS="LITERAL"
4087*4a1a9510SRong-En Fan>reset_prog_mode() </TT
4088*4a1a9510SRong-En Fan>. This function returns
4089*4a1a9510SRong-En Fanthe tty to the state stored by <TT
4090*4a1a9510SRong-En FanCLASS="LITERAL"
4091*4a1a9510SRong-En Fan>def_prog_mode()</TT
4092*4a1a9510SRong-En Fan>. Then do refresh(), and you are back to the curses mode. Here
4093*4a1a9510SRong-En Fanis an example showing the sequence of things to be done.</P
4094*4a1a9510SRong-En Fan><DIV
4095*4a1a9510SRong-En FanCLASS="EXAMPLE"
4096*4a1a9510SRong-En Fan><A
4097*4a1a9510SRong-En FanNAME="BTELE"
4098*4a1a9510SRong-En Fan></A
4099*4a1a9510SRong-En Fan><P
4100*4a1a9510SRong-En Fan><B
4101*4a1a9510SRong-En Fan>Example 12.  Temporarily Leaving Curses Mode </B
4102*4a1a9510SRong-En Fan></P
4103*4a1a9510SRong-En Fan><PRE
4104*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
4105*4a1a9510SRong-En Fan><SPAN
4106*4a1a9510SRong-En FanCLASS="INLINEMEDIAOBJECT"
4107*4a1a9510SRong-En Fan>#include &#60;ncurses.h&#62;
4108*4a1a9510SRong-En Fan
4109*4a1a9510SRong-En Fanint main()
4110*4a1a9510SRong-En Fan{
4111*4a1a9510SRong-En Fan	initscr();			/* Start curses mode 		  */
4112*4a1a9510SRong-En Fan	printw("Hello World !!!\n");	/* Print Hello World		  */
4113*4a1a9510SRong-En Fan	refresh();			/* Print it on to the real screen */
4114*4a1a9510SRong-En Fan	def_prog_mode();		/* Save the tty modes		  */
4115*4a1a9510SRong-En Fan	endwin();			/* End curses mode temporarily	  */
4116*4a1a9510SRong-En Fan	system("/bin/sh");		/* Do whatever you like in cooked mode */
4117*4a1a9510SRong-En Fan	reset_prog_mode();		/* Return to the previous tty mode*/
4118*4a1a9510SRong-En Fan					/* stored by def_prog_mode() 	  */
4119*4a1a9510SRong-En Fan	refresh();			/* Do refresh() to restore the	  */
4120*4a1a9510SRong-En Fan					/* Screen contents		  */
4121*4a1a9510SRong-En Fan	printw("Another String\n");	/* Back to curses use the full    */
4122*4a1a9510SRong-En Fan	refresh();			/* capabilities of curses	  */
4123*4a1a9510SRong-En Fan	endwin();			/* End curses mode		  */
4124*4a1a9510SRong-En Fan
4125*4a1a9510SRong-En Fan	return 0;
4126*4a1a9510SRong-En Fan}</SPAN
4127*4a1a9510SRong-En Fan></PRE
4128*4a1a9510SRong-En Fan></DIV
4129*4a1a9510SRong-En Fan></DIV
4130*4a1a9510SRong-En Fan><DIV
4131*4a1a9510SRong-En FanCLASS="SECT2"
4132*4a1a9510SRong-En Fan><HR><H3
4133*4a1a9510SRong-En FanCLASS="SECT2"
4134*4a1a9510SRong-En Fan><A
4135*4a1a9510SRong-En FanNAME="ACSVARS"
4136*4a1a9510SRong-En Fan>14.3. ACS_ variables</A
4137*4a1a9510SRong-En Fan></H3
4138*4a1a9510SRong-En Fan><P
4139*4a1a9510SRong-En Fan>If you have ever programmed in DOS, you know about those nifty characters in
4140*4a1a9510SRong-En Fanextended character set. They are printable only on some terminals. NCURSES
4141*4a1a9510SRong-En Fanfunctions like <TT
4142*4a1a9510SRong-En FanCLASS="LITERAL"
4143*4a1a9510SRong-En Fan>box()</TT
4144*4a1a9510SRong-En Fan> use these characters. All
4145*4a1a9510SRong-En Fanthese variables start with ACS meaning alternative character set. You might have
4146*4a1a9510SRong-En Fannoticed me using these characters in some of the programs above. Here's an example
4147*4a1a9510SRong-En Fanshowing all the characters.</P
4148*4a1a9510SRong-En Fan><DIV
4149*4a1a9510SRong-En FanCLASS="EXAMPLE"
4150*4a1a9510SRong-En Fan><A
4151*4a1a9510SRong-En FanNAME="BACSVARS"
4152*4a1a9510SRong-En Fan></A
4153*4a1a9510SRong-En Fan><P
4154*4a1a9510SRong-En Fan><B
4155*4a1a9510SRong-En Fan>Example 13.  ACS Variables Example </B
4156*4a1a9510SRong-En Fan></P
4157*4a1a9510SRong-En Fan><PRE
4158*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
4159*4a1a9510SRong-En Fan><SPAN
4160*4a1a9510SRong-En FanCLASS="INLINEMEDIAOBJECT"
4161*4a1a9510SRong-En Fan>#include &#60;ncurses.h&#62;
4162*4a1a9510SRong-En Fan
4163*4a1a9510SRong-En Fanint main()
4164*4a1a9510SRong-En Fan{
4165*4a1a9510SRong-En Fan        initscr();
4166*4a1a9510SRong-En Fan
4167*4a1a9510SRong-En Fan        printw("Upper left corner           "); addch(ACS_ULCORNER); printw("\n");
4168*4a1a9510SRong-En Fan        printw("Lower left corner           "); addch(ACS_LLCORNER); printw("\n");
4169*4a1a9510SRong-En Fan        printw("Lower right corner          "); addch(ACS_LRCORNER); printw("\n");
4170*4a1a9510SRong-En Fan        printw("Tee pointing right          "); addch(ACS_LTEE); printw("\n");
4171*4a1a9510SRong-En Fan        printw("Tee pointing left           "); addch(ACS_RTEE); printw("\n");
4172*4a1a9510SRong-En Fan        printw("Tee pointing up             "); addch(ACS_BTEE); printw("\n");
4173*4a1a9510SRong-En Fan        printw("Tee pointing down           "); addch(ACS_TTEE); printw("\n");
4174*4a1a9510SRong-En Fan        printw("Horizontal line             "); addch(ACS_HLINE); printw("\n");
4175*4a1a9510SRong-En Fan        printw("Vertical line               "); addch(ACS_VLINE); printw("\n");
4176*4a1a9510SRong-En Fan        printw("Large Plus or cross over    "); addch(ACS_PLUS); printw("\n");
4177*4a1a9510SRong-En Fan        printw("Scan Line 1                 "); addch(ACS_S1); printw("\n");
4178*4a1a9510SRong-En Fan        printw("Scan Line 3                 "); addch(ACS_S3); printw("\n");
4179*4a1a9510SRong-En Fan        printw("Scan Line 7                 "); addch(ACS_S7); printw("\n");
4180*4a1a9510SRong-En Fan        printw("Scan Line 9                 "); addch(ACS_S9); printw("\n");
4181*4a1a9510SRong-En Fan        printw("Diamond                     "); addch(ACS_DIAMOND); printw("\n");
4182*4a1a9510SRong-En Fan        printw("Checker board (stipple)     "); addch(ACS_CKBOARD); printw("\n");
4183*4a1a9510SRong-En Fan        printw("Degree Symbol               "); addch(ACS_DEGREE); printw("\n");
4184*4a1a9510SRong-En Fan        printw("Plus/Minus Symbol           "); addch(ACS_PLMINUS); printw("\n");
4185*4a1a9510SRong-En Fan        printw("Bullet                      "); addch(ACS_BULLET); printw("\n");
4186*4a1a9510SRong-En Fan        printw("Arrow Pointing Left         "); addch(ACS_LARROW); printw("\n");
4187*4a1a9510SRong-En Fan        printw("Arrow Pointing Right        "); addch(ACS_RARROW); printw("\n");
4188*4a1a9510SRong-En Fan        printw("Arrow Pointing Down         "); addch(ACS_DARROW); printw("\n");
4189*4a1a9510SRong-En Fan        printw("Arrow Pointing Up           "); addch(ACS_UARROW); printw("\n");
4190*4a1a9510SRong-En Fan        printw("Board of squares            "); addch(ACS_BOARD); printw("\n");
4191*4a1a9510SRong-En Fan        printw("Lantern Symbol              "); addch(ACS_LANTERN); printw("\n");
4192*4a1a9510SRong-En Fan        printw("Solid Square Block          "); addch(ACS_BLOCK); printw("\n");
4193*4a1a9510SRong-En Fan        printw("Less/Equal sign             "); addch(ACS_LEQUAL); printw("\n");
4194*4a1a9510SRong-En Fan        printw("Greater/Equal sign          "); addch(ACS_GEQUAL); printw("\n");
4195*4a1a9510SRong-En Fan        printw("Pi                          "); addch(ACS_PI); printw("\n");
4196*4a1a9510SRong-En Fan        printw("Not equal                   "); addch(ACS_NEQUAL); printw("\n");
4197*4a1a9510SRong-En Fan        printw("UK pound sign               "); addch(ACS_STERLING); printw("\n");
4198*4a1a9510SRong-En Fan
4199*4a1a9510SRong-En Fan        refresh();
4200*4a1a9510SRong-En Fan        getch();
4201*4a1a9510SRong-En Fan        endwin();
4202*4a1a9510SRong-En Fan
4203*4a1a9510SRong-En Fan	return 0;
4204*4a1a9510SRong-En Fan}</SPAN
4205*4a1a9510SRong-En Fan></PRE
4206*4a1a9510SRong-En Fan></DIV
4207*4a1a9510SRong-En Fan></DIV
4208*4a1a9510SRong-En Fan></DIV
4209*4a1a9510SRong-En Fan><DIV
4210*4a1a9510SRong-En FanCLASS="SECT1"
4211*4a1a9510SRong-En Fan><HR><H2
4212*4a1a9510SRong-En FanCLASS="SECT1"
4213*4a1a9510SRong-En Fan><A
4214*4a1a9510SRong-En FanNAME="OTHERLIB"
4215*4a1a9510SRong-En Fan>15. Other libraries</A
4216*4a1a9510SRong-En Fan></H2
4217*4a1a9510SRong-En Fan><P
4218*4a1a9510SRong-En Fan>Apart from the curses library, there are few text mode libraries, which provide
4219*4a1a9510SRong-En Fanmore functionality and a lot of features. The following sections explain three
4220*4a1a9510SRong-En Fanstandard libraries which are usually distributed along with curses. </P
4221*4a1a9510SRong-En Fan></DIV
4222*4a1a9510SRong-En Fan><DIV
4223*4a1a9510SRong-En FanCLASS="SECT1"
4224*4a1a9510SRong-En Fan><HR><H2
4225*4a1a9510SRong-En FanCLASS="SECT1"
4226*4a1a9510SRong-En Fan><A
4227*4a1a9510SRong-En FanNAME="PANELS"
4228*4a1a9510SRong-En Fan>16. Panel Library</A
4229*4a1a9510SRong-En Fan></H2
4230*4a1a9510SRong-En Fan><P
4231*4a1a9510SRong-En Fan>Now that you are proficient in curses, you wanted to do some thing big. You
4232*4a1a9510SRong-En Fancreated a lot of overlapping windows to give a professional windows-type look.
4233*4a1a9510SRong-En FanUnfortunately, it soon becomes difficult to manage these. The multiple
4234*4a1a9510SRong-En Fanrefreshes, updates plunge you into a nightmare. The overlapping windows create
4235*4a1a9510SRong-En Fanblotches, whenever you forget to refresh the windows in the proper order. </P
4236*4a1a9510SRong-En Fan><P
4237*4a1a9510SRong-En Fan>Don't despair. There's an elegant solution provided in panels library. In the
4238*4a1a9510SRong-En Fanwords of developers of ncurses </P
4239*4a1a9510SRong-En Fan><P
4240*4a1a9510SRong-En Fan><SPAN
4241*4a1a9510SRong-En FanCLASS="emphasis"
4242*4a1a9510SRong-En Fan><I
4243*4a1a9510SRong-En FanCLASS="EMPHASIS"
4244*4a1a9510SRong-En Fan>When your interface design is such that windows may dive deeper into the
4245*4a1a9510SRong-En Fanvisibility stack or pop to the top at runtime, the resulting book-keeping can be
4246*4a1a9510SRong-En Fantedious and difficult to get right. Hence the panels library.</I
4247*4a1a9510SRong-En Fan></SPAN
4248*4a1a9510SRong-En Fan></P
4249*4a1a9510SRong-En Fan><P
4250*4a1a9510SRong-En Fan>If you have lot of overlapping windows, then panels library is the way to go. It
4251*4a1a9510SRong-En Fanobviates the need of doing series of wnoutrefresh(), doupdate() and relieves the
4252*4a1a9510SRong-En Fanburden of doing it correctly(bottom up). The library maintains information about
4253*4a1a9510SRong-En Fanthe order of windows, their overlapping and update the screen properly. So why
4254*4a1a9510SRong-En Fanwait? Let's take a close peek into panels.</P
4255*4a1a9510SRong-En Fan><DIV
4256*4a1a9510SRong-En FanCLASS="SECT2"
4257*4a1a9510SRong-En Fan><HR><H3
4258*4a1a9510SRong-En FanCLASS="SECT2"
4259*4a1a9510SRong-En Fan><A
4260*4a1a9510SRong-En FanNAME="PANELBASICS"
4261*4a1a9510SRong-En Fan>16.1. The Basics</A
4262*4a1a9510SRong-En Fan></H3
4263*4a1a9510SRong-En Fan><P
4264*4a1a9510SRong-En Fan>Panel object is a window that is implicitly treated as part of a deck including
4265*4a1a9510SRong-En Fanall other panel objects. The deck is treated as a stack with the top panel being
4266*4a1a9510SRong-En Fancompletely visible and the other panels may or may not be obscured according to
4267*4a1a9510SRong-En Fantheir positions. So the basic idea is to create a stack of overlapping panels
4268*4a1a9510SRong-En Fanand use panels library to display them correctly. There is a function similar to
4269*4a1a9510SRong-En Fanrefresh() which, when called , displays panels in the correct order. Functions
4270*4a1a9510SRong-En Fanare provided to hide or show panels, move panels, change its size etc.. The
4271*4a1a9510SRong-En Fanoverlapping problem is managed by the panels library during all the calls to
4272*4a1a9510SRong-En Fanthese functions. </P
4273*4a1a9510SRong-En Fan><P
4274*4a1a9510SRong-En Fan>The general flow of a panel program goes like this:
4275*4a1a9510SRong-En Fan
4276*4a1a9510SRong-En Fan<P
4277*4a1a9510SRong-En Fan></P
4278*4a1a9510SRong-En Fan><OL
4279*4a1a9510SRong-En FanTYPE="1"
4280*4a1a9510SRong-En Fan><LI
4281*4a1a9510SRong-En Fan><P
4282*4a1a9510SRong-En Fan>Create the windows (with newwin()) to be attached to the panels.</P
4283*4a1a9510SRong-En Fan></LI
4284*4a1a9510SRong-En Fan><LI
4285*4a1a9510SRong-En Fan><P
4286*4a1a9510SRong-En Fan>Create panels with the chosen visibility order. Stack them up according to the
4287*4a1a9510SRong-En Fandesired visibility. The function new_panel() is used to created panels.</P
4288*4a1a9510SRong-En Fan></LI
4289*4a1a9510SRong-En Fan><LI
4290*4a1a9510SRong-En Fan><P
4291*4a1a9510SRong-En Fan>Call update_panels() to write the panels to the virtual screen in correct
4292*4a1a9510SRong-En Fanvisibility order. Do a doupdate() to show it on the screen. </P
4293*4a1a9510SRong-En Fan></LI
4294*4a1a9510SRong-En Fan><LI
4295*4a1a9510SRong-En Fan><P
4296*4a1a9510SRong-En Fan>Mainpulate the panels with show_panel(), hide_panel(), move_panel() etc. Make
4297*4a1a9510SRong-En Fanuse of helper functions like panel_hidden() and panel_window(). Make use of user
4298*4a1a9510SRong-En Fanpointer to store custom data for a panel. Use the functions set_panel_userptr()
4299*4a1a9510SRong-En Fanand panel_userptr() to set and get the user pointer for a panel.</P
4300*4a1a9510SRong-En Fan></LI
4301*4a1a9510SRong-En Fan><LI
4302*4a1a9510SRong-En Fan><P
4303*4a1a9510SRong-En Fan>When you are done with the panel use del_panel() to delete the panel.</P
4304*4a1a9510SRong-En Fan></LI
4305*4a1a9510SRong-En Fan></OL
4306*4a1a9510SRong-En Fan></P
4307*4a1a9510SRong-En Fan><P
4308*4a1a9510SRong-En Fan>Let's make the concepts clear, with some programs.  The following is a simple
4309*4a1a9510SRong-En Fanprogram which creates 3 overlapping panels and shows them on the screen. </P
4310*4a1a9510SRong-En Fan></DIV
4311*4a1a9510SRong-En Fan><DIV
4312*4a1a9510SRong-En FanCLASS="SECT2"
4313*4a1a9510SRong-En Fan><HR><H3
4314*4a1a9510SRong-En FanCLASS="SECT2"
4315*4a1a9510SRong-En Fan><A
4316*4a1a9510SRong-En FanNAME="COMPILEPANELS"
4317*4a1a9510SRong-En Fan>16.2. Compiling With the Panels Library</A
4318*4a1a9510SRong-En Fan></H3
4319*4a1a9510SRong-En Fan><P
4320*4a1a9510SRong-En Fan>To use panels library functions, you have to include panel.h and to link the
4321*4a1a9510SRong-En Fanprogram with panels library the flag -lpanel should be added along with
4322*4a1a9510SRong-En Fan-lncurses in that order.</P
4323*4a1a9510SRong-En Fan><PRE
4324*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
4325*4a1a9510SRong-En Fan>    #include &lt;panel.h&gt;
4326*4a1a9510SRong-En Fan    .
4327*4a1a9510SRong-En Fan    .
4328*4a1a9510SRong-En Fan    .
4329*4a1a9510SRong-En Fan
4330*4a1a9510SRong-En Fan    compile and link: gcc &lt;program file&gt; -lpanel -lncurses</PRE
4331*4a1a9510SRong-En Fan><DIV
4332*4a1a9510SRong-En FanCLASS="EXAMPLE"
4333*4a1a9510SRong-En Fan><A
4334*4a1a9510SRong-En FanNAME="PPASI"
4335*4a1a9510SRong-En Fan></A
4336*4a1a9510SRong-En Fan><P
4337*4a1a9510SRong-En Fan><B
4338*4a1a9510SRong-En Fan>Example 14.  Panel basics</B
4339*4a1a9510SRong-En Fan></P
4340*4a1a9510SRong-En Fan><PRE
4341*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
4342*4a1a9510SRong-En Fan><SPAN
4343*4a1a9510SRong-En FanCLASS="INLINEMEDIAOBJECT"
4344*4a1a9510SRong-En Fan>#include &#60;panel.h&#62;
4345*4a1a9510SRong-En Fan
4346*4a1a9510SRong-En Fanint main()
4347*4a1a9510SRong-En Fan{	WINDOW *my_wins[3];
4348*4a1a9510SRong-En Fan	PANEL  *my_panels[3];
4349*4a1a9510SRong-En Fan	int lines = 10, cols = 40, y = 2, x = 4, i;
4350*4a1a9510SRong-En Fan
4351*4a1a9510SRong-En Fan	initscr();
4352*4a1a9510SRong-En Fan	cbreak();
4353*4a1a9510SRong-En Fan	noecho();
4354*4a1a9510SRong-En Fan
4355*4a1a9510SRong-En Fan	/* Create windows for the panels */
4356*4a1a9510SRong-En Fan	my_wins[0] = newwin(lines, cols, y, x);
4357*4a1a9510SRong-En Fan	my_wins[1] = newwin(lines, cols, y + 1, x + 5);
4358*4a1a9510SRong-En Fan	my_wins[2] = newwin(lines, cols, y + 2, x + 10);
4359*4a1a9510SRong-En Fan
4360*4a1a9510SRong-En Fan	/*
4361*4a1a9510SRong-En Fan	 * Create borders around the windows so that you can see the effect
4362*4a1a9510SRong-En Fan	 * of panels
4363*4a1a9510SRong-En Fan	 */
4364*4a1a9510SRong-En Fan	for(i = 0; i &#60; 3; ++i)
4365*4a1a9510SRong-En Fan		box(my_wins[i], 0, 0);
4366*4a1a9510SRong-En Fan
4367*4a1a9510SRong-En Fan	/* Attach a panel to each window */ 	/* Order is bottom up */
4368*4a1a9510SRong-En Fan	my_panels[0] = new_panel(my_wins[0]); 	/* Push 0, order: stdscr-0 */
4369*4a1a9510SRong-En Fan	my_panels[1] = new_panel(my_wins[1]); 	/* Push 1, order: stdscr-0-1 */
4370*4a1a9510SRong-En Fan	my_panels[2] = new_panel(my_wins[2]); 	/* Push 2, order: stdscr-0-1-2 */
4371*4a1a9510SRong-En Fan
4372*4a1a9510SRong-En Fan	/* Update the stacking order. 2nd panel will be on top */
4373*4a1a9510SRong-En Fan	update_panels();
4374*4a1a9510SRong-En Fan
4375*4a1a9510SRong-En Fan	/* Show it on the screen */
4376*4a1a9510SRong-En Fan	doupdate();
4377*4a1a9510SRong-En Fan
4378*4a1a9510SRong-En Fan	getch();
4379*4a1a9510SRong-En Fan	endwin();
4380*4a1a9510SRong-En Fan}
4381*4a1a9510SRong-En Fan</SPAN
4382*4a1a9510SRong-En Fan></PRE
4383*4a1a9510SRong-En Fan></DIV
4384*4a1a9510SRong-En Fan><P
4385*4a1a9510SRong-En Fan>As you can see, above program follows a simple flow as explained. The windows
4386*4a1a9510SRong-En Fanare created with newwin() and then they are attached to panels with new_panel().
4387*4a1a9510SRong-En FanAs we attach one panel after another, the stack of panels gets updated. To put
4388*4a1a9510SRong-En Fanthem on screen update_panels() and doupdate() are called.</P
4389*4a1a9510SRong-En Fan></DIV
4390*4a1a9510SRong-En Fan><DIV
4391*4a1a9510SRong-En FanCLASS="SECT2"
4392*4a1a9510SRong-En Fan><HR><H3
4393*4a1a9510SRong-En FanCLASS="SECT2"
4394*4a1a9510SRong-En Fan><A
4395*4a1a9510SRong-En FanNAME="PANELBROWSING"
4396*4a1a9510SRong-En Fan>16.3. Panel Window Browsing</A
4397*4a1a9510SRong-En Fan></H3
4398*4a1a9510SRong-En Fan><P
4399*4a1a9510SRong-En Fan>A slightly complicated example is given below. This program creates 3
4400*4a1a9510SRong-En Fanwindows which can be cycled through using tab. Have a look at the code.</P
4401*4a1a9510SRong-En Fan><DIV
4402*4a1a9510SRong-En FanCLASS="EXAMPLE"
4403*4a1a9510SRong-En Fan><A
4404*4a1a9510SRong-En FanNAME="PPABR"
4405*4a1a9510SRong-En Fan></A
4406*4a1a9510SRong-En Fan><P
4407*4a1a9510SRong-En Fan><B
4408*4a1a9510SRong-En Fan>Example 15.  Panel Window Browsing Example </B
4409*4a1a9510SRong-En Fan></P
4410*4a1a9510SRong-En Fan><PRE
4411*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
4412*4a1a9510SRong-En Fan><SPAN
4413*4a1a9510SRong-En FanCLASS="INLINEMEDIAOBJECT"
4414*4a1a9510SRong-En Fan>#include &#60;panel.h&#62;
4415*4a1a9510SRong-En Fan
4416*4a1a9510SRong-En Fan#define NLINES 10
4417*4a1a9510SRong-En Fan#define NCOLS 40
4418*4a1a9510SRong-En Fan
4419*4a1a9510SRong-En Fanvoid init_wins(WINDOW **wins, int n);
4420*4a1a9510SRong-En Fanvoid win_show(WINDOW *win, char *label, int label_color);
4421*4a1a9510SRong-En Fanvoid print_in_middle(WINDOW *win, int starty, int startx, int width, char *string, chtype color);
4422*4a1a9510SRong-En Fan
4423*4a1a9510SRong-En Fanint main()
4424*4a1a9510SRong-En Fan{	WINDOW *my_wins[3];
4425*4a1a9510SRong-En Fan	PANEL  *my_panels[3];
4426*4a1a9510SRong-En Fan	PANEL  *top;
4427*4a1a9510SRong-En Fan	int ch;
4428*4a1a9510SRong-En Fan
4429*4a1a9510SRong-En Fan	/* Initialize curses */
4430*4a1a9510SRong-En Fan	initscr();
4431*4a1a9510SRong-En Fan	start_color();
4432*4a1a9510SRong-En Fan	cbreak();
4433*4a1a9510SRong-En Fan	noecho();
4434*4a1a9510SRong-En Fan	keypad(stdscr, TRUE);
4435*4a1a9510SRong-En Fan
4436*4a1a9510SRong-En Fan	/* Initialize all the colors */
4437*4a1a9510SRong-En Fan	init_pair(1, COLOR_RED, COLOR_BLACK);
4438*4a1a9510SRong-En Fan	init_pair(2, COLOR_GREEN, COLOR_BLACK);
4439*4a1a9510SRong-En Fan	init_pair(3, COLOR_BLUE, COLOR_BLACK);
4440*4a1a9510SRong-En Fan	init_pair(4, COLOR_CYAN, COLOR_BLACK);
4441*4a1a9510SRong-En Fan
4442*4a1a9510SRong-En Fan	init_wins(my_wins, 3);
4443*4a1a9510SRong-En Fan
4444*4a1a9510SRong-En Fan	/* Attach a panel to each window */ 	/* Order is bottom up */
4445*4a1a9510SRong-En Fan	my_panels[0] = new_panel(my_wins[0]); 	/* Push 0, order: stdscr-0 */
4446*4a1a9510SRong-En Fan	my_panels[1] = new_panel(my_wins[1]); 	/* Push 1, order: stdscr-0-1 */
4447*4a1a9510SRong-En Fan	my_panels[2] = new_panel(my_wins[2]); 	/* Push 2, order: stdscr-0-1-2 */
4448*4a1a9510SRong-En Fan
4449*4a1a9510SRong-En Fan	/* Set up the user pointers to the next panel */
4450*4a1a9510SRong-En Fan	set_panel_userptr(my_panels[0], my_panels[1]);
4451*4a1a9510SRong-En Fan	set_panel_userptr(my_panels[1], my_panels[2]);
4452*4a1a9510SRong-En Fan	set_panel_userptr(my_panels[2], my_panels[0]);
4453*4a1a9510SRong-En Fan
4454*4a1a9510SRong-En Fan	/* Update the stacking order. 2nd panel will be on top */
4455*4a1a9510SRong-En Fan	update_panels();
4456*4a1a9510SRong-En Fan
4457*4a1a9510SRong-En Fan	/* Show it on the screen */
4458*4a1a9510SRong-En Fan	attron(COLOR_PAIR(4));
4459*4a1a9510SRong-En Fan	mvprintw(LINES - 2, 0, "Use tab to browse through the windows (F1 to Exit)");
4460*4a1a9510SRong-En Fan	attroff(COLOR_PAIR(4));
4461*4a1a9510SRong-En Fan	doupdate();
4462*4a1a9510SRong-En Fan
4463*4a1a9510SRong-En Fan	top = my_panels[2];
4464*4a1a9510SRong-En Fan	while((ch = getch()) != KEY_F(1))
4465*4a1a9510SRong-En Fan	{	switch(ch)
4466*4a1a9510SRong-En Fan		{	case 9:
4467*4a1a9510SRong-En Fan				top = (PANEL *)panel_userptr(top);
4468*4a1a9510SRong-En Fan				top_panel(top);
4469*4a1a9510SRong-En Fan				break;
4470*4a1a9510SRong-En Fan		}
4471*4a1a9510SRong-En Fan		update_panels();
4472*4a1a9510SRong-En Fan		doupdate();
4473*4a1a9510SRong-En Fan	}
4474*4a1a9510SRong-En Fan	endwin();
4475*4a1a9510SRong-En Fan	return 0;
4476*4a1a9510SRong-En Fan}
4477*4a1a9510SRong-En Fan
4478*4a1a9510SRong-En Fan/* Put all the windows */
4479*4a1a9510SRong-En Fanvoid init_wins(WINDOW **wins, int n)
4480*4a1a9510SRong-En Fan{	int x, y, i;
4481*4a1a9510SRong-En Fan	char label[80];
4482*4a1a9510SRong-En Fan
4483*4a1a9510SRong-En Fan	y = 2;
4484*4a1a9510SRong-En Fan	x = 10;
4485*4a1a9510SRong-En Fan	for(i = 0; i &#60; n; ++i)
4486*4a1a9510SRong-En Fan	{	wins[i] = newwin(NLINES, NCOLS, y, x);
4487*4a1a9510SRong-En Fan		sprintf(label, "Window Number %d", i + 1);
4488*4a1a9510SRong-En Fan		win_show(wins[i], label, i + 1);
4489*4a1a9510SRong-En Fan		y += 3;
4490*4a1a9510SRong-En Fan		x += 7;
4491*4a1a9510SRong-En Fan	}
4492*4a1a9510SRong-En Fan}
4493*4a1a9510SRong-En Fan
4494*4a1a9510SRong-En Fan/* Show the window with a border and a label */
4495*4a1a9510SRong-En Fanvoid win_show(WINDOW *win, char *label, int label_color)
4496*4a1a9510SRong-En Fan{	int startx, starty, height, width;
4497*4a1a9510SRong-En Fan
4498*4a1a9510SRong-En Fan	getbegyx(win, starty, startx);
4499*4a1a9510SRong-En Fan	getmaxyx(win, height, width);
4500*4a1a9510SRong-En Fan
4501*4a1a9510SRong-En Fan	box(win, 0, 0);
4502*4a1a9510SRong-En Fan	mvwaddch(win, 2, 0, ACS_LTEE);
4503*4a1a9510SRong-En Fan	mvwhline(win, 2, 1, ACS_HLINE, width - 2);
4504*4a1a9510SRong-En Fan	mvwaddch(win, 2, width - 1, ACS_RTEE);
4505*4a1a9510SRong-En Fan
4506*4a1a9510SRong-En Fan	print_in_middle(win, 1, 0, width, label, COLOR_PAIR(label_color));
4507*4a1a9510SRong-En Fan}
4508*4a1a9510SRong-En Fan
4509*4a1a9510SRong-En Fanvoid print_in_middle(WINDOW *win, int starty, int startx, int width, char *string, chtype color)
4510*4a1a9510SRong-En Fan{	int length, x, y;
4511*4a1a9510SRong-En Fan	float temp;
4512*4a1a9510SRong-En Fan
4513*4a1a9510SRong-En Fan	if(win == NULL)
4514*4a1a9510SRong-En Fan		win = stdscr;
4515*4a1a9510SRong-En Fan	getyx(win, y, x);
4516*4a1a9510SRong-En Fan	if(startx != 0)
4517*4a1a9510SRong-En Fan		x = startx;
4518*4a1a9510SRong-En Fan	if(starty != 0)
4519*4a1a9510SRong-En Fan		y = starty;
4520*4a1a9510SRong-En Fan	if(width == 0)
4521*4a1a9510SRong-En Fan		width = 80;
4522*4a1a9510SRong-En Fan
4523*4a1a9510SRong-En Fan	length = strlen(string);
4524*4a1a9510SRong-En Fan	temp = (width - length)/ 2;
4525*4a1a9510SRong-En Fan	x = startx + (int)temp;
4526*4a1a9510SRong-En Fan	wattron(win, color);
4527*4a1a9510SRong-En Fan	mvwprintw(win, y, x, "%s", string);
4528*4a1a9510SRong-En Fan	wattroff(win, color);
4529*4a1a9510SRong-En Fan	refresh();
4530*4a1a9510SRong-En Fan}</SPAN
4531*4a1a9510SRong-En Fan></PRE
4532*4a1a9510SRong-En Fan></DIV
4533*4a1a9510SRong-En Fan></DIV
4534*4a1a9510SRong-En Fan><DIV
4535*4a1a9510SRong-En FanCLASS="SECT2"
4536*4a1a9510SRong-En Fan><HR><H3
4537*4a1a9510SRong-En FanCLASS="SECT2"
4538*4a1a9510SRong-En Fan><A
4539*4a1a9510SRong-En FanNAME="USERPTRUSING"
4540*4a1a9510SRong-En Fan>16.4. Using User Pointers</A
4541*4a1a9510SRong-En Fan></H3
4542*4a1a9510SRong-En Fan><P
4543*4a1a9510SRong-En Fan>In the above example I used user pointers to find out the next window in the
4544*4a1a9510SRong-En Fancycle.  We can attach custom information to the panel by specifying a user
4545*4a1a9510SRong-En Fanpointer, which can point to any information you want to store. In this case I
4546*4a1a9510SRong-En Fanstored the pointer to the next panel in the cycle. User pointer for a panel can
4547*4a1a9510SRong-En Fanbe set with the function <TT
4548*4a1a9510SRong-En FanCLASS="LITERAL"
4549*4a1a9510SRong-En Fan> set_panel_userptr()</TT
4550*4a1a9510SRong-En Fan>.
4551*4a1a9510SRong-En FanIt can be accessed using the function <TT
4552*4a1a9510SRong-En FanCLASS="LITERAL"
4553*4a1a9510SRong-En Fan>panel_userptr()</TT
4554*4a1a9510SRong-En Fan> which will return the user pointer for the panel given as
4555*4a1a9510SRong-En Fanargument. After finding the next panel in the cycle It's brought to the top by
4556*4a1a9510SRong-En Fanthe function top_panel().  This function brings the panel given as argument to
4557*4a1a9510SRong-En Fanthe top of the panel stack.  </P
4558*4a1a9510SRong-En Fan></DIV
4559*4a1a9510SRong-En Fan><DIV
4560*4a1a9510SRong-En FanCLASS="SECT2"
4561*4a1a9510SRong-En Fan><HR><H3
4562*4a1a9510SRong-En FanCLASS="SECT2"
4563*4a1a9510SRong-En Fan><A
4564*4a1a9510SRong-En FanNAME="PANELMOVERESIZE"
4565*4a1a9510SRong-En Fan>16.5. Moving and Resizing Panels</A
4566*4a1a9510SRong-En Fan></H3
4567*4a1a9510SRong-En Fan><P
4568*4a1a9510SRong-En Fan>The function <TT
4569*4a1a9510SRong-En FanCLASS="LITERAL"
4570*4a1a9510SRong-En Fan>move_panel()</TT
4571*4a1a9510SRong-En Fan> can be used to move a
4572*4a1a9510SRong-En Fanpanel to the desired location. It does not change the position of the panel in
4573*4a1a9510SRong-En Fanthe stack. Make sure that you use move_panel() instead mvwin() on the window
4574*4a1a9510SRong-En Fanassociated with the panel.</P
4575*4a1a9510SRong-En Fan><P
4576*4a1a9510SRong-En Fan>Resizing a panel is slightly complex.  There is no straight forward function
4577*4a1a9510SRong-En Fanjust to resize the window associated with a panel. A solution to resize a panel
4578*4a1a9510SRong-En Fanis to create a new window with the desired sizes, change the window associated
4579*4a1a9510SRong-En Fanwith the panel using replace_panel(). Don't forget to delete the old window. The
4580*4a1a9510SRong-En Fanwindow associated with a panel can be found by using the function
4581*4a1a9510SRong-En Fanpanel_window().</P
4582*4a1a9510SRong-En Fan><P
4583*4a1a9510SRong-En Fan>The following program shows these concepts, in supposedly simple program. You
4584*4a1a9510SRong-En Fancan cycle through the window with &lt;TAB&gt; as usual. To resize or move the
4585*4a1a9510SRong-En Fanactive panel press 'r' for resize 'm' for moving. Then use arrow keys to resize
4586*4a1a9510SRong-En Fanor move it to the desired way and press enter to end your resizing or moving.
4587*4a1a9510SRong-En FanThis example makes use of user data to get the required data to do the
4588*4a1a9510SRong-En Fanoperations. </P
4589*4a1a9510SRong-En Fan><DIV
4590*4a1a9510SRong-En FanCLASS="EXAMPLE"
4591*4a1a9510SRong-En Fan><A
4592*4a1a9510SRong-En FanNAME="PPARE"
4593*4a1a9510SRong-En Fan></A
4594*4a1a9510SRong-En Fan><P
4595*4a1a9510SRong-En Fan><B
4596*4a1a9510SRong-En Fan>Example 16.  Panel Moving and Resizing example </B
4597*4a1a9510SRong-En Fan></P
4598*4a1a9510SRong-En Fan><PRE
4599*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
4600*4a1a9510SRong-En Fan><SPAN
4601*4a1a9510SRong-En FanCLASS="INLINEMEDIAOBJECT"
4602*4a1a9510SRong-En Fan>#include &#60;panel.h&#62;
4603*4a1a9510SRong-En Fan
4604*4a1a9510SRong-En Fantypedef struct _PANEL_DATA {
4605*4a1a9510SRong-En Fan	int x, y, w, h;
4606*4a1a9510SRong-En Fan	char label[80];
4607*4a1a9510SRong-En Fan	int label_color;
4608*4a1a9510SRong-En Fan	PANEL *next;
4609*4a1a9510SRong-En Fan}PANEL_DATA;
4610*4a1a9510SRong-En Fan
4611*4a1a9510SRong-En Fan#define NLINES 10
4612*4a1a9510SRong-En Fan#define NCOLS 40
4613*4a1a9510SRong-En Fan
4614*4a1a9510SRong-En Fanvoid init_wins(WINDOW **wins, int n);
4615*4a1a9510SRong-En Fanvoid win_show(WINDOW *win, char *label, int label_color);
4616*4a1a9510SRong-En Fanvoid print_in_middle(WINDOW *win, int starty, int startx, int width, char *string, chtype color);
4617*4a1a9510SRong-En Fanvoid set_user_ptrs(PANEL **panels, int n);
4618*4a1a9510SRong-En Fan
4619*4a1a9510SRong-En Fanint main()
4620*4a1a9510SRong-En Fan{	WINDOW *my_wins[3];
4621*4a1a9510SRong-En Fan	PANEL  *my_panels[3];
4622*4a1a9510SRong-En Fan	PANEL_DATA  *top;
4623*4a1a9510SRong-En Fan	PANEL *stack_top;
4624*4a1a9510SRong-En Fan	WINDOW *temp_win, *old_win;
4625*4a1a9510SRong-En Fan	int ch;
4626*4a1a9510SRong-En Fan	int newx, newy, neww, newh;
4627*4a1a9510SRong-En Fan	int size = FALSE, move = FALSE;
4628*4a1a9510SRong-En Fan
4629*4a1a9510SRong-En Fan	/* Initialize curses */
4630*4a1a9510SRong-En Fan	initscr();
4631*4a1a9510SRong-En Fan	start_color();
4632*4a1a9510SRong-En Fan	cbreak();
4633*4a1a9510SRong-En Fan	noecho();
4634*4a1a9510SRong-En Fan	keypad(stdscr, TRUE);
4635*4a1a9510SRong-En Fan
4636*4a1a9510SRong-En Fan	/* Initialize all the colors */
4637*4a1a9510SRong-En Fan	init_pair(1, COLOR_RED, COLOR_BLACK);
4638*4a1a9510SRong-En Fan	init_pair(2, COLOR_GREEN, COLOR_BLACK);
4639*4a1a9510SRong-En Fan	init_pair(3, COLOR_BLUE, COLOR_BLACK);
4640*4a1a9510SRong-En Fan	init_pair(4, COLOR_CYAN, COLOR_BLACK);
4641*4a1a9510SRong-En Fan
4642*4a1a9510SRong-En Fan	init_wins(my_wins, 3);
4643*4a1a9510SRong-En Fan
4644*4a1a9510SRong-En Fan	/* Attach a panel to each window */ 	/* Order is bottom up */
4645*4a1a9510SRong-En Fan	my_panels[0] = new_panel(my_wins[0]); 	/* Push 0, order: stdscr-0 */
4646*4a1a9510SRong-En Fan	my_panels[1] = new_panel(my_wins[1]); 	/* Push 1, order: stdscr-0-1 */
4647*4a1a9510SRong-En Fan	my_panels[2] = new_panel(my_wins[2]); 	/* Push 2, order: stdscr-0-1-2 */
4648*4a1a9510SRong-En Fan
4649*4a1a9510SRong-En Fan	set_user_ptrs(my_panels, 3);
4650*4a1a9510SRong-En Fan	/* Update the stacking order. 2nd panel will be on top */
4651*4a1a9510SRong-En Fan	update_panels();
4652*4a1a9510SRong-En Fan
4653*4a1a9510SRong-En Fan	/* Show it on the screen */
4654*4a1a9510SRong-En Fan	attron(COLOR_PAIR(4));
4655*4a1a9510SRong-En Fan	mvprintw(LINES - 3, 0, "Use 'm' for moving, 'r' for resizing");
4656*4a1a9510SRong-En Fan	mvprintw(LINES - 2, 0, "Use tab to browse through the windows (F1 to Exit)");
4657*4a1a9510SRong-En Fan	attroff(COLOR_PAIR(4));
4658*4a1a9510SRong-En Fan	doupdate();
4659*4a1a9510SRong-En Fan
4660*4a1a9510SRong-En Fan	stack_top = my_panels[2];
4661*4a1a9510SRong-En Fan	top = (PANEL_DATA *)panel_userptr(stack_top);
4662*4a1a9510SRong-En Fan	newx = top-&#62;x;
4663*4a1a9510SRong-En Fan	newy = top-&#62;y;
4664*4a1a9510SRong-En Fan	neww = top-&#62;w;
4665*4a1a9510SRong-En Fan	newh = top-&#62;h;
4666*4a1a9510SRong-En Fan	while((ch = getch()) != KEY_F(1))
4667*4a1a9510SRong-En Fan	{	switch(ch)
4668*4a1a9510SRong-En Fan		{	case 9:		/* Tab */
4669*4a1a9510SRong-En Fan				top = (PANEL_DATA *)panel_userptr(stack_top);
4670*4a1a9510SRong-En Fan				top_panel(top-&#62;next);
4671*4a1a9510SRong-En Fan				stack_top = top-&#62;next;
4672*4a1a9510SRong-En Fan				top = (PANEL_DATA *)panel_userptr(stack_top);
4673*4a1a9510SRong-En Fan				newx = top-&#62;x;
4674*4a1a9510SRong-En Fan				newy = top-&#62;y;
4675*4a1a9510SRong-En Fan				neww = top-&#62;w;
4676*4a1a9510SRong-En Fan				newh = top-&#62;h;
4677*4a1a9510SRong-En Fan				break;
4678*4a1a9510SRong-En Fan			case 'r':	/* Re-Size*/
4679*4a1a9510SRong-En Fan				size = TRUE;
4680*4a1a9510SRong-En Fan				attron(COLOR_PAIR(4));
4681*4a1a9510SRong-En Fan				mvprintw(LINES - 4, 0, "Entered Resizing :Use Arrow Keys to resize and press &#60;ENTER&#62; to end resizing");
4682*4a1a9510SRong-En Fan				refresh();
4683*4a1a9510SRong-En Fan				attroff(COLOR_PAIR(4));
4684*4a1a9510SRong-En Fan				break;
4685*4a1a9510SRong-En Fan			case 'm':	/* Move */
4686*4a1a9510SRong-En Fan				attron(COLOR_PAIR(4));
4687*4a1a9510SRong-En Fan				mvprintw(LINES - 4, 0, "Entered Moving: Use Arrow Keys to Move and press &#60;ENTER&#62; to end moving");
4688*4a1a9510SRong-En Fan				refresh();
4689*4a1a9510SRong-En Fan				attroff(COLOR_PAIR(4));
4690*4a1a9510SRong-En Fan				move = TRUE;
4691*4a1a9510SRong-En Fan				break;
4692*4a1a9510SRong-En Fan			case KEY_LEFT:
4693*4a1a9510SRong-En Fan				if(size == TRUE)
4694*4a1a9510SRong-En Fan				{	--newx;
4695*4a1a9510SRong-En Fan					++neww;
4696*4a1a9510SRong-En Fan				}
4697*4a1a9510SRong-En Fan				if(move == TRUE)
4698*4a1a9510SRong-En Fan					--newx;
4699*4a1a9510SRong-En Fan				break;
4700*4a1a9510SRong-En Fan			case KEY_RIGHT:
4701*4a1a9510SRong-En Fan				if(size == TRUE)
4702*4a1a9510SRong-En Fan				{	++newx;
4703*4a1a9510SRong-En Fan					--neww;
4704*4a1a9510SRong-En Fan				}
4705*4a1a9510SRong-En Fan				if(move == TRUE)
4706*4a1a9510SRong-En Fan					++newx;
4707*4a1a9510SRong-En Fan				break;
4708*4a1a9510SRong-En Fan			case KEY_UP:
4709*4a1a9510SRong-En Fan				if(size == TRUE)
4710*4a1a9510SRong-En Fan				{	--newy;
4711*4a1a9510SRong-En Fan					++newh;
4712*4a1a9510SRong-En Fan				}
4713*4a1a9510SRong-En Fan				if(move == TRUE)
4714*4a1a9510SRong-En Fan					--newy;
4715*4a1a9510SRong-En Fan				break;
4716*4a1a9510SRong-En Fan			case KEY_DOWN:
4717*4a1a9510SRong-En Fan				if(size == TRUE)
4718*4a1a9510SRong-En Fan				{	++newy;
4719*4a1a9510SRong-En Fan					--newh;
4720*4a1a9510SRong-En Fan				}
4721*4a1a9510SRong-En Fan				if(move == TRUE)
4722*4a1a9510SRong-En Fan					++newy;
4723*4a1a9510SRong-En Fan				break;
4724*4a1a9510SRong-En Fan			case 10:	/* Enter */
4725*4a1a9510SRong-En Fan				move(LINES - 4, 0);
4726*4a1a9510SRong-En Fan				clrtoeol();
4727*4a1a9510SRong-En Fan				refresh();
4728*4a1a9510SRong-En Fan				if(size == TRUE)
4729*4a1a9510SRong-En Fan				{	old_win = panel_window(stack_top);
4730*4a1a9510SRong-En Fan					temp_win = newwin(newh, neww, newy, newx);
4731*4a1a9510SRong-En Fan					replace_panel(stack_top, temp_win);
4732*4a1a9510SRong-En Fan					win_show(temp_win, top-&#62;label, top-&#62;label_color);
4733*4a1a9510SRong-En Fan					delwin(old_win);
4734*4a1a9510SRong-En Fan					size = FALSE;
4735*4a1a9510SRong-En Fan				}
4736*4a1a9510SRong-En Fan				if(move == TRUE)
4737*4a1a9510SRong-En Fan				{	move_panel(stack_top, newy, newx);
4738*4a1a9510SRong-En Fan					move = FALSE;
4739*4a1a9510SRong-En Fan				}
4740*4a1a9510SRong-En Fan				break;
4741*4a1a9510SRong-En Fan
4742*4a1a9510SRong-En Fan		}
4743*4a1a9510SRong-En Fan		attron(COLOR_PAIR(4));
4744*4a1a9510SRong-En Fan		mvprintw(LINES - 3, 0, "Use 'm' for moving, 'r' for resizing");
4745*4a1a9510SRong-En Fan	    	mvprintw(LINES - 2, 0, "Use tab to browse through the windows (F1 to Exit)");
4746*4a1a9510SRong-En Fan	    	attroff(COLOR_PAIR(4));
4747*4a1a9510SRong-En Fan	        refresh();
4748*4a1a9510SRong-En Fan		update_panels();
4749*4a1a9510SRong-En Fan		doupdate();
4750*4a1a9510SRong-En Fan	}
4751*4a1a9510SRong-En Fan	endwin();
4752*4a1a9510SRong-En Fan	return 0;
4753*4a1a9510SRong-En Fan}
4754*4a1a9510SRong-En Fan
4755*4a1a9510SRong-En Fan/* Put all the windows */
4756*4a1a9510SRong-En Fanvoid init_wins(WINDOW **wins, int n)
4757*4a1a9510SRong-En Fan{	int x, y, i;
4758*4a1a9510SRong-En Fan	char label[80];
4759*4a1a9510SRong-En Fan
4760*4a1a9510SRong-En Fan	y = 2;
4761*4a1a9510SRong-En Fan	x = 10;
4762*4a1a9510SRong-En Fan	for(i = 0; i &#60; n; ++i)
4763*4a1a9510SRong-En Fan	{	wins[i] = newwin(NLINES, NCOLS, y, x);
4764*4a1a9510SRong-En Fan		sprintf(label, "Window Number %d", i + 1);
4765*4a1a9510SRong-En Fan		win_show(wins[i], label, i + 1);
4766*4a1a9510SRong-En Fan		y += 3;
4767*4a1a9510SRong-En Fan		x += 7;
4768*4a1a9510SRong-En Fan	}
4769*4a1a9510SRong-En Fan}
4770*4a1a9510SRong-En Fan
4771*4a1a9510SRong-En Fan/* Set the PANEL_DATA structures for individual panels */
4772*4a1a9510SRong-En Fanvoid set_user_ptrs(PANEL **panels, int n)
4773*4a1a9510SRong-En Fan{	PANEL_DATA *ptrs;
4774*4a1a9510SRong-En Fan	WINDOW *win;
4775*4a1a9510SRong-En Fan	int x, y, w, h, i;
4776*4a1a9510SRong-En Fan	char temp[80];
4777*4a1a9510SRong-En Fan
4778*4a1a9510SRong-En Fan	ptrs = (PANEL_DATA *)calloc(n, sizeof(PANEL_DATA));
4779*4a1a9510SRong-En Fan
4780*4a1a9510SRong-En Fan	for(i = 0;i &#60; n; ++i)
4781*4a1a9510SRong-En Fan	{	win = panel_window(panels[i]);
4782*4a1a9510SRong-En Fan		getbegyx(win, y, x);
4783*4a1a9510SRong-En Fan		getmaxyx(win, h, w);
4784*4a1a9510SRong-En Fan		ptrs[i].x = x;
4785*4a1a9510SRong-En Fan		ptrs[i].y = y;
4786*4a1a9510SRong-En Fan		ptrs[i].w = w;
4787*4a1a9510SRong-En Fan		ptrs[i].h = h;
4788*4a1a9510SRong-En Fan		sprintf(temp, "Window Number %d", i + 1);
4789*4a1a9510SRong-En Fan		strcpy(ptrs[i].label, temp);
4790*4a1a9510SRong-En Fan		ptrs[i].label_color = i + 1;
4791*4a1a9510SRong-En Fan		if(i + 1 == n)
4792*4a1a9510SRong-En Fan			ptrs[i].next = panels[0];
4793*4a1a9510SRong-En Fan		else
4794*4a1a9510SRong-En Fan			ptrs[i].next = panels[i + 1];
4795*4a1a9510SRong-En Fan		set_panel_userptr(panels[i], &#38;ptrs[i]);
4796*4a1a9510SRong-En Fan	}
4797*4a1a9510SRong-En Fan}
4798*4a1a9510SRong-En Fan
4799*4a1a9510SRong-En Fan/* Show the window with a border and a label */
4800*4a1a9510SRong-En Fanvoid win_show(WINDOW *win, char *label, int label_color)
4801*4a1a9510SRong-En Fan{	int startx, starty, height, width;
4802*4a1a9510SRong-En Fan
4803*4a1a9510SRong-En Fan	getbegyx(win, starty, startx);
4804*4a1a9510SRong-En Fan	getmaxyx(win, height, width);
4805*4a1a9510SRong-En Fan
4806*4a1a9510SRong-En Fan	box(win, 0, 0);
4807*4a1a9510SRong-En Fan	mvwaddch(win, 2, 0, ACS_LTEE);
4808*4a1a9510SRong-En Fan	mvwhline(win, 2, 1, ACS_HLINE, width - 2);
4809*4a1a9510SRong-En Fan	mvwaddch(win, 2, width - 1, ACS_RTEE);
4810*4a1a9510SRong-En Fan
4811*4a1a9510SRong-En Fan	print_in_middle(win, 1, 0, width, label, COLOR_PAIR(label_color));
4812*4a1a9510SRong-En Fan}
4813*4a1a9510SRong-En Fan
4814*4a1a9510SRong-En Fanvoid print_in_middle(WINDOW *win, int starty, int startx, int width, char *string, chtype color)
4815*4a1a9510SRong-En Fan{	int length, x, y;
4816*4a1a9510SRong-En Fan	float temp;
4817*4a1a9510SRong-En Fan
4818*4a1a9510SRong-En Fan	if(win == NULL)
4819*4a1a9510SRong-En Fan		win = stdscr;
4820*4a1a9510SRong-En Fan	getyx(win, y, x);
4821*4a1a9510SRong-En Fan	if(startx != 0)
4822*4a1a9510SRong-En Fan		x = startx;
4823*4a1a9510SRong-En Fan	if(starty != 0)
4824*4a1a9510SRong-En Fan		y = starty;
4825*4a1a9510SRong-En Fan	if(width == 0)
4826*4a1a9510SRong-En Fan		width = 80;
4827*4a1a9510SRong-En Fan
4828*4a1a9510SRong-En Fan	length = strlen(string);
4829*4a1a9510SRong-En Fan	temp = (width - length)/ 2;
4830*4a1a9510SRong-En Fan	x = startx + (int)temp;
4831*4a1a9510SRong-En Fan	wattron(win, color);
4832*4a1a9510SRong-En Fan	mvwprintw(win, y, x, "%s", string);
4833*4a1a9510SRong-En Fan	wattroff(win, color);
4834*4a1a9510SRong-En Fan	refresh();
4835*4a1a9510SRong-En Fan}</SPAN
4836*4a1a9510SRong-En Fan></PRE
4837*4a1a9510SRong-En Fan></DIV
4838*4a1a9510SRong-En Fan><P
4839*4a1a9510SRong-En Fan>Concentrate on the main while loop. Once it finds out the type of key pressed,
4840*4a1a9510SRong-En Fanit takes appropriate action. If 'r' is pressed resizing mode is started. After
4841*4a1a9510SRong-En Fanthis the new sizes are updated as the user presses the arrow keys. When the user
4842*4a1a9510SRong-En Fanpresses &lt;ENTER&gt; present selection ends and panel is resized by using the
4843*4a1a9510SRong-En Fanconcept explained.  While in resizing mode the program doesn't show how the
4844*4a1a9510SRong-En Fanwindow is getting resized.  It's left as an exercise to the reader to print a
4845*4a1a9510SRong-En Fandotted border while it gets resized to a new position. </P
4846*4a1a9510SRong-En Fan><P
4847*4a1a9510SRong-En Fan>When the user presses 'm' the move mode starts. This is a bit simpler than
4848*4a1a9510SRong-En Fanresizing.  As the arrow keys are pressed the new position is updated and
4849*4a1a9510SRong-En Fanpressing of &lt;ENTER&gt; causes the panel to be moved by calling the function
4850*4a1a9510SRong-En Fanmove_panel().</P
4851*4a1a9510SRong-En Fan><P
4852*4a1a9510SRong-En Fan>In this program the user data which is represented as PANEL_DATA, plays very
4853*4a1a9510SRong-En Fanimportant role in finding the associated information with a panel. As written in
4854*4a1a9510SRong-En Fanthe comments, the PANEL_DATA stores the panel sizes, label, label color and a
4855*4a1a9510SRong-En Fanpointer to the next panel in the cycle.</P
4856*4a1a9510SRong-En Fan></DIV
4857*4a1a9510SRong-En Fan><DIV
4858*4a1a9510SRong-En FanCLASS="SECT2"
4859*4a1a9510SRong-En Fan><HR><H3
4860*4a1a9510SRong-En FanCLASS="SECT2"
4861*4a1a9510SRong-En Fan><A
4862*4a1a9510SRong-En FanNAME="PANELSHOWHIDE"
4863*4a1a9510SRong-En Fan>16.6. Hiding and Showing Panels</A
4864*4a1a9510SRong-En Fan></H3
4865*4a1a9510SRong-En Fan><P
4866*4a1a9510SRong-En Fan>A Panel can be hidden by using the function hide_panel(). This function merely
4867*4a1a9510SRong-En Fanremoves it form the stack of panels, thus hiding it on the screen once you do
4868*4a1a9510SRong-En Fanupdate_panels() and doupdate(). It doesn't destroy the PANEL structure
4869*4a1a9510SRong-En Fanassociated with the hidden panel.  It can be shown again by using the
4870*4a1a9510SRong-En Fanshow_panel() function.</P
4871*4a1a9510SRong-En Fan><P
4872*4a1a9510SRong-En Fan>The following program shows the hiding of panels. Press 'a' or 'b' or 'c' to
4873*4a1a9510SRong-En Fanshow or hide first, second and third windows respectively. It uses a user data
4874*4a1a9510SRong-En Fanwith a small variable hide, which keeps track of whether the window is hidden or
4875*4a1a9510SRong-En Fannot. For some reason the function
4876*4a1a9510SRong-En Fan<TT
4877*4a1a9510SRong-En FanCLASS="LITERAL"
4878*4a1a9510SRong-En Fan>panel_hidden()</TT
4879*4a1a9510SRong-En Fan> which tells whether a panel is
4880*4a1a9510SRong-En Fanhidden or not is not working.  A bug report was also presented by Michael Andres
4881*4a1a9510SRong-En Fan<A
4882*4a1a9510SRong-En FanHREF="http://www.geocrawler.com/archives/3/344/1999/9/0/2643549/"
4883*4a1a9510SRong-En FanTARGET="_top"
4884*4a1a9510SRong-En Fan> here</A
4885*4a1a9510SRong-En Fan></P
4886*4a1a9510SRong-En Fan><DIV
4887*4a1a9510SRong-En FanCLASS="EXAMPLE"
4888*4a1a9510SRong-En Fan><A
4889*4a1a9510SRong-En FanNAME="PPAHI"
4890*4a1a9510SRong-En Fan></A
4891*4a1a9510SRong-En Fan><P
4892*4a1a9510SRong-En Fan><B
4893*4a1a9510SRong-En Fan>Example 17.  Panel Hiding and Showing example </B
4894*4a1a9510SRong-En Fan></P
4895*4a1a9510SRong-En Fan><PRE
4896*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
4897*4a1a9510SRong-En Fan><SPAN
4898*4a1a9510SRong-En FanCLASS="INLINEMEDIAOBJECT"
4899*4a1a9510SRong-En Fan>#include &#60;panel.h&#62;
4900*4a1a9510SRong-En Fan
4901*4a1a9510SRong-En Fantypedef struct _PANEL_DATA {
4902*4a1a9510SRong-En Fan	int hide;	/* TRUE if panel is hidden */
4903*4a1a9510SRong-En Fan}PANEL_DATA;
4904*4a1a9510SRong-En Fan
4905*4a1a9510SRong-En Fan#define NLINES 10
4906*4a1a9510SRong-En Fan#define NCOLS 40
4907*4a1a9510SRong-En Fan
4908*4a1a9510SRong-En Fanvoid init_wins(WINDOW **wins, int n);
4909*4a1a9510SRong-En Fanvoid win_show(WINDOW *win, char *label, int label_color);
4910*4a1a9510SRong-En Fanvoid print_in_middle(WINDOW *win, int starty, int startx, int width, char *string, chtype color);
4911*4a1a9510SRong-En Fan
4912*4a1a9510SRong-En Fanint main()
4913*4a1a9510SRong-En Fan{	WINDOW *my_wins[3];
4914*4a1a9510SRong-En Fan	PANEL  *my_panels[3];
4915*4a1a9510SRong-En Fan	PANEL_DATA panel_datas[3];
4916*4a1a9510SRong-En Fan	PANEL_DATA *temp;
4917*4a1a9510SRong-En Fan	int ch;
4918*4a1a9510SRong-En Fan
4919*4a1a9510SRong-En Fan	/* Initialize curses */
4920*4a1a9510SRong-En Fan	initscr();
4921*4a1a9510SRong-En Fan	start_color();
4922*4a1a9510SRong-En Fan	cbreak();
4923*4a1a9510SRong-En Fan	noecho();
4924*4a1a9510SRong-En Fan	keypad(stdscr, TRUE);
4925*4a1a9510SRong-En Fan
4926*4a1a9510SRong-En Fan	/* Initialize all the colors */
4927*4a1a9510SRong-En Fan	init_pair(1, COLOR_RED, COLOR_BLACK);
4928*4a1a9510SRong-En Fan	init_pair(2, COLOR_GREEN, COLOR_BLACK);
4929*4a1a9510SRong-En Fan	init_pair(3, COLOR_BLUE, COLOR_BLACK);
4930*4a1a9510SRong-En Fan	init_pair(4, COLOR_CYAN, COLOR_BLACK);
4931*4a1a9510SRong-En Fan
4932*4a1a9510SRong-En Fan	init_wins(my_wins, 3);
4933*4a1a9510SRong-En Fan
4934*4a1a9510SRong-En Fan	/* Attach a panel to each window */ 	/* Order is bottom up */
4935*4a1a9510SRong-En Fan	my_panels[0] = new_panel(my_wins[0]); 	/* Push 0, order: stdscr-0 */
4936*4a1a9510SRong-En Fan	my_panels[1] = new_panel(my_wins[1]); 	/* Push 1, order: stdscr-0-1 */
4937*4a1a9510SRong-En Fan	my_panels[2] = new_panel(my_wins[2]); 	/* Push 2, order: stdscr-0-1-2 */
4938*4a1a9510SRong-En Fan
4939*4a1a9510SRong-En Fan	/* Initialize panel datas saying that nothing is hidden */
4940*4a1a9510SRong-En Fan	panel_datas[0].hide = FALSE;
4941*4a1a9510SRong-En Fan	panel_datas[1].hide = FALSE;
4942*4a1a9510SRong-En Fan	panel_datas[2].hide = FALSE;
4943*4a1a9510SRong-En Fan
4944*4a1a9510SRong-En Fan	set_panel_userptr(my_panels[0], &#38;panel_datas[0]);
4945*4a1a9510SRong-En Fan	set_panel_userptr(my_panels[1], &#38;panel_datas[1]);
4946*4a1a9510SRong-En Fan	set_panel_userptr(my_panels[2], &#38;panel_datas[2]);
4947*4a1a9510SRong-En Fan
4948*4a1a9510SRong-En Fan	/* Update the stacking order. 2nd panel will be on top */
4949*4a1a9510SRong-En Fan	update_panels();
4950*4a1a9510SRong-En Fan
4951*4a1a9510SRong-En Fan	/* Show it on the screen */
4952*4a1a9510SRong-En Fan	attron(COLOR_PAIR(4));
4953*4a1a9510SRong-En Fan	mvprintw(LINES - 3, 0, "Show or Hide a window with 'a'(first window)  'b'(Second Window)  'c'(Third Window)");
4954*4a1a9510SRong-En Fan	mvprintw(LINES - 2, 0, "F1 to Exit");
4955*4a1a9510SRong-En Fan
4956*4a1a9510SRong-En Fan	attroff(COLOR_PAIR(4));
4957*4a1a9510SRong-En Fan	doupdate();
4958*4a1a9510SRong-En Fan
4959*4a1a9510SRong-En Fan	while((ch = getch()) != KEY_F(1))
4960*4a1a9510SRong-En Fan	{	switch(ch)
4961*4a1a9510SRong-En Fan		{	case 'a':
4962*4a1a9510SRong-En Fan				temp = (PANEL_DATA *)panel_userptr(my_panels[0]);
4963*4a1a9510SRong-En Fan				if(temp-&#62;hide == FALSE)
4964*4a1a9510SRong-En Fan				{	hide_panel(my_panels[0]);
4965*4a1a9510SRong-En Fan					temp-&#62;hide = TRUE;
4966*4a1a9510SRong-En Fan				}
4967*4a1a9510SRong-En Fan				else
4968*4a1a9510SRong-En Fan				{	show_panel(my_panels[0]);
4969*4a1a9510SRong-En Fan					temp-&#62;hide = FALSE;
4970*4a1a9510SRong-En Fan				}
4971*4a1a9510SRong-En Fan				break;
4972*4a1a9510SRong-En Fan			case 'b':
4973*4a1a9510SRong-En Fan				temp = (PANEL_DATA *)panel_userptr(my_panels[1]);
4974*4a1a9510SRong-En Fan				if(temp-&#62;hide == FALSE)
4975*4a1a9510SRong-En Fan				{	hide_panel(my_panels[1]);
4976*4a1a9510SRong-En Fan					temp-&#62;hide = TRUE;
4977*4a1a9510SRong-En Fan				}
4978*4a1a9510SRong-En Fan				else
4979*4a1a9510SRong-En Fan				{	show_panel(my_panels[1]);
4980*4a1a9510SRong-En Fan					temp-&#62;hide = FALSE;
4981*4a1a9510SRong-En Fan				}
4982*4a1a9510SRong-En Fan				break;
4983*4a1a9510SRong-En Fan			case 'c':
4984*4a1a9510SRong-En Fan				temp = (PANEL_DATA *)panel_userptr(my_panels[2]);
4985*4a1a9510SRong-En Fan				if(temp-&#62;hide == FALSE)
4986*4a1a9510SRong-En Fan				{	hide_panel(my_panels[2]);
4987*4a1a9510SRong-En Fan					temp-&#62;hide = TRUE;
4988*4a1a9510SRong-En Fan				}
4989*4a1a9510SRong-En Fan				else
4990*4a1a9510SRong-En Fan				{	show_panel(my_panels[2]);
4991*4a1a9510SRong-En Fan					temp-&#62;hide = FALSE;
4992*4a1a9510SRong-En Fan				}
4993*4a1a9510SRong-En Fan				break;
4994*4a1a9510SRong-En Fan		}
4995*4a1a9510SRong-En Fan		update_panels();
4996*4a1a9510SRong-En Fan		doupdate();
4997*4a1a9510SRong-En Fan	}
4998*4a1a9510SRong-En Fan	endwin();
4999*4a1a9510SRong-En Fan	return 0;
5000*4a1a9510SRong-En Fan}
5001*4a1a9510SRong-En Fan
5002*4a1a9510SRong-En Fan/* Put all the windows */
5003*4a1a9510SRong-En Fanvoid init_wins(WINDOW **wins, int n)
5004*4a1a9510SRong-En Fan{	int x, y, i;
5005*4a1a9510SRong-En Fan	char label[80];
5006*4a1a9510SRong-En Fan
5007*4a1a9510SRong-En Fan	y = 2;
5008*4a1a9510SRong-En Fan	x = 10;
5009*4a1a9510SRong-En Fan	for(i = 0; i &#60; n; ++i)
5010*4a1a9510SRong-En Fan	{	wins[i] = newwin(NLINES, NCOLS, y, x);
5011*4a1a9510SRong-En Fan		sprintf(label, "Window Number %d", i + 1);
5012*4a1a9510SRong-En Fan		win_show(wins[i], label, i + 1);
5013*4a1a9510SRong-En Fan		y += 3;
5014*4a1a9510SRong-En Fan		x += 7;
5015*4a1a9510SRong-En Fan	}
5016*4a1a9510SRong-En Fan}
5017*4a1a9510SRong-En Fan
5018*4a1a9510SRong-En Fan/* Show the window with a border and a label */
5019*4a1a9510SRong-En Fanvoid win_show(WINDOW *win, char *label, int label_color)
5020*4a1a9510SRong-En Fan{	int startx, starty, height, width;
5021*4a1a9510SRong-En Fan
5022*4a1a9510SRong-En Fan	getbegyx(win, starty, startx);
5023*4a1a9510SRong-En Fan	getmaxyx(win, height, width);
5024*4a1a9510SRong-En Fan
5025*4a1a9510SRong-En Fan	box(win, 0, 0);
5026*4a1a9510SRong-En Fan	mvwaddch(win, 2, 0, ACS_LTEE);
5027*4a1a9510SRong-En Fan	mvwhline(win, 2, 1, ACS_HLINE, width - 2);
5028*4a1a9510SRong-En Fan	mvwaddch(win, 2, width - 1, ACS_RTEE);
5029*4a1a9510SRong-En Fan
5030*4a1a9510SRong-En Fan	print_in_middle(win, 1, 0, width, label, COLOR_PAIR(label_color));
5031*4a1a9510SRong-En Fan}
5032*4a1a9510SRong-En Fan
5033*4a1a9510SRong-En Fanvoid print_in_middle(WINDOW *win, int starty, int startx, int width, char *string, chtype color)
5034*4a1a9510SRong-En Fan{	int length, x, y;
5035*4a1a9510SRong-En Fan	float temp;
5036*4a1a9510SRong-En Fan
5037*4a1a9510SRong-En Fan	if(win == NULL)
5038*4a1a9510SRong-En Fan		win = stdscr;
5039*4a1a9510SRong-En Fan	getyx(win, y, x);
5040*4a1a9510SRong-En Fan	if(startx != 0)
5041*4a1a9510SRong-En Fan		x = startx;
5042*4a1a9510SRong-En Fan	if(starty != 0)
5043*4a1a9510SRong-En Fan		y = starty;
5044*4a1a9510SRong-En Fan	if(width == 0)
5045*4a1a9510SRong-En Fan		width = 80;
5046*4a1a9510SRong-En Fan
5047*4a1a9510SRong-En Fan	length = strlen(string);
5048*4a1a9510SRong-En Fan	temp = (width - length)/ 2;
5049*4a1a9510SRong-En Fan	x = startx + (int)temp;
5050*4a1a9510SRong-En Fan	wattron(win, color);
5051*4a1a9510SRong-En Fan	mvwprintw(win, y, x, "%s", string);
5052*4a1a9510SRong-En Fan	wattroff(win, color);
5053*4a1a9510SRong-En Fan	refresh();
5054*4a1a9510SRong-En Fan}</SPAN
5055*4a1a9510SRong-En Fan></PRE
5056*4a1a9510SRong-En Fan></DIV
5057*4a1a9510SRong-En Fan></DIV
5058*4a1a9510SRong-En Fan><DIV
5059*4a1a9510SRong-En FanCLASS="SECT2"
5060*4a1a9510SRong-En Fan><HR><H3
5061*4a1a9510SRong-En FanCLASS="SECT2"
5062*4a1a9510SRong-En Fan><A
5063*4a1a9510SRong-En FanNAME="PANELABOVE"
5064*4a1a9510SRong-En Fan>16.7. panel_above() and panel_below() Functions</A
5065*4a1a9510SRong-En Fan></H3
5066*4a1a9510SRong-En Fan><P
5067*4a1a9510SRong-En Fan>The functions <TT
5068*4a1a9510SRong-En FanCLASS="LITERAL"
5069*4a1a9510SRong-En Fan>panel_above()</TT
5070*4a1a9510SRong-En Fan> and
5071*4a1a9510SRong-En Fan<TT
5072*4a1a9510SRong-En FanCLASS="LITERAL"
5073*4a1a9510SRong-En Fan>panel_below()</TT
5074*4a1a9510SRong-En Fan> can be used to find out the panel
5075*4a1a9510SRong-En Fanabove and below a panel. If the argument to these functions is NULL, then they
5076*4a1a9510SRong-En Fanreturn a pointer to bottom panel and top panel respectively.</P
5077*4a1a9510SRong-En Fan></DIV
5078*4a1a9510SRong-En Fan></DIV
5079*4a1a9510SRong-En Fan><DIV
5080*4a1a9510SRong-En FanCLASS="SECT1"
5081*4a1a9510SRong-En Fan><HR><H2
5082*4a1a9510SRong-En FanCLASS="SECT1"
5083*4a1a9510SRong-En Fan><A
5084*4a1a9510SRong-En FanNAME="MENUS"
5085*4a1a9510SRong-En Fan>17. Menus Library</A
5086*4a1a9510SRong-En Fan></H2
5087*4a1a9510SRong-En Fan><P
5088*4a1a9510SRong-En Fan>The menus library provides a nice extension to basic curses, through which you
5089*4a1a9510SRong-En Fancan create menus. It provides a set of functions to create menus. But they have
5090*4a1a9510SRong-En Fanto be customized to give a nicer look, with colors etc. Let's get into the
5091*4a1a9510SRong-En Fandetails.</P
5092*4a1a9510SRong-En Fan><P
5093*4a1a9510SRong-En Fan>A menu is a screen display that assists the user to choose some subset of a
5094*4a1a9510SRong-En Fangiven set of items. To put it simple, a menu is a collection of items from which
5095*4a1a9510SRong-En Fanone or more items can be chosen. Some readers might not be aware of multiple
5096*4a1a9510SRong-En Fanitem selection capability.  Menu library provides functionality to write menus
5097*4a1a9510SRong-En Fanfrom which the user can chose more than one item as the preferred choice. This
5098*4a1a9510SRong-En Fanis dealt with in a later section. Now it is time for some rudiments.</P
5099*4a1a9510SRong-En Fan><DIV
5100*4a1a9510SRong-En FanCLASS="SECT2"
5101*4a1a9510SRong-En Fan><HR><H3
5102*4a1a9510SRong-En FanCLASS="SECT2"
5103*4a1a9510SRong-En Fan><A
5104*4a1a9510SRong-En FanNAME="MENUBASICS"
5105*4a1a9510SRong-En Fan>17.1. The Basics</A
5106*4a1a9510SRong-En Fan></H3
5107*4a1a9510SRong-En Fan><P
5108*4a1a9510SRong-En Fan>To create menus, you first create items, and then post the menu to the display.
5109*4a1a9510SRong-En FanAfter that, all the processing of user responses is done in an elegant function
5110*4a1a9510SRong-En Fanmenu_driver() which is the work horse of any menu program. </P
5111*4a1a9510SRong-En Fan><P
5112*4a1a9510SRong-En Fan>The general flow of control of a menu program looks like this.
5113*4a1a9510SRong-En Fan<P
5114*4a1a9510SRong-En Fan></P
5115*4a1a9510SRong-En Fan><OL
5116*4a1a9510SRong-En FanTYPE="1"
5117*4a1a9510SRong-En Fan><LI
5118*4a1a9510SRong-En Fan><P
5119*4a1a9510SRong-En Fan>Initialize curses</P
5120*4a1a9510SRong-En Fan></LI
5121*4a1a9510SRong-En Fan><LI
5122*4a1a9510SRong-En Fan><P
5123*4a1a9510SRong-En Fan>Create items using new_item(). You can specify a name and description for the
5124*4a1a9510SRong-En Fanitems.</P
5125*4a1a9510SRong-En Fan></LI
5126*4a1a9510SRong-En Fan><LI
5127*4a1a9510SRong-En Fan><P
5128*4a1a9510SRong-En Fan>Create the menu with new_menu() by specifying the items to be attached with.</P
5129*4a1a9510SRong-En Fan></LI
5130*4a1a9510SRong-En Fan><LI
5131*4a1a9510SRong-En Fan><P
5132*4a1a9510SRong-En Fan>Post the menu with menu_post() and refresh the screen.</P
5133*4a1a9510SRong-En Fan></LI
5134*4a1a9510SRong-En Fan><LI
5135*4a1a9510SRong-En Fan><P
5136*4a1a9510SRong-En Fan>Process the user requests with a loop and do necessary updates to menu with
5137*4a1a9510SRong-En Fanmenu_driver.</P
5138*4a1a9510SRong-En Fan></LI
5139*4a1a9510SRong-En Fan><LI
5140*4a1a9510SRong-En Fan><P
5141*4a1a9510SRong-En Fan>Unpost the menu with menu_unpost()</P
5142*4a1a9510SRong-En Fan></LI
5143*4a1a9510SRong-En Fan><LI
5144*4a1a9510SRong-En Fan><P
5145*4a1a9510SRong-En Fan>Free the memory allocated to menu by free_menu()</P
5146*4a1a9510SRong-En Fan></LI
5147*4a1a9510SRong-En Fan><LI
5148*4a1a9510SRong-En Fan><P
5149*4a1a9510SRong-En Fan>Free the memory allocated to the items with free_item() </P
5150*4a1a9510SRong-En Fan></LI
5151*4a1a9510SRong-En Fan><LI
5152*4a1a9510SRong-En Fan><P
5153*4a1a9510SRong-En Fan>End curses </P
5154*4a1a9510SRong-En Fan></LI
5155*4a1a9510SRong-En Fan></OL
5156*4a1a9510SRong-En Fan></P
5157*4a1a9510SRong-En Fan><P
5158*4a1a9510SRong-En Fan>Let's see a program which prints a simple menu and updates the current selection
5159*4a1a9510SRong-En Fanwith up, down arrows. </P
5160*4a1a9510SRong-En Fan></DIV
5161*4a1a9510SRong-En Fan><DIV
5162*4a1a9510SRong-En FanCLASS="SECT2"
5163*4a1a9510SRong-En Fan><HR><H3
5164*4a1a9510SRong-En FanCLASS="SECT2"
5165*4a1a9510SRong-En Fan><A
5166*4a1a9510SRong-En FanNAME="COMPILEMENUS"
5167*4a1a9510SRong-En Fan>17.2. Compiling With the Menu Library</A
5168*4a1a9510SRong-En Fan></H3
5169*4a1a9510SRong-En Fan><P
5170*4a1a9510SRong-En Fan>To use menu library functions, you have to include menu.h and to link the
5171*4a1a9510SRong-En Fanprogram with menu library the flag -lmenu should be added along with -lncurses
5172*4a1a9510SRong-En Fanin that order.</P
5173*4a1a9510SRong-En Fan><PRE
5174*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
5175*4a1a9510SRong-En Fan>    #include &lt;menu.h&gt;
5176*4a1a9510SRong-En Fan    .
5177*4a1a9510SRong-En Fan    .
5178*4a1a9510SRong-En Fan    .
5179*4a1a9510SRong-En Fan
5180*4a1a9510SRong-En Fan    compile and link: gcc &lt;program file&gt; -lmenu -lncurses</PRE
5181*4a1a9510SRong-En Fan><DIV
5182*4a1a9510SRong-En FanCLASS="EXAMPLE"
5183*4a1a9510SRong-En Fan><A
5184*4a1a9510SRong-En FanNAME="MMESI"
5185*4a1a9510SRong-En Fan></A
5186*4a1a9510SRong-En Fan><P
5187*4a1a9510SRong-En Fan><B
5188*4a1a9510SRong-En Fan>Example 18. Menu Basics </B
5189*4a1a9510SRong-En Fan></P
5190*4a1a9510SRong-En Fan><PRE
5191*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
5192*4a1a9510SRong-En Fan><SPAN
5193*4a1a9510SRong-En FanCLASS="INLINEMEDIAOBJECT"
5194*4a1a9510SRong-En Fan>#include &#60;curses.h&#62;
5195*4a1a9510SRong-En Fan#include &#60;menu.h&#62;
5196*4a1a9510SRong-En Fan
5197*4a1a9510SRong-En Fan#define ARRAY_SIZE(a) (sizeof(a) / sizeof(a[0]))
5198*4a1a9510SRong-En Fan#define CTRLD 	4
5199*4a1a9510SRong-En Fan
5200*4a1a9510SRong-En Fanchar *choices[] = {
5201*4a1a9510SRong-En Fan                        "Choice 1",
5202*4a1a9510SRong-En Fan                        "Choice 2",
5203*4a1a9510SRong-En Fan                        "Choice 3",
5204*4a1a9510SRong-En Fan                        "Choice 4",
5205*4a1a9510SRong-En Fan                        "Exit",
5206*4a1a9510SRong-En Fan                  };
5207*4a1a9510SRong-En Fan
5208*4a1a9510SRong-En Fanint main()
5209*4a1a9510SRong-En Fan{	ITEM **my_items;
5210*4a1a9510SRong-En Fan	int c;
5211*4a1a9510SRong-En Fan	MENU *my_menu;
5212*4a1a9510SRong-En Fan	int n_choices, i;
5213*4a1a9510SRong-En Fan	ITEM *cur_item;
5214*4a1a9510SRong-En Fan
5215*4a1a9510SRong-En Fan
5216*4a1a9510SRong-En Fan	initscr();
5217*4a1a9510SRong-En Fan	cbreak();
5218*4a1a9510SRong-En Fan	noecho();
5219*4a1a9510SRong-En Fan	keypad(stdscr, TRUE);
5220*4a1a9510SRong-En Fan
5221*4a1a9510SRong-En Fan	n_choices = ARRAY_SIZE(choices);
5222*4a1a9510SRong-En Fan	my_items = (ITEM **)calloc(n_choices + 1, sizeof(ITEM *));
5223*4a1a9510SRong-En Fan
5224*4a1a9510SRong-En Fan	for(i = 0; i &#60; n_choices; ++i)
5225*4a1a9510SRong-En Fan	        my_items[i] = new_item(choices[i], choices[i]);
5226*4a1a9510SRong-En Fan	my_items[n_choices] = (ITEM *)NULL;
5227*4a1a9510SRong-En Fan
5228*4a1a9510SRong-En Fan	my_menu = new_menu((ITEM **)my_items);
5229*4a1a9510SRong-En Fan	mvprintw(LINES - 2, 0, "F1 to Exit");
5230*4a1a9510SRong-En Fan	post_menu(my_menu);
5231*4a1a9510SRong-En Fan	refresh();
5232*4a1a9510SRong-En Fan
5233*4a1a9510SRong-En Fan	while((c = getch()) != KEY_F(1))
5234*4a1a9510SRong-En Fan	{   switch(c)
5235*4a1a9510SRong-En Fan	    {	case KEY_DOWN:
5236*4a1a9510SRong-En Fan		        menu_driver(my_menu, REQ_DOWN_ITEM);
5237*4a1a9510SRong-En Fan				break;
5238*4a1a9510SRong-En Fan			case KEY_UP:
5239*4a1a9510SRong-En Fan				menu_driver(my_menu, REQ_UP_ITEM);
5240*4a1a9510SRong-En Fan				break;
5241*4a1a9510SRong-En Fan		}
5242*4a1a9510SRong-En Fan	}
5243*4a1a9510SRong-En Fan
5244*4a1a9510SRong-En Fan	free_item(my_items[0]);
5245*4a1a9510SRong-En Fan	free_item(my_items[1]);
5246*4a1a9510SRong-En Fan	free_menu(my_menu);
5247*4a1a9510SRong-En Fan	endwin();
5248*4a1a9510SRong-En Fan}
5249*4a1a9510SRong-En Fan	</SPAN
5250*4a1a9510SRong-En Fan></PRE
5251*4a1a9510SRong-En Fan></DIV
5252*4a1a9510SRong-En Fan><P
5253*4a1a9510SRong-En Fan>This program demonstrates the basic concepts involved in creating a menu using
5254*4a1a9510SRong-En Fanmenus library.  First we create the items using new_item() and then attach them
5255*4a1a9510SRong-En Fanto the menu with new_menu() function. After posting the menu and refreshing the
5256*4a1a9510SRong-En Fanscreen, the main processing loop starts. It reads user input and takes
5257*4a1a9510SRong-En Fancorresponding action. The function menu_driver() is the main work horse of the
5258*4a1a9510SRong-En Fanmenu system. The second parameter to this function tells what's to be done with
5259*4a1a9510SRong-En Fanthe menu. According to the parameter, menu_driver() does the corresponding task.
5260*4a1a9510SRong-En FanThe value can be either a menu navigational request, an ascii character, or a
5261*4a1a9510SRong-En FanKEY_MOUSE special key associated with a mouse event.</P
5262*4a1a9510SRong-En Fan><P
5263*4a1a9510SRong-En Fan>The menu_driver accepts following navigational requests.
5264*4a1a9510SRong-En Fan<PRE
5265*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
5266*4a1a9510SRong-En Fan>&#13;     REQ_LEFT_ITEM         Move left to an item.
5267*4a1a9510SRong-En Fan     REQ_RIGHT_ITEM      Move right to an item.
5268*4a1a9510SRong-En Fan     REQ_UP_ITEM         Move up to an item.
5269*4a1a9510SRong-En Fan     REQ_DOWN_ITEM       Move down to an item.
5270*4a1a9510SRong-En Fan     REQ_SCR_ULINE       Scroll up a line.
5271*4a1a9510SRong-En Fan     REQ_SCR_DLINE          Scroll down a line.
5272*4a1a9510SRong-En Fan     REQ_SCR_DPAGE          Scroll down a page.
5273*4a1a9510SRong-En Fan     REQ_SCR_UPAGE         Scroll up a page.
5274*4a1a9510SRong-En Fan     REQ_FIRST_ITEM     Move to the first item.
5275*4a1a9510SRong-En Fan     REQ_LAST_ITEM         Move to the last item.
5276*4a1a9510SRong-En Fan     REQ_NEXT_ITEM         Move to the next item.
5277*4a1a9510SRong-En Fan     REQ_PREV_ITEM         Move to the previous item.
5278*4a1a9510SRong-En Fan     REQ_TOGGLE_ITEM     Select/deselect an item.
5279*4a1a9510SRong-En Fan     REQ_CLEAR_PATTERN     Clear the menu pattern buffer.
5280*4a1a9510SRong-En Fan     REQ_BACK_PATTERN      Delete the previous character from the pattern buffer.
5281*4a1a9510SRong-En Fan     REQ_NEXT_MATCH     Move to the next item matching the pattern match.
5282*4a1a9510SRong-En Fan     REQ_PREV_MATCH     Move to the previous item matching the pattern match.&#13;</PRE
5283*4a1a9510SRong-En Fan></P
5284*4a1a9510SRong-En Fan><P
5285*4a1a9510SRong-En Fan>Don't get overwhelmed by the number of options. We will see them slowly one
5286*4a1a9510SRong-En Fanafter another. The options of interest in this example are REQ_UP_ITEM and
5287*4a1a9510SRong-En FanREQ_DOWN_ITEM.  These two options when passed to menu_driver, menu driver
5288*4a1a9510SRong-En Fanupdates the current item to one item up or down respectively.</P
5289*4a1a9510SRong-En Fan></DIV
5290*4a1a9510SRong-En Fan><DIV
5291*4a1a9510SRong-En FanCLASS="SECT2"
5292*4a1a9510SRong-En Fan><HR><H3
5293*4a1a9510SRong-En FanCLASS="SECT2"
5294*4a1a9510SRong-En Fan><A
5295*4a1a9510SRong-En FanNAME="MENUDRIVER"
5296*4a1a9510SRong-En Fan>17.3. Menu Driver: The work horse of the menu system</A
5297*4a1a9510SRong-En Fan></H3
5298*4a1a9510SRong-En Fan><P
5299*4a1a9510SRong-En Fan>As you have seen in the above example, menu_driver plays an important role in
5300*4a1a9510SRong-En Fanupdating the menu. It is very important to understand various options it takes
5301*4a1a9510SRong-En Fanand what they do.  As explained above, the second parameter to menu_driver() can
5302*4a1a9510SRong-En Fanbe either a navigational request, a printable character or a KEY_MOUSE key.
5303*4a1a9510SRong-En FanLet's dissect the different navigational requests.</P
5304*4a1a9510SRong-En Fan><P
5305*4a1a9510SRong-En Fan></P
5306*4a1a9510SRong-En Fan><UL
5307*4a1a9510SRong-En Fan><LI
5308*4a1a9510SRong-En Fan><P
5309*4a1a9510SRong-En Fan><SPAN
5310*4a1a9510SRong-En FanCLASS="emphasis"
5311*4a1a9510SRong-En Fan><I
5312*4a1a9510SRong-En FanCLASS="EMPHASIS"
5313*4a1a9510SRong-En Fan>REQ_LEFT_ITEM and REQ_RIGHT_ITEM</I
5314*4a1a9510SRong-En Fan></SPAN
5315*4a1a9510SRong-En Fan></P
5316*4a1a9510SRong-En Fan><P
5317*4a1a9510SRong-En Fan>A Menu can be displayed with multiple columns for more than one item. This can
5318*4a1a9510SRong-En Fanbe done by using the <TT
5319*4a1a9510SRong-En FanCLASS="LITERAL"
5320*4a1a9510SRong-En Fan>menu_format()</TT
5321*4a1a9510SRong-En Fan>function.
5322*4a1a9510SRong-En FanWhen a multi columnar menu is displayed these requests cause the menu driver to
5323*4a1a9510SRong-En Fanmove the current selection to left or right.</P
5324*4a1a9510SRong-En Fan></LI
5325*4a1a9510SRong-En Fan><LI
5326*4a1a9510SRong-En Fan><P
5327*4a1a9510SRong-En Fan><SPAN
5328*4a1a9510SRong-En FanCLASS="emphasis"
5329*4a1a9510SRong-En Fan><I
5330*4a1a9510SRong-En FanCLASS="EMPHASIS"
5331*4a1a9510SRong-En Fan>REQ_UP_ITEM and REQ_DOWN_ITEM </I
5332*4a1a9510SRong-En Fan></SPAN
5333*4a1a9510SRong-En Fan> </P
5334*4a1a9510SRong-En Fan><P
5335*4a1a9510SRong-En Fan>These two options you have seen in the above example. These options when given,
5336*4a1a9510SRong-En Fanmakes the menu_driver to move the current selection to an item up or down.</P
5337*4a1a9510SRong-En Fan></LI
5338*4a1a9510SRong-En Fan><LI
5339*4a1a9510SRong-En Fan><P
5340*4a1a9510SRong-En Fan> <SPAN
5341*4a1a9510SRong-En FanCLASS="emphasis"
5342*4a1a9510SRong-En Fan><I
5343*4a1a9510SRong-En FanCLASS="EMPHASIS"
5344*4a1a9510SRong-En Fan>REQ_SCR_* options</I
5345*4a1a9510SRong-En Fan></SPAN
5346*4a1a9510SRong-En Fan> </P
5347*4a1a9510SRong-En Fan><P
5348*4a1a9510SRong-En Fan>The four options REQ_SCR_ULINE, REQ_SCR_DLINE, REQ_SCR_DPAGE, REQ_SCR_UPAGE are
5349*4a1a9510SRong-En Fanrelated to scrolling. If all the items in the menu cannot be displayed in the
5350*4a1a9510SRong-En Fanmenu sub window, then the menu is scrollable. These requests can be given to the
5351*4a1a9510SRong-En Fanmenu_driver to do the scrolling either one line up, down or one page down or up
5352*4a1a9510SRong-En Fanrespectively. </P
5353*4a1a9510SRong-En Fan></LI
5354*4a1a9510SRong-En Fan><LI
5355*4a1a9510SRong-En Fan><P
5356*4a1a9510SRong-En Fan><SPAN
5357*4a1a9510SRong-En FanCLASS="emphasis"
5358*4a1a9510SRong-En Fan><I
5359*4a1a9510SRong-En FanCLASS="EMPHASIS"
5360*4a1a9510SRong-En Fan>REQ_FIRST_ITEM, REQ_LAST_ITEM, REQ_NEXT_ITEM and
5361*4a1a9510SRong-En FanREQ_PREV_ITEM </I
5362*4a1a9510SRong-En Fan></SPAN
5363*4a1a9510SRong-En Fan> </P
5364*4a1a9510SRong-En Fan><P
5365*4a1a9510SRong-En Fan>These requests are self explanatory.</P
5366*4a1a9510SRong-En Fan></LI
5367*4a1a9510SRong-En Fan><LI
5368*4a1a9510SRong-En Fan><P
5369*4a1a9510SRong-En Fan> <SPAN
5370*4a1a9510SRong-En FanCLASS="emphasis"
5371*4a1a9510SRong-En Fan><I
5372*4a1a9510SRong-En FanCLASS="EMPHASIS"
5373*4a1a9510SRong-En Fan>REQ_TOGGLE_ITEM</I
5374*4a1a9510SRong-En Fan></SPAN
5375*4a1a9510SRong-En Fan> </P
5376*4a1a9510SRong-En Fan><P
5377*4a1a9510SRong-En Fan>This request when given, toggles the present selection. This option is to be
5378*4a1a9510SRong-En Fanused only in a multi valued menu. So to use this request the option O_ONEVALUE
5379*4a1a9510SRong-En Fanmust be off. This option can be made off or on with set_menu_opts().</P
5380*4a1a9510SRong-En Fan></LI
5381*4a1a9510SRong-En Fan><LI
5382*4a1a9510SRong-En Fan><P
5383*4a1a9510SRong-En Fan> <SPAN
5384*4a1a9510SRong-En FanCLASS="emphasis"
5385*4a1a9510SRong-En Fan><I
5386*4a1a9510SRong-En FanCLASS="EMPHASIS"
5387*4a1a9510SRong-En Fan>Pattern Requests </I
5388*4a1a9510SRong-En Fan></SPAN
5389*4a1a9510SRong-En Fan></P
5390*4a1a9510SRong-En Fan><P
5391*4a1a9510SRong-En Fan>Every menu has an associated pattern buffer, which is used to find the nearest
5392*4a1a9510SRong-En Fanmatch to the ascii characters entered by the user. Whenever ascii characters are
5393*4a1a9510SRong-En Fangiven to menu_driver, it puts in to the pattern buffer. It also tries to find
5394*4a1a9510SRong-En Fanthe nearest match to the pattern in the items list and moves current selection
5395*4a1a9510SRong-En Fanto that item. The request REQ_CLEAR_PATTERN clears the pattern buffer. The
5396*4a1a9510SRong-En Fanrequest REQ_BACK_PATTERN deletes the previous character in the pattern buffer.
5397*4a1a9510SRong-En FanIn case the pattern matches more than one item then the matched items can be
5398*4a1a9510SRong-En Fancycled through REQ_NEXT_MATCH and REQ_PREV_MATCH which move the current
5399*4a1a9510SRong-En Fanselection to the next and previous matches respectively.</P
5400*4a1a9510SRong-En Fan></LI
5401*4a1a9510SRong-En Fan><LI
5402*4a1a9510SRong-En Fan><P
5403*4a1a9510SRong-En Fan> <SPAN
5404*4a1a9510SRong-En FanCLASS="emphasis"
5405*4a1a9510SRong-En Fan><I
5406*4a1a9510SRong-En FanCLASS="EMPHASIS"
5407*4a1a9510SRong-En Fan>Mouse Requests</I
5408*4a1a9510SRong-En Fan></SPAN
5409*4a1a9510SRong-En Fan></P
5410*4a1a9510SRong-En Fan><P
5411*4a1a9510SRong-En Fan>In case of KEY_MOUSE requests, according to the mouse position an action is
5412*4a1a9510SRong-En Fantaken accordingly. The action to be taken is explained in the man page as, </P
5413*4a1a9510SRong-En Fan><PRE
5414*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
5415*4a1a9510SRong-En Fan><SPAN
5416*4a1a9510SRong-En FanCLASS="emphasis"
5417*4a1a9510SRong-En Fan><I
5418*4a1a9510SRong-En FanCLASS="EMPHASIS"
5419*4a1a9510SRong-En Fan>       If  the  second argument is the KEY_MOUSE special key, the
5420*4a1a9510SRong-En Fan       associated mouse event is translated into one of the above
5421*4a1a9510SRong-En Fan       pre-defined  requests.   Currently only clicks in the user
5422*4a1a9510SRong-En Fan       window (e.g. inside the menu display area or  the  decora&shy;
5423*4a1a9510SRong-En Fan       tion  window)  are handled. If you click above the display
5424*4a1a9510SRong-En Fan       region of the menu, a REQ_SCR_ULINE is generated,  if  you
5425*4a1a9510SRong-En Fan       doubleclick  a  REQ_SCR_UPAGE  is  generated  and  if  you
5426*4a1a9510SRong-En Fan       tripleclick a REQ_FIRST_ITEM is generated.  If  you  click
5427*4a1a9510SRong-En Fan       below  the  display region of the menu, a REQ_SCR_DLINE is
5428*4a1a9510SRong-En Fan       generated, if you doubleclick a REQ_SCR_DPAGE is generated
5429*4a1a9510SRong-En Fan       and  if  you  tripleclick a REQ_LAST_ITEM is generated. If
5430*4a1a9510SRong-En Fan       you click at an item inside the display area of the  menu,
5431*4a1a9510SRong-En Fan       the menu cursor is positioned to that item.</I
5432*4a1a9510SRong-En Fan></SPAN
5433*4a1a9510SRong-En Fan></PRE
5434*4a1a9510SRong-En Fan></LI
5435*4a1a9510SRong-En Fan></UL
5436*4a1a9510SRong-En Fan><P
5437*4a1a9510SRong-En Fan>Each of the above requests will be explained in the following lines with several
5438*4a1a9510SRong-En Fanexamples whenever appropriate.</P
5439*4a1a9510SRong-En Fan></DIV
5440*4a1a9510SRong-En Fan><DIV
5441*4a1a9510SRong-En FanCLASS="SECT2"
5442*4a1a9510SRong-En Fan><HR><H3
5443*4a1a9510SRong-En FanCLASS="SECT2"
5444*4a1a9510SRong-En Fan><A
5445*4a1a9510SRong-En FanNAME="MENUWINDOWS"
5446*4a1a9510SRong-En Fan>17.4. Menu Windows</A
5447*4a1a9510SRong-En Fan></H3
5448*4a1a9510SRong-En Fan><P
5449*4a1a9510SRong-En Fan>Every menu created is associated with a window and a sub window. The menu window
5450*4a1a9510SRong-En Fandisplays any title or border associated with the menu. The menu sub window
5451*4a1a9510SRong-En Fandisplays the menu items currently available for selection. But we didn't specify
5452*4a1a9510SRong-En Fanany window or sub window in the simple example. When a window is not specified,
5453*4a1a9510SRong-En Fanstdscr is taken as the main window, and then menu system calculates the sub
5454*4a1a9510SRong-En Fanwindow size required for the display of items. Then items are displayed in the
5455*4a1a9510SRong-En Fancalculated sub window. So let's play with these windows and display a menu with
5456*4a1a9510SRong-En Fana border and a title.</P
5457*4a1a9510SRong-En Fan><DIV
5458*4a1a9510SRong-En FanCLASS="EXAMPLE"
5459*4a1a9510SRong-En Fan><A
5460*4a1a9510SRong-En FanNAME="MMEWI"
5461*4a1a9510SRong-En Fan></A
5462*4a1a9510SRong-En Fan><P
5463*4a1a9510SRong-En Fan><B
5464*4a1a9510SRong-En Fan>Example 19.  Menu Windows Usage example </B
5465*4a1a9510SRong-En Fan></P
5466*4a1a9510SRong-En Fan><PRE
5467*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
5468*4a1a9510SRong-En Fan><SPAN
5469*4a1a9510SRong-En FanCLASS="INLINEMEDIAOBJECT"
5470*4a1a9510SRong-En Fan>#include &#60;menu.h&#62;
5471*4a1a9510SRong-En Fan
5472*4a1a9510SRong-En Fan#define ARRAY_SIZE(a) (sizeof(a) / sizeof(a[0]))
5473*4a1a9510SRong-En Fan#define CTRLD 	4
5474*4a1a9510SRong-En Fan
5475*4a1a9510SRong-En Fanchar *choices[] = {
5476*4a1a9510SRong-En Fan                        "Choice 1",
5477*4a1a9510SRong-En Fan                        "Choice 2",
5478*4a1a9510SRong-En Fan                        "Choice 3",
5479*4a1a9510SRong-En Fan                        "Choice 4",
5480*4a1a9510SRong-En Fan                        "Exit",
5481*4a1a9510SRong-En Fan                        (char *)NULL,
5482*4a1a9510SRong-En Fan                  };
5483*4a1a9510SRong-En Fanvoid print_in_middle(WINDOW *win, int starty, int startx, int width, char *string, chtype color);
5484*4a1a9510SRong-En Fan
5485*4a1a9510SRong-En Fanint main()
5486*4a1a9510SRong-En Fan{	ITEM **my_items;
5487*4a1a9510SRong-En Fan	int c;
5488*4a1a9510SRong-En Fan	MENU *my_menu;
5489*4a1a9510SRong-En Fan        WINDOW *my_menu_win;
5490*4a1a9510SRong-En Fan        int n_choices, i;
5491*4a1a9510SRong-En Fan
5492*4a1a9510SRong-En Fan	/* Initialize curses */
5493*4a1a9510SRong-En Fan	initscr();
5494*4a1a9510SRong-En Fan	start_color();
5495*4a1a9510SRong-En Fan        cbreak();
5496*4a1a9510SRong-En Fan        noecho();
5497*4a1a9510SRong-En Fan	keypad(stdscr, TRUE);
5498*4a1a9510SRong-En Fan	init_pair(1, COLOR_RED, COLOR_BLACK);
5499*4a1a9510SRong-En Fan
5500*4a1a9510SRong-En Fan	/* Create items */
5501*4a1a9510SRong-En Fan        n_choices = ARRAY_SIZE(choices);
5502*4a1a9510SRong-En Fan        my_items = (ITEM **)calloc(n_choices, sizeof(ITEM *));
5503*4a1a9510SRong-En Fan        for(i = 0; i &#60; n_choices; ++i)
5504*4a1a9510SRong-En Fan                my_items[i] = new_item(choices[i], choices[i]);
5505*4a1a9510SRong-En Fan
5506*4a1a9510SRong-En Fan	/* Crate menu */
5507*4a1a9510SRong-En Fan	my_menu = new_menu((ITEM **)my_items);
5508*4a1a9510SRong-En Fan
5509*4a1a9510SRong-En Fan	/* Create the window to be associated with the menu */
5510*4a1a9510SRong-En Fan        my_menu_win = newwin(10, 40, 4, 4);
5511*4a1a9510SRong-En Fan        keypad(my_menu_win, TRUE);
5512*4a1a9510SRong-En Fan
5513*4a1a9510SRong-En Fan	/* Set main window and sub window */
5514*4a1a9510SRong-En Fan        set_menu_win(my_menu, my_menu_win);
5515*4a1a9510SRong-En Fan        set_menu_sub(my_menu, derwin(my_menu_win, 6, 38, 3, 1));
5516*4a1a9510SRong-En Fan
5517*4a1a9510SRong-En Fan	/* Set menu mark to the string " * " */
5518*4a1a9510SRong-En Fan        set_menu_mark(my_menu, " * ");
5519*4a1a9510SRong-En Fan
5520*4a1a9510SRong-En Fan	/* Print a border around the main window and print a title */
5521*4a1a9510SRong-En Fan        box(my_menu_win, 0, 0);
5522*4a1a9510SRong-En Fan	print_in_middle(my_menu_win, 1, 0, 40, "My Menu", COLOR_PAIR(1));
5523*4a1a9510SRong-En Fan	mvwaddch(my_menu_win, 2, 0, ACS_LTEE);
5524*4a1a9510SRong-En Fan	mvwhline(my_menu_win, 2, 1, ACS_HLINE, 38);
5525*4a1a9510SRong-En Fan	mvwaddch(my_menu_win, 2, 39, ACS_RTEE);
5526*4a1a9510SRong-En Fan	mvprintw(LINES - 2, 0, "F1 to exit");
5527*4a1a9510SRong-En Fan	refresh();
5528*4a1a9510SRong-En Fan
5529*4a1a9510SRong-En Fan	/* Post the menu */
5530*4a1a9510SRong-En Fan	post_menu(my_menu);
5531*4a1a9510SRong-En Fan	wrefresh(my_menu_win);
5532*4a1a9510SRong-En Fan
5533*4a1a9510SRong-En Fan	while((c = wgetch(my_menu_win)) != KEY_F(1))
5534*4a1a9510SRong-En Fan	{       switch(c)
5535*4a1a9510SRong-En Fan	        {	case KEY_DOWN:
5536*4a1a9510SRong-En Fan				menu_driver(my_menu, REQ_DOWN_ITEM);
5537*4a1a9510SRong-En Fan				break;
5538*4a1a9510SRong-En Fan			case KEY_UP:
5539*4a1a9510SRong-En Fan				menu_driver(my_menu, REQ_UP_ITEM);
5540*4a1a9510SRong-En Fan				break;
5541*4a1a9510SRong-En Fan		}
5542*4a1a9510SRong-En Fan                wrefresh(my_menu_win);
5543*4a1a9510SRong-En Fan	}
5544*4a1a9510SRong-En Fan
5545*4a1a9510SRong-En Fan	/* Unpost and free all the memory taken up */
5546*4a1a9510SRong-En Fan        unpost_menu(my_menu);
5547*4a1a9510SRong-En Fan        free_menu(my_menu);
5548*4a1a9510SRong-En Fan        for(i = 0; i &#60; n_choices; ++i)
5549*4a1a9510SRong-En Fan                free_item(my_items[i]);
5550*4a1a9510SRong-En Fan	endwin();
5551*4a1a9510SRong-En Fan}
5552*4a1a9510SRong-En Fan
5553*4a1a9510SRong-En Fanvoid print_in_middle(WINDOW *win, int starty, int startx, int width, char *string, chtype color)
5554*4a1a9510SRong-En Fan{	int length, x, y;
5555*4a1a9510SRong-En Fan	float temp;
5556*4a1a9510SRong-En Fan
5557*4a1a9510SRong-En Fan	if(win == NULL)
5558*4a1a9510SRong-En Fan		win = stdscr;
5559*4a1a9510SRong-En Fan	getyx(win, y, x);
5560*4a1a9510SRong-En Fan	if(startx != 0)
5561*4a1a9510SRong-En Fan		x = startx;
5562*4a1a9510SRong-En Fan	if(starty != 0)
5563*4a1a9510SRong-En Fan		y = starty;
5564*4a1a9510SRong-En Fan	if(width == 0)
5565*4a1a9510SRong-En Fan		width = 80;
5566*4a1a9510SRong-En Fan
5567*4a1a9510SRong-En Fan	length = strlen(string);
5568*4a1a9510SRong-En Fan	temp = (width - length)/ 2;
5569*4a1a9510SRong-En Fan	x = startx + (int)temp;
5570*4a1a9510SRong-En Fan	wattron(win, color);
5571*4a1a9510SRong-En Fan	mvwprintw(win, y, x, "%s", string);
5572*4a1a9510SRong-En Fan	wattroff(win, color);
5573*4a1a9510SRong-En Fan	refresh();
5574*4a1a9510SRong-En Fan}</SPAN
5575*4a1a9510SRong-En Fan></PRE
5576*4a1a9510SRong-En Fan></DIV
5577*4a1a9510SRong-En Fan><P
5578*4a1a9510SRong-En Fan>This example creates a menu with a title, border, a fancy line separating title
5579*4a1a9510SRong-En Fanand the items. As you can see, in order to attach a window to a menu the
5580*4a1a9510SRong-En Fanfunction set_menu_win() has to be used. Then we attach the sub window also. This
5581*4a1a9510SRong-En Fandisplays the items in the sub window.  You can also set the mark string which
5582*4a1a9510SRong-En Fangets displayed to the left of the selected item with set_menu_mark().</P
5583*4a1a9510SRong-En Fan></DIV
5584*4a1a9510SRong-En Fan><DIV
5585*4a1a9510SRong-En FanCLASS="SECT2"
5586*4a1a9510SRong-En Fan><HR><H3
5587*4a1a9510SRong-En FanCLASS="SECT2"
5588*4a1a9510SRong-En Fan><A
5589*4a1a9510SRong-En FanNAME="SCROLLMENUS"
5590*4a1a9510SRong-En Fan>17.5. Scrolling Menus</A
5591*4a1a9510SRong-En Fan></H3
5592*4a1a9510SRong-En Fan><P
5593*4a1a9510SRong-En Fan>If the sub window given for a window is not big enough to show all the items,
5594*4a1a9510SRong-En Fanthen the menu will be scrollable. When you are on the last item in the present
5595*4a1a9510SRong-En Fanlist, if you send REQ_DOWN_ITEM, it gets translated into REQ_SCR_DLINE and the
5596*4a1a9510SRong-En Fanmenu scrolls by one item.  You can manually give REQ_SCR_ operations to do
5597*4a1a9510SRong-En Fanscrolling. Let's see how it can be done.</P
5598*4a1a9510SRong-En Fan><DIV
5599*4a1a9510SRong-En FanCLASS="EXAMPLE"
5600*4a1a9510SRong-En Fan><A
5601*4a1a9510SRong-En FanNAME="MMESC"
5602*4a1a9510SRong-En Fan></A
5603*4a1a9510SRong-En Fan><P
5604*4a1a9510SRong-En Fan><B
5605*4a1a9510SRong-En Fan>Example 20.  Scrolling Menus example </B
5606*4a1a9510SRong-En Fan></P
5607*4a1a9510SRong-En Fan><PRE
5608*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
5609*4a1a9510SRong-En Fan><SPAN
5610*4a1a9510SRong-En FanCLASS="INLINEMEDIAOBJECT"
5611*4a1a9510SRong-En Fan>#include &#60;curses.h&#62;
5612*4a1a9510SRong-En Fan#include &#60;menu.h&#62;
5613*4a1a9510SRong-En Fan
5614*4a1a9510SRong-En Fan#define ARRAY_SIZE(a) (sizeof(a) / sizeof(a[0]))
5615*4a1a9510SRong-En Fan#define CTRLD 	4
5616*4a1a9510SRong-En Fan
5617*4a1a9510SRong-En Fanchar *choices[] = {
5618*4a1a9510SRong-En Fan                        "Choice 1",
5619*4a1a9510SRong-En Fan                        "Choice 2",
5620*4a1a9510SRong-En Fan                        "Choice 3",
5621*4a1a9510SRong-En Fan                        "Choice 4",
5622*4a1a9510SRong-En Fan			"Choice 5",
5623*4a1a9510SRong-En Fan			"Choice 6",
5624*4a1a9510SRong-En Fan			"Choice 7",
5625*4a1a9510SRong-En Fan			"Choice 8",
5626*4a1a9510SRong-En Fan			"Choice 9",
5627*4a1a9510SRong-En Fan			"Choice 10",
5628*4a1a9510SRong-En Fan                        "Exit",
5629*4a1a9510SRong-En Fan                        (char *)NULL,
5630*4a1a9510SRong-En Fan                  };
5631*4a1a9510SRong-En Fanvoid print_in_middle(WINDOW *win, int starty, int startx, int width, char *string, chtype color);
5632*4a1a9510SRong-En Fan
5633*4a1a9510SRong-En Fanint main()
5634*4a1a9510SRong-En Fan{	ITEM **my_items;
5635*4a1a9510SRong-En Fan	int c;
5636*4a1a9510SRong-En Fan	MENU *my_menu;
5637*4a1a9510SRong-En Fan        WINDOW *my_menu_win;
5638*4a1a9510SRong-En Fan        int n_choices, i;
5639*4a1a9510SRong-En Fan
5640*4a1a9510SRong-En Fan	/* Initialize curses */
5641*4a1a9510SRong-En Fan	initscr();
5642*4a1a9510SRong-En Fan	start_color();
5643*4a1a9510SRong-En Fan        cbreak();
5644*4a1a9510SRong-En Fan        noecho();
5645*4a1a9510SRong-En Fan	keypad(stdscr, TRUE);
5646*4a1a9510SRong-En Fan	init_pair(1, COLOR_RED, COLOR_BLACK);
5647*4a1a9510SRong-En Fan	init_pair(2, COLOR_CYAN, COLOR_BLACK);
5648*4a1a9510SRong-En Fan
5649*4a1a9510SRong-En Fan	/* Create items */
5650*4a1a9510SRong-En Fan        n_choices = ARRAY_SIZE(choices);
5651*4a1a9510SRong-En Fan        my_items = (ITEM **)calloc(n_choices, sizeof(ITEM *));
5652*4a1a9510SRong-En Fan        for(i = 0; i &#60; n_choices; ++i)
5653*4a1a9510SRong-En Fan                my_items[i] = new_item(choices[i], choices[i]);
5654*4a1a9510SRong-En Fan
5655*4a1a9510SRong-En Fan	/* Crate menu */
5656*4a1a9510SRong-En Fan	my_menu = new_menu((ITEM **)my_items);
5657*4a1a9510SRong-En Fan
5658*4a1a9510SRong-En Fan	/* Create the window to be associated with the menu */
5659*4a1a9510SRong-En Fan        my_menu_win = newwin(10, 40, 4, 4);
5660*4a1a9510SRong-En Fan        keypad(my_menu_win, TRUE);
5661*4a1a9510SRong-En Fan
5662*4a1a9510SRong-En Fan	/* Set main window and sub window */
5663*4a1a9510SRong-En Fan        set_menu_win(my_menu, my_menu_win);
5664*4a1a9510SRong-En Fan        set_menu_sub(my_menu, derwin(my_menu_win, 6, 38, 3, 1));
5665*4a1a9510SRong-En Fan	set_menu_format(my_menu, 5, 1);
5666*4a1a9510SRong-En Fan
5667*4a1a9510SRong-En Fan	/* Set menu mark to the string " * " */
5668*4a1a9510SRong-En Fan        set_menu_mark(my_menu, " * ");
5669*4a1a9510SRong-En Fan
5670*4a1a9510SRong-En Fan	/* Print a border around the main window and print a title */
5671*4a1a9510SRong-En Fan        box(my_menu_win, 0, 0);
5672*4a1a9510SRong-En Fan	print_in_middle(my_menu_win, 1, 0, 40, "My Menu", COLOR_PAIR(1));
5673*4a1a9510SRong-En Fan	mvwaddch(my_menu_win, 2, 0, ACS_LTEE);
5674*4a1a9510SRong-En Fan	mvwhline(my_menu_win, 2, 1, ACS_HLINE, 38);
5675*4a1a9510SRong-En Fan	mvwaddch(my_menu_win, 2, 39, ACS_RTEE);
5676*4a1a9510SRong-En Fan
5677*4a1a9510SRong-En Fan	/* Post the menu */
5678*4a1a9510SRong-En Fan	post_menu(my_menu);
5679*4a1a9510SRong-En Fan	wrefresh(my_menu_win);
5680*4a1a9510SRong-En Fan
5681*4a1a9510SRong-En Fan	attron(COLOR_PAIR(2));
5682*4a1a9510SRong-En Fan	mvprintw(LINES - 2, 0, "Use PageUp and PageDown to scoll down or up a page of items");
5683*4a1a9510SRong-En Fan	mvprintw(LINES - 1, 0, "Arrow Keys to navigate (F1 to Exit)");
5684*4a1a9510SRong-En Fan	attroff(COLOR_PAIR(2));
5685*4a1a9510SRong-En Fan	refresh();
5686*4a1a9510SRong-En Fan
5687*4a1a9510SRong-En Fan	while((c = wgetch(my_menu_win)) != KEY_F(1))
5688*4a1a9510SRong-En Fan	{       switch(c)
5689*4a1a9510SRong-En Fan	        {	case KEY_DOWN:
5690*4a1a9510SRong-En Fan				menu_driver(my_menu, REQ_DOWN_ITEM);
5691*4a1a9510SRong-En Fan				break;
5692*4a1a9510SRong-En Fan			case KEY_UP:
5693*4a1a9510SRong-En Fan				menu_driver(my_menu, REQ_UP_ITEM);
5694*4a1a9510SRong-En Fan				break;
5695*4a1a9510SRong-En Fan			case KEY_NPAGE:
5696*4a1a9510SRong-En Fan				menu_driver(my_menu, REQ_SCR_DPAGE);
5697*4a1a9510SRong-En Fan				break;
5698*4a1a9510SRong-En Fan			case KEY_PPAGE:
5699*4a1a9510SRong-En Fan				menu_driver(my_menu, REQ_SCR_UPAGE);
5700*4a1a9510SRong-En Fan				break;
5701*4a1a9510SRong-En Fan		}
5702*4a1a9510SRong-En Fan                wrefresh(my_menu_win);
5703*4a1a9510SRong-En Fan	}
5704*4a1a9510SRong-En Fan
5705*4a1a9510SRong-En Fan	/* Unpost and free all the memory taken up */
5706*4a1a9510SRong-En Fan        unpost_menu(my_menu);
5707*4a1a9510SRong-En Fan        free_menu(my_menu);
5708*4a1a9510SRong-En Fan        for(i = 0; i &#60; n_choices; ++i)
5709*4a1a9510SRong-En Fan                free_item(my_items[i]);
5710*4a1a9510SRong-En Fan	endwin();
5711*4a1a9510SRong-En Fan}
5712*4a1a9510SRong-En Fan
5713*4a1a9510SRong-En Fanvoid print_in_middle(WINDOW *win, int starty, int startx, int width, char *string, chtype color)
5714*4a1a9510SRong-En Fan{	int length, x, y;
5715*4a1a9510SRong-En Fan	float temp;
5716*4a1a9510SRong-En Fan
5717*4a1a9510SRong-En Fan	if(win == NULL)
5718*4a1a9510SRong-En Fan		win = stdscr;
5719*4a1a9510SRong-En Fan	getyx(win, y, x);
5720*4a1a9510SRong-En Fan	if(startx != 0)
5721*4a1a9510SRong-En Fan		x = startx;
5722*4a1a9510SRong-En Fan	if(starty != 0)
5723*4a1a9510SRong-En Fan		y = starty;
5724*4a1a9510SRong-En Fan	if(width == 0)
5725*4a1a9510SRong-En Fan		width = 80;
5726*4a1a9510SRong-En Fan
5727*4a1a9510SRong-En Fan	length = strlen(string);
5728*4a1a9510SRong-En Fan	temp = (width - length)/ 2;
5729*4a1a9510SRong-En Fan	x = startx + (int)temp;
5730*4a1a9510SRong-En Fan	wattron(win, color);
5731*4a1a9510SRong-En Fan	mvwprintw(win, y, x, "%s", string);
5732*4a1a9510SRong-En Fan	wattroff(win, color);
5733*4a1a9510SRong-En Fan	refresh();
5734*4a1a9510SRong-En Fan}</SPAN
5735*4a1a9510SRong-En Fan></PRE
5736*4a1a9510SRong-En Fan></DIV
5737*4a1a9510SRong-En Fan><P
5738*4a1a9510SRong-En Fan>This program is self-explanatory. In this example the number of choices has been
5739*4a1a9510SRong-En Fanincreased to ten, which is larger than our sub window size which can hold 6
5740*4a1a9510SRong-En Fanitems.  This message has to be explicitly conveyed to the menu system with the
5741*4a1a9510SRong-En Fanfunction set_menu_format(). In here we specify the number of rows and columns we
5742*4a1a9510SRong-En Fanwant to be displayed for a single page. We can specify any number of items to be
5743*4a1a9510SRong-En Fanshown, in the rows variables, if it is less than the height of the sub window.
5744*4a1a9510SRong-En FanIf the key pressed by the user is a PAGE UP or PAGE DOWN, the menu is scrolled a
5745*4a1a9510SRong-En Fanpage due to the requests (REQ_SCR_DPAGE and REQ_SCR_UPAGE) given to
5746*4a1a9510SRong-En Fanmenu_driver().</P
5747*4a1a9510SRong-En Fan></DIV
5748*4a1a9510SRong-En Fan><DIV
5749*4a1a9510SRong-En FanCLASS="SECT2"
5750*4a1a9510SRong-En Fan><HR><H3
5751*4a1a9510SRong-En FanCLASS="SECT2"
5752*4a1a9510SRong-En Fan><A
5753*4a1a9510SRong-En FanNAME="MULTICOLUMN"
5754*4a1a9510SRong-En Fan>17.6. Multi Columnar Menus</A
5755*4a1a9510SRong-En Fan></H3
5756*4a1a9510SRong-En Fan><P
5757*4a1a9510SRong-En Fan>In the above example you have seen how to use the function set_menu_format(). I
5758*4a1a9510SRong-En Fandidn't mention what the cols variable (third parameter) does. Well, If your sub
5759*4a1a9510SRong-En Fanwindow is wide enough, you can opt to display more than one item per row. This
5760*4a1a9510SRong-En Fancan be specified in the cols variable. To make things simpler, the following
5761*4a1a9510SRong-En Fanexample doesn't show descriptions for the items.</P
5762*4a1a9510SRong-En Fan><DIV
5763*4a1a9510SRong-En FanCLASS="EXAMPLE"
5764*4a1a9510SRong-En Fan><A
5765*4a1a9510SRong-En FanNAME="MMEMUCO"
5766*4a1a9510SRong-En Fan></A
5767*4a1a9510SRong-En Fan><P
5768*4a1a9510SRong-En Fan><B
5769*4a1a9510SRong-En Fan>Example 21.  Milt Columnar Menus Example </B
5770*4a1a9510SRong-En Fan></P
5771*4a1a9510SRong-En Fan><PRE
5772*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
5773*4a1a9510SRong-En Fan><SPAN
5774*4a1a9510SRong-En FanCLASS="INLINEMEDIAOBJECT"
5775*4a1a9510SRong-En Fan>#include &#60;curses.h&#62;
5776*4a1a9510SRong-En Fan#include &#60;menu.h&#62;
5777*4a1a9510SRong-En Fan
5778*4a1a9510SRong-En Fan#define ARRAY_SIZE(a) (sizeof(a) / sizeof(a[0]))
5779*4a1a9510SRong-En Fan#define CTRLD 	4
5780*4a1a9510SRong-En Fan
5781*4a1a9510SRong-En Fanchar *choices[] = {
5782*4a1a9510SRong-En Fan                        "Choice 1", "Choice 2", "Choice 3", "Choice 4", "Choice 5",
5783*4a1a9510SRong-En Fan			"Choice 6", "Choice 7", "Choice 8", "Choice 9", "Choice 10",
5784*4a1a9510SRong-En Fan			"Choice 11", "Choice 12", "Choice 13", "Choice 14", "Choice 15",
5785*4a1a9510SRong-En Fan			"Choice 16", "Choice 17", "Choice 18", "Choice 19", "Choice 20",
5786*4a1a9510SRong-En Fan                        "Exit",
5787*4a1a9510SRong-En Fan                        (char *)NULL,
5788*4a1a9510SRong-En Fan                  };
5789*4a1a9510SRong-En Fan
5790*4a1a9510SRong-En Fanint main()
5791*4a1a9510SRong-En Fan{	ITEM **my_items;
5792*4a1a9510SRong-En Fan	int c;
5793*4a1a9510SRong-En Fan	MENU *my_menu;
5794*4a1a9510SRong-En Fan        WINDOW *my_menu_win;
5795*4a1a9510SRong-En Fan        int n_choices, i;
5796*4a1a9510SRong-En Fan
5797*4a1a9510SRong-En Fan	/* Initialize curses */
5798*4a1a9510SRong-En Fan	initscr();
5799*4a1a9510SRong-En Fan	start_color();
5800*4a1a9510SRong-En Fan        cbreak();
5801*4a1a9510SRong-En Fan        noecho();
5802*4a1a9510SRong-En Fan	keypad(stdscr, TRUE);
5803*4a1a9510SRong-En Fan	init_pair(1, COLOR_RED, COLOR_BLACK);
5804*4a1a9510SRong-En Fan	init_pair(2, COLOR_CYAN, COLOR_BLACK);
5805*4a1a9510SRong-En Fan
5806*4a1a9510SRong-En Fan	/* Create items */
5807*4a1a9510SRong-En Fan        n_choices = ARRAY_SIZE(choices);
5808*4a1a9510SRong-En Fan        my_items = (ITEM **)calloc(n_choices, sizeof(ITEM *));
5809*4a1a9510SRong-En Fan        for(i = 0; i &#60; n_choices; ++i)
5810*4a1a9510SRong-En Fan                my_items[i] = new_item(choices[i], choices[i]);
5811*4a1a9510SRong-En Fan
5812*4a1a9510SRong-En Fan	/* Crate menu */
5813*4a1a9510SRong-En Fan	my_menu = new_menu((ITEM **)my_items);
5814*4a1a9510SRong-En Fan
5815*4a1a9510SRong-En Fan	/* Set menu option not to show the description */
5816*4a1a9510SRong-En Fan	menu_opts_off(my_menu, O_SHOWDESC);
5817*4a1a9510SRong-En Fan
5818*4a1a9510SRong-En Fan	/* Create the window to be associated with the menu */
5819*4a1a9510SRong-En Fan        my_menu_win = newwin(10, 70, 4, 4);
5820*4a1a9510SRong-En Fan        keypad(my_menu_win, TRUE);
5821*4a1a9510SRong-En Fan
5822*4a1a9510SRong-En Fan	/* Set main window and sub window */
5823*4a1a9510SRong-En Fan        set_menu_win(my_menu, my_menu_win);
5824*4a1a9510SRong-En Fan        set_menu_sub(my_menu, derwin(my_menu_win, 6, 68, 3, 1));
5825*4a1a9510SRong-En Fan	set_menu_format(my_menu, 5, 3);
5826*4a1a9510SRong-En Fan	set_menu_mark(my_menu, " * ");
5827*4a1a9510SRong-En Fan
5828*4a1a9510SRong-En Fan	/* Print a border around the main window and print a title */
5829*4a1a9510SRong-En Fan        box(my_menu_win, 0, 0);
5830*4a1a9510SRong-En Fan
5831*4a1a9510SRong-En Fan	attron(COLOR_PAIR(2));
5832*4a1a9510SRong-En Fan	mvprintw(LINES - 3, 0, "Use PageUp and PageDown to scroll");
5833*4a1a9510SRong-En Fan	mvprintw(LINES - 2, 0, "Use Arrow Keys to navigate (F1 to Exit)");
5834*4a1a9510SRong-En Fan	attroff(COLOR_PAIR(2));
5835*4a1a9510SRong-En Fan	refresh();
5836*4a1a9510SRong-En Fan
5837*4a1a9510SRong-En Fan	/* Post the menu */
5838*4a1a9510SRong-En Fan	post_menu(my_menu);
5839*4a1a9510SRong-En Fan	wrefresh(my_menu_win);
5840*4a1a9510SRong-En Fan
5841*4a1a9510SRong-En Fan	while((c = wgetch(my_menu_win)) != KEY_F(1))
5842*4a1a9510SRong-En Fan	{       switch(c)
5843*4a1a9510SRong-En Fan	        {	case KEY_DOWN:
5844*4a1a9510SRong-En Fan				menu_driver(my_menu, REQ_DOWN_ITEM);
5845*4a1a9510SRong-En Fan				break;
5846*4a1a9510SRong-En Fan			case KEY_UP:
5847*4a1a9510SRong-En Fan				menu_driver(my_menu, REQ_UP_ITEM);
5848*4a1a9510SRong-En Fan				break;
5849*4a1a9510SRong-En Fan			case KEY_LEFT:
5850*4a1a9510SRong-En Fan				menu_driver(my_menu, REQ_LEFT_ITEM);
5851*4a1a9510SRong-En Fan				break;
5852*4a1a9510SRong-En Fan			case KEY_RIGHT:
5853*4a1a9510SRong-En Fan				menu_driver(my_menu, REQ_RIGHT_ITEM);
5854*4a1a9510SRong-En Fan				break;
5855*4a1a9510SRong-En Fan			case KEY_NPAGE:
5856*4a1a9510SRong-En Fan				menu_driver(my_menu, REQ_SCR_DPAGE);
5857*4a1a9510SRong-En Fan				break;
5858*4a1a9510SRong-En Fan			case KEY_PPAGE:
5859*4a1a9510SRong-En Fan				menu_driver(my_menu, REQ_SCR_UPAGE);
5860*4a1a9510SRong-En Fan				break;
5861*4a1a9510SRong-En Fan		}
5862*4a1a9510SRong-En Fan                wrefresh(my_menu_win);
5863*4a1a9510SRong-En Fan	}
5864*4a1a9510SRong-En Fan
5865*4a1a9510SRong-En Fan	/* Unpost and free all the memory taken up */
5866*4a1a9510SRong-En Fan        unpost_menu(my_menu);
5867*4a1a9510SRong-En Fan        free_menu(my_menu);
5868*4a1a9510SRong-En Fan        for(i = 0; i &#60; n_choices; ++i)
5869*4a1a9510SRong-En Fan                free_item(my_items[i]);
5870*4a1a9510SRong-En Fan	endwin();
5871*4a1a9510SRong-En Fan}</SPAN
5872*4a1a9510SRong-En Fan></PRE
5873*4a1a9510SRong-En Fan></DIV
5874*4a1a9510SRong-En Fan><P
5875*4a1a9510SRong-En Fan>Watch the function call to set_menu_format(). It specifies the number of columns
5876*4a1a9510SRong-En Fanto be 3, thus displaying 3 items per row. We have also switched off the showing
5877*4a1a9510SRong-En Fandescriptions with the function menu_opts_off(). There are couple of functions
5878*4a1a9510SRong-En Fanset_menu_opts(),  menu_opts_on() and menu_opts() which can be used to manipulate
5879*4a1a9510SRong-En Fanmenu options. The following menu options can be specified.</P
5880*4a1a9510SRong-En Fan><PRE
5881*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
5882*4a1a9510SRong-En Fan>       O_ONEVALUE
5883*4a1a9510SRong-En Fan            Only one item can be selected for this menu.
5884*4a1a9510SRong-En Fan
5885*4a1a9510SRong-En Fan       O_SHOWDESC
5886*4a1a9510SRong-En Fan            Display  the  item  descriptions  when  the  menu  is
5887*4a1a9510SRong-En Fan            posted.
5888*4a1a9510SRong-En Fan
5889*4a1a9510SRong-En Fan       O_ROWMAJOR
5890*4a1a9510SRong-En Fan            Display the menu in row-major order.
5891*4a1a9510SRong-En Fan
5892*4a1a9510SRong-En Fan       O_IGNORECASE
5893*4a1a9510SRong-En Fan            Ignore the case when pattern-matching.
5894*4a1a9510SRong-En Fan
5895*4a1a9510SRong-En Fan       O_SHOWMATCH
5896*4a1a9510SRong-En Fan            Move the cursor to within the item  name  while  pat&shy;
5897*4a1a9510SRong-En Fan            tern-matching.
5898*4a1a9510SRong-En Fan
5899*4a1a9510SRong-En Fan       O_NONCYCLIC
5900*4a1a9510SRong-En Fan            Don't   wrap   around  next-item  and  previous-item,
5901*4a1a9510SRong-En Fan            requests to the other end of the menu.</PRE
5902*4a1a9510SRong-En Fan><P
5903*4a1a9510SRong-En Fan>All options are on by default. You can switch specific attributes on or off with
5904*4a1a9510SRong-En Fanmenu_opts_on() and menu_opts_off() functions. You can also use set_menu_opts()
5905*4a1a9510SRong-En Fanto directly specify the options. The argument to this function should be a OR ed
5906*4a1a9510SRong-En Fanvalue of some of those above constants. The function menu_opts() can be used to
5907*4a1a9510SRong-En Fanfind out a menu's present options. </P
5908*4a1a9510SRong-En Fan></DIV
5909*4a1a9510SRong-En Fan><DIV
5910*4a1a9510SRong-En FanCLASS="SECT2"
5911*4a1a9510SRong-En Fan><HR><H3
5912*4a1a9510SRong-En FanCLASS="SECT2"
5913*4a1a9510SRong-En Fan><A
5914*4a1a9510SRong-En FanNAME="MULTIVALUEMENUS"
5915*4a1a9510SRong-En Fan>17.7. Multi Valued Menus</A
5916*4a1a9510SRong-En Fan></H3
5917*4a1a9510SRong-En Fan><P
5918*4a1a9510SRong-En Fan>You might be wondering what if you switch off the option O_ONEVALUE. Then the
5919*4a1a9510SRong-En Fanmenu becomes multi-valued. That means you can select more than one item. This
5920*4a1a9510SRong-En Fanbrings us to the request REQ_TOGGLE_ITEM. Let's see it in action.</P
5921*4a1a9510SRong-En Fan><DIV
5922*4a1a9510SRong-En FanCLASS="EXAMPLE"
5923*4a1a9510SRong-En Fan><A
5924*4a1a9510SRong-En FanNAME="MMETO"
5925*4a1a9510SRong-En Fan></A
5926*4a1a9510SRong-En Fan><P
5927*4a1a9510SRong-En Fan><B
5928*4a1a9510SRong-En Fan>Example 22.  Multi Valued Menus example </B
5929*4a1a9510SRong-En Fan></P
5930*4a1a9510SRong-En Fan><PRE
5931*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
5932*4a1a9510SRong-En Fan><SPAN
5933*4a1a9510SRong-En FanCLASS="INLINEMEDIAOBJECT"
5934*4a1a9510SRong-En Fan>#include &#60;curses.h&#62;
5935*4a1a9510SRong-En Fan#include &#60;menu.h&#62;
5936*4a1a9510SRong-En Fan
5937*4a1a9510SRong-En Fan#define ARRAY_SIZE(a) (sizeof(a) / sizeof(a[0]))
5938*4a1a9510SRong-En Fan#define CTRLD 	4
5939*4a1a9510SRong-En Fan
5940*4a1a9510SRong-En Fanchar *choices[] = {
5941*4a1a9510SRong-En Fan                        "Choice 1",
5942*4a1a9510SRong-En Fan                        "Choice 2",
5943*4a1a9510SRong-En Fan                        "Choice 3",
5944*4a1a9510SRong-En Fan                        "Choice 4",
5945*4a1a9510SRong-En Fan			"Choice 5",
5946*4a1a9510SRong-En Fan			"Choice 6",
5947*4a1a9510SRong-En Fan			"Choice 7",
5948*4a1a9510SRong-En Fan                        "Exit",
5949*4a1a9510SRong-En Fan                  };
5950*4a1a9510SRong-En Fan
5951*4a1a9510SRong-En Fanint main()
5952*4a1a9510SRong-En Fan{	ITEM **my_items;
5953*4a1a9510SRong-En Fan	int c;
5954*4a1a9510SRong-En Fan	MENU *my_menu;
5955*4a1a9510SRong-En Fan        int n_choices, i;
5956*4a1a9510SRong-En Fan	ITEM *cur_item;
5957*4a1a9510SRong-En Fan
5958*4a1a9510SRong-En Fan	/* Initialize curses */
5959*4a1a9510SRong-En Fan	initscr();
5960*4a1a9510SRong-En Fan        cbreak();
5961*4a1a9510SRong-En Fan        noecho();
5962*4a1a9510SRong-En Fan	keypad(stdscr, TRUE);
5963*4a1a9510SRong-En Fan
5964*4a1a9510SRong-En Fan	/* Initialize items */
5965*4a1a9510SRong-En Fan        n_choices = ARRAY_SIZE(choices);
5966*4a1a9510SRong-En Fan        my_items = (ITEM **)calloc(n_choices + 1, sizeof(ITEM *));
5967*4a1a9510SRong-En Fan        for(i = 0; i &#60; n_choices; ++i)
5968*4a1a9510SRong-En Fan                my_items[i] = new_item(choices[i], choices[i]);
5969*4a1a9510SRong-En Fan	my_items[n_choices] = (ITEM *)NULL;
5970*4a1a9510SRong-En Fan
5971*4a1a9510SRong-En Fan	my_menu = new_menu((ITEM **)my_items);
5972*4a1a9510SRong-En Fan
5973*4a1a9510SRong-En Fan	/* Make the menu multi valued */
5974*4a1a9510SRong-En Fan	menu_opts_off(my_menu, O_ONEVALUE);
5975*4a1a9510SRong-En Fan
5976*4a1a9510SRong-En Fan	mvprintw(LINES - 3, 0, "Use &#60;SPACE&#62; to select or unselect an item.");
5977*4a1a9510SRong-En Fan	mvprintw(LINES - 2, 0, "&#60;ENTER&#62; to see presently selected items(F1 to Exit)");
5978*4a1a9510SRong-En Fan	post_menu(my_menu);
5979*4a1a9510SRong-En Fan	refresh();
5980*4a1a9510SRong-En Fan
5981*4a1a9510SRong-En Fan	while((c = getch()) != KEY_F(1))
5982*4a1a9510SRong-En Fan	{       switch(c)
5983*4a1a9510SRong-En Fan	        {	case KEY_DOWN:
5984*4a1a9510SRong-En Fan				menu_driver(my_menu, REQ_DOWN_ITEM);
5985*4a1a9510SRong-En Fan				break;
5986*4a1a9510SRong-En Fan			case KEY_UP:
5987*4a1a9510SRong-En Fan				menu_driver(my_menu, REQ_UP_ITEM);
5988*4a1a9510SRong-En Fan				break;
5989*4a1a9510SRong-En Fan			case ' ':
5990*4a1a9510SRong-En Fan				menu_driver(my_menu, REQ_TOGGLE_ITEM);
5991*4a1a9510SRong-En Fan				break;
5992*4a1a9510SRong-En Fan			case 10:	/* Enter */
5993*4a1a9510SRong-En Fan			{	char temp[200];
5994*4a1a9510SRong-En Fan				ITEM **items;
5995*4a1a9510SRong-En Fan
5996*4a1a9510SRong-En Fan				items = menu_items(my_menu);
5997*4a1a9510SRong-En Fan				temp[0] = '\0';
5998*4a1a9510SRong-En Fan				for(i = 0; i &#60; item_count(my_menu); ++i)
5999*4a1a9510SRong-En Fan					if(item_value(items[i]) == TRUE)
6000*4a1a9510SRong-En Fan					{	strcat(temp, item_name(items[i]));
6001*4a1a9510SRong-En Fan						strcat(temp, " ");
6002*4a1a9510SRong-En Fan					}
6003*4a1a9510SRong-En Fan				move(20, 0);
6004*4a1a9510SRong-En Fan				clrtoeol();
6005*4a1a9510SRong-En Fan				mvprintw(20, 0, temp);
6006*4a1a9510SRong-En Fan				refresh();
6007*4a1a9510SRong-En Fan			}
6008*4a1a9510SRong-En Fan			break;
6009*4a1a9510SRong-En Fan		}
6010*4a1a9510SRong-En Fan	}
6011*4a1a9510SRong-En Fan
6012*4a1a9510SRong-En Fan	free_item(my_items[0]);
6013*4a1a9510SRong-En Fan        free_item(my_items[1]);
6014*4a1a9510SRong-En Fan	free_menu(my_menu);
6015*4a1a9510SRong-En Fan	endwin();
6016*4a1a9510SRong-En Fan}
6017*4a1a9510SRong-En Fan	</SPAN
6018*4a1a9510SRong-En Fan></PRE
6019*4a1a9510SRong-En Fan></DIV
6020*4a1a9510SRong-En Fan><P
6021*4a1a9510SRong-En Fan>Whew, A lot of new functions. Let's take them one after another. Firstly, the
6022*4a1a9510SRong-En FanREQ_TOGGLE_ITEM.  In a multi-valued menu, the user should be allowed to select
6023*4a1a9510SRong-En Fanor un select more than one item. The request REQ_TOGGLE_ITEM toggles the present
6024*4a1a9510SRong-En Fanselection. In this case when space is pressed REQ_TOGGLE_ITEM request is sent to
6025*4a1a9510SRong-En Fanmenu_driver to achieve the result.</P
6026*4a1a9510SRong-En Fan><P
6027*4a1a9510SRong-En Fan>Now when the user presses &lt;ENTER&gt; we show the items he presently selected.
6028*4a1a9510SRong-En FanFirst we find out the items associated with the menu using the function
6029*4a1a9510SRong-En Fanmenu_items(). Then we loop through the items to find out if the item is selected
6030*4a1a9510SRong-En Fanor not. The function item_value() returns TRUE if an item is selected. The
6031*4a1a9510SRong-En Fanfunction item_count() returns the number of items in the menu. The item name can
6032*4a1a9510SRong-En Fanbe found with item_name(). You can also find the description associated with an
6033*4a1a9510SRong-En Fanitem using item_description().</P
6034*4a1a9510SRong-En Fan></DIV
6035*4a1a9510SRong-En Fan><DIV
6036*4a1a9510SRong-En FanCLASS="SECT2"
6037*4a1a9510SRong-En Fan><HR><H3
6038*4a1a9510SRong-En FanCLASS="SECT2"
6039*4a1a9510SRong-En Fan><A
6040*4a1a9510SRong-En FanNAME="MENUOPT"
6041*4a1a9510SRong-En Fan>17.8. Menu Options</A
6042*4a1a9510SRong-En Fan></H3
6043*4a1a9510SRong-En Fan><P
6044*4a1a9510SRong-En Fan>Well, by this time you must be itching for some difference in your menu, with
6045*4a1a9510SRong-En Fanlots of functionality. I know. You want Colors !!!. You want to create nice
6046*4a1a9510SRong-En Fanmenus similar to those text mode <A
6047*4a1a9510SRong-En FanHREF="http://www.jersey.net/~debinjoe/games/"
6048*4a1a9510SRong-En FanTARGET="_top"
6049*4a1a9510SRong-En Fan>dos games</A
6050*4a1a9510SRong-En Fan>. The functions
6051*4a1a9510SRong-En Fanset_menu_fore() and set_menu_back() can be used to change the attribute of the
6052*4a1a9510SRong-En Fanselected item and unselected item. The names are misleading. They don't change
6053*4a1a9510SRong-En Fanmenu's foreground or background which would have been useless. </P
6054*4a1a9510SRong-En Fan><P
6055*4a1a9510SRong-En Fan>The function set_menu_grey() can be used to set the display attribute for the
6056*4a1a9510SRong-En Fannon-selectable items in the menu. This brings us to the interesting option for
6057*4a1a9510SRong-En Fanan item the one and only O_SELECTABLE. We can turn it off by the function
6058*4a1a9510SRong-En Fanitem_opts_off() and after that that item is not selectable. It's like a grayed
6059*4a1a9510SRong-En Fanitem in those fancy windows menus. Let's put these concepts in practice with
6060*4a1a9510SRong-En Fanthis example</P
6061*4a1a9510SRong-En Fan><DIV
6062*4a1a9510SRong-En FanCLASS="EXAMPLE"
6063*4a1a9510SRong-En Fan><A
6064*4a1a9510SRong-En FanNAME="MMEAT"
6065*4a1a9510SRong-En Fan></A
6066*4a1a9510SRong-En Fan><P
6067*4a1a9510SRong-En Fan><B
6068*4a1a9510SRong-En Fan>Example 23.  Menu Options example </B
6069*4a1a9510SRong-En Fan></P
6070*4a1a9510SRong-En Fan><PRE
6071*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
6072*4a1a9510SRong-En Fan><SPAN
6073*4a1a9510SRong-En FanCLASS="INLINEMEDIAOBJECT"
6074*4a1a9510SRong-En Fan>#include &#60;menu.h&#62;
6075*4a1a9510SRong-En Fan
6076*4a1a9510SRong-En Fan#define ARRAY_SIZE(a) (sizeof(a) / sizeof(a[0]))
6077*4a1a9510SRong-En Fan#define CTRLD 	4
6078*4a1a9510SRong-En Fan
6079*4a1a9510SRong-En Fanchar *choices[] = {
6080*4a1a9510SRong-En Fan                        "Choice 1",
6081*4a1a9510SRong-En Fan                        "Choice 2",
6082*4a1a9510SRong-En Fan                        "Choice 3",
6083*4a1a9510SRong-En Fan                        "Choice 4",
6084*4a1a9510SRong-En Fan			"Choice 5",
6085*4a1a9510SRong-En Fan			"Choice 6",
6086*4a1a9510SRong-En Fan			"Choice 7",
6087*4a1a9510SRong-En Fan                        "Exit",
6088*4a1a9510SRong-En Fan                  };
6089*4a1a9510SRong-En Fan
6090*4a1a9510SRong-En Fanint main()
6091*4a1a9510SRong-En Fan{	ITEM **my_items;
6092*4a1a9510SRong-En Fan	int c;
6093*4a1a9510SRong-En Fan	MENU *my_menu;
6094*4a1a9510SRong-En Fan        int n_choices, i;
6095*4a1a9510SRong-En Fan	ITEM *cur_item;
6096*4a1a9510SRong-En Fan
6097*4a1a9510SRong-En Fan	/* Initialize curses */
6098*4a1a9510SRong-En Fan	initscr();
6099*4a1a9510SRong-En Fan	start_color();
6100*4a1a9510SRong-En Fan        cbreak();
6101*4a1a9510SRong-En Fan        noecho();
6102*4a1a9510SRong-En Fan	keypad(stdscr, TRUE);
6103*4a1a9510SRong-En Fan	init_pair(1, COLOR_RED, COLOR_BLACK);
6104*4a1a9510SRong-En Fan	init_pair(2, COLOR_GREEN, COLOR_BLACK);
6105*4a1a9510SRong-En Fan	init_pair(3, COLOR_MAGENTA, COLOR_BLACK);
6106*4a1a9510SRong-En Fan
6107*4a1a9510SRong-En Fan	/* Initialize items */
6108*4a1a9510SRong-En Fan        n_choices = ARRAY_SIZE(choices);
6109*4a1a9510SRong-En Fan        my_items = (ITEM **)calloc(n_choices + 1, sizeof(ITEM *));
6110*4a1a9510SRong-En Fan        for(i = 0; i &#60; n_choices; ++i)
6111*4a1a9510SRong-En Fan                my_items[i] = new_item(choices[i], choices[i]);
6112*4a1a9510SRong-En Fan	my_items[n_choices] = (ITEM *)NULL;
6113*4a1a9510SRong-En Fan	item_opts_off(my_items[3], O_SELECTABLE);
6114*4a1a9510SRong-En Fan	item_opts_off(my_items[6], O_SELECTABLE);
6115*4a1a9510SRong-En Fan
6116*4a1a9510SRong-En Fan	/* Create menu */
6117*4a1a9510SRong-En Fan	my_menu = new_menu((ITEM **)my_items);
6118*4a1a9510SRong-En Fan
6119*4a1a9510SRong-En Fan	/* Set fore ground and back ground of the menu */
6120*4a1a9510SRong-En Fan	set_menu_fore(my_menu, COLOR_PAIR(1) | A_REVERSE);
6121*4a1a9510SRong-En Fan	set_menu_back(my_menu, COLOR_PAIR(2));
6122*4a1a9510SRong-En Fan	set_menu_grey(my_menu, COLOR_PAIR(3));
6123*4a1a9510SRong-En Fan
6124*4a1a9510SRong-En Fan	/* Post the menu */
6125*4a1a9510SRong-En Fan	mvprintw(LINES - 3, 0, "Press &#60;ENTER&#62; to see the option selected");
6126*4a1a9510SRong-En Fan	mvprintw(LINES - 2, 0, "Up and Down arrow keys to naviage (F1 to Exit)");
6127*4a1a9510SRong-En Fan	post_menu(my_menu);
6128*4a1a9510SRong-En Fan	refresh();
6129*4a1a9510SRong-En Fan
6130*4a1a9510SRong-En Fan	while((c = getch()) != KEY_F(1))
6131*4a1a9510SRong-En Fan	{       switch(c)
6132*4a1a9510SRong-En Fan	        {	case KEY_DOWN:
6133*4a1a9510SRong-En Fan				menu_driver(my_menu, REQ_DOWN_ITEM);
6134*4a1a9510SRong-En Fan				break;
6135*4a1a9510SRong-En Fan			case KEY_UP:
6136*4a1a9510SRong-En Fan				menu_driver(my_menu, REQ_UP_ITEM);
6137*4a1a9510SRong-En Fan				break;
6138*4a1a9510SRong-En Fan			case 10: /* Enter */
6139*4a1a9510SRong-En Fan				move(20, 0);
6140*4a1a9510SRong-En Fan				clrtoeol();
6141*4a1a9510SRong-En Fan				mvprintw(20, 0, "Item selected is : %s",
6142*4a1a9510SRong-En Fan						item_name(current_item(my_menu)));
6143*4a1a9510SRong-En Fan				pos_menu_cursor(my_menu);
6144*4a1a9510SRong-En Fan				break;
6145*4a1a9510SRong-En Fan		}
6146*4a1a9510SRong-En Fan	}
6147*4a1a9510SRong-En Fan	unpost_menu(my_menu);
6148*4a1a9510SRong-En Fan	for(i = 0; i &#60; n_choices; ++i)
6149*4a1a9510SRong-En Fan		free_item(my_items[i]);
6150*4a1a9510SRong-En Fan	free_menu(my_menu);
6151*4a1a9510SRong-En Fan	endwin();
6152*4a1a9510SRong-En Fan}
6153*4a1a9510SRong-En Fan	</SPAN
6154*4a1a9510SRong-En Fan></PRE
6155*4a1a9510SRong-En Fan></DIV
6156*4a1a9510SRong-En Fan></DIV
6157*4a1a9510SRong-En Fan><DIV
6158*4a1a9510SRong-En FanCLASS="SECT2"
6159*4a1a9510SRong-En Fan><HR><H3
6160*4a1a9510SRong-En FanCLASS="SECT2"
6161*4a1a9510SRong-En Fan><A
6162*4a1a9510SRong-En FanNAME="MENUUSERPTR"
6163*4a1a9510SRong-En Fan>17.9. The useful User Pointer</A
6164*4a1a9510SRong-En Fan></H3
6165*4a1a9510SRong-En Fan><P
6166*4a1a9510SRong-En Fan>We can associate a user pointer with each item in the menu. It works the same
6167*4a1a9510SRong-En Fanway as user pointer in panels. It's not touched by menu system. You can store
6168*4a1a9510SRong-En Fanany thing you like in that. I usually use it to store the function to be
6169*4a1a9510SRong-En Fanexecuted when the menu option is chosen (It's selected and may be the user
6170*4a1a9510SRong-En Fanpressed &lt;ENTER&gt;);</P
6171*4a1a9510SRong-En Fan><DIV
6172*4a1a9510SRong-En FanCLASS="EXAMPLE"
6173*4a1a9510SRong-En Fan><A
6174*4a1a9510SRong-En FanNAME="MMEUS"
6175*4a1a9510SRong-En Fan></A
6176*4a1a9510SRong-En Fan><P
6177*4a1a9510SRong-En Fan><B
6178*4a1a9510SRong-En Fan>Example 24.  Menu User Pointer Usage </B
6179*4a1a9510SRong-En Fan></P
6180*4a1a9510SRong-En Fan><PRE
6181*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
6182*4a1a9510SRong-En Fan><SPAN
6183*4a1a9510SRong-En FanCLASS="INLINEMEDIAOBJECT"
6184*4a1a9510SRong-En Fan>#include &#60;curses.h&#62;
6185*4a1a9510SRong-En Fan#include &#60;menu.h&#62;
6186*4a1a9510SRong-En Fan
6187*4a1a9510SRong-En Fan#define ARRAY_SIZE(a) (sizeof(a) / sizeof(a[0]))
6188*4a1a9510SRong-En Fan#define CTRLD 	4
6189*4a1a9510SRong-En Fan
6190*4a1a9510SRong-En Fanchar *choices[] = {
6191*4a1a9510SRong-En Fan                        "Choice 1",
6192*4a1a9510SRong-En Fan                        "Choice 2",
6193*4a1a9510SRong-En Fan                        "Choice 3",
6194*4a1a9510SRong-En Fan                        "Choice 4",
6195*4a1a9510SRong-En Fan			"Choice 5",
6196*4a1a9510SRong-En Fan			"Choice 6",
6197*4a1a9510SRong-En Fan			"Choice 7",
6198*4a1a9510SRong-En Fan                        "Exit",
6199*4a1a9510SRong-En Fan                  };
6200*4a1a9510SRong-En Fanvoid func(char *name);
6201*4a1a9510SRong-En Fan
6202*4a1a9510SRong-En Fanint main()
6203*4a1a9510SRong-En Fan{	ITEM **my_items;
6204*4a1a9510SRong-En Fan	int c;
6205*4a1a9510SRong-En Fan	MENU *my_menu;
6206*4a1a9510SRong-En Fan        int n_choices, i;
6207*4a1a9510SRong-En Fan	ITEM *cur_item;
6208*4a1a9510SRong-En Fan
6209*4a1a9510SRong-En Fan	/* Initialize curses */
6210*4a1a9510SRong-En Fan	initscr();
6211*4a1a9510SRong-En Fan	start_color();
6212*4a1a9510SRong-En Fan        cbreak();
6213*4a1a9510SRong-En Fan        noecho();
6214*4a1a9510SRong-En Fan	keypad(stdscr, TRUE);
6215*4a1a9510SRong-En Fan	init_pair(1, COLOR_RED, COLOR_BLACK);
6216*4a1a9510SRong-En Fan	init_pair(2, COLOR_GREEN, COLOR_BLACK);
6217*4a1a9510SRong-En Fan	init_pair(3, COLOR_MAGENTA, COLOR_BLACK);
6218*4a1a9510SRong-En Fan
6219*4a1a9510SRong-En Fan	/* Initialize items */
6220*4a1a9510SRong-En Fan        n_choices = ARRAY_SIZE(choices);
6221*4a1a9510SRong-En Fan        my_items = (ITEM **)calloc(n_choices + 1, sizeof(ITEM *));
6222*4a1a9510SRong-En Fan        for(i = 0; i &#60; n_choices; ++i)
6223*4a1a9510SRong-En Fan	{       my_items[i] = new_item(choices[i], choices[i]);
6224*4a1a9510SRong-En Fan		/* Set the user pointer */
6225*4a1a9510SRong-En Fan		set_item_userptr(my_items[i], func);
6226*4a1a9510SRong-En Fan	}
6227*4a1a9510SRong-En Fan	my_items[n_choices] = (ITEM *)NULL;
6228*4a1a9510SRong-En Fan
6229*4a1a9510SRong-En Fan	/* Create menu */
6230*4a1a9510SRong-En Fan	my_menu = new_menu((ITEM **)my_items);
6231*4a1a9510SRong-En Fan
6232*4a1a9510SRong-En Fan	/* Post the menu */
6233*4a1a9510SRong-En Fan	mvprintw(LINES - 3, 0, "Press &#60;ENTER&#62; to see the option selected");
6234*4a1a9510SRong-En Fan	mvprintw(LINES - 2, 0, "Up and Down arrow keys to naviage (F1 to Exit)");
6235*4a1a9510SRong-En Fan	post_menu(my_menu);
6236*4a1a9510SRong-En Fan	refresh();
6237*4a1a9510SRong-En Fan
6238*4a1a9510SRong-En Fan	while((c = getch()) != KEY_F(1))
6239*4a1a9510SRong-En Fan	{       switch(c)
6240*4a1a9510SRong-En Fan	        {	case KEY_DOWN:
6241*4a1a9510SRong-En Fan				menu_driver(my_menu, REQ_DOWN_ITEM);
6242*4a1a9510SRong-En Fan				break;
6243*4a1a9510SRong-En Fan			case KEY_UP:
6244*4a1a9510SRong-En Fan				menu_driver(my_menu, REQ_UP_ITEM);
6245*4a1a9510SRong-En Fan				break;
6246*4a1a9510SRong-En Fan			case 10: /* Enter */
6247*4a1a9510SRong-En Fan			{	ITEM *cur;
6248*4a1a9510SRong-En Fan				void (*p)(char *);
6249*4a1a9510SRong-En Fan
6250*4a1a9510SRong-En Fan				cur = current_item(my_menu);
6251*4a1a9510SRong-En Fan				p = item_userptr(cur);
6252*4a1a9510SRong-En Fan				p((char *)item_name(cur));
6253*4a1a9510SRong-En Fan				pos_menu_cursor(my_menu);
6254*4a1a9510SRong-En Fan				break;
6255*4a1a9510SRong-En Fan			}
6256*4a1a9510SRong-En Fan			break;
6257*4a1a9510SRong-En Fan		}
6258*4a1a9510SRong-En Fan	}
6259*4a1a9510SRong-En Fan	unpost_menu(my_menu);
6260*4a1a9510SRong-En Fan	for(i = 0; i &#60; n_choices; ++i)
6261*4a1a9510SRong-En Fan		free_item(my_items[i]);
6262*4a1a9510SRong-En Fan	free_menu(my_menu);
6263*4a1a9510SRong-En Fan	endwin();
6264*4a1a9510SRong-En Fan}
6265*4a1a9510SRong-En Fan
6266*4a1a9510SRong-En Fanvoid func(char *name)
6267*4a1a9510SRong-En Fan{	move(20, 0);
6268*4a1a9510SRong-En Fan	clrtoeol();
6269*4a1a9510SRong-En Fan	mvprintw(20, 0, "Item selected is : %s", name);
6270*4a1a9510SRong-En Fan}	</SPAN
6271*4a1a9510SRong-En Fan></PRE
6272*4a1a9510SRong-En Fan></DIV
6273*4a1a9510SRong-En Fan></DIV
6274*4a1a9510SRong-En Fan></DIV
6275*4a1a9510SRong-En Fan><DIV
6276*4a1a9510SRong-En FanCLASS="SECT1"
6277*4a1a9510SRong-En Fan><HR><H2
6278*4a1a9510SRong-En FanCLASS="SECT1"
6279*4a1a9510SRong-En Fan><A
6280*4a1a9510SRong-En FanNAME="FORMS"
6281*4a1a9510SRong-En Fan>18. Forms Library</A
6282*4a1a9510SRong-En Fan></H2
6283*4a1a9510SRong-En Fan><P
6284*4a1a9510SRong-En Fan>Well. If you have seen those forms on web pages which take input from users and
6285*4a1a9510SRong-En Fando various kinds of things, you might be wondering how would any one create such
6286*4a1a9510SRong-En Fanforms in text mode display. It's quite difficult to write those nifty forms in
6287*4a1a9510SRong-En Fanplain ncurses. Forms library tries to provide a basic frame work to build and
6288*4a1a9510SRong-En Fanmaintain forms with ease. It has lot of features(functions) which manage
6289*4a1a9510SRong-En Fanvalidation, dynamic expansion of fields etc.. Let's see it in full flow.</P
6290*4a1a9510SRong-En Fan><P
6291*4a1a9510SRong-En Fan>A form is a collection of fields; each field can be either a label(static text)
6292*4a1a9510SRong-En Fanor a data-entry location. The forms also library provides functions to divide
6293*4a1a9510SRong-En Fanforms into multiple pages. </P
6294*4a1a9510SRong-En Fan><DIV
6295*4a1a9510SRong-En FanCLASS="SECT2"
6296*4a1a9510SRong-En Fan><HR><H3
6297*4a1a9510SRong-En FanCLASS="SECT2"
6298*4a1a9510SRong-En Fan><A
6299*4a1a9510SRong-En FanNAME="FORMBASICS"
6300*4a1a9510SRong-En Fan>18.1. The Basics</A
6301*4a1a9510SRong-En Fan></H3
6302*4a1a9510SRong-En Fan><P
6303*4a1a9510SRong-En Fan>Forms are created in much the same way as menus. First the fields related to the
6304*4a1a9510SRong-En Fanform are created with new_field(). You can set options for the fields, so that
6305*4a1a9510SRong-En Fanthey can be displayed with some fancy attributes, validated before the field
6306*4a1a9510SRong-En Fanlooses focus etc.. Then the fields are attached to form. After this, the form
6307*4a1a9510SRong-En Fancan be posted to display and is ready to receive inputs. On the similar lines to
6308*4a1a9510SRong-En Fanmenu_driver(), the form is manipulated with form_driver(). We can send requests
6309*4a1a9510SRong-En Fanto form_driver to move focus to a certain field, move cursor to end of the field
6310*4a1a9510SRong-En Fanetc..  After the user enters values in the fields and validation done, form can
6311*4a1a9510SRong-En Fanbe unposted and memory allocated can be freed.</P
6312*4a1a9510SRong-En Fan><P
6313*4a1a9510SRong-En Fan>The general flow of control of a forms program looks like this.
6314*4a1a9510SRong-En Fan
6315*4a1a9510SRong-En Fan<P
6316*4a1a9510SRong-En Fan></P
6317*4a1a9510SRong-En Fan><OL
6318*4a1a9510SRong-En FanTYPE="1"
6319*4a1a9510SRong-En Fan><LI
6320*4a1a9510SRong-En Fan><P
6321*4a1a9510SRong-En Fan>Initialize curses</P
6322*4a1a9510SRong-En Fan></LI
6323*4a1a9510SRong-En Fan><LI
6324*4a1a9510SRong-En Fan><P
6325*4a1a9510SRong-En Fan>Create fields using new_field(). You can specify the height and
6326*4a1a9510SRong-En Fanwidth of the field, and its position on the form.</P
6327*4a1a9510SRong-En Fan></LI
6328*4a1a9510SRong-En Fan><LI
6329*4a1a9510SRong-En Fan><P
6330*4a1a9510SRong-En Fan>Create the forms with new_form() by specifying the fields to be
6331*4a1a9510SRong-En Fanattached with.</P
6332*4a1a9510SRong-En Fan></LI
6333*4a1a9510SRong-En Fan><LI
6334*4a1a9510SRong-En Fan><P
6335*4a1a9510SRong-En Fan>Post the form with form_post() and refresh the screen.</P
6336*4a1a9510SRong-En Fan></LI
6337*4a1a9510SRong-En Fan><LI
6338*4a1a9510SRong-En Fan><P
6339*4a1a9510SRong-En Fan>Process the user requests with a loop and do necessary updates
6340*4a1a9510SRong-En Fanto form with form_driver.</P
6341*4a1a9510SRong-En Fan></LI
6342*4a1a9510SRong-En Fan><LI
6343*4a1a9510SRong-En Fan><P
6344*4a1a9510SRong-En Fan>Unpost the menu with form_unpost()</P
6345*4a1a9510SRong-En Fan></LI
6346*4a1a9510SRong-En Fan><LI
6347*4a1a9510SRong-En Fan><P
6348*4a1a9510SRong-En Fan>Free the memory allocated to menu by free_form()</P
6349*4a1a9510SRong-En Fan></LI
6350*4a1a9510SRong-En Fan><LI
6351*4a1a9510SRong-En Fan><P
6352*4a1a9510SRong-En Fan>Free the memory allocated to the items with free_field()</P
6353*4a1a9510SRong-En Fan></LI
6354*4a1a9510SRong-En Fan><LI
6355*4a1a9510SRong-En Fan><P
6356*4a1a9510SRong-En Fan>End curses</P
6357*4a1a9510SRong-En Fan></LI
6358*4a1a9510SRong-En Fan></OL
6359*4a1a9510SRong-En Fan></P
6360*4a1a9510SRong-En Fan><P
6361*4a1a9510SRong-En Fan>As you can see, working with forms library is much similar to handling menu
6362*4a1a9510SRong-En Fanlibrary.  The following examples will explore various aspects of form
6363*4a1a9510SRong-En Fanprocessing. Let's start the journey with a simple example.  first.</P
6364*4a1a9510SRong-En Fan></DIV
6365*4a1a9510SRong-En Fan><DIV
6366*4a1a9510SRong-En FanCLASS="SECT2"
6367*4a1a9510SRong-En Fan><HR><H3
6368*4a1a9510SRong-En FanCLASS="SECT2"
6369*4a1a9510SRong-En Fan><A
6370*4a1a9510SRong-En FanNAME="COMPILEFORMS"
6371*4a1a9510SRong-En Fan>18.2. Compiling With the Forms Library</A
6372*4a1a9510SRong-En Fan></H3
6373*4a1a9510SRong-En Fan><P
6374*4a1a9510SRong-En Fan>To use forms library functions, you have to include form.h and to link the
6375*4a1a9510SRong-En Fanprogram with forms library the flag -lform should be added along with -lncurses
6376*4a1a9510SRong-En Fanin that order.</P
6377*4a1a9510SRong-En Fan><PRE
6378*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
6379*4a1a9510SRong-En Fan>    #include &lt;form.h&gt;
6380*4a1a9510SRong-En Fan    .
6381*4a1a9510SRong-En Fan    .
6382*4a1a9510SRong-En Fan    .
6383*4a1a9510SRong-En Fan
6384*4a1a9510SRong-En Fan    compile and link: gcc &lt;program file&gt; -lform -lncurses</PRE
6385*4a1a9510SRong-En Fan><DIV
6386*4a1a9510SRong-En FanCLASS="EXAMPLE"
6387*4a1a9510SRong-En Fan><A
6388*4a1a9510SRong-En FanNAME="FFOSI"
6389*4a1a9510SRong-En Fan></A
6390*4a1a9510SRong-En Fan><P
6391*4a1a9510SRong-En Fan><B
6392*4a1a9510SRong-En Fan>Example 25.  Forms Basics </B
6393*4a1a9510SRong-En Fan></P
6394*4a1a9510SRong-En Fan><PRE
6395*4a1a9510SRong-En FanCLASS="PROGRAMLISTING"
6396*4a1a9510SRong-En Fan><SPAN
6397*4a1a9510SRong-En FanCLASS="INLINEMEDIAOBJECT"
6398*4a1a9510SRong-En Fan>#include &#60;form.h&#62;
6399*4a1a9510SRong-En Fan
6400*4a1a9510SRong-En Fanint main()
6401*4a1a9510SRong-En Fan{	FIELD *field[3];
6402*4a1a9510SRong-En Fan	FORM  *my_form;
6403*4a1a9510SRong-En Fan	int ch;
6404*4a1a9510SRong-En Fan
6405*4a1a9510SRong-En Fan	/* Initialize curses */
6406*4a1a9510SRong-En Fan	initscr();
6407*4a1a9510SRong-En Fan	cbreak();
6408*4a1a9510SRong-En Fan	noecho();
6409*4a1a9510SRong-En Fan	keypad(stdscr, TRUE);
6410*4a1a9510SRong-En Fan
6411*4a1a9510SRong-En Fan	/* Initialize the fields */
6412*4a1a9510SRong-En Fan	field[0] = new_field(1, 10, 4, 18, 0, 0);
6413*4a1a9510SRong-En Fan	field[1] = new_field(1, 10, 6, 18, 0, 0);
6414	field[2] = NULL;
6415
6416	/* Set field options */
6417	set_field_back(field[0], A_UNDERLINE); 	/* Print a line for the option 	*/
6418	field_opts_off(field[0], O_AUTOSKIP);  	/* Don't go to next field when this */
6419						/* Field is filled up 		*/
6420	set_field_back(field[1], A_UNDERLINE);
6421	field_opts_off(field[1], O_AUTOSKIP);
6422
6423	/* Create the form and post it */
6424	my_form = new_form(field);
6425	post_form(my_form);
6426	refresh();
6427
6428	mvprintw(4, 10, "Value 1:");
6429	mvprintw(6, 10, "Value 2:");
6430	refresh();
6431
6432	/* Loop through to get user requests */
6433	while((ch = getch()) != KEY_F(1))
6434	{	switch(ch)
6435		{	case KEY_DOWN:
6436				/* Go to next field */
6437				form_driver(my_form, REQ_NEXT_FIELD);
6438				/* Go to the end of the present buffer */
6439				/* Leaves nicely at the last character */
6440				form_driver(my_form, REQ_END_LINE);
6441				break;
6442			case KEY_UP:
6443				/* Go to previous field */
6444				form_driver(my_form, REQ_PREV_FIELD);
6445				form_driver(my_form, REQ_END_LINE);
6446				break;
6447			default:
6448				/* If this is a normal character, it gets */
6449				/* Printed				  */
6450				form_driver(my_form, ch);
6451				break;
6452		}
6453	}
6454
6455	/* Un post form and free the memory */
6456	unpost_form(my_form);
6457	free_form(my_form);
6458	free_field(field[0]);
6459	free_field(field[1]);
6460
6461	endwin();
6462	return 0;
6463}</SPAN
6464></PRE
6465></DIV
6466><P
6467>Above example is pretty straight forward. It creates two fields with
6468<TT
6469CLASS="LITERAL"
6470>new_field()</TT
6471>.  new_field() takes height, width,
6472starty, startx, number of offscreen rows and number of additional working
6473buffers. The fifth argument number of offscreen rows specifies how much of the
6474field to be shown. If it is zero, the entire field is always displayed otherwise
6475the form will be scrollable when the user accesses not displayed parts of the
6476field.  The forms library allocates one buffer per field to store the data user
6477enters. Using the last parameter to new_field() we can specify it to allocate
6478some additional buffers.  These can be used for any purpose you like.</P
6479><P
6480>After creating the fields, back ground attribute of both of them is set to an
6481underscore with set_field_back(). The AUTOSKIP option is turned off using
6482field_opts_off().  If this option is turned on, focus will move to the next
6483field in the form once the active field is filled up completely.</P
6484><P
6485>After attaching the fields to the form, it is posted. Here on, user inputs are
6486processed in the while loop, by making corresponding requests to form_driver.
6487The details of all the requests to the form_driver() are explained later.</P
6488></DIV
6489><DIV
6490CLASS="SECT2"
6491><HR><H3
6492CLASS="SECT2"
6493><A
6494NAME="PLAYFIELDS"
6495>18.3. Playing with Fields</A
6496></H3
6497><P
6498>Each form field is associated with a lot of attributes. They can be manipulated
6499to get the required effect and to have fun !!!. So why wait? </P
6500><DIV
6501CLASS="SECT3"
6502><HR><H4
6503CLASS="SECT3"
6504><A
6505NAME="FETCHINFO"
6506>18.3.1. Fetching Size and Location of Field</A
6507></H4
6508><P
6509>The parameters we have given at the time of creation of a field can be retrieved
6510with field_info(). It returns height, width, starty, startx, number of offscreen
6511rows, and number of additional buffers into the parameters given to it. It is a
6512sort of inverse of new_field().</P
6513><PRE
6514CLASS="PROGRAMLISTING"
6515>int field_info(     FIELD *field,              /* field from which to fetch */
6516                    int *height, *int width,   /* field size */
6517                    int *top, int *left,       /* upper left corner */
6518                    int *offscreen,            /* number of offscreen rows */
6519                    int *nbuf);                /* number of working buffers */</PRE
6520></DIV
6521><DIV
6522CLASS="SECT3"
6523><HR><H4
6524CLASS="SECT3"
6525><A
6526NAME="MOVEFIELD"
6527>18.3.2. Moving the field</A
6528></H4
6529><P
6530>The location of the field can be moved to a different position with
6531move_field().</P
6532><PRE
6533CLASS="PROGRAMLISTING"
6534>int move_field(    FIELD *field,              /* field to alter */
6535                   int top, int left);        /* new upper-left corner */</PRE
6536><P
6537>As usual, the changed position can be queried with field_infor().</P
6538></DIV
6539><DIV
6540CLASS="SECT3"
6541><HR><H4
6542CLASS="SECT3"
6543><A
6544NAME="JUSTIFYFIELD"
6545>18.3.3. Field Justification</A
6546></H4
6547><P
6548>The justification to be done for the field can be fixed using the function
6549set_field_just().</P
6550><PRE
6551CLASS="PROGRAMLISTING"
6552>    int set_field_just(FIELD *field,          /* field to alter */
6553               int justmode);         /* mode to set */
6554    int field_just(FIELD *field);          /* fetch justify mode of field */</PRE
6555><P
6556>The justification mode valued accepted and returned by these functions are
6557NO_JUSTIFICATION, JUSTIFY_RIGHT, JUSTIFY_LEFT, or JUSTIFY_CENTER.</P
6558></DIV
6559><DIV
6560CLASS="SECT3"
6561><HR><H4
6562CLASS="SECT3"
6563><A
6564NAME="FIELDDISPATTRIB"
6565>18.3.4. Field Display Attributes</A
6566></H4
6567><P
6568>As you have seen, in the above example, display attribute for the fields can be
6569set with set_field_fore() and setfield_back(). These functions set foreground
6570and background attribute of the fields. You can also specify a pad character
6571which will be filled in the unfilled portion of the field. The pad character is
6572set with a call to set_field_pad(). Default pad value is a space. The functions
6573field_fore(), field_back, field_pad() can be used to query the present
6574foreground, background attributes and pad character for the field. The following
6575list gives the usage of functions.</P
6576><PRE
6577CLASS="PROGRAMLISTING"
6578>&#13;int set_field_fore(FIELD *field,        /* field to alter */
6579                   chtype attr);        /* attribute to set */
6580
6581chtype field_fore(FIELD *field);        /* field to query */
6582                                        /* returns foreground attribute */
6583
6584int set_field_back(FIELD *field,        /* field to alter */
6585                   chtype attr);        /* attribute to set */
6586
6587chtype field_back(FIELD *field);        /* field to query */
6588                                        /* returns background attribute */
6589
6590int set_field_pad(FIELD *field,         /* field to alter */
6591                  int pad);             /* pad character to set */
6592
6593chtype field_pad(FIELD *field);         /* field to query */
6594                                        /* returns present pad character */&#13;</PRE
6595><P
6596>Though above functions seem quite simple, using colors with set_field_fore() may
6597be frustrating in the beginning. Let me first explain about foreground and
6598background attributes of a field. The foreground attribute is associated with
6599the character. That means a character in the field is printed with the attribute
6600you have set with set_field_fore(). Background attribute is the attribute used
6601to fill background of field, whether any character is there or not.  So what
6602about colors? Since colors are always defined in pairs, what is the right way to
6603display colored fields? Here's an example clarifying color attributes.</P
6604><DIV
6605CLASS="EXAMPLE"
6606><A
6607NAME="FFOAT"
6608></A
6609><P
6610><B
6611>Example 26.  Form Attributes example </B
6612></P
6613><PRE
6614CLASS="PROGRAMLISTING"
6615><SPAN
6616CLASS="INLINEMEDIAOBJECT"
6617>#include &#60;form.h&#62;
6618
6619int main()
6620{	FIELD *field[3];
6621	FORM  *my_form;
6622	int ch;
6623
6624	/* Initialize curses */
6625	initscr();
6626	start_color();
6627	cbreak();
6628	noecho();
6629	keypad(stdscr, TRUE);
6630
6631	/* Initialize few color pairs */
6632	init_pair(1, COLOR_WHITE, COLOR_BLUE);
6633	init_pair(2, COLOR_WHITE, COLOR_BLUE);
6634
6635	/* Initialize the fields */
6636	field[0] = new_field(1, 10, 4, 18, 0, 0);
6637	field[1] = new_field(1, 10, 6, 18, 0, 0);
6638	field[2] = NULL;
6639
6640	/* Set field options */
6641	set_field_fore(field[0], COLOR_PAIR(1));/* Put the field with blue background */
6642	set_field_back(field[0], COLOR_PAIR(2));/* and white foreground (characters */
6643						/* are printed in white 	*/
6644	field_opts_off(field[0], O_AUTOSKIP);  	/* Don't go to next field when this */
6645						/* Field is filled up 		*/
6646	set_field_back(field[1], A_UNDERLINE);
6647	field_opts_off(field[1], O_AUTOSKIP);
6648
6649	/* Create the form and post it */
6650	my_form = new_form(field);
6651	post_form(my_form);
6652	refresh();
6653
6654	set_current_field(my_form, field[0]); /* Set focus to the colored field */
6655	mvprintw(4, 10, "Value 1:");
6656	mvprintw(6, 10, "Value 2:");
6657	mvprintw(LINES - 2, 0, "Use UP, DOWN arrow keys to switch between fields");
6658	refresh();
6659
6660	/* Loop through to get user requests */
6661	while((ch = getch()) != KEY_F(1))
6662	{	switch(ch)
6663		{	case KEY_DOWN:
6664				/* Go to next field */
6665				form_driver(my_form, REQ_NEXT_FIELD);
6666				/* Go to the end of the present buffer */
6667				/* Leaves nicely at the last character */
6668				form_driver(my_form, REQ_END_LINE);
6669				break;
6670			case KEY_UP:
6671				/* Go to previous field */
6672				form_driver(my_form, REQ_PREV_FIELD);
6673				form_driver(my_form, REQ_END_LINE);
6674				break;
6675			default:
6676				/* If this is a normal character, it gets */
6677				/* Printed				  */
6678				form_driver(my_form, ch);
6679				break;
6680		}
6681	}
6682
6683	/* Un post form and free the memory */
6684	unpost_form(my_form);
6685	free_form(my_form);
6686	free_field(field[0]);
6687	free_field(field[1]);
6688
6689	endwin();
6690	return 0;
6691}</SPAN
6692></PRE
6693></DIV
6694><P
6695>Play with the color pairs and try to understand the foreground and background
6696attributes. In my programs using color attributes, I usually set only the
6697background with set_field_back(). Curses simply doesn't allow defining
6698individual color attributes. </P
6699></DIV
6700><DIV
6701CLASS="SECT3"
6702><HR><H4
6703CLASS="SECT3"
6704><A
6705NAME="FIELDOPTIONBITS"
6706>18.3.5. Field Option Bits</A
6707></H4
6708><P
6709>There is also a large collection of field option bits you can set to control
6710various aspects of forms processing. You can manipulate them with these
6711functions:</P
6712><PRE
6713CLASS="PROGRAMLISTING"
6714>int set_field_opts(FIELD *field,          /* field to alter */
6715                   int attr);             /* attribute to set */
6716
6717int field_opts_on(FIELD *field,           /* field to alter */
6718                  int attr);              /* attributes to turn on */
6719
6720int field_opts_off(FIELD *field,          /* field to alter */
6721                  int attr);              /* attributes to turn off */
6722
6723int field_opts(FIELD *field);             /* field to query */ </PRE
6724><P
6725>The function set_field_opts() can be used to directly set attributes of a field
6726or you can choose to switch a few attributes on and off with field_opts_on() and
6727field_opts_off() selectively. Anytime you can query the attributes of a field
6728with field_opts(). The following is the list of available options. By default,
6729all options are on.</P
6730><P
6731></P
6732><DIV
6733CLASS="VARIABLELIST"
6734><DL
6735><DT
6736>O_VISIBLE</DT
6737><DD
6738><P
6739>Controls whether the field is visible on the screen.  Can be used
6740during form processing to hide or pop up fields depending on the value
6741of parent fields.</P
6742></DD
6743><DT
6744>O_ACTIVE</DT
6745><DD
6746><P
6747>Controls whether the field is active during forms processing (i.e.
6748visited by form navigation keys).  Can be used to make labels or derived
6749fields with buffer values alterable by the forms application, not the user.</P
6750></DD
6751><DT
6752>O_PUBLIC</DT
6753><DD
6754><P
6755>Controls whether data is displayed during field entry.  If this option is
6756turned off on a field, the library will accept and edit data in that field,
6757but it will not be displayed and the visible field cursor will not move.
6758You can turn off the O_PUBLIC bit to define password fields.</P
6759></DD
6760><DT
6761>O_EDIT</DT
6762><DD
6763><P
6764>Controls whether the field's data can be modified.  When this option is
6765off, all editing requests except <TT
6766CLASS="LITERAL"
6767>REQ_PREV_CHOICE</TT
6768> and <TT
6769CLASS="LITERAL"
6770>REQ_NEXT_CHOICE</TT
6771>will
6772fail.  Such read-only fields may be useful for help messages.</P
6773></DD
6774><DT
6775>O_WRAP</DT
6776><DD
6777><P
6778>Controls word-wrapping in multi-line fields.  Normally, when any
6779character of a (blank-separated) word reaches the end of the current line, the
6780entire word is wrapped to the next line (assuming there is one).  When this
6781option is off, the word will be split across the line break.</P
6782></DD
6783><DT
6784>O_BLANK</DT
6785><DD
6786><P
6787>Controls field blanking.  When this option is on, entering a character at
6788the first field position erases the entire field (except for the just-entered
6789character).</P
6790></DD
6791><DT
6792>O_AUTOSKIP</DT
6793><DD
6794><P
6795>Controls automatic skip to next field when this one fills.  Normally,
6796when the forms user tries to type more data into a field than will fit,
6797the editing location jumps to next field.  When this option is off, the
6798user's cursor will hang at the end of the field.  This option is ignored
6799in dynamic fields that have not reached their size limit.</P
6800></DD
6801><DT
6802>O_NULLOK</DT
6803><DD
6804><P
6805>Controls whether validation is applied to
6806blank fields.  Normally, it is not; the user can leave a field blank
6807without invoking the usual validation check on exit.  If this option is
6808off on a field, exit from it will invoke a validation check.</P
6809></DD
6810><DT
6811>O_PASSOK</DT
6812><DD
6813><P
6814>Controls whether validation occurs on every exit, or only after
6815the field is modified.  Normally the latter is true.  Setting O_PASSOK
6816may be useful if your field's validation function may change during
6817forms processing.</P
6818></DD
6819><DT
6820>O_STATIC</DT
6821><DD
6822><P
6823>Controls whether the field is fixed to its initial dimensions.  If you
6824turn this off, the field becomes dynamic and will
6825stretch to fit entered data.</P
6826></DD
6827></DL
6828></DIV
6829><P
6830>A field's options cannot be changed while the field is currently selected.
6831However, options may be changed on posted fields that are not current. </P
6832><P
6833>The option values are bit-masks and can be composed with logical-or in
6834the obvious way. You have seen the usage of switching off O_AUTOSKIP option.
6835The following example clarifies usage of some more options. Other options
6836are explained where appropriate.</P
6837><DIV
6838CLASS="EXAMPLE"
6839><A
6840NAME="FFOOP"
6841></A
6842><P
6843><B
6844>Example 27.  Field Options Usage example </B
6845></P
6846><PRE
6847CLASS="PROGRAMLISTING"
6848><SPAN
6849CLASS="INLINEMEDIAOBJECT"
6850>#include &#60;form.h&#62;
6851
6852#define STARTX 15
6853#define STARTY 4
6854#define WIDTH 25
6855
6856#define N_FIELDS 3
6857
6858int main()
6859{	FIELD *field[N_FIELDS];
6860	FORM  *my_form;
6861	int ch, i;
6862
6863	/* Initialize curses */
6864	initscr();
6865	cbreak();
6866	noecho();
6867	keypad(stdscr, TRUE);
6868
6869	/* Initialize the fields */
6870	for(i = 0; i &#60; N_FIELDS - 1; ++i)
6871		field[i] = new_field(1, WIDTH, STARTY + i * 2, STARTX, 0, 0);
6872	field[N_FIELDS - 1] = NULL;
6873
6874	/* Set field options */
6875	set_field_back(field[1], A_UNDERLINE); 	/* Print a line for the option 	*/
6876
6877	field_opts_off(field[0], O_ACTIVE); /* This field is a static label */
6878	field_opts_off(field[1], O_PUBLIC); /* This filed is like a password field*/
6879	field_opts_off(field[1], O_AUTOSKIP); /* To avoid entering the same field */
6880					      /* after last character is entered */
6881
6882	/* Create the form and post it */
6883	my_form = new_form(field);
6884	post_form(my_form);
6885	refresh();
6886
6887	set_field_just(field[0], JUSTIFY_CENTER); /* Center Justification */
6888	set_field_buffer(field[0], 0, "This is a static Field");
6889						  /* Initialize the field  */
6890	mvprintw(STARTY, STARTX - 10, "Field 1:");
6891	mvprintw(STARTY + 2, STARTX - 10, "Field 2:");
6892	refresh();
6893
6894	/* Loop through to get user requests */
6895	while((ch = getch()) != KEY_F(1))
6896	{	switch(ch)
6897		{	case KEY_DOWN:
6898				/* Go to next field */
6899				form_driver(my_form, REQ_NEXT_FIELD);
6900				/* Go to the end of the present buffer */
6901				/* Leaves nicely at the last character */
6902				form_driver(my_form, REQ_END_LINE);
6903				break;
6904			case KEY_UP:
6905				/* Go to previous field */
6906				form_driver(my_form, REQ_PREV_FIELD);
6907				form_driver(my_form, REQ_END_LINE);
6908				break;
6909			default:
6910				/* If this is a normal character, it gets */
6911				/* Printed				  */
6912				form_driver(my_form, ch);
6913				break;
6914		}
6915	}
6916
6917	/* Un post form and free the memory */
6918	unpost_form(my_form);
6919	free_form(my_form);
6920	free_field(field[0]);
6921	free_field(field[1]);
6922
6923	endwin();
6924	return 0;
6925}</SPAN
6926></PRE
6927></DIV
6928><P
6929>This example, though useless, shows the usage of options. If used properly, they
6930can present information very effectively in a form. The second field being not
6931O_PUBLIC, does not show the characters you are typing.</P
6932></DIV
6933><DIV
6934CLASS="SECT3"
6935><HR><H4
6936CLASS="SECT3"
6937><A
6938NAME="FIELDSTATUS"
6939>18.3.6. Field Status</A
6940></H4
6941><P
6942>The field status specifies whether the field has got edited or not. It is
6943initially set to FALSE and when user enters something and the data buffer gets
6944modified it becomes TRUE. So a field's status can be queried to find out whether
6945it has been modified or not. The following functions can assist in those
6946operations.</P
6947><PRE
6948CLASS="PROGRAMLISTING"
6949>int set_field_status(FIELD *field,      /* field to alter */
6950                   int status);         /* status to set */
6951
6952int field_status(FIELD *field);         /* fetch status of field */</PRE
6953><P
6954>It's better to check the field's status only after after leaving the field, as
6955data buffer might not have been updated yet as the validation is still due. To
6956guarantee that right status is returned, call field_status() either (1) in the
6957field's exit validation check routine, (2) from the field's or form's
6958initialization or termination hooks, or (3) just after a REQ_VALIDATION request
6959has been processed by the forms driver</P
6960></DIV
6961><DIV
6962CLASS="SECT3"
6963><HR><H4
6964CLASS="SECT3"
6965><A
6966NAME="FIELDUSERPTR"
6967>18.3.7. Field User Pointer</A
6968></H4
6969><P
6970>Every field structure contains one pointer that can be used by the user for
6971various purposes. It is not touched by forms library and can be used for any
6972purpose by the user. The following functions set and fetch user pointer.</P
6973><PRE
6974CLASS="PROGRAMLISTING"
6975>int set_field_userptr(FIELD *field,
6976           char *userptr);      /* the user pointer you wish to associate */
6977                                /* with the field    */
6978
6979char *field_userptr(FIELD *field);      /* fetch user pointer of the field */</PRE
6980></DIV
6981><DIV
6982CLASS="SECT3"
6983><HR><H4
6984CLASS="SECT3"
6985><A
6986NAME="VARIABLESIZEFIELDS"
6987>18.3.8. Variable-Sized Fields</A
6988></H4
6989><P
6990>If you want a dynamically changing field with variable width, this is the
6991feature you want to put to full use. This will allow the user to enter more data
6992than the original size of the field and let the field grow. According to the
6993field orientation it will scroll horizontally or vertically to incorporate the
6994new data.</P
6995><P
6996>To make a field dynamically growable, the option O_STATIC should be turned off.
6997This can be done with a
6998<PRE
6999CLASS="PROGRAMLISTING"
7000>    field_opts_off(field_pointer, O_STATIC);</PRE
7001></P
7002><P
7003>But it's usually not advisable to allow a field to grow infinitely. You can set
7004a maximum limit to the growth of the field with
7005<PRE
7006CLASS="PROGRAMLISTING"
7007>int set_max_field(FIELD *field,    /* Field on which to operate */
7008                  int max_growth); /* maximum growth allowed for the field */</PRE
7009></P
7010><P
7011>The field info for a dynamically growable field can be retrieved by
7012<PRE
7013CLASS="PROGRAMLISTING"
7014>int dynamic_field_info( FIELD *field,     /* Field on which to operate */
7015            int   *prows,     /* number of rows will be filled in this */
7016            int   *pcols,     /* number of columns will be filled in this*/
7017            int   *pmax)      /* maximum allowable growth will be filled */
7018                              /* in this */</PRE
7019>
7020Though field_info work as usual, it is advisable to use this function to get the
7021proper attributes of a dynamically growable field.</P
7022><P
7023>Recall the library routine new_field; a new field created with height set to one
7024will be defined to be a one line field. A new field created with height greater
7025than one will be defined to be a multi line field. </P
7026><P
7027>A one line field with O_STATIC turned off (dynamically growable field)  will
7028contain a single fixed row, but the number of columns can increase if the user
7029enters more data than the initial field will hold. The number of columns
7030displayed will remain fixed and the additional data will scroll horizontally. </P
7031><P
7032>A multi line field with O_STATIC turned off (dynamically growable field) will
7033contain a fixed number of columns, but the number of rows can increase if the
7034user enters more data than the initial field will hold. The number of rows
7035displayed will remain fixed and the additional data will scroll vertically.</P
7036><P
7037>The above two paragraphs pretty much describe a dynamically growable field's
7038behavior. The way other parts of forms library behaves is described below:</P
7039><P
7040></P
7041><OL
7042TYPE="1"
7043><LI
7044><P
7045>The field option O_AUTOSKIP will be ignored if the option O_STATIC is off and
7046there is no maximum growth specified for the field. Currently, O_AUTOSKIP
7047generates an automatic REQ_NEXT_FIELD form driver request when the user types in
7048the last character position of a field. On a growable field with no maximum
7049growth specified, there is no last character position. If a maximum growth is
7050specified, the O_AUTOSKIP option will work as normal if the field has grown to
7051its maximum size. </P
7052></LI
7053><LI
7054><P
7055>The field justification will be ignored if the option O_STATIC is off.
7056Currently, set_field_just can be used to JUSTIFY_LEFT, JUSTIFY_RIGHT,
7057JUSTIFY_CENTER the contents of a one line field. A growable one line field will,
7058by definition, grow and scroll horizontally and may contain more data than can
7059be justified. The return from field_just will be unchanged. </P
7060></LI
7061><LI
7062><P
7063>The overloaded form driver request REQ_NEW_LINE will operate the same way
7064regardless of the O_NL_OVERLOAD form option if the field option O_STATIC is off
7065and there is no maximum growth specified for the field. Currently, if the form
7066option O_NL_OVERLOAD is on, REQ_NEW_LINE implicitly generates a REQ_NEXT_FIELD
7067if called from the last line of a field. If a field can grow without bound,
7068there is no last line, so REQ_NEW_LINE will never implicitly generate a
7069REQ_NEXT_FIELD. If a maximum growth limit is specified and the O_NL_OVERLOAD
7070form option is on, REQ_NEW_LINE will only implicitly generate REQ_NEXT_FIELD if
7071the field has grown to its maximum size and the user is on the last line. </P
7072></LI
7073><LI
7074><P
7075>The library call dup_field will work as usual; it will duplicate the field,
7076including the current buffer size and contents of the field being duplicated.
7077Any specified maximum growth will also be duplicated. </P
7078></LI
7079><LI
7080><P
7081>The library call link_field will work as usual; it will duplicate all field
7082attributes and share buffers with the field being linked. If the O_STATIC field
7083option is subsequently changed by a field sharing buffers, how the system reacts
7084to an attempt to enter more data into the field than the buffer will currently
7085hold will depend on the setting of the option in the current field. </P
7086></LI
7087><LI
7088><P
7089>The library call field_info will work as usual; the variable nrow will contain
7090the value of the original call to new_field. The user should use
7091dynamic_field_info, described above, to query the current size of the buffer.</P
7092></LI
7093></OL
7094><P
7095>Some of the above points make sense only after explaining form driver. We will
7096be looking into that in next few sections.</P
7097></DIV
7098></DIV
7099><DIV
7100CLASS="SECT2"
7101><HR><H3
7102CLASS="SECT2"
7103><A
7104NAME="FORMWINDOWS"
7105>18.4. Form Windows</A
7106></H3
7107><P
7108>The form windows concept is pretty much similar to menu windows. Every form is
7109associated with a main window and a sub window. The form main window displays
7110any title or border associated or whatever the user wishes. Then the sub window
7111contains all the fields and displays them according to their position. This
7112gives the flexibility of manipulating fancy form displaying very easily. </P
7113><P
7114>Since this is pretty much similar to menu windows, I am providing an example
7115with out much explanation. The functions are similar and they work the same way.</P
7116><DIV
7117CLASS="EXAMPLE"
7118><A
7119NAME="FFOWI"
7120></A
7121><P
7122><B
7123>Example 28.  Form Windows Example </B
7124></P
7125><PRE
7126CLASS="PROGRAMLISTING"
7127><SPAN
7128CLASS="INLINEMEDIAOBJECT"
7129>#include &#60;form.h&#62;
7130
7131void print_in_middle(WINDOW *win, int starty, int startx, int width, char *string, chtype color);
7132
7133int main()
7134{
7135	FIELD *field[3];
7136	FORM  *my_form;
7137	WINDOW *my_form_win;
7138	int ch, rows, cols;
7139
7140	/* Initialize curses */
7141	initscr();
7142	start_color();
7143	cbreak();
7144	noecho();
7145	keypad(stdscr, TRUE);
7146
7147	/* Initialize few color pairs */
7148   	init_pair(1, COLOR_RED, COLOR_BLACK);
7149
7150	/* Initialize the fields */
7151	field[0] = new_field(1, 10, 6, 1, 0, 0);
7152	field[1] = new_field(1, 10, 8, 1, 0, 0);
7153	field[2] = NULL;
7154
7155	/* Set field options */
7156	set_field_back(field[0], A_UNDERLINE);
7157	field_opts_off(field[0], O_AUTOSKIP); /* Don't go to next field when this */
7158					      /* Field is filled up 		*/
7159	set_field_back(field[1], A_UNDERLINE);
7160	field_opts_off(field[1], O_AUTOSKIP);
7161
7162	/* Create the form and post it */
7163	my_form = new_form(field);
7164
7165	/* Calculate the area required for the form */
7166	scale_form(my_form, &#38;rows, &#38;cols);
7167
7168	/* Create the window to be associated with the form */
7169        my_form_win = newwin(rows + 4, cols + 4, 4, 4);
7170        keypad(my_form_win, TRUE);
7171
7172	/* Set main window and sub window */
7173        set_form_win(my_form, my_form_win);
7174        set_form_sub(my_form, derwin(my_form_win, rows, cols, 2, 2));
7175
7176	/* Print a border around the main window and print a title */
7177        box(my_form_win, 0, 0);
7178	print_in_middle(my_form_win, 1, 0, cols + 4, "My Form", COLOR_PAIR(1));
7179
7180	post_form(my_form);
7181	wrefresh(my_form_win);
7182
7183	mvprintw(LINES - 2, 0, "Use UP, DOWN arrow keys to switch between fields");
7184	refresh();
7185
7186	/* Loop through to get user requests */
7187	while((ch = wgetch(my_form_win)) != KEY_F(1))
7188	{	switch(ch)
7189		{	case KEY_DOWN:
7190				/* Go to next field */
7191				form_driver(my_form, REQ_NEXT_FIELD);
7192				/* Go to the end of the present buffer */
7193				/* Leaves nicely at the last character */
7194				form_driver(my_form, REQ_END_LINE);
7195				break;
7196			case KEY_UP:
7197				/* Go to previous field */
7198				form_driver(my_form, REQ_PREV_FIELD);
7199				form_driver(my_form, REQ_END_LINE);
7200				break;
7201			default:
7202				/* If this is a normal character, it gets */
7203				/* Printed				  */
7204				form_driver(my_form, ch);
7205				break;
7206		}
7207	}
7208
7209	/* Un post form and free the memory */
7210	unpost_form(my_form);
7211	free_form(my_form);
7212	free_field(field[0]);
7213	free_field(field[1]);
7214
7215	endwin();
7216	return 0;
7217}
7218
7219void print_in_middle(WINDOW *win, int starty, int startx, int width, char *string, chtype color)
7220{	int length, x, y;
7221	float temp;
7222
7223	if(win == NULL)
7224		win = stdscr;
7225	getyx(win, y, x);
7226	if(startx != 0)
7227		x = startx;
7228	if(starty != 0)
7229		y = starty;
7230	if(width == 0)
7231		width = 80;
7232
7233	length = strlen(string);
7234	temp = (width - length)/ 2;
7235	x = startx + (int)temp;
7236	wattron(win, color);
7237	mvwprintw(win, y, x, "%s", string);
7238	wattroff(win, color);
7239	refresh();
7240}</SPAN
7241></PRE
7242></DIV
7243></DIV
7244><DIV
7245CLASS="SECT2"
7246><HR><H3
7247CLASS="SECT2"
7248><A
7249NAME="FILEDVALIDATE"
7250>18.5. Field Validation</A
7251></H3
7252><P
7253>By default, a field will accept any data input by the user. It is possible to
7254attach validation to the field. Then any attempt by the user to leave the field,
7255while it contains data that doesn't match the validation type will fail. Some
7256validation types also have a character-validity check for each time a character
7257is entered in the field.</P
7258><P
7259>Validation can be attached to a field with the following function.
7260<PRE
7261CLASS="PROGRAMLISTING"
7262>int set_field_type(FIELD *field,          /* field to alter */
7263                   FIELDTYPE *ftype,      /* type to associate */
7264                   ...);                  /* additional arguments*/</PRE
7265>
7266Once set, the validation type for a field can be queried with
7267<PRE
7268CLASS="PROGRAMLISTING"
7269>FIELDTYPE *field_type(FIELD *field);      /* field to query */</PRE
7270></P
7271><P
7272>The form driver validates the data in a field only when data is entered by the
7273end-user. Validation does not occur when </P
7274><P
7275></P
7276><UL
7277><LI
7278><P
7279>the application program changes the field value by calling set_field_buffer. </P
7280></LI
7281><LI
7282><P
7283>linked field values are changed indirectly -- by changing the field to which
7284they are linked</P
7285></LI
7286></UL
7287><P
7288>The following are the pre-defined validation types. You can also specify custom
7289validation, though it's a bit tricky and cumbersome.</P
7290><H1
7291CLASS="BRIDGEHEAD"
7292><A
7293NAME="AEN1069"
7294></A
7295>TYPE_ALPHA</H1
7296><P
7297>This field type accepts alphabetic data; no blanks, no digits, no special
7298characters (this is checked at character-entry time).  It is set up with: </P
7299><PRE
7300CLASS="PROGRAMLISTING"
7301>int set_field_type(FIELD *field,          /* field to alter */
7302                   TYPE_ALPHA,            /* type to associate */
7303                   int width);            /* maximum width of field */</PRE
7304><P
7305>The width argument sets a minimum width of data. The user has to enter at-least
7306width number of characters before he can leave the field. Typically
7307you'll want to set this to the field width; if it's greater than the
7308field width, the validation check will always fail.  A minimum width
7309of zero makes field completion optional. </P
7310><H1
7311CLASS="BRIDGEHEAD"
7312><A
7313NAME="AEN1073"
7314></A
7315>TYPE_ALNUM</H1
7316><P
7317>This field type accepts alphabetic data and digits; no blanks, no special
7318characters (this is checked at character-entry time).  It is set up with: </P
7319><PRE
7320CLASS="PROGRAMLISTING"
7321>int set_field_type(FIELD *field,          /* field to alter */
7322                   TYPE_ALNUM,            /* type to associate */
7323                   int width);            /* maximum width of field */</PRE
7324><P
7325>The width argument sets a minimum width of data.  As with
7326TYPE_ALPHA, typically you'll want to set this to the field width; if it's
7327greater than the field width, the validation check will always fail.  A
7328minimum width of zero makes field completion optional. </P
7329><H1
7330CLASS="BRIDGEHEAD"
7331><A
7332NAME="AEN1077"
7333></A
7334>TYPE_ENUM</H1
7335><P
7336>This type allows you to restrict a field's values to be among a specified
7337set of string values (for example, the two-letter postal codes for U.S.
7338states).  It is set up with: </P
7339><PRE
7340CLASS="PROGRAMLISTING"
7341>int set_field_type(FIELD *field,          /* field to alter */
7342                   TYPE_ENUM,             /* type to associate */
7343                   char **valuelist;      /* list of possible values */
7344                   int checkcase;         /* case-sensitive? */
7345                   int checkunique);      /* must specify uniquely? */</PRE
7346><P
7347>The valuelist parameter must point at a NULL-terminated list of
7348valid strings.  The checkcase argument, if true, makes comparison
7349with the string case-sensitive. </P
7350><P
7351>When the user exits a TYPE_ENUM field, the validation procedure tries to
7352complete the data in the buffer to a valid entry.  If a complete choice string
7353has been entered, it is of course valid.  But it is also possible to enter a
7354prefix of a valid string and have it completed for you. </P
7355><P
7356>By default, if you enter such a prefix and it matches more than one value
7357in the string list, the prefix will be completed to the first matching
7358value.  But the checkunique argument, if true, requires prefix
7359matches to be unique in order to be valid. </P
7360><P
7361>The REQ_NEXT_CHOICE and REQ_PREV_CHOICE input requests can be particularly
7362useful with these fields. </P
7363><H1
7364CLASS="BRIDGEHEAD"
7365><A
7366NAME="AEN1084"
7367></A
7368>TYPE_INTEGER</H1
7369><P
7370>This field type accepts an integer.  It is set up as follows: </P
7371><PRE
7372CLASS="PROGRAMLISTING"
7373>int set_field_type(FIELD *field,          /* field to alter */
7374                   TYPE_INTEGER,          /* type to associate */
7375                   int padding,           /* # places to zero-pad to */
7376                   int vmin, int vmax);   /* valid range */</PRE
7377><P
7378>Valid characters consist of an optional leading minus and digits.
7379The range check is performed on exit.  If the range maximum is less
7380than or equal to the minimum, the range is ignored. </P
7381><P
7382>If the value passes its range check, it is padded with as many leading
7383zero digits as necessary to meet the padding argument. </P
7384><P
7385>A TYPE_INTEGER value buffer can conveniently be interpreted with the C library
7386function atoi(3).</P
7387><H1
7388CLASS="BRIDGEHEAD"
7389><A
7390NAME="AEN1090"
7391></A
7392>TYPE_NUMERIC</H1
7393><P
7394>This field type accepts a decimal number.  It is set up as follows: </P
7395><PRE
7396CLASS="PROGRAMLISTING"
7397>int set_field_type(FIELD *field,          /* field to alter */
7398                   TYPE_NUMERIC,          /* type to associate */
7399                   int padding,           /* # places of precision */
7400                   int vmin, int vmax);   /* valid range */</PRE
7401><P
7402>Valid characters consist of an optional leading minus and digits. possibly
7403including a decimal point.  The range check is performed on exit.  If the
7404range maximum is less than or equal to the minimum, the range is
7405ignored. </P
7406><P
7407>If the value passes its range check, it is padded with as many trailing
7408zero digits as necessary to meet the padding argument. </P
7409><P
7410>A TYPE_NUMERIC value buffer can conveniently be interpreted with the C library
7411function atof(3).</P
7412><H1
7413CLASS="BRIDGEHEAD"
7414><A
7415NAME="AEN1096"
7416></A
7417>TYPE_REGEXP</H1
7418><P
7419>This field type accepts data matching a regular expression.  It is set up
7420as follows: </P
7421><PRE
7422CLASS="PROGRAMLISTING"
7423>int set_field_type(FIELD *field,          /* field to alter */
7424                   TYPE_REGEXP,           /* type to associate */
7425                   char *regexp);         /* expression to match */</PRE
7426><P
7427>The syntax for regular expressions is that of regcomp(3).
7428The check for regular-expression match is performed on exit.</P
7429></DIV
7430><DIV
7431CLASS="SECT2"
7432><HR><H3
7433CLASS="SECT2"
7434><A
7435NAME="FORMDRIVER"
7436>18.6. Form Driver: The work horse of the forms system</A
7437></H3
7438><P
7439>As in the menu system, form_driver() plays a very important role in forms
7440system.  All types of requests to forms system should be funneled through
7441form_driver().</P
7442><PRE
7443CLASS="PROGRAMLISTING"
7444>int form_driver(FORM *form,     /* form on which to operate     */
7445                int request)    /* form request code         */</PRE
7446><P
7447>As you have seen some of the examples above, you have to be in a loop looking
7448for user input and then decide whether it's a field data or a form request. The
7449form requests are then passed to form_driver() to do the work.</P
7450><P
7451>The requests roughly can be divided into following categories. Different
7452requests and their usage is explained below:</P
7453><DIV
7454CLASS="SECT3"
7455><HR><H4
7456CLASS="SECT3"
7457><A
7458NAME="PAGENAVREQ"
7459>18.6.1. Page Navigation Requests</A
7460></H4
7461><P
7462>These requests cause page-level moves through the form, triggering display of a
7463new form screen. A form can be made of multiple pages. If you have a big form
7464with lot of fields and logical sections, then you can divide the form into
7465pages. The function set_new_page() to set a new page at the field specified.</P
7466><PRE
7467CLASS="PROGRAMLISTING"
7468>int set_new_page(FIELD *field,/* Field at which page break to be set or unset */
7469         bool new_page_flag); /* should be TRUE to put a break */</PRE
7470><P
7471>The following requests allow you to move to different pages</P
7472><P
7473></P
7474><UL
7475><LI
7476><P
7477><SPAN
7478CLASS="emphasis"
7479><I
7480CLASS="EMPHASIS"
7481>REQ_NEXT_PAGE</I
7482></SPAN
7483> Move to the next form page.</P
7484></LI
7485><LI
7486><P
7487><SPAN
7488CLASS="emphasis"
7489><I
7490CLASS="EMPHASIS"
7491>REQ_PREV_PAGE</I
7492></SPAN
7493> Move to the previous
7494form page.</P
7495></LI
7496><LI
7497><P
7498><SPAN
7499CLASS="emphasis"
7500><I
7501CLASS="EMPHASIS"
7502>REQ_FIRST_PAGE</I
7503></SPAN
7504> Move to the first form page.</P
7505></LI
7506><LI
7507><P
7508><SPAN
7509CLASS="emphasis"
7510><I
7511CLASS="EMPHASIS"
7512>REQ_LAST_PAGE</I
7513></SPAN
7514> Move to the last form page. </P
7515></LI
7516></UL
7517><P
7518>These requests treat the list as cyclic; that is, REQ_NEXT_PAGE from the
7519last page goes to the first, and REQ_PREV_PAGE from the first page goes to
7520the last.</P
7521></DIV
7522><DIV
7523CLASS="SECT3"
7524><HR><H4
7525CLASS="SECT3"
7526><A
7527NAME="INTERFIELDNAVREQ"
7528>18.6.2. Inter-Field Navigation Requests</A
7529></H4
7530><P
7531>These requests handle navigation between fields on the same page.</P
7532><P
7533></P
7534><UL
7535><LI
7536><P
7537><SPAN
7538CLASS="emphasis"
7539><I
7540CLASS="EMPHASIS"
7541>REQ_NEXT_FIELD</I
7542></SPAN
7543>
7544    Move to next field.  </P
7545></LI
7546><LI
7547><P
7548><SPAN
7549CLASS="emphasis"
7550><I
7551CLASS="EMPHASIS"
7552>REQ_PREV_FIELD</I
7553></SPAN
7554>
7555    Move to previous field.  </P
7556></LI
7557><LI
7558><P
7559><SPAN
7560CLASS="emphasis"
7561><I
7562CLASS="EMPHASIS"
7563>REQ_FIRST_FIELD</I
7564></SPAN
7565>
7566    Move to the first field. </P
7567></LI
7568><LI
7569><P
7570><SPAN
7571CLASS="emphasis"
7572><I
7573CLASS="EMPHASIS"
7574>REQ_LAST_FIELD</I
7575></SPAN
7576>
7577    Move to the last field. </P
7578></LI
7579><LI
7580><P
7581><SPAN
7582CLASS="emphasis"
7583><I
7584CLASS="EMPHASIS"
7585>REQ_SNEXT_FIELD</I
7586></SPAN
7587>
7588    Move to sorted next field. </P
7589></LI
7590><LI
7591><P
7592><SPAN
7593CLASS="emphasis"
7594><I
7595CLASS="EMPHASIS"
7596>REQ_SPREV_FIELD</I
7597></SPAN
7598>
7599    Move to sorted previous field. </P
7600></LI
7601><LI
7602><P
7603><SPAN
7604CLASS="emphasis"
7605><I
7606CLASS="EMPHASIS"
7607>REQ_SFIRST_FIELD</I
7608></SPAN
7609>
7610    Move to the sorted first field. </P
7611></LI
7612><LI
7613><P
7614><SPAN
7615CLASS="emphasis"
7616><I
7617CLASS="EMPHASIS"
7618>REQ_SLAST_FIELD</I
7619></SPAN
7620>
7621    Move to the sorted last field. </P
7622></LI
7623><LI
7624><P
7625><SPAN
7626CLASS="emphasis"
7627><I
7628CLASS="EMPHASIS"
7629>REQ_LEFT_FIELD</I
7630></SPAN
7631>
7632    Move left to field.  </P
7633></LI
7634><LI
7635><P
7636><SPAN
7637CLASS="emphasis"
7638><I
7639CLASS="EMPHASIS"
7640>REQ_RIGHT_FIELD</I
7641></SPAN
7642>
7643    Move right to field. </P
7644></LI
7645><LI
7646><P
7647><SPAN
7648CLASS="emphasis"
7649><I
7650CLASS="EMPHASIS"
7651>REQ_UP_FIELD</I
7652></SPAN
7653>
7654    Move up to field.  </P
7655></LI
7656><LI
7657><P
7658><SPAN
7659CLASS="emphasis"
7660><I
7661CLASS="EMPHASIS"
7662>REQ_DOWN_FIELD</I
7663></SPAN
7664>
7665    Move down to field. </P
7666></LI
7667></UL
7668><P
7669>These requests treat the list of fields on a page as cyclic; that is,
7670REQ_NEXT_FIELD from the last field goes to the first, and REQ_PREV_FIELD
7671from the first field goes to the last. The order of the fields for these
7672(and the REQ_FIRST_FIELD and REQ_LAST_FIELD requests) is simply the order of
7673the field pointers in the form array (as set up by new_form() or
7674set_form_fields()</P
7675><P
7676>It is also possible to traverse the fields as if they had been sorted in
7677screen-position order, so the sequence goes left-to-right and top-to-bottom.
7678To do this, use the second group of four sorted-movement requests.</P
7679><P
7680>Finally, it is possible to move between fields using visual directions up,
7681down, right, and left. To accomplish this, use the third group of four
7682requests. Note, however, that the position of a form for purposes of these
7683requests is its upper-left corner.</P
7684><P
7685>For example, suppose you have a multi-line field B, and two single-line
7686fields A and C on the same line with B, with A to the left of B and C to the
7687right of B. A REQ_MOVE_RIGHT from A will go to B only if A, B, and C all
7688share the same first line; otherwise it will skip over B to C.</P
7689></DIV
7690><DIV
7691CLASS="SECT3"
7692><HR><H4
7693CLASS="SECT3"
7694><A
7695NAME="INTRAFIELDNAVREQ"
7696>18.6.3. Intra-Field Navigation Requests</A
7697></H4
7698><P
7699>These requests drive movement of the edit cursor within the currently
7700selected field.</P
7701><P
7702></P
7703><UL
7704><LI
7705><P
7706><SPAN
7707CLASS="emphasis"
7708><I
7709CLASS="EMPHASIS"
7710>REQ_NEXT_CHAR</I
7711></SPAN
7712>
7713    Move to next character.  </P
7714></LI
7715><LI
7716><P
7717><SPAN
7718CLASS="emphasis"
7719><I
7720CLASS="EMPHASIS"
7721>REQ_PREV_CHAR</I
7722></SPAN
7723>
7724    Move to previous character.  </P
7725></LI
7726><LI
7727><P
7728><SPAN
7729CLASS="emphasis"
7730><I
7731CLASS="EMPHASIS"
7732>REQ_NEXT_LINE</I
7733></SPAN
7734>
7735    Move to next line.  </P
7736></LI
7737><LI
7738><P
7739><SPAN
7740CLASS="emphasis"
7741><I
7742CLASS="EMPHASIS"
7743>REQ_PREV_LINE</I
7744></SPAN
7745>
7746    Move to previous line.  </P
7747></LI
7748><LI
7749><P
7750><SPAN
7751CLASS="emphasis"
7752><I
7753CLASS="EMPHASIS"
7754>REQ_NEXT_WORD</I
7755></SPAN
7756>
7757    Move to next word. </P
7758></LI
7759><LI
7760><P
7761><SPAN
7762CLASS="emphasis"
7763><I
7764CLASS="EMPHASIS"
7765>REQ_PREV_WORD</I
7766></SPAN
7767>
7768    Move to previous word. </P
7769></LI
7770><LI
7771><P
7772><SPAN
7773CLASS="emphasis"
7774><I
7775CLASS="EMPHASIS"
7776>REQ_BEG_FIELD</I
7777></SPAN
7778>
7779    Move to beginning of field. </P
7780></LI
7781><LI
7782><P
7783><SPAN
7784CLASS="emphasis"
7785><I
7786CLASS="EMPHASIS"
7787>REQ_END_FIELD</I
7788></SPAN
7789>
7790    Move to end of field. </P
7791></LI
7792><LI
7793><P
7794><SPAN
7795CLASS="emphasis"
7796><I
7797CLASS="EMPHASIS"
7798>REQ_BEG_LINE</I
7799></SPAN
7800>
7801    Move to beginning of line. </P
7802></LI
7803><LI
7804><P
7805><SPAN
7806CLASS="emphasis"
7807><I
7808CLASS="EMPHASIS"
7809>REQ_END_LINE</I
7810></SPAN
7811>
7812    Move to end of line.  </P
7813></LI
7814><LI
7815><P
7816><SPAN
7817CLASS="emphasis"
7818><I
7819CLASS="EMPHASIS"
7820>REQ_LEFT_CHAR</I
7821></SPAN
7822>
7823    Move left in field. </P
7824></LI
7825><LI
7826><P
7827><SPAN
7828CLASS="emphasis"
7829><I
7830CLASS="EMPHASIS"
7831>REQ_RIGHT_CHAR</I
7832></SPAN
7833>
7834    Move right in field.  </P
7835></LI
7836><LI
7837><P
7838><SPAN
7839CLASS="emphasis"
7840><I
7841CLASS="EMPHASIS"
7842>REQ_UP_CHAR</I
7843></SPAN
7844>
7845    Move up in field. </P
7846></LI
7847><LI
7848><P
7849><SPAN
7850CLASS="emphasis"
7851><I
7852CLASS="EMPHASIS"
7853>REQ_DOWN_CHAR</I
7854></SPAN
7855>
7856    Move down in field. </P
7857></LI
7858></UL
7859><P
7860>Each word is separated from the previous and next characters by whitespace.
7861The commands to move to beginning and end of line or field look for the
7862first or last non-pad character in their ranges.</P
7863></DIV
7864><DIV
7865CLASS="SECT3"
7866><HR><H4
7867CLASS="SECT3"
7868><A
7869NAME="SCROLLREQ"
7870>18.6.4. Scrolling Requests</A
7871></H4
7872><P
7873>Fields that are dynamic and have grown and fields explicitly created with
7874offscreen rows are scrollable. One-line fields scroll horizontally;
7875multi-line fields scroll vertically. Most scrolling is triggered by editing
7876and intra-field movement (the library scrolls the field to keep the cursor
7877visible). It is possible to explicitly request scrolling with the following
7878requests:</P
7879><P
7880></P
7881><UL
7882><LI
7883><P
7884><SPAN
7885CLASS="emphasis"
7886><I
7887CLASS="EMPHASIS"
7888>REQ_SCR_FLINE</I
7889></SPAN
7890>
7891    Scroll vertically forward a line.  </P
7892></LI
7893><LI
7894><P
7895><SPAN
7896CLASS="emphasis"
7897><I
7898CLASS="EMPHASIS"
7899>REQ_SCR_BLINE</I
7900></SPAN
7901>
7902    Scroll vertically backward a line.  </P
7903></LI
7904><LI
7905><P
7906><SPAN
7907CLASS="emphasis"
7908><I
7909CLASS="EMPHASIS"
7910>REQ_SCR_FPAGE</I
7911></SPAN
7912>
7913    Scroll vertically forward a page.  </P
7914></LI
7915><LI
7916><P
7917><SPAN
7918CLASS="emphasis"
7919><I
7920CLASS="EMPHASIS"
7921>REQ_SCR_BPAGE</I
7922></SPAN
7923>
7924    Scroll vertically backward a page. </P
7925></LI
7926><LI
7927><P
7928><SPAN
7929CLASS="emphasis"
7930><I
7931CLASS="EMPHASIS"
7932>REQ_SCR_FHPAGE</I
7933></SPAN
7934>
7935    Scroll vertically forward half a page. </P
7936></LI
7937><LI
7938><P
7939><SPAN
7940CLASS="emphasis"
7941><I
7942CLASS="EMPHASIS"
7943>REQ_SCR_BHPAGE</I
7944></SPAN
7945>
7946    Scroll vertically backward half a page. </P
7947></LI
7948><LI
7949><P
7950><SPAN
7951CLASS="emphasis"
7952><I
7953CLASS="EMPHASIS"
7954>REQ_SCR_FCHAR</I
7955></SPAN
7956>
7957    Scroll horizontally forward a character. </P
7958></LI
7959><LI
7960><P
7961><SPAN
7962CLASS="emphasis"
7963><I
7964CLASS="EMPHASIS"
7965>REQ_SCR_BCHAR</I
7966></SPAN
7967>
7968    Scroll horizontally backward a character. </P
7969></LI
7970><LI
7971><P
7972><SPAN
7973CLASS="emphasis"
7974><I
7975CLASS="EMPHASIS"
7976>REQ_SCR_HFLINE</I
7977></SPAN
7978>
7979    Scroll horizontally one field width forward. </P
7980></LI
7981><LI
7982><P
7983><SPAN
7984CLASS="emphasis"
7985><I
7986CLASS="EMPHASIS"
7987>REQ_SCR_HBLINE</I
7988></SPAN
7989>
7990    Scroll horizontally one field width backward. </P
7991></LI
7992><LI
7993><P
7994><SPAN
7995CLASS="emphasis"
7996><I
7997CLASS="EMPHASIS"
7998>REQ_SCR_HFHALF</I
7999></SPAN
8000>
8001    Scroll horizontally one half field width forward. </P
8002></LI
8003><LI
8004><P
8005><SPAN
8006CLASS="emphasis"
8007><I
8008CLASS="EMPHASIS"
8009>REQ_SCR_HBHALF</I
8010></SPAN
8011>
8012    Scroll horizontally one half field width backward. </P
8013></LI
8014></UL
8015><P
8016>For scrolling purposes, a page of a field is the height of its visible part.</P
8017></DIV
8018><DIV
8019CLASS="SECT3"
8020><HR><H4
8021CLASS="SECT3"
8022><A
8023NAME="EDITREQ"
8024>18.6.5. Editing Requests</A
8025></H4
8026><P
8027>When you pass the forms driver an ASCII character, it is treated as a
8028request to add the character to the field's data buffer. Whether this is an
8029insertion or a replacement depends on the field's edit mode (insertion is
8030the default.</P
8031><P
8032>The following requests support editing the field and changing the edit mode:</P
8033><P
8034></P
8035><UL
8036><LI
8037><P
8038><SPAN
8039CLASS="emphasis"
8040><I
8041CLASS="EMPHASIS"
8042>REQ_INS_MODE</I
8043></SPAN
8044>
8045    Set insertion mode. </P
8046></LI
8047><LI
8048><P
8049><SPAN
8050CLASS="emphasis"
8051><I
8052CLASS="EMPHASIS"
8053>REQ_OVL_MODE</I
8054></SPAN
8055>
8056    Set overlay mode. </P
8057></LI
8058><LI
8059><P
8060><SPAN
8061CLASS="emphasis"
8062><I
8063CLASS="EMPHASIS"
8064>REQ_NEW_LINE</I
8065></SPAN
8066>
8067    New line request (see below for explanation). </P
8068></LI
8069><LI
8070><P
8071><SPAN
8072CLASS="emphasis"
8073><I
8074CLASS="EMPHASIS"
8075>REQ_INS_CHAR</I
8076></SPAN
8077>
8078    Insert space at character location.  </P
8079></LI
8080><LI
8081><P
8082><SPAN
8083CLASS="emphasis"
8084><I
8085CLASS="EMPHASIS"
8086>REQ_INS_LINE</I
8087></SPAN
8088>
8089    Insert blank line at character location.  </P
8090></LI
8091><LI
8092><P
8093><SPAN
8094CLASS="emphasis"
8095><I
8096CLASS="EMPHASIS"
8097>REQ_DEL_CHAR</I
8098></SPAN
8099>
8100    Delete character at cursor.  </P
8101></LI
8102><LI
8103><P
8104><SPAN
8105CLASS="emphasis"
8106><I
8107CLASS="EMPHASIS"
8108>REQ_DEL_PREV</I
8109></SPAN
8110>
8111    Delete previous word at cursor. </P
8112></LI
8113><LI
8114><P
8115><SPAN
8116CLASS="emphasis"
8117><I
8118CLASS="EMPHASIS"
8119>REQ_DEL_LINE</I
8120></SPAN
8121>
8122    Delete line at cursor. </P
8123></LI
8124><LI
8125><P
8126><SPAN
8127CLASS="emphasis"
8128><I
8129CLASS="EMPHASIS"
8130>REQ_DEL_WORD</I
8131></SPAN
8132>
8133    Delete word at cursor. </P
8134></LI
8135><LI
8136><P
8137><SPAN
8138CLASS="emphasis"
8139><I
8140CLASS="EMPHASIS"
8141>REQ_CLR_EOL</I
8142></SPAN
8143>
8144    Clear to end of line. </P
8145></LI
8146><LI
8147><P
8148><SPAN
8149CLASS="emphasis"
8150><I
8151CLASS="EMPHASIS"
8152>REQ_CLR_EOF</I
8153></SPAN
8154>
8155    Clear to end of field. </P
8156></LI
8157><LI
8158><P
8159><SPAN
8160CLASS="emphasis"
8161><I
8162CLASS="EMPHASIS"
8163>REQ_CLR_FIELD</I
8164></SPAN
8165>
8166    Clear entire field. </P
8167></LI
8168></UL
8169><P
8170>The behavior of the REQ_NEW_LINE and REQ_DEL_PREV requests is complicated
8171and partly controlled by a pair of forms options. The special cases are
8172triggered when the cursor is at the beginning of a field, or on the last
8173line of the field.</P
8174><P
8175>First, we consider REQ_NEW_LINE:</P
8176><P
8177>The normal behavior of REQ_NEW_LINE in insert mode is to break the current
8178line at the position of the edit cursor, inserting the portion of the
8179current line after the cursor as a new line following the current and moving
8180the cursor to the beginning of that new line (you may think of this as
8181inserting a newline in the field buffer).</P
8182><P
8183>The normal behavior of REQ_NEW_LINE in overlay mode is to clear the current
8184line from the position of the edit cursor to end of line. The cursor is then
8185moved to the beginning of the next line.</P
8186><P
8187>However, REQ_NEW_LINE at the beginning of a field, or on the last line of a
8188field, instead does a REQ_NEXT_FIELD. O_NL_OVERLOAD option is off, this
8189special action is disabled.</P
8190><P
8191>Now, let us consider REQ_DEL_PREV:</P
8192><P
8193>The normal behavior of REQ_DEL_PREV is to delete the previous character. If
8194insert mode is on, and the cursor is at the start of a line, and the text on
8195that line will fit on the previous one, it instead appends the contents of
8196the current line to the previous one and deletes the current line (you may
8197think of this as deleting a newline from the field buffer).</P
8198><P
8199>However, REQ_DEL_PREV at the beginning of a field is instead treated as a
8200REQ_PREV_FIELD.</P
8201><P
8202>If the O_BS_OVERLOAD option is off, this special action is disabled and the
8203forms driver just returns E_REQUEST_DENIED.</P
8204></DIV
8205><DIV
8206CLASS="SECT3"
8207><HR><H4
8208CLASS="SECT3"
8209><A
8210NAME="ORDERREQ"
8211>18.6.6. Order Requests</A
8212></H4
8213><P
8214>If the type of your field is ordered, and has associated functions for
8215getting the next and previous values of the type from a given value, there
8216are requests that can fetch that value into the field buffer:</P
8217><P
8218></P
8219><UL
8220><LI
8221><P
8222><SPAN
8223CLASS="emphasis"
8224><I
8225CLASS="EMPHASIS"
8226>REQ_NEXT_CHOICE</I
8227></SPAN
8228>
8229    Place the successor value of the current value in the buffer.
8230    </P
8231></LI
8232><LI
8233><P
8234><SPAN
8235CLASS="emphasis"
8236><I
8237CLASS="EMPHASIS"
8238>REQ_PREV_CHOICE</I
8239></SPAN
8240>
8241    Place the predecessor value of the current value in the buffer.
8242    </P
8243></LI
8244></UL
8245><P
8246>Of the built-in field types, only TYPE_ENUM has built-in successor and
8247predecessor functions. When you define a field type of your own (see Custom
8248Validation Types), you can associate our own ordering functions.</P
8249></DIV
8250><DIV
8251CLASS="SECT3"
8252><HR><H4
8253CLASS="SECT3"
8254><A
8255NAME="APPLICCOMMANDS"
8256>18.6.7. Application Commands</A
8257></H4
8258><P
8259>Form requests are represented as integers above the curses value greater than
8260KEY_MAX and less than or equal to the constant MAX_COMMAND.  A value within this
8261range gets ignored by form_driver(). So this can be used for any purpose by the
8262application. It can be treated as an application specific action and take
8263corresponding action.</P
8264></DIV
8265></DIV
8266></DIV
8267><DIV
8268CLASS="SECT1"
8269><HR><H2
8270CLASS="SECT1"
8271><A
8272NAME="TOOLS"
8273>19. Tools and Widget Libraries</A
8274></H2
8275><P
8276>
8277Now that you have seen the capabilities of ncurses and its sister libraries, you
8278are rolling your sleeves up and gearing for a project that heavily manipulates
8279screen. But wait..  It can be pretty difficult to write and maintain complex GUI
8280widgets in plain ncurses or even with the additional libraries. There are some
8281ready-to-use tools and widget libraries that can be used instead of writing your
8282own widgets. You can use some of them, get ideas from the code, or even extend
8283them.</P
8284><DIV
8285CLASS="SECT2"
8286><HR><H3
8287CLASS="SECT2"
8288><A
8289NAME="CDK"
8290>19.1. CDK (Curses Development Kit)</A
8291></H3
8292><P
8293>In the author's words </P
8294><P
8295><SPAN
8296CLASS="emphasis"
8297><I
8298CLASS="EMPHASIS"
8299>
8300CDK stands for 'Curses Development Kit' and it currently contains 21 ready
8301to use widgets which facilitate the speedy development of full screen
8302curses programs. </I
8303></SPAN
8304></P
8305><P
8306>The kit provides some useful widgets, which can be used in your programs
8307directly. It's pretty well written and the documentation is very good. The
8308examples in the examples directory can be a good place to start for beginners.
8309The CDK can be downloaded from <A
8310HREF="http://invisible-island.net/cdk/"
8311TARGET="_top"
8312>http://invisible-island.net/cdk/</A
8313>
8314. Follow the instructions in
8315README file to install it.</P
8316><DIV
8317CLASS="SECT3"
8318><HR><H4
8319CLASS="SECT3"
8320><A
8321NAME="WIDGETLIST"
8322>19.1.1. Widget List</A
8323></H4
8324><P
8325>The following is the list of widgets provided with cdk and their description.</P
8326><PRE
8327CLASS="PROGRAMLISTING"
8328>Widget Type           Quick Description
8329===========================================================================
8330Alphalist             Allows a user to select from a list of words, with
8331                      the ability to narrow the search list by typing in a
8332                      few characters of the desired word.
8333Buttonbox             This creates a multiple button widget.
8334Calendar              Creates a little simple calendar widget.
8335Dialog                Prompts the user with a message, and the user
8336                      can pick an answer from the buttons provided.
8337Entry                 Allows the user to enter various types of information.
8338File Selector         A file selector built from Cdk base widgets. This
8339                      example shows how to create more complicated widgets
8340                      using the Cdk widget library.
8341Graph                 Draws a graph.
8342Histogram             Draws a histogram.
8343Item List             Creates a pop up field which allows the user to select
8344                      one of several choices in a small field. Very useful
8345                      for things like days of the week or month names.
8346Label                 Displays messages in a pop up box, or the label can be
8347                      considered part of the screen.
8348Marquee               Displays a message in a scrolling marquee.
8349Matrix                Creates a complex matrix with lots of options.
8350Menu                  Creates a pull-down menu interface.
8351Multiple Line Entry   A multiple line entry field. Very useful
8352                      for long fields. (like a description
8353                      field)
8354Radio List            Creates a radio button list.
8355Scale                 Creates a numeric scale. Used for allowing a user to
8356                      pick a numeric value and restrict them to a range of
8357                      values.
8358Scrolling List        Creates a scrolling list/menu list.
8359Scrolling Window      Creates a scrolling log file viewer. Can add
8360                      information into the window while its running.
8361                      A good widget for displaying the progress of
8362                      something. (akin to a console window)
8363Selection List        Creates a multiple option selection list.
8364Slider                Akin to the scale widget, this widget provides a
8365                      visual slide bar to represent the numeric value.
8366Template              Creates a entry field with character sensitive
8367                      positions. Used for pre-formatted fields like
8368                      dates and phone numbers.
8369Viewer                This is a file/information viewer. Very useful
8370                      when you need to display loads of information.
8371===========================================================================</PRE
8372><P
8373>A few of the widgets are modified by Thomas Dickey in recent versions.</P
8374></DIV
8375><DIV
8376CLASS="SECT3"
8377><HR><H4
8378CLASS="SECT3"
8379><A
8380NAME="CDKATTRACT"
8381>19.1.2. Some Attractive Features</A
8382></H4
8383><P
8384>Apart from making our life easier with readily usable widgets, cdk solves one
8385frustrating problem with printing multi colored strings, justified strings
8386elegantly.  Special formatting tags can be embedded in the strings which are
8387passed to CDK functions. For Example</P
8388><P
8389>If the string</P
8390><PRE
8391CLASS="PROGRAMLISTING"
8392>"&lt;/B/1&gt;This line should have a yellow foreground and a blue
8393background.&lt;!1&gt;"</PRE
8394><P
8395>given as a parameter to newCDKLabel(), it prints the line with yellow foreground
8396and blue background. There are other tags available for justifying string,
8397embedding special drawing characters etc.. Please refer to the man page
8398cdk_display(3X) for details. The man page explains the usage with nice examples.</P
8399></DIV
8400><DIV
8401CLASS="SECT3"
8402><HR><H4
8403CLASS="SECT3"
8404><A
8405NAME="CDKCONCLUSION"
8406>19.1.3. Conclusion</A
8407></H4
8408><P
8409>All in all, CDK is a well-written package of widgets, which if used properly can
8410form a strong frame work for developing complex GUI.</P
8411></DIV
8412></DIV
8413><DIV
8414CLASS="SECT2"
8415><HR><H3
8416CLASS="SECT2"
8417><A
8418NAME="DIALOG"
8419>19.2. The dialog</A
8420></H3
8421><P
8422>Long long ago, in September 1994, when few people knew linux, Jeff Tranter wrote
8423an <A
8424HREF="http://www2.linuxjournal.com/lj-issues/issue5/2807.html"
8425TARGET="_top"
8426>article</A
8427> on dialog in Linux Journal. He starts the article with these words..</P
8428><P
8429><SPAN
8430CLASS="emphasis"
8431><I
8432CLASS="EMPHASIS"
8433>Linux is based on the Unix operating system, but also features a number of
8434unique and useful kernel features and application programs that often go beyond
8435what is available under Unix. One little-known gem is "dialog", a utility for
8436creating professional-looking dialog boxes from within shell scripts. This
8437article presents a tutorial introduction to the dialog utility, and shows
8438examples of how and where it can be used</I
8439></SPAN
8440></P
8441><P
8442>
8443As he explains, dialog is a real gem in making professional-looking dialog boxes
8444with ease. It creates a variety of dialog boxes, menus, check lists etc.. It is
8445usually installed by default. If not, you can download it from <A
8446HREF="http://invisible-island.net/dialog/"
8447TARGET="_top"
8448>Thomas Dickey</A
8449>'s site. </P
8450><P
8451>The above-mentioned article gives a very good overview of its uses and
8452capabilites.  The man page has more details. It can be used in variety of
8453situations. One good example is building of linux kernel in text mode. Linux
8454kernel uses a modified version of dialog tailored for its needs. </P
8455><P
8456>dialog was initially designed to be used with shell scripts. If you want to use
8457its functionality in a c program, then you can use libdialog. The documentation
8458regarding this is sparse. Definitive reference is the dialog.h header file which
8459comes with the library. You may need to hack here and there to get the required
8460output. The source is easily customizable. I have used it on a number of
8461occasions by modifying the code.</P
8462></DIV
8463><DIV
8464CLASS="SECT2"
8465><HR><H3
8466CLASS="SECT2"
8467><A
8468NAME="PERLCURSES"
8469>19.3. Perl Curses Modules CURSES::FORM and CURSES::WIDGETS</A
8470></H3
8471><P
8472>The perl module Curses, Curses::Form and Curses::Widgets give access to curses
8473from perl.  If you have curses and basic perl is installed, you can get these
8474modules from <A
8475HREF="http://www.cpan.org/modules/01modules.index.html"
8476TARGET="_top"
8477> CPAN
8478All Modules page</A
8479>.  Get the three zipped modules in the Curses category.
8480Once installed you can use these modules from perl scripts like any other
8481module. For more information on perl modules see perlmod man page. The above
8482modules come with good documentation and they have some demo scripts to test the
8483functionality. Though the widgets provided are very rudimentary, these modules
8484provide good access to curses library from perl.</P
8485><P
8486>Some of my code examples are converted to perl by Anuradha Ratnaweera and they
8487are available in the <TT
8488CLASS="LITERAL"
8489>perl</TT
8490> directory.</P
8491><P
8492>
8493For more information see man pages Curses(3) , Curses::Form(3) and
8494Curses::Widgets(3).  These pages are installed only when the above modules are
8495acquired and installed.</P
8496></DIV
8497></DIV
8498><DIV
8499CLASS="SECT1"
8500><HR><H2
8501CLASS="SECT1"
8502><A
8503NAME="JUSTFORFUN"
8504>20. Just For Fun !!!</A
8505></H2
8506><P
8507>This section contains few programs written by me just for fun. They don't
8508signify a better programming practice or the best way of using ncurses. They are
8509provided here so as to allow beginners to get ideas and add more programs to
8510this section.  If you have written a couple of nice, simple programs in curses
8511and want them to included here, contact <A
8512HREF="mailto:[email protected]"
8513TARGET="_top"
8514>me</A
8515>.</P
8516><DIV
8517CLASS="SECT2"
8518><HR><H3
8519CLASS="SECT2"
8520><A
8521NAME="GAMEOFLIFE"
8522>20.1. The Game of Life</A
8523></H3
8524><P
8525>Game of life is a wonder of math. In
8526<A
8527HREF="http://www.math.com/students/wonders/life/life.html"
8528TARGET="_top"
8529>Paul Callahan</A
8530>'s words</P
8531><PRE
8532CLASS="PROGRAMLISTING"
8533><SPAN
8534CLASS="emphasis"
8535><I
8536CLASS="EMPHASIS"
8537>The Game of Life (or simply Life) is not a game in the conventional sense. There
8538are no players, and no winning or losing. Once the "pieces" are placed in the
8539starting position, the rules determine everything that happens later.
8540Nevertheless, Life is full of surprises! In most cases, it is impossible to look
8541at a starting position (or pattern) and see what will happen in the future. The
8542only way to find out is to follow the rules of the game.</I
8543></SPAN
8544></PRE
8545><P
8546>This program starts with a simple inverted U pattern and shows how wonderful
8547life works. There is a lot of room for improvement in the program. You can let
8548the user enter pattern of his choice or even take input from a file. You can
8549also change rules and play with a lot of variations. Search on <A
8550HREF="http://www.google.com"
8551TARGET="_top"
8552>google</A
8553> for interesting information on game
8554of life.</P
8555><P
8556><SPAN
8557CLASS="emphasis"
8558><I
8559CLASS="EMPHASIS"
8560>File Path: JustForFun/life.c</I
8561></SPAN
8562></P
8563></DIV
8564><DIV
8565CLASS="SECT2"
8566><HR><H3
8567CLASS="SECT2"
8568><A
8569NAME="MAGIC"
8570>20.2. Magic Square</A
8571></H3
8572><P
8573>Magic Square, another wonder of math, is very simple to understand but very
8574difficult to make. In a magic square sum of the numbers in each row, each column
8575is equal.  Even diagnol sum can be equal. There are many variations which have
8576special properties.</P
8577><P
8578>This program creates a simple magic square of odd order.</P
8579><P
8580><SPAN
8581CLASS="emphasis"
8582><I
8583CLASS="EMPHASIS"
8584>File Path: JustForFun/magic.c</I
8585></SPAN
8586></P
8587></DIV
8588><DIV
8589CLASS="SECT2"
8590><HR><H3
8591CLASS="SECT2"
8592><A
8593NAME="HANOI"
8594>20.3. Towers of Hanoi</A
8595></H3
8596><P
8597>The famous towers of hanoi solver. The aim of the game is to move the disks on
8598the first peg to last peg, using middle peg as a temporary stay. The catch is
8599not to place a larger disk over a small disk at any time.</P
8600><P
8601><SPAN
8602CLASS="emphasis"
8603><I
8604CLASS="EMPHASIS"
8605>File Path: JustForFun/hanoi.c</I
8606></SPAN
8607></P
8608></DIV
8609><DIV
8610CLASS="SECT2"
8611><HR><H3
8612CLASS="SECT2"
8613><A
8614NAME="QUEENS"
8615>20.4. Queens Puzzle</A
8616></H3
8617><P
8618>The objective of the famous N-Queen puzzle is to put N queens on a N X N chess
8619board without attacking each other. </P
8620><P
8621>This program solves it with a simple backtracking technique.</P
8622><P
8623><SPAN
8624CLASS="emphasis"
8625><I
8626CLASS="EMPHASIS"
8627>File Path: JustForFun/queens.c</I
8628></SPAN
8629></P
8630></DIV
8631><DIV
8632CLASS="SECT2"
8633><HR><H3
8634CLASS="SECT2"
8635><A
8636NAME="SHUFFLE"
8637>20.5. Shuffle</A
8638></H3
8639><P
8640>A fun game, if you have time to kill. </P
8641><P
8642><SPAN
8643CLASS="emphasis"
8644><I
8645CLASS="EMPHASIS"
8646>File Path: JustForFun/shuffle.c</I
8647></SPAN
8648></P
8649></DIV
8650><DIV
8651CLASS="SECT2"
8652><HR><H3
8653CLASS="SECT2"
8654><A
8655NAME="TT"
8656>20.6. Typing Tutor</A
8657></H3
8658><P
8659>A simple typing tutor, I created more out of need than for ease of use. If you
8660know how to put your fingers correctly on the keyboard, but lack practice, this
8661can be helpful. </P
8662><P
8663><SPAN
8664CLASS="emphasis"
8665><I
8666CLASS="EMPHASIS"
8667>File Path: JustForFun/tt.c</I
8668></SPAN
8669></P
8670></DIV
8671></DIV
8672><DIV
8673CLASS="SECT1"
8674><HR><H2
8675CLASS="SECT1"
8676><A
8677NAME="REF"
8678>21. References</A
8679></H2
8680><P
8681></P
8682><UL
8683><LI
8684><P
8685>NCURSES man pages </P
8686></LI
8687><LI
8688><P
8689>NCURSES FAQ at <A
8690HREF="http://invisible-island.net/ncurses/ncurses.faq.html"
8691TARGET="_top"
8692>http://invisible-island.net/ncurses/ncurses.faq.html</A
8693>
8694    </P
8695></LI
8696><LI
8697><P
8698>Writing programs with NCURSES by Eric Raymond and Zeyd M.
8699Ben-Halim at
8700<A
8701HREF="http://invisible-island.net/ncurses/ncurses-intro.html"
8702TARGET="_top"
8703>http://invisible-island.net/ncurses/ncurses-intro.html</A
8704> - somewhat
8705obsolete. I was inspired by this document and the structure of this HOWTO
8706follows from the original document</P
8707></LI
8708></UL
8709></DIV
8710></DIV
8711></BODY
8712></HTML
8713>