sourceview5/auto/
mark.rs

1// This file was generated by gir (https://github.com/gtk-rs/gir)
2// from
3// from gir-files (https://github.com/gtk-rs/gir-files.git)
4// DO NOT EDIT
5
6use crate::ffi;
7use glib::{prelude::*, translate::*};
8
9glib::wrapper! {
10    #[doc(alias = "GtkSourceMark")]
11    pub struct Mark(Object<ffi::GtkSourceMark, ffi::GtkSourceMarkClass>) @extends gtk::TextMark;
12
13    match fn {
14        type_ => || ffi::gtk_source_mark_get_type(),
15    }
16}
17
18impl Mark {
19    pub const NONE: Option<&'static Mark> = None;
20
21    #[doc(alias = "gtk_source_mark_new")]
22    pub fn new(name: Option<&str>, category: &str) -> Mark {
23        assert_initialized_main_thread!();
24        unsafe {
25            from_glib_full(ffi::gtk_source_mark_new(
26                name.to_glib_none().0,
27                category.to_glib_none().0,
28            ))
29        }
30    }
31
32    // rustdoc-stripper-ignore-next
33    /// Creates a new builder-pattern struct instance to construct [`Mark`] objects.
34    ///
35    /// This method returns an instance of [`MarkBuilder`](crate::builders::MarkBuilder) which can be used to create [`Mark`] objects.
36    pub fn builder() -> MarkBuilder {
37        MarkBuilder::new()
38    }
39}
40
41impl Default for Mark {
42    fn default() -> Self {
43        glib::object::Object::new::<Self>()
44    }
45}
46
47// rustdoc-stripper-ignore-next
48/// A [builder-pattern] type to construct [`Mark`] objects.
49///
50/// [builder-pattern]: https://doc.rust-lang.org/1.0.0/style/ownership/builders.html
51#[must_use = "The builder must be built to be used"]
52pub struct MarkBuilder {
53    builder: glib::object::ObjectBuilder<'static, Mark>,
54}
55
56impl MarkBuilder {
57    fn new() -> Self {
58        Self {
59            builder: glib::object::Object::builder(),
60        }
61    }
62
63    pub fn category(self, category: impl Into<glib::GString>) -> Self {
64        Self {
65            builder: self.builder.property("category", category.into()),
66        }
67    }
68
69    pub fn left_gravity(self, left_gravity: bool) -> Self {
70        Self {
71            builder: self.builder.property("left-gravity", left_gravity),
72        }
73    }
74
75    pub fn name(self, name: impl Into<glib::GString>) -> Self {
76        Self {
77            builder: self.builder.property("name", name.into()),
78        }
79    }
80
81    // rustdoc-stripper-ignore-next
82    /// Build the [`Mark`].
83    #[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
84    pub fn build(self) -> Mark {
85        self.builder.build()
86    }
87}
88
89mod sealed {
90    pub trait Sealed {}
91    impl<T: super::IsA<super::Mark>> Sealed for T {}
92}
93
94pub trait MarkExt: IsA<Mark> + sealed::Sealed + 'static {
95    #[doc(alias = "gtk_source_mark_get_category")]
96    #[doc(alias = "get_category")]
97    fn category(&self) -> glib::GString {
98        unsafe {
99            from_glib_none(ffi::gtk_source_mark_get_category(
100                self.as_ref().to_glib_none().0,
101            ))
102        }
103    }
104
105    #[doc(alias = "gtk_source_mark_next")]
106    #[must_use]
107    fn next(&self, category: Option<&str>) -> Option<Mark> {
108        unsafe {
109            from_glib_none(ffi::gtk_source_mark_next(
110                self.as_ref().to_glib_none().0,
111                category.to_glib_none().0,
112            ))
113        }
114    }
115
116    #[doc(alias = "gtk_source_mark_prev")]
117    #[must_use]
118    fn prev(&self, category: Option<&str>) -> Option<Mark> {
119        unsafe {
120            from_glib_none(ffi::gtk_source_mark_prev(
121                self.as_ref().to_glib_none().0,
122                category.to_glib_none().0,
123            ))
124        }
125    }
126}
127
128impl<O: IsA<Mark>> MarkExt for O {}