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 IconTheme.lookupIcon followed by 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.

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

scale int

desired scale

forWindow Window

gdk.Window to optimize drawing for, or NULL

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 Surface.destroy to release your reference to the icon. NULL if the icon isn’t found.

Throws

GException on failure.

Meta

Since

3.10