Difference between revisions of "INX Parameters"

From Inkscape Wiki
Jump to navigation Jump to search
(→‎Types: int and float parameters: document appearance="full")
(→‎Types: Formatting)
Line 36: Line 36:
 
! Result
 
! Result
 
|-
 
|-
|string
+
! string
 
|A textbox to capture a '''character string'''.
 
|A textbox to capture a '''character string'''.
 
<code><pre>
 
<code><pre>
<param name="some_name" type="string" _gui-text="Some text label">Some default text</param>
+
<param name="name" type="string" gui-text="Some text label">Some default text</param>
 
</pre></code>
 
</pre></code>
 
To limit the number of characters the user is allowed to enter use the <code>max_length</code> attribute.
 
To limit the number of characters the user is allowed to enter use the <code>max_length</code> attribute.
 
|[[File:INX_sample-string.png]]
 
|[[File:INX_sample-string.png]]
 
|-
 
|-
|int
+
! int
 
|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.
 
|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.
 
<code><pre>
 
<code><pre>
<param name="some_name" type="int" min="1" max="100" _gui-text="Some label text">1</param>
+
<param name="name" type="int" min="1" max="100" gui-text="Some label text">1</param>
 
</pre></code>
 
</pre></code>
  
Line 53: Line 53:
 
|[[File:INX_sample-int.png]]<br><br>[[File:INX_sample-int_full.png|240px]]
 
|[[File:INX_sample-int.png]]<br><br>[[File:INX_sample-int_full.png|240px]]
 
|-
 
|-
|float
+
! float
 
|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
 
|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
 
<code><pre>
 
<code><pre>
<param name="some_name" type="float" precision="3" min="0" max="9999"  
+
<param name="name" type="float" precision="3" min="0" max="9999"  
_gui-text="Some label text">1.234</param>
+
gui-text="Some label text">1.234</param>
 
</pre></code>
 
</pre></code>
  
Line 63: Line 63:
 
|[[File:INX_sample-float.png]]<br><br>[[File:INX_sample-float_full.png|240px]]
 
|[[File:INX_sample-float.png]]<br><br>[[File:INX_sample-float_full.png|240px]]
 
|-
 
|-
|boolean
+
! boolean
 
|Gives a '''checkbox'''. Set the default value to <code>true</code> or <code>1</code>, <code>false</code> or <code>0</code>.
 
|Gives a '''checkbox'''. Set the default value to <code>true</code> or <code>1</code>, <code>false</code> or <code>0</code>.
 
<code><pre>
 
<code><pre>
<param name="some_name" type="boolean" _gui-text="Some label text">false</param>
+
<param name="name" type="boolean" gui-text="Some label text">false</param>
 
</pre></code>
 
</pre></code>
 
|[[File:INX_sample-boolean.png]]
 
|[[File:INX_sample-boolean.png]]
 
|-
 
|-
|enum
+
! enum
 
