-
Notifications
You must be signed in to change notification settings - Fork 138
/
Copy pathdialog_extras.py
1278 lines (1141 loc) · 50.5 KB
/
dialog_extras.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
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
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
from typing import List, Optional
import os.path, fnmatch, re
from pathlib import Path
from gettext import gettext as _
from gi.repository import GObject, Gtk, Pango
from gi.repository.GLib import get_user_special_dir, UserDirectory
import xml.sax.saxutils
from . import optionTable
from gourmet.gdebug import debug
from gourmet.image_utils import image_to_pixbuf, make_thumbnail
H_PADDING=12
Y_PADDING=12
class UserCancelledError(Exception):
pass
def is_markup (s):
try:
Pango.parse_markup(s,'0')
return True
except:
return False
class ModalDialog (Gtk.Dialog):
def __init__(self, default=None, title="", okay=True, label=False, sublabel=False, parent=None, cancel=True,
modal=True, expander=None):
"""Our basic class. We allow for a label. Possibly an expander
with extra information, and a simple Okay button. The
expander is are only fancy option. It should be a list ['Name
of expander', CONTENTS]. CONTENTS can be a string (to be put
in a label), a widget (to be packed in the expander), or a
list of strings and widgets to be packed in order."""
self.widget_that_grabs_focus = None
self.setup_dialog(title=title, parent=parent)
self.connect('destroy',self.cancelcb)
self.set_border_width(15)
self.default = default
self.ret = default
self.responses = {Gtk.ResponseType.OK:self.okcb,
Gtk.ResponseType.CANCEL:self.cancelcb,
Gtk.ResponseType.NONE:self.cancelcb,
Gtk.ResponseType.CLOSE:self.cancelcb,
Gtk.ResponseType.DELETE_EVENT:self.cancelcb}
if modal: self.set_modal(True)
else: self.set_modal(False)
if label:
self.setup_label(label)
if sublabel:
self.setup_sublabel(sublabel)
if expander:
# if we have an expander, our window
# should be resizable (just in case
# the user wants to do more resizing)
self.set_resizable(True)
self.setup_expander(expander)
self.setup_buttons(cancel, okay)
self.vbox.set_vexpand(True)
self.vbox.show_all()
def setup_dialog (self, *args, **kwargs):
Gtk.Dialog.__init__(self, *args, **kwargs)
def setup_label (self, label):
# we're going to add pango markup to our
# label to make it bigger as per GNOME HIG
self.set_title(label)
label = '<span weight="bold" size="larger">%s</span>'%label
self.label = Gtk.Label(label=label)
self.label.set_line_wrap(True)
self.label.set_selectable(True)
self.vbox.pack_start(self.label, expand=False, fill=False, padding=0)
self.label.set_padding(H_PADDING,Y_PADDING)
self.label.set_alignment(0,0)
self.label.set_justify(Gtk.Justification.LEFT)
self.label.set_use_markup(True)
self.label.show()
def setup_sublabel (self,sublabel):
self.sublabel = Gtk.Label(label=sublabel)
self.sublabel.set_selectable(True)
self.vbox.pack_start(self.sublabel, False, True, 0)
self.sublabel.set_padding(H_PADDING,Y_PADDING)
self.sublabel.set_alignment(0,0)
self.sublabel.set_justify(Gtk.Justification.LEFT)
self.sublabel.set_use_markup(True)
self.sublabel.set_line_wrap_mode(Pango.WrapMode.WORD)
self.sublabel.show()
def setup_buttons (self, cancel, okay):
if cancel:
self.add_button(Gtk.STOCK_CANCEL,Gtk.ResponseType.CANCEL)
if okay:
self.add_button(Gtk.STOCK_OK,Gtk.ResponseType.OK)
self.connect('response',self.response_cb)
def response_cb (self, dialog, response, *params):
#print 'response CB ',dialog,response,params
if response in self.responses:
#print 'we have a response!'
self.responses[response]()
else:
print('WARNING, no response for ',response)
def setup_expander (self, expander):
label=expander[0]
body = expander[1]
# self.expander = Gtk.Expander(label)
self.expander = Gtk.Expander()
self.expander.set_use_underline(True)
self.expander_vbox = Gtk.VBox()
sw = Gtk.ScrolledWindow()
sw.add_with_viewport(self.expander_vbox)
sw.set_policy(Gtk.PolicyType.AUTOMATIC, Gtk.PolicyType.AUTOMATIC)
self.expander.add(sw)
self._add_expander_item(body)
self.expander.show()
self.expander_vbox.show_all()
self.vbox.add(self.expander)
def _add_expander_item (self, item):
if isinstance(item, str):
l=Gtk.Label(label=item)
l.set_selectable(True)
l.set_line_wrap_mode(Pango.WrapMode.WORD)
self.expander_vbox.pack_start(l,False, False, 0)
elif isinstance(item, (list, tuple)):
list(map(self._add_expander_item,item))
else:
self.expander_vbox.pack_start(item, True, True, 0)
def run (self):
self.show()
if self.widget_that_grabs_focus: self.widget_that_grabs_focus.grab_focus()
if self.get_modal(): Gtk.main()
return self.ret
def okcb (self, *args):
self.hide()
if self.get_modal():
Gtk.main_quit()
def cancelcb (self, *args):
self.hide()
self.ret=None
if self.get_modal():
Gtk.main_quit()
class MessageDialog(Gtk.MessageDialog, ModalDialog):
"""A simple class for displaying messages to our users."""
def __init__(self, title="", default=None, okay=True, cancel=True,
label=False, sublabel=False, expander=None,
message_type=Gtk.MessageType.INFO, parent=None, modal=True):
self.message_type = message_type
ModalDialog.__init__(self, title=title, default=default, okay=okay,
cancel=cancel, label=label, sublabel=sublabel,
parent=parent, expander=expander, modal=modal)
def setup_dialog(self, *args, **kwargs):
kwargs['type'] = self.message_type
title = kwargs.pop('title', None)
super().__init__(self, *args, **kwargs)
self.set_title(title)
def setup_label(self, label: str):
if not is_markup(label):
label = xml.sax.saxutils.escape(label)
label = f'<span weight="bold" size="larger">{label}</span>'
self.set_markup(label)
def setup_sublabel(self, sublabel: str):
self.format_secondary_markup(sublabel)
class NumberDialog (ModalDialog):
"""A dialog to get a number from our user."""
def __init__(self,default=None,label=False,sublabel=False,step_incr=1,page_incr=10,digits=0,
min=0,max=10000, parent=None):
ModalDialog.__init__(self,default=default, parent=parent)
self.hbox=Gtk.HBox()
self.vbox.add(self.hbox)
self.spinButton = Gtk.SpinButton()
if not default:
val = 0
else:
val = float(default)
self.adjustment=Gtk.Adjustment(val,
lower=min,
upper=max,
step_incr=step_incr,
page_incr=page_incr)
self.spinButton.set_adjustment(self.adjustment)
if default:
self.spinButton.set_value(default)
if label:
self.label=Gtk.Label(label=label)
self.label.set_selectable(True)
self.label.set_line_wrap_mode(Pango.WrapMode.WORD)
self.label.set_padding(H_PADDING, Y_PADDING)
self.hbox.add(self.label)
self.label.show()
self.hbox.add(self.spinButton)
self.spinButton.get_adjustment().connect("value_changed",self.update_value)
self.spinButton.get_adjustment().connect("changed",self.update_value)
self.spinButton.show()
self.spinButton.connect('activate',self.entry_activate_cb)
self.hbox.show()
def update_value (self, *args):
self.ret=self.spinButton.get_value()
def entry_activate_cb (self, *args):
self.okcb()
class EntryDialog (ModalDialog):
"""A dialog to get some text from an Entry from our user."""
def __init__ (self, default=None,
label=None,
sublabel=None,
entryLabel=False,
entryTip=None,
parent=None,
visibility=True,
default_value=None,
default_character_width=None):
ModalDialog.__init__(self,default=default,parent=parent, label=label, sublabel=sublabel)
self.hbox=Gtk.HBox()
self.vbox.add(self.hbox)
if entryLabel:
self.elabel=Gtk.Label(label=entryLabel)
self.elabel.set_line_wrap_mode(Pango.WrapMode.WORD)
self.elabel.set_selectable(True)
self.elabel.set_alignment(0,0)
self.hbox.add(self.elabel)
self.elabel.show()
self.elabel.set_padding(H_PADDING,Y_PADDING)
self.entry = Gtk.Entry()
self.entry.set_visibility(visibility)
self.entry.connect('activate',self.entry_activate_cb)
if default_character_width:
if hasattr(self.entry,'set_width_chars'):
self.entry.set_width_chars(default_character_width)
if hasattr(self,'label') and hasattr(self.label,'set_width_chars'):
self.label.set_width_chars(default_character_width)
if hasattr(self,'sublabel') and hasattr(self.sublabel,'set_width_chars'):
self.sublabel.set_width_chars(default_character_width)
self.hbox.add(self.entry)
self.entry.set_can_default(True)
self.entry.grab_default()
self.hbox.show()
if default:
self.entry.set_text(default)
if entryTip:
self.entry.set_tooltip_text(entryTip)
self.entry.connect("changed",self.update_value)
# Set the default value after connecting our handler so our
# value gets updated!
if default_value:
self.entry.set_text(default_value)
self.entry.show_all()
self.entry.show()
self.widget_that_grabs_focus = self.entry
def update_value (self, *args):
self.ret = self.entry.get_text()
def entry_activate_cb (self, *args):
if self.ret:
self.okcb()
class RadioDialog (ModalDialog):
"""A dialog to offer our user a choice between a few options."""
def __init__ (self, default=None, label="Select Option", sublabel=None, options=[],
parent=None,expander=None,cancel=True):
ModalDialog.__init__(self, okay=True, label=label, sublabel=sublabel, parent=parent, expander=expander, cancel=cancel)
# defaults value is first value...
self.default = default
self.setup_radio_buttons(options)
if options and default==None:
self.ret = options[0][1]
def setup_radio_buttons (self,options):
previous_radio = None
self.buttons = []
for label,value in options:
rb = Gtk.RadioButton(group=previous_radio, label=label, use_underline=True)
rb.connect('activate',self.okcb)
self.vbox.add(rb)
rb.show()
rb.connect('toggled',self.toggle_cb,value)
self.buttons.append(rb)
previous_radio=rb
if self.default==value:
rb.set_active(True)
self.widget_that_grabs_focus = rb
if self.default==None:
self.buttons[0].set_active(True)
self.widget_that_grabs_focus = self.buttons[0]
def toggle_cb (self, widget, value):
if widget.get_active():
self.ret = value
class OptionDialog (ModalDialog):
"""A dialog to offer our user a choice between options using an option menu"""
def __init__ (self, default=None, label="Select Option", sublabel=None, options=[], parent=None, expander=None, cancel=True):
"""Options can be a simple option or can be a tuple or a list
where the first item is the label and the second the value"""
ModalDialog.__init__(self, okay=True, label=label, sublabel=sublabel, parent=parent, expander=expander, cancel=cancel)
self.combobox = Gtk.ComboBoxText()
self.vbox.pack_start(
self.combobox, expand=False, fill=False, padding=0
)
self.option_values = []
for o in options:
if isinstance(o, str):
label = value = o
else:
label, value = o
self.combobox.append_text(label)
self.option_values.append(value)
# set the default value to the first item
self.ret = self.option_values[0]
self.combobox.connect('changed', self.get_option)
self.combobox.set_active(0)
self.combobox.show()
def get_option (self, widget):
self.ret = self.option_values[self.combobox.get_active()]
#return self.ret
def set_value (self, value):
self.ret=value
class ProgressDialog (ModalDialog):
"""A dialog to show a progress bar"""
def __init__ (self, title="", okay=True, label="", sublabel=False, parent=None,
cancel=False, stop=False, pause=False,modal=False):
"""stop,cancel,and pause will be given as callbacks to their prospective buttons."""
self.custom_pausecb=pause
self.custom_cancelcb=cancel
self.custom_pause_handlers = []
self.custom_stop_handlers = []
self.custom_stopcb=stop
ModalDialog.__init__(self, title, okay=okay, label=label, sublabel=sublabel, parent=parent,
cancel=cancel,modal=modal)
self.set_title(label)
self.progress_bar = Gtk.ProgressBar()
self.vbox.add(self.progress_bar)
self.detail_label = Gtk.Label()
self.vbox.add(self.detail_label)
self.detail_label.set_use_markup(True)
self.detail_label.set_padding(H_PADDING,Y_PADDING)
self.detail_label.set_line_wrap_mode(Pango.WrapMode.WORD)
self.vbox.show_all()
if okay: self.set_response_sensitive(Gtk.ResponseType.OK,False) # we're false by default!
if not stop: self.stop.hide()
if not pause: self.pause.hide()
def reset_label (self, label):
self.set_title(label)
self.label.set_text('<span weight="bold" size="larger">%s</span>'%label)
self.label.set_use_markup(True)
def reassign_buttons (self, pausecb=None, stopcb=None):
debug('reassign_buttons called with pausecb=%s, stopcb=%s'%(pausecb,stopcb),1)
while self.custom_pause_handlers:
h=self.custom_pause_handlers.pop()
if self.pause.handler_is_connected(h):
self.pause.disconnect(h)
if pausecb:
self.pause.connect('toggled',pausecb)
self.pause.set_property('visible',True)
else:
self.pause.set_property('visible',False)
while self.custom_stop_handlers:
h=self.custom_stop_handlers.pop()
if self.stop.handler_is_connected(h):
self.stop.disconnect(h)
if stopcb:
self.stop.connect('clicked',stopcb)
#self.stop.connect('clicked',self.cancelcb)
self.stop.set_property('visible',True)
else:
self.stop.set_property('visible',False)
def setup_buttons (self, cancel, okay):
# setup pause button
self.pause = Gtk.ToggleButton(_('_Pause'))
self.pause.set_use_underline(True)
self.action_area.pack_end(self.pause, True, True, 0)
# only show it/connect it if we want to...
if self.custom_pausecb:
# we keep a list of handlers for possible disconnection later
self.custom_pause_handlers.append(self.pause.connect('toggled',self.custom_pausecb))
self.pause.set_property('visible',True)
else:
self.pause.set_property('visible',False)
self.pause.hide()
# setup stop button
self.stop = Gtk.Button(_('_Stop'))
self.action_area.pack_end(self.stop, True, True, 0)
if self.custom_stopcb:
self.stop.set_property('visible',True)
# we keep a list of handlers for possible disconnection later
self.custom_stop_handlers.append(self.stop.connect('clicked',self.custom_stopcb))
#self.custom_stop_handlers.append(self.stop.connect('clicked',self.cancelcb))
else:
self.stop.set_property('visible',False)
self.stop.hide()
ModalDialog.setup_buttons(self,cancel,okay)
if self.custom_cancelcb:
self.cancelcb = self.custom_cancelcb
#self.cancel.connect('clicked',self.custom_cancelcb)
def set_progress (self, prog, message=None):
if prog < 0:
self.progress_bar.pulse()
else:
self.progress_bar.set_fraction(prog)
if message: self.progress_bar.set_text(message)
if prog==1:
self.set_response_sensitive(Gtk.ResponseType.OK,True)
class PreferencesDialog (ModalDialog):
"""A dialog to get preferences from a user and return user preferences as a list."""
def __init__ (self, options=([None,None]), option_label="Option",
value_label="Value", default=True, label=None, sublabel=False,
apply_func=None, parent=None, dont_ask_cb=None,
dont_ask_custom_text=None):
"""Options is a tuple of tuples where each tuple is ('option', VALUE), handed to OptionTable
VALUE can be any of the following:
a string (will be editable)
a number (will be editable and returned as a number)
true or false (will be a checkbox)
If apply_func is True, we will have an apply button, which
will hand the option tuple as its argument. Otherwise, okay will simply
return the list on okay."""
if apply_func: modal=False
else: modal=True
self.apply_func = apply_func
self.options = options
ModalDialog.__init__(self, okay=True, label=label, sublabel=sublabel, parent=parent, modal=modal)
self.table = optionTable.OptionTable(options=self.options,
option_label=option_label,
value_label=value_label,
changedcb=self.changedcb)
for widget_info in self.table.widgets:
widget = widget_info[0]
# Activating any widget activates the dialog...
try:
widget.connect('activate',self.okcb)
except TypeError:
# not all widgets have a signal -- no biggy
pass
self.hbox = Gtk.HBox(); self.hbox.show()
self.hbox.add(self.table)
self.vbox.add(self.hbox)
if dont_ask_cb:
if not dont_ask_custom_text:
dont_ask_custom_text=_("Don't ask me this again.")
self.dont_ask = Gtk.CheckButton(dont_ask_custom_text)
self.dont_ask.connect('toggled',dont_ask_cb)
self.vbox.add(self.dont_ask)
self.vbox.show_all()
def setup_buttons (self, cancel, okay):
if self.apply_func:
self.revert = Gtk.Button(stock=Gtk.STOCK_REVERT_TO_SAVED)
self.revert.connect('clicked',self.revertcb)
self.action_area.add(self.revert)
self.apply = Gtk.Button(stock=Gtk.STOCK_APPLY)
self.apply.set_sensitive(False)
self.apply.connect('clicked',self.applycb)
self.action_area.add(self.apply)
self.apply.show()
self.changedcb = lambda *args: self.apply.set_sensitive(True)
else:
self.changedcb=None
self.set_modal(False)
ModalDialog.setup_buttons(self, cancel, okay)
def revertcb (self, *args):
self.table.revert()
def applycb (self, *args):
self.table.apply()
self.apply_func(self.table.options)
self.apply.set_sensitive(False)
def run (self):
self.show()
if self.apply_func:
return
else:
Gtk.main()
return self.ret
def okcb (self, *args):
if self.apply_func:
if self.apply.get_property('sensitive'):
# if there are unsaved changes...
if getBoolean(label="Would you like to apply the changes you've made?"):
self.applycb()
self.hide()
else:
self.table.apply()
self.ret = self.table.options
self.hide()
Gtk.main_quit()
def cancelcb (self, *args):
self.hide()
self.ret=None
class BooleanDialog (MessageDialog):
def __init__ (self, title="", default=True, label=_("Do you really want to do this"),
sublabel=False, cancel=True,
parent=None, custom_yes=None, custom_no=None, expander=None,
dont_ask_cb=None, dont_ask_custom_text=None,
cancel_returns=None, message_type=Gtk.MessageType.QUESTION
):
"""Setup a BooleanDialog which returns True or False.
parent is our parent window.
custom_yes is custom text for the button that returns true or a dictionary
to be handed to Gtk.Button as keyword args.
custom_no is custom text for the button that returns False or a dictionary
to be handed to Gtk.Button as keyword args
expander is a list whose first item is a label and second is a widget to be packed
into an expander widget with more information.
if dont_ask_variable is set, a Don't ask me again check
button will be displayed which the user can check to avoid this kind
of question again. (NOTE: if dont_ask_variable==None, this won't work!)
dont_ask_custom_text is custom don't ask text."""
self.cancel_returns = cancel_returns
self.yes,self.no = custom_yes,custom_no
if not self.yes: self.yes = Gtk.STOCK_YES
if not self.no: self.no = Gtk.STOCK_NO
MessageDialog.__init__(self,title=title,okay=False,label=label, cancel=cancel, sublabel=sublabel,parent=parent, expander=expander, message_type=message_type)
self.responses[Gtk.ResponseType.YES]=self.yescb
self.responses[Gtk.ResponseType.NO]=self.nocb
if not cancel:
# if there's no cancel, all cancel-like actions
# are the equivalent of a NO response
self.responses[Gtk.ResponseType.NONE]=self.nocb
self.responses[Gtk.ResponseType.CANCEL]=self.nocb
self.responses[Gtk.ResponseType.CLOSE]=self.nocb
self.responses[Gtk.ResponseType.DELETE_EVENT]=self.nocb
if dont_ask_cb:
if not dont_ask_custom_text:
dont_ask_custom_text=_("Don't ask me this again.")
self.dont_ask = Gtk.CheckButton(dont_ask_custom_text)
self.dont_ask.connect('toggled',dont_ask_cb)
self.vbox.add(self.dont_ask)
self.dont_ask.show()
#self.action_area.add(self.no)
#self.action_area.add(self.yes)
#self.yes.connect('clicked',self.yescb)
#self.no.connect('clicked',self.nocb)
#self.action_area.show_all()
def setup_buttons (self,*args,**kwargs):
MessageDialog.setup_buttons(self,*args,**kwargs)
self.add_button((self.no or Gtk.STOCK_NO),Gtk.ResponseType.NO)
self.add_button((self.yes or Gtk.STOCK_YES),Gtk.ResponseType.YES)
def yescb (self, *args):
self.ret=True
self.okcb()
def cancelcb (self, *args):
if self.cancel_returns != None:
self.ret = self.cancel_returns
self.okcb()
def nocb (self, *args):
self.ret=False
self.okcb()
class SimpleFaqDialog (ModalDialog):
"""A dialog to view a plain old text FAQ in an attractive way"""
INDEX_MATCHER = re.compile("^[0-9]+[.][A-Za-z0-9.]* .*")
# We except one level of nesting in our headers.
# NESTED_MATCHER should match nested headers
NESTED_MATCHER = re.compile("^[0-9]+[.][A-Za-z0-9.]+ .*")
def __init__ (self,
faq_file='/home/tom/Projects/grm-0.8/FAQ',
title="Frequently Asked Questions",
jump_to = None,
parent=None,
modal=True):
#print faq_file
ModalDialog.__init__(self,title=title,parent=parent,modal=modal,cancel=False)
self.set_default_size(950,500)
self.textview = Gtk.TextView()
self.textview.set_editable(False)
self.textview.set_wrap_mode(Gtk.WrapMode.WORD)
self.textview.set_left_margin(18)
self.textview.set_right_margin(18)
self.textbuf = self.textview.get_buffer()
self.boldtag = self.textbuf.create_tag()
self.boldtag.set_property('weight', Pango.Weight.BOLD)
self.textwin = Gtk.ScrolledWindow()
self.textwin.set_policy(Gtk.PolicyType.AUTOMATIC,Gtk.PolicyType.AUTOMATIC)
self.textwin.add(self.textview)
self.index_lines = []
self.index_dic = {}
self.text = ""
self.parse_faq(faq_file)
if self.index_lines:
self.paned = Gtk.Paned()
self.indexView = Gtk.TreeView()
self.indexWin = Gtk.ScrolledWindow()
self.indexWin.set_policy(Gtk.PolicyType.AUTOMATIC,Gtk.PolicyType.AUTOMATIC)
self.indexWin.add(self.indexView)
self.setup_index()
self.paned.add1(self.indexWin)
self.paned.add2(self.textwin)
self.vbox.add(self.paned)
self.vbox.show_all()
self.paned.set_position(325)
self.paned.set_vexpand(True)
else:
self.vbox.add(self.textwin)
self.vbox.show_all()
if jump_to: self.jump_to_header(jump_to)
def jump_to_header (self, text):
"""Jump to the header/index items that contains text.
"""
text = text.lower()
for l in self.index_lines:
if l.lower().find(text) > 0:
itr=self.index_iter_dic[l]
# select our iter...
# as a side effect, we will jump to the right part of the text
self.indexView.get_selection().select_iter(itr)
# expand our iter
mod = self.indexView.get_model()
self.indexView.expand_row(mod.get_path(itr),True)
return
def parse_faq(self, filename: str) -> None:
"""Parse file infile as our FAQ to display.
infile can be a filename or a file-like object.
We parse index lines according to self.INDEX_MATCHER
"""
# Clear data
self.index_lines = []
self.index_dic = {}
self.text = ""
with open(filename, 'r') as fin:
for l in fin.readlines():
line = l.strip()
if self.INDEX_MATCHER.match(line): # it is a heading
self.index_lines.append(line)
curiter = self.textbuf.get_iter_at_mark(self.textbuf.get_insert())
self.index_dic[line] = self.textbuf.create_mark(None,
curiter,
left_gravity=True)
self.textbuf.insert_with_tags(curiter,
line + " ",
self.boldtag)
elif line: # it is body content
self.textbuf.insert_at_cursor(line + " ")
else: # an empty line is a paragraph break
self.textbuf.insert_at_cursor("\n\n")
def setup_index (self):
"""Set up a clickable index view"""
self.imodel = Gtk.TreeStore(str)
self.index_iter_dic={}
last_parent = None
for l in self.index_lines:
if self.NESTED_MATCHER.match(l):
itr=self.imodel.append(last_parent,[l])
else:
itr=self.imodel.append(None,[l])
last_parent=itr
self.index_iter_dic[l]=itr
# setup our lone column
self.indexView.append_column(
Gtk.TreeViewColumn("",
Gtk.CellRendererText(),
text=0)
)
self.indexView.set_model(self.imodel)
self.indexView.set_headers_visible(False)
self.indexView.connect('row-activated',self.index_activated_cb)
self.indexView.get_selection().connect('changed',self.index_selected_cb)
def index_activated_cb (self, *args):
"""Toggle expanded state of rows."""
mod,itr = self.indexView.get_selection().get_selected()
path=mod.get_path(itr)
if self.indexView.row_expanded(path):
self.indexView.collapse_row(path)
else:
self.indexView.expand_row(path, True)
def index_selected_cb (self,*args):
mod,itr = self.indexView.get_selection().get_selected()
val=self.indexView.get_model().get_value(itr,0)
self.textview.scroll_to_mark(mark=self.index_dic[val],
within_margin=0.1,
use_align=True,
xalign=0.5,
yalign=0.0)
def jump_to_text (self, txt, itr=None):
if not itr:
itr = self.textbuf.get_iter_at_offset(0)
match_start,match_end=itr.forward_search(txt,Gtk.TextSearchFlags.VISIBLE_ONLY)
self.textview.scroll_to_iter(match_start,False,use_align=True,yalign=0.1)
class RatingsConversionDialog (ModalDialog):
"""A dialog to allow the user to select the number of stars
distinct ratings should convert to.
This dialog exists to aid conversion of ratings from old gourmet
exports or databases or from other imports that use strings of
some kind ('great','groovy',etc.) to aid in conversion.
"""
def __init__ (self,
strings,
star_generator,
defaults={_("excellent"):10,
_("great"):8,
_("good"):6,
_("fair"):4,
_("poor"):2,},
parent=None,
modal=True):
"""strings is a list of strings that are currently used for ratings.
The user will be asked to give the star equivalent of each string.
"""
self.strings = strings
self.star_generator=star_generator
self.defaults = defaults
ModalDialog.__init__(
self,
title=_("Convert ratings to 5 star scale."),
label=_("Convert ratings."),
sublabel=_("Please give each of the ratings an equivalent on a scale of 1 to 5"),
parent=parent,
modal=modal
)
self.set_default_size(750,500)
self.ret = {}
self.setup_tree()
def setup_tree (self):
self.tv = Gtk.TreeView()
self.setup_model()
self.tv.set_model(self.tm)
from .ratingWidget import TreeWithStarMaker
textcol = Gtk.TreeViewColumn(_('Current Rating'),Gtk.CellRendererText(),text=0)
textcol.set_sort_column_id(0)
self.tv.append_column(textcol)
TreeWithStarMaker(self.tv,
self.star_generator,
col_title=_("Rating out of 5 Stars"),
col_position=-1,
data_col=1,
handlers=[self.ratings_change_cb],
)
self.sw = Gtk.ScrolledWindow()
self.sw.set_policy(Gtk.PolicyType.AUTOMATIC,Gtk.PolicyType.AUTOMATIC)
self.sw.add(self.tv)
self.vbox.add(self.sw)
self.sw.show_all()
def setup_model (self):
self.tm = Gtk.ListStore(str,int)
for s in self.strings:
val=self.defaults.get(s.lower(),0)
self.tm.append([s,val])
self.ret[s]=val
def ratings_change_cb (self, value, model, treeiter, colnum):
string = model.get_value(treeiter,0)
self.ret[string]=value
model.set_value(treeiter,colnum,value)
def show_traceback(label: str = "Error", sublabel: str = None):
"""Show an error dialog with a traceback viewable."""
from io import StringIO
import traceback
error_mess = traceback.format_exc()
show_message(label=label,
sublabel=sublabel,
expander=(_("_Details"), error_mess),
message_type=Gtk.MessageType.ERROR)
def show_message (*args, **kwargs):
"""Show a message dialog.
Args and Kwargs are handed to MessageDialog
We most likely want to hand it label= and sublabel=
"""
#if not kwargs.has_key(message_type):
# message_type=Gtk.MessageType.INFO
if 'cancel' not in kwargs:
kwargs['cancel']=False
d=MessageDialog(*args,**kwargs)
d.run()
return d
def select_file (title,
filename=None,
filters=[],
# filters are lists of a name, a list of mime types and a list of
# patterns ['Plain Text', ['text/plain'], '*txt']
action=Gtk.FileChooserAction.OPEN,
set_filter=True,
select_multiple=False,
buttons=None,
parent=None
):
sfd=FileSelectorDialog(title,
filename=filename,
filters=filters,
select_multiple=select_multiple,
action=action,
set_filter=set_filter,
buttons=buttons,parent=parent)
return sfd.run()
def saveas_file(title: str,
filename: Optional[str] = None,
filters: Optional[List[str]] = None,
action: Gtk.FileChooserAction = Gtk.FileChooserAction.SAVE,
set_filter: bool = True,
buttons: List[Gtk.FileChooserButtonClass] = None,
parent: Gtk.Window = None,
show_filetype: bool = True):
"""Almost identical to select_file, except that we return a tuple containing
the filename and the export type (the string the user selected)"""
sfd = FileSelectorDialog(title,
filename=filename,
filters=filters,
action=action,
set_filter=set_filter,
buttons=buttons,
show_filetype=show_filetype,
parent=parent)
filename = sfd.run()
if not filename:
return None, None
filename, *_ = filename
exp_type = get_type_for_filters(filename, filters[:])
if not exp_type:
# If we don't have a type based on our regexps... then lets
# just see what the combobox was set to...
exp_type = filters[sfd.saveas.get_active()][0]
return filename, exp_type
def get_type_for_filters (fname, filters):
base,ext = os.path.splitext(fname)
exp_type = None
while filters and not exp_type:
name,mime,rgxps = filters.pop()
for r in rgxps:
if os.path.splitext(r)[1] == ext:
exp_type = name
return exp_type
def select_image (title,
filename=None,
action=Gtk.FileChooserAction.OPEN,
buttons=None):
sfd=ImageSelectorDialog(title,filename=filename,action=action,buttons=buttons)
return sfd.run()
class FileSelectorDialog:
"""A dialog to ask the user for a file. We provide a few custom additions to the
standard file dialog, including a special choose-filetype menu and including dynamic update
of the filetype based on user input of an extension"""
def __init__ (self,
title,
filename=None,
filters=[],
# filters are lists of a name, a list of mime types and a list of
# patterns ['Plain Text', ['text/plain'], '*txt']
action=Gtk.FileChooserAction.SAVE,
set_filter=True,
buttons=None,
show_filetype=True,
parent=None,
select_multiple=False
):
self.parent=parent
self.buttons=buttons
self.multiple=select_multiple
self.set_filter=set_filter
self.action=action
self.filename=filename
self.title=title
self.filters=filters
self.show_filetype=show_filetype
self.setup_dialog()
self.post_dialog()
def post_dialog (self):
"""Run after the dialog is set up (to allow subclasses to do further setup)"""
pass
def setup_dialog (self):
"""Create our dialog"""
self.setup_buttons()
self.fsd = Gtk.FileChooserDialog(self.title,
action=self.action,
parent=self.parent,
buttons=self.buttons,
#backend = (vfs_available and 'gnome-vfs') or None,
)
#if vfs_available:
# self.fsd.props.local_only = False
self.fsd.set_default_response(Gtk.ResponseType.OK)
self.fsd.set_select_multiple(self.multiple)
self.fsd.set_do_overwrite_confirmation(True)
if self.filename:
path,name=os.path.split(os.path.expanduser(self.filename))
if path: self.fsd.set_current_folder(path)
if name: self.fsd.set_current_name(name)
self.setup_filters()
if self.action==Gtk.FileChooserAction.SAVE:
self.setup_saveas_widget()
def setup_buttons (self):
"""Set our self.buttons attribute"""
if not self.buttons:
if self.action==Gtk.FileChooserAction.OPEN or self.action==Gtk.FileChooserAction.SELECT_FOLDER:
self.buttons=(Gtk.STOCK_CANCEL,Gtk.ResponseType.CANCEL,Gtk.STOCK_OPEN,Gtk.ResponseType.OK)
else:
self.buttons=(Gtk.STOCK_CANCEL,Gtk.ResponseType.CANCEL,Gtk.STOCK_OK,Gtk.ResponseType.OK)
def setup_filters (self):
"""Create and set filters for the dialog."""
self.extensions = []
for fil in self.filters:
filter = Gtk.FileFilter()
filter_name, filter_mime_types, filter_patterns = fil
filter.set_name(filter_name)
if filter_mime_types:
for f in filter_mime_types:
filter.add_mime_type(f)
if filter_patterns:
for f in filter_patterns:
filter.add_pattern(f)
self.extensions.append(f)
self.fsd.add_filter(filter)
if self.set_filter and self.filters:
self.fsd.set_filter(self.fsd.list_filters()[0])
def setup_saveas_widget (self):
"""Set up the filter widget."""
if not self.filters:
self.do_saveas = False
return