djkato/luadocs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added Lua API 6.2.1 changes (selection-changed event, event naming, and darktable.destroy_event). Reordered darktable and event sections alphabetically except where grouping made sense.

Browse source
This commit is contained in:
wpferguson 2021-02-03 22:14:39 -05:00
parent e2d876dcb2
commit 3187934c7d
31 changed files with 81 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
content/lua.api.manual/darktable/darktable.collection.md
View file

@ -1,7 +1,7 @@
--- ---
title: darktable.collection title: darktable.collection
id: darktable.collection id: darktable.collection
weight: 180 weight: 20
draft: false draft: false
author: "people" author: "people"
--- ---

2
content/lua.api.manual/darktable/darktable.configuration.md
View file

@ -1,7 +1,7 @@
--- ---
title: darktable.configuration title: darktable.configuration
id: darktable.configuration id: darktable.configuration
weight: 140 weight: 30
draft: false draft: false
author: "people" author: "people"
--- ---

2
content/lua.api.manual/darktable/darktable.control.md
View file

@ -1,7 +1,7 @@
--- ---
title: darktable.control title: darktable.control
id: darktable.control id: darktable.control
weight: 190 weight: 40
draft: false draft: false
author: "people" author: "people"
--- ---

2
content/lua.api.manual/darktable/darktable.database.md
View file

@ -1,7 +1,7 @@
--- ---
title: darktable.database title: darktable.database
id: darktable.database id: darktable.database
weight: 180 weight: 50
draft: false draft: false
author: "people" author: "people"
--- ---

2
content/lua.api.manual/darktable/darktable.debug.md
View file

@ -1,7 +1,7 @@
--- ---
title: darktable.debug title: darktable.debug
id: darktable.debug id: darktable.debug
weight: 210 weight: 60
draft: false draft: false
author: "people" author: "people"
--- ---

22
content/lua.api.manual/darktable/darktable.destroy_event.md Normal file
View file

@ -0,0 +1,22 @@
---
title: darktable.destroy_event
id: darktable.destroy_event
weight: 195
draft: false
author: "people"
---
**API 6.2.1**
```
function(
event_name : string,
event_type : string,
)
```
This function removes the callback registered by [darktable.register_event](darktable.register_event.md).
Events are documented in the [event](../events) 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.

2
content/lua.api.manual/darktable/darktable.gettext.md
View file

@ -1,7 +1,7 @@
--- ---
title: darktable.gettext title: darktable.gettext
id: darktable.gettext id: darktable.gettext
weight: 200 weight: 80
draft: false draft: false
author: "people" author: "people"
--- ---

2
content/lua.api.manual/darktable/darktable.gui.md
View file

@ -1,7 +1,7 @@
--- ---
title: darktable.gui title: darktable.gui
id: darktable.gui id: darktable.gui
weight: 110 weight: 90
draft: false draft: false
author: "people" author: "people"
--- ---

2
content/lua.api.manual/darktable/darktable.guides.md
View file

@ -1,7 +1,7 @@
--- ---
title: darktable.guides title: darktable.guides
id: darktable.guides id: darktable.guides
weight: 120 weight: 100
draft: false draft: false
author: "people" author: "people"
--- ---

2
content/lua.api.manual/darktable/darktable.new_format.md
View file

@ -1,7 +1,7 @@
--- ---
title: darktable.new_format title: darktable.new_format
id: darktable.new_format id: darktable.new_format
weight: 80 weight: 110
draft: false draft: false
author: "people" author: "people"
--- ---

2
content/lua.api.manual/darktable/darktable.new_storage.md
View file

@ -1,7 +1,7 @@
--- ---
title: darktable.new_storage title: darktable.new_storage
id: darktable.new_storage id: darktable.new_storage
weight: 90 weight: 120
draft: false draft: false
author: "people" author: "people"
--- ---

2
content/lua.api.manual/darktable/darktable.new_widget.md
View file

@ -1,7 +1,7 @@
--- ---
title: darktable.new_widget title: darktable.new_widget
id: darktable.new_widget id: darktable.new_widget
weight: 100 weight: 130
draft: false draft: false
author: "people" author: "people"
--- ---

2
content/lua.api.manual/darktable/password.md → content/lua.api.manual/darktable/darktable.password.md
View file

@ -1,7 +1,7 @@
--- ---
title: darktable.password title: darktable.password
id: darktable.password id: darktable.password
weight: 155 weight: 140
draft: false draft: false
author: "people" author: "people"
--- ---

2
content/lua.api.manual/darktable/darktable.print.md
View file

@ -1,7 +1,7 @@
--- ---
title: darktable.print title: darktable.print
id: darktable.print id: darktable.print
weight: 20 weight: 160
draft: false draft: false
author: "people" author: "people"
--- ---

2
content/lua.api.manual/darktable/darktable.print_error.md
View file

@ -1,7 +1,7 @@
--- ---
title: darktable.print_error title: darktable.print_error
id: darktable.print_error id: darktable.print_error
weight: 40 weight: 170
draft: false draft: false
author: "people" author: "people"
--- ---

2
content/lua.api.manual/darktable/darktable.print_log.md
View file

@ -1,7 +1,7 @@
--- ---
title: darktable.print_log title: darktable.print_log
id: darktable.print_log id: darktable.print_log
weight: 30 weight: 180
draft: false draft: false
author: "people" author: "people"
--- ---

