Implemented toolbar button. Closes #40.

chrome.manifest.pack

@@ -1,6 +1,7 @@
 content	keysnail	jar:chrome/keysnail.jar!/content/keysnail
 
 skin	keysnail	classic/1.0	jar:chrome/keysnail.jar!/skin/classic/keysnail/
+style	chrome://global/content/customizeToolbar.xul	chrome://keysnail/skin/css/toolbar-button.css
 
 locale	keysnail	en-US	jar:chrome/keysnail.jar!/locale/en-US/
 locale	keysnail	ja	jar:chrome/keysnail.jar!/locale/ja/

content/browser.xul

@@ -2,10 +2,48 @@
 
 <?xml-stylesheet href="chrome://global/skin/global.css" type="text/css"?>
 <?xml-stylesheet href="chrome://keysnail/skin/css/prompt.css" type="text/css"?>
+<?xml-stylesheet href="chrome://keysnail/skin/css/toolbar-button.css" type="text/css"?>
 
 <!DOCTYPE dialog SYSTEM "chrome://keysnail/locale/statusbar.dtd">
 
 <overlay xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul">
+    <toolbarpalette id="BrowserToolbarPalette">
+        <toolbarbutton id="keysnail-toolbar-button"
+                       class="toolbarbutton-1"
+                       type="menu-button"
+                       label="KeySnail"
+                       tooltiptext="KeySnail"
+                       oncommand="if (event.target === this) KeySnail.modules.key.toggleStatus();">
+            <menupopup onpopupshowing="KeySnail.modules.key.updateToolbarButtonMenu();">
+	        <menuitem id="keysnail-toolbar-button-status"
+                          label="&keySnail.statusbar.isEnabled;"
+                          accesskey="t"
+                          type="checkbox"
+		          oncommand="KeySnail.modules.key.toggleStatus();" />
+	        <menuitem label="&keySnail.statusbar.openPreference;"
+                          accesskey="c"
+	                  oncommand="KeySnail.openPreference();" />
+	        <menuitem label="&keySnail.statusbar.openPluginManager;"
+	                  accesskey="o"
+	                  oncommand="KeySnail.modules.userscript.openPluginManager();" />
+                <menuseparator/>
+	        <menuitem label="&keySnail.statusbar.reloadUserScript;"
+                          accesskey="r"
+		          oncommand="KeySnail.modules.userscript.reload();" />
+	        <menuitem label="&keySnail.statusbar.listKeyBindings;"
+                          accesskey="v"
+		          oncommand="KeySnail.modules.key.listKeyBindings();" />
+                <menuseparator/>
+	        <menuitem label="&keySnail.statusbar.editInitFile;"
+                          accesskey="e"
+	                  oncommand="KeySnail.modules.userscript.editInitFile();" />
+	        <menuitem label="&keySnail.statusbar.wizard;"
+                          accesskey="w"
+	                  oncommand="KeySnail.modules.userscript.beginRcFileWizard();" />
+            </menupopup>
+        </toolbarbutton>
+    </toolbarpalette>
+
     <!-- tool menu -->
     <menupopup id="menu_ToolsPopup">
         <menu id="keysnail-tool-menu"

content/keysnail.js

@@ -134,7 +134,7 @@
             // main-window specific settings
             if (this.isMainWindow) {
                 this.settingsForBrowserWindow();
-                key.updateStatusBar();
+                key.updateStatusDisplay();
             }
 
             document.addEventListener("copy", function () { command.clipboardChanged(); }, true);

content/modules/key.js

