ncurses 6.0 - patch 20170401
[ncurses.git] / doc / html / man / curs_sp_funcs.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright (c) 2010-2015,2017 Free Software Foundation, Inc.              *
4   *                                                                          *
5   * Permission is hereby granted, free of charge, to any person obtaining a  *
6   * copy of this software and associated documentation files (the            *
7   * "Software"), to deal in the Software without restriction, including      *
8   * without limitation the rights to use, copy, modify, merge, publish,      *
9   * distribute, distribute with modifications, sublicense, and/or sell       *
10   * copies of the Software, and to permit persons to whom the Software is    *
11   * furnished to do so, subject to the following conditions:                 *
12   *                                                                          *
13   * The above copyright notice and this permission notice shall be included  *
14   * in all copies or substantial portions of the Software.                   *
15   *                                                                          *
16   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23   *                                                                          *
24   * Except as contained in this notice, the name(s) of the above copyright   *
25   * holders shall not be used in advertising or otherwise to promote the     *
26   * sale, use or other dealings in this Software without prior written       *
27   * authorization.                                                           *
28   ****************************************************************************
29   * @Id: curs_sp_funcs.3x,v 1.9 2017/03/27 08:35:44 tom Exp @
30   * ***************************************************************************
31   * ***************************************************************************
32   * ***************************************************************************
33 -->
34 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
35 <HTML>
36 <HEAD>
37 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
38 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
39 <TITLE>curs_sp_funcs 3x</TITLE>
40 <link rev=made href="mailto:bug-ncurses@gnu.org">
41 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
42 </HEAD>
43 <BODY>
44 <H1 class="no-header">curs_sp_funcs 3x</H1>
45 <PRE>
46 <STRONG><A HREF="curs_sp_funcs.3x.html">curs_sp_funcs(3x)</A></STRONG>                                     <STRONG><A HREF="curs_sp_funcs.3x.html">curs_sp_funcs(3x)</A></STRONG>
47
48
49
50
51 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
52        curs_sp_funcs - <STRONG>curses</STRONG> screen-pointer extension
53
54
55 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
56        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
57
58        <STRONG>int</STRONG> <STRONG>alloc_pair_sp(SCREEN*,</STRONG> <STRONG>int,</STRONG> <STRONG>int);</STRONG>
59        <STRONG>int</STRONG> <STRONG>assume_default_colors_sp(SCREEN*,</STRONG> <STRONG>int,</STRONG> <STRONG>int);</STRONG>
60        <STRONG>int</STRONG> <STRONG>baudrate_sp(SCREEN*);</STRONG>
61        <STRONG>int</STRONG> <STRONG>beep_sp(SCREEN*);</STRONG>
62        <STRONG>bool</STRONG> <STRONG>can_change_color_sp(SCREEN*);</STRONG>
63        <STRONG>int</STRONG> <STRONG>cbreak_sp(SCREEN*);</STRONG>
64        <STRONG>int</STRONG> <STRONG>color_content_sp(SCREEN*,</STRONG> <STRONG>short,</STRONG> <STRONG>short*,</STRONG> <STRONG>short*,</STRONG> <STRONG>short*);</STRONG>
65        <STRONG>int</STRONG> <STRONG>curs_set_sp(SCREEN*,</STRONG> <STRONG>int);</STRONG>
66        <STRONG>int</STRONG> <STRONG>define_key_sp(SCREEN*,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*,</STRONG> <STRONG>int);</STRONG>
67        <STRONG>int</STRONG> <STRONG>def_prog_mode_sp(SCREEN*);</STRONG>
68        <STRONG>int</STRONG> <STRONG>def_shell_mode_sp(SCREEN*);</STRONG>
69        <STRONG>int</STRONG> <STRONG>delay_output_sp(SCREEN*,</STRONG> <STRONG>int);</STRONG>
70        <STRONG>int</STRONG> <STRONG>doupdate_sp(SCREEN*);</STRONG>
71        <STRONG>int</STRONG> <STRONG>echo_sp(SCREEN*);</STRONG>
72        <STRONG>int</STRONG> <STRONG>endwin_sp(SCREEN*);</STRONG>
73        <STRONG>int</STRONG> <STRONG>erasechar_sp(SCREEN*);</STRONG>
74        <STRONG>int</STRONG> <STRONG>extended_color_content_sp(SCREEN</STRONG> <STRONG>*,</STRONG> <STRONG>int,</STRONG> <STRONG>int</STRONG> <STRONG>*,</STRONG> <STRONG>int</STRONG> <STRONG>*,</STRONG> <STRONG>int</STRONG> <STRONG>*);</STRONG>
75        <STRONG>int</STRONG> <STRONG>extended_pair_content_sp(SCREEN*,</STRONG> <STRONG>int,</STRONG> <STRONG>int</STRONG> <STRONG>*,</STRONG> <STRONG>int</STRONG> <STRONG>*);</STRONG>
76        <STRONG>int</STRONG> <STRONG>extended_slk_color_sp(SCREEN*,</STRONG> <STRONG>int);</STRONG>
77        <STRONG>int</STRONG> <STRONG>filter_sp(SCREEN*);</STRONG>
78        <STRONG>int</STRONG> <STRONG>find_pair_sp(SCREEN*,</STRONG> <STRONG>int,</STRONG> <STRONG>int);</STRONG>
79        <STRONG>int</STRONG> <STRONG>free_pair_sp(SCREEN*,</STRONG> <STRONG>int);</STRONG>
80        <STRONG>int</STRONG> <STRONG>flash_sp(SCREEN*);</STRONG>
81        <STRONG>int</STRONG> <STRONG>flushinp_sp(SCREEN*);</STRONG>
82        <STRONG>int</STRONG> <STRONG>get_escdelay_sp(SCREEN*);</STRONG>
83        <STRONG>int</STRONG> <STRONG>getmouse_sp(SCREEN*,</STRONG> <STRONG>MEVENT*);</STRONG>
84        <STRONG>WINDOW*</STRONG> <STRONG>getwin_sp(SCREEN*,</STRONG> <STRONG>FILE*);</STRONG>
85        <STRONG>int</STRONG> <STRONG>halfdelay_sp(SCREEN*);</STRONG>
86        <STRONG>bool</STRONG> <STRONG>has_colors_sp(SCREEN*);</STRONG>
87        <STRONG>bool</STRONG> <STRONG>has_ic_sp(SCREEN*);</STRONG>
88        <STRONG>bool</STRONG> <STRONG>has_il_sp(SCREEN*);</STRONG>
89        <STRONG>int</STRONG> <STRONG>has_key_sp(SCREEN*,</STRONG> <STRONG>int);</STRONG>
90        <STRONG>bool</STRONG> <STRONG>has_mouse_sp(SCREEN*);</STRONG>
91        <STRONG>int</STRONG> <STRONG>init_color_sp(SCREEN*,</STRONG> <STRONG>short,</STRONG> <STRONG>short,</STRONG> <STRONG>short,</STRONG> <STRONG>short);</STRONG>
92        <STRONG>int</STRONG> <STRONG>init_extended_color_sp(SCREEN*,</STRONG> <STRONG>int,</STRONG> <STRONG>int,</STRONG> <STRONG>int,</STRONG> <STRONG>int);</STRONG>
93        <STRONG>int</STRONG> <STRONG>init_extended_pair_sp(SCREEN*,</STRONG> <STRONG>int,</STRONG> <STRONG>int,</STRONG> <STRONG>int);</STRONG>
94        <STRONG>int</STRONG> <STRONG>init_pair_sp(SCREEN*,</STRONG> <STRONG>short,</STRONG> <STRONG>short,</STRONG> <STRONG>short);</STRONG>
95        <STRONG>int</STRONG> <STRONG>intrflush_sp(SCREEN*,</STRONG> <STRONG>WINDOW*,</STRONG> <STRONG>bool);</STRONG>
96        <STRONG>bool</STRONG> <STRONG>isendwin_sp(SCREEN*);</STRONG>
97        <STRONG>bool</STRONG> <STRONG>is_term_resized_sp(SCREEN*,</STRONG> <STRONG>int,</STRONG> <STRONG>int);</STRONG>
98        <STRONG>char*</STRONG> <STRONG>keybound_sp(SCREEN*,</STRONG> <STRONG>int,</STRONG> <STRONG>int);</STRONG>
99        <STRONG>int</STRONG> <STRONG>key_defined_sp(SCREEN*,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*);</STRONG>
100        <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>keyname_sp(SCREEN*,</STRONG> <STRONG>int);</STRONG>
101        <STRONG>int</STRONG> <STRONG>keyok_sp(SCREEN*,</STRONG> <STRONG>int,</STRONG> <STRONG>bool);</STRONG>
102        <STRONG>char</STRONG> <STRONG>killchar_sp(SCREEN*);</STRONG>
103        <STRONG>char*</STRONG> <STRONG>longname_sp(SCREEN*);</STRONG>
104        <STRONG>int</STRONG> <STRONG>mcprint_sp(SCREEN*,</STRONG> <STRONG>char</STRONG> <STRONG>*,</STRONG> <STRONG>int);</STRONG>
105        <STRONG>int</STRONG> <STRONG>mouseinterval_sp(SCREEN*,</STRONG> <STRONG>int);</STRONG>
106        <STRONG>mmask_t</STRONG> <STRONG>mousemask_sp(SCREEN*,</STRONG> <STRONG>mmask_t,</STRONG> <STRONG>mmask_t</STRONG> <STRONG>*);</STRONG>
107        <STRONG>int</STRONG> <STRONG>mvcur_sp(SCREEN*,</STRONG> <STRONG>int,</STRONG> <STRONG>int,</STRONG> <STRONG>int,</STRONG> <STRONG>int);</STRONG>
108        <STRONG>int</STRONG> <STRONG>napms_sp(SCREEN*,</STRONG> <STRONG>int);</STRONG>
109        <STRONG>WINDOW*</STRONG> <STRONG>newpad_sp(SCREEN*,</STRONG> <STRONG>int,</STRONG> <STRONG>int);</STRONG>
110        <STRONG>SCREEN*</STRONG> <STRONG>new_prescr(void);</STRONG>
111        <STRONG>SCREEN*</STRONG> <STRONG>newterm_sp(SCREEN*,</STRONG> <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*,</STRONG> <STRONG>FILE</STRONG> <STRONG>*,</STRONG> <STRONG>FILE</STRONG> <STRONG>*);</STRONG>
112        <STRONG>WINDOW*</STRONG> <STRONG>newwin_sp(SCREEN*,</STRONG> <STRONG>int,</STRONG> <STRONG>int,</STRONG> <STRONG>int,</STRONG> <STRONG>int);</STRONG>
113        <STRONG>int</STRONG> <STRONG>nl_sp(SCREEN*);</STRONG>
114        <STRONG>int</STRONG> <STRONG>nocbreak_sp(SCREEN*);</STRONG>
115        <STRONG>int</STRONG> <STRONG>noecho_sp(SCREEN*);</STRONG>
116        <STRONG>int</STRONG> <STRONG>nofilter_sp(SCREEN*);</STRONG>
117        <STRONG>int</STRONG> <STRONG>nonl_sp(SCREEN*);</STRONG>
118        <STRONG>void</STRONG> <STRONG>noqiflush_sp(SCREEN*);</STRONG>
119        <STRONG>int</STRONG> <STRONG>noraw_sp(SCREEN*);</STRONG>
120        <STRONG>int</STRONG> <STRONG>pair_content_sp(SCREEN*,</STRONG> <STRONG>short,</STRONG> <STRONG>short*,</STRONG> <STRONG>short*);</STRONG>
121        <STRONG>void</STRONG> <STRONG>qiflush_sp(SCREEN*);</STRONG>
122        <STRONG>int</STRONG> <STRONG>raw_sp(SCREEN*);</STRONG>
123        <STRONG>int</STRONG> <STRONG>reset_prog_mode_sp(SCREEN*);</STRONG>
124        <STRONG>int</STRONG> <STRONG>reset_shell_mode_sp(SCREEN*);</STRONG>
125        <STRONG>int</STRONG> <STRONG>resetty_sp(SCREEN*);</STRONG>
126        <STRONG>int</STRONG> <STRONG>resize_term_sp(SCREEN*,</STRONG> <STRONG>int,</STRONG> <STRONG>int);</STRONG>
127        <STRONG>int</STRONG> <STRONG>resizeterm_sp(SCREEN*,</STRONG> <STRONG>int,</STRONG> <STRONG>int);</STRONG>
128        <STRONG>int</STRONG> <STRONG>restartterm_sp(SCREEN*,</STRONG> <STRONG>NCURSES_CONST</STRONG> <STRONG>char*,</STRONG> <STRONG>int,</STRONG> <STRONG>int</STRONG> <STRONG>*);</STRONG>
129        <STRONG>int</STRONG> <STRONG>ripoffline_sp(SCREEN*,</STRONG> <STRONG>int,</STRONG> <STRONG>int</STRONG> <STRONG>(*)(WINDOW*,</STRONG> <STRONG>int));</STRONG>
130        <STRONG>int</STRONG> <STRONG>savetty_sp(SCREEN*);</STRONG>
131        <STRONG>int</STRONG> <STRONG>scr_init_sp(SCREEN*,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*);</STRONG>
132        <STRONG>int</STRONG> <STRONG>scr_restore_sp(SCREEN*,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*);</STRONG>
133        <STRONG>int</STRONG> <STRONG>scr_set_sp(SCREEN*,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*);</STRONG>
134        <STRONG>TERMINAL*</STRONG> <STRONG>set_curterm_sp(SCREEN*,</STRONG> <STRONG>TERMINAL*);</STRONG>
135        <STRONG>int</STRONG> <STRONG>set_escdelay_sp(SCREEN*,</STRONG> <STRONG>int);</STRONG>
136        <STRONG>int</STRONG> <STRONG>set_tabsize_sp(SCREEN*,</STRONG> <STRONG>int);</STRONG>
137        <STRONG>int</STRONG> <STRONG>slk_attroff_sp(SCREEN*,</STRONG> <STRONG>const</STRONG> <STRONG>chtype);</STRONG>
138        <STRONG>int</STRONG> <STRONG>slk_attron_sp(SCREEN*,</STRONG> <STRONG>const</STRONG> <STRONG>chtype);</STRONG>
139        <STRONG>int</STRONG> <STRONG>slk_attr_set_sp(SCREEN*,</STRONG> <STRONG>const</STRONG> <STRONG>attr_t,</STRONG> <STRONG>short,</STRONG> <STRONG>void*);</STRONG>
140        <STRONG>int</STRONG> <STRONG>slk_attrset_sp(SCREEN*,</STRONG> <STRONG>const</STRONG> <STRONG>chtype);</STRONG>
141        <STRONG>int</STRONG> <STRONG>slk_attr_sp(SCREEN*);</STRONG>
142        <STRONG>int</STRONG> <STRONG>slk_clear_sp(SCREEN*);</STRONG>
143        <STRONG>int</STRONG> <STRONG>slk_color_sp(SCREEN*,</STRONG> <STRONG>short);</STRONG>
144        <STRONG>int</STRONG> <STRONG>slk_init_sp(SCREEN*,</STRONG> <STRONG>int);</STRONG>
145        <STRONG>int</STRONG> <STRONG>slk_label_sp(SCREEN*,</STRONG> <STRONG>int);</STRONG>
146        <STRONG>int</STRONG> <STRONG>slk_noutrefresh_sp(SCREEN*);</STRONG>
147        <STRONG>int</STRONG> <STRONG>slk_refresh_sp(SCREEN*);</STRONG>
148        <STRONG>int</STRONG> <STRONG>slk_restore_sp(SCREEN*);</STRONG>
149        <STRONG>int</STRONG> <STRONG>slk_set_sp(SCREEN*,</STRONG> <STRONG>int,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*,</STRONG> <STRONG>int);</STRONG>
150        <STRONG>int</STRONG> <STRONG>slk_touch_sp(SCREEN*);</STRONG>
151        <STRONG>int</STRONG> <STRONG>start_color_sp(SCREEN*);</STRONG>
152        <STRONG>attr_t</STRONG> <STRONG>term_attrs_sp(SCREEN*);</STRONG>
153        <STRONG>chtype</STRONG> <STRONG>termattrs_sp(SCREEN*);</STRONG>
154        <STRONG>char*</STRONG> <STRONG>termname_sp(SCREEN*);</STRONG>
155        <STRONG>int</STRONG> <STRONG>typeahead_sp(SCREEN*,</STRONG> <STRONG>int);</STRONG>
156        <STRONG>NCURSES_CONST</STRONG> <STRONG>char*</STRONG> <STRONG>unctrl_sp(SCREEN*,</STRONG> <STRONG>chtype);</STRONG>
157        <STRONG>int</STRONG> <STRONG>ungetch_sp(SCREEN*,</STRONG> <STRONG>int);</STRONG>
158        <STRONG>int</STRONG> <STRONG>ungetmouse_sp(SCREEN*,MEVENT</STRONG> <STRONG>*);</STRONG>
159        <STRONG>int</STRONG> <STRONG>unget_wch_sp(SCREEN*,</STRONG> <STRONG>const</STRONG> <STRONG>wchar_t);</STRONG>
160        <STRONG>int</STRONG> <STRONG>use_default_colors_sp(SCREEN*);</STRONG>
161        <STRONG>void</STRONG> <STRONG>use_env_sp(SCREEN*,</STRONG> <STRONG>bool);</STRONG>
162        <STRONG>void</STRONG> <STRONG>use_tioctl_sp</STRONG> <STRONG>(SCREEN</STRONG> <STRONG>*,</STRONG> <STRONG>bool)</STRONG>
163        <STRONG>int</STRONG> <STRONG>use_legacy_coding_sp(SCREEN*,</STRONG> <STRONG>int);</STRONG>
164        <STRONG>int</STRONG> <STRONG>vid_attr_sp(SCREEN*,</STRONG> <STRONG>attr_t,</STRONG> <STRONG>short,</STRONG> <STRONG>void</STRONG> <STRONG>*);</STRONG>
165        <STRONG>int</STRONG> <STRONG>vidattr_sp(SCREEN*,</STRONG> <STRONG>chtype);</STRONG>
166        <STRONG>int</STRONG> <STRONG>vid_puts_sp(SCREEN*,</STRONG> <STRONG>attr_t,</STRONG> <STRONG>short,</STRONG> <STRONG>void</STRONG> <STRONG>*,</STRONG> <STRONG>NCURSES_SP_OUTC);</STRONG>
167        <STRONG>int</STRONG> <STRONG>vidputs_sp(SCREEN*,</STRONG> <STRONG>chtype,</STRONG> <STRONG>NCURSES_SP_OUTC);</STRONG>
168        <STRONG>wchar_t*</STRONG> <STRONG>wunctrl_sp(SCREEN*,</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*);</STRONG>
169
170        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
171
172        <STRONG>int</STRONG> <STRONG>new_form_sp(SCREEN*,</STRONG> <STRONG>FIELD</STRONG> <STRONG>**);</STRONG>
173
174        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
175
176        <STRONG>int</STRONG> <STRONG>new_menu_sp(SCREEN*,</STRONG> <STRONG>ITEM</STRONG> <STRONG>**);</STRONG>
177
178        <STRONG>#include</STRONG> <STRONG>&lt;panel.h&gt;</STRONG>
179
180        <STRONG>int</STRONG> <STRONG>ceiling_panel(SCREEN*);</STRONG>
181        <STRONG>PANEL*</STRONG> <STRONG>ground_panel(SCREEN*);</STRONG>
182        <STRONG>int</STRONG> <STRONG>update_panels_sp(SCREEN*);</STRONG>
183
184        <STRONG>#include</STRONG> <STRONG>&lt;term.h&gt;</STRONG>
185
186        <STRONG>int</STRONG> <STRONG>del_curterm_sp(SCREEN*,</STRONG> <STRONG>TERMINAL</STRONG> <STRONG>*);</STRONG>
187        <STRONG>int</STRONG> <STRONG>putp_sp(SCREEN*,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*);</STRONG>
188        <STRONG>int</STRONG> <STRONG>tgetflag_sp(SCREEN*,</STRONG> <STRONG>char</STRONG> <STRONG>*,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*);</STRONG>
189        <STRONG>int</STRONG> <STRONG>tgetent_sp(SCREEN*,</STRONG> <STRONG>char</STRONG> <STRONG>*,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*);</STRONG>
190        <STRONG>int</STRONG> <STRONG>tgetnum_sp(SCREEN*,</STRONG> <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*);</STRONG>
191        <STRONG>char*</STRONG> <STRONG>tgetstr_sp(SCREEN*,</STRONG> <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*,</STRONG> <STRONG>char</STRONG> <STRONG>**);</STRONG>
192        <STRONG>int</STRONG> <STRONG>tigetflag_sp(SCREEN*,</STRONG> <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*);</STRONG>
193        <STRONG>int</STRONG> <STRONG>tigetnum_sp(SCREEN*,</STRONG> <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*);</STRONG>
194        <STRONG>char*</STRONG> <STRONG>tigetstr_sp(SCREEN*,</STRONG> <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*);</STRONG>
195        <STRONG>int</STRONG> <STRONG>tputs_sp(SCREEN*,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*,</STRONG> <STRONG>int,</STRONG> <STRONG>NCURSES_SP_OUTC);</STRONG>
196
197
198 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
199        This  implementation can be configured to provide a set of
200        functions which improve the  ability  to  manage  multiple
201        screens.  This feature can be added to any of the configu-
202        rations supported by  ncurses;  it  adds  new  entrypoints
203        without changing the meaning of any of the existing ones.
204
205
206 </PRE><H3><a name="h3-IMPROVED-FUNCTIONS">IMPROVED FUNCTIONS</a></H3><PRE>
207        Most  of  the functions are new versions of existing func-
208        tions.  A parameter is added at the front of the parameter
209        list.  It is a SCREEN pointer.
210
211        The  existing  functions all use the current screen, which
212        is a static variable.   The  extended  functions  use  the
213        specified screen, thereby reducing the number of variables
214        which must be modified to update multiple screens.
215
216
217 </PRE><H3><a name="h3-NEW-FUNCTIONS">NEW FUNCTIONS</a></H3><PRE>
218        Here are the new functions:
219
220        ceiling_panel
221             this returns a pointer to the topmost  panel  in  the
222             given screen.
223
224        ground_panel
225             this  returns  a  pointer  to the lowest panel in the
226             given screen.
227
228        new_prescr
229             when creating a new screen, the library  uses  static
230             variables   which   have   been   preset,   e.g.,  by
231             <STRONG><A HREF="curs_util.3x.html">use_env(3x)</A></STRONG>, <STRONG><A HREF="curs_util.3x.html">filter(3x)</A></STRONG>, etc.  With the screen-point-
232             er extension, there are situations where it must cre-
233             ate a current screen before  the  unextended  library
234             does.   The <STRONG>new_prescr</STRONG> function is used internally to
235             handle these cases.  It is also provided as an entry-
236             point  to allow applications to customize the library
237             initialization.
238
239
240 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
241        This extension introduces some new names:
242
243        NCURSES_SP_FUNCS
244             This is set to the library  patch-level  number.   In
245             the  unextended library, this is zero (0), to make it
246             useful for checking if the extension is provided.
247
248        NCURSES_SP_NAME
249             The new functions are named using  the  macro  <EM>NCURS-</EM>
250             <EM>ES</EM><STRONG>_</STRONG><EM>SP</EM><STRONG>_</STRONG><EM>NAME</EM>,  which  hides  the actual implementation.
251             Currently this adds a "_sp" suffix to the name of the
252             unextended  function.   This  manual page indexes the
253             extensions showing the full name.  However the proper
254             usage  of  these functions uses the macro, to provide
255             for the possibility of changing the naming convention
256             for specific library configurations.
257
258        NCURSES_SP_OUTC
259             This  is  a  new  function-pointer type to use in the
260             screen-pointer functions  where  an  <EM>NCURSES</EM><STRONG>_</STRONG><EM>OUTC</EM>  is
261             used in the unextended library.
262
263        NCURSES_OUTC
264             This  is  a  function-pointer type used for the cases
265             where a function  passes  characters  to  the  output
266             stream, e.g., <STRONG><A HREF="curs_terminfo.3x.html">vidputs(3x)</A></STRONG>.
267
268
269 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
270        These  routines  are  specific  to ncurses.  They were not
271        supported on Version 7, BSD or System  V  implementations.
272        It  is  recommended that any code depending on ncurses ex-
273        tensions be conditioned using <EM>NCURSES</EM><STRONG>_</STRONG><EM>SP</EM><STRONG>_</STRONG><EM>FUNCS</EM>.
274
275
276 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
277        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>, <STRONG><A HREF="curs_threads.3x.html">curs_threads(3x)</A></STRONG>.
278
279
280
281                                                       <STRONG><A HREF="curs_sp_funcs.3x.html">curs_sp_funcs(3x)</A></STRONG>
282 </PRE>
283 <div class="nav">
284 <ul>
285 <li><a href="#h2-NAME">NAME</a></li>
286 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
287 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
288 <ul>
289 <li><a href="#h3-IMPROVED-FUNCTIONS">IMPROVED FUNCTIONS</a></li>
290 <li><a href="#h3-NEW-FUNCTIONS">NEW FUNCTIONS</a></li>
291 </ul>
292 </li>
293 <li><a href="#h2-NOTES">NOTES</a></li>
294 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
295 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
296 </ul>
297 </div>
298 </BODY>
299 </HTML>