4
content/lua.api.manual/darktable/darktable.register_event.md
View file

@ -1,13 +1,14 @@
--- ---
title: darktable.register_event title: darktable.register_event
id: darktable.register_event id: darktable.register_event
weight: 50 weight: 190
draft: false draft: false
author: "people" author: "people"
--- ---
``` ```
function( function(
event_name : string,
event_type : string, event_type : string,
callback : function, callback : function,
... : variable ... : variable
@ -17,6 +18,7 @@ function(
This function registers a callback to be called when a given event happens. This function registers a callback to be called when a given event happens.
Events are documented in the [event](../events) section. Events are documented in the [event](../events) 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. **API 6.2.1**
* **event_type** - _string_ - The name of the event to register to. * **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 * **callback** - _function_ - The function to call on event. The signature of the function depends on the type of
event. event.

2
content/lua.api.manual/darktable/darktable.register_lib.md
View file

@ -1,7 +1,7 @@
--- ---
title: darktable.register_lib title: darktable.register_lib
id: darktable.register_lib id: darktable.register_lib
weight: 60 weight: 200
draft: false draft: false
author: "people" author: "people"
--- ---

2
content/lua.api.manual/darktable/darktable.register_storage.md
View file

@ -1,7 +1,7 @@
--- ---
title: darktable.register_storage title: darktable.register_storage
id: darktable.register_storage id: darktable.register_storage
weight: 50 weight: 210
draft: false draft: false
author: "people" author: "people"
--- ---

2
content/lua.api.manual/darktable/darktable.styles.md
View file

@ -1,7 +1,7 @@
--- ---
title: darktable.styles title: darktable.styles
id: darktable.styles id: darktable.styles
weight: 160 weight: 220
draft: false draft: false
author: "people" author: "people"
--- ---

2
content/lua.api.manual/darktable/darktable.tags.md
View file

@ -1,7 +1,7 @@
--- ---
title: darktable.tags title: darktable.tags
id: darktable.tags id: darktable.tags
weight: 130 weight: 230
draft: false draft: false
author: "people" author: "people"
--- ---

2
content/lua.api.manual/events/exit.md
View file

@ -1,7 +1,7 @@
--- ---
title: exit title: exit
id: exit id: exit
weight: 100 weight: 20
draft: false draft: false
author: "people" author: "people"
--- ---

2
content/lua.api.manual/events/global_toolbox-grouping_toggle.md
View file

@ -1,7 +1,7 @@
--- ---
title: global_toolbox-grouping_toggle title: global_toolbox-grouping_toggle
id: global_toolbox-grouping_toggle id: global_toolbox-grouping_toggle
weight: 70 weight: 30
draft: false draft: false
author: "people" author: "people"
--- ---

2
content/lua.api.manual/events/global_toolbox-overlay_toggle.md
View file

@ -1,7 +1,7 @@
--- ---
title: global_toolbox-overlay_toggle title: global_toolbox-overlay_toggle
id: global_toolbox-overlay_toggle id: global_toolbox-overlay_toggle
weight: 80 weight: 40
draft: false draft: false
author: "people" author: "people"
--- ---

2
content/lua.api.manual/events/intermediate-export-image.md
View file

@ -1,7 +1,7 @@
--- ---
title: intermediate-export-image title: intermediate-export-image
id: intermediate-export-image id: intermediate-export-image
weight: 20 weight: 50
draft: false draft: false
author: "people" author: "people"
--- ---

2
content/lua.api.manual/events/mouse-over-image-changed.md
View file

@ -1,7 +1,7 @@
--- ---
title: mouse-over-image-changed title: mouse-over-image-changed
id: mouse-over-image-changed id: mouse-over-image-changed
weight: 90 weight: 60
draft: false draft: false
author: "people" author: "people"
--- ---

2
content/lua.api.manual/events/post-import-film.md
View file

@ -1,7 +1,7 @@
--- ---
title: post-import-film title: post-import-film
id: post-import-film id: post-import-film
weight: 50 weight: 70
draft: false draft: false
author: "people" author: "people"
--- ---

2
content/lua.api.manual/events/post-import-image.md
View file

@ -1,7 +1,7 @@
--- ---
title: post-import-image title: post-import-image
id: post-import-image id: post-import-image
weight: 30 weight: 80
draft: false draft: false
author: "people" author: "people"
--- ---

2
content/lua.api.manual/events/pre-import.md
View file

@ -1,7 +1,7 @@
--- ---
title: pre-import title: pre-import
id: pre-import id: pre-import
weight: 110 weight: 90
draft: false draft: false
author: "people" author: "people"
--- ---

28
content/lua.api.manual/events/selection-changed.md Normal file
View file

@ -0,0 +1,28 @@
---
title: selection-changed
id: selection-changed
weight: 100
draft: false
author: "people"
---
**API 6.2.1**
`event`
This event is triggered whenever the selection of images changes
# selection-changed.callback
```
function(
event : string
)
```
* **event** - _string_ - The name of the event that triggered the callback.
# selection-changed.extra registration parameters
This event has no extra registration parameters.

2
content/lua.api.manual/events/shortcut.md
View file

@ -1,7 +1,7 @@
--- ---
title: shortcut title: shortcut
id: shortcut id: shortcut
weight: 40 weight: 110
draft: false draft: false
author: "people" author: "people"
--- ---