Difference between revisions of "Extensions: INX widgets and parameters"
(→Common attributes: add indent) |
|||
(30 intermediate revisions by 3 users not shown) | |||
Line 4: | Line 4: | ||
Use parameter elements to capture user input for further use by a script. The basic structure of the element is: | Use parameter elements to capture user input for further use by a script. The basic structure of the element is: | ||
< | <source lang="xml"> | ||
<param name="some_name" type="some_type">default value</param> | <param name="some_name" type="some_type">default value</param> | ||
</ | </source> | ||
The default value is the value that is shown in the input control the first time the user opens the dialog window. Inkscape automatically displays the values used last time when the dialog window is opened again. | The default value is the value that is shown in the input control the first time the user opens the dialog window. Inkscape automatically displays the values used last time when the dialog window is opened again. | ||
== Common attributes == | == Common attributes == | ||
=== | === gui-description === | ||
Tooltip of the parameter, which is shown when the user hovers the mouse cursor over the active area of the parameter in question. | |||
To enable translations for this string use the underscore variant (<code>_gui-description </code>, see [[#Localization of parameters|localization of parameters]] below for details). | |||
=== gui-hidden === | |||
If the value is set to <code>true</code> the parameter is hidden from the GUI (defaults to <code>false</code>). | |||
=== gui-text === | === gui-text === | ||
Line 22: | Line 25: | ||
To enable translations for this string use the underscore variant (<code>_gui-text</code>, see [[#Localization of parameters|localization of parameters]] below for details). | To enable translations for this string use the underscore variant (<code>_gui-text</code>, see [[#Localization of parameters|localization of parameters]] below for details). | ||
=== | === indent === | ||
Sets indentation level of the parameter (e.g. <code>indent="1"</code>). | |||
=== name === | |||
The value of the <code>name</code> attribute is used as an identifier of the parameter. It has to be unique since the value of this attribute is used to save and transmit parameter values internally! | |||
=== | |||
=== | === type === | ||
The <code>type</code> attribute determines the type of the parameter (for tags <code><param></code>) (possible values are <code>boolean, int, float, string, enum, optiongroup, color, notebook, description</code>), see the extensive description of [[#Available types|available types]] below. | |||
== Available types == | == Available types == | ||
Line 52: | Line 53: | ||
|- | |- | ||
! | ! color | ||
|Creates a | |Creates a control to select a '''color value'''. | ||
The '''returned value''' is an RGBA-value. | |||
<pre> | <pre> | ||
<param name="name" type=" | <param name="name" type="color"></param> | ||
</pre> | </pre> | ||
|[[File:INX_sample-color.png]] | |||
|[[File:INX_sample- | |||
|- | |- | ||
! | ! description | ||
|Creates a | |Creates a text element. Specifying the attribute <code>xml:space="preserve"</code> preserves whitespace in the text content of the description and enables multiline text. | ||
<pre> | <pre> | ||
<param name="name" type=" | <param name="name" type="description">Some text here.</param> | ||
</pre> | </pre> | ||
When additionally setting the attribute <code>appearance="header"</code> the text is styled as a heading and can be used as another possibility to group parameters. | |||
<pre><param name="name" type="description" appearance="header">Header</param></pre> | |||
All <code>description</code> type parameters are purely informational (they do not return any value). They are intended to be used to provide additional information / help on other parameters (Consider using the <code>gui-description</code> attribute for short help texts that are specific to a single parameter, though). | |||
|[[File:INX_sample-description.png]]<br><small>default appearance</small><br><br><br><br> | |||
[[File:INX_sample-description_header.png]]<br><small>with <code>appearance="header"</code></small><br><br><br> | |||
|- | |- | ||
Line 98: | Line 93: | ||
|- | |- | ||
! | ! float | ||
|Creates a | |Creates a textbox input to enter a '''floating point number'''. Limit the input range with the <code>min</code> and <code>max</code> attributes; set the number of decimal places with the <code>precision</code> attribute. (Default: <code>min="0"</code>, <code>max="10"</code> and <code>precision="1"</code>) | ||
<pre> | <pre> | ||
<param name="name" type=" | <param name="name" type="float" precision="3" min="0" max="9999" | ||
gui-text="Some label text"> | gui-text="Some label text">1.234</param> | ||
</param> | |||
</pre> | </pre> | ||
Use the attribute <code>appearance="full"</code> to create a slider with which the floating point value can be adjusted dynamically over the full range. | |||
|[[File:INX_sample-float.png]]<br><br>[[File:INX_sample-float_full.png|240px]] | |||
|[[File:INX_sample- | |||
|- | |- | ||
! | ! int | ||
|Creates a | |Creates a textbox input to enter an '''integer number'''. Limit the input range with the <code>min</code> and <code>max</code> attributes. (Default: <code>min="0"</code> and <code>max="10"</code>) | ||
<pre> | <pre> | ||
<param name="name" type=" | <param name="name" type="int" min="1" max="100" gui-text="Some label text">1</param> | ||
</pre> | </pre> | ||
|[[File:INX_sample- | |||
Use the attribute <code>appearance="full"</code> to create a slider with which the integer value can be adjusted dynamically over the full range. | |||
|[[File:INX_sample-int.png]]<br><br>[[File:INX_sample-int_full.png|240px]] | |||
|- | |- | ||
Line 142: | Line 133: | ||
|- | |- | ||
! | ! optiongroup | ||
|Creates a | |Creates a set of radio buttons from which '''one predefined value''' can be chosen. The different choices are created with <code><option></code> elements. The first <code><option></code> is selected by default. | ||
The '''returned value''' for <code>optiongroup</code> type parameters is the value of the <code>value</code> attribute of the selected <code><option></code>. | |||
<pre> | <pre> | ||
<param name="name" type=" | <param name="name" type="optiongroup" | ||
gui-text="Some label text"> | |||
<option value="1">First option</option> | |||
<option value="2">Second option</option> | |||
</param> | |||
</pre> | </pre> | ||
Set the attribute <code>appearance="minimal"</code> to display a drop-down list instead of radio buttons.<br> | |||
< | <small>''The option group will occupy the minimum space on the right hand side of the dialog. Versus the Enum, which expands to fill available space.''</small> | ||
|[[File:INX_sample-optiongroup.png]]<br><br><br><br><br>[[File:INX_sample-optiongroup-minimal.png]] | |||
|- | |||
! string | |||
|Creates a textbox input to enter a '''character string'''. Limit the number of characters the user is allowed to enter with the <code>max_length</code> attribute. (Default: no limit) | |||
<pre> | |||
<param name="name" type="string" gui-text="Some text label">Some default text</param> | |||
</pre> | |||
|[[File:INX_sample-string.png]] | |||
|} | |} | ||
Line 167: | Line 168: | ||
* Also for <code>description</code> type (and ''only'' for <code>description</code> type!) parameters an underscore is added to the tag name itself:<br><code><_param type="description">Localized text here.</_param></code> | * Also for <code>description</code> type (and ''only'' for <code>description</code> type!) parameters an underscore is added to the tag name itself:<br><code><_param type="description">Localized text here.</_param></code> | ||
= Editing INX Parameters in 1.0 = | |||
In this section: | |||
* When an attribute is in square brackets (<code>[name="value"]</code>), it means that <code>name</code> is optional. | |||
* The 1 in <code>indent="1"</code> is the indentation level that you want. | |||
== Tags for the layout == | |||
<source lang="xml"> | |||
<label [indent="1"] [appearance="header"]>Some text</label> | |||
<label [indent="1"] [appearance="url"]>http://some/url</label> | |||
<image>some/inx/relative/path/to/img.svg</image> | |||
<spacer/> | |||
<separator [indent="1"]/> | |||
<hbox [indent="1"]></hbox> | |||
<vbox [indent="1"]></vbox> | |||
</source> | |||
== Tags for the parameters == | |||
* The <code>name</code> attribute of tag <code><param></code> means the name of the argument (<code>--name=</code>) your command will get. | |||
* Parameter values (when opening the dialog) are set to the last used value, which is saved in the user's preferences file (e.g. ~/.config/inkscape/preferences.xml on GNU/Linux systems): | |||
<source lang="xml"> | |||
<inkscape> | |||
<group id="extensions" com.attrib.id.param_name="param value"/> | |||
</inkscape> | |||
</source> | |||
The (default) values in the inx file are visible only when the user first uses the extension. | |||
=== Notebook === | |||
{| class="wikitable" | |||
|+ Multiple views/options in the same dialog window. | |||
|- | |||
| colspan="2" | It helps with layouting, and allows you to retrieve the active page (tab) name. | |||
|- | |||
| scope="col" style="width: 240px; background-color:#f0f0f0;" | [[File:INX_sample-notebook.png|border]] | |||
| It defaults to the first page. | |||
|- | |||
| colspan="2" | <source lang="xml"> | |||
<param type="notebook" name="varname" [indent="1"]> | |||
<page name="value" gui-text="label"> | |||
<!-- Any elements contained in the page go here --> | |||
</page> | |||
<!-- You can add as many pages as you like --> | |||
</param> | |||
</source> | |||
|} | |||
*The value of the selected <code><page name></code> attribute will be passed as an argument to your extension. | |||
**The default value is the name of the first page. | |||
*If the same <code><param name></code> is used in multiple tabs, its value will be taken from the last <code><page></code> it appears on. | |||
**This means that it's best to use different names if the same parameter is used on multiple pages. | |||
=== Checkbox === | |||
{| class="wikitable" | |||
|+ To get a boolean value | |||
|- | |||
| scope="col" style="width: 240px; background-color:#f0f0f0;" | [[File:INX_sample-boolean.png]] | |||
| The default value is <code>true</code> | |||
|- | |||
| colspan="2" | | |||
<source lang="xml"> | |||
<param type="bool" name="varname" gui-text="label" [indent="1"]>false</param> | |||
</source> | |||
|} | |||
=== Numeric spinner === | |||
{| class="wikitable" | |||
|+ To get numbers, int or float | |||
|- | |||
| scope="col" style="width: 240px; background-color:#f0f0f0;" | [[File:INX_sample-float.png]] | |||
| scope="col" style="width: 240px; background-color:#f0f0f0;" | [[File:INX_sample-int.png]] | |||
| The default value is 0 | |||
|- | |||
| colspan="3" | | |||
{| style="margin: auto;" | |||
|+ With <code>appearance="full"</code>, you get a full width slider. | |||
|- | |||
| scope="col" style="border: 1px solid #a2a9b1; background-color:#f0f0f0;" | [[File:INX_sample-float_full.png|center]] | |||
|} | |||
|- | |||
| colspan="3" | | |||
<source lang="xml"> | |||
<param type="int" name="varname" gui-text="labal" [min="1"] [max="10"] [appearance="full"] [indent="1"]/> | |||
<param type="float" name="varname" gui-text="label" [min="0.5"] [max="5.0"] [appearance="full"] [indent="1"]/> | |||
</source> | |||
|} | |||
* The widget has a precision of 0.1 for float. | |||
* The default <code>min</code> value is "0". | |||
* The default <code>max</code> value is "10". | |||
=== Text fields === | |||
{| class="wikitable" | |||
|+ Get text input | |||
|- | |||
| scope="col" style="width: 240px; background-color:#f0f0f0;" | [[File:INX_sample-string.png]] | |||
| The default value is the empty string and with such a value, the parameter is omitted. | |||
|- | |||
| colspan="2" | | |||
<source lang="xml"> | |||
<param type="string" name="varname" gui-text="label" [indent="1"] [max-length="5" | appearance="multiline"]>some text</param> | |||
</source> | |||
|} | |||
You can provide an integer to the attribute <code>max-lenght</code> to limit the number of characters you can get. | |||
=== File chooser === | |||
{| class="wikitable" | |||
|+ Get a path, either a file or a directory | |||
|- | |||
| scope="col" style="width: 240px; background-color:#f0f0f0;" | [[File:INX path.png|none]] || Default's to the path of the folder containing the script | |||
|- | |||
| colspan="2" | Use one of: | |||
<source lang="xml"> | |||
<param type="path" name="varname" gui-text="label" [indent="1"] mode="file" filetypes="svg,png"/> | |||
<param type="path" name="varname" gui-text="label" [indent="1"] mode="files" filetypes="svg,png"/> | |||
<param type="path" name="varname" gui-text="label" [indent="1"] mode="file_new" filetypes="svg,png"/> | |||
<param type="path" name="varname" gui-text="label" [indent="1"] mode="folder"/> | |||
<param type="path" name="varname" gui-text="label" [indent="1"] mode="folders"/> | |||
<param type="path" name="varname" gui-text="label" [indent="1"] mode="folder_new"/> | |||
</source> | |||
|} | |||
* The attribute <code>mode</code> with a value of: | |||
** <code>"file"</code> or <code>"folder"</code> (without <code>s</code>) open a file browser for selecting 1 object. | |||
** The versions ending with a <code>s</code> open a file browser for selecting multiple objects. | |||
** And the ones ending with <code>_new</code> are for creating new objects. | |||
* The <code>filetype</code> attribute contains a list of file extensions to look for. In this example only svg or png files will be displayed. | |||
=== A combobox or radio buttons === | |||
{| class="wikitable" | |||
|+ To get a choice of predefined values | |||
|- | |||
| scope="col" style="width: 240px; background-color:#f0f0f0;" | [[File:INX_sample-optiongroup-minimal.png]] | |||
| scope="col" style="width: 240px; background-color:#f0f0f0;" | [[File:INX_sample-optiongroup.png]] | |||
| Default value is the first item | |||
|- | |||
| colspan="3" | | |||
<source lang="xml"> | |||
<param type="optiongroup" name="varname" gui-text="label" [appearance="combo"|appearance="radio"] [indent="1"]> | |||
<item value="value">Some text</item> | |||
<!-- Other choices --> | |||
</param> | |||
</source> | |||
|} | |||
* The default <code>appearance</code> is <code>"radio"</code>. The appearance <code>"combo"</code> is also valid. | |||
=== Color === | |||
{| class="wikitable" | |||
|+ Get a hex color value | |||
|- | |||
| rowspan="2" scope="col" style="width: 240px; background-color:#f0f0f0;" | [[File:INX_sample-color.png]] | |||
| scope="col" style="width: 240px; height: 35px; background-color:#f0f0f0;" | [[File:INX color-btn.png]] | |||
| Default value is <code>#000000FF</code> | |||
|- | |||
| colspan="2" style="vertical-align: top;" | | |||
{| | |||
| style="padding-left: 6em;" | <b style="font-size:18px;">↑</b>With<b style="font-size:18px;">↑</b> the attribute <code>appearance="colorbutton"</code> | |||
|- | |||
| style="height: 100px;" | <b style="font-size:18px;">⇇</b> Without <code>appearance="colorbutton"</code> | |||
|} | |||
|- | |||
| colspan=3 | | |||
<source lang="xml"> | |||
<param type="color" name="varname" [appearance="colorbutton" gui-text="label"] [indent="1"]/> | |||
</source> | |||
|} | |||
The parameter value is an RGBA value in hexadecimal notation. | |||
To document: | |||
* Multiline text fields: appearance="multiline" | |||
* type "description" | |||
* translatable="no" | |||
* implements-custom-gui | |||
[[Category:Developer Documentation]] | [[Category:Developer Documentation]] | ||
[[Category:Extensions]] | [[Category:Extensions]] |
Revision as of 02:11, 29 March 2020
Here you will find the different parameter elements you may use in your .inx files (Inkscape Extensions)
Introduction
Use parameter elements to capture user input for further use by a script. The basic structure of the element is:
<param name="some_name" type="some_type">default value</param>
The default value is the value that is shown in the input control the first time the user opens the dialog window. Inkscape automatically displays the values used last time when the dialog window is opened again.
Common attributes
gui-description
Tooltip of the parameter, which is shown when the user hovers the mouse cursor over the active area of the parameter in question.
To enable translations for this string use the underscore variant (_gui-description
, see localization of parameters below for details).
If the value is set to true
the parameter is hidden from the GUI (defaults to false
).
gui-text
Label of the parameter.
To enable translations for this string use the underscore variant (_gui-text
, see localization of parameters below for details).
indent
Sets indentation level of the parameter (e.g. indent="1"
).
name
The value of the name
attribute is used as an identifier of the parameter. It has to be unique since the value of this attribute is used to save and transmit parameter values internally!
type
The type
attribute determines the type of the parameter (for tags <param>
) (possible values are boolean, int, float, string, enum, optiongroup, color, notebook, description
), see the extensive description of available types below.
Available types
Localization of parameters
To mark parameters to be included into the translation files (this is done automatically during the build process) there exist special variants of all relevant attributes and tag names that start with an underscore.
- Labels and tooltips can be marked for translation by simply using the attribute names
_gui-text
and_gui-description
instead of their counterparts without underscore. - For
<item>
s and<option>
s (both of which do not use the attributes just explained) add an underscore to the tag name itself:<_item value="1">Localized item name</_item>
and<_option value="1">Localized option name</_option>
respectively. - Also for
description
type (and only fordescription
type!) parameters an underscore is added to the tag name itself:<_param type="description">Localized text here.</_param>
Editing INX Parameters in 1.0
In this section:
- When an attribute is in square brackets (
[name="value"]
), it means thatname
is optional. - The 1 in
indent="1"
is the indentation level that you want.
Tags for the layout
<label [indent="1"] [appearance="header"]>Some text</label>
<label [indent="1"] [appearance="url"]>http://some/url</label>
<image>some/inx/relative/path/to/img.svg</image>
<spacer/>
<separator [indent="1"]/>
<hbox [indent="1"]></hbox>
<vbox [indent="1"]></vbox>
Tags for the parameters
- The
name
attribute of tag<param>
means the name of the argument (--name=
) your command will get. - Parameter values (when opening the dialog) are set to the last used value, which is saved in the user's preferences file (e.g. ~/.config/inkscape/preferences.xml on GNU/Linux systems):
<inkscape>
<group id="extensions" com.attrib.id.param_name="param value"/>
</inkscape>
The (default) values in the inx file are visible only when the user first uses the extension.
Notebook
- The value of the selected
<page name>
attribute will be passed as an argument to your extension.- The default value is the name of the first page.
- If the same
<param name>
is used in multiple tabs, its value will be taken from the last<page>
it appears on.- This means that it's best to use different names if the same parameter is used on multiple pages.
Checkbox
The default value is true
| |
<param type="bool" name="varname" gui-text="label" [indent="1"]>false</param>
|
Numeric spinner
- The widget has a precision of 0.1 for float.
- The default
min
value is "0". - The default
max
value is "10".
Text fields
The default value is the empty string and with such a value, the parameter is omitted. | |
<param type="string" name="varname" gui-text="label" [indent="1"] [max-length="5" | appearance="multiline"]>some text</param>
|
You can provide an integer to the attribute max-lenght
to limit the number of characters you can get.
File chooser
Default's to the path of the folder containing the script | |
Use one of:
<param type="path" name="varname" gui-text="label" [indent="1"] mode="file" filetypes="svg,png"/>
<param type="path" name="varname" gui-text="label" [indent="1"] mode="files" filetypes="svg,png"/>
<param type="path" name="varname" gui-text="label" [indent="1"] mode="file_new" filetypes="svg,png"/>
<param type="path" name="varname" gui-text="label" [indent="1"] mode="folder"/>
<param type="path" name="varname" gui-text="label" [indent="1"] mode="folders"/>
<param type="path" name="varname" gui-text="label" [indent="1"] mode="folder_new"/>
|
- The attribute
mode
with a value of:"file"
or"folder"
(withouts
) open a file browser for selecting 1 object.- The versions ending with a
s
open a file browser for selecting multiple objects. - And the ones ending with
_new
are for creating new objects.
- The
filetype
attribute contains a list of file extensions to look for. In this example only svg or png files will be displayed.
A combobox or radio buttons
Default value is the first item | ||
<param type="optiongroup" name="varname" gui-text="label" [appearance="combo"|appearance="radio"] [indent="1"]>
<item value="value">Some text</item>
<!-- Other choices -->
</param>
|
- The default
appearance
is"radio"
. The appearance"combo"
is also valid.
Color
Default value is #000000FF
| |||
| |||
<param type="color" name="varname" [appearance="colorbutton" gui-text="label"] [indent="1"]/>
|
The parameter value is an RGBA value in hexadecimal notation.
To document:
- Multiline text fields: appearance="multiline"
- type "description"
- translatable="no"
- implements-custom-gui