[ikhal] add option to disable mouse, fixes pimutils#1289

This is done by passing the `handle_mouse` Boolean argument to urwid's
main loop (currently unused). By default, the mouse remains enabled
(see `khal.spec`). Mouse can be disabled either by setting
`enable_mouse = False` in the `[default]` section of khal's config
file, or by passing the `--no-mouse` flag to the `khal interactive` or
`ikhal` click commands.

.gitignore

@@ -19,3 +19,4 @@ env/
 venv/
 .hypothesis/
 .python-version
+.dmypy.json

khal.conf.sample

@@ -30,3 +30,4 @@ monthdisplay = firstday
 default_calendar = home
 timedelta = 2d # the default timedelta that list uses
 highlight_event_days = True  # the default is False
+enable_mouse = True  # mouse is enabled by default in interactive mode

khal/cli.py

@@ -93,6 +93,12 @@ def multi_calendar_option(f):
     return d(a(f))
 
 
+def no_mouse_option(f):
+    o = click.option('--no-mouse', is_flag=True,
+                     help='Disable mouse in interactive UI')
+    return o(f)
+
+
 def _select_one_calendar_callback(ctx, option, calendar):
     if isinstance(calendar, tuple):
         if len(calendar) > 1:
@@ -480,9 +486,12 @@ def isatty(_file):
 
     @cli.command()
     @multi_calendar_option
+    @no_mouse_option
     @click.pass_context
-    def interactive(ctx, include_calendar, exclude_calendar):
+    def interactive(ctx, include_calendar, exclude_calendar, no_mouse):
         '''Interactive UI. Also launchable via `ikhal`.'''
+        if no_mouse:
+            ctx.obj['conf']['default']['enable_mouse'] = False
         controllers.interactive(
             build_collection(
                 ctx.obj['conf'],
@@ -494,10 +503,13 @@ def interactive(ctx, include_calendar, exclude_calendar):
     @click.command()
     @global_options
     @multi_calendar_option
+    @no_mouse_option
     @click.pass_context
-    def interactive_cli(ctx, config, include_calendar, exclude_calendar):
+    def interactive_cli(ctx, config, include_calendar, exclude_calendar, no_mouse):
         '''Interactive UI. Also launchable via `khal interactive`.'''
         prepare_context(ctx, config)
+        if no_mouse:
+            ctx.obj['conf']['default']['enable_mouse'] = False
         controllers.interactive(
             build_collection(
                 ctx.obj['conf'],

khal/settings/khal.spec

@@ -216,6 +216,10 @@ default_event_duration = timedelta(default='1d')
 # Define the default duration for an event ('khal new' only)
 default_dayevent_duration = timedelta(default='1h')
 
+# Whether the mouse should be enabled in interactive mode ('khal interactive' and
+# 'ikhal' only)
+enable_mouse = boolean(default=True)
+
 
 # The view section contains configuration options that effect the visual appearance
 # when using khal and ikhal.

khal/ui/__init__.py

@@ -1344,7 +1344,12 @@ def emit(self, record):
     palette = _add_calendar_colors(
         getattr(colors, pane._conf['view']['theme']), pane.collection)
     loop = urwid.MainLoop(
-        frame, palette, unhandled_input=frame.on_key_press, pop_ups=True)
+        widget=frame,
+        palette=palette,
+        unhandled_input=frame.on_key_press,
+        pop_ups=True,
+        handle_mouse=pane._conf['default']['enable_mouse'],
+    )
     frame.loop = loop
 
     def redraw_today(loop, pane, meta=None):