example4_webkitgtk.py

#!/usr/bin/python3

# A port of [^1] from PyGTK to PyGObject + GTK 3.0.
# Original author: Andy Breiner <breinera@gmail.com>
# Author: Ratchanan Srirattanamet <peathot@hotmail.com>
#
# Note: the listed license at [^1] specify the license simply as "GPL", without
# clarifying which versions of GPL are applicable. The code is being used
# as a demonstration only, which is _probably_ fine, but don't try to push
# your luck on this file's license.
#
# [^1]: http://www.eurion.net/python-snippets/snippet/Webkit%20Browser.html

import gi

gi.require_versions(
    {
        "Gtk": "3.0",
        "WebKit2": "4.1",
    }
)

from gi.repository import Gio, Gtk, WebKit2


class Browser:
    default_site = "http://th.pycon.org/"

    def delete_event(self, widget, event, data=None):
        return False

    def destroy(self, widget, data=None):
        self.app.quit()

    def __init__(self):
        self.app = Gtk.Application.new(
            "xyz.peat-network.webkitexample", Gio.ApplicationFlags.DEFAULT_FLAGS
        )
        self.app.connect("activate", self.app_activated)

    def app_activated(self, app):
        self.window = Gtk.ApplicationWindow.new(self.app)
        self.window.set_resizable(True)
        self.window.connect("delete_event", self.delete_event)
        self.window.connect("destroy", self.destroy)

        # webkit.WebView allows us to embed a webkit browser
        # it takes care of going backwards/fowards/reloading
        self.web_view = WebKit2.WebView.new()
        self.web_view.load_uri(self.default_site)

        toolbar = Gtk.Toolbar.new()

        # create the back button and connect the action to
        # allow us to go backwards using webkit
        self.back_button = Gtk.ToolButton(stock_id=Gtk.STOCK_GO_BACK)
        self.back_button.connect("clicked", self.go_back)

        # same idea for forward button
        self.forward_button = Gtk.ToolButton(stock_id=Gtk.STOCK_GO_FORWARD)
        self.forward_button.connect("clicked", self.go_forward)

        # again for refresh
        refresh_button = Gtk.ToolButton(stock_id=Gtk.STOCK_REFRESH)
        refresh_button.connect("clicked", self.refresh)

        # add the buttons to the toolbar
        toolbar.add(self.back_button)
        toolbar.add(self.forward_button)
        toolbar.add(refresh_button)

        # entry bar for typing in and display URLs, when they type in a site
        # and hit enter the on_active function is called
        self.url_bar = Gtk.Entry()
        self.url_bar.connect("activate", self.on_active)

        # anytime a site is loaded the update_buttons will be called
        self.web_view.connect("load-changed", self.load_changed)

        scroll_window = Gtk.ScrolledWindow(hadjustment=None, vadjustment=None)
        scroll_window.add(self.web_view)

        hbox = Gtk.HBox(homogeneous=False, spacing=0)
        hbox.pack_start(toolbar, False, False, 0)
        hbox.pack_start(self.url_bar, True, True, 0)

        vbox = Gtk.VBox(homogeneous=False, spacing=0)
        vbox.pack_start(hbox, False, True, 0)
        vbox.add(scroll_window)

        self.window.add(vbox)
        self.window.show_all()

    def on_active(self, widge, data=None):
        """When the user enters an address in the bar, we check to make
        sure they added the http://, if not we add it for them.  Once
        the url is correct, we just ask webkit to open that site."""
        url = self.url_bar.get_text()
        try:
            url.index("://")
        except:
            url = "http://" + url
        self.url_bar.set_text(url)
        self.web_view.load_uri(url)

    def go_back(self, widget, data=None):
        """Webkit will remember the links and this will allow us to go
        backwards."""
        self.web_view.go_back()

    def go_forward(self, widget, data=None):
        """Webkit will remember the links and this will allow us to go
        forwards."""
        self.web_view.go_forward()

    def refresh(self, widget, data=None):
        """Simple makes webkit reload the current back."""
        self.web_view.reload()

    def load_changed(self, webview, load_event):
        if load_event == WebKit2.LoadEvent.COMMITTED:
            self.update_buttons()

    def update_buttons(self):
        """Gets the current url entry and puts that into the url bar.
        It then checks to see if we can go back, if we can it makes the
        back button clickable.  Then it does the same for the foward
        button."""
        self.url_bar.set_text(self.web_view.get_uri())
        self.back_button.set_sensitive(self.web_view.can_go_back())
        self.forward_button.set_sensitive(self.web_view.can_go_forward())

    def main(self):
        self.app.run()


if __name__ == "__main__":
    browser = Browser()
    browser.main()