[kupfer] uiutils: User Interface Utility Functions

[Ulrik Sverdrup <usverdrup src gnome org>]

commit 57375f89a2db6807ddea83f114e6de633f9da9d0
Author: Ulrik Sverdrup <ulrik sverdrup gmail com>
Date:   Mon Oct 26 16:56:28 2009 +0100

    uiutils: User Interface Utility Functions
    
    Implement a window for showing a text result, that plugins can use.

 data/result.ui    |   78 ++++++++++++++++++++++++++++++++++++
 kupfer/uiutils.py |  113 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 191 insertions(+), 0 deletions(-)
---
diff --git a/data/result.ui b/data/result.ui
new file mode 100644
index 0000000..0c774ee
--- /dev/null
+++ b/data/result.ui
@@ -0,0 +1,78 @@
+<?xml version="1.0"?>
+<interface>
+  <requires lib="gtk+" version="2.14"/>
+  <!-- interface-naming-policy project-wide -->
+  <object class="GtkWindow" id="text_result_window">
+    <property name="border_width">10</property>
+    <property name="window_position">center</property>
+    <property name="default_width">800</property>
+    <property name="default_height">600</property>
+    <property name="icon_name">search</property>
+    <signal name="key_press_event" handler="on_text_result_window_key_press_event"/>
+    <child>
+      <object class="GtkVBox" id="vbox1">
+        <property name="visible">True</property>
+        <property name="orientation">vertical</property>
+        <property name="spacing">10</property>
+        <child>
+          <object class="GtkScrolledWindow" id="scrolledwindow1">
+            <property name="visible">True</property>
+            <property name="can_focus">True</property>
+            <property name="hscrollbar_policy">automatic</property>
+            <property name="vscrollbar_policy">automatic</property>
+            <child>
+              <object class="GtkTextView" id="result_textview">
+                <property name="visible">True</property>
+                <property name="can_focus">True</property>
+                <property name="editable">False</property>
+                <property name="wrap_mode">word</property>
+              </object>
+            </child>
+          </object>
+          <packing>
+            <property name="position">0</property>
+          </packing>
+        </child>
+        <child>
+          <object class="GtkHButtonBox" id="hbuttonbox1">
+            <property name="visible">True</property>
+            <child>
+              <object class="GtkButton" id="copy_button">
+                <property name="label">gtk-copy</property>
+                <property name="visible">True</property>
+                <property name="can_focus">True</property>
+                <property name="receives_default">True</property>
+                <property name="use_stock">True</property>
+                <signal name="clicked" handler="on_copy_button_clicked"/>
+              </object>
+              <packing>
+                <property name="expand">False</property>
+                <property name="fill">False</property>
+                <property name="position">0</property>
+              </packing>
+            </child>
+            <child>
+              <object class="GtkButton" id="close_button">
+                <property name="label">gtk-close</property>
+                <property name="visible">True</property>
+                <property name="can_focus">True</property>
+                <property name="receives_default">True</property>
+                <property name="use_stock">True</property>
+                <signal name="clicked" handler="on_close_button_clicked"/>
+              </object>
+              <packing>
+                <property name="expand">False</property>
+                <property name="fill">False</property>
+                <property name="position">1</property>
+              </packing>
+            </child>
+          </object>
+          <packing>
+            <property name="expand">False</property>
+            <property name="position">1</property>
+          </packing>
+        </child>
+      </object>
+    </child>
+  </object>
+</interface>
diff --git a/kupfer/uiutils.py b/kupfer/uiutils.py
new file mode 100644
index 0000000..1bc8bd4
--- /dev/null
+++ b/kupfer/uiutils.py
@@ -0,0 +1,113 @@
+"""
+User Interface Utility Functions for Kupfer
+
+These helper functions can be called from plugins (are meant to serve this
+purpose), but care should be taken to only call UI functions from the main
+(default) thread.
+"""
+
+import gtk
+import pango
+
+from kupfer import config
+
+def _window_destroy_on_escape(widget, event):
+	"""
+	Callback function for Window's key press event, will destroy window
+	on escape
+	"""
+	if event.keyval == gtk.gdk.keyval_from_name("Escape"):
+		widget.destroy()
+		return True
+
+def builder_get_objects_from_file(fname, attrs, autoconnect_to=None):
+	"""
+	Open @fname with gtk.Builder and yield objects named @attrs
+
+	@fname is sought in the data directories.
+	If @autoconnect_to is not None, signals are autoconnected to this object,
+	and a user_data object is passed as a namespace containing all @attrs
+	"""
+	builder = gtk.Builder()
+	try:
+		import version_subst
+	except ImportError:
+		package_name = "kupfer"
+	else:
+		package_name = version_subst.PACKAGE_NAME
+	builder.set_translation_domain(package_name)
+
+	ui_file = config.get_data_file(fname)
+	builder.add_from_file(ui_file)
+	class Namespace (object):
+		pass
+	names = Namespace()
+	for attr in attrs:
+		obj = builder.get_object(attr)
+		setattr(names, attr, obj)
+		yield obj
+	if autoconnect_to:
+		builder.connect_signals(autoconnect_to, user_data=names)
+
+def show_text_result(text, title=None):
+	"""
+	Show @text in a result window.
+
+	Use @title to set a window title
+	"""
+	class ResultWindowBehavior (object):
+		def on_text_result_window_key_press_event(self, widget, event, names):
+			if event.keyval == gtk.gdk.keyval_from_name("Escape"):
+				widget.destroy()
+				return True
+		def on_close_button_clicked(self, widget, names):
+			names.text_result_window.window.destroy()
+			return True
+		def on_copy_button_clicked(self, widget, names):
+			clip = gtk.clipboard_get(gtk.gdk.SELECTION_CLIPBOARD)
+			textview = names.result_textview
+			buf = textview.get_buffer()
+			buf.select_range(*buf.get_bounds())
+			buf.copy_clipboard(clip)
+
+	window, textview = builder_get_objects_from_file("result.ui",
+			("text_result_window", "result_textview"),
+			autoconnect_to=ResultWindowBehavior())
+
+
+	# Set up text buffer
+	buf = gtk.TextBuffer()
+	buf.set_text(text)
+	monospace = gtk.TextTag("fixed")
+	monospace.set_property("family", "Monospace")
+	monospace.set_property("scale", pango.SCALE_LARGE)
+	beg, end = buf.get_bounds()
+	tag_table = buf.get_tag_table()
+	tag_table.add(monospace)
+	buf.apply_tag(monospace, beg, end)
+
+	textview.set_buffer(buf)
+	textview.set_wrap_mode(gtk.WRAP_NONE)
+
+	if title:
+		window.set_title(title)
+
+	window.show_all()
+
+	# Fix Sizing:
+	# We want to size the window so that the
+	# TextView is displayed without scrollbars
+	# initially, if it fits on screen.
+	oldwid, oldhei = textview.window.get_size()
+	winwid, winhei = window.get_size()
+
+	max_hsize, max_vsize = window.get_default_size()
+	wid, hei = textview.size_request()
+	textview.set_wrap_mode(gtk.WRAP_WORD)
+
+	vsize = int(min(hei + (winhei - oldhei) + 5, max_vsize))
+	hsize = int(min(wid + (winwid - oldwid) + 5, max_hsize))
+
+	window.resize(hsize, vsize)
+	window.present()
+