|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'''.
 
|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>
 
<code><pre>
<param name="some_name" type="enum" _gui-text="Some label text">
+
<param name="name" type="enum" gui-text="Some label text">
   <_item value="1">First option</_item>
+
   <item value="1">First option</item>
   <_item value="2">Second option</_item>
+
   <item value="2">Second option</item>
 
</param>
 
</param>
 
</pre></code>
 
</pre></code>
 
|[[File:INX_sample-enum.png]]
 
|[[File:INX_sample-enum.png]]
 
|-
 
|-
|optiongroup
+
! optiongroup
 
|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 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.
 
<code><pre>
 
<code><pre>
<param name="some_name" type="optiongroup"
+
<param name="name" type="optiongroup"
_gui-text="Some label text">
+
gui-text="Some label text">
   <_option value="1">First option</_option>
+
   <option value="1">First option</option>
   <_option value="2">Second option</_option>
+
   <option value="2">Second option</option>
 
</param>
 
</param>
 
</pre></code>
 
</pre></code>
Line 93: Line 93:
 
|[[File:INX_sample-optiongroup.png]]<br><br><br><br><br>[[File:INX_sample-optiongroup-minimal.png]]
 
|[[File:INX_sample-optiongroup.png]]<br><br><br><br><br>[[File:INX_sample-optiongroup-minimal.png]]
 
|-
 
|-
|color
+
! color
 
|Creates a control to select a '''color'''. The returned value is a RGBA-value.
 
|Creates a control to select a '''color'''. The returned value is a RGBA-value.
 
<code><pre>
 
<code><pre>
<param name="some_name" type="color"></param>
+
<param name="name" type="color"></param>
 
</pre></code>
 
</pre></code>
 
|[[File:INX_sample-color.png]]
 
|[[File:INX_sample-color.png]]
 
|-
 
|-
|description
+
! description
 
|To show some text in the dialog window, for example as "help" text.
 
|To show some text in the dialog window, for example as "help" text.
 
<code><pre>
 
<code><pre>
<param name="some_name" type="description">Some text here.</param>
+
<param name="name" type="description">Some text here.</param>
 
</pre></code>
 
</pre></code>
 
When additionally setting the attribute <code>appearance="header"</code> the text is styled as a heading.
 
When additionally setting the attribute <code>appearance="header"</code> the text is styled as a heading.
<code><pre><param name="some_name" type="description" appearance="header">Header</param></pre></code>
+
<code><pre><param name="name" type="description" appearance="header">Header</param></pre></code>
 
|[[File:INX_sample-description.png]]<br><br><br><br>[[File:INX_sample-description_header.png]]
 
|[[File:INX_sample-description.png]]<br><br><br><br>[[File:INX_sample-description_header.png]]
 
|-
 
|-
|notebook
+
! notebook
 
|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 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.
 
<code><pre>
 
<code><pre>
<param name="some_name" type="notebook">
+
<param name="name" type="notebook">
   <page name="name_page_1" _gui-text="First page">
+
   <page name="name_page_1" gui-text="First page">
 
       <param>...</param>
 
       <param>...</param>
 
   </page>
 
   </page>
   <page name="name_page_2" _gui-text="Second page">
+
   <page name="name_page_2" gui-text="Second page">
 
       <param>...</param>
 
       <param>...</param>
 
   </page>
 
   </page>

Revision as of 21:31, 26 November 2015

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

type

Gives the type of parameter (int|float|string|boolean|enum|notebook|description|optiongroup|color).

name

Identifier of the parameter.

gui-text

Label of the parameter.

Not used by the notebook parameter (you can set the attribute, but it doesn't show in the dialog).

gui-description

Tooltip of the parameter.

gui-hidden

If true, hide the parameter in the GUI (default to false).

Types

Type Code Result
string A textbox to capture a character string.
<param name="name" type="string" gui-text="Some text label">Some default text</param>

To limit the number of characters the user is allowed to enter use the max_length attribute.

INX sample-string.png
int To get a textbox for an integer number. Limit the input range with the min and max attributes. By 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
float To get a textbox for a float number. Limit the input range with the min and max attributes. To set the number of decimal places, use the precision attribute. By 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
boolean Gives a checkbox. 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
enum Creates a list of choices where the user can only select one option using a drop down select list. Create the different choices with <item> elements. The first item is selected by default. The returned value for the optiongroup element is 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
optiongroup Creates a list of choices where the user can only select one option. By default this is displayed as radiobuttons. Set the attribute appearance="minimal" to display a drop down select list instead.
<param name="name" type="optiongroup"
gui-text="Some label text">
   <option value="1">First option</option>
   <option value="2">Second option</option>
</param>

Create the different choices with <option> elements. The first option is selected by default. The returned value for the optiongroup element is the value attribute of the selected option.

INX sample-optiongroup.png




INX sample-optiongroup-minimal.png
color Creates a control to select a color. The returned value is a RGBA-value.
<param name="name" type="color"></param>
INX sample-color.png
description To show some text in the dialog window, for example as "help" text.
<param name="name" type="description">Some text here.</param>

When additionally setting the attribute appearance="header" the text is styled as a heading.

<param name="name" type="description" appearance="header">Header</param>
INX sample-description.png



INX sample-description header.png
notebook Creates a set of pages or tab-sheets. Create individual pages with the <page> element. The returned value for the notebook parameter element is the name of the selected page/tab.
<param name="name" type="notebook">
   <page name="name_page_1" gui-text="First page">
      <param>...</param>
   </page>
   <page name="name_page_2" gui-text="Second page">
      <param>...</param>
   </page>
</param>
INX sample-notebook.png