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
// This file was generated by gir (https://github.com/gtk-rs/gir)
// from
// from gir-files (https://github.com/gtk-rs/gir-files.git)
// DO NOT EDIT
#[cfg(feature = "v3_26")]
#[cfg_attr(docsrs, doc(cfg(feature = "v3_26")))]
use crate::PropertiesFlags;
use glib::{
prelude::*,
signal::{connect_raw, SignalHandlerId},
translate::*,
};
use std::{boxed::Box as Box_, fmt, mem::transmute};
glib::wrapper! {
///
///
/// ## Properties
///
///
/// #### `object`
/// Readable | Writeable
///
///
/// #### `object-type`
/// Readable | Writeable | Construct Only
///
/// # Implements
///
/// [`trait@glib::ObjectExt`], [`trait@gio::prelude::ActionGroupExt`]
#[doc(alias = "DzlPropertiesGroup")]
pub struct PropertiesGroup(Object<ffi::DzlPropertiesGroup, ffi::DzlPropertiesGroupClass>) @implements gio::ActionGroup;
match fn {
type_ => || ffi::dzl_properties_group_get_type(),
}
}
impl PropertiesGroup {
/// This creates a new [`PropertiesGroup`][crate::PropertiesGroup] to create stateful actions
/// around properties in `object`.
///
/// Call [`add_property()`][Self::add_property()] to add a property to
/// action name mapping for this group. Until you've called this,
/// no actions are mapped.
///
/// Note that [`PropertiesGroup`][crate::PropertiesGroup] only holds a weak reference to
/// `object` and therefore you must keep `object` alive elsewhere.
/// ## `object`
/// The object containing the properties
///
/// # Returns
///
/// A [`PropertiesGroup`][crate::PropertiesGroup]
#[cfg(feature = "v3_26")]
#[cfg_attr(docsrs, doc(cfg(feature = "v3_26")))]
#[doc(alias = "dzl_properties_group_new")]
pub fn new(object: &impl IsA<glib::Object>) -> PropertiesGroup {
assert_initialized_main_thread!();
unsafe {
from_glib_full(ffi::dzl_properties_group_new(
object.as_ref().to_glib_none().0,
))
}
}
/// This creates a new [`PropertiesGroup`][crate::PropertiesGroup] for which the initial object is
/// [`None`].
///
/// Set `object_type` to a type of a class which is a [`glib::Object`][crate::glib::Object]-based type.
/// ## `object_type`
/// A `GObjectClass` based type
///
/// # Returns
///
/// A [`PropertiesGroup`][crate::PropertiesGroup].
#[doc(alias = "dzl_properties_group_new_for_type")]
#[doc(alias = "new_for_type")]
pub fn for_type(object_type: glib::types::Type) -> PropertiesGroup {
assert_initialized_main_thread!();
unsafe {
from_glib_none(ffi::dzl_properties_group_new_for_type(
object_type.into_glib(),
))
}
}
/// This function will try to add all properties found on the target
/// instance to the group. Only properties that are supported by the
/// [`PropertiesGroup`][crate::PropertiesGroup] will be added.
///
/// The action name of all added properties will be identical to their
/// property name.
#[cfg(feature = "v3_26")]
#[cfg_attr(docsrs, doc(cfg(feature = "v3_26")))]
#[doc(alias = "dzl_properties_group_add_all_properties")]
pub fn add_all_properties(&self) {
unsafe {
ffi::dzl_properties_group_add_all_properties(self.to_glib_none().0);
}
}
/// Adds a new stateful action named `name` which maps to the underlying
/// property `property_name` of [`object`][struct@crate::PropertiesGroup#object].
/// ## `name`
/// the name of the action
/// ## `property_name`
/// the name of the property
#[cfg(feature = "v3_26")]
#[cfg_attr(docsrs, doc(cfg(feature = "v3_26")))]
#[doc(alias = "dzl_properties_group_add_property")]
pub fn add_property(&self, name: &str, property_name: &str) {
unsafe {
ffi::dzl_properties_group_add_property(
self.to_glib_none().0,
name.to_glib_none().0,
property_name.to_glib_none().0,
);
}
}
/// Adds a new stateful action named `name` which maps to the underlying
/// property `property_name` of [`object`][struct@crate::PropertiesGroup#object].
///
/// Seting `flags` allows you to tweak some settings about the action.
/// ## `name`
/// the name of the action
/// ## `property_name`
/// the name of the property
/// ## `flags`
/// optional flags for the action
#[cfg(feature = "v3_26")]
#[cfg_attr(docsrs, doc(cfg(feature = "v3_26")))]
#[doc(alias = "dzl_properties_group_add_property_full")]
pub fn add_property_full(&self, name: &str, property_name: &str, flags: PropertiesFlags) {
unsafe {
ffi::dzl_properties_group_add_property_full(
self.to_glib_none().0,
name.to_glib_none().0,
property_name.to_glib_none().0,
flags.into_glib(),
);
}
}
/// Removes an action from `self` that was previously added with
/// [`add_property()`][Self::add_property()]. `name` should match the
/// name parameter to that function.
/// ## `name`
/// the name of the action
#[cfg(feature = "v3_26")]
#[cfg_attr(docsrs, doc(cfg(feature = "v3_26")))]
#[doc(alias = "dzl_properties_group_remove")]
pub fn remove(&self, name: &str) {
unsafe {
ffi::dzl_properties_group_remove(self.to_glib_none().0, name.to_glib_none().0);
}
}
pub fn object(&self) -> Option<glib::Object> {
ObjectExt::property(self, "object")
}
pub fn set_object<P: IsA<glib::Object>>(&self, object: Option<&P>) {
ObjectExt::set_property(self, "object", object)
}
#[doc(alias = "object-type")]
pub fn object_type(&self) -> glib::types::Type {
ObjectExt::property(self, "object-type")
}
#[doc(alias = "object")]
pub fn connect_object_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_object_trampoline<F: Fn(&PropertiesGroup) + 'static>(
this: *mut ffi::DzlPropertiesGroup,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::object\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_object_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
}
impl fmt::Display for PropertiesGroup {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str("PropertiesGroup")
}
}