class: Picture

[39:7] extends: object

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: c 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 and image loading framework such as libglycin, then create the GtkPicture with [ctor@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, [ctor@Gtk.Picture.new_for_resource] and [method@Gtk.Picture.set_resource] should be used. GtkPicture displays an image at its natural size. See [class@Gtk.Image] 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 [property@Gtk.Picture:content-fit]. See [enum@Gtk.ContentFit] for details. [property@Gtk.Picture: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 [property@Gtk.Widget:halign] and [property@Gtk.Widget: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 [enum@Gtk.AccessibleRole.img] role.

Members

• handleObj
• lib
• retainedCallbacks
• signalHandlerNames
• signalSetterHandlers

Methods

• Picture ()

  Creates a new empty GtkPicture widget.

• toNativeHandle (Source)

  Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.

  • @p Source is the raw handle, raw buffer, wrapper, or null.
  • @r A raw pointer carrier or null when no pointer is present.

• getLib ()

  Returns the opened native library for this generated wrapper.

  • @r The opened native library.

• handle ()

  Returns the wrapped NativeHandle.

  • @r The wrapped NativeHandle.

• isNull ()

  Returns true when the wrapped handle is null.

  • @r A bool.

• describe ()

  Returns a small string for debugging generated wrappers.

  • @r A string.

• asWidget ()

  Wraps this handle as Widget.

  • @r A Widget object.

• asAccessible ()

  Wraps this handle as Accessible.

  • @r A Accessible object.

• asBuildable ()

  Wraps this handle as Buildable.

  • @r A Buildable object.

• asConstraintTarget ()

  Wraps this handle as ConstraintTarget.

  • @r A ConstraintTarget object.

• getProperty (string Name)

  Reads one generated property by name.

• setProperty (string Name, Value)

  Writes one generated property by name.

• setAlternativetext (string Value)

  The alternative textual description for the picture.

  • @p Value is the new property value.
  • @r None.

• setCanshrink (bool Value)

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

  • @p Value is the new property value.
  • @r None.

• setContentfit (string Value)

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

  • @p Value is the new property value.
  • @r None.

• setFile (object Value)

  The GFile that is displayed or %NULL if none.

  • @p Value is the new property value.
  • @r None.

• setIsolatecontents (bool Value)

  If the rendering of the contents is isolated from the rest of the widget tree.

  • @p Value is the new property value.
  • @r None.

• setKeepaspectratio (bool Value)

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

  • @p Value is the new property value.
  • @r None.

• setPaintable (object Value)

  The GdkPaintable to be displayed by this GtkPicture.

  • @p Value is the new property value.
  • @r None.

• get_alternative_text ()

  Gets the alternative textual description of the picture. The returned string will be %NULL if the picture cannot be described textually.

• get_can_shrink ()

  Returns whether the GtkPicture respects its contents size.

• get_content_fit ()

  Returns the fit mode for the content of the GtkPicture. See [enum@Gtk.ContentFit] for details.

• get_file ()

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

  • @self is not displaying a file, for example when [method@Gtk.Picture.set_paintable] was used, then %NULL is returned.

• get_isolate_contents ()

  Returns whether the contents are isolated.

• get_keep_aspect_ratio ()

  Returns whether the GtkPicture preserves its contents aspect ratio.

• get_paintable ()

  Gets the GdkPaintable being displayed by the GtkPicture.

• set_alternative_text (string alternative_text)

  Sets an alternative textual description for the picture contents. It is equivalent to the "alt" attribute for images on websites. This text will be made available to accessibility tools. If the picture cannot be described textually, set this property to %NULL.

  • @p alternative_text is a textual description of the contents.
  • @r None.

• set_can_shrink (bool can_shrink)

  If set to %TRUE, then @self can be made smaller than its contents. The contents will then be scaled down when rendering. If you want to still force a minimum size manually, consider using [method@Gtk.Widget.set_size_request]. Also of note is that a similar function for growing does not exist because the grow behavior can be controlled via [method@Gtk.Widget.set_halign] and [method@Gtk.Widget.set_valign].

  • @p can_shrink is if @self can be made smaller than its contents.
  • @r None.

• set_content_fit (string content_fit)

  Sets how the content should be resized to fit the GtkPicture. See [enum@Gtk.ContentFit] for details.

  • @p content_fit is the content fit mode.
  • @r None.

• set_file (object file)

  Makes @self load and display @file. See [ctor@Gtk.Picture.new_for_file] for details. ::: warning Note that this function should not be used with untrusted data. Use a proper image loading framework such as libglycin, which can load many image formats into a GdkTexture, and then use [method@Gtk.Image.set_from_paintable].

  • @p file is a GFile.
  • @r None.

• set_filename (string filename)

  Makes @self load and display the given @filename. This is a utility function that calls [method@Gtk.Picture.set_file]. ::: warning Note that this function should not be used with untrusted data. Use a proper image loading framework such as libglycin, which can load many image formats into a GdkTexture, and then use [method@Gtk.Image.set_from_paintable].

  • @p filename is the filename to play.
  • @r None.

• set_isolate_contents (bool isolate_contents)

  If set to true, then the contents will be rendered individually. If set to false they will be able to erase or otherwise mix with the background. GTK supports finer grained isolation, in rare cases where you need this, you can use [method@Gtk.Snapshot.push_isolation] yourself to achieve this. By default contents are isolated.

  • @p isolate_contents is if contents are rendered separately.
  • @r None.

• set_keep_aspect_ratio (bool keep_aspect_ratio)

  If set to %TRUE, the @self will render its contents according to their aspect ratio. That means that empty space may show up at the top/bottom or left/right of @self. If set to %FALSE or if the contents provide no aspect ratio, the contents will be stretched over the picture's whole area.

  • @p keep_aspect_ratio is whether to keep aspect ratio.
  • @r None.

• set_paintable (object paintable)

  Makes @self display the given @paintable. If @paintable is NULL, nothing will be displayed. See [ctor@Gtk.Picture.new_for_paintable] for details.

  • @p paintable is a GdkPaintable.
  • @r None.

• set_pixbuf (object pixbuf)

  Sets a GtkPicture to show a GdkPixbuf. See [ctor@Gtk.Picture.new_for_pixbuf] for details. This is a utility function that calls [method@Gtk.Picture.set_paintable].

  • @p pixbuf is a GdkPixbuf.
  • @r None.

• set_resource (string resource_path)

  Makes @self load and display the resource at the given @resource_path. This is a utility function that calls [method@Gtk.Picture.set_file].

  • @p resource_path is the resource to set.
  • @r None.

class: PictureMeta

[550:14] static extends: object

Generated metadata helpers for Picture class surfaces.

Methods

• properties ()

  Returns property metadata for Picture.

  • @r A list.

class: PictureCtors

[472:14] static extends: object

Alternate constructors for Picture. Usage: PictureCtors.<name>(...). The primary constructor lives directly on Picture.

Methods

• newForFile (object file)

  Creates a new GtkPicture displaying the given @file. If the file isn’t found or can’t be loaded, the resulting GtkPicture is empty. If you need to detect failures to load the file, use an image loading framework such as libglycin to load the file yourself, then create the GtkPicture from the texture.

  • @p file is a GFile.
  • @r A new Picture.

• newForFilename (string filename)

  Creates a new GtkPicture displaying the file @filename. This is a utility function that calls [ctor@Gtk.Picture.new_for_file]. See that function for details.

  • @p filename is a filename.
  • @r A new Picture.

• newForPaintable (object paintable)

  Creates a new GtkPicture displaying @paintable. The GtkPicture will track changes to the @paintable and update its size and contents in response to it.

  • @p paintable is a GdkPaintable.
  • @r A new Picture.

• newForPixbuf (object pixbuf)

  Creates a new GtkPicture displaying @pixbuf. This is a utility function that calls [ctor@Gtk.Picture.new_for_paintable], See that function for details. The pixbuf must not be modified after passing it to this function.

  • @p pixbuf is a GdkPixbuf.
  • @r A new Picture.

• newForResource (string resource_path)

  Creates a new GtkPicture displaying the resource at @resource_path. This is a utility function that calls [ctor@Gtk.Picture.new_for_file]. See that function for details.

  • @p resource_path is resource path to play back.
  • @r A new Picture.