Difference between revisions of "INX Parameters"

From Inkscape Wiki
Jump to navigation Jump to search
(→‎Types: document "max_length" for string parameters)
m (→‎Available types: try to fix table some more (remove extraneous column))
(18 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:
  
<code><pre>
+
<pre>
 
<param name="some_name" type="some_type">default value</param>
 
<param name="some_name" type="some_type">default value</param>
</pre></code>
+
</pre>
  
 
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 ==
===type===
 
Gives the type of parameter (int|float|string|boolean|enum|notebook|description|optiongroup|color).
 
  
===name===
+
=== gui-description ===
Identifier of the parameter.
+
Tooltip of the parameter, which is shown when the user hovers the mouse cursor over the active area of the parameter in question.
  
===gui-text===
+
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 ===
 
Label of the parameter.
 
Label of the parameter.
  
Not used by the notebook parameter (you can set the attribute, but it doesn't show in the dialog).
+
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>).
  
===gui-description===
+
=== name ===
Tooltip of the parameter.
+
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!
  
===gui-hidden===
+
=== type ===
If true, hide the parameter in the GUI (default to false).
+
The <code>type</code> attribute determines the type of the parameter (possible values are <code>boolean, int, float, string, enum, optiongroup, color, notebook, description</code>), see the extensive description of [[#Available types|available types]] below.
  
== Types ==
+
== Available types ==
  
 
{| class="wikitable" style="width:100%"
 
{| class="wikitable" style="width:100%"
 +
 
|-
 
|-
 
! Type
 
! Type
! Code
+
! Description / Code
 
! Result
 
! Result
 +
 
|-
 
|-
|string
+
! boolean
|A textbox to capture a '''character string'''.
+
|Creates a checkbox input to set a '''boolean value'''. Set the default value to <code>true</code> or <code>1</code>, <code>false</code> or <code>0</code>.
<code><pre>
+
 
<param name="some_name" type="string" _gui-text="Some text label">Some default text</param>
+
<pre>
</pre></code>
+
<param name="name" type="boolean" gui-text="Some label text">false</param>
To limit the number of characters the user is allowed to enter use the <code>max_length</code> attribute.
+
</pre>
|[[File:INX_sample-string.png]]
+
|[[File:INX_sample-boolean.png]]
 +
 
 
|-
 
|-
|int
+
! color
|To get a textbox for an '''integer''' number. Limit the input range with the <code>min</code> and <code>max</code> attributes. By default, min=0 and max=10.
+
|Creates a control to select a '''color value'''.
<code><pre>
+
The '''returned value''' is an RGBA-value.
<param name="some_name" type="int" min="1" max="100" _gui-text="Some label text">1</param>
+
 
</pre></code>
+
<pre>
|[[File:INX_sample-int.png]]
+
<param name="name" type="color"></param>
 +
</pre>
 +
|[[File:INX_sample-color.png]]
 +
 
 
|-
 
|-
|float
+
! description
|To get a textbox for a '''float number'''. Limit the input range with the <code>min</code> and <code>max</code> attributes. To set the number of decimal places, use the <code>precision</code> attribute. By default, min=0, max=10, and precision=1
+
|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.
<code><pre>
+
 
<param name="some_name" type="float" precision="3" min="0" max="9999"
+
<pre>
_gui-text="Some label text">1.234</param>
+
<param name="name" type="description">Some text here.</param>
</pre></code>
+
</pre>
|[[File:INX_sample-float.png]]
+
 
 +
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>&nbsp;
 +
 
 
|-
 
|-
|boolean
+
! enum
|Gives a '''checkbox'''. Set the default value to <code>true</code> or <code>1</code>, <code>false</code> or <code>0</code>.
+
|Creates a drop-down list from which '''one predefined value''' can be chosen. The different choices are created with <code><item></code> elements. The first <code><item></code> is selected by default.
<code><pre>
+
The '''returned value''' for <code>enum</code> type parameters is the value of the <code>value</code> attribute of the selected <code><item></code>.
<param name="some_name" type="boolean" _gui-text="Some label text">false</param>
+
 
</pre></code>
+
<pre>
|[[File:INX_sample-boolean.png]]
+
<param name="name" type="enum" gui-text="Some label text">
|-
+
   <item value="1">First option</item>
|enum
+
   <item value="2">Second option</item>
|Creates a list of choices where the user can only select '''one option''' using a drop down select list. Create the different choices with <code><item></code> elements. The first item is selected by default. The '''returned value''' for the optiongroup element is the '''value attribute of the selected item'''.
 
<code><pre>
 
<param name="some_name" type="enum" _gui-text="Some label text">
 
   <_item value="1">First option</_item>
 
   <_item value="2">Second option</_item>
 
 
</param>
 
</param>
</pre></code>
+
</pre>
 
|[[File:INX_sample-enum.png]]
 
|[[File:INX_sample-enum.png]]
 +
 
|-
 
|-
|optiongroup
+
! float
|Creates a list of choices where the user can only select '''one option'''. By default this is displayed as radiobuttons. Set the attribute <code>appearance="minimal"</code> to display a drop down select list instead.
+
|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>)
<code><pre>
+
 
<param name="some_name" type="optiongroup"
+
<pre>
_gui-text="Some label text">
+
<param name="name" type="float" precision="3" min="0" max="9999"  
  <_option value="1">First option</_option>
+
gui-text="Some label text">1.234</param>
  <_option value="2">Second option</_option>
+
</pre>
</param>
+
 
</pre></code>
+
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]]
  
Create the different choices with <code><option></code> elements. The first option is selected by default. The '''returned value''' for the optiongroup element is the '''value attribute of the selected option'''.
 
|[[File:INX_sample-optiongroup.png]]<br><br><br><br><br>[[File:INX_sample-optiongroup-minimal.png]]
 
 
|-
 
|-
|color
+
! int
|Creates a control to select a '''color'''. The returned value is a RGBA-value.
+
|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>)
<code><pre>
+
 
<param name="some_name" type="color"></param>
+
<pre>
</pre></code>
+
<param name="name" type="int" min="1" max="100" gui-text="Some label text">1</param>
|[[File:INX_sample-color.png]]
+
</pre>
 +
 
 +
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]]
 +
 
 
