Struct webkit6::WindowProperties

pub struct WindowProperties { /* private fields */ }

Window properties of a #WebKitWebView.

The content of a #WebKitWebView can request to change certain properties of the window containing the view. This can include the x, y position of the window, the width and height but also if a toolbar, scrollbar, statusbar, locationbar should be visible to the user, and the request to show the #WebKitWebView fullscreen.

The #WebKitWebView::ready-to-show signal handler is the proper place to apply the initial window properties. Then you can monitor the #WebKitWindowProperties by connecting to ::notify signal.

⚠️ The following code is in c ⚠️

static void ready_to_show_cb (WebKitWebView *web_view, gpointer user_data)
{
    GtkWidget *window;
    WebKitWindowProperties *window_properties;
    gboolean visible;

    // Create the window to contain the WebKitWebView.
    window = browser_window_new ();
    gtk_container_add (GTK_CONTAINER (window), GTK_WIDGET (web_view));
    gtk_widget_show (GTK_WIDGET (web_view));

    // Get the WebKitWindowProperties of the web view and monitor it.
    window_properties = webkit_web_view_get_window_properties (web_view);
    g_signal_connect (window_properties, "notify::geometry",
                      G_CALLBACK (window_geometry_changed), window);
    g_signal_connect (window_properties, "notify::toolbar-visible",
                      G_CALLBACK (window_toolbar_visibility_changed), window);
    g_signal_connect (window_properties, "notify::menubar-visible",
                      G_CALLBACK (window_menubar_visibility_changed), window);

    // Apply the window properties before showing the window.
    visible = webkit_window_properties_get_toolbar_visible (window_properties);
    browser_window_set_toolbar_visible (BROWSER_WINDOW (window), visible);
    visible = webkit_window_properties_get_menubar_visible (window_properties);
    browser_window_set_menubar_visible (BROWSER_WINDOW (window), visible);

    if (webkit_window_properties_get_fullscreen (window_properties)) {
        gtk_window_fullscreen (GTK_WINDOW (window));
    } else {
        GdkRectangle geometry;

        gtk_window_set_resizable (GTK_WINDOW (window),
                                  webkit_window_properties_get_resizable (window_properties));
        webkit_window_properties_get_geometry (window_properties, &geometry);
        gtk_window_move (GTK_WINDOW (window), geometry.x, geometry.y);
        gtk_window_resize (GTK_WINDOW (window), geometry.width, geometry.height);
    }

    gtk_widget_show (window);
}

Properties

fullscreen

Whether window will be displayed fullscreen.

Readable | Writeable | Construct Only

geometry

The size and position of the window on the screen.

Readable | Writeable | Construct Only

locationbar-visible

Whether the locationbar should be visible for the window.

Readable | Writeable | Construct Only

menubar-visible

Whether the menubar should be visible for the window.

Readable | Writeable | Construct Only

resizable

Whether the window can be resized.

Readable | Writeable | Construct Only

scrollbars-visible

Whether the scrollbars should be visible for the window.

Readable | Writeable | Construct Only

statusbar-visible

Whether the statusbar should be visible for the window.

Readable | Writeable | Construct Only

toolbar-visible

Whether the toolbar should be visible for the window.

Readable | Writeable | Construct Only

GLib type: GObject with reference counted clone semantics.

Implementations

impl WindowProperties

pub fn builder() -> WindowPropertiesBuilder

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

This method returns an instance of WindowPropertiesBuilder which can be used to create WindowProperties objects.

pub fn is_fullscreen(&self) -> bool

Get whether the window should be shown in fullscreen state or not.

Returns

true if the window should be fullscreen or false otherwise.

pub fn geometry(&self) -> Rectangle

Get the geometry the window should have on the screen when shown.

Returns

geometry

return location for the window geometry

pub fn is_locationbar_visible(&self) -> bool

Get whether the window should have the locationbar visible or not.

Returns

true if locationbar should be visible or false otherwise.

pub fn is_menubar_visible(&self) -> bool

Get whether the window should have the menubar visible or not.

Returns

true if menubar should be visible or false otherwise.

pub fn is_resizable(&self) -> bool

Get whether the window should be resizable by the user or not.

Returns

true if the window should be resizable or false otherwise.

pub fn is_scrollbars_visible(&self) -> bool

Get whether the window should have the scrollbars visible or not.

Returns

true if scrollbars should be visible or false otherwise.

pub fn is_statusbar_visible(&self) -> bool

Get whether the window should have the statusbar visible or not.

Returns

true if statusbar should be visible or false otherwise.

pub fn is_toolbar_visible(&self) -> bool

Get whether the window should have the toolbar visible or not.

Returns

true if toolbar should be visible or false otherwise.

Trait Implementations

impl Clone for WindowProperties

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

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

Performs copy-assignment from source.

impl Debug for WindowProperties

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

Formats the value using the given formatter.

impl HasParamSpec for WindowProperties

type ParamSpec = ParamSpecObject

type SetValue = WindowProperties

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for WindowProperties

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

where H: Hasher,

Hashes the memory address of this object.

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 WindowProperties

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

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

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 WindowProperties

type Parent = Object

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

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

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

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 WindowProperties

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

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

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 WindowProperties

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for WindowProperties