Struct gtk4::Editable[−][src]

pub struct Editable(_);

Expand description

Editable is an interface for text editing widgets.

Typical examples of editable widgets are Entry and 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 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 ⚠️

#include <ctype.h>

void
insert_text_handler (GtkEditable *editable,
                     const char  *text,
                     int          length,
                     int         *position,
                     gpointer     data)
{
  char *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);
}

Implementing GtkEditable

The most likely scenario for implementing Editable on your own widget is that you will embed a Text inside a complex widget, and want to delegate the editable functionality to that text widget. Editable provides some utility functions to make this easy.

In your class_init function, call [install_properties()][Self::install_properties()], passing the first available property ID:

⚠️ The following code is in c ⚠️

static void
my_class_init (MyClass *class)
{
  ...
  g_object_class_install_properties (object_class, NUM_PROPERTIES, props);
  gtk_editable_install_properties (object_clas, NUM_PROPERTIES);
  ...
}

In your interface_init function for the Editable interface, provide an implementation for the get_delegate vfunc that returns your text widget:

⚠️ The following code is in c ⚠️

GtkEditable *
get_editable_delegate (GtkEditable *editable)
{
  return GTK_EDITABLE (MY_WIDGET (editable)->text_widget);
}

static void
my_editable_init (GtkEditableInterface *iface)
{
  iface->get_delegate = get_editable_delegate;
}

You don’t need to provide any other vfuncs. The default implementations work by forwarding to the delegate that the GtkEditableInterface.get_delegate() vfunc returns.

In your instance_init function, create your text widget, and then call EditableExt::init_delegate():

⚠️ The following code is in c ⚠️

static void
my_widget_init (MyWidget *self)
{
  ...
  self->text_widget = gtk_text_new ();
  gtk_editable_init_delegate (GTK_EDITABLE (self));
  ...
}

In your dispose function, call EditableExt::finish_delegate() before destroying your text widget:

⚠️ The following code is in c ⚠️

static void
my_widget_dispose (GObject *object)
{
  ...
  gtk_editable_finish_delegate (GTK_EDITABLE (self));
  g_clear_pointer (&self->text_widget, gtk_widget_unparent);
  ...
}

Finally, use [delegate_set_property()][Self::delegate_set_property()] in your set_property function (and similar for get_property), to set the editable properties:

⚠️ The following code is in c ⚠️

  ...
  if (gtk_editable_delegate_set_property (object, prop_id, value, pspec))
    return;

  switch (prop_id)
  ...

It is important to note that if you create a Editable that uses a delegate, the low level signal::Editable::insert-text and signal::Editable::delete-text signals will be propagated from the “wrapper” editable to the delegate, but they will not be propagated from the delegate to the “wrapper” editable, as they would cause an infinite recursion. If you wish to connect to the signal::Editable::insert-text and signal::Editable::delete-text signals, you will need to connect to them on the delegate obtained via EditableExt::delegate().

Implements

EditableExt, WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, EditableExtManual, WidgetExtManual, AccessibleExtManual

Trait Implementations

impl Clone for Editable

fn clone(&self) -> Editable

Returns a copy of the value. Read more

1.0.0[src]

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl Debug for Editable

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

impl Display for Editable

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

impl Hash for Editable

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more

1.3.0[src]

fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,

Feeds a slice of this type into the given Hasher. Read more

impl<T: EditableImpl + ObjectSubclass> IsImplementable<T> for Editable

fn interface_init(iface: &mut Interface<Self>)

Override the virtual methods of this interface for the given subclass and do other interface initialization. Read more

fn instance_init(_instance: &mut InitializingObject<T>)

Instance specific initialization. Read more

impl Ord for Editable

fn cmp(&self, other: &Editable) -> Ordering

This method returns an Ordering between self and other. Read more

1.21.0[src]

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values. Read more

1.21.0[src]

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values. Read more

1.50.0[src]

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval. Read more

impl<T: ObjectType> PartialEq<T> for Editable

fn eq(&self, other: &T) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0[src]

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: ObjectType> PartialOrd<T> for Editable

fn partial_cmp(&self, other: &T) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more

1.0.0[src]

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more

1.0.0[src]

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0[src]

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more

1.0.0[src]

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

impl StaticType for Editable

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Editable

impl IsA<Accessible> for Editable

impl IsA<Buildable> for Editable

impl IsA<ConstraintTarget> for Editable

impl IsA<Editable> for EditableLabel

impl IsA<Editable> for Entry

impl IsA<Editable> for PasswordEntry

impl IsA<Editable> for SearchEntry

impl IsA<Editable> for SpinButton

impl IsA<Editable> for Text

