.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" 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::Image 3" .TH Gtk2::Image 3 2023-07-25 "perl v5.38.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::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 / static-nick / static-blurb)" 4 .IX Item "'file' (string : default undef : readable / writable / private / static-nick / static-blurb)" Filename to load and display .IP "'gicon' (Glib::Object::_Unregistered::GIcon : default undef : readable / writable / private / static-nick / static-blurb)" 4 .IX Item "'gicon' (Glib::Object::_Unregistered::GIcon : default undef : readable / writable / private / static-nick / static-blurb)" The GIcon being displayed .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 icon from the icon theme .IP "'icon\-set' (Gtk2::IconSet : default undef : readable / writable / private / static-nick / static-blurb)" 4 .IX Item "'icon-set' (Gtk2::IconSet : default undef : readable / writable / private / static-nick / static-blurb)" Icon set to display .IP "'icon\-size' (integer : default 4 : readable / writable / private / static-nick / static-blurb)" 4 .IX Item "'icon-size' (integer : default 4 : readable / writable / private / static-nick / static-blurb)" Symbolic size to use for stock icon, icon set or named icon .IP "'image' (Gtk2::Gdk::Image : default undef : readable / writable / private / static-nick / static-blurb)" 4 .IX Item "'image' (Gtk2::Gdk::Image : default undef : readable / writable / private / static-nick / static-blurb)" A GdkImage to display .IP "'mask' (Gtk2::Gdk::Pixmap : default undef : readable / writable / private / static-nick / static-blurb)" 4 .IX Item "'mask' (Gtk2::Gdk::Pixmap : default undef : readable / writable / private / static-nick / static-blurb)" Mask bitmap to use with GdkImage or GdkPixmap .IP "'pixbuf' (Gtk2::Gdk::Pixbuf : default undef : readable / writable / private / static-nick / static-blurb)" 4 .IX Item "'pixbuf' (Gtk2::Gdk::Pixbuf : default undef : readable / writable / private / static-nick / static-blurb)" A GdkPixbuf to display .IP "'pixbuf\-animation' (Gtk2::Gdk::PixbufAnimation : default undef : readable / writable / private / static-nick / static-blurb)" 4 .IX Item "'pixbuf-animation' (Gtk2::Gdk::PixbufAnimation : default undef : readable / writable / private / static-nick / static-blurb)" GdkPixbufAnimation to display .IP "'pixel\-size' (integer : default \-1 : readable / writable / private / static-nick / static-blurb)" 4 .IX Item "'pixel-size' (integer : default -1 : readable / writable / private / static-nick / static-blurb)" Pixel size to use for named icon .IP "'pixmap' (Gtk2::Gdk::Pixmap : default undef : readable / writable / private / static-nick / static-blurb)" 4 .IX Item "'pixmap' (Gtk2::Gdk::Pixmap : default undef : readable / writable / private / static-nick / static-blurb)" A GdkPixmap to display .IP "'stock' (string : default undef : readable / writable / private / static-nick / static-blurb)" 4 .IX Item "'stock' (string : default undef : readable / writable / private / static-nick / static-blurb)" Stock ID for a stock image to display .IP "'storage\-type' (Gtk2::ImageType : default ""empty"" : readable / private / static-nick / static-blurb)" 4 .IX Item "'storage-type' (Gtk2::ImageType : default ""empty"" : readable / private / static-nick / static-blurb)" 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' / 'GTK_ICON_SIZE_INVALID' .IP \(bu 4 \&'menu' / 'GTK_ICON_SIZE_MENU' .IP \(bu 4 \&'small\-toolbar' / 'GTK_ICON_SIZE_SMALL_TOOLBAR' .IP \(bu 4 \&'large\-toolbar' / 'GTK_ICON_SIZE_LARGE_TOOLBAR' .IP \(bu 4 \&'button' / 'GTK_ICON_SIZE_BUTTON' .IP \(bu 4 \&'dnd' / 'GTK_ICON_SIZE_DND' .IP \(bu 4 \&'dialog' / 'GTK_ICON_SIZE_DIALOG' .SS "enum Gtk2::ImageType" .IX Subsection "enum Gtk2::ImageType" .IP \(bu 4 \&'empty' / 'GTK_IMAGE_EMPTY' .IP \(bu 4 \&'pixmap' / 'GTK_IMAGE_PIXMAP' .IP \(bu 4 \&'image' / 'GTK_IMAGE_IMAGE' .IP \(bu 4 \&'pixbuf' / 'GTK_IMAGE_PIXBUF' .IP \(bu 4 \&'stock' / 'GTK_IMAGE_STOCK' .IP \(bu 4 \&'icon\-set' / 'GTK_IMAGE_ICON_SET' .IP \(bu 4 \&'animation' / 'GTK_IMAGE_ANIMATION' .IP \(bu 4 \&'icon\-name' / 'GTK_IMAGE_ICON_NAME' .IP \(bu 4 \&'gicon' / 'GTK_IMAGE_GICON' .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 LGPL. See Gtk2 for a full notice.