https://darktable-org.github.io/luadocs/lua.api.manual/darktable/gui/ Recent content in darktable.gui on darktable lua documentation Hugo -- gohugo.io en-us https://darktable-org.github.io/luadocs/lua.api.manual/darktable/gui/overview/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/darktable/gui/overview/ 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). https://darktable-org.github.io/luadocs/lua.api.manual/darktable/gui/action/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/darktable/gui/action/ function( path : string, instance : integer, element : string, effect : string, speed : integer ) : string Will perform the specified effect on the path, instance, and element of an action, or return the status. path - string - The full path of an action, i.e. 'lib/filter/view'. instance - integer - The instance of an image processing module to execute action on". element - string - The element of an action, for example ‘selection’, or leave empty for default". https://darktable-org.github.io/luadocs/lua.api.manual/darktable/gui/action_images/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/darktable/gui/action_images/ table A table of types.dt_lua_image_t 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 darktable.gui.hovered or darktable.gui.selection to be consistent with darktable’s GUI. https://darktable-org.github.io/luadocs/lua.api.manual/darktable/gui/create_job/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/darktable/gui/create_job/ function( text : string, [percentage : boolean], [cancel_callback : function] ) : types.dt_lua_backgroundjob_t Create a new progress_bar displayed in darktable.gui.libs.backgroundjobs text - string - The text to display in the job entry [percentage] - boolean - Should a progress bar be displayed [cancel_callback] - function - A function called when the cancel button for that job is pressed. Note: the job won’t be destroyed automatically. https://darktable-org.github.io/luadocs/lua.api.manual/darktable/gui/current_view/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/darktable/gui/current_view/ function( [view : types.dt_lua_view_t] ) : types.dt_lua_view_t Get or change the current view. [view] - _types.dt_lua_view_t_ - The view to switch to. If empty the current view is unchanged return - _types.dt_lua_view_t_ - the current view https://darktable-org.github.io/luadocs/lua.api.manual/darktable/gui/hovered/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/darktable/gui/hovered/ types.dt_lua_image_t The image under the cursor or nil if no image is hovered. https://darktable-org.github.io/luadocs/lua.api.manual/darktable/gui/panel_get_size/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/darktable/gui/panel_get_size/ function( panel : types.dt_ui_panel_t ):int Gets the size in pixels of the specified panel. This only works for the left, right, and bottom panels. panel - types.dt_ui_panel_t - The panel to get the size of. https://darktable-org.github.io/luadocs/lua.api.manual/darktable/gui/panel_hide/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/darktable/gui/panel_hide/ function( panel : types.dt_ui_panel_t ) Hides the specified panel. panel - types.dt_ui_panel_t - The panel to hide. https://darktable-org.github.io/luadocs/lua.api.manual/darktable/gui/panel_hide_all/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/darktable/gui/panel_hide_all/ function( ) Hide all panels. https://darktable-org.github.io/luadocs/lua.api.manual/darktable/gui/panel_set_size/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/darktable/gui/panel_set_size/ function( panel : types.dt_ui_panel_t size : int ) Sets the size in pixels of the specified panel. This only works for the left, right, and bottom panels. panel - types.dt_ui_panel_t - The panel to set the size of. size - int - The size to set the panel to. https://darktable-org.github.io/luadocs/lua.api.manual/darktable/gui/panel_show/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/darktable/gui/panel_show/ function( panel : types.dt_ui_panel_t ) Shows the specified panel. panel - types.dt_ui_panel_t - The panel to show. https://darktable-org.github.io/luadocs/lua.api.manual/darktable/gui/panel_show_all/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/darktable/gui/panel_show_all/ function( ) Show all panels. https://darktable-org.github.io/luadocs/lua.api.manual/darktable/gui/panel_visible/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/darktable/gui/panel_visible/ function( panel : types.dt_ui_panel_t ) : boolean Determines if the specified panel is visible. panel - types.dt_ui_panel_t - The panel to check. return - boolean - true if the panel is visible, false if not https://darktable-org.github.io/luadocs/lua.api.manual/darktable/gui/selection/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/darktable/gui/selection/ function( [selection : table of types.dt_lua_image_t] ) : table of types.dt_lua_image_t Get or change the set of selected images. Attributes: implicit_yield [selection] - table of types.dt_lua_image_t - 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. return - table of types.dt_lua_image_t - A table containing the selection as it was before the function was called.