Difference between revisions of "Extensions: INX widgets and parameters"

From Inkscape Wiki
Jump to navigation Jump to search
(→‎Types: Added images and rearranged data into tables)
 
(84 intermediate revisions by 10 users not shown)
Line 1: Line 1:
Here you will find the different parameter elements you may use in your .inx files (Inkscape Extensions)
{{Template:MovedToOtherSite|topic=Extension development|new_url=https://inkscape.gitlab.io/extensions/documentation/authors/inx-widgets.html|new_site=GitLab}}


== Introduction ==
----
Use parameter elements to capture user input for further use by a script. The basic structure of the element is:
 
<code><pre>
<param name="some_name" type="some_type">default value</param>
</pre></code>
 
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-tip===
Tooltip of the parameter.
 
Rarely used in the current extensions due to a crashing bug when used in a notebook.
 
===gui-hidden===
If true, hide the parameter in the GUI (default to false).
 
== Types ==
 
{| class="wikitable" style="width:100%"
|-
! Type
! Code
! Result
|-
|string
|A textbox to capture a '''character string'''.
<code><pre>
<param name="some_name" type="string" _gui-text="Some text label">Some default text</param>
</pre></code>
|[[File:INX_sample-string.png]]
|-
|int
|To get a textbox for an '''integer''' number. Limit the input range with the <code>min</code> and <code>max</code> attributes.
<code><pre>
<param name="some_name" type="int" min="1" max="100" _gui-text="Some label text">1</param>
</pre></code>
|[[File:INX_sample-int.png]]
|-
|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.
<code><pre>
<param name="some_name" type="float" precision="3" min="0" max="9999"
_gui-text="Some label text">1.234</param>
</pre></code>
|[[File:INX_sample-float.png]]
|-
|boolean
|Gives a '''checkbox'''. 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="boolean" _gui-text="Some label text">false</param>
</pre></code>
|[[File: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 <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>
</pre></code>
|[[File: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 <code>appearance="minimal"</code> to display a drop down select list instead. 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'''.
<code><pre>
<param name="some_name" type="optiongroup" appearance="minimal"
_gui-text="Some label text">
  <_option value="1">First option</_option>
  <_option value="2">Second option</_option>
</param>
</pre></code>
|[[File:INX_sample-optiongroup-minimal.png]]
|-
|color
|Creates a control to select a '''color'''. The returned value is a RGBA-value.
<code><pre>
<param name="some_name" type="color"></param>
</pre></code>
|[[File:INX_sample-color.png]]
|-
|description
|To show some text in the dialog window, for example as "help" text.
<code><pre>
<param name="some_name" type="description">Some text here.</param>
</pre></code>
|[[File:INX_sample-description.png]]
|-
|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.
<code><pre>
<param name="some_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>
</pre></code>
|[[File:INX_sample-notebook.png]]
|}


[[Category:Developer Documentation]]
[[Category:Developer Documentation]]
[[Category:Extensions]]
[[Category:Extensions]]

Latest revision as of 19:55, 3 February 2023

The Inkscape Wiki is no longer used to host information about Extension development.

You can now find related information at GitLab.

This page is kept for historical reasons, e.g. to document specific decisions in Inkscape development.

Retrieved from "https://wiki.inkscape.org/wiki/index.php?title=Extensions:_INX_widgets_and_parameters&oldid=122085"