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

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

glib::wrapper! {
    /// Context for populating [`HoverDisplay`][crate::HoverDisplay] contents.
    ///
    /// [`HoverContext`][crate::HoverContext] contains information about the request to populate
    /// contents for a [`HoverDisplay`][crate::HoverDisplay].
    ///
    /// It can be used to retrieve the [`View`][crate::View], [`Buffer`][crate::Buffer], and
    /// [`gtk::TextIter`][crate::gtk::TextIter] for the regions of text which are being displayed.
    ///
    /// Use [`bounds()`][Self::bounds()] to get the word that was
    /// requested. [`is_iter()`][Self::is_iter()] will get you the location
    /// of the pointer when the request was made.
    ///
    /// # Implements
    ///
    /// [`trait@glib::ObjectExt`]
    #[doc(alias = "GtkSourceHoverContext")]
    pub struct HoverContext(Object<ffi::GtkSourceHoverContext, ffi::GtkSourceHoverContextClass>);

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

impl HoverContext {
    /// Gets the current word bounds of the hover.
    ///
    /// If @begin is non-[`None`], it will be set to the start position of the
    /// current word being hovered.
    ///
    /// If @end is non-[`None`], it will be set to the end position for the
    /// current word being hovered.
    ///
    /// # Returns
    ///
    /// [`true`] if the marks are still valid and @begin or @end was set.
    ///
    /// ## `begin`
    /// a #GtkTextIter
    ///
    /// ## `end`
    /// a #GtkTextIter
    #[doc(alias = "gtk_source_hover_context_get_bounds")]
    #[doc(alias = "get_bounds")]
    pub fn bounds(&self) -> Option<(gtk::TextIter, gtk::TextIter)> {
        unsafe {
            let mut begin = gtk::TextIter::uninitialized();
            let mut end = gtk::TextIter::uninitialized();
            let ret = from_glib(ffi::gtk_source_hover_context_get_bounds(
                self.to_glib_none().0,
                begin.to_glib_none_mut().0,
                end.to_glib_none_mut().0,
            ));
            if ret {
                Some((begin, end))
            } else {
                None
            }
        }
    }

    /// A convenience function to get the buffer.
    ///
    /// # Returns
    ///
    /// The #GtkSourceBuffer for the view
    #[doc(alias = "gtk_source_hover_context_get_buffer")]
    #[doc(alias = "get_buffer")]
    pub fn buffer(&self) -> Buffer {
        unsafe {
            from_glib_none(ffi::gtk_source_hover_context_get_buffer(
                self.to_glib_none().0,
            ))
        }
    }

    #[doc(alias = "gtk_source_hover_context_get_iter")]
    #[doc(alias = "get_iter")]
    pub fn is_iter(&self, iter: &mut gtk::TextIter) -> bool {
        unsafe {
            from_glib(ffi::gtk_source_hover_context_get_iter(
                self.to_glib_none().0,
                iter.to_glib_none_mut().0,
            ))
        }
    }

    ///
    /// # Returns
    ///
    /// the #GtkSourceView that owns the context
    #[doc(alias = "gtk_source_hover_context_get_view")]
    #[doc(alias = "get_view")]
    pub fn view(&self) -> View {
        unsafe {
            from_glib_none(ffi::gtk_source_hover_context_get_view(
                self.to_glib_none().0,
            ))
        }
    }
}