Struct gtk::Image

#[repr(transparent)]
pub struct Image { /* private fields */ }

The Image widget displays an image. Various kinds of object can be displayed as an image; most typically, you would load a gdk_pixbuf::Pixbuf (“pixel buffer”) from a file, and then display that. There’s a convenience function to do this, from_file(), used as follows:

⚠️ The following code is in C ⚠️

  GtkWidget *image;
  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 gdk_pixbuf::Pixbuf::from_file(), then create the Image with from_pixbuf().

The image file may contain an animation, if so the Image will display an animation (gdk_pixbuf::PixbufAnimation) instead of a static image.

Image is a subclass of Misc, which implies that you can align it (center, left, right) and add padding to it, using Misc methods.

Image is a “no window” widget (has no gdk::Window of its own), so by default does not receive events. If you want to receive events on the image, such as button clicks, place the image inside a EventBox, then connect to the event signals on the event box.

Handling button press events on a Image.

⚠️ The following code is in C ⚠️

  static gboolean
  button_press_callback (GtkWidget      *event_box,
                         GdkEventButton *event,
                         gpointer        data)
  {
    g_print ("Event box clicked at coordinates %f,%f\n",
             event->x, event->y);

    // Returning TRUE means we handled the event, so the signal
    // emission should be stopped (don’t call any further callbacks
    // that may be connected). Return FALSE to continue invoking callbacks.
    return TRUE;
  }

  static GtkWidget*
  create_image (void)
  {
    GtkWidget *image;
    GtkWidget *event_box;

    image = gtk_image_new_from_file ("myfile.png");

    event_box = gtk_event_box_new ();

    gtk_container_add (GTK_CONTAINER (event_box), image);

    g_signal_connect (G_OBJECT (event_box),
                      "button_press_event",
                      G_CALLBACK (button_press_callback),
                      image);

    return image;
  }

When handling events on the event box, keep in mind that coordinates in the image may be different from event box coordinates due to the alignment and padding settings on the image (see Misc). The simplest way to solve this is to set the alignment to 0.0 (left/top), and set the padding to zero. Then the origin of the image will be the same as the origin of the event box.

Sometimes an application will want to avoid depending on external data files, such as image files. GTK+ comes with a program to avoid this, called “gdk-pixbuf-csource”. This library allows you to convert an image into a C variable declaration, which can then be loaded into a gdk_pixbuf::Pixbuf using gdk_pixbuf_new_from_inline().

CSS nodes

GtkImage has a single CSS node with the name image. The style classes may appear on image CSS nodes: .icon-dropshadow, .lowres-icon.

Implements

ImageExt, [MiscExt][trait@crate::prelude::MiscExt], WidgetExt, glib::ObjectExt, BuildableExt, ImageExtManual, WidgetExtManual, BuildableExtManual

Implementations

impl Image

pub const NONE: Option<&'static Image> = None

pub fn new() -> Image

Creates a new empty Image widget.

Returns

a newly created Image widget.

pub fn from_animation(animation: &impl IsA<PixbufAnimation>) -> Image

Creates a Image displaying the given animation. The Image does not assume a reference to the animation; you still need to unref it if you own references. Image will add its own reference rather than adopting yours.

Note that the animation frames are shown using a timeout with G_PRIORITY_DEFAULT. When using animations to indicate busyness, keep in mind that the animation will only be shown if the main loop is not busy with something that has a higher priority.

animation

an animation

Returns

a new Image widget

pub fn from_file(filename: impl AsRef<Path>) -> Image

Creates a new Image displaying the file filename. If the file isn’t found or can’t be loaded, the resulting Image will display a “broken image” icon. This function never returns None, it always returns a valid Image widget.

If the file contains an animation, the image will contain an animation.

If you need to detect failures to load the file, use gdk_pixbuf::Pixbuf::from_file() to load the file yourself, then create the Image from the pixbuf. (Or for animations, use gdk_pixbuf::PixbufAnimation::from_file()).

The storage type (ImageExt::storage_type()) of the returned image is not defined, it will be whatever is appropriate for displaying the file.

filename

a filename

Returns

a new Image

pub fn from_gicon(icon: &impl IsA<Icon>, size: IconSize) -> Image

Creates a Image displaying an icon from the current icon theme. If the icon name isn’t known, a “broken image” icon will be displayed instead. If the current icon theme is changed, the icon will be updated appropriately.

icon

an icon

size

a stock icon size (IconSize)

Returns

a new Image displaying the themed icon

pub fn from_icon_name(icon_name: Option<&str>, size: IconSize) -> Image

Creates a Image displaying an icon from the current icon theme. If the icon name isn’t known, a “broken image” icon will be displayed instead. If the current icon theme is changed, the icon will be updated appropriately.

icon_name

an icon name or None

size

a stock icon size (IconSize)

Returns

a new Image displaying the themed icon

pub fn from_pixbuf(pixbuf: Option<&Pixbuf>) -> Image

Creates a new Image displaying pixbuf. The Image does not assume a reference to the pixbuf; you still need to unref it if you own references. Image will add its own reference rather than adopting yours.

Note that this function just creates an Image from the pixbuf. The Image created will not react to state changes. Should you want that, you should use from_icon_name().

pixbuf

a gdk_pixbuf::Pixbuf, or None

Returns

a new Image

pub fn from_resource(resource_path: &str) -> Image

Creates a new Image displaying the resource file resource_path. If the file isn’t found or can’t be loaded, the resulting Image will display a “broken image” icon. This function never returns None, it always returns a valid Image widget.

If the file contains an animation, the image will contain an animation.

If you need to detect failures to load the file, use gdk_pixbuf::Pixbuf::from_file() to load the file yourself, then create the Image from the pixbuf. (Or for animations, use gdk_pixbuf::PixbufAnimation::from_file()).

The storage type (ImageExt::storage_type()) of the returned image is not defined, it will be whatever is appropriate for displaying the file.

resource_path

a resource path

Returns

a new Image

pub fn from_surface(surface: Option<&Surface>) -> Image

Creates a new Image displaying surface. The Image does not assume a reference to the surface; you still need to unref it if you own references. Image will add its own reference rather than adopting yours.

surface

a cairo::Surface, or None

Returns

a new Image

impl Image

pub fn builder() -> ImageBuilder

Creates a new builder-style object to construct a Image.

This method returns an instance of ImageBuilder which can be used to create a Image.

Trait Implementations

impl Clone for Image

fn clone(&self) -> Self

Returns a copy of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Image

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Image

fn default() -> Self

Returns the “default value” for a type.

impl Display for Image

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for Image

fn hash<H>(&self, state: &mut H)where
    H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,

Feeds a slice of this type into the given Hasher.

impl Ord for Image

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

const fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

const fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

const fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for Image

type Parent = Misc

impl<OT: ObjectType> PartialEq<OT> for Image

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for Image

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

const fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

const fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

const fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

const fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Image

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Image

impl IsA<Buildable> for Image

impl IsA<Misc> for Image

impl IsA<Widget> for Image