DiaShow-Objekt: Unterschied zwischen den Versionen

Aus AquaSoft Wiki
Zur Navigation springenZur Suche springen
K (hat „Skript-Methoden vom DiaShow-Objekt“ nach „DiaShow-Objekt“ verschoben)
 
(11 dazwischenliegende Versionen von 3 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
Das DiaShow-Objekt, eigentlich ''SlideShowObject'' vom Typ '''ISlideShowObject''' (Abk. SSO), bildet die Basis-Klasse für alle Objekte, die in der DiaShow Verwendung finden. Dementsprechenden leiten alle anderen von ihm ab und enthalten deshalb alle Methoden dessen.
+
Das DiaShow-Objekt ist die Basis-Klasse für [[DiaShow-Objekte|alle Objekte]], die in der DiaShow Verwendung finden.  
 +
 
 +
<code>
 +
  ISlideShowObject
 +
    procedure SetItem(Index: Integer; Item: ISlideShowObject);
 +
    function GetItem(Index: Integer): ISlideShowObject;
 +
    function Text: [[IText]];
 +
    function Clone: ISlideShowObject;
 +
    function CloneWithChildren: ISlideShowObject;
 +
    procedure SetValueAsString(const Key: String; const Value: String);
 +
    function GetValueAsString(const Key: String): String;
 +
    procedure SetValueAsSingle(const Key: String; const Value: Single);
 +
    function GetValueAsSingle(const Key: String): Single;
 +
    procedure SetValueAsInteger(const Key: String; const Value: Integer);
 +
    function GetValueAsInteger(const Key: String): Integer;
 +
    procedure SetValueAsBoolean(const Key: String; const Value: Boolean);
 +
    function GetValueAsBoolean(const Key: String): Boolean;
 +
    function NameIs(const AName: string): Boolean;
 +
    property Name: string;
 +
    property Offset: Integer;
 +
    property Duration: Integer;
 +
    property Parent: ISlideShowObject;
 +
    property Count: Integer;
 +
  end;
 +
</code>
  
 
= Methoden =
 
= Methoden =
 +
 
* Getter und Setter für Kindelemente. Alle Objekte können andere SlideShowObjekte als Kinder halten. Als herausragendes Beispiel kann man das Kapitel nennen, welches Bilder in sich vereint. Generell geht das aber mit allen anderen Objekten genauso.
 
* Getter und Setter für Kindelemente. Alle Objekte können andere SlideShowObjekte als Kinder halten. Als herausragendes Beispiel kann man das Kapitel nennen, welches Bilder in sich vereint. Generell geht das aber mit allen anderen Objekten genauso.
 
<code>
 
<code>
   procedure SetItem(Index: Integer; Item: IScripting_ISlideShowObject);
+
  procedure InsertItem(Index: Integer; Item: ISlideShowObject);
   function GetItem(Index: Integer): IScripting_ISlideShowObject;
+
  procedure AddItem(Item: ISlideShowObject);
 +
   procedure SetItem(Index: Integer; Item: ISlideShowObject);
 +
   function GetItem(Index: Integer): ISlideShowObject;
 
</code>
 
</code>
  
Zeile 11: Zeile 38:
 
* Gibt die Anzahl der Kindelemente zurück
 
* Gibt die Anzahl der Kindelemente zurück
 
<code>
 
<code>
   function GetCount: Integer;
+
   property Count: Integer;
 
</code>
 
</code>
  
Zeile 17: Zeile 44:
 
* Gibt das Elternelement zurück
 
* Gibt das Elternelement zurück
 
<code>
 
<code>
   function GetParent: IScripting_ISlideShowObject;
+
  property Parent: ISlideShowObject;
 +
</code>
 +
 
 +
 
 +
* Ein SSO kann Text enthalten und ist vom Typ '''[[IText]]'''
 +
<code>
 +
   function Text: IText;
 +
</code>
 +
 
 +
 
 +
* Abspiel-/Anzeigedauer eines Objektes in Millisekunden. Achtung, sollte nur in Ausnahmefällen geändert werden!
 +
<code>
 +
  property Duration: Integer; // lesen und schreiben
 +
</code>
 +
 
 +
 
 +
* Der Offset des Objektes ist der Abstand zum Vorgänger-Objekt in Millisekunden. W
 +
<code>
 +
  property Offset: Integer; // lesen und schreiben
 
</code>
 
</code>
  
  
* Ein SSO kann Text enthalten, dieses [[Textobjekt]] ist vom Typ '''IText'''
+
* Kopiert das SSO ohne bzw. mit dessen Kindelemente(n)
 +
<code>
 +
  function Clone: ISlideShowObject;
 +
  function CloneWithChildren: ISlideShowObject;
 +
</code>
  
  function Text: IText;
 
  
* function GetDuration: Integer;
+
* Getter und Setter für [[GUI-API|GUI]]-Werte. Der '''Key''' gibt an, welches GUI-Element gemeint ist, '''Value''' setzt den entsprechenden Wert. Der Datentyp von Value ist dabei von Komponente zu Komponente unterschiedlich.
* function GetOffset: Integer;
+
<code>
* procedure SetDuration(const Value: Integer);
+
  procedure SetValueAsString(const Key: String; const Value: String);
* procedure SetOffset(const Value: Integer);
+
  function GetValueAsString(const Key: String): String;
 +
 
 +
  procedure SetValueAsSingle(const Key: String; const Value: Single);
 +
  function GetValueAsSingle(const Key: String): Single;
 +
 
 +
  procedure SetValueAsInteger(const Key: String; const Value: Integer);
 +
  function GetValueAsInteger(const Key: String): Integer;
 +
 
 +
  procedure SetValueAsBoolean(const Key: String; const Value: Boolean);
 +
  function GetValueAsBoolean(const Key: String): Boolean;
 +
</code>
 +
 
 +
* Objektbenennung: Objekte können im Hauptprogramm einen Zugriffsnamen bekommen. Dieser kann über das "Name"-Propery abgerufen werden.
 +
<code>
 +
  property Name: string;
 +
</code>
 +
 
 +
* Liefert True zurück, wenn der Name des Objekts AName entspricht. Dabei wird Groß-/Kleinschreibung vernachlässigt.
 +
<code>
 +
  function NameIs(const AName: string): Boolean;
 +
</code>
 +
 
  
* procedure SetValueAsString(const Key: String; const Value: String);
+
= Verwendung =
* function GetValueAsString(const Key: String): String;
 
  
* procedure SetValueAsSingle(const Key: String; const Value: Single);
+
Ein ISlideShowObject kommt niemals in reiner Form vor, sondern immer als spezielle Variante (z.B. ein [[IPicture|Bild]] oder [[IText|Text]]). Es ist die Basis für [[DiaShow-Objekte|alle Objekte]], die in der DiaShow Verwendung finden. Dementsprechenden leiten alle anderen von ihm ab und können in eine ISlideShowObject umgewandelt (gecastet) werden:
* function GetValueAsSingle(const Key: String): Single;
 
  
* procedure SetValueAsInteger(const Key: String; const Value: Integer);
+
<code>
* function GetValueAsInteger(const Key: String): Integer;
+
  var Pic: IPicture;
 +
  var SSO: ISlideShowObject;
 +
  Pic := CreatePicture;
 +
  SSO := Pic as ISlideShowObject; // ein Bild lässt sich in das allgemeinere ISlideShowObject casten
 +
</code>
  
* procedure SetValueAsBoolean(const Key: String; const Value: Boolean);
 
* function GetValueAsBoolean(const Key: String): Boolean;
 
  
* function Clone: IScripting_ISlideShowObject;
 
* function CloneWithChildren: IScripting_ISlideShowObject;
 
  
* function GetFace (const Index: Integer): IScripting_IFaceObject;
+
[[Kategorie:Scripting-API]]
* function GetFaceCount: Integer;
 

Aktuelle Version vom 13. März 2013, 10:50 Uhr

Das DiaShow-Objekt ist die Basis-Klasse für alle Objekte, die in der DiaShow Verwendung finden.

 ISlideShowObject
   procedure SetItem(Index: Integer; Item: ISlideShowObject);
   function GetItem(Index: Integer): ISlideShowObject;
   function Text: IText;
   function Clone: ISlideShowObject;
   function CloneWithChildren: ISlideShowObject;
   procedure SetValueAsString(const Key: String; const Value: String);
   function GetValueAsString(const Key: String): String;
   procedure SetValueAsSingle(const Key: String; const Value: Single);
   function GetValueAsSingle(const Key: String): Single;
   procedure SetValueAsInteger(const Key: String; const Value: Integer);
   function GetValueAsInteger(const Key: String): Integer;
   procedure SetValueAsBoolean(const Key: String; const Value: Boolean);
   function GetValueAsBoolean(const Key: String): Boolean;
   function NameIs(const AName: string): Boolean;
   property Name: string;
   property Offset: Integer;
   property Duration: Integer;
   property Parent: ISlideShowObject;
   property Count: Integer;
 end;

Methoden

  • Getter und Setter für Kindelemente. Alle Objekte können andere SlideShowObjekte als Kinder halten. Als herausragendes Beispiel kann man das Kapitel nennen, welches Bilder in sich vereint. Generell geht das aber mit allen anderen Objekten genauso.

 procedure InsertItem(Index: Integer; Item: ISlideShowObject);
 procedure AddItem(Item: ISlideShowObject);
 procedure SetItem(Index: Integer; Item: ISlideShowObject);
 function GetItem(Index: Integer): ISlideShowObject;


  • Gibt die Anzahl der Kindelemente zurück

 property Count: Integer;


  • Gibt das Elternelement zurück

 property Parent: ISlideShowObject;


  • Ein SSO kann Text enthalten und ist vom Typ IText

 function Text: IText;


  • Abspiel-/Anzeigedauer eines Objektes in Millisekunden. Achtung, sollte nur in Ausnahmefällen geändert werden!

 property Duration: Integer; // lesen und schreiben


  • Der Offset des Objektes ist der Abstand zum Vorgänger-Objekt in Millisekunden. W

 property Offset: Integer; // lesen und schreiben


  • Kopiert das SSO ohne bzw. mit dessen Kindelemente(n)

 function Clone: ISlideShowObject;
 function CloneWithChildren: ISlideShowObject;


  • Getter und Setter für GUI-Werte. Der Key gibt an, welches GUI-Element gemeint ist, Value setzt den entsprechenden Wert. Der Datentyp von Value ist dabei von Komponente zu Komponente unterschiedlich.

 procedure SetValueAsString(const Key: String; const Value: String);
 function GetValueAsString(const Key: String): String;
 procedure SetValueAsSingle(const Key: String; const Value: Single);
 function GetValueAsSingle(const Key: String): Single;
 procedure SetValueAsInteger(const Key: String; const Value: Integer);
 function GetValueAsInteger(const Key: String): Integer;
 procedure SetValueAsBoolean(const Key: String; const Value: Boolean);
 function GetValueAsBoolean(const Key: String): Boolean;

  • Objektbenennung: Objekte können im Hauptprogramm einen Zugriffsnamen bekommen. Dieser kann über das "Name"-Propery abgerufen werden.

 property Name: string;

  • Liefert True zurück, wenn der Name des Objekts AName entspricht. Dabei wird Groß-/Kleinschreibung vernachlässigt.

 function NameIs(const AName: string): Boolean;


Verwendung

Ein ISlideShowObject kommt niemals in reiner Form vor, sondern immer als spezielle Variante (z.B. ein Bild oder Text). Es ist die Basis für alle Objekte, die in der DiaShow Verwendung finden. Dementsprechenden leiten alle anderen von ihm ab und können in eine ISlideShowObject umgewandelt (gecastet) werden:

 var Pic: IPicture;
 var SSO: ISlideShowObject;
 Pic := CreatePicture;
 SSO := Pic as ISlideShowObject; // ein Bild lässt sich in das allgemeinere ISlideShowObject casten