Class

GtkImage

Description [src]

final class Gtk.Image : Gtk.Widget {
  /* No available fields */
}

The GtkImage widget displays an image.

An example GtkImage

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.

Hierarchy

hierarchy this GtkImage implements_0 GtkAccessible this--implements_0 implements_1 GtkBuildable this--implements_1 implements_2 GtkConstraintTarget this--implements_2 ancestor_0 GtkWidget ancestor_0--this ancestor_1 GInitiallyUnowned ancestor_1--ancestor_0 ancestor_2 GObject ancestor_2--ancestor_1

Ancestors

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)
gtk_widget_action_set_enabled

Enable or disable an action installed with gtk_widget_class_install_action().

gtk_widget_activate

For widgets that can be “activated” (buttons, menu items, etc.), this function activates them.

gtk_widget_activate_action

Looks up the action in the action groups associated with widget and its ancestors, and activates it.

gtk_widget_activate_action_variant

Looks up the action in the action groups associated with widget and its ancestors, and activates it.

gtk_widget_activate_default

Activates the default.activate action from widget.

gtk_widget_add_controller

Adds controller to widget so that it will receive events.

gtk_widget_add_css_class

Adds a style class to widget.

gtk_widget_add_mnemonic_label

Adds a widget to the list of mnemonic labels for this widget.

gtk_widget_add_tick_callback

Queues an animation frame update and adds a callback to be called before each frame.

gtk_widget_allocate

This function is only used by GtkWidget subclasses, to assign a size, position and (optionally) baseline to their child widgets.

gtk_widget_child_focus

Called by widgets as the user moves around the window using keyboard shortcuts.

gtk_widget_compute_bounds

Computes the bounds for widget in the coordinate space of target.

gtk_widget_compute_expand

Computes whether a container should give this widget extra space when possible.

gtk_widget_compute_point

Translates the given point in widgets coordinates to coordinates relative to target’s coordinate system.

gtk_widget_compute_transform

Computes a matrix suitable to describe a transformation from widgets coordinate system into targets coordinate system.

gtk_widget_contains

Tests if the point at (x, y) is contained in widget.

gtk_widget_create_pango_context

Creates a new PangoContext with the appropriate font map, font options, font description, and base direction for drawing text for this widget.

gtk_widget_create_pango_layout

Creates a new PangoLayout with the appropriate font map, font description, and base direction for drawing text for this widget.

gtk_drag_check_threshold

Checks to see if a drag movement has passed the GTK drag threshold.

gtk_widget_error_bell

Notifies the user about an input-related error on this widget.

gtk_widget_get_allocated_baseline

Returns the baseline that has currently been allocated to widget.

gtk_widget_get_allocated_height

Returns the height that has currently been allocated to widget.

gtk_widget_get_allocated_width

Returns the width that has currently been allocated to widget.

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.