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

more porting cleanup

Browse source
This commit is contained in:
wpferguson 2020-12-22 01:08:37 -05:00
parent 9b3dc9e465
commit 500ae67bf3
8 changed files with 43 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
content/lua.api.manual/_index.html
View file

@ -6,6 +6,3 @@ draft: false
author: "people" author: "people"
--- ---
<p>
The Lua API manual is currently being converted.
</p>

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

@ -8,8 +8,8 @@ author: "people"
`event` `event`
This event is triggered when an film import is finished (all post-import-image callbacks This event is triggered when an film import is finished \(all post-import-image callbacks
have already been triggered). This event can be registered multiple times. have already been triggered\). This event can be registered multiple times.
# post-import-film.callback # post-import-film.callback

12
content/lua.api.manual/types/dt_imageio_module_format_data_pdf.md
View file

@ -58,7 +58,17 @@ Attributes:
`string` `string`
The title for the document types.dt_imageio_module_format_data_pdf.rotate:set_text([[Should the images be rotated to match the PDF orientation The title for the document
Attributes:
* [write](../attributes#write)
# dt_imageio_module_format_data_pdf.rotate
`boolean`
Should the images be rotated to match the PDF orientation
Attributes: Attributes:

2
content/lua.api.manual/types/dt_lua_film_t.md
View file

@ -48,7 +48,7 @@ Attributes:
# dt_lua_film_t.delete # dt_lua_film_t.delete
``` ```
self:function( self:function(
[force : boolean] [force : boolean]
) )
``` ```

10
content/lua.api.manual/types/dt_lua_image_t.md
View file

@ -283,8 +283,8 @@ Attributes:
`boolean` `boolean`
True if the image is a RAW file. True if the image is a RAW file.
WARNING: This is a flag that gets set the first time the image is opened, either by an edit **WARNING:** This is a flag that gets set the first time the image is opened, either by an edit
or thumbnail generation. If images are imported using darktable.database.import(), then or thumbnail generation. If images are imported using darktable.database.import\(\), then
dt_lua_image_t.is_raw is not guaranteed to be correct. dt_lua_image_t.is_raw is not guaranteed to be correct.
# dt_lua_image_t.is_ldr # dt_lua_image_t.is_ldr
@ -325,7 +325,7 @@ The height of the image.
`number` `number`
The rating of the image (-1 for rejected). The rating of the image \(-1 for rejected\).
Attributes: Attributes:
@ -427,7 +427,7 @@ self:function(
) )
``` ```
drops the cached version of this image. drops the cached version of this image.
This function should be called if an image is modified out of darktable to force DT to regenerate the thumbnail This function should be called if an image is modified out of darktable to force darktable to regenerate the thumbnail.
darktable will regenerate the thumbnail by itself when it is needed darktable will regenerate the thumbnail by itself when it is needed.
* **self** - _[types.dt_lua_image_t](../types/dt_lua_image_t)_ - The image whose cache must be dropped. * **self** - _[types.dt_lua_image_t](../types/dt_lua_image_t)_ - The image whose cache must be dropped.

24
content/lua.api.manual/types/lua_combobox.md
View file

@ -8,9 +8,9 @@ author: "people"
`dt_type` `dt_type`
A widget with multiple text entries in a menu A widget with multiple text entries in a menu.
This widget can be set as editable at construction time. This widget can be set as editable at construction time.
If it is editable the user can type a value and is not constrained by the values in the menu If it is editable the user can type a value and is not constrained by the values in the menu.
Attributes: Attributes:
@ -27,10 +27,10 @@ This widget has no extra registration parameters
`string` `string`
The text content of the selected entry, can be nil The text content of the selected entry, can be nil.
You can set it to a number to select the corresponding entry from the menu You can set it to a number to select the corresponding entry from the menu.
If the combo box is editable, you can set it to any string If the combobox is editable, you can set it to any string.
You can set it to nil to deselect all entries You can set it to nil to deselect all entries.
Attributes: Attributes:
@ -40,10 +40,10 @@ Attributes:
`integer` `integer`
The index of the selected entry, or 0 if nothing is selected The index of the selected entry, or 0 if nothing is selected.
You can set it to a number to select the corresponding entry from the menu, or to 0 to You can set it to a number to select the corresponding entry from the menu, or to 0 to
select nothing select nothing.
You can set it to nil to deselect all entries You can set it to nil to deselect all entries.
Attributes: Attributes:
@ -54,8 +54,8 @@ Attributes:
`string` `string`
The various menu entries. The various menu entries.
You can add new entries by writing to the first element beyond the end You can add new entries by writing to the first element beyond the end.
You can removes entries by setting them to nil You can removes entries by setting them to nil.
Attributes: Attributes:
@ -67,7 +67,7 @@ function(
widget : types.lua_widget widget : types.lua_widget
) )
``` ```
A function to call when the value field changes (character entered or value selected) A function to call when the value field changes \(character entered or value selected\)
* **widget** - _[types.lua_widget](../types/lua_widget)_ - The widget that triggered the callback * **widget** - _[types.lua_widget](../types/lua_widget)_ - The widget that triggered the callback

20
content/lua.api.manual/types/lua_slider.md
View file

@ -15,13 +15,13 @@ Attributes:
* [has_tostring](../attributes#has_tostring) * [has_tostring](../attributes#has_tostring)
* [parent](../attributes#parent) : [types.lua_widget](../types/lua_widget) * [parent](../attributes#parent) : [types.lua_widget](../types/lua_widget)
2.63.1. types.lua_slider.\_\_call # lua_slider.\_\_call
see [types.lua_widget.As a function](../types/lua_widget#lua_widgetas-a-function) see [types.lua_widget.As a function](../types/lua_widget#lua_widgetas-a-function)
2.63.2. types.lua_slider.extra registration parameters # lua_slider.extra registration parameters
This widget has no extra registration parameters This widget has no extra registration parameters
2.63.3. types.lua_slider.soft_min # lua_slider.soft_min
`number` `number`
@ -31,7 +31,7 @@ Attributes:
* [write](../attributes#write) * [write](../attributes#write)
2.63.4. types.lua_slider.soft_max # lua_slider.soft_max
`number` `number`
@ -42,7 +42,7 @@ Attributes:
* [write](../attributes#write) * [write](../attributes#write)
2.63.5. types.lua_slider.hard_min # lua_slider.hard_min
`number` `number`
@ -53,7 +53,7 @@ Attributes:
* [write](../attributes#write) * [write](../attributes#write)
2.63.6. types.lua_slider.hard_max # lua_slider.hard_max
`number` `number`
@ -64,7 +64,7 @@ Attributes:
* [write](../attributes#write) * [write](../attributes#write)
2.63.7. types.lua_slider.step # lua_slider.step
`number` `number`
@ -74,7 +74,7 @@ Attributes:
* [write](../attributes#write) * [write](../attributes#write)
2.63.8. types.lua_slider.digits # lua_slider.digits
`integer` `integer`
@ -84,7 +84,7 @@ Attributes:
* [write](../attributes#write) * [write](../attributes#write)
2.63.9. types.lua_slider.value # lua_slider.value
`number` `number`
@ -94,7 +94,7 @@ Attributes:
* [write](../attributes#write) * [write](../attributes#write)
2.63.10. types.lua_slider.label # lua_slider.label
`string` `string`

4
content/lua.api.manual/types/lua_widget.md
View file

@ -46,9 +46,9 @@ function(
) )
``` ```
A function to call when the widget needs to reset itself A function to call when the widget needs to reset itself.
Note that some widgets have a default implementation that can be overridden, \(containers in particular will recursively reset their children\). If you replace that default implementation you need to reimplement that functionality or call the original function within your Note that some widgets have a default implementation that can be overridden, \(containers in particular will recursively reset their children\). If you replace that default implementation you need to reimplement that functionality or call the original function within your
callback callback.
Attributes: Attributes: