gtk/auto/
plug_accessible.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 glib::{prelude::*, translate::*};
6use std::fmt;
7
8glib::wrapper! {
9    ///
10    ///
11    /// # Implements
12    ///
13    /// [`PlugAccessibleExt`][trait@crate::prelude::PlugAccessibleExt], [`trait@atk::prelude::ObjectExt`], [`trait@glib::ObjectExt`]
14    #[doc(alias = "GtkPlugAccessible")]
15    pub struct PlugAccessible(Object<ffi::GtkPlugAccessible, ffi::GtkPlugAccessibleClass>) @extends atk::Object;
16
17    match fn {
18        type_ => || ffi::gtk_plug_accessible_get_type(),
19    }
20}
21
22impl PlugAccessible {
23    pub const NONE: Option<&'static PlugAccessible> = None;
24
25    // rustdoc-stripper-ignore-next
26    /// Creates a new builder-pattern struct instance to construct [`PlugAccessible`] objects.
27    ///
28    /// This method returns an instance of [`PlugAccessibleBuilder`](crate::builders::PlugAccessibleBuilder) which can be used to create [`PlugAccessible`] objects.
29    pub fn builder() -> PlugAccessibleBuilder {
30        PlugAccessibleBuilder::new()
31    }
32}
33
34// rustdoc-stripper-ignore-next
35/// A [builder-pattern] type to construct [`PlugAccessible`] objects.
36///
37/// [builder-pattern]: https://doc.rust-lang.org/1.0.0/style/ownership/builders.html
38#[must_use = "The builder must be built to be used"]
39pub struct PlugAccessibleBuilder {
40    builder: glib::object::ObjectBuilder<'static, PlugAccessible>,
41}
42
43impl PlugAccessibleBuilder {
44    fn new() -> Self {
45        Self {
46            builder: glib::object::Object::builder(),
47        }
48    }
49
50    pub fn accessible_description(self, accessible_description: impl Into<glib::GString>) -> Self {
51        Self {
52            builder: self
53                .builder
54                .property("accessible-description", accessible_description.into()),
55        }
56    }
57
58    pub fn accessible_name(self, accessible_name: impl Into<glib::GString>) -> Self {
59        Self {
60            builder: self
61                .builder
62                .property("accessible-name", accessible_name.into()),
63        }
64    }
65
66    pub fn accessible_parent(self, accessible_parent: &impl IsA<atk::Object>) -> Self {
67        Self {
68            builder: self
69                .builder
70                .property("accessible-parent", accessible_parent.clone().upcast()),
71        }
72    }
73
74    pub fn accessible_role(self, accessible_role: atk::Role) -> Self {
75        Self {
76            builder: self.builder.property("accessible-role", accessible_role),
77        }
78    }
79
80    /// Table caption.
81    /// Since 1.3. Use table-caption-object instead.
82    pub fn accessible_table_caption(
83        self,
84        accessible_table_caption: impl Into<glib::GString>,
85    ) -> Self {
86        Self {
87            builder: self
88                .builder
89                .property("accessible-table-caption", accessible_table_caption.into()),
90        }
91    }
92
93    pub fn accessible_table_caption_object(
94        self,
95        accessible_table_caption_object: &impl IsA<atk::Object>,
96    ) -> Self {
97        Self {
98            builder: self.builder.property(
99                "accessible-table-caption-object",
100                accessible_table_caption_object.clone().upcast(),
101            ),
102        }
103    }
104
105    /// Accessible table column description.
106    /// Since 2.12. Use `atk_table_get_column_description()`
107    /// and `atk_table_set_column_description()` instead.
108    pub fn accessible_table_column_description(
109        self,
110        accessible_table_column_description: impl Into<glib::GString>,
111    ) -> Self {
112        Self {
113            builder: self.builder.property(
114                "accessible-table-column-description",
115                accessible_table_column_description.into(),
116            ),
117        }
118    }
119
120    /// Accessible table column header.
121    /// Since 2.12. Use `atk_table_get_column_header()` and
122    /// `atk_table_set_column_header()` instead.
123    pub fn accessible_table_column_header(
124        self,
125        accessible_table_column_header: &impl IsA<atk::Object>,
126    ) -> Self {
127        Self {
128            builder: self.builder.property(
129                "accessible-table-column-header",
130                accessible_table_column_header.clone().upcast(),
131            ),
132        }
133    }
134
135    /// Accessible table row description.
136    /// Since 2.12. Use `atk_table_get_row_description()` and
137    /// `atk_table_set_row_description()` instead.
138    pub fn accessible_table_row_description(
139        self,
140        accessible_table_row_description: impl Into<glib::GString>,
141    ) -> Self {
142        Self {
143            builder: self.builder.property(
144                "accessible-table-row-description",
145                accessible_table_row_description.into(),
146            ),
147        }
148    }
149
150    /// Accessible table row header.
151    /// Since 2.12. Use `atk_table_get_row_header()` and
152    /// `atk_table_set_row_header()` instead.
153    pub fn accessible_table_row_header(
154        self,
155        accessible_table_row_header: &impl IsA<atk::Object>,
156    ) -> Self {
157        Self {
158            builder: self.builder.property(
159                "accessible-table-row-header",
160                accessible_table_row_header.clone().upcast(),
161            ),
162        }
163    }
164
165    pub fn accessible_table_summary(
166        self,
167        accessible_table_summary: &impl IsA<atk::Object>,
168    ) -> Self {
169        Self {
170            builder: self.builder.property(
171                "accessible-table-summary",
172                accessible_table_summary.clone().upcast(),
173            ),
174        }
175    }
176
177    /// Numeric value of this object, in case being and AtkValue.
178    /// Since 2.12. Use `atk_value_get_value_and_text()` to get
179    /// the value, and value-changed signal to be notified on their value
180    /// changes.
181    pub fn accessible_value(self, accessible_value: f64) -> Self {
182        Self {
183            builder: self.builder.property("accessible-value", accessible_value),
184        }
185    }
186
187    // rustdoc-stripper-ignore-next
188    /// Build the [`PlugAccessible`].
189    #[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
190    pub fn build(self) -> PlugAccessible {
191        self.builder.build()
192    }
193}
194
195mod sealed {
196    pub trait Sealed {}
197    impl<T: super::IsA<super::PlugAccessible>> Sealed for T {}
198}
199
200/// Trait containing all [`struct@PlugAccessible`] methods.
201///
202/// # Implementors
203///
204/// [`PlugAccessible`][struct@crate::PlugAccessible]
205pub trait PlugAccessibleExt: IsA<PlugAccessible> + sealed::Sealed + 'static {
206    #[doc(alias = "gtk_plug_accessible_get_id")]
207    #[doc(alias = "get_id")]
208    fn id(&self) -> Option<glib::GString> {
209        unsafe {
210            from_glib_full(ffi::gtk_plug_accessible_get_id(
211                self.as_ref().to_glib_none().0,
212            ))
213        }
214    }
215}
216
217impl<O: IsA<PlugAccessible>> PlugAccessibleExt for O {}
218
219impl fmt::Display for PlugAccessible {
220    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
221        f.write_str("PlugAccessible")
222    }
223}
gtk/auto/plug_accessible.rs

gtk/auto/
plug_accessible.rs
