Dokumentation der Scripting-API: Unterschied zwischen den Versionen
Aus AquaSoft Wiki
Zur Navigation springenZur Suche springen (→Hooks) |
|||
| Zeile 1: | Zeile 1: | ||
= Hooks = | = 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. | ||
| + | |||
| + | Alle Hooks haben als Parameter das aktuelle [[DiaShow-Objekt]] vom Typ '''ISlideShowShow'''. So kann direkt auf das Objekt zugegriffen werden, dem die Skript-Datei angehängt ist. | ||
| + | |||
| + | == allgemeine Hooks == | ||
| + | |||
| + | * Vor dem Abspielen der Show | ||
| + | <code> | ||
| + | procedure OnExpandSlideShow(SlideShowObject: ISlideShowObject); | ||
| + | <code> | ||
| + | |||
| + | |||
| + | * 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. | ||
| + | <code> | ||
| + | function OnInsertPreset(SlideShowObject: ISlideShowObject): Boolean; | ||
| + | </code> | ||
| + | |||
| + | |||
| + | == 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 [https://de.wikipedia.org/wiki/JSON JSON]-formatiert. Der anzugebene Hook ist einfach eine Skript-Methode, die beim Klick ausgeführt werden soll. | ||
| + | <code> | ||
| + | //Beispiel eines möglichen Kontextmenü-Eintrags | ||
| + | function OnCreateContextMenu(SlideShowObject: ISlideShowObject): String; | ||
| + | begin | ||
| + | Result := '[' + | ||
| + | '{' + | ||
| + | '"Caption": "Text des Eintrags",' + | ||
| + | '"Hint": "MouseOver-Text",' + | ||
| + | '"Hook": "OnDoClickContextEntry"' + | ||
| + | '}' + | ||
| + | ']'; | ||
| + | end; | ||
| + | </code> | ||
| + | |||
| + | * Erstellen der GUI, siehe dazu [[GUI-API]] | ||
| + | |||
= Unterstützte DiaShow-Objekte = | = Unterstützte DiaShow-Objekte = | ||
* [[DiaShow-Objekt|allgemein]] | * [[DiaShow-Objekt|allgemein]] | ||
Version vom 14. August 2012, 14:02 Uhr
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.
Alle Hooks haben als Parameter das aktuelle DiaShow-Objekt vom Typ ISlideShowShow. 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
Unterstützte DiaShow-Objekte
weitere
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
Beispiel
