X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_opaque.3x;h=1596bfff4405be1efc66a80b18758d32f9eac8fb;hp=ac538123b7174f9f9b7f9d62ab7429d78dff7526;hb=321b81e6b3fa425daddac02420d862100dc3aac8;hpb=efd59f16f336b4c4c698ff783e1723f3161026ef diff --git a/man/curs_opaque.3x b/man/curs_opaque.3x index ac538123..1596bfff 100644 --- a/man/curs_opaque.3x +++ b/man/curs_opaque.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 2007 Free Software Foundation, Inc. * +.\" Copyright (c) 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 +26,12 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_opaque.3x,v 1.2 2007/04/14 20:19:39 tom Exp $ +.\" $Id: curs_opaque.3x,v 1.13 2015/12/05 20:05:45 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 +42,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 *win);\fR .br -\fBbool is_idcok(WINDOW *win);\fR +\fBbool is_idcok(const WINDOW *win);\fR .br -\fBbool is_idlok(WINDOW *win);\fR +\fBbool is_idlok(const WINDOW *win);\fR .br -\fBbool is_immedok(WINDOW *win);\fR +\fBbool is_immedok(const WINDOW *win);\fR .br -\fBbool is_keypad(WINDOW *win);\fR +\fBbool is_keypad(const WINDOW *win);\fR .br -\fBbool is_leaveok(WINDOW *win);\fR +\fBbool is_leaveok(const WINDOW *win);\fR .br -\fBbool is_nodelay(WINDOW *win);\fR +\fBbool is_nodelay(const WINDOW *win);\fR .br -\fBbool is_notimeout(WINDOW *win);\fR +\fBbool is_notimeout(const WINDOW *win);\fR .br -\fBbool is_scrollok(WINDOW *win);\fR +\fBbool is_pad(const WINDOW *win);\fR .br -\fBbool is_syncok(WINDOW *win);\fR +\fBbool is_scrollok(const WINDOW *win);\fR +.br +\fBbool is_subwin(const WINDOW *win);\fR +.br +\fBbool is_syncok(const WINDOW *win);\fR +.br +\fBWINDOW * wgetparent(const WINDOW *win);\fR +.br +\fBint wgetdelay(const WINDOW *win);\fR +.br +\fBint wgetscrreg(const WINDOW *win, int *top, int *bottom);\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,14 +114,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 -.RE +.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 @@ -115,9 +152,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: