doc/frame.n

   1 '\"
   2 '\" Copyright (c) 1990-1994 The Regents of the University of California.
   3 '\" Copyright (c) 1994-1995 Sun Microsystems, Inc.
   4 '\" Copyright (c) 1996-1999 Christian Werner
   5 '\"
   6 '\" See the file "license.terms" for information on usage and redistribution
   7 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
   8 '\"
   9 .so man.macros
  10 .TH frame n 8.0 Ck "Ck Built-In Commands"
  11 .BS
  12 '\" Note:  do not modify the .SH NAME line immediately below!
  13 .SH NAME
  14 frame \- Create and manipulate frame widgets
  15 .SH SYNOPSIS
  16 \fBframe\fI \fIpathName ?\fIoptions\fR?
  17 .SH "STANDARD OPTIONS"
  18 .LP
  19 .nf
  20 .ta 4c 8c 12c
  21 \fBattributes\fR        \fBborder\fR    \fBforeground\fR        \fBtakefocus\fR
  22 \fBbackground\fR
  23 .fi
  24 .LP
  25 See the ``options'' manual entry for details on the standard options.
  26 .SH "WIDGET-SPECIFIC OPTIONS"
  27 .ta 4c
  28 .LP
  29 .nf
  30 Name:   \fBclass\fR
  31 Class:  \fBClass\fR
  32 Command-Line Switch:    \fB\-class\fR
  33 .fi
  34 .IP
  35 Specifies a class for the window.
  36 This class will be used when querying the option database for
  37 the window's other options, and it will also be used later for
  38 other purposes such as bindings.
  39 The \fBclass\fR option may not be changed with the \fBconfigure\fR
  40 widget command.
  41 .LP
  42 .nf
  43 Name:   \fBheight\fR
  44 Class:  \fBHeight\fR
  45 Command-Line Switch:    \fB\-height\fR
  46 .fi
  47 .IP
  48 Specifies the desired height for the window in screen lines.
  49 If this option is equal to zero then the window will
  50 not request any size at all.
  51 .LP
  52 .nf
  53 Name:   \fBwidth\fR
  54 Class:  \fBWidth\fR
  55 Command-Line Switch:    \fB\-width\fR
  56 .fi
  57 .IP
  58 Specifies the desired width for the window in screen columns.
  59 If this option is equal to zero then the window will
  60 not request any size at all.
  61 .BE
  62
  63 .SH DESCRIPTION
  64 .PP
  65 The \fBframe\fR command creates a new window (given by the
  66 \fIpathName\fR argument) and makes it into a frame widget.
  67 Additional
  68 options, described above, may be specified on the command line
  69 or in the option database
  70 to configure aspects of the frame such as its background color
  71 and attributes.  The \fBframe\fR command returns the
  72 path name of the new window.
  73 .PP
  74 A frame is a simple widget.  Its primary purpose is to act as a
  75 spacer or container for complex window layouts.  The only features
  76 of a frame are its background color, attributes and border.
  77
  78 .SH "WIDGET COMMAND"
  79 .PP
  80 The \fBframe\fR command creates a new Tcl command whose
  81 name is the same as the path name of the frame's window.  This
  82 command may be used to invoke various
  83 operations on the widget.  It has the following general form:
  84 .DS C
  85 \fIpathName option \fR?\fIarg arg ...\fR?
  86 .DE
  87 \fIPathName\fR is the name of the command, which is the same as
  88 the frame widget's path name.  \fIOption\fR and the \fIarg\fRs
  89 determine the exact behavior of the command.  The following
  90 commands are possible for frame widgets:
  91 .TP
  92 \fIpathName \fBcget\fR \fIoption\fR
  93 Returns the current value of the configuration option given
  94 by \fIoption\fR.
  95 \fIOption\fR may have any of the values accepted by the \fBframe\fR
  96 command.
  97 .TP
  98 \fIpathName \fBconfigure\fR ?\fIoption\fR? \fI?value option value ...\fR?
  99 Query or modify the configuration options of the widget.
 100 If no \fIoption\fR is specified, returns a list describing all of
 101 the available options for \fIpathName\fR. If \fIoption\fR is specified
 102 with no \fIvalue\fR, then the command returns a list describing the
 103 one named option (this list will be identical to the corresponding
 104 sublist of the value returned if no \fIoption\fR is specified).  If
 105 one or more \fIoption\-value\fR pairs are specified, then the command
 106 modifies the given widget option(s) to have the given value(s);  in
 107 this case the command returns an empty string.
 108 \fIOption\fR may have any of the values accepted by the \fBframe\fR
 109 command.
 110
 111 .SH BINDINGS
 112 .PP
 113 When a new frame is created, it has no default event bindings:
 114 frames are not intended to be interactive.
 115
 116 .SH KEYWORDS
 117 frame, widget