2020-12-21 18:19:20 +00:00
<!doctype html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "x-ua-compatible" content = "ie=edge" >
< title > darktable lua documentation - darktable.gui< / title >
< meta name = "description" content = "" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< link rel = "manifest" href = "site.webmanifest" >
< link rel = "apple-touch-icon" href = "icon.png" >
2021-01-21 01:51:13 +00:00
< link rel = "stylesheet" href = "https://darktable-org.github.io/luadocs/css/style.min.675cc3d890fd09471555ac6ad008c01d3ccff9181784247e343b1d86fd6bff31.css" >
2020-12-21 18:19:20 +00:00
< script src = "https://darktable-org.github.io/luadocs/js/jquery.js" > < / script >
< script src = "https://darktable-org.github.io/luadocs/js/popper.js" type = "module" > < / script >
< script src = "https://darktable-org.github.io/luadocs/js/bootstrap.js" > < / script >
< script src = "https://darktable-org.github.io/luadocs/js/lunr.js" > < / script >
< script src = "https://darktable-org.github.io/luadocs/js/app.js" > < / script >
< / head >
< body >
< header class = "navbar navbar-expand-lg sticky-top navbar-dark bg-dark" >
< a class = "navbar-brand" href = "https://darktable-org.github.io/luadocs/" rel = "home" title = ".Site.Title" >
darktable lua documentation
< / a >
< button class = "navbar-toggler" type = "button" data-toggle = "collapse" data-target = "#navbarSupportedContent" aria-controls = "navbarSupportedContent" aria-expanded = "false" aria-label = "Toggle navigation" >
< span class = "navbar-toggler-icon" > < / span >
< / button >
< div class = "collapse navbar-collapse" id = "navbarSupportedContent" >
< ul class = "navbar-nav ml-auto" >
< form class = "form-inline my-2 my-lg-0" >
< input id = "search-input" class = "form-control mr-sm-2" type = "search" placeholder = "Search" autocomplete = "off" aria-label = "Search" >
< / form >
< / ul >
< / div >
< / header >
< div id = "search-results" class = "search-results" >
< / div >
< div class = "container-fluid" >
< div class = "row" >
< nav class = "navigation col-sm-12 order-sm-12 col-md-3 order-md-1" >
< ul >
< li class = "parent" >
< i class = "fa fa-plus-square toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/" class = "" >
Lua Scripts Manual
< / a >
< ul >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/overview/" class = "" >
overview
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/installation/" class = "" >
installation
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/troubleshooting/" class = "" >
troubleshooting
< / a >
< / li >
< li class = "parent" >
< i class = "fa fa-plus-square toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/" class = "" >
scripts
< / a >
< ul >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/overview/" class = "" >
overview
< / a >
< / li >
< li class = "parent" >
< i class = "fa fa-plus-square toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/" class = "" >
contrib
< / a >
< ul >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/autogrouper/" class = "" >
AutoGrouper
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/autostyle/" class = "" >
autostyle
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/clear_gps/" class = "" >
clear_GPS
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/collecthelper/" class = "" >
CollectHelper
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/copy_attach_detach_tags/" class = "" >
copy_attach_detach_tags
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/cr2hdr/" class = "" >
cr2hdr
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/enfuseadvanced/" class = "" >
enfuseAdvanced
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/exportlut/" class = "" >
exportLUT
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/ext_editor/" class = "" >
ext_editor
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/face_recognition/" class = "" >
face_recognition
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/fujifilm_ratings/" class = "" >
fujifilm_ratings
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/geojson_export/" class = "" >
geoJSON_export
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/geotoolbox/" class = "" >
geoToolbox
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/gimp/" class = "" >
gimp
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/gpx_export/" class = "" >
gpx_export
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/hdrmerge/" class = "" >
HDRMerge
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/hugin/" class = "" >
hugin
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/image_stack/" class = "" >
image_stack
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/image_time/" class = "" >
image_time
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/kml_export/" class = "" >
kml_export
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/labelstotags/" class = "" >
LabelsToTags
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/openinexplorer/" class = "" >
OpenInExplorer
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/passport_guide/" class = "" >
passport_guide
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/pdf_slideshow/" class = "" >
pdf_slideshow
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/photils/" class = "" >
photils
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/quicktag/" class = "" >
quicktag
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/rate_group/" class = "" >
rate_group
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/rename-tags/" class = "" >
rename_tags
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/rl_out_sharp/" class = "" >
RL_out_sharp
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/slideshowmusic/" class = "" >
slideshowMusic
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/transfer_hierarchy/" class = "" >
transfer_hierarchy
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/video_ffmpeg/" class = "" >
video_ffmpeg
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/select_untagged/" class = "" >
select_untagged
< / a >
< / li >
< / ul >
< / li >
< li class = "parent" >
< i class = "fa fa-plus-square toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/examples/" class = "" >
examples
< / a >
< ul >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/examples/api_version/" class = "" >
api_version
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/examples/darkroom_demo/" class = "" >
darkroom_demo
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/examples/gettextexample/" class = "" >
gettextExample
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/examples/hello_world/" class = "" >
hello_world
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/examples/lighttable_demo/" class = "" >
lighttable_demo
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/examples/moduleexample/" class = "" >
moduleExample
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/examples/multi_os/" class = "" >
name
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/examples/panels_demo/" class = "" >
panels_demo
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/examples/preferenceexamples/" class = "" >
preferenceExample
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/examples/printexamples/" class = "" >
printExamples
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/examples/running_os/" class = "" >
running_os
< / a >
< / li >
< / ul >
< / li >
< li class = "parent" >
< i class = "fa fa-plus-square toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/official/" class = "" >
official
< / a >
< ul >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/official/check_for_updates/" class = "" >
check_for_updates
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/official/copy_paste_metadata/" class = "" >
copy_paste_metadata
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/official/delete_long_tags/" class = "" >
delete_long_tags
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/official/delete_unused_tags/" class = "" >
delete_unused_tags
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/official/enfuse/" class = "" >
enfuse
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/official/generate_image_txt/" class = "" >
generate_image_txt
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/official/image_path_in_ui/" class = "" >
image_path_in_ui
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/official/import_filter_manager/" class = "" >
import_filter_manager
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/official/import_filters/" class = "" >
import_filters
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/official/save_selection/" class = "" >
save_selection
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/official/selection_to_pdf/" class = "" >
selection_to_pdf
< / a >
< / li >
< / ul >
< / li >
< li class = "parent" >
< i class = "fa fa-plus-square toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/tools/" class = "" >
tools
< / a >
< ul >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/tools/executable_manager/" class = "" >
executable_manager
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/tools/gen_i18n_mo/" class = "" >
gen_i18n_mo
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/tools/get_lib_manpages/" class = "" >
get_lib_manpages
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/tools/get_libdoc/" class = "" >
get_libdoc
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/tools/script_manager/" class = "" >
script_manager
< / a >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< li class = "parent" >
< i class = "fa fa-plus-square toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/" class = "" >
Lua Scripts Libraries API Manual
< / a >
< ul >
< li class = "parent" >
< i class = "fa fa-plus-square toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils/" class = "" >
dtutils
< / a >
< ul >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils/details/" class = "" >
details
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils/check_min_api_version/" class = "" >
check_min_api_version
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils/check_os/" class = "" >
check_os
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2021-01-21 01:51:13 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils/find_image_by_id/" class = "" >
find_image_by_id
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-21 18:19:20 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils/join/" class = "" >
join
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils/prequire/" class = "" >
prequire
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils/spairs/" class = "" >
spairs
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils/split/" class = "" >
split
< / a >
< / li >
< / ul >
< / li >
< li class = "parent" >
< i class = "fa fa-plus-square toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.debug/" class = "" >
dtutils.debug
< / a >
< ul >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.debug/details/" class = "" >
details
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.debug/dprint/" class = "" >
dprint
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.debug/new_tracepoint/" class = "" >
new_tracepoint
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.debug/terse_dump/" class = "" >
terse_dump
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.debug/tracepoint/" class = "" >
tracepoint
< / a >
< / li >
< / ul >
< / li >
< li class = "parent" >
< i class = "fa fa-plus-square toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.file/" class = "" >
dtutils.file
< / a >
< ul >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.file/details/" class = "" >
details
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.file/check_if_bin_exists/" class = "" >
check_if_bin_exists
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.file/check_if_file_exists/" class = "" >
check_if_file_exists
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.file/chop_filetype/" class = "" >
chop_filetype
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.file/create_unique_filename/" class = "" >
create_unique_filename
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.file/executable_path_widget/" class = "" >
executable_path_widget
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.file/file_copy/" class = "" >
file_copy
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.file/file_move/" class = "" >
file_move
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.file/filename_increment/" class = "" >
filename_increment
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.file/get_basename/" class = "" >
get_basename
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.file/get_executable_path_preference/" class = "" >
get_executable_path_preference
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.file/get_filename/" class = "" >
get_filename
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.file/get_filetype/" class = "" >
get_filetype
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.file/get_path/" class = "" >
get_path
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.file/mkdir/" class = "" >
mkdir
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.file/rmdir/" class = "" >
rmdir
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.file/sanitize_filename/" class = "" >
sanitize_filename
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.file/set_executable_path_preference/" class = "" >
set_executable_path_preference
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.file/split_filepath/" class = "" >
split_filepath
< / a >
2020-12-24 14:58:00 +00:00
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.file/test_file/" class = "" >
test_file
< / a >
2020-12-21 18:19:20 +00:00
< / li >
< / ul >
< / li >
< li class = "parent" >
< i class = "fa fa-plus-square toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.log/" class = "" >
dtutils.log
< / a >
< ul >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.log/details/" class = "" >
details
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.log/caller/" class = "" >
caller
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.log/engine/" class = "" >
engine
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.log/log_level/" class = "" >
log_level
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.log/msg/" class = "" >
msg
< / a >
< / li >
< / ul >
< / li >
< li class = "parent" >
< i class = "fa fa-plus-square toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.string/" class = "" >
dtutils.string
< / a >
< ul >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.string/details/" class = "" >
details
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.string/escape_xml_characters/" class = "" >
escape_xml_characters
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.string/is_not_sanitized/" class = "" >
is_not_sanitized
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.string/sanitize/" class = "" >
sanitize
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.string/sanitize_lua/" class = "" >
sanitize_lua
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.string/strip_accents/" class = "" >
strip_accents
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.string/urlencode/" class = "" >
urlencode
< / a >
< / li >
< / ul >
< / li >
< li class = "parent" >
< i class = "fa fa-plus-square toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.system/" class = "" >
dtutils.system
< / a >
< ul >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.system/details/" class = "" >
details
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.system/external_command/" class = "" >
external_command
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.system/launch_default_app/" class = "" >
launch_default_app
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.system/windows_command/" class = "" >
windows_command
< / a >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< li class = "parent" >
< i class = "fa fa-plus-square toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/" class = "" >
Lua API Manual
< / a >
< ul >
2020-12-28 15:53:40 +00:00
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/version/" class = "" >
Lua API Version
< / a >
< / li >
2020-12-21 18:19:20 +00:00
< li class = "parent" >
< i class = "fa fa-plus-square toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/darktable/" class = "" >
darktable
< / a >
< ul >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/darktable/overview/" class = "" >
overview
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2021-02-04 03:15:37 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/darktable/darktable.collection/" class = "" >
darktable.collection
2020-12-21 18:19:20 +00:00
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2021-02-04 03:15:37 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/darktable/darktable.configuration/" class = "" >
darktable.configuration
2020-12-21 18:19:20 +00:00
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2021-02-04 03:15:37 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/darktable/darktable.control/" class = "" >
darktable.control
2020-12-21 18:19:20 +00:00
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2021-02-04 03:15:37 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/darktable/darktable.database/" class = "" >
darktable.database
2020-12-21 18:19:20 +00:00
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2021-02-04 03:15:37 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/darktable/darktable.debug/" class = "" >
darktable.debug
2020-12-21 18:19:20 +00:00
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2021-02-04 03:15:37 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/darktable/darktable.films/" class = "" >
darktable.films
2020-12-21 18:19:20 +00:00
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2021-02-04 03:15:37 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/darktable/darktable.gettext/" class = "" >
darktable.gettext
2020-12-21 18:19:20 +00:00
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2021-02-04 03:15:37 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/darktable/darktable.gui/" class = " active" >
darktable.gui
2020-12-21 18:19:20 +00:00
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2021-02-04 03:15:37 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/darktable/darktable.guides/" class = "" >
darktable.guides
2020-12-21 18:19:20 +00:00
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2021-02-04 03:15:37 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/darktable/darktable.new_format/" class = "" >
darktable.new_format
2020-12-21 18:19:20 +00:00
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2021-02-04 03:15:37 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/darktable/darktable.new_storage/" class = "" >
darktable.new_storage
2020-12-21 18:19:20 +00:00
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2021-02-04 03:15:37 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/darktable/darktable.new_widget/" class = "" >
darktable.new_widget
2020-12-21 18:19:20 +00:00
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2021-02-04 03:15:37 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/darktable/darktable.password/" class = "" >
darktable.password
2020-12-21 18:19:20 +00:00
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2021-02-04 03:15:37 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/darktable/darktable.preferences/" class = "" >
darktable.preferences
2020-12-21 18:19:20 +00:00
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2021-02-04 03:15:37 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/darktable/darktable.print/" class = "" >
darktable.print
2020-12-21 18:19:20 +00:00
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2021-02-04 03:15:37 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/darktable/darktable.print_error/" class = "" >
darktable.print_error
2020-12-28 15:53:40 +00:00
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2021-02-04 03:15:37 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/darktable/darktable.print_log/" class = "" >
darktable.print_log
2020-12-21 18:19:20 +00:00
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2021-02-04 03:15:37 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/darktable/darktable.register_event/" class = "" >
darktable.register_event
2020-12-21 18:19:20 +00:00
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2021-02-04 03:15:37 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/darktable/darktable.destroy_event/" class = "" >
darktable.destroy_event
2020-12-21 18:19:20 +00:00
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2021-02-04 03:15:37 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/darktable/darktable.register_lib/" class = "" >
darktable.register_lib
2020-12-21 18:19:20 +00:00
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2021-02-04 03:15:37 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/darktable/darktable.register_storage/" class = "" >
darktable.register_storage
2020-12-21 18:19:20 +00:00
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2021-02-04 03:15:37 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/darktable/darktable.styles/" class = "" >
darktable.styles
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/darktable/darktable.tags/" class = "" >
darktable.tags
2020-12-21 18:19:20 +00:00
< / a >
< / li >
< / ul >
< / li >
< li class = "parent" >
< i class = "fa fa-plus-square toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/" class = "" >
types
< / a >
< ul >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/overview/" class = "" >
overview
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_os_type/" class = "" >
lua_os_type
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_lua_image_t/" class = "" >
dt_lua_image_t
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_format_t/" class = "" >
dt_imageio_module_format_t
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_format_data_png/" class = "" >
dt_imageio_module_format_data_png
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_format_data_tiff/" class = "" >
dt_imageio_module_format_data_tiff
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_format_data_exr/" class = "" >
dt_imageio_module_format_data_exr
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_format_data_copy/" class = "" >
dt_imageio_module_format_data_copy
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_format_data_pfm/" class = "" >
dt_imageio_module_format_data_pfm
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_format_data_jpeg/" class = "" >
dt_imageio_module_format_data_jpeg
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_format_data_ppm/" class = "" >
dt_imageio_module_format_data_ppm
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_format_data_webp/" class = "" >
dt_imageio_module_format_data_webp
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_format_data_j2k/" class = "" >
dt_imageio_module_format_data_j2k
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_format_data_pdf/" class = "" >
dt_imageio_module_format_data_pdf
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/_pdf_mode_t/" class = "" >
_pdf_mode_t
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/_pdf_pages_t/" class = "" >
_pdf_pages_t
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_pdf_stream_encoder_t/" class = "" >
dt_pdf_stream_encoder_t
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_storage_t/" class = "" >
dt_imageio_module_storage_t
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_storage_data_email/" class = "" >
dt_imageio_module_storage_data_email
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_storage_data_latex/" class = "" >
dt_imageio_module_storage_data_latex
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_storage_data_piwigo/" class = "" >
dt_imageio_module_storage_data_piwigo
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_storage_data_gallery/" class = "" >
dt_imageio_module_storage_data_gallery
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_storage_data_disk/" class = "" >
dt_imageio_module_storage_data_disk
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_lua_film_t/" class = "" >
dt_lua_film_t
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_style_t/" class = "" >
dt_style_t
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_style_item_t/" class = "" >
dt_style_item_t
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_lua_tag_t/" class = "" >
dt_lua_tag_t
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_lua_lib_t/" class = "" >
dt_lua_lib_t
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_lua_view_t/" class = "" >
dt_lua_view_t
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_lua_backgroundjob_t/" class = "" >
dt_lua_backgroundjob_t
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_lua_snapshot_t/" class = "" >
dt_lua_snapshot_t
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/hint_t/" class = "" >
hint_t
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_ui_container_t/" class = "" >
dt_ui_container_t
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/snapshot_direction_t/" class = "" >
snapshot_direction_t
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_j2k_format_t/" class = "" >
dt_imageio_j2k_format_t
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_j2k_preset_t/" class = "" >
dt_imageio_j2k_preset_t
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/comp_type_t/" class = "" >
comp_type_t
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_pref_type/" class = "" >
lua_pref_type
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_exr_compression_t/" class = "" >
dt_imageio_exr_compression_t
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_lib_collect_params_rule_t/" class = "" >
dt_lib_collect_params_rule_t
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_lib_collect_mode_t/" class = "" >
dt_lib_collect_mode_t
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_collection_properties_t/" class = "" >
dt_collection_properties_t
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_collection_sort_t/" class = "" >
dt_collection_sort_t
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_collection_sort_order_t/" class = "" >
dt_collection_sort_order_t
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_collection_filter_t/" class = "" >
dt_collection_filter_t
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_collection_rating_comperator_t/" class = "" >
dt_collection_rating_comperator_t
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_lua_orientation_t/" class = "" >
dt_lua_orientation_t
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_lua_align_t/" class = "" >
dt_lua_align_t
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_lua_ellipsize_mode_t/" class = "" >
dt_lua_ellipsize_mode_t
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_lua_cairo_t/" class = "" >
dt_lua_cairo_t
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_ui_panel_t/" class = "" >
dt_ui_panel_t
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_lighttable_layout_t/" class = "" >
dt_lighttable_layout_t
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_widget/" class = "" >
lua_widget
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_container/" class = "" >
lua_container
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_check_button/" class = "" >
lua_check_button
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_label/" class = "" >
lua_label
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_button/" class = "" >
lua_button
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_box/" class = "" >
lua_box
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_entry/" class = "" >
lua_entry
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_separator/" class = "" >
lua_separator
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_combobox/" class = "" >
lua_combobox
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_file_chooser_button/" class = "" >
lua_file_chooser_button
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_stack/" class = "" >
lua_stack
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_slider/" class = "" >
lua_slider
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_text_view/" class = "" >
lua_text_view
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_section_label/" class = "" >
lua_section_label
< / a >
< / li >
< / ul >
< / li >
< li class = "parent" >
< i class = "fa fa-plus-square toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/events/" class = "" >
events
< / a >
< ul >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/events/overview/" class = "" >
overview
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2021-02-04 03:15:37 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/events/exit/" class = "" >
exit
2020-12-21 18:19:20 +00:00
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2021-02-04 03:15:37 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/events/global_toolbox-grouping_toggle/" class = "" >
global_toolbox-grouping_toggle
2020-12-21 18:19:20 +00:00
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2021-02-04 03:15:37 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/events/global_toolbox-overlay_toggle/" class = "" >
global_toolbox-overlay_toggle
2020-12-21 18:19:20 +00:00
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2021-02-04 03:15:37 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/events/intermediate-export-image/" class = "" >
intermediate-export-image
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/events/mouse-over-image-changed/" class = "" >
mouse-over-image-changed
2020-12-21 18:19:20 +00:00
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/events/view-changed/" class = "" >
view_changed
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2021-02-04 03:15:37 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/events/post-import-film/" class = "" >
post-import-film
2020-12-21 18:19:20 +00:00
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2021-02-04 03:15:37 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/events/post-import-image/" class = "" >
post-import-image
2020-12-21 18:19:20 +00:00
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2021-02-04 03:15:37 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/events/pre-import/" class = "" >
pre-import
2020-12-21 18:19:20 +00:00
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2021-02-04 03:15:37 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/events/selection-changed/" class = "" >
selection-changed
2020-12-21 18:19:20 +00:00
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2021-02-04 03:15:37 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/events/shortcut/" class = "" >
shortcut
2020-12-21 18:19:20 +00:00
< / a >
< / li >
< / ul >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/attributes/" class = "" >
attributes
< / a >
< / li >
< / ul >
< / li >
< / ul >
< / nav >
< div class = "content col-sm-12 order-sm-1 col-md-9 mx-md-auto order-md-12" >
< div class = "crumbs" >
< span class = "crumb" >
< a href = 'https://darktable-org.github.io/luadocs/' > Home< / a > / < a href = 'https://darktable-org.github.io/luadocs/lua.api.manual/' > Lua API Manual< / a > / < a href = 'https://darktable-org.github.io/luadocs/lua.api.manual/darktable/' > darktable< / a > / darktable.gui
< / span >
< / div >
< div class = "prev-next row" >
< div class = "col-6" >
2021-02-04 03:15:37 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/darktable/darktable.gettext/" class = "next" > < darktable.gettext< / a >
2020-12-21 18:19:20 +00:00
< / div >
< div class = "col-6" >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/darktable/darktable.guides/" class = "prev" > darktable.guides > < / a >
< / div >
< / div >
< article role = "main" >
< h1 class = "title" >
darktable.gui
< / h1 >
< p > This subtable contains function and data to manipulate the darktable user interface with
Lua.
Most of these function won’ t do anything if the GUI is not enabled (i.e you are using the
command line version darktable-cli instead of darktable).< / p >
< h1 id = "darktableguiaction_images" > < a href = "#darktableguiaction_images" > 🔗< / a > darktable.gui.action_images< / h1 >
< p > < code > table< / code > < / p >
< p > A table of < a href = "../../types/dt_lua_image_t" > types.dt_lua_image_t< / a > on which the user expects UI actions to happen.
It is based on both the hovered image and the selection and is consistent with the way
darktable works.
It is recommended to use this table to implement Lua actions rather than < a href = "#darktable.gui.hovered" > darktable.gui.hovered< / a > or < a href = "#darktable.gui.selection" > darktable.gui.selection< / a > to be consistent with darktable’ s GUI.< / p >
< h1 id = "darktableguihovered" > < a href = "#darktableguihovered" > 🔗< / a > darktable.gui.hovered< / h1 >
< p > < code > types.dt_lua_image_t< / code > < / p >
< p > The image under the cursor or nil if no image is hovered.< / p >
< h1 id = "darktableguiselection" > < a href = "#darktableguiselection" > 🔗< / a > darktable.gui.selection< / h1 >
< pre > < code > function(
[selection : table of types.dt_lua_image_t]
) : table of types.dt_lua_image_t
< / code > < / pre > < p > Get or change the set of selected images.< / p >
< p > Attributes: < a href = "/luadocs/lua.api.manual/attributes/#implicit_yield" > implicit_yield< / a > < / p >
< ul >
< li > < strong > [selection]< / strong > - < em > table of < a href = "../../types/dt_lua_image_t" > types.dt_lua_image_t< / a > < / em > - A table of images which will define the selected images. If this parameter is not given
the selection will be untouched. If an empty table is given the selection will be emptied.< / li >
< li > < strong > return< / strong > - < em > table of < a href = "../../types/dt_lua_image_t" > types.dt_lua_image_t< / a > < / em > - A table containing the selection as it was before the function was called.< / li >
< / ul >
< h1 id = "darktableguicurrent_view" > < a href = "#darktableguicurrent_view" > 🔗< / a > darktable.gui.current_view< / h1 >
< pre > < code > function(
[view : types.dt_lua_view_t]
) : types.dt_lua_view_t
< / code > < / pre > < p > Get or change the current view.< / p >
< ul >
< li > < strong > [view]< / strong > - < a href = "../../types/dt_lua_view_t" > _types.dt_lua_view_t< / a > _ - The view to switch to. If empty the current view is unchanged< / li >
< li > < strong > return< / strong > - < a href = "../../types/dt_lua_view_t" > _types.dt_lua_view_t< / a > _ - the current view< / li >
< / ul >
< h1 id = "darktableguipanel_visible" > < a href = "#darktableguipanel_visible" > 🔗< / a > darktable.gui.panel_visible< / h1 >
< pre > < code > function(
panel : types.dt_ui_panel_t
) : boolean
< / code > < / pre > < p > Determines if the specified panel is visible.< / p >
< ul >
< li > < strong > panel< / strong > - < em > < a href = "../../types/dt_ui_panel_t" > types.dt_ui_panel_t< / a > < / em > - The panel to check.< / li >
< li > < strong > return< / strong > - < em > boolean< / em > - true if the panel is visible, false if not< / li >
< / ul >
< h1 id = "darktableguipanel_hide" > < a href = "#darktableguipanel_hide" > 🔗< / a > darktable.gui.panel_hide< / h1 >
< pre > < code > function(
panel : types.dt_ui_panel_t
)
< / code > < / pre > < p > Hides the specified panel.< / p >
< ul >
< li > < strong > panel< / strong > - < em > < a href = "../../types/dt_ui_panel_t" > types.dt_ui_panel_t< / a > < / em > - The panel to hide.< / li >
< / ul >
< h1 id = "darktableguipanel_show" > < a href = "#darktableguipanel_show" > 🔗< / a > darktable.gui.panel_show< / h1 >
< pre > < code > function(
panel : types.dt_ui_panel_t
)
< / code > < / pre > < p > Shows the specified panel.< / p >
< ul >
< li > < strong > panel< / strong > - < em > < a href = "../../types/dt_ui_panel_t" > types.dt_ui_panel_t< / a > < / em > - The panel to show.< / li >
< / ul >
< h1 id = "darktableguipanel_hide_all" > < a href = "#darktableguipanel_hide_all" > 🔗< / a > darktable.gui.panel_hide_all< / h1 >
< pre > < code > function(
)
< / code > < / pre > < p > Hide all panels.< / p >
< h1 id = "darktableguipanel_show_all" > < a href = "#darktableguipanel_show_all" > 🔗< / a > darktable.gui.panel_show_all< / h1 >
< pre > < code > function(
)
< / code > < / pre > < p > Show all panels.< / p >
< h1 id = "darktableguipanel_get_size" > < a href = "#darktableguipanel_get_size" > 🔗< / a > darktable.gui.panel_get_size< / h1 >
< pre > < code > function(
panel : types.dt_ui_panel_t
):int
< / code > < / pre > < p > Gets the size in pixels of the specified panel. This only works for the left, right, and bottom
panels.< / p >
< ul >
< li > < strong > panel< / strong > - < em > < a href = "../../types/dt_ui_panel_t" > types.dt_ui_panel_t< / a > < / em > - The panel to get the size of.< / li >
< / ul >
< h1 id = "darktableguipanel_set_size" > < a href = "#darktableguipanel_set_size" > 🔗< / a > darktable.gui.panel_set_size< / h1 >
< pre > < code > function(
panel : types.dt_ui_panel_t
size : int
)
< / code > < / pre > < p > Sets the size in pixels of the specified panel. This only works for the left, right, and bottom
panels.< / p >
< ul >
< li > < strong > panel< / strong > - < em > < a href = "../../types/dt_ui_panel_t" > types.dt_ui_panel_t< / a > < / em > - The panel to set the size of.< / li >
< li > < strong > size< / strong > - < em > int< / em > - The size to set the panel to.< / li >
< / ul >
< h1 id = "darktableguicreate_job" > < a href = "#darktableguicreate_job" > 🔗< / a > darktable.gui.create_job< / h1 >
< pre > < code > function(
text : string,
[percentage : boolean],
[cancel_callback : function]
) : types.dt_lua_backgroundjob_t
< / code > < / pre > < p > Create a new progress_bar displayed in < a href = "#darktable.gui.libs.backgroundjobs" > darktable.gui.libs.backgroundjobs< / a > < / p >
< ul >
< li >
< p > < strong > text< / strong > - < em > string< / em > - The text to display in the job entry< / p >
< / li >
< li >
< p > < strong > [percentage]< / strong > - < em > boolean< / em > - Should a progress bar be displayed< / p >
< / li >
< li >
< p > < strong > [cancel_callback]< / strong > - < em > < a href = "#cancel_callback" > function< / a > < / em > - A function called when the cancel button for that job is pressed. Note: the job won’ t be destroyed automatically. You need to set < a href = "../../types/dt_lua_backgroundjob_t#valid" > types.dt_lua_backgroundjob_t.valid< / a > to false for that.< / p >
< / li >
< li >
< p > < strong > return< / strong > - < em > < a href = "../../types/dt_lua_backgroundjob_t" > types.dt_lua_backgroundjob_t< / a > < / em > - The newly created job object< / p >
< / li >
< / ul >
< h2 id = "cancel_callback" > < a href = "#cancel_callback" > 🔗< / a > cancel_callback< / h2 >
< pre > < code > function(
job : types.dt_lua_backgroundjob_t
)
< / code > < / pre > < ul >
< li > < strong > job< / strong > - < em > < a href = "../../types/dt_lua_backgroundjob_t" > types.dt_lua_backgroundjob_t< / a > < / em > - The job who is being cancelled< / li >
< / ul >
< h1 id = "darktableguiviews" > < a href = "#darktableguiviews" > 🔗< / a > darktable.gui.views< / h1 >
< p > The different views in darktable< / p >
< h2 id = "darktableguiviewsmap" > < a href = "#darktableguiviewsmap" > 🔗< / a > darktable.gui.views.map< / h2 >
< p > The map view< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#has_tostring" > has_tostring< / a > < / li >
< li > < a href = "/luadocs/lua.api.manual/attributes/#paren" > parent< / a > : < a href = "../../types/dt_lua_view_t" > types.dt_lua_view_t< / a > < / li >
< / ul >
< h3 id = "darktableguiviewsmaplatitude" > < a href = "#darktableguiviewsmaplatitude" > 🔗< / a > darktable.gui.views.map.latitude< / h3 >
< ul >
< li > number - The latitude of the center of the map< / li >
< / ul >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#write" > write< / a > < / li >
< / ul >
< h3 id = "darktableguiviewsmaplongitude" > < a href = "#darktableguiviewsmaplongitude" > 🔗< / a > darktable.gui.views.map.longitude< / h3 >
< ul >
< li > number - The longitude of the center of the map< / li >
< / ul >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#write" > write< / a > < / li >
< / ul >
< h3 id = "darktableguiviewsmapzoom" > < a href = "#darktableguiviewsmapzoom" > 🔗< / a > darktable.gui.views.map.zoom< / h3 >
< ul >
< li > number - The current zoom level of the map< / li >
< / ul >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#write" > write< / a > < / li >
< / ul >
< h2 id = "darktableguiviewsdarkroom" > < a href = "#darktableguiviewsdarkroom" > 🔗< / a > darktable.gui.views.darkroom< / h2 >
< p > The darkroom view< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#has_tostring" > has_tostring< / a > < / li >
< li > < a href = "/luadocs/lua.api.manual/attributes/#parent" > parent< / a > : < a href = "../../types/dt_lua_view_t" > types.dt_lua_view_t< / a > < / li >
< / ul >
< h3 id = "darktableguiviewsdarkroomdisplay_image" > < a href = "#darktableguiviewsdarkroomdisplay_image" > 🔗< / a > darktable.gui.views.darkroom.display_image< / h3 >
< pre > < code > function(
[image : types.dt_lua_image_t]
) : types.dt_lua_image_t
< / code > < / pre > < p > Display an image in darkroom view.< / p >
< ul >
< li > **[image] - < em > < a href = "../../types/dt_lua_image_t" > types.dt_lua_image_t< / a > < / em > - The image to be displayed. If the image is not given, nothing will be changed.< / li >
< li > < strong > return< / strong > - < em > < a href = "../../types/dt_lua_image_t" > types.dt_lua_image_t< / a > < / em > - The image currently displayed.< / li >
< / ul >
< h2 id = "darktableguiviewslighttable" > < a href = "#darktableguiviewslighttable" > 🔗< / a > darktable.gui.views.lighttable< / h2 >
< p > The lighttable view< / p >
< p > Attributes:< / p >
< ul >
2020-12-22 05:33:45 +00:00
< li > < a href = "../../Attributes#has_tostring" > has_tostring< / a > < / li >
< li > < a href = "../../Attributes#parent" > parent< / a > : < a href = "../../types/dt_lua_view_t" > types.dt_lua_view_t< / a > < / li >
2020-12-21 18:19:20 +00:00
< / ul >
< h3 id = "darktableguiviewslighttableis_image_visible" > < a href = "#darktableguiviewslighttableis_image_visible" > 🔗< / a > darktable.gui.views.lighttable.is_image_visible< / h3 >
< pre > < code > function(
image : types.dt_lua_image_t
) : types.dt_lua_image_t
< / code > < / pre > < p > Check if the image is visible in lighttable view. The lighttable must be in file manager or
zoomable mode.< / p >
< ul >
< li > < strong > image< / strong > - < em > < a href = "../../types/dt_lua_image_t" > types.dt_lua_image_t< / a > < / em > - The image to be checked.< / li >
< li > < strong > return< / strong > - < em > boolean< / em > - True if the image is displayed. False if the image is partially displayed or not displayed.< / li >
< / ul >
< h3 id = "darktableguiviewslighttableset_image_visible" > < a href = "#darktableguiviewslighttableset_image_visible" > 🔗< / a > darktable.gui.views.lighttable.set_image_visible< / h3 >
< pre > < code > function(
image : types.dt_lua_image_t
) : types.dt_lua_image_t
< / code > < / pre > < p > Set the image visible in lighttable view. The lighttable must be in file manager or zoomable
mode.< / p >
< ul >
< li > < strong > image< / strong > - < em > < a href = "../../types/dt_lua_image_t" > types.dt_lua_image_t< / a > < / em > - The image to set visible.< / li >
< li > < strong > return< / strong > - < em > int< / em > - An error is returned if no image is specified.< / li >
< / ul >
< h2 id = "darktableguiviewstethering" > < a href = "#darktableguiviewstethering" > 🔗< / a > darktable.gui.views.tethering< / h2 >
< p > The tethering view< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#has_tostring" > has_tostring< / a > < / li >
< li > < a href = "/luadocs/lua.api.manual/attributes/#parent" > parent< / a > : < a href = "../../types/dt_lua_view_t" > types.dt_lua_view_t< / a > < / li >
< / ul >
< h2 id = "darktableguiviewsslideshow" > < a href = "#darktableguiviewsslideshow" > 🔗< / a > darktable.gui.views.slideshow< / h2 >
< p > The slideshow view< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#has_tostring" > has_tostring< / a > < / li >
< li > < a href = "/luadocs/lua.api.manual/attributes/#parent" > parent< / a > : < a href = "../../types/dt_lua_view_t" > types.dt_lua_view_t< / a > < / li >
< / ul >
< h2 id = "darktableguiviewsprint" > < a href = "#darktableguiviewsprint" > 🔗< / a > darktable.gui.views.print< / h2 >
< p > The print view< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#has_tostring" > has_tostring< / a > < / li >
< li > < a href = "/luadocs/lua.api.manual/attributes/#parent" > parent< / a > : < a href = "../../types/dt_lua_view_t" > types.dt_lua_view_t< / a > < / li >
< / ul >
< h1 id = "darktableguilibs" > < a href = "#darktableguilibs" > 🔗< / a > darktable.gui.libs< / h1 >
< p > This table allows referencing all lib objects.
lib objects are the graphical blocks within each view.
To quickly figure out which lib is which, you can use the following code, which will make a
given lib blink.< / p >
< pre > < code > local dt = require " darktable"
local tested_module=" global_toolbox"
dt.gui.libs[tested_module].visible=false
dt.control.sleep(2000)
while true do
dt.gui.libs[tested_module].visible = not dt.gui.libs[tested_module].visible
dt.control.sleep(2000)
end
< / code > < / pre > < h3 id = "darktableguilibssnapshots" > < a href = "#darktableguilibssnapshots" > 🔗< / a > darktable.gui.libs.snapshots< / h3 >
< p > The UI element that manipulates snapshots in darkroom< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#has_tostring" > has_tostring< / a > < / li >
< li > < a href = "/luadocs/lua.api.manual/attributes/#parent" > parent< / a > : < a href = "../../types/dt_lua_lib_t" > types.dt_lua_lib_t< / a > < / li >
< / ul >
< h3 id = "darktableguilibssnapshotsratio" > < a href = "#darktableguilibssnapshotsratio" > 🔗< / a > darktable.gui.libs.snapshots.ratio< / h3 >
< p > number - The place in the screen where the line separating the snapshot is. Between 0 and 1< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#write" > write< / a > < / li >
< / ul >
< p > darktable.gui.libs.snapshots.direction< / p >
< p > < a href = "../../types/snapshot_direction_t" > types.snapshot_direction_t< / a > - The direction of the snapshot overlay< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#write" > write< / a > < / li >
< / ul >
< h3 id = "darktableguilibssnapshots-1" > < a href = "#darktableguilibssnapshots-1" > 🔗< / a > darktable.gui.libs.snapshots.#< / h3 >
< p > < a href = "../../types/snapshot_direction_t" > types.snapshot_direction_t< / a > - The different snapshots for the image< / p >
< h3 id = "darktableguilibssnapshotsselected" > < a href = "#darktableguilibssnapshotsselected" > 🔗< / a > darktable.gui.libs.snapshots.selected< / h3 >
< p > < a href = "../../types/snapshot_direction_t" > types.snapshot_direction_t< / a > - The currently selected snapshot< / p >
< h3 id = "darktableguilibssnapshotstake_snapshot" > < a href = "#darktableguilibssnapshotstake_snapshot" > 🔗< / a > darktable.gui.libs.snapshots.take_snapshot< / h3 >
< pre > < code > function(
)
< / code > < / pre > < p > Take a snapshot of the current image and add it to the UI
The snapshot file will be generated at the next redraw of the main window< / p >
< h3 id = "darktableguilibssnapshotsmax_snapshot" > < a href = "#darktableguilibssnapshotsmax_snapshot" > 🔗< / a > darktable.gui.libs.snapshots.max_snapshot< / h3 >
< p > number - The maximum number of snapshots< / p >
< h2 id = "darktableguilibscollect" > < a href = "#darktableguilibscollect" > 🔗< / a > darktable.gui.libs.collect< / h2 >
< p > The collection UI element that allows to filter images by collection< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#has_tostring" > has_tostring< / a > < / li >
< li > < a href = "/luadocs/lua.api.manual/attributes/#parent" > parent< / a > : < a href = "../../types/dt_lua_lib_t" > types.dt_lua_lib_t< / a > < / li >
< / ul >
< h3 id = "darktableguilibscollectfilter" > < a href = "#darktableguilibscollectfilter" > 🔗< / a > darktable.gui.libs.collect.filter< / h3 >
< pre > < code > function(
[rules : array of types.dt_lib_collect_params_rule_t]
) : array oftypes.dt_lib_collect_params_rule_t
< / code > < / pre > < p > Get or change the list of visible images< / p >
< p > Attributes:< / p >
< ul >
< li >
< p > < a href = "/luadocs/lua.api.manual/attributes/#implicit_yield" > implicit_yield< / a > < / p >
< / li >
< li >
< p > < strong > [rules]< / strong > - < em > array of < a href = "../../types/dt_lib_collect_params_rule_t" > types.dt_lib_collect_params_rule_t< / a > < / em > - A table of rules describing the filter. These rules will be applied after this call< / p >
< / li >
< li >
< p > < strong > return< / strong > - < em > array of < a href = "../../types/dt_lib_collect_params_rule_t" > types.dt_lib_collect_params_rule_t< / a > < / em > - The rules that were applied before this call.< / p >
< / li >
< / ul >
< h3 id = "darktableguilibscollectnew_rule" > < a href = "#darktableguilibscollectnew_rule" > 🔗< / a > darktable.gui.libs.collect.new_rule< / h3 >
< pre > < code > function(
) : types.dt_lib_collect_params_rule_t
< / code > < / pre > < p > Returns a newly created rule object< / p >
< ul >
< li > < strong > return< / strong > - < em > < a href = "../../types/dt_lib_collect_params_rule_t" > types.dt_lib_collect_params_rule_t< / a > < / em > - The newly created rule< / li >
< / ul >
< h2 id = "darktableguilibsimport" > < a href = "#darktableguilibsimport" > 🔗< / a > darktable.gui.libs.import< / h2 >
< p > The buttons to start importing images< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#has_tostring" > has_tostring< / a > < / li >
< li > < a href = "/luadocs/lua.api.manual/attributes/#parent" > parent< / a > : < a href = "../../types/dt_lua_lib_t" > types.dt_lua_lib_t< / a > < / li >
< / ul >
< h3 id = "darktableguilibsimportregister_widget" > < a href = "#darktableguilibsimportregister_widget" > 🔗< / a > darktable.gui.libs.import.register_widget< / h3 >
< pre > < code > function(
widget : types.lua_widget
)
< / code > < / pre > < p > Add a widget in the option expander of the import dialog< / p >
< ul >
< li > < strong > widget< / strong > - < em > < a href = "../../types/lua_widget" > types.lua_widget< / a > < / em > - The widget to add to the dialog. The reset callback of the widget will be called whenever the dialog is opened.< / li >
< / ul >
< h2 id = "darktableguilibsstyles" > < a href = "#darktableguilibsstyles" > 🔗< / a > darktable.gui.libs.styles< / h2 >
< p > The style selection menu< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#has_tostring" > has_tostring< / a > < / li >
< li > < a href = "/luadocs/lua.api.manual/attributes/#parent" > parent< / a > : < a href = "../../types/dt_lua_lib_t" > types.dt_lua_lib_t< / a > < / li >
< / ul >
< h2 id = "darktableguilibsmetadata_view" > < a href = "#darktableguilibsmetadata_view" > 🔗< / a > darktable.gui.libs.metadata_view< / h2 >
< p > The widget displaying metadata about the current image< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#has_tostring" > has_tostring< / a > < / li >
< li > < a href = "/luadocs/lua.api.manual/attributes/#parent" > parent< / a > : < a href = "../../types/dt_lua_lib_t" > types.dt_lua_lib_t< / a > < / li >
< / ul >
< h3 id = "darktableguilibsmetadata_viewregister_info" > < a href = "#darktableguilibsmetadata_viewregister_info" > 🔗< / a > darktable.gui.libs.metadata_view.register_info< / h3 >
< pre > < code > function(
name : string,
callback : function
)
2021-01-28 19:59:40 +00:00
< / code > < / pre > < p > Register a field in the image information module with a callback function to update the field< / p >
2020-12-21 18:19:20 +00:00
< ul >
< li > < strong > name< / strong > - < em > string< / em > - The name displayed for the new information< / li >
< li > < strong > callback< / strong > - < em > function< / em > - The function providing the info< / li >
< / ul >
< p > callback -< / p >
< pre > < code > function(
image : types.dt_lua_image_t
) : string
< / code > < / pre > < ul >
< li > < strong > image< / strong > - < em > < a href = "../../types/dt_lua_image_t" > types.dt_lua_image_t< / a > < / em > - The image to analyze< / li >
< li > < strong > return< / strong > - < em > string< / em > - The extra information to display< / li >
< / ul >
2021-01-28 19:59:40 +00:00
< h3 id = "darktableguilibsmetadata_viewdestroy_info" > < a href = "#darktableguilibsmetadata_viewdestroy_info" > 🔗< / a > darktable.gui.libs.metadata_view.destroy_info< / h3 >
< p > < strong > lua API 6.2.0< / strong > < / p >
< pre > < code > function(
name : string
)
< / code > < / pre > < p > Remove the named field from the image information module and it’ s associated callback< / p >
< ul >
< li > < strong > name< / strong > - < em > string< / em > - The name of the field, created by < a href = "#darktable.gui.libs.metadata_view.register_info" > darktable.gui.libs.metadata_view.register_info< / a > , to remove< / li >
< / ul >
2020-12-21 18:19:20 +00:00
< h2 id = "darktableguilibsmetadata" > < a href = "#darktableguilibsmetadata" > 🔗< / a > darktable.gui.libs.metadata< / h2 >
< p > The widget allowing modification of metadata fields on the current image< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#has_tostring" > has_tostring< / a > < / li >
< li > < a href = "/luadocs/lua.api.manual/attributes/#parent" > parent< / a > : < a href = "../../types/dt_lua_lib_t" > types.dt_lua_lib_t< / a > < / li >
< / ul >
< h2 id = "darktableguilibshinter" > < a href = "#darktableguilibshinter" > 🔗< / a > darktable.gui.libs.hinter< / h2 >
< p > The small line of text at the top of the UI showing the number of selected images< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#has_tostring" > has_tostring< / a > < / li >
< li > < a href = "/luadocs/lua.api.manual/attributes/#parent" > parent< / a > : < a href = "../../types/dt_lua_lib_t" > types.dt_lua_lib_t< / a > < / li >
< / ul >
< h2 id = "darktableguilibsfilmstrip" > < a href = "#darktableguilibsfilmstrip" > 🔗< / a > darktable.gui.libs.filmstrip< / h2 >
< p > The filmstrip at the bottom of some views< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#has_tostring" > has_tostring< / a > < / li >
< li > < a href = "/luadocs/lua.api.manual/attributes/#parent" > parent< / a > : < a href = "../../types/dt_lua_lib_t" > types.dt_lua_lib_t< / a > < / li >
< / ul >
< h2 id = "darktableguilibsviewswitcher" > < a href = "#darktableguilibsviewswitcher" > 🔗< / a > darktable.gui.libs.viewswitcher< / h2 >
< p > The labels allowing to switch view< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#has_tostring" > has_tostring< / a > < / li >
< li > < a href = "/luadocs/lua.api.manual/attributes/#parent" > parent< / a > : < a href = "../../types/dt_lua_lib_t" > types.dt_lua_lib_t< / a > < / li >
< / ul >
< h2 id = "darktableguilibsdarktable_label" > < a href = "#darktableguilibsdarktable_label" > 🔗< / a > darktable.gui.libs.darktable_label< / h2 >
< p > The darktable logo in the upper left corner< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#has_tostring" > has_tostring< / a > < / li >
< li > < a href = "/luadocs/lua.api.manual/attributes/#parent" > parent< / a > : < a href = "../../types/dt_lua_lib_t" > types.dt_lua_lib_t< / a > < / li >
< / ul >
< h2 id = "darktableguilibstagging" > < a href = "#darktableguilibstagging" > 🔗< / a > darktable.gui.libs.tagging< / h2 >
< p > The tag manipulation UI< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#has_tostring" > has_tostring< / a > < / li >
< li > < a href = "/luadocs/lua.api.manual/attributes/#parent" > parent< / a > : < a href = "../../types/dt_lua_lib_t" > types.dt_lua_lib_t< / a > < / li >
< / ul >
< h2 id = "darktableguilibsgeotagging" > < a href = "#darktableguilibsgeotagging" > 🔗< / a > darktable.gui.libs.geotagging< / h2 >
< p > The geotagging time synchronisation UI< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#has_tostring" > has_tostring< / a > < / li >
< li > < a href = "/luadocs/lua.api.manual/attributes/#parent" > parent< / a > : < a href = "../../types/dt_lua_lib_t" > types.dt_lua_lib_t< / a > < / li >
< / ul >
< h2 id = "darktableguilibsrecentcollect" > < a href = "#darktableguilibsrecentcollect" > 🔗< / a > darktable.gui.libs.recentcollect< / h2 >
< p > The recent collection UI element< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#has_tostring" > has_tostring< / a > < / li >
< li > < a href = "/luadocs/lua.api.manual/attributes/#parent" > parent< / a > : < a href = "../../types/dt_lua_lib_t" > types.dt_lua_lib_t< / a > < / li >
< / ul >
< h2 id = "darktableguilibsglobal_toolbox" > < a href = "#darktableguilibsglobal_toolbox" > 🔗< / a > darktable.gui.libs.global_toolbox< / h2 >
< p > The common tools to all view (settings, grouping… )< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#has_tostring" > has_tostring< / a > < / li >
< li > < a href = "/luadocs/lua.api.manual/attributes/#parent" > parent< / a > : < a href = "../../types/dt_lua_lib_t" > types.dt_lua_lib_t< / a > < / li >
< / ul >
< h3 id = "darktableguilibsglobal_toolboxgrouping" > < a href = "#darktableguilibsglobal_toolboxgrouping" > 🔗< / a > darktable.gui.libs.global_toolbox.grouping< / h3 >
< p > boolean- The current status of the image grouping option< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#write" > write< / a > < / li >
< / ul >
< h3 id = "darktableguilibsglobal_toolboxshow_overlays" > < a href = "#darktableguilibsglobal_toolboxshow_overlays" > 🔗< / a > darktable.gui.libs.global_toolbox.show_overlays< / h3 >
< p > boolean - the current status of the image overlays option< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#write" > write< / a > < / li >
< / ul >
< h2 id = "darktableguilibsfilter" > < a href = "#darktableguilibsfilter" > 🔗< / a > darktable.gui.libs.filter< / h2 >
< p > The image-filter menus at the top of the UI< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#has_tostring" > has_tostring< / a > < / li >
< li > < a href = "/luadocs/lua.api.manual/attributes/#parent" > parent< / a > : < a href = "../../types/dt_lua_lib_t" > types.dt_lua_lib_t< / a > < / li >
< / ul >
< h3 id = "darktableguilibsfiltersort" > < a href = "#darktableguilibsfiltersort" > 🔗< / a > darktable.gui.libs.filter.sort< / h3 >
< pre > < code > function(
[sort : types.dt_collection_sort_t]
) : types.dt_collection_sort_t
< / code > < / pre > < p > Change the collection sort field.< / p >
< ul >
< li > < strong > [sort]< / strong > - < em > < a href = "../../types/dt_collection_sort_t" > types.dt_collection_sort_t< / a > < / em > - The new field to sort by. If empty the current sort field is unchanged< / li >
< li > < strong > return< / strong > - < em > < a href = "../../types/dt_collection_sort_t" > types.dt_collection_sort_t< / a > < / em > = The current sort field.< / li >
< / ul >
< h3 id = "darktableguilibsfiltersort_order" > < a href = "#darktableguilibsfiltersort_order" > 🔗< / a > darktable.gui.libs.filter.sort_order< / h3 >
< pre > < code > function(
[order : types.dt_collection_sort_order_t]
) : types.dt_collection_sort_order_t
< / code > < / pre > < p > Change the collection sort order.< / p >
< ul >
< li > < strong > [order]< / strong > - < em > < a href = "../../types/dt_collection_sort_order_t" > types.dt_collection_sort_order_t< / a > < / em > - The order to sort by. If empty the current sort order is unchanged.< / li >
< li > < strong > return< / strong > - < em > < a href = "../../types/dt_collection_sort_order_t" > types.dt_collection_sort_order_t< / a > < / em > - The current sort order.< / li >
< / ul >
< h3 id = "darktableguilibsfilterrating" > < a href = "#darktableguilibsfilterrating" > 🔗< / a > darktable.gui.libs.filter.rating< / h3 >
< pre > < code > function(
[rating : types.dt_collection_filter_t]
) : types.dt_collection_filter_t
< / code > < / pre > < p > Change the collection rating filter.< / p >
< ul >
< li > < strong > [rating]< / strong > - < em > < a href = "../../types/dt_collection_filter_t" > types.dt_collection_filter_t< / a > < / em > - The new rating field to filter by. If empty the current rating field is unchanged.< / li >
< li > < strong > return< / strong > - < a href = "../../types/dt_collection_filter_t" > types.dt_collection_filter_t< / a > - The current rating field.< / li >
< / ul >
< h3 id = "darktableguilibsfilterrating_comparator" > < a href = "#darktableguilibsfilterrating_comparator" > 🔗< / a > darktable.gui.libs.filter.rating_comparator< / h3 >
< pre > < code > function(
[comparator : types.dt_collection_rating_comperator_t]
) : types.dt_collection_rating_comperator_t
< / code > < / pre > < p > Change the collection filter comparison field.< / p >
< ul >
< li > < strong > [comparator]< / strong > - < em > < a href = "../../types/dt_collection_rating_comperator_t" > types.dt_collection_rating_comperator_t< / a > < / em > - The new comparison field to filter the rating by. If empty the current rating comparison field is unchanged< / li >
< li > < strong > return< / strong > - < em > < a href = "../../types/dt_collection_rating_comperator_t" > types.dt_collection_rating_comperator_t< / a > < / em > - The current rating comparison field< / li >
< / ul >
< h2 id = "darktableguilibsratings" > < a href = "#darktableguilibsratings" > 🔗< / a > darktable.gui.libs.ratings< / h2 >
< p > The stars to set the rating of an image< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#has_tostring" > has_tostring< / a > < / li >
< li > < a href = "/luadocs/lua.api.manual/attributes/#parent" > parent< / a > : < a href = "../../types/dt_lua_lib_t" > types.dt_lua_lib_t< / a > < / li >
< / ul >
< h2 id = "darktableguilibsselect" > < a href = "#darktableguilibsselect" > 🔗< / a > darktable.gui.libs.select< / h2 >
< p > The buttons that allow to quickly change the selection< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#has_tostring" > has_tostring< / a > < / li >
< li > < a href = "/luadocs/lua.api.manual/attributes/#parent" > parent< / a > : < a href = "../../types/dt_lua_lib_t" > types.dt_lua_lib_t< / a > < / li >
< / ul >
< h3 id = "darktableguilibsselectregister_selection" > < a href = "#darktableguilibsselectregister_selection" > 🔗< / a > darktable.gui.libs.select.register_selection< / h3 >
< pre > < code > function(
label : string,
callback : function,
[tooltip : string]
)
< / code > < / pre > < p > Add a new button and call a callback when it is clicked< / p >
< ul >
< li > < strong > label< / strong > - < em > string< / em > - The label to display on the button< / li >
< li > < strong > callback< / strong > - < em > function< / em > - The function to call when the button is pressed< / li >
< li > < strong > [tooltip]< / strong > - < em > string< / em > - The tooltip to use on the new button< / li >
< / ul >
< p > callback -< / p >
< pre > < code > function(
event : string,
images : table oftypes.dt_lua_image_t
) : table oftypes.dt_lua_image_t
< / code > < / pre > < p > The function to call when the button is pressed< / p >
< ul >
< li > < strong > event< / strong > - < em > string< / em > - The name of the button that was pressed< / li >
< li > < strong > images< / strong > - < em > table of < a href = "../../types/dt_lua_image_t" > types.dt_lua_image_t< / a > < / em > - The images in the current collection. This is the same content asdarktable.collection< / li >
< li > < strong > return< / strong > - < em > table of < a href = "../../types/dt_lua_image_t" > types.dt_lua_image_t< / a > < / em > - The images to set the selection to< / li >
< / ul >
< h2 id = "darktableguilibscolorlabels" > < a href = "#darktableguilibscolorlabels" > 🔗< / a > darktable.gui.libs.colorlabels< / h2 >
< p > The color buttons that allow to set labels on an image< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#has_tostring" > has_tostring< / a > < / li >
< li > < a href = "/luadocs/lua.api.manual/attributes/#parent" > parent< / a > : < a href = "../../types/dt_lua_lib_t" > types.dt_lua_lib_t< / a > < / li >
< / ul >
< h2 id = "darktableguilibslighttable_mode" > < a href = "#darktableguilibslighttable_mode" > 🔗< / a > darktable.gui.libs.lighttable_mode< / h2 >
< p > The navigation and zoom level UI in lighttable< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#has_tostring" > has_tostring< / a > < / li >
< li > < a href = "/luadocs/lua.api.manual/attributes/#parent" > parent< / a > : < a href = "../../types/dt_lua_lib_t" > types.dt_lua_lib_t< / a > < / li >
< / ul >
< h3 id = "darktableguilibslighttable_modelayout" > < a href = "#darktableguilibslighttable_modelayout" > 🔗< / a > darktable.gui.libs.lighttable_mode.layout< / h3 >
< pre > < code > function(
[layout : types.dt_lighttable_layout_t]
) : types.dt_lighttable_layout_t
< / code > < / pre > < p > Change the lighttable layout.< / p >
< ul >
< li > < strong > [layout]< / strong > - < em > < a href = "../../types/dt_lighttable_layout_t" > types.dt_lighttable_layout_t< / a > < / em > - The layout to switch to. If empty the current layout is unchanged< / li >
< li > < strong > return< / strong > - < em > < a href = "../../types/dt_lighttable_layout_t" > types.dt_lighttable_layout_t< / a > < / em > - the current layout< / li >
< / ul >
< h3 id = "darktableguilibslighttable_modezoom_level" > < a href = "#darktableguilibslighttable_modezoom_level" > 🔗< / a > darktable.gui.libs.lighttable_mode.zoom_level< / h3 >
< pre > < code > function(
[level : int]
) : int
< / code > < / pre > < p > Change the lighttable zoom level.< / p >
< ul >
< li > < strong > [level]< / strong > - < em > int< / em > - The zoom level to switch to. If empty the current zoom level is unchanged< / li >
< li > < strong > return< / strong > - < em > int< / em > - the current zoom level< / li >
< / ul >
< h2 id = "darktableguilibscopy_history" > < a href = "#darktableguilibscopy_history" > 🔗< / a > darktable.gui.libs.copy_history< / h2 >
< p > The UI element that manipulates history< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#has_tostring" > has_tostring< / a > < / li >
< li > < a href = "/luadocs/lua.api.manual/attributes/#parent" > parent< / a > : < a href = "../../types/dt_lua_lib_t" > types.dt_lua_lib_t< / a > < / li >
< / ul >
< h2 id = "darktableguilibsimage" > < a href = "#darktableguilibsimage" > 🔗< / a > darktable.gui.libs.image< / h2 >
< p > The UI element that manipulates the current images< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#has_tostring" > has_tostring< / a > < / li >
< li > < a href = "/luadocs/lua.api.manual/attributes/#parent" > parent< / a > : < a href = "../../types/dt_lua_lib_t" > types.dt_lua_lib_t< / a > < / li >
< / ul >
< h3 id = "darktableguilibsimageregister_action" > < a href = "#darktableguilibsimageregister_action" > 🔗< / a > darktable.gui.libs.image.register_action< / h3 >
< pre > < code > function(
label : string,
callback : function,
[tooltip : string]
)
< / code > < / pre > < p > Add a new button and call a callback when it is clicked< / p >
< ul >
< li > < strong > label< / strong > - < em > string< / em > - The label to display on the button< / li >
< li > < strong > callback< / strong > - < em > function< / em > - The function to call when the button is pressed< / li >
< li > < strong > [tooltip]< / strong > - < em > string< / em > - The tooltip to use on the new button< / li >
< / ul >
< p > callback -< / p >
< pre > < code > function(
event : string,
images : table oftypes.dt_lua_image_t
)
< / code > < / pre > < p > The function to call when the button is pressed< / p >
< ul >
< li > < strong > event< / strong > - < em > string< / em > - The name of the button that was pressed< / li >
< li > < strong > images< / strong > - < em > table of < a href = "../../types/dt_lua_image_t" > types.dt_lua_image_t< / a > < / em > - The images to act on when the button was clicked< / li >
< / ul >
< h2 id = "darktableguilibsmodulegroups" > < a href = "#darktableguilibsmodulegroups" > 🔗< / a > darktable.gui.libs.modulegroups< / h2 >
< p > The icons describing the different iop groups< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#has_tostring" > has_tostring< / a > < / li >
< li > < a href = "/luadocs/lua.api.manual/attributes/#parent" > parent< / a > : < a href = "../../types/dt_lua_lib_t" > types.dt_lua_lib_t< / a > < / li >
< / ul >
< h2 id = "darktableguilibsmodule_toolbox" > < a href = "#darktableguilibsmodule_toolbox" > 🔗< / a > darktable.gui.libs.module_toolbox< / h2 >
< p > The tools on the bottom line of the UI (overexposure)< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#has_tostring" > has_tostring< / a > < / li >
< li > < a href = "/luadocs/lua.api.manual/attributes/#parent" > parent< / a > : < a href = "../../types/dt_lua_lib_t" > types.dt_lua_lib_t< / a > < / li >
< / ul >
< h2 id = "darktableguilibssession" > < a href = "#darktableguilibssession" > 🔗< / a > darktable.gui.libs.session< / h2 >
< p > The session UI when tethering< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#has_tostring" > has_tostring< / a > < / li >
< li > < a href = "/luadocs/lua.api.manual/attributes/#parent" > parent< / a > : < a href = "../../types/dt_lua_lib_t" > types.dt_lua_lib_t< / a > < / li >
< / ul >
< h2 id = "darktableguilibshistogram" > < a href = "#darktableguilibshistogram" > 🔗< / a > darktable.gui.libs.histogram< / h2 >
< p > The histogram widget< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#has_tostring" > has_tostring< / a > < / li >
< li > < a href = "/luadocs/lua.api.manual/attributes/#parent" > parent< / a > : < a href = "../../types/dt_lua_lib_t" > types.dt_lua_lib_t< / a > < / li >
< / ul >
< h2 id = "darktableguilibsexport" > < a href = "#darktableguilibsexport" > 🔗< / a > darktable.gui.libs.export< / h2 >
< p > The export menu< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#has_tostring" > has_tostring< / a > < / li >
< li > < a href = "/luadocs/lua.api.manual/attributes/#parent" > parent< / a > : < a href = "../../types/dt_lua_lib_t" > types.dt_lua_lib_t< / a > < / li >
< / ul >
< h2 id = "darktableguilibshistory" > < a href = "#darktableguilibshistory" > 🔗< / a > darktable.gui.libs.history< / h2 >
< p > The history manipulation menu< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#has_tostring" > has_tostring< / a > < / li >
< li > < a href = "/luadocs/lua.api.manual/attributes/#parent" > parent< / a > : < a href = "../../types/dt_lua_lib_t" > types.dt_lua_lib_t< / a > < / li >
< / ul >
< h2 id = "darktableguilibscolorpicker" > < a href = "#darktableguilibscolorpicker" > 🔗< / a > darktable.gui.libs.colorpicker< / h2 >
< p > The colorpicker menu< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#has_tostring" > has_tostring< / a > < / li >
< li > < a href = "/luadocs/lua.api.manual/attributes/#parent" > parent< / a > : < a href = "../../types/dt_lua_lib_t" > types.dt_lua_lib_t< / a > < / li >
< / ul >
< h2 id = "darktableguilibsnavigation" > < a href = "#darktableguilibsnavigation" > 🔗< / a > darktable.gui.libs.navigation< / h2 >
< p > The full image preview to allow navigation< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#has_tostring" > has_tostring< / a > < / li >
< li > < a href = "/luadocs/lua.api.manual/attributes/#parent" > parent< / a > : < a href = "../../types/dt_lua_lib_t" > types.dt_lua_lib_t< / a > < / li >
< / ul >
< h2 id = "darktableguilibsmasks" > < a href = "#darktableguilibsmasks" > 🔗< / a > darktable.gui.libs.masks< / h2 >
< p > The masks window< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#has_tostring" > has_tostring< / a > < / li >
< li > < a href = "/luadocs/lua.api.manual/attributes/#parent" > parent< / a > : < a href = "../../types/dt_lua_lib_t" > types.dt_lua_lib_t< / a > < / li >
< / ul >
< h2 id = "darktableguilibsview_toolbox" > < a href = "#darktableguilibsview_toolbox" > 🔗< / a > darktable.gui.libs.view_toolbox< / h2 >
< p > The view_toolbox window< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#has_tostring" > has_tostring< / a > < / li >
< li > < a href = "/luadocs/lua.api.manual/attributes/#parent" > parent< / a > : < a href = "../../types/dt_lua_lib_t" > types.dt_lua_lib_t< / a > < / li >
< / ul >
< h2 id = "darktableguilibslive_view" > < a href = "#darktableguilibslive_view" > 🔗< / a > darktable.gui.libs.live_view< / h2 >
< p > The liveview window< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#has_tostring" > has_tostring< / a > < / li >
< li > < a href = "/luadocs/lua.api.manual/attributes/#parent" > parent< / a > : < a href = "../../types/dt_lua_lib_t" > types.dt_lua_lib_t< / a > < / li >
< / ul >
< h2 id = "darktableguilibsmap_settings" > < a href = "#darktableguilibsmap_settings" > 🔗< / a > darktable.gui.libs.map_settings< / h2 >
< p > The map setting window< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#has_tostring" > has_tostring< / a > < / li >
< li > < a href = "/luadocs/lua.api.manual/attributes/#parent" > parent< / a > : < a href = "../../types/dt_lua_lib_t" > types.dt_lua_lib_t< / a > < / li >
< / ul >
< h2 id = "darktableguilibscamera" > < a href = "#darktableguilibscamera" > 🔗< / a > darktable.gui.libs.camera< / h2 >
< p > The camera selection UI< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#has_tostring" > has_tostring< / a > < / li >
< li > < a href = "/luadocs/lua.api.manual/attributes/#parent" > parent< / a > : < a href = "../../types/dt_lua_lib_t" > types.dt_lua_lib_t< / a > < / li >
< / ul >
< h2 id = "darktableguilibslocation" > < a href = "#darktableguilibslocation" > 🔗< / a > darktable.gui.libs.location< / h2 >
< p > The location ui< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#has_tostring" > has_tostring< / a > < / li >
< li > < a href = "/luadocs/lua.api.manual/attributes/#parent" > parent< / a > : < a href = "../../types/dt_lua_lib_t" > types.dt_lua_lib_t< / a > < / li >
< / ul >
< h2 id = "darktableguilibsbackgroundjobs" > < a href = "#darktableguilibsbackgroundjobs" > 🔗< / a > darktable.gui.libs.backgroundjobs< / h2 >
< p > The window displaying the currently running jobs< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#has_tostring" > has_tostring< / a > < / li >
< li > < a href = "/luadocs/lua.api.manual/attributes/#parent" > parent< / a > : < a href = "../../types/dt_lua_lib_t" > types.dt_lua_lib_t< / a > < / li >
< / ul >
< h2 id = "darktableguilibsprint_settings" > < a href = "#darktableguilibsprint_settings" > 🔗< / a > darktable.gui.libs.print_settings< / h2 >
< p > The settings window in the print view< / p >
< p > Attributes:< / p >
< ul >
< li > < a href = "/luadocs/lua.api.manual/attributes/#has_tostring" > has_tostring< / a > < / li >
< li > < a href = "/luadocs/lua.api.manual/attributes/#parent" > parent< / a > : < a href = "../../types/dt_lua_lib_t" > types.dt_lua_lib_t< / a > < / li >
< / ul >
< / article >
< div class = "prev-next row" >
< div class = "col-6" >
2021-02-04 03:15:37 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/darktable/darktable.gettext/" class = "next" > < darktable.gettext< / a >
2020-12-21 18:19:20 +00:00
< / div >
< div class = "col-6" >
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/darktable/darktable.guides/" class = "prev" > darktable.guides > < / a >
< / div >
< / div >
< / div >
< / div >
< / div >
< / body >
< / html >
< script >
(function($) {
$.fn.scrollToMiddle = function(options) {
var settings = $.extend({
duration: 0
}, options );
return this.each(function() {
var $el = $(this);
var elOffset = $el.offset().top;
var elHeight = $el.height();
var windowHeight = $(window).height();
var offset;
if (elHeight < windowHeight ) {
offset = elOffset - ((windowHeight / 2) - (elHeight / 2));
}
else {
offset = elOffset;
}
$('.navigation').scrollTop(offset);
});
};
}(jQuery));
$('.navigation').css('opacity', '0');
$(document).ready(function(){
$('.parent ul').hide();
$('.navigation').css('opacity', 1.0);
$('.active').parents('ul').show();
$('.active').siblings('ul').show();
$('.active').children('i.toggle').removeClass("fa-plus-squre").addClass("fa-minus-square-o");
$('.active').parents('li').children('.toggle').removeClass("fa-plus-square").addClass("fa-minus-square-o");
$('.active').scrollToMiddle();
$('.toggle').on('click', function (e) {
e.stopPropagation();
$(this).siblings('ul').slideToggle();
if($(this).hasClass("fa-plus-square")) {
$(this).addClass("fa-minus-square-o");
$(this).removeClass("fa-plus-square");
}
else {
$(this).addClass("fa-plus-square");
$(this).removeClass("fa-minus-square-o");
}
});
});
< / script >
