class Gtk::Picture

• Gtk::Picture
• Gtk::Widget
• GObject::InitiallyUnowned
• GObject::Object
• Reference
• Object

Overview

The Gtk::Picture widget displays a Gdk::Paintable.

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:

WARNING ⚠️ The following code is in c ⚠️

Gtk::Widget *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 Gtk::Picture 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#resource= should be used.

Gtk::Picture displays an image at its natural size. See 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 Gtk::Picture by changing [property@Gtk.Picture:content-fit]. See 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 Gtk::Widget::halign and 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

Gtk::Picture has a single CSS node with the name picture.

Accessibility

Gtk::Picture uses the GTK_ACCESSIBLE_ROLE_IMG role.

Included Modules

• Gtk::Accessible
• Gtk::Buildable
• Gtk::ConstraintTarget

Defined in:

Constructors

• .new : self

  Creates a new empty Gtk::Picture widget.

• .new(*, accessible_role : Gtk::AccessibleRole? = nil, alternative_text : String? = nil, can_focus : Bool? = nil, can_shrink : Bool? = nil, can_target : Bool? = nil, content_fit : Gtk::ContentFit? = nil, css_classes : Enumerable(String)? = nil, css_name : String? = nil, cursor : Gdk::Cursor? = nil, file : Gio::File? = nil, focus_on_click : Bool? = nil, focusable : Bool? = nil, halign : Gtk::Align? = nil, has_default : Bool? = nil, has_focus : Bool? = nil, has_tooltip : Bool? = nil, height_request : Int32? = nil, hexpand : Bool? = nil, hexpand_set : Bool? = nil, keep_aspect_ratio : Bool? = nil, layout_manager : Gtk::LayoutManager? = nil, margin_bottom : Int32? = nil, margin_end : Int32? = nil, margin_start : Int32? = nil, margin_top : Int32? = nil, name : String? = nil, opacity : Float64? = nil, overflow : Gtk::Overflow? = nil, paintable : Gdk::Paintable? = nil, parent : Gtk::Widget? = nil, receives_default : Bool? = nil, root : Gtk::Root? = nil, scale_factor : Int32? = nil, sensitive : Bool? = nil, tooltip_markup : String? = nil, tooltip_text : String? = nil, valign : Gtk::Align? = nil, vexpand : Bool? = nil, vexpand_set : Bool? = nil, visible : Bool? = nil, width_request : Int32? = nil)
• .new_for_file(file : Gio::File?) : self

  Creates a new Gtk::Picture displaying the given @file.

• .new_for_filename(filename : String?) : self

  Creates a new Gtk::Picture displaying the file @filename.

• .new_for_paintable(paintable : Gdk::Paintable?) : self

  Creates a new Gtk::Picture displaying @paintable.

• .new_for_pixbuf(pixbuf : GdkPixbuf::Pixbuf?) : self

  Creates a new Gtk::Picture displaying @pixbuf.

• .new_for_resource(resource_path : String?) : self

  Creates a new Gtk::Picture displaying the resource at @resource_path.

Class Method Summary

• .g_type : UInt64

  Returns the type id (GType) registered in GLib type system.

Instance Method Summary

• #alternative_text : String?

  Gets the alternative textual description of the picture.

• #alternative_text=(value : String) : String
• #alternative_text=(alternative_text : String?) : Nil

  Sets an alternative textual description for the picture contents.

• #can_shrink : Bool

  Returns whether the Gtk::Picture respects its contents size.

• #can_shrink=(can_shrink : Bool) : Nil

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

• #can_shrink? : Bool
• #content_fit : Gtk::ContentFit

  Returns the fit mode for the content of the Gtk::Picture.

• #content_fit=(content_fit : Gtk::ContentFit) : Nil

  Sets how the content should be resized to fit the Gtk::Picture.

• #file : Gio::File?

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

• #file=(file : Gio::File?) : Nil

  Makes @self load and display @file.

• #filename=(filename : String?) : Nil

  Makes @self load and display the given @filename.

• #keep_aspect_ratio : Bool

  Returns whether the Gtk::Picture preserves its contents aspect ratio.

• #keep_aspect_ratio=(keep_aspect_ratio : Bool) : Nil

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

• #keep_aspect_ratio? : Bool
• #paintable : Gdk::Paintable?

  Gets the Gdk::Paintable being displayed by the Gtk::Picture.

• #paintable=(paintable : Gdk::Paintable?) : Nil

  Makes @self display the given @paintable.

• #pixbuf=(pixbuf : GdkPixbuf::Pixbuf?) : Nil

  Sets a Gtk::Picture to show a Gdk::Pixbuf.

• #resource=(resource_path : String?) : Nil

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

Constructor Detail

Class Method Detail

Instance Method Detail