X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_opaque.3x;h=1d0cb55f2bb2e2b9f2469ce95fe493866c2f9870;hp=15e5c61a68e753fe157288f71d12fd1c8933cf04;hb=a6eb34d7fec8170a8715f9e53ca2f96452dd30dd;hpb=1051e5f924808ea27fcf8f5b624e63d07788b86e diff --git a/man/curs_opaque.3x b/man/curs_opaque.3x index 15e5c61a..1d0cb55f 100644 --- a/man/curs_opaque.3x +++ b/man/curs_opaque.3x @@ -1,5 +1,6 @@ .\"*************************************************************************** -.\" Copyright (c) 2007 Free Software Foundation, Inc. * +.\" Copyright 2020 Thomas E. Dickey * +.\" Copyright 2007-2014,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 * @@ -26,8 +27,12 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_opaque.3x,v 1.3 2007/05/12 17:04:47 tom Exp $ +.\" $Id: curs_opaque.3x,v 1.15 2020/10/24 09:41:22 tom Exp $ .TH curs_opaque 3X "" +.ie \n(.g .ds `` \(lq +.el .ds `` `` +.ie \n(.g .ds '' \(rq +.el .ds '' '' .na .hy 0 .SH NAME @@ -38,37 +43,52 @@ \fBis_keypad\fR, \fBis_leaveok\fR, \fBis_nodelay\fR, -\fBis_timeout\fR, +\fBis_notimeout\fR, +\fBis_pad\fR, \fBis_scrollok\fR, -\fBis_syncok\fR - \fBcurses\fR output options +\fBis_subwin\fR, +\fBis_syncok\fR, +\fBwgetdelay\fR, +\fBwgetparent\fR, +\fBwgetscrreg\fR \- \fBcurses\fR window properties .ad .hy .SH SYNOPSIS \fB#include \fR .sp -\fBbool is_cleared(WINDOW *win);\fR +\fBbool is_cleared(const WINDOW *\fP\fIwin\fP\fB);\fR .br -\fBbool is_idcok(WINDOW *win);\fR +\fBbool is_idcok(const WINDOW *\fP\fIwin\fP\fB);\fR .br -\fBbool is_idlok(WINDOW *win);\fR +\fBbool is_idlok(const WINDOW *\fP\fIwin\fP\fB);\fR .br -\fBbool is_immedok(WINDOW *win);\fR +\fBbool is_immedok(const WINDOW *\fP\fIwin\fP\fB);\fR .br -\fBbool is_keypad(WINDOW *win);\fR +\fBbool is_keypad(const WINDOW *\fP\fIwin\fP\fB);\fR .br -\fBbool is_leaveok(WINDOW *win);\fR +\fBbool is_leaveok(const WINDOW *\fP\fIwin\fP\fB);\fR .br -\fBbool is_nodelay(WINDOW *win);\fR +\fBbool is_nodelay(const WINDOW *\fP\fIwin\fP\fB);\fR .br -\fBbool is_notimeout(WINDOW *win);\fR +\fBbool is_notimeout(const WINDOW *\fP\fIwin\fP\fB);\fR .br -\fBbool is_scrollok(WINDOW *win);\fR +\fBbool is_pad(const WINDOW *\fP\fIwin\fP\fB);\fR .br -\fBbool is_syncok(WINDOW *win);\fR +\fBbool is_scrollok(const WINDOW *\fP\fIwin\fP\fB);\fR +.br +\fBbool is_subwin(const WINDOW *\fP\fIwin\fP\fB);\fR +.br +\fBbool is_syncok(const WINDOW *\fP\fIwin\fP\fB);\fR +.br +\fBWINDOW * wgetparent(const WINDOW *\fP\fIwin\fP\fB);\fR +.br +\fBint wgetdelay(const WINDOW *\fP\fIwin\fP\fB);\fR +.br +\fBint wgetscrreg(const WINDOW *\fP\fIwin\fP\fB, int *\fP\fItop\fP\fB, int *\fP\fIbottom\fP\fB);\fR .br .SH DESCRIPTION This implementation provides functions which return properties -set in the WINDOW structure, allowing it to be ``opaque'' if +set in the WINDOW structure, allowing it to be \*(``opaque\*('' if the symbol \fBNCURSES_OPAQUE\fR is defined: .TP 5 \fBis_cleared\fR @@ -95,13 +115,32 @@ returns the value set in \fBnodelay\fR \fBis_notimeout\fR returns the value set in \fBnotimeout\fR .TP 5 +\fBis_pad\fR +returns \fBTRUE\fP if the window is a pad +i.e., created by \fBnewpad\fP +.TP 5 \fBis_scrollok\fR returns the value set in \fBscrollok\fR .TP 5 +\fBis_subwin\fR +returns \fBTRUE\fP if the window is a subwindow, +i.e., created by \fBsubwin\fP or \fBderwin\fP +.TP 5 \fBis_syncok\fR returns the value set in \fBsyncok\fR +.TP 5 +\fBwgetdelay\fR +returns the delay timeout as set in \fBwtimeout\fP. +.TP 5 +\fBwgetparent\fR +returns the parent WINDOW pointer for subwindows, +or NULL for windows having no parent. +.TP 5 +\fBwgetscrreg\fR +returns the top and bottom rows for the scrolling margin +as set in \fBwsetscrreg\fP. .SH RETURN VALUE -These functions all return TRUE or FALSE. +These functions all return \fBTRUE\fP or \fBFALSE\fP, except as noted. .SH NOTES Both a macro and a function are provided for each name. .SH PORTABILITY @@ -114,9 +153,3 @@ be conditioned using NCURSES_VERSION. \fBcurs_inopts\fR(3X), \fBcurs_outopts\fR(3X), \fBcurs_window\fR(3X) -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: