NAME

Tk::TixGrid - Create and manipulate Tix Grid widgets

SYNOPSIS

$tixgrid = $parent->TixGrid?(options)?;

STANDARD OPTIONS

-background -borderwidth -cursor -font -foreground -height -highlightbackground -highlightcolor -highlightthickness -padx -pady -relief -selectbackground -selectborderwidth -selectforeground -state -takefocus -width -xscrollcommand -yscrollcommand

See Tk::options for details of the standard options.

WIDGET-SPECIFIC OPTIONS

Undocumented (also in Tix manpage): -floatingcols (=0), -floatingrows (=0), -itemtype (=text), -sizecmd (=undef),

Name: editDoneCmd

Class: EditDoneCmd

Switch: -editdonecmd

If defined, gives a perl/Tk callback to be executed when the user has edited grid cell. When this callback is called, it is passed with two additional parameters: x y, where (x,y) is the location of the cell that has just been edited.

Name: editNotifyCmd

Class: EditNotifyCmd

Switch: -editnotifycmd

If defined gives a perl/Tk callback to be executed when the user tries to edit a grid cell. When this callback is called, it is passed with two additional parameters: x y, where (x,y,) is the location of the cell. This callback should return a boolean value: true indicates that the cell is editable and false otherwise.

Name: formatCmd

Class: FormatCmd

Switch: -formatcmd

If defined, gives a perl/Tk callback to be executed when the grid cells need to be formatted on the screen. Normally, this callback calls the format method (see below). When this callback is called, it is passed with five additional parameters: type x1 y1 x2 y2. type gives the logical type of the region in the grid. It may be one of the following.

x-region

the horizontal margin

y-region

the vertical margin

s-region

the area where the the horizontal and vertical margins are joined

main

all the cells that do not fall into the above three types

x1 y1 x2 y2 gives the extent of the region that needs formatting.

Name: leftMargin

Class: LeftMargin

Switch: -leftmargin

In the number of cells, gives the width of vertical margin. A zero indicates that no vertical should be drawn.

Name: selectMode

Class: SelectMode

Switch: -selectmode

Specifies one of several styles for manipulating the selection. The value of the option may be arbitrary, but the default bindings expect it to be either single, browse, multiple, or extended; the default value is single.

Name: selectUnit

Class: SelectUnit

Switch: -selectunit

Specifies the selection unit. Valid values are cell, column or row.

Name: topMargin

Class: TopMargin

Switch: -topmargin

In the number of cells, gives the height of horizontal margin. A zero indicates that no horizontal should be drawn.

DESCRIPTION

The TixGrid method creates a TixGrid new window and returns a blessed reference of this TixGrid widget. Additional options, described above, may be specified on the command line or in the option database to configure aspects of the TixGrid widget such as its cursor and relief.

A Grid widget displays its contents in a two dimensional grid of cells. Each cell may contain one Tix display item, which may be in text, graphics or other formats. See Tk::DItem 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.

WIDGET METHODS

The TixGrid method creates a TixGrid widget and returns a blessed reference of this TixGrid widget. This reference may be used to invoke various operations on the widget. It has the following general form:

$tixgrid->method?(arg, arg, ...)?

args determine the exact behavior of the method. The following methods are possible for TixGrid widgets:

$tixgrid->anchor(option?, args, ...?)

Manipulates the anchor cell of the TixGrid widget. The anchor cell is the end of the selection that is fixed while the user is dragging out a selection with the mouse.

$tixgrid->bdtype

????

$tixgrid->cget('-option')

Returns the current value of the configuration option given by -option. -option may have any of the values accepted by the TixGrid constructor method.

$tixgrid->configure(?-option??=>value, -option=>value, ...?)

Query or modify the configuration options of the widget. If no -option is specified, returns a list describing all of the available options for $tixgrid (see Tk_ConfigureInfo for information on the format of this list.) If -option is specified with no value, then the method returns a list describing the one named option (this list will be identical to the corresponding sublist of the value returned if no -option is specified). If one or more option-value pairs are specified, then the method modifies the given widget option(s) to have the given value(s); in this case the method returns an empty string. -option may have any of the values accepted by the TixGrid constructor method.

$tixgrid->delete(dim, from?, to?)

$tixgrid->deleteColumn(from?, to?)

$tixgrid->deleteRow(from?, to?)

Dim may be row or column. If to is not given, deletes a single row (or column) at the position from. If to is given, deletes the range of rows (or columns) from position from through to.

$tixgrid->editApply

If any cell is being edited, de-highlight the cell and applies the changes.

$tixgrid->editSet(x, y)

Highlights the cell at (x,y) for editing, if the -editnotify callback returns true for this cell.

$tixgrid->entrycget(x, y, '-option')

Returns the current value of the configuration option given by -option of the cell at (x,y). -option may have any of the values accepted by the set method.

$tixgrid->entryconfigure(x, y?, -option??=>value, -option=>value, ...?)

Query or modify the configuration options of the cell at (x,y). If no -option is specified, returns a list describing all of the available options for the cell (see Tk_ConfigureInfo for information on the format of this list.) If -option is specified with no value, then the method returns a list describing the one named option (this list will be identical to the corresponding sublist of the value returned if no -option is specified.) If one or more option-value pairs are specified, then the method modifies the given widget option(s) to have the given value(s); in this case the method returns an empty string. Option may have any of the values accepted by the set method.

$tixgrid->format =item $tixgrid->formatBorder(x1,y1, x2,y2, options); =item $tixgrid->formatGrid(x1,y1, x2,y2, options);

???

the format method can only be called by the -formatcmd callback of the tixGrid widget.

$tixgrid->index

???

$tixgrid->move(dim, from, to, offset)

$tixgrid->moveColumn(from, to, offset)

$tixgrid->moveRow(from, to, offset)

Dim may be row or column. Moves the the range of rows (or columns) from position from through to by the distance indicated by offset. For example, $tixgrid->moveRow(2, 4, 1) moves the rows 2,3,4 to rows 3,4,5.

$tixgrid->set(x, y?, -itemtype=>type??, -option=>value, ...?)

Creates a new display item at the cell at (x,y). The optional -itemtype parameter gives the type of the display item. An additional list of option-value pairs specify options of the display item. If a display item already exists at this cell, the old item will be deleted automatically.

$tixgrid->size(dim, index?, -option??=>value, ...?)

$tixgrid->sizeColumn(index?, -option??=>value, ...?)

$tixgrid->sizeRow(index?, -option??=>value, ...?)

Queries or sets the size of the row or column given by dim and index. Dim may be row or column. Index may be any non-negative integer that gives the position of a given row (or column). Index can also be the string default; in this case, this method queries or sets the default size of all rows (or columns). When no option-value pair is given, this method returns a list containing the current size setting of the given row (or column). When option-value pairs are given, the corresponding options of the size setting of the given row are changed. -option may be one of the following:

-pad0 => pixels

Specifies the paddings to the left or a column or the top of a row.

-pad1 => pixels

Specifies the paddings to the right or a column or the bottom of a row.

-size => val

Specifies the width of a column or the height of a row. Val may be: auto -- the width of the column is set the the widest cell in the column; a valid Tk screen distance unit (see Tk_GetPixels); or a real number following by the word chars (e.g. 3.4chars) that sets the width of the column to the given number of characters.

$tixgrid->unset(x, y)

Clears the cell at (x,y) by removing its display item.

$tixgrid->xview

????

$tixgrid->yview

????

BINDINGS

to be done.

SEE ALSO

Tk::DItem Tk::callbacks

BUGS

Default bindings not implemented.

KEYWORDS

tix, tixgrid, table, display item, spreadsheet