X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fresizeterm.3x;h=5f2bc9350ff72c869b4b8f8d78062a4c4176b5da;hp=be0756cee5f31b378c451104929f789fbb342194;hb=47d2fb4537d9ad5bb14f4810561a327930ca4280;hpb=2560bc3dae7f4919060c02c91a593566c908091c diff --git a/man/resizeterm.3x b/man/resizeterm.3x index be0756ce..5f2bc935 100644 --- a/man/resizeterm.3x +++ b/man/resizeterm.3x @@ -1,5 +1,6 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2015,2017 Free Software Foundation, Inc. * +.\" Copyright 2018-2019,2020 Thomas E. Dickey * +.\" Copyright 1998-2015,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,10 +29,11 @@ .\" .\" Author: Thomas E. Dickey 1996-on .\" -.\" $Id: resizeterm.3x,v 1.23 2017/05/30 21:08:21 tom Exp $ +.\" $Id: resizeterm.3x,v 1.27 2020/02/02 23:34:34 tom Exp $ .TH resizeterm 3X "" .de bP -.IP \(bu 4 +.ie n .IP \(bu 4 +.el .IP \(bu 2 .. .SH NAME \fBis_term_resized\fR, @@ -59,19 +61,31 @@ such as the \fBLINES\fP and \fBCOLS\fP variables. .SS resize_term .PP Most of the work is done by the inner function \fBresize_term\fR. -The outer function \fBresizeterm\fR adds bookkeeping for the \fBSIGWINCH\fP handler. +The outer function \fBresizeterm\fR adds bookkeeping +for the \fBSIGWINCH\fP handler, +as well as repainting the soft-key area (see \fBslk_touch\fP(3X)). +.PP When resizing the windows, \fBresize_term\fR blank-fills the areas that are extended. The calling application should fill in these areas with appropriate data. +.PP The \fBresize_term\fR function attempts to resize all windows. However, due to the calling convention of pads, it is not possible to resize these without additional interaction with the application. +.PP +When resizing windows, \fBresize_term\fR recursively adjusts subwindows, +keeping them within the updated parent window's limits. +If a top-level window happens to extend to the screen's limits, +then on resizing the window, \fBresize_term\fR will keep the window +extending to the corresponding limit, regardless of whether the +screen has shrunk or grown. .SS is_term_resized .PP A support function \fBis_term_resized\fR is provided so that applications can check if the \fBresize_term\fR function would modify the window structures. -It returns \fBTRUE\fP if the windows would be modified, and \fBFALSE\fP otherwise. +It returns \fBTRUE\fP if the windows would be modified, +and \fBFALSE\fP otherwise. .SH RETURN VALUE Except as noted, these functions return the integer \fBERR\fR upon failure and \fBOK\fR on success.