1Labelframe(3)         User Contributed Perl Documentation        Labelframe(3)
2
3
4

NAME

6       Tk::Labelframe - Create and manipulate Labelframe widgets
7

SYNOPSIS

9       $labelframe = $parent->Labelframe(?options?);
10
11        -borderwidth -highlightbackground -pady
12        -cursor      -highlightcolor      -relief
13        -font        -highlightthickness  -takefocus
14        -foreground  -padx                -text
15

WIDGET-SPECIFIC OPTIONS

17       Option:   -background
18       Name:     background
19       Class:    Background
20           This option is the same as the standard background option except
21           that its value may also be specified as an empty string.  In this
22           case, the widget will display no background or border, and no col‐
23           ors will be consumed from its colormap for its background and bor‐
24           der.
25
26       Option:   -class
27       Name:     class
28       Class:    Class
29           Specifies a class for the window.  This class will be used when
30           querying the option database for the window's other options, and it
31           will also be used later for other purposes such as bindings.  The
32           class option may not be changed with the configure method.
33
34       Option:   -colormap
35       Name:     colormap
36       Class:    Colormap
37           Specifies a colormap to use for the window.  The value may be
38           either new, in which case a new colormap is created for the window
39           and its children, or the name of another window (which must be on
40           the same screen and have the same visual as $widget), in which case
41           the new window will use the colormap from the specified window.  If
42           the colormap option is not specified, the new window uses the same
43           colormap as its parent.  This option may not be changed with the
44           configure method.
45
46       Option:   -container
47       Name:     container
48       Class:    Container
49           The value must be a boolean.  If true, it means that this window
50           will be used as a container in which some other application will be
51           embedded (for example, a Tk toplevel can be embedded using the -use
52           option).  The window will support the appropriate window manager
53           protocols for things like geometry requests.  The window should not
54           have any children of its own in this application.  This option may
55           not be changed with the configure method.
56
57       Option:   -height
58       Name:     height
59       Class:    Height
60           Specifies the desired height for the window in any of the forms
61           acceptable to Tk_GetPixels.  If this option is less than or equal
62           to zero then the window will not request any size at all.
63
64       Option:   -labelanchor
65       Name:     labelAnchor
66       Class:    LabelAnchor
67           Specifies where to place the label. A label is only displayed if
68           the -text option is not the empty string.  Valid values for this
69           option are (listing them clockwise) nw, n, ne, en, e, es, se, s,sw,
70           ws, w and wn.  The default value is nw.
71
72       Option:   -labelwidget
73       Name:     labelWidget
74       Class:    LabelWidget
75           Specifies a widget to use as label. This overrides any -text
76           option. The widget must exist before being used as -labelwidget and
77           if it is not a descendant of this window, it will be raised above
78           it in the stacking order.
79
80       Option:   -visual
81       Name:     visual
82       Class:    Visual
83           Specifies visual information for the new window in any of the forms
84           accepted by Tk_GetVisual.  If this option is not specified, the new
85           window will use the same visual as its parent.  The visual option
86           may not be modified with the configure method.
87
88       Option:   -width
89       Name:     width
90       Class:    Width
91           Specifies the desired width for the window in any of the forms
92           acceptable to Tk_GetPixels.  If this option is less than or equal
93           to zero then the window will not request any size at all.
94

DESCRIPTION

96       The Labelframe method creates a new window (given by the $labelframe
97       argument) and makes it into a Labelframe widget.  Additional options,
98       described above, may be specified on the command line or in the option
99       database to configure aspects of the Labelframe such as its background
100       color and relief.
101
102       A Labelframe is a simple widget.  Its primary purpose is to act as a
103       spacer or container for complex window layouts.  It has the features of
104       a Frame plus the ability to display a label.
105

WIDGET METHODS

107       The Labelframe method may be used to invoke various operations on the
108       widget.  It has the following general form:
109
110        $widget->method(?arg arg ...?);
111
112       The following methods are possible for Labelframe widgets:
113
114       $widget->cget(option);
115           Returns the current value of the configuration option given by
116           option.  Option may have any of the values accepted by the Label‐
117           frame command.
118
119       $widget->configure(?option?, ?value, option, value, ...?);
120           Query or modify the configuration options of the widget.  If no
121           option is specified, returns a list describing all of the available
122           options for $widget (see Tk::configure for information on the for‐
123           mat of this list).  If option is specified with no value, then the
124           command returns a list describing the one named option (this list
125           will be identical to the corresponding sublist of the value
126           returned if no option is specified).  If one or more option-value
127           pairs are specified, then the command modifies the given widget
128           option(s) to have the given value(s);  in this case the command
129           returns an empty string.  Option may have any of the values
130           accepted by the Labelframe command.
131

BINDINGS

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

SEE ALSO

137       Tk::Frame, Tk::Label
138

KEYWORDS

140       Labelframe, widget
141
142
143
144perl v5.8.8                       2008-02-05                     Labelframe(3)
Impressum