gtk/auto/

cell_renderer.rs

// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT

use crate::{
    CellEditable, CellRendererMode, CellRendererState, Requisition, SizeRequestMode, StateFlags,
    TreePath, Widget,
};
use glib::{
    prelude::*,
    signal::{connect_raw, SignalHandlerId},
    translate::*,
};
use std::{boxed::Box as Box_, fmt, mem, mem::transmute};

glib::wrapper! {
    /// The [`CellRenderer`][crate::CellRenderer] is a base class of a set of objects used for
    /// rendering a cell to a [`cairo::Context`][crate::cairo::Context]. These objects are used primarily by
    /// the [`TreeView`][crate::TreeView] widget, though they aren’t tied to them in any
    /// specific way. It is worth noting that [`CellRenderer`][crate::CellRenderer] is not a
    /// [`Widget`][crate::Widget] and cannot be treated as such.
    ///
    /// The primary use of a [`CellRenderer`][crate::CellRenderer] is for drawing a certain graphical
    /// elements on a [`cairo::Context`][crate::cairo::Context]. Typically, one cell renderer is used to
    /// draw many cells on the screen. To this extent, it isn’t expected that a
    /// CellRenderer keep any permanent state around. Instead, any state is set
    /// just prior to use using `GObjects` property system. Then, the
    /// cell is measured using `gtk_cell_renderer_get_size()`. Finally, the cell
    /// is rendered in the correct location using [`CellRendererExt::render()`][crate::prelude::CellRendererExt::render()].
    ///
    /// There are a number of rules that must be followed when writing a new
    /// [`CellRenderer`][crate::CellRenderer]. First and foremost, it’s important that a certain set
    /// of properties will always yield a cell renderer of the same size,
    /// barring a `GtkStyle` change. The [`CellRenderer`][crate::CellRenderer] also has a number of
    /// generic properties that are expected to be honored by all children.
    ///
    /// Beyond merely rendering a cell, cell renderers can optionally
    /// provide active user interface elements. A cell renderer can be
    /// “activatable” like [`CellRendererToggle`][crate::CellRendererToggle],
    /// which toggles when it gets activated by a mouse click, or it can be
    /// “editable” like [`CellRendererText`][crate::CellRendererText], which
    /// allows the user to edit the text using a widget implementing the
    /// [`CellEditable`][crate::CellEditable] interface, e.g. [`Entry`][crate::Entry].
    /// To make a cell renderer activatable or editable, you have to
    /// implement the `GtkCellRendererClass.activate` or
    /// `GtkCellRendererClass.start_editing` virtual functions, respectively.
    ///
    /// Many properties of [`CellRenderer`][crate::CellRenderer] and its subclasses have a
    /// corresponding “set” property, e.g. “cell-background-set” corresponds
    /// to “cell-background”. These “set” properties reflect whether a property
    /// has been set or not. You should not set them independently.
    ///
    /// This is an Abstract Base Class, you cannot instantiate it.
    ///
    /// ## Properties
    ///
    ///
    /// #### `cell-background`
    ///  Writeable
    ///
    ///
    /// #### `cell-background-gdk`
    ///  Cell background as a `GdkColor`
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `cell-background-rgba`
    ///  Cell background as a [`gdk::RGBA`][crate::gdk::RGBA]
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `cell-background-set`
    ///  Readable | Writeable
    ///
    ///
    /// #### `editing`
    ///  Readable
    ///
    ///
    /// #### `height`
    ///  Readable | Writeable
    ///
    ///
    /// #### `is-expanded`
    ///  Readable | Writeable
    ///
    ///
    /// #### `is-expander`
    ///  Readable | Writeable
    ///
    ///
    /// #### `mode`
    ///  Readable | Writeable
    ///
    ///
    /// #### `sensitive`
    ///  Readable | Writeable
    ///
    ///
    /// #### `visible`
    ///  Readable | Writeable
    ///
    ///
    /// #### `width`
    ///  Readable | Writeable
    ///
    ///
    /// #### `xalign`
    ///  Readable | Writeable
    ///
    ///
    /// #### `xpad`
    ///  Readable | Writeable
    ///
    ///
    /// #### `yalign`
    ///  Readable | Writeable
    ///
    ///
    /// #### `ypad`
    ///  Readable | Writeable
    ///
    /// ## Signals
    ///
    ///
    /// #### `editing-canceled`
    ///  This signal gets emitted when the user cancels the process of editing a
    /// cell. For example, an editable cell renderer could be written to cancel
    /// editing when the user presses Escape.
    ///
    /// See also: [`CellRendererExt::stop_editing()`][crate::prelude::CellRendererExt::stop_editing()].
    ///
    ///
    ///
    ///
    /// #### `editing-started`
    ///  This signal gets emitted when a cell starts to be edited.
    /// The intended use of this signal is to do special setup
    /// on `editable`, e.g. adding a [`EntryCompletion`][crate::EntryCompletion] or setting
    /// up additional columns in a [`ComboBox`][crate::ComboBox].
    ///
    /// See [`CellEditableExt::start_editing()`][crate::prelude::CellEditableExt::start_editing()] for information on the lifecycle of
    /// the `editable` and a way to do setup that doesn’t depend on the `renderer`.
    ///
    /// Note that GTK+ doesn't guarantee that cell renderers will
    /// continue to use the same kind of widget for editing in future
    /// releases, therefore you should check the type of `editable`
    /// before doing any specific setup, as in the following example:
    ///
    ///
    /// **⚠️ The following code is in C ⚠️**
    ///
    /// ```C
    /// static void
    /// text_editing_started (GtkCellRenderer *cell,
    ///                       GtkCellEditable *editable,
    ///                       const gchar     *path,
    ///                       gpointer         data)
    /// {
    ///   if (GTK_IS_ENTRY (editable))
    ///     {
    ///       GtkEntry *entry = GTK_ENTRY (editable);
    ///
    ///       // ... create a GtkEntryCompletion
    ///
    ///       gtk_entry_set_completion (entry, completion);
    ///     }
    /// }
    /// ```
    ///
    ///
    ///
    /// # Implements
    ///
    /// [`CellRendererExt`][trait@crate::prelude::CellRendererExt], [`trait@glib::ObjectExt`]
    #[doc(alias = "GtkCellRenderer")]
    pub struct CellRenderer(Object<ffi::GtkCellRenderer, ffi::GtkCellRendererClass>);

    match fn {
        type_ => || ffi::gtk_cell_renderer_get_type(),
    }
}

