created 3 demonstration scripts of the dt3.0 lua API additions

examples/darkroom_demo.lua

@@ -0,0 +1,98 @@
+--[[
+    This file is part of darktable,
+    copyright (c) 2019 Bill Ferguson <wpferguson@gmail.com>
+
+    darktable is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    darktable is distributed in the hope that it will be useful,
+     but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with darktable.  If not, see <http://www.gnu.org/licenses/>.
+]]
+--[[
+    darkroom_demo - an example script demonstrating how to control image display in darkroom mode
+
+    darkroom_demo is an example script showing how to control the currently displayed image in 
+    darkroom mode using lua.
+
+    ADDITIONAL SOFTWARE NEEDED FOR THIS SCRIPT
+    * none
+
+    USAGE
+    * require this script from your main lua file
+
+    BUGS, COMMENTS, SUGGESTIONS
+    * Send to Bill Ferguson, wpferguson@gmail.com
+
+    CHANGES
+]]
+
+local dt = require "darktable"
+local du = require "lib/dtutils"
+
+-- - - - - - - - - - - - - - - - - - - - - - - -
+-- V E R S I O N  C H E C K
+-- - - - - - - - - - - - - - - - - - - - - - - -
+
+du.check_min_api_version("5.0.2", "darkroom_mode")  -- darktable 3.0
+
+-- - - - - - - - - - - - - - - - - - - - - - - -
+-- C O N S T A N T S
+-- - - - - - - - - - - - - - - - - - - - - - - -
+
+local MODULE_NAME = "darkroom"
+local PS = dt.configuration.running_os == "windows" and  "\\"  or  "/"
+
+-- - - - - - - - - - - - - - - - - - - - - - - -
+-- T R A N S L A T I O N S
+-- - - - - - - - - - - - - - - - - - - - - - - -
+local gettext = dt.gettext
+gettext.bindtextdomain(MODULE_NAME, dt.configuration.config_dir..PS.."lua"..PS.."locale"..PS)
+
+local function _(msgid)
+  return gettext.dgettext(MODULE_NAME, msgid)
+end
+
+-- - - - - - - - - - - - - - - - - - - - - - - -
+-- M A I N
+-- - - - - - - - - - - - - - - - - - - - - - - -
+
+-- alias dt.control.sleep to sleep
+local sleep = dt.control.sleep
+
+-- save the configuration
+
+local current_view = dt.gui.current_view()
+
+-- enter darkroom view
+
+dt.gui.current_view(dt.gui.views.darkroom)
+
+local max_images = 10
+
+dt.print(_("Showing images, with a pause in between each"))
+sleep(1500)
+
+-- display first 10 images of collection pausing for a second between each
+
+for i, img in ipairs(dt.collection) do 
+  dt.print(_("Displaying image " .. i))
+  dt.gui.views.darkroom.display_image(img)
+  sleep(1500)
+  if i == max_images then
+    break
+  end
+end
+
+-- return to lighttable view
+
+dt.print(_("Restoring view"))
+sleep(1500)
+dt.gui.current_view(current_view)
+