options(n)		     Ck Built-In Commands		    options(n)



______________________________________________________________________________

NAME
       options - Standard options supported by widgets
_________________________________________________________________


DESCRIPTION
       This  manual entry describes the common configuration options supported
       by widgets in the Ck toolkit.  Every widget does not  necessarily  sup-
       port  every option (see the manual entries for individual widgets for a
       list of the standard options supported by that widget), but if a widget
       does support an option with one of the names listed below, then the op-
       tion has exactly the effect described below.

       In the descriptions below, ``Name'' refers to the option's name in  the
       option database ``Class'' refers to the option's class value in the op-
       tion database.  ``Command-Line Switch'' refers to the  switch  used  in
       widget-creation	and  configure widget commands to set this value.  For
       example, if an option's command-line switch is  -foreground  and	 there
       exists a widget .a.b.c, then the command .a.b.c	configure  -foreground
       black may be used to specify the value black for the option in the  the
       widget  .a.b.c.	 Command-line  switches may be abbreviated, as long as
       the abbreviation is unambiguous.

       Name:	       activeAttributes
       Class:	       Attributes
       Command-Line Switch:-activeattributes

	      Specifies video attributes to use when drawing  active  elements
	      of widgets. This option must be a proper Tcl list which may con-
	      tain the elements:

		       blink	      reverse
		       bold	      standout
		       dim	      underline
		       normal

	      If the list is empty,  the  normal  attribute  is	 automatically
	      present.

       Name:	       activeBackground
       Class:	       Foreground
       Command-Line Switch:-activebackground

	      Specifies	 background  color to use when drawing active elements
	      of widgets. Color	 specifications	 are  always  symbolic;	 valid
	      color names are:

		       black	      magenta
		       blue	      red
		       cyan	      yellow
		       green	      white

       Name:	       activeForeground
       Class:	       Background
       Command-Line Switch:-activeforeground

	      Specifies	 foreground color to use when drawing active elements.
	      See above for possible colors.

       Name:	       anchor
       Class:	       Anchor
       Command-Line Switch:-anchor

	      Specifies how the text in a widget is to	be  displayed  in  the
	      widget.	Must  be one of the values n, ne, e, se, s, sw, w, nw,
	      or center.  For example, nw means display the text such that its
	      top-left corner is at the top-left corner of the widget.

       Name:	       attributes
       Class:	       Attributes
       Command-Line Switch:-attributes

	      Specifies	 video	attributes  to use when displaying the widget.
	      See activeAttributes for possible values.

       Name:	       background
       Class:	       Background
       Command-Line Switch:-background or -bg

	      Specifies the normal background color to use when displaying the
	      widget. See activeBackground for possible colors.

       Name:	       border
       Class:	       Border
       Command-Line Switch:-border

	      Specifies the characters used for drawing a border around a wid-
	      get.  This options must be a proper Tcl list with exactly	 zero,
	      one, three, six, or eight elements:

	      0 elements  No  extra  space  for the border is allocated by the
			  widget.

	      1 element	  All four sides of the border's  rectangle  plus  the
			  corners are made from the sole element.

	      3 elements  The  first  element is used for the rectangle's cor-
			  ners, the second for the horizontal sides,  and  the
			  third for the vertical sides.

	      6 elements  The  order  of  elements  in the rectangle is: upper
			  left corner, horizontal side,	 upper	right  corner,
			  vertical  side,  lower right corner, lower left cor-
			  ner.

	      8 elements  Each element gives  corner  and  side,  alternating,
			  starting  at	the  upper  left corner of the square,
			  clockwise.

	      The list elements must be either a single character  or  a  sym-
	      bolic  name of a graphical character. For valid names of graphi-
	      cal characters refer to the curses gchar command.

       Name:	       disabledAttributes
       Class:	       DisabledAttributes
       Command-Line Switch:-disabledattributes

	      Specifies video attributes to use when drawing a	disabled  ele-
	      ment.  See activeAttributes for possible values.

       Name:	       disabledBackground
       Class:	       DisabledBackground
       Command-Line Switch:-disabledbackground

	      Specifies	 background  color to use when drawing a disabled ele-
	      ment.  See activeBackground for possible colors.

       Name:	       disabledForeground
       Class:	       DisabledForeground
       Command-Line Switch:-disabledforeground

	      Specifies foreground color to use when drawing a	disabled  ele-
	      ment.  See activeBackground for possible colors.

       Name:	       foreground
       Class:	       Foreground
       Command-Line Switch:-foreground or -fg

	      Specifies the normal foreground color to use when displaying the
	      widget.  See activeBackground for possible colors.

       Name:	       justify
       Class:	       Justify
       Command-Line Switch:-justify

	      When there are multiple lines of text  displayed	in  a  widget,
	      this  option  determines	how the lines line up with each other.
	      Must be one of left, center, or  right.	Left  means  that  the
	      lines' left edges all line up, center means that the lines' cen-
	      ters are aligned, and right means that the  lines'  right	 edges
	      line up.

       Name:	       orient
       Class:	       Orient
       Command-Line Switch:-orient

	      For widgets that can lay themselves out with either a horizontal
	      or vertical orientation, such as scrollbars, this option	speci-
	      fies  which orientation should be used.  Must be either horizon-
	      tal or vertical or an abbreviation of one of these.

       Name:	       selectAttributes
       Class:	       SelectAttributes
       Command-Line Switch:-selectattributes

	      Specifies video  attributes  to  use  when  displaying  selected
	      items.  See activeAttributes for possible values.

       Name:	       selectBackground
       Class:	       Foreground
       Command-Line Switch:-selectbackground

	      Specifies	 the  background color to use when displaying selected
	      items. See activeBackground for possible colors.

       Name:	       selectForeground
       Class:	       Background
       Command-Line Switch:-selectforeground

	      Specifies the foreground color to use when  displaying  selected
	      items. See activeBackground for possible colors.

       Name:	       takeFocus
       Class:	       TakeFocus
       Command-Line Switch:-takefocus

	      Provides	information  used when moving the focus from window to
	      window via keyboard traversal (e.g., Tab and  BackTab).	Before
	      setting the focus to a window, the traversal scripts first check
	      whether the window is viewable (it and  all  its	ancestors  are
	      mapped);	if not, the window is skipped.	Next, the scripts con-
	      sult the value of the takeFocus option.  A value of 0 means that
	      this  window  should be skipped entirely during keyboard traver-
	      sal.  1 means that the this window should always receive the in-
	      put focus.  An empty value means that the traversal scripts make
	      the decision about whether or not to focus on the	 window:   the
	      current  algorithm is to skip the window if it is disabled or if
	      it has no key bindings.  If the value has any other  form,  then
	      the  traversal  scripts  take  the value, append the name of the
	      window to it (with a separator space), and evaluate the  result-
	      ing  string as a Tcl script.  The script must return 0, 1, or an
	      empty string;  this value is used just as if the option had that
	      value  in the first place.  Note: this interpretation of the op-
	      tion is defined entirely by the Tcl scripts that implement  tra-
	      versal:	the widget implementations ignore the option entirely,
	      so you can change its meaning if you redefine the keyboard  tra-
	      versal scripts.

       Name:	       text
       Class:	       Text
       Command-Line Switch:-text

	      Specifies	 a  string to be displayed inside the widget.  The way
	      in which the string is displayed depends on the particular  wid-
	      get  and	may  be determined by other options, such as anchor or
	      justify.

       Name:	       textVariable
       Class:	       Variable
       Command-Line Switch:-textvariable

	      Specifies the name of a variable.	 The value of the variable  is
	      a	 text  string to be displayed inside the widget;  if the vari-
	      able value changes then the widget will automatically update it-
	      self  to	reflect the new value.	The way in which the string is
	      displayed in the widget depends on the particular widget and may
	      be determined by other options, such as anchor or justify.

       Name:	       underline
       Class:	       Underline
       Command-Line Switch:-underline

	      Specifies	 the  integer index of a character to underline in the
	      widget.  This option is used by the default bindings  to	imple-
	      ment  keyboard  traversal	 for menu buttons and menu entries.  0
	      corresponds to the first character of the text displayed in  the
	      widget, 1 to the next character, and so on.

       Name:	       underlineAttributes
       Class:	       UnderlineAttributes
       Command-Line Switch:-underlineattributes

       Name:	       underlineForeground
       Class:	       UnderlineForeground
       Command-Line Switch:-underlineforeground

	      Specifies	 the foreground color to use when displaying an under-
	      lined character. See activeBackground for possible colors.

       Name:	       xScrollCommand
       Class:	       ScrollCommand
       Command-Line Switch:-xscrollcommand

	      Specifies the prefix for a command used to communicate with hor-
	      izontal  scrollbars.   When  the	view  in  the  widget's window
	      changes (or whenever anything else occurs that could change  the
	      display  in  a  scrollbar, such as a change in the total size of
	      the widget's contents), the widget will generate a  Tcl  command
	      by  concatenating	 the  scroll command and two numbers.  Each of
	      the numbers is a fraction between 0 and 1, which indicates a po-
	      sition  in the document.	0 indicates the beginning of the docu-
	      ment, 1 indicates the end, .333 indicates a position  one	 third
	      the way through the document, and so on.	The first fraction in-
	      dicates the first information in the document that is visible in
	      the  window,  and	 the second fraction indicates the information
	      just after the last portion that is  visible.   The  command  is
	      then passed to the Tcl interpreter for execution.	 Typically the
	      xScrollCommand option consists of the path name of  a  scrollbar
	      widget  followed	by  ``set'',  e.g. ``.x.scrollbar set'':  this
	      will cause the scrollbar to be updated whenever the view in  the
	      window  changes.	 If this option is not specified, then no com-
	      mand will be executed.

       Name:	       yScrollCommand
       Class:	       ScrollCommand
       Command-Line Switch:-yscrollcommand

	      Specifies the prefix for a command used to communicate with ver-
	      tical scrollbars.	 This option is treated in the same way as the
	      xScrollCommand option, except  that  it  is  used	 for  vertical
	      scrollbars  and  is  provided  by	 widgets that support vertical
	      scrolling.  See the description of xScrollCommand for details on
	      how this option is used.


KEYWORDS
       class, name, standard option, switch



Ck				      8.0			    options(n)
