LabFrame(3) User Contributed Perl Documentation LabFrame(3)

# [NAME](#NAME)

Tk::LabFrame - labeled frame.

# [SYNOPSIS](#SYNOPSIS)

    **use Tk::LabFrame;**

    *$f* = *$parent*->**LabFrame**(?**-label**=>*text*, **-labelside**=>*where*, ...?);

# [DESCRIPTION](#DESCRIPTION)

**LabFrame** is exactly like **Frame** and additionaly allows to add a label to the frame.

# [WIDGET-OPTIONS](#WIDGET)

**LabFrame** supports the same options as the Frame widget.

Additional options of **LabFrame** are:

[**-font** => *font*](#font)

Specifies the label's font

[**-foreground** => *color*](#foreground)

Specifies the label's foreground color

[**-label** => *text*](#label)

The text of the label to be placed with the Frame.

[**-labelside** => *where*](#labelside)

*Where* can be one of **left**, **right**, **top**, **bottom** or **acrosstop**. The first four work as might be expected and place the label to the left, right, above or below the frame respectively. The **acrosstop** creates a grooved frame around the central frame and puts the label near the northwest corner such that it appears to "overwrite" the groove.

[**-labelvariable** => *scalar\_ref*](#labelvariable)

Specifies a reference to a variable and used as an alternative to -label. If the value of the variable changes, then the widget will be updated automatically to reflect the change. Used like -textvariable.

# [ADVERTISED SUBWIDGETS](#ADVERTISED_SUBWIDGETS)

See "Subwidget" in Tk::mega how to use advertised widgets.

[*border*](#border)

```
  Frame used to display the border
    
```

[*frame*](#frame)

```
  Frame used to create new LabFrame children.
    
```

[*label*](#label~2)

```
  Label used for displaying text
    
```

# [EXAMPLE](#EXAMPLE)

Run the following test program to see this in action:

```
    use strict;
    use Tk;
    require Tk::LabFrame;
    require Tk::LabEntry;
    my $test = 'Test this';
    my $mw = Tk::MainWindow->new;
    my $f = $mw->LabFrame(-label => "This is a label",
                           -labelside => "acrosstop");
    $f->LabEntry(-label => "Testing", -textvariable => \$test)->pack;
    $f->pack;
    Tk::MainLoop;
```

# [BUGS](#BUGS)

Perhaps **LabFrame** should be subsumed within the generic pTk labeled widget mechanism.

# [AUTHOR](#AUTHOR)

**Rajappa Iyer** rsi@earthling.net

This code is derived from LabFrame.tcl and LabWidg.tcl in the Tix4.0 distribution by Ioi Lam. The code may be redistributed under the same terms as Perl.

2026-10-25 perl v5.44.0

---

Document: Tk::LabFrame(3pm) from perl-tk 804.036-r12 (Chainguard OS)
Source: https://github.com/eserte/perl-tk