Method

Gtk.IconTheme.lookup_icon

Declaration [src]

GtkIconPaintable*
gtk_icon_theme_lookup_icon (
  GtkIconTheme* self,
  const char* icon_name,
  const char** fallbacks,
  int size,
  int scale,
  GtkTextDirection direction,
  GtkIconLookupFlags flags
)

Description [src]

Looks up a named icon for a desired size and window scale, returning a GtkIconPaintable.

The icon can then be rendered by using it as a GdkPaintable, or you can get information such as the filename and size.

If the available icon_name is not available and fallbacks are provided, they will be tried in order.

If no matching icon is found, then a paintable that renders the “missing icon” icon is returned. If you need to do something else for missing icons you need to use gtk_icon_theme_has_icon().

Note that you probably want to listen for icon theme changes and update the icon. This is usually done by overriding the GtkWidgetClass.css-changed() function.

Parameters

icon_name const char*
 

the name of the icon to lookup

 Ownership is not transferred to the callee
 The string is a NUL terminated UTF-8 string
fallbacks An array of char*
  No description available.
 Can be NULL
 Ownership is not transferred to the callee
size int
 

desired icon size.

scale int
 

the window scale this will be displayed on

direction GtkTextDirection
 

text direction the icon will be displayed in

flags GtkIconLookupFlags
 

flags modifying the behavior of the icon lookup

Return value

Returns: GtkIconPaintable

a GtkIconPaintable object containing the icon.

Ownership of the data is transferred to the caller