.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Gtk2::ToolButton 3"
.TH Gtk2::ToolButton 3 2024-09-01 "perl v5.40.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Gtk2::ToolButton \- wrapper for GtkToolButton
.SH HIERARCHY
.IX Header "HIERARCHY"
.Vb 8
\&  Glib::Object
\&  +\-\-\-\-Glib::InitiallyUnowned
\&       +\-\-\-\-Gtk2::Object
\&            +\-\-\-\-Gtk2::Widget
\&                 +\-\-\-\-Gtk2::Container
\&                      +\-\-\-\-Gtk2::Bin
\&                           +\-\-\-\-Gtk2::ToolItem
\&                                +\-\-\-\-Gtk2::ToolButton
.Ve
.SH INTERFACES
.IX Header "INTERFACES"
.Vb 3
\&  Glib::Object::_Unregistered::AtkImplementorIface
\&  Gtk2::Buildable
\&  Gtk2::Activatable
.Ve
.SH METHODS
.IX Header "METHODS"
.ie n .SS "toolitem = Gtk2::ToolButton\->\fBnew\fP ($icon_widget, $label)"
.el .SS "toolitem = Gtk2::ToolButton\->\fBnew\fP ($icon_widget, \f(CW$label\fP)"
.IX Subsection "toolitem = Gtk2::ToolButton->new ($icon_widget, $label)"
.IP \(bu 4
\&\f(CW$icon_widget\fR (Gtk2::Widget or undef)
.IP \(bu 4
\&\f(CW$label\fR (string or undef)
.SS "toolitem = Gtk2::ToolButton\->\fBnew_from_stock\fP ($stock_id)"
.IX Subsection "toolitem = Gtk2::ToolButton->new_from_stock ($stock_id)"
.IP \(bu 4
\&\f(CW$stock_id\fR (string)
.ie n .SS "string or undef = $button\->\fBget_icon_name\fP"
.el .SS "string or undef = \f(CW$button\fP\->\fBget_icon_name\fP"
.IX Subsection "string or undef = $button->get_icon_name"
Since: gtk+ 2.8
.ie n .SS "$button\->\fBset_icon_name\fP ($icon_name)"
.el .SS "\f(CW$button\fP\->\fBset_icon_name\fP ($icon_name)"
.IX Subsection "$button->set_icon_name ($icon_name)"
.IP \(bu 4
\&\f(CW$icon_name\fR (string or undef)
.PP
Since: gtk+ 2.8
.ie n .SS "widget or undef = $button\->\fBget_icon_widget\fP"
.el .SS "widget or undef = \f(CW$button\fP\->\fBget_icon_widget\fP"
.IX Subsection "widget or undef = $button->get_icon_widget"
.ie n .SS "$button\->\fBset_icon_widget\fP ($icon_widget)"
.el .SS "\f(CW$button\fP\->\fBset_icon_widget\fP ($icon_widget)"
.IX Subsection "$button->set_icon_widget ($icon_widget)"
.IP \(bu 4
\&\f(CW$icon_widget\fR (Gtk2::Widget or undef)
.ie n .SS "string or undef = $button\->\fBget_label\fP"
.el .SS "string or undef = \f(CW$button\fP\->\fBget_label\fP"
.IX Subsection "string or undef = $button->get_label"
.ie n .SS "$button\->\fBset_label\fP ($label)"
.el .SS "\f(CW$button\fP\->\fBset_label\fP ($label)"
.IX Subsection "$button->set_label ($label)"
.IP \(bu 4
\&\f(CW$label\fR (string or undef)
.ie n .SS "widget or undef = $button\->\fBget_label_widget\fP"
.el .SS "widget or undef = \f(CW$button\fP\->\fBget_label_widget\fP"
.IX Subsection "widget or undef = $button->get_label_widget"
.ie n .SS "$button\->\fBset_label_widget\fP ($label_widget)"
.el .SS "\f(CW$button\fP\->\fBset_label_widget\fP ($label_widget)"
.IX Subsection "$button->set_label_widget ($label_widget)"
.IP \(bu 4
\&\f(CW$label_widget\fR (Gtk2::Widget or undef)
.ie n .SS "string = $button\->\fBget_stock_id\fP"
.el .SS "string = \f(CW$button\fP\->\fBget_stock_id\fP"
.IX Subsection "string = $button->get_stock_id"
.ie n .SS "$button\->\fBset_stock_id\fP ($stock_id)"
.el .SS "\f(CW$button\fP\->\fBset_stock_id\fP ($stock_id)"
.IX Subsection "$button->set_stock_id ($stock_id)"
.IP \(bu 4
\&\f(CW$stock_id\fR (string or undef)
.ie n .SS "boolean = $button\->\fBget_use_underline\fP"
.el .SS "boolean = \f(CW$button\fP\->\fBget_use_underline\fP"
.IX Subsection "boolean = $button->get_use_underline"
.ie n .SS "$button\->\fBset_use_underline\fP ($use_underline)"
.el .SS "\f(CW$button\fP\->\fBset_use_underline\fP ($use_underline)"
.IX Subsection "$button->set_use_underline ($use_underline)"
.IP \(bu 4
\&\f(CW$use_underline\fR (boolean)
.SH PROPERTIES
.IX Header "PROPERTIES"
.IP "'icon\-name' (string : default undef : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'icon-name' (string : default undef : readable / writable / private / static-nick / static-blurb)"
The name of the themed icon displayed on the item
.IP "'icon\-widget' (Gtk2::Widget : default undef : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'icon-widget' (Gtk2::Widget : default undef : readable / writable / private / static-nick / static-blurb)"
Icon widget to display in the item
.IP "'label' (string : default undef : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'label' (string : default undef : readable / writable / private / static-nick / static-blurb)"
Text to show in the item.
.IP "'label\-widget' (Gtk2::Widget : default undef : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'label-widget' (Gtk2::Widget : default undef : readable / writable / private / static-nick / static-blurb)"
Widget to use as the item label
.IP "'stock\-id' (string : default undef : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'stock-id' (string : default undef : readable / writable / private / static-nick / static-blurb)"
The stock icon displayed on the item
.IP "'use\-underline' (boolean : default false : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'use-underline' (boolean : default false : readable / writable / private / static-nick / static-blurb)"
If set, an underline in the label property indicates that the next character should be used for the mnemonic accelerator key in the overflow menu
.SH "STYLE PROPERTIES"
.IX Header "STYLE PROPERTIES"
.IP "'icon\-spacing' (integer : default 3 : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'icon-spacing' (integer : default 3 : readable / writable / private / static-nick / static-blurb)"
Spacing in pixels between the icon and label
.SH SIGNALS
.IX Header "SIGNALS"
.IP "\fBclicked\fR (Gtk2::ToolButton)" 4
.IX Item "clicked (Gtk2::ToolButton)"
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Gtk2, Glib::Object, Glib::InitiallyUnowned, Gtk2::Object, Gtk2::Widget, Gtk2::Container, Gtk2::Bin, Gtk2::ToolItem
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2003\-2011 by the gtk2\-perl team.
.PP
This software is licensed under the LGPL.  See Gtk2 for a full notice.