gtk4/auto/
im_multicontext.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
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
// 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, IMContext, InputHints, InputPurpose};
use glib::{prelude::*, translate::*};

glib::wrapper! {
    /// [`IMMulticontext`][crate::IMMulticontext] is an input method context supporting multiple,
    /// switchable input methods.
    ///
    /// Text widgets such as [`Text`][crate::Text] or [`TextView`][crate::TextView] use a `GtkIMMultiContext`
    /// to implement their `im-module` property for switching between different
    /// input methods.
    ///
    /// # Implements
    ///
    /// [`IMMulticontextExt`][trait@crate::prelude::IMMulticontextExt], [`IMContextExt`][trait@crate::prelude::IMContextExt], [`trait@glib::ObjectExt`]
    #[doc(alias = "GtkIMMulticontext")]
    pub struct IMMulticontext(Object<ffi::GtkIMMulticontext, ffi::GtkIMMulticontextClass>) @extends IMContext;

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

impl IMMulticontext {
    pub const NONE: Option<&'static IMMulticontext> = None;

    /// Creates a new [`IMMulticontext`][crate::IMMulticontext].
    ///
    /// # Returns
    ///
    /// a new [`IMMulticontext`][crate::IMMulticontext].
    #[doc(alias = "gtk_im_multicontext_new")]
    pub fn new() -> IMMulticontext {
        assert_initialized_main_thread!();
        unsafe { IMContext::from_glib_full(ffi::gtk_im_multicontext_new()).unsafe_cast() }
    }

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

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

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

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

    /// Additional hints that allow input methods to fine-tune
    /// their behaviour.
    pub fn input_hints(self, input_hints: InputHints) -> Self {
        Self {
            builder: self.builder.property("input-hints", input_hints),
        }
    }

    /// The purpose of the text field that the `GtkIMContext is connected to.
    ///
    /// This property can be used by on-screen keyboards and other input
    /// methods to adjust their behaviour.
    pub fn input_purpose(self, input_purpose: InputPurpose) -> Self {
        Self {
            builder: self.builder.property("input-purpose", input_purpose),
        }
    }

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

mod sealed {
    pub trait Sealed {}
    impl<T: super::IsA<super::IMMulticontext>> Sealed for T {}
}

/// Trait containing all [`struct@IMMulticontext`] methods.
///
/// # Implementors
///
/// [`IMMulticontext`][struct@crate::IMMulticontext]
pub trait IMMulticontextExt: IsA<IMMulticontext> + sealed::Sealed + 'static {
    /// Gets the id of the currently active delegate of the @self.
    ///
    /// # Returns
    ///
    /// the id of the currently active delegate
    #[doc(alias = "gtk_im_multicontext_get_context_id")]
    #[doc(alias = "get_context_id")]
    fn context_id(&self) -> glib::GString {
        unsafe {
            from_glib_none(ffi::gtk_im_multicontext_get_context_id(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Sets the context id for @self.
    ///
    /// This causes the currently active delegate of @self to be
    /// replaced by the delegate corresponding to the new context id.
    ///
    /// Setting this to a non-[`None`] value overrides the system-wide
    /// IM module setting. See the [`gtk-im-module`][struct@crate::Settings#gtk-im-module]
    /// property.
    /// ## `context_id`
    /// the id to use
    #[doc(alias = "gtk_im_multicontext_set_context_id")]
    fn set_context_id(&self, context_id: Option<&str>) {
        unsafe {
            ffi::gtk_im_multicontext_set_context_id(
                self.as_ref().to_glib_none().0,
                context_id.to_glib_none().0,
            );
        }
    }
}

impl<O: IsA<IMMulticontext>> IMMulticontextExt for O {}