IconInfo.loadSymbolic

Loads an icon, modifying it to match the system colours for the foreground, success, warning and error colors provided. If the icon is not a symbolic one, the function will return the result from IconInfo.loadIcon.

This allows loading symbolic icons that will match the system theme.

Unless you are implementing a widget, you will want to use ThemedIcon.newWithDefaultFallbacks to load the icon.

As implementation details, the icon loaded needs to be of SVG type, contain the “symbolic” term as the last component of the icon name, and use the “fg”, “success”, “warning” and “error” CSS styles in the SVG file itself.

See the Symbolic Icons Specification for more information about symbolic icons.

Parameters

fg RGBA

a gdk.RGBA representing the foreground color of the icon

successColor RGBA

a gdk.RGBA representing the warning color of the icon or NULL to use the default color

warningColor RGBA

a gdk.RGBA representing the warning color of the icon or NULL to use the default color

errorColor RGBA

a gdk.RGBA representing the error color of the icon or NULL to use the default color (allow-none)

wasSymbolic bool

a gboolean, returns whether the loaded icon was a symbolic one and whether the fg color was applied to it.

Return Value

Type: Pixbuf

a gdk.Pixbuf representing the loaded icon

Throws

GException on failure.

Meta