https://darktable-org.github.io/luadocs/lua.api.manual/types/ Recent content in types on darktable lua documentation Hugo -- gohugo.io en-us https://darktable-org.github.io/luadocs/lua.api.manual/types/overview/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/overview/ This section documents types that are specific to darktable’s Lua API. https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_os_type/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_os_type/ enum The type of OS we darktable can run on Values : windows macos linux unix https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_lua_image_t/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_lua_image_t/ dt_type Image objects represent an image in the database. This is slightly different from a file on disk since a file can have multiple developments. Note that this is the real image object; changing the value of a field will immediately change it in darktable and will be reflected on any copy of that image object you may have kept. Attributes: has_tostring 🔗dt_lua_image_t.attach_tag see darktable.tags.attach 🔗dt_lua_image_t.detach_tag see darktable.tags.detach https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_format_t/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_format_t/ dt_type A virtual type representing all format types. 🔗dt_imageio_module_format_t.plugin_name string A unique name for the plugin. 🔗dt_imageio_module_format_t.name string A human readable name for the plugin. 🔗dt_imageio_module_format_t.extension string The typical filename extension for that format. 🔗dt_imageio_module_format_t.mime string The mime type associated with the format. 🔗dt_imageio_module_format_t.max_width number The max width allowed for the format (0 = unlimited). Attributes: write 2.3.6. dt_imageio_module_format_t.max_height number The max height allowed for the format (0 = unlimited). https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_format_data_png/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_format_data_png/ dt_type Type object describing parameters to export to png. Attributes: parent : types.dt_imageio_module_format_t../types/dt_imageio_module_format_t 🔗dt_imageio_module_format_data_png.bpp number The bpp parameter to use when exporting. Attributes: write https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_format_data_tiff/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_format_data_tiff/ dt_type Type object describing parameters to export to tiff. Attributes: parent : types.dt_imageio_module_format_t 🔗dt_imageio_module_format_data_tiff.bpp number The bpp parameter to use when exporting. Attributes: write https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_format_data_exr/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_format_data_exr/ dt_type Type object describing parameters to export to exr. Attributes: parent : types.dt_imageio_module_format_t 🔗dt_imageio_module_format_data_exr.compression string The compression parameter to use when exporting. Attributes: write https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_format_data_copy/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_format_data_copy/ dt_type Type object describing parameters to export to copy. Attributes: parent : types.dt_imageio_module_format_t https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_format_data_pfm/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_format_data_pfm/ dt_type Type object describing parameters to export to pfm. Attributes: parent : types.dt_imageio_module_format_t https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_format_data_jpeg/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_format_data_jpeg/ dt_type Type object describing parameters to export to jpeg. Attributes: parent : types.dt_imageio_module_format_t 🔗dt_imageio_module_format_data_jpeg.quality number The quality to use at export time. Attributes: write https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_format_data_ppm/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_format_data_ppm/ dt_type Type object describing parameters to export to ppm. Attributes: parent : types.dt_imageio_module_format_t https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_format_data_webp/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_format_data_webp/ dt_type Type object describing parameters to export to webp. Attributes: parent : types.dt_imageio_module_format_t 🔗dt_imageio_module_format_data_webp.quality number The quality to use at export time. Attributes: write 🔗dt_imageio_module_format_data_webp.comp_type types.comp_type_t The overall quality to use; can be one of “webp_lossy” or “webp_lossless”. Attributes: write 🔗dt_imageio_module_format_data_webp.hint types.hint_t A hint on the overall content of the image. Attributes: write https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_format_data_j2k/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_format_data_j2k/ dt_type Type object describing parameters to export to jpeg2000. Attributes: parent : types.dt_imageio_module_format_t 🔗dt_imageio_module_format_data_j2k.quality number The quality to use at export time. Attributes: write 🔗dt_imageio_module_format_data_j2k.bpp number The bpp parameter to use when exporting. Attributes: write 🔗dt_imageio_module_format_data_j2k.format types.dt_imageio_j2k_format_t The format to use. Attributes: write 🔗dt_imageio_module_format_data_j2k.preset types.dt_imageio_j2k_preset_t The preset to use. Attributes: 62 write https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_format_data_pdf/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_format_data_pdf/ dt_type Type object describing parameters to export to pdf. Attributes: parent : types.dt_imageio_module_format_t 🔗dt_imageio_module_format_data_pdf.dpi number The dot per inch value to use at export Attributes: write 🔗dt_imageio_module_format_data_pdf.icc boolean Should the images be tagged with their embedded profile Attributes: write 🔗dt_imageio_module_format_data_pdf.border string Empty space around the PDF images Attributes: write 🔗dt_imageio_module_format_data_pdf.orientation string Orientation of the pages in the document Attributes: write 🔗dt_imageio_module_format_data_pdf. https://darktable-org.github.io/luadocs/lua.api.manual/types/_pdf_mode_t/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/_pdf_mode_t/ enum The export mode to use for PDF document Values: normal draft debug https://darktable-org.github.io/luadocs/lua.api.manual/types/_pdf_pages_t/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/_pdf_pages_t/ enum The different page types for PDF export Values : all single contact https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_pdf_stream_encoder_t/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_pdf_stream_encoder_t/ enum The compression mode for PDF document Values: uncompressed deflate https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_storage_t/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_storage_t/ dt_type A virtual type representing all storage types. 🔗dt_imageio_module_storage_t.plugin_name string A unique name for the plugin. Attributes: write 🔗dt_imageio_module_storage_t.name string A human readable name for the plugin. Attributes: write 🔗dt_imageio_module_storage_t.width number The currently selected width for the plugin. Attributes: write 🔗dt_imageio_module_storage_t.height number The currently selected height for the plugin. Attributes: write 🔗dt_imageio_module_storage_t.recommended_width number The recommended width for the plugin. Attributes: write 🔗dt_imageio_module_storage_t. https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_storage_data_email/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_storage_data_email/ dt_type An object containing parameters to export to email. Attributes: parent : types.dt_imageio_module_storage_t https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_storage_data_latex/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_storage_data_latex/ dt_type An object containing parameters to export to latex. Attributes: parent : types.dt_imageio_module_storage_t 🔗dt_imageio_module_storage_data_latex.filename string The filename to export to. Attributes: write 🔗dt_imageio_module_storage_data_latex.title string The title to use for export. Attributes: write https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_storage_data_piwigo/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_storage_data_piwigo/ dt_type An object containing parameters to export to piwigo. Attributes: parent : types.dt_imageio_module_storage_t https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_storage_data_gallery/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_storage_data_gallery/ dt_type An object containing parameters to export to gallery. Attributes: parent : types.dt_imageio_module_storage_t 🔗dt_imageio_module_storage_data_gallery.filename string The filename to export to. Attributes: write 🔗dt_imageio_module_storage_data_gallery.title string The title to use for export. Attributes: write https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_storage_data_disk/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_module_storage_data_disk/ dt_type An object containing parameters to export to disk. Attributes: parent : types.dt_imageio_module_storage_t 🔗dt_imageio_module_storage_data_disk.filename string The filename to export to. Attributes: write https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_lua_film_t/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_lua_film_t/ dt_type A film in darktable; this represents a directory containing imported images. Attributes: has_tostring 🔗dt_lua_film_t.move_image see darktable.database.move_image 🔗dt_lua_film_t.copy_image see darktable.database.copy_image 🔗dt_lua_film_t.# types.dt_lua_image_t The different images within the film. 🔗dt_lua_film_t.id number A unique numeric id used by this film. Attributes: write 🔗dt_lua_film_t.path string The path represented by this film. Attributes: write 🔗dt_lua_film_t.delete self:function( [force : boolean] ) Removes the film from the database. self - types. https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_style_t/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_style_t/ dt_type A style that can be applied to an image. Attributes: has_tostring 🔗dt_style_t.delete see darktable.styles.delete 🔗dt_style_t.duplicate see darktable.styles.duplicate 🔗dt_style_t.apply see darktable.styles.apply 🔗dt_style_t.export see darktable.styles.export 🔗dt_style_t.name string The name of the style. 🔗dt_style_t.description string The description of the style. 🔗dt_style_t.# types.dt_style_item_t The different items that make the style. https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_style_item_t/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_style_item_t/ dt_type An element that is part of a style. Attributes: has_tostring 🔗dt_style_item_t.name string The name of the style item. 🔗dt_style_item_t.num number The position of the style item within its style. https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_lua_tag_t/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_lua_tag_t/ dt_type A tag that can be attached to an image. Attributes: has_tostring 🔗dt_lua_tag_t.delete see darktable.tags.delete 🔗dt_lua_tag_t.attach see darktable.tags.attach 🔗dt_lua_tag_t.detach see darktable.tags.detach 🔗dt_lua_tag_t.name string The name of the tag. 🔗dt_lua_tag_t.# types.dt_lua_image_t The images that have that tag attached to them. https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_lua_lib_t/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_lua_lib_t/ dt_type The type of a UI lib 🔗dt_lua_lib_t.id string A unit string identifying the lib 🔗dt_lua_lib_t.name string The translated title of the UI element 🔗dt_lua_lib_t.version number The version of the internal data of this lib 🔗dt_lua_lib_t.visible boolean Allow to make a lib module completely invisible to the user. Note that if the module is invisible the user will have no way to restore it without lua Attributes: implicit_yield write 🔗dt_lua_lib_t. https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_lua_view_t/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_lua_view_t/ dt_type A darktable view 🔗dt_lua_view_t.id string A unique string identifying the view 🔗dt_lua_view_t.name string The name of the view https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_lua_backgroundjob_t/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_lua_backgroundjob_t/ dt_type A lua-managed entry in the backgroundjob lib 🔗dt_lua_backgroundjob_t.percent number The value of the progress bar, between 0 and 1. will return nil if there is no progress bar, will raise an error if read or written on an invalid job Attributes: write 🔗dt_lua_backgroundjob_t.valid boolean True if the job is displayed, set it to false to destroy the entry An invalid job cannot be made valid again Attributes: https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_lua_snapshot_t/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_lua_snapshot_t/ dt_type The description of a snapshot in the snapshot lib Attributes: has_tostring 🔗dt_lua_snapshot_t.filename string The filename of an image containing the snapshot 🔗dt_lua_snapshot_t.select self:function( ) Activates this snapshot on the display. To deactivate all snapshot you need to call this function on the active snapshot self - types.dt_lua_snapshot_t - The snapshot to activate 🔗dt_lua_snapshot_t.name string The name of the snapshot, as seen in the UI https://darktable-org.github.io/luadocs/lua.api.manual/types/hint_t/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/hint_t/ enum a hint on the way to encode a webp image Values: hint_default hint_picture hint_photo hint_graphic https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_ui_container_t/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_ui_container_t/ enum A place in the darktable UI where a lib can be placed Values: DT_UI_CONTAINER_PANEL_LEFT_TOP DT_UI_CONTAINER_PANEL_LEFT_CENTER DT_UI_CONTAINER_PANEL_LEFT_BOTTOM DT_UI_CONTAINER_PANEL_RIGHT_TOP DT_UI_CONTAINER_PANEL_RIGHT_CENTER DT_UI_CONTAINER_PANEL_RIGHT_BOTTOM DT_UI_CONTAINER_PANEL_TOP_LEFT DT_UI_CONTAINER_PANEL_TOP_CENTER DT_UI_CONTAINER_PANEL_TOP_RIGHT DT_UI_CONTAINER_PANEL_CENTER_TOP_LEFT DT_UI_CONTAINER_PANEL_CENTER_TOP_CENTER DT_UI_CONTAINER_PANEL_CENTER_TOP_RIGHT DT_UI_CONTAINER_PANEL_CENTER_BOTTOM_LEFT DT_UI_CONTAINER_PANEL_CENTER_BOTTOM_CENTER DT_UI_CONTAINER_PANEL_CENTER_BOTTOM_RIGHT DT_UI_CONTAINER_PANEL_BOTTOM https://darktable-org.github.io/luadocs/lua.api.manual/types/snapshot_direction_t/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/snapshot_direction_t/ enum Which part of the main window is occupied by a snapshot Values: left right top bottom https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_j2k_format_t/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_j2k_format_t/ enum J2K format type Values: j2k jp2 https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_j2k_preset_t/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_j2k_preset_t/ enum J2K preset type Values: off cinema2k_24 cinema2k_48 cinema4k_24 https://darktable-org.github.io/luadocs/lua.api.manual/types/comp_type_t/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/comp_type_t/ enum Type of compression for webp Values: webp_lossy webp_lossless https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_pref_type/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_pref_type/ enum The type of value to save in a preference Values: enum directory file string bool integer float lua https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_exr_compression_t/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_imageio_exr_compression_t/ enum The type of compression to use for the EXR image Values: off rle zips zip piz pxr24 b44 b44a https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_lib_collect_params_rule_t/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_lib_collect_params_rule_t/ dt_type A single rule for filtering a collection 🔗dt_lib_collect_params_rule_t.mode types.dt_lib_collect_mode_t How this rule is applied after the previous one. Unused for the first rule Attributes: write 🔗dt_lib_collect_params_rule_t.data string The text segment of the rule. Exact content depends on the type of rule Attributes: write 🔗dt_lib_collect_params_rule_t.item types.dt_collection_properties_t The item on which this rule filter. i.e the type of the rule Attributes: write https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_lib_collect_mode_t/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_lib_collect_mode_t/ enum The logical operators to apply between rulesAttributes: Values: DT_LIB_COLLECT_MODE_AND DT_LIB_COLLECT_MODE_OR DT_LIB_COLLECT_MODE_AND_NOT https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_collection_properties_t/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_collection_properties_t/ enum The different elements on which a collection can be filtered Values: DT_COLLECTION_PROP_FILMROLL DT_COLLECTION_PROP_FOLDERS DT_COLLECTION_PROP_CAMERA DT_COLLECTION_PROP_TAG DT_COLLECTION_PROP_DAY DT_COLLECTION_PROP_TIME DT_COLLECTION_PROP_IMPORT_TIMESTAMP DT_COLLECTION_PROP_CHANGE_TIMESTAMP DT_COLLECTION_PROP_EXPORT_TIMESTAMP DT_COLLECTION_PROP_PRINT_TIMESTAMP DT_COLLECTION_PROP_HISTORY DT_COLLECTION_PROP_COLORLABEL DT_COLLECTION_PROP_TITLE DT_COLLECTION_PROP_DESCRIPTION DT_COLLECTION_PROP_CREATOR DT_COLLECTION_PROP_PUBLISHER DT_COLLECTION_PROP_RIGHTS DT_COLLECTION_PROP_LENS DT_COLLECTION_PROP_FOCAL_LENGTH DT_COLLECTION_PROP_ISO DT_COLLECTION_PROP_APERTURE DT_COLLECTION_PROP_FILENAME DT_COLLECTION_PROP_GEOTAGGING https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_collection_sort_t/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_collection_sort_t/ enum The different elements on which a collection can be sorted Values: DT_COLLECTION_SORT_NONE DT_COLLECTION_SORT_FILENAME DT_COLLECTION_SORT_DATETIME DT_COLLECTION_SORT_RATING DT_COLLECTION_SORT_ID DT_COLLECTION_SORT_COLOR DT_COLLECTION_SORT_GROUP DT_COLLECTION_SORT_PATH DT_COLLECTION_SORT_CUSTOM_ORDER DT_COLLECTION_SORT_TITLE DT_COLLECTION_SORT_DESCRIPTION DT_COLLECTION_SORT_ASPECT_RATIO DT_COLLECTION_SORT_SHUFFLE https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_collection_sort_order_t/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_collection_sort_order_t/ enum The different orders that a collection can be sorted in Values: DT_COLLECTION_SORT_ORDER_ASCENDING DT_COLLECTION_SORT_ORDER_DESCENDING https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_collection_filter_t/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_collection_filter_t/ enum The different elements on which a collection can be filtered Values: DT_COLLECTION_FILTER_ALL DT_COLLECTION_FILTER_STAR_NO DT_COLLECTION_FILTER_STAR_1 DT_COLLECTION_FILTER_STAR_2 DT_COLLECTION_FILTER_STAR_3 DT_COLLECTION_FILTER_STAR_4 DT_COLLECTION_FILTER_STAR_5 DT_COLLECTION_FILTER_REJECT DT_COLLECTION_FILTER_NOT_REJECT https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_collection_rating_comperator_t/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_collection_rating_comperator_t/ enum The different ways in which a collection filter can be compared Values: DT_COLLECTION_RATING_COMP_LT DT_COLLECTION_RATING_COMP_LEQ DT_COLLECTION_RATING_COMP_EQ DT_COLLECTION_RATING_COMP_GEQ DT_COLLECTION_RATING_COMP_GT DT_COLLECTION_RATING_COMP_NE DT_COLLECTION_RATING_N_COMPS https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_lua_orientation_t/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_lua_orientation_t/ enum A possible orientation for a widget Values: horizontal vertical https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_lua_align_t/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_lua_align_t/ enum The alignment of a label Values: fill start end center baseline https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_lua_ellipsize_mode_t/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_lua_ellipsize_mode_t/ enum The ellipsize mode of a label Values: none start middle end https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_lua_cairo_t/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_lua_cairo_t/ dt_type A wrapper around a cairo drawing context. You probably shouldn’t use this after the callback that got it passed returned. For more details of the member functions have a look at the cairo documentation for the drawing context, transformations and paths. 🔗dt_lua_cairo_t.save self:function( ) Save the state of the drawing context. self - types.dt_lua_cairo_t - The context to modify. 🔗types.dt_lua_cairo_t.restore self:function( ) Restore a previously saved state. https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_ui_panel_t/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_ui_panel_t/ enum The different user interface panels Values: DT_UI_PANEL_TOP DT_UI_PANEL_CENTER_TOP DT_UI_PANEL_CENTER_BOTTOM DT_UI_PANEL_LEFT DT_UI_PANEL_RIGHT DT_UI_PANEL_BOTTOM DT_UI_PANEL_SIZE https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_lighttable_layout_t/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/dt_lighttable_layout_t/ enum The different lighttable layouts Values: DT_LIGHTTABLE_LAYOUT_FIRST DT_LIGHTTABLE_LAYOUT_ZOOMABLE DT_LIGHTTABLE_LAYOUT_FILEMANAGER DT_LIGHTTABLE_LAYOUT_CULLING DT_LIGHTTABLE_LAYOUT_LAST https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_widget/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_widget/ dt_type Common parent type for all lua-handled widgets Attributes: has_tostring 🔗lua_widget.extra registration parameters This widget has no extra registration parameters 🔗lua_widget.sensitive boolean Set if the widget is enabled/disabled Attributes: write 🔗lua_widget.tooltip string or nil Tooltip to display for the widget 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). https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_container/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_container/ dt_type A widget containing other widgets Attributes: has_tostring parent : types.lua_widget 🔗lua_container.__call see types.lua_widget.As a function 🔗lua_container.extra registration parameters This widget has no extra registration parameters 🔗lua_container.# types.lua_widget The widgets contained by the box. You can append widgets by adding them at the end of the list. You can remove widgets by setting them to nil. Attributes: write https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_check_button/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_check_button/ dt_type A checkable button with a label next to it Attributes: has_tostring parent : types.lua_widget 🔗lua_check_button.__call see types.lua_widget.As a function 🔗lua_check_button.extra registration parameters This widget has no extra registration parameters 🔗lua_check_button.label string The label displayed next to the button Attributes: write 🔗lua_check_button.value boolean If the widget is checked or not Attributes: write 🔗lua_check_button.clicked_callback function( widget : types.lua_widget ) A function to call on button click https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_label/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_label/ dt_type A label containing some text Attributes: has_tostring parent : types.lua_widget 🔗lua_label.__call see types.lua_widget.As a function 🔗lua_label.extra registration parameters This widget has no extra registration parameters 🔗lua_label.label string The label displayed Attributes: write 🔗lua_label.selectable boolean True if the label content should be selectable Attributes: write 🔗lua_label.halign types.dt_lua_align_t The horizontal alignment of the label Attributes: write 🔗lua_label.ellipsize types.dt_lua_ellipsize_mode_t The ellipsize mode of the label https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_button/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_button/ dt_type A clickable button Attributes: has_tostring parent : types.lua_widget 🔗lua_button.__call see types.lua_widget.As a function 🔗lua_button.extra registration parameters This widget has no extra registration parameters 🔗lua_button.label string The label displayed on the button Attributes: write 🔗lua_button.ellipsize types.dt_lua_ellipsize_mode_t The ellipsize mode of the button label Attributes: write 🔗lua_button.clicked_callback function( widget : types.lua_widget ) A function to call on button click widget - types.lua_widget - The widget that triggered the callback Attributes: https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_box/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_box/ dt_type A container for widget in a horizontal or vertical list Attributes: has_tostring parent : types.lua_widget 🔗lua_box.__call see types.lua_widget.As a function 🔗lua_box.extra registration parameters This widget has no extra registration parameters 🔗lua_box.orientation types.dt_lua_orientation_t The orientation of the box. Attributes: write https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_entry/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_entry/ dt_type A widget in which the user can input text Attributes: has_tostring parent : types.lua_widget 🔗lua_entry.__call see types.lua_widget.As a function 🔗lua_entry.extra registration parameters This widget has no extra registration parameters 🔗lua_entry.text string The content of the entry Attributes: write 🔗lua_entry.placeholder string The text to display when the entry is empty Attributes: write 🔗lua_entry.is_password boolean True if the text content should be hidden Attributes: write 🔗lua_entry. https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_separator/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_separator/ dt_type A widget providing a separation in the UI. Attributes: has_tostring parent : types.lua_widget 🔗lua_separator.__call see types.lua_widget.As a function 🔗lua_separator.extra registration parameters This widget has no extra registration parameters 🔗lua_separator.orientation string The orientation of the separator. Attributes: write https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_combobox/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_combobox/ 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 Attributes: 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.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 https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_file_chooser_button/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_file_chooser_button/ dt_type A button that allows the user to select an existing file Attributes: has_tostring parent : types.lua_widget 🔗lua_file_chooser_button.__call see types.lua_widget.As a function 🔗lua_file_chooser_button.extra registration parameters This widget has no extra registration parameters 🔗lua_file_chooser_button.title string The title of the window when choosing a file Attributes: write 🔗lua_file_chooser_button.value string The currently selected file Attributes: write 🔗lua_file_chooser_button.changed_callback function( widget : types.lua_widget ) A function to call when the value field changes (character entered or value selected) https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_stack/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_stack/ dt_type A container that will only show one of its child at a time Attributes: has_tostring parent : types.lua_widget 🔗lua_stack.__call see types.lua_widget.As a function 🔗lua_stack.extra registration parameters This widget has no extra registration parameters 🔗lua_stack.active types.lua_widget or nil The currently selected child, can be nil if the container has no child, can be set to one of the child widget or to an index in the child table https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_slider/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_slider/ dt_type A slider that can be set by the user Attributes: has_tostring parent : types.lua_widget 2.63.1. types.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 2.63.3. types.lua_slider.soft_min number The soft minimum value for the slider, the slider can’t go beyond this point Attributes: write 2.63.4. types.lua_slider.soft_max number The soft maximum value for the slider, the slider can’t go beyond this point https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_text_view/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_text_view/ dt_type A multiline text input widget Attributes: has_tostring parent : types.lua_widget 🔗lua_text_view.__call see types.lua_widget.As a function 🔗lua_text_view.extra registration parameters This widget has no extra registration parameters 🔗lua_text_view.text string The text in the widget Attributes: write 🔗lua_text_view.editable boolean False if the entry should be read-only Attributes: write https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_section_label/ Mon, 01 Jan 0001 00:00:00 +0000 https://darktable-org.github.io/luadocs/lua.api.manual/types/lua_section_label/ dt_type A section label Attributes: has_tostring parent : types.lua_widget 🔗lua_section_label.__call see types.lua_widget.As a function 🔗types.lua_section_label.extra registration parameters This widget has no extra registration parameters 🔗lua_section_label.label string The section name Attributes: write