gio/auto/
filename_completer.rs

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
// 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::ffi;
use glib::{
    prelude::*,
    signal::{connect_raw, SignalHandlerId},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    /// Completes partial file and directory names given a partial string by
    /// looking in the file system for clues. Can return a list of possible
    /// completion strings for widget implementations.
    ///
    /// ## Signals
    ///
    ///
    /// #### `got-completion-data`
    ///  Emitted when the file name completion information comes available.
    ///
    ///
    ///
    /// # Implements
    ///
    /// [`trait@glib::ObjectExt`]
    #[doc(alias = "GFilenameCompleter")]
    pub struct FilenameCompleter(Object<ffi::GFilenameCompleter, ffi::GFilenameCompleterClass>);

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

impl FilenameCompleter {
    /// Creates a new filename completer.
    ///
    /// # Returns
    ///
    /// a #GFilenameCompleter.
    #[doc(alias = "g_filename_completer_new")]
    pub fn new() -> FilenameCompleter {
        unsafe { from_glib_full(ffi::g_filename_completer_new()) }
    }

    /// Obtains a completion for @initial_text from @self.
    /// ## `initial_text`
    /// text to be completed.
    ///
    /// # Returns
    ///
    /// a completed string, or [`None`] if no
    ///     completion exists. This string is not owned by GIO, so remember to g_free()
    ///     it when finished.
    #[doc(alias = "g_filename_completer_get_completion_suffix")]
    #[doc(alias = "get_completion_suffix")]
    pub fn completion_suffix(&self, initial_text: &str) -> Option<glib::GString> {
        unsafe {
            from_glib_full(ffi::g_filename_completer_get_completion_suffix(
                self.to_glib_none().0,
                initial_text.to_glib_none().0,
            ))
        }
    }

    /// Gets an array of completion strings for a given initial text.
    /// ## `initial_text`
    /// text to be completed.
    ///
    /// # Returns
    ///
    /// array of strings with possible completions for @initial_text.
    /// This array must be freed by g_strfreev() when finished.
    #[doc(alias = "g_filename_completer_get_completions")]
    #[doc(alias = "get_completions")]
    pub fn completions(&self, initial_text: &str) -> Vec<glib::GString> {
        unsafe {
            FromGlibPtrContainer::from_glib_full(ffi::g_filename_completer_get_completions(
                self.to_glib_none().0,
                initial_text.to_glib_none().0,
            ))
        }
    }

    /// If @dirs_only is [`true`], @self will only
    /// complete directory names, and not file names.
    /// ## `dirs_only`
    /// a #gboolean.
    #[doc(alias = "g_filename_completer_set_dirs_only")]
    pub fn set_dirs_only(&self, dirs_only: bool) {
        unsafe {
            ffi::g_filename_completer_set_dirs_only(self.to_glib_none().0, dirs_only.into_glib());
        }
    }

    /// Emitted when the file name completion information comes available.
    #[doc(alias = "got-completion-data")]
    pub fn connect_got_completion_data<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn got_completion_data_trampoline<F: Fn(&FilenameCompleter) + 'static>(
            this: *mut ffi::GFilenameCompleter,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"got-completion-data\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    got_completion_data_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl Default for FilenameCompleter {
    fn default() -> Self {
        Self::new()
    }
}