// 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;
use glib::{prelude::*, translate::*};

glib::wrapper! {
    /// Mark object for [`Buffer`][crate::Buffer].
    ///
    /// A [`Mark`][crate::Mark] marks a position in the text where you want to display
    /// additional info. It is based on [`gtk::TextMark`][crate::gtk::TextMark] and thus is still valid after
    /// the text has changed though its position may change.
    ///
    /// [`Mark`][crate::Mark]s are organized in categories which you have to set
    /// when you create the mark. Each category can have a priority, a pixbuf and
    /// other associated attributes. See [`ViewExt::set_mark_attributes()`][crate::prelude::ViewExt::set_mark_attributes()].
    /// The pixbuf will be displayed in the margin at the line where the mark
    /// residents if the [`show-line-marks`][struct@crate::View#show-line-marks] property is set to [`true`]. If
    /// there are multiple marks in the same line, the pixbufs will be drawn on top
    /// of each other. The mark with the highest priority will be drawn on top.
    ///
    /// ## Properties
    ///
    ///
    /// #### `category`
    ///  The category of the [`Mark`][crate::Mark], classifies the mark and controls
    /// which pixbuf is used and with which priority it is drawn.
    ///
    /// Readable | Writeable | Construct Only
    /// <details><summary><h4>TextMark</h4></summary>
    ///
    ///
    /// #### `left-gravity`
    ///  Whether the mark has left gravity.
    ///
    /// When text is inserted at the mark’s current location, if the mark
    /// has left gravity it will be moved to the left of the newly-inserted
    /// text, otherwise to the right.
    ///
    /// Readable | Writeable | Construct Only
    ///
    ///
    /// #### `name`
    ///  The name of the mark or [`None`] if the mark is anonymous.
    ///
    /// Readable | Writeable | Construct Only
    /// </details>
    ///
    /// # Implements
    ///
    /// [`MarkExt`][trait@crate::prelude::MarkExt], [`trait@gtk::prelude::TextMarkExt`], [`trait@glib::ObjectExt`]
    #[doc(alias = "GtkSourceMark")]
    pub struct Mark(Object<ffi::GtkSourceMark, ffi::GtkSourceMarkClass>) @extends gtk::TextMark;

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

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

    /// Creates a text mark.
    ///
    /// Add it to a buffer using [`TextBufferExtManual::add_mark()`][crate::gtk::prelude::TextBufferExtManual::add_mark()].
    /// If name is NULL, the mark is anonymous; otherwise, the mark can be retrieved
    /// by name using [`TextBufferExtManual::mark()`][crate::gtk::prelude::TextBufferExtManual::mark()].
    /// Normally marks are created using the utility function
    /// [`BufferExt::create_source_mark()`][crate::prelude::BufferExt::create_source_mark()].
    /// ## `name`
    /// Name of the #GtkSourceMark or [`None`]
    /// ## `category`
    /// is used to classify marks according to common characteristics
    ///   (e.g. all the marks representing a bookmark could belong to the "bookmark"
    ///   category, or all the marks representing a compilation error could belong
    ///   to "error" category).
    ///
    /// # Returns
    ///
    /// a new #GtkSourceMark that can be added using [`TextBufferExtManual::add_mark()`][crate::gtk::prelude::TextBufferExtManual::add_mark()].
    #[doc(alias = "gtk_source_mark_new")]
    pub fn new(name: Option<&str>, category: &str) -> Mark {
        assert_initialized_main_thread!();
        unsafe {
            from_glib_full(ffi::gtk_source_mark_new(
                name.to_glib_none().0,
                category.to_glib_none().0,
            ))
        }
    }

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

impl Default for Mark {
    fn default() -> Self {
        glib::object::Object::new::<Self>()
    }
}

// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`Mark`] 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 MarkBuilder {
    builder: glib::object::ObjectBuilder<'static, Mark>,
}

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

    /// The category of the [`Mark`][crate::Mark], classifies the mark and controls
    /// which pixbuf is used and with which priority it is drawn.
    pub fn category(self, category: impl Into<glib::GString>) -> Self {
        Self {
            builder: self.builder.property("category", category.into()),
        }
    }

    /// Whether the mark has left gravity.
    ///
    /// When text is inserted at the mark’s current location, if the mark
    /// has left gravity it will be moved to the left of the newly-inserted
    /// text, otherwise to the right.
    pub fn left_gravity(self, left_gravity: bool) -> Self {
        Self {
            builder: self.builder.property("left-gravity", left_gravity),
        }
    }

    /// The name of the mark or [`None`] if the mark is anonymous.
    pub fn name(self, name: impl Into<glib::GString>) -> Self {
        Self {
            builder: self.builder.property("name", name.into()),
        }
    }

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

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

/// Trait containing all [`struct@Mark`] methods.
///
/// # Implementors
///
/// [`Mark`][struct@crate::Mark]
pub trait MarkExt: IsA<Mark> + sealed::Sealed + 'static {
    /// Returns the mark category.
    ///
    /// # Returns
    ///
    /// the category of the #GtkSourceMark.
    #[doc(alias = "gtk_source_mark_get_category")]
    #[doc(alias = "get_category")]
    fn category(&self) -> glib::GString {
        unsafe {
            from_glib_none(ffi::gtk_source_mark_get_category(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Returns the next [`Mark`][crate::Mark] in the buffer or [`None`] if the mark
    /// was not added to a buffer.
    ///
    ///  If there is no next mark, [`None`] will be returned.
    ///
    /// If @category is [`None`], looks for marks of any category.
    /// ## `category`
    /// a string specifying the mark category, or [`None`].
    ///
    /// # Returns
    ///
    /// the next #GtkSourceMark, or [`None`].
    #[doc(alias = "gtk_source_mark_next")]
    #[must_use]
    fn next(&self, category: Option<&str>) -> Option<Mark> {
        unsafe {
            from_glib_none(ffi::gtk_source_mark_next(
                self.as_ref().to_glib_none().0,
                category.to_glib_none().0,
            ))
        }
    }

    /// Returns the previous [`Mark`][crate::Mark] in the buffer or [`None`] if the mark
    /// was not added to a buffer.
    ///
    /// If there is no previous mark, [`None`] is returned.
    ///
    /// If @category is [`None`], looks for marks of any category
    /// ## `category`
    /// a string specifying the mark category, or [`None`].
    ///
    /// # Returns
    ///
    /// the previous #GtkSourceMark, or [`None`].
    #[doc(alias = "gtk_source_mark_prev")]
    #[must_use]
    fn prev(&self, category: Option<&str>) -> Option<Mark> {
        unsafe {
            from_glib_none(ffi::gtk_source_mark_prev(
                self.as_ref().to_glib_none().0,
                category.to_glib_none().0,
            ))
        }
    }
}

impl<O: IsA<Mark>> MarkExt for O {}