This commit is contained in:
wpferguson 2020-12-22 06:09:41 +00:00
parent 128be69078
commit 7e7b55c8d6
9 changed files with 59 additions and 52 deletions

File diff suppressed because one or more lines are too long

View file

@ -2548,7 +2548,7 @@ Attributes:
write 🔗lua_widget.tooltip string or nil write 🔗lua_widget.tooltip string or nil
Tooltip to display for the widget Tooltip to display for the widget
Attributes: Attributes:
write 🔗lua_widget.reset_callback function( widget : types.lua_widget ) 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).</description> write 🔗lua_widget.reset_callback function( widget : types.lua_widget ) 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).</description>
</item> </item>
<item> <item>
@ -2696,12 +2696,12 @@ Attributes:
<guid>https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_combobox/</guid> <guid>https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_combobox/</guid>
<description>dt_type <description>dt_type
A widget with multiple text entries in a menu 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 A widget with multiple text entries in a menu. 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.
Attributes: Attributes:
has_tostring parent : types.lua_widget 🔗lua_combobox.__call see types.lua_widget.As a function has_tostring parent : types.lua_widget 🔗lua_combobox.__call see types.lua_widget.As a function
🔗lua_combobox.extra registration parameters This widget has no extra registration parameters 🔗lua_combobox.extra registration parameters This widget has no extra registration parameters
🔗lua_combobox.value string 🔗lua_combobox.value string
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 If the combo box is editable, you can set it to any string You can set it to nil to deselect all entries</description> The text content of the selected entry, can be nil.</description>
</item> </item>
<item> <item>
@ -2748,15 +2748,15 @@ The currently selected child, can be nil if the container has no child, can be s
<description>dt_type <description>dt_type
A slider that can be set by the user A slider that can be set by the user
Attributes: Attributes:
has_tostring parent : types.lua_widget 2.63.1. types.lua_slider.__call see types.lua_widget.As a function has_tostring parent : types.lua_widget 🔗lua_slider.__call see types.lua_widget.As a function
2.63.2. types.lua_slider.extra registration parameters This widget has no extra registration parameters 🔗lua_slider.extra registration parameters This widget has no extra registration parameters
2.63.3. types.lua_slider.soft_min 🔗lua_slider.soft_min number
number
The soft minimum value for the slider, the slider can&amp;rsquo;t go beyond this point The soft minimum value for the slider, the slider can&amp;rsquo;t go beyond this point
Attributes: Attributes:
write 2.63.4. types.lua_slider.soft_max write 🔗lua_slider.soft_max number
number The soft maximum value for the slider, the slider can&amp;rsquo;t go beyond this point
The soft maximum value for the slider, the slider can&amp;rsquo;t go beyond this point</description> Attributes:
write 🔗lua_slider.</description>
</item> </item>
<item> <item>

View file

@ -2423,7 +2423,14 @@
</ul> </ul>
<h1 id="dt_imageio_module_format_data_pdftitle"><a href="#dt_imageio_module_format_data_pdftitle">🔗</a>dt_imageio_module_format_data_pdf.title</h1> <h1 id="dt_imageio_module_format_data_pdftitle"><a href="#dt_imageio_module_format_data_pdftitle">🔗</a>dt_imageio_module_format_data_pdf.title</h1>
<p><code>string</code></p> <p><code>string</code></p>
<p>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</p> <p>The title for the document</p>
<p>Attributes:</p>
<ul>
<li><a href="/luadocs/lua.api.manual/attributes/#write">write</a></li>
</ul>
<h1 id="dt_imageio_module_format_data_pdfrotate"><a href="#dt_imageio_module_format_data_pdfrotate">🔗</a>dt_imageio_module_format_data_pdf.rotate</h1>
<p><code>boolean</code></p>
<p>Should the images be rotated to match the PDF orientation</p>
<p>Attributes:</p> <p>Attributes:</p>
<ul> <ul>
<li><a href="/luadocs/lua.api.manual/attributes/#write">write</a></li> <li><a href="/luadocs/lua.api.manual/attributes/#write">write</a></li>
@ -2456,7 +2463,7 @@
<ul> <ul>
<li><a href="/luadocs/lua.api.manual/attributes/#write">write</a></li> <li><a href="/luadocs/lua.api.manual/attributes/#write">write</a></li>
</ul> </ul>
<h1 id="dt_imageio_module_format_data_pdfrotate"><a href="#dt_imageio_module_format_data_pdfrotate">🔗</a>dt_imageio_module_format_data_pdf.rotate</h1> <h1 id="dt_imageio_module_format_data_pdfrotate-1"><a href="#dt_imageio_module_format_data_pdfrotate-1">🔗</a>dt_imageio_module_format_data_pdf.rotate</h1>
<p><code>boolean</code></p> <p><code>boolean</code></p>
<p>Should the images be rotated in the resulting PDF</p> <p>Should the images be rotated in the resulting PDF</p>
<p>Attributes:</p> <p>Attributes:</p>

