WebKitWebWindowFeatures

WebKitWebWindowFeatures — Window properties of a WebKitWebView

Synopsis

                    WebKitWebWindowFeatures;
gboolean            webkit_web_window_features_equal    (WebKitWebWindowFeatures *features1,
                                                         WebKitWebWindowFeatures *features2);
WebKitWebWindowFeatures * webkit_web_window_features_new
                                                        (void);

Object Hierarchy

  GObject
   +----WebKitWebWindowFeatures

Properties

  "fullscreen"               gboolean              : Read / Write / Construct
  "height"                   gint                  : Read / Write / Construct
  "locationbar-visible"      gboolean              : Read / Write / Construct
  "menubar-visible"          gboolean              : Read / Write / Construct
  "scrollbar-visible"        gboolean              : Read / Write / Construct
  "statusbar-visible"        gboolean              : Read / Write / Construct
  "toolbar-visible"          gboolean              : Read / Write / Construct
  "width"                    gint                  : Read / Write / Construct
  "x"                        gint                  : Read / Write / Construct
  "y"                        gint                  : Read / Write / Construct

Description

The content of a WebKitWebView can request to change certain properties of a WebKitWebView. 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, the request to show the WebKitWebView fullscreen.

In the normal case one will use webkit_web_view_get_window_features to get the WebKitWebWindowFeatures and then monitor the property changes. Be aware that the WebKitWebWindowFeatures might change before "web-view-ready" signal is emitted. To be safe listen to the notify::window-features signal of the WebKitWebView and reconnect the signals whenever the WebKitWebWindowFeatures of a WebKitWebView changes.

/* Get the current WebKitWebWindowFeatures */
WebKitWebWindowFeatures *features = webkit_web_view_get_window_features (my_webview);

/* Connect to the property changes */
g_signal_connect (G_OBJECT(features), "notify::menubar-visible", G_CALLBACK(make_menu_bar_visible), NULL);
g_signal_connect (G_OBJECT(features), "notify::statusbar-visible", G_CALLBACK(make_status_bar_visible), NULL);

Details

WebKitWebWindowFeatures

typedef struct _WebKitWebWindowFeatures WebKitWebWindowFeatures;


webkit_web_window_features_equal ()

gboolean            webkit_web_window_features_equal    (WebKitWebWindowFeatures *features1,
                                                         WebKitWebWindowFeatures *features2);

Decides if a WebKitWebWindowFeatures instance equals another, as in has the same values.

features1 :

a WebKitWebWindowFeatures instance

features2 :

another WebKitWebWindowFeatures instance

Returns :

TRUE if the instances have the same values, FALSE otherwise

Since 1.0.3


webkit_web_window_features_new ()

WebKitWebWindowFeatures * webkit_web_window_features_new
                                                        (void);

Creates a new WebKitWebWindowFeatures instance with default values. It must be manually attached to a WebView.

Returns :

a new WebKitWebWindowFeatures instance

Since 1.0.3

Property Details

The "fullscreen" property

  "fullscreen"               gboolean              : Read / Write / Construct

Controls whether window will be displayed fullscreen.

Default value: FALSE

Since 1.0.3


The "height" property

  "height"                   gint                  : Read / Write / Construct

The height of the window on the screen.

Allowed values: >= -1

Default value: -1

Since 1.0.3


The "locationbar-visible" property

  "locationbar-visible"      gboolean              : Read / Write / Construct

Controls whether the locationbar should be visible for the window.

Default value: TRUE

Since 1.0.3


The "menubar-visible" property

  "menubar-visible"          gboolean              : Read / Write / Construct

Controls whether the menubar should be visible for the window.

Default value: TRUE

Since 1.0.3


The "scrollbar-visible" property

  "scrollbar-visible"        gboolean              : Read / Write / Construct

Controls whether the scrollbars should be visible for the window.

Default value: TRUE

Since 1.0.3


The "statusbar-visible" property

  "statusbar-visible"        gboolean              : Read / Write / Construct

Controls whether the statusbar should be visible for the window.

Default value: TRUE

Since 1.0.3


The "toolbar-visible" property

  "toolbar-visible"          gboolean              : Read / Write / Construct

Controls whether the toolbar should be visible for the window.

Default value: TRUE

Since 1.0.3


The "width" property

  "width"                    gint                  : Read / Write / Construct

The width of the window on the screen.

Allowed values: >= -1

Default value: -1

Since 1.0.3


The "x" property

  "x"                        gint                  : Read / Write / Construct

The starting x position of the window on the screen.

Allowed values: >= -1

Default value: -1

Since 1.0.3


The "y" property

  "y"                        gint                  : Read / Write / Construct

The starting y position of the window on the screen.

Allowed values: >= -1

Default value: -1

Since 1.0.3

See Also

"web-view-ready"