From 334f3bf27ebf63f7480f19be42ff0384f643e7ce Mon Sep 17 00:00:00 2001
From: Jente Hidskes <hjdskes@gmail.com>
Date: Thu, 20 Jul 2017 17:08:31 +0200
Subject: [PATCH] ButtonDialog: add special mapping page

---
 data/ui/ButtonDialog.ui | 152 ++++++++++++++++++++++++++++++++++++++--
 piper/buttondialog.py   |  22 ++++++
 piper/buttonspage.py    |   2 +
 3 files changed, 172 insertions(+), 4 deletions(-)

diff --git a/data/ui/ButtonDialog.ui b/data/ui/ButtonDialog.ui
index f830185..2de332c 100644
--- a/data/ui/ButtonDialog.ui
+++ b/data/ui/ButtonDialog.ui
@@ -2,6 +2,92 @@
 <!-- Generated with glade 3.20.0 -->
 <interface>
   <requires lib="gtk+" version="3.20"/>
+  <object class="GtkListStore" id="liststore_special">
+    <columns>
+      <!-- column-name id, MUST be synced with RatbagdButton.ACTION_SPECIAL_* -->
+      <column type="gint"/>
+      <!-- column-name name -->
+      <column type="gchararray"/>
+    </columns>
+    <data>
+      <row>
+        <col id="0">1073741824</col>
+        <col id="1" translatable="yes">Unknown</col>
+      </row>
+      <row>
+        <col id="0">1073741825</col>
+        <col id="1" translatable="yes">Doubleclick</col>
+      </row>
+      <row>
+        <col id="0">1073741825</col>
+        <col id="1" translatable="yes">Wheel Left</col>
+      </row>
+      <row>
+        <col id="0">1073741826</col>
+        <col id="1" translatable="yes">Wheel Right</col>
+      </row>
+      <row>
+        <col id="0">1073741827</col>
+        <col id="1" translatable="yes">Wheel Up</col>
+      </row>
+      <row>
+        <col id="0">1073741828</col>
+        <col id="1" translatable="yes">Wheel Down</col>
+      </row>
+      <row>
+        <col id="0">1073741829</col>
+        <col id="1" translatable="yes">Ratchet Mode Switch</col>
+      </row>
+      <row>
+        <col id="0">1073741830</col>
+        <col id="1" translatable="yes">Resolution Cycle Up</col>
+      </row>
+      <row>
+        <col id="0">1073741831</col>
+        <col id="1" translatable="yes">Resolution Cycle Down</col>
+      </row>
+      <row>
+        <col id="0">1073741832</col>
+        <col id="1" translatable="yes">Resolution Up</col>
+      </row>
+      <row>
+        <col id="0">1073741833</col>
+        <col id="1" translatable="yes">Resolution Down</col>
+      </row>
+      <row>
+        <col id="0">1073741834</col>
+        <col id="1" translatable="yes">Resolution Switch</col>
+      </row>
+      <row>
+        <col id="0">1073741835</col>
+        <col id="1" translatable="yes">Resolution Default</col>
+      </row>
+      <row>
+        <col id="0">1073741836</col>
+        <col id="1" translatable="yes">Profile Cycle Up</col>
+      </row>
+      <row>
+        <col id="0">1073741837</col>
+        <col id="1" translatable="yes">Profile Cycle Down</col>
+      </row>
+      <row>
+        <col id="0">1073741838</col>
+        <col id="1" translatable="yes">Profile Up</col>
+      </row>
+      <row>
+        <col id="0">1073741839</col>
+        <col id="1" translatable="yes">Profile Down</col>
+      </row>
+      <row>
+        <col id="0">1073741840</col>
+        <col id="1" translatable="yes">Second Mode</col>
+      </row>
+      <row>
+        <col id="0">1073741841</col>
+        <col id="1" translatable="yes">Battery Level</col>
+      </row>
+    </data>
+  </object>
   <template class="ButtonDialog" parent="GtkDialog">
     <property name="width_request">400</property>
     <property name="height_request">300</property>
@@ -252,15 +338,73 @@ a click on the right mouse button.</property>
                 <property name="can_focus">False</property>
                 <property name="orientation">vertical</property>
                 <child>
-                  <placeholder/>
+                  <object class="GtkLabel">
+                    <property name="visible">True</property>
+                    <property name="can_focus">False</property>
+                    <property name="label" translatable="yes">Custom mappings allow you to assign to a physical mouse button a mouse-specific function.
+This way you may for example switch between resolutions or profiles.</property>
+                    <property name="justify">center</property>
+                    <property name="wrap">True</property>
+                    <property name="track_visited_links">False</property>
+                  </object>
+                  <packing>
+                    <property name="expand">True</property>
+                    <property name="fill">True</property>
+                    <property name="position">0</property>
+                  </packing>
                 </child>
                 <child>
