ncurses 6.0 - patch 20151205
[ncurses.git] / doc / html / man / curs_sp_funcs.3x.html
index a11947a74abddb09699984dbdcee430375577c82..c85498ba6821ee0d546bc6aa198247b2adc1d51d 100644 (file)
@@ -1,7 +1,6 @@
-<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
 <!-- 
   ****************************************************************************
-  * Copyright (c) 2010 Free Software Foundation, Inc.                        *
+  * Copyright (c) 2010-2013,2015 Free Software Foundation, Inc.              *
   *                                                                          *
   * Permission is hereby granted, free of charge, to any person obtaining a  *
   * copy of this software and associated documentation files (the            *
   * sale, use or other dealings in this Software without prior written       *
   * authorization.                                                           *
   ****************************************************************************
-  * @Id: curs_sp_funcs.3x,v 1.5 2010/12/04 18:38:55 tom Exp @
+  * @Id: curs_sp_funcs.3x,v 1.7 2015/12/05 20:33:14 tom Exp @
   * ***************************************************************************
   * ***************************************************************************
   * ***************************************************************************
 -->
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
 <HTML>
 <HEAD>
+<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
+<meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
 <TITLE>curs_sp_funcs 3x</TITLE>
 <link rev=made href="mailto:bug-ncurses@gnu.org">
 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
 </HEAD>
 <BODY>
-<H1>curs_sp_funcs 3x</H1>
-<HR>
+<H1 class="no-header">curs_sp_funcs 3x</H1>
 <PRE>
-<!-- Manpage converted by man2html 3.0.1 -->
 <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>
 
 
 
 
 </PRE>
-<H2>NAME</H2><PRE>
-       new_prescr - <STRONG>curses</STRONG> screen-pointer extension
+<H2><a name="h2-NAME">NAME</a></H2><PRE>
+       curs_sp_funcs - <STRONG>curses</STRONG> screen-pointer extension
 
 
 </PRE>
-<H2>SYNOPSIS</H2><PRE>
+<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
 
        <STRONG>int</STRONG> <STRONG>assume_default_colors_sp(SCREEN*,</STRONG> <STRONG>int,</STRONG> <STRONG>int);</STRONG>
        <STRONG>int</STRONG> <STRONG>slk_attron_sp(SCREEN*,</STRONG> <STRONG>const</STRONG> <STRONG>chtype);</STRONG>
        <STRONG>int</STRONG> <STRONG>slk_attr_set_sp(SCREEN*,</STRONG> <STRONG>const</STRONG> <STRONG>attr_t,</STRONG> <STRONG>short,</STRONG> <STRONG>void*);</STRONG>
        <STRONG>int</STRONG> <STRONG>slk_attrset_sp(SCREEN*,</STRONG> <STRONG>const</STRONG> <STRONG>chtype);</STRONG>
-       <STRONG>int</STRONG> <STRONG>slk_attr_sp((SCREEN*);</STRONG>
+       <STRONG>int</STRONG> <STRONG>slk_attr_sp(SCREEN*);</STRONG>
        <STRONG>int</STRONG> <STRONG>slk_clear_sp(SCREEN*);</STRONG>
        <STRONG>int</STRONG> <STRONG>slk_color_sp(SCREEN*,</STRONG> <STRONG>short);</STRONG>
        <STRONG>int</STRONG> <STRONG>slk_init_sp(SCREEN*,</STRONG> <STRONG>int);</STRONG>
 
 
 </PRE>
-<H2>DESCRIPTION</H2><PRE>
+<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
        This  implementation can be configured to provide a set of
        functions which improve the  ability  to  manage  multiple
        screens.  This feature can be added to any of the configu-
        rations supported by  ncurses;  it  adds  new  entrypoints
-       without  changing the meaning of any of the existing ones.
+       without changing the meaning of any of the existing ones.
 
 
-   <STRONG>IMPROVED</STRONG> <STRONG>FUNCTIONS</STRONG>
-       Most of the functions are new versions of  existing  func-
+</PRE>
+<H3><a name="h3-IMPROVED-FUNCTIONS">IMPROVED FUNCTIONS</a></H3><PRE>
+       Most  of  the functions are new versions of existing func-
        tions.  A parameter is added at the front of the parameter
        list.  It is a SCREEN pointer.
 
-       The existing functions all use the current  screen,  which
-       is  a  static  variable.   The  extended functions use the
+       The  existing  functions all use the current screen, which
+       is a static variable.   The  extended  functions  use  the
        specified screen, thereby reducing the number of variables
        which must be modified to update multiple screens.
 
-   <STRONG>NEW</STRONG> <STRONG>FUNCTIONS</STRONG>
+
+</PRE>
+<H3><a name="h3-NEW-FUNCTIONS">NEW FUNCTIONS</a></H3><PRE>
        Here are the new functions:
 
        ceiling_panel
-            this  returns  a  pointer to the topmost panel in the
+            this returns a pointer to the topmost  panel  in  the
             given screen.
 
        ground_panel
-            this returns a pointer to the  lowest  panel  in  the
+            this  returns  a  pointer  to the lowest panel in the
             given screen.
 
        new_prescr
-            when  creating  a new screen, the library uses static
-            variables  which   have   been   preset,   e.g.,   by
-            <STRONG><A HREF="use_env.3x.html">use_env(3x)</A></STRONG>, <STRONG><A HREF="filter.3x.html">filter(3x)</A></STRONG>, etc.  With the screen-point-
+            when creating a new screen, the library  uses  static
+            variables   which   have   been   preset,   e.g.,  by
+            <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>, <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>, etc.  With the screen-point-
             er extension, there are situations where it must cre-
-            ate  a  current  screen before the unextended library
-            does.  The <STRONG>new_prescr</STRONG> function is used internally  to
+            ate a current screen before  the  unextended  library
+            does.   The <STRONG>new_prescr</STRONG> function is used internally to
             handle these cases.  It is also provided as an entry-
-            point to allow applications to customize the  library
+            point  to allow applications to customize the library
             initialization.
 
 
 </PRE>
-<H2>NOTES</H2><PRE>
+<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
        This extension introduces some new names:
 
        NCURSES_SP_FUNCS
-            This  is  set  to the library patch-level number.  In
-            the unextended library, this is zero (0), to make  it
+            This is set to the library  patch-level  number.   In
+            the  unextended library, this is zero (0), to make it
             useful for checking if the extension is provided.
 
        NCURSES_SP_NAME
-            The  new  functions  are named using the macro <EM>NCURS-</EM>
-            <EM>ES</EM><STRONG>_</STRONG><EM>SP</EM><STRONG>_</STRONG><EM>NAME</EM>, which hides  the  actual  implementation.
+            The new functions are named using  the  macro  <EM>NCURS-</EM>
+            <EM>ES</EM><STRONG>_</STRONG><EM>SP</EM><STRONG>_</STRONG><EM>NAME</EM>,  which  hides  the actual implementation.
             Currently this adds a "_sp" suffix to the name of the
-            unextended function.  This manual  page  indexes  the
+            unextended  function.   This  manual page indexes the
             extensions showing the full name.  However the proper
-            usage of these functions uses the macro,  to  provide
+            usage  of  these functions uses the macro, to provide
             for the possibility of changing the naming convention
             for specific library configurations.
 
        NCURSES_SP_OUTC
-            This is a new function-pointer type  to  use  in  the
-            screen-pointer  functions  where  an  <EM>NCURSES</EM><STRONG>_</STRONG><EM>OUTC</EM> is
+            This  is  a  new  function-pointer type to use in the
+            screen-pointer functions  where  an  <EM>NCURSES</EM><STRONG>_</STRONG><EM>OUTC</EM>  is
             used in the unextended library.
 
        NCURSES_OUTC
-            This is a function-pointer type used  for  the  cases
-            where  a  function  passes  characters  to the output
-            stream, e.g., <STRONG><A HREF="vidputs.3x.html">vidputs(3x)</A></STRONG>.
-
+            This  is  a  function-pointer type used for the cases
+            where a function  passes  characters  to  the  output
+            stream, e.g., <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>.
 
 
 </PRE>
-<H2>PORTABILITY</H2><PRE>
-       These routines are specific to  ncurses.   They  were  not
-       supported  on  Version 7, BSD or System V implementations.
-       It is recommended that any code depending on  ncurses  ex-
+<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
+       These  routines  are  specific  to ncurses.  They were not
+       supported on Version 7, BSD or System  V  implementations.
+       It  is  recommended that any code depending on ncurses ex-
        tensions be conditioned using <EM>NCURSES</EM><STRONG>_</STRONG><EM>SP</EM><STRONG>_</STRONG><EM>FUNCS</EM>.
 
 
 </PRE>
-<H2>SEE ALSO</H2><PRE>
+<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
        <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>.
 
 
 
                                                       <STRONG><A HREF="curs_sp_funcs.3x.html">curs_sp_funcs(3x)</A></STRONG>
 </PRE>
-<HR>
-<ADDRESS>
-Man(1) output converted with
-<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
-</ADDRESS>
+<div class="nav">
+<ul>
+<li><a href="#h2-NAME">NAME</a></li>
+<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
+<li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
+<ul>
+<li><a href="#h3-IMPROVED-FUNCTIONS">IMPROVED FUNCTIONS</a></li>
+<li><a href="#h3-NEW-FUNCTIONS">NEW FUNCTIONS</a></li>
+</ul>
+</li>
+<li><a href="#h2-NOTES">NOTES</a></li>
+<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
+<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
+</ul>
+</div>
 </BODY>
 </HTML>