Extensions: INX widgets and parameters

From Inkscape Wiki
Revision as of 08:01, 1 November 2010 by Flor (talk | contribs) (→‎notebook)
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

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

List of choices; the different choices are given by <item> elements.

notebook

Creates a set of pages or tab-sheets. Create individual pages with the <page> element.

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>

The returned value for the notebook parameter element is the name of the selected page/tab.

optiongroup

List of choices with rounded checkboxes; the different choices are given by <option> elements.

color

??