luadocs/content/lua.api.manual/darktable/darktable.register_event.md
wpferguson fbebfabca5 [Lua API] Removed references to API 6.x.x. Updated version to 7.0.0.
Reordered types alphabetically.  Fixed darktable.gui.libs.snapshots
2021-06-22 22:40:54 -04:00

796 B

title id weight draft author
darktable.register_event darktable.register_event 190 false people
function(
  event_name : string,
  event_type : string,
  callback : function,
  ... : variable
)

This function registers a callback to be called when a given event happens. Events are documented in the event section.

  • event_name - string - The name of the event used to manipulate the event. The combination of event_name and event_type must be unique.
  • event_type - string - The name of the event to register to.
  • callback - function - The function to call on event. The signature of the function depends on the type of event.
  • ... - variable - Some events need extra parameters at registration time; these must be specified here.