-
Notifications
You must be signed in to change notification settings - Fork 385
/
document.py
2326 lines (2008 loc) · 88.3 KB
/
document.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
# -*- coding: utf-8 -*-
# This file is part of MyPaint.
# Copyright (C) 2010-2019 by the MyPaint Development Team.
# Copyright (C) 2007-2013 by Martin Renold <martinxyz@gmx.ch>
#
# 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.
"""Top-level document controller classes
The classes defined here oparate as controllers in the MVC sense,
i.e. they convert user input into updates to the document model.
"""
## Imports
import logging
import math
import os
import os.path
import weakref
from warnings import warn
import gui.application
import gui.backgroundwindow
import gui.buttonmap
import gui.colorpicker # purely for registration
import gui.device
import gui.externalapp
import gui.freehand
import gui.inktool # registration only
import gui.layerprops
import gui.mode
import gui.symmetry # registration only
import gui.tileddrawwidget
import lib.document
import lib.helpers
import lib.layer
import lib.observable
from gui.widgets import with_wait_cursor
from lib.gettext import C_
from lib.gettext import gettext as _
from lib.gibindings import Gdk, GLib, Gtk
from lib.helpers import clamp
from lib.modes import PASS_THROUGH_MODE
from . import stategroup
logger = logging.getLogger(__name__)
## Class definitions
class CanvasController(object):
"""Minimal canvas controller using a stack of modes.
Basic CanvasController objects can be set up to handle scroll events
like zooming or rotation only, pointer events like drawing only, or
both.
The actual interpretation of each event is delegated to the top item
on the controller's modes stack: see `gui.mode` for details.
Simpler modes may assume the basic CanvasController interface, more
complex ones may require the full Document interface.
"""
# NOTE: If multiple, editable, views of a single model are required,
# NOTE: then this interface will have to be revised.
## Initialization
def __init__(self, tdw):
"""Initialize.
:param tdw: The view widget to attach handlers onto.
:type tdw: gui.tileddrawwidget.TiledDrawWidget
"""
object.__init__(self)
self.tdw = tdw #: the TiledDrawWidget being controlled.
self.modes = gui.mode.ModeStack(self) #: stack of delegates
self.modes.default_mode_class = gui.freehand.FreehandMode
def init_pointer_events(self):
"""Establish TDW event listeners for pointer button presses & drags."""
self.tdw.connect("button-press-event", self.button_press_cb)
self.tdw.connect("motion-notify-event", self.motion_notify_cb)
self.tdw.connect("button-release-event", self.button_release_cb)
def init_scroll_events(self):
"""Establish TDW event listeners for scroll-wheel actions."""
self.tdw.connect("scroll-event", self.scroll_cb)
self.tdw.add_events(Gdk.EventMask.SCROLL_MASK)
## Low-level GTK event handlers: delegated to the current mode
def button_press_cb(self, tdw, event):
"""Delegate a button-press-event to the current mode"""
mode = self.modes.top
result = mode.button_press_cb(tdw, event)
self._update_last_event_info(tdw, event)
return result
def button_release_cb(self, tdw, event):
"""Delegate a button-release-event to the current mode"""
mode = self.modes.top
result = mode.button_release_cb(tdw, event)
self._update_last_event_info(tdw, event)
return result
def motion_notify_cb(self, tdw, event, mode=None):
"""Delegate a motion-notify-event to the current mode"""
mode = mode or self.modes.top
result = mode.motion_notify_cb(tdw, event)
self._update_last_event_info(tdw, event)
return result
def scroll_cb(self, tdw, event):
"""Delegate a scroll-event to the current mode"""
mode = self.modes.top
result = mode.scroll_cb(tdw, event)
self._update_last_event_info(tdw, event)
return result
def key_press_cb(self, win, tdw, event):
"""Delegate a key-press-event to the current mode"""
mode = self.modes.top
return mode.key_press_cb(win, tdw, event)
def key_release_cb(self, win, tdw, event):
"""Delegate a key-release-event to the current mode"""
mode = self.modes.top
return mode.key_release_cb(win, tdw, event)
def _update_last_event_info(self, tdw, event):
# Update the stored details of the last event delegated.
tdw.last_tdw_event_info = event.time, event.x, event.y
def get_last_event_info(self, tdw):
"""Get details of the last event delegated to a mode in the stack.
:rtype: tuple
:returns: event details: ``(time, x, y)``
"""
info = tdw.last_tdw_event_info
if not info:
return 0, None, None
else:
return info
## High-level event observing interface
@lib.observable.event
def input_stroke_ended(self, event):
"""Event: input stroke just ended
An input stroke is a single button-down, move, button-up action. This
sort of stroke is not the same as a brush engine stroke (see
``lib.document``). It is possible that the visible stroke starts
earlier and ends later, depending on how the operating system maps
pressure to button up/down events.
:param self: Passed on to registered observers
:param event: The button release event which ended the input stroke
Observer functions and methods are called with the originating Document
Controller and the GTK event as arguments. This is a good place to
listen for "just painted something" events in some cases; ``app.brush``
will contain everything needed about the input stroke which is ending.
"""
pass
@lib.observable.event
def input_stroke_started(self, event):
"""Event: input stroke just started
Callbacks interested in the start of an input stroke should be attached
here. See `input_stroke_ended()`.
"""
pass
REDO_CMD = _("Redo %s")
REDO_PLAIN = _("Redo")
UNDO_CMD = _("Undo %s")
UNDO_PLAIN = _("Undo")
class Document(CanvasController): # TODO: rename to "DocumentController"
"""Manipulation of a loaded document via the the GUI.
A `gui.Document` is something like a Controller in the MVC sense: it
translates GtkAction activations and keypresses for changing the
view into View (`gui.tileddrawwidget`) manipulations. It is also
responsible for directly manipulating the Model (`lib.document` and
some of its internals) in response to actions and keypresses.
Some per-application state can be manipulated through this object
too: for example the drawing brush which is owned by the main
application singleton.
"""
## Class constants
# Layers have this attr set temporarily if they don't have a name yet
_NONAME_LAYER_REFNUM_ATTR = "_document_noname_ref_number"
#: Rotation step amount for single-shot commands.
#: Allows easy and quick rotation to 45/90/180 degrees.
ROTATION_STEP = 2 * math.pi / 16
# Constants for rotating and zooming by increments
ROTATE_ANTICLOCKWISE = 4 #: Rotation step direction: RotateLeft
ROTATE_CLOCKWISE = 8 #: Rotation step direction: RotateRight
ZOOM_INWARDS = 16 #: Zoom step direction: into the canvas
ZOOM_OUTWARDS = 32 #: Zoom step direction: out of the canvas
# Step zoom and rotations can happen at specified locations, or these.
CENTER_ON_VIEWPORT = 1 #: Zoom or rotate at the canvas center
CENTER_ON_POINTER = 2 #: Zoom/rotate at the last observed pointer pos
# Constants for panning (movement) by increments
PAN_STEP = 0.2 #: Stepwise panning amount: proportion of the canvas size
PAN_LEFT = 1 #: Stepwise panning direction: left
PAN_RIGHT = 2 #: Stepwise panning direction: right
PAN_UP = 3 #: Stepwise panning direction: up
PAN_DOWN = 4 #: Stepwise panning direction: down
# Picking
MIN_PICKING_OPACITY = 0.1
PICKING_RADIUS = 5
# Opacity changing
OPACITY_STEP = 0.08
# Registration
_INSTANCE_REFS = []
## Registry of controller instances
@classmethod
def get_instances(cls):
"""Iterates across all Document instances
:returns: All Document instances registered
:rtype: iterable
"""
for instance_ref in cls._INSTANCE_REFS:
instance = instance_ref()
if not instance:
continue
yield instance
@classmethod
def get_primary_instance(cls):
"""Return the main application working doc"""
primary_instance = None
for instance in cls.get_instances():
primary_instance = instance
break
return primary_instance
@classmethod
def get_active_instance(cls):
"""Get the Document instance which has the active tdw."""
active_tdw = gui.tileddrawwidget.TiledDrawWidget.get_active_tdw()
for instance in cls.get_instances():
if instance.tdw is active_tdw:
return instance
return None
## Construction
def __init__(self, app, tdw, model):
"""Constructor for a document controller
:param app: main application instance
:type app: gui.application.Application
:param tdw: primary canvas widget for this controller
:type tdw: gui.tileddrawwidget.TiledDrawWidget
:param model: model document to be controlled and reflected
:type model: lib.document.Document
Document controllers initialized here are registered
automatically with the class. See get_instances().
"""
self.app = app
self.model = model
CanvasController.__init__(self, tdw)
# Current mode observation
self._top_mode = self.modes.top
self.modes.changed += self._modestack_changed_cb
self.model.frame_enabled_changed += self._frame_enabled_changed_cb
layerstack = self.model.layer_stack
layerstack.symmetry_state_changed += self._symmetry_state_changed_cb
# Deferred until after the app starts (runs in the first idle-
# processing phase) as a workaround for https://gna.org/bugs/?14372
# ([Windows] crash when moving the pen during startup)
GLib.idle_add(self.init_pointer_events)
GLib.idle_add(self.init_scroll_events)
self.zoomlevel_values = [
# micro
1.0 / 16,
1.0 / 8,
2.0 / 11,
0.25,
1.0 / 3,
0.50,
2.0 / 3,
# normal
1.0,
1.5,
2.0,
3.0,
4.0,
5.5,
8.0,
# macro
11.0,
16.0,
23.0,
32.0,
45.0,
64.0,
]
default_zoom = self.app.preferences["view.default_zoom"]
self.tdw.scale = default_zoom
self.tdw.zoom_min = min(self.zoomlevel_values)
self.tdw.zoom_max = max(self.zoomlevel_values)
# Device-specific brushes: save at end of stroke
self.input_stroke_ended += self._input_stroke_ended_cb
self._init_stategroups()
leader = self.get_primary_instance()
if leader is not None:
# This is a secondary controller (e.g. the scratchpad)
# which plays follow-the-leader for some events.
assert isinstance(leader, Document)
self.action_group = leader.action_group # hack, but needed by tdw
else:
# This doc owns the Actions which are (sometimes) passed on to
# followers to perform. Its model is also the main 'document'
# being worked on by the user.
self._init_actions()
self._init_context_actions()
for action in self.action_group.list_actions():
self.app.kbm.takeover_action(action)
for action in self.modes_action_group.list_actions():
self.app.kbm.takeover_action(action)
self._init_extra_keys()
toggle_action = self.app.builder.get_object("ContextRestoreColor")
toggle_action.set_active(
self.app.preferences["misc.context_restores_color"]
)
#: Saved transformation to allow FitView to be toggled.
self.saved_view = None
#: Viewport change/manipulation observers.
self.view_changed_observers = []
self.view_changed_observers.append(self._view_changed_cb)
self._view_changed_notification_srcid = None
self.tdw.connect_after(
"size-allocate",
lambda *a: self.notify_view_changed(),
)
# Brush settings observers
self.app.brush.observers.append(self._brush_settings_changed_cb)
# External file edit requests
self._layer_edit_manager = gui.externalapp.LayerEditManager(self)
# Registration
cls = self.__class__
cls._INSTANCE_REFS.append(weakref.ref(self))
def _init_actions(self):
"""Internal: initializes action groups & state reflection"""
# Actions are defined in resources.xml, just grab a ref to
# the groups.
builder = self.app.builder
self.action_group = builder.get_object("DocumentActions")
self.modes_action_group = builder.get_object("ModeStackActions")
# Fine-grained observation of various model objects
cmdstack = self.model.command_stack
layerstack = self.model.layer_stack
self._init_undo_redo_actions()
observed_events = {
self._update_command_stack_actions: [
cmdstack.stack_updated,
],
self._update_merge_layer_down_action: [
# Depends on this layer and the layer beneath it
# being compatible.
layerstack.layer_properties_changed,
layerstack.current_path_updated,
layerstack.layer_inserted,
layerstack.layer_deleted,
],
self._update_normalize_layer_action: [
layerstack.current_path_updated,
layerstack.layer_properties_changed,
],
self._update_layer_bubble_actions: [
# Depends on where this layer lies in the stack
layerstack.current_path_updated,
layerstack.layer_inserted,
layerstack.layer_deleted,
],
self._update_layer_select_actions: [
# Depends on where this layer lies in the stack
layerstack.current_path_updated,
layerstack.layer_inserted,
layerstack.layer_deleted,
],
self._update_trim_layer_action: [
layerstack.current_path_updated,
],
self._update_layer_slice_actions: [
layerstack.current_path_updated,
],
self._update_show_background_toggle: [
layerstack.background_visible_changed,
layerstack.current_layer_solo_changed,
],
self._update_layer_solo_toggle: [
layerstack.current_layer_solo_changed,
],
self._update_layer_flag_toggles: [
# Visible and Locked
layerstack.current_path_updated,
layerstack.layer_properties_changed,
],
self._update_current_layer_actions: [
layerstack.current_path_updated,
],
self._update_external_layer_edit_actions: [
layerstack.current_path_updated,
],
self._update_layer_visible_toggle_from_current_view: [
self.model.layer_view_manager.current_view_changed,
],
}
for observer_method, events in observed_events.items():
for event in events:
event += observer_method
observer_method()
def _init_context_actions(self):
"""Internal: initializes several brush shortcut-key actions"""
ag = self.action_group
context_actions = []
for x in range(10):
rt = _("Load brush settings from shortcut slot %d") % x
st = _("Store brush settings in shortcut slot %d") % x
r = (
"Context0%d" % x,
None,
_("Restore Brush %d") % x,
"%d" % x,
rt,
self.context_cb,
)
s = (
"Context0%ds" % x,
None,
_("Save to Brush %d") % x,
"<control>%d" % x,
st,
self.context_cb,
)
context_actions.append(s)
context_actions.append(r)
ag.add_actions(context_actions)
def _init_stategroups(self):
"""Internal: initializes internal StateGroups"""
sg = stategroup.StateGroup()
self.layerblink_state = sg.create_state(
self.layerblink_state_enter, self.layerblink_state_leave
)
sg = stategroup.StateGroup()
self.strokeblink_state = sg.create_state(
self.strokeblink_state_enter, self.strokeblink_state_leave
)
self.strokeblink_state.autoleave_timeout = 0.3
def _init_extra_keys(self):
"""Internal: initializes secondary keyboard shortcuts
The keyboard shortcuts here are not visible in the menu.
Shortcuts assigned through the menu will take precedence.
If we assign the same key twice, the last one will work.
"""
k = self.app.kbm.add_extra_key
k("bracketleft", "Smaller") # GIMP, Photoshop, Painter
k("bracketright", "Bigger") # GIMP, Photoshop, Painter
k("<control>bracketleft", "RotateLeft") # Krita
k("<control>bracketright", "RotateRight") # Krita
k("less", "LessOpaque") # GIMP
k("greater", "MoreOpaque") # GIMP
k("equal", "ZoomIn") # (on US keyboard next to minus)
k("comma", "Smaller") # Krita
k("period", "Bigger") # Krita
k("BackSpace", "ClearLayer")
k("z", "Undo") # Old-style MyPaint Shortcut
k("<control>y", "Redo")
k("y", "Redo") # Old-style MyPaint Shortcut
k("<control>w", lambda action: self.app.drawWindow.quit_cb())
k("KP_Add", "ZoomIn")
k("KP_Subtract", "ZoomOut")
k("KP_4", "RotateLeft") # Blender
k("KP_6", "RotateRight") # Blender
k("KP_5", "ResetRotation")
k("plus", "ZoomIn")
k("minus", "ZoomOut")
k("<control>plus", "ZoomIn") # Krita
k("<control>minus", "ZoomOut") # Krita
k("bar", "SymmetryActive")
k("Left", lambda action: self.pan(self.PAN_LEFT))
k("Right", lambda action: self.pan(self.PAN_RIGHT))
k("Down", lambda action: self.pan(self.PAN_DOWN))
k("Up", lambda action: self.pan(self.PAN_UP))
k("<control>Left", "RotateLeft")
k("<control>Right", "RotateRight")
## Command history traversal actions
def undo_cb(self, action):
"""Undo action callback"""
self.model.undo()
def redo_cb(self, action):
"""Redo action callback"""
self.model.redo()
def _init_undo_redo_actions(self):
ag = self.action_group
# Icon names
style_state = self.app.drawWindow.get_style_context().get_state()
if style_state & Gtk.StateFlags.DIR_LTR:
direction = "ltr"
else:
direction = "rtl"
undo_icon_name = "mypaint-undo-%s-symbolic" % direction
redo_icon_name = "mypaint-redo-%s-symbolic" % direction
# Undo
undo_action = ag.get_action("Undo")
undo_action.set_icon_name(undo_icon_name)
self._undo_action = undo_action
# Redo
redo_action = ag.get_action("Redo")
redo_action.set_icon_name(redo_icon_name)
self._redo_action = redo_action
def _update_undo_redo(self, action, stack, cmd_str, plain_str):
"""Set label, tooltip and sensitivity"""
if len(stack) > 0:
cmd = stack[-1]
desc = cmd_str % cmd.display_name
else:
desc = plain_str
action.set_label(desc)
action.set_tooltip(desc)
action.set_sensitive(len(stack) > 0)
def _update_command_stack_actions(self, *_ignored):
"""Update the undo and redo actions"""
stack = self.model.command_stack
self._update_undo_redo(
self._undo_action, stack.undo_stack, UNDO_CMD, UNDO_PLAIN
)
self._update_undo_redo(
self._redo_action, stack.redo_stack, REDO_CMD, REDO_PLAIN
)
## Event handling
def button_press_cb(self, tdw, event):
"""Handles button press events received on a canvas"""
# User-configurable switching between modes, menu popups etc.
mode = self.modes.top
consider_mode_switch = (
mode.supports_button_switching
and not getattr(mode, "in_drag", False)
and (event.button == 1 or not (event.state & Gdk.ModifierType.BUTTON1_MASK))
)
# Look up per-device user settings
mon = self.app.device_monitor
dev = event.get_source_device()
dev_settings = mon.get_device_settings(dev)
if consider_mode_switch:
buttonmap = self.app.button_mapping
modifiers = event.state & Gtk.accelerator_get_default_mod_mask()
button = event.button
action_names = [buttonmap.lookup(modifiers, button)]
# Allow button 1 to initiate switches of mode as button 2 if
# the device is navigation-only. This allows single-finger
# panning with specially configured touchscreens while we're
# not handling touch separately. Remove this when we
# implement real touch event support.
if dev_settings and (button == 1):
if dev_settings.usage == gui.device.AllowedUsage.NAVONLY:
action_names.insert(0, buttonmap.lookup(modifiers, 2))
# Limit to actions in the whitelist, unless it's empty
limited_to = mode.permitted_switch_actions
for name in action_names:
if name and (not limited_to or name in limited_to):
return self._dispatch_named_action(None, tdw, event, name)
# User-configurable forbidding of particular devices
if dev_settings:
if not (dev_settings.usage_mask & mode.pointer_behavior):
return True
# Normal event dispatch to the top mode on the mode stack
return CanvasController.button_press_cb(self, tdw, event)
def button_release_cb(self, tdw, event):
"""Handles button release events received on a canvas"""
# User-configurable forbidding of particular devices
mode = self.modes.top
mon = self.app.device_monitor
dev = event.get_source_device()
dev_settings = mon.get_device_settings(dev)
if dev_settings:
if not (dev_settings.usage_mask & mode.pointer_behavior):
return True
# Normal event dispatch
return CanvasController.button_release_cb(self, tdw, event)
def motion_notify_cb(self, tdw, event):
"""Handles motion-notify events received on a canvas"""
mode = self._top_mode
mon = self.app.device_monitor
dev = event.get_source_device()
dev_settings = mon.get_device_settings(dev)
if dev_settings:
if not (dev_settings.usage_mask & mode.pointer_behavior):
return True
# Normal event dispatch
CanvasController.motion_notify_cb(self, tdw, event, mode)
return False # XXX don't consume motions to allow workspace autohide
def scroll_cb(self, tdw, event):
"""Handles scroll events received on a canvas"""
mode = self.modes.top
mon = self.app.device_monitor
dev = event.get_source_device()
dev_settings = mon.get_device_settings(dev)
if dev_settings:
if not (dev_settings.usage_mask & mode.scroll_behavior):
return True
CanvasController.scroll_cb(self, tdw, event)
def key_press_cb(self, win, tdw, event):
"""Handles key-press events received on the main window"""
# User-configurable switching between modes, menu popups etc.
mode = self.modes.top
consider_mode_switch = mode.supports_button_switching and not getattr(
mode, "in_drag", False
)
if consider_mode_switch:
# Naively pick an action based on the button map
buttonmap = self.app.button_mapping
action_name = None
mods = self.get_current_modifiers()
is_modifier = event.is_modifier or (
mods != 0 and event.keyval != Gdk.KEY_space
)
if is_modifier:
# If the keypress is a modifier only, determine the
# modifier mask a subsequent Button1 press event would
# get. This is used for early spring-loaded mode
# switching.
action_name = buttonmap.get_unique_action_for_modifiers(mods)
# Only mode-based immediate dispatch is allowed, however.
# Might relax this later.
if action_name is not None:
if not action_name.endswith("Mode"):
action_name = None
else:
# Strategy 2: pretend that the space bar is really button 2.
if event.keyval == Gdk.KEY_space:
action_name = buttonmap.lookup(mods, 2)
# Limit to actions in the whitelist, unless it's empty
limited_to = mode.permitted_switch_actions
if action_name and (not limited_to or action_name in limited_to):
# If we found something to do, dispatch;
return self._dispatch_named_action(
win,
tdw,
event,
action_name,
)
# Explain what's possible from here with some extra
# modifiers and button presses.
self._update_key_pressed_status_message()
# TODO: Maybe display the inactive cursor belonging to the
# TODO: button1 binding for these modifiers. Blocker: need
# TODO: to do it without instantiating the handler class.
# btn1_action_name = buttonmap.lookup(mods, 1)
# btn1_handler_type, btn1_handler = gui.buttonmap\
# .get_handler_object(
# self.app,
# btn1_action_name,
# )
# if btn1_handler_type == 'mode_class':
# assert issubclass(btn1_handler, gui.mode.DragMode)
# btn1_cursor = btn1_handler.inactive_cursor # fails.
# if btn1_cursor:
# self.tdw.set_override_cursor(btn1_cursor)
# Normal event dispatch
return CanvasController.key_press_cb(self, win, tdw, event)
def key_release_cb(self, win, tdw, event):
self._update_key_pressed_status_message()
return CanvasController.key_release_cb(self, win, tdw, event)
def _dispatch_named_action(self, win, tdw, event, action_name):
"""Dispatch an action looked up via the buttonmap"""
app = self.app
drawwindow = app.drawWindow
if action_name == "ShowPopupMenu":
# Unfortunately still a special case.
# Just firing the action doesn't work well with pads which fire a
# button-release event immediately after the button-press.
# Name it after the action however, in case we find a fix.
drawwindow.show_popupmenu(event=event)
return True
handler_type, handler = gui.buttonmap.get_handler_object(
app,
action_name,
)
if handler_type == "mode_class":
# Transfer control to another mode temporarily.
assert issubclass(handler, gui.mode.DragMode)
if issubclass(handler, gui.mode.OneshotDragMode):
mode = handler(temporary_activation=True)
else:
mode = handler()
self.modes.push(mode)
if win is not None:
return mode.key_press_cb(win, tdw, event)
else:
return mode.button_press_cb(tdw, event)
elif handler_type == "popup_state":
# Still needed. The code is more tailored to MyPaint's
# purposes. The names are action names, but have the more
# tailored popup states code shadow generic action activation.
if win is not None:
# WORKAROUND: dispatch keypress events via the kbm so it can
# keep track of pressed-down keys. Popup states become upset if
# this doesn't happen: https://gna.org/bugs/index.php?20325
action = app.find_action(action_name)
return app.kbm.activate_keydown_event(action, event)
else:
# Pointer: popup states handle these themselves sanely.
handler.activate(event)
return True
elif handler_type == "gtk_action":
# Generic named action activation. GtkActions trigger without
# event details, so they're less flexible.
# Hack: Firing the action in an idle handler helps with
# actions that are sensitive to immediate button-release
# events. But not ShowPopupMenu, sadly: we'd break button
# hold behaviour for more reasonable devices if we used
# this trick.
GLib.idle_add(handler.activate)
return True
else:
return False
def _get_key_pressed_status_message_context_id(self):
statusbar = self.app.statusbar
try:
context_id = self.__key_pressed_msg_statusbar_context
except AttributeError:
context_id = statusbar.get_context_id("key-pressed-msg")
self.__key_pressed_msg_statusbar_context = context_id
return context_id
def get_current_modifiers(self):
"""Returns the current set of modifier keys as a Gdk bitmask.
:returns: The current set of modifier keys.
:rtype: Gdk.ModifierType
This method should only be used in
* Handlers for keypress events
when the key in question is itself a modifier,
* Handlers of multiple types of event (both key and pointer),
* When the triggering event simply isn't available.
Normal pointer button event handling should use
``event.state & Gtk.accelerator_get_default_mod_mask()``
instead.
"""
win = self.tdw.get_window()
display = self.tdw.get_display()
devmgr = display and display.get_device_manager() or None
coredev = devmgr and devmgr.get_client_pointer() or None
if coredev and win:
win_, x, y, mask = win.get_device_position(coredev)
return mask & Gtk.accelerator_get_default_mod_mask()
return Gdk.ModifierType(0)
def _update_key_pressed_status_message(self):
"""Update app statusbar to explain what modes are reachable"""
context_id = self._get_key_pressed_status_message_context_id()
statusbar = self.app.statusbar
statusbar.remove_all(context_id)
btn_map = self.app.button_mapping
mods = self.get_current_modifiers()
if mods == 0:
return
poss_list = btn_map.lookup_possibilities(mods)
if not poss_list:
return
poss_list.sort()
poss_msgs = []
current_mode = self.modes.top
limited_to = current_mode.permitted_switch_actions
for pmods, button, action_name in poss_list:
# Limit to actions in the white list, unless it's empty
if limited_to and action_name not in limited_to:
continue
# Don't repeat what's currently held
pmods = pmods & ~mods
label = gui.buttonmap.button_press_displayname(button, pmods, True)
mode_class = gui.mode.ModeRegistry.get_mode_class(action_name)
mode_desc = None
if mode_class:
mode_desc = mode_class.get_name()
else:
action = self.app.find_action(action_name)
if action:
mode_desc = action.get_label()
if mode_desc:
# TRANSLATORS: Statusbar message explaining button and modifier
# TRANSLATORS: combinations used to access modes/tools/actions.
# TRANSLATORS: "With <current-modifiers> held down: <list>"
msg = _("{button_combination} is {resultant_action}").format(
button_combination=label,
resultant_action=mode_desc,
)
poss_msgs.append(msg)
if not poss_msgs:
return
# TRANSLATORS: This is a separator for the list of button actions
# TRANSLATORS: that appears when a modifier key is held down.
# TRANSLATORS: search for " held down: " (incl spaces) for the context
sep = _("; ")
# TRANSLATORS: "With <current-modifiers> held down: <separated-list>"
# TRANSLATORS: Action names may contain coordinating conjunctions such
# TRANSLATORS: as the English "and", so use appropriate punctuation or
# TRANSLATORS: wording for the separator. Also a little more spacing
# TRANSLATORS: than normal looks good here.
msg = _("With {modifiers} held down: {button_actions}.").format(
modifiers=Gtk.accelerator_get_label(0, mods),
button_actions=sep.join(poss_msgs),
)
self.app.statusbar.push(context_id, msg)
## Copy/Paste
def _get_clipboard(self):
"""Internal: return the GtkClipboard for the current display"""
display = self.tdw.get_display()
cb = Gtk.Clipboard.get_for_display(display, Gdk.SELECTION_CLIPBOARD)
return cb
def copy_cb(self, action):
"""``CopyLayer`` GtkAction callback: copy layer to clipboard"""
# use the full document bbox, so we can paste layers back to the
# correct position
rootstack = self.model.layer_stack
if self.app.preferences.get("ui.legacy-copy-paste", False):
bbox = self.model.get_bbox()
else:
bbox = rootstack.current.get_bbox()
if bbox.w == 0 or bbox.h == 0:
self.app.show_transient_message(
C_(
"Statusbar message: copy result",
"Empty document, nothing copied.",
)
)
return
pixbuf = rootstack.render_layer_as_pixbuf(
rootstack.current,
bbox,
alpha=True,
)
cb = self._get_clipboard()
cb.set_image(pixbuf)
self.app.show_transient_message(
C_(
"Statusbar message: copy result",
"Copied layer as {w}×{h} image.",
).format(
w=pixbuf.get_width(),
h=pixbuf.get_height(),
)
)
def paste_cb(self, action):
"""``PasteLayer`` GtkAction callback: replace layer with clipboard"""
clipboard = self._get_clipboard()
# Windows requires the available targets to be polled first.
# Ensure that happens fully before polling for image data.
# If we don't do this, nothing other than the 1st pasted image
# can be pasted: https://github.com/mypaint/mypaint/issues/595
targs_avail, targets = clipboard.wait_for_targets()
if not targs_avail:
self.app.show_transient_message(
C_(
"Statusbar message: paste result",
"Nothing on clipboard.",
)
)
return
logger.debug("Paste: available targets: %r", [str(a) for a in targets])
# Then grab any available image, also synchronously
pixbuf = clipboard.wait_for_image()
if not pixbuf:
self.app.show_transient_message(
C_(
"Statusbar message: paste result",
"Clipboard does not contain an image.",
)
)
return
# Supports old copy-paste, useful if moving a layer from one document
# to another with the same bounding box.
if self.app.preferences.get("ui.legacy-copy-paste", False):
x, y, __, __ = self.model.get_bbox()
# If pasting with a shortcut, the upper left corner of the content
# is aligned with the cursor location, otherwise it is centered.
elif action.keydown:
x, y = self.tdw.display_to_model(*self.get_last_event_info(self.tdw)[1:])
else:
x, y = self.tdw.get_center_model_coords()
x -= pixbuf.get_width() / 2.0
y -= pixbuf.get_height() / 2.0
try:
self.model.load_layer_from_pixbuf(pixbuf, int(x), int(y), to_new_layer=True)
except Exception:
logger.exception("Paste failed")
self.app.show_transient_message(
C_(
"Statusbar message: paste result",
"Cannot paste into this type of layer.",
)
)
return
self.app.show_transient_message(
C_(
"Statusbar message: paste result",
"Pasted {w}×{h} image.",
).format(
w=pixbuf.get_width(),
h=pixbuf.get_height(),
)