Quelltext der Seite GUI-API

Es ist manchmal notwendig, dass für Vorlagen und Effekte Einstellungen und Eingaben vom Benutzer gebraucht werden. Daher bietet die Scripting-API die Möglichkeit, einfache [Benutzeroberflächen] (GUI) zu gestalten. 

= Einfügen der GUI =
Die Gestaltung geschieht innerhalb der vordefinierten Funktion '''GetGUI''', die irgendwo im betreffenden Skript eingefügt sein muss:
<code>
  function GetGUI(SlideShowObject: ISlideShowObject): string;
  begin
    Result := '';
  end;
</code>
Diese Funktion hält einen Parameter '''SlideShowObject'''. Dieses ist eine Referenz auf das Objekt, welches das Skript ausführt. Das ist in der Regel das Effekt- bzw. das BlackBox-Objekt selbst.

Die Definition der GUI erfolgt mittels [[https://de.wikipedia.org/wiki/JSON|JSON]]-Syntax. Die Funktion liefert also einen JSON-String zurück.

= Struktur des JSON-Strings =
Das JSON-Objekt ist ein Array aus Komponenten-Objekten:
<code>
  [
    {
      # Komponente 1
    },
    {
      # Komponente 2
    }
  ]

</code>
Jede Komponente benötigt das '''Key'''-Element, das '''Caption'''-Element und das '''Type'''-Element. Alle diese Elemente sind vom Datentyp ''String''.
* ''Key'': Eindeutige Kennung der Komponente, seine ID
* ''Type'': Art der Komponente. Kann folgende Werte annehmen:
** ''[[Dokumentation der Komponente Title|Title]]'': Title der Vorlage oder des Effekts
** ''[[Dokumentation der Komponente Edit|Edit]]'': Eingabefeld
** ''[[Dokumentation der Komponente ListBox|ListBox]]'': Listenelement, enthält Strings
** ''[[Dokumentation der Komponente ComboBox|ComboBox]]'': Aufklappbarer Auswahldialog, enthält Strings
** ''[[Dokumentation der Komponente CheckBox|CheckBox]]'': Kästchen zur binären Auswahl
** ''[[Dokumentation der Komponente ImageComboBox|ImageComboBox]]'': Aufklappbarer Auswahldialog, enthält Bilder
** ''[[Dokumentation der Komponente SpinEdit|SpinEdit]]'': Eingabefeld für Ganzzahlen, liefert Integer-Werte
** ''[[Dokumentation der Komponente Slider|Slider]]'': auch unter '''TrackBar''' bekannt, Schieberegler, liefert Integer-Werte
* ''Caption'': Beschriftung der Komponente, kann leer sein.
Zusätzlich gibt es das optionale '''Options'''-Objekt, welches bei Bedarf bestimmte Zusatzinformationen enthalten kann - je nach Type.
<code>
  # Beispiel für ein Edit-Feld und ein beschränktes Spin-Edit.
  [
    {
      "Key" : "Edit1",
      "Type" : "Edit",
      "Caption" : "Dies ist eine Edit-Feld"
    },
    {
      "Key" : "Spin1",
      "Type" : "SpinEdit",
      "Caption" : "Dies ist ein SpinEdit-Feld",
      "Options" :
        {
          "Min" : 1,
          "Max" : 10
        }
    }
  ]
</code>

[[Kategorie:Scripting-API]]