.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'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 turned on, 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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Gtk2::Action 3pm"
.TH Gtk2::Action 3pm "2015-02-24" "perl v5.14.2" "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::Action \- wrapper for GtkAction
.SH "HIERARCHY"
.IX Header "HIERARCHY"
.Vb 2
\&  Glib::Object
\&  +\-\-\-\-Gtk2::Action
.Ve
.SH "INTERFACES"
.IX Header "INTERFACES"
.Vb 1
\&  Gtk2::Buildable
.Ve
.SH "CONSTRUCTOR"
.IX Header "CONSTRUCTOR"
.SS "action = Gtk2::Action\->\fBnew\fP (key=>value,...)"
.IX Subsection "action = Gtk2::Action->new (key=>value,...)"
Create and return a new action object.  Note that this is the \f(CW\*(C`new\*(C'\fR
of Glib::Object, not \f(CW\*(C`gtk_action_new\*(C'\fR.  Eg.
.PP
.Vb 3
\&    Gtk2::Action\->new (name => \*(Aqopen\-foo\*(Aq,
\&                       stock_id => \*(Aqgtk\-open\*(Aq,
\&                       tooltip => \*(AqStart a foo\*(Aq);
.Ve
.PP
The keyword/value style is more flexible and a little clearer than the
four direct arguments of \f(CW\*(C`gtk_action_new\*(C'\fR (and also works better for
subclasses).
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS "$action\->\fBset_accel_group\fP ($accel_group)"
.el .SS "\f(CW$action\fP\->\fBset_accel_group\fP ($accel_group)"
.IX Subsection "$action->set_accel_group ($accel_group)"
.IP "\(bu" 4
\&\f(CW$accel_group\fR (Gtk2::AccelGroup or undef)
.ie n .SS "string = $action\->\fBget_accel_path\fP"
.el .SS "string = \f(CW$action\fP\->\fBget_accel_path\fP"
.IX Subsection "string = $action->get_accel_path"
Since: gtk+ 2.6
.ie n .SS "$action\->\fBset_accel_path\fP ($accel_path)"
.el .SS "\f(CW$action\fP\->\fBset_accel_path\fP ($accel_path)"
.IX Subsection "$action->set_accel_path ($accel_path)"
.IP "\(bu" 4
\&\f(CW$accel_path\fR (string)
.ie n .SS "$action\->\fBactivate\fP"
.el .SS "\f(CW$action\fP\->\fBactivate\fP"
.IX Subsection "$action->activate"
.ie n .SS "boolean = $action\->\fBget_always_show_image\fP"
.el .SS "boolean = \f(CW$action\fP\->\fBget_always_show_image\fP"
.IX Subsection "boolean = $action->get_always_show_image"
Since: gtk+ 2.20
.ie n .SS "$action\->\fBset_always_show_image\fP ($always_show)"
.el .SS "\f(CW$action\fP\->\fBset_always_show_image\fP ($always_show)"
.IX Subsection "$action->set_always_show_image ($always_show)"
.IP "\(bu" 4
\&\f(CW$always_show\fR (boolean)
.PP
Since: gtk+ 2.20
.ie n .SS "$action\->\fBblock_activate\fP"
.el .SS "\f(CW$action\fP\->\fBblock_activate\fP"
.IX Subsection "$action->block_activate"
Since: gtk+ 2.16
.ie n .SS "$action\->\fBblock_activate_from\fP ($proxy)"
.el .SS "\f(CW$action\fP\->\fBblock_activate_from\fP ($proxy)"
.IX Subsection "$action->block_activate_from ($proxy)"
.IP "\(bu" 4
\&\f(CW$proxy\fR (Gtk2::Widget)
.ie n .SS "$action\->\fBconnect_accelerator\fP"
.el .SS "\f(CW$action\fP\->\fBconnect_accelerator\fP"
.IX Subsection "$action->connect_accelerator"
.ie n .SS "$action\->\fBconnect_proxy\fP ($proxy)"
.el .SS "\f(CW$action\fP\->\fBconnect_proxy\fP ($proxy)"
.IX Subsection "$action->connect_proxy ($proxy)"
.IP "\(bu" 4
\&\f(CW$proxy\fR (Gtk2::Widget)
.ie n .SS "widget = $action\->\fBcreate_icon\fP ($icon_size)"
.el .SS "widget = \f(CW$action\fP\->\fBcreate_icon\fP ($icon_size)"
.IX Subsection "widget = $action->create_icon ($icon_size)"
.IP "\(bu" 4
\&\f(CW$icon_size\fR (Gtk2::IconSize)
.ie n .SS "widget = $action\->\fBcreate_menu\fP"
.el .SS "widget = \f(CW$action\fP\->\fBcreate_menu\fP"
.IX Subsection "widget = $action->create_menu"
Since: gtk+ 2.12
.ie n .SS "widget = $action\->\fBcreate_menu_item\fP"
.el .SS "widget = \f(CW$action\fP\->\fBcreate_menu_item\fP"
.IX Subsection "widget = $action->create_menu_item"
.ie n .SS "widget = $action\->\fBcreate_tool_item\fP"
.el .SS "widget = \f(CW$action\fP\->\fBcreate_tool_item\fP"
.IX Subsection "widget = $action->create_tool_item"
.ie n .SS "$action\->\fBdisconnect_accelerator\fP"
.el .SS "\f(CW$action\fP\->\fBdisconnect_accelerator\fP"
.IX Subsection "$action->disconnect_accelerator"
.ie n .SS "$action\->\fBdisconnect_proxy\fP ($proxy)"
.el .SS "\f(CW$action\fP\->\fBdisconnect_proxy\fP ($proxy)"
.IX Subsection "$action->disconnect_proxy ($proxy)"
.IP "\(bu" 4
\&\f(CW$proxy\fR (Gtk2::Widget)
.ie n .SS "string or undef = $action\->\fBget_icon_name\fP"
.el .SS "string or undef = \f(CW$action\fP\->\fBget_icon_name\fP"
.IX Subsection "string or undef = $action->get_icon_name"
Since: gtk+ 2.16
.ie n .SS "$action\->\fBset_icon_name\fP ($icon_name)"
.el .SS "\f(CW$action\fP\->\fBset_icon_name\fP ($icon_name)"
.IX Subsection "$action->set_icon_name ($icon_name)"
.IP "\(bu" 4
\&\f(CW$icon_name\fR (string or undef)
.PP
Since: gtk+ 2.16
.ie n .SS "boolean = $action\->\fBget_is_important\fP"
.el .SS "boolean = \f(CW$action\fP\->\fBget_is_important\fP"
.IX Subsection "boolean = $action->get_is_important"
Since: gtk+ 2.16
.ie n .SS "$action\->\fBset_is_important\fP ($is_important)"
.el .SS "\f(CW$action\fP\->\fBset_is_important\fP ($is_important)"
.IX Subsection "$action->set_is_important ($is_important)"
.IP "\(bu" 4
\&\f(CW$is_important\fR (boolean)
.PP
Since: gtk+ 2.16
.ie n .SS "boolean = $action\->\fBis_sensitive\fP"
.el .SS "boolean = \f(CW$action\fP\->\fBis_sensitive\fP"
.IX Subsection "boolean = $action->is_sensitive"
.ie n .SS "boolean = $action\->\fBis_visible\fP"
.el .SS "boolean = \f(CW$action\fP\->\fBis_visible\fP"
.IX Subsection "boolean = $action->is_visible"
.ie n .SS "string or undef = $action\->\fBget_label\fP"
.el .SS "string or undef = \f(CW$action\fP\->\fBget_label\fP"
.IX Subsection "string or undef = $action->get_label"
Since: gtk+ 2.16
.ie n .SS "$action\->\fBset_label\fP ($label)"
.el .SS "\f(CW$action\fP\->\fBset_label\fP ($label)"
.IX Subsection "$action->set_label ($label)"
.IP "\(bu" 4
\&\f(CW$label\fR (string)
.PP
Since: gtk+ 2.16
.ie n .SS "string = $action\->\fBget_name\fP"
.el .SS "string = \f(CW$action\fP\->\fBget_name\fP"
.IX Subsection "string = $action->get_name"
.ie n .SS "list = $action\->\fBget_proxies\fP"
.el .SS "list = \f(CW$action\fP\->\fBget_proxies\fP"
.IX Subsection "list = $action->get_proxies"
.ie n .SS "boolean = $action\->\fBget_sensitive\fP"
.el .SS "boolean = \f(CW$action\fP\->\fBget_sensitive\fP"
.IX Subsection "boolean = $action->get_sensitive"
.ie n .SS "$action\->\fBset_sensitive\fP ($sensitive)"
.el .SS "\f(CW$action\fP\->\fBset_sensitive\fP ($sensitive)"
.IX Subsection "$action->set_sensitive ($sensitive)"
.IP "\(bu" 4
\&\f(CW$sensitive\fR (boolean)
.PP
Since: gtk+ 2.6
.ie n .SS "string or undef = $action\->\fBget_short_label\fP"
.el .SS "string or undef = \f(CW$action\fP\->\fBget_short_label\fP"
.IX Subsection "string or undef = $action->get_short_label"
Since: gtk+ 2.16
.ie n .SS "$action\->\fBset_short_label\fP ($short_label)"
.el .SS "\f(CW$action\fP\->\fBset_short_label\fP ($short_label)"
.IX Subsection "$action->set_short_label ($short_label)"
.IP "\(bu" 4
\&\f(CW$short_label\fR (string)
.PP
Since: gtk+ 2.16
.ie n .SS "string or undef = $action\->\fBget_stock_id\fP"
.el .SS "string or undef = \f(CW$action\fP\->\fBget_stock_id\fP"
.IX Subsection "string or undef = $action->get_stock_id"
Since: gtk+ 2.16
.ie n .SS "$action\->\fBset_stock_id\fP ($stock_id)"
.el .SS "\f(CW$action\fP\->\fBset_stock_id\fP ($stock_id)"
.IX Subsection "$action->set_stock_id ($stock_id)"
.IP "\(bu" 4
\&\f(CW$stock_id\fR (string or undef)
.PP
Since: gtk+ 2.16
.ie n .SS "string or undef = $action\->\fBget_tooltip\fP"
.el .SS "string or undef = \f(CW$action\fP\->\fBget_tooltip\fP"
.IX Subsection "string or undef = $action->get_tooltip"
Since: gtk+ 2.16
.ie n .SS "$action\->\fBset_tooltip\fP ($tooltip)"
.el .SS "\f(CW$action\fP\->\fBset_tooltip\fP ($tooltip)"
.IX Subsection "$action->set_tooltip ($tooltip)"
.IP "\(bu" 4
\&\f(CW$tooltip\fR (string or undef)
.PP
Since: gtk+ 2.16
.ie n .SS "$action\->\fBunblock_activate\fP"
.el .SS "\f(CW$action\fP\->\fBunblock_activate\fP"
.IX Subsection "$action->unblock_activate"
Since: gtk+ 2.16
.ie n .SS "$action\->\fBunblock_activate_from\fP ($proxy)"
.el .SS "\f(CW$action\fP\->\fBunblock_activate_from\fP ($proxy)"
.IX Subsection "$action->unblock_activate_from ($proxy)"
.IP "\(bu" 4
\&\f(CW$proxy\fR (Gtk2::Widget)
.ie n .SS "boolean = $action\->\fBget_visible\fP"
.el .SS "boolean = \f(CW$action\fP\->\fBget_visible\fP"
.IX Subsection "boolean = $action->get_visible"
.ie n .SS "boolean = $action\->\fBget_visible_horizontal\fP"
.el .SS "boolean = \f(CW$action\fP\->\fBget_visible_horizontal\fP"
.IX Subsection "boolean = $action->get_visible_horizontal"
Since: gtk+ 2.16
.ie n .SS "$action\->\fBset_visible_horizontal\fP ($visible_horizontal)"
.el .SS "\f(CW$action\fP\->\fBset_visible_horizontal\fP ($visible_horizontal)"
.IX Subsection "$action->set_visible_horizontal ($visible_horizontal)"
.IP "\(bu" 4
\&\f(CW$visible_horizontal\fR (boolean)
.PP
Since: gtk+ 2.16
.ie n .SS "$action\->\fBset_visible\fP ($visible)"
.el .SS "\f(CW$action\fP\->\fBset_visible\fP ($visible)"
.IX Subsection "$action->set_visible ($visible)"
.IP "\(bu" 4
\&\f(CW$visible\fR (boolean)
.PP
Since: gtk+ 2.6
.ie n .SS "boolean = $action\->\fBget_visible_vertical\fP"
.el .SS "boolean = \f(CW$action\fP\->\fBget_visible_vertical\fP"
.IX Subsection "boolean = $action->get_visible_vertical"
Since: gtk+ 2.16
.ie n .SS "$action\->\fBset_visible_vertical\fP ($visible_vertical)"
.el .SS "\f(CW$action\fP\->\fBset_visible_vertical\fP ($visible_vertical)"
.IX Subsection "$action->set_visible_vertical ($visible_vertical)"
.IP "\(bu" 4
\&\f(CW$visible_vertical\fR (boolean)
.PP
Since: gtk+ 2.16
.SH "PROPERTIES"
.IX Header "PROPERTIES"
.IP "'action\-group' (Gtk2::ActionGroup : default undef : readable / writable / private)" 4
.IX Item "'action-group' (Gtk2::ActionGroup : default undef : readable / writable / private)"
The GtkActionGroup this GtkAction is associated with, or \s-1NULL\s0 (for internal use).
.IP "'always\-show\-image' (boolean : default false : readable / writable / construct / private)" 4
.IX Item "'always-show-image' (boolean : default false : readable / writable / construct / private)"
Whether the image will always be shown
.IP "'gicon' (Glib::Object::_Unregistered::GIcon : default undef : readable / writable / private)" 4
.IX Item "'gicon' (Glib::Object::_Unregistered::GIcon : default undef : readable / writable / private)"
The GIcon being displayed
.IP "'hide\-if\-empty' (boolean : default true : readable / writable / private)" 4
.IX Item "'hide-if-empty' (boolean : default true : readable / writable / private)"
When \s-1TRUE\s0, empty menu proxies for this action are hidden.
.IP "'icon\-name' (string : default undef : readable / writable / private)" 4
.IX Item "'icon-name' (string : default undef : readable / writable / private)"
The name of the icon from the icon theme
.IP "'is\-important' (boolean : default false : readable / writable / private)" 4
.IX Item "'is-important' (boolean : default false : readable / writable / private)"
Whether the action is considered important. When \s-1TRUE\s0, toolitem proxies for this action show text in \s-1GTK_TOOLBAR_BOTH_HORIZ\s0 mode.
.IP "'label' (string : default undef : readable / writable / private)" 4
.IX Item "'label' (string : default undef : readable / writable / private)"
The label used for menu items and buttons that activate this action.
.IP "'name' (string : default undef : readable / writable / construct-only / private)" 4
.IX Item "'name' (string : default undef : readable / writable / construct-only / private)"
A unique name for the action.
.IP "'sensitive' (boolean : default true : readable / writable / private)" 4
.IX Item "'sensitive' (boolean : default true : readable / writable / private)"
Whether the action is enabled.
.IP "'short\-label' (string : default undef : readable / writable / private)" 4
.IX Item "'short-label' (string : default undef : readable / writable / private)"
A shorter label that may be used on toolbar buttons.
.IP "'stock\-id' (string : default undef : readable / writable / private)" 4
.IX Item "'stock-id' (string : default undef : readable / writable / private)"
The stock icon displayed in widgets representing this action.
.IP "'tooltip' (string : default undef : readable / writable / private)" 4
.IX Item "'tooltip' (string : default undef : readable / writable / private)"
A tooltip for this action.
.IP "'visible' (boolean : default true : readable / writable / private)" 4
.IX Item "'visible' (boolean : default true : readable / writable / private)"
Whether the action is visible.
.IP "'visible\-horizontal' (boolean : default true : readable / writable / private)" 4
.IX Item "'visible-horizontal' (boolean : default true : readable / writable / private)"
Whether the toolbar item is visible when the toolbar is in a horizontal orientation.
.IP "'visible\-overflown' (boolean : default true : readable / writable / private)" 4
.IX Item "'visible-overflown' (boolean : default true : readable / writable / private)"
When \s-1TRUE\s0, toolitem proxies for this action are represented in the toolbar overflow menu.
.IP "'visible\-vertical' (boolean : default true : readable / writable / private)" 4
.IX Item "'visible-vertical' (boolean : default true : readable / writable / private)"
Whether the toolbar item is visible when the toolbar is in a vertical orientation.
.SH "SIGNALS"
.IX Header "SIGNALS"
.IP "\fBactivate\fR (Gtk2::Action)" 4
.IX Item "activate (Gtk2::Action)"
.SH "ENUMS AND FLAGS"
.IX Header "ENUMS AND FLAGS"
.SS "enum Gtk2::IconSize"
.IX Subsection "enum Gtk2::IconSize"
.PD 0
.IP "\(bu" 4
.PD
\&'invalid' / '\s-1GTK_ICON_SIZE_INVALID\s0'
.IP "\(bu" 4
\&'menu' / '\s-1GTK_ICON_SIZE_MENU\s0'
.IP "\(bu" 4
\&'small\-toolbar' / '\s-1GTK_ICON_SIZE_SMALL_TOOLBAR\s0'
.IP "\(bu" 4
\&'large\-toolbar' / '\s-1GTK_ICON_SIZE_LARGE_TOOLBAR\s0'
.IP "\(bu" 4
\&'button' / '\s-1GTK_ICON_SIZE_BUTTON\s0'
.IP "\(bu" 4
\&'dnd' / '\s-1GTK_ICON_SIZE_DND\s0'
.IP "\(bu" 4
\&'dialog' / '\s-1GTK_ICON_SIZE_DIALOG\s0'
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Gtk2, Glib::Object
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2003\-2011 by the gtk2\-perl team.
.PP
This software is licensed under the \s-1LGPL\s0.  See Gtk2 for a full notice.