Gtk.Image – gtk4 – Vala Binding Reference

Object Hierarchy:

Description:

[ CCode ( type_id = "gtk_image_get_type ()" ) ]
public class Image : Widget, Accessible, Buildable, ConstraintTarget

The `GtkImage` widget displays an image.

![An example GtkImage](image.png)

Various kinds of object can be displayed as an image; most typically, you would load a `GdkTexture` from a file, using the convenience function [[email protected]_from_file], for instance:

```c 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 [ [email protected]_from_file], then create the `GtkImage` with [[email protected]_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, [[email protected]:resource], [[email protected]_from_resource], and [ [email protected]_from_resource] should be used.

`GtkImage` displays its image as an icon, with a size that is determined by the application. See [[email protected]] 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 [[email protected]:icon-size] property.

Accessibility

`GtkImage` uses the `GTK_ACCESSIBLE_ROLE_IMG` role.

Namespace: Gtk

Package: gtk4

Content:

Properties:

public string file { owned get; set; }

The `GFile to display.

public Icon gicon { owned get; set; }

The `GIcon` displayed in the GtkImage.

public string icon_name { owned get; set; }

The name of the icon in the icon theme.

public IconSize icon_size { get; set; }

The symbolic size to display icons at.

public Paintable paintable { owned get; set; }

The `GdkPaintable` to display.

public int pixel_size { get; set; }

The size in pixels to display icons at.

public string resource { owned get; set; }

A path to a resource file to display.

public ImageType storage_type { get; }

The representation being used for image data.

public bool use_fallback { get; set; }

Whether the icon displayed in the `GtkImage` will use standard icon names fallback.

Creation methods:

public Image ()

Creates a new empty `GtkImage` widget.

public Image.from_file (string filename)

Creates a new `GtkImage` displaying the file filename.

public Image.from_gicon (Icon icon)

Creates a `GtkImage` displaying an icon from the current icon theme.

public Image.from_icon_name (string? icon_name)

Creates a `GtkImage` displaying an icon from the current icon theme.

public Image.from_paintable (Paintable? paintable)

Creates a new `GtkImage` displaying paintable.

public Image.from_pixbuf (Pixbuf? pixbuf)

Creates a new `GtkImage` displaying pixbuf.

public Image.from_resource (string resource_path)

Creates a new `GtkImage` displaying the resource file


									resource_path

Methods:

public void clear ()

Resets the image to be empty.

public unowned Icon? get_gicon ()

Gets the `GIcon` being displayed by the `GtkImage`.

public unowned string? get_icon_name ()

Gets the icon name and size being displayed by the `GtkImage`.

public IconSize get_icon_size ()

Gets the icon size used by the this when rendering icons.

public unowned Paintable? get_paintable ()

Gets the image `GdkPaintable` being displayed by the `GtkImage`.

public int get_pixel_size ()

Gets the pixel size used for named icons.

public ImageType get_storage_type ()

Gets the type of representation being used by the `GtkImage` to store image data.

public void set_from_file (string? filename)

Sets a `GtkImage` to show a file.

public void set_from_gicon (Icon icon)

Sets a `GtkImage` to show a `GIcon`.

public void set_from_icon_name (string? icon_name)

Sets a `GtkImage` to show a named icon.

public void set_from_paintable (Paintable? paintable)

Sets a `GtkImage` to show a `GdkPaintable`.

public void set_from_pixbuf (Pixbuf? pixbuf)

Sets a `GtkImage` to show a `GdkPixbuf`.

public void set_from_resource (string? resource_path)

Sets a `GtkImage` to show a resource.

public void set_icon_size (IconSize icon_size)

Suggests an icon size to the theme for named icons.

public void set_pixel_size (int pixel_size)

Sets the pixel size to use for named icons.

Inherited Members:

All known members inherited from class GLib.Object

@get
@new
@ref
@set
add_toggle_ref
add_weak_pointer
bind_property
connect
constructed
disconnect
dispose
dup_data
dup_qdata
force_floating
freeze_notify
get_class
get_data

get_property
get_qdata
get_type
getv
interface_find_property
interface_install_property
interface_list_properties
is_floating
new_valist
new_with_properties
newv
notify
notify_property
ref_count
ref_sink
remove_toggle_ref
remove_weak_pointer

replace_data
replace_qdata
set_data
set_data_full
set_property
set_qdata
set_qdata_full
set_valist
setv
steal_data
steal_qdata
thaw_notify
unref
watch_closure
weak_ref
weak_unref