image_path_in_ui.lua

--[[
  This file is part of darktable,
  copyright (c) 2014 Jérémy Rosen

  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/>.
]]
--[[
IMAGE_PATH_IN_UI
Add a widget with the path of the selected images for easy copy/past
Simple shortcuts to have multiple selection bufers


USAGE
* require this file from your main lua config file:

This plugin will add a widget at the bottom of the left column in lighttable mode


]]
local dt = require "darktable"
local du = require "lib/dtutils"

du.check_min_api_version("7.0.0", "image_path_in_ui") 

local gettext = dt.gettext.gettext

local function _(msgid)
    return gettext(msgid)
end

-- return data structure for script_manager

local script_data = {}

script_data.metadata = {
  name = _("image path in UI"),
  purpose = _("print the image path in the UI"),
  author = "Jérémy Rosen",
  help = "https://docs.darktable.org/lua/stable/lua.scripts.manual/scripts/official/image_path_in_ui"
}

script_data.destroy = nil -- function to destory the script
script_data.destroy_method = nil -- set to hide for libs since we can't destroy them commpletely yet
script_data.restart = nil -- how to restart the (lib) script after it's been hidden - i.e. make it visible again
script_data.show = nil -- only required for libs since the destroy_method only hides them

local ipiu = {}
ipiu.module_installed = false
ipiu.event_registered = false

local main_label = dt.new_widget("label"){selectable = true, ellipsize = "middle", halign = "start"}

local function install_module()
  if not ipiu.module_installed then
    dt.register_lib("image_path_no_ui",_("selected images path"),true,false,{
      [dt.gui.views.lighttable] = {"DT_UI_CONTAINER_PANEL_LEFT_CENTER",300}
      }, main_label
    )
    ipiu.module_installed = true
  end
end

local function reset_widget()
  local selection = dt.gui.selection()
  local result = ""
  local array = {}
  for _,img in pairs(selection) do
    array[img.path] = true
  end
  for path in pairs(array) do
    if result == "" then
      result = path
    else
      result = result.."\n"..path
    end
  end
  main_label.label = result
end

local function destroy()
  dt.gui.libs["image_path_no_ui"].visible = false
  dt.destroy_event("ipiu", "mouse-over-image-changed")
end

local function restart()
  dt.register_event("ipiu", "mouse-over-image-changed", reset_widget);
  dt.gui.libs["image_path_no_ui"].visible = true
end

local function show()
  dt.gui.libs["image_path_no_ui"].visible = true
end

main_label.reset_callback = reset_widget

if dt.gui.current_view().id == "lighttable" then
  install_module()
else
  if not ipiu.event_registered then
    dt.register_event(
      "ipiu", "view-changed",
      function(event, old_view, new_view)
        if new_view.name == "lighttable" and old_view.name == "darkroom" then
          install_module()
         end
      end
    )
    ipiu.event_registered = true
  end
end

dt.register_event("ipiu", "mouse-over-image-changed", reset_widget);

script_data.destroy = destroy
script_data.restart = restart
script_data.destroy_method = "hide"
script_data.show = show

return script_data
  --
-- vim: shiftwidth=2 expandtab tabstop=2 cindent syntax=lua