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
261
262
263
264
265
266
267
268
|
# Miro - an RSS based video player application
# Copyright (C) 2005-2010 Participatory Culture Foundation
#
# 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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
#
# In addition, as a special exception, the copyright holders give
# permission to link the code of portions of this program with the OpenSSL
# library.
#
# You must obey the GNU General Public License in all respects for all of
# the code used other than OpenSSL. If you modify file(s) with this
# exception, you may extend this exception to your version of the file(s),
# but you are not obligated to do so. If you do not wish to do so, delete
# this exception statement from your version. If you delete this exception
# statement from all source files in the program, then also delete it here.
"""Handle dialog popups.
Simple Choices
For dialogs where you just want to ask the user a question use the
``ChoiceDialog class``. Pass it a title, description and a the
buttons to display. Then call ``dialog.run``, passing it a callback.
Here's an example::
dialog = dialog.ChoiceDialog("Do you like pizza?",
"Democracy would like to know if you enjoy eating pizza.",
dialog.BUTTON_YES, dialog.BUTTON_NO)
def handlePizzaAnswer(dialog):
if dialog.choice is None:
# handle the user closing the dialog windows
elif dialog.choice == dialog.BUTTON_YES:
# handle yes response
elif dialog.choice == dialag.BUTTON_NO:
# handle no respnose
dialog.run(handlePizzaAnswer)
Advanced usage
For more advanced usage, check out the other ``Dialog`` subclasses.
They will probably have different constructor arguments and may have
attributes other than choice that will be set. For example, the
``HTTPAuthDialog`` has a ``username`` and ``password`` attribute that
store what the user entered in the textboxes.
Frontend requirements
Frontends should implement the ``runDialog`` method in
``UIBackendDelegate`` class. It inputs a ``Dialog`` subclass and
displays it to the user. When the user clicks on a button, or closes
the dialog window, the frontend must call ``dialog.run_callback()``.
As we add new dialog boxes, the frontend may run into ``Dialog``
subclasses that it doesn't recognize. In that case, call
``dialog.run_callback(None)``.
The frontend can layout the window however it wants, in particular
buttons can be arranged with the default on the right or the left
depending on the platform. The default button is the 1st button in
the list. Frontends should try to recognize standard buttons and
display the stock icons for them.
"""
import threading
from miro import eventloop
from miro import signals
from miro import util
from miro.gtcache import gettext as _
class DialogButton(object):
def __init__(self, text):
self.text = text
def __eq__(self, other):
return isinstance(other, DialogButton) and self.text == other.text
def __str__(self):
return "DialogButton(%r)" % util.stringify(self.text)
BUTTON_OK = DialogButton(_("Ok"))
BUTTON_APPLY = DialogButton(_("Apply"))
BUTTON_CLOSE = DialogButton(_("Close"))
BUTTON_CANCEL = DialogButton(_("Cancel"))
BUTTON_DONE = DialogButton(_("Done"))
BUTTON_YES = DialogButton(_("Yes"))
BUTTON_NO = DialogButton(_("No"))
BUTTON_QUIT = DialogButton(_("Quit"))
BUTTON_CONTINUE = DialogButton(_("Continue"))
BUTTON_IGNORE = DialogButton(_("Ignore"))
BUTTON_SUBMIT_REPORT = DialogButton(_("Submit Crash Report"))
BUTTON_MIGRATE = DialogButton(_("Migrate"))
BUTTON_DONT_MIGRATE = DialogButton(_("Don't Migrate"))
BUTTON_DOWNLOAD = DialogButton(_("Download"))
BUTTON_REMOVE_ENTRY = DialogButton(_("Remove Entry"))
BUTTON_DELETE_FILE = DialogButton(_("Delete File"))
BUTTON_DELETE_FILES = DialogButton(_("Delete Files"))
BUTTON_KEEP_VIDEOS = DialogButton(_("Keep Videos"))
BUTTON_DELETE_VIDEOS = DialogButton(_("Delete Videos"))
BUTTON_CREATE = DialogButton(_("Create"))
BUTTON_CREATE_FEED = DialogButton(_("Create Feed"))
BUTTON_CREATE_FOLDER = DialogButton(_("Create Folder"))
BUTTON_ADD = DialogButton(_("Add"))
BUTTON_ADD_INTO_NEW_FOLDER = DialogButton(_("Add Into New Folder"))
BUTTON_KEEP = DialogButton(_("Keep"))
BUTTON_DELETE = DialogButton(_("Delete"))
BUTTON_REMOVE = DialogButton(_("Remove"))
BUTTON_NOT_NOW = DialogButton(_("Not Now"))
BUTTON_CLOSE_TO_TRAY = DialogButton(_("Close to Tray"))
BUTTON_LAUNCH_MIRO = DialogButton(_("Launch Miro"))
BUTTON_DOWNLOAD_ANYWAY = DialogButton(_("Download Anyway"))
BUTTON_OPEN_IN_EXTERNAL_BROWSER = DialogButton(_("Open in External Browser"))
BUTTON_DONT_INSTALL = DialogButton(_("Don't Install"))
BUTTON_SUBSCRIBE = DialogButton(_("Subscribe"))
BUTTON_STOP_WATCHING = DialogButton(_("Stop Watching"))
BUTTON_RETRY = DialogButton(_("Retry"))
BUTTON_START_FRESH = DialogButton(_("Start Fresh"))
class Dialog(object):
"""Abstract base class for dialogs.
"""
def __init__(self, title, description, buttons):
self.title = title
self.description = description
self.buttons = buttons
self.event = threading.Event()
def run(self, callback):
self.callback = callback
self.choice = None
signals.system.new_dialog(self)
def run_blocking(self):
"""Run the dialog, blocking for a response from the frontend.
Returns the user's choice.
"""
self.run(None)
self.event.wait()
return self.choice
def run_callback(self, choice):
"""Run the callback for this dialog. Choice should be the
button that the user clicked, or None if the user closed the
window without makeing a selection.
"""
self.choice = choice
self.event.set()
if self.callback is not None:
eventloop.addUrgentCall(self.callback,
"%s callback" % self.__class__,
args=(self,))
class MessageBoxDialog(Dialog):
"""Show the user some info in a dialog box. The only button is
Okay. The callback is optional for a message box dialog.
"""
def __init__(self, title, description):
Dialog.__init__(self, title, description, [BUTTON_OK])
def run(self, callback=None):
Dialog.run(self, callback)
def run_callback(self, choice):
if self.callback is not None:
Dialog.run_callback(self, choice)
class ChoiceDialog(Dialog):
"""Give the user a choice of 2 options (Yes/No, Ok/Cancel,
Migrate/Don't Migrate, etc.)
"""
def __init__(self, title, description, default_button, other_button):
super(ChoiceDialog, self).__init__(title, description,
[default_button, other_button])
class ThreeChoiceDialog(Dialog):
"""Give the user a choice of 3 options (e.g. Remove entry/
Delete file/Cancel).
"""
def __init__(self, title, description, default_button, second_button,
third_button):
super(ThreeChoiceDialog, self).__init__(title, description,
[default_button,
second_button,
third_button])
class HTTPAuthDialog(Dialog):
"""Ask for a username and password for HTTP authorization.
Frontends should create a dialog with text entries for a username
and password. Use prefill_user and prefill_password for the initial
values of the entries.
The buttons are always BUTTON_OK and BUTTON_CANCEL.
"""
def __init__(self, url, realm, prefill_user=None, prefill_password=None):
desc = 'location %s requires a username and password for "%s".' % \
(url, realm)
super(HTTPAuthDialog, self).__init__("Login Required", desc,
(BUTTON_OK, BUTTON_CANCEL))
self.prefill_user = prefill_user
self.prefill_password = prefill_password
def run_callback(self, choice, username='', password=''):
self.username = username
self.password = password
super(HTTPAuthDialog, self).run_callback(choice)
class TextEntryDialog(Dialog):
"""Like the ChoiceDialog, but also contains a textbox for the user
to enter a value into. This is used for things like the create
playlist dialog, the rename dialog, etc.
"""
def __init__(self, title, description, default_button, other_button,
prefill_callback=None, fill_with_clipboard_url=False):
super(TextEntryDialog, self).__init__(title, description,
[default_button, other_button])
self.prefill_callback = prefill_callback
self.fill_with_clipboard_url = fill_with_clipboard_url
def run_callback(self, choice, value=None):
self.value = value
super(TextEntryDialog, self).run_callback(choice)
class CheckboxDialog(Dialog):
"""Like the ChoiceDialog, but also contains a checkbox for the
user to enter a value into. This is used for things like asking
whether to show the dialog again. There's also a mesage for the
checkbox and an initial value.
"""
def __init__(self, title, description, checkbox_text, checkbox_value,
default_button, other_button):
super(CheckboxDialog, self).__init__(title, description,
[default_button, other_button])
self.checkbox_text = checkbox_text
self.checkbox_value = checkbox_value
def run_callback(self, choice, checkbox_value=False):
self.checkbox_value = checkbox_value
super(CheckboxDialog, self).run_callback(choice)
class CheckboxTextboxDialog(CheckboxDialog):
"""Like ``CheckboxDialog`` but also with a text area. Used for
capturing bug report data.
"""
def __init__(self, title, description, checkbox_text,
checkbox_value, textbox_value, default_button, other_button):
super(CheckboxTextboxDialog, self).__init__(title, description,
checkbox_text,
checkbox_value,
default_button,
other_button)
self.textbox_value = textbox_value
def run_callback(self, choice, checkbox_value=False, textbox_value=""):
self.textbox_value = textbox_value
super(CheckboxTextboxDialog, self).run_callback(choice, checkbox_value)
|
