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
// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files.git)
// DO NOT EDIT
use crate::Accessible;
use crate::Buildable;
use crate::ConstraintTarget;
use crate::Native;
use crate::Widget;
use glib::object::IsA;
use glib::translate::*;
use std::fmt;
glib::wrapper! {
/// [`Root`][crate::Root] is the interface implemented by all widgets that can act as a toplevel
/// widget.
///
/// The root widget takes care of providing the connection to the windowing system
/// and manages layout, drawing and event delivery for its widget hierarchy.
///
/// The obvious example of a [`Root`][crate::Root] is [`Window`][crate::Window].
///
/// To get the display to which a [`Root`][crate::Root] belongs, use
/// `Gtk::Root::get_display()`.
///
/// [`Root`][crate::Root] also maintains the location of keyboard focus inside its widget
/// hierarchy, with [`RootExt::set_focus()`][crate::prelude::RootExt::set_focus()] and [`RootExt::focus()`][crate::prelude::RootExt::focus()].
///
/// # Implements
///
/// [`RootExt`][trait@crate::prelude::RootExt], [`NativeExt`][trait@crate::prelude::NativeExt], [`WidgetExt`][trait@crate::prelude::WidgetExt], [`trait@glib::ObjectExt`], [`AccessibleExt`][trait@crate::prelude::AccessibleExt], [`BuildableExt`][trait@crate::prelude::BuildableExt], [`ConstraintTargetExt`][trait@crate::prelude::ConstraintTargetExt], [`WidgetExtManual`][trait@crate::prelude::WidgetExtManual], [`AccessibleExtManual`][trait@crate::prelude::AccessibleExtManual]
#[doc(alias = "GtkRoot")]
pub struct Root(Interface<ffi::GtkRoot, ffi::GtkRootInterface>) @requires Native, Widget, Accessible, Buildable, ConstraintTarget;
match fn {
type_ => || ffi::gtk_root_get_type(),
}
}
impl Root {
pub const NONE: Option<&'static Root> = None;
}
/// Trait containing all [`struct@Root`] methods.
///
/// # Implementors
///
/// [`AboutDialog`][struct@crate::AboutDialog], [`AppChooserDialog`][struct@crate::AppChooserDialog], [`ApplicationWindow`][struct@crate::ApplicationWindow], [`Assistant`][struct@crate::Assistant], [`ColorChooserDialog`][struct@crate::ColorChooserDialog], [`Dialog`][struct@crate::Dialog], [`DragIcon`][struct@crate::DragIcon], [`FileChooserDialog`][struct@crate::FileChooserDialog], [`FontChooserDialog`][struct@crate::FontChooserDialog], [`MessageDialog`][struct@crate::MessageDialog], [`PageSetupUnixDialog`][struct@crate::PageSetupUnixDialog], [`PrintUnixDialog`][struct@crate::PrintUnixDialog], [`Root`][struct@crate::Root], [`ShortcutsWindow`][struct@crate::ShortcutsWindow], [`Window`][struct@crate::Window]
pub trait RootExt: 'static {
/// Retrieves the current focused widget within the root.
///
/// Note that this is the widget that would have the focus
/// if the root is active; if the root is not focused then
/// `gtk_widget_has_focus (widget)` will be [`false`] for the
/// widget.
///
/// # Returns
///
/// the currently focused widget
#[doc(alias = "gtk_root_get_focus")]
#[doc(alias = "get_focus")]
fn focus(&self) -> Option<Widget>;
/// If @focus is not the current focus widget, and is focusable, sets
/// it as the focus widget for the root.
///
/// If @focus is [`None`], unsets the focus widget for the root.
///
/// To set the focus to a particular widget in the root, it is usually
/// more convenient to use [`WidgetExt::grab_focus()`][crate::prelude::WidgetExt::grab_focus()] instead of
/// this function.
/// ## `focus`
/// widget to be the new focus widget, or [`None`]
/// to unset the focus widget
#[doc(alias = "gtk_root_set_focus")]
fn set_focus(&self, focus: Option<&impl IsA<Widget>>);
}
impl<O: IsA<Root>> RootExt for O {
fn focus(&self) -> Option<Widget> {
unsafe { from_glib_none(ffi::gtk_root_get_focus(self.as_ref().to_glib_none().0)) }
}
fn set_focus(&self, focus: Option<&impl IsA<Widget>>) {
unsafe {
ffi::gtk_root_set_focus(
self.as_ref().to_glib_none().0,
focus.map(|p| p.as_ref()).to_glib_none().0,
);
}
}
}
impl fmt::Display for Root {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str("Root")
}
}