-
Notifications
You must be signed in to change notification settings - Fork 0
/
sys_show_shortcuts.py
1259 lines (1172 loc) · 50.9 KB
/
sys_show_shortcuts.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: utf8 -*-
# # # # # # BEGIN GPL LICENSE BLOCK # # # # # #
# 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 Street, Fifth Floor, Boston, MA 02110-1301, USA.
#
# # # # # # END GPL LICENSE BLOCK # # # # #
# <pep8 compliant>
bl_info = {
"name": "Show Shortcuts",
"author": "Yardie (Greg Dickson)",
"version": (1, 5, 4),
"blender":
(2, 7, 2),
"location":
"[Cmd+Shft+F1] User Prefs -> Input -> Window -> Show Shortcut Keys",
"description":
"Shows the currently active and enabled shortcuts in a popup.",
"wiki_url": "https://github.com/Yardie-/show_shortcuts/wiki",
"tracker_url": "http://blenderartists.org/forum/showthread.php?347589",
"category": "System"}
import bpy
# import os
import string
import textwrap
# from datetime import datetime, date
from bpy.props import StringProperty, BoolProperty, EnumProperty, IntProperty
from bpy.types import Operator, AddonPreferences
from bpy_extras import keyconfig_utils
from bpy.app.translations import pgettext_tip as translate_
# Last release update
# 13 October 2014 7:37:53 AM AWST
# Last dev update
# 13 October 2014 7:37:44 AM AWST
# import pprint
DEBUG = False
# TODO
# Make a menu to show list of grouped keymaps
# Show Global shortcuts like Alt + A Seems to work everywhere
# needs to group shortcuts by identical shortcuts
# maybe duplicate a keymap-item then remove only the shortcut sections call sections
# solve error RNA Warning: Current value "0" matches no enum in 'GROUP_OT_objects_remove', '(null)', 'group'
# self.idname_py()
"""
add a pie menu for groups
ideally this will
list items by name
onmouse over of the name will show the
keycombo
alternative
tooltip lines
each being a call to the full description popup
"""
def get_description(op_class):
"""Get the description of the Call this with C name not python name."""
descr = ""
if op_class:
descr = op_class.bl_rna.description
if not descr:
descr = op_class.__doc__
if not descr and hasattr(op_class, 'bl_label'):
descr = op_class.bl_label
if not descr and hasattr(op_class, 'name'):
descr = op_class.name
if not descr:
return ""
return translate_(descr) + "."
def kmi_compare_props(keymap_item_a, keymap_item_b):
"""Compare 2 keymap items if they have the same properties
they are effectively the same just are alternative key combos.
"""
# differs by keymap_item.properties.??
# call menu -> name
# context_enum -> data_path
a_rna = getattr(keymap_item_a, 'properties', None)
b_rna = getattr(keymap_item_b, 'properties', None)
for a_prop in dir(a_rna):
if not a_prop.startswith("_") and a_prop not in {"bl_rna", "rna_type"}:
if getattr(a_rna, a_prop, False) != getattr(b_rna, a_prop, False):
return False
return True
def execute_string(opname):
if not opname.startswith("bpy.ops."):
opname = "bpy.ops." + opname
op_name = opname.split(".", 4)
op = getattr(getattr(bpy.ops, op_name[2]), op_name[3])
if op.poll():
return op() # exec operator
def poll_op(opname):
if not opname.startswith("bpy.ops."):
opname = "bpy.ops." + opname
op_name = opname.split(".", 4)
op = getattr(getattr(bpy.ops, op_name[2]), op_name[3])
if op.poll():
return True
if DEBUG:
print("!!! Poll Failed for", op)
return False
def map_operator_from_shortcut(op, op_class, keymap_item):
for prop in dir(keymap_item.properties):
if (prop in op_class.bl_rna.properties and
not prop.startswith("_") and
prop not in {"bl_rna", "rna_type", ""}):
if (op_class.bl_rna.properties[prop].type == 'ENUM' and
len(op_class.bl_rna.properties[prop].enum_items) == 0):
continue
attr = getattr(keymap_item.properties, prop, None)
if (op_class.bl_rna.properties[prop].type == 'ENUM' and
attr not in op_class.bl_rna.properties[prop].enum_items):
continue
if hasattr(op, prop) and getattr(op, prop) != attr:
try:
setattr(op, prop, attr)
except AttributeError:
pass
return op
# def find_keymap(lookfor):
# found = None
# return found
def eval_attr(object, name):
resolved = object
for o in name.split("."):
resolved = getattr(resolved, o)
return resolved
def nice_text(punc):
"""Convert the ugly string name into the actual character
Stolen from node_effciency_tools adapted to user prefs"""
user_prefs = get_user_prefs()
pairs = (
('LEFTMOUSE', "Left Mouse"),
('MIDDLEMOUSE', "Middle Mouse"),
('RIGHTMOUSE', "Right Mouse"),
('SELECTMOUSE', "Select Mouse"),
('ACTIONMOUSE', "Action Mouse"),
('WHEELUPMOUSE', "Wheel Up"),
('WHEELDOWNMOUSE', "Wheel Down"),
('WHEELINMOUSE', "Wheel In"),
('WHEELOUTMOUSE', "Wheel Out"),
('LEFT_ARROW', user_prefs.leftarrow_text),
('RIGHT_ARROW', user_prefs.rightarrow_text),
('UP_ARROW', user_prefs.uparrow_text),
('DOWN_ARROW', user_prefs.downarrow_text),
('ZERO', "0"),
('ONE', "1"),
('TWO', "2"),
('THREE', "3"),
('FOUR', "4"),
('FIVE', "5"),
('SIX', "6"),
('SEVEN', "7"),
('EIGHT', "8"),
('NINE', "9"),
('OSKEY', "Cmd"),
('RET', "Return"),
('ESC', "Esc"),
('TAB', "Tab"),
('DEL', "Delete"),
('SEMI_COLON', ";"),
('PERIOD', "."),
('COMMA', ","),
('QUOTE', "\""),
('ACCENT_GRAVE', "`"),
('MINUS', "-"),
('BACK_SLASH', "\\"),
('EQUAL', "="),
('LEFT_BRACKET', "("),
('RIGHT_BRACKET', ")"),
('LINE_FEED', "Return"),
('SLASH', "/"),
('BACK_SLASH', "\\"),
('EQUAL', "="),
('NDOF_ISO1', "NDOF Isometric 1"),
('NDOF_ISO2', "NDOF Isometric 2"),
('NUMPAD_PERIOD', "Numpad" + " ."),
('NUMPAD_SLASH', "Numpad" + " /"),
('NUMPAD_ASTERIX', "Numpad" + " *"),
('NUMPAD_MINUS', "Numpad" + " -"),
('NUMPAD_ENTER', "Numpad" + " Enter"),
('NUMPAD_PLUS', "Numpad" + " +"),
)
punc = punc.strip()
nice_punc = False
for (ugly, nice) in pairs:
if punc == ugly:
nice_punc = nice
break
if not nice_punc:
nice_punc = punc.replace("_", " ").title().replace('Ccw', 'CCW').replace('Cw', 'CW').replace('Ndof', 'NDOF').replace('Ccw', 'CCW')
# String replace ndof to NDOF Cw CW Ccw CCW then nearly all the NDOF strings will translate
# NDOF_ISO1 -> NDOF Isometric 1
return translate_(nice_punc)
def get_user_prefs():
"""simply returns the current prefs for this addon """
return bpy.context.user_preferences.addons[__name__].preferences
def get_input_types():
input_type = []
addon_prefs = get_user_prefs()
if addon_prefs.KEYBOARD:
input_type.append('KEYBOARD')
if addon_prefs.MOUSE:
input_type.append('MOUSE')
if addon_prefs.NDOF:
input_type.append('NDOF')
if addon_prefs.TWEAK:
input_type.append('TWEAK')
if addon_prefs.TEXTINPUT:
input_type.append('TEXTINPUT')
return input_type
def keymap_guess_opname(context, opname):
""" Pythonised vesion of
file blender/windowmanager/intern/wm_keymap.c
My version also uses path to determine context
- - find in wm_keymap.c line 1413+
ingroup wm
Blender 2.71 will need to be kept up to date with that so
I will try to make it as similar as possible
# /* Guess an appropriate keymap from the operator name */
# /* Needs to be kept up to date with Keymap and Operator naming */
# wmKeyMap *WM_keymap_guess_opname(const bContext *C, const char *opname)
# {
# ....wmKeyMap *km = NULL;
# /* Op types purposely skipped for now:
* BRUSH_OT
* BOID_OT
* BUTTONS_OT
* CONSTRAINT_OT
* DPAINT_OT
* ED_OT
* FLUID_OT
* TEXTURE_OT
* UI_OT
* VIEW2D_OT
* WORLD_OT
*/
"""
# km = False
map = (
# /* Window */
("WM_", "Window", 0, 0),
# /* Screen & Render */
("SCREEN_", "Screen", 0, 0),
("RENDER_", "Screen", 0, 0),
("SOUND_", "Screen", 0, 0),
("SCENE_", "Screen", 0, 0),
# /* Grease Pencil */
("GPENCIL_", "Grease Pencil", 0, 0),
# /* Markers */
("MARKER_", "Markers", 0, 0),
# /* Import/Export*/
("IMPORT_", "Window", 0, 0),
("EXPORT_", "Window", 0, 0),
# /* 3D View */
("VIEW3D_", "3D View", context.space_data.type, 0),
("OBJECT__mode_set", "Object Non-modal", 0, 0),
("OBJECT_", "Object Mode", 0, 0),
# /* Object mode related */
("GROUP_", "Object Mode", 0, 0),
("MATERIAL_", "Object Mode", 0, 0),
("PTCACHE_", "Object Mode", 0, 0),
("RIGIDBODY_", "Object Mode", 0, 0),
# /* Editing Modes */
("MESH_",
"Object Mode" if context.mode == 'OBJECT' else "Mesh", 0, 0),
("CURVE_",
"Object Mode" if context.mode == 'OBJECT' else "Curve", 0, 0),
("SURFACE_",
"Object Mode" if context.mode == 'OBJECT' else "Curve", 0, 0),
("ARMATURE_", "Armature", 0, 0),
("SKETCH_", "Armature", 0, 0),
("POSE_", "Pose", 0, 0),
("POSELIB_", "Pose", 0, 0),
("SCULPT_",
"Sculpt" if context.mode == 'SCULPT' else "UV Sculpt", 0, 0),
("LATTICE_", "Lattice", 0, 0),
("PARTICLE_", "Particle", 0, 0),
("FONT_", "Font", 0, 0),
("PAINT__face_select", "Face Mask", 0, 0),
("PAINT_",
"Weight Paint" if context.mode == 'PAINT_WEIGHT' else
"Vertex Paint" if context.mode == 'PAINT_VERTEX' else
"Image Paint" if context.mode == 'PAINT_TEXTURE' else None, 0, 0),
# /* Timeline */
("TIME_", "Timeline", context.space_data.type, 0),
# /* Image Editor */
("IMAGE_", "Image", context.space_data.type, 0),
# /* Clip Editor */
("CLIP_", "Clip", context.space_data.type, 0),
("MASK_", "Mask Editing", 0, 0),
# /* UV Editor */
("UV_", "UV Editor", context.space_data.type, 0),
# /* Node Editor */
("NODE_", "Node Editor", context.space_data.type, 0),
# /* Animation Editor Channels */
("ANIM__channels", "Animation Channels", context.space_data.type, 0),
# /* Animation Generic - after channels */
("ANIM_", "Animation", 0, 0),
# /* Graph Editor */
("GRAPH_", "Graph Editor", context.space_data.type, 0),
# /* Dopesheet Editor */
("ACTION_", "Dopesheet", context.space_data.type, 0),
# /* NLA Editor */
("NLA_", "NLA Editor", context.space_data.type, 0),
# /* Script */
("SCRIPT_", "Script", context.space_data.type, 0),
# /* Text */
("TEXT_", "Text", context.space_data.type, 0),
# /* Sequencer */
("SEQUENCER_", "Sequencer", context.space_data.type, 0),
# /* Console */
("CONSOLE_", "Console", context.space_data.type, 0),
# /* Console */
("INFO_", "Info", context.space_data.type, 0),
# /* File browser */
("FILE_", "File Browser", context.space_data.type, 0),
# /* Logic Editor */
("LOGIC_", "Logic Editor", context.space_data.type, 0),
# /* Outliner */
("OUTLINER_", "Outliner", context.space_data.type, 0),
("TRANSFORM_",
"3D View" if context.space_data.type == 'VIEW_3D' else
"Graph Editor" if context.space_data.type == 'GRAPH_EDITOR' else
"Dopesheet" if context.space_data.type == 'DOPESHEET_EDITOR' else
"NLA Editor" if context.space_data.type == 'NLA_EDITOR' else
"UV Editor" if context.space_data.type == 'IMAGE_EDITOR' else
"Node Editor" if context.space_data.type == 'NODE_EDITOR' else
"Sequencer" if context.space_data.type == 'SEQUENCE_EDITOR' else None, context.space_data.type, 0),
)
# context.space_data.type ['EMPTY', 'VIEW_3D', 'TIMELINE', 'GRAPH_EDITOR', 'DOPESHEET_EDITOR', 'NLA_EDITOR', 'IMAGE_EDITOR', 'SEQUENCE_EDITOR', 'CLIP_EDITOR', 'TEXT_EDITOR',
# 'NODE_EDITOR', 'LOGIC_EDITOR', 'PROPERTIES', 'OUTLINER', 'USER_PREFERENCES', 'INFO', 'FILE_BROWSER', 'CONSOLE'],
# default 'EMPTY',
# names in C are different than python """
# the [0] returns just the first match
# so "ANIM_OT_channels" being before "ANIM_OT" works == a switch statement
for k, v, s, r in map:
if opname.startswith(k):
return (k, v, s, r)
return (False, False, False, False)
def get_flat_keymap_hierarchy_as_dict():
""" Recurse through the key map hierarchy and flatten it into one straight
list in the correct vertical order
bpy.type.KeyMap: (km.name, km.space_type, km.region_type, [...])"""
result = {}
def testEntry(entry, parent_space=""):
idname, spaceid, regionid, children = entry
if spaceid == 'EMPTY' and parent_space != "":
spaceid = parent_space
result[idname] = (spaceid, regionid)
for child in children:
testEntry(child, spaceid)
for entry in keyconfig_utils.KM_HIERARCHY:
testEntry(entry)
return result
def check_context_keymap(context, keymap, km_hierarchy, addon_prefs):
mode_ = mode_map(keymap.name)
if (mode_ and context.mode != mode_):
if DEBUG:
print("!!! Keymap:", keymap.name, "not available in mode", context.mode)
return False
if DEBUG:
print("Key map name =", keymap.name, "is available in", context.mode)
entry = get_kmh_entry(keymap.name)
idname = spaceid = regionid = children = False
if entry:
idname, spaceid, regionid, children = entry
if ((keymap.name in km_hierarchy and km_hierarchy[keymap.name][0] == context.space_data.type) or
(context.region.type == keymap.region_type and
(keymap.space_type == context.space_data.type and
context.space_data.type == spaceid)) or
(keymap.name == "Screen" and addon_prefs.show_screen) or
(keymap.name.startswith("Anim") and addon_prefs.show_animation) or
(keymap.name == "Frames" and addon_prefs.show_frames) or
(keymap.name == "Grease Pencil" and addon_prefs.grease_pencil) or
(keymap.name == "Markers" and addon_prefs.show_markers) or
(keymap.name == "Window" and addon_prefs.show_window)):
if DEBUG:
print(">>> Context OK:", keymap.name)
return True
return False
def check_context_keymap_item(context, item):
return False
def check_context_operator(context, op_name, km_hierarchy, addon_prefs, context_map=[]):
op_prefix, space_name, region_id, dunno = keymap_guess_opname(context, op_name)
context_map.append(context.space_data.type)
mode_ = mode_map(space_name)
if (mode_ and context.mode != mode_):
return False
if (addon_prefs.show_screen or
addon_prefs.show_animation or
addon_prefs.show_frames or
addon_prefs.grease_pencil or
addon_prefs.show_markers or
addon_prefs.show_window):
context_map.append('EMPTY')
if space_name in km_hierarchy and km_hierarchy[space_name][0] in context_map:
return True
if DEBUG:
print ("!!! Operator:", op_name, "not available in context", context.area.type)
return False
def squash_keymap_hierarchy():
""" Recurse through the key map hierarchy and
flatten it into one straight list in the correct vertical order
bpy.type.KeyMap: (km.name, km.space_type, km.region_type, [...])
if the space type is empty then assign the space type to
that of the parent
"""
result = {}
def testEntry(entry, parent_space="EMPTY"):
idname, spaceid, regionid, children = entry
# print (idname)
if spaceid == 'EMPTY' and parent_space != "EMPTY":
spaceid = parent_space
result[idname] = (spaceid, regionid)
for child in children:
testEntry(child, spaceid)
for entry in keyconfig_utils.KM_HIERARCHY:
testEntry(entry)
return result
def get_kmh_entry(k):
for entry in keyconfig_utils.KM_HIERARCHY:
idname, spaceid, regionid, children = entry
if idname == k:
return entry
return False
# redundant see import line
# def translate(text):
# txt = bpy.app.translations.pgettext_tip(text)
# if txt != text:
# return txt
# return text
def mode_map(find_):
return{
"Pose": "POSE",
"Object Mode": "OBJECT",
"Paint Curve": "PAINT_CURVE",
"Curve": "EDIT_CURVE",
"Image Paint": "PAINT_TEXTURE",
"Vertex Paint": "PAINT_VERTEX",
"Weight Paint": "PAINT_WEIGHT",
"Sculpt": "SCULPT",
"Mesh": "EDIT_MESH",
"Armature": "EDIT_ARMATURE",
"Metaball": "EDIT_METABALL",
"Lattice": "EDIT_LATTICE",
"Particle": "PARTICLE"}.get(find_, False)
def get_available_keymaps(self, context, search_name=False):
available_keymaps = {}
location = ""
# simple test for 3D View available
if bpy.ops.view3d.select.poll():
x, y, z = context.scene.cursor_location
location = "x {:.1}, y {:.1}, z {:.1}".format(x, y, z)
addon_prefs = get_user_prefs()
show_window = addon_prefs.show_window
show_screen = addon_prefs.show_screen
mode = False
km_hierarchy = squash_keymap_hierarchy()
if DEBUG:
print("Space type", context.space_data.type)
for keymap in bpy.context.window_manager.keyconfigs.user.keymaps:
# Remove region specific stuff and get the similar space type or empty
# this should be possible in a straight table lookup but not sure how
if not check_context_keymap(context, keymap, km_hierarchy, addon_prefs):
continue
for keymap_item in keymap.keymap_items:
name = keymap_item.name
if DEBUG:
print("???", name)
# ***************** move on if we are only called with one name
if search_name and search_name != name:
continue
# some have no idname skip them also skip inactive
if not keymap_item.active or not keymap_item.idname:
continue
if (keymap_item.map_type in get_input_types() and poll_op(keymap_item.idname)):
if DEBUG:
print (">>> Available:", keymap_item.idname)
# Only show the input types selected
mod, opname = keymap_item.idname.split(".")
idname_c = "{!s}_OT_{!s}".format(mod.upper(), opname)
show_wm = False
# ***************** move on if context is wrong
if not check_context_operator(context, idname_c, km_hierarchy, addon_prefs, context_map=[]):
continue
# TODO Needs to check mode for some ops
description = ""
# remove the Context Set Enum key items for now TODO reenable to get this working
# if name.startswith('Context Set'):
# if DEBUG:
# print ("-> Fix Me! Skipping", name)
# continue
# use the idname to check for Call Menu to allow for name changes in prefs
op_map = keymap_guess_opname(context, idname_c)
if op_map:
op = op_map[1]
else:
op = False
if keymap_item.idname == "wm.call_menu":
if hasattr(keymap_item.properties, "name"):
c_op = getattr(keymap_item.properties, "name")
if DEBUG:
print (keymap_item.idname, c_op)
if not check_context_operator(context, c_op, km_hierarchy, addon_prefs, ['INFO']):
continue
else:
description = get_description(getattr(bpy.types, c_op, False))
op_class = getattr(bpy.types, c_op, False)
pre, called = c_op.split("_MT_")
name = translate_("Call Menu") + " (" + called.replace('_', ' ').title() + ")"
# if op_class:
# if (type(op_class.__doc__) is str and
# len(op_class.__doc__.strip()) > 0):
# if DEBUG:
# description += "doc: "
# description += translate_(op_class.__doc__) + ". "
# if (type(op_class.bl_rna.description) is str and
# len(op_class.bl_rna.description.strip()) > 0):
# description += translate_(op_class.bl_rna.description) + ". "
# if (type(op_class.bl_label) is str and
# len(op_class.bl_label.strip()) > 0):
# description += translate_(op_class.bl_label) + ". "
# http://blenderartists.org/forum/showthread.php?348582-collect-quot-quot-quot-tooltips-quot-quot-quot-in-python&p=2726119&viewfull=1#post2726119
# http://blenderartists.org/forum/showthread.php?348582-collect-quot-quot-quot-tooltips-quot-quot-quot-in-python&p=2726048&viewfull=1#post2726048
if (op and
op in km_hierarchy and
(km_hierarchy[op][0] == context.space_data.type or
(op == "Object Mode" and context.mode is 'OBJECT') or
(op == "Screen" and addon_prefs.show_screen) or
(op.startswith("Anim") and addon_prefs.show_animation) or
(op == "Frames" and addon_prefs.show_frames) or
(op == "Markers" and addon_prefs.show_markers) or
(op == "Window" and addon_prefs.show_window))):
# and keymap.space_type != "EMPTY":
# now the final test
# print ("Operator = ", op, (op is "Window"))
op_class = getattr(bpy.types, idname_c)
# bpy.ops.wm.context_set_enum(data_path="", value="")
# bpy.ops.wm.call_menu(name="")
# If there is __doc__ info that should precede others
description = get_description(op_class)
#
# if (type(op_class.__doc__) is str and
# len(op_class.__doc__.strip()) > 0):
# # is str is not None and:
# if DEBUG:
# description += "doc: "
# description += translate_(op_class.__doc__) + ". "
# if (type(op_class.bl_rna.description) is str and
# len(op_class.bl_rna.description.strip()) > 0):
# description += translate_(op_class.bl_rna.description) + ". "
# if len(description) > 0:
# description = "\nTooltips\n" + description
args = []
props = ""
args_description = ""
refine = ""
for prop in dir(keymap_item.properties):
if (prop in op_class.bl_rna.properties and
not prop.startswith("_") and
prop not in {"bl_rna", "rna_type"}):
attr = getattr(keymap_item.properties, prop, False)
if DEBUG and attr:
args_description += "\n{} {} {!r}".format(prop, op_class.bl_rna.properties[prop].type, attr)
# RNA Warning: Current value "0" matches no enum in 'GROUP_OT_objects_remove', '(null)', 'group'
# if (op_class.bl_rna.properties[prop].type == 'ENUM' and
# len(op_class.bl_rna.properties[prop].enum_items) == 0):
# continue
property_description = getattr(op_class.bl_rna.properties[prop], "description", prop).strip()
if property_description == "":
property_description = nice_text(prop)
property_description = translate_(property_description)
# ________needs work to make Vectors and the like more readable
if attr: # str(attr).strip() !="":
# might fix RNA Warning: Current value "0" matches no enum in 'GROUP_OT_objects_remove', '(null)', 'group'
if (op_class.bl_rna.properties[prop].type == 'ENUM' and
attr not in op_class.bl_rna.properties[prop].enum_items):
if DEBUG:
print(attr, "not found in", prop)
continue
if op_class.bl_rna.properties[prop].type == 'BOOLEAN':
# A BOOLEAN that is False will not reach here as attr is False and dealt with above.
args_description += "\n{}".format(property_description)
refine += " (" + nice_text(prop) + ")"
# elif op_class.bl_rna.properties[prop].type == 'FLOAT':
# args_description += "\n{} @ {}".format(
# translate_(op_class.bl_rna.properties[prop].description),
# ", ".join(map(str, getattr(keymap_item.properties, prop))))
elif prop == "location" and location != "":
# po "3D cursor location"
# args_description += op_class.bl_rna.properties[prop].type + "\n{:} set to {} {}.".format(op_class.bl_rna.properties[prop].description, attr[0], attr[0])
args_description += "\nUsing current {}".format(property_description)
# , location)
else:
if (op_class.bl_rna.properties[prop].type == 'ENUM' and
len(op_class.bl_rna.properties[prop].enum_items) > 0 and
attr in op_class.bl_rna.properties[prop].enum_items):
refine += " (" + nice_text(attr) + ")"
enum_ = getattr(op_class.bl_rna.properties[prop].enum_items, attr, False)
desc = False
if enum_:
desc = getattr(enum_, "description", False)
if desc and len(desc.strip()) > 0:
desc = desc.strip()
else:
desc = "{}".format(nice_text(attr))
# attr in op_class.bl_rna.properties[prop].enum_items and
# op_class.bl_rna.properties[prop].enum_items[attr].description is not None and
# len(op_class.bl_rna.properties[prop].enum_items[attr].description.strip()) > 0):
args_description += "\n{}: '{}'.".format(
translate_(property_description),
nice_text(desc))
else:
args_description += "\n{}: {}.".format(
property_description,
nice_text("{!r}".format(attr)))
if op_class.bl_rna.properties[prop].type == 'INT' and prop == "delta":
refine += " (" + nice_text(str(attr)) + ")"
# if attr != "": # Would be cool to remove defaults if the keymap = default
args.append("{!s}={!r}".format(prop, attr))
if args_description != "":
# args_description = "\nSettings:\n" + args_description
description += args_description
# if description.find("editmode only") > 0:
# name += " EDITONLY"
# continue
text_args = ",\n\t".join(args).strip()
args = ", ".join(args)
if len(args) > 0:
text_args = "\n\t" + text_args
function_call_text = "bpy.ops.{:}({:})".format(keymap_item.idname, text_args)
function_call = "bpy.ops.{:}({:})".format(keymap_item.idname, args)
modifiers = ""
if keymap_item.any:
modifiers = addon_prefs.any_text
else:
modifier_key = []
if keymap_item.shift:
modifier_key.append(addon_prefs.shft_text)
if keymap_item.ctrl:
modifier_key.append(addon_prefs.ctrl_text)
if keymap_item.alt:
modifier_key.append(addon_prefs.alt_text)
if keymap_item.oskey:
modifier_key.append(addon_prefs.oskey_text)
modifiers = " + ".join(modifier_key)
# sortable key for dict
if modifiers != "":
key_combo = " + ".join([modifiers, nice_text(keymap_item.type)])
else:
key_combo = nice_text(keymap_item.type)
"""
TODO
Unique key for keymaps
This groups them by name as per visual expectation
and function to allow for alternative keys
needs to have menu_enum to work correctly
"""
#if search_name:
# sort_key = key_combo # keymap_item.name + keymap_item.type + modifiers
# print('line 610', sort_key)
#else:
sort_key = name + refine # function_call
# key_combo = "[ " + key_combo + " ]"
# If there is already a keymap with the same name and
# function then add the key as an alternative only.
if sort_key in available_keymaps:
# TODO
if kmi_compare_props(keymap_item, available_keymaps[sort_key]['keymap_item']):
if (available_keymaps[sort_key]["alternate keys"].find(key_combo) == -1 and
available_keymaps[sort_key]["key combo"] != key_combo):
prespace = "".ljust(len(translate_("Shortcut: %s")), " ")
available_keymaps[sort_key]["alternate keys"] += "{}\t{}\n".format(prespace, key_combo)
# if an existing description is empty but this one is not
# then use this one.
if (len(available_keymaps[sort_key]["description"]) == 0 and
len(description) > 0):
available_keymaps[sort_key]["description"] = description
else:
if key_combo != "None":
if sort_key in available_keymaps:
sort_key += " " # add a space to the end to distinguish them
name += " "
# modifiers += " + "
if description == name or description == "":
description = "{}:\n{}".format(translate_("Operator"), function_call)
available_keymaps[sort_key] = {
"name": name,
"refine": refine,
"idname": keymap_item.idname,
"key combo": key_combo,
"modifiers": modifiers,
"function call": function_call,
"function call text": function_call_text,
"description": description,
"alternate keys": "",
"region": keymap.region_type,
"space": keymap.space_type,
"keymap_item": keymap_item,
"op_class": op_class,
"is modal": keymap.is_modal,
"seen": 0,
}
return available_keymaps
# # if the name occurs more than once make a menu flag
# seen[keymap_item.name] = {
# "seen": True,
# "sort_key": sort_key
# }
# scn = False
# if keymap_item.name in seen:
# scn = True
# seen[keymap_item.name] = {
# "seen": True,
# "sort_key": sort_key
# }
def get_biggest_window_dimensions():
width = 0
height = 0
for i in range(len(bpy.context.window_manager.windows)):
old_height = getattr(bpy.context.window_manager.windows[i], 'height')
if old_height > height:
height = old_height
old_width = getattr(bpy.context.window_manager.windows[i], 'width')
if old_width > width:
width = old_width
return [width, height]
# _________________________User Prefs
class ShowShortcutsPrefs(AddonPreferences):
"""User Prefs for Show Shortcuts Popup"""
bl_idname = __name__
filename_ext = ".html"
check_existing = True
out_dir = ""
window_dim = get_biggest_window_dimensions()
# Allow me for my hires screen
import sys
cmd_key = "Cmd"
if sys.platform[:3] == "win":
cmd_key = "Super"
elif sys.platform == "darwin":
cmd_key = "⌘"
if DEBUG:
divisor = 1
else:
divisor = 2
show_run = BoolProperty(
name="Show Run Button",
default=False)
show_function = BoolProperty(
name="Show Operator",
default=DEBUG)
KEYBOARD = BoolProperty(
name="Keyboard",
default=True)
TWEAK = BoolProperty(
name="Tweak",
default=True)
MOUSE = BoolProperty(
name="Mouse:",
default=True)
NDOF = BoolProperty(
name="NDOF Device:",
default=False)
TEXTINPUT = BoolProperty(
name="Text",
default=False)
TIMER = BoolProperty(
name="Timer",
default=False)
show_window = BoolProperty(
name="Window",
default=True)
show_animation = BoolProperty(
name="Animation",
default=DEBUG)
show_markers = BoolProperty(
name="Markers",
default=DEBUG)
show_frames = BoolProperty(
name="Frames",
default=DEBUG)
show_screen = BoolProperty(
name="Screen",
default=DEBUG)
grease_pencil = BoolProperty(
name="Grease Pencil",
default=DEBUG)
popup_width = IntProperty(
name="Width of the box",
default=window_dim[0] // divisor,
min=1,
max=window_dim[0] * 2,
step=10)
info_width = IntProperty(
name="Width of the box",
default=window_dim[0] // 2,
min=1,
max=window_dim[0] * 2,
step=10)
popup_columns = IntProperty(
name="Show column",
default=3 if DEBUG else 2,
min=1,
max=6,
step=1)
characters_per_line = IntProperty(
name="Characters",
default=54,
min=10,
max=180,
step=1)
popup_infill = StringProperty(
name="Button fill character",
default=" ",
maxlen=2)
oskey_text = StringProperty(
name="Command/Super key text.",
default="⌘",
maxlen=15)
ctrl_text = StringProperty(
name="Control",
default="Ctl",
maxlen=15)
shft_text = StringProperty(
name="Shift",
default="Shft",
maxlen=20)
alt_text = StringProperty(
name="Alt",
default="Alt",
maxlen=15)
any_text = StringProperty(
name="Any modifier",
default="Any mod",
maxlen=15)
# numpad_text = StringProperty(
# name="Numpad",
# default="Numpad",
# maxlen=15)
uparrow_text = StringProperty(
name="Up arrow",
default="↑",
maxlen=15)
downarrow_text = StringProperty(
name="Down arrow",
default=" ↓",
maxlen=15)
leftarrow_text = StringProperty(
name="Left arrow",
default="←",
maxlen=15)
rightarrow_text = StringProperty(
name="Right arrow.",
default="→",
maxlen=15)
def draw(self, context):
layout = self.layout
row = layout.row(align=False)
box1 = row.box()
row = box1.row()
row = row.split(.5)
col = row.column()
box = col.box()
box.label(text="Input")
box.prop(self, "KEYBOARD")
box.prop(self, "MOUSE")
box.prop(self, "NDOF")
box.prop(self, "TWEAK")
box.prop(self, "TEXTINPUT")
box = col.box()
box.label(text="Display Settings")
# box.label(text="Preferences")
# box.prop(self, "show_wm")
# box.label(text="Character used to right justify button text.")
# row1= box.row()
# left = row1.split(.8)
# left.label("Maximum 2 characters")
# left.prop(self, "popup_infill", text = "")
box.prop(self, "popup_width", slider=True)
# box.prop(self, "popup_height", slider=True)
box.prop(self, "popup_columns", slider=True)
box = col.box()
box.label(text="Information")
box.prop(self, "info_width", slider=True)
box.prop(self, "characters_per_line", slider=True)
#box.prop(self, "show_run")
box.label(text="Python " + translate_("Tooltip:"))
box.prop(self, "show_function")
box = row.box()
box.label(text="Key")
row = box.row()
left = row.split(.7)
left.label(text="Operating system key pressed")
row = box.row()
left.prop(self, "oskey_text", text="")
left = row.split(.7)
left.label(text="Control key pressed")
left.prop(self, "ctrl_text", text="")
row = box.row()
left = row.split(.7)
left.label(text="Shift key pressed")
left.prop(self, "shft_text", text="")
row = box.row()
left = row.split(.7)
left.label(text="Alt key pressed")
left.prop(self, "alt_text", text="")
row = box.row()
left = row.split(.7)
left.label(text="Any modifier keys pressed")
left.prop(self, "any_text", text="")
# row = box.row()
# left = row.split(.7)
# left.label(text="Numpad")
# left.prop(self, "numpad_text", text="")
row = box.row()
row.label(text="Arrows")
row = box.row()
left = row.split(.7)
left.label(text=" " + translate_("Up"))
left.prop(self, "uparrow_text", text="")
row = box.row()
left = row.split(.7)
left.label(text=" " + translate_("Down"))
left.prop(self, "downarrow_text", text="")
row = box.row()
left = row.split(.7)
left.label(text=" " + translate_("Left"))
left.prop(self, "leftarrow_text", text="")
row = box.row()
left = row.split(.7)
left.label(text=" " + translate_("Right"))
left.prop(self, "rightarrow_text", text="")
box = box.box()
box.label(text="Show:")
row = box.row()
row.prop(self, "show_window")