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

From Inkscape Wiki
Jump to navigation Jump to search
Line 79: Line 79:


==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.
The default value is always the first option element.


Create the different choices with <code><option></code> elements.
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'''.
The '''returned value''' for the optiongroup element is the '''value attribute of the selected option'''.

Revision as of 09:13, 1 November 2010

Here you will find the differents parameters you may use in your .inx files (Inkscape Extensions)

boolean

Gives a checkbox. Set the default value to true or 1, false or 0.

Example:

<param name="some_name" type="boolean" _gui-text="Some label text">false</param>

int

To get a textbox for an integer number. Input to the textbox is limited to integer numbers with up and down buttons at the right-hand side.

Limit the input range with the min and max attributes.

Example:

<param name="some_name" type="int" min="1" max="100" _gui-text="Some label text">1</param>

float

To get a textbox for a float number. Input to the textbox is limited to numbers with up and down buttons at the right-hand side.

Limit the input range with the min and max attributes. To set the number of decimal places, use the precision attribute.

Example:

<param name="some_name" type="float" precision="3" min="0" max="9999" 
_gui-text="Some label text">1.234</param>

string

A textbox to capture a character string.

Example:

<param name="some_name" type="string" _gui-text="Some text label">Some default text</param>

description

To show some text in the dialog window, for example as "help" text.

Example:

<param name="some_name" type="description"">Some text here.</param>

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.

Example:

<param name="some_name" type="enum" _gui-text="Some label text">
   <_item value="1">First option</_item>
   <_item value="2">Second option</_item>
</param>

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.

Example:

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

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.

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.

Example:

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

color

??