Skip to content

Gtk.SymbolicPaintable

interface

An interface that supports symbolic colors in paintables.

GdkPaintables implementing the interface will have the SymbolicPaintable.snapshot_symbolic function called and have the colors for drawing symbolic icons passed. At least 5 colors are guaranteed to be passed every time. These 5 colors are the foreground color, and the colors to use for errors, warnings and success information in that order, followed by the system accent color.

The system accent color has been added in GTK 4.22. More colors may be added in the future.

Methods

snapshot_symbolic

def snapshot_symbolic(self, snapshot: Gdk.Snapshot, width: float, height: float, colors: list[Gdk.RGBA]) -> None

Snapshots the paintable with the given colors.

If less than 5 colors are provided, GTK will pad the array with default colors.

Parameters:

  • snapshot — a GdkSnapshot to snapshot to
  • width — width to snapshot in
  • height — height to snapshot in
  • colors — a pointer to an array of colors

snapshot_with_weight

def snapshot_with_weight(self, snapshot: Gdk.Snapshot, width: float, height: float, colors: list[Gdk.RGBA], weight: float) -> None

Snapshots the paintable with the given colors and weight.

If less than 5 colors are provided, GTK will pad the array with default colors.

Parameters:

  • snapshot — a GdkSnapshot to snapshot to
  • width — width to snapshot in
  • height — height to snapshot in
  • colors — a pointer to an array of colors
  • weight — The font weight to use (from 1 to 1000, with default 400)

Virtual methods

do_snapshot_symbolic

def do_snapshot_symbolic(self, snapshot: Gdk.Snapshot, width: float, height: float, colors: list[Gdk.RGBA]) -> None

Snapshots the paintable with the given colors.

If less than 5 colors are provided, GTK will pad the array with default colors.

Parameters:

  • snapshot — a GdkSnapshot to snapshot to
  • width — width to snapshot in
  • height — height to snapshot in
  • colors — a pointer to an array of colors

do_snapshot_with_weight

def do_snapshot_with_weight(self, snapshot: Gdk.Snapshot, width: float, height: float, colors: list[Gdk.RGBA], weight: float) -> None

Snapshots the paintable with the given colors and weight.

If less than 5 colors are provided, GTK will pad the array with default colors.

Parameters:

  • snapshot — a GdkSnapshot to snapshot to
  • width — width to snapshot in
  • height — height to snapshot in
  • colors — a pointer to an array of colors
  • weight — The font weight to use (from 1 to 1000, with default 400)