share/extensions/jessyInk_keyBindings.py

   1 #!/usr/bin/env python
   2 # Copyright 2008, 2009 Hannes Hochreiner
   3 # This program is free software: you can redistribute it and/or modify
   4 # it under the terms of the GNU General Public License as published by
   5 # the Free Software Foundation, either version 3 of the License, or
   6 # (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, see http://www.gnu.org/licenses/.
  15
  16 # These lines are only needed if you don't put the script directly into
  17 # the installation directory
  18 import sys
  19 # Unix
  20 sys.path.append('/usr/share/inkscape/extensions')
  21 # OS X
  22 sys.path.append('/Applications/Inkscape.app/Contents/Resources/extensions')
  23 # Windows
  24 sys.path.append('C:\Program Files\Inkscape\share\extensions')
  25
  26 # We will use the inkex module with the predefined Effect base class.
  27 import inkex
  28 import gettext
  29 _ = gettext.gettext
  30
  31 class   JessyInk_CustomKeyBindings(inkex.Effect):
  32         modes = ('slide', 'index', 'drawing')
  33         keyCodes = ('LEFT', 'RIGHT', 'DOWN', 'UP', 'HOME', 'END', 'ENTER', 'SPACE', 'PAGE_UP', 'PAGE_DOWN', 'ESCAPE')
  34         slideActions = {}
  35         slideCharCodes = {}
  36         slideKeyCodes = {}
  37         drawingActions = {}
  38         drawingCharCodes = {}
  39         drawingKeyCodes = {}
  40         indexActions = {}
  41         indexCharCodes = {}
  42         indexKeyCodes = {}
  43
  44
  45         def __init__(self):
  46                 # Call the base class constructor.
  47                 inkex.Effect.__init__(self)
  48
  49                 self.OptionParser.add_option('--tab', action = 'store', type = 'string', dest = 'what')
  50                 self.OptionParser.add_option('--slide_backWithEffects', action = 'callback', type = 'string', callback = self.slideOptions, default = '')
  51                 self.OptionParser.add_option('--slide_nextWithEffects', action = 'callback', type = 'string', callback = self.slideOptions, default = '')
  52                 self.OptionParser.add_option('--slide_backWithoutEffects', action = 'callback', type = 'string', callback = self.slideOptions, default = '')
  53                 self.OptionParser.add_option('--slide_nextWithoutEffects', action = 'callback', type = 'string', callback = self.slideOptions, default = '')
  54                 self.OptionParser.add_option('--slide_firstSlide', action = 'callback', type = 'string', callback = self.slideOptions, default = '')
  55                 self.OptionParser.add_option('--slide_lastSlide', action = 'callback', type = 'string', callback = self.slideOptions, default = '')
  56                 self.OptionParser.add_option('--slide_switchToIndexMode', action = 'callback', type = 'string', callback = self.slideOptions, default = '')
  57                 self.OptionParser.add_option('--slide_switchToDrawingMode', action = 'callback', type = 'string', callback = self.slideOptions, default = '')
  58                 self.OptionParser.add_option('--slide_setDuration', action = 'callback', type = 'string', callback = self.slideOptions, default = '')
  59                 self.OptionParser.add_option('--slide_addSlide', action = 'callback', type = 'string', callback = self.slideOptions, default = '')
  60                 self.OptionParser.add_option('--slide_toggleProgressBar', action = 'callback', type = 'string', callback = self.slideOptions, default = '')
  61                 self.OptionParser.add_option('--slide_resetTimer', action = 'callback', type = 'string', callback = self.slideOptions, default = '')
  62                 self.OptionParser.add_option('--slide_export', action = 'callback', type = 'string', callback = self.slideOptions, default = '')
  63                 self.OptionParser.add_option('--drawing_switchToSlideMode', action = 'callback', type = 'string', callback = self.drawingOptions, default = '')
  64                 self.OptionParser.add_option('--drawing_pathWidthDefault', action = 'callback', type = 'string', callback = self.drawingOptions, default = '')
  65                 self.OptionParser.add_option('--drawing_pathWidth1', action = 'callback', type = 'string', callback = self.drawingOptions, default = '')
  66                 self.OptionParser.add_option('--drawing_pathWidth2', action = 'callback', type = 'string', callback = self.drawingOptions, default = '')
  67                 self.OptionParser.add_option('--drawing_pathWidth3', action = 'callback', type = 'string', callback = self.drawingOptions, default = '')
  68                 self.OptionParser.add_option('--drawing_pathWidth4', action = 'callback', type = 'string', callback = self.drawingOptions, default = '')
  69                 self.OptionParser.add_option('--drawing_pathWidth5', action = 'callback', type = 'string', callback = self.drawingOptions, default = '')
  70                 self.OptionParser.add_option('--drawing_pathWidth6', action = 'callback', type = 'string', callback = self.drawingOptions, default = '')
  71                 self.OptionParser.add_option('--drawing_pathWidth7', action = 'callback', type = 'string', callback = self.drawingOptions, default = '')
  72                 self.OptionParser.add_option('--drawing_pathWidth8', action = 'callback', type = 'string', callback = self.drawingOptions, default = '')
  73                 self.OptionParser.add_option('--drawing_pathWidth9', action = 'callback', type = 'string', callback = self.drawingOptions, default = '')
  74                 self.OptionParser.add_option('--drawing_pathColourBlue', action = 'callback', type = 'string', callback = self.drawingOptions, default = '')
  75                 self.OptionParser.add_option('--drawing_pathColourCyan', action = 'callback', type = 'string', callback = self.drawingOptions, default = '')
  76                 self.OptionParser.add_option('--drawing_pathColourGreen', action = 'callback', type = 'string', callback = self.drawingOptions, default = '')
  77                 self.OptionParser.add_option('--drawing_pathColourBlack', action = 'callback', type = 'string', callback = self.drawingOptions, default = '')
  78                 self.OptionParser.add_option('--drawing_pathColourMagenta', action = 'callback', type = 'string', callback = self.drawingOptions, default = '')
  79                 self.OptionParser.add_option('--drawing_pathColourOrange', action = 'callback', type = 'string', callback = self.drawingOptions, default = '')
  80                 self.OptionParser.add_option('--drawing_pathColourRed', action = 'callback', type = 'string', callback = self.drawingOptions, default = '')
  81                 self.OptionParser.add_option('--drawing_pathColourWhite', action = 'callback', type = 'string', callback = self.drawingOptions, default = '')
  82                 self.OptionParser.add_option('--drawing_pathColourYellow', action = 'callback', type = 'string', callback = self.drawingOptions, default = '')
  83                 self.OptionParser.add_option('--drawing_undo', action = 'callback', type = 'string', callback = self.drawingOptions, default = '')
  84                 self.OptionParser.add_option('--index_selectSlideToLeft', action = 'callback', type = 'string', callback = self.indexOptions, default = '')
  85                 self.OptionParser.add_option('--index_selectSlideToRight', action = 'callback', type = 'string', callback = self.indexOptions, default = '')
  86                 self.OptionParser.add_option('--index_selectSlideAbove', action = 'callback', type = 'string', callback = self.indexOptions, default = '')
  87                 self.OptionParser.add_option('--index_selectSlideBelow', action = 'callback', type = 'string', callback = self.indexOptions, default = '')
  88                 self.OptionParser.add_option('--index_previousPage', action = 'callback', type = 'string', callback = self.indexOptions, default = '')
  89                 self.OptionParser.add_option('--index_nextPage', action = 'callback', type = 'string', callback = self.indexOptions, default = '')
  90                 self.OptionParser.add_option('--index_firstSlide', action = 'callback', type = 'string', callback = self.indexOptions, default = '')
  91                 self.OptionParser.add_option('--index_lastSlide', action = 'callback', type = 'string', callback = self.indexOptions, default = '')
  92                 self.OptionParser.add_option('--index_switchToSlideMode', action = 'callback', type = 'string', callback = self.indexOptions, default = '')
  93                 self.OptionParser.add_option('--index_decreaseNumberOfColumns', action = 'callback', type = 'string', callback = self.indexOptions, default = '')
  94                 self.OptionParser.add_option('--index_increaseNumberOfColumns', action = 'callback', type = 'string', callback = self.indexOptions, default = '')
  95                 self.OptionParser.add_option('--index_setNumberOfColumnsToDefault', action = 'callback', type = 'string', callback = self.indexOptions, default = '')
  96
  97                 inkex.NSS[u"jessyink"] = u"https://launchpad.net/jessyink"
  98
  99                 self.slideActions["backWithEffects"] = "dispatchEffects(-1);"
 100                 self.slideActions["nextWithEffects"] = "dispatchEffects(1);"
 101                 self.slideActions["backWithoutEffects"] = "skipEffects(-1);"
 102                 self.slideActions["nextWithoutEffects"] = "skipEffects(1);"
 103                 self.slideActions["firstSlide"] = "slideSetActiveSlide(0);"
 104                 self.slideActions["lastSlide"] = "slideSetActiveSlide(slides.length - 1);"
 105                 self.slideActions["switchToIndexMode"] = "toggleSlideIndex();"
 106                 self.slideActions["switchToDrawingMode"] = "slideSwitchToDrawingMode();"
 107                 self.slideActions["setDuration"] = "slideQueryDuration();"
 108                 self.slideActions["addSlide"] = "slideAddSlide(activeSlide);"
 109                 self.slideActions["toggleProgressBar"] = "slideToggleProgressBarVisibility();"
 110                 self.slideActions["resetTimer"] = "slideResetTimer();"
 111                 self.slideActions["export"] = "slideUpdateExportLayer();"
 112
 113                 self.drawingActions["switchToSlideMode"] = "drawingSwitchToSlideMode();"
 114                 self.drawingActions["pathWidthDefault"] = "drawingResetPathWidth();"
 115                 self.drawingActions["pathWidth1"] = "drawingSetPathWidth(1.0);"
 116                 self.drawingActions["pathWidth3"] = "drawingSetPathWidth(3.0);"
 117                 self.drawingActions["pathWidth5"] = "drawingSetPathWidth(5.0);"
 118                 self.drawingActions["pathWidth7"] = "drawingSetPathWidth(7.0);"
 119                 self.drawingActions["pathWidth9"] = "drawingSetPathWidth(9.0);"
 120                 self.drawingActions["pathColourBlue"] = "drawingSetPathColour(\"blue\");"
 121                 self.drawingActions["pathColourCyan"] = "drawingSetPathColour(\"cyan\");"
 122                 self.drawingActions["pathColourGreen"] = "drawingSetPathColour(\"green\");"
 123                 self.drawingActions["pathColourBlack"] = "drawingSetPathColour(\"black\");"
 124                 self.drawingActions["pathColourMagenta"] = "drawingSetPathColour(\"magenta\");"
 125                 self.drawingActions["pathColourOrange"] = "drawingSetPathColour(\"orange\");"
 126                 self.drawingActions["pathColourRed"] = "drawingSetPathColour(\"red\");"
 127                 self.drawingActions["pathColourWhite"] = "drawingSetPathColour(\"white\");"
 128                 self.drawingActions["pathColourYellow"] = "drawingSetPathColour(\"yellow\");"
 129                 self.drawingActions["undo"] = "drawingUndo();"
 130
 131                 self.indexActions["selectSlideToLeft"] = "indexSetPageSlide(activeSlide - 1);"
 132                 self.indexActions["selectSlideToRight"] = "indexSetPageSlide(activeSlide + 1);"
 133                 self.indexActions["selectSlideAbove"] = "indexSetPageSlide(activeSlide - INDEX_COLUMNS);"
 134                 self.indexActions["selectSlideBelow"] = "indexSetPageSlide(activeSlide + INDEX_COLUMNS);"
 135                 self.indexActions["previousPage"] = "indexSetPageSlide(activeSlide - INDEX_COLUMNS * INDEX_COLUMNS);"
 136                 self.indexActions["nextPage"] = "indexSetPageSlide(activeSlide + INDEX_COLUMNS * INDEX_COLUMNS);"
 137                 self.indexActions["firstSlide"] = "indexSetPageSlide(0);"
 138                 self.indexActions["lastSlide"] = "indexSetPageSlide(slides.length - 1);"
 139                 self.indexActions["switchToSlideMode"] = "toggleSlideIndex();"
 140                 self.indexActions["decreaseNumberOfColumns"] = "indexDecreaseNumberOfColumns();"
 141                 self.indexActions["increaseNumberOfColumns"] = "indexIncreaseNumberOfColumns();"
 142                 self.indexActions["setNumberOfColumnsToDefault"] = "indexResetNumberOfColumns();"
 143
 144         def slideOptions(self, option, opt_str, value, parser):
 145                 action = self.getAction(opt_str)
 146
 147                 valueArray = value.split(",")
 148
 149                 for val in valueArray:
 150                         val = val.strip()
 151
 152                         if val in self.keyCodes:
 153                                 self.slideKeyCodes[val + "_KEY"] = self.slideActions[action]
 154                         elif len(val) == 1:
 155                                 self.slideCharCodes[val] = self.slideActions[action]
 156
 157         def drawingOptions(self, option, opt_str, value, parser):
 158                 action = self.getAction(opt_str)
 159
 160                 valueArray = value.split(",")
 161
 162                 for val in valueArray:
 163                         val = val.strip()
 164
 165                         if val in self.keyCodes:
 166                                 self.drawingKeyCodes[val + "_KEY"] = self.drawingActions[action]
 167                         elif len(val) == 1:
 168                                 self.drawingCharCodes[val] = self.drawingActions[action]
 169
 170         def indexOptions(self, option, opt_str, value, parser):
 171                 action = self.getAction(opt_str)
 172
 173                 valueArray = value.split(",")
 174
 175                 for val in valueArray:
 176                         val = val.strip()
 177
 178                         if val in self.keyCodes:
 179                                 self.indexKeyCodes[val + "_KEY"] = self.indexActions[action]
 180                         elif len(val) == 1:
 181                                 self.indexCharCodes[val] = self.indexActions[action]
 182
 183         def effect(self):
 184                 # Check version.
 185                 scriptNodes = self.document.xpath("//svg:script[@jessyink:version='1.5.5']", namespaces=inkex.NSS)
 186
 187                 if len(scriptNodes) != 1:
 188                         inkex.errormsg(_("The JessyInk script is not installed in this SVG file or has a different version than the JessyInk extensions. Please select \"install/update...\" from the \"JessyInk\" sub-menu of the \"Extensions\" menu to install or update the JessyInk script.\n\n"))
 189
 190                 # Remove old master slide property
 191                 for node in self.document.xpath("//svg:g[@jessyink:customKeyBindings='customKeyBindings']", namespaces=inkex.NSS):
 192                         node.getparent().remove(node)
 193
 194                 # Set custom key bindings.
 195                 nodeText = "function getCustomKeyBindingsSub()" + "\n"
 196                 nodeText += "{" + "\n"
 197                 nodeText += "   var keyDict = new Object();" + "\n"
 198                 nodeText += "   keyDict[SLIDE_MODE] = new Object();" + "\n"
 199                 nodeText += "   keyDict[INDEX_MODE] = new Object();" + "\n"
 200                 nodeText += "   keyDict[DRAWING_MODE] = new Object();" + "\n"
 201
 202                 for key, value in self.slideKeyCodes.items():
 203                         nodeText += "   keyDict[SLIDE_MODE][" + key + "] = function() { " + value + " };" + "\n"
 204
 205                 for key, value in self.drawingKeyCodes.items():
 206                         nodeText += "   keyDict[DRAWING_MODE][" + key + "] = function() { " + value + " };" + "\n"
 207
 208                 for key, value in self.indexKeyCodes.items():
 209                         nodeText += "   keyDict[INDEX_MODE][" + key + "] = function() { " + value + " };" + "\n"
 210
 211                 nodeText += "   return keyDict;" + "\n"
 212                 nodeText += "}" + "\n\n"
 213
 214                 # Set custom char bindings.
 215                 nodeText += "function getCustomCharBindingsSub()" + "\n"
 216                 nodeText += "{" + "\n"
 217                 nodeText += "   var charDict = new Object();" + "\n"
 218                 nodeText += "   charDict[SLIDE_MODE] = new Object();" + "\n"
 219                 nodeText += "   charDict[INDEX_MODE] = new Object();" + "\n"
 220                 nodeText += "   charDict[DRAWING_MODE] = new Object();" + "\n"
 221
 222                 for key, value in self.slideCharCodes.items():
 223                         nodeText += "   charDict[SLIDE_MODE][\"" + key + "\"] = function() { " + value + " };" + "\n"
 224
 225                 for key, value in self.drawingCharCodes.items():
 226                         nodeText += "   charDict[DRAWING_MODE][\"" + key + "\"] = function() { " + value + " };" + "\n"
 227
 228                 for key, value in self.indexCharCodes.items():
 229                         nodeText += "   charDict[INDEX_MODE][\"" + key + "\"] = function() { " + value + " };" + "\n"
 230
 231                 nodeText += "   return charDict;" + "\n"
 232                 nodeText += "}" + "\n"
 233
 234                 # Create new script node
 235                 scriptElm = inkex.etree.Element(inkex.addNS("script", "svg"))
 236                 scriptElm.text = nodeText
 237                 groupElm = inkex.etree.Element(inkex.addNS("g", "svg"))
 238                 groupElm.set("{" + inkex.NSS["jessyink"] + "}customKeyBindings", "customKeyBindings")
 239                 groupElm.set("onload", "this.getCustomCharBindings = function() { return getCustomCharBindingsSub(); }; this.getCustomKeyBindings = function() { return getCustomKeyBindingsSub(); };")
 240                 groupElm.append(scriptElm)
 241                 self.document.getroot().append(groupElm)
 242
 243         def getAction(self, varName):
 244                 parts = varName.split('_')
 245
 246                 if (len(parts) != 2):
 247                         raise StandardException("Error parsing variable name.")
 248
 249                 return parts[1]
 250
 251 # Create effect instance
 252 effect = JessyInk_CustomKeyBindings()
 253 effect.affect()
 254