1tixGrid(n)                   Tix Built-In Commands                  tixGrid(n)
2
3
4

NAME

6       tixGrid  -  Create and manipulate Tix Grid widgets -background    -bor‐
7       derWidth   -cursor     -font     -foreground    -height     -highlight‐
8       Color     -highlightThickness -relief  -selectBackground   -selectFore‐
9       ground   -width -xScrollCommand     -yScrollCommand
10

WIDGET-SPECIFIC OPTIONS

12       [-editdonecmd editDoneCmd] If non-empty, gives a Tcl command to be exe‐
13       cuted  when the user has edited grid cell. When this command is called,
14       it is passed with two additional parameters: x y, where  (x,y)  is  the
15       location  of the cell that has just been edited.  [-editnotifycmd edit‐
16       NotifyCmd] If non-empty, gives a Tcl command to be  executed  when  the
17       user  tries  to  edit  a  grid cell. When this command is called, it is
18       passed with two additional parameters: x y, where (x,y,) is  the  loca‐
19       tion  of  the  cell.  This  command should return a boolean value: true
20       indicates that the cells  is  editable  and  false  otherwise.   [-for‐
21       matcmd formatCmd] If non-empty, gives a Tcl command to be executed when
22       the grid cells need to be formatted on the screen. Normally, this  com‐
23       mand  calls the format widget command (see below). When this command is
24       called, it is passed with five additional parameters: type x1 y1 x2 y2.
25       type gives the logical type of the region in the grid. It may be one of
26       the following. x-region: the horizontal margin; y-region: the  vertical
27       margin;  s-region,  the area where the the horizontal and vertical mar‐
28       gins are joined; main: all the cells that do not fall  into  the  above
29       three  types.   x1  y1  x2 y2 gives the extent of the region that needs
30       formatting.  [-leftmargin leftMargin] In the number of cells, gives the
31       width  of  vertical margin. A zero indicates that no vertical should be
32       drawn.  [-selectmode selectMode] Specifies one of  several  styles  for
33       manipulating  the  selection. The value of the option may be arbitrary,
34       but the default bindings expect it to be either single, browse,  multi‐
35       ple,  or  extended; the default value is single.  [-selectunit selectU‐
36       nit] Specifies the selection unit. Valid values  are  cell,  column  or
37       row.   [-topmargin topMargin]  In the number of cells, gives the height
38       of horizontal margin. A zero indicates that  no  horizontal  should  be
39       drawn.
40

DESCRIPTION

42       The  tixGrid  command creates a new window (given by the pathName argu‐
43       ment)  and  makes  it  into  a  tixGrid  widget.   Additional  options,
44       described  above, may be specified on the command line or in the option
45       database to configure aspects of the tixGrid widget such as its  cursor
46       and relief.
47
48       A Grid widget displays its contents in a two dimensional grid of cells.
49       Each cell may contain one Tix display  item,  which  may  be  in  text,
50       graphics or other formats. See the tixDisplayStyle manual page for more
51       information about Tix display items. Individual  cells,  or  groups  of
52       cells,  can  be  formatted with a wide range of attributes, such as its
53       color, relief and border.
54

WIDGET COMMAND

