Modul scriptforge

Das Modul scriptforge enthält eine erweiterbare Sammlung von Skriptressourcen für LibreOfficeDev, die aus Python-Skripten heraus aufgerufen werden können. Eine vollständige Beschreibung dieser Ressourcen ist auf der Hilfeseite zu den ScriptForge-Bibliotheken zu finden.

Methoden

CreateScriptService

Instanziiert Ressourcen ScriptForge als „Dienste“. Es dient als generischer Konstruktor für alle Eigenschaften, Methoden oder Klassen der Dienste ScriptForge.

CreateScriptService(servicename: str [, arg0, arg1, ...]): svc

servicename: Ein ScriptForge-Servicename wie "ScriptForge.FileSystem", "SFDialogs.Dialog" oder Ähnliches.

arg0, arg1, …: Optionale Parameter für den instanziierten Dienst.

      from scriptforge import CreateScriptService as getSvc
      svc = getSvc('ScriptForge.Basic')
	  svc.MsgBox('Hello')
      svc.Dispose()
    

Die Methode Dispose steht in allen Diensten zur Verfügung und sollte aufgerufen werden, um Ressourcen nach der Verwendung freizugeben.

Der Dienst "ScripForge.Basic" enthält spezifische Eigenschaften und Methoden für den Zugriff auf UNO-Objekte und -Dienste sowie auf weitere Funktionen.

ScriptForge class

Verbindet sich mit einem laufenden LibreOfficeDev-Dienst, der über die Befehlszeile gestartet wurde. Die Klasse ScriptForge kann IDE-basierte Python-Skripte zu Debugging-Zwecken mit einem LibreOfficeDev-Remote-Prozess verbinden.

opt ScriptForge(pipe = 'PIPE2LIBREOFFICE'): obj
opt ScriptForge(hostname = '', port = 0): obj

Pipe- und Socket-Verbindungen schließen einander aus.

pipe: Benannte Pipe, die zum Starten des LibreOfficeDev-Remote-Dienstes verwendet wird. Der Standardname lautet „PIPE2LIBREOFFICE“.

hostname: '', 'localhost' oder die IP-Adresse des Rechners, auf dem der LibreOfficeDev-Remote-Dienst gehostet wird.

port: Die Portnummer, die zum Starten von LibreOfficeDev als Dienst verwendet wird.

Der Aufruf von LibreOfficeDev über die Befehlszeile erfolgte wie folgt:

      from scriptforge import CreateScriptService as getSvc
      ui = getSvc('ScriptForge.Basic')

      def my_script():  # Benutzercode kommt hierhin.
          response = ui.MsgBox('Fortfahren?',ui.MB_YESNOCANCEL,'Eine Nachricht von Python')
          ui.MsgBox('Modul scriptforge',ui.MB_OK,response)
      g_exportedScripts = (my_script,)  # LibreOffice-Einstiegspunkte
      if __name__ == "__main__":  # Einstiegspunkt für IDEs
          # from scriptforge import ScriptForge # als Sitzungsmanager
          # ScriptForge(pipe='PIPE2LIBREOFFICE')  # im Hintergrund ausgeführt
          my_script()
    

Um mehr darüber zu erfahren, wie Python-Skripte mit dem Modul scriptforge erstellt und ausgeführt werden, die Hilfeseite Python-Skripte mit ScriptForge erstellen lesen.

Alle Methoden oder Bezeichner scriptforge, denen ein Unterstrich („_“) vorangestellt ist, sind für den internen Gebrauch reserviert. Sie sind nicht für die Verwendung in Python-Skripten vorgesehen.