luadocs/content/lua.api.manual/darktable/gui/libs/select.md

title	id	weight	draft	author
darktable.gui.libs.select	select	320	false	people

The buttons that allow quickly changing the selection

Attributes:

• has_tostring
• parent : types.dt_lua_lib_t

darktable.gui.libs.select.register_selection

function(
  name : string
  label : string,
  callback : function,
  [tooltip : string]
)

Add a new button and call a callback when it is clicked

• name - string - The name to use to refer to the select button
• label - string - The label to display on the button
• callback - function - The function to call when the button is pressed
• [tooltip] - string - The tooltip to use on the new button

callback -

function(
  event : string,
  images : table oftypes.dt_lua_image_t
) : table oftypes.dt_lua_image_t

The function to call when the button is pressed

• event - string - The name of the button that was pressed
• images - table of types.dt_lua_image_t - The images in the current collection. This is the same content asdarktable.collection
• return - table of types.dt_lua_image_t - The images to set the selection to

darktable.gui.libs.select.destroy_selection

function(
  name : string
)

Remove a button created by darktable.gui.libs.select.register_selection.

• name - string - The name of the selection button to destroy

darktable.gui.libs.select.selection_set_sensitive

function(
  name : string
  sensitive : boolean
)

Set the sensitivity of a button created by darktable.gui.libs.select.register_selection.

• name - string - The name of the selection button to change the sensitivty of
• sensitive - boolean - True to set the button sensitive, false to set it insensitive