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 '\" RCS: @(#) $Id: options.n,v 1.4 1999/08/13 02:58:12 hobbs Exp $
10 '\" The definitions below are for supplemental macros used in Tcl/Tk
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)
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.
26 '\" Start box enclosure. From here until next .BE, everything will be
27 '\" enclosed in one large box.
30 '\" End of box enclosure.
33 '\" Begin code excerpt.
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.
46 '\" End of vertical sidebar.
49 '\" Begin an indented unfilled display.
52 '\" End of indented unfilled display.
55 '\" Start of list of standard options for a Tk widget. The
56 '\" options follow on successive lines, in four columns separated
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.
71 '\" RCS: @(#) $Id: man.macros,v 1.3 1999/04/16 00:46:35 stanton Exp $
73 '\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
77 '\" # Start an argument description
81 . ie !"\\$2"" .TP \\n()Cu
86 \&\\$1 \\fI\\$2\\fP (\\$3)
99 '\" # define tabbing values for .AP
102 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
105 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
106 .nr )C \\n()Bu+\\w'(in/out)'u+2n
108 .AS Tcl_Interp Tcl_CreateInterp in/out
109 '\" # BS - start boxed text
110 '\" # ^y = starting y location
118 .if n \l'\\n(.lu\(ul'
121 '\" # BE - end boxed text (draw box now)
126 .ie n \l'\\n(^lu\(ul'
128 .\" Draw four-sided box normally, but don't draw top of
129 .\" box if the box started on an earlier page.
131 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
134 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
141 '\" # VS - start vertical sidebar
142 '\" # ^Y = starting y location
143 '\" # ^v = 1 (for troff; for nroff this doesn't matter)
147 .ie n 'mc \s12\(br\s0
150 '\" # VE - end of vertical sidebar
158 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
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.
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
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
194 '\" # DS - begin display
200 '\" # DE - end display
206 '\" # SO - start of list of standard options
208 .SH "STANDARD OPTIONS"
214 '\" # SE - end of list of standard options
219 See the \\fBoptions\\fR manual entry for details on the standard options.
221 '\" # OP - start of full description for a single option
226 Command-Line Name: \\fB\\$1\\fR
227 Database Name: \\fB\\$2\\fR
228 Database Class: \\fB\\$3\\fR
232 '\" # CS - begin code excerpt
238 '\" # CE - end code excerpt
246 .TH options n 4.4 Tk "Tk Built-In Commands"
248 '\" Note: do not modify the .SH NAME line immediately below!
250 options \- Standard options supported by widgets
254 This manual entry describes the common configuration options supported
255 by widgets in the Tk toolkit. Every widget does not necessarily support
256 every option (see the manual entries for individual widgets for a list
257 of the standard options supported by that widget), but if a widget does
258 support an option with one of the names listed below, then the option
259 has exactly the effect described below.
261 In the descriptions below, ``Command-Line Name'' refers to the
262 switch used in class commands and \fBconfigure\fR widget commands to
263 set this value. For example, if an option's command-line switch is
264 \fB\-foreground\fR and there exists a widget \fB.a.b.c\fR, then the
267 \&\fB.a.b.c\0\0configure\0\0\-foreground black\fR
269 may be used to specify the value \fBblack\fR for the option in the
270 the widget \fB.a.b.c\fR. Command-line switches may be abbreviated,
271 as long as the abbreviation is unambiguous.
272 ``Database Name'' refers to the option's name in the option database (e.g.
273 in .Xdefaults files). ``Database Class'' refers to the option's class value
274 in the option database.
275 .OP \-activebackground activeBackground Foreground
276 Specifies background color to use when drawing active elements.
277 An element (a widget or portion of a widget) is active if the
278 mouse cursor is positioned over the element and pressing a mouse button
279 will cause some action to occur.
280 If strict Motif compliance has been requested by setting the
281 \fBtk_strictMotif\fR variable, this option will normally be
282 ignored; the normal background color will be used instead.
284 For some elements on Windows and Macintosh systems, the active color
285 will only be used while mouse button 1 is pressed over the element.
287 .OP \-activeborderwidth activeBorderWidth BorderWidth
288 Specifies a non-negative value indicating
289 the width of the 3-D border drawn around active elements. See above for
290 definition of active elements.
291 The value may have any of the forms acceptable to \fBTk_GetPixels\fR.
292 This option is typically only available in widgets displaying more
293 than one element at a time (e.g. menus but not buttons).
294 .OP \-activeforeground activeForeground Background
295 Specifies foreground color to use when drawing active elements.
296 See above for definition of active elements.
297 .OP \-anchor anchor Anchor
298 Specifies how the information in a widget (e.g. text or a bitmap)
299 is to be displayed in the widget.
300 Must be one of the values \fBn\fR, \fBne\fR, \fBe\fR, \fBse\fR,
301 \fBs\fR, \fBsw\fR, \fBw\fR, \fBnw\fR, or \fBcenter\fR.
302 For example, \fBnw\fR means display the information such that its
303 top-left corner is at the top-left corner of the widget.
304 .OP "\-background or \-bg" background Background
305 Specifies the normal background color to use when displaying the
307 .OP \-bitmap bitmap Bitmap
308 Specifies a bitmap to display in the widget, in any of the forms
309 acceptable to \fBTk_GetBitmap\fR.
310 The exact way in which the bitmap is displayed may be affected by
311 other options such as \fBanchor\fR or \fBjustify\fR.
312 Typically, if this option is specified then it overrides other
313 options that specify a textual value to display in the widget;
314 the \fBbitmap\fR option may be reset to an empty string to re-enable
316 In widgets that support both \fBbitmap\fR and \fBimage\fR options,
317 \fBimage\fR will usually override \fBbitmap\fR.
318 .OP "\-borderwidth or \-bd" borderWidth BorderWidth
319 Specifies a non-negative value indicating the width
320 of the 3-D border to draw around the outside of the widget (if such a
321 border is being drawn; the \fBrelief\fR option typically determines
322 this). The value may also be used when drawing 3-D effects in the
323 interior of the widget.
324 The value may have any of the forms acceptable to \fBTk_GetPixels\fR.
325 .OP \-cursor cursor Cursor
326 Specifies the mouse cursor to be used for the widget.
327 The value may have any of the forms acceptable to \fBTk_GetCursor\fR.
328 .OP \-disabledforeground disabledForeground DisabledForeground
329 Specifies foreground color to use when drawing a disabled element.
330 If the option is specified as an empty string (which is typically the
331 case on monochrome displays), disabled elements are drawn with the
332 normal foreground color but they are dimmed by drawing them
333 with a stippled fill pattern.
334 .OP \-exportselection exportSelection ExportSelection
335 Specifies whether or not a selection in the widget should also be
337 The value may have any of the forms accepted by \fBTcl_GetBoolean\fR,
338 such as \fBtrue\fR, \fBfalse\fR, \fB0\fR, \fB1\fR, \fByes\fR, or \fBno\fR.
339 If the selection is exported, then selecting in the widget deselects
340 the current X selection, selecting outside the widget deselects any
341 widget selection, and the widget will respond to selection retrieval
342 requests when it has a selection. The default is usually for widgets
343 to export selections.
345 Specifies the font to use when drawing text inside the widget.
346 .OP "\-foreground or \-fg" foreground Foreground
347 Specifies the normal foreground color to use when displaying the widget.
348 .OP \-highlightbackground highlightBackground HighlightBackground
349 Specifies the color to display in the traversal highlight region when
350 the widget does not have the input focus.
351 .OP \-highlightcolor highlightColor HighlightColor
352 Specifies the color to use for the traversal highlight rectangle that is
353 drawn around the widget when it has the input focus.
354 .OP \-highlightthickness highlightThickness HighlightThickness
355 Specifies a non-negative value indicating the width of the highlight
356 rectangle to draw around the outside of the widget when it has the
358 The value may have any of the forms acceptable to \fBTk_GetPixels\fR.
359 If the value is zero, no focus highlight is drawn around the widget.
360 .OP \-image image Image
361 Specifies an image to display in the widget, which must have been
362 created with the \fBimage create\fR command.
363 Typically, if the \fBimage\fR option is specified then it overrides other
364 options that specify a bitmap or textual value to display in the widget;
365 the \fBimage\fR option may be reset to an empty string to re-enable
366 a bitmap or text display.
367 .OP \-insertbackground insertBackground Foreground
368 Specifies the color to use as background in the area covered by the
369 insertion cursor. This color will normally override either the normal
370 background for the widget (or the selection background if the insertion
371 cursor happens to fall in the selection).
372 .OP \-insertborderwidth insertBorderWidth BorderWidth
373 Specifies a non-negative value indicating the width
374 of the 3-D border to draw around the insertion cursor.
375 The value may have any of the forms acceptable to \fBTk_GetPixels\fR.
376 .OP \-insertofftime insertOffTime OffTime
377 Specifies a non-negative integer value indicating the number of
378 milliseconds the insertion cursor should remain ``off'' in each blink cycle.
379 If this option is zero then the cursor doesn't blink: it is on
381 .OP \-insertontime insertOnTime OnTime
382 Specifies a non-negative integer value indicating the number of
383 milliseconds the insertion cursor should remain ``on'' in each blink cycle.
384 .OP \-insertwidth insertWidth InsertWidth
385 Specifies a value indicating the total width of the insertion cursor.
386 The value may have any of the forms acceptable to \fBTk_GetPixels\fR.
387 If a border has been specified for the insertion
388 cursor (using the \fBinsertBorderWidth\fR option), the border
389 will be drawn inside the width specified by the \fBinsertWidth\fR
392 For widgets with a slider that can be dragged to adjust a value,
393 such as scrollbars, this option determines when
394 notifications are made about changes in the value.
395 The option's value must be a boolean of the form accepted by
396 \fBTcl_GetBoolean\fR.
397 If the value is false, updates are made continuously as the
399 If the value is true, updates are delayed until the mouse button
400 is released to end the drag; at that point a single notification
401 is made (the value ``jumps'' rather than changing smoothly).
402 .OP \-justify justify Justify
403 When there are multiple lines of text displayed in a widget, this
404 option determines how the lines line up with each other.
405 Must be one of \fBleft\fR, \fBcenter\fR, or \fBright\fR.
406 \fBLeft\fR means that the lines' left edges all line up, \fBcenter\fR
407 means that the lines' centers are aligned, and \fBright\fR means
408 that the lines' right edges line up.
409 .OP \-orient orient Orient
410 For widgets that can lay themselves out with either a horizontal
411 or vertical orientation, such as scrollbars, this option specifies
412 which orientation should be used. Must be either \fBhorizontal\fR
413 or \fBvertical\fR or an abbreviation of one of these.
415 Specifies a non-negative value indicating how much extra space
416 to request for the widget in the X-direction.
417 The value may have any of the forms acceptable to \fBTk_GetPixels\fR.
418 When computing how large a window it needs, the widget will
419 add this amount to the width it would normally need (as determined
420 by the width of the things displayed in the widget); if the geometry
421 manager can satisfy this request, the widget will end up with extra
422 internal space to the left and/or right of what it displays inside.
423 Most widgets only use this option for padding text: if they are
424 displaying a bitmap or image, then they usually ignore padding
427 Specifies a non-negative value indicating how much extra space
428 to request for the widget in the Y-direction.
429 The value may have any of the forms acceptable to \fBTk_GetPixels\fR.
430 When computing how large a window it needs, the widget will add
431 this amount to the height it would normally need (as determined by
432 the height of the things displayed in the widget); if the geometry
433 manager can satisfy this request, the widget will end up with extra
434 internal space above and/or below what it displays inside.
435 Most widgets only use this option for padding text: if they are
436 displaying a bitmap or image, then they usually ignore padding
438 .OP \-relief relief Relief
439 Specifies the 3-D effect desired for the widget. Acceptable
440 values are \fBraised\fR, \fBsunken\fR, \fBflat\fR, \fBridge\fR,
441 \fBsolid\fR, and \fBgroove\fR.
443 indicates how the interior of the widget should appear relative
444 to its exterior; for example, \fBraised\fR means the interior of
445 the widget should appear to protrude from the screen, relative to
446 the exterior of the widget.
447 .OP \-repeatdelay repeatDelay RepeatDelay
448 Specifies the number of milliseconds a button or key must be held
449 down before it begins to auto-repeat. Used, for example, on the
450 up- and down-arrows in scrollbars.
451 .OP \-repeatinterval repeatInterval RepeatInterval
452 Used in conjunction with \fBrepeatDelay\fR: once auto-repeat
453 begins, this option determines the number of milliseconds between
455 .OP \-selectbackground selectBackground Foreground
456 Specifies the background color to use when displaying selected
458 .OP \-selectborderwidth selectBorderWidth BorderWidth
459 Specifies a non-negative value indicating the width
460 of the 3-D border to draw around selected items.
461 The value may have any of the forms acceptable to \fBTk_GetPixels\fR.
462 .OP \-selectforeground selectForeground Background
463 Specifies the foreground color to use when displaying selected
465 .OP \-setgrid setGrid SetGrid
466 Specifies a boolean value that determines whether this widget controls the
467 resizing grid for its top-level window.
468 This option is typically used in text widgets, where the information
469 in the widget has a natural size (the size of a character) and it makes
470 sense for the window's dimensions to be integral numbers of these units.
471 These natural window sizes form a grid.
472 If the \fBsetGrid\fR option is set to true then the widget will
473 communicate with the window manager so that when the user interactively
474 resizes the top-level window that contains the widget, the dimensions of
475 the window will be displayed to the user in grid units and the window
476 size will be constrained to integral numbers of grid units.
477 See the section GRIDDED GEOMETRY MANAGEMENT in the \fBwm\fR manual
478 entry for more details.
479 .OP \-takefocus takeFocus TakeFocus
480 Determines whether the window accepts the focus during keyboard
481 traversal (e.g., Tab and Shift-Tab).
482 Before setting the focus to a window, the traversal scripts
483 consult the value of the \fBtakeFocus\fR option.
484 A value of \fB0\fR means that the window should be skipped entirely
485 during keyboard traversal.
486 \fB1\fR means that the window should receive the input
487 focus as long as it is viewable (it and all of its ancestors are mapped).
488 An empty value for the option means that the traversal scripts make
489 the decision about whether or not to focus on the window: the current
490 algorithm is to skip the window if it is
491 disabled, if it has no key bindings, or if it is not viewable.
492 If the value has any other form, then the traversal scripts take
493 the value, append the name of the window to it (with a separator space),
494 and evaluate the resulting string as a Tcl script.
495 The script must return \fB0\fR, \fB1\fR, or an empty string: a
496 \fB0\fR or \fB1\fR value specifies whether the window will receive
497 the input focus, and an empty string results in the default decision
499 Note: this interpretation of the option is defined entirely by
500 the Tcl scripts that implement traversal: the widget implementations
501 ignore the option entirely, so you can change its meaning if you
502 redefine the keyboard traversal scripts.
504 Specifies a string to be displayed inside the widget. The way in which
505 the string is displayed depends on the particular widget and may be
506 determined by other options, such as \fBanchor\fR or \fBjustify\fR.
507 .OP \-textvariable textVariable Variable
508 Specifies the name of a variable. The value of the variable is a text
509 string to be displayed inside the widget; if the variable value changes
510 then the widget will automatically update itself to reflect the new value.
511 The way in which the string is displayed in the widget depends on the
512 particular widget and may be determined by other options, such as
513 \fBanchor\fR or \fBjustify\fR.
514 .OP \-troughcolor troughColor Background
515 Specifies the color to use for the rectangular trough areas
516 in widgets such as scrollbars and scales. This option is ignored for
517 scrollbars on Windows (native widget doesn't recognize this option).
518 .OP \-underline underline Underline
519 Specifies the integer index of a character to underline in the widget.
520 This option is used by the default bindings to implement keyboard
521 traversal for menu buttons and menu entries.
522 0 corresponds to the first character of the text displayed in the
523 widget, 1 to the next character, and so on.
524 .OP \-wraplength wrapLength WrapLength
525 For widgets that can perform word-wrapping, this option specifies
526 the maximum line length.
527 Lines that would exceed this length are wrapped onto the next line,
528 so that no line is longer than the specified length.
529 The value may be specified in any of the standard forms for
531 If this value is less than or equal to 0 then no wrapping is done: lines
532 will break only at newline characters in the text.
533 .OP \-xscrollcommand xScrollCommand ScrollCommand
534 Specifies the prefix for a command used to communicate with horizontal
536 When the view in the widget's window changes (or
537 whenever anything else occurs that could change the display in a
538 scrollbar, such as a change in the total size of the widget's
539 contents), the widget will
540 generate a Tcl command by concatenating the scroll command and
542 Each of the numbers is a fraction between 0 and 1, which indicates
543 a position in the document. 0 indicates the beginning of the document,
544 1 indicates the end, .333 indicates a position one third the way through
545 the document, and so on.
546 The first fraction indicates the first information in the document
547 that is visible in the window, and the second fraction indicates
548 the information just after the last portion that is visible.
550 then passed to the Tcl interpreter for execution. Typically the
551 \fBxScrollCommand\fR option consists of the path name of a scrollbar
552 widget followed by ``set'', e.g. ``.x.scrollbar set'': this will cause
553 the scrollbar to be updated whenever the view in the window changes.
554 If this option is not specified, then no command will be executed.
555 .OP \-yscrollcommand yScrollCommand ScrollCommand
556 Specifies the prefix for a command used to communicate with vertical
557 scrollbars. This option is treated in the same way as the
558 \fBxScrollCommand\fR option, except that it is used for vertical
559 scrollbars and is provided by widgets that support vertical scrolling.
560 See the description of \fBxScrollCommand\fR for details
561 on how this option is used.
564 class, name, standard option, switch
OSDN Git Service