-                  <placeholder/>
+                  <object class="GtkBox">
+                    <property name="visible">True</property>
+                    <property name="can_focus">False</property>
+                    <child>
+                      <object class="GtkComboBox" id="combo_special">
+                        <property name="visible">True</property>
+                        <property name="can_focus">False</property>
+                        <property name="tooltip_text" translatable="yes">Assign a mouse-specific function to this button</property>
+                        <property name="model">liststore_special</property>
+                        <property name="has_entry">True</property>
+                        <property name="entry_text_column">1</property>
+                        <property name="id_column">0</property>
+                        <signal name="changed" handler="_on_special_changed" swapped="no"/>
+                        <child internal-child="entry">
+                          <object class="GtkEntry">
+                            <property name="can_focus">False</property>
+                          </object>
+                        </child>
+                      </object>
+                      <packing>
+                        <property name="expand">False</property>
+                        <property name="fill">True</property>
+                        <property name="pack_type">end</property>
+                        <property name="position">0</property>
+                      </packing>
+                    </child>
+                    <child>
+                      <object class="GtkLabel">
+                        <property name="visible">True</property>
+                        <property name="can_focus">False</property>
+                        <property name="halign">start</property>
+                        <property name="label" translatable="yes">Assign a custom mapping:</property>
+                        <property name="track_visited_links">False</property>
+                      </object>
+                      <packing>
+                        <property name="expand">False</property>
+                        <property name="fill">True</property>
+                        <property name="position">1</property>
+                      </packing>
+                    </child>
+                  </object>
+                  <packing>
+                    <property name="expand">False</property>
+                    <property name="fill">True</property>
+                    <property name="position">1</property>
+                  </packing>
                 </child>
               </object>
               <packing>
                 <property name="name">special</property>
-                <property name="title" translatable="yes">Key Sequence</property>
+                <property name="title" translatable="yes">Special</property>
                 <property name="position">1</property>
               </packing>
             </child>
@@ -277,7 +421,7 @@ a click on the right mouse button.</property>
               </object>
               <packing>
                 <property name="name">macro</property>
-                <property name="title" translatable="yes">Custom</property>
+                <property name="title" translatable="yes">Macro</property>
                 <property name="position">2</property>
               </packing>
             </child>
diff --git a/piper/buttondialog.py b/piper/buttondialog.py
index fafad58..52e3b0b 100644
--- a/piper/buttondialog.py
+++ b/piper/buttondialog.py
@@ -62,6 +62,7 @@ class ButtonDialog(Gtk.Dialog):
     stack_mapping = GtkTemplate.Child()
     label_keystroke = GtkTemplate.Child()
     label_preview = GtkTemplate.Child()
+    combo_special = GtkTemplate.Child()
 
     def __init__(self, ratbagd_button, buttons, *args, **kwargs):
         """Instantiates a new ButtonDialog.
@@ -77,8 +78,10 @@ class ButtonDialog(Gtk.Dialog):
         self._action_type = self._button.action_type
         self._button_mapping = ratbagd_button.mapping
         self._key_mapping = ratbagd_button.key
+        self._special_mapping = ratbagd_button.special
 
         self._init_mapping_page(buttons)
+        self._init_special_page()
         self._activate_current_page()
 
     def _activate_current_page(self):
@@ -108,6 +111,10 @@ class ButtonDialog(Gtk.Dialog):
             keys = self._button.key
             self._keystroke.set_from_evdev(keys[0], keys[1:])
 
+    def _init_special_page(self):
+        if self._button.type == RatbagdButton.ACTION_TYPE_SPECIAL:
+            self.combo_special.set_active_id(self._special_mapping)
+
     def _get_button_key_and_name(self, button):
         if button.index in RatbagdButton.BUTTON_DESCRIPTION:
             name = RatbagdButton.BUTTON_DESCRIPTION[button.index]
@@ -215,6 +222,17 @@ class ButtonDialog(Gtk.Dialog):
             self._button_mapping = mapping
             self._action_type = RatbagdButton.ACTION_TYPE_BUTTON
 
+    @GtkTemplate.Callback
+    def _on_special_changed(self, combo):
+        tree_iter = combo.get_active_iter()
+        if tree_iter is None:
+            return
+        model = combo.get_model()
+        mapping = model[tree_iter][0]
+        if mapping != self._special_mapping:
+            self._special_mapping = mapping
+            self._action_type = RatbagdButton.ACTION_TYPE_SPECIAL
+
     @GtkTemplate.Callback
     def _on_capture_keystroke_clicked(self, button):
         # Switches to the capture stack page and grabs the keyboard seat to
@@ -235,3 +253,7 @@ class ButtonDialog(Gtk.Dialog):
     @GObject.Property
     def key_mapping(self):
         return self._key_mapping
+
+    @GObject.Property
+    def special_mapping(self):
+        return self._special_mapping
diff --git a/piper/buttonspage.py b/piper/buttonspage.py
index 143aed9..4ab1451 100644
--- a/piper/buttonspage.py
+++ b/piper/buttonspage.py
@@ -72,6 +72,8 @@ class ButtonsPage(Gtk.Box):
                 ratbagd_button.mapping = dialog.button_mapping
             elif dialog.action_type == RatbagdButton.ACTION_TYPE_KEY:
                 ratbagd_button.key = dialog.key_mapping
+            elif dialog.action_type == RatbagdButton.ACTION_TYPE_SPECIAL:
+                ratbagd_button.special = dialog.special_mapping
         dialog.destroy()
 
     def _find_active_profile(self):