home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Source Code 1993 July / THE_SOURCE_CODE_CD_ROM.iso / languages / tcl / tk3.3b1 / doc / frame.n < prev    next >
Encoding:
Text File  |  1993-04-01  |  5.2 KB  |  140 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. '\"
  22. '\" $Header: /user6/ouster/wish/man/RCS/frame.n,v 1.9 93/04/01 09:52:40 ouster Exp $ SPRITE (Berkeley)
  23. '/" 
  24. .so man.macros
  25. .HS frame tk
  26. .BS
  27. '\" Note:  do not modify the .SH NAME line immediately below!
  28. .SH NAME
  29. frame \- Create and manipulate frame widgets
  30. .SH SYNOPSIS
  31. \fBframe\fI \fIpathName \fR?\fB\-class \fIclassName\fR? ?\fIoptions\fR?
  32. .SH "STANDARD OPTIONS"
  33. .LP
  34. .nf
  35. .ta 4c 8c 12c
  36. .VS
  37. \fBbackground\fR    \fBcursor\fR    \fBrelief\fR
  38. .VE
  39. \fBborderWidth\fR    \fBgeometry\fR
  40. .fi
  41. .LP
  42. See the ``options'' manual entry for details on the standard options.
  43. .SH "WIDGET-SPECIFIC OPTIONS"
  44. .LP
  45. .nf
  46. .VS
  47. Name:    \fBheight\fR
  48. Class:    \fBHeight\fR
  49. Command-Line Switch:    \fB\-height\fR
  50. .fi
  51. .IP
  52. Specifies the desired height for the window in any of the forms
  53. acceptable to \fBTk_GetPixels\fR.
  54. This option is only used if the \fB\-geometry\fR option is
  55. unspecified.
  56. If this option is less than or equal to zero (and \fB\-geometry\fR
  57. is not specified) then the window will not request any size at
  58. all.
  59. .LP
  60. .nf
  61. Name:    \fBwidth\fR
  62. Class:    \fBWidth\fR
  63. Command-Line Switch:    \fB\-width\fR
  64. .fi
  65. .IP
  66. Specifies the desired width for the window in any of the forms
  67. acceptable to \fBTk_GetPixels\fR.
  68. This option is only used if the \fB\-geometry\fR option is
  69. unspecified.
  70. If this option is less than or equal to zero (and \fB\-geometry\fR
  71. is not specified) then the window will not request any size at
  72. all.
  73. .VE
  74. .BE
  75.  
  76. .SH DESCRIPTION
  77. .PP
  78. The \fBframe\fR command creates a new window (given by the
  79. \fIpathName\fR argument) and makes it into a frame widget.
  80. Additional
  81. options, described above, may be specified on the command line
  82. or in the option database
  83. to configure aspects of the frame such as its background color
  84. and relief.  The \fBframe\fR command returns the
  85. path name of the new window.
  86. .PP
  87. A frame is a simple widget.  Its primary purpose is to act as a
  88. spacer or container for complex window layouts.  The only features
  89. of a frame are its background color and an optional 3-D border to make the
  90. frame appear raised or sunken.
  91. .PP
  92. In addition to the standard options listed above, a \fB\-class\fR
  93. option may be specified on the command line.  If it is specified, then
  94. the new widget's class will be set to \fIclassName\fR instead of
  95. \fBFrame\fR.  Changing the class of a frame widget may be useful
  96. in order to use a special class name in database options referring
  97. to this widget and its children.  Note:  \fB\-class\fR is handled
  98. differently than other command-line options and cannot be specified
  99. using the option database (it has to be processed
  100. before the other options are even looked up, since the new class
  101. name will affect the lookup of the other options).  In addition,
  102. the \fB\-class\fR option may not be queried or changed using the
  103. \fBconfig\fR command described below.
  104.  
  105. .SH "WIDGET COMMAND"
  106. .PP
  107. The \fBframe\fR command creates a new Tcl command whose
  108. name is the same as the path name of the frame's window.  This
  109. command may be used to invoke various
  110. operations on the widget.  It has the following general form:
  111. .DS C
  112. \fIpathName option \fR?\fIarg arg ...\fR?
  113. .DE
  114. \fIPathName\fR is the name of the command, which is the same as
  115. the frame widget's path name.  \fIOption\fR and the \fIarg\fRs
  116. determine the exact behavior of the command.  The following
  117. commands are possible for frame widgets:
  118. .TP
  119. \fIpathName \fBconfigure\fR ?\fIoption\fR? \fI?value option value ...\fR?
  120. Query or modify the configuration options of the widget.
  121. If no \fIoption\fR is specified, returns a list describing all of
  122. the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
  123. information on the format of this list).  If \fIoption\fR is specified
  124. with no \fIvalue\fR, then the command returns a list describing the
  125. one named option (this list will be identical to the corresponding
  126. sublist of the value returned if no \fIoption\fR is specified).  If
  127. one or more \fIoption\-value\fR pairs are specified, then the command
  128. modifies the given widget option(s) to have the given value(s);  in
  129. this case the command returns an empty string.
  130. \fIOption\fR may have any of the values accepted by the \fBframe\fR
  131. command.
  132.  
  133. .SH BINDINGS
  134. .PP
  135. When a new frame is created, it has no default event bindings:
  136. frames are not intended to be interactive.
  137.  
  138. .SH KEYWORDS
  139. frame, widget
  140.