IconTheme.loadSurface

Looks up an icon in an icon theme for a particular window scale, scales it to the given size and renders it into a cairo surface. This is a convenience function; if more details about the icon are needed, use gtk_icon_theme_lookup_icon() followed by gtk_icon_info_load_surface(). Note that you probably want to listen for icon theme changes and update the icon. This is usually done by connecting to the GtkWidget::style-set signal.

class IconTheme
loadSurface

Parameters

iconName string

the name of the icon to lookup

size int

the desired icon size. The resulting icon may not be exactly this size; see gtk_icon_info_load_icon().

scale int

desired scale

forWindow Window

GdkWindow to optimize drawing for, or NULL. [allow-none]

flags GtkIconLookupFlags

flags modifying the behavior of the icon lookup

Return Value

Type: Surface

the rendered icon; this may be a newly created icon or a new reference to an internal icon, so you must not modify the icon. Use cairo_surface_destroy() to release your reference to the icon. NULL if the icon isn't found. [transfer full] Since 3.10

Throws

GException on failure.

Meta