Struct libhandy::Window

pub struct Window { /* private fields */ }

A freeform window.

The Window widget is a subclass of [gtk::Window][crate::gtk::Window] which has no titlebar area and provides rounded corners on all sides, ensuring they can never be overlapped by the content. This makes it safe to use headerbars in the content area as follows:

<object class="HdyWindow"/>
  <child>
    <object class="GtkBox">
      <property name="visible">True</property>
      <property name="orientation">vertical</property>
      <child>
        <object class="HdyHeaderBar">
          <property name="visible">True</property>
          <property name="show-close-button">True</property>
        </object>
      </child>
      <child>
        <!-- ... -->
      </child>
    </object>
  </child>
</object>

It’s recommended to use HeaderBar with Window, as unlike [gtk::HeaderBar][crate::gtk::HeaderBar] it remains draggable inside the window. Otherwise, WindowHandle can be used.

Window allows to easily implement titlebar autohiding by putting the headerbar inside a Gtk::Revealer, and to show titlebar above content by putting it into a Gtk::Overlay instead of [gtk::Box][crate::gtk::Box].

If the window has a Gtk::GLArea, it may bring a slight performance regression when the window is not fullscreen, tiled or maximized.

Using [GtkWindowExtManual::titlebar()][crate::gtk::prelude::GtkWindowExtManual::titlebar()] and [GtkWindowExtManual::set_titlebar()][crate::gtk::prelude::GtkWindowExtManual::set_titlebar()] is not supported and will result in a crash.

CSS nodes

Window has a main CSS node with the name window and style classes .background, .csd and .unified.

The .solid-csd style class on the main node is used for client-side decorations without invisible borders.

Window also represents window states with the following style classes on the main node: .tiled, .maximized, .fullscreen.

It contains the subnodes decoration for window shadow and/or border, decoration-overlay for the sheen on top of the window, widget.titlebar, and deck, which contains the child inside the window.

Implements

[trait@gtk::prelude::GtkWindowExt], [trait@gtk::prelude::BinExt], [trait@gtk::prelude::ContainerExt], [trait@gtk::prelude::WidgetExt], [trait@glib::ObjectExt], [trait@gtk::prelude::BuildableExt]

Implementations

impl Window

pub const NONE: Option<&'static Window> = None

pub fn new() -> Window

Creates a new Window.

Returns

the newly created Window

pub fn builder() -> WindowBuilder

Creates a new builder-pattern struct instance to construct Window objects.

This method returns an instance of WindowBuilder which can be used to create Window objects.

Trait Implementations

impl Clone for Window

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Window

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Window

fn default() -> Self

Returns the “default value” for a type.

impl Display for Window

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for Window

type ParamSpec = ParamSpecObject

type SetValue = Window

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, Window>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Window

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Window

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for Window

type Parent = Window

impl<OT: ObjectType> PartialEq<OT> for Window

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for Window

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Window

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Window

impl IsA<Bin> for Window

impl IsA<Buildable> for Window

impl IsA<Container> for Window

impl IsA<Widget> for Window

impl IsA<Window> for PreferencesWindow

impl IsA<Window> for Window