I686LINUX/util/I686LINUX/man/mann/label.n

   1 '\"
   2 '\" Copyright (c) 1990-1994 The Regents of the University of California.
   3 '\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
   4 '\"
   5 '\" See the file "license.terms" for information on usage and redistribution
   6 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
   7 '\"
   8 '\" RCS: @(#) $Id: label.n,v 1.6 2002/12/18 21:46:48 tmh Exp $
   9 '\"
  10 '\" The definitions below are for supplemental macros used in Tcl/Tk
  11 '\" manual entries.
  12 '\"
  13 '\" .AP type name in/out ?indent?
  14 '\"     Start paragraph describing an argument to a library procedure.
  15 '\"     type is type of argument (int, etc.), in/out is either "in", "out",
  16 '\"     or "in/out" to describe whether procedure reads or modifies arg,
  17 '\"     and indent is equivalent to second arg of .IP (shouldn't ever be
  18 '\"     needed;  use .AS below instead)
  19 '\"
  20 '\" .AS ?type? ?name?
  21 '\"     Give maximum sizes of arguments for setting tab stops.  Type and
  22 '\"     name are examples of largest possible arguments that will be passed
  23 '\"     to .AP later.  If args are omitted, default tab stops are used.
  24 '\"
  25 '\" .BS
  26 '\"     Start box enclosure.  From here until next .BE, everything will be
  27 '\"     enclosed in one large box.
  28 '\"
  29 '\" .BE
  30 '\"     End of box enclosure.
  31 '\"
  32 '\" .CS
  33 '\"     Begin code excerpt.
  34 '\"
  35 '\" .CE
  36 '\"     End code excerpt.
  37 '\"
  38 '\" .VS ?version? ?br?
  39 '\"     Begin vertical sidebar, for use in marking newly-changed parts
  40 '\"     of man pages.  The first argument is ignored and used for recording
  41 '\"     the version when the .VS was added, so that the sidebars can be
  42 '\"     found and removed when they reach a certain age.  If another argument
  43 '\"     is present, then a line break is forced before starting the sidebar.
  44 '\"
  45 '\" .VE
  46 '\"     End of vertical sidebar.
  47 '\"
  48 '\" .DS
  49 '\"     Begin an indented unfilled display.
  50 '\"
  51 '\" .DE
  52 '\"     End of indented unfilled display.
  53 '\"
  54 '\" .SO
  55 '\"     Start of list of standard options for a Tk widget.  The
  56 '\"     options follow on successive lines, in four columns separated
  57 '\"     by tabs.
  58 '\"
  59 '\" .SE
  60 '\"     End of list of standard options for a Tk widget.
  61 '\"
  62 '\" .OP cmdName dbName dbClass
  63 '\"     Start of description of a specific option.  cmdName gives the
  64 '\"     option's name as specified in the class command, dbName gives
  65 '\"     the option's name in the option database, and dbClass gives
  66 '\"     the option's class in the option database.
  67 '\"
  68 '\" .UL arg1 arg2
  69 '\"     Print arg1 underlined, then print arg2 normally.
  70 '\"
  71 '\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $
  72 '\"
  73 '\"     # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
  74 .if t .wh -1.3i ^B
  75 .nr ^l \n(.l
  76 .ad b
  77 '\"     # Start an argument description
  78 .de AP
  79 .ie !"\\$4"" .TP \\$4
  80 .el \{\
  81 .   ie !"\\$2"" .TP \\n()Cu
  82 .   el          .TP 15
  83 .\}
  84 .ta \\n()Au \\n()Bu
  85 .ie !"\\$3"" \{\
  86 \&\\$1  \\fI\\$2\\fP    (\\$3)
  87 .\".b
  88 .\}
  89 .el \{\
  90 .br
  91 .ie !"\\$2"" \{\
  92 \&\\$1  \\fI\\$2\\fP
  93 .\}
  94 .el \{\
  95 \&\\fI\\$1\\fP
  96 .\}
  97 .\}
  98 ..
  99 '\"     # define tabbing values for .AP
 100 .de AS
 101 .nr )A 10n
 102 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
 103 .nr )B \\n()Au+15n
 104 .\"
 105 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
 106 .nr )C \\n()Bu+\\w'(in/out)'u+2n
 107 ..
 108 .AS Tcl_Interp Tcl_CreateInterp in/out
 109 '\"     # BS - start boxed text
 110 '\"     # ^y = starting y location
 111 '\"     # ^b = 1
 112 .de BS
 113 .br
 114 .mk ^y
 115 .nr ^b 1u
 116 .if n .nf
 117 .if n .ti 0
 118 .if n \l'\\n(.lu\(ul'
 119 .if n .fi
 120 ..
 121 '\"     # BE - end boxed text (draw box now)
 122 .de BE
 123 .nf
 124 .ti 0
 125 .mk ^t
 126 .ie n \l'\\n(^lu\(ul'
 127 .el \{\
 128 .\"     Draw four-sided box normally, but don't draw top of
 129 .\"     box if the box started on an earlier page.
 130 .ie !\\n(^b-1 \{\
 131 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 132 .\}
 133 .el \}\
 134 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 135 .\}
 136 .\}
 137 .fi
 138 .br
 139 .nr ^b 0
 140 ..
 141 '\"     # VS - start vertical sidebar
 142 '\"     # ^Y = starting y location
 143 '\"     # ^v = 1 (for troff;  for nroff this doesn't matter)
 144 .de VS
 145 .if !"\\$2"" .br
 146 .mk ^Y
 147 .ie n 'mc \s12\(br\s0
 148 .el .nr ^v 1u
 149 ..
 150 '\"     # VE - end of vertical sidebar
 151 .de VE
 152 .ie n 'mc
 153 .el \{\
 154 .ev 2
 155 .nf
 156 .ti 0
 157 .mk ^t
 158 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
 159 .sp -1
 160 .fi
 161 .ev
 162 .\}
 163 .nr ^v 0
 164 ..
 165 '\"     # Special macro to handle page bottom:  finish off current
 166 '\"     # box/sidebar if in box/sidebar mode, then invoked standard
 167 '\"     # page bottom macro.
 168 .de ^B
 169 .ev 2
 170 'ti 0
 171 'nf
 172 .mk ^t
 173 .if \\n(^b \{\
 174 .\"     Draw three-sided box if this is the box's first page,
 175 .\"     draw two sides but no top otherwise.
 176 .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 177 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 178 .\}
 179 .if \\n(^v \{\
 180 .nr ^x \\n(^tu+1v-\\n(^Yu
 181 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
 182 .\}
 183 .bp
 184 'fi
 185 .ev
 186 .if \\n(^b \{\
 187 .mk ^y
 188 .nr ^b 2
 189 .\}
 190 .if \\n(^v \{\
 191 .mk ^Y
 192 .\}
 193 ..
 194 '\"     # DS - begin display
 195 .de DS
 196 .RS
 197 .nf
 198 .sp
 199 ..
 200 '\"     # DE - end display
 201 .de DE
 202 .fi
 203 .RE
 204 .sp
 205 ..
 206 '\"     # SO - start of list of standard options
 207 .de SO
 208 .SH "STANDARD OPTIONS"
 209 .LP
 210 .nf
 211 .ta 5.5c 11c
 212 .ft B
 213 ..
 214 '\"     # SE - end of list of standard options
 215 .de SE
 216 .fi
 217 .ft R
 218 .LP
 219 See the \\fBoptions\\fR manual entry for details on the standard options.
 220 ..
 221 '\"     # OP - start of full description for a single option
 222 .de OP
 223 .LP
 224 .nf
 225 .ta 4c
 226 Command-Line Name:      \\fB\\$1\\fR
 227 Database Name:  \\fB\\$2\\fR
 228 Database Class: \\fB\\$3\\fR
 229 .fi
 230 .IP
 231 ..
 232 '\"     # CS - begin code excerpt
 233 .de CS
 234 .RS
 235 .nf
 236 .ta .25i .5i .75i 1i
 237 ..
 238 '\"     # CE - end code excerpt
 239 .de CE
 240 .fi
 241 .RE
 242 ..
 243 .de UL
 244 \\$1\l'|0\(ul'\\$2
 245 ..
 246 .TH label n 4.0 Tk "Tk Built-In Commands"
 247 .BS
 248 '\" Note:  do not modify the .SH NAME line immediately below!
 249 .SH NAME
 250 label \- Create and manipulate label widgets
 251 .SH SYNOPSIS
 252 \fBlabel\fR \fIpathName \fR?\fIoptions\fR?
 253 .SO
 254 \-activebackground      \-font  \-pady
 255 \-activeforeground      \-foreground    \-relief
 256 \-anchor        \-highlightbackground   \-takefocus
 257 \-background    \-highlightcolor        \-text
 258 \-bitmap        \-highlightthickness    \-textvariable
 259 \-borderwidth   \-image \-underline
 260 \-cursor        \-justify       \-wraplength
 261 \-disabledforeground    \-padx
 262 .SE
 263 .SH "WIDGET-SPECIFIC OPTIONS"
 264 .OP \-compound compound Compound
 265 Specifies whether the label should display both an image and text,
 266 and if so, where the image should be placed relative to the text.
 267 Valid values for this option are \fBbottom\fR, \fBcenter\fR,
 268 \fBleft\fR, \fBnone\fR, \fBright\fR and \fBtop\fR.  The default value
 269 is \fBnone\fR, meaning that the label will display either an image or
 270 text, depending on the values of the \fB\-image\fR and \fB\-bitmap\fR
 271 options.
 272 .OP \-height height Height
 273 Specifies a desired height for the label.
 274 If an image or bitmap is being displayed in the label then the value is in
 275 screen units (i.e. any of the forms acceptable to \fBTk_GetPixels\fR);
 276 for text it is in lines of text.
 277 If this option isn't specified, the label's desired height is computed
 278 from the size of the image or bitmap or text being displayed in it.
 279 .OP \-state state State
 280 Specifies one of three states for the label:  \fBnormal\fR, \fBactive\fR,
 281 or \fBdisabled\fR.  In normal state the button is displayed using the
 282 \fBforeground\fR and \fBbackground\fR options.  In active state
 283 the label is displayed using the \fBactiveForeground\fR and
 284 \fBactiveBackground\fR options.  In the disabled state the
 285 \fBdisabledForeground\fR and \fBbackground\fR options determine how
 286 the button is displayed.
 287 .OP \-width width Width
 288 Specifies a desired width for the label.
 289 If an image or bitmap is being displayed in the label then the value is in
 290 screen units (i.e. any of the forms acceptable to \fBTk_GetPixels\fR);
 291 for text it is in characters.
 292 If this option isn't specified, the label's desired width is computed
 293 from the size of the image or bitmap or text being displayed in it.
 294 .BE
 295
 296 .SH DESCRIPTION
 297 .PP
 298 The \fBlabel\fR command creates a new window (given by the
 299 \fIpathName\fR argument) and makes it into a label widget.
 300 Additional
 301 options, described above, may be specified on the command line
 302 or in the option database
 303 to configure aspects of the label such as its colors, font,
 304 text, and initial relief.  The \fBlabel\fR command returns its
 305 \fIpathName\fR argument.  At the time this command is invoked,
 306 there must not exist a window named \fIpathName\fR, but
 307 \fIpathName\fR's parent must exist.
 308 .PP
 309 A label is a widget that displays a textual string, bitmap or image.
 310 If text is displayed, it must all be in a single font, but it
 311 can occupy multiple lines on the screen (if it contains newlines
 312 or if wrapping occurs because of the \fBwrapLength\fR option) and
 313 one of the characters may optionally be underlined using the
 314 \fBunderline\fR option.
 315 The label can be manipulated in a few simple ways, such as
 316 changing its relief or text, using the commands described below.
 317
 318 .SH "WIDGET COMMAND"
 319 .PP
 320 The \fBlabel\fR command creates a new Tcl command whose
 321 name is \fIpathName\fR.  This
 322 command may be used to invoke various
 323 operations on the widget.  It has the following general form:
 324 .CS
 325 \fIpathName option \fR?\fIarg arg ...\fR?
 326 .CE
 327 \fIOption\fR and the \fIarg\fRs
 328 determine the exact behavior of the command.  The following
 329 commands are possible for label widgets:
 330 .TP
 331 \fIpathName \fBcget\fR \fIoption\fR
 332 Returns the current value of the configuration option given
 333 by \fIoption\fR.
 334 \fIOption\fR may have any of the values accepted by the \fBlabel\fR
 335 command.
 336 .TP
 337 \fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR?
 338 Query or modify the configuration options of the widget.
 339 If no \fIoption\fR is specified, returns a list describing all of
 340 the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
 341 information on the format of this list).  If \fIoption\fR is specified
 342 with no \fIvalue\fR, then the command returns a list describing the
 343 one named option (this list will be identical to the corresponding
 344 sublist of the value returned if no \fIoption\fR is specified).  If
 345 one or more \fIoption\-value\fR pairs are specified, then the command
 346 modifies the given widget option(s) to have the given value(s);  in
 347 this case the command returns an empty string.
 348 \fIOption\fR may have any of the values accepted by the \fBlabel\fR
 349 command.
 350
 351 .SH BINDINGS
 352 .PP
 353 When a new label is created, it has no default event bindings:
 354 labels are not intended to be interactive.
 355
 356 .SH KEYWORDS
 357 label, widget