impl IsA<Widget> for Editable

impl StructuralEq for Editable

Auto Trait Implementations

impl RefUnwindSafe for Editable

impl !Send for Editable

impl !Sync for Editable

impl Unpin for Editable

impl UnwindSafe for Editable

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> Cast for T where
T: ObjectType,

fn upcast<T>(self) -> T where
T: ObjectType,
Self: IsA<T>,

Upcasts an object to a superclass or interface T. Read more

fn upcast_ref<T>(&self) -> &T where
T: ObjectType,
Self: IsA<T>,

Upcasts an object to a reference of its superclass or interface T. Read more

fn downcast<T>(self) -> Result<T, Self> where
T: ObjectType,
Self: CanDowncast<T>,

Tries to downcast to a subclass or interface implementor T. Read more

fn downcast_ref<T>(&self) -> Option<&T> where
T: ObjectType,
Self: CanDowncast<T>,

Tries to downcast to a reference of its subclass or interface implementor T. Read more

fn dynamic_cast<T>(self) -> Result<T, Self> where
T: ObjectType,

Tries to cast to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while downcast and upcast will do many checks at compile-time already. Read more

fn dynamic_cast_ref<T>(&self) -> Option<&T> where
T: ObjectType,

Tries to cast to reference to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while downcast and upcast will do many checks at compile-time already. Read more

unsafe fn unsafe_cast<T>(self) -> T where
T: ObjectType,

Casts to T unconditionally. Read more

unsafe fn unsafe_cast_ref<T>(&self) -> &T where
T: ObjectType,

Casts to &T unconditionally. Read more

impl<T> From<T> for T

pub fn from(t: T) -> T

Performs the conversion.

impl<T, U> Into<U> for T where
U: From<T>,

pub fn into(self) -> U

Performs the conversion.

impl<T> ObjectExt for T where
T: ObjectType,

pub fn is<U>(&self) -> bool where
U: StaticType,

Returns true if the object is an instance of (can be cast to) T.

pub fn type_(&self) -> Type

pub fn object_class(&self) -> &Class<Object>

pub fn class(&self) -> &Class<T> where
T: IsClass,

pub fn class_of<U>(&self) -> Option<&Class<U>> where
U: IsClass,

pub fn interface<U>(&self) -> Option<InterfaceRef<'_, U>> where
U: IsInterface,

pub fn set_property<'a, N, V>(
    &self,
    property_name: N,
    value: V
) -> Result<(), BoolError> where
    N: Into<&'a str>,
    V: ToValue,

pub fn set_property_from_value<'a, N>(
    &self,
    property_name: N,
    value: &Value
) -> Result<(), BoolError> where
    N: Into<&'a str>,

pub fn set_properties(
&self,
property_values: &[(&str, &dyn ToValue )]
) -> Result<(), BoolError>

pub fn set_properties_from_value(
&self,
property_values: &[(&str, Value )]
) -> Result<(), BoolError>

pub fn property<'a, N>(&self, property_name: N) -> Result<Value, BoolError> where
N: Into<&'a str>,

pub fn has_property<'a, N>(&self, property_name: N, type_: Option<Type>) -> bool where
N: Into<&'a str>,

pub fn property_type<'a, N>(&self, property_name: N) -> Option<Type> where
N: Into<&'a str>,

pub fn find_property<'a, N>(&self, property_name: N) -> Option<ParamSpec> where
N: Into<&'a str>,

pub fn list_properties(&self) -> Vec<ParamSpec, Global>

pub fn freeze_notify(&self) -> PropertyNotificationFreezeGuard

pub unsafe fn set_qdata<QD>(&self, key: Quark, value: QD) where
QD: 'static,

Safety Read more

pub unsafe fn qdata<QD>(&self, key: Quark) -> Option<NonNull<QD>> where
QD: 'static,

Safety Read more

pub unsafe fn steal_qdata<QD>(&self, key: Quark) -> Option<QD> where
QD: 'static,

Safety Read more

pub unsafe fn set_data<QD>(&self, key: &str, value: QD) where
QD: 'static,

Safety Read more

pub unsafe fn data<QD>(&self, key: &str) -> Option<NonNull<QD>> where
QD: 'static,

Safety Read more

pub unsafe fn steal_data<QD>(&self, key: &str) -> Option<QD> where
QD: 'static,

Safety Read more

pub fn block_signal(&self, handler_id: &SignalHandlerId)

pub fn unblock_signal(&self, handler_id: &SignalHandlerId)

pub fn stop_signal_emission(&self, signal_name: &str)