|-
 
|-
|description
+
! notebook
|To show some text in the dialog window, for example as "help" text.
+
|Creates a set of pages (aka tab control). The user can switch between individual pages, each page can contain an arbitrary set of other parameters. Individual pages are created with the <code><page></code> element.
<code><pre>
+
The '''returned value''' for <code>notebook</code> type parameters is the value of the <code>name</code> attribute of the selected <code><page></code>.
<param name="some_name" type="description">Some text here.</param>
+
 
</pre></code>
+
<pre>
When additionally setting the attribute <code>appearance="header"</code> the text is styled as a heading.
+
<param name="name" type="notebook">
<code><pre><param name="some_name" type="description" appearance="header">Header</param></pre></code>
+
    <page name="page_1" gui-text="First page">
|[[File:INX_sample-description.png]]<br><br><br><br>[[File:INX_sample-description_header.png]]
+
        <param>...</param>
 +
    </page>
 +
    <page name="page_2" gui-text="Second page">
 +
        <param>...</param>
 +
    </page>
 +
</param>
 +
</pre>
 +
|[[File:INX_sample-notebook.png]]
 +
 
 
|-
 
|-
|notebook
+
! optiongroup
|Creates a '''set of pages''' or tab-sheets. Create individual pages with the <code>&lt;page&gt;</code> element. The '''returned value''' for the notebook parameter element is the name of the '''selected''' page/tab.
+
|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.
<code><pre>
+
The '''returned value''' for <code>optiongroup</code> type parameters is the value of the <code>value</code> attribute of the selected <code><option></code>.
<param name="some_name" type="notebook">
+
 
  <page name="name_page_1" _gui-text="First page">
+
<pre>
      <param>...</param>
+
<param name="name" type="optiongroup"
   </page>
+
gui-text="Some label text">
  <page name="name_page_2" _gui-text="Second page">
+
  <option value="1">First option</option>
      <param>...</param>
+
   <option value="2">Second option</option>
  </page>
 
 
