home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Source Code 1993 July / THE_SOURCE_CODE_CD_ROM.iso / languages / tcl / tk3.3b1 / doc / Restack.3 < prev    next >
Encoding:
Text File  |  1993-07-07  |  2.4 KB  |  63 lines
  1. '\"
  2. '\" Copyright (c) 1990 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/wish/man/RCS/Restack.3,v 1.1 93/07/07 11:11:05 ouster Exp $ SPRITE (Berkeley)
  22. '\" 
  23. .so man.macros
  24. .HS Tk_RestackWindow tkc
  25. .BS
  26. .SH NAME
  27. Tk_RestackWindow \- Change a window's position in the stacking order
  28. .SH SYNOPSIS
  29. .nf
  30. \fB#include <tk.h>\fR
  31. .sp
  32. int
  33. \fBTk_RestackWindow\fR(\fItkwin, aboveBelow, other\fR)
  34. .SH ARGUMENTS
  35. .AS Tk_Window aboveBelow
  36. .AP Tk_Window tkwin in
  37. Token for window to restack.
  38. .AP int aboveBelow in
  39. Indicates new position of \fItkwin\fR relative to \fIother\fR;
  40. must be \fBAbove\fR or \fBBelow\fR.
  41. .AP Tk_Window other in
  42. \fITkwin\fR will be repositioned just above or below this window.
  43. Must be a sibling of \fItkwin\fR or a descendant of a sibling.
  44. If NULL then \fItkwin\fR is restacked above or below all siblings.
  45. .BE
  46.  
  47. .SH DESCRIPTION
  48. .PP
  49. \fBTk_RestackWindow\fR changes the stacking order of \fIwindow\fR relative
  50. to its siblings.
  51. If \fIother\fR is specified as NULL then \fIwindow\fR is repositioned
  52. at the top or bottom of its stacking order, depending on whether
  53. \fIaboveBelow\fR is \fBAbove\fR or \fBBelow\fR.
  54. If \fIother\fR has a non-NULL value then \fIwindow\fR is repositioned
  55. just above or below \fIother\fR.
  56. .PP
  57. The \fIaboveBelow\fR argument must have one of the symbolic values
  58. \fBAbove\fR or \fBBelow\fR.
  59. Both of these values are defined by the include file <X11/Xlib.h>.
  60.  
  61. .SH KEYWORDS
  62. above, below, obscure, stacking order
  63.