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
|
"""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. The 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.runCallback().
As we add new dialog boxes, the frontend may run into Dialog subclasses
that it doesn't recognize. In that case, call dialog.runCallback(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 eventloop
from gtcache import gettext as _
# Pass in a connection to the frontend
def setDelegate(newDelegate):
global delegate
delegate = newDelegate
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)" % self.text
BUTTON_OK = DialogButton(_("Ok"))
BUTTON_CANCEL = DialogButton(_("Cancel"))
BUTTON_YES = DialogButton(_("Yes"))
BUTTON_NO = DialogButton(_("No"))
BUTTON_QUIT = DialogButton(_("Quit"))
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_CHANNEL = DialogButton(_("Create Channel"))
BUTTON_ADD = DialogButton(_("Add"))
BUTTON_ADD_INTO_NEW_FOLDER = DialogButton(_("Add Into New Folder"))
BUTTON_KEEP = DialogButton(_("Keep"))
BUTTON_DELETE = DialogButton(_("Delete"))
class Dialog(object):
"""Abstract base class for dialogs."""
def __init__(self, title, description, buttons):
self.title = title
self.description = description
self.buttons = buttons
def run(self, callback):
self.callback = callback
self.choice = None
delegate.runDialog(self)
def runCallback(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
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 runCallback(self, choice):
if self.callback is not None:
Dialog.runCallback(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, defaultButton, otherButton):
super(ChoiceDialog, self).__init__(title, description,
[defaultButton, otherButton])
class ThreeChoiceDialog(Dialog):
"""Give the user a choice of 3 options (e.g. Remove entry/
Delete file/Cancel).
"""
def __init__(self, title, description, defaultButton, secondButton,
thirdButton):
super(ThreeChoiceDialog, self).__init__(title, description,
[defaultButton, secondButton, thirdButton])
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
prefillUser and prefillPassword for the initial values of the entries.
The buttons are always BUTTON_OK and BUTTON_CANCEL.
"""
def __init__(self, url, realm, prefillUser=None, prefillPassword=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.prefillUser = prefillUser
self.prefillPassword = prefillPassword
def runCallback(self, choice, username='', password=''):
self.username = username
self.password = password
super(HTTPAuthDialog, self).runCallback(choice)
class SearchChannelDialog(Dialog):
"""Ask for information to create a new search channel. Frontends
should create a dialog with all sorts of fields. Use the given
values for the initial values and replace the values if the user
selects anything.
The buttons are always BUTTON_CREATE_CHANNEL and BUTTON_CANCEL.
"""
CHANNEL = 0
ENGINE = 1
URL = 2
def __init__(self, term=None, style=CHANNEL, location=None):
import views
import indexes
import util
from feed import RSSFeedImpl, ScraperFeedImpl
self.term = term
self.style = style
self.location = location
self.channels = []
for feed in views.feeds:
if feed.actualFeed.__class__ in (RSSFeedImpl, ScraperFeedImpl):
self.channels.append((feed.id, feed.getTitle()))
self.engines = []
for engine in views.searchEngines:
self.engines.append((engine.name, engine.title))
# For testing
if style == self.CHANNEL and self.location == -1:
self.location = self.channels[2][0]
searchFeed = util.getSingletonDDBObject (views.feeds.filterWithIndex(indexes.feedsByURL, 'dtv:search'))
self.defaultEngine = searchFeed.lastEngine
super(SearchChannelDialog, self).__init__(_("New Search Channel"), _("A search channel contains items that match a search term."),
(BUTTON_CREATE_CHANNEL, BUTTON_CANCEL))
def getURL(self):
from xhtmltools import urlencode
import searchengines
from database import defaultDatabase
term = self.term
location = self.location
style = self.style
if not term or not location:
return None
if style == self.CHANNEL:
# Pull data from channel and switch style.
channel = defaultDatabase.getObjectByID(location)
if channel:
style = self.URL
location = channel.getBaseURL()
searchTerm = channel.getSearchTerm()
if searchTerm is not None:
term = searchTerm + " " + term
# Do this after possibly pulling data from channel.
if type (term) == unicode:
term = term.encode("utf8")
if type (location) == unicode:
location = location.encode("utf8")
if style == self.ENGINE:
return searchengines.getRequestURL (location, term)
if style == self.URL:
return "dtv:searchTerm:%s?%s" % (urlencode(location), urlencode(term))
return None
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, defaultButton, otherButton, prefillCallback=None, fillWithClipboardURL=False):
super(TextEntryDialog, self).__init__(title, description,
[defaultButton, otherButton])
self.prefillCallback = prefillCallback
self.fillWithClipboardURL = fillWithClipboardURL
def runCallback(self, choice, value=None):
self.value = value
super(TextEntryDialog, self).runCallback(choice)
|