</param>
 
</param>
</pre></code>
+
</pre>
|[[File:INX_sample-notebook.png]]
+
 
 +
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]]
 +
 
 
|}
 
|}
 +
 +
== 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 <code>_gui-text</code> and <code>_gui-description</code> instead of their counterparts without underscore.
 +
* For <code><item></code>s and <code><option></code>s (both of which do not use the attributes just explained) add an underscore to the tag name itself:<br><code><_item value="1">Localized item name</_item></code> and<br><code><_option value="1">Localized option name</_option></code> respectively.
 +
* 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>
 +
  
 
[[Category:Developer Documentation]]
 
[[Category:Developer Documentation]]
 
[[Category:Extensions]]
 
[[Category:Extensions]]

Revision as of 04:12, 12 February 2017

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).

gui-hidden

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 (possible values are boolean, int, float, string, enum, optiongroup, color, notebook, description), see the extensive description of available types below.

Available types

Type Description / Code Result
boolean Creates a checkbox input to set a boolean value. Set the default value to true or 1, false or 0.
<param name="name" type="boolean" gui-text="Some label text">false</param>
INX sample-boolean.png
color Creates a control to select a color value.

The returned value is an RGBA-value.

<param name="name" type="color"></param>
INX sample-color.png
description Creates a text element. Specifying the attribute xml:space="preserve" preserves whitespace in the text content of the description and enables multiline text.
<param name="name" type="description">Some text here.</param>

When additionally setting the attribute appearance="header" the text is styled as a heading and can be used as another possibility to group parameters.

<param name="name" type="description" appearance="header">Header</param>

All description 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 gui-description attribute for short help texts that are specific to a single parameter, though).


INX sample-description.png
default appearance



INX sample-description header.png
with appearance="header"


 

enum Creates a drop-down list from which one predefined value can be chosen. The different choices are created with <item> elements. The first <item> is selected by default.

The returned value for enum type parameters is the value of the value attribute of the selected <item>.

<param name="name" type="enum" gui-text="Some label text">
   <item value="1">First option</item>
   <item value="2">Second option</item>
</param>
INX sample-enum.png
float Creates a textbox input to enter a floating point number. Limit the input range with the min and max attributes; set the number of decimal places with the precision attribute. (Default: min="0", max="10" and precision="1")
<param name="name" type="float" precision="3" min="0" max="9999" 
gui-text="Some label text">1.234</param>

Use the attribute appearance="full" to create a slider with which the floating point value can be adjusted dynamically over the full range.

INX sample-float.png

INX sample-float full.png
int Creates a textbox input to enter an integer number. Limit the input range with the min and max attributes. (Default: min="0" and max="10")
<param name="name" type="int" min="1" max="100" gui-text="Some label text">1</param>

Use the attribute appearance="full" to create a slider with which the integer value can be adjusted dynamically over the full range.

INX sample-int.png

INX sample-int full.png
notebook Creates a set of pages (aka tab control). The user can switch between individual pages, each page can contain an arbitrary set of other parameters. Individual pages are created with the <page> element.

The returned value for notebook type parameters is the value of the name attribute of the selected <page>.

<param name="name" type="notebook">
    <page name="page_1" gui-text="First page">
        <param>...</param>
    </page>
    <page name="page_2" gui-text="Second page">
        <param>...</param>
    </page>
</param>
INX sample-notebook.png
optiongroup Creates a set of radio buttons from which one predefined value can be chosen. The different choices are created with <option> elements. The first <option> is selected by default.

The returned value for optiongroup type parameters is the value of the value attribute of the selected <option>.

<param name="name" type="optiongroup"
gui-text="Some label text">
   <option value="1">First option</option>
   <option value="2">Second option</option>
</param>

Set the attribute appearance="minimal" to display a drop-down list instead of radio buttons.
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.

INX sample-optiongroup.png




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 max_length attribute. (Default: no limit)
<param name="name" type="string" gui-text="Some text label">Some default text</param>
INX sample-string.png

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 for description type!) parameters an underscore is added to the tag name itself:
    <_param type="description">Localized text here.</_param>