Rgp changes for rgplua 0.72 (#716)

* add mouse tracking events to slider sample

* couple of minor changes to samples

* documentation update

* DoSomething opens a modal window.

* fiddle with modeless dialog sample

* modeless sample modified for testing console

* Add `IsActive` to finenv doc.

* rename IsScriptActive func

* eat own dogfood plus lint bugfix

* initial checkin of key mode editor

* refinement

* Use FCKeySignature to get default values.

* get major/minor from key sig

* doc update

* moving ahead with keymode editor

* added base info

* init popup with current selection

* checkpoint

* delete working

* save existing is working

* Save button fully implemented

* added beginning of symbol editor

* bugfixes for windows

* revisions towards actually using the symbol editor

* symbol font encoding

* more efficient calls

* bugfix

* various fixes

* rework font stuff for accidental symbol font

* symbol list editor code complete

* feature complete; aesthetic changes still required

* aesthetic fixes

* little improvements to key mode editor

* fix typo

Author: rpatters1

docs/rgp-lua/finenv-properties.md

@@ -49,7 +49,7 @@ Returns an instance of `FCLuaScriptItems` that can be used to launch ad-hoc scri
 
 ##### Inputs:
 
-- `string1` : A Lua string containing the fully qualified path to the script file.
+- `string1` : [optional] A Lua string containing the fully qualified path to the script file. If this parameter is omitted, it still creates a collection with one item. You can then supply the Lua code with the item's `SetOptionalScriptText` method.
 - `string2` : [optional] A Lua string containing the Lua code to execute. If this parameter is provided, the contents of the fully qualified path are ignored, though RGP Lua will continue to use the path for display and security purposes.
 
 ##### Outputs:
@@ -196,6 +196,12 @@ end
 
 ---
 
+#### IsScriptActive\* (function)
+
+Boolean function that should always return `true`. This value is primarily useful as a diagnostic tool for testing _RGP Lua_. It proves that the plugin can find a running script from its Lua state, even if that Lua state is a coroutine state. Normal scripts probably never need to access this function.
+
+---
+
 #### LoadedAsString\* (read-only property)
 
 A read-only property that returns the setting of “Load As String”, either from _RGP Lua’s_ configuration dialog or from the `plugindef()` function, whichever is in effect.

docs/rgp-lua/rgp-lua-console.md

@@ -45,11 +45,13 @@ The Console recognizes standard keyboard navigation commands for each operating
 
 #### File Popup Shortcuts
 
-- **New File**: `cmd+N` (macOS) `ctrl+N` (Windows)
+- **New File**: `shift-cmd+N` (macOS) `ctrl+N` (Windows)
 - **Open File**: `cmd+O` (macOS) `ctrl+O` (Windows)
 - **Save File**: `cmd+S` (macOS) `ctrl+S` (Windows)
 - **Close File**: `cmd+W` (macOS) `ctrl+W` (Windows)
 
+(Note the `shift` key added for **New File** on macOS. This leaves `cmd+N` available for opening new Finale file while the console is in focus.)
+
 #### Search Shortcuts
 
 - **Find Text**: `cmd+F` (macOS) `ctrl+F` (Windows)

samples/modeless_dialog.lua

@@ -4,6 +4,9 @@ function plugindef()
     finaleplugin.Notes = [[
         This script illustrates how to set up a modeless dialog box.
     ]]
+    finaleplugin.AdditionalMenuOptions = [[
+        "0--modeless_dialog.lua 2"
+    ]]
     return "0--modeless_dialog.lua"
 end
 
@@ -14,7 +17,29 @@ end
 local mixin = require("library.mixin")
 
 local strings = {"Option 1", "Option 2", "Option 3"}
-local strings2 = {"Long Suboption 1", "Long Suboption 2"}
+local strings2 = { "Long Suboption 1", "Long Suboption 2" }
+
+local function show_self(dlg)
+    local fpath = finale.FCString()
+    fpath:SetRunningLuaFolderPath()
+    local fname = finale.FCString()
+    fname:SetRunningLuaFilePath()
+    dlg:CreateChildUI():AlertInfo(fname.LuaString, fpath.LuaString)
+end
+
+local function modal_dialog() -- luacheck: ignore
+    local dlg = mixin.FCXCustomLuaWindow()
+    dlg:SetTitle("Modal Popup")
+    dlg:CreateButton(0, 0)
+        :SetText("Popup Message")
+        :SetWidth(150)
+        :AddHandleCommand(function(_control)
+            show_self(dlg)
+        end)
+    dlg:CreateOkButton()
+    dlg:CreateCancelButton()
+    dlg:ExecuteModal()
+end
 
 local function create_dialog()
     local dlg = mixin.FCXCustomLuaWindow()
@@ -66,10 +91,14 @@ local function create_dialog()
 
     dlg:RegisterHandleControlEvent(do_something,
         function(_control)
+            show_self(dlg)
+--            modal_dialog()
+            --[[
             local grp1 = global_dialog:GetControl("radio1")
             print("radio group 1 selected item: " .. grp1:GetSelectedItem())
             local grp2 = global_dialog:GetControl("radio2")
-            print("radio group 1 selected item: " .. grp2:GetSelectedItem())
+            print("radio group 2 selected item: " .. grp2:GetSelectedItem())
+            ]]
             --[[
             finenv.StartNewUndoBlock("Playback Region", false)
             finenv.Region():Playback()
@@ -92,13 +121,6 @@ local function create_dialog()
             end
             ]]
             --[[
-            local fpath = finale.FCString()
-            fpath:SetRunningLuaFolderPath()
-            local fname = finale.FCString()
-            fname:SetRunningLuaFilePath()
-            finenv.UI():AlertInfo(fname.LuaString, fpath.LuaString)
-            ]]
-            --[[
             local function fcstr(s)
                 local str = finale.FCString()
                 str.LuaString = s

samples/slider_control.lua

@@ -20,14 +20,27 @@ slider:SetThumbPosition(2)
 str.LuaString = "Thumb position: " .. slider:GetThumbPosition()
 static:SetText(str)
 
+dialog:CreateOkButton()
+dialog:CreateCancelButton()
+
 dialog:RegisterHandleControlEvent(slider, function(ctrl)
     local thumb_pos = ctrl:GetThumbPosition()
     str.LuaString = "Thumb position: " .. tostring(thumb_pos)
     print(str.LuaString)
     static:SetText(str)
 end)
 
---require('mobdebug').start()
-dialog:ExecuteModal(nil)
+dialog:RegisterMouseTrackingStarted(function(ctrl)
+    local thumb_pos = ctrl:GetThumbPosition()
+    print("Slider tracking started: " .. thumb_pos)
+end)
+
+dialog:RegisterMouseTrackingStopped(function(ctrl)
+    local thumb_pos = ctrl:GetThumbPosition()
+    print("Slider tracking stopped: " .. thumb_pos)
+end)
+
+local result = dialog:ExecuteModal(nil)
+print("ExecuteModal returned: " .. result)
 
 finenv.UI():AlertInfo("Thumb position: " .. tostring(slider:GetThumbPosition()), "")