Dokumentation der Scripting-API

Hooks

Hooks, also Haken, sind vordefinierte Stellen, die genutzt werden, um ein Skript an die DiaShow zu koppeln. Sie bestimmen, wann welcher Code ausgeführt wird. Code, der in die Prozedur OnExpandSlideShow geschrieben wird, wird beispielsweise direkt vor dem Abspielen der Show ausgeführt. Hooks brauchen nicht definiert zu werden, die Skript-Engine kennt diese speziellen Methoden und reagiert entsprechend darauf.

Alle Hooks haben als Parameter das aktuelle DiaShow-Objekt vom Typ ISlideShow. So kann direkt auf das Objekt zugegriffen werden, dem die Skript-Datei angehängt ist.

allgemeine Hooks

• Vor dem Abspielen der Show

 procedure OnExpandSlideShow(SlideShowObject: ISlideShowObject);

• Beim Einfügen aus der Toolbox; Wird ausgeführt, bevor das Objekt in der Timeline oder dem Storyboard erstellt wurde; Gibt die Funktion TRUE zurück, dann wird das Objekt endgültig eingefügt.

 function OnInsertPreset(SlideShowObject: ISlideShowObject): Boolean;

spezielle Hooks

• Beim Rechtsklick auf das Objekt, also beim Erstellen des Kontextmenüs. Dieser Hook sollte genutzt werden, um spezielle Kontextmenü-Einträge zu generieren. Diese sind JSON-formatiert. Der anzugebene Hook ist einfach eine Skript-Methode, die beim Klick ausgeführt werden soll.

 //Beispiel eines möglichen Kontextmenü-Eintrags
 function OnCreateContextMenu(SlideShowObject: ISlideShowObject): String;
 begin
   Result := '[' +
               '{' +	
                 '"Caption": "Text des Eintrags",' +
                 '"Hint": "MouseOver-Text",' +
                 '"Hook": "OnDoClickContextEntry"' +
               '}' +
             ']';
 end;

• Erstellen der GUI, siehe dazu GUI-API

• Bei Anwenden des Effekts Bildeffekte
  • Parameter Bitmap: Das Leinwandobjekt, auf das gezeichnet wird

 procedure Render(SlideShowObject: ISlideShowObject; Bitmap: ICanvas);

Unterstützte DiaShow-Objekte

• allgemein
• Bilder
• Sounds (wie Musik, etc.)
• Filme
• Zeichenfläche zum eigenen Zeichnen
• Partikel
• Kapitel und Collagen

weitere

• Bewegungsobjekte

Aufbau der GUI für Skript-Vorlagen

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 Grafische Benutzeroberflächen (GUI) zu gestalten.

• siehe dazu die Dokumentation der GUI-API