Struct gtk4::IMContext[−][src]

pub struct IMContext(_);

Expand description

IMContext defines the interface for GTK input methods.

IMContext is used by GTK text input widgets like Text to map from key events to Unicode character strings.

An input method may consume multiple key events in sequence before finally outputting the composed result. This is called preediting, and an input method may provide feedback about this process by displaying the intermediate composition states as preedit text. To do so, the IMContext will emit signal::IMContext::preedit-start, signal::IMContext::preedit-changed and signal::IMContext::preedit-end signals.

For instance, the built-in GTK input method IMContextSimple implements the input of arbitrary Unicode code points by holding down the <kbd>Control</kbd> and <kbd>Shift</kbd> keys and then typing <kbd>u</kbd> followed by the hexadecimal digits of the code point. When releasing the <kbd>Control</kbd> and <kbd>Shift</kbd> keys, preediting ends and the character is inserted as text. For example,

Ctrl+Shift+u 2 0 A C

results in the € sign.

Additional input methods can be made available for use by GTK widgets as loadable modules. An input method module is a small shared library which provides a GIOExtension for the extension point named “gtk-im-module”.

To connect a widget to the users preferred input method, you should use IMMulticontext.

This is an Abstract Base Class, you cannot instantiate it.

Struct gtk4::IMContext[−][src]

Implements

Trait Implementations

impl Clone for IMContext

fn clone(&self) -> IMContext

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

impl Debug for IMContext

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

impl Display for IMContext

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

impl Hash for IMContext

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

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

impl<T: IMContextImpl> IsSubclassable<T> for IMContext

fn class_init(class: &mut Class<Self>)

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

impl Ord for IMContext

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

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

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

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

impl ParentClassIs for IMContext

type Parent = Object

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

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

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

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

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

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

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

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

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

impl StaticType for IMContext

fn static_type() -> Type

impl Eq for IMContext

impl IsA<IMContext> for IMContextSimple

impl IsA<IMContext> for IMMulticontext

impl StructuralEq for IMContext

Auto Trait Implementations

impl RefUnwindSafe for IMContext

impl !Send for IMContext

impl !Sync for IMContext

impl Unpin for IMContext

impl UnwindSafe for IMContext

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

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

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

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

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

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

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

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

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

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

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

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>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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 unsafe fn set_qdata<QD>(&self, key: Quark, value: QD) where
QD: 'static,

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

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

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

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

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

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,

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>,

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>,

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

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

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

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

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

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

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 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>,

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

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

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

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

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

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>,