Struct gtk4::Image

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

The Image widget displays an image.

An example GtkImage

Various kinds of object can be displayed as an image; most typically, you would load a gdk::Texture from a file, using the convenience function from_file(), for instance:

⚠️ The following code is in c ⚠️

GtkWidget *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::Texture::from_file(), then create the Image with from_paintable().

Sometimes an application will want to avoid depending on external data files, such as image files. See the documentation of GResource inside GIO, for details. In this case, property::Image::resource, from_resource(), and set_from_resource() should be used.

Image displays its image as an icon, with a size that is determined by the application. See Picture if you want to show an image at is actual size.

CSS nodes

Image has a single CSS node with the name image. The style classes .normal-icons or .large-icons may appear, depending on the property::Image::icon-size property.

Accessibility

Image uses the GTK_ACCESSIBLE_ROLE_IMG role.

Implements

WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, WidgetExtManual, AccessibleExtManual

Implementations

Creates a new empty Image widget.

Returns

a newly created Image widget.

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 you need to detect failures to load the file, use gdk::Texture::from_file() to load the file yourself, then create the Image from the texture.

The storage type (see 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

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

Returns

a new Image displaying the themed icon

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

Returns

a new Image displaying the themed icon

Creates a new Image displaying @paintable.

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

The Image will track changes to the @paintable and update its size and contents in response to it.

paintable

a gdk::Paintable

Returns

a new 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.

This is a helper for from_paintable(), and you can’t get back the exact pixbuf once this is called, only a texture.

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

Returns

a new 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 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.

The storage type (see 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

Creates a new builder-pattern struct instance to construct Image objects.

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

Resets the image to be empty.

Gets the GIcon being displayed by the Image.

The storage type of the image must be ImageType::Empty or ImageType::Gicon (see storage_type()). The caller of this function does not own a reference to the returned GIcon.

Returns

a GIcon

Gets the icon name and size being displayed by the Image.

The storage type of the image must be ImageType::Empty or ImageType::IconName (see storage_type()). The returned string is owned by the Image and should not be freed.

Returns

the icon name

Gets the icon size used by the @self when rendering icons.

Returns

the image size used by icons

Gets the image gdk::Paintable being displayed by the Image.

The storage type of the image must be ImageType::Empty or ImageType::Paintable (see storage_type()). The caller of this function does not own a reference to the returned paintable.

Returns

the displayed paintable

Gets the pixel size used for named icons.

Returns

the pixel size used for named icons.

Gets the type of representation being used by the Image to store image data.

If the Image has no image data, the return value will be ImageType::Empty.

Returns

image representation being used

Sets a Image to show a file.

See from_file() for details.

filename

a filename

Sets a Image to show a GIcon.

See from_gicon() for details.

icon

an icon

Sets a Image to show a named icon.

See from_icon_name() for details.

icon_name

an icon name

Sets a Image to show a gdk::Paintable.

See from_paintable() for details.

paintable

a gdk::Paintable

Sets a Image to show a gdk_pixbuf::Pixbuf.

See from_pixbuf() for details.

Note: This is a helper for set_from_paintable(), and you can’t get back the exact pixbuf once this is called, only a paintable.

pixbuf

a gdk_pixbuf::Pixbuf or NULL

Sets a Image to show a resource.

See from_resource() for details.

resource_path

a resource path

Suggests an icon size to the theme for named icons.

icon_size

the new icon size

Sets the pixel size to use for named icons.

If the pixel size is set to a value != -1, it is used instead of the icon size set by set_from_icon_name().

pixel_size

the new pixel size

The `GFile to display.

The `GFile to display.

The GIcon displayed in the GtkImage.

For themed icons, If the icon theme is changed, the image will be updated automatically.

The name of the icon in the icon theme.

If the icon theme is changed, the image will be updated automatically.

The gdk::Paintable to display.

A path to a resource file to display.

A path to a resource file to display.

Whether the icon displayed in the Image will use standard icon names fallback.

The value of this property is only relevant for images of type ImageType::IconName and ImageType::Gicon.

Whether the icon displayed in the Image will use standard icon names fallback.

The value of this property is only relevant for images of type ImageType::IconName and ImageType::Gicon.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Returns the “default value” for a type. Read more

Formats the value using the given formatter. Read more

Feeds this value into the given Hasher. Read more

Feeds a slice of this type into the given Hasher. Read more

This method returns an Ordering between self and other. Read more

Compares and returns the maximum of two values. Read more

Compares and returns the minimum of two values. Read more

Restrict a value to a certain interval. Read more

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

This method tests for !=.

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

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

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

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

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

Returns the type identifier of Self.

Auto Trait Implementations

Blanket Implementations

Updates an array of accessible properties. Read more

Updates an array of accessible relations. Read more

Updates an array of accessible states. Read more

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Upcasts an object to a superclass or interface T. Read more

Upcasts an object to a reference of its superclass or interface T. Read more

Tries to downcast to a subclass or interface implementor T. Read more

Tries to downcast to a reference of its subclass or interface implementor T. Read more

Tries to cast to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while downcast and upcast will do many checks at compile-time already. Read more

Tries to cast to reference to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while downcast and upcast will do many checks at compile-time already. Read more

Casts to T unconditionally. Read more

Casts to &T unconditionally. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Returns true if the object is an instance of (can be cast to) T.

Returns the type of the object.

Returns the ObjectClass of the object. Read more

Returns the class of the object.

Returns the class of the object in the given type T. Read more

Returns the interface T of the object. Read more

Similar to Self::set_property but fails instead of panicking.

Sets the property property_name of the object to value value. Read more

Similar to Self::set_property but fails instead of panicking.

Sets the property property_name of the object to value value. Read more

Similar to Self::set_properties but fails instead of panicking.

Sets multiple properties of the object at once. Read more

Similar to Self::set_properties_from_value but fails instead of panicking.

Sets multiple properties of the object at once. Read more

Similar to Self::property but fails instead of panicking.

Gets the property property_name of the object and cast it to the type V. Read more

Similar to Self::property_value but fails instead of panicking.

Gets the property property_name of the object. Read more

Check if the object has a property property_name of the given type_. Read more

Get the type of the property property_name of this object. Read more

Get the ParamSpec of the property property_name of this object.

Return all ParamSpec of the properties of this object.

Freeze all property notifications until the return guard object is dropped. Read more

Set arbitrary data on this object with the given key. Read more

Return previously set arbitrary data of this object with the given key. Read more

Retrieve previously set arbitrary data of this object with the given key. Read more

Set arbitrary data on this object with the given key. Read more

Return previously set arbitrary data of this object with the given key. Read more

Retrieve previously set arbitrary data of this object with the given key. Read more

Block a given signal handler. Read more

Unblock a given signal handler.

Stop emission of the currently emitted signal.

Stop emission of the currently emitted signal by the (possibly detailed) signal name.

Similar to Self::connect but fails instead of panicking.

Connect to the signal signal_name on this object. Read more

Similar to Self::connect_id but fails instead of panicking.

Connect to the signal signal_id on this object. Read more

Similar to Self::connect_local but fails instead of panicking.

Connect to the signal signal_name on this object. Read more

Similar to Self::connect_local_id but fails instead of panicking.

Connect to the signal signal_id on this object. Read more

Similar to Self::connect_unsafe but fails instead of panicking.

Connect to the signal signal_name on this object. Read more

Similar to Self::connect_unsafe_id but fails instead of panicking.

Similar to Self::connect_closure but fails instead of panicking.

Connect a closure to the signal signal_name on this object. Read more

Similar to Self::connect_closure_id but fails instead of panicking.

Connect a closure to the signal signal_id on this object. Read more

Limits the lifetime of closure to the lifetime of the object. When the object’s reference count drops to zero, the closure will be invalidated. An invalidated closure will ignore any calls to Closure::invoke. Read more

Connect to the signal signal_id on this object. Read more

Similar to Self::emit but fails instead of panicking.

Emit signal by signal id. Read more

Similar to Self::emit_with_values but fails instead of panicking.

Same as Self::emit but takes Value for the arguments.

Similar to Self::emit_by_name but fails instead of panicking.

Emit signal by its name. Read more

Similar to Self::emit_by_name_with_values but fails instead of panicking.

Emit signal by its name. Read more

Similar to Self::emit_with_details but fails instead of panicking.

Emit signal by signal id with details. Read more

Similar to Self::emit_with_details_and_values but fails instead of panicking.

Emit signal by signal id with details. Read more

Disconnect a previously connected signal handler.

Connect to the notify signal of the object. Read more

Connect to the notify signal of the object. Read more

Connect to the notify signal of the object. Read more

Notify that the given property has changed its value. Read more

Notify that the given property has changed its value. Read more

Downgrade this object to a weak reference.

Bind property source_property on this object to the target_property on the target object. Read more

Returns the strong reference count of this object.

Ensures that the type has been registered with the type system.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

Uses borrowed data to replace owned data, usually by cloning. Read more

Converts the given value to a String. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.