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 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322
// 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 glib::object::IsA;
use glib::translate::*;
use std::fmt;
use std::mem;
glib::wrapper! {
/// The [`Editable`][crate::Editable] interface is an interface which should be implemented by
/// text editing widgets, such as [`Entry`][crate::Entry] and [`SpinButton`][crate::SpinButton]. It contains functions
/// for generically manipulating an editable widget, a large number of action
/// signals used for key bindings, and several signals that an application can
/// connect to to modify the behavior of a widget.
///
/// As an example of the latter usage, by connecting
/// the following handler to `signal::Editable::insert-text`, an application
/// can convert all entry into a widget into uppercase.
///
/// ## Forcing entry to uppercase.
///
///
///
/// **⚠️ The following code is in C ⚠️**
///
/// ```C
/// #include <ctype.h>;
///
/// void
/// insert_text_handler (GtkEditable *editable,
/// const gchar *text,
/// gint length,
/// gint *position,
/// gpointer data)
/// {
/// gchar *result = g_utf8_strup (text, length);
///
/// g_signal_handlers_block_by_func (editable,
/// (gpointer) insert_text_handler, data);
/// gtk_editable_insert_text (editable, result, length, position);
/// g_signal_handlers_unblock_by_func (editable,
/// (gpointer) insert_text_handler, data);
///
/// g_signal_stop_emission_by_name (editable, "insert_text");
///
/// g_free (result);
/// }
/// ```
///
/// # Implements
///
/// [`EditableExt`][trait@crate::prelude::EditableExt], [`EditableSignals`][trait@crate::prelude::EditableSignals]
#[doc(alias = "GtkEditable")]
pub struct Editable(Interface<ffi::GtkEditable, ffi::GtkEditableInterface>);
match fn {
type_ => || ffi::gtk_editable_get_type(),
}
}
impl Editable {
pub const NONE: Option<&'static Editable> = None;
}
/// Trait containing all [`struct@Editable`] methods.
///
/// # Implementors
///
/// [`Editable`][struct@crate::Editable], [`Entry`][struct@crate::Entry], [`SearchEntry`][struct@crate::SearchEntry], [`SpinButton`][struct@crate::SpinButton]
pub trait EditableExt: 'static {
/// Copies the contents of the currently selected content in the editable and
/// puts it on the clipboard.
#[doc(alias = "gtk_editable_copy_clipboard")]
fn copy_clipboard(&self);
/// Removes the contents of the currently selected content in the editable and
/// puts it on the clipboard.
#[doc(alias = "gtk_editable_cut_clipboard")]
fn cut_clipboard(&self);
/// Deletes the currently selected text of the editable.
/// This call doesn’t do anything if there is no selected text.
#[doc(alias = "gtk_editable_delete_selection")]
fn delete_selection(&self);
/// Deletes a sequence of characters. The characters that are deleted are
/// those characters at positions from `start_pos` up to, but not including
/// `end_pos`. If `end_pos` is negative, then the characters deleted
/// are those from `start_pos` to the end of the text.
///
/// Note that the positions are specified in characters, not bytes.
/// ## `start_pos`
/// start position
/// ## `end_pos`
/// end position
#[doc(alias = "gtk_editable_delete_text")]
fn delete_text(&self, start_pos: i32, end_pos: i32);
/// Retrieves a sequence of characters. The characters that are retrieved
/// are those characters at positions from `start_pos` up to, but not
/// including `end_pos`. If `end_pos` is negative, then the characters
/// retrieved are those characters from `start_pos` to the end of the text.
///
/// Note that positions are specified in characters, not bytes.
/// ## `start_pos`
/// start of text
/// ## `end_pos`
/// end of text
///
/// # Returns
///
/// a pointer to the contents of the widget as a
/// string. This string is allocated by the [`Editable`][crate::Editable]
/// implementation and should be freed by the caller.
#[doc(alias = "gtk_editable_get_chars")]
#[doc(alias = "get_chars")]
fn chars(&self, start_pos: i32, end_pos: i32) -> Option<glib::GString>;
/// Retrieves whether `self` is editable. See
/// [`set_editable()`][Self::set_editable()].
///
/// # Returns
///
/// [`true`] if `self` is editable.
#[doc(alias = "gtk_editable_get_editable")]
#[doc(alias = "get_editable")]
fn is_editable(&self) -> bool;
/// Retrieves the current position of the cursor relative to the start
/// of the content of the editable.
///
/// Note that this position is in characters, not in bytes.
///
/// # Returns
///
/// the cursor position
#[doc(alias = "gtk_editable_get_position")]
#[doc(alias = "get_position")]
fn position(&self) -> i32;
/// Retrieves the selection bound of the editable. start_pos will be filled
/// with the start of the selection and `end_pos` with end. If no text was
/// selected both will be identical and [`false`] will be returned.
///
/// Note that positions are specified in characters, not bytes.
///
/// # Returns
///
/// [`true`] if an area is selected, [`false`] otherwise
///
/// ## `start_pos`
/// location to store the starting position, or [`None`]
///
/// ## `end_pos`
/// location to store the end position, or [`None`]
#[doc(alias = "gtk_editable_get_selection_bounds")]
#[doc(alias = "get_selection_bounds")]
fn selection_bounds(&self) -> Option<(i32, i32)>;
/// Inserts `new_text_length` bytes of `new_text` into the contents of the
/// widget, at position `position`.
///
/// Note that the position is in characters, not in bytes.
/// The function updates `position` to point after the newly inserted text.
/// ## `new_text`
/// the text to append
/// ## `new_text_length`
/// the length of the text in bytes, or -1
/// ## `position`
/// location of the position text will be inserted at
#[doc(alias = "gtk_editable_insert_text")]
fn insert_text(&self, new_text: &str, position: &mut i32);
/// Pastes the content of the clipboard to the current position of the
/// cursor in the editable.
#[doc(alias = "gtk_editable_paste_clipboard")]
fn paste_clipboard(&self);
/// Selects a region of text. The characters that are selected are
/// those characters at positions from `start_pos` up to, but not
/// including `end_pos`. If `end_pos` is negative, then the
/// characters selected are those characters from `start_pos` to
/// the end of the text.
///
/// Note that positions are specified in characters, not bytes.
/// ## `start_pos`
/// start of region
/// ## `end_pos`
/// end of region
#[doc(alias = "gtk_editable_select_region")]
fn select_region(&self, start_pos: i32, end_pos: i32);
/// Determines if the user can edit the text in the editable
/// widget or not.
/// ## `is_editable`
/// [`true`] if the user is allowed to edit the text
/// in the widget
#[doc(alias = "gtk_editable_set_editable")]
fn set_editable(&self, is_editable: bool);
/// Sets the cursor position in the editable to the given value.
///
/// The cursor is displayed before the character with the given (base 0)
/// index in the contents of the editable. The value must be less than or
/// equal to the number of characters in the editable. A value of -1
/// indicates that the position should be set after the last character
/// of the editable. Note that `position` is in characters, not in bytes.
/// ## `position`
/// the position of the cursor
#[doc(alias = "gtk_editable_set_position")]
fn set_position(&self, position: i32);
}
impl<O: IsA<Editable>> EditableExt for O {
fn copy_clipboard(&self) {
unsafe {
ffi::gtk_editable_copy_clipboard(self.as_ref().to_glib_none().0);
}
}
fn cut_clipboard(&self) {
unsafe {
ffi::gtk_editable_cut_clipboard(self.as_ref().to_glib_none().0);
}
}
fn delete_selection(&self) {
unsafe {
ffi::gtk_editable_delete_selection(self.as_ref().to_glib_none().0);
}
}
fn delete_text(&self, start_pos: i32, end_pos: i32) {
unsafe {
ffi::gtk_editable_delete_text(self.as_ref().to_glib_none().0, start_pos, end_pos);
}
}
fn chars(&self, start_pos: i32, end_pos: i32) -> Option<glib::GString> {
unsafe {
from_glib_full(ffi::gtk_editable_get_chars(
self.as_ref().to_glib_none().0,
start_pos,
end_pos,
))
}
}
fn is_editable(&self) -> bool {
unsafe {
from_glib(ffi::gtk_editable_get_editable(
self.as_ref().to_glib_none().0,
))
}
}
fn position(&self) -> i32 {
unsafe { ffi::gtk_editable_get_position(self.as_ref().to_glib_none().0) }
}
fn selection_bounds(&self) -> Option<(i32, i32)> {
unsafe {
let mut start_pos = mem::MaybeUninit::uninit();
let mut end_pos = mem::MaybeUninit::uninit();
let ret = from_glib(ffi::gtk_editable_get_selection_bounds(
self.as_ref().to_glib_none().0,
start_pos.as_mut_ptr(),
end_pos.as_mut_ptr(),
));
let start_pos = start_pos.assume_init();
let end_pos = end_pos.assume_init();
if ret {
Some((start_pos, end_pos))
} else {
None
}
}
}
fn insert_text(&self, new_text: &str, position: &mut i32) {
let new_text_length = new_text.len() as i32;
unsafe {
ffi::gtk_editable_insert_text(
self.as_ref().to_glib_none().0,
new_text.to_glib_none().0,
new_text_length,
position,
);
}
}
fn paste_clipboard(&self) {
unsafe {
ffi::gtk_editable_paste_clipboard(self.as_ref().to_glib_none().0);
}
}
fn select_region(&self, start_pos: i32, end_pos: i32) {
unsafe {
ffi::gtk_editable_select_region(self.as_ref().to_glib_none().0, start_pos, end_pos);
}
}
fn set_editable(&self, is_editable: bool) {
unsafe {
ffi::gtk_editable_set_editable(self.as_ref().to_glib_none().0, is_editable.into_glib());
}
}
fn set_position(&self, position: i32) {
unsafe {
ffi::gtk_editable_set_position(self.as_ref().to_glib_none().0, position);
}
}
}
impl fmt::Display for Editable {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str("Editable")
}
}