gio/auto/menu_link_iter.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
// 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, MenuModel};
use glib::{prelude::*, translate::*};
glib::wrapper! {
/// #GMenuLinkIter is an opaque structure type. You must access it using
/// the functions below.
///
/// This is an Abstract Base Class, you cannot instantiate it.
///
/// # Implements
///
/// [`MenuLinkIterExt`][trait@crate::prelude::MenuLinkIterExt], [`trait@glib::ObjectExt`]
#[doc(alias = "GMenuLinkIter")]
pub struct MenuLinkIter(Object<ffi::GMenuLinkIter, ffi::GMenuLinkIterClass>);
match fn {
type_ => || ffi::g_menu_link_iter_get_type(),
}
}
impl MenuLinkIter {
pub const NONE: Option<&'static MenuLinkIter> = None;
}
mod sealed {
pub trait Sealed {}
impl<T: super::IsA<super::MenuLinkIter>> Sealed for T {}
}
/// Trait containing all [`struct@MenuLinkIter`] methods.
///
/// # Implementors
///
/// [`MenuLinkIter`][struct@crate::MenuLinkIter]
pub trait MenuLinkIterExt: IsA<MenuLinkIter> + sealed::Sealed + 'static {
/// This function combines g_menu_link_iter_next() with
/// g_menu_link_iter_get_name() and g_menu_link_iter_get_value().
///
/// First the iterator is advanced to the next (possibly first) link.
/// If that fails, then [`false`] is returned and there are no other effects.
///
/// If successful, @out_link and @value are set to the name and #GMenuModel
/// of the link that has just been advanced to. At this point,
/// g_menu_link_iter_get_name() and g_menu_link_iter_get_value() will return the
/// same values again.
///
/// The value returned in @out_link remains valid for as long as the iterator
/// remains at the current position. The value returned in @value must
/// be unreffed using g_object_unref() when it is no longer in use.
///
/// # Returns
///
/// [`true`] on success, or [`false`] if there is no additional link
///
/// ## `out_link`
/// the name of the link
///
/// ## `value`
/// the linked #GMenuModel
#[doc(alias = "g_menu_link_iter_get_next")]
#[doc(alias = "get_next")]
fn next(&self) -> Option<(glib::GString, MenuModel)> {
unsafe {
let mut out_link = std::ptr::null();
let mut value = std::ptr::null_mut();
let ret = from_glib(ffi::g_menu_link_iter_get_next(
self.as_ref().to_glib_none().0,
&mut out_link,
&mut value,
));
if ret {
Some((from_glib_none(out_link), from_glib_full(value)))
} else {
None
}
}
}
}
impl<O: IsA<MenuLinkIter>> MenuLinkIterExt for O {}