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.IconTheme.lookupIcon followed by gtk.icon_info.IconInfo.loadSurface.

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.

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.IconInfo.loadIcon.

scale int

desired scale

forWindow gdk.window.Window

#GdkWindow to optimize drawing for, or null

flags gtk.types.IconLookupFlags

flags modifying the behavior of the icon lookup

Return Value

Type: cairo.surface.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.Surface.destroy to release your reference to the icon. null if the icon isn’t found.

Throws