pub fn connect<'a, N, F>(
    &self,
    signal_name: N,
    after: bool,
    callback: F
) -> Result<SignalHandlerId, BoolError> where
    N: Into<&'a str>,
    F: 'static + Fn(&[Value ]) -> Option<Value> + Send + Sync,

pub fn connect_id<F>(
    &self,
    signal_id: SignalId,
    details: Option<Quark>,
    after: bool,
    callback: F
) -> Result<SignalHandlerId, BoolError> where
    F: 'static + Fn(&[Value ]) -> Option<Value> + Send + Sync,

Same as connect but takes a SignalId instead of a signal name.

pub fn connect_local<'a, N, F>(
    &self,
    signal_name: N,
    after: bool,
    callback: F
) -> Result<SignalHandlerId, BoolError> where
    N: Into<&'a str>,
    F: 'static + Fn(&[Value ]) -> Option<Value>,

pub fn connect_local_id<F>(
    &self,
    signal_id: SignalId,
    details: Option<Quark>,
    after: bool,
    callback: F
) -> Result<SignalHandlerId, BoolError> where
    F: 'static + Fn(&[Value ]) -> Option<Value>,

Same as connect_local but takes a SignalId instead of a signal name.

pub unsafe fn connect_unsafe<'a, N, F>(
    &self,
    signal_name: N,
    after: bool,
    callback: F
) -> Result<SignalHandlerId, BoolError> where
    N: Into<&'a str>,
    F: Fn(&[Value ]) -> Option<Value>,

pub unsafe fn connect_unsafe_id<F>(
    &self,
    signal_id: SignalId,
    details: Option<Quark>,
    after: bool,
    callback: F
) -> Result<SignalHandlerId, BoolError> where
    F: Fn(&[Value ]) -> Option<Value>,

Same as connect_unsafe but takes a SignalId instead of a signal name.

pub fn emit(
    &self,
    signal_id: SignalId,
    args: &[&dyn ToValue ]
) -> Result<Option<Value>, BoolError>

Emit signal by signal id.

pub fn emit_with_values(
    &self,
    signal_id: SignalId,
    args: &[Value ]
) -> Result<Option<Value>, BoolError>

Same as emit but takes Value for the arguments.

pub fn emit_by_name<'a, N>(
    &self,
    signal_name: N,
    args: &[&dyn ToValue ]
) -> Result<Option<Value>, BoolError> where
    N: Into<&'a str>,

Emit signal by its name.

pub fn emit_by_name_with_values<'a, N>(
    &self,
    signal_name: N,
    args: &[Value ]
) -> Result<Option<Value>, BoolError> where
    N: Into<&'a str>,

Same as emit_by_name but takes Value for the arguments.

pub fn emit_with_details(
    &self,
    signal_id: SignalId,
    details: Quark,
    args: &[&dyn ToValue ]
) -> Result<Option<Value>, BoolError>

Emit signal with details by signal id.

pub fn emit_with_details_and_values(
    &self,
    signal_id: SignalId,
    details: Quark,
    args: &[Value ]
) -> Result<Option<Value>, BoolError>

Same as emit_with_details but takes Value for the arguments.

pub fn disconnect(&self, handler_id: SignalHandlerId)

pub fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId where
F: 'static + Fn(&T, &ParamSpec) + Send + Sync,

pub fn connect_notify_local<F>(
    &self,
    name: Option<&str>,
    f: F
) -> SignalHandlerId where
    F: 'static + Fn(&T, &ParamSpec),

pub unsafe fn connect_notify_unsafe<F>(
    &self,
    name: Option<&str>,
    f: F
) -> SignalHandlerId where
    F: Fn(&T, &ParamSpec),

pub fn notify<'a, N>(&self, property_name: N) where
N: Into<&'a str>,

pub fn notify_by_pspec(&self, pspec: &ParamSpec)

pub fn downgrade(&self) -> WeakRef<T>

pub fn bind_property<'a, O, N, M>(
    &'a self,
    source_property: N,
    target: &'a O,
    target_property: M
) -> BindingBuilder<'a> where
    O: ObjectType,
    N: Into<&'a str>,
    M: Into<&'a str>,

pub fn ref_count(&self) -> u32

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToSendValue for T where
T: Send + ToValue + ?Sized,

pub fn to_send_value(&self) -> SendValue

Returns a SendValue clone of self.

impl<T> ToString for T where
T: Display + ?Sized,

pub default fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<Super, Sub> CanDowncast<Sub> for Super where
Super: IsA<Super>,
Sub: IsA<Super>,

impl<'a, T, C> FromValueOptional<'a> for T where
T: FromValue<'a, Checker = C>,
C: ValueTypeChecker<Error = ValueTypeMismatchOrNoneError>,