View file

@ -2574,7 +2574,7 @@ from 0.</p>
<h1 id="dt_lua_image_tis_raw"><a href="#dt_lua_image_tis_raw">🔗</a>dt_lua_image_t.is_raw</h1> <h1 id="dt_lua_image_tis_raw"><a href="#dt_lua_image_tis_raw">🔗</a>dt_lua_image_t.is_raw</h1>
<p><code>boolean</code></p> <p><code>boolean</code></p>
<p>True if the image is a RAW file. <p>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 <strong>WARNING:</strong> 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.</p> dt_lua_image_t.is_raw is not guaranteed to be correct.</p>
<h1 id="dt_lua_image_tis_ldr"><a href="#dt_lua_image_tis_ldr">🔗</a>dt_lua_image_t.is_ldr</h1> <h1 id="dt_lua_image_tis_ldr"><a href="#dt_lua_image_tis_ldr">🔗</a>dt_lua_image_t.is_ldr</h1>
@ -2673,8 +2673,8 @@ iterate through that table).</p>
<pre><code>self:function( <pre><code>self:function(
) )
</code></pre><p>drops the cached version of this image. </code></pre><p>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</p> darktable will regenerate the thumbnail by itself when it is needed.</p>
<ul> <ul>
<li><strong>self</strong> - <em><a href="/luadocs/lua.api.manual/types/dt_lua_image_t/">types.dt_lua_image_t</a></em> - The image whose cache must be dropped.</li> <li><strong>self</strong> - <em><a href="/luadocs/lua.api.manual/types/dt_lua_image_t/">types.dt_lua_image_t</a></em> - The image whose cache must be dropped.</li>
</ul> </ul>

View file

@ -782,7 +782,7 @@ Attributes:
write 🔗lua_widget.tooltip string or nil write 🔗lua_widget.tooltip string or nil
Tooltip to display for the widget Tooltip to display for the widget
Attributes: Attributes:
write 🔗lua_widget.reset_callback function( widget : types.lua_widget ) 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).</description> write 🔗lua_widget.reset_callback function( widget : types.lua_widget ) 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).</description>
</item> </item>
<item> <item>
@ -930,12 +930,12 @@ Attributes:
<guid>https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_combobox/</guid> <guid>https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_combobox/</guid>
<description>dt_type <description>dt_type
A widget with multiple text entries in a menu 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 A widget with multiple text entries in a menu. 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.
Attributes: Attributes:
has_tostring parent : types.lua_widget 🔗lua_combobox.__call see types.lua_widget.As a function has_tostring parent : types.lua_widget 🔗lua_combobox.__call see types.lua_widget.As a function
🔗lua_combobox.extra registration parameters This widget has no extra registration parameters 🔗lua_combobox.extra registration parameters This widget has no extra registration parameters
🔗lua_combobox.value string 🔗lua_combobox.value string
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 If the combo box is editable, you can set it to any string You can set it to nil to deselect all entries</description> The text content of the selected entry, can be nil.</description>
</item> </item>
<item> <item>
@ -982,15 +982,15 @@ The currently selected child, can be nil if the container has no child, can be s
<description>dt_type <description>dt_type
A slider that can be set by the user A slider that can be set by the user
Attributes: Attributes:
has_tostring parent : types.lua_widget 2.63.1. types.lua_slider.__call see types.lua_widget.As a function has_tostring parent : types.lua_widget 🔗lua_slider.__call see types.lua_widget.As a function
2.63.2. types.lua_slider.extra registration parameters This widget has no extra registration parameters 🔗lua_slider.extra registration parameters This widget has no extra registration parameters
2.63.3. types.lua_slider.soft_min 🔗lua_slider.soft_min number
number
The soft minimum value for the slider, the slider can&amp;rsquo;t go beyond this point The soft minimum value for the slider, the slider can&amp;rsquo;t go beyond this point
Attributes: Attributes:
write 2.63.4. types.lua_slider.soft_max write 🔗lua_slider.soft_max number
number The soft maximum value for the slider, the slider can&amp;rsquo;t go beyond this point
The soft maximum value for the slider, the slider can&amp;rsquo;t go beyond this point</description> Attributes:
write 🔗lua_slider.</description>
</item> </item>
<item> <item>

View file

