diff options
Diffstat (limited to 'doc/html/man/new_pair.3x.html')
| -rw-r--r-- | doc/html/man/new_pair.3x.html | 64 |
1 files changed, 32 insertions, 32 deletions
diff --git a/doc/html/man/new_pair.3x.html b/doc/html/man/new_pair.3x.html index dec3de1..12214be 100644 --- a/doc/html/man/new_pair.3x.html +++ b/doc/html/man/new_pair.3x.html @@ -1,6 +1,6 @@ -<!-- +<!-- **************************************************************************** - * Copyright 2018,2020 Thomas E. Dickey * + * Copyright 2018-2020,2021 Thomas E. Dickey * * Copyright 2017 Free Software Foundation, Inc. * * * * Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,7 +28,7 @@ * authorization. * **************************************************************************** * Author: Thomas E. Dickey - * @Id: new_pair.3x,v 1.14 2020/02/02 23:34:34 tom Exp @ + * @Id: new_pair.3x,v 1.16 2021/06/17 21:26:02 tom Exp @ --> <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <HTML> @@ -54,33 +54,33 @@ </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE> <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> - <STRONG>int</STRONG> <STRONG>alloc_pair(int</STRONG> <STRONG>fg,</STRONG> <STRONG>int</STRONG> <STRONG>bg);</STRONG> - <STRONG>int</STRONG> <STRONG>find_pair(int</STRONG> <STRONG>fg,</STRONG> <STRONG>int</STRONG> <STRONG>bg);</STRONG> - <STRONG>int</STRONG> <STRONG>free_pair(int</STRONG> <STRONG>pair);</STRONG> + <STRONG>int</STRONG> <STRONG>alloc_pair(int</STRONG> <EM>fg</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>bg</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>find_pair(int</STRONG> <EM>fg</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>bg</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>free_pair(int</STRONG> <EM>pair</EM><STRONG>);</STRONG> </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE> These functions are an extension to the curses library. They permit an - application to dynamically allocate a color pair using the fore- - ground/background colors rather than assign a fixed color pair number, - and return an unused pair to the pool. + application to dynamically allocate a color pair using the + foreground/background colors rather than assign a fixed color pair + number, and return an unused pair to the pool. The number of colors may be related to the number of possible color pairs for a given terminal, or it may not: - <STRONG>o</STRONG> While almost all terminals allow setting the color <EM>attributes</EM> inde- - pendently, it is unlikely that your terminal allows you to modify - the attributes of a given character cell without rewriting it. - That is, the foreground and background colors are applied as a + <STRONG>o</STRONG> While almost all terminals allow setting the color <EM>attributes</EM> + independently, it is unlikely that your terminal allows you to + modify the attributes of a given character cell without rewriting + it. That is, the foreground and background colors are applied as a pair. - <STRONG>o</STRONG> Color pairs are the curses library's way of managing a color pal- - ette on a terminal. If the library does not keep track of the <EM>com-</EM> - <EM>binations</EM> of colors which are displayed, it will be inefficient. + <STRONG>o</STRONG> Color pairs are the curses library's way of managing a color + palette on a terminal. If the library does not keep track of the + <EM>combinations</EM> of colors which are displayed, it will be inefficient. - <STRONG>o</STRONG> For simple terminal emulators with only a few dozen color combina- - tions, it is convenient to use the maximum number of combinations - as the limit on color pairs: + <STRONG>o</STRONG> For simple terminal emulators with only a few dozen color + combinations, it is convenient to use the maximum number of + combinations as the limit on color pairs: <STRONG>COLORS</STRONG> <EM>*</EM> <STRONG>COLORS</STRONG> @@ -93,8 +93,8 @@ a predefined color scheme. Beyond that lies in the realm of programs using the foreground and - background colors for "ASCII art" (or some other non-textual appli- - cation). + background colors for "ASCII art" (or some other non-textual + application). Also beyond those few dozen pairs, the required size for a table to represent the combinations grows rapidly with an increasing number @@ -105,9 +105,9 @@ </PRE><H3><a name="h3-alloc_pair">alloc_pair</a></H3><PRE> - The <STRONG>alloc_pair</STRONG> function accepts parameters for foreground and back- - ground color, and checks if that color combination is already associ- - ated with a color pair. + The <STRONG>alloc_pair</STRONG> function accepts parameters for foreground and + background color, and checks if that color combination is already + associated with a color pair. <STRONG>o</STRONG> If the combination already exists, <STRONG>alloc_pair</STRONG> returns the existing pair. @@ -115,21 +115,21 @@ <STRONG>o</STRONG> If the combination does not exist, <STRONG>alloc_pair</STRONG> allocates a new color pair and returns that. - <STRONG>o</STRONG> If the table fills up, <STRONG>alloc_pair</STRONG> discards the least-recently allo- - cated entry using <STRONG>free_pair</STRONG> and allocates a new color pair. + <STRONG>o</STRONG> If the table fills up, <STRONG>alloc_pair</STRONG> discards the least-recently + allocated entry using <STRONG>free_pair</STRONG> and allocates a new color pair. All of the color pairs are allocated from a table of possible color - pairs. The size of the table is determined by the terminfo <EM>pairs</EM> capa- - bility. The table is shared with <STRONG>init_pair</STRONG>; in fact <STRONG>alloc_pair</STRONG> calls - <STRONG>init_pair</STRONG> after updating the ncurses library's fast index to the colors - versus color pairs. + pairs. The size of the table is determined by the terminfo <EM>pairs</EM> + capability. The table is shared with <STRONG>init_pair</STRONG>; in fact <STRONG>alloc_pair</STRONG> + calls <STRONG>init_pair</STRONG> after updating the ncurses library's fast index to the + colors versus color pairs. </PRE><H3><a name="h3-find_pair">find_pair</a></H3><PRE> The <STRONG>find_pair</STRONG> function accepts parameters for foreground and background color, and checks if that color combination is already associated with - a color pair, returning the pair number if it has been allocated. Oth- - erwise it returns -1. + a color pair, returning the pair number if it has been allocated. + Otherwise it returns -1. </PRE><H3><a name="h3-free_pair">free_pair</a></H3><PRE> |