X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fnew_pair.3x;h=c22523887ac63b046960eb36824d09a9d6618b7d;hp=46c23b48f7d6fa31563fa246ae81f4d60b778d4d;hb=5925150381bb42a4d8c7116d62c348a7b84309f3;hpb=90d42867e1296bc79021006a92032c76e59068b6 diff --git a/man/new_pair.3x b/man/new_pair.3x index 46c23b48..c2252388 100644 --- a/man/new_pair.3x +++ b/man/new_pair.3x @@ -1,5 +1,6 @@ .\"*************************************************************************** -.\" Copyright (c) 2017 Free Software Foundation, Inc. * +.\" Copyright 2018,2020 Thomas E. Dickey * +.\" Copyright 2017 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 * @@ -28,19 +29,20 @@ .\" .\" Author: Thomas E. Dickey .\" -.\" $Id: new_pair.3x,v 1.8 2017/03/09 09:59:11 tom Exp $ +.\" $Id: new_pair.3x,v 1.15 2020/10/17 23:54:50 tom Exp $ .TH new_pair 3X "" .ie \n(.g .ds `` \(lq .el .ds `` `` .ie \n(.g .ds '' \(rq .el .ds '' '' .de bP -.IP \(bu 4 +.ie n .IP \(bu 4 +.el .IP \(bu 2 .. .de NS -.ie \n(.sp +.ie n .sp .el .sp .5 -.ie \n(.in +4 +.ie n .in +4 .el .in +2 .nf .ft C \" Courier @@ -48,17 +50,21 @@ .de NE .fi .ft R -.in -4 +.ie n .in -4 +.el .in -2 .. .SH NAME \fBalloc_pair\fP, +\fBfind_pair\fP, \fBfree_pair\fP \- new curses color-pair functions .SH SYNOPSIS \fB#include \fP .sp -\fBint alloc_pair(int fg, int bg);\fP +\fBint alloc_pair(int \fP\fIfg\fP\fB, int \fP\fIbg\fP\fB);\fP .br -\fBint free_pair(int pair);\fP +\fBint find_pair(int \fP\fIfg\fP\fB, int \fP\fIbg\fP\fB);\fP +.br +\fBint free_pair(int \fP\fIpair\fP\fB);\fP .SH DESCRIPTION These functions are an extension to the curses library. They permit an application to dynamically allocate a color pair using @@ -87,7 +93,8 @@ as the limit on color pairs: \fBCOLORS\fP\fI * \fP\fBCOLORS\fP .NE .bP -Terminals which support \fIdefault colors\fP distinct from \*(``ANSI colors\*('' +Terminals which support \fIdefault colors\fP distinct +from \*(``ANSI colors\*('' add to the possible combinations, producing this total: .NS \fI( \fP\fBCOLORS\fP\fI + 1 ) * ( \fP\fBCOLORS\fP\fI + 1 )\fP @@ -110,9 +117,11 @@ The \fBalloc_pair\fP function accepts parameters for foreground and background color, and checks if that color combination is already associated with a color pair. .bP -If the combination already exists, \fBalloc_pair\fP returns the existing pair. +If the combination already exists, +\fBalloc_pair\fP returns the existing pair. .bP -If the combination does not exist, \fBalloc_pair\fP allocates a new color pair and returns that. +If the combination does not exist, +\fBalloc_pair\fP allocates a new color pair and returns that. .bP If the table fills up, \fBalloc_pair\fP discards the least-recently allocated entry using \fBfree_pair\fP and allocates a new color pair. @@ -136,7 +145,8 @@ i.e., like color pair 0. The \fBalloc_pair\fP function returns a color pair number in the range 1 through \fBCOLOR_PAIRS\fP\-1, unless it encounters an error updating its fast index to the color pair values, preventing it from allocating -a color pair. In that case, it returns \-1. +a color pair. +In that case, it returns \-1. .PP The \fBfind_pair\fP function returns a color pair number if the given color combination has been associated with a color pair, @@ -145,10 +155,12 @@ or \-1 if not. Likewise, \fBfree_pair\fP returns \fBOK\fP unless it encounters an error updating the fast index or if no such color pair is in use. .SH PORTABILITY -These routines are specific to ncurses. They were not supported on -Version 7, BSD or System V implementations. It is recommended that +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 them be conditioned using NCURSES_VERSION. .SH SEE ALSO -\fBinit_pair\fR(3X). +\fBcurs_color\fR(3X). .SH AUTHOR Thomas Dickey.