@ -2388,9 +2388,9 @@
</h1> </h1>
<p><code>dt_type</code></p> <p><code>dt_type</code></p>
<p>A widget with multiple text entries in a menu <p>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</p> If it is editable the user can type a value and is not constrained by the values in the menu.</p>
<p>Attributes:</p> <p>Attributes:</p>
<ul> <ul>
<li><a href="/luadocs/lua.api.manual/attributes/#has_tostring">has_tostring</a></li> <li><a href="/luadocs/lua.api.manual/attributes/#has_tostring">has_tostring</a></li>
@ -2402,20 +2402,20 @@ If it is editable the user can type a value and is not constrained by the values
<p>This widget has no extra registration parameters</p> <p>This widget has no extra registration parameters</p>
<h1 id="lua_comboboxvalue"><a href="#lua_comboboxvalue">🔗</a>lua_combobox.value</h1> <h1 id="lua_comboboxvalue"><a href="#lua_comboboxvalue">🔗</a>lua_combobox.value</h1>
<p><code>string</code></p> <p><code>string</code></p>
<p>The text content of the selected entry, can be nil <p>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</p> You can set it to nil to deselect all entries.</p>
<p>Attributes:</p> <p>Attributes:</p>
<ul> <ul>
<li><a href="/luadocs/lua.api.manual/attributes/#write">write</a></li> <li><a href="/luadocs/lua.api.manual/attributes/#write">write</a></li>
</ul> </ul>
<h1 id="lua_comboboxselected"><a href="#lua_comboboxselected">🔗</a>lua_combobox.selected</h1> <h1 id="lua_comboboxselected"><a href="#lua_comboboxselected">🔗</a>lua_combobox.selected</h1>
<p><code>integer</code></p> <p><code>integer</code></p>
<p>The index of the selected entry, or 0 if nothing is selected <p>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</p> You can set it to nil to deselect all entries.</p>
<p>Attributes:</p> <p>Attributes:</p>
<ul> <ul>
<li><a href="/luadocs/lua.api.manual/attributes/#write">write</a></li> <li><a href="/luadocs/lua.api.manual/attributes/#write">write</a></li>
@ -2423,8 +2423,8 @@ You can set it to nil to deselect all entries</p>
<h1 id="lua_combobox"><a href="#lua_combobox">🔗</a>lua_combobox.#</h1> <h1 id="lua_combobox"><a href="#lua_combobox">🔗</a>lua_combobox.#</h1>
<p><code>string</code></p> <p><code>string</code></p>
<p>The various menu entries. <p>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</p> You can removes entries by setting them to nil.</p>
<p>Attributes:</p> <p>Attributes:</p>
<ul> <ul>
<li><a href="/luadocs/lua.api.manual/attributes/#write">write</a></li> <li><a href="/luadocs/lua.api.manual/attributes/#write">write</a></li>

View file

