Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Contact Us
Online Help
Domain Status
Man Pages

Virtual Servers

Topology Map

Server Agreement
Year 2038

USA Flag



Man Pages

Manual Reference Pages  -  TK::LABELFRAME (3)

.ds Aq ’


Tk::Labelframe - Create and manipulate Labelframe widgets



$labelframe = $parent-><B>LabelframeB>(?options?);

 -borderwidth -highlightbackground -pady
 -cursor      -highlightcolor      -relief
 -font        -highlightthickness  -takefocus
 -foreground  -padx                -text


Option:        <B>-backgroundB>
Name:  <B>backgroundB>
Class: <B>BackgroundB> This option is the same as the standard <B>backgroundB> option except that its value may also be specified as an empty string. In this case, the widget will display no background or border, and no colors will be consumed from its colormap for its background and border.
Option:        <B>-classB>
Name:  <B>classB>
Class: <B>ClassB> Specifies a class for the window. This class will be used when querying the option database for the window’s other options, and it will also be used later for other purposes such as bindings. The <B>classB> option may not be changed with the <B>configureB> method.
Option:        <B>-colormapB>
Name:  <B>colormapB>
Class: <B>ColormapB> Specifies a colormap to use for the window. The value may be either <B>newB>, in which case a new colormap is created for the window and its children, or the name of another window (which must be on the same screen and have the same visual as $widget), in which case the new window will use the colormap from the specified window. If the <B>colormapB> option is not specified, the new window uses the same colormap as its parent. This option may not be changed with the <B>configureB> method.
Option:        <B>-containerB>
Name:  <B>containerB>
Class: <B>ContainerB> The value must be a boolean. If true, it means that this window will be used as a container in which some other application will be embedded (for example, a Tk toplevel can be embedded using the <B>-useB> option). The window will support the appropriate window manager protocols for things like geometry requests. The window should not have any children of its own in this application. This option may not be changed with the <B>configureB> method.
Option:        <B>-heightB>
Name:  <B>heightB>
Class: <B>HeightB> Specifies the desired height for the window in any of the forms acceptable to <B>Tk_GetPixelsB>. If this option is less than or equal to zero then the window will not request any size at all.
Option:        <B>-labelanchorB>
Name:  <B>labelAnchorB>
Class: <B>LabelAnchorB> Specifies where to place the label. A label is only displayed if the <B>-textB> option is not the empty string. Valid values for this option are (listing them clockwise) <B>nwB>, <B>nB>, <B>neB>, <B>enB>, <B>eB>, <B>esB>, <B>seB>, <B>sB>,<B>swB>, <B>wsB>, <B>wB> and <B>wnB>. The default value is <B>nwB>.
Option:        <B>-labelwidgetB>
Name:  <B>labelWidgetB>
Class: <B>LabelWidgetB> Specifies a widget to use as label. This overrides any <B>-textB> option. The widget must exist before being used as <B>-labelwidgetB> and if it is not a descendant of this window, it will be raised above it in the stacking order.
Option:        <B>-visualB>
Name:  <B>visualB>
Class: <B>VisualB> Specifies visual information for the new window in any of the forms accepted by <B>Tk_GetVisualB>. If this option is not specified, the new window will use the same visual as its parent. The <B>visualB> option may not be modified with the <B>configureB> method.
Option:        <B>-widthB>
Name:  <B>widthB>
Class: <B>WidthB> Specifies the desired width for the window in any of the forms acceptable to <B>Tk_GetPixelsB>. If this option is less than or equal to zero then the window will not request any size at all.


The <B>LabelframeB> method creates a new window (given by the $labelframe argument) and makes it into a Labelframe widget. Additional options, described above, may be specified on the command line or in the option database to configure aspects of the Labelframe such as its background color and relief.

A Labelframe is a simple widget. Its primary purpose is to act as a spacer or container for complex window layouts. It has the features of a <B>FrameB> plus the ability to display a label.


The <B>LabelframeB> method may be used to invoke various operations on the widget. It has the following general form:

 $widget->method(?arg arg ...?);

The following methods are possible for Labelframe widgets:
$widget-><B>cgetB>(option); Returns the current value of the configuration option given by option. Option may have any of the values accepted by the <B>LabelframeB> command.
$widget-><B>configureB>(?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 $widget (see Tk::configure for information on the format of this list). If option is specified with no value, then the command 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 command modifies the given widget option(s) to have the given value(s); in this case the command returns an empty string. Option may have any of the values accepted by the <B>LabelframeB> command.


When a new Labelframe is created, it has no default event bindings: Labelframes are not intended to be interactive.


Tk::Frame, Tk::Label


Labelframe, widget
Search for    or go to Top of page |  Section 3 |  Main Index

perl v5.20.3 LABELFRAME (3) 2013-11-15

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.