:right-sidebar: True

GutterRendererPixbuf
===================================================================

.. currentmodule:: gi.repository.GtkSource





.. class:: GutterRendererPixbuf(**properties: ~typing.Any)
   :no-contents-entry:


Superclasses: :class:`~gi.repository.GtkSource.GutterRenderer`, :class:`~gi.repository.Gtk.Widget`, :class:`~gi.repository.GObject.InitiallyUnowned`, :class:`~gi.repository.GObject.Object`



Implemented Interfaces: :class:`~gi.repository.Gtk.Accessible`, :class:`~gi.repository.Gtk.Buildable`, :class:`~gi.repository.Gtk.ConstraintTarget`



Renders a pixbuf in the gutter.

A ``GtkSourceGutterRendererPixbuf`` can be used to render an image in a cell of
:obj:`~gi.repository.GtkSource.Gutter`\.


Constructors
------------

.. rst-class:: interim-class

.. class:: GutterRendererPixbuf
   :no-index:


   .. classmethod:: new() -> ~gi.repository.GtkSource.GutterRenderer

      Create a new :obj:`~gi.repository.GtkSource.GutterRendererPixbuf`\.













Methods
-------

.. rst-class:: interim-class

.. class:: GutterRendererPixbuf
   :no-index:


   .. method:: get_gicon() -> ~gi.repository.Gio.Icon

      Get the gicon of the renderer









   .. method:: get_icon_name() -> str

      









   .. method:: get_paintable() -> ~gi.repository.Gdk.Paintable | None

      Gets a :obj:`~gi.repository.Gdk.Paintable` that was set with
      :obj:`~gi.repository.GutterRendererPixbuf.set_paintable`









   .. method:: get_pixbuf() -> ~gi.repository.GdkPixbuf.Pixbuf

      Get the pixbuf of the renderer.









   .. method:: overlay_paintable(paintable: ~gi.repository.Gdk.Paintable) -> None

      Allows overlaying a paintable on top of any other image that
      has been set for the pixbuf. This will be applied when the
      widget is next snapshot.






      :param paintable: a :obj:`~gi.repository.Gdk.Paintable`




   .. method:: set_gicon(icon: ~gi.repository.Gio.Icon | None = None) -> None

      






      :param icon: the icon, or :const:`None`.




   .. method:: set_icon_name(icon_name: str | None = None) -> None

      






      :param icon_name: the icon name, or :const:`None`.




   .. method:: set_paintable(paintable: ~gi.repository.Gdk.Paintable | None = None) -> None

      






      :param paintable: the paintable, or :const:`None`.




   .. method:: set_pixbuf(pixbuf: ~gi.repository.GdkPixbuf.Pixbuf | None = None) -> None

      






      :param pixbuf: the pixbuf, or :const:`None`.








Properties
----------

.. rst-class:: interim-class

.. class:: GutterRendererPixbuf
   :no-index:
   

   .. attribute:: props.gicon
      :type: ~gi.repository.Gio.Icon

      The type of the None singleton.







   .. attribute:: props.icon_name
      :type: str

      The type of the None singleton.







   .. attribute:: props.paintable
      :type: ~gi.repository.Gdk.Paintable

      The type of the None singleton.







   .. attribute:: props.pixbuf
      :type: ~gi.repository.GdkPixbuf.Pixbuf

      The type of the None singleton.















Fields
------

.. rst-class:: interim-class

.. class:: GutterRendererPixbuf
   :no-index:
   

   .. attribute:: parent_instance