@ -2394,25 +2394,25 @@
<li><a href="/luadocs/lua.api.manual/attributes/#has_tostring">has_tostring</a></li> <li><a href="/luadocs/lua.api.manual/attributes/#has_tostring">has_tostring</a></li>
<li><a href="/luadocs/lua.api.manual/attributes/#parent">parent</a> : <a href="/luadocs/lua.api.manual/types/lua_widget/">types.lua_widget</a></li> <li><a href="/luadocs/lua.api.manual/attributes/#parent">parent</a> : <a href="/luadocs/lua.api.manual/types/lua_widget/">types.lua_widget</a></li>
</ul> </ul>
<p>2.63.1. types.lua_slider.__call <h1 id="lua_slider__call"><a href="#lua_slider__call">🔗</a>lua_slider.__call</h1>
see <a href="/luadocs/lua.api.manual/types/lua_widget/#lua_widgetas-a-function">types.lua_widget.As a function</a></p> <p>see <a href="/luadocs/lua.api.manual/types/lua_widget/#lua_widgetas-a-function">types.lua_widget.As a function</a></p>
<p>2.63.2. types.lua_slider.extra registration parameters <h1 id="lua_sliderextra-registration-parameters"><a href="#lua_sliderextra-registration-parameters">🔗</a>lua_slider.extra registration parameters</h1>
This widget has no extra registration parameters</p> <p>This widget has no extra registration parameters</p>
<p>2.63.3. types.lua_slider.soft_min</p> <h1 id="lua_slidersoft_min"><a href="#lua_slidersoft_min">🔗</a>lua_slider.soft_min</h1>
<p><code>number</code></p> <p><code>number</code></p>
<p>The soft minimum value for the slider, the slider can&rsquo;t go beyond this point</p> <p>The soft minimum value for the slider, the slider can&rsquo;t go beyond this point</p>
<p>Attributes:</p> <p>Attributes:</p>
<ul> <ul>
<li><a href="/luadocs/lua.api.manual/attributes/#write">write</a></li> <li><a href="/luadocs/lua.api.manual/attributes/#write">write</a></li>
</ul> </ul>
<p>2.63.4. types.lua_slider.soft_max</p> <h1 id="lua_slidersoft_max"><a href="#lua_slidersoft_max">🔗</a>lua_slider.soft_max</h1>
<p><code>number</code></p> <p><code>number</code></p>
<p>The soft maximum value for the slider, the slider can&rsquo;t go beyond this point</p> <p>The soft maximum value for the slider, the slider can&rsquo;t go beyond this point</p>
<p>Attributes:</p> <p>Attributes:</p>
<ul> <ul>
<li><a href="/luadocs/lua.api.manual/attributes/#write">write</a></li> <li><a href="/luadocs/lua.api.manual/attributes/#write">write</a></li>
</ul> </ul>
<p>2.63.5. types.lua_slider.hard_min</p> <h1 id="lua_sliderhard_min"><a href="#lua_sliderhard_min">🔗</a>lua_slider.hard_min</h1>
<p><code>number</code></p> <p><code>number</code></p>
<p>The hard minimum value for the slider, the user can&rsquo;t manually enter a value beyond this <p>The hard minimum value for the slider, the user can&rsquo;t manually enter a value beyond this
point point
@ -2420,7 +2420,7 @@ Attributes:</p>
<ul> <ul>
<li><a href="/luadocs/lua.api.manual/attributes/#write">write</a></li> <li><a href="/luadocs/lua.api.manual/attributes/#write">write</a></li>
</ul> </ul>
<p>2.63.6. types.lua_slider.hard_max</p> <h1 id="lua_sliderhard_max"><a href="#lua_sliderhard_max">🔗</a>lua_slider.hard_max</h1>
<p><code>number</code></p> <p><code>number</code></p>
<p>The hard maximum value for the slider, the user can&rsquo;t manually enter a value beyond this <p>The hard maximum value for the slider, the user can&rsquo;t manually enter a value beyond this
point</p> point</p>
@ -2428,28 +2428,28 @@ point</p>
<ul> <ul>
<li><a href="/luadocs/lua.api.manual/attributes/#write">write</a></li> <li><a href="/luadocs/lua.api.manual/attributes/#write">write</a></li>
</ul> </ul>
<p>2.63.7. types.lua_slider.step</p> <h1 id="lua_sliderstep"><a href="#lua_sliderstep">🔗</a>lua_slider.step</h1>
<p><code>number</code></p> <p><code>number</code></p>
<p>The step width of the slider</p> <p>The step width of the slider</p>
<p>Attributes:</p> <p>Attributes:</p>
<ul> <ul>
<li><a href="/luadocs/lua.api.manual/attributes/#write">write</a></li> <li><a href="/luadocs/lua.api.manual/attributes/#write">write</a></li>
</ul> </ul>
<p>2.63.8. types.lua_slider.digits</p> <h1 id="lua_sliderdigits"><a href="#lua_sliderdigits">🔗</a>lua_slider.digits</h1>
<p><code>integer</code></p> <p><code>integer</code></p>
<p>The number of decimal digits shown on the slider</p> <p>The number of decimal digits shown on the slider</p>
<p>Attributes:</p> <p>Attributes:</p>
<ul> <ul>
<li><a href="/luadocs/lua.api.manual/attributes/#write">write</a></li> <li><a href="/luadocs/lua.api.manual/attributes/#write">write</a></li>
</ul> </ul>
<p>2.63.9. types.lua_slider.value</p> <h1 id="lua_slidervalue"><a href="#lua_slidervalue">🔗</a>lua_slider.value</h1>
<p><code>number</code></p> <p><code>number</code></p>
<p>The current value of the slider</p> <p>The current value of the slider</p>
<p>Attributes:</p> <p>Attributes:</p>
<ul> <ul>
<li><a href="/luadocs/lua.api.manual/attributes/#write">write</a></li> <li><a href="/luadocs/lua.api.manual/attributes/#write">write</a></li>
</ul> </ul>
<p>2.63.10. types.lua_slider.label</p> <h1 id="lua_sliderlabel"><a href="#lua_sliderlabel">🔗</a>lua_slider.label</h1>
<p><code>string</code></p> <p><code>string</code></p>
<p>The label next to the slider</p> <p>The label next to the slider</p>
<p>Attributes:</p> <p>Attributes:</p>

View file

@ -2413,9 +2413,9 @@
<pre><code>function( <pre><code>function(
widget : types.lua_widget widget : types.lua_widget
) )
</code></pre><p>A function to call when the widget needs to reset itself </code></pre><p>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</p> callback.</p>
<p>Attributes:</p> <p>Attributes:</p>
<ul> <ul>
<li> <li>