Devhelp.WebView

g Atk.ImplementorIface Atk.ImplementorIface Gtk.Widget Gtk.Widget Atk.ImplementorIface->Gtk.Widget Devhelp.WebView Devhelp.WebView GObject.GInterface GObject.GInterface GObject.GInterface->Atk.ImplementorIface Gtk.Buildable Gtk.Buildable GObject.GInterface->Gtk.Buildable GObject.InitiallyUnowned GObject.InitiallyUnowned GObject.InitiallyUnowned->Gtk.Widget GObject.Object GObject.Object GObject.Object->GObject.InitiallyUnowned Gtk.Buildable->Gtk.Widget Gtk.Container Gtk.Container WebKit2.WebViewBase WebKit2.WebViewBase Gtk.Container->WebKit2.WebViewBase Gtk.Widget->Gtk.Container WebKit2.WebView WebKit2.WebView WebKit2.WebView->Devhelp.WebView WebKit2.WebViewBase->WebKit2.WebView

Subclasses:

None

Methods

Inherited:

WebKit2.WebView (93), Gtk.Container (35), Gtk.Widget (278), GObject.Object (37), Gtk.Buildable (10)

Structs:

Gtk.ContainerClass (5), Gtk.WidgetClass (12), GObject.ObjectClass (5)

class

new (profile)

can_reset_zoom ()

can_zoom_in ()

can_zoom_out ()

get_devhelp_title ()

get_profile ()

reset_zoom ()

search_next ()

search_previous ()

set_search_text (search_text)

zoom_in ()

zoom_out ()

Virtual Methods

Inherited:

WebKit2.WebView (27), Gtk.Container (10), Gtk.Widget (82), GObject.Object (7), Gtk.Buildable (10)

do_open_new_tab (uri)

Properties

Inherited:

WebKit2.WebView (24), Gtk.Container (3), Gtk.Widget (39)

Name

Type

Flags

Short Description

profile

Devhelp.Profile

r/w/co

Style Properties

Inherited:

Gtk.Widget (17)

Signals

Inherited:

WebKit2.WebView (28), Gtk.Container (4), Gtk.Widget (69), GObject.Object (1)

Name

Short Description

open-new-tab

The ::open-new-tab signal is emitted when a URI needs to be opened in a new Devhelp.WebView.

Fields

Inherited:

WebKit2.WebView (28), Gtk.Container (4), Gtk.Widget (69), GObject.Object (1)

Name

Type

Access

Description

parent

WebKit2.WebView

r

Class Details

class Devhelp.WebView(**kwargs)
Bases:

WebKit2.WebView

Abstract:

No

Structure:

Devhelp.WebViewClass

classmethod new(profile)
Parameters:

profile (Devhelp.Profile or None) – a Devhelp.Profile, or None for the default profile.

Returns:

a new Devhelp.WebView widget.

Return type:

Devhelp.WebView

New in version 3.30.

can_reset_zoom()
Returns:

whether calling Devhelp.WebView.reset_zoom() will have an effect.

Return type:

bool

New in version 3.30.

can_zoom_in()
Returns:

whether calling Devhelp.WebView.zoom_in() will have an effect.

Return type:

bool

New in version 3.30.

can_zoom_out()
Returns:

whether calling Devhelp.WebView.zoom_out() will have an effect.

Return type:

bool

New in version 3.30.

get_devhelp_title()
Returns:

the title of self, suitable for a tab label or window title.

Return type:

str

An enhanced getter function for the WebKit2.WebView :title property: when that property is the empty string or None, this function returns “Empty Page” (translated).

New in version 3.30.

get_profile()
Returns:

the Devhelp.WebView :profile.

Return type:

Devhelp.Profile

New in version 3.30.

reset_zoom()

Reset the text size to the normal size.

New in version 3.30.

search_next()

Like WebKit2.FindController.search_next(), but takes into account whether Devhelp.WebView.set_search_text() has been called.

New in version 3.30.

search_previous()

Like WebKit2.FindController.search_previous(), but takes into account whether Devhelp.WebView.set_search_text() has been called.

New in version 3.30.

set_search_text(search_text)
Parameters:

search_text (str or None) – the search string, or None.

A more convenient API (for Devhelp needs) than WebKit2.FindController. If search_text is not empty, it calls WebKit2.FindController.search() if not already done. If search_text is empty or None, it calls WebKit2.FindController.search_finish().

New in version 3.30.

zoom_in()

Makes the text larger.

New in version 3.30.

zoom_out()

Makes the text smaller.

New in version 3.30.

do_open_new_tab(uri) virtual
Parameters:

uri (str) –

Signal Details

Devhelp.WebView.signals.open_new_tab(web_view, uri)
Signal Name:

open-new-tab

Flags:

RUN_LAST

Parameters:
  • web_view (Devhelp.WebView) – The object which received the signal

  • uri (str) – the URI to open.

The ::open-new-tab signal is emitted when a URI needs to be opened in a new Devhelp.WebView. This happens when doing Ctrl+click or middle click on a link.

New in version 3.30.

Property Details

Devhelp.WebView.props.profile
Name:

profile

Type:

Devhelp.Profile

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

The Devhelp.Profile. If set to None, the default profile as returned by Devhelp.Profile.get_default() is used.

New in version 3.30.