2.6 Python UI files:
[blender.git] / release / scripts / startup / bl_ui / space_userpref_keymap.py
1 # ##### BEGIN GPL LICENSE BLOCK #####
2 #
3 #  This program is free software; you can redistribute it and/or
4 #  modify it under the terms of the GNU General Public License
5 #  as published by the Free Software Foundation; either version 2
6 #  of the License, or (at your option) any later version.
7 #
8 #  This program is distributed in the hope that it will be useful,
9 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
10 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 #  GNU General Public License for more details.
12 #
13 #  You should have received a copy of the GNU General Public License
14 #  along with this program; if not, write to the Free Software Foundation,
15 #  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 #
17 # ##### END GPL LICENSE BLOCK #####
18
19 # <pep8 compliant>
20 import bpy
21 from bpy.types import Menu, OperatorProperties
22 import os
23
24
25 KM_HIERARCHY = [
26     ('Window', 'EMPTY', 'WINDOW', []),  # file save, window change, exit
27     ('Screen', 'EMPTY', 'WINDOW', [     # full screen, undo, screenshot
28         ('Screen Editing', 'EMPTY', 'WINDOW', []),    # resizing, action corners
29         ]),
30
31     ('View2D', 'EMPTY', 'WINDOW', []),    # view 2d navigation (per region)
32     ('View2D Buttons List', 'EMPTY', 'WINDOW', []),  # view 2d with buttons navigation
33     ('Header', 'EMPTY', 'WINDOW', []),    # header stuff (per region)
34     ('Grease Pencil', 'EMPTY', 'WINDOW', []),  # grease pencil stuff (per region)
35
36     ('3D View', 'VIEW_3D', 'WINDOW', [  # view 3d navigation and generic stuff (select, transform)
37         ('Object Mode', 'EMPTY', 'WINDOW', []),
38         ('Mesh', 'EMPTY', 'WINDOW', []),
39         ('Curve', 'EMPTY', 'WINDOW', []),
40         ('Armature', 'EMPTY', 'WINDOW', []),
41         ('Metaball', 'EMPTY', 'WINDOW', []),
42         ('Lattice', 'EMPTY', 'WINDOW', []),
43         ('Font', 'EMPTY', 'WINDOW', []),
44
45         ('Pose', 'EMPTY', 'WINDOW', []),
46
47         ('Vertex Paint', 'EMPTY', 'WINDOW', []),
48         ('Weight Paint', 'EMPTY', 'WINDOW', []),
49         ('Face Mask', 'EMPTY', 'WINDOW', []),
50         ('Image Paint', 'EMPTY', 'WINDOW', []),  # image and view3d
51         ('Sculpt', 'EMPTY', 'WINDOW', []),
52
53         ('Armature Sketch', 'EMPTY', 'WINDOW', []),
54         ('Particle', 'EMPTY', 'WINDOW', []),
55
56         ('Object Non-modal', 'EMPTY', 'WINDOW', []),  # mode change
57
58         ('3D View Generic', 'VIEW_3D', 'WINDOW', [])    # toolbar and properties
59         ]),
60
61     ('Frames', 'EMPTY', 'WINDOW', []),    # frame navigation (per region)
62     ('Markers', 'EMPTY', 'WINDOW', []),    # markers (per region)
63     ('Animation', 'EMPTY', 'WINDOW', []),    # frame change on click, preview range (per region)
64     ('Animation Channels', 'EMPTY', 'WINDOW', []),
65     ('Graph Editor', 'GRAPH_EDITOR', 'WINDOW', [
66         ('Graph Editor Generic', 'GRAPH_EDITOR', 'WINDOW', [])
67         ]),
68     ('Dopesheet', 'DOPESHEET_EDITOR', 'WINDOW', []),
69     ('NLA Editor', 'NLA_EDITOR', 'WINDOW', [
70         ('NLA Channels', 'NLA_EDITOR', 'WINDOW', []),
71         ('NLA Generic', 'NLA_EDITOR', 'WINDOW', [])
72         ]),
73
74     ('Image', 'IMAGE_EDITOR', 'WINDOW', [
75         ('UV Editor', 'EMPTY', 'WINDOW', []),  # image (reverse order, UVEdit before Image
76         ('Image Paint', 'EMPTY', 'WINDOW', []),  # image and view3d
77         ('Image Generic', 'IMAGE_EDITOR', 'WINDOW', [])
78         ]),
79
80     ('Timeline', 'TIMELINE', 'WINDOW', []),
81     ('Outliner', 'OUTLINER', 'WINDOW', []),
82
83     ('Node Editor', 'NODE_EDITOR', 'WINDOW', [
84         ('Node Generic', 'NODE_EDITOR', 'WINDOW', [])
85         ]),
86     ('Sequencer', 'SEQUENCE_EDITOR', 'WINDOW', []),
87     ('Logic Editor', 'LOGIC_EDITOR', 'WINDOW', []),
88
89     ('File Browser', 'FILE_BROWSER', 'WINDOW', [
90         ('File Browser Main', 'FILE_BROWSER', 'WINDOW', []),
91         ('File Browser Buttons', 'FILE_BROWSER', 'WINDOW', [])
92         ]),
93
94     ('Property Editor', 'PROPERTIES', 'WINDOW', []),  # align context menu
95
96     ('Script', 'SCRIPTS_WINDOW', 'WINDOW', []),
97     ('Text', 'TEXT_EDITOR', 'WINDOW', []),
98     ('Console', 'CONSOLE', 'WINDOW', []),
99
100     ('View3D Gesture Circle', 'EMPTY', 'WINDOW', []),
101     ('Gesture Border', 'EMPTY', 'WINDOW', []),
102     ('Standard Modal Map', 'EMPTY', 'WINDOW', []),
103     ('Transform Modal Map', 'EMPTY', 'WINDOW', []),
104     ('View3D Fly Modal', 'EMPTY', 'WINDOW', []),
105     ('View3D Rotate Modal', 'EMPTY', 'WINDOW', []),
106     ('View3D Move Modal', 'EMPTY', 'WINDOW', []),
107     ('View3D Zoom Modal', 'EMPTY', 'WINDOW', []),
108     ]
109
110
111 def _km_exists_in(km, export_keymaps):
112     for km2, kc in export_keymaps:
113         if km2.name == km.name:
114             return True
115     return False
116
117
118 def _merge_keymaps(kc1, kc2):
119     """ note: kc1 takes priority over kc2
120     """
121     merged_keymaps = [(km, kc1) for km in kc1.keymaps]
122     if kc1 != kc2:
123         merged_keymaps.extend((km, kc2) for km in kc2.keymaps if not _km_exists_in(km, merged_keymaps))
124
125     return merged_keymaps
126
127
128 class USERPREF_MT_keyconfigs(Menu):
129     bl_label = "KeyPresets"
130     preset_subdir = "keyconfig"
131     preset_operator = "wm.keyconfig_activate"
132
133     def draw(self, context):
134         props = self.layout.operator("wm.context_set_value", text="Blender (default)")
135         props.data_path = "window_manager.keyconfigs.active"
136         props.value = "context.window_manager.keyconfigs.default"
137
138         # now draw the presets
139         Menu.draw_preset(self, context)
140
141
142 class InputKeyMapPanel:
143     bl_space_type = 'USER_PREFERENCES'
144     bl_label = "Input"
145     bl_region_type = 'WINDOW'
146     bl_options = {'HIDE_HEADER'}
147
148     def draw_entry(self, display_keymaps, entry, col, level=0):
149         idname, spaceid, regionid, children = entry
150
151         for km, kc in display_keymaps:
152             if km.name == idname and km.space_type == spaceid and km.region_type == regionid:
153                 self.draw_km(display_keymaps, kc, km, children, col, level)
154
155         '''
156         km = kc.keymaps.find(idname, space_type=spaceid, region_type=regionid)
157         if not km:
158             kc = defkc
159             km = kc.keymaps.find(idname, space_type=spaceid, region_type=regionid)
160
161         if km:
162             self.draw_km(kc, km, children, col, level)
163         '''
164
165     def indented_layout(self, layout, level):
166         indentpx = 16
167         if level == 0:
168             level = 0.0001   # Tweak so that a percentage of 0 won't split by half
169         indent = level * indentpx / bpy.context.region.width
170
171         split = layout.split(percentage=indent)
172         col = split.column()
173         col = split.column()
174         return col
175
176     def draw_km(self, display_keymaps, kc, km, children, layout, level):
177         km = km.active()
178
179         layout.context_pointer_set("keymap", km)
180
181         col = self.indented_layout(layout, level)
182
183         row = col.row()
184         row.prop(km, "show_expanded_children", text="", emboss=False)
185         row.label(text=km.name)
186
187         row.label()
188         row.label()
189
190         if km.is_modal:
191             row.label(text="", icon='LINKED')
192         if km.is_user_modified:
193             row.operator("wm.keymap_restore", text="Restore")
194         else:
195             row.label()
196
197         if km.show_expanded_children:
198             if children:
199                 # Put the Parent key map's entries in a 'global' sub-category
200                 # equal in hierarchy to the other children categories
201                 subcol = self.indented_layout(col, level + 1)
202                 subrow = subcol.row()
203                 subrow.prop(km, "show_expanded_items", text="", emboss=False)
204                 subrow.label(text="%s " % km.name + "(Global)")
205             else:
206                 km.show_expanded_items = True
207
208             # Key Map items
209             if km.show_expanded_items:
210                 for kmi in km.keymap_items:
211                     self.draw_kmi(display_keymaps, kc, km, kmi, col, level + 1)
212
213                 # "Add New" at end of keymap item list
214                 col = self.indented_layout(col, level + 1)
215                 subcol = col.split(percentage=0.2).column()
216                 subcol.operator("wm.keyitem_add", text="Add New", icon='ZOOMIN')
217
218             col.separator()
219
220             # Child key maps
221             if children:
222                 subcol = col.column()
223                 row = subcol.row()
224
225                 for entry in children:
226                     self.draw_entry(display_keymaps, entry, col, level + 1)
227
228     @staticmethod
229     def draw_kmi_properties(box, properties, title=None):
230         box.separator()
231         if title:
232             box.label(text=title)
233         flow = box.column_flow(columns=2)
234         for pname, value in properties.bl_rna.properties.items():
235             if pname != "rna_type" and not properties.is_property_hidden(pname):
236                 if isinstance(value, OperatorProperties):
237                     InputKeyMapPanel.draw_kmi_properties(box, value, title=pname)
238                 else:
239                     flow.prop(properties, pname)
240
241     def draw_kmi(self, display_keymaps, kc, km, kmi, layout, level):
242         map_type = kmi.map_type
243
244         col = self.indented_layout(layout, level)
245
246         if kmi.show_expanded:
247             col = col.column(align=True)
248             box = col.box()
249         else:
250             box = col.column()
251
252         split = box.split(percentage=0.05)
253
254         # header bar
255         row = split.row()
256         row.prop(kmi, "show_expanded", text="", emboss=False)
257
258         row = split.row()
259         row.prop(kmi, "active", text="", emboss=False)
260
261         if km.is_modal:
262             row.prop(kmi, "propvalue", text="")
263         else:
264             row.label(text=kmi.name)
265
266         row = split.row()
267         row.prop(kmi, "map_type", text="")
268         if map_type == 'KEYBOARD':
269             row.prop(kmi, "type", text="", full_event=True)
270         elif map_type == 'MOUSE':
271             row.prop(kmi, "type", text="", full_event=True)
272         elif map_type == 'NDOF':
273             row.prop(kmi, "type", text="", full_event=True)
274         elif map_type == 'TWEAK':
275             subrow = row.row()
276             subrow.prop(kmi, "type", text="")
277             subrow.prop(kmi, "value", text="")
278         elif map_type == 'TIMER':
279             row.prop(kmi, "type", text="")
280         else:
281             row.label()
282
283         if (not kmi.is_user_defined) and kmi.is_user_modified:
284             op = row.operator("wm.keyitem_restore", text="", icon='BACK')
285             op.item_id = kmi.id
286         else:
287             op = row.operator("wm.keyitem_remove", text="", icon='X')
288             op.item_id = kmi.id
289
290         # Expanded, additional event settings
291         if kmi.show_expanded:
292             box = col.box()
293
294             if map_type not in {'TEXTINPUT', 'TIMER'}:
295                 split = box.split(percentage=0.4)
296                 sub = split.row()
297
298                 if km.is_modal:
299                     sub.prop(kmi, "propvalue", text="")
300                 else:
301                     # One day...
302                     # sub.prop_search(kmi, "idname", bpy.context.window_manager, "operators_all", text="")
303                     sub.prop(kmi, "idname", text="")
304
305                 sub = split.column()
306                 subrow = sub.row(align=True)
307
308                 if map_type in {'KEYBOARD', 'NDOF'}:
309                     subrow.prop(kmi, "type", text="", event=True)
310                     subrow.prop(kmi, "value", text="")
311                 elif map_type == 'MOUSE':
312                     subrow.prop(kmi, "type", text="")
313                     subrow.prop(kmi, "value", text="")
314
315                 subrow = sub.row()
316                 subrow.scale_x = 0.75
317                 subrow.prop(kmi, "any")
318                 subrow.prop(kmi, "shift")
319                 subrow.prop(kmi, "ctrl")
320                 subrow.prop(kmi, "alt")
321                 subrow.prop(kmi, "oskey", text="Cmd")
322                 subrow.prop(kmi, "key_modifier", text="", event=True)
323
324             # Operator properties
325             props = kmi.properties
326             if props is not None:
327                 InputKeyMapPanel.draw_kmi_properties(box, props)
328
329             # Modal key maps attached to this operator
330             if not km.is_modal:
331                 kmm = kc.keymaps.find_modal(kmi.idname)
332                 if kmm:
333                     self.draw_km(display_keymaps, kc, kmm, None, layout, level + 1)
334                     layout.context_pointer_set("keymap", km)
335
336     def draw_filtered(self, display_keymaps, filter_text, layout):
337         for km, kc in display_keymaps:
338             km = km.active()
339             layout.context_pointer_set("keymap", km)
340
341             filtered_items = [kmi for kmi in km.keymap_items if filter_text in kmi.name.lower()]
342
343             if len(filtered_items) != 0:
344                 col = layout.column()
345
346                 row = col.row()
347                 row.label(text=km.name, icon="DOT")
348
349                 row.label()
350                 row.label()
351
352                 if km.is_user_modified:
353                     row.operator("wm.keymap_restore", text="Restore")
354                 else:
355                     row.label()
356
357                 for kmi in filtered_items:
358                     self.draw_kmi(display_keymaps, kc, km, kmi, col, 1)
359
360                 # "Add New" at end of keymap item list
361                 col = self.indented_layout(layout, 1)
362                 subcol = col.split(percentage=0.2).column()
363                 subcol.operator("wm.keyitem_add", text="Add New", icon='ZOOMIN')
364
365     def draw_hierarchy(self, display_keymaps, layout):
366         for entry in KM_HIERARCHY:
367             self.draw_entry(display_keymaps, entry, layout)
368
369     def draw_keymaps(self, context, layout):
370         wm = context.window_manager
371         kc = wm.keyconfigs.user
372
373         col = layout.column()
374         sub = col.column()
375
376         subsplit = sub.split()
377         subcol = subsplit.column()
378
379         row = subcol.row(align=True)
380
381         #row.prop_search(wm.keyconfigs, "active", wm, "keyconfigs", text="Key Config:")
382         text = bpy.path.display_name(context.window_manager.keyconfigs.active.name)
383         if not text:
384             text = "Blender (default)"
385         row.menu("USERPREF_MT_keyconfigs", text=text)
386         row.operator("wm.keyconfig_preset_add", text="", icon="ZOOMIN")
387         row.operator("wm.keyconfig_preset_add", text="", icon="ZOOMOUT").remove_active = True
388
389 #        layout.context_pointer_set("keyconfig", wm.keyconfigs.active)
390 #        row.operator("wm.keyconfig_remove", text="", icon='X')
391
392         row.prop(context.space_data, "filter_text", icon="VIEWZOOM")
393
394         col.separator()
395
396         display_keymaps = _merge_keymaps(kc, kc)
397         if context.space_data.filter_text != "":
398             filter_text = context.space_data.filter_text.lower()
399             self.draw_filtered(display_keymaps, filter_text, col)
400         else:
401             self.draw_hierarchy(display_keymaps, col)
402
403
404 def export_properties(prefix, properties, lines=None):
405     if lines is None:
406         lines = []
407
408     for pname in properties.bl_rna.properties.keys():
409         if pname != "rna_type" and not properties.is_property_hidden(pname):
410             value = getattr(properties, pname)
411             if isinstance(value, OperatorProperties):
412                 export_properties(prefix + "." + pname, value, lines)
413             elif properties.is_property_set(pname):
414                 value = _string_value(value)
415                 if value != "":
416                     lines.append("%s.%s = %s\n" % (prefix, pname, value))
417     return lines
418
419 if __name__ == "__main__":  # only for live edit.
420     bpy.utils.register_module(__name__)