// 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 glib::object::Cast;
use glib::object::IsA;
use glib::translate::*;
use glib::GString;
use glib::StaticType;
use glib::ToValue;
use gtk_sys;
use std::fmt;
use TextBuffer;

glib_wrapper! {
    /// You may wish to begin by reading the
    /// [text widget conceptual overview][TextWidget]
    /// which gives an overview of all the objects and data
    /// types related to the text widget and how they work together.
    ///
    /// A `TextMark` is like a bookmark in a text buffer; it preserves a position in
    /// the text. You can convert the mark to an iterator using
    /// `TextBufferExt::get_iter_at_mark`. Unlike iterators, marks remain valid across
    /// buffer mutations, because their behavior is defined when text is inserted or
    /// deleted. When text containing a mark is deleted, the mark remains in the
    /// position originally occupied by the deleted text. When text is inserted at a
    /// mark, a mark with “left gravity” will be moved to the
    /// beginning of the newly-inserted text, and a mark with “right
    /// gravity” will be moved to the end.
    ///
    /// Note that “left” and “right” here refer to logical direction (left
    /// is the toward the start of the buffer); in some languages such as
    /// Hebrew the logically-leftmost text is not actually on the left when
    /// displayed.
    ///
    /// Marks are reference counted, but the reference count only controls the validity
    /// of the memory; marks can be deleted from the buffer at any time with
    /// `TextBufferExt::delete_mark`. Once deleted from the buffer, a mark is
    /// essentially useless.
    ///
    /// Marks optionally have names; these can be convenient to avoid passing the
    /// `TextMark` object around.
    ///
    /// Marks are typically created using the `TextBufferExt::create_mark` function.
    ///
    /// # Implements
    ///
    /// [`TextMarkExt`](trait.TextMarkExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
    pub struct TextMark(Object<gtk_sys::GtkTextMark, gtk_sys::GtkTextMarkClass, TextMarkClass>);

    match fn {
        get_type => || gtk_sys::gtk_text_mark_get_type(),
    }
}

impl TextMark {
    /// Creates a text mark. Add it to a buffer using `TextBufferExt::add_mark`.
    /// If `name` is `None`, the mark is anonymous; otherwise, the mark can be
    /// retrieved by name using `TextBufferExt::get_mark`. If a mark has left
    /// gravity, and text is inserted at the mark’s current location, the mark
    /// will be moved to the left of the newly-inserted text. If the mark has
    /// right gravity (`left_gravity` = `false`), the mark will end up on the
    /// right of newly-inserted text. The standard left-to-right cursor is a
    /// mark with right gravity (when you type, the cursor stays on the right
    /// side of the text you’re typing).
    /// ## `name`
    /// mark name or `None`
    /// ## `left_gravity`
    /// whether the mark should have left gravity
    ///
    /// # Returns
    ///
    /// new `TextMark`
    pub fn new(name: Option<&str>, left_gravity: bool) -> TextMark {
        assert_initialized_main_thread!();
        unsafe {
            from_glib_full(gtk_sys::gtk_text_mark_new(
                name.to_glib_none().0,
                left_gravity.to_glib(),
            ))
        }
    }
}

#[derive(Clone, Default)]
pub struct TextMarkBuilder {
    left_gravity: Option<bool>,
    name: Option<String>,
}

impl TextMarkBuilder {
    pub fn new() -> Self {
        Self::default()
    }

    pub fn build(self) -> TextMark {
        let mut properties: Vec<(&str, &dyn ToValue)> = vec![];
        if let Some(ref left_gravity) = self.left_gravity {
            properties.push(("left-gravity", left_gravity));
        }
        if let Some(ref name) = self.name {
            properties.push(("name", name));
        }
        let ret = glib::Object::new(TextMark::static_type(), &properties)
            .expect("object new")
            .downcast::<TextMark>()
            .expect("downcast");
        ret
    }

    pub fn left_gravity(mut self, left_gravity: bool) -> Self {
        self.left_gravity = Some(left_gravity);
        self
    }

    pub fn name(mut self, name: &str) -> Self {
        self.name = Some(name.to_string());
        self
    }
}

pub const NONE_TEXT_MARK: Option<&TextMark> = None;

/// Trait containing all `TextMark` methods.
///
/// # Implementors
///
/// [`TextMark`](struct.TextMark.html)
pub trait TextMarkExt: 'static {
    /// Gets the buffer this mark is located inside,
    /// or `None` if the mark is deleted.
    ///
    /// # Returns
    ///
    /// the mark’s `TextBuffer`
    fn get_buffer(&self) -> Option<TextBuffer>;

    /// Returns `true` if the mark has been removed from its buffer
    /// with `TextBufferExt::delete_mark`. See `TextBufferExt::add_mark`
    /// for a way to add it to a buffer again.
    ///
    /// # Returns
    ///
    /// whether the mark is deleted
    fn get_deleted(&self) -> bool;

    /// Determines whether the mark has left gravity.
    ///
    /// # Returns
    ///
    /// `true` if the mark has left gravity, `false` otherwise
    fn get_left_gravity(&self) -> bool;

    /// Returns the mark name; returns NULL for anonymous marks.
    ///
    /// # Returns
    ///
    /// mark name
    fn get_name(&self) -> Option<GString>;

    /// Returns `true` if the mark is visible (i.e. a cursor is displayed
    /// for it).
    ///
    /// # Returns
    ///
    /// `true` if visible
    fn get_visible(&self) -> bool;

    /// Sets the visibility of `self`; the insertion point is normally
    /// visible, i.e. you can see it as a vertical bar. Also, the text
    /// widget uses a visible mark to indicate where a drop will occur when
    /// dragging-and-dropping text. Most other marks are not visible.
    /// Marks are not visible by default.
    /// ## `setting`
    /// visibility of mark
    fn set_visible(&self, setting: bool);
}

impl<O: IsA<TextMark>> TextMarkExt for O {
    fn get_buffer(&self) -> Option<TextBuffer> {
        unsafe {
            from_glib_none(gtk_sys::gtk_text_mark_get_buffer(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    fn get_deleted(&self) -> bool {
        unsafe {
            from_glib(gtk_sys::gtk_text_mark_get_deleted(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    fn get_left_gravity(&self) -> bool {
        unsafe {
            from_glib(gtk_sys::gtk_text_mark_get_left_gravity(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    fn get_name(&self) -> Option<GString> {
        unsafe {
            from_glib_none(gtk_sys::gtk_text_mark_get_name(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    fn get_visible(&self) -> bool {
        unsafe {
            from_glib(gtk_sys::gtk_text_mark_get_visible(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    fn set_visible(&self, setting: bool) {
        unsafe {
            gtk_sys::gtk_text_mark_set_visible(self.as_ref().to_glib_none().0, setting.to_glib());
        }
    }
}

impl fmt::Display for TextMark {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "TextMark")
    }
}