demo/demo.py

   1 #!/usr/bin/env python
   2 # -*- Mode: Python; py-indent-offset: 4 -*-
   3 # vim: tabstop=4 shiftwidth=4 expandtab
   4 #
   5 # Copyright (C) 2010 Red Hat, Inc., John (J5) Palmieri <johnp@redhat.com>
   6 #
   7 # This library is free software; you can redistribute it and/or
   8 # modify it under the terms of the GNU Lesser General Public
   9 # License as published by the Free Software Foundation; either
  10 # version 2.1 of the License, or (at your option) any later version.
  11 #
  12 # This library is distributed in the hope that it will be useful,
  13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 # Lesser General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU Lesser General Public
  18 # License along with this library; if not, write to the Free Software
  19 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
  20 # USA
  21
  22
  23 import codecs
  24 import os
  25 import sys
  26 import textwrap
  27
  28 from gi.repository import GLib, GObject, Pango, GdkPixbuf, Gtk, Gio
  29
  30 try:
  31     from gi.repository import GtkSource
  32     GtkSource  # PyFlakes
  33 except ImportError:
  34     GtkSource = None
  35
  36
  37 DEMOROOTDIR = os.path.abspath(os.path.dirname(__file__))
  38 DEMOCODEDIR = os.path.join(DEMOROOTDIR, 'demos')
  39 sys.path.insert(0, DEMOROOTDIR)
  40
  41
  42 class Demo(GObject.GObject):
  43     __gtype_name__ = 'GtkDemo'
  44
  45     def __init__(self, title, module, filename):
  46         super(Demo, self).__init__()
  47
  48         self.title = title
  49         self.module = module
  50         self.filename = filename
  51
  52     @classmethod
  53     def new_from_file(cls, path):
  54         relpath = os.path.relpath(path, DEMOROOTDIR)
  55         packagename = os.path.dirname(relpath).replace(os.sep, '.')
  56         modulename = os.path.basename(relpath)[0:-3]
  57
  58         package = __import__(packagename, globals(), locals(), [modulename], 0)
  59         module = getattr(package, modulename)
  60
  61         try:
  62             return cls(module.title, module, path)
  63         except AttributeError as e:
  64             raise AttributeError('(%s): %s' % (path, e.message))
  65
  66
  67 class DemoTreeStore(Gtk.TreeStore):
  68     __gtype_name__ = 'GtkDemoTreeStore'
  69
  70     def __init__(self, *args):
  71         super(DemoTreeStore, self).__init__(str, Demo, Pango.Style)
  72
  73         self._parent_nodes = {}
  74
  75         for filename in self._list_dir(DEMOCODEDIR):
  76             fullpath = os.path.join(DEMOCODEDIR, filename)
  77             initfile = os.path.join(os.path.dirname(fullpath), '__init__.py')
  78
  79             if fullpath != initfile and os.path.isfile(initfile) and fullpath.endswith('.py'):
  80                 parentname = os.path.dirname(os.path.relpath(fullpath, DEMOCODEDIR))
  81
  82                 if parentname:
  83                     parent = self._get_parent_node(parentname)
  84                 else:
  85                     parent = None
  86
  87                 demo = Demo.new_from_file(fullpath)
  88                 self.append(parent, (demo.title, demo, Pango.Style.NORMAL))
  89
  90     def _list_dir(self, path):
  91         demo_file_list = []
  92
  93         for filename in os.listdir(path):
  94             fullpath = os.path.join(path, filename)
  95
  96             if os.path.isdir(fullpath):
  97                 demo_file_list.extend(self._list_dir(fullpath))
  98             elif os.path.isfile(fullpath):
  99                 demo_file_list.append(fullpath)
 100
 101         return sorted(demo_file_list, key=str.lower)
 102
 103     def _get_parent_node(self, name):
 104         if name not in self._parent_nodes.keys():
 105             node = self.append(None, (name, None, Pango.Style.NORMAL))
 106             self._parent_nodes[name] = node
 107
 108         return self._parent_nodes[name]
 109
 110
 111 class GtkDemoApp(Gtk.Application):
 112     __gtype_name__ = 'GtkDemoWindow'
 113
 114     def __init__(self):
 115         super(GtkDemoApp, self).__init__(application_id='org.gnome.pygobject.gtkdemo')
 116
 117         # Use a GResource to hold the CSS files. Resource bundles are created by
 118         # the glib-compile-resources program shipped with Glib which takes an xml
 119         # file that describes the bundle, and a set of files that the xml
 120         # references. These are combined into a binary resource bundle.
 121         base_path = os.path.abspath(os.path.dirname(__file__))
 122         resource_path = os.path.join(base_path, 'demos/data/demo.gresource')
 123         resource = Gio.Resource.load(resource_path)
 124
 125         # FIXME: method register() should be without the underscore
 126         # FIXME: see https://bugzilla.gnome.org/show_bug.cgi?id=684319
 127         # Once the resource has been globally registered it can be used
 128         # throughout the application.
 129         resource._register()
 130
 131     def on_activate(self, app):
 132         self.window = Gtk.ApplicationWindow.new(self)
 133         self.window.set_title('PyGObject GTK+ Code Demos')
 134         self.window.set_default_size(600, 400)
 135         self.setup_default_icon()
 136
 137         self.header_bar = Gtk.HeaderBar(show_close_button=True,
 138                                         subtitle='Foobar')
 139         self.window.set_titlebar(self.header_bar)
 140
 141         stack = Gtk.Stack(transition_type=Gtk.StackTransitionType.SLIDE_LEFT_RIGHT,
 142                           homogeneous=True)
 143         switcher = Gtk.StackSwitcher(stack=stack, halign=Gtk.Align.CENTER)
 144
 145         self.header_bar.set_custom_title(switcher)
 146
 147         hbox = Gtk.Box(orientation=Gtk.Orientation.HORIZONTAL,
 148                        homogeneous=False,
 149                        spacing=0)
 150         self.window.add(hbox)
 151
 152         tree = self.create_tree()
 153         hbox.pack_start(child=tree, expand=False, fill=False, padding=0)
 154         hbox.pack_start(child=stack, expand=True, fill=True, padding=0)
 155
 156         text_widget, info_buffer = self.create_text_view()
 157         stack.add_titled(text_widget, name='info', title='Info')
 158
 159         self.info_buffer = info_buffer
 160         self.info_buffer.create_tag('title', font='Sans 18')
 161
 162         text_widget, self.source_buffer = self.create_source_view()
 163         stack.add_titled(text_widget, name='source', title='Source')
 164
 165         self.window.show_all()
 166
 167         self.selection_cb(self.tree_view.get_selection(),
 168                           self.tree_view.get_model())
 169
 170     def find_file(self, base=''):
 171         dir = os.path.join(DEMOCODEDIR, 'data')
 172         logo_file = os.path.join(dir, 'gtk-logo-rgb.gif')
 173         base_file = os.path.join(dir, base)
 174
 175         if (GLib.file_test(logo_file, GLib.FileTest.EXISTS) and
 176                 GLib.file_test(base_file, GLib.FileTest.EXISTS)):
 177             return base_file
 178         else:
 179             filename = os.path.join(DEMOCODEDIR, base)
 180
 181             if GLib.file_test(filename, GLib.FileTest.EXISTS):
 182                 return filename
 183
 184             # can't find the file
 185             raise IOError('Cannot find demo data file "%s"' % base)
 186
 187     def setup_default_icon(self):
 188         filename = self.find_file('gtk-logo-rgb.gif')
 189         pixbuf = GdkPixbuf.Pixbuf.new_from_file(filename)
 190         transparent = pixbuf.add_alpha(True, 0xff, 0xff, 0xff)
 191         list = []
 192         list.append(transparent)
 193         Gtk.Window.set_default_icon_list(list)
 194
 195     def selection_cb(self, selection, model):
 196         sel = selection.get_selected()
 197         if sel == ():
 198             return
 199
 200         treeiter = sel[1]
 201         title = model.get_value(treeiter, 0)
 202         demo = model.get_value(treeiter, 1)
 203
 204         if demo is None:
 205             return
 206
 207         # Split into paragraphs based on double newlines and use
 208         # textwrap to strip out all other formatting whitespace
 209         description = ''
 210         for paragraph in demo.module.description.split('\n\n'):
 211             description += '\n'.join(textwrap.wrap(paragraph, 99999))
 212             description += '\n\n'  # Add paragraphs back in
 213
 214         f = codecs.open(demo.filename, 'rU', 'utf-8')
 215         code = f.read()
 216         f.close()
 217
 218         # output and style the title
 219         (start, end) = self.info_buffer.get_bounds()
 220         self.info_buffer.delete(start, end)
 221         (start, end) = self.source_buffer.get_bounds()
 222         self.source_buffer.delete(start, end)
 223
 224         start = self.info_buffer.get_iter_at_offset(0)
 225         end = start.copy()
 226         self.info_buffer.insert(end, title)
 227         start = end.copy()
 228         start.backward_chars(len(title))
 229         self.info_buffer.apply_tag_by_name('title', start, end)
 230         self.info_buffer.insert(end, '\n')
 231
 232         # output the description
 233         self.info_buffer.insert(end, description)
 234
 235         # output the code
 236         start = self.source_buffer.get_iter_at_offset(0)
 237         end = start.copy()
 238         self.source_buffer.insert(end, code)
 239
 240     def row_activated_cb(self, view, path, col, store):
 241         iter = store.get_iter(path)
 242         demo = store.get_value(iter, 1)
 243
 244         if demo is not None:
 245             store.set_value(iter, 2, Pango.Style.ITALIC)
 246             try:
 247                 demo.module.main(self)
 248             finally:
 249                 store.set_value(iter, 2, Pango.Style.NORMAL)
 250
 251     def create_tree(self):
 252         tree_store = DemoTreeStore()
 253         tree_view = Gtk.TreeView()
 254         self.tree_view = tree_view
 255         tree_view.set_model(tree_store)
 256         selection = tree_view.get_selection()
 257         selection.set_mode(Gtk.SelectionMode.BROWSE)
 258         tree_view.set_size_request(200, -1)
 259
 260         cell = Gtk.CellRendererText()
 261         column = Gtk.TreeViewColumn(title='Widget (double click for demo)',
 262                                     cell_renderer=cell,
 263                                     text=0,
 264                                     style=2)
 265
 266         first_iter = tree_store.get_iter_first()
 267         if first_iter is not None:
 268             selection.select_iter(first_iter)
 269
 270         selection.connect('changed', self.selection_cb, tree_store)
 271         tree_view.connect('row_activated', self.row_activated_cb, tree_store)
 272
 273         tree_view.append_column(column)
 274
 275         tree_view.expand_all()
 276         tree_view.set_headers_visible(False)
 277         scrolled_window = Gtk.ScrolledWindow(hadjustment=None,
 278                                              vadjustment=None)
 279         scrolled_window.set_policy(Gtk.PolicyType.NEVER,
 280                                    Gtk.PolicyType.AUTOMATIC)
 281
 282         scrolled_window.add(tree_view)
 283
 284         label = Gtk.Label(label='Widget (double click for demo)')
 285
 286         box = Gtk.Notebook()
 287         box.append_page(scrolled_window, label)
 288
 289         tree_view.grab_focus()
 290
 291         return box
 292
 293     def create_scrolled_window(self):
 294         scrolled_window = Gtk.ScrolledWindow(hadjustment=None,
 295                                              vadjustment=None)
 296         scrolled_window.set_policy(Gtk.PolicyType.AUTOMATIC,
 297                                    Gtk.PolicyType.AUTOMATIC)
 298         scrolled_window.set_shadow_type(Gtk.ShadowType.IN)
 299         return scrolled_window
 300
 301     def create_text_view(self):
 302         text_view = Gtk.TextView()
 303         buffer = Gtk.TextBuffer()
 304
 305         text_view.set_buffer(buffer)
 306         text_view.set_editable(False)
 307         text_view.set_cursor_visible(False)
 308
 309         scrolled_window = self.create_scrolled_window()
 310         scrolled_window.add(text_view)
 311
 312         text_view.set_wrap_mode(Gtk.WrapMode.WORD)
 313         text_view.set_pixels_above_lines(2)
 314         text_view.set_pixels_below_lines(2)
 315
 316         return scrolled_window, buffer
 317
 318     def create_source_view(self):
 319         font_desc = Pango.FontDescription('monospace 11')
 320
 321         if GtkSource:
 322             lang_mgr = GtkSource.LanguageManager()
 323             lang = lang_mgr.get_language('python')
 324
 325             buffer = GtkSource.Buffer()
 326             buffer.set_language(lang)
 327             buffer.set_highlight_syntax(True)
 328
 329             view = GtkSource.View()
 330             view.set_buffer(buffer)
 331             view.set_show_line_numbers(True)
 332
 333             scrolled_window = self.create_scrolled_window()
 334             scrolled_window.add(view)
 335
 336         else:
 337             scrolled_window, buffer = self.create_text_view()
 338             view = scrolled_window.get_child()
 339
 340         view.modify_font(font_desc)
 341         view.set_wrap_mode(Gtk.WrapMode.NONE)
 342         return scrolled_window, buffer
 343
 344     def run(self, argv):
 345         self.connect('activate', self.on_activate)
 346         return super(GtkDemoApp, self).run(argv)
 347
 348
 349 def main(argv):
 350     """Entry point for demo manager"""
 351     app = GtkDemoApp()
 352     return app.run(argv)
 353
 354
 355 if __name__ == '__main__':
 356     SystemExit(main(sys.argv))