summaryrefslogtreecommitdiff
path: root/tix/man/Utils.n
diff options
context:
space:
mode:
Diffstat (limited to 'tix/man/Utils.n')
-rw-r--r--tix/man/Utils.n82
1 files changed, 82 insertions, 0 deletions
diff --git a/tix/man/Utils.n b/tix/man/Utils.n
new file mode 100644
index 00000000000..0bffedcc74d
--- /dev/null
+++ b/tix/man/Utils.n
@@ -0,0 +1,82 @@
+'\"
+'\" Copyright (c) 1996, Expert Interface Technologies
+'\"
+'\" See the file "license.terms" for information on usage and redistribution
+'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
+'\"
+'\" The file man.macros and some of the macros used by this file are
+'\" copyrighted: (c) 1990 The Regents of the University of California.
+'\" (c) 1994-1995 Sun Microsystems, Inc.
+'\" The license terms of the Tcl/Tk distrobution are in the file
+'\" license.tcl.
+.so man.macros
+'----------------------------------------------------------------------
+.HS Utils tix 4.0
+.BS
+'
+'
+.SH NAME
+Utils - Utility commands in Tix 4.0.
+'
+'
+'
+.SH SYNOPSIS
+.TP
+\fBtixDescendants\fI \fIpathName\fR
+.TP
+\fBtixDisableAll \fIpathName\fR
+.TP
+\fBtixEnableAll \fIpathName\fR
+.TP
+\fBtixPushGrab\fR ?\fI-global\fR? \fIwindow\fR
+.TP
+\fBtixPopGrab\fR
+.BE
+.PP
+.SH DESCRIPTION
+.PP
+.TP
+\fBtixDescendants\fR \fIpathName\fR
+'
+Returns a list of all the descendant widgets of \fIpathName\fR plus
+\fIpathName\fR itself.
+'
+.TP
+\fBtixDisableAll\fR \fIpathName\fR
+'
+Disables \fIpathName\fR and all its descendants.
+'
+'
+.TP
+\fBtixEnableAll\fR \fIpathName\fR
+'
+Enables \fIpathName\fR and all its descendants.
+'
+'
+.TP
+\fBtixPushGrab\fR ?\fI-global\fR? \fIwindow\fR
+'
+The \fBtixPushGrab\fR and \fBtixPopGrab\fR commands allows you to
+perform "cascade-grabbing". \fBtixPushGrab\fR calls the \fBgrab(n)\fR
+command on \fIwindow\fR and saves \fIwindow\fR on a grabbing
+stack.
+'
+.TP
+\fBtixPopGrab\fR
+'
+\fBtixPopGrab\fR pops the top-most element from the grabbing stack and
+release its grab. If the grabbing stack is not empty, then
+\fBtixPopGrab\fR will execute grab(n) on the current top-most element
+in the grabbing stack.
+'
+.SH NOTES
+.PP
+Some Tix widgets (for example, tixComboBox and tixPanedWindow) grabs
+the screen on certain occasions using \fBtixPushGrab\fR and
+\fBtixPopGrab\fR. Therefore, if you need to grab the screen when these
+widgets are present, you should also call \fBtixPushGrab\fR and
+\fBtixPopGrab\fR in place of the Tk \fBgrab\fR and \fBgrab release\fR
+commands. Otherwise, the behavior of these widgets may be undefined.
+'
+.SH KEYWORDS
+Tix(n),grab(n)