Method

StIconThemelookup_icon

Declaration [src]

StIconInfo*
st_icon_theme_lookup_icon (
  StIconTheme* icon_theme,
  const char* icon_name,
  int size,
  StIconLookupFlags flags
)

Description [src]

Looks up a named icon and returns a StIconInfo containing information such as the filename of the icon. The icon can then be rendered into a pixbuf using st_icon_info_load_icon(). (st_icon_theme_load_icon() combines these two steps if all you need is the pixbuf.)

When rendering on displays with high pixel densities you should not use a size multiplied by the scaling factor returned by functions like gdk_window_get_scale_factor(). Instead, you should use st_icon_theme_lookup_icon_for_scale(), as the assets loaded for a given scaling factor may be different.

Parameters

icon_name

Type: const char*

The name of the icon to lookup.

The data is owned by the caller of the method.
The value is a NUL terminated UTF-8 string.
size

Type: int

Desired icon size.

flags

Type: StIconLookupFlags

Flags modifying the behavior of the icon lookup.

Return value

Type: StIconInfo

A StIconInfo object containing information about the icon, or NULL if the icon wasn’t found.

The caller of the method takes ownership of the data, and is responsible for freeing it.
The return value can be NULL.