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

use crate::{ffi, Mark};
use glib::{
    prelude::*,
    signal::{connect_raw, SignalHandlerId},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    /// The source mark attributes object.
    ///
    /// [`MarkAttributes`][crate::MarkAttributes] is an object specifying attributes used by
    /// a [`View`][crate::View] to visually show lines marked with [`Mark`][crate::Mark]s
    /// of a specific category. It allows you to define a background color of a line,
    /// an icon shown in gutter and tooltips.
    ///
    /// The background color is used as a background of a line where a mark is placed
    /// and it can be set with [`set_background()`][Self::set_background()]. To check
    /// if any custom background color was defined and what color it is, use
    /// [`background()`][Self::background()].
    ///
    /// An icon is a graphic element which is shown in the gutter of a view. An
    /// example use is showing a red filled circle in a debugger to show that a
    /// breakpoint was set in certain line. To get an icon that will be placed in
    /// a gutter, first a base for it must be specified and then
    /// [`render_icon()`][Self::render_icon()] must be called.
    /// There are several ways to specify a base for an icon:
    ///
    /// - [`set_icon_name()`][Self::set_icon_name()]
    /// - [`set_gicon()`][Self::set_gicon()]
    /// - [`set_pixbuf()`][Self::set_pixbuf()]
    ///
    /// Using any of the above functions overrides the one used earlier. But note
    /// that a getter counterpart of earlier used function can still return some
    /// value, but it is just not used when rendering the proper icon.
    ///
    /// To provide meaningful tooltips for a given mark of a category, you should
    /// connect to [`query-tooltip-text`][struct@crate::MarkAttributes#query-tooltip-text] or
    /// [`query-tooltip-markup`][struct@crate::MarkAttributes#query-tooltip-markup] where the latter
    /// takes precedence.
    ///
    /// ## Properties
    ///
    ///
    /// #### `background`
    ///  A color used for background of a line.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `gicon`
    ///  A #GIcon that may be a base of a rendered icon.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `icon-name`
    ///  An icon name that may be a base of a rendered icon.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `pixbuf`
    ///  A #GdkPixbuf that may be a base of a rendered icon.
    ///
    /// Readable | Writeable
    ///
    /// ## Signals
    ///
    ///
    /// #### `query-tooltip-markup`
    ///  The code should connect to this signal to provide a tooltip for given
    /// @mark. The tooltip can contain a markup.
    ///
    ///
    ///
    ///
    /// #### `query-tooltip-text`
    ///  The code should connect to this signal to provide a tooltip for given
    /// @mark. The tooltip should be just a plain text.
    ///
    ///
    ///
    /// # Implements
    ///
    /// [`trait@glib::ObjectExt`]
    #[doc(alias = "GtkSourceMarkAttributes")]
    pub struct MarkAttributes(Object<ffi::GtkSourceMarkAttributes, ffi::GtkSourceMarkAttributesClass>);

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

impl MarkAttributes {
    /// Creates a new source mark attributes.
    ///
    /// # Returns
    ///
    /// a new source mark attributes.
    #[doc(alias = "gtk_source_mark_attributes_new")]
    pub fn new() -> MarkAttributes {
        assert_initialized_main_thread!();
        unsafe { from_glib_full(ffi::gtk_source_mark_attributes_new()) }
    }

    // rustdoc-stripper-ignore-next
    /// Creates a new builder-pattern struct instance to construct [`MarkAttributes`] objects.
    ///
    /// This method returns an instance of [`MarkAttributesBuilder`](crate::builders::MarkAttributesBuilder) which can be used to create [`MarkAttributes`] objects.
    pub fn builder() -> MarkAttributesBuilder {
        MarkAttributesBuilder::new()
    }

    /// Stores background color in @background.
    ///
    /// # Returns
    ///
    /// whether background color for @self was set.
    ///
    /// ## `background`
    /// a #GdkRGBA.
    #[doc(alias = "gtk_source_mark_attributes_get_background")]
    #[doc(alias = "get_background")]
    pub fn background(&self) -> Option<gdk::RGBA> {
        unsafe {
            let mut background = gdk::RGBA::uninitialized();
            let ret = from_glib(ffi::gtk_source_mark_attributes_get_background(
                self.to_glib_none().0,
                background.to_glib_none_mut().0,
            ));
            if ret {
                Some(background)
            } else {
                None
            }
        }
    }

    /// Gets a [`gio::Icon`][crate::gio::Icon] to be used as a base for rendered icon.
    ///
    /// Note that the icon can be [`None`] if it wasn't set earlier.
    ///
    /// # Returns
    ///
    /// An icon. The icon belongs to @self and should
    /// not be unreffed.
    #[doc(alias = "gtk_source_mark_attributes_get_gicon")]
    #[doc(alias = "get_gicon")]
    pub fn gicon(&self) -> gio::Icon {
        unsafe {
            from_glib_none(ffi::gtk_source_mark_attributes_get_gicon(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets a name of an icon to be used as a base for rendered icon.
    ///
    /// Note that the icon name can be [`None`] if it wasn't set earlier.
    ///
    /// # Returns
    ///
    /// An icon name. The string belongs to @self and
    /// should not be freed.
    #[doc(alias = "gtk_source_mark_attributes_get_icon_name")]
    #[doc(alias = "get_icon_name")]
    #[doc(alias = "icon-name")]
    pub fn icon_name(&self) -> glib::GString {
        unsafe {
            from_glib_none(ffi::gtk_source_mark_attributes_get_icon_name(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets a [`gdk_pixbuf::Pixbuf`][crate::gdk_pixbuf::Pixbuf] to be used as a base for rendered icon.
    ///
    /// Note that the pixbuf can be [`None`] if it wasn't set earlier.
    ///
    /// # Returns
    ///
    /// A pixbuf. The pixbuf belongs to @self and
    /// should not be unreffed.
    #[doc(alias = "gtk_source_mark_attributes_get_pixbuf")]
    #[doc(alias = "get_pixbuf")]
    pub fn pixbuf(&self) -> gdk_pixbuf::Pixbuf {
        unsafe {
            from_glib_none(ffi::gtk_source_mark_attributes_get_pixbuf(
                self.to_glib_none().0,
            ))
        }
    }

    /// Queries for a tooltip by emitting a [`query-tooltip-markup`][struct@crate::MarkAttributes#query-tooltip-markup] signal.
    ///
    /// The tooltip may contain a markup.
    /// ## `mark`
    /// a #GtkSourceMark.
    ///
    /// # Returns
    ///
    /// A tooltip. The returned string should be freed by
    /// using g_free() when done with it.
    #[doc(alias = "gtk_source_mark_attributes_get_tooltip_markup")]
    #[doc(alias = "get_tooltip_markup")]
    pub fn tooltip_markup(&self, mark: &impl IsA<Mark>) -> glib::GString {
        unsafe {
            from_glib_full(ffi::gtk_source_mark_attributes_get_tooltip_markup(
                self.to_glib_none().0,
                mark.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Queries for a tooltip by emitting a [`query-tooltip-text`][struct@crate::MarkAttributes#query-tooltip-text] signal.
    ///
    /// The tooltip is a plain text.
    /// ## `mark`
    /// a #GtkSourceMark.
    ///
    /// # Returns
    ///
    /// A tooltip. The returned string should be freed by
    /// using g_free() when done with it.
    #[doc(alias = "gtk_source_mark_attributes_get_tooltip_text")]
    #[doc(alias = "get_tooltip_text")]
    pub fn tooltip_text(&self, mark: &impl IsA<Mark>) -> glib::GString {
        unsafe {
            from_glib_full(ffi::gtk_source_mark_attributes_get_tooltip_text(
                self.to_glib_none().0,
                mark.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Renders an icon of given size.
    ///
    /// The base of the icon is set by the last call to one of:
    ///
    /// - [`set_pixbuf()`][Self::set_pixbuf()]
    /// - [`set_gicon()`][Self::set_gicon()]
    /// - [`set_icon_name()`][Self::set_icon_name()]
    ///
    /// @size cannot be lower than 1.
    /// ## `widget`
    /// widget of which style settings may be used.
    /// ## `size`
    /// size of the rendered icon.
    ///
    /// # Returns
    ///
    /// A #GdkPaintable. The paintable belongs to @self
    /// and should not be unreffed.
    #[doc(alias = "gtk_source_mark_attributes_render_icon")]
    pub fn render_icon(&self, widget: &impl IsA<gtk::Widget>, size: i32) -> gdk::Paintable {
        unsafe {
            from_glib_none(ffi::gtk_source_mark_attributes_render_icon(
                self.to_glib_none().0,
                widget.as_ref().to_glib_none().0,
                size,
            ))
        }
    }

    /// Sets background color to the one given in @background.
    /// ## `background`
    /// a #GdkRGBA.
    #[doc(alias = "gtk_source_mark_attributes_set_background")]
    #[doc(alias = "background")]
    pub fn set_background(&self, background: &gdk::RGBA) {
        unsafe {
            ffi::gtk_source_mark_attributes_set_background(
                self.to_glib_none().0,
                background.to_glib_none().0,
            );
        }
    }

    /// Sets an icon to be used as a base for rendered icon.
    /// ## `gicon`
    /// a #GIcon to be used.
    #[doc(alias = "gtk_source_mark_attributes_set_gicon")]
    #[doc(alias = "gicon")]
    pub fn set_gicon(&self, gicon: &impl IsA<gio::Icon>) {
        unsafe {
            ffi::gtk_source_mark_attributes_set_gicon(
                self.to_glib_none().0,
                gicon.as_ref().to_glib_none().0,
            );
        }
    }

    /// Sets a name of an icon to be used as a base for rendered icon.
    /// ## `icon_name`
    /// name of an icon to be used.
    #[doc(alias = "gtk_source_mark_attributes_set_icon_name")]
    #[doc(alias = "icon-name")]
    pub fn set_icon_name(&self, icon_name: &str) {
        unsafe {
            ffi::gtk_source_mark_attributes_set_icon_name(
                self.to_glib_none().0,
                icon_name.to_glib_none().0,
            );
        }
    }

    /// Sets a pixbuf to be used as a base for rendered icon.
    /// ## `pixbuf`
    /// a #GdkPixbuf to be used.
    #[doc(alias = "gtk_source_mark_attributes_set_pixbuf")]
    #[doc(alias = "pixbuf")]
    pub fn set_pixbuf(&self, pixbuf: &gdk_pixbuf::Pixbuf) {
        unsafe {
            ffi::gtk_source_mark_attributes_set_pixbuf(
                self.to_glib_none().0,
                pixbuf.to_glib_none().0,
            );
        }
    }

    /// The code should connect to this signal to provide a tooltip for given
    /// @mark. The tooltip can contain a markup.
    /// ## `mark`
    /// The #GtkSourceMark.
    ///
    /// # Returns
    ///
    /// A tooltip. The string should be freed with
    /// g_free() when done with it.
    #[doc(alias = "query-tooltip-markup")]
    pub fn connect_query_tooltip_markup<F: Fn(&Self, &Mark) -> String + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn query_tooltip_markup_trampoline<
            F: Fn(&MarkAttributes, &Mark) -> String + 'static,
        >(
            this: *mut ffi::GtkSourceMarkAttributes,
            mark: *mut ffi::GtkSourceMark,
            f: glib::ffi::gpointer,
        ) -> *mut libc::c_char {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this), &from_glib_borrow(mark)).to_glib_full()
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"query-tooltip-markup\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    query_tooltip_markup_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// The code should connect to this signal to provide a tooltip for given
    /// @mark. The tooltip should be just a plain text.
    /// ## `mark`
    /// The #GtkSourceMark.
    ///
    /// # Returns
    ///
    /// A tooltip. The string should be freed with
    /// g_free() when done with it.
    #[doc(alias = "query-tooltip-text")]
    pub fn connect_query_tooltip_text<F: Fn(&Self, &Mark) -> String + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn query_tooltip_text_trampoline<
            F: Fn(&MarkAttributes, &Mark) -> String + 'static,
        >(
            this: *mut ffi::GtkSourceMarkAttributes,
            mark: *mut ffi::GtkSourceMark,
            f: glib::ffi::gpointer,
        ) -> *mut libc::c_char {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this), &from_glib_borrow(mark)).to_glib_full()
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"query-tooltip-text\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    query_tooltip_text_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "background")]
    pub fn connect_background_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_background_trampoline<F: Fn(&MarkAttributes) + 'static>(
            this: *mut ffi::GtkSourceMarkAttributes,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::background\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_background_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "gicon")]
    pub fn connect_gicon_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_gicon_trampoline<F: Fn(&MarkAttributes) + 'static>(
            this: *mut ffi::GtkSourceMarkAttributes,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::gicon\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_gicon_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "icon-name")]
    pub fn connect_icon_name_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_icon_name_trampoline<F: Fn(&MarkAttributes) + 'static>(
            this: *mut ffi::GtkSourceMarkAttributes,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::icon-name\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_icon_name_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "pixbuf")]
    pub fn connect_pixbuf_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_pixbuf_trampoline<F: Fn(&MarkAttributes) + 'static>(
            this: *mut ffi::GtkSourceMarkAttributes,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::pixbuf\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_pixbuf_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl Default for MarkAttributes {
    fn default() -> Self {
        Self::new()
    }
}

// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`MarkAttributes`] objects.
///
/// [builder-pattern]: https://doc.rust-lang.org/1.0.0/style/ownership/builders.html
#[must_use = "The builder must be built to be used"]
pub struct MarkAttributesBuilder {
    builder: glib::object::ObjectBuilder<'static, MarkAttributes>,
}

impl MarkAttributesBuilder {
    fn new() -> Self {
        Self {
            builder: glib::object::Object::builder(),
        }
    }

    /// A color used for background of a line.
    pub fn background(self, background: &gdk::RGBA) -> Self {
        Self {
            builder: self.builder.property("background", background),
        }
    }

    /// A #GIcon that may be a base of a rendered icon.
    pub fn gicon(self, gicon: &impl IsA<gio::Icon>) -> Self {
        Self {
            builder: self.builder.property("gicon", gicon.clone().upcast()),
        }
    }

    /// An icon name that may be a base of a rendered icon.
    pub fn icon_name(self, icon_name: impl Into<glib::GString>) -> Self {
        Self {
            builder: self.builder.property("icon-name", icon_name.into()),
        }
    }

    /// A #GdkPixbuf that may be a base of a rendered icon.
    pub fn pixbuf(self, pixbuf: &gdk_pixbuf::Pixbuf) -> Self {
        Self {
            builder: self.builder.property("pixbuf", pixbuf.clone()),
        }
    }

    // rustdoc-stripper-ignore-next
    /// Build the [`MarkAttributes`].
    #[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
    pub fn build(self) -> MarkAttributes {
        self.builder.build()
    }
}