56       The tixGrid command creates a new Tcl command whose name is the same as
57       the  path name of the tixGrid widget's window. This command may be used
58       to invoke various operations on the widget. It has the  following  gen‐
59       eral form:
60              pathName option ?arg arg ...?
61       PathName  is  the name of the command, which is the same as the tixGrid
62       widget's path name. Option and the args determine the exact behavior of
63       the command. The following commands are possible for tixGrid widgets:
64
65       pathName anchor option ?args ...?
66              Manipulates  the  anchor  cell of the tixGrid widget. The anchor
67              cell is the end of the selection that is fixed while the user is
68              dragging out a selection with the mouse.
69
70       pathName bdtype
71              TODO place holder
72
73       pathName cget option
74              Returns  the  current value of the configuration option given by
75              option. Option may have any of the values accepted by  the  tix‐
76              Grid command.
77
78       pathName configure ?option? ?value option value ...?
79              Query  or modify the configuration options of the widget.  If no
80              option is specified, returns a list describing all of the avail‐
81              able  options for pathName (see Tk_ConfigureInfo(n) for informa‐
82              tion on the format of this list.) If option is specified with no
83              value,  then the command returns a list describing the one named
84              option (this list will be identical to the corresponding sublist
85              of the value returned if no option is specified). If one or more
86              option-value pairs are specified, then the command modifies  the
87              given  widget option(s) to have the given value(s); in this case
88              the command returns an empty string. Option may have any of  the
89              values accepted by the tixGrid command.
90
91       pathName delete dim from ?to?
92              Dim  may  be row or column. If to is not given, deletes a single
93              row (or column) at the position from. If to  is  given,  deletes
94              the range of rows (or columns) from position from through to.
95
96       pathName edit apply
97              If  any  cell is being edited, de-highlight the cell and applies
98              the changes.
99
100       pathName edit set x y
101              Highlights the cell at (x,y) for  editing,  if  the  -editnotify
102              command returns true for this cell.
103
104       pathName entrycget x y option
105              Returns  the  current value of the configuration option given by
106              option of the cell at (x,y). Option may have any of  the  values
107              accepted by the set widget command.
108
109       pathName entryconfigure x y ?option? ?value option value ...?
110              Query  or modify the configuration options of the cell at (x,y).
111              If no option is specified, returns a list describing all of  the
112              available  options  for  the  cell  (see Tk_ConfigureInfo(n) for
113              information on the format of this list.)  If option is specified
114              with  no  value,  then the command returns a list describing the
115              one named option (this list will be identical to the correspond‐
116              ing sublist of the value returned if no option is specified.) If
117              one or more option-value pairs are specified, then  the  command
118              modifies  the given widget option(s) to have the given value(s);
119              in this case the command returns an empty  string.   Option  may
120              have any of the values accepted by the set widget command.
121
122       pathName format
123              TODO place holder
124
125       pathName index
126              TODO place holder
127
128       pathName move dim from to offset
129              Dim  may  be row or column. Moves the the range of rows (or col‐
130              umns) from position from through to by the distance indicated by
131              offset. For example, move row 2 4 1 moves the rows 2,3,4 to rows
132              3,4,5.
133
134       pathName set x y ?-itemtype type? ?option value...?
135              Creates a new display item at the cell at  (x,y).  The  optional
136              -itemtype parameter gives the type of the display item. An addi‐
137              tional list of option-value pairs specify options of the display
138              item.  If  a  display  item already exists at this cell, the old
139              item will be deleted automatically.
140
141       pathName size dim index ?option value ...?
142              Queries or sets the size of the row or column given by  dim  and
143              index.  Dim may be row or column.  Index may be any non-negative
144              integer that gives the position of  a  given  row  (or  column).
145              Index can also be the string default; in this case, this command
146              queries or sets the default size of all rows (or columns).
147
148       When no option-value pair is given, this command returns  a  list  con‐
149       taining  the  current  size  setting of the given row (or column). When
150       option-value pairs are given, the corresponding  options  of  the  size
151       setting  of  the  given row are changed. Option may be one of the foll‐
152       wing:
153
154              -pad0 pixels
155                     Specifies the paddings to the left or a column or the top
156                     of a row.
157
158              -pad1 pixels
159                     Specifies  the  paddings  to the right or a column or the
160                     bottom of a row.
161
162              -size val
163                     Specifies the width of a column or the height of  a  row.
164                     Val  may  be:  auto -- the width of the column is set the
165                     the widest cell in the column; a valid Tk screen distance
166                     unit (see Tk_GetPixels(n)); or a real number following by
167                     the word chars (e.g. 3.4chars) that sets the width of the
168                     column to the given number of characters.
169
170       pathName unset x y
171              Clears the cell at (x,y) by removing its display item.
172
173       pathName xview
174              TODO place holder
175
176       pathName yview
177              TODO place holder
178

KEYWORDS

180       grid, spread sheet, table
181
182
183
184
185
186
187
188Tix                                   4.1                           tixGrid(n)
Impressum