home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Source Code 1993 July / THE_SOURCE_CODE_CD_ROM.iso / languages / tcl / tk3.3b1 / doc / GeomReq.3 < prev    next >
Encoding:
Text File  |  1993-04-01  |  3.5 KB  |  83 lines
  1. '\"
  2. '\" Copyright (c) 1990, 1991 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. '\" 
  22. '\" $Header: /user6/ouster/wish/man/RCS/GeomReq.3,v 1.7 93/04/01 09:41:21 ouster Exp $ SPRITE (Berkeley)
  23. '\" 
  24. .so man.macros
  25. .HS Tk_GeometryRequest tkc
  26. .BS
  27. .SH NAME
  28. Tk_GeometryRequest, Tk_SetInternalBorder \- specify desired geometry or internal border for a window
  29. .SH SYNOPSIS
  30. .nf
  31. \fB#include <tk.h>\fR
  32. .sp
  33. \fBTk_GeometryRequest\fR(\fItkwin, reqWidth, reqHeight\fR)
  34. .sp
  35. \fBTk_SetInternalBorder\fR(\fItkwin, width\fR)
  36. .SH ARGUMENTS
  37. .AS baseHeight clientData
  38. .AP Tk_Window tkwin in
  39. Window for which geometry is being requested.
  40. .AP int reqWidth in
  41. Desired width for \fItkwin\fR, in pixel units.
  42. .AP int reqHeight in
  43. Desired height for \fItkwin\fR, in pixel units.
  44. .AP int width in
  45. Space to leave for internal border for \fItkwin\fR, in pixel units.
  46. .BE
  47.  
  48. .SH DESCRIPTION
  49. .PP
  50. \fBTk_GeometryRequest\fR is called by widget code to indicate its
  51. preference for the dimensions of a particular window.  The arguments
  52. to \fBTk_GeometryRequest\fR are made available to the geometry
  53. manager for the window, which then decides on the actual geometry
  54. for the window.  Although geometry managers generally try to satisfy
  55. requests made to \fBTk_GeometryRequest\fR, there is no guarantee that
  56. this will always be possible.  Widget code should not assume that
  57. a geometry request will be satisfied until it receives a
  58. \fBConfigureNotify\fR event indicating that the geometry change has
  59. occurred.  Widget code should never call procedures like
  60. \fBTk_ResizeWindow\fR directly.  Instead, it should invoke
  61. \fBTk_GeometryRequest\fR and leave the final geometry decisions to
  62. the geometry manager.
  63. .PP
  64. If \fItkwin\fR is a top-level window, then the geometry information
  65. will be passed to the window manager using the standard ICCCM protocol.
  66. .PP
  67. \fBTk_SetInternalBorder\fR is called by widget code to indicate that
  68. the widget has an internal border.  This means that the widget draws
  69. a decorative border inside the window instead of using the standard
  70. X borders, which are external to the window's area.  For example,
  71. internal borders are used to draw 3-D effects.  \fIWidth\fR
  72. specifies the width of the border in pixels.  Geometry managers will
  73. use this information to avoid placing any children of \fItkwin\fR
  74. overlapping the outermost \fIwidth\fR pixels of \fItkwin\fR's area.
  75. .PP
  76. The information specified in calls to \fBTk_GeometryRequest\fR and
  77. \fBTk_SetInternalBorder\fR can be retrieved using the macros
  78. \fBTk_ReqWidth\fR, \fBTk_ReqHeight\fR, and \fBTk_InternalBorderWidth\fR.
  79. See the \fBTk_WindowId\fR manual entry for details.
  80.  
  81. .SH KEYWORDS
  82. geometry, request
  83.