Gtk.Picture
Description: Reference for Gtk.Picture

### Class

# GtkPicture

#### Description [src]

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

The `GtkPicture` widget displays a `GdkPaintable`.

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

#### Ancestors

- GtkWidget
- GInitiallyUnowned
- GObject

#### Implements

- GtkAccessible
- GtkBuildable
- GtkConstraintTarget

#### 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 (162)

Please see GtkWidget for a full list of methods.

##### Methods inherited from GObject (43)

Please see GObject for a full list of methods.

##### Methods inherited from GtkAccessible (19)

###### gtk_accessible_announce

Requests the user’s screen reader to announce the given message.

since: 4.14

###### gtk_accessible_get_accessible_parent

Retrieves the accessible parent for an accessible object.

since: 4.10

###### gtk_accessible_get_accessible_role

Retrieves the accessible role of an accessible object.

###### gtk_accessible_get_at_context

Retrieves the accessible implementation for the given `GtkAccessible`.

since: 4.10

###### gtk_accessible_get_bounds

Queries the coordinates and dimensions of this accessible.

since: 4.10

###### gtk_accessible_get_first_accessible_child

Retrieves the first accessible child of an accessible object.

since: 4.10

###### gtk_accessible_get_next_accessible_sibling

Retrieves the next accessible sibling of an accessible object.

since: 4.10

###### gtk_accessible_get_platform_state

Query a platform state, such as focus.

since: 4.10

###### 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_set_accessible_parent

Sets the parent and sibling of an accessible object.

since: 4.10

###### gtk_accessible_update_next_accessible_sibling

Updates the next accessible sibling of `self`.

since: 4.10

###### 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.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 (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)

###### GtkAccessible:accessible-role

The accessible role of the given `GtkAccessible` implementation.

#### Signals

##### Signals inherited from GtkWidget (13)

###### GtkWidget::destroy

Signals that all holders of a reference to the widget should release the reference that they hold.

###### GtkWidget::direction-changed

Emitted when the text direction of a widget changes.

###### GtkWidget::hide

Emitted when `widget` is hidden.

###### GtkWidget::keynav-failed

Emitted if keyboard navigation fails.

###### GtkWidget::map

Emitted when `widget` is going to be mapped.

###### GtkWidget::mnemonic-activate

Emitted when a widget is activated via a mnemonic.

###### GtkWidget::move-focus

Emitted when the focus is moved.

###### GtkWidget::query-tooltip

Emitted when the widget’s tooltip is about to be shown.

###### GtkWidget::realize

Emitted when `widget` is associated with a `GdkSurface`.

###### GtkWidget::show

Emitted when `widget` is shown.

###### GtkWidget::state-flags-changed

Emitted when the widget state changes.

###### GtkWidget::unmap

Emitted when `widget` is going to be unmapped.

###### GtkWidget::unrealize

Emitted when the `GdkSurface` associated with `widget` is destroyed.

##### Signals inherited from GObject (1)

###### GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

#### Class structure

    struct GtkPictureClass {
      GtkWidgetClass parent_class;

    }

No description available.

###### Class members

`parent_class: GtkWidgetClass`

  No description available.