'\" '\" Copyright (c) 1996, Expert Interface Technologies '\" '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" '\" The definitions below are for supplemental macros used in Tix '\" manual entries. '\" '\" .HS name section [date [version]] '\" Replacement for .TH in other man pages. See below for valid '\" section names. '\" '\" .AP type name in/out [indent] '\" Start paragraph describing an argument to a library procedure. '\" type is type of argument (int, etc.), in/out is either "in", "out", '\" or "in/out" to describe whether procedure reads or modifies arg, '\" and indent is equivalent to second arg of .IP (shouldn't ever be '\" needed; use .AS below instead) '\" '\" .AS [type [name]] '\" Give maximum sizes of arguments for setting tab stops. Type and '\" name are examples of largest possible arguments that will be passed '\" to .AP later. If args are omitted, default tab stops are used. '\" '\" .BS '\" Start box enclosure. From here until next .BE, everything will be '\" enclosed in one large box. '\" '\" .BE '\" End of box enclosure. '\" '\" .VS '\" Begin vertical sidebar, for use in marking newly-changed parts '\" of man pages. '\" '\" .VE '\" End of vertical sidebar. '\" '\" .DS '\" Begin an indented unfilled display. '\" '\" .DE '\" End of indented unfilled display. '\" .\" '\" # Heading for Tix man pages .de HS .ds ^3 \\0 .if !"\\$3"" .ds ^3 \\$3 .if '\\$2'cmds' .TH "\\$1" 1 "\\*(^3" "\\$4" "\\$5" .if '\\$2'lib' .TH "\\$1" 3 "\\*(^3" "\\$4" "\\$5" .if '\\$2'ncmds' .TH "\\$1" n "\\*(^3" "\\$4" "\\$5" .if '\\$2'tcl' .TH "\\$1" n "\\*(^3" Tcl "Tcl Built-In Commands" .if '\\$2'tk' .TH "\\$1" n "\\*(^3" Tk "Tk Commands" .if '\\$2'tclc' .TH "\\$1" 3 "\\*(^3" Tcl "Tcl Library Procedures" .if '\\$2'tkc' .TH "\\$1" 3 "\\*(^3" Tk "Tk Library Procedures" .if '\\$2'tclcmds' .TH "\\$1" 1 "\\*(^3" Tcl "Tcl Applications" .if '\\$2'tkcmds' .TH "\\$1" 1 "\\*(^3" Tk "Tk Applications" .if '\\$2'tix' .TH "\\$1" n "\\*(^3" Tk "Tix Commands" .if '\\$2'tixcmds' .TH "\\$1" 1 "\\*(^3" Tk "Tix Applications" .if t .wh -1.3i ^B .nr ^l \\n(.l .ad b .. '\" # Start an argument description .de AP .ie !"\\$4"" .TP \\$4 .el \{\ . ie !"\\$2"" .TP \\n()Cu . el .TP 15 .\} .ie !"\\$3"" \{\ .ta \\n()Au \\n()Bu \&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ .br .ie !"\\$2"" \{\ \&\\$1 \\fI\\$2\\fP .\} .el \{\ \&\\fI\\$1\\fP .\} .\} .. '\" # define tabbing values for .AP .de AS .nr )A 10n .if !"\\$1"" .nr )A \\w'\\$1'u+3n .nr )B \\n()Au+15n .\" .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n .nr )C \\n()Bu+\\w'(in/out)'u+2n .. '\" # BS - start boxed text '\" # ^y = starting y location '\" # ^b = 1 .de BS .br .mk ^y .nr ^b 1u .if n .nf .if n .ti 0 .if n \l'\\n(.lu\(ul' .if n .fi .. '\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 .mk ^t .ie n \l'\\n(^lu\(ul' .el \{\ .\" Draw four-sided box normally, but don't draw top of .\" box if the box started on an earlier page. .ie !\\n(^b-1 \{\ \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' .\} .el \}\ \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' .\} .\} .fi .br .nr ^b 0 .. '\" # VS - start vertical sidebar '\" # ^Y = starting y location '\" # ^v = 1 (for troff; for nroff this doesn't matter) .de VS .mk ^Y .ie n 'mc \s12\(br\s0 .el .nr ^v 1u .. '\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ .ev 2 .nf .ti 0 .mk ^t \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n' .sp -1 .fi .ev .\} .nr ^v 0 .. '\" # Special macro to handle page bottom: finish off current '\" # box/sidebar if in box/sidebar mode, then invoked standard '\" # page bottom macro. .de ^B .ev 2 'ti 0 'nf .mk ^t .if \\n(^b \{\ .\" Draw three-sided box if this is the box's first page, .\" draw two sides but no top otherwise. .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 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c .\} .if \\n(^v \{\ .nr ^x \\n(^tu+1v-\\n(^Yu \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c .\} .bp 'fi .ev .if \\n(^b \{\ .mk ^y .nr ^b 2 .\} .if \\n(^v \{\ .mk ^Y .\} .. '\" # DS - begin display .de DS .RS .nf .sp .. '\" # DE - end display .de DE .fi .RE .sp .. '\" copyrighted: (c) 1990 The Regents of the University of California. '\" (c) 1994-1995 Sun Microsystems, Inc. '\" The license terms of the Tcl/Tk distrobution are in the file '\" license.tcl. '\" The definitions below are for supplemental macros used in Tix '\" manual entries. '\" '\" .HS name section [date [version]] '\" Replacement for .TH in other man pages. See below for valid '\" section names. '\" '\" .AP type name in/out [indent] '\" Start paragraph describing an argument to a library procedure. '\" type is type of argument (int, etc.), in/out is either "in", "out", '\" or "in/out" to describe whether procedure reads or modifies arg, '\" and indent is equivalent to second arg of .IP (shouldn't ever be '\" needed; use .AS below instead) '\" '\" .AS [type [name]] '\" Give maximum sizes of arguments for setting tab stops. Type and '\" name are examples of largest possible arguments that will be passed '\" to .AP later. If args are omitted, default tab stops are used. '\" '\" .BS '\" Start box enclosure. From here until next .BE, everything will be '\" enclosed in one large box. '\" '\" .BE '\" End of box enclosure. '\" '\" .VS '\" Begin vertical sidebar, for use in marking newly-changed parts '\" of man pages. '\" '\" .VE '\" End of vertical sidebar. '\" '\" .DS '\" Begin an indented unfilled display. '\" '\" .DE '\" End of indented unfilled display. '\" .\" '\" # Heading for Tix man pages .de HS .ds ^3 \\0 .if !"\\$3"" .ds ^3 \\$3 .if '\\$2'cmds' .TH "\\$1" 1 "\\*(^3" "\\$4" "\\$5" .if '\\$2'lib' .TH "\\$1" 3 "\\*(^3" "\\$4" "\\$5" .if '\\$2'ncmds' .TH "\\$1" n "\\*(^3" "\\$4" "\\$5" .if '\\$2'tcl' .TH "\\$1" n "\\*(^3" Tcl "Tcl Built-In Commands" .if '\\$2'tk' .TH "\\$1" n "\\*(^3" Tk "Tk Commands" .if '\\$2'tclc' .TH "\\$1" 3 "\\*(^3" Tcl "Tcl Library Procedures" .if '\\$2'tkc' .TH "\\$1" 3 "\\*(^3" Tk "Tk Library Procedures" .if '\\$2'tclcmds' .TH "\\$1" 1 "\\*(^3" Tcl "Tcl Applications" .if '\\$2'tkcmds' .TH "\\$1" 1 "\\*(^3" Tk "Tk Applications" .if '\\$2'tix' .TH "\\$1" n "\\*(^3" Tk "Tix Commands" .if '\\$2'tixcmds' .TH "\\$1" 1 "\\*(^3" Tk "Tix Applications" .if t .wh -1.3i ^B .nr ^l \\n(.l .ad b .. '\" # Start an argument description .de AP .ie !"\\$4"" .TP \\$4 .el \{\ . ie !"\\$2"" .TP \\n()Cu . el .TP 15 .\} .ie !"\\$3"" \{\ .ta \\n()Au \\n()Bu \&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ .br .ie !"\\$2"" \{\ \&\\$1 \\fI\\$2\\fP .\} .el \{\ \&\\fI\\$1\\fP .\} .\} .. '\" # define tabbing values for .AP .de AS .nr )A 10n .if !"\\$1"" .nr )A \\w'\\$1'u+3n .nr )B \\n()Au+15n .\" .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n .nr )C \\n()Bu+\\w'(in/out)'u+2n .. '\" # BS - start boxed text '\" # ^y = starting y location '\" # ^b = 1 .de BS .br .mk ^y .nr ^b 1u .if n .nf .if n .ti 0 .if n \l'\\n(.lu\(ul' .if n .fi .. '\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 .mk ^t .ie n \l'\\n(^lu\(ul' .el \{\ .\" Draw four-sided box normally, but don't draw top of .\" box if the box started on an earlier page. .ie !\\n(^b-1 \{\ \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' .\} .el \}\ \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' .\} .\} .fi .br .nr ^b 0 .. '\" # VS - start vertical sidebar '\" # ^Y = starting y location '\" # ^v = 1 (for troff; for nroff this doesn't matter) .de VS .mk ^Y .ie n 'mc \s12\(br\s0 .el .nr ^v 1u .. '\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ .ev 2 .nf .ti 0 .mk ^t \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n' .sp -1 .fi .ev .\} .nr ^v 0 .. '\" # Special macro to handle page bottom: finish off current '\" # box/sidebar if in box/sidebar mode, then invoked standard '\" # page bottom macro. .de ^B .ev 2 'ti 0 'nf .mk ^t .if \\n(^b \{\ .\" Draw three-sided box if this is the box's first page, .\" draw two sides but no top otherwise. .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 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c .\} .if \\n(^v \{\ .nr ^x \\n(^tu+1v-\\n(^Yu \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c .\} .bp 'fi .ev .if \\n(^b \{\ .mk ^y .nr ^b 2 .\} .if \\n(^v \{\ .mk ^Y .\} .. '\" # DS - begin display .de DS .RS .nf .sp .. '\" # DE - end display .de DE .fi .RE .sp .. '---------------------------------------------------------------------- .HS tixGrid tix 4.0 .BS ' ' '---------------------------------------------------------------------- .SH NAME tixGrid \- Create and manipulate Tix Grid widgets ' .PP \fIThis manual page is not complete. It will be completed in the next release of Tix. \fR ' '---------------------------------------------------------------------- .SH SYNOPSIS \fBtixGrid\fI \fIpathName ?\fIoptions\fR? ' ' '---------------------------------------------------------------------- .PP .SH SUPER-CLASS None. '---------------------------------------------------------------------- .SH "STANDARD OPTIONS" ' .LP .nf .ta 4c 8c 12c \fBbackground\fR \fBborderWidth\fR \fBcursor\fR \fBforeground\fR \fBfont\fR \fBheight\fR \fBhighlightColor \fBhighlightThickness \fBrelief\fR \fBselectBackground\fR \fBselectForeground\fR \fBxScrollCommand\fR \fByScrollCommand\fR \fBwidth\fR .ta 4c .fi .LP See the \fBoptions(n)\fR manual entry for details on the standard options. ' '---------------------------------------------------------------------- .SH "WIDGET-SPECIFIC OPTIONS" ' '----------BEGIN .LP .nf Name: \fBformatCmd\fR Class: \fBformatCmd\fR Switch: \fB\-formatcmd\fR .fi .IP If non-empty, gives a Tcl command to be executed when the grid cells need to be formatted on the screen. Normally, this command calls the \fBformat\fR widget command (see below). When this command is called, it is passed with five additional parameters: \fItype x1 y1 x2 y2\fR. \fIx1 y1 x2 y2\fR gives the extent of the region that needs formatting. \fItype\fR gives the logical type of the region in the grid. It may be one of the following. \fBx-region\fR: the horizontal margin; \fBy-region\fR: the vertical margin; \fIs-region\fR, the area where the the horizontal and vertical margins are joined; \fBmain\fR: all the cells that do not fall into the above three types. '----------END ' '----------BEGIN .LP .nf Name: \fBleftMargin\fR Class: \fBLeftMargin\fR Switch: \fB\-leftmargin\fR .fi .IP In the number of cells, gives the width of vertical margin. A zero indicates that no vertical should be drawn. '----------END ' '----------BEGIN .LP .nf Name: \fBtopMargin\fR Class: \fBTopMargin\fR Switch: \fB\-topmargin\fR .fi .IP In the number of cells, gives the height of horizontal margin. A zero indicates that no horizontal should be drawn. '----------END ' .BE ' ' '---------------------------------------------------------------------- .SH DESCRIPTION ' .PP ' The \fBtixGrid\fR command creates a new window (given by the \fIpathName\fR argument) and makes it into a Grid widget. Additional options, described above, may be specified on the command line or in the option database to configure aspects of the Grid widget such as its cursor and relief. .PP A Grid widget displays its contents in a two dimensional grid of cells. Each cell may contain one Tix\fB display item\fR, which may be in text, graphics or other formats. See the \fBtixItemType(n)\fR for more information about Tix display items. Individual cells, or groups of cells, can be formatted with a wide range of attributes, such as its color, relief and border. .PP This version of Grid does not support dynamic editing of the contents of the cells. This feature is expected to be added in the near future. '---------------------------------------------------------------------- .SH "WIDGET COMMAND" .PP ' The \fBtixGrid\fR command creates a new Tcl command whose name is the same as the path name of the Grid widget's window. This command may be used to invoke various operations on the widget. It has the following general form: ' .DS C ' \fIpathName option \fR?\fIarg arg ...\fR? .PP .DE ' \fIPathName\fR is the name of the command, which is the same as the Grid widget's path name. \fIOption\fR and the \fIarg\fRs determine the exact behavior of the command. The following commands are possible for Grid widgets: ' .TP \fIpathName \fBanchor get \fIx y\fR ' Returns a list of two elements. The first element is the row number of the anchor cell and the second element is the column number. The anchor cell is the end of the selection that is fixed while the user is dragging out a selection with the mouse. ' .TP \fIpathName \fBanchor clear\fR ' Removes the anchor, if any, from this Grid widget. This only removes the surrounding highlights of the anchor cell and does not affect its selection status. ' .TP \fIpathName \fBanchor set \fIx y\fR ' Sets the anchor to be at cell (\fIx\fR,\fI). ' .TP \fIpathName \fBcget\fR \fIoption\fR ' Returns the current value of the configuration option given by \fIoption\fR. \fIOption\fR may have any of the values accepted by the \fBtixGrid\fR command. ' .TP ' \fIpathName \fBconfigure\fR ?\fIoption\fR? \fI?value option value ...\fR? ' Query or modify the configuration options of the widget. If no \fIoption\fR is specified, returns a list describing all of the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for information on the format of this list). If \fIoption\fR is specified with no \fIvalue\fR, then the command returns a list describing the one named option (this list will be identical to the corresponding sublist of the value returned if no \fIoption\fR is specified). If one or more \fIoption\-value\fR pairs are specified, then the command modifies the given widget option(s) to have the given value(s); in this case the command returns an empty string. \fIOption\fR may have any of the values accepted by the \fBtixGrid\fR command. ' '.TP '\fIpathName \fBdelete \fIx y\fR ' 'Deletes the display item in the cell at location (\fIx\fR,\fIy\fR). ' .TP \fIpathName \fBformat \fItype x1 y1 x2 y2 \fR?\fIoption value ...\fR? ' Formats the border and background colors of the cells in the range (\fIx1\fR,\fIy1\fR) to (\fIx2\fR,\fIy2\fR). This command draws rectangles in these cells to achieve various formatting effects. The size and location of the rectangles are controlled by the \fB-xon\fR, \fB-xoff\fR, \fB-yon\fR and \fB-yoff\fR options (see below.) \fItype\fR may be \fBborder\fR or \fBgrid\fR. The \fBborder\fR formats the region with 3D borders. The \fBgrid\fR formats the region into a set of grids that do not display 3D borders. The following options may be passed in \fIoption-value\fR pairs to configure the properties of the formatting of the cells within the range. ' .RS .TP \fB\-background\fR \fIcolor\fR ' Gives the background color of the cells and the 3D borders. ' .TP \fB\-borderwidth\fR \fIpixels\fR ' Gives the with of the 3D borders or the grid borders. ' .TP \fB\-filled\fR \fIboolean\fR ' Specifies whether the background of the cells should be affected by the \fB\-background\fR option. When set the false (the default), the \fB\-background\fR option affects only the 3D border of the cells. ' .TP \fB\-xon\fR \fIint\fR \fB\-xoff\fR \fIint\fR ' These two options controls the size and location of the rectangles in the horizontal dimension. If \fB\-xon\fR is set to 0, the width of the rectangles will span the whole region. Specifically, if both \fB\-xon\fR and \fB\-yon\fR are set to 0, the \fBformat\fR command draws a single rectangle that surrounds the whole region given by (\fIx1\fR,\fIy1\fR) and (\fIx2\fR,\fIy2\fR). If \fB\-xon\fR is non-zero, the \fBformat\fR command starts at cell (\fIx1\fR,\fIy1\fR), draws a rectangle that spans the the width of the number of cells given by \fB\-xon\fR, skips the number of cells given by \fB\-xoff\fR, and it repeats the process until it reaches (\fIx2\fR,\fIy2\fR). ' .TP \fB\-yon\fR \fIint\fR \fB\-yoff\fR \fIint\fR ' These two options controls the size and location of the rectangles in the vertical dimension. See \fB\-xon\fR and \fB\-xoff\fR above. ' .RE The \fBformat\fR command may be called only inside the Tcl procedure specified in the \fB\-formatcmd\fR option. ' .TP \fIpathName \fBset \fIx y -itemtype type \fR?\fIoption value ...\fR? ' Creates a display item of \fItype\fR in the cell at location (\fIx\fR,\fIy\fR). Extra options may be passed in \fIoption-value\fR pairs to configure the properties of the display item. See \fBDItem(n)\fR for a description on display items. ' '---------------------------------------------------------------------- .SH KEYWORDS Tix(n), Grid Widget, Display Items