gaupol/dialogs/builder.py¶
Source code for module gaupol.dialogs.builder from file gaupol/dialogs/builder.py.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 | # -*- coding: utf-8 -*-
# Copyright (C) 2006 Osmo Salomaa
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
"""Baseclass and wrapper for :class:`Gtk.Builder` constructed dialogs."""
import aeidon
import os
from gi.repository import Gtk
__all__ = ("BuilderDialog",)
class BuilderDialog:
"""
Baseclass and wrapper for :class:`Gtk.Builder` constructed dialogs.
:cvar _widgets: List of names of widgets to be assigned as attributes
All widgets defined in :attr:`_widgets` are assigned as instance variables
with names preceded by a single underscore. All signals defined in the UI
definition file are connected to ``self``. All :func:`getattr` calls not
found in ``self`` are delegated to :attr:`self._dialog` allowing ``self``
to look and act like a :class:`Gtk.Dialog`.
"""
_widgets = ()
def __init__(self, ui_file_path, connect_signals=True):
"""Initialize a :class:`BuilderDialog` instance from `ui_file_path`."""
if not os.path.isabs(ui_file_path):
ui_file_path = os.path.join(aeidon.DATA_DIR, "ui", ui_file_path)
self._builder = Gtk.Builder()
self._builder.set_translation_domain("gaupol")
self._builder.add_from_file(ui_file_path)
self._dialog = self._builder.get_object("dialog")
if connect_signals:
self._builder.connect_signals(self)
self._set_attributes(self._widgets)
def __getattr__(self, name):
"""Return attribute from :attr:`_dialog`."""
return getattr(self._dialog, name)
def run(self):
"""Show the dialog, run it and return response."""
self._dialog.show()
return self._dialog.run()
def _set_attributes(self, widgets, prefix=None):
"""Assign all names in `widgets` as attributes of `self`."""
for name in widgets:
widget = self._builder.get_object(name)
if prefix is not None and name.startswith(prefix):
name = name.replace(prefix, "")
setattr(self, "_{}".format(name), widget)
|