gtk4/auto/
password_entry_buffer.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
// 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, EntryBuffer};
use glib::{prelude::*, translate::*};

glib::wrapper! {
    /// A [`EntryBuffer`][crate::EntryBuffer] that locks the underlying memory to prevent it
    /// from being swapped to disk.
    ///
    /// [`PasswordEntry`][crate::PasswordEntry] uses a [`PasswordEntryBuffer`][crate::PasswordEntryBuffer].
    ///
    /// # Implements
    ///
    /// [`EntryBufferExt`][trait@crate::prelude::EntryBufferExt], [`trait@glib::ObjectExt`], [`EntryBufferExtManual`][trait@crate::prelude::EntryBufferExtManual]
    #[doc(alias = "GtkPasswordEntryBuffer")]
    pub struct PasswordEntryBuffer(Object<ffi::GtkPasswordEntryBuffer, ffi::GtkPasswordEntryBufferClass>) @extends EntryBuffer;

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

impl PasswordEntryBuffer {
    /// Creates a new [`EntryBuffer`][crate::EntryBuffer] using secure memory allocations.
    ///
    /// # Returns
    ///
    /// the newly created instance
    #[doc(alias = "gtk_password_entry_buffer_new")]
    pub fn new() -> PasswordEntryBuffer {
        assert_initialized_main_thread!();
        unsafe { EntryBuffer::from_glib_full(ffi::gtk_password_entry_buffer_new()).unsafe_cast() }
    }

    // rustdoc-stripper-ignore-next
    /// Creates a new builder-pattern struct instance to construct [`PasswordEntryBuffer`] objects.
    ///
    /// This method returns an instance of [`PasswordEntryBufferBuilder`](crate::builders::PasswordEntryBufferBuilder) which can be used to create [`PasswordEntryBuffer`] objects.
    pub fn builder() -> PasswordEntryBufferBuilder {
        PasswordEntryBufferBuilder::new()
    }
}

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

// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`PasswordEntryBuffer`] 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 PasswordEntryBufferBuilder {
    builder: glib::object::ObjectBuilder<'static, PasswordEntryBuffer>,
}

impl PasswordEntryBufferBuilder {
    fn new() -> Self {
        Self {
            builder: glib::object::Object::builder(),
        }
    }

    /// The maximum length (in characters) of the text in the buffer.
    pub fn max_length(self, max_length: i32) -> Self {
        Self {
            builder: self.builder.property("max-length", max_length),
        }
    }

    /// The contents of the buffer.
    pub fn text(self, text: impl Into<glib::GString>) -> Self {
        Self {
            builder: self.builder.property("text", text.into()),
        }
    }

    // rustdoc-stripper-ignore-next
    /// Build the [`PasswordEntryBuffer`].
    #[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
    pub fn build(self) -> PasswordEntryBuffer {
        assert_initialized_main_thread!();
        self.builder.build()
    }
}