This commit is contained in:
wpferguson 2021-02-16 03:15:33 +00:00
parent ab94a34557
commit 00578cbe98
6 changed files with 34 additions and 14 deletions

File diff suppressed because one or more lines are too long

View file

@ -178,8 +178,8 @@ Any changes made using executable_manager won’t be saved in the darkta
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>https://darktable-org.github.io/luadocs/lua.api.manual/version/</guid> <guid>https://darktable-org.github.io/luadocs/lua.api.manual/version/</guid>
<description>🔗Current API The Lua API version currently used in darktable 3.4 is 6.1.0. <description>🔗Current API The Lua API version currently used in darktable 3.4.x is 6.1.0.
🔗Development API The Lua API is currently at version 6.2.1 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.</description> 🔗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.</description>
</item> </item>
<item> <item>
@ -2867,10 +2867,10 @@ The name of the snapshot, as seen in the UI</description>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>https://darktable-org.github.io/luadocs/lua.api.manual/darktable/gui/libs/select/</guid> <guid>https://darktable-org.github.io/luadocs/lua.api.manual/darktable/gui/libs/select/</guid>
<description>The buttons that allow to quickly change the selection <description>The buttons that allow quickly changing the selection
Attributes: Attributes:
has_tostring parent : types.dt_lua_lib_t 🔗darktable.gui.libs.select.register_selection function( label : string, callback : function, [tooltip : string] ) Add a new button and call a callback when it is clicked has_tostring parent : types.dt_lua_lib_t 🔗darktable.gui.libs.select.register_selection function( name : string label : string, callback : function, [tooltip : string] ) Add a new button and call a callback when it is clicked
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 callback -</description> name - string - The name to use to refer to the select button API 6.2.2 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 callback -</description>
</item> </item>
<item> <item>

View file

@ -367,10 +367,10 @@ Attributes:
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>https://darktable-org.github.io/luadocs/lua.api.manual/darktable/gui/libs/select/</guid> <guid>https://darktable-org.github.io/luadocs/lua.api.manual/darktable/gui/libs/select/</guid>
<description>The buttons that allow to quickly change the selection <description>The buttons that allow quickly changing the selection
Attributes: Attributes:
has_tostring parent : types.dt_lua_lib_t 🔗darktable.gui.libs.select.register_selection function( label : string, callback : function, [tooltip : string] ) Add a new button and call a callback when it is clicked has_tostring parent : types.dt_lua_lib_t 🔗darktable.gui.libs.select.register_selection function( name : string label : string, callback : function, [tooltip : string] ) Add a new button and call a callback when it is clicked
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 callback -</description> name - string - The name to use to refer to the select button API 6.2.2 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 callback -</description>
</item> </item>
<item> <item>

View file

@ -3052,7 +3052,7 @@
darktable.gui.libs.select darktable.gui.libs.select
</h1> </h1>
<p>The buttons that allow to quickly change the selection</p> <p>The buttons that allow quickly changing the selection</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>
@ -3060,12 +3060,14 @@
</ul> </ul>
<h2 id="darktableguilibsselectregister_selection"><a href="#darktableguilibsselectregister_selection">🔗</a>darktable.gui.libs.select.register_selection</h2> <h2 id="darktableguilibsselectregister_selection"><a href="#darktableguilibsselectregister_selection">🔗</a>darktable.gui.libs.select.register_selection</h2>
<pre><code>function( <pre><code>function(
name : string
label : string, label : string,
callback : function, callback : function,
[tooltip : string] [tooltip : string]
) )
</code></pre><p>Add a new button and call a callback when it is clicked</p> </code></pre><p>Add a new button and call a callback when it is clicked</p>
<ul> <ul>
<li><strong>name</strong> - <em>string</em> - The name to use to refer to the select button <strong>API 6.2.2</strong></li>
<li><strong>label</strong> - <em>string</em> - The label to display on the button</li> <li><strong>label</strong> - <em>string</em> - The label to display on the button</li>
<li><strong>callback</strong> - <em>function</em> - The function to call when the button is pressed</li> <li><strong>callback</strong> - <em>function</em> - The function to call when the button is pressed</li>
<li><strong>[tooltip]</strong> - <em>string</em> - The tooltip to use on the new button</li> <li><strong>[tooltip]</strong> - <em>string</em> - The tooltip to use on the new button</li>
@ -3081,6 +3083,24 @@
<li><strong>images</strong> - <em>table of <a href="/luadocs/lua.api.manual/types/dt_lua_image_t/">types.dt_lua_image_t</a></em> - The images in the current collection. This is the same content asdarktable.collection</li> <li><strong>images</strong> - <em>table of <a href="/luadocs/lua.api.manual/types/dt_lua_image_t/">types.dt_lua_image_t</a></em> - The images in the current collection. This is the same content asdarktable.collection</li>
<li><strong>return</strong> - <em>table of <a href="/luadocs/lua.api.manual/types/dt_lua_image_t/">types.dt_lua_image_t</a></em> - The images to set the selection to</li> <li><strong>return</strong> - <em>table of <a href="/luadocs/lua.api.manual/types/dt_lua_image_t/">types.dt_lua_image_t</a></em> - The images to set the selection to</li>
</ul> </ul>
<h2 id="darktableguilibsselectdestroy_selection-api-622"><a href="#darktableguilibsselectdestroy_selection-api-622">🔗</a>darktable.gui.libs.select.destroy_selection <strong>API 6.2.2</strong></h2>
<pre><code>function(
name : string
)
</code></pre><p>Remove a button created by darktable.gui.libs.select.register_selection.</p>
<ul>
<li><strong>name</strong> - <em>string</em> - The name of the selection button to destroy</li>
</ul>
<h2 id="darktableguilibsselectselection_set_sensitive-api-622"><a href="#darktableguilibsselectselection_set_sensitive-api-622">🔗</a>darktable.gui.libs.select.selection_set_sensitive <strong>API 6.2.2</strong></h2>
<pre><code>function(
name : string
sensitive : boolean
)
</code></pre><p>Set the sensitivity of a button created by darktable.gui.libs.select.register_selection.</p>
<ul>
<li><strong>name</strong> - <em>string</em> - The name of the selection button to change the sensitivty of</li>
<li><strong>sensitive</strong> - <em>boolean</em> - True to set the button sensitive, false to set it insensitive</li>
</ul>

View file

@ -12,8 +12,8 @@
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>https://darktable-org.github.io/luadocs/lua.api.manual/version/</guid> <guid>https://darktable-org.github.io/luadocs/lua.api.manual/version/</guid>
<description>🔗Current API The Lua API version currently used in darktable 3.4 is 6.1.0. <description>🔗Current API The Lua API version currently used in darktable 3.4.x is 6.1.0.
🔗Development API The Lua API is currently at version 6.2.1 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.</description> 🔗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.</description>
</item> </item>
<item> <item>

View file

@ -3050,9 +3050,9 @@
</h1> </h1>
<h1 id="current-api"><a href="#current-api">🔗</a>Current API</h1> <h1 id="current-api"><a href="#current-api">🔗</a>Current API</h1>
<p>The Lua API version currently used in darktable 3.4 is 6.1.0.</p> <p>The Lua API version currently used in darktable 3.4.x is 6.1.0.</p>
<h1 id="development-api"><a href="#development-api">🔗</a>Development API</h1> <h1 id="development-api"><a href="#development-api">🔗</a>Development API</h1>
<p>The Lua API is currently at version 6.2.1 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.</p> <p>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.</p>