File: ui.py

package info (click to toggle)
bzr-gtk 0.103.0+bzr792-3
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 1,524 kB
  • sloc: python: 9,616; makefile: 16; sh: 10
file content (260 lines) | stat: -rw-r--r-- 7,969 bytes parent folder | download
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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
# Copyright (C) 2006 Szilveszter Farkas <szilveszter.farkas@gmail.com>
# Copyright (C) 2007 Jelmer Vernooij <jelmer@samba.org>

# 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 2 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, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA


"""GTK UI
"""

from gi.repository import Gtk

from bzrlib.ui import UIFactory


def main_iteration(function):
    def with_main_iteration(self, *args, **kwargs):
        result = function(self, *args, **kwargs)
        while Gtk.events_pending():
            Gtk.main_iteration_do(False)
        return result
    return with_main_iteration


class PromptDialog(Gtk.MessageDialog):
    """Prompt the user for a yes/no answer."""

    def __init__(self, prompt, parent=None):
        super(PromptDialog, self).__init__(
            parent, Gtk.DialogFlags.DESTROY_WITH_PARENT,
            Gtk.MessageType.QUESTION, Gtk.ButtonsType.YES_NO, prompt)


class InfoDialog(Gtk.MessageDialog):
    """Show the user an informational message."""

    MESSAGE_TYPE = Gtk.MessageType.INFO

    def __init__(self, prompt, parent=None):
        super(InfoDialog, self).__init__(
            parent, Gtk.DialogFlags.DESTROY_WITH_PARENT,
            self.MESSAGE_TYPE, Gtk.ButtonsType.CLOSE, prompt)


class WarningDialog(InfoDialog):
    """Show the user a warning message."""

    MESSAGE_TYPE = Gtk.MessageType.WARNING


class ErrorDialog(InfoDialog):
    """Show the user a warning message."""

    MESSAGE_TYPE = Gtk.MessageType.ERROR


class GtkProgressBar(Gtk.ProgressBar):

    def __init__(self):
        super(GtkProgressBar, self).__init__()
        self.set_fraction(0.0)
        self.current = None
        self.total = None

    @main_iteration
    def tick(self):
        self.show()
        self.pulse()

    @main_iteration
    def update(self, msg=None, current_cnt=None, total_cnt=None):
        self.show()
        if current_cnt is not None:
            self.current = current_cnt
        if total_cnt is not None:
            self.total = total_cnt
        if msg is not None:
            self.set_text(msg)
        if None not in (self.current, self.total):
            fraction = float(self.current) / self.total
            if fraction < 0.0 or fraction > 1.0:
                raise ValueError
            self.set_fraction(fraction)

    @main_iteration
    def finished(self):
        self.set_fraction(0.0)
        self.current = None
        self.total = None
        self.hide()

    def clear(self):
        self.finished()


class ProgressContainerMixin:
    """Expose GtkProgressBar methods to a container class."""

    def tick(self, *args, **kwargs):
        self.show_all()
        self.pb.tick(*args, **kwargs)

    def update(self, *args, **kwargs):
        self.show_all()
        self.pb.update(*args, **kwargs)

    def finished(self):
        self.hide()
        self.pb.finished()

    def clear(self):
        self.hide()
        self.pb.clear()


class ProgressBarWindow(ProgressContainerMixin, Gtk.Window):

    def __init__(self):
        super(ProgressBarWindow, self).__init__(type=Gtk.WindowType.TOPLEVEL)
        self.set_border_width(0)
        self.set_title("Progress")
        self.set_position(Gtk.WindowPosition.CENTER_ALWAYS)
        self.pb = GtkProgressBar()
        self.add(self.pb)
        self.resize(250, 15)
        self.set_resizable(False)


class ProgressPanel(ProgressContainerMixin, Gtk.Box):

    def __init__(self):
        super(ProgressPanel, self).__init__(Gtk.Orientation.HORIZONTAL, 5)
        image_loading = Gtk.Image.new_from_stock(Gtk.STOCK_REFRESH,
                                                 Gtk.IconSize.BUTTON)
        image_loading.show()

        self.pb = GtkProgressBar()
        self.set_border_width(5)
        self.pack_start(image_loading, False, False, 0)
        self.pack_start(self.pb, True, True, 0)


class PasswordDialog(Gtk.Dialog):
    """ Prompt the user for a password. """

    def __init__(self, prompt):
        super(PasswordDialog, self).__init__()

        label = Gtk.Label(label=prompt)
        self.get_content_area().pack_start(label, True, True, 10)

        self.entry = Gtk.Entry()
        self.entry.set_visibility(False)
        self.get_content_area().pack_end(self.entry, False, False, 10)

        self.get_content_area().show_all()

        self.add_buttons(Gtk.STOCK_OK, Gtk.ResponseType.OK,
                         Gtk.STOCK_CANCEL, Gtk.ResponseType.CANCEL)

    def _get_passwd(self):
        return self.entry.get_text()

    passwd = property(_get_passwd)


class GtkUIFactory(UIFactory):
    """A UI factory for GTK user interfaces."""

    def __init__(self):
        """Create a GtkUIFactory"""
        super(GtkUIFactory, self).__init__()
        self.set_progress_bar_widget(None)

    def set_progress_bar_widget(self, widget):
        self._progress_bar_widget = widget

    def get_boolean(self, prompt):
        """GtkDialog with yes/no answers"""
        dialog = PromptDialog(prompt)
        response = dialog.run()
        dialog.destroy()
        return (response == Gtk.ResponseType.YES)

    def show_message(self, msg):
        """See UIFactory.show_message."""
        dialog = InfoDialog(msg)
        dialog.run()
        dialog.destroy()

    def show_warning(self, msg):
        """See UIFactory.show_warning."""
        dialog = WarningDialog(msg)
        dialog.run()
        dialog.destroy()

    def show_error(self, msg):
        """See UIFactory.show_error."""
        dialog = ErrorDialog(msg)
        dialog.run()
        dialog.destroy()

    def show_user_warning(self, warning_id, **message_args):
        """See UIFactory.show_user_warning."""
        if warning_id not in self.suppressed_warnings:
            message = self.format_user_warning(warning_id, message_args)
            self.show_warning(message)

    def get_password(self, prompt='', **kwargs):
        """Prompt the user for a password.

        :param prompt: The prompt to present the user
        :param kwargs: Arguments which will be expanded into the prompt.
                       This lets front ends display different things if
                       they so choose.
        :return: The password string, return None if the user
                 canceled the request.
        """
        dialog = PasswordDialog(prompt % kwargs)
        response = dialog.run()
        passwd = dialog.passwd
        dialog.destroy()
        if response == Gtk.ResponseType.OK:
            return passwd
        else:
            return None

    def _progress_all_finished(self):
        """See UIFactory._progress_all_finished."""
        pbw = self._progress_bar_widget
        if pbw:
            pbw.finished()

    def _ensure_progress_widget(self):
        if self._progress_bar_widget is None:
            # Default to a window since nobody gave us a better means to report
            # progress.
            self.set_progress_bar_widget(ProgressBarWindow())

    def _progress_updated(self, task):
        """See UIFactory._progress_updated."""
        self._ensure_progress_widget()
        self._progress_bar_widget.update(task.msg,
                                         task.current_cnt, task.total_cnt)

    def report_transport_activity(self, transport, byte_count, direction):
        """See UIFactory.report_transport_activity."""
        self._ensure_progress_widget()
        self._progress_bar_widget.tick()