[Lua API] Removed references to API 6.x.x. Updated version to 7.0.0.

Reordered types alphabetically.  Fixed darktable.gui.libs.snapshots
This commit is contained in:
wpferguson 2021-06-22 22:40:54 -04:00
parent 36c58ad3c8
commit fbebfabca5
74 changed files with 74 additions and 95 deletions

View file

@ -48,8 +48,6 @@ imported.
# darktable.database.get_image
**Lua API 6.2.0**
```
function(
image_id : int,

View file

@ -6,8 +6,6 @@ draft: false
author: "people"
---
**API 6.2.1**
```
function(
event_name : string,

View file

@ -6,8 +6,6 @@ draft: false
author: "people"
---
## Lua API 6.2.0
Store and retrieve credentials using the darktable password storage backend.
# darktable.password.save

View file

@ -79,7 +79,7 @@ function(
Reads a value from a Lua preference.
* **script** - _string_ - Invisible prefix to guarantee unicity of preferences. **Lua API 6.2.0** Specifying "darktable" as the script name allows access to the darktable core preferences.
* **script** - _string_ - Invisible prefix to guarantee unicity of preferences. Specifying "darktable" as the script name allows access to the darktable core preferences.
* **name** - _string_ - The name of the preference displayed in the preference screen.
* **type** - _[types.lua_pref_type](../../types/lua_pref_type)_ - The type of the preference.
* **return** - _depends on type_ - The value of the preference.
@ -102,8 +102,6 @@ Writes a value to a Lua preference.
* **type** - _[types.lua_pref_type](../../types/lua_pref_type)_ - The type of the preference.
* **value** - _depends on type_ - The value to set the preference to.
**Lua API 6.2.0**
# darktable.preferences.destroy
```
@ -119,8 +117,6 @@ Destroys a lua preference key and value.
* **name** - _string_ - The name of the preference displayed in the preference screen.
* **return** - _boolean_ - True for success, false otherwise.
**Lua API 6.2.0**
# darktable.preferences.get_keys
```

View file

@ -18,7 +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_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.

View file

@ -39,8 +39,6 @@ function(
## darktable.gui.libs.metadata_view.destroy_info
**lua API 6.2.0**
```
function(
name : string

View file

@ -25,7 +25,7 @@ function(
Add a new button and call a callback when it is clicked
* **name** - _string_ - The name to use to refer to the select button **API 6.2.2**
* **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
@ -45,7 +45,7 @@ The function to call when the button is pressed
* **images** - _table of [types.dt_lua_image_t](../../../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](../../../types/dt_lua_image_t)_ - The images to set the selection to
## darktable.gui.libs.select.destroy_selection **API 6.2.2**
## darktable.gui.libs.select.destroy_selection
```
function(
@ -57,7 +57,7 @@ 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 **API 6.2.2**
## darktable.gui.libs.select.selection_set_sensitive
```
function(

View file

@ -19,7 +19,7 @@ number - The place in the screen where the line separating the snapshot is. Betw
Attributes:
* [write](../../../Attributes#write)
darktable.gui.libs.snapshots.direction
## darktable.gui.libs.snapshots.direction
[types.snapshot_direction_t](../../../types/snapshot_direction_t) - The direction of the snapshot overlay
@ -28,11 +28,11 @@ Attributes:
## darktable.gui.libs.snapshots.#
[types.snapshot_direction_t](../../../types/snapshot_direction_t) - The different snapshots for the image
[types.dt_lua_snapshot_t](../../../types/dt_lua_snapshot_t) - Each snapshot appears with a numerical index; you can iterate over them with ipairs.
## darktable.gui.libs.snapshots.selected
[types.snapshot_direction_t](../../../types/snapshot_direction_t) - The currently selected snapshot
[types.dt_lua_snapshot_t](../../../types/dt_lua_snapshot_t) - The currently selected snapshot
## darktable.gui.libs.snapshots.take_snapshot
@ -46,5 +46,5 @@ The snapshot file will be generated at the next redraw of the main window
## darktable.gui.libs.snapshots.max_snapshot
number - The maximum number of snapshots
[types.dt_lua_snapshot_t](../../../types/dt_lua_snapshot_t) - The maximum number of snapshots

View file

@ -6,8 +6,6 @@ draft: false
author: "people"
---
**API 6.2.1**
`event`
This event is triggered whenever the selection of images changes

View file

@ -1,7 +1,7 @@
---
title: view_changed
id: view_changed
weight: 60
weight: 120
draft: false
author: "people"
---

View file

@ -1,7 +1,7 @@
---
title: _pdf_mode_t
id: _pdf_mode_t
weight: 150
weight: 10
draft: false
author: "people"
---

View file

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

View file

@ -1,7 +1,7 @@
---
title: comp_type_t
id: comp_type_t
weight: 370
weight: 30
draft: false
author: "people"
---

View file

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

View file

@ -1,7 +1,7 @@
---
title: dt_collection_properties_t
id: dt_collection_properties_t
weight: 420
weight: 50
draft: false
author: "people"
---

View file

@ -1,7 +1,7 @@
---
title: dt_collection_rating_comperator_t
id: dt_collection_rating_comperator_t
weight: 460
weight: 60
draft: false
author: "people"
---

View file

@ -1,7 +1,7 @@
---
title: dt_collection_sort_order_t
id: dt_collection_sort_order_t
weight: 440
weight: 70
draft: false
author: "people"
---

View file

@ -1,7 +1,7 @@
---
title: dt_collection_sort_t
id: dt_collection_sort_t
weight: 430
weight: 80
draft: false
author: "people"
---

View file

@ -1,7 +1,7 @@
---
title: dt_imageio_exr_compression_t
id: dt_imageio_exr_compression_t
weight: 390
weight: 90
draft: false
author: "people"
---

View file

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

View file

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

View file

@ -1,7 +1,7 @@
---
title: dt_imageio_module_format_data_copy
id: dt_imageio_module_format_data_copy
weight: 80
weight: 120
draft: false
author: "people"
---

View file

@ -1,7 +1,7 @@
---
title: dt_imageio_module_format_data_exr
id: dt_imageio_module_format_data_exr
weight: 70
weight: 130
draft: false
author: "people"
---

View file

@ -1,7 +1,7 @@
---
title: dt_imageio_module_format_data_j2k
id: dt_imageio_module_format_data_j2k
weight: 130
weight: 140
draft: false
author: "people"
---

View file

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

View file

@ -1,7 +1,7 @@
---
title: dt_imageio_module_format_data_pdf
id: dt_imageio_module_format_data_pdf
weight: 140
weight: 160
draft: false
author: "people"
---

View file

@ -1,7 +1,7 @@
---
title: dt_imageio_module_format_data_pfm
id: dt_imageio_module_format_data_pfm
weight: 90
weight: 170
draft: false
author: "people"
---

View file

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

View file

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

View file

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

View file

@ -1,7 +1,7 @@
---
title: dt_imageio_module_format_data_webp
id: dt_imageio_module_format_data_webp
weight: 120
weight: 210
draft: false
author: "people"
---

View file

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

View file

@ -1,7 +1,7 @@
---
title: dt_imageio_module_storage_data_email
id: dt_imageio_module_storage_data_email
weight: 190
weight: 240
draft: false
author: "people"
---

View file

@ -1,7 +1,7 @@
---
title: dt_imageio_module_storage_data_gallery
id: dt_imageio_module_storage_data_gallery
weight: 220
weight: 250
draft: false
author: "people"
---

View file

@ -1,7 +1,7 @@
---
title: dt_imageio_module_storage_data_latex
id: dt_imageio_module_storage_data_latex
weight: 200
weight: 260
draft: false
author: "people"
---

View file

@ -1,7 +1,7 @@
---
title: dt_imageio_module_storage_data_piwigo
id: dt_imageio_module_storage_data_piwigo
weight: 210
weight: 270
draft: false
author: "people"
---

View file

@ -1,7 +1,7 @@
---
title: dt_imageio_module_storage_t
id: dt_imageio_module_storage_t
weight: 180
weight: 280
draft: false
author: "people"
---

View file

@ -1,7 +1,7 @@
---
title: dt_lib_collect_mode_t
id: dt_lib_collect_mode_t
weight: 410
weight: 290
draft: false
author: "people"
---

View file

@ -1,7 +1,7 @@
---
title: dt_lib_collect_params_rule_t
id: dt_lib_collect_params_rule_t
weight: 400
weight: 300
draft: false
author: "people"
---

View file

@ -1,7 +1,7 @@
---
title: dt_lighttable_layout_t
id: dt_lighttable_layout_t
weight: 520
weight: 310
draft: false
author: "people"
---

View file

@ -1,7 +1,7 @@
---
title: dt_lua_align_t
id: dt_lua_align_t
weight: 480
weight: 320
draft: false
author: "people"
---

View file

@ -1,7 +1,7 @@
---
title: dt_lua_backgroundjob_t
id: dt_lua_backgroundjob_t
weight: 300
weight: 330
draft: false
author: "people"
---

View file

@ -1,7 +1,7 @@
---
title: dt_lua_cairo_t
id: dt_lua_cairo_t
weight: 500
weight: 340
draft: false
author: "people"
---

View file

@ -1,7 +1,7 @@
---
title: dt_lua_ellipsize_mode_t
id: dt_lua_ellipsize_mode_t
weight: 490
weight: 350
draft: false
author: "people"
---

View file

@ -1,7 +1,7 @@
---
title: dt_lua_film_t
id: dt_lua_film_t
weight: 240
weight: 360
draft: false
author: "people"
---

View file

@ -1,7 +1,7 @@
---
title: dt_lua_image_t
id: dt_lua_image_t
weight: 30
weight: 370
draft: false
author: "people"
---

View file

@ -1,7 +1,7 @@
---
title: dt_lua_lib_t
id: dt_lua_lib_t
weight: 280
weight: 380
draft: false
author: "people"
---

View file

@ -1,7 +1,7 @@
---
title: dt_lua_orientation_t
id: dt_lua_orientation_t
weight: 470
weight: 390
draft: false
author: "people"
---

View file

@ -1,7 +1,7 @@
---
title: dt_lua_snapshot_t
id: dt_lua_snapshot_t
weight: 310
weight: 400
draft: false
author: "people"
---

View file

@ -1,7 +1,7 @@
---
title: dt_lua_tag_t
id: dt_lua_tag_t
weight: 270
weight: 410
draft: false
author: "people"
---

View file

@ -1,7 +1,7 @@
---
title: dt_lua_view_t
id: dt_lua_view_t
weight: 290
weight: 420
draft: false
author: "people"
---

View file

@ -1,7 +1,7 @@
---
title: dt_pdf_stream_encoder_t
id: dt_pdf_stream_encoder_t
weight: 170
weight: 430
draft: false
author: "people"
---

View file

@ -1,7 +1,7 @@
---
title: dt_style_item_t
id: dt_style_item_t
weight: 260
weight: 440
draft: false
author: "people"
---

View file

@ -1,7 +1,7 @@
---
title: dt_style_t
id: dt_style_t
weight: 250
weight: 450
draft: false
author: "people"
---

View file

@ -1,7 +1,7 @@
---
title: dt_ui_container_t
id: dt_ui_container_t
weight: 330
weight: 460
draft: false
author: "people"
---

View file

@ -1,7 +1,7 @@
---
title: dt_ui_panel_t
id: dt_ui_panel_t
weight: 510
weight: 470
draft: false
author: "people"
---

View file

@ -1,7 +1,7 @@
---
title: hint_t
id: hint_t
weight: 320
weight: 480
draft: false
author: "people"
---

View file

@ -1,7 +1,7 @@
---
title: lua_box
id: lua_box
weight: 580
weight: 490
draft: false
author: "people"
---

View file

@ -1,7 +1,7 @@
---
title: lua_button
id: lua_button
weight: 570
weight: 500
draft: false
author: "people"
---

View file

@ -1,7 +1,7 @@
---
title: lua_check_button
id: lua_check_button
weight: 550
weight: 510
draft: false
author: "people"
---

View file

@ -1,7 +1,7 @@
---
title: lua_combobox
id: lua_combobox
weight: 610
weight: 520
draft: false
author: "people"
---

View file

@ -1,7 +1,7 @@
---
title: lua_container
id: lua_container
weight: 540
weight: 530
draft: false
author: "people"
---

View file

@ -1,7 +1,7 @@
---
title: lua_entry
id: lua_entry
weight: 590
weight: 540
draft: false
author: "people"
---

View file

@ -1,7 +1,7 @@
---
title: lua_file_chooser_button
id: lua_file_chooser_button
weight: 620
weight: 550
draft: false
author: "people"
---

View file

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

View file

@ -1,7 +1,7 @@
---
title: lua_pref_type
id: lua_pref_type
weight: 380
weight: 580
draft: false
author: "people"
---

View file

@ -1,7 +1,7 @@
---
title: lua_section_label
id: lua_section_label
weight: 660
weight: 590
draft: false
author: "people"
---

View file

@ -1,7 +1,7 @@
---
title: lua_slider
id: lua_slider
weight: 640
weight: 610
draft: false
author: "people"
---

View file

@ -1,7 +1,7 @@
---
title: lua_stack
id: lua_stack
weight: 630
weight: 620
draft: false
author: "people"
---

View file

@ -1,7 +1,7 @@
---
title: lua_text_view
id: lua_text_view
weight: 650
weight: 630
draft: false
author: "people"
---

View file

@ -1,7 +1,7 @@
---
title: lua_widget
id: lua_widget
weight: 530
weight: 640
draft: false
author: "people"
---
@ -20,8 +20,6 @@ This widget has no extra registration parameters
# lua_widget.name
**Lua API 6.2.0**
`string or nil`
Name assigned to the widget for CSS styling purposes.
@ -52,8 +50,6 @@ Attributes:
# lua_widget.visible
**Lua API 7.0.0**
`boolean or nil`
Hide or show widget. Default is show.

View file

@ -1,7 +1,7 @@
---
title: overview
id: overview
weight: 10
weight: 5
draft: false
author: "people"
---

View file

@ -1,7 +1,7 @@
---
title: snapshot_direction_t
id: snapshot_direction_t
weight: 340
weight: 650
draft: false
author: "people"
---

View file

@ -8,8 +8,5 @@ author: "people"
# Current API
The Lua API version currently used in darktable 3.4.x is 6.1.0.
The Lua API version used in darktable 3.6.0 is 7.0.0.
# Development API
The Lua API is currently at version 6.2.2 in the development branch of darktable \(currently 3.5\). All changes for version 6.2.+ will be identified as such until version 6.2.+ is included in a darktable release.