.\" 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::Image 3pm"
.TH Gtk2::Image 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::Image \- wrapper for GtkImage
.SH "HIERARCHY"
.IX Header "HIERARCHY"
.Vb 6
\&  Glib::Object
\&  +\-\-\-\-Glib::InitiallyUnowned
\&       +\-\-\-\-Gtk2::Object
\&            +\-\-\-\-Gtk2::Widget
\&                 +\-\-\-\-Gtk2::Misc
\&                      +\-\-\-\-Gtk2::Image
.Ve
.SH "INTERFACES"
.IX Header "INTERFACES"
.Vb 2
\&  Glib::Object::_Unregistered::AtkImplementorIface
\&  Gtk2::Buildable
.Ve
.SH "METHODS"
.IX Header "METHODS"
.SS "widget = Gtk2::Image\->\fBnew\fP"
.IX Subsection "widget = Gtk2::Image->new"
.SS "widget = Gtk2::Image\->\fBnew_from_animation\fP ($animation)"
.IX Subsection "widget = Gtk2::Image->new_from_animation ($animation)"
.IP "\(bu" 4
\&\f(CW$animation\fR (Gtk2::Gdk::PixbufAnimation)
.SS "widget = Gtk2::Image\->\fBnew_from_file\fP ($filename)"
.IX Subsection "widget = Gtk2::Image->new_from_file ($filename)"
.IP "\(bu" 4
\&\f(CW$filename\fR (localized file name or undef)
.ie n .SS "widget = Gtk2::Image\->\fBnew_from_icon_name\fP ($icon_name, $size)"
.el .SS "widget = Gtk2::Image\->\fBnew_from_icon_name\fP ($icon_name, \f(CW$size\fP)"
.IX Subsection "widget = Gtk2::Image->new_from_icon_name ($icon_name, $size)"
.IP "\(bu" 4
\&\f(CW$icon_name\fR (string)
.IP "\(bu" 4
\&\f(CW$size\fR (Gtk2::IconSize)
.PP
Since: gtk+ 2.6
.ie n .SS "widget = Gtk2::Image\->\fBnew_from_icon_set\fP ($icon_set, $size)"
.el .SS "widget = Gtk2::Image\->\fBnew_from_icon_set\fP ($icon_set, \f(CW$size\fP)"
.IX Subsection "widget = Gtk2::Image->new_from_icon_set ($icon_set, $size)"
.IP "\(bu" 4
\&\f(CW$icon_set\fR (Gtk2::IconSet)
.IP "\(bu" 4
\&\f(CW$size\fR (Gtk2::IconSize)
.ie n .SS "widget = Gtk2::Image\->\fBnew_from_image\fP ($image, $mask)"
.el .SS "widget = Gtk2::Image\->\fBnew_from_image\fP ($image, \f(CW$mask\fP)"
.IX Subsection "widget = Gtk2::Image->new_from_image ($image, $mask)"
.IP "\(bu" 4
\&\f(CW$image\fR (Gtk2::Gdk::Image or undef)
.IP "\(bu" 4
\&\f(CW$mask\fR (Gtk2::Gdk::Bitmap or undef)
.SS "widget = Gtk2::Image\->\fBnew_from_pixbuf\fP ($pixbuf)"
.IX Subsection "widget = Gtk2::Image->new_from_pixbuf ($pixbuf)"
.IP "\(bu" 4
\&\f(CW$pixbuf\fR (Gtk2::Gdk::Pixbuf or undef)
.ie n .SS "widget = Gtk2::Image\->\fBnew_from_pixmap\fP ($pixmap, $mask)"
.el .SS "widget = Gtk2::Image\->\fBnew_from_pixmap\fP ($pixmap, \f(CW$mask\fP)"
.IX Subsection "widget = Gtk2::Image->new_from_pixmap ($pixmap, $mask)"
.IP "\(bu" 4
\&\f(CW$pixmap\fR (Gtk2::Gdk::Pixmap or undef)
.IP "\(bu" 4
\&\f(CW$mask\fR (Gtk2::Gdk::Bitmap or undef)
.ie n .SS "widget = Gtk2::Image\->\fBnew_from_stock\fP ($stock_id, $size)"
.el .SS "widget = Gtk2::Image\->\fBnew_from_stock\fP ($stock_id, \f(CW$size\fP)"
.IX Subsection "widget = Gtk2::Image->new_from_stock ($stock_id, $size)"
.IP "\(bu" 4
\&\f(CW$stock_id\fR (string)
.IP "\(bu" 4
\&\f(CW$size\fR (Gtk2::IconSize)
.ie n .SS "pixbufanimation = $image\->\fBget_animation\fP"
.el .SS "pixbufanimation = \f(CW$image\fP\->\fBget_animation\fP"
.IX Subsection "pixbufanimation = $image->get_animation"
.ie n .SS "$image\->\fBclear\fP"
.el .SS "\f(CW$image\fP\->\fBclear\fP"
.IX Subsection "$image->clear"
Since: gtk+ 2.8
.ie n .SS "$image\->\fBset_from_animation\fP ($animation)"
.el .SS "\f(CW$image\fP\->\fBset_from_animation\fP ($animation)"
.IX Subsection "$image->set_from_animation ($animation)"
.IP "\(bu" 4
\&\f(CW$animation\fR (Gtk2::Gdk::PixbufAnimation)
.ie n .SS "$image\->\fBset_from_file\fP ($filename)"
.el .SS "\f(CW$image\fP\->\fBset_from_file\fP ($filename)"
.IX Subsection "$image->set_from_file ($filename)"
.IP "\(bu" 4
\&\f(CW$filename\fR (localized file name or undef)
.ie n .SS "$image\->\fBset_from_icon_name\fP ($icon_name, $size)"
.el .SS "\f(CW$image\fP\->\fBset_from_icon_name\fP ($icon_name, \f(CW$size\fP)"
.IX Subsection "$image->set_from_icon_name ($icon_name, $size)"
.IP "\(bu" 4
\&\f(CW$icon_name\fR (string)
.IP "\(bu" 4
\&\f(CW$size\fR (Gtk2::IconSize)
.PP
Since: gtk+ 2.6
.ie n .SS "$image\->\fBset_from_icon_set\fP ($icon_set, $size)"
.el .SS "\f(CW$image\fP\->\fBset_from_icon_set\fP ($icon_set, \f(CW$size\fP)"
.IX Subsection "$image->set_from_icon_set ($icon_set, $size)"
.IP "\(bu" 4
\&\f(CW$icon_set\fR (Gtk2::IconSet)
.IP "\(bu" 4
\&\f(CW$size\fR (Gtk2::IconSize)
.ie n .SS "$image\->\fBset_from_image\fP ($gdk_image, $mask)"
.el .SS "\f(CW$image\fP\->\fBset_from_image\fP ($gdk_image, \f(CW$mask\fP)"
.IX Subsection "$image->set_from_image ($gdk_image, $mask)"
.IP "\(bu" 4
\&\f(CW$gdk_image\fR (Gtk2::Gdk::Image or undef)
.IP "\(bu" 4
\&\f(CW$mask\fR (Gtk2::Gdk::Bitmap or undef)
.ie n .SS "$image\->\fBset_from_pixbuf\fP ($pixbuf)"
.el .SS "\f(CW$image\fP\->\fBset_from_pixbuf\fP ($pixbuf)"
.IX Subsection "$image->set_from_pixbuf ($pixbuf)"
.IP "\(bu" 4
\&\f(CW$pixbuf\fR (Gtk2::Gdk::Pixbuf or undef)
.ie n .SS "$image\->\fBset_from_pixmap\fP ($pixmap, $mask)"
.el .SS "\f(CW$image\fP\->\fBset_from_pixmap\fP ($pixmap, \f(CW$mask\fP)"
.IX Subsection "$image->set_from_pixmap ($pixmap, $mask)"
.IP "\(bu" 4
\&\f(CW$pixmap\fR (Gtk2::Gdk::Pixmap or undef)
.IP "\(bu" 4
\&\f(CW$mask\fR (Gtk2::Gdk::Bitmap or undef)
.ie n .SS "$image\->\fBset_from_stock\fP ($stock_id, $size)"
.el .SS "\f(CW$image\fP\->\fBset_from_stock\fP ($stock_id, \f(CW$size\fP)"
.IX Subsection "$image->set_from_stock ($stock_id, $size)"
.IP "\(bu" 4
\&\f(CW$stock_id\fR (string)
.IP "\(bu" 4
\&\f(CW$size\fR (Gtk2::IconSize)
.ie n .SS "list = $image\->\fBget_icon_name\fP"
.el .SS "list = \f(CW$image\fP\->\fBget_icon_name\fP"
.IX Subsection "list = $image->get_icon_name"
Since: gtk+ 2.6
.ie n .SS "list = $image\->\fBget_icon_set\fP"
.el .SS "list = \f(CW$image\fP\->\fBget_icon_set\fP"
.IX Subsection "list = $image->get_icon_set"
.ie n .SS "list = $image\->\fBget_image\fP"
.el .SS "list = \f(CW$image\fP\->\fBget_image\fP"
.IX Subsection "list = $image->get_image"
.ie n .SS "pixbuf = $image\->\fBget_pixbuf\fP"
.el .SS "pixbuf = \f(CW$image\fP\->\fBget_pixbuf\fP"
.IX Subsection "pixbuf = $image->get_pixbuf"
.ie n .SS "integer = $image\->\fBget_pixel_size\fP"
.el .SS "integer = \f(CW$image\fP\->\fBget_pixel_size\fP"
.IX Subsection "integer = $image->get_pixel_size"
Since: gtk+ 2.6
.ie n .SS "$image\->\fBset_pixel_size\fP ($pixel_size)"
.el .SS "\f(CW$image\fP\->\fBset_pixel_size\fP ($pixel_size)"
.IX Subsection "$image->set_pixel_size ($pixel_size)"
.IP "\(bu" 4
\&\f(CW$pixel_size\fR (integer)
.PP
Since: gtk+ 2.6
.ie n .SS "list = $image\->\fBget_pixmap\fP"
.el .SS "list = \f(CW$image\fP\->\fBget_pixmap\fP"
.IX Subsection "list = $image->get_pixmap"
.ie n .SS "(stock_id, icon_size) = $image\->\fBget_stock\fP"
.el .SS "(stock_id, icon_size) = \f(CW$image\fP\->\fBget_stock\fP"
.IX Subsection "(stock_id, icon_size) = $image->get_stock"
.ie n .SS "imagetype = $image\->\fBget_storage_type\fP"
.el .SS "imagetype = \f(CW$image\fP\->\fBget_storage_type\fP"
.IX Subsection "imagetype = $image->get_storage_type"
.SH "PROPERTIES"
.IX Header "PROPERTIES"
.IP "'file' (string : default undef : readable / writable / private)" 4
.IX Item "'file' (string : default undef : readable / writable / private)"
Filename to load and display
.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 "'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 "'icon\-set' (Gtk2::IconSet : default undef : readable / writable / private)" 4
.IX Item "'icon-set' (Gtk2::IconSet : default undef : readable / writable / private)"
Icon set to display
.IP "'icon\-size' (integer : default 4 : readable / writable / private)" 4
.IX Item "'icon-size' (integer : default 4 : readable / writable / private)"
Symbolic size to use for stock icon, icon set or named icon
.IP "'image' (Gtk2::Gdk::Image : default undef : readable / writable / private)" 4
.IX Item "'image' (Gtk2::Gdk::Image : default undef : readable / writable / private)"
A GdkImage to display
.IP "'mask' (Gtk2::Gdk::Pixmap : default undef : readable / writable / private)" 4
.IX Item "'mask' (Gtk2::Gdk::Pixmap : default undef : readable / writable / private)"
Mask bitmap to use with GdkImage or GdkPixmap
.IP "'pixbuf' (Gtk2::Gdk::Pixbuf : default undef : readable / writable / private)" 4
.IX Item "'pixbuf' (Gtk2::Gdk::Pixbuf : default undef : readable / writable / private)"
A GdkPixbuf to display
.IP "'pixbuf\-animation' (Gtk2::Gdk::PixbufAnimation : default undef : readable / writable / private)" 4
.IX Item "'pixbuf-animation' (Gtk2::Gdk::PixbufAnimation : default undef : readable / writable / private)"
GdkPixbufAnimation to display
.IP "'pixel\-size' (integer : default \-1 : readable / writable / private)" 4
.IX Item "'pixel-size' (integer : default -1 : readable / writable / private)"
Pixel size to use for named icon
.IP "'pixmap' (Gtk2::Gdk::Pixmap : default undef : readable / writable / private)" 4
.IX Item "'pixmap' (Gtk2::Gdk::Pixmap : default undef : readable / writable / private)"
A GdkPixmap to display
.IP "'stock' (string : default undef : readable / writable / private)" 4
.IX Item "'stock' (string : default undef : readable / writable / private)"
Stock \s-1ID\s0 for a stock image to display
.ie n .IP "'storage\-type' (Gtk2::ImageType : default ""empty"" : readable / private)" 4
.el .IP "'storage\-type' (Gtk2::ImageType : default ``empty'' : readable / private)" 4
.IX Item "'storage-type' (Gtk2::ImageType : default empty : readable / private)"
The representation being used for image data
.SH "ENUMS AND FLAGS"
.IX Header "ENUMS AND FLAGS"
.SS "enum Gtk2::IconSize"
.IX Subsection "enum Gtk2::IconSize"
.IP "\(bu" 4
\&'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'
.SS "enum Gtk2::ImageType"
.IX Subsection "enum Gtk2::ImageType"
.IP "\(bu" 4
\&'empty' / '\s-1GTK_IMAGE_EMPTY\s0'
.IP "\(bu" 4
\&'pixmap' / '\s-1GTK_IMAGE_PIXMAP\s0'
.IP "\(bu" 4
\&'image' / '\s-1GTK_IMAGE_IMAGE\s0'
.IP "\(bu" 4
\&'pixbuf' / '\s-1GTK_IMAGE_PIXBUF\s0'
.IP "\(bu" 4
\&'stock' / '\s-1GTK_IMAGE_STOCK\s0'
.IP "\(bu" 4
\&'icon\-set' / '\s-1GTK_IMAGE_ICON_SET\s0'
.IP "\(bu" 4
\&'animation' / '\s-1GTK_IMAGE_ANIMATION\s0'
.IP "\(bu" 4
\&'icon\-name' / '\s-1GTK_IMAGE_ICON_NAME\s0'
.IP "\(bu" 4
\&'gicon' / '\s-1GTK_IMAGE_GICON\s0'
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Gtk2, Glib::Object, Glib::InitiallyUnowned, Gtk2::Object, Gtk2::Widget, Gtk2::Misc
.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.