Tk::form 804.027

Tk::form is a Perl module with a geometry manager based on attachment rules.

SYNOPSIS

$widget->form?(args)?
$widget->formOption?(args)?

The form method is used to communicate with the form Geometry Manager, a geometry manager that arranges the geometry of the children in a parent window according to attachment rules. The form geometry manager is very flexible and powerful; it can be used to emulate all the existing features of the Tk packer and placer geometry managers (see pack, place). The form method can have any of several forms, depending on Option:

$slave->form?(options)?

Sets or adjusts the attachment values of the slave window according to the -option=>value argument pairs.

-b => attachment

Abbreviation for the -bottom option.

-bottom => attachment

Specifies an attachment for the bottom edge of the slave window. The attachment must specified according to "SPECIFYING ATTACHMENTS" below.

-bottomspring => weight

Specifies the weight of the spring at the bottom edge of the slave window. See "USING SPRINGS" below.

-bp => value

Abbreviation for the -padbottom option.

-bs => weight

Abbreviation for the -bottomspring option.

-fill => style

Specifies the fillings when springs are used for this widget. The value must be x, y, both or none.

-in => $master

Places the slave window into the specified $master window. If the slave was originally in another master window, all attachment values with respect to the original master window are discarded. Even if the attachment values are the same as in the original master window, they need to be specified again. The -in flag, when needed, must appear as the first flag of options. Otherwise an error is generated.

-l => attachment

Abbreviation for the -left option.

-left => attachment

Specifies an attachment for the left edge of the slave window. The attachment must specified according to "SPECIFYING ATTACHMENTS" below.

-leftspring => weight

Specifies the weight of the spring at the left edge of the slave window. See "USING SPRINGS" below.

-lp => value

Abbreviation for the -padleft option.

-ls => weight

Abbreviation for the -leftspring option.

-padbottom => value

Specifies the amount of external padding to leave on the bottom side of the slave. The value may have any of the forms acceptable to Tk_GetPixels.

-padleft => value

Specifies the amount of external padding to leave on the left side of the slave.

-padright => value

Specifies the amount of external padding to leave on the right side of the slave.

-padtop => value

Specifies the amount of external padding to leave on the top side of the slave.

-padx => value

Specifies the amount of external padding to leave on both the left and the right sides of the slave.

-pady => value

Specifies the amount of external padding to leave on both the top and the bottom sides of the slave.

-r => attachment

Abbreviation for the -right option.

-right => attachment

Specifies an attachment for the right edge of the slave window. The attachment must specified according to "SPECIFYING ATTACHMENTS" below.

-rightspring => weight

Specifies the weight of the spring at the right edge of the slave window. See "USING SPRINGS" below.

-rp => value

Abbreviation for the -padright option.

-rs => weight

Abbreviation for the -rightspring option.

-t => attachment

Abbreviation for the -top option.

-top => attachment

Specifies an attachment for the top edge of the slave window. The attachment must specified according to "SPECIFYING ATTACHMENTS" below.

-topspring => weight

Specifies the weight of the spring at the top edge of the slave window. See "USING SPRINGS" below.

-tp => value

Abbreviation for the -padtop option.

-ts => weight

Abbreviation for the -topspring option.

$master->formCheck

This method checks whether there is circular dependency in the attachments of the masters slaves (see "CIRCULAR DEPENDENCY" below). It returns the Boolean value TRUE if it discover circular dependency and FALSE otherwise.

$slave->formForget

Removes the slave from its master and unmaps its window. The slave will no longer be managed by form. All attachment values with respect to its master window are discarded. If another slave is attached to this slave, then the attachment of the other slave will be changed to grid attachment based on its geometry.

$master->formGrid?(x_size, y_size)?

When x_size and y_size are given, this method returns the number of grids of the $master window in a pair of integers of the form (x_size, y_size). When both x_size and y_size are given, this method changes the number of horizontal and vertical grids on the master window.

$slave->formInfo?(-option)?

Queries the attachment options of a slave window. -option can be any of the options accepted by the form method. If -option is given, only the value of that option is returned. Otherwise, this method returns a list whose elements are the current configuration state of the slave given in the same option-value form that might be specified to form. The first two elements in this list list are "-in=>$master" where $master is the slaves master window.

$master->formSlaves

Returns a list of all of the slaves for the master window. The order of the slaves in the list is the same as their order in the packing order. If master has no slaves then an empty string is returned.