impl CellRenderer {
    pub const NONE: Option<&'static CellRenderer> = None;
}

mod sealed {
    pub trait Sealed {}
    impl<T: super::IsA<super::CellRenderer>> Sealed for T {}
}

/// Trait containing all [`struct@CellRenderer`] methods.
///
/// # Implementors
///
/// [`CellRendererPixbuf`][struct@crate::CellRendererPixbuf], [`CellRendererProgress`][struct@crate::CellRendererProgress], [`CellRendererSpinner`][struct@crate::CellRendererSpinner], [`CellRendererText`][struct@crate::CellRendererText], [`CellRendererToggle`][struct@crate::CellRendererToggle], [`CellRenderer`][struct@crate::CellRenderer]
pub trait CellRendererExt: IsA<CellRenderer> + sealed::Sealed + 'static {
    /// Passes an activate event to the cell renderer for possible processing.
    /// Some cell renderers may use events; for example, [`CellRendererToggle`][crate::CellRendererToggle]
    /// toggles when it gets a mouse click.
    /// ## `event`
    /// a `GdkEvent`
    /// ## `widget`
    /// widget that received the event
    /// ## `path`
    /// widget-dependent string representation of the event location;
    ///  e.g. for [`TreeView`][crate::TreeView], a string representation of [`TreePath`][crate::TreePath]
    /// ## `background_area`
    /// background area as passed to [`render()`][Self::render()]
    /// ## `cell_area`
    /// cell area as passed to [`render()`][Self::render()]
    /// ## `flags`
    /// render flags
    ///
    /// # Returns
    ///
    /// [`true`] if the event was consumed/handled
    #[doc(alias = "gtk_cell_renderer_activate")]
    fn activate(
        &self,
        event: &gdk::Event,
        widget: &impl IsA<Widget>,
        path: &str,
        background_area: &gdk::Rectangle,
        cell_area: &gdk::Rectangle,
        flags: CellRendererState,
    ) -> bool {
        unsafe {
            from_glib(ffi::gtk_cell_renderer_activate(
                self.as_ref().to_glib_none().0,
                mut_override(event.to_glib_none().0),
                widget.as_ref().to_glib_none().0,
                path.to_glib_none().0,
                background_area.to_glib_none().0,
                cell_area.to_glib_none().0,
                flags.into_glib(),
            ))
        }
    }

    /// Gets the aligned area used by `self` inside `cell_area`. Used for finding
    /// the appropriate edit and focus rectangle.
    /// ## `widget`
    /// the [`Widget`][crate::Widget] this cell will be rendering to
    /// ## `flags`
    /// render flags
    /// ## `cell_area`
    /// cell area which would be passed to [`render()`][Self::render()]
    ///
    /// # Returns
    ///
    ///
    /// ## `aligned_area`
    /// the return location for the space inside `cell_area`
    ///  that would acually be used to render.
    #[doc(alias = "gtk_cell_renderer_get_aligned_area")]
    #[doc(alias = "get_aligned_area")]
    fn aligned_area(
        &self,
        widget: &impl IsA<Widget>,
        flags: CellRendererState,
        cell_area: &gdk::Rectangle,
    ) -> gdk::Rectangle {
        unsafe {
            let mut aligned_area = gdk::Rectangle::uninitialized();
            ffi::gtk_cell_renderer_get_aligned_area(
                self.as_ref().to_glib_none().0,
                widget.as_ref().to_glib_none().0,
                flags.into_glib(),
                cell_area.to_glib_none().0,
                aligned_area.to_glib_none_mut().0,
            );
            aligned_area
        }
    }

    /// Fills in `xalign` and `yalign` with the appropriate values of `self`.
    ///
    /// # Returns
    ///
    ///
    /// ## `xalign`
    /// location to fill in with the x alignment of the cell, or [`None`]
    ///
    /// ## `yalign`
    /// location to fill in with the y alignment of the cell, or [`None`]
    #[doc(alias = "gtk_cell_renderer_get_alignment")]
    #[doc(alias = "get_alignment")]
    fn alignment(&self) -> (f32, f32) {
        unsafe {
            let mut xalign = mem::MaybeUninit::uninit();
            let mut yalign = mem::MaybeUninit::uninit();
            ffi::gtk_cell_renderer_get_alignment(
                self.as_ref().to_glib_none().0,
                xalign.as_mut_ptr(),
                yalign.as_mut_ptr(),
            );
            (xalign.assume_init(), yalign.assume_init())
        }
    }

    /// Fills in `width` and `height` with the appropriate size of `self`.
    ///
    /// # Returns
    ///
    ///
    /// ## `width`
    /// location to fill in with the fixed width of the cell, or [`None`]
    ///
    /// ## `height`
    /// location to fill in with the fixed height of the cell, or [`None`]
    #[doc(alias = "gtk_cell_renderer_get_fixed_size")]
    #[doc(alias = "get_fixed_size")]
    fn fixed_size(&self) -> (i32, i32) {
        unsafe {
            let mut width = mem::MaybeUninit::uninit();
            let mut height = mem::MaybeUninit::uninit();
            ffi::gtk_cell_renderer_get_fixed_size(
                self.as_ref().to_glib_none().0,
                width.as_mut_ptr(),
                height.as_mut_ptr(),
            );
            (width.assume_init(), height.assume_init())
        }
    }

    /// Fills in `xpad` and `ypad` with the appropriate values of `self`.
    ///
    /// # Returns
    ///
    ///
    /// ## `xpad`
    /// location to fill in with the x padding of the cell, or [`None`]
    ///
    /// ## `ypad`
    /// location to fill in with the y padding of the cell, or [`None`]
    #[doc(alias = "gtk_cell_renderer_get_padding")]
    #[doc(alias = "get_padding")]
    fn padding(&self) -> (i32, i32) {
        unsafe {
            let mut xpad = mem::MaybeUninit::uninit();
            let mut ypad = mem::MaybeUninit::uninit();
            ffi::gtk_cell_renderer_get_padding(
                self.as_ref().to_glib_none().0,
                xpad.as_mut_ptr(),
                ypad.as_mut_ptr(),
            );
            (xpad.assume_init(), ypad.assume_init())
        }
    }

    /// Retreives a renderer’s natural size when rendered to `widget`.
    /// ## `widget`
    /// the [`Widget`][crate::Widget] this cell will be rendering to
    ///
    /// # Returns
    ///
    ///
    /// ## `minimum_size`
    /// location to store the minimum size, or [`None`]
    ///
    /// ## `natural_size`
    /// location to store the natural size, or [`None`]
    #[doc(alias = "gtk_cell_renderer_get_preferred_height")]
    #[doc(alias = "get_preferred_height")]
    fn preferred_height(&self, widget: &impl IsA<Widget>) -> (i32, i32) {
        unsafe {
            let mut minimum_size = mem::MaybeUninit::uninit();
            let mut natural_size = mem::MaybeUninit::uninit();
            ffi::gtk_cell_renderer_get_preferred_height(
                self.as_ref().to_glib_none().0,
                widget.as_ref().to_glib_none().0,
                minimum_size.as_mut_ptr(),
                natural_size.as_mut_ptr(),
            );
            (minimum_size.assume_init(), natural_size.assume_init())
        }
    }

    /// Retreives a cell renderers’s minimum and natural height if it were rendered to
    /// `widget` with the specified `width`.
    /// ## `widget`
    /// the [`Widget`][crate::Widget] this cell will be rendering to
    /// ## `width`
    /// the size which is available for allocation
    ///
    /// # Returns
    ///
    ///
    /// ## `minimum_height`
    /// location for storing the minimum size, or [`None`]
    ///
    /// ## `natural_height`
    /// location for storing the preferred size, or [`None`]
    #[doc(alias = "gtk_cell_renderer_get_preferred_height_for_width")]
    #[doc(alias = "get_preferred_height_for_width")]
    fn preferred_height_for_width(&self, widget: &impl IsA<Widget>, width: i32) -> (i32, i32) {
        unsafe {
            let mut minimum_height = mem::MaybeUninit::uninit();
            let mut natural_height = mem::MaybeUninit::uninit();
            ffi::gtk_cell_renderer_get_preferred_height_for_width(
                self.as_ref().to_glib_none().0,
                widget.as_ref().to_glib_none().0,
                width,
                minimum_height.as_mut_ptr(),
                natural_height.as_mut_ptr(),
            );
            (minimum_height.assume_init(), natural_height.assume_init())
        }
    }

    /// Retrieves the minimum and natural size of a cell taking
    /// into account the widget’s preference for height-for-width management.
    /// ## `widget`
    /// the [`Widget`][crate::Widget] this cell will be rendering to
    ///
    /// # Returns
    ///
    ///
    /// ## `minimum_size`
    /// location for storing the minimum size, or [`None`]
    ///
    /// ## `natural_size`
    /// location for storing the natural size, or [`None`]
    #[doc(alias = "gtk_cell_renderer_get_preferred_size")]
    #[doc(alias = "get_preferred_size")]
    fn preferred_size(&self, widget: &impl IsA<Widget>) -> (Requisition, Requisition) {
        unsafe {
            let mut minimum_size = Requisition::uninitialized();
            let mut natural_size = Requisition::uninitialized();
            ffi::gtk_cell_renderer_get_preferred_size(
                self.as_ref().to_glib_none().0,
                widget.as_ref().to_glib_none().0,
                minimum_size.to_glib_none_mut().0,
                natural_size.to_glib_none_mut().0,
            );
            (minimum_size, natural_size)
        }
    }

    /// Retreives a renderer’s natural size when rendered to `widget`.
    /// ## `widget`
    /// the [`Widget`][crate::Widget] this cell will be rendering to
    ///
    /// # Returns
    ///
    ///
    /// ## `minimum_size`
    /// location to store the minimum size, or [`None`]
    ///
    /// ## `natural_size`
    /// location to store the natural size, or [`None`]
    #[doc(alias = "gtk_cell_renderer_get_preferred_width")]
    #[doc(alias = "get_preferred_width")]
    fn preferred_width(&self, widget: &impl IsA<Widget>) -> (i32, i32) {
        unsafe {
            let mut minimum_size = mem::MaybeUninit::uninit();
            let mut natural_size = mem::MaybeUninit::uninit();
            ffi::gtk_cell_renderer_get_preferred_width(
                self.as_ref().to_glib_none().0,
                widget.as_ref().to_glib_none().0,
                minimum_size.as_mut_ptr(),
                natural_size.as_mut_ptr(),
            );
            (minimum_size.assume_init(), natural_size.assume_init())
        }
    }

    /// Retreives a cell renderers’s minimum and natural width if it were rendered to
    /// `widget` with the specified `height`.
    /// ## `widget`
    /// the [`Widget`][crate::Widget] this cell will be rendering to
    /// ## `height`
    /// the size which is available for allocation
    ///
    /// # Returns
    ///
    ///
    /// ## `minimum_width`
    /// location for storing the minimum size, or [`None`]
    ///
    /// ## `natural_width`
    /// location for storing the preferred size, or [`None`]
    #[doc(alias = "gtk_cell_renderer_get_preferred_width_for_height")]
    #[doc(alias = "get_preferred_width_for_height")]
    fn preferred_width_for_height(&self, widget: &impl IsA<Widget>, height: i32) -> (i32, i32) {
        unsafe {
            let mut minimum_width = mem::MaybeUninit::uninit();
            let mut natural_width = mem::MaybeUninit::uninit();
            ffi::gtk_cell_renderer_get_preferred_width_for_height(
                self.as_ref().to_glib_none().0,
                widget.as_ref().to_glib_none().0,
                height,
                minimum_width.as_mut_ptr(),
                natural_width.as_mut_ptr(),
            );
            (minimum_width.assume_init(), natural_width.assume_init())
        }
    }

    /// Gets whether the cell renderer prefers a height-for-width layout
    /// or a width-for-height layout.
    ///
    /// # Returns
    ///
    /// The [`SizeRequestMode`][crate::SizeRequestMode] preferred by this renderer.
    #[doc(alias = "gtk_cell_renderer_get_request_mode")]
    #[doc(alias = "get_request_mode")]
    fn request_mode(&self) -> SizeRequestMode {
        unsafe {
            from_glib(ffi::gtk_cell_renderer_get_request_mode(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Returns the cell renderer’s sensitivity.
    ///
    /// # Returns
    ///
    /// [`true`] if the cell renderer is sensitive
    #[doc(alias = "gtk_cell_renderer_get_sensitive")]
    #[doc(alias = "get_sensitive")]
    fn is_sensitive(&self) -> bool {
        unsafe {
            from_glib(ffi::gtk_cell_renderer_get_sensitive(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Translates the cell renderer state to [`StateFlags`][crate::StateFlags],
    /// based on the cell renderer and widget sensitivity, and
    /// the given [`CellRendererState`][crate::CellRendererState].
    /// ## `widget`
    /// a [`Widget`][crate::Widget], or [`None`]
    /// ## `cell_state`
    /// cell renderer state
    ///
    /// # Returns
    ///
    /// the widget state flags applying to `self`
    #[doc(alias = "gtk_cell_renderer_get_state")]
    #[doc(alias = "get_state")]
    fn state(
        &self,
        widget: Option<&impl IsA<Widget>>,
        cell_state: CellRendererState,
    ) -> StateFlags {
        unsafe {
            from_glib(ffi::gtk_cell_renderer_get_state(
                self.as_ref().to_glib_none().0,
                widget.map(|p| p.as_ref()).to_glib_none().0,
                cell_state.into_glib(),
            ))
        }
    }

    /// Returns the cell renderer’s visibility.
    ///
    /// # Returns
    ///
    /// [`true`] if the cell renderer is visible
    #[doc(alias = "gtk_cell_renderer_get_visible")]
    #[doc(alias = "get_visible")]
    fn is_visible(&self) -> bool {
        unsafe {
            from_glib(ffi::gtk_cell_renderer_get_visible(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Checks whether the cell renderer can do something when activated.
    ///
    /// # Returns
    ///
    /// [`true`] if the cell renderer can do anything when activated
    #[doc(alias = "gtk_cell_renderer_is_activatable")]
    fn is_activatable(&self) -> bool {
        unsafe {
            from_glib(ffi::gtk_cell_renderer_is_activatable(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Invokes the virtual render function of the [`CellRenderer`][crate::CellRenderer]. The three
    /// passed-in rectangles are areas in `cr`. Most renderers will draw within
    /// `cell_area`; the xalign, yalign, xpad, and ypad fields of the [`CellRenderer`][crate::CellRenderer]
    /// should be honored with respect to `cell_area`. `background_area` includes the
    /// blank space around the cell, and also the area containing the tree expander;
    /// so the `background_area` rectangles for all cells tile to cover the entire
    /// `window`.
    /// ## `cr`
    /// a cairo context to draw to
    /// ## `widget`
    /// the widget owning `window`
    /// ## `background_area`
    /// entire cell area (including tree expanders and maybe
    ///  padding on the sides)
    /// ## `cell_area`
    /// area normally rendered by a cell renderer
    /// ## `flags`
    /// flags that affect rendering
    #[doc(alias = "gtk_cell_renderer_render")]
    fn render(
        &self,
        cr: &cairo::Context,
        widget: &impl IsA<Widget>,
        background_area: &gdk::Rectangle,
        cell_area: &gdk::Rectangle,
        flags: CellRendererState,
    ) {
        unsafe {
            ffi::gtk_cell_renderer_render(
                self.as_ref().to_glib_none().0,
                mut_override(cr.to_glib_none().0),
                widget.as_ref().to_glib_none().0,
                background_area.to_glib_none().0,
                cell_area.to_glib_none().0,
                flags.into_glib(),
            );
        }
    }

    /// Sets the renderer’s alignment within its available space.
    /// ## `xalign`
    /// the x alignment of the cell renderer
    /// ## `yalign`
    /// the y alignment of the cell renderer
    #[doc(alias = "gtk_cell_renderer_set_alignment")]
    fn set_alignment(&self, xalign: f32, yalign: f32) {
        unsafe {
            ffi::gtk_cell_renderer_set_alignment(self.as_ref().to_glib_none().0, xalign, yalign);
        }
    }

    /// Sets the renderer size to be explicit, independent of the properties set.
    /// ## `width`
    /// the width of the cell renderer, or -1
    /// ## `height`
    /// the height of the cell renderer, or -1
    #[doc(alias = "gtk_cell_renderer_set_fixed_size")]
    fn set_fixed_size(&self, width: i32, height: i32) {
        unsafe {
            ffi::gtk_cell_renderer_set_fixed_size(self.as_ref().to_glib_none().0, width, height);
        }
    }

    /// Sets the renderer’s padding.
    /// ## `xpad`
    /// the x padding of the cell renderer
    /// ## `ypad`
    /// the y padding of the cell renderer
    #[doc(alias = "gtk_cell_renderer_set_padding")]
    fn set_padding(&self, xpad: i32, ypad: i32) {
        unsafe {
            ffi::gtk_cell_renderer_set_padding(self.as_ref().to_glib_none().0, xpad, ypad);
        }
    }

    /// Sets the cell renderer’s sensitivity.
    /// ## `sensitive`
    /// the sensitivity of the cell
    #[doc(alias = "gtk_cell_renderer_set_sensitive")]
    fn set_sensitive(&self, sensitive: bool) {
        unsafe {
            ffi::gtk_cell_renderer_set_sensitive(
                self.as_ref().to_glib_none().0,
                sensitive.into_glib(),
            );
        }
    }

    /// Sets the cell renderer’s visibility.
    /// ## `visible`
    /// the visibility of the cell
    #[doc(alias = "gtk_cell_renderer_set_visible")]
    fn set_visible(&self, visible: bool) {
        unsafe {
            ffi::gtk_cell_renderer_set_visible(self.as_ref().to_glib_none().0, visible.into_glib());
        }
    }

    /// Starts editing the contents of this `self`, through a new [`CellEditable`][crate::CellEditable]
    /// widget created by the `GtkCellRendererClass.start_editing` virtual function.
    /// ## `event`
    /// a `GdkEvent`
    /// ## `widget`
    /// widget that received the event
    /// ## `path`
    /// widget-dependent string representation of the event location;
    ///  e.g. for [`TreeView`][crate::TreeView], a string representation of [`TreePath`][crate::TreePath]
    /// ## `background_area`
    /// background area as passed to [`render()`][Self::render()]
    /// ## `cell_area`
    /// cell area as passed to [`render()`][Self::render()]
    /// ## `flags`
    /// render flags
    ///
    /// # Returns
    ///
    /// A new [`CellEditable`][crate::CellEditable] for editing this
    ///  `self`, or [`None`] if editing is not possible
    #[doc(alias = "gtk_cell_renderer_start_editing")]
    fn start_editing(
        &self,
        event: Option<&gdk::Event>,
        widget: &impl IsA<Widget>,
        path: &str,
        background_area: &gdk::Rectangle,
        cell_area: &gdk::Rectangle,
        flags: CellRendererState,
    ) -> Option<CellEditable> {
        unsafe {
            from_glib_none(ffi::gtk_cell_renderer_start_editing(
                self.as_ref().to_glib_none().0,
                mut_override(event.to_glib_none().0),
                widget.as_ref().to_glib_none().0,
                path.to_glib_none().0,
                background_area.to_glib_none().0,
                cell_area.to_glib_none().0,
                flags.into_glib(),
            ))
        }
    }

    /// Informs the cell renderer that the editing is stopped.
    /// If `canceled` is [`true`], the cell renderer will emit the
    /// [`editing-canceled`][struct@crate::CellRenderer#editing-canceled] signal.
    ///
    /// This function should be called by cell renderer implementations
    /// in response to the [`editing-done`][struct@crate::CellEditable#editing-done] signal of
    /// [`CellEditable`][crate::CellEditable].
    /// ## `canceled`
    /// [`true`] if the editing has been canceled
    #[doc(alias = "gtk_cell_renderer_stop_editing")]
    fn stop_editing(&self, canceled: bool) {
        unsafe {
            ffi::gtk_cell_renderer_stop_editing(
                self.as_ref().to_glib_none().0,
                canceled.into_glib(),
            );
        }
    }

    #[doc(alias = "cell-background")]
    fn set_cell_background(&self, cell_background: Option<&str>) {
        ObjectExt::set_property(self.as_ref(), "cell-background", cell_background)
    }

    /// Cell background as a [`gdk::RGBA`][crate::gdk::RGBA]
    #[doc(alias = "cell-background-rgba")]
    fn cell_background_rgba(&self) -> Option<gdk::RGBA> {
        ObjectExt::property(self.as_ref(), "cell-background-rgba")
    }

    /// Cell background as a [`gdk::RGBA`][crate::gdk::RGBA]
    #[doc(alias = "cell-background-rgba")]
    fn set_cell_background_rgba(&self, cell_background_rgba: Option<&gdk::RGBA>) {
        ObjectExt::set_property(self.as_ref(), "cell-background-rgba", cell_background_rgba)
    }

    #[doc(alias = "cell-background-set")]
    fn is_cell_background_set(&self) -> bool {
        ObjectExt::property(self.as_ref(), "cell-background-set")
    }

    #[doc(alias = "cell-background-set")]
    fn set_cell_background_set(&self, cell_background_set: bool) {
        ObjectExt::set_property(self.as_ref(), "cell-background-set", cell_background_set)
    }

    fn is_editing(&self) -> bool {
        ObjectExt::property(self.as_ref(), "editing")
    }

    fn height(&self) -> i32 {
        ObjectExt::property(self.as_ref(), "height")
    }

    fn set_height(&self, height: i32) {
        ObjectExt::set_property(self.as_ref(), "height", height)
    }

    #[doc(alias = "is-expanded")]
    fn is_expanded(&self) -> bool {
        ObjectExt::property(self.as_ref(), "is-expanded")
    }

    #[doc(alias = "is-expanded")]
    fn set_is_expanded(&self, is_expanded: bool) {
        ObjectExt::set_property(self.as_ref(), "is-expanded", is_expanded)
    }

    #[doc(alias = "is-expander")]
    fn is_expander(&self) -> bool {
        ObjectExt::property(self.as_ref(), "is-expander")
    }

    #[doc(alias = "is-expander")]
    fn set_is_expander(&self, is_expander: bool) {
        ObjectExt::set_property(self.as_ref(), "is-expander", is_expander)
    }

    fn mode(&self) -> CellRendererMode {
        ObjectExt::property(self.as_ref(), "mode")
    }

    fn set_mode(&self, mode: CellRendererMode) {
        ObjectExt::set_property(self.as_ref(), "mode", mode)
    }

    fn width(&self) -> i32 {
        ObjectExt::property(self.as_ref(), "width")
    }

    fn set_width(&self, width: i32) {
        ObjectExt::set_property(self.as_ref(), "width", width)
    }

    fn xalign(&self) -> f32 {
        ObjectExt::property(self.as_ref(), "xalign")
    }

    fn set_xalign(&self, xalign: f32) {
        ObjectExt::set_property(self.as_ref(), "xalign", xalign)
    }

    fn xpad(&self) -> u32 {
        ObjectExt::property(self.as_ref(), "xpad")
    }

    fn set_xpad(&self, xpad: u32) {
        ObjectExt::set_property(self.as_ref(), "xpad", xpad)
    }

    fn yalign(&self) -> f32 {
        ObjectExt::property(self.as_ref(), "yalign")
    }

    fn set_yalign(&self, yalign: f32) {
        ObjectExt::set_property(self.as_ref(), "yalign", yalign)
    }

    fn ypad(&self) -> u32 {
        ObjectExt::property(self.as_ref(), "ypad")
    }

    fn set_ypad(&self, ypad: u32) {
        ObjectExt::set_property(self.as_ref(), "ypad", ypad)
    }

    /// This signal gets emitted when the user cancels the process of editing a
    /// cell. For example, an editable cell renderer could be written to cancel
    /// editing when the user presses Escape.
    ///
    /// See also: [`stop_editing()`][Self::stop_editing()].
    #[doc(alias = "editing-canceled")]
    fn connect_editing_canceled<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn editing_canceled_trampoline<
            P: IsA<CellRenderer>,
            F: Fn(&P) + 'static,
        >(
            this: *mut ffi::GtkCellRenderer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(CellRenderer::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"editing-canceled\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    editing_canceled_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// This signal gets emitted when a cell starts to be edited.
    /// The intended use of this signal is to do special setup
    /// on `editable`, e.g. adding a [`EntryCompletion`][crate::EntryCompletion] or setting
    /// up additional columns in a [`ComboBox`][crate::ComboBox].
    ///
    /// See [`CellEditableExt::start_editing()`][crate::prelude::CellEditableExt::start_editing()] for information on the lifecycle of
    /// the `editable` and a way to do setup that doesn’t depend on the `renderer`.
    ///
    /// Note that GTK+ doesn't guarantee that cell renderers will
    /// continue to use the same kind of widget for editing in future
    /// releases, therefore you should check the type of `editable`
    /// before doing any specific setup, as in the following example:
    ///
    ///
    /// **⚠️ The following code is in C ⚠️**
    ///
    /// ```C
    /// static void
    /// text_editing_started (GtkCellRenderer *cell,
    ///                       GtkCellEditable *editable,
    ///                       const gchar     *path,
    ///                       gpointer         data)
    /// {
    ///   if (GTK_IS_ENTRY (editable))
    ///     {
    ///       GtkEntry *entry = GTK_ENTRY (editable);
    ///
    ///       // ... create a GtkEntryCompletion
    ///
    ///       gtk_entry_set_completion (entry, completion);
    ///     }
    /// }
    /// ```
    /// ## `editable`
    /// the [`CellEditable`][crate::CellEditable]
    /// ## `path`
    /// the path identifying the edited cell
    #[doc(alias = "editing-started")]
    fn connect_editing_started<F: Fn(&Self, &CellEditable, TreePath) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn editing_started_trampoline<
            P: IsA<CellRenderer>,
            F: Fn(&P, &CellEditable, TreePath) + 'static,
        >(
            this: *mut ffi::GtkCellRenderer,
            editable: *mut ffi::GtkCellEditable,
            path: *mut libc::c_char,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            let path = from_glib_full(crate::ffi::gtk_tree_path_new_from_string(path));
            f(
                CellRenderer::from_glib_borrow(this).unsafe_cast_ref(),
                &from_glib_borrow(editable),
                path,
            )
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"editing-started\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    editing_started_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "cell-background")]
    fn connect_cell_background_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_cell_background_trampoline<
            P: IsA<CellRenderer>,
            F: Fn(&P) + 'static,
        >(
            this: *mut ffi::GtkCellRenderer,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(CellRenderer::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::cell-background\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_cell_background_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "cell-background-rgba")]
    fn connect_cell_background_rgba_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_cell_background_rgba_trampoline<
            P: IsA<CellRenderer>,
            F: Fn(&P) + 'static,
        >(
            this: *mut ffi::GtkCellRenderer,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(CellRenderer::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::cell-background-rgba\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_cell_background_rgba_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "cell-background-set")]
    fn connect_cell_background_set_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_cell_background_set_trampoline<
            P: IsA<CellRenderer>,
            F: Fn(&P) + 'static,
        >(
            this: *mut ffi::GtkCellRenderer,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(CellRenderer::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::cell-background-set\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_cell_background_set_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "editing")]
    fn connect_editing_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_editing_trampoline<
            P: IsA<CellRenderer>,
            F: Fn(&P) + 'static,
        >(
            this: *mut ffi::GtkCellRenderer,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(CellRenderer::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::editing\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_editing_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "height")]
    fn connect_height_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_height_trampoline<P: IsA<CellRenderer>, F: Fn(&P) + 'static>(
            this: *mut ffi::GtkCellRenderer,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(CellRenderer::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::height\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_height_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "is-expanded")]
    fn connect_is_expanded_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_is_expanded_trampoline<
            P: IsA<CellRenderer>,
            F: Fn(&P) + 'static,
        >(
            this: *mut ffi::GtkCellRenderer,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(CellRenderer::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::is-expanded\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_is_expanded_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "is-expander")]
    fn connect_is_expander_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_is_expander_trampoline<
            P: IsA<CellRenderer>,
            F: Fn(&P) + 'static,
        >(
            this: *mut ffi::GtkCellRenderer,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(CellRenderer::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::is-expander\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_is_expander_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "mode")]
    fn connect_mode_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_mode_trampoline<P: IsA<CellRenderer>, F: Fn(&P) + 'static>(
            this: *mut ffi::GtkCellRenderer,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(CellRenderer::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::mode\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_mode_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "sensitive")]
    fn connect_sensitive_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_sensitive_trampoline<
            P: IsA<CellRenderer>,
            F: Fn(&P) + 'static,
        >(
            this: *mut ffi::GtkCellRenderer,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(CellRenderer::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::sensitive\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_sensitive_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "visible")]
    fn connect_visible_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_visible_trampoline<
            P: IsA<CellRenderer>,
            F: Fn(&P) + 'static,
        >(
            this: *mut ffi::GtkCellRenderer,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(CellRenderer::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::visible\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_visible_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "width")]
    fn connect_width_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_width_trampoline<P: IsA<CellRenderer>, F: Fn(&P) + 'static>(
            this: *mut ffi::GtkCellRenderer,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(CellRenderer::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::width\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_width_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "xalign")]
    fn connect_xalign_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_xalign_trampoline<P: IsA<CellRenderer>, F: Fn(&P) + 'static>(
            this: *mut ffi::GtkCellRenderer,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(CellRenderer::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::xalign\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_xalign_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "xpad")]
    fn connect_xpad_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_xpad_trampoline<P: IsA<CellRenderer>, F: Fn(&P) + 'static>(
            this: *mut ffi::GtkCellRenderer,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(CellRenderer::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::xpad\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_xpad_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "yalign")]
    fn connect_yalign_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_yalign_trampoline<P: IsA<CellRenderer>, F: Fn(&P) + 'static>(
            this: *mut ffi::GtkCellRenderer,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(CellRenderer::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::yalign\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_yalign_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "ypad")]
    fn connect_ypad_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_ypad_trampoline<P: IsA<CellRenderer>, F: Fn(&P) + 'static>(
            this: *mut ffi::GtkCellRenderer,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(CellRenderer::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::ypad\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_ypad_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl<O: IsA<CellRenderer>> CellRendererExt for O {}

impl fmt::Display for CellRenderer {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        f.write_str("CellRenderer")
    }
}