GUI API

GUI API Es ist manchmal notwendig, dass für Vorlagen und Effekte Einstellungen und Eingaben vom Benutzer gebraucht werden. Daher bietet die Scripting-API (http://wiki.aquasoft.de/wiki/index.php/Scripting-API) die Möglichkeit, einfache Grafische Benutzeroberflächen (https://de.wikipedia.org/wiki/Grafische_Benutzeroberfl%C3%A4che) (GUI) zu gestalten. Table of contents * 1 Inserting the GUI (http://support.aquasoft.de/436949-GUI-API#Inserting_the_GUI) * 2 Structure of the JSON string ...

CheckBox 1. Definition _ComboBox_ is one possible value that the Type element of the GUI Strings (http://support.aquasoft.de/436949-GUI-API) can receive. A component for binary selection is generated ("tick", "cross"). Stores the value of type Boolean. 2. Options * none 3. Example { "Key" : "CheckBox1", "Type" : "CheckBox", "Caption" : "MyCheckBox" }

ComboBox 1. Definition _ComboBox_ is one possible value that the Type element of the GUI Strings (http://support.aquasoft.de/436949-GUI-API) can receive. It creates a dropdown list that contains values of type string. Stores a value of type string, in this case the selected text. 2. Options * "Items": predefined items, Datentyp: Array of string 3. Example { "Key" : "ComboBox1", "Type" : "ComboBox", "Caption" : "MyComboBox", "Options" : { "Items" : ["Item1", "Item2"] } }

Edit 1. Definition _Edit_ is one possible value that the Type element of the GUI Strings (http://support.aquasoft.de/436949-GUI-API) can receive. It creates a single-line entry field. Stores the value of type string. 2. Example { "Key" : "<EditID>", "Type" : "Edit", "Caption" : "<EditDescription>" }

Gallery 1. Definition _Gallery_ is one possible value that the Type element of the GUI Strings (http://support.aquasoft.de/436949-GUI-API) can receive. An image display is generated. Stores a value of type string. 2. Options * "ImageDir": Path to insert images from, relative to the SlideShow Presets folder. Data type: string ImageDir can hold a simple folder, e.g. "MyImagePath". Then all found and supported images are loaded into the gallery. If you set "MyImagePath\\*" (Look for the d...

Label 1. Definition _Label_ is one possible value that the Type element of the GUI Strings (http://support.aquasoft.de/436949-GUI-API) can receive. It creates a labeling field. Its own Caption element is used as text. 2. Options * "Headline": Boolean value(_true_ or _false_, Caution, case-sensitiv); The label is highlighted, therefore suitable as a heading 3. Example { "Key" : "Label1", "Type" : "Label", "Caption" : "MyLabel", "Options" : { "Headline" : true } }

ListBox 1. Definition _ListBox_ is one possible value that the Type element of the GUI Strings (http://support.aquasoft.de/436949-GUI-API) can receive. It creates a list view that contains rows of values of type _string_. Stores a value of type string, in this case the string on the selected index. 2. Options * "Items": predefined list items, data type: Array of string 3. Example { "Key" : "ListBox1", "Type" : "ListBox", "Caption" : "MyListBox", "Options" : { "Items" : ["Item1", "Item...

Slider 1. Definition _Slider_ is one possible value that the Type element of the GUI Strings (http://support.aquasoft.de/436949-GUI-API) can receive. It creates a slider for the integer section. This component will also be named TrackBar. Stores a value of type Integer. 2. Options * "Min": min. value, data type: Integer * "Max": max. value, data type: Integer 3. Example { "Key" : "Slider1", "Type" : "Slider", "Caption" : "MySlider", "Options" : { "Min": 23, "Max": 42 } }

SpinEdit 1. Definition _SpinEdit_ is one possible value that the Type element of the GUI Strings (http://support.aquasoft.de/436949-GUI-API) can receive. It creates an input field for integers containing controls. Stores a value of type Integer. 2. Options * "Min": min. value, data type: Integer * "Max": max. value, data type: Integer * "Increment": Increment to be counted when value is regulated by controls, data type: Integer 3. Example { "Key" : "SpinEdit1", "Type" : "SpinEdit"...

Title 1. Definition _Title_ is one possible value that the Type element of the GUI Strings (http://support.aquasoft.de/436949-GUI-API) can contain. This "component" describes the title of the template or effect. Title is the headline of the GUI. In contrast to all other GUI-types, the Key element is not necessary. Only the Type and the Caption element are required. In addition, this type is the only one taking no line in the layout because it is restricted to the top of the template. Stores a...