Class
Gtk.Image
Description [src]
final class Gtk.Image : Gtk.Widget {
/* No available fields */
}The GtkImage widget displays an image.
Various kinds of object can be displayed as an image; most typically,
you would load a GdkTexture from a file, using the convenience function
gtk_image_new_from_file(), for instance:
GtkWidget *image = gtk_image_new_from_file ("myfile.png");
If the file isn’t loaded successfully, the image will contain a “broken image” icon similar to that used in many web browsers.
If you want to handle errors in loading the file yourself,
for example by displaying an error message, then load the image with
Gdk.Texture.new_from_file, then create the GtkImage with
gtk_image_new_from_paintable().
Sometimes an application will want to avoid depending on external data
files, such as image files. See the documentation of GResource inside
GIO, for details. In this case, GtkImage:resource,
gtk_image_new_from_resource(), and gtk_image_set_from_resource()
should be used.
GtkImage displays its image as an icon, with a size that is determined
by the application. See GtkPicture if you want to show an image
at is actual size.
CSS nodes
GtkImage has a single CSS node with the name image. The style classes
.normal-icons or .large-icons may appear, depending on the
GtkImage:icon-size property.
Accessibility
GtkImage uses the GTK_ACCESSIBLE_ROLE_IMG role.
Ancestors
- GtkWidget
- GInitiallyUnowned
- GObject
Constructors
gtk_image_new
Creates a new empty GtkImage widget.
gtk_image_new_from_file
Creates a new GtkImage displaying the file filename.
gtk_image_new_from_gicon
Creates a GtkImage displaying an icon from the current icon theme.
gtk_image_new_from_icon_name
Creates a GtkImage displaying an icon from the current icon theme.
gtk_image_new_from_paintable
Creates a new GtkImage displaying paintable.
gtk_image_new_from_pixbuf
Creates a new GtkImage displaying pixbuf.
gtk_image_new_from_resource
Creates a new GtkImage displaying the resource file resource_path.
Instance methods
gtk_image_clear
Resets the image to be empty.
gtk_image_get_gicon
Gets the GIcon being displayed by the GtkImage.
gtk_image_get_icon_name
Gets the icon name and size being displayed by the GtkImage.
gtk_image_get_icon_size
Gets the icon size used by the image when rendering icons.
gtk_image_get_paintable
Gets the image GdkPaintable being displayed by the GtkImage.
gtk_image_get_pixel_size
Gets the pixel size used for named icons.
gtk_image_get_storage_type
Gets the type of representation being used by the GtkImage
to store image data.
gtk_image_set_from_file
Sets a GtkImage to show a file.
gtk_image_set_from_gicon
Sets a GtkImage to show a GIcon.
gtk_image_set_from_icon_name
Sets a GtkImage to show a named icon.
gtk_image_set_from_paintable
Sets a GtkImage to show a GdkPaintable.
gtk_image_set_from_pixbuf
Sets a GtkImage to show a GdkPixbuf.
gtk_image_set_from_resource
Sets a GtkImage to show a resource.
gtk_image_set_icon_size
Suggests an icon size to the theme for named icons.
gtk_image_set_pixel_size
Sets the pixel size to use for named icons.
Methods inherited from GtkWidget (159)
Methods inherited from GtkAccessible (10)
gtk_accessible_get_accessible_role
Retrieves the GtkAccessibleRole for the given GtkAccessible.
gtk_accessible_reset_property
Resets the accessible property to its default value.
gtk_accessible_reset_relation
Resets the accessible relation to its default value.
gtk_accessible_reset_state
Resets the accessible state to its default value.
gtk_accessible_update_property
Updates a list of accessible properties.
gtk_accessible_update_property_value
Updates an array of accessible properties.
gtk_accessible_update_relation
Updates a list of accessible relations.
gtk_accessible_update_relation_value
Updates an array of accessible relations.
gtk_accessible_update_state
Updates a list of accessible states. See the GtkAccessibleState
documentation for the value types of accessible states.
gtk_accessible_update_state_value
Updates an array of accessible states.
Methods inherited from GtkBuildable (1)
gtk_buildable_get_buildable_id
Gets the ID of the buildable object.
Properties
Gtk.Image:file
The `GFile to display.
Gtk.Image:gicon
The GIcon displayed in the GtkImage.
Gtk.Image:icon-name
The name of the icon in the icon theme.
Gtk.Image:icon-size
The symbolic size to display icons at.
Gtk.Image:paintable
The GdkPaintable to display.
Gtk.Image:pixel-size
The size in pixels to display icons at.
Gtk.Image:resource
A path to a resource file to display.
Gtk.Image:storage-type
The representation being used for image data.
Gtk.Image:use-fallback
Whether the icon displayed in the GtkImage will use
standard icon names fallback.
Properties inherited from GtkWidget (34)
Gtk.Widget:can-focus
Whether the widget or any of its descendents can accept the input focus.
Gtk.Widget:can-target
Whether the widget can receive pointer events.
Gtk.Widget:css-classes
A list of css classes applied to this widget.
Gtk.Widget:css-name
The name of this widget in the CSS tree.
Gtk.Widget:cursor
The cursor used by widget.
Gtk.Widget:focus-on-click
Whether the widget should grab focus when it is clicked with the mouse.
Gtk.Widget:focusable
Whether this widget itself will accept the input focus.
Gtk.Widget:halign
How to distribute horizontal space if widget gets extra space.
Gtk.Widget:has-default
Whether the widget is the default widget.
Gtk.Widget:has-focus
Whether the widget has the input focus.
Gtk.Widget:has-tooltip
Enables or disables the emission of the ::query-tooltip signal on widget.
Gtk.Widget:height-request
Override for height request of the widget.
Gtk.Widget:hexpand
Whether to expand horizontally.
Gtk.Widget:hexpand-set
Whether to use the hexpand property.
Gtk.Widget:layout-manager
The GtkLayoutManager instance to use to compute the preferred size
of the widget, and allocate its children.
Gtk.Widget:margin-bottom
Margin on bottom side of widget.
Gtk.Widget:margin-end
Margin on end of widget, horizontally.
Gtk.Widget:margin-start
Margin on start of widget, horizontally.
Gtk.Widget:margin-top
Margin on top side of widget.
Gtk.Widget:name
The name of the widget.
Gtk.Widget:opacity
The requested opacity of the widget.
Gtk.Widget:overflow
How content outside the widget’s content area is treated.
Gtk.Widget:parent
The parent widget of this widget.
Gtk.Widget:receives-default
Whether the widget will receive the default action when it is focused.
Gtk.Widget:root
The GtkRoot widget of the widget tree containing this widget.
Gtk.Widget:scale-factor
The scale factor of the widget.
Gtk.Widget:sensitive
Whether the widget responds to input.
Gtk.Widget:tooltip-markup
Sets the text of tooltip to be the given string, which is marked up with Pango markup.
Gtk.Widget:tooltip-text
Sets the text of tooltip to be the given string.
Gtk.Widget:valign
How to distribute vertical space if widget gets extra space.
Gtk.Widget:vexpand
Whether to expand vertically.
Gtk.Widget:vexpand-set
Whether to use the vexpand property.
Gtk.Widget:visible
Whether the widget is visible.
Gtk.Widget:width-request
Override for width request of the widget.
Properties inherited from GtkAccessible (1)
Gtk.Accessible:accessible-role
The accessible role of the given GtkAccessible implementation.