IconPaintable#

class IconPaintable(**properties: Any)#

Superclasses: Object

Implemented Interfaces: Paintable, SymbolicPaintable

Contains information found when looking up an icon in GtkIconTheme.

GtkIconPaintable implements GdkPaintable.

Constructors#

class IconPaintable
classmethod new_for_file(file: File, size: int, scale: int) → IconPaintable#

Creates a GtkIconPaintable for a file with a given size and scale.

The icon can then be rendered by using it as a GdkPaintable.

Parameters:

  • file – a GFile

  • size – desired icon size, in application pixels

  • scale – the desired scale

Methods#

class IconPaintable
get_file() → File | None#

Gets the GFile that was used to load the icon.

Returns None if the icon was not loaded from a file.

get_icon_name() → str | None#

Get the icon name being used for this icon.

When an icon looked up in the icon theme was not available, the icon theme may use fallback icons - either those specified to lookup_icon() or the always-available “image-missing”. The icon chosen is returned by this function.

If the icon was created without an icon theme, this function returns None.

is_symbolic() → bool#

Checks if the icon is symbolic or not.

This currently uses only the file name and not the file contents for determining this. This behaviour may change in the future.

Note that to render a symbolic GtkIconPaintable properly (with recoloring), you have to set its icon name on a GtkImage.

Properties#

class IconPaintable
props.file: File#

The type of the None singleton.

props.icon_name: str#

The type of the None singleton.

props.is_symbolic: bool#

The type of the None singleton.