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.
This commit is contained in:
wpferguson
parent
e2d876dcb2
commit
3187934c7d
31 changed files with 81 additions and 29 deletions
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: darktable.collection
|
||||
id: darktable.collection
|
||||
weight: 180
|
||||
weight: 20
|
||||
draft: false
|
||||
author: "people"
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: darktable.configuration
|
||||
id: darktable.configuration
|
||||
weight: 140
|
||||
weight: 30
|
||||
draft: false
|
||||
author: "people"
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: darktable.control
|
||||
id: darktable.control
|
||||
weight: 190
|
||||
weight: 40
|
||||
draft: false
|
||||
author: "people"
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: darktable.database
|
||||
id: darktable.database
|
||||
weight: 180
|
||||
weight: 50
|
||||
draft: false
|
||||
author: "people"
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: darktable.debug
|
||||
id: darktable.debug
|
||||
weight: 210
|
||||
weight: 60
|
||||
draft: false
|
||||
author: "people"
|
||||
---
|
||||
|
|
|
|||
22
content/lua.api.manual/darktable/darktable.destroy_event.md
Normal file
22
content/lua.api.manual/darktable/darktable.destroy_event.md
Normal 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.
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: darktable.gettext
|
||||
id: darktable.gettext
|
||||
weight: 200
|
||||
weight: 80
|
||||
draft: false
|
||||
author: "people"
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: darktable.gui
|
||||
id: darktable.gui
|
||||
weight: 110
|
||||
weight: 90
|
||||
draft: false
|
||||
author: "people"
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: darktable.guides
|
||||
id: darktable.guides
|
||||
weight: 120
|
||||
weight: 100
|
||||
draft: false
|
||||
author: "people"
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: darktable.new_format
|
||||
id: darktable.new_format
|
||||
weight: 80
|
||||
weight: 110
|
||||
draft: false
|
||||
author: "people"
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: darktable.new_storage
|
||||
id: darktable.new_storage
|
||||
weight: 90
|
||||
weight: 120
|
||||
draft: false
|
||||
author: "people"
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: darktable.new_widget
|
||||
id: darktable.new_widget
|
||||
weight: 100
|
||||
weight: 130
|
||||
draft: false
|
||||
author: "people"
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: darktable.password
|
||||
id: darktable.password
|
||||
weight: 155
|
||||
weight: 140
|
||||
draft: false
|
||||
author: "people"
|
||||
---
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: darktable.print
|
||||
id: darktable.print
|
||||
weight: 20
|
||||
weight: 160
|
||||
draft: false
|
||||
author: "people"
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: darktable.print_error
|
||||
id: darktable.print_error
|
||||
weight: 40
|
||||
weight: 170
|
||||
draft: false
|
||||
author: "people"
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: darktable.print_log
|
||||
id: darktable.print_log
|
||||
weight: 30
|
||||
weight: 180
|
||||
draft: false
|
||||
author: "people"
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,13 +1,14 @@
|
|||
---
|
||||
title: darktable.register_event
|
||||
id: darktable.register_event
|
||||
weight: 50
|
||||
weight: 190
|
||||
draft: false
|
||||
author: "people"
|
||||
---
|
||||
|
||||
```
|
||||
function(
|
||||
event_name : string,
|
||||
event_type : string,
|
||||
callback : function,
|
||||
... : variable
|
||||
|
|
@ -17,6 +18,7 @@ function(
|
|||
This function registers a callback to be called when a given event happens.
|
||||
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.
|
||||
* **callback** - _function_ - The function to call on event. The signature of the function depends on the type of
|
||||
event.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: darktable.register_lib
|
||||
id: darktable.register_lib
|
||||
weight: 60
|
||||
weight: 200
|
||||
draft: false
|
||||
author: "people"
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: darktable.register_storage
|
||||
id: darktable.register_storage
|
||||
weight: 50
|
||||
weight: 210
|
||||
draft: false
|
||||
author: "people"
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: darktable.styles
|
||||
id: darktable.styles
|
||||
weight: 160
|
||||
weight: 220
|
||||
draft: false
|
||||
author: "people"
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: darktable.tags
|
||||
id: darktable.tags
|
||||
weight: 130
|
||||
weight: 230
|
||||
draft: false
|
||||
author: "people"
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: exit
|
||||
id: exit
|
||||
weight: 100
|
||||
weight: 20
|
||||
draft: false
|
||||
author: "people"
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: global_toolbox-grouping_toggle
|
||||
id: global_toolbox-grouping_toggle
|
||||
weight: 70
|
||||
weight: 30
|
||||
draft: false
|
||||
author: "people"
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: global_toolbox-overlay_toggle
|
||||
id: global_toolbox-overlay_toggle
|
||||
weight: 80
|
||||
weight: 40
|
||||
draft: false
|
||||
author: "people"
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: intermediate-export-image
|
||||
id: intermediate-export-image
|
||||
weight: 20
|
||||
weight: 50
|
||||
draft: false
|
||||
author: "people"
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: mouse-over-image-changed
|
||||
id: mouse-over-image-changed
|
||||
weight: 90
|
||||
weight: 60
|
||||
draft: false
|
||||
author: "people"
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: post-import-film
|
||||
id: post-import-film
|
||||
weight: 50
|
||||
weight: 70
|
||||
draft: false
|
||||
author: "people"
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: post-import-image
|
||||
id: post-import-image
|
||||
weight: 30
|
||||
weight: 80
|
||||
draft: false
|
||||
author: "people"
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: pre-import
|
||||
id: pre-import
|
||||
weight: 110
|
||||
weight: 90
|
||||
draft: false
|
||||
author: "people"
|
||||
---
|
||||
|
|
|
|||
28
content/lua.api.manual/events/selection-changed.md
Normal file
28
content/lua.api.manual/events/selection-changed.md
Normal 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.
|
||||
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: shortcut
|
||||
id: shortcut
|
||||
weight: 40
|
||||
weight: 110
|
||||
draft: false
|
||||
author: "people"
|
||||
---
|
||||
|
|
|
|||
Loading…
Reference in a new issue