1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
// 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::TextBuffer;
use glib::object::Cast;
use glib::object::IsA;
use glib::translate::*;
use glib::StaticType;
use glib::ToValue;
use std::fmt;
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`][crate::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::iter_at_mark()`][crate::prelude::TextBufferExt::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()`][crate::prelude::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`][crate::TextMark] object around.
///
/// Marks are typically created using the [`TextBufferExt::create_mark()`][crate::prelude::TextBufferExt::create_mark()] function.
///
/// # Implements
///
/// [`TextMarkExt`][trait@crate::prelude::TextMarkExt], [`trait@glib::ObjectExt`]
#[doc(alias = "GtkTextMark")]
pub struct TextMark(Object<ffi::GtkTextMark, ffi::GtkTextMarkClass>);
match fn {
type_ => || ffi::gtk_text_mark_get_type(),
}
}
impl TextMark {
pub const NONE: Option<&'static TextMark> = None;
/// Creates a text mark. Add it to a buffer using [`TextBufferExt::add_mark()`][crate::prelude::TextBufferExt::add_mark()].
/// If `name` is [`None`], the mark is anonymous; otherwise, the mark can be
/// retrieved by name using [`TextBufferExt::mark()`][crate::prelude::TextBufferExt::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`][crate::TextMark]
#[doc(alias = "gtk_text_mark_new")]
pub fn new(name: Option<&str>, left_gravity: bool) -> TextMark {
assert_initialized_main_thread!();
unsafe {
from_glib_full(ffi::gtk_text_mark_new(
name.to_glib_none().0,
left_gravity.into_glib(),
))
}
}
// rustdoc-stripper-ignore-next
/// Creates a new builder-pattern struct instance to construct [`TextMark`] objects.
///
/// This method returns an instance of [`TextMarkBuilder`](crate::builders::TextMarkBuilder) which can be used to create [`TextMark`] objects.
pub fn builder() -> TextMarkBuilder {
TextMarkBuilder::default()
}
}
impl Default for TextMark {
fn default() -> Self {
glib::object::Object::new::<Self>(&[])
}
}
#[derive(Clone, Default)]
// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`TextMark`] 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 TextMarkBuilder {
left_gravity: Option<bool>,
name: Option<String>,
}
impl TextMarkBuilder {
// rustdoc-stripper-ignore-next
/// Create a new [`TextMarkBuilder`].
pub fn new() -> Self {
Self::default()
}
// rustdoc-stripper-ignore-next
/// Build the [`TextMark`].
#[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
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));
}
glib::Object::new::<TextMark>(&properties)
}
/// 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(mut self, left_gravity: bool) -> Self {
self.left_gravity = Some(left_gravity);
self
}
/// The name of the mark or [`None`] if the mark is anonymous.
pub fn name(mut self, name: &str) -> Self {
self.name = Some(name.to_string());
self
}
}
/// Trait containing all [`struct@TextMark`] methods.
///
/// # Implementors
///
/// [`TextMark`][struct@crate::TextMark]
pub trait TextMarkExt: 'static {
/// Gets the buffer this mark is located inside,
/// or [`None`] if the mark is deleted.
///
/// # Returns
///
/// the mark’s [`TextBuffer`][crate::TextBuffer]
#[doc(alias = "gtk_text_mark_get_buffer")]
#[doc(alias = "get_buffer")]
fn buffer(&self) -> Option<TextBuffer>;
/// Returns [`true`] if the mark has been removed from its buffer
/// with [`TextBufferExt::delete_mark()`][crate::prelude::TextBufferExt::delete_mark()]. See [`TextBufferExt::add_mark()`][crate::prelude::TextBufferExt::add_mark()]
/// for a way to add it to a buffer again.
///
/// # Returns
///
/// whether the mark is deleted
#[doc(alias = "gtk_text_mark_get_deleted")]
#[doc(alias = "get_deleted")]
fn is_deleted(&self) -> bool;
/// Determines whether the mark has left gravity.
///
/// # Returns
///
/// [`true`] if the mark has left gravity, [`false`] otherwise
#[doc(alias = "gtk_text_mark_get_left_gravity")]
#[doc(alias = "get_left_gravity")]
fn is_left_gravity(&self) -> bool;
/// Returns the mark name; returns NULL for anonymous marks.
///
/// # Returns
///
/// mark name
#[doc(alias = "gtk_text_mark_get_name")]
#[doc(alias = "get_name")]
fn name(&self) -> Option<glib::GString>;
/// Returns [`true`] if the mark is visible (i.e. a cursor is displayed
/// for it).
///
/// # Returns
///
/// [`true`] if visible
#[doc(alias = "gtk_text_mark_get_visible")]
#[doc(alias = "get_visible")]
fn is_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
#[doc(alias = "gtk_text_mark_set_visible")]
fn set_visible(&self, setting: bool);
}
impl<O: IsA<TextMark>> TextMarkExt for O {
fn buffer(&self) -> Option<TextBuffer> {
unsafe {
from_glib_none(ffi::gtk_text_mark_get_buffer(
self.as_ref().to_glib_none().0,
))
}
}
fn is_deleted(&self) -> bool {
unsafe {
from_glib(ffi::gtk_text_mark_get_deleted(
self.as_ref().to_glib_none().0,
))
}
}
fn is_left_gravity(&self) -> bool {
unsafe {
from_glib(ffi::gtk_text_mark_get_left_gravity(
self.as_ref().to_glib_none().0,
))
}
}
fn name(&self) -> Option<glib::GString> {
unsafe { from_glib_none(ffi::gtk_text_mark_get_name(self.as_ref().to_glib_none().0)) }
}
fn is_visible(&self) -> bool {
unsafe {
from_glib(ffi::gtk_text_mark_get_visible(
self.as_ref().to_glib_none().0,
))
}
}
fn set_visible(&self, setting: bool) {
unsafe {
ffi::gtk_text_mark_set_visible(self.as_ref().to_glib_none().0, setting.into_glib());
}
}
}
impl fmt::Display for TextMark {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str("TextMark")
}
}