load_symbolic


Description:

[ Version ( since = "3.0" ) ]
public Pixbuf load_symbolic (RGBA fg, RGBA? success_color = null, RGBA? warning_color = null, RGBA? error_color = null, out bool was_symbolic = null) throws Error

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 load_icon.

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

Unless you are implementing a widget, you will want to use ThemedIcon.with_default_fallbacks 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:

this

a IconInfo

fg

a RGBA representing the foreground color of the icon

success_color

a RGBA representing the warning color of the icon or null to use the default color

warning_color

a RGBA representing the warning color of the icon or null to use the default color

error_color

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

was_symbolic

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

Returns:

a Pixbuf representing the loaded icon