Class

GtkPicture

[]

Description [src]

final class Gtk.Picture : Gtk.Widget
  implements Gtk.Accessible, Gtk.Buildable, Gtk.ConstraintTarget {
  /* No available fields */
}

Displays a GdkPaintable.

picture> An example GtkPicture

Many convenience functions are provided to make pictures simple to use. For example, if you want to load an image from a file, and then display it, there’s a convenience function to do this:

GtkWidget *widget = gtk_picture_new_for_filename ("myfile.png");

If the file isn’t loaded successfully, the picture 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 GtkPicture with gtk_picture_new_for_paintable().

Sometimes an application will want to avoid depending on external data files, such as image files. See the documentation of GResource for details. In this case, gtk_picture_new_for_resource() and gtk_picture_set_resource() should be used.

GtkPicture displays an image at its natural size. See GtkImage if you want to display a fixed-size image, such as an icon.

Sizing the paintable

You can influence how the paintable is displayed inside the GtkPicture by changing GtkPicture:content-fit. See GtkContentFit for details. GtkPicture:can-shrink can be unset to make sure that paintables are never made smaller than their ideal size - but be careful if you do not know the size of the paintable in use (like when displaying user-loaded images). This can easily cause the picture to grow larger than the screen. And GtkWidget:halign and GtkWidget:valign can be used to make sure the paintable doesn’t fill all available space but is instead displayed at its original size.

CSS nodes

GtkPicture has a single CSS node with the name picture.

Accessibility

GtkPicture uses the GTK_ACCESSIBLE_ROLE_IMG role.

[]

Hierarchy

hierarchy this GtkPicture 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
[]

Constructors

gtk_picture_new

Creates a new empty GtkPicture widget.

gtk_picture_new_for_file

Creates a new GtkPicture displaying the given file.

gtk_picture_new_for_filename

Creates a new GtkPicture displaying the file filename.

gtk_picture_new_for_paintable

Creates a new GtkPicture displaying paintable.

gtk_picture_new_for_pixbuf

Creates a new GtkPicture displaying pixbuf.

deprecated: 4.12 

gtk_picture_new_for_resource

Creates a new GtkPicture displaying the resource at resource_path.

[]

Instance methods

gtk_picture_get_alternative_text

Gets the alternative textual description of the picture.

gtk_picture_get_can_shrink

Returns whether the GtkPicture respects its contents size.

gtk_picture_get_content_fit

Returns the fit mode for the content of the GtkPicture.

since: 4.8

gtk_picture_get_file

Gets the GFile currently displayed if self is displaying a file.

gtk_picture_get_keep_aspect_ratio

Returns whether the GtkPicture preserves its contents aspect ratio.

deprecated: 4.8 

gtk_picture_get_paintable

Gets the GdkPaintable being displayed by the GtkPicture.

gtk_picture_set_alternative_text

Sets an alternative textual description for the picture contents.

gtk_picture_set_can_shrink

If set to TRUE, the self can be made smaller than its contents.

gtk_picture_set_content_fit

Sets how the content should be resized to fit the GtkPicture.

since: 4.8

gtk_picture_set_file

Makes self load and display file.

gtk_picture_set_filename

Makes self load and display the given filename.

gtk_picture_set_keep_aspect_ratio

If set to TRUE, the self will render its contents according to their aspect ratio.

deprecated: 4.8 

gtk_picture_set_paintable

Makes self display the given paintable.

gtk_picture_set_pixbuf

Sets a GtkPicture to show a GdkPixbuf.

deprecated: 4.12 

gtk_picture_set_resource

Makes self load and display the resource at the given resource_path.

Methods inherited from GtkWidget (164)
Methods inherited from GObject (43)
Methods inherited from GtkAccessible (20)
Methods inherited from GtkBuildable (1)
[]

Properties

Gtk.Picture:alternative-text

The alternative textual description for the picture.

Gtk.Picture:can-shrink

If the GtkPicture can be made smaller than the natural size of its contents.

Gtk.Picture:content-fit

How the content should be resized to fit inside the GtkPicture.

since: 4.8

Gtk.Picture:file

The GFile that is displayed or NULL if none.

Gtk.Picture:keep-aspect-ratio

Whether the GtkPicture will render its contents trying to preserve the aspect ratio.

deprecated: 4.8 

Gtk.Picture:paintable

The GdkPaintable to be displayed by this GtkPicture.

Properties inherited from GtkWidget (35)
Properties inherited from GtkAccessible (1)
[]

Signals

Signals inherited from GtkWidget (13)
Signals inherited from GObject (1)

Class structure