2 '\" Copyright (c) 1990-1994 The Regents of the University of California.
3 '\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
5 '\" See the file "license.terms" for information on usage and redistribution
6 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
8 .TH options n 4.4 Tk "Tk Built-In Commands"
9 .\" The -*- nroff -*- definitions below are for supplemental macros used
10 .\" in Tcl/Tk manual entries.
12 .\" .AP type name in/out ?indent?
13 .\" Start paragraph describing an argument to a library procedure.
14 .\" type is type of argument (int, etc.), in/out is either "in", "out",
15 .\" or "in/out" to describe whether procedure reads or modifies arg,
16 .\" and indent is equivalent to second arg of .IP (shouldn't ever be
17 .\" needed; use .AS below instead)
20 .\" Give maximum sizes of arguments for setting tab stops. Type and
21 .\" name are examples of largest possible arguments that will be passed
22 .\" to .AP later. If args are omitted, default tab stops are used.
25 .\" Start box enclosure. From here until next .BE, everything will be
26 .\" enclosed in one large box.
29 .\" End of box enclosure.
32 .\" Begin code excerpt.
37 .\" .VS ?version? ?br?
38 .\" Begin vertical sidebar, for use in marking newly-changed parts
39 .\" of man pages. The first argument is ignored and used for recording
40 .\" the version when the .VS was added, so that the sidebars can be
41 .\" found and removed when they reach a certain age. If another argument
42 .\" is present, then a line break is forced before starting the sidebar.
45 .\" End of vertical sidebar.
48 .\" Begin an indented unfilled display.
51 .\" End of indented unfilled display.
54 .\" Start of list of standard options for a Tk widget. The manpage
55 .\" argument defines where to look up the standard options; if
56 .\" omitted, defaults to "options". The options follow on successive
57 .\" lines, in three columns separated by tabs.
60 .\" End of list of standard options for a Tk widget.
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.
69 .\" Print arg1 underlined, then print arg2 normally.
72 .\" Print arg1 in quotes, then arg2 normally (for trailing punctuation).
75 .\" Print an open parenthesis, arg1 in quotes, then arg2 normally
76 .\" (for trailing punctuation) and then a closing parenthesis.
78 .\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
82 .\" # Start an argument description
86 . ie !"\\$2"" .TP \\n()Cu
91 \&\\$1 \\fI\\$2\\fP (\\$3)
104 .\" # define tabbing values for .AP
107 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
110 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
111 .nr )C \\n()Bu+\\w'(in/out)'u+2n
113 .AS Tcl_Interp Tcl_CreateInterp in/out
114 .\" # BS - start boxed text
115 .\" # ^y = starting y location
123 .if n \l'\\n(.lu\(ul'
126 .\" # BE - end boxed text (draw box now)
131 .ie n \l'\\n(^lu\(ul'
133 .\" Draw four-sided box normally, but don't draw top of
134 .\" box if the box started on an earlier page.
136 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
139 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
146 .\" # VS - start vertical sidebar
147 .\" # ^Y = starting y location
148 .\" # ^v = 1 (for troff; for nroff this doesn't matter)
152 .ie n 'mc \s12\(br\s0
155 .\" # VE - end of vertical sidebar
163 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
170 .\" # Special macro to handle page bottom: finish off current
171 .\" # box/sidebar if in box/sidebar mode, then invoked standard
172 .\" # page bottom macro.
179 .\" Draw three-sided box if this is the box's first page,
180 .\" draw two sides but no top otherwise.
181 .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
182 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
185 .nr ^x \\n(^tu+1v-\\n(^Yu
186 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
199 .\" # DS - begin display
205 .\" # DE - end display
211 .\" # SO - start of list of standard options
213 'ie '\\$1'' .ds So \\fBoptions\\fR
214 'el .ds So \\fB\\$1\\fR
215 .SH "STANDARD OPTIONS"
221 .\" # SE - end of list of standard options
226 See the \\*(So manual entry for details on the standard options.
228 .\" # OP - start of full description for a single option
233 Command-Line Name: \\fB\\$1\\fR
234 Database Name: \\fB\\$2\\fR
235 Database Class: \\fB\\$3\\fR
239 .\" # CS - begin code excerpt
245 .\" # CE - end code excerpt
250 .\" # UL - underline word
254 .\" # QW - apply quotation marks to word
256 .ie '\\*(lq'"' ``\\$1''\\$2
257 .\"" fix emacs highlighting
258 .el \\*(lq\\$1\\*(rq\\$2
260 .\" # PQ - apply parens and quotation marks to word
262 .ie '\\*(lq'"' (``\\$1''\\$2)\\$3
263 .\"" fix emacs highlighting
264 .el (\\*(lq\\$1\\*(rq\\$2)\\$3
266 .\" # QR - quoted range
268 .ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3
269 .\"" fix emacs highlighting
270 .el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3
272 .\" # MT - "empty" string
277 '\" Note: do not modify the .SH NAME line immediately below!
279 options \- Standard options supported by widgets
283 This manual entry describes the common configuration options supported
284 by widgets in the Tk toolkit. Every widget does not necessarily support
285 every option (see the manual entries for individual widgets for a list
286 of the standard options supported by that widget), but if a widget does
287 support an option with one of the names listed below, then the option
288 has exactly the effect described below.
290 In the descriptions below,
291 .QW "Command-Line Name"
293 switch used in class commands and \fBconfigure\fR widget commands to
294 set this value. For example, if an option's command-line switch is
295 \fB\-foreground\fR and there exists a widget \fB.a.b.c\fR, then the
298 \&\fB.a.b.c\0\0configure\0\0\-foreground black\fR
300 may be used to specify the value \fBblack\fR for the option in
301 the widget \fB.a.b.c\fR. Command-line switches may be abbreviated,
302 as long as the abbreviation is unambiguous.
304 refers to the option's name in the option database (e.g. in .Xdefaults files).
306 refers to the option's class value in the option database.
307 .OP \-activebackground activeBackground Foreground
308 Specifies background color to use when drawing active elements.
309 An element (a widget or portion of a widget) is active if the
310 mouse cursor is positioned over the element and pressing a mouse button
311 will cause some action to occur.
312 If strict Motif compliance has been requested by setting the
313 \fBtk_strictMotif\fR variable, this option will normally be
314 ignored; the normal background color will be used instead.
315 For some elements on Windows and Macintosh systems, the active color
316 will only be used while mouse button 1 is pressed over the element.
317 .OP \-activeborderwidth activeBorderWidth BorderWidth
318 Specifies a non-negative value indicating
319 the width of the 3-D border drawn around active elements. See above for
320 definition of active elements.
321 The value may have any of the forms acceptable to \fBTk_GetPixels\fR.
322 This option is typically only available in widgets displaying more
323 than one element at a time (e.g. menus but not buttons).
324 .OP \-activeforeground activeForeground Background
325 Specifies foreground color to use when drawing active elements.
326 See above for definition of active elements.
327 .OP \-anchor anchor Anchor
328 Specifies how the information in a widget (e.g. text or a bitmap)
329 is to be displayed in the widget.
330 Must be one of the values \fBn\fR, \fBne\fR, \fBe\fR, \fBse\fR,
331 \fBs\fR, \fBsw\fR, \fBw\fR, \fBnw\fR, or \fBcenter\fR.
332 For example, \fBnw\fR means display the information such that its
333 top-left corner is at the top-left corner of the widget.
334 .OP "\-background or \-bg" background Background
335 Specifies the normal background color to use when displaying the
337 .OP \-bitmap bitmap Bitmap
338 Specifies a bitmap to display in the widget, in any of the forms
339 acceptable to \fBTk_GetBitmap\fR.
340 The exact way in which the bitmap is displayed may be affected by
341 other options such as \fB\-anchor\fR or \fB\-justify\fR.
342 Typically, if this option is specified then it overrides other
343 options that specify a textual value to display in the widget
344 but this is controlled by the \fB\-compound\fR option;
345 the \fB\-bitmap\fR option may be reset to an empty string to re-enable
347 In widgets that support both \fB\-bitmap\fR and \fB\-image\fR options,
348 \fB\-image\fR will usually override \fB\-bitmap\fR.
349 .OP "\-borderwidth or \-bd" borderWidth BorderWidth
350 Specifies a non-negative value indicating the width
351 of the 3-D border to draw around the outside of the widget (if such a
352 border is being drawn; the \fB\-relief\fR option typically determines
353 this). The value may also be used when drawing 3-D effects in the
354 interior of the widget.
355 The value may have any of the forms acceptable to \fBTk_GetPixels\fR.
356 .OP \-cursor cursor Cursor
357 Specifies the mouse cursor to be used for the widget.
358 The value may have any of the forms acceptable to \fBTk_GetCursor\fR.
359 In addition, if an empty string is specified, it indicates that the
360 widget should defer to its parent for cursor specification.
361 .OP \-compound compound Compound
362 Specifies if the widget should display text and bitmaps/images at the
363 same time, and if so, where the bitmap/image should be placed relative
364 to the text. Must be one of the values \fBnone\fR, \fBbottom\fR,
365 \fBtop\fR, \fBleft\fR, \fBright\fR, or \fBcenter\fR. For example, the
366 (default) value \fBnone\fR specifies that the bitmap or image should
367 (if defined) be displayed instead of the text, the value \fBleft\fR
368 specifies that the bitmap or image should be displayed to the left of
369 the text, and the value \fBcenter\fR specifies that the bitmap or
370 image should be displayed on top of the text.
371 .OP \-disabledforeground disabledForeground DisabledForeground
372 Specifies foreground color to use when drawing a disabled element.
373 If the option is specified as an empty string (which is typically the
374 case on monochrome displays), disabled elements are drawn with the
375 normal foreground color but they are dimmed by drawing them
376 with a stippled fill pattern.
377 .OP \-exportselection exportSelection ExportSelection
378 Specifies whether or not a selection in the widget should also be
380 The value may have any of the forms accepted by \fBTcl_GetBoolean\fR,
381 such as \fBtrue\fR, \fBfalse\fR, \fB0\fR, \fB1\fR, \fByes\fR, or \fBno\fR.
382 If the selection is exported, then selecting in the widget deselects
383 the current X selection, selecting outside the widget deselects any
384 widget selection, and the widget will respond to selection retrieval
385 requests when it has a selection. The default is usually for widgets
386 to export selections.
388 Specifies the font to use when drawing text inside the widget.
389 The value may have any of the forms described in the \fBfont\fR manual
390 page under \fBFONT DESCRIPTION\fR.
391 .OP "\-foreground or \-fg" foreground Foreground
392 Specifies the normal foreground color to use when displaying the widget.
393 .OP \-highlightbackground highlightBackground HighlightBackground
394 Specifies the color to display in the traversal highlight region when
395 the widget does not have the input focus.
396 .OP \-highlightcolor highlightColor HighlightColor
397 Specifies the color to use for the traversal highlight rectangle that is
398 drawn around the widget when it has the input focus.
399 .OP \-highlightthickness highlightThickness HighlightThickness
400 Specifies a non-negative value indicating the width of the highlight
401 rectangle to draw around the outside of the widget when it has the
403 The value may have any of the forms acceptable to \fBTk_GetPixels\fR.
404 If the value is zero, no focus highlight is drawn around the widget.
405 .OP \-image image Image
406 Specifies an image to display in the widget, which must have been
407 created with the \fBimage create\fR command.
408 Typically, if the \fB\-image\fR option is specified then it overrides other
409 options that specify a bitmap or textual value to display in the
410 widget, though this is controlled by the \fB\-compound\fR option;
411 the \fB\-image\fR option may be reset to an empty string to re-enable
412 a bitmap or text display.
413 .OP \-insertbackground insertBackground Foreground
414 Specifies the color to use as background in the area covered by the
415 insertion cursor. This color will normally override either the normal
416 background for the widget (or the selection background if the insertion
417 cursor happens to fall in the selection).
418 .OP \-insertborderwidth insertBorderWidth BorderWidth
419 Specifies a non-negative value indicating the width
420 of the 3-D border to draw around the insertion cursor.
421 The value may have any of the forms acceptable to \fBTk_GetPixels\fR.
422 .OP \-insertofftime insertOffTime OffTime
423 Specifies a non-negative integer value indicating the number of
424 milliseconds the insertion cursor should remain
427 If this option is zero then the cursor does not blink: it is on
429 .OP \-insertontime insertOnTime OnTime
430 Specifies a non-negative integer value indicating the number of
431 milliseconds the insertion cursor should remain
434 .OP \-insertwidth insertWidth InsertWidth
435 Specifies a value indicating the total width of the insertion cursor.
436 The value may have any of the forms acceptable to \fBTk_GetPixels\fR.
437 If a border has been specified for the insertion
438 cursor (using the \fB\-insertborderwidth\fR option), the border
439 will be drawn inside the width specified by the \fB\-insertwidth\fR
442 For widgets with a slider that can be dragged to adjust a value,
443 such as scrollbars, this option determines when
444 notifications are made about changes in the value.
445 The option's value must be a boolean of the form accepted by
446 \fBTcl_GetBoolean\fR.
447 If the value is false, updates are made continuously as the
449 If the value is true, updates are delayed until the mouse button
450 is released to end the drag; at that point a single notification
453 rather than changing smoothly).
454 .OP \-justify justify Justify
455 When there are multiple lines of text displayed in a widget, this
456 option determines how the lines line up with each other.
457 Must be one of \fBleft\fR, \fBcenter\fR, or \fBright\fR.
458 \fBLeft\fR means that the lines' left edges all line up, \fBcenter\fR
459 means that the lines' centers are aligned, and \fBright\fR means
460 that the lines' right edges line up.
461 .OP \-orient orient Orient
462 For widgets that can lay themselves out with either a horizontal
463 or vertical orientation, such as scrollbars, this option specifies
464 which orientation should be used. Must be either \fBhorizontal\fR
465 or \fBvertical\fR or an abbreviation of one of these.
467 Specifies a non-negative value indicating how much extra space
468 to request for the widget in the X-direction.
469 The value may have any of the forms acceptable to \fBTk_GetPixels\fR.
470 When computing how large a window it needs, the widget will
471 add this amount to the width it would normally need (as determined
472 by the width of the things displayed in the widget); if the geometry
473 manager can satisfy this request, the widget will end up with extra
474 internal space to the left and/or right of what it displays inside.
475 Most widgets only use this option for padding text: if they are
476 displaying a bitmap or image, then they usually ignore padding
479 Specifies a non-negative value indicating how much extra space
480 to request for the widget in the Y-direction.
481 The value may have any of the forms acceptable to \fBTk_GetPixels\fR.
482 When computing how large a window it needs, the widget will add
483 this amount to the height it would normally need (as determined by
484 the height of the things displayed in the widget); if the geometry
485 manager can satisfy this request, the widget will end up with extra
486 internal space above and/or below what it displays inside.
487 Most widgets only use this option for padding text: if they are
488 displaying a bitmap or image, then they usually ignore padding
490 .OP \-relief relief Relief
491 Specifies the 3-D effect desired for the widget. Acceptable
492 values are \fBraised\fR, \fBsunken\fR, \fBflat\fR, \fBridge\fR,
493 \fBsolid\fR, and \fBgroove\fR.
495 indicates how the interior of the widget should appear relative
496 to its exterior; for example, \fBraised\fR means the interior of
497 the widget should appear to protrude from the screen, relative to
498 the exterior of the widget.
499 .OP \-repeatdelay repeatDelay RepeatDelay
500 Specifies the number of milliseconds a button or key must be held
501 down before it begins to auto-repeat. Used, for example, on the
502 up- and down-arrows in scrollbars.
503 .OP \-repeatinterval repeatInterval RepeatInterval
504 Used in conjunction with \fB\-repeatdelay\fR: once auto-repeat
505 begins, this option determines the number of milliseconds between
507 .OP \-selectbackground selectBackground Foreground
508 Specifies the background color to use when displaying selected
510 .OP \-selectborderwidth selectBorderWidth BorderWidth
511 Specifies a non-negative value indicating the width
512 of the 3-D border to draw around selected items.
513 The value may have any of the forms acceptable to \fBTk_GetPixels\fR.
514 .OP \-selectforeground selectForeground Background
515 Specifies the foreground color to use when displaying selected
517 .OP \-setgrid setGrid SetGrid
518 Specifies a boolean value that determines whether this widget controls the
519 resizing grid for its top-level window.
520 This option is typically used in text widgets, where the information
521 in the widget has a natural size (the size of a character) and it makes
522 sense for the window's dimensions to be integral numbers of these units.
523 These natural window sizes form a grid.
524 If the \fB\-setgrid\fR option is set to true then the widget will
525 communicate with the window manager so that when the user interactively
526 resizes the top-level window that contains the widget, the dimensions of
527 the window will be displayed to the user in grid units and the window
528 size will be constrained to integral numbers of grid units.
529 See the section \fBGRIDDED GEOMETRY MANAGEMENT\fR in the \fBwm\fR manual
530 entry for more details.
531 .OP \-takefocus takeFocus TakeFocus
532 Determines whether the window accepts the focus during keyboard
533 traversal (e.g., Tab and Shift-Tab).
534 Before setting the focus to a window, the traversal scripts
535 consult the value of the \fB\-takefocus\fR option.
536 A value of \fB0\fR means that the window should be skipped entirely
537 during keyboard traversal.
538 \fB1\fR means that the window should receive the input
539 focus as long as it is viewable (it and all of its ancestors are mapped).
540 An empty value for the option means that the traversal scripts make
541 the decision about whether or not to focus on the window: the current
542 algorithm is to skip the window if it is
543 disabled, if it has no key bindings, or if it is not viewable.
544 If the value has any other form, then the traversal scripts take
545 the value, append the name of the window to it (with a separator space),
546 and evaluate the resulting string as a Tcl script.
547 The script must return \fB0\fR, \fB1\fR, or an empty string: a
548 \fB0\fR or \fB1\fR value specifies whether the window will receive
549 the input focus, and an empty string results in the default decision
551 Note: this interpretation of the option is defined entirely by
552 the Tcl scripts that implement traversal: the widget implementations
553 ignore the option entirely, so you can change its meaning if you
554 redefine the keyboard traversal scripts.
556 Specifies a string to be displayed inside the widget. The way in which
557 the string is displayed depends on the particular widget and may be
558 determined by other options, such as \fB\-anchor\fR or \fB\-justify\fR.
559 .OP \-textvariable textVariable Variable
560 Specifies the name of a global variable. The value of the variable is a text
561 string to be displayed inside the widget; if the variable value changes
562 then the widget will automatically update itself to reflect the new value.
563 The way in which the string is displayed in the widget depends on the
564 particular widget and may be determined by other options, such as
565 \fB\-anchor\fR or \fB\-justify\fR.
566 .OP \-troughcolor troughColor Background
567 Specifies the color to use for the rectangular trough areas
568 in widgets such as scrollbars and scales. This option is ignored for
569 scrollbars on Windows (native widget does not recognize this option).
570 .OP \-underline underline Underline
571 Specifies the integer index of a character to underline in the widget.
572 This option is used by the default bindings to implement keyboard
573 traversal for menu buttons and menu entries.
574 0 corresponds to the first character of the text displayed in the
575 widget, 1 to the next character, and so on.
576 .OP \-wraplength wrapLength WrapLength
577 For widgets that can perform word-wrapping, this option specifies
578 the maximum line length.
579 Lines that would exceed this length are wrapped onto the next line,
580 so that no line is longer than the specified length.
581 The value may be specified in any of the standard forms for
583 If this value is less than or equal to 0 then no wrapping is done: lines
584 will break only at newline characters in the text.
585 .OP \-xscrollcommand xScrollCommand ScrollCommand
586 Specifies the prefix for a command used to communicate with horizontal
588 When the view in the widget's window changes (or
589 whenever anything else occurs that could change the display in a
590 scrollbar, such as a change in the total size of the widget's
591 contents), the widget will
592 generate a Tcl command by concatenating the scroll command and
594 Each of the numbers is a fraction between 0 and 1, which indicates
595 a position in the document. 0 indicates the beginning of the document,
596 1 indicates the end, .333 indicates a position one third the way through
597 the document, and so on.
598 The first fraction indicates the first information in the document
599 that is visible in the window, and the second fraction indicates
600 the information just after the last portion that is visible.
602 then passed to the Tcl interpreter for execution. Typically the
603 \fB\-xscrollcommand\fR option consists of the path name of a scrollbar
607 .QW ".x.scrollbar set" :
609 the scrollbar to be updated whenever the view in the window changes.
610 If this option is not specified, then no command will be executed.
611 .OP \-yscrollcommand yScrollCommand ScrollCommand
612 Specifies the prefix for a command used to communicate with vertical
613 scrollbars. This option is treated in the same way as the
614 \fB\-xscrollcommand\fR option, except that it is used for vertical
615 scrollbars and is provided by widgets that support vertical scrolling.
616 See the description of \fB\-xscrollcommand\fR for details
617 on how this option is used.
619 colors, cursors, font
621 class, name, standard option, switch
OSDN Git Service
