gtk4/auto/

fixed.rs

// 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, Accessible, AccessibleRole, Align, Buildable, ConstraintTarget, LayoutManager, Overflow,
    Widget,
};
use glib::{prelude::*, translate::*};

glib::wrapper! {
    /// [`Fixed`][crate::Fixed] places its child widgets at fixed positions and with fixed sizes.
    ///
    /// [`Fixed`][crate::Fixed] performs no automatic layout management.
    ///
    /// For most applications, you should not use this container! It keeps
    /// you from having to learn about the other GTK containers, but it
    /// results in broken applications.  With [`Fixed`][crate::Fixed], the following
    /// things will result in truncated text, overlapping widgets, and
    /// other display bugs:
    ///
    /// - Themes, which may change widget sizes.
    ///
    /// - Fonts other than the one you used to write the app will of course
    ///   change the size of widgets containing text; keep in mind that
    ///   users may use a larger font because of difficulty reading the
    ///   default, or they may be using a different OS that provides different fonts.
    ///
    /// - Translation of text into other languages changes its size. Also,
    ///   display of non-English text will use a different font in many
    ///   cases.
    ///
    /// In addition, [`Fixed`][crate::Fixed] does not pay attention to text direction and
    /// thus may produce unwanted results if your app is run under right-to-left
    /// languages such as Hebrew or Arabic. That is: normally GTK will order
    /// containers appropriately for the text direction, e.g. to put labels to
    /// the right of the thing they label when using an RTL language, but it can’t
    /// do that with [`Fixed`][crate::Fixed]. So if you need to reorder widgets depending on
    /// the text direction, you would need to manually detect it and adjust child
    /// positions accordingly.
    ///
    /// Finally, fixed positioning makes it kind of annoying to add/remove
    /// UI elements, since you have to reposition all the other elements. This
    /// is a long-term maintenance problem for your application.
    ///
    /// If you know none of these things are an issue for your application,
    /// and prefer the simplicity of [`Fixed`][crate::Fixed], by all means use the
    /// widget. But you should be aware of the tradeoffs.
    ///
    /// # Implements
    ///
    /// [`FixedExt`][trait@crate::prelude::FixedExt], [`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 = "GtkFixed")]
    pub struct Fixed(Object<ffi::GtkFixed, ffi::GtkFixedClass>) @extends Widget, @implements Accessible, Buildable, ConstraintTarget;

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

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

    /// Creates a new [`Fixed`][crate::Fixed].
    ///
    /// # Returns
    ///
    /// a new [`Fixed`][crate::Fixed].
    #[doc(alias = "gtk_fixed_new")]
    pub fn new() -> Fixed {
        assert_initialized_main_thread!();
        unsafe { Widget::from_glib_none(ffi::gtk_fixed_new()).unsafe_cast() }
    }

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

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

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

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

    /// Whether the widget or any of its descendents can accept
    /// the input focus.
    ///
    /// This property is meant to be set by widget implementations,
    /// typically in their instance init function.
    pub fn can_focus(self, can_focus: bool) -> Self {
        Self {
            builder: self.builder.property("can-focus", can_focus),
        }
    }

    /// Whether the widget can receive pointer events.
    pub fn can_target(self, can_target: bool) -> Self {
        Self {
            builder: self.builder.property("can-target", can_target),
        }
    }

    /// A list of css classes applied to this widget.
    pub fn css_classes(self, css_classes: impl Into<glib::StrV>) -> Self {
        Self {
            builder: self.builder.property("css-classes", css_classes.into()),
        }
    }

    /// The name of this widget in the CSS tree.
    ///
    /// This property is meant to be set by widget implementations,
    /// typically in their instance init function.
    pub fn css_name(self, css_name: impl Into<glib::GString>) -> Self {
        Self {
            builder: self.builder.property("css-name", css_name.into()),
        }
    }

    /// The cursor used by @widget.
    pub fn cursor(self, cursor: &gdk::Cursor) -> Self {
        Self {
            builder: self.builder.property("cursor", cursor.clone()),
        }
    }

    /// Whether the widget should grab focus when it is clicked with the mouse.
    ///
    /// This property is only relevant for widgets that can take focus.
    pub fn focus_on_click(self, focus_on_click: bool) -> Self {
        Self {
            builder: self.builder.property("focus-on-click", focus_on_click),
        }
    }

    /// Whether this widget itself will accept the input focus.
    pub fn focusable(self, focusable: bool) -> Self {
        Self {
            builder: self.builder.property("focusable", focusable),
        }
    }

    /// How to distribute horizontal space if widget gets extra space.
    pub fn halign(self, halign: Align) -> Self {
        Self {
            builder: self.builder.property("halign", halign),
        }
    }

    /// Enables or disables the emission of the ::query-tooltip signal on @widget.
    ///
    /// A value of [`true`] indicates that @widget can have a tooltip, in this case
    /// the widget will be queried using [`query-tooltip`][struct@crate::Widget#query-tooltip] to
    /// determine whether it will provide a tooltip or not.
    pub fn has_tooltip(self, has_tooltip: bool) -> Self {
        Self {
            builder: self.builder.property("has-tooltip", has_tooltip),
        }
    }

    /// Override for height request of the widget.
    ///
    /// If this is -1, the natural request will be used.
    pub fn height_request(self, height_request: i32) -> Self {
        Self {
            builder: self.builder.property("height-request", height_request),
        }
    }

    /// Whether to expand horizontally.
    pub fn hexpand(self, hexpand: bool) -> Self {
        Self {
            builder: self.builder.property("hexpand", hexpand),
        }
    }

    /// Whether to use the `hexpand` property.
    pub fn hexpand_set(self, hexpand_set: bool) -> Self {
        Self {
            builder: self.builder.property("hexpand-set", hexpand_set),
        }
    }

    /// The [`LayoutManager`][crate::LayoutManager] instance to use to compute the preferred size
    /// of the widget, and allocate its children.
    ///
    /// This property is meant to be set by widget implementations,
    /// typically in their instance init function.
    pub fn layout_manager(self, layout_manager: &impl IsA<LayoutManager>) -> Self {
        Self {
            builder: self
                .builder
                .property("layout-manager", layout_manager.clone().upcast()),
        }
    }

    /// Margin on bottom side of widget.
    ///
    /// This property adds margin outside of the widget's normal size
    /// request, the margin will be added in addition to the size from
    /// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
    pub fn margin_bottom(self, margin_bottom: i32) -> Self {
        Self {
            builder: self.builder.property("margin-bottom", margin_bottom),
        }
    }

    /// Margin on end of widget, horizontally.
    ///
    /// This property supports left-to-right and right-to-left text
    /// directions.
    ///
    /// This property adds margin outside of the widget's normal size
    /// request, the margin will be added in addition to the size from
    /// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
    pub fn margin_end(self, margin_end: i32) -> Self {
        Self {
            builder: self.builder.property("margin-end", margin_end),
        }
    }

    /// Margin on start of widget, horizontally.
    ///
    /// This property supports left-to-right and right-to-left text
    /// directions.
    ///
    /// This property adds margin outside of the widget's normal size
    /// request, the margin will be added in addition to the size from
    /// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
    pub fn margin_start(self, margin_start: i32) -> Self {
        Self {
            builder: self.builder.property("margin-start", margin_start),
        }
    }

    /// Margin on top side of widget.
    ///
    /// This property adds margin outside of the widget's normal size
    /// request, the margin will be added in addition to the size from
    /// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
    pub fn margin_top(self, margin_top: i32) -> Self {
        Self {
            builder: self.builder.property("margin-top", margin_top),
        }
    }

    /// The name of the widget.
    pub fn name(self, name: impl Into<glib::GString>) -> Self {
        Self {
            builder: self.builder.property("name", name.into()),
        }
    }

    /// The requested opacity of the widget.
    pub fn opacity(self, opacity: f64) -> Self {
        Self {
            builder: self.builder.property("opacity", opacity),
        }
    }

    /// How content outside the widget's content area is treated.
    ///
    /// This property is meant to be set by widget implementations,
    /// typically in their instance init function.
    pub fn overflow(self, overflow: Overflow) -> Self {
        Self {
            builder: self.builder.property("overflow", overflow),
        }
    }

    /// Whether the widget will receive the default action when it is focused.
    pub fn receives_default(self, receives_default: bool) -> Self {
        Self {
            builder: self.builder.property("receives-default", receives_default),
        }
    }

    /// Whether the widget responds to input.
    pub fn sensitive(self, sensitive: bool) -> Self {
        Self {
            builder: self.builder.property("sensitive", sensitive),
        }
    }

    /// Sets the text of tooltip to be the given string, which is marked up
    /// with Pango markup.
    ///
    /// Also see [`Tooltip::set_markup()`][crate::Tooltip::set_markup()].
    ///
    /// This is a convenience property which will take care of getting the
    /// tooltip shown if the given string is not [`None`]:
    /// [`has-tooltip`][struct@crate::Widget#has-tooltip] will automatically be set to [`true`]
    /// and there will be taken care of [`query-tooltip`][struct@crate::Widget#query-tooltip] in
    /// the default signal handler.
    ///
    /// Note that if both [`tooltip-text`][struct@crate::Widget#tooltip-text] and
    /// [`tooltip-markup`][struct@crate::Widget#tooltip-markup] are set, the last one wins.
    pub fn tooltip_markup(self, tooltip_markup: impl Into<glib::GString>) -> Self {
        Self {
            builder: self
                .builder
                .property("tooltip-markup", tooltip_markup.into()),
        }
    }

    /// Sets the text of tooltip to be the given string.
    ///
    /// Also see [`Tooltip::set_text()`][crate::Tooltip::set_text()].
    ///
    /// This is a convenience property which will take care of getting the
    /// tooltip shown if the given string is not [`None`]:
    /// [`has-tooltip`][struct@crate::Widget#has-tooltip] will automatically be set to [`true`]
    /// and there will be taken care of [`query-tooltip`][struct@crate::Widget#query-tooltip] in
    /// the default signal handler.
    ///
    /// Note that if both [`tooltip-text`][struct@crate::Widget#tooltip-text] and
    /// [`tooltip-markup`][struct@crate::Widget#tooltip-markup] are set, the last one wins.
    pub fn tooltip_text(self, tooltip_text: impl Into<glib::GString>) -> Self {
        Self {
            builder: self.builder.property("tooltip-text", tooltip_text.into()),
        }
    }

    /// How to distribute vertical space if widget gets extra space.
    pub fn valign(self, valign: Align) -> Self {
        Self {
            builder: self.builder.property("valign", valign),
        }
    }

    /// Whether to expand vertically.
    pub fn vexpand(self, vexpand: bool) -> Self {
        Self {
            builder: self.builder.property("vexpand", vexpand),
        }
    }

    /// Whether to use the `vexpand` property.
    pub fn vexpand_set(self, vexpand_set: bool) -> Self {
        Self {
            builder: self.builder.property("vexpand-set", vexpand_set),
        }
    }

    /// Whether the widget is visible.
    pub fn visible(self, visible: bool) -> Self {
        Self {
            builder: self.builder.property("visible", visible),
        }
    }

    /// Override for width request of the widget.
    ///
    /// If this is -1, the natural request will be used.
    pub fn width_request(self, width_request: i32) -> Self {
        Self {
            builder: self.builder.property("width-request", width_request),
        }
    }

    /// The accessible role of the given [`Accessible`][crate::Accessible] implementation.
    ///
    /// The accessible role cannot be changed once set.
    pub fn accessible_role(self, accessible_role: AccessibleRole) -> Self {
        Self {
            builder: self.builder.property("accessible-role", accessible_role),
        }
    }

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

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

/// Trait containing all [`struct@Fixed`] methods.
///
/// # Implementors
///
/// [`Fixed`][struct@crate::Fixed]
pub trait FixedExt: IsA<Fixed> + sealed::Sealed + 'static {
    /// Retrieves the translation transformation of the
    /// given child [`Widget`][crate::Widget] in the [`Fixed`][crate::Fixed].
    ///
    /// See also: [`child_transform()`][Self::child_transform()].
    /// ## `widget`
    /// a child of @self
    ///
    /// # Returns
    ///
    ///
    /// ## `x`
    /// the horizontal position of the @widget
    ///
    /// ## `y`
    /// the vertical position of the @widget
    #[doc(alias = "gtk_fixed_get_child_position")]
    #[doc(alias = "get_child_position")]
    fn child_position(&self, widget: &impl IsA<Widget>) -> (f64, f64) {
        unsafe {
            let mut x = std::mem::MaybeUninit::uninit();
            let mut y = std::mem::MaybeUninit::uninit();
            ffi::gtk_fixed_get_child_position(
                self.as_ref().to_glib_none().0,
                widget.as_ref().to_glib_none().0,
                x.as_mut_ptr(),
                y.as_mut_ptr(),
            );
            (x.assume_init(), y.assume_init())
        }
    }

    /// Retrieves the transformation for @widget set using
    /// gtk_fixed_set_child_transform().
    /// ## `widget`
    /// a [`Widget`][crate::Widget], child of @self
    ///
    /// # Returns
    ///
    /// a [`gsk::Transform`][crate::gsk::Transform]
    #[doc(alias = "gtk_fixed_get_child_transform")]
    #[doc(alias = "get_child_transform")]
    fn child_transform(&self, widget: &impl IsA<Widget>) -> Option<gsk::Transform> {
        unsafe {
            from_glib_none(ffi::gtk_fixed_get_child_transform(
                self.as_ref().to_glib_none().0,
                widget.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Sets a translation transformation to the given @x and @y
    /// coordinates to the child @widget of the [`Fixed`][crate::Fixed].
    /// ## `widget`
    /// the child widget
    /// ## `x`
    /// the horizontal position to move the widget to
    /// ## `y`
    /// the vertical position to move the widget to
    #[doc(alias = "gtk_fixed_move")]
    #[doc(alias = "move")]
    fn move_(&self, widget: &impl IsA<Widget>, x: f64, y: f64) {
        unsafe {
            ffi::gtk_fixed_move(
                self.as_ref().to_glib_none().0,
                widget.as_ref().to_glib_none().0,
                x,
                y,
            );
        }
    }

    /// Adds a widget to a [`Fixed`][crate::Fixed] at the given position.
    /// ## `widget`
    /// the widget to add
    /// ## `x`
    /// the horizontal position to place the widget at
    /// ## `y`
    /// the vertical position to place the widget at
    #[doc(alias = "gtk_fixed_put")]
    fn put(&self, widget: &impl IsA<Widget>, x: f64, y: f64) {
        unsafe {
            ffi::gtk_fixed_put(
                self.as_ref().to_glib_none().0,
                widget.as_ref().to_glib_none().0,
                x,
                y,
            );
        }
    }

    /// Removes a child from @self.
    /// ## `widget`
    /// the child widget to remove
    #[doc(alias = "gtk_fixed_remove")]
    fn remove(&self, widget: &impl IsA<Widget>) {
        unsafe {
            ffi::gtk_fixed_remove(
                self.as_ref().to_glib_none().0,
                widget.as_ref().to_glib_none().0,
            );
        }
    }

    /// Sets the transformation for @widget.
    ///
    /// This is a convenience function that retrieves the
    /// [`FixedLayoutChild`][crate::FixedLayoutChild] instance associated to
    /// @widget and calls [`FixedLayoutChild::set_transform()`][crate::FixedLayoutChild::set_transform()].
    /// ## `widget`
    /// a [`Widget`][crate::Widget], child of @self
    /// ## `transform`
    /// the transformation assigned to @widget
    ///   to reset @widget's transform
    #[doc(alias = "gtk_fixed_set_child_transform")]
    fn set_child_transform(&self, widget: &impl IsA<Widget>, transform: Option<&gsk::Transform>) {
        unsafe {
            ffi::gtk_fixed_set_child_transform(
                self.as_ref().to_glib_none().0,
                widget.as_ref().to_glib_none().0,
                transform.to_glib_none().0,
            );
        }
    }
}

impl<O: IsA<Fixed>> FixedExt for O {}