@@ -164,32 +164,23 @@ const key = {
      * toggle current keyhandler status
      * when init file is not loaded, reject
      */
-    toggleStatus: function () {
+    toggleStatus: function (elem) {
+        let name = elem ? elem.localName : "<not given>";
+        util.message("toggleStatus called " + this.status + " " + name);
+
         if (this.status)
-        {
             this.stop();
-        }
-        else
-        {
+        else {
             if (!userscript.initFileLoaded)
-            {
-                // load init file
                 userscript.load();
-            }
+
             if (!userscript.initFileLoaded)
-            {
-                // Failed to load init file
-                // display.notify(util.getLocaleString("noUserScriptLoaded"));
                 this.status = false;
-            }
             else
-            {
                 this.run();
-            }
         }
 
-        this.updateMenu();
-        this.updateStatusBar();
+        key.updateStatusDisplay();
     },
 
     /**
@@ -213,41 +204,68 @@ const key = {
             this.suspended = false;
         }
 
-        this.updateStatusBar();
+        this.updateStatusDisplay();
     },
 
     // }} ======================================================================= //
 
     // Update GUI {{ ============================================================ //
 
+    STATUSES: {
+        ENABLED: "enabled",
+        DISABLED: "disabled",
+        SUSPENDED: "suspended"
+    },
+
+    get statusString() {
+        if (!this.status)
+            return this.STATUSES.DISABLED;
+        if (this.suspended)
+            return this.STATUSES.SUSPENDED;
+        return this.STATUSES.ENABLED;
+    },
+
+    updateStatusDisplay: function () {
+        this.updateMenu();
+        this.updateToolbarButton();
+        this.updateStatusBar();
+    },
+
+    updateToolbarButton: function () {
+        let button = document.getElementById("keysnail-toolbar-button");
+        if (!button)
+            return;
+
+        button.setAttribute("data-ks-status", this.statusString);
+    },
+
     /**
      * update the status bar icon
      */
     updateStatusBar: function () {
-        var icon = document.getElementById("keysnail-statusbar-icon");
+        let icon = document.getElementById("keysnail-statusbar-icon");
         if (!icon)
             return;
 
-        if (this.status)
-        {
-            // enabled
-            if (this.suspended)
-            {
-                icon.src = "chrome://keysnail/skin/icon16suspended.png";
-                icon.tooltipText = util.getLocaleString("keySnailSuspended");
-            }
-            else
-            {
-                icon.src = "chrome://keysnail/skin/icon16.png";
-                icon.tooltipText = util.getLocaleString("keySnailEnabled");
-            }
-        }
-        else
-        {
-            // disabled
-            icon.src = "chrome://keysnail/skin/icon16gray.png";
-            icon.tooltipText = util.getLocaleString("keySnailDisabled");
+        let src, tooltip;
+
+        switch (this.statusString) {
+        case this.STATUSES.ENABLED:
+            src = "chrome://keysnail/skin/icon16.png";
+            tooltip = util.getLocaleString("keySnailEnabled");
+            break;
+        case this.STATUSES.DISABLED:
+            src = "chrome://keysnail/skin/icon16gray.png";
+            tooltip = util.getLocaleString("keySnailDisabled");
+            break;
+        default:
+            src = "chrome://keysnail/skin/icon16suspended.png";
+            tooltip = util.getLocaleString("keySnailSuspended");
+            break;
         }
+
+        icon.src = src;
+        icon.tooltipText = tooltip;
     },
 
     /**
@@ -262,7 +280,7 @@ const key = {
     },
 
     /**
-     * update the tool box menu
+     * update the tool box menu (from onpopupshowing)
      */
     updateToolMenu: function () {
         var checkbox = document.getElementById("keysnail-tool-menu-status");
@@ -272,6 +290,17 @@ const key = {
         checkbox.setAttribute('checked', this.status);
     },
 
+    /**
+     * update the toolbar button menu (from onpopupshowing)
+     */
+    updateToolbarButtonMenu: function () {
+        var checkbox = document.getElementById("keysnail-toolbar-button-status");
+        if (!checkbox)
+            return;
+
+        checkbox.setAttribute('checked', this.status);
+    },
+
     // }} ======================================================================= //
 
     // Mode {{ ================================================================== //
@@ -411,7 +440,7 @@ const key = {
         {
             util.stopEventPropagation(aEvent);
             this.suspended = !this.suspended;
-            this.updateStatusBar();
+            this.updateStatusDisplay();
             this.backToNeutral("Suspension switched", 1000);
             return;
         }

content/modules/userscript.js

@@ -263,8 +263,7 @@ const userscript = {
             this.initFileLoaded = false;
 
             key.stop();
-            key.updateMenu();
-            key.updateStatusBar();
+            key.updateStatusDisplay();
         }
 
         return this.initFileLoaded;
@@ -1136,8 +1135,7 @@ const userscript = {
         {
             this.initFileLoaded = true;
             key.run();
-            key.updateMenu();
-            key.updateStatusBar();
+            key.updateStatusDisplay();
         }
 
         return loadStatus;

content/preference.js

@@ -307,8 +307,7 @@ var ksPreference = {
                     this.modules.display.clearNotify();
 
                     this.modules.key.run();
-                    this.modules.key.updateMenu();
-                    this.modules.key.updateStatusBar();
+                    this.modules.key.updateStatusDisplay();
 
                     this.modules.util.parent.openPreference(true);
                 }

createpackage.sh

@@ -26,7 +26,8 @@ zip -r -0 chrome/keysnail.jar \
     content/prettifier/*~*~ \
     content/modules/*.js~(*~) \
     locale/**/*.*~(*~) \
-    skin/**/*.*~(*~|*.svg)
+    skin/**/*.*~(*~|*.svg) \
+    skin/**/filter.svg
 
 echo "====================== Create xpi file ========================="
 

skin/classic/keysnail/css/toolbar-button.css

@@ -0,0 +1,16 @@
+#keysnail-toolbar-button {
+    list-style-image: url("../icon24.png");
+}
+
+toolbar[iconsize="small"] #keysnail-toolbar-button {
+    list-style-image: url("../icon16.png");
+}
+
+#keysnail-toolbar-button[data-ks-status=disabled] *|image {
+    filter: url("../filter/filter.svg#grayscale");
+    opacity: 0.7;
+}
+
+#keysnail-toolbar-button[data-ks-status=suspended] *|image {
+    filter: url("../filter/filter.svg#hue240");
+}