gtk4/auto/entry_buffer.rs
1// This file was generated by gir (https://github.com/gtk-rs/gir)
2// from gir-files (https://github.com/gtk-rs/gir-files)
3// DO NOT EDIT
4
5use crate::ffi;
6use glib::{
7 prelude::*,
8 signal::{connect_raw, SignalHandlerId},
9 translate::*,
10};
11use std::boxed::Box as Box_;
12
13glib::wrapper! {
14 /// Holds the text that is displayed in a single-line text entry widget.
15 ///
16 /// A single [`EntryBuffer`][crate::EntryBuffer] object can be shared by multiple widgets
17 /// which will then share the same text content, but not the cursor
18 /// position, visibility attributes, icon etc.
19 ///
20 /// [`EntryBuffer`][crate::EntryBuffer] may be derived from. Such a derived class might allow
21 /// text to be stored in an alternate location, such as non-pageable memory,
22 /// useful in the case of important passwords. Or a derived class could
23 /// integrate with an application’s concept of undo/redo.
24 ///
25 /// ## Properties
26 ///
27 ///
28 /// #### `length`
29 /// The length (in characters) of the text in buffer.
30 ///
31 /// Readable
32 ///
33 ///
34 /// #### `max-length`
35 /// The maximum length (in characters) of the text in the buffer.
36 ///
37 /// Readable | Writeable
38 ///
39 ///
40 /// #### `text`
41 /// The contents of the buffer.
42 ///
43 /// Readable | Writeable
44 ///
45 /// ## Signals
46 ///
47 ///
48 /// #### `deleted-text`
49 /// The text is altered in the default handler for this signal.
50 ///
51 /// If you want access to the text after the text has been modified,
52 /// use `G_CONNECT_AFTER`.
53 ///
54 ///
55 ///
56 ///
57 /// #### `inserted-text`
58 /// This signal is emitted after text is inserted into the buffer.
59 ///
60 ///
61 ///
62 /// # Implements
63 ///
64 /// [`EntryBufferExt`][trait@crate::prelude::EntryBufferExt], [`trait@glib::ObjectExt`], [`EntryBufferExtManual`][trait@crate::prelude::EntryBufferExtManual]
65 #[doc(alias = "GtkEntryBuffer")]
66 pub struct EntryBuffer(Object<ffi::GtkEntryBuffer, ffi::GtkEntryBufferClass>);
67
68 match fn {
69 type_ => || ffi::gtk_entry_buffer_get_type(),
70 }
71}
72
73impl EntryBuffer {
74 pub const NONE: Option<&'static EntryBuffer> = None;
75
76 // rustdoc-stripper-ignore-next
77 /// Creates a new builder-pattern struct instance to construct [`EntryBuffer`] objects.
78 ///
79 /// This method returns an instance of [`EntryBufferBuilder`](crate::builders::EntryBufferBuilder) which can be used to create [`EntryBuffer`] objects.
80 pub fn builder() -> EntryBufferBuilder {
81 EntryBufferBuilder::new()
82 }
83}
84
85// rustdoc-stripper-ignore-next
86/// A [builder-pattern] type to construct [`EntryBuffer`] objects.
87///
88/// [builder-pattern]: https://doc.rust-lang.org/1.0.0/style/ownership/builders.html
89#[must_use = "The builder must be built to be used"]
90pub struct EntryBufferBuilder {
91 builder: glib::object::ObjectBuilder<'static, EntryBuffer>,
92}
93
94impl EntryBufferBuilder {
95 fn new() -> Self {
96 Self {
97 builder: glib::object::Object::builder(),
98 }
99 }
100
101 /// The maximum length (in characters) of the text in the buffer.
102 pub fn max_length(self, max_length: i32) -> Self {
103 Self {
104 builder: self.builder.property("max-length", max_length),
105 }
106 }
107
108 /// The contents of the buffer.
109 pub fn text(self, text: impl Into<glib::GString>) -> Self {
110 Self {
111 builder: self.builder.property("text", text.into()),
112 }
113 }
114
115 // rustdoc-stripper-ignore-next
116 /// Build the [`EntryBuffer`].
117 #[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
118 pub fn build(self) -> EntryBuffer {
119 assert_initialized_main_thread!();
120 self.builder.build()
121 }
122}
123
124/// Trait containing all [`struct@EntryBuffer`] methods.
125///
126/// # Implementors
127///
128/// [`EntryBuffer`][struct@crate::EntryBuffer], [`PasswordEntryBuffer`][struct@crate::PasswordEntryBuffer]
129pub trait EntryBufferExt: IsA<EntryBuffer> + 'static {
130 /// Used when subclassing [`EntryBuffer`][crate::EntryBuffer].
131 /// ## `position`
132 /// position at which text was deleted
133 /// ## `n_chars`
134 /// number of characters deleted
135 #[doc(alias = "gtk_entry_buffer_emit_deleted_text")]
136 fn emit_deleted_text(&self, position: u32, n_chars: u32) {
137 unsafe {
138 ffi::gtk_entry_buffer_emit_deleted_text(
139 self.as_ref().to_glib_none().0,
140 position,
141 n_chars,
142 );
143 }
144 }
145
146 /// Used when subclassing [`EntryBuffer`][crate::EntryBuffer].
147 /// ## `position`
148 /// position at which text was inserted
149 /// ## `chars`
150 /// text that was inserted
151 /// ## `n_chars`
152 /// number of characters inserted
153 #[doc(alias = "gtk_entry_buffer_emit_inserted_text")]
154 fn emit_inserted_text(&self, position: u32, chars: &str, n_chars: u32) {
155 unsafe {
156 ffi::gtk_entry_buffer_emit_inserted_text(
157 self.as_ref().to_glib_none().0,
158 position,
159 chars.to_glib_none().0,
160 n_chars,
161 );
162 }
163 }
164
165 #[doc(alias = "length")]
166 fn connect_length_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
167 unsafe extern "C" fn notify_length_trampoline<P: IsA<EntryBuffer>, F: Fn(&P) + 'static>(
168 this: *mut ffi::GtkEntryBuffer,
169 _param_spec: glib::ffi::gpointer,
170 f: glib::ffi::gpointer,
171 ) {
172 let f: &F = &*(f as *const F);
173 f(EntryBuffer::from_glib_borrow(this).unsafe_cast_ref())
174 }
175 unsafe {
176 let f: Box_<F> = Box_::new(f);
177 connect_raw(
178 self.as_ptr() as *mut _,
179 c"notify::length".as_ptr() as *const _,
180 Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
181 notify_length_trampoline::<Self, F> as *const (),
182 )),
183 Box_::into_raw(f),
184 )
185 }
186 }
187
188 #[doc(alias = "max-length")]
189 fn connect_max_length_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
190 unsafe extern "C" fn notify_max_length_trampoline<
191 P: IsA<EntryBuffer>,
192 F: Fn(&P) + 'static,
193 >(
194 this: *mut ffi::GtkEntryBuffer,
195 _param_spec: glib::ffi::gpointer,
196 f: glib::ffi::gpointer,
197 ) {
198 let f: &F = &*(f as *const F);
199 f(EntryBuffer::from_glib_borrow(this).unsafe_cast_ref())
200 }
201 unsafe {
202 let f: Box_<F> = Box_::new(f);
203 connect_raw(
204 self.as_ptr() as *mut _,
205 c"notify::max-length".as_ptr() as *const _,
206 Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
207 notify_max_length_trampoline::<Self, F> as *const (),
208 )),
209 Box_::into_raw(f),
210 )
211 }
212 }
213
214 #[doc(alias = "text")]
215 fn connect_text_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
216 unsafe extern "C" fn notify_text_trampoline<P: IsA<EntryBuffer>, F: Fn(&P) + 'static>(
217 this: *mut ffi::GtkEntryBuffer,
218 _param_spec: glib::ffi::gpointer,
219 f: glib::ffi::gpointer,
220 ) {
221 let f: &F = &*(f as *const F);
222 f(EntryBuffer::from_glib_borrow(this).unsafe_cast_ref())
223 }
224 unsafe {
225 let f: Box_<F> = Box_::new(f);
226 connect_raw(
227 self.as_ptr() as *mut _,
228 c"notify::text".as_ptr() as *const _,
229 Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
230 notify_text_trampoline::<Self, F> as *const (),
231 )),
232 Box_::into_raw(f),
233 )
234 }
235 }
236}
237
238impl<O: IsA<EntryBuffer>> EntryBufferExt for O {}