Initial commit of OpenSPARC T2 design and verification files.
[OpenSPARC-T2-DV] / tools / perl-5.8.0 / man / man3 / Tk::TixGrid.3
CommitLineData
86530b38
AT
1.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sh \" Subsection heading
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
13.de Sp \" Vertical space (when we can't use .PP)
14.if t .sp .5v
15.if n .sp
16..
17.de Vb \" Begin verbatim text
18.ft CW
19.nf
20.ne \\$1
21..
22.de Ve \" End verbatim text
23.ft R
24.fi
25..
26.\" Set up some character translations and predefined strings. \*(-- will
27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28.\" double quote, and \*(R" will give a right double quote. | will give a
29.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31.\" expand to `' in nroff, nothing in troff, for use with C<>.
32.tr \(*W-|\(bv\*(Tr
33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34.ie n \{\
35. ds -- \(*W-
36. ds PI pi
37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
39. ds L" ""
40. ds R" ""
41. ds C` ""
42. ds C' ""
43'br\}
44.el\{\
45. ds -- \|\(em\|
46. ds PI \(*p
47. ds L" ``
48. ds R" ''
49'br\}
50.\"
51.\" If the F register is turned on, we'll generate index entries on stderr for
52.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53.\" entries marked with X<> in POD. Of course, you'll have to process the
54.\" output yourself in some meaningful fashion.
55.if \nF \{\
56. de IX
57. tm Index:\\$1\t\\n%\t"\\$2"
58..
59. nr % 0
60. rr F
61.\}
62.\"
63.\" For nroff, turn off justification. Always turn off hyphenation; it makes
64.\" way too many mistakes in technical documents.
65.hy 0
66.if n .na
67.\"
68.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69.\" Fear. Run. Save yourself. No user-serviceable parts.
70. \" fudge factors for nroff and troff
71.if n \{\
72. ds #H 0
73. ds #V .8m
74. ds #F .3m
75. ds #[ \f1
76. ds #] \fP
77.\}
78.if t \{\
79. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80. ds #V .6m
81. ds #F 0
82. ds #[ \&
83. ds #] \&
84.\}
85. \" simple accents for nroff and troff
86.if n \{\
87. ds ' \&
88. ds ` \&
89. ds ^ \&
90. ds , \&
91. ds ~ ~
92. ds /
93.\}
94.if t \{\
95. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
101.\}
102. \" troff and (daisy-wheel) nroff accents
103.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110.ds ae a\h'-(\w'a'u*4/10)'e
111.ds Ae A\h'-(\w'A'u*4/10)'E
112. \" corrections for vroff
113.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115. \" for low resolution devices (crt and lpr)
116.if \n(.H>23 .if \n(.V>19 \
117\{\
118. ds : e
119. ds 8 ss
120. ds o a
121. ds d- d\h'-1'\(ga
122. ds D- D\h'-1'\(hy
123. ds th \o'bp'
124. ds Th \o'LP'
125. ds ae ae
126. ds Ae AE
127.\}
128.rm #[ #] #H #V #F C
129.\" ========================================================================
130.\"
131.IX Title "TIXGRID 1"
132.TH TIXGRID 1 "2000-12-30" "perl v5.8.0" "User Contributed Perl Documentation"
133.SH "NAME"
134Tk::TixGrid \- Create and manipulate Tix Grid widgets
135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS"
137\&\ \fI$tixgrid\fR = \fI$parent\fR\->\fBTixGrid\fR?(\fIoptions\fR)?;
138.PP
139.Vb 2
140\& The port of C code and bindings is done but needs
141\& debugging. THERE ARE KNOWN BUGS. Work in progress ...
142.Ve
143.SH "STANDARD OPTIONS"
144.IX Header "STANDARD OPTIONS"
145\&\fB\-background\fR
146 \fB\-borderwidth\fR
147 \fB\-cursor\fR
148 \fB\-font\fR
149 \fB\-foreground\fR
150 \fB\-height\fR
151 \fB\-highlightbackground\fR
152 \fB\-highlightcolor\fR
153 \fB\-highlightthickness\fR
154 \fB\-padx\fR
155 \fB\-pady\fR
156 \fB\-relief\fR
157 \fB\-selectbackground\fR
158 \fB\-selectborderwidth\fR
159 \fB\-selectforeground\fR
160 \fB\-state\fR
161 \fB\-takefocus\fR
162 \fB\-width\fR
163 \fB\-xscrollcommand\fR
164 \fB\-yscrollcommand\fR
165.PP
166See Tk::options for details of the standard options.
167.SH "WIDGET-SPECIFIC OPTIONS"
168.IX Header "WIDGET-SPECIFIC OPTIONS"
169.IP "Name: \fBbrowseCmd\fR" 4
170.IX Item "Name: browseCmd"
171.PD 0
172.IP "Class: \fBBrowseCmd\fR" 4
173.IX Item "Class: BrowseCmd"
174.IP "Switch: \fB\-browsecmd\fR" 4
175.IX Item "Switch: -browsecmd"
176.PD
177?docu here? Not in configure output but used in bindings ??!!
178.Sp
179If defined, gives a perl/Tk callback
180to be executed when the
181user browses a grid cell (This is normally the case when
182the user clicks on an entry). When this callback is called, it is
183passed with two additional parameters: \fIx\fR \fIy\fR, where (\fIx\fR,\fIy\fR)
184is the location of the cell that has just been clicked.
185.IP "Name: \fBCommand\fR" 4
186.IX Item "Name: Command"
187.PD 0
188.IP "Class: \fBCommand\fR" 4
189.IX Item "Class: Command"
190.IP "Switch: \fB\-command\fR" 4
191.IX Item "Switch: -command"
192.PD
193?docu here? Not in configure output but used in bindings ??!!
194.IP "Name: \fBeditDoneCmd\fR" 4
195.IX Item "Name: editDoneCmd"
196.PD 0
197.IP "Class: \fBEditDoneCmd\fR" 4
198.IX Item "Class: EditDoneCmd"
199.IP "Switch: \fB\-editdonecmd\fR" 4
200.IX Item "Switch: -editdonecmd"
201.PD
202If defined, gives a perl/Tk callback
203to be executed when the
204user has edited grid cell. When this callback is called, it is
205passed with two additional parameters: \fIx\fR \fIy\fR, where (\fIx\fR,\fIy\fR)
206is the location of the cell that has just been edited.
207.IP "Name: \fBeditNotifyCmd\fR" 4
208.IX Item "Name: editNotifyCmd"
209.PD 0
210.IP "Class: \fBEditNotifyCmd\fR" 4
211.IX Item "Class: EditNotifyCmd"
212.IP "Switch: \fB\-editnotifycmd\fR" 4
213.IX Item "Switch: -editnotifycmd"
214.PD
215If defined gives a perl/Tk callback
216to be executed when the user tries to edit a grid cell.
217When this callback is called, it is passed with two additional
218parameters: \fIx\fR \fIy\fR, where (\fIx\fR,\fIy\fR,) is the location
219of the cell. This callback should return a boolean value: \fBtrue\fR
220indicates that the cell is editable and \fBfalse\fR otherwise.
221.IP "Name: \fBFloatingCols\fR" 4
222.IX Item "Name: FloatingCols"
223.PD 0
224.IP "Class: \fBfloatingCols\fR" 4
225.IX Item "Class: floatingCols"
226.IP "Switch: \fB\-floatingcols\fR" 4
227.IX Item "Switch: -floatingcols"
228.PD
229Defines the number of columns that fixed when the widget
230is horizontally scrolled. These column(s)
231can be used as label(s) for the column(s). The floating column(s)
232can be configured in the \fB\-formatcmd\fR callback with the
233\&\fBformatBorder\fR method. The default value is 0.
234.IP "Name: \fBFloatingRows\fR" 4
235.IX Item "Name: FloatingRows"
236.PD 0
237.IP "Class: \fBfloatingRows\fR" 4
238.IX Item "Class: floatingRows"
239.IP "Switch: \fB\-floatingrows\fR" 4
240.IX Item "Switch: -floatingrows"
241.PD
242Defines the number of rows that are fixed when the widget
243is vertically scrolled. These row(s)
244can be used as label(s) for the row(s). The floating row(s)
245can be configured in the \fB\-formatcmd\fR callback with the
246\&\fBformatBorder\fR method. The default value is 0.
247.IP "Name: \fBformatCmd\fR" 4
248.IX Item "Name: formatCmd"
249.PD 0
250.IP "Class: \fBFormatCmd\fR" 4
251.IX Item "Class: FormatCmd"
252.IP "Switch: \fB\-formatcmd\fR" 4
253.IX Item "Switch: -formatcmd"
254.PD
255If defined, gives a perl/Tk callback to be
256executed when the grid cells need to be formatted on the screen.
257Normally, this callback calls the \fBformat\fR method (see below).
258When this callback is called, it is passed with five additional
259parameters: \fItype\fR \fIx1\fR \fIy1\fR \fIx2\fR \fIy2\fR. \fItype\fR gives the
260logical type of the region in the grid. It may be one of the
261following.
262.RS 4
263.IP "\fBx\-region\fR" 8
264.IX Item "x-region"
265the horizontal margin
266.IP "\fBy\-region\fR" 8
267.IX Item "y-region"
268the vertical margin
269.IP "\fBs\-region\fR" 8
270.IX Item "s-region"
271the area where the horizontal and vertical margins are joined
272.IP "\fBmain\fR" 8
273.IX Item "main"
274all the cells that do not fall into the above three types
275.RE
276.RS 4
277.Sp
278\&\fIx1\fR \fIy1\fR \fIx2\fR \fIy2\fR gives the extent of the region that needs
279formatting.
280.RE
281.IP "Name: \fBleftMargin\fR" 4
282.IX Item "Name: leftMargin"
283.PD 0
284.IP "Class: \fBLeftMargin\fR" 4
285.IX Item "Class: LeftMargin"
286.IP "Switch: \fB\-leftmargin\fR" 4
287.IX Item "Switch: -leftmargin"
288.PD
289In the number of cells, gives the width of vertical margin.
290A zero indicates that no vertical should be drawn.
291.IP "Name: \fBitemType\fR" 4
292.IX Item "Name: itemType"
293.PD 0
294.IP "Class: \fBItemType\fR" 4
295.IX Item "Class: ItemType"
296.IP "Switch: \fB\-itemtype\fR" 4
297.IX Item "Switch: -itemtype"
298.PD
299?docu here?
300.IP "Name: \fBselectMode\fR" 4
301.IX Item "Name: selectMode"
302.PD 0
303.IP "Class: \fBSelectMode\fR" 4
304.IX Item "Class: SelectMode"
305.IP "Switch: \fB\-selectmode\fR" 4
306.IX Item "Switch: -selectmode"
307.PD
308Specifies one of several styles for manipulating the selection.
309The value of the option may be arbitrary, but the default bindings
310expect it to be either \fBsingle\fR, \fBbrowse\fR, \fBmultiple\fR, or \fBextended\fR;
311the default value is \fBsingle\fR.
312.IP "Name: \fBselectUnit\fR" 4
313.IX Item "Name: selectUnit"
314.PD 0
315.IP "Class: \fBSelectUnit\fR" 4
316.IX Item "Class: SelectUnit"
317.IP "Switch: \fB\-selectunit\fR" 4
318.IX Item "Switch: -selectunit"
319.PD
320Specifies the selection unit. Valid values are \fBcell\fR, \fBcolumn\fR or \fBrow\fR.
321.IP "Name: \fBsizeCmd\fR" 4
322.IX Item "Name: sizeCmd"
323.PD 0
324.IP "Class: \fBSizeCmd\fR" 4
325.IX Item "Class: SizeCmd"
326.IP "Switch: \fB\-sizecmd\fR" 4
327.IX Item "Switch: -sizecmd"
328.PD
329?docu here?
330.IP "Name: \fBtopMargin\fR" 4
331.IX Item "Name: topMargin"
332.PD 0
333.IP "Class: \fBTopMargin\fR" 4
334.IX Item "Class: TopMargin"
335.IP "Switch: \fB\-topmargin\fR" 4
336.IX Item "Switch: -topmargin"
337.PD
338In the number of cells, gives the height of horizontal margin.
339A zero indicates that no horizontal should be drawn.
340.SH "DESCRIPTION"
341.IX Header "DESCRIPTION"
342The \fBTixGrid\fR method creates a TixGrid new window and returns a
343blessed reference of this TixGrid widget.
344Additional options,
345described above, may be specified on the command line or in the
346option database to configure aspects of the \fBTixGrid\fR widget
347such as its cursor and relief.
348.PP
349A Grid widget displays its contents in a two dimensional grid of cells.
350Each cell may contain one Tix display item, which may be in text,
351graphics or other formats. See Tk::DItem for more information
352about Tix display items. Individual cells, or groups of cells,
353can be formatted with a wide range of attributes, such as its color,
354relief and border.
355.SH "WIDGET METHODS"
356.IX Header "WIDGET METHODS"
357The \fBTixGrid\fR method creates a TixGrid widget and returns a blessed
358reference of this TixGrid widget. This reference may be used to
359invoke various operations on the widget. It has the following general
360form:
361.PP
362\&\ \fI$tixgrid\fR\->\fBmethod\fR?(\fIarg, arg, ...\fR)?
363.PP
364\&\fIarg\fRs determine the exact behavior of the method. The following
365methods are possible for \fBTixGrid\fR widgets:
366.IP "\fI$tixgrid\fR\->\fBanchor\fR(\fIaction\fR, \fIx\fR, \fIy\fR)" 4
367.IX Item "$tixgrid->anchor(action, x, y)"
368.PD 0
369.IP "\fI$tixgrid\fR\->\fBanchor\fR\fIAction\fR(\fIx\fR, \fIy\fR)" 4
370.IX Item "$tixgrid->anchorAction(x, y)"
371.PD
372Manipulates the \fBanchor cell\fR of the \fBTixGrid\fR widget.
373The anchor cell is the end of the selection that is fixed
374while the user is dragging out a selection with the mouse.
375\&\fIAction\fR can be \fBclear\fR, \fBget\fR or \fBset\fR. If \fIaction\fR
376is \fBclear\fR, \fIx\fR and \fIy\fR args are not accepted.
377.IP "\fI$tixgrid\fR\->\fBbdtype\fR(\fIx\fR, \fIy\fR ?,\fIxbdWidth\fR, \fIybdWidth\fR?)" 4
378.IX Item "$tixgrid->bdtype(x, y ?,xbdWidth, ybdWidth?)"
379????
380.IP "\fI$tixgrid\fR\->\fBcget\fR('\fI\-option\fR')" 4
381.IX Item "$tixgrid->cget('-option')"
382Returns the current value of the configuration option given
383by \fI\-option\fR. \fI\-option\fR may have any of the values accepted
384by the \fBTixGrid\fR constructor method.
385.IP "\fI$tixgrid\fR\->\fBconfigure\fR(?\fI\-option\fR??=>\fIvalue\fR, \fI\-option\fR=>\fIvalue\fR, \fI...\fR?)" 4
386.IX Item "$tixgrid->configure(?-option??=>value, -option=>value, ...?)"
387Query or modify the configuration options of the widget.
388If no \fI\-option\fR is specified, returns a list describing all
389of the available options for \fI$tixgrid\fR (see \fBTk_ConfigureInfo\fR
390for information on the format of this list.) If \fI\-option\fR is
391specified with no \fIvalue\fR, then the method returns a list describing
392the one named option (this list will be identical to the corresponding
393sublist of the value returned if no \fI\-option\fR is specified).
394If one or more \fIoption-value\fR pairs are specified, then the
395method modifies the given widget option(s) to have the given value(s);
396in this case the method returns an empty string. \fI\-option\fR may have
397any of the values accepted by the \fBTixGrid\fR constructor method.
398.IP "\fI$tixgrid\fR\->\fBdelete\fR(\fIdim\fR, \fIfrom\fR?, \fIto\fR?)" 4
399.IX Item "$tixgrid->delete(dim, from?, to?)"
400.PD 0
401.IP "\fI$tixgrid\fR\->\fBdeleteColumn\fR(\fIfrom\fR?, \fIto\fR?)" 4
402.IX Item "$tixgrid->deleteColumn(from?, to?)"
403.IP "\fI$tixgrid\fR\->\fBdeleteRow\fR(\fIfrom\fR?, \fIto\fR?)" 4
404.IX Item "$tixgrid->deleteRow(from?, to?)"
405.PD
406\&\fIDim\fR may be \fBrow\fR or \fBcolumn\fR. If \fIto\fR is not given,
407deletes a single row (or column) at the position \fIfrom\fR.
408If \fIto\fR is given, deletes the range of rows (or columns)
409from position \fIfrom\fR through \fIto\fR.
410.IP "\fI$tixgrid\fR\->\fBdragsite\fR(\fIoption\fR, \fIx\fR, \fIy\fR)" 4
411.IX Item "$tixgrid->dragsite(option, x, y)"
412?docu here? not implemented :\-(
413.IP "\fI$tixgrid\fR\->\fBdropsite\fR(\fIoption\fR, \fIx\fR, \fIy\fR)" 4
414.IX Item "$tixgrid->dropsite(option, x, y)"
415?docu here? not implemented :\-(
416.IP "\fI$tixgrid\fR\->\fBeditApply\fR" 4
417.IX Item "$tixgrid->editApply"
418If any cell is being edited, de-highlight the cell and
419applies the changes.
420.IP "\fI$tixgrid\fR\->\fBeditSet\fR(\fIx\fR, \fIy\fR)" 4
421.IX Item "$tixgrid->editSet(x, y)"
422Highlights the cell at (\fIx\fR,\fIy\fR) for editing,
423if the \fB\-editnotify\fR callback returns true for this cell.
424.IP "\fI$tixgrid\fR\->\fBentrycget\fR(\fIx\fR, \fIy\fR, '\fI\-option\fR')" 4
425.IX Item "$tixgrid->entrycget(x, y, '-option')"
426Returns the current value of the configuration option given by
427\&\fI\-option\fR of the cell at (\fIx\fR,\fIy\fR). \fI\-option\fR may have any
428of the values accepted by the \fBset\fR method.
429.IP "\fI$tixgrid\fR\->\fBentryconfigure\fR(\fIx\fR, \fIy\fR?, \fI\-option\fR??=>\fIvalue\fR, \fI\-option\fR=>\fIvalue\fR, \fI...\fR?)" 4
430.IX Item "$tixgrid->entryconfigure(x, y?, -option??=>value, -option=>value, ...?)"
431Query or modify the configuration options of the cell at (\fIx\fR,\fIy\fR).
432If no \fI\-option\fR is specified, returns a list describing all of the
433available options for the cell (see \fBTk_ConfigureInfo\fR for information
434on the format of this list.) If \fI\-option\fR is specified with no
435\&\fIvalue\fR, then the method returns a list describing the one named
436option (this list will be identical to the corresponding sublist
437of the value returned if no \fI\-option\fR is specified.) If one or
438more \fIoption-value\fR pairs are specified, then the method modifies
439the given widget option(s) to have the given value(s); in this case
440the method returns an empty string. \fIOption\fR may have any of the
441values accepted by the \fBset\fR method.
442.IP "\fI$tixgrid\fR\->\fBformat\fR(\fIoption\fR, ?\fIargs\fR, ...?)" 4
443.IX Item "$tixgrid->format(option, ?args, ...?)"
444.PD 0
445.IP "\fI$tixgrid\fR\->\fBformatBorder\fR(\fIx1,y1\fR, \fIx2,y2\fR, \fIoptions\fR);" 4
446.IX Item "$tixgrid->formatBorder(x1,y1, x2,y2, options);"
447.IP "\fI$tixgrid\fR\->\fBformatGrid\fR(\fIx1,y1\fR, \fIx2,y2\fR, \fIoptions\fR);" 4
448.IX Item "$tixgrid->formatGrid(x1,y1, x2,y2, options);"
449.PD
450the \fBformat\fR method can only be called by the \fB\-formatcmd\fR callback
451of the tixGrid widget.
452.Sp
453?docu complete?
454.IP "\fI$tixgrid\fR\->\fBgeometryinfo\fR(?\fIwidth\fR, ?\fIheight\fR, ...?)" 4
455.IX Item "$tixgrid->geometryinfo(?width, ?height, ...?)"
456?docu here? Return a list of 4 floats! Currently \*(L"{first1 last1} {first2,last2}\*(R" :\-(
457.IP "\fI$tixgrid\fR\->\fBindex\fR(\fI$coordx\fR, \fI$coordy\fR)" 4
458.IX Item "$tixgrid->index($coordx, $coordy)"
459?docu here?
460.Sp
461retuns \fI(nx, ny)\fR of entry at position (\fI$coordx\fR, \fI$coordy\fR).
462(??widget or screen offset??)
463.IP "\fI$tixgrid\fR\->\fBinfo\fR(\fIoption\fR, ?\fIargs\fR, ...?)" 4
464.IX Item "$tixgrid->info(option, ?args, ...?)"
465?docu here?
466.IP "\fI$tixgrid\fR\->\fBmove\fR(\fIdim\fR, \fIfrom\fR, \fIto\fR, \fIoffset\fR)" 4
467.IX Item "$tixgrid->move(dim, from, to, offset)"
468.PD 0
469.IP "\fI$tixgrid\fR\->\fBmoveColumn\fR(\fIfrom\fR, \fIto\fR, \fIoffset\fR)" 4
470.IX Item "$tixgrid->moveColumn(from, to, offset)"
471.IP "\fI$tixgrid\fR\->\fBmoveRow\fR(\fIfrom\fR, \fIto\fR, \fIoffset\fR)" 4
472.IX Item "$tixgrid->moveRow(from, to, offset)"
473.PD
474\&\fIDim\fR may be \fBrow\fR or \fBcolumn\fR. Moves the range of rows
475(or columns) from position \fIfrom\fR through \fIto\fR by the distance
476indicated by \fIoffset\fR. For example,
477\&\fI$tixgrid\fR\->\fBmoveRow\fR(\fB2\fR, \fB4\fR, \fB1\fR) moves the rows 2,3,4
478to rows 3,4,5.
479.IP "\fI$tixgrid\fR\->\fBnearest\fR(\fIx\fR, \fIy\fR)" 4
480.IX Item "$tixgrid->nearest(x, y)"
481?docu here? screen pos (pixels) to entry (nx,ny) translation.
482.IP "\fI$tixgrid\fR\->\fBselection\fR(\fIoption\fR, \fIx1\fR, \fIy1\fR ?,\fIx2\fR, \fIy2\fR?)" 4
483.IX Item "$tixgrid->selection(option, x1, y1 ?,x2, y2?)"
484.PD 0
485.IP "\fI$tixgrid\fR\->\fBselection\fR\fIOption\fR(\fIx1\fR, \fIy1\fR ?,\fIx2\fR, \fIy2\fR?)" 4
486.IX Item "$tixgrid->selectionOption(x1, y1 ?,x2, y2?)"
487.PD
488Option one of: \fBadjust\fR, \fBclear\fR, \fBincludes\fR, \fBset\fR, and \fBtoggle\fR.
489.Sp
490x1 (y1) has not to be greater than x2 (y2), but only x2 and y2 can be 'max'.
491.Sp
492\&\s-1BUG:\s0 \fIselection includes\fR: has no visible effect (as in Tix). Eh???
493.Sp
494\&\s-1BUG:\s0 \fIselection clear\fR: only works for 0, 0, max, max (as in Tix). Eh???
495.Sp
496When \fIx2, y2\fR are not given they default to \fIx1, y1\fR, respectively.
497.RS 4
498.IP "\fI$tixgrid\fR\->\fBselectionAdjust\fR(\fIx1\fR, \fIy1\fR ?,\fIx2\fR, \fIy2\fR?)" 8
499.IX Item "$tixgrid->selectionAdjust(x1, y1 ?,x2, y2?)"
500?docu here?
501.IP "\fI$tixgrid\fR\->\fBselectionClear\fR(\fIx1\fR, \fIy1\fR ?,\fIx2\fR, \fIy2\fR?)" 8
502.IX Item "$tixgrid->selectionClear(x1, y1 ?,x2, y2?)"
503?docu here?
504.IP "\fI$tixgrid\fR\->\fBselectionIncludes\fR(\fIx1\fR, \fIy1\fR ?,\fIx2\fR, \fIy2\fR?)" 8
505.IX Item "$tixgrid->selectionIncludes(x1, y1 ?,x2, y2?)"
506?docu here?
507.IP "\fI$tixgrid\fR\->\fBselectionSet\fR(\fIx1\fR, \fIy1\fR ?,\fIx2\fR, \fIy2\fR?)" 8
508.IX Item "$tixgrid->selectionSet(x1, y1 ?,x2, y2?)"
509?docu here?
510.IP "\fI$tixgrid\fR\->\fBselectionToggle\fR(\fIx1\fR, \fIy1\fR ?,\fIx2\fR, \fIy2\fR?)" 8
511.IX Item "$tixgrid->selectionToggle(x1, y1 ?,x2, y2?)"
512?docu here?
513.RE
514.RS 4
515.RE
516.IP "\fI$tixgrid\fR\->\fBset\fR(\fIx\fR, \fIy\fR?, \fB\-itemtype\fR=>\fItype\fR??, \fI\-option\fR=>\fIvalue\fR, \fI...\fR?)" 4
517.IX Item "$tixgrid->set(x, y?, -itemtype=>type??, -option=>value, ...?)"
518Creates a new display item at the cell at (\fIx\fR,\fIy\fR). The optional
519\&\fB\-itemtype\fR parameter gives the type of the display item.
520An additional list of \fIoption-value\fR pairs specify options
521of the display item. If a display item already exists at this cell,
522the old item will be deleted automatically.
523.IP "\fI$tixgrid\fR\->\fBsize\fR(\fIdim\fR, \fIindex\fR?, \fI\-option\fR??=>\fIvalue\fR, \fI...\fR?)" 4
524.IX Item "$tixgrid->size(dim, index?, -option??=>value, ...?)"
525.PD 0
526.IP "\fI$tixgrid\fR\->\fBsizeColumn\fR(\fIindex\fR?, \fI\-option\fR??=>\fIvalue\fR, \fI...\fR?)" 4
527.IX Item "$tixgrid->sizeColumn(index?, -option??=>value, ...?)"
528.IP "\fI$tixgrid\fR\->\fBsizeRow\fR(\fIindex\fR?, \fI\-option\fR??=>\fIvalue\fR, \fI...\fR?)" 4
529.IX Item "$tixgrid->sizeRow(index?, -option??=>value, ...?)"
530.PD
531Queries or sets the size of the row or column given by \fIdim\fR and
532\&\fIindex\fR. \fIDim\fR may be \fBrow\fR or \fBcolumn\fR. \fIIndex\fR may be any
533non-negative integer that gives the position of a given row (or column).
534\&\fIIndex\fR can also be the string \fBdefault\fR; in this case, this method
535queries or sets the default size of all rows (or columns).
536When no \fIoption-value\fR pair is given, this method returns
537a list containing the current size setting of the given row (or column).
538When \fIoption-value\fR pairs are given, the corresponding options
539of the size setting of the given row are changed. \fI\-option\fR may be
540one of the following:
541.RS 4
542.IP "\fB\-pad0\fR => \fIpixels\fR" 8
543.IX Item "-pad0 => pixels"
544Specifies the paddings to the left of a column or the top of a row.
545.IP "\fB\-pad1\fR => \fIpixels\fR" 8
546.IX Item "-pad1 => pixels"
547Specifies the paddings to the right of a column or the bottom of a row.
548.IP "\fB\-size\fR => \fIval\fR" 8
549.IX Item "-size => val"
550Specifies the width of a column or the height of a row.
551\&\fIVal\fR may be: \fBauto\fR \*(-- the width of the column is set
552the widest cell in the column; a valid Tk screen distance
553unit (see \fBTk_GetPixels\fR); or a real number following by the
554word \fBchars\fR (e.g. \fB3.4chars\fR) that sets the width of the
555column to the given number of characters.
556.RE
557.RS 4
558.RE
559.IP "\fI$tixgrid\fR\->\fBsort\fR(\fIdimension\fR, \fIstart\fR, \fIend\fR, ?\fIargs ...\fR?)" 4
560.IX Item "$tixgrid->sort(dimension, start, end, ?args ...?)"
561?docu here? (not supported on Win* OSs up to now)
562.IP "\fI$tixgrid\fR\->\fBunset\fR(\fIx\fR, \fIy\fR)" 4
563.IX Item "$tixgrid->unset(x, y)"
564Clears the cell at (\fIx\fR,\fIy\fR) by removing its display item.
565.IP "\fI$tixgrid\fR\->\fBxview\fR" 4
566.IX Item "$tixgrid->xview"
567?docu here?
568.IP "\fI$tixgrid\fR\->\fByview\fR" 4
569.IX Item "$tixgrid->yview"
570?docu here?
571.SH "BINDINGS"
572.IX Header "BINDINGS"
573to be done.
574.SH "SEE ALSO"
575.IX Header "SEE ALSO"
576Tk::DItem
577Tk::callbacks
578Tk::FloatEntry
579.SH "BUGS"
580.IX Header "BUGS"
581C code and bindings of TixGrid have some bugs.
582.SH "KEYWORDS"
583.IX Header "KEYWORDS"
584tix, tixgrid, table, display item, spreadsheet